diff --git a/README.md b/README.md
index 1196e63f..aba6de0b 100644
--- a/README.md
+++ b/README.md
@@ -44,18 +44,12 @@ Instantiate and use the client with the following:
```python
from merge import Merge
-from merge.resources.ats import ActivityRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.activities.create(
- is_debug_mode=True,
- run_async=True,
- model=ActivityRequest(),
- remote_user_id="remote_user_id",
-)
+client.ats.account_token.regenerate_create()
```
## Instantiation
@@ -89,7 +83,6 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
import asyncio
from merge import AsyncMerge
-from merge.resources.ats import ActivityRequest
client = AsyncMerge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -98,12 +91,7 @@ client = AsyncMerge(
async def main() -> None:
- await client.ats.activities.create(
- is_debug_mode=True,
- run_async=True,
- model=ActivityRequest(),
- remote_user_id="remote_user_id",
- )
+ await client.ats.account_token.regenerate_create()
asyncio.run(main())
@@ -118,7 +106,7 @@ will be thrown.
from merge.core.api_error import ApiError
try:
- client.ats.activities.create(...)
+ client.ats.account_token.regenerate_create(...)
except ApiError as e:
print(e.status_code)
print(e.body)
@@ -137,7 +125,7 @@ from merge import Merge
client = Merge(
...,
)
-response = client.ats.activities.with_raw_response.create(...)
+response = client.ats.account_token.with_raw_response.regenerate_create(...)
print(response.headers) # access the response headers
print(response.data) # access the underlying object
```
@@ -157,7 +145,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
Use the `max_retries` request option to configure this behavior.
```python
-client.ats.activities.create(..., request_options={
+client.ats.account_token.regenerate_create(..., request_options={
"max_retries": 1
})
```
@@ -177,7 +165,7 @@ client = Merge(
# Override timeout for a specific method
-client.ats.activities.create(..., request_options={
+client.ats.account_token.regenerate_create(..., request_options={
"timeout_in_seconds": 1
})
```
@@ -266,3 +254,4 @@ while response.next is not None:
+
diff --git a/poetry.lock b/poetry.lock
index 437fa955..46f7b7b8 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -133,13 +133,13 @@ zstd = ["zstandard (>=0.18.0)"]
[[package]]
name = "idna"
-version = "3.13"
+version = "3.14"
description = "Internationalized Domain Names in Applications (IDNA)"
optional = false
python-versions = ">=3.8"
files = [
- {file = "idna-3.13-py3-none-any.whl", hash = "sha256:892ea0cde124a99ce773decba204c5552b69c3c67ffd5f232eb7696135bc8bb3"},
- {file = "idna-3.13.tar.gz", hash = "sha256:585ea8fe5d69b9181ec1afba340451fba6ba764af97026f92a91d4eef164a242"},
+ {file = "idna-3.14-py3-none-any.whl", hash = "sha256:e677eaf072e290f7b725f9acf0b3a2bd55f9fd6f7c70abe5f0e34823d0accf69"},
+ {file = "idna-3.14.tar.gz", hash = "sha256:466d810d7a2cc1022bea9b037c39728d51ae7dad40d480fc9b7d7ecf98ba8ee3"},
]
[package.extras]
diff --git a/pyproject.toml b/pyproject.toml
index d8697a31..30811706 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -3,7 +3,7 @@ name = "MergePythonClient"
[tool.poetry]
name = "MergePythonClient"
-version = "2.6.4"
+version = "3.0.0a1"
description = ""
readme = "README.md"
authors = []
diff --git a/reference.md b/reference.md
index 72c3f6b5..882dcc90 100644
--- a/reference.md
+++ b/reference.md
@@ -129,6 +129,67 @@ client.ats.account_token.retrieve(
+
+
+
+
+client.ats.account_token.regenerate_create()
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Exchange Linked Account account tokens.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.account_token.regenerate_create()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
-
-**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.
@@ -283,7 +348,7 @@ client.ats.activities.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -501,7 +566,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,9 +714,6 @@ 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",
@@ -664,7 +730,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,
@@ -743,7 +808,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 +1043,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 +1050,6 @@ client = Merge(
)
client.ats.applications.retrieve(
id="id",
- expand=ApplicationsRetrieveRequestExpand.CANDIDATE,
include_remote_data=True,
include_shell_data=True,
)
@@ -1010,7 +1076,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.
@@ -1473,7 +1544,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 +1801,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.
@@ -1919,7 +2000,7 @@ client.ats.audit_trail.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -2048,7 +2129,6 @@ 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",
@@ -2063,7 +2143,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,
@@ -2126,7 +2205,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 +2437,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 +2444,6 @@ client = Merge(
)
client.ats.candidates.retrieve(
id="id",
- expand=CandidatesRetrieveRequestExpand.APPLICATIONS,
include_remote_data=True,
include_shell_data=True,
)
@@ -2390,7 +2470,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 +2647,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 +2655,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 +2682,7 @@ client.ats.candidates.ignore_create(
-
-**reason:** `IgnoreCommonModelRequestReason`
-
-
-
-
-
--
-
-**message:** `typing.Optional[str]`
+**request:** `IgnoreCommonModelRequest`
@@ -3402,7 +3481,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.
@@ -3450,7 +3534,7 @@ client.ats.eeocs.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -3561,7 +3645,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.
@@ -3798,6 +3887,14 @@ client.ats.field_mapping.field_mappings_create(
-
+**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.
@@ -3916,6 +4013,7 @@ client = Merge(
)
client.ats.field_mapping.field_mappings_partial_update(
field_mapping_id="field_mapping_id",
+ remote_data_iteration_count=1,
)
```
@@ -3940,6 +4038,14 @@ client.ats.field_mapping.field_mappings_partial_update(
-
+**remote_data_iteration_count:** `typing.Optional[int]` β Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.
+
+
+
+
+
+-
+
**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.
@@ -3964,6 +4070,14 @@ client.ats.field_mapping.field_mappings_partial_update(
-
+**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.
@@ -4220,7 +4334,6 @@ 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",
@@ -4235,7 +4348,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,
@@ -4298,7 +4410,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.
@@ -4370,7 +4487,7 @@ client.ats.interviews.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -4541,9 +4658,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 +4665,6 @@ client = Merge(
)
client.ats.interviews.retrieve(
id="id",
- expand=InterviewsRetrieveRequestExpand.APPLICATION,
include_remote_data=True,
include_shell_data=True,
)
@@ -4578,7 +4691,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.
@@ -4855,7 +4973,7 @@ client.ats.issues.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -5063,7 +5181,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.
@@ -5119,7 +5239,7 @@ client.ats.job_interview_stages.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -5208,7 +5328,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.
@@ -5343,7 +5465,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.
@@ -5391,7 +5515,7 @@ client.ats.job_postings.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -5496,7 +5620,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,10 +5689,7 @@ 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",
@@ -5581,7 +5704,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,
@@ -5643,7 +5765,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.
@@ -5699,7 +5825,7 @@ client.ats.jobs.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -5787,7 +5913,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 +5920,6 @@ client = Merge(
)
client.ats.jobs.retrieve(
id="id",
- expand=JobsRetrieveRequestExpand.DEPARTMENTS,
include_remote_data=True,
include_shell_data=True,
)
@@ -5822,7 +5946,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,9 +6031,6 @@ 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",
@@ -5913,7 +6039,6 @@ client = Merge(
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,
@@ -5950,7 +6075,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.
@@ -5982,7 +6112,7 @@ client.ats.jobs.screening_questions_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -6015,7 +6145,7 @@ client.ats.jobs.screening_questions_list(
-
-Creates a link token to be used when linking a new end user.
+Creates a link token to be used when linking a new end user. The link token expires after single use.
@@ -6351,7 +6481,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -6410,7 +6540,7 @@ Returns a list of `Offer` objects.
import datetime
from merge import Merge
-from merge.resources.ats.resources.offers import OffersListRequestExpand
+from merge.resources.ats.resources.offers import OffersListRequestStatus
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -6426,7 +6556,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,
@@ -6438,6 +6567,7 @@ client.ats.offers.list(
),
page_size=1,
remote_id="remote_id",
+ status=OffersListRequestStatus.APPROVAL_SENT,
)
```
@@ -6494,7 +6624,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.
@@ -6574,6 +6709,26 @@ client.ats.offers.list(
-
+**status:** `typing.Optional[OffersListRequestStatus]`
+
+If provided, will only return offers with this status. Options: ('DRAFT', 'APPROVAL-SENT', 'APPROVED', 'SENT', 'SENT-MANUALLY', 'OPENED', 'DENIED', 'SIGNED', 'DEPRECATED')
+
+* `DRAFT` - DRAFT
+* `APPROVAL-SENT` - APPROVAL-SENT
+* `APPROVED` - APPROVED
+* `SENT` - SENT
+* `SENT-MANUALLY` - SENT-MANUALLY
+* `OPENED` - OPENED
+* `DENIED` - DENIED
+* `SIGNED` - SIGNED
+* `DEPRECATED` - DEPRECATED
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -6614,7 +6769,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 +6776,6 @@ client = Merge(
)
client.ats.offers.retrieve(
id="id",
- expand=OffersRetrieveRequestExpand.APPLICATION,
include_remote_data=True,
include_shell_data=True,
)
@@ -6649,7 +6802,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.
@@ -6836,7 +6994,7 @@ client.ats.offices.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -7236,7 +7394,7 @@ client.ats.reject_reasons.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -7384,7 +7542,6 @@ 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",
@@ -7399,7 +7556,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,
@@ -7461,7 +7617,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.
@@ -7525,7 +7686,7 @@ client.ats.scorecards.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -7597,9 +7758,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 +7765,6 @@ client = Merge(
)
client.ats.scorecards.retrieve(
id="id",
- expand=ScorecardsRetrieveRequestExpand.APPLICATION,
include_remote_data=True,
include_shell_data=True,
)
@@ -7634,7 +7791,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.
@@ -7747,7 +7909,7 @@ client.ats.sync_status.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -7964,7 +8126,7 @@ client.ats.tags.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -8136,7 +8298,7 @@ client.ats.users.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -8435,8 +8597,8 @@ client.ats.webhook_receivers.create(
-## Chat AccountDetails
-client.chat.account_details.retrieve()
+## Accounting AccountDetails
+client.accounting.account_details.retrieve()
-
@@ -8469,7 +8631,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 +8659,8 @@ client.chat.account_details.retrieve()
client.chat.account_token.retrieve(...)
+## Accounting AccountToken
+client.accounting.account_token.retrieve(...)
-
@@ -8531,7 +8693,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 +8731,7 @@ client.chat.account_token.retrieve(
client.chat.async_passthrough.create(...)
+client.accounting.account_token.regenerate_create()
-
@@ -8582,7 +8743,7 @@ client.chat.account_token.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Exchange Linked Account account tokens.
@@ -8598,18 +8759,12 @@ 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",
- ),
-)
+client.accounting.account_token.regenerate_create()
```
@@ -8625,14 +8780,6 @@ client.chat.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -8645,79 +8792,8 @@ client.chat.async_passthrough.create(
client.chat.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.chat.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.chat.audit_trail.list(...)
+## Accounting AccountingPeriods
+client.accounting.accounting_periods.list(...)
-
@@ -8729,7 +8805,7 @@ client.chat.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+Returns a list of `AccountingPeriod` objects.
@@ -8750,13 +8826,12 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.audit_trail.list(
+client.accounting.accounting_periods.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
page_size=1,
- start_date="start_date",
- user_email="user_email",
)
```
@@ -8781,15 +8856,7 @@ client.chat.audit_trail.list(
-
-**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`
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -8797,7 +8864,7 @@ client.chat.audit_trail.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -8805,7 +8872,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_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -8813,7 +8880,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.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -8833,8 +8900,7 @@ client.chat.audit_trail.list(
client.chat.available_actions.retrieve()
+client.accounting.accounting_periods.retrieve(...)
-
@@ -8846,7 +8912,7 @@ client.chat.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Returns an `AccountingPeriod` object with the given `id`.
@@ -8867,7 +8933,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.available_actions.retrieve()
+client.accounting.accounting_periods.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
```
@@ -8883,6 +8953,30 @@ client.chat.available_actions.retrieve()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `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.
@@ -8895,8 +8989,8 @@ client.chat.available_actions.retrieve()
client.chat.conversations.list(...)
+## Accounting Accounts
+client.accounting.accounts.list(...)
-
@@ -8908,7 +9002,7 @@ client.chat.available_actions.retrieve()
-
-Returns a list of `Conversation` objects.
+Returns a list of `Account` objects.
@@ -8926,12 +9020,21 @@ Returns a list of `Conversation` 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.chat.conversations.list(
+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",
),
@@ -8948,8 +9051,12 @@ client.chat.conversations.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,
)
```
@@ -8966,6 +9073,30 @@ client.chat.conversations.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.
@@ -8990,7 +9121,11 @@ client.chat.conversations.list(
-
-**expand:** `typing.Optional[typing.Literal["members"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ 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.
@@ -9038,6 +9173,14 @@ client.chat.conversations.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. The maximum limit is 100.
@@ -9046,6 +9189,14 @@ client.chat.conversations.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.
@@ -9054,6 +9205,22 @@ client.chat.conversations.list(
-
+**show_enum_origins:** `typing.Optional[AccountsListRequestShowEnumOrigins]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**status:** `typing.Optional[AccountsListRequestStatus]` β If provided, will only return accounts with this status.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -9066,7 +9233,7 @@ client.chat.conversations.list(
client.chat.conversations.members_list(...)
+client.accounting.accounts.create(...)
-
@@ -9078,7 +9245,7 @@ client.chat.conversations.list(
-
-Returns a list of `Member` objects.
+Creates an `Account` object with the given values.
@@ -9094,22 +9261,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 +9287,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 +9295,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 +9303,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 +9323,7 @@ client.chat.conversations.members_list(
client.chat.conversations.retrieve(...)
+client.accounting.accounts.retrieve(...)
-
@@ -9206,7 +9335,7 @@ client.chat.conversations.members_list(
-
-Returns a `Conversation` object with the given `id`.
+Returns an `Account` object with the given `id`.
@@ -9222,15 +9351,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 +9390,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 +9418,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 +9446,7 @@ client.chat.conversations.retrieve(
client.chat.scopes.default_scopes_retrieve()
+client.accounting.accounts.meta_post_retrieve()
-
@@ -9304,7 +9458,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 +9479,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 +9507,8 @@ client.chat.scopes.default_scopes_retrieve()
client.chat.scopes.linked_account_scopes_retrieve()
+## Accounting Addresses
+client.accounting.addresses.retrieve(...)
-
@@ -9365,7 +9520,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 +9541,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 +9561,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 +9613,8 @@ client.chat.scopes.linked_account_scopes_retrieve()
client.chat.scopes.linked_account_scopes_create(...)
+## Accounting AsyncPassthrough
+client.accounting.async_passthrough.create(...)
-
@@ -9426,7 +9626,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 +9642,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 +9669,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 +9689,7 @@ client.chat.scopes.linked_account_scopes_create(
client.chat.delete_account.delete()
+client.accounting.async_passthrough.retrieve(...)
-
@@ -9527,7 +9701,7 @@ client.chat.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Retrieves data from earlier async-passthrough POST request
@@ -9548,7 +9722,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 +9740,14 @@ client.chat.delete_account.delete()
-
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -9576,8 +9760,8 @@ client.chat.delete_account.delete()
client.chat.field_mapping.field_mappings_retrieve(...)
+## Accounting AsyncTasks
+client.accounting.async_tasks.retrieve(...)
-
@@ -9589,7 +9773,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 +9794,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 +9812,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 +9832,8 @@ client.chat.field_mapping.field_mappings_retrieve(
client.chat.field_mapping.field_mappings_create(...)
+## Accounting Attachments
+client.accounting.attachments.list(...)
-
@@ -9660,7 +9845,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,20 +9860,34 @@ 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",
+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",
)
```
@@ -9705,7 +9904,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 +9912,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 +9920,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 +9928,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 +9936,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 +9944,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 +9952,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 +9960,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 +9968,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. The maximum limit is 100.
+
-#### βοΈ Parameters
-
-
-
--
-
-**field_mapping_id:** `str`
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -9852,7 +10004,7 @@ client.chat.field_mapping.field_mappings_destroy(
client.chat.field_mapping.field_mappings_partial_update(...)
+client.accounting.attachments.create(...)
-
@@ -9864,7 +10016,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 +10032,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 +10058,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 +10066,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 +10074,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 +10094,7 @@ client.chat.field_mapping.field_mappings_partial_update(
client.chat.field_mapping.remote_fields_retrieve(...)
+client.accounting.attachments.retrieve(...)
-
@@ -9967,7 +10106,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 +10127,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 +10147,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 +10155,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 +10183,7 @@ client.chat.field_mapping.remote_fields_retrieve(
client.chat.field_mapping.target_fields_retrieve()
+client.accounting.attachments.meta_post_retrieve()
-
@@ -10047,7 +10195,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 +10216,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,8 +10244,8 @@ client.chat.field_mapping.target_fields_retrieve()
client.chat.generate_key.create(...)
+## Accounting AuditTrail
+client.accounting.audit_trail.list(...)
-
@@ -10109,7 +10257,7 @@ client.chat.field_mapping.target_fields_retrieve()
-
-Create a remote key.
+Gets a list of audit trail events.
@@ -10130,8 +10278,13 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.generate_key.create(
- name="Remote Deployment Key 1",
+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",
)
```
@@ -10148,7 +10301,47 @@ client.chat.generate_key.create(
-
-**name:** `str` β The name of the remote key
+**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.
@@ -10168,8 +10361,8 @@ client.chat.generate_key.create(
client.chat.groups.list(...)
+## Accounting AvailableActions
+client.accounting.available_actions.retrieve()
-
@@ -10181,7 +10374,69 @@ client.chat.generate_key.create(
-
-Returns a list of `Group` objects.
+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.accounting.available_actions.retrieve()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+
+
+## Accounting BalanceSheets
+client.accounting.balance_sheets.list(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns a list of `BalanceSheet` objects.
@@ -10204,7 +10459,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.groups.list(
+client.accounting.balance_sheets.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -10239,6 +10495,14 @@ client.chat.groups.list(
-
+**company_id:** `typing.Optional[str]` β If provided, will only return balance sheets for this company.
+
+
+
+
+
+-
+
**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -10263,7 +10527,11 @@ 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.
+**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.
@@ -10339,7 +10607,7 @@ client.chat.groups.list(
client.chat.groups.retrieve(...)
+client.accounting.balance_sheets.retrieve(...)
-
@@ -10351,7 +10619,7 @@ client.chat.groups.list(
-
-Returns a `Group` object with the given `id`.
+Returns a `BalanceSheet` object with the given `id`.
@@ -10372,7 +10640,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.groups.retrieve(
+client.accounting.balance_sheets.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -10400,7 +10668,11 @@ client.chat.groups.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["users"]]` β 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.
@@ -10436,8 +10708,8 @@ client.chat.groups.retrieve(
client.chat.issues.list(...)
+## Accounting BankFeedAccounts
+client.accounting.bank_feed_accounts.list(...)
-
@@ -10449,7 +10721,7 @@ client.chat.groups.retrieve(
-
-Gets all issues for Organization.
+Returns a list of `BankFeedAccount` objects.
@@ -10464,38 +10736,18 @@ Gets all issues for Organization.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.chat.resources.issues import IssuesListRequestStatus
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.issues.list(
- account_token="account_token",
+client.accounting.bank_feed_accounts.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,
page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
)
```
@@ -10512,7 +10764,7 @@ client.chat.issues.list(
-
-**account_token:** `typing.Optional[str]`
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -10520,7 +10772,7 @@ client.chat.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/).
@@ -10528,7 +10780,7 @@ client.chat.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.
@@ -10536,7 +10788,7 @@ client.chat.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).
@@ -10544,7 +10796,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.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -10552,55 +10804,73 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
-
--
-**include_muted:** `typing.Optional[str]` β If true, will include muted issues
-
+client.accounting.bank_feed_accounts.create(...)
-
-**integration_name:** `typing.Optional[str]`
-
-
-
+#### π Description
-
-**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.
-
+Creates a `BankFeedAccount` object with the given values.
+
+
+#### π Usage
+
-
-**linked_account_id:** `typing.Optional[str]` β If provided, will only include issues pertaining to the linked account passed in.
-
+
+-
+
+```python
+from merge import Merge
+from merge.resources.accounting import BankFeedAccountRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.bank_feed_accounts.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=BankFeedAccountRequest(),
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+-
+
+**model:** `BankFeedAccountRequest`
@@ -10608,7 +10878,7 @@ client.chat.issues.list(
-
-**start_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred after this time
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -10616,12 +10886,7 @@ client.chat.issues.list(
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
-
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -10641,7 +10906,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-client.chat.issues.retrieve(...)
+client.accounting.bank_feed_accounts.retrieve(...)
-
@@ -10653,7 +10918,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Returns a `BankFeedAccount` object with the given `id`.
@@ -10674,8 +10939,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.issues.retrieve(
+client.accounting.bank_feed_accounts.retrieve(
id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -10700,6 +10967,22 @@ client.chat.issues.retrieve(
-
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -10712,8 +10995,7 @@ client.chat.issues.retrieve(
client.chat.link_token.create(...)
+client.accounting.bank_feed_accounts.meta_post_retrieve()
-
@@ -10725,7 +11007,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 metadata for `BankFeedAccount` POSTs.
@@ -10741,18 +11023,12 @@ 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],
-)
+client.accounting.bank_feed_accounts.meta_post_retrieve()
```
@@ -10768,31 +11044,91 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+client.accounting.bank_feed_transactions.list(...)
-
-**end_user_organization_name:** `str` β Your end user's organization.
-
+#### π Description
+
+
+-
+
+
+-
+
+Returns a list of `BankFeedTransaction` objects.
+
+
+
+#### π Usage
-
-**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.
-
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.bank_feed_transactions.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ is_processed=True,
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ page_size=1,
+ remote_id="remote_id",
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**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.
@@ -10800,7 +11136,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/.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -10808,7 +11144,7 @@ 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.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -10816,7 +11152,12 @@ client.chat.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.
+**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.
@@ -10824,7 +11165,7 @@ client.chat.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_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -10832,7 +11173,7 @@ client.chat.link_token.create(
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` β An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -10840,14 +11181,7 @@ client.chat.link_token.create(
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
- ]
-]` β When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -10855,12 +11189,7 @@ client.chat.link_token.create(
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
-
-The following subset of IETF language tags can be used to configure localization.
-
-* `en` - en
-* `de` - de
+**is_processed:** `typing.Optional[bool]` β If provided, will only return bank feed transactions with this is_processed value
@@ -10868,7 +11197,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_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -10876,7 +11205,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.
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -10884,11 +11213,15 @@ The following subset of IETF language tags can be used to configure localization
-
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]`
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
-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.
@@ -10908,8 +11241,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
client.chat.linked_accounts.list(...)
+client.accounting.bank_feed_transactions.create(...)
-
@@ -10921,7 +11253,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-
-List linked accounts for your organization.
+Creates a `BankFeedTransaction` object with the given values.
@@ -10937,28 +11269,16 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.chat.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
+from merge.resources.accounting import BankFeedTransactionRequestRequest
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",
- id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
+client.accounting.bank_feed_transactions.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=BankFeedTransactionRequestRequest(),
)
```
@@ -10975,19 +11295,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
+**model:** `BankFeedTransactionRequestRequest`
@@ -10995,7 +11303,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-**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.
@@ -11003,7 +11311,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.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -11011,31 +11319,72 @@ 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.
+
+
+
+
+
+client.accounting.bank_feed_transactions.retrieve(...)
-
-**end_user_origin_id:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given origin ID.
-
+#### π Description
+
+
+-
+
+
+-
+
+Returns a `BankFeedTransaction` object with the given `id`.
+
+
+#### π Usage
+
-
-**end_user_origin_ids:** `typing.Optional[str]` β Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.bank_feed_transactions.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**id:** `typing.Optional[str]`
+
+-
+
+**id:** `str`
@@ -11043,7 +11392,12 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-**ids:** `typing.Optional[str]` β Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+**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.
@@ -11051,7 +11405,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-**include_duplicates:** `typing.Optional[bool]` β If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -11059,7 +11413,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-**integration_name:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given integration name.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11067,27 +11421,64 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-**is_test_account:** `typing.Optional[str]` β If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+client.accounting.bank_feed_transactions.meta_post_retrieve()
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
-
+#### π Description
+
+
+-
+
+
+-
+
+Returns metadata for `BankFeedTransaction` POSTs.
+
+
+#### π Usage
+
-
-**status:** `typing.Optional[str]` β Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.bank_feed_transactions.meta_post_retrieve()
+
+```
+
+
+#### βοΈ Parameters
+
+
+-
+
-
@@ -11103,8 +11494,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
client.chat.messages.list(...)
+## Accounting CashFlowStatements
+client.accounting.cash_flow_statements.list(...)
-
@@ -11116,7 +11507,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-Returns a list of `Message` objects.
+Returns a list of `CashFlowStatement` objects.
@@ -11134,14 +11525,13 @@ 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",
+client.accounting.cash_flow_statements.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -11158,10 +11548,8 @@ client.chat.messages.list(
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",
)
```
@@ -11178,7 +11566,7 @@ client.chat.messages.list(
-
-**conversation_id:** `typing.Optional[str]` β Filter messages by conversation ID.
+**company_id:** `typing.Optional[str]` β If provided, will only return cash flow statements for this company.
@@ -11210,7 +11598,11 @@ client.chat.messages.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.
@@ -11218,7 +11610,7 @@ client.chat.messages.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/).
@@ -11226,7 +11618,7 @@ client.chat.messages.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.
@@ -11234,7 +11626,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.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11242,7 +11634,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 +11642,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.
@@ -11274,14 +11666,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 +11678,7 @@ client.chat.messages.list(
client.chat.messages.retrieve(...)
+client.accounting.cash_flow_statements.retrieve(...)
-
@@ -11306,7 +11690,7 @@ client.chat.messages.list(
-
-Returns a `Message` object with the given `id`.
+Returns a `CashFlowStatement` object with the given `id`.
@@ -11327,7 +11711,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.messages.retrieve(
+client.accounting.cash_flow_statements.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -11355,6 +11739,18 @@ client.chat.messages.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.
@@ -11383,7 +11779,8 @@ client.chat.messages.retrieve(
client.chat.messages.replies_list(...)
+## Accounting CompanyInfo
+client.accounting.company_info.list(...)
-
@@ -11395,7 +11792,7 @@ client.chat.messages.retrieve(
-
-Returns a list of `Message` objects.
+Returns a list of `CompanyInfo` objects.
@@ -11410,23 +11807,34 @@ Returns a list of `Message` objects.
-
```python
+import datetime
+
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",
+client.accounting.company_info.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,
- order_by=MessagesRepliesListRequestOrderBy.REMOTE_CREATED_AT_DESCENDING,
+ 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",
)
```
@@ -11443,7 +11851,7 @@ client.chat.messages.replies_list(
-
-**message_id:** `str`
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -11451,7 +11859,7 @@ client.chat.messages.replies_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.
@@ -11459,7 +11867,7 @@ client.chat.messages.replies_list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -11467,7 +11875,12 @@ client.chat.messages.replies_list(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**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.
@@ -11475,7 +11888,7 @@ client.chat.messages.replies_list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -11483,7 +11896,7 @@ 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.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -11491,7 +11904,7 @@ client.chat.messages.replies_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11499,75 +11912,39 @@ client.chat.messages.replies_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.chat.passthrough.create(...)
-
-#### π Description
-
-
--
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
-
-Pull data from an endpoint not currently supported by Merge.
-
-
+**name:** `typing.Optional[str]` β If provided, will only return CompanyInfo objects with this name.
+
-#### π Usage
-
-
-
--
-
-```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",
- ),
-)
-
-```
-
-
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
-#### βοΈ Parameters
-
-
--
-
-
-**request:** `DataPassthroughRequest`
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -11587,8 +11964,7 @@ client.chat.passthrough.create(
client.chat.regenerate_key.create(...)
+client.accounting.company_info.retrieve(...)
-
@@ -11600,7 +11976,7 @@ client.chat.passthrough.create(
-
-Exchange remote keys.
+Returns a `CompanyInfo` object with the given `id`.
@@ -11621,8 +11997,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.regenerate_key.create(
- name="Remote Deployment Key 1",
+client.accounting.company_info.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -11639,7 +12017,7 @@ client.chat.regenerate_key.create(
-
-**name:** `str` β The name of the remote key
+**id:** `str`
@@ -11647,72 +12025,20 @@ client.chat.regenerate_key.create(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**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.
-
-
-
-
-
-
-client.chat.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.chat.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
-)
-
-```
-
-
-
-
-
-#### βοΈ 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.
@@ -11720,7 +12046,7 @@ client.chat.sync_status.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11740,8 +12066,8 @@ client.chat.sync_status.list(
client.chat.force_resync.sync_status_resync_create()
+## Accounting Contacts
+client.accounting.contacts.list(...)
-
@@ -11753,7 +12079,7 @@ client.chat.sync_status.list(
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+Returns a list of `Contact` objects.
@@ -11768,13 +12094,44 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
-
```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.force_resync.sync_status_resync_create()
+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,
+)
```
@@ -11790,90 +12147,84 @@ client.chat.force_resync.sync_status_resync_create()
-
-**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.users.list(...)
-
-#### π Description
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+
+
+
-
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
-
-Returns a list of `User` objects.
-
-
+**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
-import datetime
-
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.chat.users.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
-
-```
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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.
+
-#### βοΈ Parameters
-
-
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11881,7 +12232,7 @@ client.chat.users.list(
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+**is_customer:** `typing.Optional[str]` β If provided, will only return Contacts that are denoted as customers.
@@ -11889,7 +12240,7 @@ client.chat.users.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**is_supplier:** `typing.Optional[str]` β If provided, will only return Contacts that are denoted as suppliers.
@@ -11897,7 +12248,7 @@ 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.
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -11905,7 +12256,7 @@ client.chat.users.list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -11913,7 +12264,7 @@ client.chat.users.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 Contacts that match this name.
@@ -11921,7 +12272,7 @@ client.chat.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).
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -11929,7 +12280,7 @@ client.chat.users.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[typing.Literal["status"]]` β Deprecated. Use show_enum_origins.
@@ -11937,7 +12288,7 @@ client.chat.users.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.
@@ -11945,7 +12296,7 @@ client.chat.users.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**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)
@@ -11953,7 +12304,7 @@ client.chat.users.list(
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+**status:** `typing.Optional[ContactsListRequestStatus]` β If provided, will only return Contacts that match this status.
@@ -11973,7 +12324,7 @@ client.chat.users.list(
client.chat.users.retrieve(...)
+client.accounting.contacts.create(...)
-
@@ -11985,7 +12336,7 @@ client.chat.users.list(
-
-Returns a `User` object with the given `id`.
+Creates a `Contact` object with the given values.
@@ -12001,15 +12352,16 @@ Returns a `User` object with the given `id`.
```python
from merge import Merge
+from merge.resources.accounting import ContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.users.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.accounting.contacts.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=ContactRequest(),
)
```
@@ -12026,15 +12378,7 @@ client.chat.users.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["groups"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**model:** `ContactRequest`
@@ -12042,7 +12386,7 @@ client.chat.users.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -12050,7 +12394,7 @@ client.chat.users.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -12070,8 +12414,7 @@ client.chat.users.retrieve(
client.chat.webhook_receivers.list()
+client.accounting.contacts.retrieve(...)
-
@@ -12083,7 +12426,7 @@ client.chat.users.retrieve(
-
-Returns a list of `WebhookReceiver` objects.
+Returns a `Contact` object with the given `id`.
@@ -12104,7 +12447,12 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.webhook_receivers.list()
+client.accounting.contacts.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
```
@@ -12120,6 +12468,67 @@ client.chat.webhook_receivers.list()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ ContactsRetrieveRequestExpandItem,
+ typing.Sequence[ContactsRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**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).
+
+
+
+
+
+-
+
+**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.
@@ -12132,7 +12541,7 @@ client.chat.webhook_receivers.list()
client.chat.webhook_receivers.create(...)
+client.accounting.contacts.partial_update(...)
-
@@ -12144,7 +12553,7 @@ client.chat.webhook_receivers.list()
-
-Creates a `WebhookReceiver` object with the given values.
+Updates a `Contact` object with the given `id`.
@@ -12160,14 +12569,17 @@ Creates a `WebhookReceiver` object with the given values.
```python
from merge import Merge
+from merge.resources.accounting import PatchedContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.webhook_receivers.create(
- event="event",
- is_active=True,
+client.accounting.contacts.partial_update(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedContactRequest(),
)
```
@@ -12184,7 +12596,7 @@ client.chat.webhook_receivers.create(
-
-**event:** `str`
+**id:** `str`
@@ -12192,7 +12604,7 @@ client.chat.webhook_receivers.create(
-
-**is_active:** `bool`
+**model:** `PatchedContactRequest`
@@ -12200,7 +12612,15 @@ client.chat.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**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.
@@ -12220,8 +12640,7 @@ client.chat.webhook_receivers.create(
client.crm.account_details.retrieve()
+client.accounting.contacts.meta_patch_retrieve(...)
-
@@ -12233,7 +12652,7 @@ client.chat.webhook_receivers.create(
-
-Get details for a linked account.
+Returns metadata for `Contact` PATCHs.
@@ -12254,7 +12673,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.account_details.retrieve()
+client.accounting.contacts.meta_patch_retrieve(
+ id="id",
+)
```
@@ -12270,6 +12691,14 @@ client.crm.account_details.retrieve()
-
+**id:** `str`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -12282,8 +12711,7 @@ client.crm.account_details.retrieve()
client.crm.account_token.retrieve(...)
+client.accounting.contacts.meta_post_retrieve()
-
@@ -12295,7 +12723,7 @@ client.crm.account_details.retrieve()
-
-Returns the account token for the end user with the provided public token.
+Returns metadata for `Contact` POSTs.
@@ -12316,9 +12744,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.account_token.retrieve(
- public_token="public_token",
-)
+client.accounting.contacts.meta_post_retrieve()
```
@@ -12334,14 +12760,6 @@ client.crm.account_token.retrieve(
-
-**public_token:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -12354,8 +12772,7 @@ client.crm.account_token.retrieve(
client.crm.accounts.list(...)
+client.accounting.contacts.remote_field_classes_list(...)
-
@@ -12367,7 +12784,7 @@ client.crm.account_token.retrieve(
-
-Returns a list of `Account` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -12382,36 +12799,20 @@ 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",
- ),
+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,
- 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",
+ is_common_model_field=True,
+ is_custom=True,
page_size=1,
- remote_id="remote_id",
)
```
@@ -12428,7 +12829,7 @@ client.crm.accounts.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -12436,7 +12837,7 @@ client.crm.accounts.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/).
@@ -12444,7 +12845,7 @@ client.crm.accounts.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.
@@ -12452,7 +12853,7 @@ client.crm.accounts.list(
-
-**expand:** `typing.Optional[typing.Literal["owner"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12460,7 +12861,7 @@ client.crm.accounts.list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
@@ -12468,7 +12869,7 @@ client.crm.accounts.list(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
@@ -12476,7 +12877,7 @@ client.crm.accounts.list(
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -12484,31 +12885,103 @@ client.crm.accounts.list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+client.accounting.credit_notes.list(...)
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
+#### π Description
+
+
+-
+
+
+-
+
+Returns a list of `CreditNote` objects.
+
+
+#### π Usage
+
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
-
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+from merge.resources.accounting.resources.credit_notes import (
+ CreditNotesListRequestRemoteFields,
+ CreditNotesListRequestShowEnumOrigins,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+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",
+ ),
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**name:** `typing.Optional[str]` β If provided, will only return accounts with this name.
+
+-
+
+**company_id:** `typing.Optional[str]` β If provided, will only return credit notes for this company.
@@ -12516,7 +12989,7 @@ client.crm.accounts.list(
-
-**owner_id:** `typing.Optional[str]` β If provided, will only return accounts with this owner.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -12524,7 +12997,7 @@ client.crm.accounts.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -12532,7 +13005,7 @@ client.crm.accounts.list(
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -12540,73 +13013,84 @@ client.crm.accounts.list(
-
-**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.create(...)
-
-#### π 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).
+
+
+
+
-
-Creates an `Account` object with the given values.
-
-
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+
-#### π Usage
-
-
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
-
-```python
-from merge import Merge
-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(),
-)
-
-```
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+-
+
+**remote_fields:** `typing.Optional[CreditNotesListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+
-#### βοΈ Parameters
-
-
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
+
+
+
-
-**model:** `AccountRequest`
+**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)
@@ -12614,7 +13098,7 @@ client.crm.accounts.create(
-
-**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.
@@ -12622,7 +13106,7 @@ client.crm.accounts.create(
-
-**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.
@@ -12642,7 +13126,7 @@ client.crm.accounts.create(
client.crm.accounts.retrieve(...)
+client.accounting.credit_notes.create(...)
-
@@ -12654,7 +13138,7 @@ client.crm.accounts.create(
-
-Returns an `Account` object with the given `id`.
+Creates a `CreditNote` object with the given values.
@@ -12670,16 +13154,16 @@ Returns an `Account` object with the given `id`.
```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.retrieve(
- id="id",
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
+client.accounting.credit_notes.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=CreditNoteRequest(),
)
```
@@ -12696,23 +13180,7 @@ client.crm.accounts.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["owner"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**model:** `CreditNoteRequest`
@@ -12720,7 +13188,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.
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -12728,7 +13196,7 @@ client.crm.accounts.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -12748,7 +13216,7 @@ client.crm.accounts.retrieve(
client.crm.accounts.partial_update(...)
+client.accounting.credit_notes.retrieve(...)
-
@@ -12760,7 +13228,7 @@ client.crm.accounts.retrieve(
-
-Updates an `Account` object with the given `id`.
+Returns a `CreditNote` object with the given `id`.
@@ -12776,17 +13244,21 @@ Updates an `Account` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm import PatchedAccountRequest
+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.partial_update(
+client.accounting.credit_notes.retrieve(
id="id",
- is_debug_mode=True,
- run_async=True,
- model=PatchedAccountRequest(),
+ include_remote_data=True,
+ include_shell_data=True,
+ remote_fields=CreditNotesRetrieveRequestRemoteFields.STATUS,
+ show_enum_origins=CreditNotesRetrieveRequestShowEnumOrigins.STATUS,
)
```
@@ -12811,7 +13283,12 @@ client.crm.accounts.partial_update(
-
-**model:** `PatchedAccountRequest`
+**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.
@@ -12819,7 +13296,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.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -12827,7 +13304,23 @@ client.crm.accounts.partial_update(
-
-**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[CreditNotesRetrieveRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**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)
@@ -12847,7 +13340,7 @@ client.crm.accounts.partial_update(
client.crm.accounts.meta_patch_retrieve(...)
+client.accounting.credit_notes.partial_update(...)
-
@@ -12859,7 +13352,7 @@ client.crm.accounts.partial_update(
-
-Returns metadata for `CRMAccount` PATCHs.
+Updates a `CreditNote` object with the given `id`.
@@ -12875,13 +13368,17 @@ Returns metadata for `CRMAccount` PATCHs.
```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_patch_retrieve(
+client.accounting.credit_notes.partial_update(
id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=CreditNoteRequest(),
)
```
@@ -12906,64 +13403,27 @@ client.crm.accounts.meta_patch_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**model:** `CreditNoteRequest`
-
-
-
-
-
-
-client.crm.accounts.meta_post_retrieve()
-
--
-
-#### π Description
-
-
--
-
-Returns metadata for `CRMAccount` POSTs.
-
-
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
+
-#### π Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.accounts.meta_post_retrieve()
-
-```
-
-
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
+
-#### βοΈ Parameters
-
-
--
-
-
@@ -12979,7 +13439,7 @@ client.crm.accounts.meta_post_retrieve()
client.crm.accounts.remote_field_classes_list(...)
+client.accounting.credit_notes.application_create(...)
-
@@ -12991,7 +13451,7 @@ client.crm.accounts.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Creates a new CreditNoteApplyLine to apply a credit note to an invoice
@@ -13006,21 +13466,22 @@ 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.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,
+client.accounting.credit_notes.application_create(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ applied_date=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ applied_amount="applied_amount",
)
```
@@ -13037,23 +13498,7 @@ client.crm.accounts.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.
+**id:** `str`
@@ -13061,7 +13506,7 @@ client.crm.accounts.remote_field_classes_list(
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**applied_date:** `dt.datetime` β Date that the credit note is applied to the invoice.
@@ -13069,7 +13514,7 @@ client.crm.accounts.remote_field_classes_list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**applied_amount:** `str` β The amount of credit applied to the invoice.
@@ -13077,7 +13522,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_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -13085,7 +13530,7 @@ client.crm.accounts.remote_field_classes_list(
-
-**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -13093,7 +13538,7 @@ client.crm.accounts.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**invoice:** `typing.Optional[str]` β The invoice to apply the credit note to.
@@ -13113,8 +13558,7 @@ client.crm.accounts.remote_field_classes_list(
client.crm.async_passthrough.create(...)
+client.accounting.credit_notes.meta_patch_retrieve(...)
-
@@ -13126,7 +13570,7 @@ client.crm.accounts.remote_field_classes_list(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns metadata for `CreditNote` PATCHs.
@@ -13142,17 +13586,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.crm import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.async_passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+client.accounting.credit_notes.meta_patch_retrieve(
+ id="id",
)
```
@@ -13169,7 +13609,7 @@ client.crm.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**id:** `str`
@@ -13189,7 +13629,7 @@ client.crm.async_passthrough.create(
client.crm.async_passthrough.retrieve(...)
+client.accounting.credit_notes.meta_post_retrieve()
-
@@ -13201,7 +13641,7 @@ client.crm.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns metadata for `CreditNote` POSTs.
@@ -13222,9 +13662,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.credit_notes.meta_post_retrieve()
```
@@ -13240,10 +13678,64 @@ client.crm.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+client.accounting.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.accounting.scopes.default_scopes_retrieve()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
-
@@ -13260,8 +13752,7 @@ client.crm.async_passthrough.retrieve(
client.crm.audit_trail.list(...)
+client.accounting.scopes.linked_account_scopes_retrieve()
-
@@ -13273,7 +13764,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 +13785,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 +13801,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 +13913,8 @@ client.crm.audit_trail.list(
client.crm.available_actions.retrieve()
+## Accounting DeleteAccount
+client.accounting.delete_account.delete()
-
@@ -13390,7 +13926,7 @@ client.crm.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Delete a linked account.
@@ -13411,7 +13947,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 +13975,8 @@ client.crm.available_actions.retrieve()
client.crm.contacts.list(...)
+## Accounting Employees
+client.accounting.employees.list(...)
-
@@ -13452,7 +13988,7 @@ client.crm.available_actions.retrieve()
-
-Returns a list of `Contact` objects.
+Returns a list of `Employee` objects.
@@ -13470,14 +14006,13 @@ Returns a list of `Contact` objects.
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",
+client.accounting.employees.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -13485,11 +14020,8 @@ client.crm.contacts.list(
"2024-01-15 09:30:00+00:00",
),
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",
@@ -13498,7 +14030,6 @@ client.crm.contacts.list(
"2024-01-15 09:30:00+00:00",
),
page_size=1,
- phone_numbers="phone_numbers",
remote_id="remote_id",
)
@@ -13516,7 +14047,7 @@ client.crm.contacts.list(
-
-**account_id:** `typing.Optional[str]` β If provided, will only return contacts with this account.
+**company_id:** `typing.Optional[str]` β If provided, will only return employees for this company.
@@ -13548,15 +14079,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 +14107,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).
@@ -13612,15 +14131,7 @@ client.crm.contacts.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
-
-
-
-
--
-
-**phone_numbers:** `typing.Optional[str]` β If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -13648,7 +14159,7 @@ client.crm.contacts.list(
client.crm.contacts.create(...)
+client.accounting.employees.retrieve(...)
-
@@ -13660,7 +14171,7 @@ client.crm.contacts.list(
-
-Creates a `Contact` object with the given values.
+Returns an `Employee` object with the given `id`.
@@ -13676,16 +14187,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 +14212,7 @@ client.crm.contacts.create(
-
-**model:** `ContactRequest`
+**id:** `str`
@@ -13710,7 +14220,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 +14232,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 +14260,8 @@ client.crm.contacts.create(
client.crm.contacts.retrieve(...)
+## Accounting ExpenseReports
+client.accounting.expense_reports.list(...)
-
@@ -13750,7 +14273,7 @@ client.crm.contacts.create(
-
-Returns a `Contact` object with the given `id`.
+Returns a list of `ExpenseReport` objects.
@@ -13765,19 +14288,35 @@ 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,
+client.accounting.expense_reports.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",
)
```
@@ -13794,7 +14333,7 @@ client.crm.contacts.retrieve(
-
-**id:** `str`
+**company_id:** `typing.Optional[str]` β If provided, will only return expense reports for this company.
@@ -13802,7 +14341,44 @@ 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.
+
+
+
+
+
+-
+
+**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.Union[
+ ExpenseReportsListRequestExpandItem,
+ typing.Sequence[ExpenseReportsListRequestExpandItem],
+ ]
+]` β 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/).
@@ -13834,6 +14410,38 @@ client.crm.contacts.retrieve(
-
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -13846,7 +14454,7 @@ client.crm.contacts.retrieve(
client.crm.contacts.partial_update(...)
+client.accounting.expense_reports.create(...)
-
@@ -13858,7 +14466,7 @@ client.crm.contacts.retrieve(
-
-Updates a `Contact` object with the given `id`.
+Creates an `ExpenseReport` object with the given values.
@@ -13874,17 +14482,21 @@ Updates a `Contact` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm import PatchedContactRequest
+from merge.resources.accounting import ExpenseReportRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.partial_update(
- id="id",
+client.accounting.expense_reports.create(
is_debug_mode=True,
run_async=True,
- model=PatchedContactRequest(),
+ model=ExpenseReportRequest(
+ tracking_categories=[
+ "a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d",
+ "d4c3b2a1-9e8f-7g6h-5i4j-3k2l1m0n9o8p",
+ ],
+ ),
)
```
@@ -13901,15 +14513,7 @@ client.crm.contacts.partial_update(
-
-**id:** `str`
-
-
-
-
-
--
-
-**model:** `PatchedContactRequest`
+**model:** `ExpenseReportRequest`
@@ -13945,7 +14549,7 @@ client.crm.contacts.partial_update(
client.crm.contacts.ignore_create(...)
+client.accounting.expense_reports.lines_list(...)
-
@@ -13957,7 +14561,7 @@ client.crm.contacts.partial_update(
-
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+Returns a list of `ExpenseReportLine` objects that point to a `ExpenseReport` with the given id.
@@ -13973,17 +14577,19 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```python
from merge import Merge
-from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.ignore_create(
- model_id="model_id",
- request=IgnoreCommonModelRequest(
- reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
- ),
+client.accounting.expense_reports.lines_list(
+ expense_report_id="expense_report_id",
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+ page_size=1,
)
```
@@ -14000,7 +14606,7 @@ client.crm.contacts.ignore_create(
-
-**model_id:** `str`
+**expense_report_id:** `str`
@@ -14008,7 +14614,60 @@ client.crm.contacts.ignore_create(
-
-**request:** `IgnoreCommonModelRequest`
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ ExpenseReportsLinesListRequestExpandItem,
+ typing.Sequence[ExpenseReportsLinesListRequestExpandItem],
+ ]
+]` β 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).
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -14028,7 +14687,7 @@ client.crm.contacts.ignore_create(
client.crm.contacts.meta_patch_retrieve(...)
+client.accounting.expense_reports.retrieve(...)
-
@@ -14040,7 +14699,7 @@ client.crm.contacts.ignore_create(
-
-Returns metadata for `CRMContact` PATCHs.
+Returns an `ExpenseReport` object with the given `id`.
@@ -14061,8 +14720,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.meta_patch_retrieve(
+client.accounting.expense_reports.retrieve(
id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
)
```
@@ -14087,64 +14749,40 @@ client.crm.contacts.meta_patch_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**expand:** `typing.Optional[
+ typing.Union[
+ ExpenseReportsRetrieveRequestExpandItem,
+ typing.Sequence[ExpenseReportsRetrieveRequestExpandItem],
+ ]
+]` β 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 +14798,7 @@ client.crm.contacts.meta_post_retrieve()
client.crm.contacts.remote_field_classes_list(...)
+client.accounting.expense_reports.lines_remote_field_classes_list(...)
-
@@ -14193,11 +14831,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.remote_field_classes_list(
+client.accounting.expense_reports.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,
@@ -14242,14 +14879,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).
@@ -14274,7 +14903,7 @@ client.crm.contacts.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -14294,8 +14923,7 @@ client.crm.contacts.remote_field_classes_list(
client.crm.custom_object_classes.list(...)
+client.accounting.expense_reports.meta_post_retrieve()
-
@@ -14307,7 +14935,7 @@ client.crm.contacts.remote_field_classes_list(
-
-Returns a list of `CustomObjectClass` objects.
+Returns metadata for `ExpenseReport` POSTs.
@@ -14322,34 +14950,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.expense_reports.meta_post_retrieve()
```
@@ -14365,94 +14972,6 @@ client.crm.custom_object_classes.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["fields"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**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.
@@ -14465,7 +14984,7 @@ client.crm.custom_object_classes.list(
client.crm.custom_object_classes.retrieve(...)
+client.accounting.expense_reports.remote_field_classes_list(...)
-
@@ -14477,7 +14996,7 @@ client.crm.custom_object_classes.list(
-
-Returns a `CustomObjectClass` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -14498,10 +15017,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.custom_object_classes.retrieve(
- id="id",
+client.accounting.expense_reports.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,
)
```
@@ -14518,7 +15041,7 @@ client.crm.custom_object_classes.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -14526,7 +15049,7 @@ client.crm.custom_object_classes.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["fields"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -14550,6 +15073,30 @@ client.crm.custom_object_classes.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. The maximum limit is 100.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -14562,8 +15109,8 @@ client.crm.custom_object_classes.retrieve(
client.crm.association_types.custom_object_classes_association_types_list(...)
+## Accounting Expenses
+client.accounting.expenses.list(...)
-
@@ -14575,7 +15122,7 @@ client.crm.custom_object_classes.retrieve(
-
-Returns a list of `AssociationType` objects.
+Returns a list of `Expense` objects.
@@ -14598,8 +15145,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.association_types.custom_object_classes_association_types_list(
- custom_object_class_id="custom_object_class_id",
+client.accounting.expenses.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -14609,6 +15156,7 @@ client.crm.association_types.custom_object_classes_association_types_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",
@@ -14618,6 +15166,12 @@ client.crm.association_types.custom_object_classes_association_types_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",
+ ),
)
```
@@ -14634,7 +15188,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**custom_object_class_id:** `str`
+**company_id:** `typing.Optional[str]` β If provided, will only return expenses for this company.
@@ -14666,7 +15220,12 @@ 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.
+**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.
@@ -14690,6 +15249,14 @@ client.crm.association_types.custom_object_classes_association_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).
@@ -14714,7 +15281,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -14730,6 +15297,22 @@ client.crm.association_types.custom_object_classes_association_types_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.
@@ -14742,7 +15325,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
client.crm.association_types.custom_object_classes_association_types_create(...)
+client.accounting.expenses.create(...)
-
@@ -14754,7 +15337,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-Creates an `AssociationType` object with the given values.
+Creates an `Expense` object with the given values.
@@ -14770,33 +15353,16 @@ Creates an `AssociationType` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import (
- AssociationTypeRequestRequest,
- ObjectClassDescriptionRequest,
- OriginTypeEnum,
-)
+from merge.resources.accounting import ExpenseRequest
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",
+client.accounting.expenses.create(
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",
- ),
+ model=ExpenseRequest(),
)
```
@@ -14813,15 +15379,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
-**custom_object_class_id:** `str`
-
-
-
-
-
--
-
-**model:** `AssociationTypeRequestRequest`
+**model:** `ExpenseRequest`
@@ -14857,7 +15415,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
client.crm.association_types.custom_object_classes_association_types_retrieve(...)
+client.accounting.expenses.retrieve(...)
-
@@ -14869,7 +15427,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
-Returns an `AssociationType` object with the given `id`.
+Returns an `Expense` object with the given `id`.
@@ -14890,10 +15448,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.association_types.custom_object_classes_association_types_retrieve(
- custom_object_class_id="custom_object_class_id",
+client.accounting.expenses.retrieve(
id="id",
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
)
@@ -14911,7 +15469,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
-**custom_object_class_id:** `str`
+**id:** `str`
@@ -14919,7 +15477,12 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
-**id:** `str`
+**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.
@@ -14927,7 +15490,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
-**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -14935,7 +15498,7 @@ 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.
+**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.
@@ -14963,7 +15526,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.expenses.bulk_create(...)
-
@@ -14975,7 +15538,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
-Returns metadata for `CRMAssociationType` POSTs.
+Creates multiple `Expense` objects with the given values.
@@ -14991,13 +15554,19 @@ Returns metadata for `CRMAssociationType` POSTs.
```python
from merge import Merge
+from merge.resources.accounting import ExpenseBatchItemRequest, ExpenseRequest
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.expenses.bulk_create(
+ batch_items=[
+ ExpenseBatchItemRequest(
+ item_id="item_id",
+ payload=ExpenseRequest(),
+ )
+ ],
)
```
@@ -15014,7 +15583,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-
-**custom_object_class_id:** `str`
+**batch_items:** `typing.Sequence[ExpenseBatchItemRequest]`
@@ -15034,8 +15603,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
+client.accounting.expenses.bulk_retrieve(...)
-
@@ -15047,7 +15615,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-
-Returns a list of `CustomObject` objects.
+Returns the status and results of an `Expense` bulk create batch.
@@ -15062,35 +15630,14 @@ Returns a list of `CustomObject` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.custom_objects.custom_object_classes_custom_objects_list(
- custom_object_class_id="custom_object_class_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.accounting.expenses.bulk_retrieve(
+ batch_id="batch_id",
)
```
@@ -15107,7 +15654,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**custom_object_class_id:** `str`
+**batch_id:** `str`
@@ -15115,39 +15662,76 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**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.lines_remote_field_classes_list(...)
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
+#### π Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+#### π Usage
+
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.expenses.lines_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,
+)
+
+```
+
+
+
+#### βοΈ 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.
@@ -15155,7 +15739,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_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -15163,7 +15747,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15171,7 +15755,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15179,7 +15763,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
@@ -15187,7 +15771,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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
@@ -15195,7 +15779,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -15215,7 +15799,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
+client.accounting.expenses.meta_post_retrieve()
-
@@ -15227,7 +15811,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-Creates a `CustomObject` object with the given values.
+Returns metadata for `Expense` POSTs.
@@ -15243,20 +15827,12 @@ 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.expenses.meta_post_retrieve()
```
@@ -15272,38 +15848,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
-**custom_object_class_id:** `str`
-
-
-
-
-
--
-
-**model:** `CustomObjectRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -15316,7 +15860,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
+client.accounting.expenses.remote_field_classes_list(...)
-
@@ -15328,7 +15872,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
-Returns a `CustomObject` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -15349,12 +15893,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
- custom_object_class_id="custom_object_class_id",
- id="id",
+client.accounting.expenses.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,
)
```
@@ -15371,7 +15917,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
-**custom_object_class_id:** `str`
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -15379,7 +15925,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
-**id:** `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/).
@@ -15395,7 +15941,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15403,7 +15949,23 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**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. The maximum limit is 100.
@@ -15423,7 +15985,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
+## Accounting FieldMapping
+client.accounting.field_mapping.field_mappings_retrieve(...)
-
@@ -15435,7 +15998,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
-Returns metadata for `CRMCustomObject` 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/).
@@ -15456,8 +16019,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(
- custom_object_class_id="custom_object_class_id",
+client.accounting.field_mapping.field_mappings_retrieve(
+ exclude_remote_field_metadata=True,
)
```
@@ -15474,7 +16037,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
-**custom_object_class_id:** `str`
+**exclude_remote_field_metadata:** `typing.Optional[bool]` β If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -15494,7 +16057,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.field_mapping.field_mappings_create(...)
-
@@ -15506,7 +16069,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
-Returns a list of `RemoteFieldClass` objects.
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -15527,15 +16090,15 @@ 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,
- 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.field_mapping.field_mappings_create(
+ exclude_remote_field_metadata=True,
+ remote_data_iteration_count=1,
+ 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",
)
```
@@ -15552,7 +16115,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**target_field_name:** `str` β The name of the target field you want this remote field to map to.
@@ -15560,7 +16123,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**target_field_description:** `str` β The description of the target field you want this remote field to map to.
@@ -15568,7 +16131,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**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.
@@ -15576,7 +16139,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**remote_method:** `str` β The method of the remote endpoint where the remote field is coming from.
@@ -15584,7 +16147,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**remote_url_path:** `str` β The path of the remote endpoint where the remote field is coming from.
@@ -15592,7 +16155,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
+**common_model_name:** `str` β The name of the Common Model that the remote field corresponds to in a given category.
@@ -15600,7 +16163,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
+**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.
@@ -15608,7 +16171,23 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**remote_data_iteration_count:** `typing.Optional[int]` β Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.
+
+
+
+
+
+-
+
+**jmes_path:** `typing.Optional[str]` β DEPRECATED: Use 'advanced_mapping_expression' instead.
+
+
+
+
+
+-
+
+**advanced_mapping_expression:** `typing.Optional[str]` β A JSONata expression used to transform the remote field data.
@@ -15628,8 +16207,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
+client.accounting.field_mapping.field_mappings_destroy(...)
-
@@ -15641,7 +16219,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-Returns a list of `Association` objects.
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -15656,36 +16234,14 @@ Returns a list of `Association` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.associations.custom_object_classes_custom_objects_associations_list(
- custom_object_class_id="custom_object_class_id",
- object_id="object_id",
- association_type_id="association_type_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.accounting.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
)
```
@@ -15702,7 +16258,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**custom_object_class_id:** `str`
+**field_mapping_id:** `str`
@@ -15710,55 +16266,71 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**object_id:** `str`
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
-
--
-**association_type_id:** `typing.Optional[str]` β If provided, will only return opportunities with this association_type.
-
+client.accounting.field_mapping.field_mappings_partial_update(...)
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
-
-
-
+#### π Description
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
-
-
-
-
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
+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
+
-
-**expand:** `typing.Optional[typing.Literal["association_type"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
+ remote_data_iteration_count=1,
+)
+
+```
+
+
+
+#### βοΈ 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/).
+
+-
+
+**field_mapping_id:** `str`
@@ -15766,7 +16338,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**remote_data_iteration_count:** `typing.Optional[int]` β Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.
@@ -15774,7 +16346,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).
+**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.
@@ -15782,7 +16354,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.
+**remote_method:** `typing.Optional[str]` β The method of the remote endpoint where the remote field is coming from.
@@ -15790,7 +16362,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.
+**remote_url_path:** `typing.Optional[str]` β The path of the remote endpoint where the remote field is coming from.
@@ -15798,7 +16370,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**jmes_path:** `typing.Optional[str]` β DEPRECATED: Use 'advanced_mapping_expression' instead.
@@ -15806,7 +16378,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.
+**advanced_mapping_expression:** `typing.Optional[str]` β A JSONata expression used to transform the remote field data.
@@ -15826,7 +16398,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
+client.accounting.field_mapping.remote_fields_retrieve(...)
-
@@ -15838,7 +16410,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
+Get 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/).
@@ -15859,14 +16431,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.associations.custom_object_classes_custom_objects_associations_update(
- source_class_id="source_class_id",
- source_object_id="source_object_id",
- target_class_id="target_class_id",
- target_object_id="target_object_id",
- association_type_id="association_type_id",
- is_debug_mode=True,
- run_async=True,
+client.accounting.field_mapping.remote_fields_retrieve(
+ common_models="common_models",
+ include_example_values="include_example_values",
)
```
@@ -15883,47 +16450,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**source_class_id:** `str`
-
-
-
-
-
--
-
-**source_object_id:** `str`
-
-
-
-
-
--
-
-**target_class_id:** `str`
-
-
-
-
-
--
-
-**target_object_id:** `str`
-
-
-
-
-
--
-
-**association_type_id:** `str`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
+**common_models:** `typing.Optional[str]` β A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -15931,7 +16458,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
+**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.
@@ -15951,8 +16478,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
client.crm.scopes.default_scopes_retrieve()
+client.accounting.field_mapping.target_fields_retrieve()
-
@@ -15964,7 +16490,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+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/).
@@ -15985,7 +16511,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.scopes.default_scopes_retrieve()
+client.accounting.field_mapping.target_fields_retrieve()
```
@@ -16013,7 +16539,8 @@ client.crm.scopes.default_scopes_retrieve()
client.crm.scopes.linked_account_scopes_retrieve()
+## Accounting GeneralLedgerTransactions
+client.accounting.general_ledger_transactions.list(...)
-
@@ -16025,7 +16552,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 a list of `GeneralLedgerTransaction` objects.
@@ -16040,13 +16567,41 @@ 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.crm.scopes.linked_account_scopes_retrieve()
+client.accounting.general_ledger_transactions.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,
+ 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",
+)
```
@@ -16062,6 +16617,123 @@ client.crm.scopes.linked_account_scopes_retrieve()
-
+**company_id:** `typing.Optional[str]` β If provided, will only return general ledger transactions for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**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.Union[
+ GeneralLedgerTransactionsListRequestExpandItem,
+ typing.Sequence[GeneralLedgerTransactionsListRequestExpandItem],
+ ]
+]` β 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.
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -16074,7 +16746,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
client.crm.scopes.linked_account_scopes_create(...)
+client.accounting.general_ledger_transactions.retrieve(...)
-
@@ -16086,7 +16758,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+Returns a `GeneralLedgerTransaction` object with the given `id`.
@@ -16102,42 +16774,15 @@ Update permissions for any Common Model or field for a single Linked Account. An
```python
from merge import Merge
-from merge.resources.crm import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.scopes.linked_account_scopes_create(
- common_models=[
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Employee",
- model_permissions={
- "READ": ModelPermissionDeserializerRequest(
- is_enabled=True,
- ),
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- ),
- },
- field_permissions=FieldPermissionDeserializerRequest(
- enabled_fields=["avatar", "home_location"],
- disabled_fields=["work_location"],
- ),
- ),
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Benefit",
- model_permissions={
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- )
- },
- ),
- ],
+client.accounting.general_ledger_transactions.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -16154,7 +16799,36 @@ client.crm.scopes.linked_account_scopes_create(
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β The common models you want to update the scopes for
+**id:** `str`
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**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).
@@ -16174,8 +16848,8 @@ client.crm.scopes.linked_account_scopes_create(
client.crm.delete_account.delete()
+## Accounting GenerateKey
+client.accounting.generate_key.create(...)
-
@@ -16187,7 +16861,7 @@ client.crm.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Create a remote key.
@@ -16208,7 +16882,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.delete_account.delete()
+client.accounting.generate_key.create(
+ name="Remote Deployment Key 1",
+)
```
@@ -16224,6 +16900,14 @@ client.crm.delete_account.delete()
-
+**name:** `str` β The name of the remote key
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -16236,8 +16920,8 @@ client.crm.delete_account.delete()
client.crm.engagement_types.list(...)
+## Accounting IncomeStatements
+client.accounting.income_statements.list(...)
-
@@ -16249,7 +16933,7 @@ client.crm.delete_account.delete()
-
-Returns a list of `EngagementType` objects.
+Returns a list of `IncomeStatement` objects.
@@ -16272,7 +16956,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagement_types.list(
+client.accounting.income_statements.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -16282,7 +16967,6 @@ client.crm.engagement_types.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",
@@ -16308,6 +16992,14 @@ client.crm.engagement_types.list(
-
+**company_id:** `typing.Optional[str]` β If provided, will only return income statements for this company.
+
+
+
+
+
+-
+
**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -16332,7 +17024,11 @@ client.crm.engagement_types.list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**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.
@@ -16340,7 +17036,7 @@ client.crm.engagement_types.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/).
@@ -16348,7 +17044,7 @@ 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_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -16380,7 +17076,7 @@ client.crm.engagement_types.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -16408,7 +17104,7 @@ client.crm.engagement_types.list(
client.crm.engagement_types.retrieve(...)
+client.accounting.income_statements.retrieve(...)
-
@@ -16420,7 +17116,7 @@ client.crm.engagement_types.list(
-
-Returns an `EngagementType` object with the given `id`.
+Returns an `IncomeStatement` object with the given `id`.
@@ -16441,10 +17137,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagement_types.retrieve(
+client.accounting.income_statements.retrieve(
id="id",
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
)
@@ -16470,7 +17165,11 @@ 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.
+**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.
@@ -16478,7 +17177,7 @@ client.crm.engagement_types.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.
@@ -16506,7 +17205,8 @@ client.crm.engagement_types.retrieve(
client.crm.engagement_types.remote_field_classes_list(...)
+## Accounting Invoices
+client.accounting.invoices.list(...)
-
@@ -16518,7 +17218,7 @@ client.crm.engagement_types.retrieve(
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `Invoice` objects.
@@ -16533,21 +17233,49 @@ Returns a list of `RemoteFieldClass` objects.
-
```python
+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.engagement_types.remote_field_classes_list(
+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",
+ ),
+ 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",
+ ),
+ number="number",
page_size=1,
+ remote_id="remote_id",
+ status=InvoicesListRequestStatus.DRAFT,
+ type=InvoicesListRequestType.ACCOUNTS_PAYABLE,
)
```
@@ -16564,7 +17292,7 @@ client.crm.engagement_types.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**company_id:** `typing.Optional[str]` β If provided, will only return invoices for this company.
@@ -16572,7 +17300,7 @@ client.crm.engagement_types.remote_field_classes_list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**contact_id:** `typing.Optional[str]` β If provided, will only return invoices for this contact.
@@ -16580,7 +17308,7 @@ client.crm.engagement_types.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_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -16588,7 +17316,7 @@ client.crm.engagement_types.remote_field_classes_list(
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -16596,7 +17324,7 @@ client.crm.engagement_types.remote_field_classes_list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -16604,7 +17332,12 @@ client.crm.engagement_types.remote_field_classes_list(
-
-**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
+**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.
@@ -16612,7 +17345,7 @@ client.crm.engagement_types.remote_field_classes_list(
-
-**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -16620,7 +17353,7 @@ client.crm.engagement_types.remote_field_classes_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.
@@ -16628,101 +17361,15 @@ client.crm.engagement_types.remote_field_classes_list(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
-
-
-
-
-client.crm.engagements.list(...)
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Returns a list of `Engagement` objects.
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.crm.resources.engagements import (
- EngagementsListRequestExpand,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.engagements.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=EngagementsListRequestExpand.ACCOUNT,
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
- started_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- started_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
-)
-
-```
-
-
-
-
-
-#### βοΈ 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).
@@ -16730,7 +17377,7 @@ client.crm.engagements.list(
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+**issue_date_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -16738,7 +17385,7 @@ client.crm.engagements.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**issue_date_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -16746,7 +17393,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.
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -16754,7 +17401,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/).
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -16762,7 +17409,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.
+**number:** `typing.Optional[str]` β If provided, will only return Invoices with this number.
@@ -16770,7 +17417,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.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -16778,7 +17425,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).
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` β Deprecated. Use show_enum_origins.
@@ -16786,7 +17433,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.
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -16794,7 +17441,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.
+**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)
@@ -16802,15 +17449,16 @@ client.crm.engagements.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
-
-
+**status:** `typing.Optional[InvoicesListRequestStatus]`
-
--
+If provided, will only return Invoices with this status.
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+* `PAID` - PAID
+* `DRAFT` - DRAFT
+* `SUBMITTED` - SUBMITTED
+* `PARTIALLY_PAID` - PARTIALLY_PAID
+* `OPEN` - OPEN
+* `VOID` - VOID
@@ -16818,15 +17466,12 @@ client.crm.engagements.list(
-
-**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return engagements started after this datetime.
-
-
-
+**type:** `typing.Optional[InvoicesListRequestType]`
-
--
+If provided, will only return Invoices with this type.
-**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return engagements started before this datetime.
+* `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE
+* `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE
@@ -16846,7 +17491,7 @@ client.crm.engagements.list(
client.crm.engagements.create(...)
+client.accounting.invoices.create(...)
-
@@ -16858,7 +17503,9 @@ client.crm.engagements.list(
-
-Creates an `Engagement` object with the given values.
+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).
+
@@ -16874,16 +17521,16 @@ Creates an `Engagement` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import EngagementRequest
+from merge.resources.accounting import InvoiceRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.create(
+client.accounting.invoices.create(
is_debug_mode=True,
run_async=True,
- model=EngagementRequest(),
+ model=InvoiceRequest(),
)
```
@@ -16900,7 +17547,7 @@ client.crm.engagements.create(
-
-**model:** `EngagementRequest`
+**model:** `InvoiceRequest`
@@ -16936,7 +17583,7 @@ client.crm.engagements.create(
client.crm.engagements.retrieve(...)
+client.accounting.invoices.retrieve(...)
-
@@ -16948,7 +17595,7 @@ client.crm.engagements.create(
-
-Returns an `Engagement` object with the given `id`.
+Returns an `Invoice` object with the given `id`.
@@ -16964,17 +17611,13 @@ Returns an `Engagement` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm.resources.engagements import (
- EngagementsRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.retrieve(
+client.accounting.invoices.retrieve(
id="id",
- expand=EngagementsRetrieveRequestExpand.ACCOUNT,
include_remote_data=True,
include_remote_fields=True,
include_shell_data=True,
@@ -17002,7 +17645,12 @@ client.crm.engagements.retrieve(
-
-**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ InvoicesRetrieveRequestExpandItem,
+ typing.Sequence[InvoicesRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17034,6 +17682,22 @@ client.crm.engagements.retrieve(
-
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` β Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -17046,7 +17710,7 @@ client.crm.engagements.retrieve(
client.crm.engagements.partial_update(...)
+client.accounting.invoices.partial_update(...)
-
@@ -17058,7 +17722,7 @@ client.crm.engagements.retrieve(
-
-Updates an `Engagement` object with the given `id`.
+Updates an `Invoice` object with the given `id`.
@@ -17074,17 +17738,17 @@ Updates an `Engagement` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm import PatchedEngagementRequest
+from merge.resources.accounting import InvoiceRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.partial_update(
+client.accounting.invoices.partial_update(
id="id",
is_debug_mode=True,
run_async=True,
- model=PatchedEngagementRequest(),
+ model=InvoiceRequest(),
)
```
@@ -17109,7 +17773,7 @@ client.crm.engagements.partial_update(
-
-**model:** `PatchedEngagementRequest`
+**model:** `InvoiceRequest`
@@ -17145,7 +17809,7 @@ client.crm.engagements.partial_update(
client.crm.engagements.meta_patch_retrieve(...)
+client.accounting.invoices.bulk_create(...)
-
@@ -17157,7 +17821,7 @@ client.crm.engagements.partial_update(
-
-Returns metadata for `Engagement` PATCHs.
+Creates multiple `Invoice` objects with the given values.
@@ -17173,13 +17837,19 @@ Returns metadata for `Engagement` PATCHs.
```python
from merge import Merge
+from merge.resources.accounting import InvoiceBatchItemRequest, InvoiceRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.meta_patch_retrieve(
- id="id",
+client.accounting.invoices.bulk_create(
+ batch_items=[
+ InvoiceBatchItemRequest(
+ item_id="item_id",
+ payload=InvoiceRequest(),
+ )
+ ],
)
```
@@ -17196,7 +17866,7 @@ client.crm.engagements.meta_patch_retrieve(
-
-**id:** `str`
+**batch_items:** `typing.Sequence[InvoiceBatchItemRequest]`
@@ -17216,7 +17886,7 @@ client.crm.engagements.meta_patch_retrieve(
client.crm.engagements.meta_post_retrieve()
+client.accounting.invoices.bulk_retrieve(...)
-
@@ -17228,7 +17898,7 @@ client.crm.engagements.meta_patch_retrieve(
-
-Returns metadata for `Engagement` POSTs.
+Returns the status and results of an `Invoice` bulk create batch.
@@ -17249,7 +17919,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.meta_post_retrieve()
+client.accounting.invoices.bulk_retrieve(
+ batch_id="batch_id",
+)
```
@@ -17265,6 +17937,14 @@ client.crm.engagements.meta_post_retrieve()
-
+**batch_id:** `str`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -17277,7 +17957,7 @@ client.crm.engagements.meta_post_retrieve()
client.crm.engagements.remote_field_classes_list(...)
+client.accounting.invoices.line_items_remote_field_classes_list(...)
-
@@ -17310,11 +17990,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.remote_field_classes_list(
+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,
is_common_model_field=True,
is_custom=True,
@@ -17359,14 +18038,6 @@ client.crm.engagements.remote_field_classes_list(
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
-
-
-
--
-
**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -17391,7 +18062,7 @@ client.crm.engagements.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -17411,8 +18082,7 @@ client.crm.engagements.remote_field_classes_list(
client.crm.field_mapping.field_mappings_retrieve(...)
+client.accounting.invoices.meta_patch_retrieve(...)
-
@@ -17424,7 +18094,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 `Invoice` PATCHs.
@@ -17445,8 +18115,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.invoices.meta_patch_retrieve(
+ id="id",
)
```
@@ -17463,7 +18133,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 +18153,7 @@ client.crm.field_mapping.field_mappings_retrieve(
client.crm.field_mapping.field_mappings_create(...)
+client.accounting.invoices.meta_post_retrieve()
-
@@ -17495,7 +18165,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 `Invoice` POSTs.
@@ -17516,14 +18186,75 @@ 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.invoices.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.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.accounting.invoices.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,
)
```
@@ -17540,7 +18271,7 @@ 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.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -17548,7 +18279,7 @@ client.crm.field_mapping.field_mappings_create(
-
-**target_field_description:** `str` β The description of the target field you want this remote field to map to.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -17556,7 +18287,7 @@ client.crm.field_mapping.field_mappings_create(
-
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` β The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17564,7 +18295,7 @@ client.crm.field_mapping.field_mappings_create(
-
-**remote_method:** `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).
@@ -17572,7 +18303,7 @@ client.crm.field_mapping.field_mappings_create(
-
-**remote_url_path:** `str` β The path of the remote endpoint where the remote field is coming from.
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
@@ -17580,7 +18311,7 @@ client.crm.field_mapping.field_mappings_create(
-
-**common_model_name:** `str` β The name of the Common Model that the remote field corresponds to in a given category.
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
@@ -17588,7 +18319,7 @@ client.crm.field_mapping.field_mappings_create(
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` β If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -17608,7 +18339,8 @@ client.crm.field_mapping.field_mappings_create(
client.crm.field_mapping.field_mappings_destroy(...)
+## Accounting Issues
+client.accounting.issues.list(...)
-
@@ -17620,7 +18352,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.
+Gets all issues for Organization.
@@ -17635,14 +18367,38 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
-
```python
+import datetime
+
from merge import Merge
+from merge.resources.accounting.resources.issues import IssuesListRequestStatus
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.field_mapping.field_mappings_destroy(
- field_mapping_id="field_mapping_id",
+client.accounting.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,
)
```
@@ -17659,7 +18415,7 @@ client.crm.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**account_token:** `typing.Optional[str]`
@@ -17667,70 +18423,108 @@ client.crm.field_mapping.field_mappings_destroy(
-
-**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
+
+
+-
+**end_user_organization_name:** `typing.Optional[str]`
+
-
client.crm.field_mapping.field_mappings_partial_update(...)
-
-#### π Description
+**first_incident_time_after:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose first incident time was after this datetime.
+
+
+
-
+**first_incident_time_before:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose first incident time was before this datetime.
+
+
+
+
-
-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_muted:** `typing.Optional[str]` β If true, will include muted issues
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]`
+
-#### π Usage
-
-
+**last_incident_time_after:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was after this datetime.
+
+
+
+
-
-```python
-from merge import Merge
+**last_incident_time_before:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was before this datetime.
+
+
+
-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",
-)
+
+-
-```
+**linked_account_id:** `typing.Optional[str]` β If provided, will only include issues pertaining to the linked account passed in.
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
-#### βοΈ Parameters
-
-
+**start_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred after this time
+
+
+
+
-
-**field_mapping_id:** `str`
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+* `ONGOING` - ONGOING
+* `RESOLVED` - RESOLVED
@@ -17738,23 +18532,70 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+client.accounting.issues.retrieve(...)
-
-**remote_method:** `typing.Optional[str]` β The method of the remote endpoint where the remote field is coming from.
-
+#### π Description
+
+
+-
+
+
+-
+
+Get a specific issue.
+
+
+
+#### π Usage
-
-**remote_url_path:** `typing.Optional[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.accounting.issues.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
@@ -17774,7 +18615,8 @@ client.crm.field_mapping.field_mappings_partial_update(
client.crm.field_mapping.remote_fields_retrieve(...)
+## Accounting ItemFulfillments
+client.accounting.item_fulfillments.list(...)
-
@@ -17786,7 +18628,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns a list of `ItemFulfillment` objects.
@@ -17807,9 +18649,13 @@ 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.item_fulfillments.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+ page_size=1,
)
```
@@ -17826,7 +18672,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.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -17834,7 +18680,68 @@ 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.
+**expand:** `typing.Optional[
+ typing.Union[
+ ItemFulfillmentsListRequestExpandItem,
+ typing.Sequence[ItemFulfillmentsListRequestExpandItem],
+ ]
+]` β 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).
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**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)
@@ -17854,7 +18761,7 @@ client.crm.field_mapping.remote_fields_retrieve(
client.crm.field_mapping.target_fields_retrieve()
+client.accounting.item_fulfillments.create(...)
-
@@ -17866,7 +18773,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/).
+Creates an `ItemFulfillment` object with the given values.
@@ -17882,12 +18789,17 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```python
from merge import Merge
+from merge.resources.accounting import ItemFulfillmentRequestRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.field_mapping.target_fields_retrieve()
+client.accounting.item_fulfillments.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=ItemFulfillmentRequestRequest(),
+)
```
@@ -17903,6 +18815,30 @@ client.crm.field_mapping.target_fields_retrieve()
-
+**model:** `ItemFulfillmentRequestRequest`
+
+
+
+
+
+-
+
+**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.
@@ -17915,8 +18851,7 @@ client.crm.field_mapping.target_fields_retrieve()
client.crm.generate_key.create(...)
+client.accounting.item_fulfillments.retrieve(...)
-
@@ -17928,7 +18863,7 @@ client.crm.field_mapping.target_fields_retrieve()
-
-Create a remote key.
+Returns an `ItemFulfillment` object with the given `id`.
@@ -17949,8 +18884,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.generate_key.create(
- name="Remote Deployment Key 1",
+client.accounting.item_fulfillments.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
)
```
@@ -17967,7 +18905,60 @@ client.crm.generate_key.create(
-
-**name:** `str` β The name of the remote key
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ ItemFulfillmentsRetrieveRequestExpandItem,
+ typing.Sequence[ItemFulfillmentsRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**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)
@@ -17987,8 +18978,7 @@ client.crm.generate_key.create(
client.crm.issues.list(...)
+client.accounting.item_fulfillments.bulk_create(...)
-
@@ -18000,7 +18990,7 @@ client.crm.generate_key.create(
-
-Gets all issues for Organization.
+Creates multiple `ItemFulfillment` objects with the given values.
@@ -18015,38 +19005,23 @@ Gets all issues for Organization.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.issues import IssuesListRequestStatus
+from merge.resources.accounting import (
+ ItemFulfillmentBatchItemRequest,
+ ItemFulfillmentRequestRequest,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.issues.list(
- account_token="account_token",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
+client.accounting.item_fulfillments.bulk_create(
+ batch_items=[
+ ItemFulfillmentBatchItemRequest(
+ item_id="item_id",
+ payload=ItemFulfillmentRequestRequest(),
+ )
+ ],
)
```
@@ -18063,7 +19038,7 @@ client.crm.issues.list(
-
-**account_token:** `typing.Optional[str]`
+**batch_items:** `typing.Sequence[ItemFulfillmentBatchItemRequest]`
@@ -18071,23 +19046,70 @@ client.crm.issues.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+client.accounting.item_fulfillments.bulk_retrieve(...)
-
-**end_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred before this time
-
+#### π Description
+
+
+-
+
+
+-
+
+Returns the status and results of an `ItemFulfillment` bulk create batch.
+
+
+
+#### π Usage
-
-**end_user_organization_name:** `typing.Optional[str]`
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.item_fulfillments.bulk_retrieve(
+ batch_id="batch_id",
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**batch_id:** `str`
@@ -18095,15 +19117,76 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+client.accounting.item_fulfillments.lines_remote_field_classes_list(...)
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose first incident time was before this datetime.
+#### π 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.accounting.item_fulfillments.lines_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,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -18111,7 +19194,7 @@ client.crm.issues.list(
-
-**include_muted:** `typing.Optional[str]` β If true, will include muted issues
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -18119,7 +19202,7 @@ client.crm.issues.list(
-
-**integration_name:** `typing.Optional[str]`
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -18127,7 +19210,7 @@ client.crm.issues.list(
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was after this datetime.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18135,7 +19218,7 @@ client.crm.issues.list(
-
-**last_incident_time_before:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was before this datetime.
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
@@ -18143,7 +19226,7 @@ client.crm.issues.list(
-
-**linked_account_id:** `typing.Optional[str]` β If provided, will only include issues pertaining to the linked account passed in.
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
@@ -18151,7 +19234,7 @@ client.crm.issues.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -18159,23 +19242,63 @@ client.crm.issues.list(
-
-**start_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred after this time
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+client.accounting.item_fulfillments.meta_post_retrieve()
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
+#### π Description
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+-
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
-
+
+-
+
+Returns metadata for `ItemFulfillment` POSTs.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.item_fulfillments.meta_post_retrieve()
+
+```
+
+
+
+#### βοΈ Parameters
+
+
+-
-
@@ -18192,7 +19315,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
client.crm.issues.retrieve(...)
+client.accounting.item_fulfillments.remote_field_classes_list(...)
-
@@ -18204,7 +19327,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Returns a list of `RemoteFieldClass` objects.
@@ -18225,8 +19348,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.issues.retrieve(
- id="id",
+client.accounting.item_fulfillments.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,
)
```
@@ -18243,7 +19372,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. The maximum limit is 100.
@@ -18263,8 +19440,8 @@ client.crm.issues.retrieve(
client.crm.leads.list(...)
+## Accounting Items
+client.accounting.items.list(...)
-
@@ -18276,7 +19453,7 @@ client.crm.issues.retrieve(
-
-Returns a list of `Lead` objects.
+Returns a list of `Item` objects.
@@ -18294,15 +19471,13 @@ Returns a list of `Lead` objects.
import datetime
from merge import Merge
-from merge.resources.crm.resources.leads import LeadsListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.leads.list(
- converted_account_id="converted_account_id",
- converted_contact_id="converted_contact_id",
+client.accounting.items.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -18310,11 +19485,8 @@ client.crm.leads.list(
"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",
@@ -18322,9 +19494,8 @@ client.crm.leads.list(
modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- owner_id="owner_id",
+ name="name",
page_size=1,
- phone_numbers="phone_numbers",
remote_id="remote_id",
)
@@ -18342,15 +19513,7 @@ client.crm.leads.list(
-
-**converted_account_id:** `typing.Optional[str]` β If provided, will only return leads with this account.
-
-
-
-
-
--
-
-**converted_contact_id:** `typing.Optional[str]` β If provided, will only return leads with this contact.
+**company_id:** `typing.Optional[str]` β If provided, will only return items for this company.
@@ -18382,15 +19545,11 @@ 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.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[LeadsListRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.
@@ -18414,7 +19573,7 @@ client.crm.leads.list(
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18422,7 +19581,7 @@ client.crm.leads.list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -18430,7 +19589,7 @@ client.crm.leads.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -18438,7 +19597,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.
+**name:** `typing.Optional[str]` β If provided, will only return items with this name.
@@ -18446,7 +19605,7 @@ client.crm.leads.list(
-
-**owner_id:** `typing.Optional[str]` β If provided, will only return leads with this owner.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -18454,7 +19613,7 @@ client.crm.leads.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` β Deprecated. Use show_enum_origins.
@@ -18462,7 +19621,7 @@ client.crm.leads.list(
-
-**phone_numbers:** `typing.Optional[str]` β If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -18470,7 +19629,7 @@ client.crm.leads.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)
@@ -18490,7 +19649,7 @@ client.crm.leads.list(
client.crm.leads.create(...)
+client.accounting.items.create(...)
-
@@ -18502,7 +19661,7 @@ client.crm.leads.list(
-
-Creates a `Lead` object with the given values.
+Creates an `Item` object with the given values.
@@ -18518,16 +19677,16 @@ Creates a `Lead` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import LeadRequest
+from merge.resources.accounting import ItemRequestRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.leads.create(
+client.accounting.items.create(
is_debug_mode=True,
run_async=True,
- model=LeadRequest(),
+ model=ItemRequestRequest(),
)
```
@@ -18544,7 +19703,7 @@ client.crm.leads.create(
-
-**model:** `LeadRequest`
+**model:** `ItemRequestRequest`
@@ -18580,7 +19739,7 @@ client.crm.leads.create(
client.crm.leads.retrieve(...)
+client.accounting.items.retrieve(...)
-
@@ -18592,7 +19751,7 @@ client.crm.leads.create(
-
-Returns a `Lead` object with the given `id`.
+Returns an `Item` object with the given `id`.
@@ -18608,17 +19767,14 @@ Returns a `Lead` object with the given `id`.
```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(
+client.accounting.items.retrieve(
id="id",
- expand=LeadsRetrieveRequestExpand.CONVERTED_ACCOUNT,
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
)
@@ -18644,7 +19800,12 @@ 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.
+**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.
@@ -18660,7 +19821,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.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18668,7 +19829,15 @@ 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).
+**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)
@@ -18688,7 +19857,7 @@ client.crm.leads.retrieve(
client.crm.leads.meta_post_retrieve()
+client.accounting.items.partial_update(...)
-
@@ -18700,7 +19869,7 @@ client.crm.leads.retrieve(
-
-Returns metadata for `Lead` POSTs.
+Updates an `Item` object with the given `id`.
@@ -18716,12 +19885,18 @@ Returns metadata for `Lead` POSTs.
```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.leads.meta_post_retrieve()
+client.accounting.items.partial_update(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedItemRequestRequest(),
+)
```
@@ -18737,6 +19912,38 @@ client.crm.leads.meta_post_retrieve()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedItemRequestRequest`
+
+
+
+
+
+-
+
+**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.
@@ -18749,7 +19956,7 @@ client.crm.leads.meta_post_retrieve()
client.crm.leads.remote_field_classes_list(...)
+client.accounting.items.meta_patch_retrieve(...)
-
@@ -18761,7 +19968,7 @@ client.crm.leads.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Returns metadata for `Item` PATCHs.
@@ -18782,15 +19989,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.leads.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.meta_patch_retrieve(
+ id="id",
)
```
@@ -18807,7 +20007,7 @@ client.crm.leads.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**id:** `str`
@@ -18815,76 +20015,81 @@ client.crm.leads.remote_field_classes_list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**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.items.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
-
-**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
-
+Returns metadata for `Item` POSTs.
+
+
+#### π Usage
+
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
-
-
-
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
-
-
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.items.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
client.crm.link_token.create(...)
+## Accounting JournalEntries
+client.accounting.journal_entries.list(...)
-
@@ -18896,7 +20101,7 @@ client.crm.leads.remote_field_classes_list(
-
-Creates a link token to be used when linking a new end user.
+Returns a list of `JournalEntry` objects.
@@ -18911,18 +20116,41 @@ Creates a link token to be used when linking a new end user.
-
```python
+import datetime
+
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.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",
+ ),
)
```
@@ -18939,7 +20167,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.
+**company_id:** `typing.Optional[str]` β If provided, will only return journal entries for this company.
@@ -18947,7 +20175,7 @@ client.crm.link_token.create(
-
-**end_user_organization_name:** `str` β Your end user's organization.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -18955,7 +20183,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.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -18963,7 +20191,7 @@ client.crm.link_token.create(
-
-**categories:** `typing.Sequence[CategoriesEnum]` β The integration categories to show in Merge Link.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -18971,7 +20199,12 @@ client.crm.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/.
+**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.
@@ -18979,7 +20212,7 @@ client.crm.link_token.create(
-
-**link_expiry_mins:** `typing.Optional[int]` β An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -18987,7 +20220,7 @@ client.crm.link_token.create(
-
-**should_create_magic_link_url:** `typing.Optional[bool]` β Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -18995,7 +20228,7 @@ client.crm.link_token.create(
-
-**hide_admin_magic_link:** `typing.Optional[bool]` β Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+**include_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.
@@ -19003,7 +20236,7 @@ client.crm.link_token.create(
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` β An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19011,14 +20244,7 @@ client.crm.link_token.create(
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
- ]
-]` β When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -19026,12 +20252,15 @@ client.crm.link_token.create(
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
-The following subset of IETF language tags can be used to configure localization.
+
+-
-* `en` - en
-* `de` - de
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -19039,7 +20268,7 @@ The following subset of IETF language tags can be used to configure localization
-
-**are_syncs_disabled:** `typing.Optional[bool]` β The boolean that indicates whether initial, periodic, and force syncs will be disabled.
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -19047,7 +20276,15 @@ The following subset of IETF language tags can be used to configure localization
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β A JSON object containing integration-specific configuration options.
+**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.
@@ -19067,8 +20304,7 @@ The following subset of IETF language tags can be used to configure localization
client.crm.linked_accounts.list(...)
+client.accounting.journal_entries.create(...)
-
@@ -19080,7 +20316,7 @@ The following subset of IETF language tags can be used to configure localization
-
-List linked accounts for your organization.
+Creates a `JournalEntry` object with the given values.
@@ -19096,28 +20332,16 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.crm.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
+from merge.resources.accounting import JournalEntryRequest
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",
- id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
+client.accounting.journal_entries.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=JournalEntryRequest(),
)
```
@@ -19134,17 +20358,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
+**model:** `JournalEntryRequest`
@@ -19152,7 +20366,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -19160,7 +20374,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**end_user_email_address:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given email address.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -19168,47 +20382,73 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**end_user_organization_name:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given organization name.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
-
--
-**end_user_origin_id:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given origin ID.
-
+client.accounting.journal_entries.retrieve(...)
-
-**end_user_origin_ids:** `typing.Optional[str]` β Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
-
-
-
+#### π Description
-
-**id:** `typing.Optional[str]`
-
+
+-
+
+Returns a `JournalEntry` object with the given `id`.
+
+
+#### π Usage
+
-
-**ids:** `typing.Optional[str]` β Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.journal_entries.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**include_duplicates:** `typing.Optional[bool]` β If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+
+-
+
+**id:** `str`
@@ -19216,7 +20456,12 @@ 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.
+**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.
@@ -19224,7 +20469,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**is_test_account:** `typing.Optional[str]` β If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19232,7 +20477,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**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.
@@ -19240,7 +20485,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 +20505,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
client.crm.notes.list(...)
+client.accounting.journal_entries.lines_remote_field_classes_list(...)
-
@@ -19273,7 +20517,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-Returns a list of `Note` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -19288,40 +20532,20 @@ Returns a list of `Note` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.notes import NotesListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.notes.list(
- account_id="account_id",
- contact_id="contact_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+client.accounting.journal_entries.lines_remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=NotesListRequestExpand.ACCOUNT,
include_deleted_data=True,
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- opportunity_id="opportunity_id",
- owner_id="owner_id",
+ is_common_model_field=True,
+ is_custom=True,
page_size=1,
- remote_id="remote_id",
)
```
@@ -19338,38 +20562,6 @@ client.crm.notes.list(
-
-**account_id:** `typing.Optional[str]` β If provided, will only return notes with this account.
-
-
-
-
-
--
-
-**contact_id:** `typing.Optional[str]` β If provided, will only return notes with this contact.
-
-
-
-
-
--
-
-**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.
@@ -19378,14 +20570,6 @@ 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.
-
-
-
-
-
--
-
**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -19402,14 +20586,6 @@ client.crm.notes.list(
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
-
-
-
--
-
**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19418,31 +20594,7 @@ client.crm.notes.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**opportunity_id:** `typing.Optional[str]` β If provided, will only return notes with this opportunity.
-
-
-
-
-
--
-
-**owner_id:** `typing.Optional[str]` β If provided, will only return notes with this owner.
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
@@ -19450,7 +20602,7 @@ client.crm.notes.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
@@ -19458,7 +20610,7 @@ client.crm.notes.list(
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -19478,7 +20630,7 @@ client.crm.notes.list(
client.crm.notes.create(...)
+client.accounting.journal_entries.meta_post_retrieve()
-
@@ -19490,7 +20642,7 @@ client.crm.notes.list(
-
-Creates a `Note` object with the given values.
+Returns metadata for `JournalEntry` POSTs.
@@ -19506,17 +20658,12 @@ Creates a `Note` object with the given values.
```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(),
-)
+client.accounting.journal_entries.meta_post_retrieve()
```
@@ -19532,30 +20679,6 @@ client.crm.notes.create(
-
-**model:** `NoteRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -19568,7 +20691,7 @@ client.crm.notes.create(
client.crm.notes.retrieve(...)
+client.accounting.journal_entries.remote_field_classes_list(...)
-
@@ -19580,7 +20703,7 @@ client.crm.notes.create(
-
-Returns a `Note` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -19596,18 +20719,19 @@ 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(
- id="id",
- expand=NotesRetrieveRequestExpand.ACCOUNT,
+client.accounting.journal_entries.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,
)
```
@@ -19624,7 +20748,7 @@ client.crm.notes.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -19632,7 +20756,7 @@ client.crm.notes.retrieve(
-
-**expand:** `typing.Optional[NotesRetrieveRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -19648,7 +20772,7 @@ client.crm.notes.retrieve(
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19656,7 +20780,23 @@ client.crm.notes.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**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. The maximum limit is 100.
@@ -19676,7 +20816,8 @@ client.crm.notes.retrieve(
client.crm.notes.meta_post_retrieve()
+## Accounting LinkToken
+client.accounting.link_token.create(...)
-
@@ -19688,7 +20829,7 @@ client.crm.notes.retrieve(
-
-Returns metadata for `Note` POSTs.
+Creates a link token to be used when linking a new end user. The link token expires after single use.
@@ -19704,12 +20845,18 @@ Returns metadata for `Note` POSTs.
```python
from merge import Merge
+from merge.resources.accounting import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.notes.meta_post_retrieve()
+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],
+)
```
@@ -19725,77 +20872,71 @@ client.crm.notes.meta_post_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**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.
+
-client.crm.notes.remote_field_classes_list(...)
-
-#### π Description
+**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.
+
+
+
+
-
-Returns a list of `RemoteFieldClass` objects.
-
-
+**integration:** `typing.Optional[str]` β The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+
-#### π Usage
-
-
+**link_expiry_mins:** `typing.Optional[int]` β An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.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,
-)
-
-```
-
-
+**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.
+
-#### βοΈ Parameters
-
-
+**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.
+
+
+
+
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**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.
@@ -19803,7 +20944,14 @@ client.crm.notes.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/).
+**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.
@@ -19811,7 +20959,12 @@ client.crm.notes.remote_field_classes_list(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
+
+The following subset of IETF language tags can be used to configure localization.
+
+* `en` - en
+* `de` - de
@@ -19819,7 +20972,7 @@ client.crm.notes.remote_field_classes_list(
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**are_syncs_disabled:** `typing.Optional[bool]` β The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -19827,7 +20980,7 @@ client.crm.notes.remote_field_classes_list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β A JSON object containing integration-specific configuration options.
@@ -19835,7 +20988,11 @@ client.crm.notes.remote_field_classes_list(
-
-**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
+**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
@@ -19843,7 +21000,7 @@ client.crm.notes.remote_field_classes_list(
-
-**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
+**linked_destination_id:** `typing.Optional[str]` β The UUID of the linked destination that you want this Linked Account to be tied to.
@@ -19851,7 +21008,7 @@ client.crm.notes.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**credential_id:** `typing.Optional[str]` β The id of the credential that you want this Linked Account to be tied to.
@@ -19871,8 +21028,8 @@ client.crm.notes.remote_field_classes_list(
client.crm.opportunities.list(...)
+## Accounting LinkedAccounts
+client.accounting.linked_accounts.list(...)
-
@@ -19884,7 +21041,7 @@ client.crm.notes.remote_field_classes_list(
-
-Returns a list of `Opportunity` objects.
+List linked accounts for your organization.
@@ -19899,46 +21056,29 @@ Returns a list of `Opportunity` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.opportunities import (
- OpportunitiesListRequestExpand,
- OpportunitiesListRequestStatus,
+from merge.resources.accounting.resources.linked_accounts import (
+ LinkedAccountsListRequestCategory,
)
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",
- ),
+client.accounting.linked_accounts.list(
+ category=LinkedAccountsListRequestCategory.ACCOUNTING,
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",
+ 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_created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- remote_id="remote_id",
- stage_id="stage_id",
- status=OpportunitiesListRequestStatus.LOST,
+ status="status",
)
```
@@ -19955,7 +21095,21 @@ client.crm.opportunities.list(
-
-**account_id:** `typing.Optional[str]` β If provided, will only return opportunities with this account.
+**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
+* `datawarehouse` - datawarehouse
+* `knowledgebase` - knowledgebase
+* `communication` - communication
+* `chat` - chat
@@ -19963,7 +21117,7 @@ client.crm.opportunities.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.
@@ -19971,7 +21125,7 @@ client.crm.opportunities.list(
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+**end_user_email_address:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given email address.
@@ -19979,7 +21133,7 @@ client.crm.opportunities.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**end_user_organization_name:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given organization name.
@@ -19987,7 +21141,7 @@ client.crm.opportunities.list(
-
-**expand:** `typing.Optional[OpportunitiesListRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**end_user_origin_id:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given origin ID.
@@ -19995,7 +21149,7 @@ 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/).
+**end_user_origin_ids:** `typing.Optional[str]` β Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -20003,7 +21157,7 @@ client.crm.opportunities.list(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**id:** `typing.Optional[str]`
@@ -20011,7 +21165,7 @@ client.crm.opportunities.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.
+**ids:** `typing.Optional[str]` β Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -20019,7 +21173,7 @@ client.crm.opportunities.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.
@@ -20027,7 +21181,7 @@ client.crm.opportunities.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.
@@ -20035,7 +21189,7 @@ client.crm.opportunities.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.
@@ -20043,7 +21197,7 @@ client.crm.opportunities.list(
-
-**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. The maximum limit is 100.
@@ -20051,7 +21205,7 @@ client.crm.opportunities.list(
-
-**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`
@@ -20059,53 +21213,75 @@ client.crm.opportunities.list(
-
-**remote_created_after:** `typing.Optional[dt.datetime]` β If provided, will only return opportunities created in the third party platform after this datetime.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
-
--
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` β Deprecated. Use show_enum_origins.
-
+client.accounting.passthrough.create(...)
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
-
-
+#### π Description
-
-**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)
-
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+#### π Usage
+
-
-**stage_id:** `typing.Optional[str]` β If provided, will only return opportunities with this stage.
-
+
+-
+
+```python
+from merge import Merge
+from merge.resources.accounting import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+#### βοΈ Parameters
-
-**status:** `typing.Optional[OpportunitiesListRequestStatus]`
-
-If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
+
+-
-* `OPEN` - OPEN
-* `WON` - WON
-* `LOST` - LOST
+**request:** `DataPassthroughRequest`
@@ -20125,7 +21301,8 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
client.crm.opportunities.create(...)
+## Accounting PaymentMethods
+client.accounting.payment_methods.list(...)
-
@@ -20137,7 +21314,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-
-Creates an `Opportunity` object with the given values.
+Returns a list of `PaymentMethod` objects.
@@ -20153,16 +21330,17 @@ Creates an `Opportunity` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import OpportunityRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.opportunities.create(
- is_debug_mode=True,
- run_async=True,
- model=OpportunityRequest(),
+client.accounting.payment_methods.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ page_size=1,
)
```
@@ -20179,7 +21357,7 @@ client.crm.opportunities.create(
-
-**model:** `OpportunityRequest`
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -20187,7 +21365,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 +21373,23 @@ 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).
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -20215,7 +21409,7 @@ client.crm.opportunities.create(
client.crm.opportunities.retrieve(...)
+client.accounting.payment_methods.retrieve(...)
-
@@ -20227,7 +21421,7 @@ client.crm.opportunities.create(
-
-Returns an `Opportunity` object with the given `id`.
+Returns a `PaymentMethod` object with the given `id`.
@@ -20243,19 +21437,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.payment_methods.retrieve(
id="id",
- expand=OpportunitiesRetrieveRequestExpand.ACCOUNT,
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
)
@@ -20281,14 +21470,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 +21478,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 +21486,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 +21498,8 @@ client.crm.opportunities.retrieve(
client.crm.opportunities.partial_update(...)
+## Accounting PaymentTerms
+client.accounting.payment_terms.list(...)
-
@@ -20353,7 +21511,7 @@ client.crm.opportunities.retrieve(
-
-Updates an `Opportunity` object with the given `id`.
+Returns a list of `PaymentTerm` objects.
@@ -20369,17 +21527,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.payment_terms.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ page_size=1,
)
```
@@ -20396,7 +21554,7 @@ client.crm.opportunities.partial_update(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -20404,7 +21562,11 @@ client.crm.opportunities.partial_update(
-
-**model:** `PatchedOpportunityRequest`
+**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.
@@ -20412,7 +21574,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 +21582,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. The maximum limit is 100.
@@ -20440,7 +21618,7 @@ client.crm.opportunities.partial_update(
client.crm.opportunities.meta_patch_retrieve(...)
+client.accounting.payment_terms.retrieve(...)
-
@@ -20452,7 +21630,7 @@ client.crm.opportunities.partial_update(
-
-Returns metadata for `Opportunity` PATCHs.
+Returns a `PaymentTerm` object with the given `id`.
@@ -20473,8 +21651,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.opportunities.meta_patch_retrieve(
+client.accounting.payment_terms.retrieve(
id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -20499,64 +21679,31 @@ client.crm.opportunities.meta_patch_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**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.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 +21719,8 @@ client.crm.opportunities.meta_post_retrieve()
client.crm.opportunities.remote_field_classes_list(...)
+## Accounting Payments
+client.accounting.payments.list(...)
-
@@ -20584,7 +21732,7 @@ client.crm.opportunities.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `Payment` objects.
@@ -20599,21 +21747,43 @@ 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(
+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",
+ ),
+ 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,
+ 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",
+ ),
)
```
@@ -20630,7 +21800,7 @@ client.crm.opportunities.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**account_id:** `typing.Optional[str]` β If provided, will only return payments for this account.
@@ -20638,7 +21808,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/).
+**company_id:** `typing.Optional[str]` β If provided, will only return payments for this company.
@@ -20646,7 +21816,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.
+**contact_id:** `typing.Optional[str]` β If provided, will only return payments for this contact.
@@ -20654,7 +21824,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.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -20662,7 +21832,7 @@ client.crm.opportunities.remote_field_classes_list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -20670,7 +21840,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
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -20678,7 +21848,12 @@ 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
+**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.
@@ -20686,7 +21861,7 @@ client.crm.opportunities.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -20694,75 +21869,71 @@ client.crm.opportunities.remote_field_classes_list(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
+
+-
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
-client.crm.passthrough.create(...)
-
-#### π Description
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
-
-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. The maximum limit is 100.
+
+
+
+
-
-```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_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
-#### βοΈ Parameters
-
-
+**transaction_date_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+
+
+
+
-
-**request:** `DataPassthroughRequest`
+**transaction_date_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -20782,8 +21953,7 @@ client.crm.passthrough.create(
client.crm.regenerate_key.create(...)
+client.accounting.payments.create(...)
-
@@ -20795,7 +21965,7 @@ client.crm.passthrough.create(
-
-Exchange remote keys.
+Creates a `Payment` object with the given values.
@@ -20811,13 +21981,16 @@ Exchange remote keys.
```python
from merge import Merge
+from merge.resources.accounting import PaymentRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.regenerate_key.create(
- name="Remote Deployment Key 1",
+client.accounting.payments.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=PaymentRequest(),
)
```
@@ -20834,7 +22007,23 @@ client.crm.regenerate_key.create(
-
-**name:** `str` β The name of the remote key
+**model:** `PaymentRequest`
+
+
+
+
+
+-
+
+**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 +22043,7 @@ client.crm.regenerate_key.create(
client.crm.stages.list(...)
+client.accounting.payments.retrieve(...)
-
@@ -20867,7 +22055,7 @@ client.crm.regenerate_key.create(
-
-Returns a list of `Stage` objects.
+Returns a `Payment` object with the given `id`.
@@ -20882,34 +22070,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.payments.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 +22097,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 +22105,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[
+ PaymentsRetrieveRequestExpandItem,
+ typing.Sequence[PaymentsRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20982,38 +22142,6 @@ 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_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -21026,7 +22154,7 @@ client.crm.stages.list(
client.crm.stages.retrieve(...)
+client.accounting.payments.partial_update(...)
-
@@ -21038,7 +22166,7 @@ client.crm.stages.list(
-
-Returns a `Stage` object with the given `id`.
+Updates a `Payment` object with the given `id`.
@@ -21054,16 +22182,17 @@ Returns a `Stage` object with the given `id`.
```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.stages.retrieve(
+client.accounting.payments.partial_update(
id="id",
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedPaymentRequest(),
)
```
@@ -21088,7 +22217,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.
+**model:** `PatchedPaymentRequest`
@@ -21096,7 +22225,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.
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -21104,7 +22233,7 @@ client.crm.stages.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -21124,7 +22253,7 @@ client.crm.stages.retrieve(
client.crm.stages.remote_field_classes_list(...)
+client.accounting.payments.line_items_remote_field_classes_list(...)
-
@@ -21157,11 +22286,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.stages.remote_field_classes_list(
+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,
@@ -21206,14 +22334,6 @@ 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).
@@ -21238,7 +22358,7 @@ client.crm.stages.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -21258,8 +22378,7 @@ client.crm.stages.remote_field_classes_list(
client.crm.sync_status.list(...)
+client.accounting.payments.meta_patch_retrieve(...)
-
@@ -21271,7 +22390,7 @@ client.crm.stages.remote_field_classes_list(
-
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+Returns metadata for `Payment` PATCHs.
@@ -21292,9 +22411,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
+client.accounting.payments.meta_patch_retrieve(
+ id="id",
)
```
@@ -21311,15 +22429,7 @@ client.crm.sync_status.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**id:** `str`
@@ -21339,8 +22449,7 @@ client.crm.sync_status.list(
client.crm.force_resync.sync_status_resync_create()
+client.accounting.payments.meta_post_retrieve()
-
@@ -21352,7 +22461,7 @@ client.crm.sync_status.list(
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+Returns metadata for `Payment` POSTs.
@@ -21373,7 +22482,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.force_resync.sync_status_resync_create()
+client.accounting.payments.meta_post_retrieve()
```
@@ -21401,8 +22510,7 @@ client.crm.force_resync.sync_status_resync_create()
client.crm.tasks.list(...)
+client.accounting.payments.remote_field_classes_list(...)
-
@@ -21414,7 +22522,7 @@ client.crm.force_resync.sync_status_resync_create()
-
-Returns a list of `Task` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -21429,36 +22537,20 @@ Returns a list of `Task` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.tasks import TasksListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.tasks.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+client.accounting.payments.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=TasksListRequestExpand.ACCOUNT,
include_deleted_data=True,
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+ is_common_model_field=True,
+ is_custom=True,
page_size=1,
- remote_id="remote_id",
)
```
@@ -21475,7 +22567,7 @@ client.crm.tasks.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.
@@ -21483,7 +22575,7 @@ client.crm.tasks.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/).
@@ -21491,7 +22583,7 @@ client.crm.tasks.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.
@@ -21499,7 +22591,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.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21507,7 +22599,7 @@ 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/).
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
@@ -21515,7 +22607,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.
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
@@ -21523,7 +22615,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.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -21531,23 +22623,73 @@ client.crm.tasks.list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+client.accounting.phone_numbers.retrieve(...)
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
+#### π Description
+
+
+-
+
+
+-
+
+Returns an `AccountingPhoneNumber` 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.
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.phone_numbers.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
@@ -21555,7 +22697,7 @@ client.crm.tasks.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.
@@ -21563,7 +22705,7 @@ client.crm.tasks.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).
@@ -21583,7 +22725,8 @@ client.crm.tasks.list(
client.crm.tasks.create(...)
+## Accounting Projects
+client.accounting.projects.list(...)
-
@@ -21595,7 +22738,7 @@ client.crm.tasks.list(
-
-Creates a `Task` object with the given values.
+Returns a list of `Project` objects.
@@ -21610,17 +22753,35 @@ Creates a `Task` object with the given values.
-
```python
+import datetime
+
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(),
+client.accounting.projects.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,
+ is_active="is_active",
+ 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",
)
```
@@ -21637,7 +22798,7 @@ client.crm.tasks.create(
-
-**model:** `TaskRequest`
+**company_id:** `typing.Optional[str]` β If provided, will only return projects for this company.
@@ -21645,7 +22806,7 @@ client.crm.tasks.create(
-
-**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -21653,7 +22814,92 @@ client.crm.tasks.create(
-
-**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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_active:** `typing.Optional[str]` β If provided, will only return projects with this value for is_active.
+
+
+
+
+
+-
+
+**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.
@@ -21673,7 +22919,7 @@ client.crm.tasks.create(
client.crm.tasks.retrieve(...)
+client.accounting.projects.retrieve(...)
-
@@ -21685,7 +22931,7 @@ client.crm.tasks.create(
-
-Returns a `Task` object with the given `id`.
+Returns a `Project` object with the given `id`.
@@ -21701,17 +22947,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.projects.retrieve(
id="id",
- expand=TasksRetrieveRequestExpand.ACCOUNT,
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
)
@@ -21737,7 +22980,12 @@ 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[
+ ProjectsRetrieveRequestExpandItem,
+ typing.Sequence[ProjectsRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21753,14 +23001,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 +23021,8 @@ client.crm.tasks.retrieve(
client.crm.tasks.partial_update(...)
+## Accounting PurchaseOrders
+client.accounting.purchase_orders.list(...)
-
@@ -21793,7 +23034,7 @@ client.crm.tasks.retrieve(
-
-Updates a `Task` object with the given `id`.
+Returns a list of `PurchaseOrder` objects.
@@ -21808,18 +23049,41 @@ Updates a `Task` object with the given `id`.
-
```python
+import datetime
+
from merge import Merge
-from merge.resources.crm import PatchedTaskRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.tasks.partial_update(
- id="id",
- is_debug_mode=True,
- run_async=True,
- model=PatchedTaskRequest(),
+client.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,
+ 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",
)
```
@@ -21836,7 +23100,7 @@ client.crm.tasks.partial_update(
-
-**id:** `str`
+**company_id:** `typing.Optional[str]` β If provided, will only return purchase orders for this company.
@@ -21844,7 +23108,7 @@ client.crm.tasks.partial_update(
-
-**model:** `PatchedTaskRequest`
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -21852,7 +23116,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_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -21860,7 +23124,7 @@ client.crm.tasks.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.
@@ -21868,70 +23132,52 @@ client.crm.tasks.partial_update(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**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.
-
-
+
+-
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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_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.
+
+
+
-
-Returns metadata for `Task` PATCHs.
-
-
+**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.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`
+**issue_date_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -21939,64 +23185,59 @@ client.crm.tasks.meta_patch_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**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.
+
-client.crm.tasks.meta_post_retrieve()
-
-#### π Description
-
-
--
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
-
-Returns metadata for `Task` POSTs.
-
-
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
-#### π 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.tasks.meta_post_retrieve()
-
-```
-
-
+**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)
+
+
+
+
-
@@ -22012,7 +23253,7 @@ client.crm.tasks.meta_post_retrieve()
client.crm.tasks.remote_field_classes_list(...)
+client.accounting.purchase_orders.create(...)
-
@@ -22024,7 +23265,7 @@ client.crm.tasks.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Creates a `PurchaseOrder` object with the given values.
@@ -22040,20 +23281,16 @@ Returns a list of `RemoteFieldClass` objects.
```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.tasks.remote_field_classes_list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
+client.accounting.purchase_orders.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=PurchaseOrderRequest(),
)
```
@@ -22070,47 +23307,7 @@ client.crm.tasks.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
+**model:** `PurchaseOrderRequest`
@@ -22118,7 +23315,7 @@ client.crm.tasks.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.
@@ -22126,7 +23323,7 @@ client.crm.tasks.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.
@@ -22146,8 +23343,7 @@ client.crm.tasks.remote_field_classes_list(
client.crm.users.list(...)
+client.accounting.purchase_orders.retrieve(...)
-
@@ -22159,7 +23355,7 @@ client.crm.tasks.remote_field_classes_list(
-
-Returns a list of `User` objects.
+Returns a `PurchaseOrder` object with the given `id`.
@@ -22174,35 +23370,17 @@ Returns a list of `User` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.users.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- email="email",
- 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",
)
```
@@ -22219,31 +23397,7 @@ client.crm.users.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
-
-
-
-
--
-
-**email:** `typing.Optional[str]` β If provided, will only return users with this email.
+**id:** `str`
@@ -22251,7 +23405,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[
+ PurchaseOrdersRetrieveRequestExpandItem,
+ typing.Sequence[PurchaseOrdersRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22283,23 +23442,7 @@ client.crm.users.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` β Deprecated. Use show_enum_origins.
@@ -22307,7 +23450,7 @@ client.crm.users.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)
@@ -22327,7 +23470,7 @@ client.crm.users.list(
client.crm.users.retrieve(...)
+client.accounting.purchase_orders.line_items_remote_field_classes_list(...)
-
@@ -22339,7 +23482,7 @@ client.crm.users.list(
-
-Returns a `User` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -22360,11 +23503,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.users.retrieve(
- id="id",
+client.accounting.purchase_orders.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,
)
```
@@ -22381,7 +23527,7 @@ client.crm.users.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -22389,7 +23535,7 @@ client.crm.users.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -22397,7 +23543,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.
@@ -22413,6 +23559,30 @@ client.crm.users.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. The maximum limit is 100.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -22425,7 +23595,7 @@ client.crm.users.retrieve(
client.crm.users.ignore_create(...)
+client.accounting.purchase_orders.meta_post_retrieve()
-
@@ -22437,7 +23607,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 metadata for `PurchaseOrder` POSTs.
@@ -22453,18 +23623,12 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```python
from merge import Merge
-from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.users.ignore_create(
- model_id="model_id",
- request=IgnoreCommonModelRequest(
- reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
- ),
-)
+client.accounting.purchase_orders.meta_post_retrieve()
```
@@ -22480,22 +23644,6 @@ client.crm.users.ignore_create(
-
-**model_id:** `str`
-
-
-
-
-
--
-
-**request:** `IgnoreCommonModelRequest`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -22508,7 +23656,7 @@ client.crm.users.ignore_create(
client.crm.users.remote_field_classes_list(...)
+client.accounting.purchase_orders.remote_field_classes_list(...)
-
@@ -22541,11 +23689,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.users.remote_field_classes_list(
+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,
@@ -22590,14 +23737,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).
@@ -22622,7 +23761,7 @@ client.crm.users.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -22642,8 +23781,8 @@ client.crm.users.remote_field_classes_list(
client.crm.webhook_receivers.list()
+## Accounting RegenerateKey
+client.accounting.regenerate_key.create(...)
-
@@ -22655,7 +23794,7 @@ client.crm.users.remote_field_classes_list(
-
-Returns a list of `WebhookReceiver` objects.
+Exchange remote keys.
@@ -22676,7 +23815,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.webhook_receivers.list()
+client.accounting.regenerate_key.create(
+ name="Remote Deployment Key 1",
+)
```
@@ -22692,6 +23833,14 @@ client.crm.webhook_receivers.list()
-
+**name:** `str` β The name of the remote key
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -22704,7 +23853,8 @@ client.crm.webhook_receivers.list()
client.crm.webhook_receivers.create(...)
+## Accounting SalesOrders
+client.accounting.sales_orders.list(...)
-
@@ -22716,7 +23866,7 @@ client.crm.webhook_receivers.list()
-
-Creates a `WebhookReceiver` object with the given values.
+Returns a list of `SalesOrder` objects.
@@ -22731,15 +23881,41 @@ Creates a `WebhookReceiver` object with the given values.
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.webhook_receivers.create(
- event="event",
- is_active=True,
+client.accounting.sales_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,
+ 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",
)
```
@@ -22756,7 +23932,7 @@ client.crm.webhook_receivers.create(
-
-**event:** `str`
+**company_id:** `typing.Optional[str]` β If provided, will only return sales orders for this company.
@@ -22764,7 +23940,7 @@ client.crm.webhook_receivers.create(
-
-**is_active:** `bool`
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -22772,7 +23948,124 @@ client.crm.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**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.Union[
+ SalesOrdersListRequestExpandItem,
+ typing.Sequence[SalesOrdersListRequestExpandItem],
+ ]
+]` β 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).
+
+
+
+
+
+-
+
+**issue_date_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[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)
@@ -22792,8 +24085,7 @@ client.crm.webhook_receivers.create(
client.filestorage.account_details.retrieve()
+client.accounting.sales_orders.create(...)
-
@@ -22805,7 +24097,7 @@ client.crm.webhook_receivers.create(
-
-Get details for a linked account.
+Creates a `SalesOrder` object with the given values.
@@ -22821,12 +24113,17 @@ Get details for a linked account.
```python
from merge import Merge
+from merge.resources.accounting import SalesOrderRequestRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.account_details.retrieve()
+client.accounting.sales_orders.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=SalesOrderRequestRequest(),
+)
```
@@ -22842,6 +24139,30 @@ client.filestorage.account_details.retrieve()
-
+**model:** `SalesOrderRequestRequest`
+
+
+
+
+
+-
+
+**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.
@@ -22854,8 +24175,7 @@ client.filestorage.account_details.retrieve()
client.filestorage.account_token.retrieve(...)
+client.accounting.sales_orders.retrieve(...)
-
@@ -22867,7 +24187,7 @@ client.filestorage.account_details.retrieve()
-
-Returns the account token for the end user with the provided public token.
+Returns a `SalesOrder` object with the given `id`.
@@ -22888,8 +24208,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.account_token.retrieve(
- public_token="public_token",
+client.accounting.sales_orders.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
)
```
@@ -22906,7 +24229,60 @@ client.filestorage.account_token.retrieve(
-
-**public_token:** `str`
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ SalesOrdersRetrieveRequestExpandItem,
+ typing.Sequence[SalesOrdersRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**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)
@@ -22926,8 +24302,7 @@ client.filestorage.account_token.retrieve(
client.filestorage.async_passthrough.create(...)
+client.accounting.sales_orders.bulk_create(...)
-
@@ -22939,7 +24314,7 @@ client.filestorage.account_token.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Creates multiple `SalesOrder` objects with the given values.
@@ -22955,17 +24330,22 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.filestorage import DataPassthroughRequest, MethodEnum
+from merge.resources.accounting import (
+ SalesOrderBatchItemRequest,
+ SalesOrderRequestRequest,
+)
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.sales_orders.bulk_create(
+ batch_items=[
+ SalesOrderBatchItemRequest(
+ item_id="item_id",
+ payload=SalesOrderRequestRequest(),
+ )
+ ],
)
```
@@ -22982,7 +24362,7 @@ client.filestorage.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**batch_items:** `typing.Sequence[SalesOrderBatchItemRequest]`
@@ -23002,7 +24382,7 @@ client.filestorage.async_passthrough.create(
client.filestorage.async_passthrough.retrieve(...)
+client.accounting.sales_orders.bulk_retrieve(...)
-
@@ -23014,7 +24394,7 @@ client.filestorage.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns the status and results of a `SalesOrder` bulk create batch.
@@ -23035,8 +24415,8 @@ 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.sales_orders.bulk_retrieve(
+ batch_id="batch_id",
)
```
@@ -23053,7 +24433,7 @@ client.filestorage.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
+**batch_id:** `str`
@@ -23073,8 +24453,7 @@ client.filestorage.async_passthrough.retrieve(
client.filestorage.audit_trail.list(...)
+client.accounting.sales_orders.lines_remote_field_classes_list(...)
-
@@ -23086,7 +24465,7 @@ client.filestorage.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+Returns a list of `RemoteFieldClass` objects.
@@ -23107,13 +24486,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.audit_trail.list(
+client.accounting.sales_orders.lines_remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
+ 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",
- user_email="user_email",
)
```
@@ -23138,7 +24518,7 @@ client.filestorage.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/).
@@ -23146,7 +24526,7 @@ client.filestorage.audit_trail.list(
-
-**event_type:** `typing.Optional[str]` β If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23154,7 +24534,7 @@ client.filestorage.audit_trail.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23162,7 +24542,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_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
@@ -23170,7 +24550,15 @@ 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.
+**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. The maximum limit is 100.
@@ -23190,8 +24578,7 @@ client.filestorage.audit_trail.list(
client.filestorage.available_actions.retrieve()
+client.accounting.sales_orders.meta_post_retrieve()
-
@@ -23203,7 +24590,7 @@ client.filestorage.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Returns metadata for `SalesOrder` POSTs.
@@ -23224,7 +24611,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.available_actions.retrieve()
+client.accounting.sales_orders.meta_post_retrieve()
```
@@ -23252,8 +24639,7 @@ client.filestorage.available_actions.retrieve()
client.filestorage.scopes.default_scopes_retrieve()
+client.accounting.sales_orders.remote_field_classes_list(...)
-
@@ -23265,7 +24651,7 @@ client.filestorage.available_actions.retrieve()
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a list of `RemoteFieldClass` objects.
@@ -23286,7 +24672,15 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.scopes.default_scopes_retrieve()
+client.accounting.sales_orders.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,
+)
```
@@ -23302,64 +24696,59 @@ client.filestorage.scopes.default_scopes_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
-
+
+-
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-client.filestorage.scopes.linked_account_scopes_retrieve()
-
-#### π Description
-
-
--
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-#### π Usage
-
-
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.scopes.linked_account_scopes_retrieve()
-
-```
-
-
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
+
-#### βοΈ Parameters
-
-
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+
-
@@ -23375,7 +24764,8 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
client.filestorage.scopes.linked_account_scopes_create(...)
+## Accounting SyncStatus
+client.accounting.sync_status.list(...)
-
@@ -23387,7 +24777,7 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+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).
@@ -23403,42 +24793,14 @@ Update permissions for any Common Model or field for a single Linked Account. An
```python
from merge import Merge
-from merge.resources.filestorage import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.scopes.linked_account_scopes_create(
- common_models=[
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Employee",
- model_permissions={
- "READ": ModelPermissionDeserializerRequest(
- is_enabled=True,
- ),
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- ),
- },
- field_permissions=FieldPermissionDeserializerRequest(
- enabled_fields=["avatar", "home_location"],
- disabled_fields=["work_location"],
- ),
- ),
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Benefit",
- model_permissions={
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- )
- },
- ),
- ],
+client.accounting.sync_status.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ page_size=1,
)
```
@@ -23455,7 +24817,15 @@ client.filestorage.scopes.linked_account_scopes_create(
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β The common models you want to update the scopes for
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -23475,8 +24845,8 @@ client.filestorage.scopes.linked_account_scopes_create(
client.filestorage.delete_account.delete()
+## Accounting ForceResync
+client.accounting.force_resync.sync_status_resync_create()
-
@@ -23488,7 +24858,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -23509,7 +24879,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.delete_account.delete()
+client.accounting.force_resync.sync_status_resync_create()
```
@@ -23537,8 +24907,8 @@ client.filestorage.delete_account.delete()
client.filestorage.drives.list(...)
+## Accounting TaxRates
+client.accounting.tax_rates.list(...)
-
@@ -23550,7 +24920,7 @@ client.filestorage.delete_account.delete()
-
-Returns a list of `Drive` objects.
+Returns a list of `TaxRate` objects.
@@ -23573,7 +24943,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.drives.list(
+client.accounting.tax_rates.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -23609,6 +24980,14 @@ client.filestorage.drives.list(
-
+**company_id:** `typing.Optional[str]` β If provided, will only return tax rates for this company.
+
+
+
+
+
+-
+
**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -23633,6 +25012,18 @@ client.filestorage.drives.list(
-
+**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_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -23673,7 +25064,7 @@ client.filestorage.drives.list(
-
-**name:** `typing.Optional[str]` β If provided, will only return drives with this name. This performs an exact match.
+**name:** `typing.Optional[str]` β If provided, will only return TaxRates with this name.
@@ -23681,7 +25072,7 @@ client.filestorage.drives.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -23709,7 +25100,7 @@ client.filestorage.drives.list(
client.filestorage.drives.retrieve(...)
+client.accounting.tax_rates.retrieve(...)
-
@@ -23721,7 +25112,7 @@ client.filestorage.drives.list(
-
-Returns a `Drive` object with the given `id`.
+Returns a `TaxRate` object with the given `id`.
@@ -23742,7 +25133,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.drives.retrieve(
+client.accounting.tax_rates.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -23770,15 +25161,11 @@ 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.
-
-
-
-
-
--
-
-**include_shell_data:** `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[
+ 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.
@@ -23786,71 +25173,15 @@ client.filestorage.drives.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
-
-client.filestorage.field_mapping.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.filestorage.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.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23870,7 +25201,8 @@ client.filestorage.field_mapping.field_mappings_retrieve(
client.filestorage.field_mapping.field_mappings_create(...)
+## Accounting TrackingCategories
+client.accounting.tracking_categories.list(...)
-
@@ -23882,7 +25214,7 @@ client.filestorage.field_mapping.field_mappings_retrieve(
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `TrackingCategory` objects.
@@ -23897,20 +25229,41 @@ Create new Field Mappings that will be available after the next scheduled sync.
-
```python
+import datetime
+
from merge import Merge
+from merge.resources.accounting.resources.tracking_categories import (
+ TrackingCategoriesListRequestCategoryType,
+ TrackingCategoriesListRequestStatus,
+)
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.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,
)
```
@@ -23927,7 +25280,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.
+**category_type:** `typing.Optional[TrackingCategoriesListRequestCategoryType]` β If provided, will only return tracking categories with this type.
@@ -23935,7 +25288,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.
+**company_id:** `typing.Optional[str]` β If provided, will only return tracking categories for this company.
@@ -23943,7 +25296,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` β The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -23951,7 +25304,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
-**remote_method:** `str` β The method of the remote endpoint where the remote field is coming from.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -23959,7 +25312,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.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -23967,7 +25320,11 @@ client.filestorage.field_mapping.field_mappings_create(
-
-**common_model_name:** `str` β The name of the Common Model that the remote field corresponds to in a given category.
+**expand:** `typing.Optional[
+ 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.
@@ -23975,7 +25332,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` β If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -23983,70 +25340,23 @@ client.filestorage.field_mapping.field_mappings_create(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
-
-client.filestorage.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.filestorage.field_mapping.field_mappings_destroy(
- 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).
+
-#### βοΈ Parameters
-
-
--
-
-
-**field_mapping_id:** `str`
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -24054,70 +25364,31 @@ client.filestorage.field_mapping.field_mappings_destroy(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
-
-client.filestorage.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.
-
-
+**name:** `typing.Optional[str]` β If provided, will only return tracking categories with this name.
+
-#### π Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-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",
-)
-
-```
-
-
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
-#### βοΈ Parameters
-
-
--
-
-
-**field_mapping_id:** `str`
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` β Deprecated. Use show_enum_origins.
@@ -24125,7 +25396,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` β The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -24133,7 +25404,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
-**remote_method:** `typing.Optional[str]` β The method of the remote endpoint where the remote field is coming from.
+**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)
@@ -24141,7 +25412,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
-**remote_url_path:** `typing.Optional[str]` β The path of the remote endpoint where the remote field is coming from.
+**status:** `typing.Optional[TrackingCategoriesListRequestStatus]` β If provided, will only return tracking categories with this status.
@@ -24161,7 +25432,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
client.filestorage.field_mapping.remote_fields_retrieve(...)
+client.accounting.tracking_categories.retrieve(...)
-
@@ -24173,7 +25444,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns a `TrackingCategory` object with the given `id`.
@@ -24194,9 +25465,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
+client.accounting.tracking_categories.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -24213,7 +25485,7 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-
-**common_models:** `typing.Optional[str]` β A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+**id:** `str`
@@ -24221,7 +25493,11 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-
-**include_example_values:** `typing.Optional[str]` β If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+**expand:** `typing.Optional[
+ 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.
@@ -24229,64 +25505,35 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
-
-client.filestorage.field_mapping.target_fields_retrieve()
-
-#### π Description
-
-
--
+**include_shell_data:** `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/).
-
-
+**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.filestorage.field_mapping.target_fields_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
-
-
--
-
-
@@ -24302,8 +25549,8 @@ client.filestorage.field_mapping.target_fields_retrieve()
client.filestorage.files.list(...)
+## Accounting Transactions
+client.accounting.transactions.list(...)
-
@@ -24315,7 +25562,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-
-Returns a list of `File` objects.
+Returns a list of `Transaction` objects.
@@ -24333,16 +25580,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(
+client.accounting.transactions.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -24350,29 +25594,23 @@ 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",
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
- mime_type="mime_type",
modified_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- name="name",
- order_by=FilesListRequestOrderBy.CREATED_AT_DESCENDING,
page_size=1,
- remote_created_after=datetime.datetime.fromisoformat(
+ remote_id="remote_id",
+ transaction_date_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- remote_created_before=datetime.datetime.fromisoformat(
+ transaction_date_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- remote_id="remote_id",
)
```
@@ -24389,6 +25627,14 @@ client.filestorage.files.list(
-
+**company_id:** `typing.Optional[str]` β If provided, will only return accounting transactions for this company.
+
+
+
+
+
+-
+
**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -24413,23 +25659,12 @@ client.filestorage.files.list(
-
-**drive_id:** `typing.Optional[str]` β Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[FilesListRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**folder_id:** `typing.Optional[str]` β Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory.
+**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.
@@ -24461,14 +25696,6 @@ 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.
-
-
-
-
-
--
-
**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -24485,23 +25712,7 @@ client.filestorage.files.list(
-
-**name:** `typing.Optional[str]` β If provided, will only return files with this name. This performs an exact match.
-
-
-
-
-
--
-
-**order_by:** `typing.Optional[FilesListRequestOrderBy]` β Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -24509,7 +25720,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_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -24517,7 +25728,7 @@ client.filestorage.files.list(
-
-**remote_created_before:** `typing.Optional[dt.datetime]` β If provided, will only return files created in the third party platform before this datetime.
+**transaction_date_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -24525,7 +25736,7 @@ client.filestorage.files.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.
@@ -24545,7 +25756,7 @@ client.filestorage.files.list(
client.filestorage.files.create(...)
+client.accounting.transactions.retrieve(...)
-
@@ -24557,7 +25768,7 @@ client.filestorage.files.list(
-
-Creates a `File` object with the given values.
+Returns a `Transaction` object with the given `id`.
@@ -24573,16 +25784,15 @@ Creates a `File` object with the given values.
```python
from merge import Merge
-from merge.resources.filestorage import FileRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.create(
- is_debug_mode=True,
- run_async=True,
- model=FileRequest(),
+client.accounting.transactions.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -24599,7 +25809,7 @@ client.filestorage.files.create(
-
-**model:** `FileRequest`
+**id:** `str`
@@ -24607,7 +25817,12 @@ client.filestorage.files.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[
+ TransactionsRetrieveRequestExpandItem,
+ typing.Sequence[TransactionsRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24615,7 +25830,15 @@ client.filestorage.files.create(
-
-**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -24635,7 +25858,8 @@ client.filestorage.files.create(
client.filestorage.files.retrieve(...)
+## Accounting VendorCredits
+client.accounting.vendor_credits.list(...)
-
@@ -24647,7 +25871,7 @@ client.filestorage.files.create(
-
-Returns a `File` object with the given `id`.
+Returns a list of `VendorCredit` objects.
@@ -24662,20 +25886,40 @@ Returns a `File` object with the given `id`.
-
```python
+import datetime
+
from merge import Merge
-from merge.resources.filestorage.resources.files import (
- FilesRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.retrieve(
- id="id",
- expand=FilesRetrieveRequestExpand.DRIVE,
+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",
+ ),
)
```
@@ -24692,7 +25936,7 @@ client.filestorage.files.retrieve(
-
-**id:** `str`
+**company_id:** `typing.Optional[str]` β If provided, will only return vendor credits for this company.
@@ -24700,7 +25944,7 @@ client.filestorage.files.retrieve(
-
-**expand:** `typing.Optional[FilesRetrieveRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -24708,7 +25952,7 @@ client.filestorage.files.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -24716,7 +25960,7 @@ client.filestorage.files.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -24724,71 +25968,76 @@ client.filestorage.files.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**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.
-
-
+
+-
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-client.filestorage.files.download_request_meta_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 to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
-
-
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+
-#### π Usage
-
-
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.files.download_request_meta_retrieve(
- id="id",
- mime_type="mime_type",
-)
-
-```
-
-
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
-#### βοΈ Parameters
-
-
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
+
+
+
-
-**id:** `str`
+**transaction_date_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -24796,7 +26045,7 @@ 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.
+**transaction_date_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -24816,7 +26065,7 @@ client.filestorage.files.download_request_meta_retrieve(
client.filestorage.files.download_request_meta_list(...)
+client.accounting.vendor_credits.create(...)
-
@@ -24828,7 +26077,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.
+Creates a `VendorCredit` object with the given values.
@@ -24844,24 +26093,16 @@ 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.accounting import VendorCreditRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.download_request_meta_list(
- created_after="created_after",
- created_before="created_before",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- mime_types="mime_types",
- modified_after="modified_after",
- modified_before="modified_before",
- order_by=FilesDownloadRequestMetaListRequestOrderBy.CREATED_AT_DESCENDING,
- page_size=1,
+client.accounting.vendor_credits.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=VendorCreditRequest(),
)
```
@@ -24878,7 +26119,7 @@ client.filestorage.files.download_request_meta_list(
-
-**created_after:** `typing.Optional[str]` β If provided, will only return objects created after this datetime.
+**model:** `VendorCreditRequest`
@@ -24886,7 +26127,7 @@ client.filestorage.files.download_request_meta_list(
-
-**created_before:** `typing.Optional[str]` β 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.
@@ -24894,7 +26135,7 @@ client.filestorage.files.download_request_meta_list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -24902,79 +26143,64 @@ client.filestorage.files.download_request_meta_list(
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` β If provided, will only return objects with the given IDs. Comma-separated list of strings.
+**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/).
-
-
--
-**mime_types:** `typing.Optional[str]` β A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article.
-
+
client.accounting.vendor_credits.retrieve(...)
-
-**modified_after:** `typing.Optional[str]` β If provided, will only return objects modified after this datetime.
-
-
-
+#### π Description
-
-**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.
-
+Returns a `VendorCredit` object with the given `id`.
+
+
+#### π Usage
+
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
-
-
-
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
-
-
-
+```python
+from merge import Merge
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.vendor_credits.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+```
+
+
-client.filestorage.files.meta_post_retrieve()
-
--
-#### π Description
+#### βοΈ Parameters
-
@@ -24982,40 +26208,40 @@ client.filestorage.files.download_request_meta_list(
-
-Returns metadata for `FileStorageFile` POSTs.
-
-
+**id:** `str`
+
-#### π Usage
-
-
+**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.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.files.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.
+
-#### βοΈ 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).
+
+
+
+
-
@@ -25031,8 +26257,7 @@ client.filestorage.files.meta_post_retrieve()
client.filestorage.folders.list(...)
+client.accounting.vendor_credits.partial_update(...)
-
@@ -25044,7 +26269,7 @@ client.filestorage.files.meta_post_retrieve()
-
-Returns a list of `Folder` objects.
+Updates a `VendorCredit` object with the given `id`.
@@ -25059,40 +26284,18 @@ Returns a list of `Folder` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.filestorage.resources.folders import (
- FoldersListRequestExpand,
-)
+from merge.resources.accounting import PatchedVendorCreditRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.folders.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- drive_id="drive_id",
- expand=FoldersListRequestExpand.DRIVE,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- name="name",
- page_size=1,
- parent_folder_id="parent_folder_id",
- remote_id="remote_id",
+client.accounting.vendor_credits.partial_update(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedVendorCreditRequest(),
)
```
@@ -25109,7 +26312,7 @@ client.filestorage.folders.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**id:** `str`
@@ -25117,7 +26320,7 @@ client.filestorage.folders.list(
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+**model:** `PatchedVendorCreditRequest`
@@ -25125,7 +26328,7 @@ client.filestorage.folders.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.
@@ -25133,7 +26336,7 @@ client.filestorage.folders.list(
-
-**drive_id:** `typing.Optional[str]` β If provided, will only return folders in this drive.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -25141,39 +26344,78 @@ 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.
+**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.vendor_credits.application_create(...)
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
+#### π Description
+
+
+-
+
+
+-
+
+Creates a new VendorCreditApplyLine to apply a vendor credit to an invoice
+
+
+#### π 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
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.vendor_credits.application_create(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ applied_date=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ applied_amount="applied_amount",
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+
+-
+
+**id:** `str`
@@ -25181,7 +26423,7 @@ client.filestorage.folders.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+**applied_date:** `dt.datetime` β Date that the vendor credit is applied to the invoice.
@@ -25189,7 +26431,7 @@ client.filestorage.folders.list(
-
-**name:** `typing.Optional[str]` β If provided, will only return folders with this name. This performs an exact match.
+**applied_amount:** `str` β The amount of vendor credit applied to the invoice.
@@ -25197,7 +26439,7 @@ client.filestorage.folders.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.
@@ -25205,7 +26447,7 @@ client.filestorage.folders.list(
-
-**parent_folder_id:** `typing.Optional[str]` β If provided, will only return folders in this parent folder. If null, will return folders in root directory.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -25213,7 +26455,7 @@ client.filestorage.folders.list(
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+**invoice:** `typing.Optional[str]` β The invoice to apply the vendor credit to.
@@ -25233,7 +26475,7 @@ client.filestorage.folders.list(
client.filestorage.folders.create(...)
+client.accounting.vendor_credits.meta_patch_retrieve(...)
-
@@ -25245,7 +26487,7 @@ client.filestorage.folders.list(
-
-Creates a `Folder` object with the given values.
+Returns metadata for `VendorCredit` PATCHs.
@@ -25261,16 +26503,13 @@ Creates a `Folder` object with the given values.
```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(),
+client.accounting.vendor_credits.meta_patch_retrieve(
+ id="id",
)
```
@@ -25287,23 +26526,7 @@ client.filestorage.folders.create(
-
-**model:** `FolderRequest`
-
-
-
-
-
--
-
-**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`
@@ -25323,7 +26546,7 @@ client.filestorage.folders.create(
client.filestorage.folders.retrieve(...)
+client.accounting.vendor_credits.meta_post_retrieve()
-
@@ -25335,7 +26558,7 @@ client.filestorage.folders.create(
-
-Returns a `Folder` object with the given `id`.
+Returns metadata for `VendorCredit` POSTs.
@@ -25351,20 +26574,12 @@ 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(
- id="id",
- expand=FoldersRetrieveRequestExpand.DRIVE,
- include_remote_data=True,
- include_shell_data=True,
-)
+client.accounting.vendor_credits.meta_post_retrieve()
```
@@ -25380,38 +26595,6 @@ client.filestorage.folders.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` β 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.
@@ -25424,7 +26607,8 @@ client.filestorage.folders.retrieve(
client.filestorage.folders.meta_post_retrieve()
+## Accounting WebhookReceivers
+client.accounting.webhook_receivers.list()
-
@@ -25436,7 +26620,7 @@ client.filestorage.folders.retrieve(
-
-Returns metadata for `FileStorageFolder` POSTs.
+Returns a list of `WebhookReceiver` objects.
@@ -25457,7 +26641,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.folders.meta_post_retrieve()
+client.accounting.webhook_receivers.list()
```
@@ -25485,8 +26669,7 @@ client.filestorage.folders.meta_post_retrieve()
client.filestorage.generate_key.create(...)
+client.accounting.webhook_receivers.create(...)
-
@@ -25498,7 +26681,7 @@ client.filestorage.folders.meta_post_retrieve()
-
-Create a remote key.
+Creates a `WebhookReceiver` object with the given values.
@@ -25519,8 +26702,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.generate_key.create(
- name="Remote Deployment Key 1",
+client.accounting.webhook_receivers.create(
+ event="event",
+ is_active=True,
)
```
@@ -25537,7 +26721,23 @@ client.filestorage.generate_key.create(
-
-**name:** `str` β The name of the remote key
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
@@ -25557,8 +26757,8 @@ client.filestorage.generate_key.create(
client.filestorage.groups.list(...)
+## Crm AccountDetails
+client.crm.account_details.retrieve()
-
@@ -25570,7 +26770,7 @@ client.filestorage.generate_key.create(
-
-Returns a list of `Group` objects.
+Get details for a linked account.
@@ -25585,34 +26785,13 @@ Returns a list of `Group` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.groups.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- 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.account_details.retrieve()
```
@@ -25628,87 +26807,71 @@ client.filestorage.groups.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
-
-
--
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
+
client.crm.account_token.retrieve(...)
-
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
+#### π 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.
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+#### π Usage
+
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.account_token.retrieve(
+ public_token="public_token",
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
-
-
-
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+**public_token:** `str`
@@ -25728,7 +26891,7 @@ client.filestorage.groups.list(
client.filestorage.groups.retrieve(...)
+client.crm.account_token.regenerate_create()
-
@@ -25740,7 +26903,7 @@ client.filestorage.groups.list(
-
-Returns a `Group` object with the given `id`.
+Exchange Linked Account account tokens.
@@ -25761,11 +26924,7 @@ 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.account_token.regenerate_create()
```
@@ -25781,38 +26940,6 @@ 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).
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -25825,8 +26952,8 @@ client.filestorage.groups.retrieve(
client.filestorage.issues.list(...)
+## Crm Accounts
+client.crm.accounts.list(...)
-
@@ -25838,7 +26965,7 @@ client.filestorage.groups.retrieve(
-
-Gets all issues for Organization.
+Returns a list of `Account` objects.
@@ -25856,35 +26983,33 @@ 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(
+client.crm.accounts.list(
+ created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- first_incident_time_before=datetime.datetime.fromisoformat(
+ created_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ 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",
+ name="name",
+ owner_id="owner_id",
page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
+ remote_id="remote_id",
)
```
@@ -25901,7 +27026,7 @@ client.filestorage.issues.list(
-
-**account_token:** `typing.Optional[str]`
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -25909,7 +27034,7 @@ client.filestorage.issues.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -25917,7 +27042,7 @@ client.filestorage.issues.list(
-
-**end_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred before this time
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -25925,7 +27050,11 @@ client.filestorage.issues.list(
-
-**end_user_organization_name:** `typing.Optional[str]`
+**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.
@@ -25933,7 +27062,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.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -25941,7 +27070,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_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25949,7 +27078,7 @@ client.filestorage.issues.list(
-
-**include_muted:** `typing.Optional[str]` β If true, will include muted issues
+**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.
@@ -25957,7 +27086,7 @@ client.filestorage.issues.list(
-
-**integration_name:** `typing.Optional[str]`
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25965,7 +27094,7 @@ client.filestorage.issues.list(
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was after this datetime.
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -25973,7 +27102,7 @@ client.filestorage.issues.list(
-
-**last_incident_time_before:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was before this datetime.
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -25981,7 +27110,7 @@ client.filestorage.issues.list(
-
-**linked_account_id:** `typing.Optional[str]` β If provided, will only include issues pertaining to the linked account passed in.
+**name:** `typing.Optional[str]` β If provided, will only return accounts with this name.
@@ -25989,7 +27118,7 @@ client.filestorage.issues.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**owner_id:** `typing.Optional[str]` β If provided, will only return accounts with this owner.
@@ -25997,7 +27126,7 @@ client.filestorage.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. The maximum limit is 100.
@@ -26005,12 +27134,7 @@ client.filestorage.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.
@@ -26030,7 +27154,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
client.filestorage.issues.retrieve(...)
+client.crm.accounts.create(...)
-
@@ -26042,7 +27166,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Creates an `Account` object with the given values.
@@ -26058,13 +27182,16 @@ Get a specific issue.
```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.issues.retrieve(
- id="id",
+client.crm.accounts.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=AccountRequest(),
)
```
@@ -26081,7 +27208,23 @@ client.filestorage.issues.retrieve(
-
-**id:** `str`
+**model:** `AccountRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -26101,8 +27244,7 @@ client.filestorage.issues.retrieve(
client.filestorage.link_token.create(...)
+client.crm.accounts.retrieve(...)
-
@@ -26114,7 +27256,7 @@ client.filestorage.issues.retrieve(
-
-Creates a link token to be used when linking a new end user.
+Returns an `Account` object with the given `id`.
@@ -26130,17 +27272,16 @@ 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.accounts.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
)
```
@@ -26157,71 +27298,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.
-
-
-
-
-
--
-
-**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.
+**id:** `str`
@@ -26229,14 +27306,11 @@ client.filestorage.link_token.create(
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["owner"], typing.Sequence[typing.Literal["owner"]]
]
-]` β 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.
@@ -26244,12 +27318,7 @@ client.filestorage.link_token.create(
-
-**language:** `typing.Optional[LanguageEnum]`
-
-The following subset of IETF language tags can be used to configure localization.
-
-* `en` - en
-* `de` - de
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26257,7 +27326,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_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.
@@ -26265,7 +27334,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_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -26285,8 +27354,7 @@ The following subset of IETF language tags can be used to configure localization
client.filestorage.linked_accounts.list(...)
+client.crm.accounts.partial_update(...)
-
@@ -26298,7 +27366,7 @@ The following subset of IETF language tags can be used to configure localization
-
-List linked accounts for your organization.
+Updates an `Account` object with the given `id`.
@@ -26314,28 +27382,17 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.filestorage.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
+from merge.resources.crm import PatchedAccountRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_user_email_address="end_user_email_address",
- end_user_organization_name="end_user_organization_name",
- end_user_origin_id="end_user_origin_id",
- end_user_origin_ids="end_user_origin_ids",
+client.crm.accounts.partial_update(
id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedAccountRequest(),
)
```
@@ -26352,17 +27409,7 @@ client.filestorage.linked_accounts.list(
-
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-* `hris` - hris
-* `ats` - ats
-* `accounting` - accounting
-* `ticketing` - ticketing
-* `crm` - crm
-* `mktg` - mktg
-* `filestorage` - filestorage
+**id:** `str`
@@ -26370,7 +27417,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**model:** `PatchedAccountRequest`
@@ -26378,7 +27425,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.
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -26386,7 +27433,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.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -26394,71 +27441,70 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
-
--
-**end_user_origin_ids:** `typing.Optional[str]` β Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
-
+client.crm.accounts.meta_patch_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 `CRMAccount` PATCHs.
+
+
+#### π Usage
+
-
-**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.
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.accounts.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+#### βοΈ Parameters
-
-**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`
+**id:** `str`
@@ -26478,8 +27524,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
client.filestorage.passthrough.create(...)
+client.crm.accounts.meta_post_retrieve()
-
@@ -26491,7 +27536,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-Pull data from an endpoint not currently supported by Merge.
+Returns metadata for `CRMAccount` POSTs.
@@ -26507,18 +27552,12 @@ Pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.filestorage import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
-)
+client.crm.accounts.meta_post_retrieve()
```
@@ -26534,14 +27573,6 @@ client.filestorage.passthrough.create(
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -26554,8 +27585,7 @@ client.filestorage.passthrough.create(
client.filestorage.regenerate_key.create(...)
+client.crm.accounts.remote_field_classes_list(...)
-
@@ -26567,7 +27597,7 @@ client.filestorage.passthrough.create(
-
-Exchange remote keys.
+Returns a list of `RemoteFieldClass` objects.
@@ -26588,8 +27618,15 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.regenerate_key.create(
- name="Remote Deployment Key 1",
+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,
)
```
@@ -26606,7 +27643,7 @@ client.filestorage.regenerate_key.create(
-
-**name:** `str` β The name of the remote key
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -26614,32 +27651,88 @@ client.filestorage.regenerate_key.create(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
+
+-
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
-client.filestorage.sync_status.list(...)
-
-#### π Description
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
-
-
--
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-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).
+
+-
+
+**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. The maximum limit is 100.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.async_passthrough.create(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -26655,14 +27748,17 @@ Get sync status for the current sync and the most recently finished sync. `last_
```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.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
+client.crm.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -26679,15 +27775,7 @@ client.filestorage.sync_status.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
+**request:** `DataPassthroughRequest`
@@ -26707,8 +27795,7 @@ client.filestorage.sync_status.list(
client.filestorage.force_resync.sync_status_resync_create()
+client.crm.async_passthrough.retrieve(...)
-
@@ -26720,7 +27807,7 @@ client.filestorage.sync_status.list(
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+Retrieves data from earlier async-passthrough POST request
@@ -26741,7 +27828,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.force_resync.sync_status_resync_create()
+client.crm.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
+)
```
@@ -26757,6 +27846,14 @@ client.filestorage.force_resync.sync_status_resync_create()
-
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -26769,8 +27866,8 @@ client.filestorage.force_resync.sync_status_resync_create()
client.filestorage.users.list(...)
+## Crm AuditTrail
+client.crm.audit_trail.list(...)
-
@@ -26782,7 +27879,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-
-Returns a list of `User` objects.
+Gets a list of audit trail events.
@@ -26797,34 +27894,19 @@ 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",
- ),
+client.crm.audit_trail.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- is_me="is_me",
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+ end_date="end_date",
+ event_type="event_type",
page_size=1,
- remote_id="remote_id",
+ start_date="start_date",
+ user_email="user_email",
)
```
@@ -26841,7 +27923,7 @@ client.filestorage.users.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.
@@ -26849,7 +27931,7 @@ client.filestorage.users.list(
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+**end_date:** `typing.Optional[str]` β If included, will only include audit trail events that occurred before this time
@@ -26857,7 +27939,7 @@ client.filestorage.users.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**event_type:** `typing.Optional[str]` β If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -26865,7 +27947,7 @@ client.filestorage.users.list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -26873,7 +27955,7 @@ client.filestorage.users.list(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**start_date:** `typing.Optional[str]` β If included, will only include audit trail events that occurred after this time
@@ -26881,7 +27963,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).
+**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.
@@ -26889,43 +27971,65 @@ client.filestorage.users.list(
-
-**is_me:** `typing.Optional[str]` β If provided, will only return the user object for requestor.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
-
--
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
+client.crm.available_actions.retrieve()
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
-
-
-
+#### π Description
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+#### π Usage
+
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.available_actions.retrieve()
+
+```
+
+
+#### βοΈ Parameters
+
+
+-
+
-
@@ -26941,7 +28045,8 @@ client.filestorage.users.list(
client.filestorage.users.retrieve(...)
+## Crm Contacts
+client.crm.contacts.list(...)
-
@@ -26953,7 +28058,7 @@ client.filestorage.users.list(
-
-Returns a `User` object with the given `id`.
+Returns a list of `Contact` objects.
@@ -26968,16 +28073,37 @@ Returns a `User` 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.filestorage.users.retrieve(
- id="id",
+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",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ email_addresses="email_addresses",
+ 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",
)
```
@@ -26994,7 +28120,7 @@ client.filestorage.users.retrieve(
-
-**id:** `str`
+**account_id:** `typing.Optional[str]` β If provided, will only return contacts with this account.
@@ -27002,7 +28128,7 @@ client.filestorage.users.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -27010,7 +28136,7 @@ client.filestorage.users.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -27018,65 +28144,104 @@ client.filestorage.users.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+-
+
+**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[
+ typing.Union[
+ ContactsListRequestExpandItem,
+ typing.Sequence[ContactsListRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
-
client.filestorage.webhook_receivers.list()
-
-#### π Description
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
-
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
-
-Returns a list of `WebhookReceiver` objects.
+**include_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).
+
-#### π 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
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.webhook_receivers.list()
+
+-
-```
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+-
+
+**phone_numbers:** `typing.Optional[str]` β If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
+
-#### βοΈ Parameters
-
-
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
+
+
+
-
@@ -27092,7 +28257,7 @@ client.filestorage.webhook_receivers.list()
client.filestorage.webhook_receivers.create(...)
+client.crm.contacts.create(...)
-
@@ -27104,7 +28269,7 @@ client.filestorage.webhook_receivers.list()
-
-Creates a `WebhookReceiver` object with the given values.
+Creates a `Contact` object with the given values.
@@ -27120,14 +28285,16 @@ Creates a `WebhookReceiver` 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.filestorage.webhook_receivers.create(
- event="event",
- is_active=True,
+client.crm.contacts.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=ContactRequest(),
)
```
@@ -27144,7 +28311,7 @@ client.filestorage.webhook_receivers.create(
-
-**event:** `str`
+**model:** `ContactRequest`
@@ -27152,7 +28319,7 @@ client.filestorage.webhook_receivers.create(
-
-**is_active:** `bool`
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -27160,7 +28327,7 @@ client.filestorage.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -27180,8 +28347,7 @@ client.filestorage.webhook_receivers.create(
client.hris.account_details.retrieve()
+client.crm.contacts.retrieve(...)
-
@@ -27193,7 +28359,7 @@ client.filestorage.webhook_receivers.create(
-
-Get details for a linked account.
+Returns a `Contact` object with the given `id`.
@@ -27214,7 +28380,12 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.account_details.retrieve()
+client.crm.contacts.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
```
@@ -27230,71 +28401,44 @@ client.hris.account_details.retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**id:** `str`
-
-
-
-
-
-
-client.hris.account_token.retrieve(...)
-
-#### π Description
-
-
--
+**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.
+
+
+
-
-Returns the account token for the end user with the provided public token.
-
-
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### π Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.account_token.retrieve(
- public_token="public_token",
-)
-
-```
-
-
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
-#### βοΈ 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).
@@ -27314,8 +28458,7 @@ client.hris.account_token.retrieve(
client.hris.async_passthrough.create(...)
+client.crm.contacts.partial_update(...)
-
@@ -27327,7 +28470,7 @@ client.hris.account_token.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Updates a `Contact` object with the given `id`.
@@ -27343,17 +28486,17 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.hris import DataPassthroughRequest, MethodEnum
+from merge.resources.crm import PatchedContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.async_passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+client.crm.contacts.partial_update(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedContactRequest(),
)
```
@@ -27370,7 +28513,31 @@ client.hris.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**id:** `str`
+
+
+
+
+
+-
+
+**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.
@@ -27390,7 +28557,7 @@ client.hris.async_passthrough.create(
client.hris.async_passthrough.retrieve(...)
+client.crm.contacts.ignore_create(...)
-
@@ -27402,7 +28569,7 @@ client.hris.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+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.
@@ -27418,13 +28585,17 @@ Retrieves data from earlier async-passthrough POST request
```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.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_id",
+client.crm.contacts.ignore_create(
+ model_id="model_id",
+ request=IgnoreCommonModelRequest(
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+ ),
)
```
@@ -27441,7 +28612,15 @@ client.hris.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
+**model_id:** `str`
+
+
+
+
+
+-
+
+**request:** `IgnoreCommonModelRequest`
@@ -27461,8 +28640,7 @@ client.hris.async_passthrough.retrieve(
client.hris.audit_trail.list(...)
+client.crm.contacts.meta_patch_retrieve(...)
-
@@ -27474,7 +28652,7 @@ client.hris.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+Returns metadata for `CRMContact` PATCHs.
@@ -27495,13 +28673,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.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.crm.contacts.meta_patch_retrieve(
+ id="id",
)
```
@@ -27518,47 +28691,7 @@ client.hris.audit_trail.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` β If included, will only include audit trail events that occurred before this time
-
-
-
-
-
--
-
-**event_type:** `typing.Optional[str]` β If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
-
-
-
-
--
-
-**start_date:** `typing.Optional[str]` β If included, will only include audit trail events that occurred after this time
-
-
-
-
-
--
-
-**user_email:** `typing.Optional[str]` β If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+**id:** `str`
@@ -27578,8 +28711,7 @@ client.hris.audit_trail.list(
client.hris.available_actions.retrieve()
+client.crm.contacts.meta_post_retrieve()
-
@@ -27591,7 +28723,7 @@ client.hris.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Returns metadata for `CRMContact` POSTs.
@@ -27612,7 +28744,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.available_actions.retrieve()
+client.crm.contacts.meta_post_retrieve()
```
@@ -27640,8 +28772,7 @@ client.hris.available_actions.retrieve()
client.hris.bank_info.list(...)
+client.crm.contacts.remote_field_classes_list(...)
-
@@ -27653,7 +28784,7 @@ client.hris.available_actions.retrieve()
-
-Returns a list of `BankInfo` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -27668,41 +28799,21 @@ Returns a list of `BankInfo` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.hris.resources.bank_info import (
- BankInfoListRequestAccountType,
- BankInfoListRequestOrderBy,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.bank_info.list(
- account_type=BankInfoListRequestAccountType.CHECKING,
- bank_name="bank_name",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+client.crm.contacts.remote_field_classes_list(
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",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- order_by=BankInfoListRequestOrderBy.REMOTE_CREATED_AT_DESCENDING,
+ is_common_model_field=True,
+ is_custom=True,
page_size=1,
- remote_id="remote_id",
)
```
@@ -27719,43 +28830,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.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -27764,22 +28838,6 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**employee_id:** `typing.Optional[str]` β If provided, will only return bank accounts for this employee.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -27796,7 +28854,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**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.
@@ -27804,7 +28862,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27812,7 +28870,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
@@ -27820,7 +28878,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.
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
@@ -27836,143 +28894,6 @@ 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.
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.hris.bank_info.retrieve(...)
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Returns a `BankInfo` object with the given `id`.
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.bank_info.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` β Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -27985,8 +28906,8 @@ client.hris.bank_info.retrieve(
client.hris.benefits.list(...)
+## Crm CustomObjectClasses
+client.crm.custom_object_classes.list(...)
-
@@ -27998,7 +28919,7 @@ client.hris.bank_info.retrieve(
-
-Returns a list of `Benefit` objects.
+Returns a list of `CustomObjectClass` objects.
@@ -28021,7 +28942,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.benefits.list(
+client.crm.custom_object_classes.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -28029,7 +28950,6 @@ client.hris.benefits.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
@@ -28081,15 +29001,11 @@ client.hris.benefits.list(
-
-**employee_id:** `typing.Optional[str]` β If provided, will return the benefits associated with the employee.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.
@@ -28165,7 +29081,7 @@ client.hris.benefits.list(
client.hris.benefits.retrieve(...)
+client.crm.custom_object_classes.retrieve(...)
-
@@ -28177,7 +29093,7 @@ client.hris.benefits.list(
-
-Returns a `Benefit` object with the given `id`.
+Returns a `CustomObjectClass` object with the given `id`.
@@ -28198,7 +29114,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.benefits.retrieve(
+client.crm.custom_object_classes.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -28226,7 +29142,11 @@ 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.
+**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.
@@ -28262,8 +29182,8 @@ client.hris.benefits.retrieve(
client.hris.companies.list(...)
+## Crm AssociationTypes
+client.crm.association_types.custom_object_classes_association_types_list(...)
-
@@ -28275,7 +29195,7 @@ client.hris.benefits.retrieve(
-
-Returns a list of `Company` objects.
+Returns a list of `AssociationType` objects.
@@ -28298,7 +29218,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.companies.list(
+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",
),
@@ -28333,6 +29254,14 @@ client.hris.companies.list(
-
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -28357,6 +29286,19 @@ client.hris.companies.list(
-
+**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/).
@@ -28425,7 +29367,7 @@ client.hris.companies.list(
client.hris.companies.retrieve(...)
+client.crm.association_types.custom_object_classes_association_types_create(...)
-
@@ -28437,7 +29379,7 @@ client.hris.companies.list(
-
-Returns a `Company` object with the given `id`.
+Creates an `AssociationType` object with the given values.
@@ -28453,15 +29395,33 @@ Returns a `Company` object with the given `id`.
```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.hris.companies.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+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",
+ ),
)
```
@@ -28478,7 +29438,7 @@ client.hris.companies.retrieve(
-
-**id:** `str`
+**custom_object_class_id:** `str`
@@ -28486,7 +29446,7 @@ client.hris.companies.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**model:** `AssociationTypeRequestRequest`
@@ -28494,7 +29454,7 @@ client.hris.companies.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -28502,64 +29462,10 @@ client.hris.companies.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
-
-client.hris.scopes.default_scopes_retrieve()
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.scopes.default_scopes_retrieve()
-
-```
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
@@ -28576,7 +29482,7 @@ client.hris.scopes.default_scopes_retrieve()
client.hris.scopes.linked_account_scopes_retrieve()
+client.crm.association_types.custom_object_classes_association_types_retrieve(...)
-
@@ -28588,7 +29494,7 @@ client.hris.scopes.default_scopes_retrieve()
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns an `AssociationType` object with the given `id`.
@@ -28609,7 +29515,12 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.scopes.linked_account_scopes_retrieve()
+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,
+)
```
@@ -28625,99 +29536,44 @@ client.hris.scopes.linked_account_scopes_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**custom_object_class_id:** `str`
-
-
-
-
-
-
-client.hris.scopes.linked_account_scopes_create(...)
-
-#### π Description
-
-
--
+**id:** `str`
+
+
+
-
-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)
-
-
+**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.
+
-#### π Usage
-
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.scopes.linked_account_scopes_create(
- common_models=[
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Employee",
- model_permissions={
- "READ": ModelPermissionDeserializerRequest(
- is_enabled=True,
- ),
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- ),
- },
- field_permissions=FieldPermissionDeserializerRequest(
- enabled_fields=["avatar", "home_location"],
- disabled_fields=["work_location"],
- ),
- ),
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Benefit",
- model_permissions={
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- )
- },
- ),
- ],
-)
-
-```
-
-
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### βοΈ Parameters
-
-
--
-
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β The common models you want to update the scopes for
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28737,8 +29593,7 @@ client.hris.scopes.linked_account_scopes_create(
client.hris.delete_account.delete()
+client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
-
@@ -28750,7 +29605,7 @@ client.hris.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Returns metadata for `CRMAssociationType` POSTs.
@@ -28771,7 +29626,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.delete_account.delete()
+client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(
+ custom_object_class_id="custom_object_class_id",
+)
```
@@ -28787,6 +29644,14 @@ client.hris.delete_account.delete()
-
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -28799,8 +29664,8 @@ client.hris.delete_account.delete()
client.hris.dependents.list(...)
+## Crm CustomObjects
+client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
-
@@ -28812,7 +29677,7 @@ client.hris.delete_account.delete()
-
-Returns a list of `Dependent` objects.
+Returns a list of `CustomObject` objects.
@@ -28835,7 +29700,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.dependents.list(
+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",
),
@@ -28843,10 +29709,9 @@ client.hris.dependents.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
include_deleted_data=True,
include_remote_data=True,
- include_sensitive_fields=True,
+ include_remote_fields=True,
include_shell_data=True,
modified_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -28872,7 +29737,7 @@ client.hris.dependents.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**custom_object_class_id:** `str`
@@ -28880,7 +29745,7 @@ client.hris.dependents.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.
@@ -28888,7 +29753,7 @@ client.hris.dependents.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.
@@ -28896,7 +29761,7 @@ client.hris.dependents.list(
-
-**employee_id:** `typing.Optional[str]` β If provided, will only return dependents for this employee.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -28920,7 +29785,7 @@ client.hris.dependents.list(
-
-**include_sensitive_fields:** `typing.Optional[bool]` β Whether to include sensitive fields (such as social security numbers) in the response.
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -28980,7 +29845,7 @@ client.hris.dependents.list(
client.hris.dependents.retrieve(...)
+client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
-
@@ -28992,7 +29857,7 @@ client.hris.dependents.list(
-
-Returns a `Dependent` object with the given `id`.
+Creates a `CustomObject` object with the given values.
@@ -29008,16 +29873,19 @@ Returns a `Dependent` object with the given `id`.
```python
from merge import Merge
+from merge.resources.crm import CustomObjectRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.dependents.retrieve(
- id="id",
- include_remote_data=True,
- include_sensitive_fields=True,
- include_shell_data=True,
+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"},
+ ),
)
```
@@ -29034,7 +29902,7 @@ client.hris.dependents.retrieve(
-
-**id:** `str`
+**custom_object_class_id:** `str`
@@ -29042,7 +29910,7 @@ client.hris.dependents.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**model:** `CustomObjectRequest`
@@ -29050,7 +29918,7 @@ client.hris.dependents.retrieve(
-
-**include_sensitive_fields:** `typing.Optional[bool]` β Whether to include sensitive fields (such as social security numbers) in the response.
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -29058,7 +29926,7 @@ client.hris.dependents.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -29078,8 +29946,7 @@ client.hris.dependents.retrieve(
client.hris.employee_payroll_runs.list(...)
+client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
-
@@ -29091,7 +29958,7 @@ client.hris.dependents.retrieve(
-
-Returns a list of `EmployeePayrollRun` objects.
+Returns a `CustomObject` object with the given `id`.
@@ -29106,51 +29973,18 @@ Returns a list of `EmployeePayrollRun` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.hris.resources.employee_payroll_runs import (
- EmployeePayrollRunsListRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.employee_payroll_runs.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- ended_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- ended_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- expand=EmployeePayrollRunsListRequestExpand.EMPLOYEE,
- include_deleted_data=True,
+client.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,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- payroll_run_id="payroll_run_id",
- remote_id="remote_id",
- started_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- started_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
)
```
@@ -29167,7 +30001,7 @@ client.hris.employee_payroll_runs.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**custom_object_class_id:** `str`
@@ -29175,7 +30009,7 @@ client.hris.employee_payroll_runs.list(
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+**id:** `str`
@@ -29183,7 +30017,7 @@ client.hris.employee_payroll_runs.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29191,7 +30025,7 @@ client.hris.employee_payroll_runs.list(
-
-**employee_id:** `typing.Optional[str]` β If provided, will only return employee payroll runs for this 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.
@@ -29199,7 +30033,7 @@ client.hris.employee_payroll_runs.list(
-
-**ended_after:** `typing.Optional[dt.datetime]` β If provided, will only return employee payroll runs ended 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).
@@ -29207,95 +30041,70 @@ client.hris.employee_payroll_runs.list(
-
-**ended_before:** `typing.Optional[dt.datetime]` β If provided, will only return employee payroll runs ended before this datetime.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
--
-
-**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
--
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
+
client.crm.custom_objects.custom_object_classes_custom_objects_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 `CRMCustomObject` POSTs.
-
-
--
-
-**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.
-
-
-
-
-
-**payroll_run_id:** `typing.Optional[str]` β If provided, will only return employee payroll runs for this employee.
-
-
-
+```python
+from merge import Merge
-
--
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(
+ custom_object_class_id="custom_object_class_id",
+)
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
+```
+
+
+#### βοΈ Parameters
+
-
-**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return employee payroll runs started after this datetime.
-
-
-
-
-
-**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return employee payroll runs started before this datetime.
+**custom_object_class_id:** `str`
@@ -29315,7 +30124,7 @@ client.hris.employee_payroll_runs.list(
client.hris.employee_payroll_runs.retrieve(...)
+client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
-
@@ -29327,7 +30136,7 @@ client.hris.employee_payroll_runs.list(
-
-Returns an `EmployeePayrollRun` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -29343,19 +30152,20 @@ 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(
- id="id",
- expand=EmployeePayrollRunsRetrieveRequestExpand.EMPLOYEE,
+client.crm.custom_objects.custom_object_classes_custom_objects_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,
)
```
@@ -29372,7 +30182,7 @@ client.hris.employee_payroll_runs.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -29380,7 +30190,7 @@ 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_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -29396,6 +30206,14 @@ client.hris.employee_payroll_runs.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).
@@ -29404,6 +30222,30 @@ client.hris.employee_payroll_runs.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. The maximum limit is 100.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -29416,8 +30258,8 @@ client.hris.employee_payroll_runs.retrieve(
client.hris.employees.list(...)
+## Crm Associations
+client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
-
@@ -29429,7 +30271,7 @@ client.hris.employee_payroll_runs.retrieve(
-
-Returns a list of `Employee` objects.
+Returns a list of `Association` objects.
@@ -29447,19 +30289,15 @@ 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",
+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",
),
@@ -29467,21 +30305,9 @@ 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",
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",
),
@@ -29489,26 +30315,7 @@ client.hris.employees.list(
"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",
)
```
@@ -29525,7 +30332,23 @@ client.hris.employees.list(
-
-**company_id:** `typing.Optional[str]` β If provided, will only return employees for this company.
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**object_id:** `str`
+
+
+
+
+
+-
+
+**association_type_id:** `typing.Optional[str]` β If provided, will only return opportunities with this association_type.
@@ -29557,15 +30380,12 @@ client.hris.employees.list(
-
-**display_full_name:** `typing.Optional[str]` β If provided, will only return employees with this display name.
-
-
-
-
-
--
-
-**employee_number:** `typing.Optional[str]` β If provided, will only return employees with this employee number.
+**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.
@@ -29573,13 +30393,7 @@ client.hris.employees.list(
-
-**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]`
-
-If provided, will only return employees with this employment status.
-
-* `ACTIVE` - ACTIVE
-* `PENDING` - PENDING
-* `INACTIVE` - INACTIVE
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -29587,7 +30401,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_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29595,7 +30409,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_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -29603,7 +30417,7 @@ If provided, will only return employees with this employment status.
-
-**first_name:** `typing.Optional[str]` β If provided, will only return employees with this first name.
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -29611,7 +30425,7 @@ If provided, will only return employees with this employment status.
-
-**groups:** `typing.Optional[str]` β If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -29619,7 +30433,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.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -29627,7 +30441,7 @@ If provided, will only return employees with this employment status.
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -29635,119 +30449,76 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
--
-
-**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).
-
+
client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
-
-**job_title:** `typing.Optional[str]` β If provided, will only return employees that have an employment of the specified job title.
-
-
-
+#### π Description
-
-**last_name:** `typing.Optional[str]` β If provided, will only return employees with this last name.
-
-
-
-
-
-**manager_id:** `typing.Optional[str]` β If provided, will only return employees for this manager.
-
+Creates an Association between `source_object_id` and `target_object_id` of type `association_type_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.
-
-
-
+#### π Usage
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
-
-
-
-
-**pay_group_id:** `typing.Optional[str]` β If provided, will only return employees for this pay group
-
-
-
+```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,
+)
-**personal_email:** `typing.Optional[str]` β If provided, will only return Employees with this personal email
-
+```
-
-
--
-
-**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
-
-
--
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
-
-
+#### βοΈ Parameters
-
-**show_enum_origins:** `typing.Optional[EmployeesListRequestShowEnumOrigins]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
-**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return employees that started after this datetime.
+**source_class_id:** `str`
@@ -29755,7 +30526,7 @@ If provided, will only return employees with this employment status.
-
-**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return employees that started before this datetime.
+**source_object_id:** `str`
@@ -29763,7 +30534,7 @@ If provided, will only return employees with this employment status.
-
-**team_id:** `typing.Optional[str]` β If provided, will only return employees for this team.
+**target_class_id:** `str`
@@ -29771,7 +30542,7 @@ If provided, will only return employees with this employment status.
-
-**terminated_after:** `typing.Optional[dt.datetime]` β If provided, will only return employees that were terminated after this datetime.
+**target_object_id:** `str`
@@ -29779,7 +30550,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.
+**association_type_id:** `str`
@@ -29787,7 +30558,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
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -29795,7 +30566,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.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -29815,7 +30586,8 @@ If provided, will only return employees with this employment status.
client.hris.employees.create(...)
+## Crm Scopes
+client.crm.scopes.default_scopes_retrieve()
-
@@ -29827,7 +30599,7 @@ If provided, will only return employees with this employment status.
-
-Creates an `Employee` object with the given values.
+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).
@@ -29843,17 +30615,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.scopes.default_scopes_retrieve()
```
@@ -29869,30 +30636,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 +30648,7 @@ client.hris.employees.create(
client.hris.employees.retrieve(...)
+client.crm.scopes.linked_account_scopes_retrieve()
-
@@ -29917,7 +30660,7 @@ client.hris.employees.create(
-
-Returns an `Employee` object with the given `id`.
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -29933,25 +30676,12 @@ 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,
- include_remote_data=True,
- include_sensitive_fields=True,
- include_shell_data=True,
- remote_fields=EmployeesRetrieveRequestRemoteFields.EMPLOYMENT_STATUS,
- show_enum_origins=EmployeesRetrieveRequestShowEnumOrigins.EMPLOYMENT_STATUS,
-)
+client.crm.scopes.linked_account_scopes_retrieve()
```
@@ -29967,62 +30697,6 @@ client.hris.employees.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_sensitive_fields:** `typing.Optional[bool]` β Whether to include sensitive fields (such as social security numbers) in the response.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**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.
@@ -30035,7 +30709,7 @@ client.hris.employees.retrieve(
client.hris.employees.ignore_create(...)
+client.crm.scopes.linked_account_scopes_create(...)
-
@@ -30047,7 +30721,7 @@ client.hris.employees.retrieve(
-
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -30063,15 +30737,42 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```python
from merge import Merge
-from merge.resources.hris import ReasonEnum
+from merge.resources.crm import (
+ FieldPermissionDeserializerRequest,
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.employees.ignore_create(
- model_id="model_id",
- reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+client.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,
+ )
+ },
+ ),
+ ],
)
```
@@ -30088,23 +30789,7 @@ client.hris.employees.ignore_create(
-
-**model_id:** `str`
-
-
-
-
-
--
-
-**reason:** `IgnoreCommonModelRequestReason`
-
-
-
-
-
--
-
-**message:** `typing.Optional[str]`
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β The common models you want to update the scopes for
@@ -30124,7 +30809,8 @@ client.hris.employees.ignore_create(
client.hris.employees.meta_post_retrieve()
+## Crm DeleteAccount
+client.crm.delete_account.delete()
-
@@ -30136,7 +30822,7 @@ client.hris.employees.ignore_create(
-
-Returns metadata for `Employee` POSTs.
+Delete a linked account.
@@ -30157,7 +30843,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.employees.meta_post_retrieve()
+client.crm.delete_account.delete()
```
@@ -30185,8 +30871,8 @@ client.hris.employees.meta_post_retrieve()
client.hris.employer_benefits.list(...)
+## Crm EngagementTypes
+client.crm.engagement_types.list(...)
-
@@ -30198,7 +30884,7 @@ client.hris.employees.meta_post_retrieve()
-
-Returns a list of `EmployerBenefit` objects.
+Returns a list of `EngagementType` objects.
@@ -30221,7 +30907,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.employer_benefits.list(
+client.crm.engagement_types.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -30231,6 +30917,7 @@ client.hris.employer_benefits.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",
@@ -30296,6 +30983,14 @@ client.hris.employer_benefits.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).
@@ -30348,7 +31043,7 @@ client.hris.employer_benefits.list(
client.hris.employer_benefits.retrieve(...)
+client.crm.engagement_types.retrieve(...)
-
@@ -30360,7 +31055,7 @@ client.hris.employer_benefits.list(
-
-Returns an `EmployerBenefit` object with the given `id`.
+Returns an `EngagementType` object with the given `id`.
@@ -30381,9 +31076,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.employer_benefits.retrieve(
+client.crm.engagement_types.retrieve(
id="id",
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
)
@@ -30417,6 +31113,14 @@ client.hris.employer_benefits.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).
@@ -30437,8 +31141,7 @@ client.hris.employer_benefits.retrieve(
client.hris.employments.list(...)
+client.crm.engagement_types.remote_field_classes_list(...)
-
@@ -30450,7 +31153,7 @@ client.hris.employer_benefits.retrieve(
-
-Returns a list of `Employment` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -30465,44 +31168,21 @@ Returns a list of `Employment` objects.
-
```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",
- ),
+client.crm.engagement_types.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- expand=EmploymentsListRequestExpand.EMPLOYEE,
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",
- ),
- order_by=EmploymentsListRequestOrderBy.EFFECTIVE_DATE_DESCENDING,
+ is_common_model_field=True,
+ is_custom=True,
page_size=1,
- remote_fields=EmploymentsListRequestRemoteFields.EMPLOYMENT_TYPE,
- remote_id="remote_id",
- show_enum_origins=EmploymentsListRequestShowEnumOrigins.EMPLOYMENT_TYPE,
)
```
@@ -30519,22 +31199,6 @@ client.hris.employments.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.
@@ -30543,22 +31207,6 @@ client.hris.employments.list(
-
-**employee_id:** `typing.Optional[str]` β If provided, will only return employments for this employee.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[EmploymentsListRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -30575,7 +31223,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).
+**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.
@@ -30583,7 +31231,7 @@ client.hris.employments.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30591,7 +31239,7 @@ client.hris.employments.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
@@ -30599,7 +31247,7 @@ client.hris.employments.list(
-
-**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` β Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
@@ -30615,30 +31263,6 @@ client.hris.employments.list(
-
-**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[EmploymentsListRequestShowEnumOrigins]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -30651,7 +31275,8 @@ client.hris.employments.list(
client.hris.employments.retrieve(...)
+## Crm Engagements
+client.crm.engagements.list(...)
-
@@ -30663,7 +31288,7 @@ client.hris.employments.list(
-
-Returns an `Employment` object with the given `id`.
+Returns a list of `Engagement` objects.
@@ -30678,24 +31303,40 @@ Returns an `Employment` object with the given `id`.
-
```python
+import datetime
+
from merge import Merge
-from merge.resources.hris.resources.employments import (
- EmploymentsRetrieveRequestExpand,
- EmploymentsRetrieveRequestRemoteFields,
- EmploymentsRetrieveRequestShowEnumOrigins,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.employments.retrieve(
- id="id",
- expand=EmploymentsRetrieveRequestExpand.EMPLOYEE,
+client.crm.engagements.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
- remote_fields=EmploymentsRetrieveRequestRemoteFields.EMPLOYMENT_TYPE,
- show_enum_origins=EmploymentsRetrieveRequestShowEnumOrigins.EMPLOYMENT_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",
+ ),
+ 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",
+ ),
)
```
@@ -30712,7 +31353,7 @@ client.hris.employments.retrieve(
-
-**id:** `str`
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -30720,7 +31361,7 @@ client.hris.employments.retrieve(
-
-**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -30728,7 +31369,7 @@ client.hris.employments.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -30736,7 +31377,12 @@ 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).
+**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.
@@ -30744,7 +31390,7 @@ client.hris.employments.retrieve(
-
-**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -30752,7 +31398,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_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30760,71 +31406,63 @@ client.hris.employments.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
+
+-
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-client.hris.field_mapping.field_mappings_retrieve(...)
-
-#### π Description
-
-
--
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+
+
+
-
-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/).
-
-
+**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.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
-)
-
-```
-
-
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
-#### βοΈ Parameters
-
-
+**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return engagements started after this datetime.
+
+
+
+
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` β If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return engagements started before this datetime.
@@ -30844,7 +31482,7 @@ client.hris.field_mapping.field_mappings_retrieve(
client.hris.field_mapping.field_mappings_create(...)
+client.crm.engagements.create(...)
-
@@ -30856,7 +31494,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.
+Creates an `Engagement` object with the given values.
@@ -30872,19 +31510,16 @@ Create new Field Mappings that will be available after the next scheduled sync.
```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.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.engagements.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=EngagementRequest(),
)
```
@@ -30901,47 +31536,7 @@ client.hris.field_mapping.field_mappings_create(
-
-**target_field_name:** `str` β The name of the target field you want this remote field to map to.
-
-
-
-
-
--
-
-**target_field_description:** `str` β The description of the target field you want this remote field to map to.
-
-
-
-
-
--
-
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` β The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
-
-
-
-
-
--
-
-**remote_method:** `str` β The method of the remote endpoint where the remote field is coming from.
-
-
-
-
-
--
-
-**remote_url_path:** `str` β The path of the remote endpoint where the remote field is coming from.
-
-
-
-
-
--
-
-**common_model_name:** `str` β The name of the Common Model that the remote field corresponds to in a given category.
+**model:** `EngagementRequest`
@@ -30949,7 +31544,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_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -30957,7 +31552,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.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -30977,7 +31572,7 @@ client.hris.field_mapping.field_mappings_create(
client.hris.field_mapping.field_mappings_destroy(...)
+client.crm.engagements.retrieve(...)
-
@@ -30989,7 +31584,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 an `Engagement` object with the given `id`.
@@ -31010,8 +31605,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.field_mapping.field_mappings_destroy(
- field_mapping_id="field_mapping_id",
+client.crm.engagements.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
)
```
@@ -31028,7 +31626,44 @@ client.hris.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ EngagementsRetrieveRequestExpandItem,
+ typing.Sequence[EngagementsRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -31048,7 +31683,7 @@ client.hris.field_mapping.field_mappings_destroy(
client.hris.field_mapping.field_mappings_partial_update(...)
+client.crm.engagements.partial_update(...)
-
@@ -31060,7 +31695,7 @@ client.hris.field_mapping.field_mappings_destroy(
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Updates an `Engagement` object with the given `id`.
@@ -31076,13 +31711,17 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```python
from merge import Merge
+from merge.resources.crm import PatchedEngagementRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.field_mapping.field_mappings_partial_update(
- field_mapping_id="field_mapping_id",
+client.crm.engagements.partial_update(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedEngagementRequest(),
)
```
@@ -31099,15 +31738,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-
-**field_mapping_id:** `str`
-
-
-
-
-
--
-
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` β The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**id:** `str`
@@ -31115,7 +31746,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.
+**model:** `PatchedEngagementRequest`
@@ -31123,7 +31754,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.
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -31131,7 +31762,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.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -31151,7 +31782,7 @@ client.hris.field_mapping.field_mappings_partial_update(
client.hris.field_mapping.remote_fields_retrieve(...)
+client.crm.engagements.meta_patch_retrieve(...)
-
@@ -31163,7 +31794,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns metadata for `Engagement` PATCHs.
@@ -31184,9 +31815,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
+client.crm.engagements.meta_patch_retrieve(
+ id="id",
)
```
@@ -31203,15 +31833,7 @@ client.hris.field_mapping.remote_fields_retrieve(
-
-**common_models:** `typing.Optional[str]` β A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
-
-
-
-
-
--
-
-**include_example_values:** `typing.Optional[str]` β If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+**id:** `str`
@@ -31231,7 +31853,7 @@ client.hris.field_mapping.remote_fields_retrieve(
client.hris.field_mapping.target_fields_retrieve()
+client.crm.engagements.meta_post_retrieve()
-
@@ -31243,7 +31865,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/).
+Returns metadata for `Engagement` POSTs.
@@ -31264,7 +31886,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.field_mapping.target_fields_retrieve()
+client.crm.engagements.meta_post_retrieve()
```
@@ -31292,8 +31914,7 @@ client.hris.field_mapping.target_fields_retrieve()
client.hris.generate_key.create(...)
+client.crm.engagements.remote_field_classes_list(...)
-
@@ -31305,7 +31926,7 @@ client.hris.field_mapping.target_fields_retrieve()
-
-Create a remote key.
+Returns a list of `RemoteFieldClass` objects.
@@ -31326,8 +31947,15 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.generate_key.create(
- name="Remote Deployment Key 1",
+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,
)
```
@@ -31344,7 +31972,63 @@ client.hris.generate_key.create(
-
-**name:** `str` β The name of the remote key
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
+
+
+
+
+
+-
+
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -31364,8 +32048,8 @@ client.hris.generate_key.create(
client.hris.groups.list(...)
+## Crm FieldMapping
+client.crm.field_mapping.field_mappings_retrieve(...)
-
@@ -31377,7 +32061,7 @@ client.hris.generate_key.create(
-
-Returns a list of `Group` objects.
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -31392,36 +32076,14 @@ 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.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",
+client.crm.field_mapping.field_mappings_retrieve(
+ exclude_remote_field_metadata=True,
)
```
@@ -31438,7 +32100,7 @@ client.hris.groups.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**exclude_remote_field_metadata:** `typing.Optional[bool]` β If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -31446,47 +32108,77 @@ client.hris.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.
-
+client.crm.field_mapping.field_mappings_create(...)
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
+#### π Description
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
+
+-
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+#### π Usage
+
-
-**include_shell_data:** `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.field_mapping.field_mappings_create(
+ exclude_remote_field_metadata=True,
+ remote_data_iteration_count=1,
+ 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
-
-**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.
+
+-
+
+**target_field_name:** `str` β The name of the target field you want this remote field to map to.
@@ -31494,7 +32186,7 @@ client.hris.groups.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+**target_field_description:** `str` β The description of the target field you want this remote field to map to.
@@ -31502,7 +32194,7 @@ client.hris.groups.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+**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.
@@ -31510,7 +32202,7 @@ client.hris.groups.list(
-
-**names:** `typing.Optional[str]` β If provided, will only return groups with these names. Multiple values can be separated by commas.
+**remote_method:** `str` β The method of the remote endpoint where the remote field is coming from.
@@ -31518,7 +32210,7 @@ client.hris.groups.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**remote_url_path:** `str` β The path of the remote endpoint where the remote field is coming from.
@@ -31526,7 +32218,7 @@ client.hris.groups.list(
-
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` β Deprecated. Use show_enum_origins.
+**common_model_name:** `str` β The name of the Common Model that the remote field corresponds to in a given category.
@@ -31534,7 +32226,7 @@ client.hris.groups.list(
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+**exclude_remote_field_metadata:** `typing.Optional[bool]` β If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -31542,7 +32234,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)
+**remote_data_iteration_count:** `typing.Optional[int]` β Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.
@@ -31550,7 +32242,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.
+**jmes_path:** `typing.Optional[str]` β JMES path to specify json query expression to be used on field mapping.
@@ -31570,7 +32262,7 @@ client.hris.groups.list(
client.hris.groups.retrieve(...)
+client.crm.field_mapping.field_mappings_destroy(...)
-
@@ -31582,7 +32274,7 @@ client.hris.groups.list(
-
-Returns a `Group` object with the given `id`.
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -31603,10 +32295,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.groups.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.crm.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
)
```
@@ -31623,39 +32313,7 @@ client.hris.groups.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` β Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**field_mapping_id:** `str`
@@ -31675,8 +32333,7 @@ client.hris.groups.retrieve(
client.hris.issues.list(...)
+client.crm.field_mapping.field_mappings_partial_update(...)
-
@@ -31688,7 +32345,7 @@ client.hris.groups.retrieve(
-
-Gets all issues for Organization.
+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.
@@ -31703,38 +32360,15 @@ 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",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
+client.crm.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
+ remote_data_iteration_count=1,
)
```
@@ -31751,7 +32385,7 @@ client.hris.issues.list(
-
-**account_token:** `typing.Optional[str]`
+**field_mapping_id:** `str`
@@ -31759,7 +32393,7 @@ client.hris.issues.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**remote_data_iteration_count:** `typing.Optional[int]` β Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.
@@ -31767,7 +32401,7 @@ client.hris.issues.list(
-
-**end_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred before this time
+**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.
@@ -31775,7 +32409,7 @@ client.hris.issues.list(
-
-**end_user_organization_name:** `typing.Optional[str]`
+**remote_method:** `typing.Optional[str]` β The method of the remote endpoint where the remote field is coming from.
@@ -31783,7 +32417,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.
+**remote_url_path:** `typing.Optional[str]` β The path of the remote endpoint where the remote field is coming from.
@@ -31791,7 +32425,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.
+**jmes_path:** `typing.Optional[str]` β JMES path to specify json query expression to be used on field mapping.
@@ -31799,31 +32433,71 @@ client.hris.issues.list(
-
-**include_muted:** `typing.Optional[str]` β If true, will include muted issues
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+client.crm.field_mapping.remote_fields_retrieve(...)
-
-**integration_name:** `typing.Optional[str]`
-
+#### π 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
+
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was after this datetime.
-
+
+-
+
+```python
+from merge import Merge
+
+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",
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**last_incident_time_before:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was before 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.
@@ -31831,7 +32505,7 @@ client.hris.issues.list(
-
-**linked_account_id:** `typing.Optional[str]` β If provided, will only include issues pertaining to the linked account passed in.
+**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.
@@ -31839,32 +32513,64 @@ client.hris.issues.list(
-
-**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.field_mapping.target_fields_retrieve()
-
-**start_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred after this time
-
+#### π 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
+
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
+
+-
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
+```python
+from merge import Merge
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
-
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.field_mapping.target_fields_retrieve()
+
+```
+
+
+#### βοΈ Parameters
+
+
+-
+
-
@@ -31880,7 +32586,8 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
client.hris.issues.retrieve(...)
+## Crm GenerateKey
+client.crm.generate_key.create(...)
-
@@ -31892,7 +32599,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Create a remote key.
@@ -31913,8 +32620,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.issues.retrieve(
- id="id",
+client.crm.generate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -31931,7 +32638,7 @@ client.hris.issues.retrieve(
-
-**id:** `str`
+**name:** `str` β The name of the remote key
@@ -31951,8 +32658,8 @@ client.hris.issues.retrieve(
client.hris.link_token.create(...)
+## Crm Issues
+client.crm.issues.list(...)
-
@@ -31964,7 +32671,7 @@ client.hris.issues.retrieve(
-
-Creates a link token to be used when linking a new end user.
+Gets all issues for Organization.
@@ -31979,18 +32686,38 @@ 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
+from merge.resources.crm.resources.issues import IssuesListRequestStatus
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.link_token.create(
- end_user_email_address="example@gmail.com",
- end_user_organization_name="Test Organization",
- end_user_origin_id="12345",
- categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+client.crm.issues.list(
+ account_token="account_token",
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ end_date="end_date",
+ end_user_organization_name="end_user_organization_name",
+ first_incident_time_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ first_incident_time_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ include_muted="include_muted",
+ integration_name="integration_name",
+ last_incident_time_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ last_incident_time_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ linked_account_id="linked_account_id",
+ page_size=1,
+ start_date="start_date",
+ status=IssuesListRequestStatus.ONGOING,
)
```
@@ -32007,7 +32734,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.
+**account_token:** `typing.Optional[str]`
@@ -32015,7 +32742,7 @@ client.hris.link_token.create(
-
-**end_user_organization_name:** `str` β Your end user's organization.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -32023,7 +32750,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.
+**end_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred before this time
@@ -32031,7 +32758,7 @@ client.hris.link_token.create(
-
-**categories:** `typing.Sequence[CategoriesEnum]` β The integration categories to show in Merge Link.
+**end_user_organization_name:** `typing.Optional[str]`
@@ -32039,7 +32766,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/.
+**first_incident_time_after:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose first incident time was after this datetime.
@@ -32047,7 +32774,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.
+**first_incident_time_before:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose first incident time was before this datetime.
@@ -32055,7 +32782,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_muted:** `typing.Optional[str]` β If true, will include muted issues
@@ -32063,7 +32790,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.
+**integration_name:** `typing.Optional[str]`
@@ -32071,7 +32798,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.
+**last_incident_time_after:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was after this datetime.
@@ -32079,14 +32806,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.
+**last_incident_time_before:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was before this datetime.
@@ -32094,12 +32814,7 @@ client.hris.link_token.create(
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
-
-The following subset of IETF language tags can be used to configure localization.
-
-* `en` - en
-* `de` - de
+**linked_account_id:** `typing.Optional[str]` β If provided, will only include issues pertaining to the linked account passed in.
@@ -32107,7 +32822,7 @@ The following subset of IETF language tags can be used to configure localization
-
-**are_syncs_disabled:** `typing.Optional[bool]` β The boolean that indicates whether initial, periodic, and force syncs will be disabled.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -32115,7 +32830,7 @@ The following subset of IETF language tags can be used to configure localization
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` β A JSON object containing integration-specific configuration options.
+**start_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred after this time
@@ -32123,11 +32838,12 @@ The following subset of IETF language tags can be used to configure localization
-
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]`
+**status:** `typing.Optional[IssuesListRequestStatus]`
-When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account.
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
-* `SELECTIVE_SYNC` - SELECTIVE_SYNC
+* `ONGOING` - ONGOING
+* `RESOLVED` - RESOLVED
@@ -32147,8 +32863,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
client.hris.linked_accounts.list(...)
+client.crm.issues.retrieve(...)
-
@@ -32160,7 +32875,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-
-List linked accounts for your organization.
+Get a specific issue.
@@ -32176,28 +32891,13 @@ 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,
- 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.crm.issues.retrieve(
id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
)
```
@@ -32214,17 +32914,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
+**id:** `str`
@@ -32232,24 +32922,930 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
--
-
-**end_user_email_address:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given email address.
-
-
--
-**end_user_organization_name:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given organization name.
-
+
+
+
client.crm.leads.list(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns a list of `Lead` objects.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+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",
+ 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",
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**converted_account_id:** `typing.Optional[str]` β If provided, will only return leads with this account.
+
+
+
+
+
+-
+
+**converted_contact_id:** `typing.Optional[str]` β If provided, will only return leads with 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.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
+
+-
+
+**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[
+ typing.Union[
+ LeadsListRequestExpandItem, typing.Sequence[LeadsListRequestExpandItem]
+ ]
+]` β 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.
+
+
+
+
+
+-
+
+**owner_id:** `typing.Optional[str]` β If provided, will only return leads with this owner.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+
+
+
+
+client.crm.leads.create(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Creates a `Lead` object with the given values.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```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
+
+
+-
+
+
+-
+
+**model:** `LeadRequest`
+
+
+
+
+
+-
+
+**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.crm.leads.retrieve(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns a `Lead` 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.leads.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.leads.meta_post_retrieve()
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns metadata for `Lead` POSTs.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.leads.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.leads.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.leads.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,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
+
+
+
+
+
+-
+
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.link_token.create(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user. The link token expires after single use.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```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],
+)
+
+```
+
+
+
+
+
+#### βοΈ 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.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.linked_accounts.list(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```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",
+ 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.
+
@@ -32264,7 +33860,2907 @@ 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.
+**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.crm.notes.list(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns a list of `Note` objects.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.notes.list(
+ account_id="account_id",
+ contact_id="contact_id",
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ 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",
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**account_id:** `typing.Optional[str]` β If provided, will only return notes with this account.
+
+
+
+
+
+-
+
+**contact_id:** `typing.Optional[str]` β If provided, will only return notes with this contact.
+
+
+
+
+
+-
+
+**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.Union[
+ NotesListRequestExpandItem, typing.Sequence[NotesListRequestExpandItem]
+ ]
+]` β 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.
+
+
+
+
+
+-
+
+**opportunity_id:** `typing.Optional[str]` β If provided, will only return notes with this opportunity.
+
+
+
+
+
+-
+
+**owner_id:** `typing.Optional[str]` β If provided, will only return notes with this owner.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. 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.crm.notes.create(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Creates a `Note` object with the given values.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+from merge.resources.crm import NoteRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.notes.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=NoteRequest(),
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**model:** `NoteRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.notes.retrieve(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns a `Note` 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.notes.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.notes.meta_post_retrieve()
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns metadata for `Note` POSTs.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.notes.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.notes.remote_field_classes_list(...)
+
+-
+
+#### π 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.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,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
+
+
+
+
+
+-
+
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.list(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns a list of `Opportunity` objects.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```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.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,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**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[
+ typing.Union[
+ OpportunitiesListRequestExpandItem,
+ typing.Sequence[OpportunitiesListRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**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. The maximum limit is 100.
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[OpportunitiesListRequestStatus]`
+
+If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
+
+* `OPEN` - OPEN
+* `WON` - WON
+* `LOST` - LOST
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.create(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Creates an `Opportunity` object with the given values.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```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(),
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**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.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.retrieve(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns an `Opportunity` 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.opportunities.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**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).
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.partial_update(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Updates an `Opportunity` object with the given `id`.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```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
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedOpportunityRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.meta_patch_retrieve(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns metadata for `Opportunity` PATCHs.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.opportunities.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.meta_post_retrieve()
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns metadata for `Opportunity` POSTs.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.opportunities.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.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.opportunities.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+ is_common_model_field=True,
+ is_custom=True,
+ page_size=1,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
+
+
+
+
+
+-
+
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.passthrough.create(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+from merge.resources.crm import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.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.crm.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.crm.stages.list(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns a list of `Stage` objects.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.stages.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ page_size=1,
+ remote_id="remote_id",
+)
+
+```
+
+
+
+
+
+#### βοΈ 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_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. 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.crm.stages.retrieve(...)
+
+-
+
+#### π 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`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.stages.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.stages.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+ is_common_model_field=True,
+ is_custom=True,
+ page_size=1,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
+
+
+
+
+
+-
+
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.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.crm.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.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
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.list(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns a list of `Task` objects.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ 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",
+)
+
+```
+
+
+
+
+
+#### βοΈ 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.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/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` β Number of results to return per page. 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.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`
+
+
+
+
+
+-
+
+**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.crm.tasks.retrieve(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns a `Task` 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.tasks.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.partial_update(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Updates a `Task` object with the given `id`.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+from merge.resources.crm import PatchedTaskRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.partial_update(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedTaskRequest(),
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedTaskRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.meta_patch_retrieve(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns metadata for `Task` PATCHs.
+
+
+
+
+
+#### π 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",
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.meta_post_retrieve()
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns metadata for `Task` POSTs.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.remote_field_classes_list(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+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.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,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -32272,7 +36768,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**id:** `typing.Optional[str]`
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -32280,7 +36776,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**ids:** `typing.Optional[str]` β Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -32288,7 +36784,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**include_duplicates:** `typing.Optional[bool]` β If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+**include_remote_fields:** `typing.Optional[bool]` β Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -32296,7 +36792,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**integration_name:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given integration name.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -32304,7 +36800,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**is_test_account:** `typing.Optional[str]` β If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+**is_common_model_field:** `typing.Optional[bool]` β If provided, will only return remote field classes with this is_common_model_field value
@@ -32312,7 +36808,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.
+**is_custom:** `typing.Optional[bool]` β If provided, will only return remote fields classes with this is_custom value
@@ -32320,7 +36816,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**status:** `typing.Optional[str]` β Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -32340,8 +36836,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
client.hris.locations.list(...)
+## Crm Users
+client.crm.users.list(...)
-
@@ -32353,7 +36849,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-Returns a list of `Location` objects.
+Returns a list of `User` objects.
@@ -32371,17 +36867,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(
+client.crm.users.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -32389,10 +36880,11 @@ client.hris.locations.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,
- location_type=LocationsListRequestLocationType.HOME,
modified_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -32400,9 +36892,7 @@ 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,
)
```
@@ -32443,7 +36933,7 @@ client.hris.locations.list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**email:** `typing.Optional[str]` β If provided, will only return users with this email.
@@ -32451,7 +36941,7 @@ client.hris.locations.list(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -32459,7 +36949,7 @@ client.hris.locations.list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -32467,12 +36957,15 @@ client.hris.locations.list(
-
-**location_type:** `typing.Optional[LocationsListRequestLocationType]`
+**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.
+
+
+
-If provided, will only return locations with this location type
+
+-
-* `HOME` - HOME
-* `WORK` - WORK
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -32504,7 +36997,7 @@ If provided, will only return locations with this location type
-
-**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -32512,15 +37005,97 @@ If provided, will only return locations with this location type
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+client.crm.users.retrieve(...)
-
-**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)
+#### π 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.crm.users.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_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).
@@ -32540,7 +37115,7 @@ If provided, will only return locations with this location type
client.hris.locations.retrieve(...)
+client.crm.users.ignore_create(...)
-
@@ -32552,7 +37127,7 @@ If provided, will only return locations with this location type
-
-Returns a `Location` object with the given `id`.
+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.
@@ -32568,21 +37143,103 @@ Returns a `Location` object with the given `id`.
```python
from merge import Merge
-from merge.resources.hris.resources.locations import (
- LocationsRetrieveRequestRemoteFields,
- LocationsRetrieveRequestShowEnumOrigins,
+from merge.resources.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,
+ ),
)
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**model_id:** `str`
+
+
+
+
+
+-
+
+**request:** `IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+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.hris.locations.retrieve(
- id="id",
+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,
- remote_fields=LocationsRetrieveRequestRemoteFields.COUNTRY,
- show_enum_origins=LocationsRetrieveRequestShowEnumOrigins.COUNTRY,
+ is_common_model_field=True,
+ is_custom=True,
+ page_size=1,
)
```
@@ -32599,7 +37256,15 @@ client.hris.locations.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/).
@@ -32615,6 +37280,14 @@ client.hris.locations.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).
@@ -32623,7 +37296,7 @@ client.hris.locations.retrieve(
-
-**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` β 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
@@ -32631,7 +37304,15 @@ 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)
+**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. The maximum limit is 100.
@@ -32651,8 +37332,8 @@ client.hris.locations.retrieve(
client.hris.passthrough.create(...)
+## Crm WebhookReceivers
+client.crm.webhook_receivers.list()
-
@@ -32664,7 +37345,7 @@ client.hris.locations.retrieve(
-
-Pull data from an endpoint not currently supported by Merge.
+Returns a list of `WebhookReceiver` objects.
@@ -32680,17 +37361,75 @@ Pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.hris import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+client.crm.webhook_receivers.list()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.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.crm.webhook_receivers.create(
+ event="event",
+ is_active=True,
)
```
@@ -32707,7 +37446,157 @@ client.hris.passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+
client.hris.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.hris.account_details.retrieve()
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.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.hris.account_token.retrieve(
+ public_token="public_token",
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**public_token:** `str`
@@ -32727,8 +37616,7 @@ client.hris.passthrough.create(
client.hris.pay_groups.list(...)
+client.hris.account_token.regenerate_create()
-
@@ -32740,7 +37628,7 @@ client.hris.passthrough.create(
-
-Returns a list of `PayGroup` objects.
+Exchange Linked Account account tokens.
@@ -32755,34 +37643,13 @@ Returns a list of `PayGroup` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.pay_groups.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
+client.hris.account_token.regenerate_create()
```
@@ -32798,79 +37665,75 @@ client.hris.pay_groups.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
-
-
--
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
+
client.hris.async_passthrough.create(...)
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
+#### π Description
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+
+#### π Usage
+
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
-
+```python
+from merge import Merge
+from merge.resources.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",
+ ),
+)
+
+```
+
+
+
+#### βοΈ Parameters
-
-**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:** `DataPassthroughRequest`
@@ -32890,7 +37753,7 @@ client.hris.pay_groups.list(
client.hris.pay_groups.retrieve(...)
+client.hris.async_passthrough.retrieve(...)
-
@@ -32902,7 +37765,7 @@ client.hris.pay_groups.list(
-
-Returns a `PayGroup` object with the given `id`.
+Retrieves data from earlier async-passthrough POST request
@@ -32923,10 +37786,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.pay_groups.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.hris.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
)
```
@@ -32943,23 +37804,7 @@ client.hris.pay_groups.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**async_passthrough_receipt_id:** `str`
@@ -32979,8 +37824,8 @@ client.hris.pay_groups.retrieve(
client.hris.payroll_runs.list(...)
+## Hris AuditTrail
+client.hris.audit_trail.list(...)
-
@@ -32992,7 +37837,7 @@ client.hris.pay_groups.retrieve(
-
-Returns a list of `PayrollRun` objects.
+Gets a list of audit trail events.
@@ -33007,53 +37852,19 @@ Returns a list of `PayrollRun` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.hris.resources.payroll_runs import (
- PayrollRunsListRequestRemoteFields,
- PayrollRunsListRequestRunType,
- PayrollRunsListRequestShowEnumOrigins,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.payroll_runs.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+client.hris.audit_trail.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- ended_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- ended_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+ end_date="end_date",
+ event_type="event_type",
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",
- ),
+ start_date="start_date",
+ user_email="user_email",
)
```
@@ -33070,7 +37881,7 @@ client.hris.payroll_runs.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.
@@ -33078,7 +37889,7 @@ client.hris.payroll_runs.list(
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+**end_date:** `typing.Optional[str]` β If included, will only include audit trail events that occurred before this time
@@ -33086,7 +37897,7 @@ client.hris.payroll_runs.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**event_type:** `typing.Optional[str]` β If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -33094,7 +37905,7 @@ client.hris.payroll_runs.list(
-
-**ended_after:** `typing.Optional[dt.datetime]` β If provided, will only return payroll runs ended after this datetime.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -33102,7 +37913,7 @@ client.hris.payroll_runs.list(
-
-**ended_before:** `typing.Optional[dt.datetime]` β If provided, will only return payroll runs ended before this datetime.
+**start_date:** `typing.Optional[str]` β If included, will only include audit trail events that occurred after this time
@@ -33110,7 +37921,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/).
+**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.
@@ -33118,99 +37929,65 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
--
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
+
client.hris.available_actions.retrieve()
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
-
-
-
+#### π Description
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
-**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
-
+Returns a list of models and actions available for an account.
+
+
+#### π Usage
+
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
-
-
-
-
-**run_type:** `typing.Optional[PayrollRunsListRequestRunType]`
+```python
+from merge import Merge
-If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.available_actions.retrieve()
-* `REGULAR` - REGULAR
-* `OFF_CYCLE` - OFF_CYCLE
-* `CORRECTION` - CORRECTION
-* `TERMINATION` - TERMINATION
-* `SIGN_ON_BONUS` - SIGN_ON_BONUS
-
+```
-
-
--
-
-**show_enum_origins:** `typing.Optional[PayrollRunsListRequestShowEnumOrigins]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
--
-
-**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return payroll runs started after this datetime.
-
-
-
+#### βοΈ Parameters
-
-**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return payroll runs started before this datetime.
-
-
-
-
-
@@ -33226,7 +38003,8 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
client.hris.payroll_runs.retrieve(...)
+## Hris BankInfo
+client.hris.bank_info.list(...)
-
@@ -33238,7 +38016,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-
-Returns a `PayrollRun` object with the given `id`.
+Returns a list of `BankInfo` objects.
@@ -33253,22 +38031,41 @@ Returns a `PayrollRun` object with the given `id`.
-
```python
+import datetime
+
from merge import Merge
-from merge.resources.hris.resources.payroll_runs import (
- PayrollRunsRetrieveRequestRemoteFields,
- PayrollRunsRetrieveRequestShowEnumOrigins,
+from merge.resources.hris.resources.bank_info import (
+ BankInfoListRequestAccountType,
+ BankInfoListRequestOrderBy,
)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.payroll_runs.retrieve(
- id="id",
+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,
- remote_fields=PayrollRunsRetrieveRequestRemoteFields.RUN_STATE,
- show_enum_origins=PayrollRunsRetrieveRequestShowEnumOrigins.RUN_STATE,
+ 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",
)
```
@@ -33285,7 +38082,12 @@ client.hris.payroll_runs.retrieve(
-
-**id:** `str`
+**account_type:** `typing.Optional[BankInfoListRequestAccountType]`
+
+If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
+
+* `SAVINGS` - SAVINGS
+* `CHECKING` - CHECKING
@@ -33293,7 +38095,7 @@ client.hris.payroll_runs.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**bank_name:** `typing.Optional[str]` β If provided, will only return BankInfo's with this bank name.
@@ -33301,7 +38103,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).
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -33309,7 +38111,7 @@ client.hris.payroll_runs.retrieve(
-
-**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -33317,7 +38119,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)
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -33325,71 +38127,99 @@ client.hris.payroll_runs.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**employee_id:** `typing.Optional[str]` β If provided, will only return bank accounts for this employee.
-
-
+
+-
+**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.
+
-client.hris.regenerate_key.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.
+
+
+
+
-
-Exchange remote keys.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+
-#### π Usage
-
-
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
-
-```python
-from merge import Merge
+**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` β Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.regenerate_key.create(
- name="Remote Deployment Key 1",
-)
+
+-
-```
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` β Deprecated. Use show_enum_origins.
+
-#### βοΈ Parameters
-
-
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
+
+
+
-
-**name:** `str` β The name of the remote key
+**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)
@@ -33409,8 +38239,7 @@ client.hris.regenerate_key.create(
client.hris.sync_status.list(...)
+client.hris.bank_info.retrieve(...)
-
@@ -33422,7 +38251,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 `BankInfo` object with the given `id`.
@@ -33443,9 +38272,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
+client.hris.bank_info.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -33462,7 +38292,7 @@ client.hris.sync_status.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**id:** `str`
@@ -33470,7 +38300,11 @@ client.hris.sync_status.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**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.
@@ -33478,65 +38312,35 @@ 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.
-
-
-
-
-
-
-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.
-
-
+**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.hris.force_resync.sync_status_resync_create()
-
-```
-
-
+**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
-
-
--
-
-
@@ -33552,8 +38356,8 @@ client.hris.force_resync.sync_status_resync_create()
client.hris.teams.list(...)
+## Hris Benefits
+client.hris.benefits.list(...)
-
@@ -33565,7 +38369,7 @@ client.hris.force_resync.sync_status_resync_create()
-
-Returns a list of `Team` objects.
+Returns a list of `Benefit` objects.
@@ -33588,7 +38392,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.teams.list(
+client.hris.benefits.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -33596,6 +38400,7 @@ client.hris.teams.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,
@@ -33606,7 +38411,6 @@ client.hris.teams.list(
"2024-01-15 09:30:00+00:00",
),
page_size=1,
- parent_team_id="parent_team_id",
remote_id="remote_id",
)
@@ -33648,7 +38452,7 @@ client.hris.teams.list(
-
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**employee_id:** `typing.Optional[str]` β If provided, will return the benefits associated with the employee.
@@ -33656,7 +38460,11 @@ client.hris.teams.list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**expand:** `typing.Optional[
+ typing.Union[
+ 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.
@@ -33664,7 +38472,7 @@ client.hris.teams.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/).
@@ -33672,7 +38480,7 @@ client.hris.teams.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.
@@ -33680,7 +38488,7 @@ client.hris.teams.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -33688,7 +38496,7 @@ client.hris.teams.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.
@@ -33696,7 +38504,7 @@ client.hris.teams.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.
@@ -33704,7 +38512,7 @@ client.hris.teams.list(
-
-**parent_team_id:** `typing.Optional[str]` β If provided, will only return teams with this parent team.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -33732,7 +38540,7 @@ client.hris.teams.list(
client.hris.teams.retrieve(...)
+client.hris.benefits.retrieve(...)
-
@@ -33744,7 +38552,7 @@ client.hris.teams.list(
-
-Returns a `Team` object with the given `id`.
+Returns a `Benefit` object with the given `id`.
@@ -33765,7 +38573,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.teams.retrieve(
+client.hris.benefits.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -33793,7 +38601,11 @@ client.hris.teams.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ 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.
@@ -33829,8 +38641,8 @@ client.hris.teams.retrieve(
client.hris.time_off.list(...)
+## Hris Companies
+client.hris.companies.list(...)
-
@@ -33842,7 +38654,7 @@ client.hris.teams.retrieve(
-
-Returns a list of `TimeOff` objects.
+Returns a list of `Company` objects.
@@ -33860,20 +38672,12 @@ Returns a list of `TimeOff` objects.
import datetime
from merge import Merge
-from merge.resources.hris.resources.time_off import (
- TimeOffListRequestExpand,
- TimeOffListRequestRemoteFields,
- TimeOffListRequestRequestType,
- TimeOffListRequestShowEnumOrigins,
- TimeOffListRequestStatus,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.time_off.list(
- approver_id="approver_id",
+client.hris.companies.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -33881,14 +38685,6 @@ client.hris.time_off.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",
- ),
- expand=TimeOffListRequestExpand.APPROVER,
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
@@ -33899,17 +38695,7 @@ client.hris.time_off.list(
"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,
)
```
@@ -33926,14 +38712,6 @@ 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.
@@ -33958,7 +38736,7 @@ client.hris.time_off.list(
-
-**employee_id:** `typing.Optional[str]` β If provided, will only return time off 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/).
@@ -33966,7 +38744,7 @@ client.hris.time_off.list(
-
-**ended_after:** `typing.Optional[dt.datetime]` β If provided, will only return employees that 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.
@@ -33974,7 +38752,7 @@ client.hris.time_off.list(
-
-**ended_before:** `typing.Optional[dt.datetime]` β If provided, will only return time-offs that ended before this datetime.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -33982,7 +38760,7 @@ client.hris.time_off.list(
-
-**expand:** `typing.Optional[TimeOffListRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -33990,7 +38768,7 @@ client.hris.time_off.list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -33998,7 +38776,7 @@ client.hris.time_off.list(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -34006,7 +38784,7 @@ client.hris.time_off.list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -34014,72 +38792,72 @@ client.hris.time_off.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+**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.hris.companies.retrieve(...)
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
-
-
-
+#### π Description
-
-**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
-
-
-
-
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
+Returns a `Company` object with the given `id`.
+
+
+#### π Usage
+
-
-**request_type:** `typing.Optional[TimeOffListRequestRequestType]`
+
+-
-If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
+```python
+from merge import Merge
-* `VACATION` - VACATION
-* `SICK` - SICK
-* `PERSONAL` - PERSONAL
-* `JURY_DUTY` - JURY_DUTY
-* `VOLUNTEER` - VOLUNTEER
-* `BEREAVEMENT` - BEREAVEMENT
-
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.companies.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**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.
+**id:** `str`
@@ -34087,7 +38865,7 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-
-**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return time-offs that started before this datetime.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34095,15 +38873,7 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-
-**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
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -34123,7 +38893,8 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
client.hris.time_off.create(...)
+## Hris Scopes
+client.hris.scopes.default_scopes_retrieve()
-
@@ -34135,7 +38906,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-
-Creates a `TimeOff` object with the given values.
+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).
@@ -34151,17 +38922,12 @@ 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.hris.scopes.default_scopes_retrieve()
```
@@ -34177,30 +38943,6 @@ 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.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -34213,7 +38955,7 @@ client.hris.time_off.create(
client.hris.time_off.retrieve(...)
+client.hris.scopes.linked_account_scopes_retrieve()
-
@@ -34225,7 +38967,7 @@ client.hris.time_off.create(
-
-Returns a `TimeOff` object with the given `id`.
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -34241,24 +38983,12 @@ 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,
-)
+client.hris.scopes.linked_account_scopes_retrieve()
```
@@ -34274,47 +39004,99 @@ client.hris.time_off.retrieve(
-
-**id:** `str`
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
-
--
-**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
+client.hris.scopes.linked_account_scopes_create(...)
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
+#### π Description
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+
+-
+
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+
+
+#### π Usage
+
-
-**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` β Deprecated. Use show_enum_origins.
-
+
+-
+
+```python
+from merge import Merge
+from merge.resources.hris import (
+ FieldPermissionDeserializerRequest,
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.scopes.linked_account_scopes_create(
+ common_models=[
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Employee",
+ model_permissions={
+ "READ": ModelPermissionDeserializerRequest(
+ is_enabled=True,
+ ),
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ ),
+ },
+ field_permissions=FieldPermissionDeserializerRequest(
+ enabled_fields=["avatar", "home_location"],
+ disabled_fields=["work_location"],
+ ),
+ ),
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Benefit",
+ model_permissions={
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ )
+ },
+ ),
+ ],
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**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)
+
+-
+
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β The common models you want to update the scopes for
@@ -34334,7 +39116,8 @@ client.hris.time_off.retrieve(
client.hris.time_off.meta_post_retrieve()
+## Hris DeleteAccount
+client.hris.delete_account.delete()
-
@@ -34346,7 +39129,7 @@ client.hris.time_off.retrieve(
-
-Returns metadata for `TimeOff` POSTs.
+Delete a linked account.
@@ -34367,7 +39150,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.time_off.meta_post_retrieve()
+client.hris.delete_account.delete()
```
@@ -34395,8 +39178,8 @@ client.hris.time_off.meta_post_retrieve()
client.hris.time_off_balances.list(...)
+## Hris Dependents
+client.hris.dependents.list(...)
-
@@ -34408,7 +39191,7 @@ client.hris.time_off.meta_post_retrieve()
-
-Returns a list of `TimeOffBalance` objects.
+Returns a list of `Dependent` objects.
@@ -34426,15 +39209,12 @@ Returns a list of `TimeOffBalance` objects.
import datetime
from merge import Merge
-from merge.resources.hris.resources.time_off_balances import (
- TimeOffBalancesListRequestPolicyType,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.time_off_balances.list(
+client.hris.dependents.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -34445,6 +39225,7 @@ client.hris.time_off_balances.list(
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",
@@ -34453,7 +39234,6 @@ client.hris.time_off_balances.list(
"2024-01-15 09:30:00+00:00",
),
page_size=1,
- policy_type=TimeOffBalancesListRequestPolicyType.BEREAVEMENT,
remote_id="remote_id",
)
@@ -34487,31 +39267,7 @@ client.hris.time_off_balances.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
-
-
-
-
--
-
-**employee_id:** `typing.Optional[str]` β If provided, will only return time off balances for this employee.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -34519,7 +39275,7 @@ client.hris.time_off_balances.list(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**employee_id:** `typing.Optional[str]` β If provided, will only return dependents for this employee.
@@ -34527,7 +39283,7 @@ client.hris.time_off_balances.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/).
@@ -34535,7 +39291,7 @@ client.hris.time_off_balances.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.
@@ -34543,7 +39299,7 @@ client.hris.time_off_balances.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+**include_sensitive_fields:** `typing.Optional[bool]` β Whether to include sensitive fields (such as social security numbers) in the response.
@@ -34551,7 +39307,7 @@ client.hris.time_off_balances.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -34559,16 +39315,7 @@ client.hris.time_off_balances.list(
-
-**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]`
-
-If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
-
-* `VACATION` - VACATION
-* `SICK` - SICK
-* `PERSONAL` - PERSONAL
-* `JURY_DUTY` - JURY_DUTY
-* `VOLUNTEER` - VOLUNTEER
-* `BEREAVEMENT` - BEREAVEMENT
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -34576,7 +39323,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
-**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` β Deprecated. Use show_enum_origins.
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -34584,7 +39331,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -34592,7 +39339,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
-**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -34612,7 +39359,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
client.hris.time_off_balances.retrieve(...)
+client.hris.dependents.retrieve(...)
-
@@ -34624,7 +39371,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
-Returns a `TimeOffBalance` object with the given `id`.
+Returns a `Dependent` object with the given `id`.
@@ -34645,9 +39392,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.time_off_balances.retrieve(
+client.hris.dependents.retrieve(
id="id",
include_remote_data=True,
+ include_sensitive_fields=True,
include_shell_data=True,
)
@@ -34673,14 +39421,6 @@ client.hris.time_off_balances.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34689,15 +39429,7 @@ client.hris.time_off_balances.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[typing.Literal["policy_type"]]` β Deprecated. Use show_enum_origins.
+**include_sensitive_fields:** `typing.Optional[bool]` β Whether to include sensitive fields (such as social security numbers) in the response.
@@ -34705,7 +39437,7 @@ client.hris.time_off_balances.retrieve(
-
-**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)
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -34725,8 +39457,8 @@ client.hris.time_off_balances.retrieve(
client.hris.timesheet_entries.list(...)
+## Hris EmployeePayrollRuns
+client.hris.employee_payroll_runs.list(...)
-
@@ -34738,7 +39470,7 @@ client.hris.time_off_balances.retrieve(
-
-Returns a list of `TimesheetEntry` objects.
+Returns a list of `EmployeePayrollRun` objects.
@@ -34756,15 +39488,12 @@ Returns a list of `TimesheetEntry` objects.
import datetime
from merge import Merge
-from merge.resources.hris.resources.timesheet_entries import (
- TimesheetEntriesListRequestOrderBy,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.timesheet_entries.list(
+client.hris.employee_payroll_runs.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -34788,8 +39517,8 @@ client.hris.timesheet_entries.list(
modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- order_by=TimesheetEntriesListRequestOrderBy.START_TIME_DESCENDING,
page_size=1,
+ payroll_run_id="payroll_run_id",
remote_id="remote_id",
started_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -34837,7 +39566,7 @@ client.hris.timesheet_entries.list(
-
-**employee_id:** `typing.Optional[str]` β If provided, will only return timesheet entries for this employee.
+**employee_id:** `typing.Optional[str]` β If provided, will only return employee payroll runs for this employee.
@@ -34845,7 +39574,7 @@ client.hris.timesheet_entries.list(
-
-**ended_after:** `typing.Optional[dt.datetime]` β If provided, will only return timesheet entries ended after this datetime.
+**ended_after:** `typing.Optional[dt.datetime]` β If provided, will only return employee payroll runs ended after this datetime.
@@ -34853,7 +39582,7 @@ client.hris.timesheet_entries.list(
-
-**ended_before:** `typing.Optional[dt.datetime]` β If provided, will only return timesheet entries ended before this datetime.
+**ended_before:** `typing.Optional[dt.datetime]` β If provided, will only return employee payroll runs ended before this datetime.
@@ -34861,7 +39590,12 @@ 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.
+**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.
@@ -34909,7 +39643,7 @@ client.hris.timesheet_entries.list(
-
-**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` β Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -34917,7 +39651,7 @@ client.hris.timesheet_entries.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**payroll_run_id:** `typing.Optional[str]` β If provided, will only return employee payroll runs for this employee.
@@ -34933,7 +39667,7 @@ client.hris.timesheet_entries.list(
-
-**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return timesheet entries started after this datetime.
+**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return employee payroll runs started after this datetime.
@@ -34941,7 +39675,7 @@ client.hris.timesheet_entries.list(
-
-**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return timesheet entries started before this datetime.
+**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return employee payroll runs started before this datetime.
@@ -34961,7 +39695,7 @@ client.hris.timesheet_entries.list(
client.hris.timesheet_entries.create(...)
+client.hris.employee_payroll_runs.retrieve(...)
-
@@ -34973,7 +39707,7 @@ client.hris.timesheet_entries.list(
-
-Creates a `TimesheetEntry` object with the given values.
+Returns an `EmployeePayrollRun` object with the given `id`.
@@ -34989,16 +39723,15 @@ 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.hris.employee_payroll_runs.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -35015,7 +39748,7 @@ client.hris.timesheet_entries.create(
-
-**model:** `TimesheetEntryRequest`
+**id:** `str`
@@ -35023,7 +39756,12 @@ client.hris.timesheet_entries.create(
-
-**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
+**expand:** `typing.Optional[
+ typing.Union[
+ EmployeePayrollRunsRetrieveRequestExpandItem,
+ typing.Sequence[EmployeePayrollRunsRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35031,7 +39769,15 @@ client.hris.timesheet_entries.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).
@@ -35051,7 +39797,8 @@ client.hris.timesheet_entries.create(
client.hris.timesheet_entries.retrieve(...)
+## Hris Employees
+client.hris.employees.list(...)
-
@@ -35063,7 +39810,7 @@ client.hris.timesheet_entries.create(
-
-Returns a `TimesheetEntry` object with the given `id`.
+Returns a list of `Employee` objects.
@@ -35078,16 +39825,69 @@ Returns a `TimesheetEntry` object with the given `id`.
-
```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.hris.timesheet_entries.retrieve(
- id="id",
+client.hris.employees.list(
+ company_id="company_id",
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ display_full_name="display_full_name",
+ employee_number="employee_number",
+ employment_status=EmployeesListRequestEmploymentStatus.ACTIVE,
+ employment_type="employment_type",
+ 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",
)
```
@@ -35104,7 +39904,7 @@ client.hris.timesheet_entries.retrieve(
-
-**id:** `str`
+**company_id:** `typing.Optional[str]` β If provided, will only return employees for this company.
@@ -35112,7 +39912,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.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -35120,7 +39920,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.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -35128,7 +39928,7 @@ client.hris.timesheet_entries.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -35136,194 +39936,90 @@ client.hris.timesheet_entries.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**display_full_name:** `typing.Optional[str]` β If provided, will only return employees with this display name.
-
-
-
-
-
-
-client.hris.timesheet_entries.meta_post_retrieve()
-
--
-
-#### π Description
-
-
--
-
-Returns metadata for `TimesheetEntry` POSTs.
-
-
+**employee_number:** `typing.Optional[str]` β If provided, will only return employees with this employee number.
+
-#### π Usage
-
-
--
-
-
-```python
-from merge import Merge
+**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]`
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.timesheet_entries.meta_post_retrieve()
+If provided, will only return employees with this employment status.
-```
-
-
+* `ACTIVE` - ACTIVE
+* `PENDING` - PENDING
+* `INACTIVE` - INACTIVE
+
-#### βοΈ Parameters
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**employment_type:** `typing.Optional[str]` β If provided, will only return employees that have an employment of the specified employment type.
-
-
-
-
-
-
-client.hris.webhook_receivers.list()
-
--
-
-#### π Description
-
-
--
-
-Returns a list of `WebhookReceiver` objects.
-
-
+**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.
+
-#### π Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.webhook_receivers.list()
-
-```
-
-
+**first_name:** `typing.Optional[str]` β If provided, will only return employees with this first name.
+
-#### βοΈ Parameters
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**groups:** `typing.Optional[str]` β If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
-
-
-
-
-
-
-client.hris.webhook_receivers.create(...)
-
--
-
-#### π Description
-
-
--
-
-Creates a `WebhookReceiver` object with the given values.
-
-
+**home_location_id:** `typing.Optional[str]` β If provided, will only return employees for this home location.
+
-#### π Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.webhook_receivers.create(
- event="event",
- is_active=True,
-)
-
-```
-
-
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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
-
-
--
-
-
-**event:** `str`
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35331,7 +40027,7 @@ client.hris.webhook_receivers.create(
-
-**is_active:** `bool`
+**include_sensitive_fields:** `typing.Optional[bool]` β Whether to include sensitive fields (such as social security numbers) in the response.
@@ -35339,7 +40035,7 @@ client.hris.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35347,133 +40043,55 @@ client.hris.webhook_receivers.create(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**job_title:** `typing.Optional[str]` β If provided, will only return employees that have an employment of the specified job title.
-
-
-
-
-
-
-client.knowledgebase.account_details.retrieve()
-
--
-
-#### π Description
-
-
--
-
-Get details for a linked account.
-
-
+**last_name:** `typing.Optional[str]` β If provided, will only return employees with this last name.
+
-#### π Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.account_details.retrieve()
-
-```
-
-
+**manager_id:** `typing.Optional[str]` β If provided, will only return employees for this manager.
+
-#### βοΈ Parameters
-
-
-
--
-
-**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.knowledgebase.account_token.retrieve(...)
-
--
-
-#### π Description
-
-
--
-
-Returns the account token for the end user with the provided public token.
-
-
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
-#### π Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.account_token.retrieve(
- public_token="public_token",
-)
-
-```
-
-
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
-#### βοΈ Parameters
-
-
--
-
-
-**public_token:** `str`
+**pay_group_id:** `typing.Optional[str]` β If provided, will only return employees for this pay group
@@ -35481,100 +40099,31 @@ client.knowledgebase.account_token.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**personal_email:** `typing.Optional[str]` β If provided, will only return Employees with this personal email
-
-
-
-
-
-
-client.knowledgebase.articles.list(...)
-
--
-
-#### π Description
-
-
--
-
-Returns a list of `Article` objects.
-
-
+**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+
-#### π Usage
-
-
--
-
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.knowledgebase.resources.articles import (
- ArticlesListRequestExpand,
- ArticlesListRequestType,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.articles.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ArticlesListRequestExpand.ATTACHMENTS,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- parent_article_id="parent_article_id",
- parent_container_id="parent_container_id",
- remote_id="remote_id",
- root_container_id="root_container_id",
- status="status",
- type=ArticlesListRequestType.EMPTY,
-)
-
-```
-
-
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
-#### βοΈ Parameters
-
-
--
-
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**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)
@@ -35582,7 +40131,7 @@ client.knowledgebase.articles.list(
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return employees that started after this datetime.
@@ -35590,7 +40139,7 @@ client.knowledgebase.articles.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return employees that started before this datetime.
@@ -35598,7 +40147,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.
+**team_id:** `typing.Optional[str]` β If provided, will only return employees for this team.
@@ -35606,7 +40155,7 @@ 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/).
+**terminated_after:** `typing.Optional[dt.datetime]` β If provided, will only return employees that were terminated after this datetime.
@@ -35614,7 +40163,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.
+**terminated_before:** `typing.Optional[dt.datetime]` β If provided, will only return employees that were terminated before this datetime.
@@ -35622,7 +40171,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).
+**work_email:** `typing.Optional[str]` β If provided, will only return Employees with this work email
@@ -35630,7 +40179,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.
+**work_location_id:** `typing.Optional[str]` β If provided, will only return employees for this location.
@@ -35638,47 +40187,73 @@ client.knowledgebase.articles.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.
+
+
-
--
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
-
+
client.hris.employees.create(...)
-
-**parent_article_id:** `typing.Optional[str]` β If provided, will only return sub articles of the parent_article_id.
-
-
-
+#### π Description
-
-**parent_container_id:** `typing.Optional[str]` β If provided, will only return sub articles of the parent_container_id.
-
+
+-
+
+Creates an `Employee` object with the given values.
+
+
+
+#### π Usage
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
+
+-
+
+```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
-
-**root_container_id:** `typing.Optional[str]` β If provided, will only return sub articles of the root_container_id.
+
+-
+
+**model:** `EmployeeRequest`
@@ -35686,7 +40261,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.
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -35694,7 +40269,7 @@ client.knowledgebase.articles.list(
-
-**type:** `typing.Optional[ArticlesListRequestType]` β If provided, will only return articles of the given type.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -35714,7 +40289,7 @@ client.knowledgebase.articles.list(
client.knowledgebase.articles.retrieve(...)
+client.hris.employees.retrieve(...)
-
@@ -35726,7 +40301,7 @@ client.knowledgebase.articles.list(
-
-Returns an `Article` object with the given `id`.
+Returns an `Employee` object with the given `id`.
@@ -35742,19 +40317,22 @@ Returns an `Article` object with the given `id`.
```python
from merge import Merge
-from merge.resources.knowledgebase.resources.articles import (
- ArticlesRetrieveRequestExpand,
+from merge.resources.hris.resources.employees import (
+ EmployeesRetrieveRequestRemoteFields,
+ EmployeesRetrieveRequestShowEnumOrigins,
)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.articles.retrieve(
+client.hris.employees.retrieve(
id="id",
- expand=ArticlesRetrieveRequestExpand.ATTACHMENTS,
include_remote_data=True,
+ include_sensitive_fields=True,
include_shell_data=True,
+ remote_fields=EmployeesRetrieveRequestRemoteFields.EMPLOYMENT_STATUS,
+ show_enum_origins=EmployeesRetrieveRequestShowEnumOrigins.EMPLOYMENT_STATUS,
)
```
@@ -35779,7 +40357,12 @@ client.knowledgebase.articles.retrieve(
-
-**expand:** `typing.Optional[ArticlesRetrieveRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ EmployeesRetrieveRequestExpandItem,
+ typing.Sequence[EmployeesRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35795,6 +40378,14 @@ client.knowledgebase.articles.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).
@@ -35803,6 +40394,22 @@ client.knowledgebase.articles.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.
@@ -35815,8 +40422,7 @@ client.knowledgebase.articles.retrieve(
client.knowledgebase.async_passthrough.create(...)
+client.hris.employees.ignore_create(...)
-
@@ -35828,7 +40434,7 @@ client.knowledgebase.articles.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+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.
@@ -35844,16 +40450,16 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum
+from merge.resources.hris import IgnoreCommonModelRequest, ReasonEnum
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.hris.employees.ignore_create(
+ model_id="model_id",
+ request=IgnoreCommonModelRequest(
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
),
)
@@ -35871,7 +40477,15 @@ client.knowledgebase.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**model_id:** `str`
+
+
+
+
+
+-
+
+**request:** `IgnoreCommonModelRequest`
@@ -35891,7 +40505,7 @@ client.knowledgebase.async_passthrough.create(
client.knowledgebase.async_passthrough.retrieve(...)
+client.hris.employees.meta_post_retrieve()
-
@@ -35903,7 +40517,7 @@ client.knowledgebase.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns metadata for `Employee` POSTs.
@@ -35924,9 +40538,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_id",
-)
+client.hris.employees.meta_post_retrieve()
```
@@ -35942,14 +40554,6 @@ client.knowledgebase.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -35962,8 +40566,8 @@ client.knowledgebase.async_passthrough.retrieve(
client.knowledgebase.attachments.list(...)
+## Hris EmployerBenefits
+client.hris.employer_benefits.list(...)
-
@@ -35975,7 +40579,7 @@ client.knowledgebase.async_passthrough.retrieve(
-
-Returns a list of `Attachment` objects.
+Returns a list of `EmployerBenefit` objects.
@@ -35998,7 +40602,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.attachments.list(
+client.hris.employer_benefits.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -36125,7 +40729,7 @@ client.knowledgebase.attachments.list(
client.knowledgebase.attachments.retrieve(...)
+client.hris.employer_benefits.retrieve(...)
-
@@ -36137,7 +40741,7 @@ client.knowledgebase.attachments.list(
-
-Returns an `Attachment` object with the given `id`.
+Returns an `EmployerBenefit` object with the given `id`.
@@ -36158,7 +40762,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.attachments.retrieve(
+client.hris.employer_benefits.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -36214,187 +40818,8 @@ client.knowledgebase.attachments.retrieve(
client.knowledgebase.audit_trail.list(...)
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Gets a list of audit trail events.
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.audit_trail.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
-)
-
-```
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` β If included, will only include audit trail events that occurred before this time
-
-
-
-
-
--
-
-**event_type:** `typing.Optional[str]` β If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
-
-
-
-
--
-
-**start_date:** `typing.Optional[str]` β If included, will only include audit trail events that occurred after this time
-
-
-
-
-
--
-
-**user_email:** `typing.Optional[str]` β If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.knowledgebase.available_actions.retrieve()
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Returns a list of models and actions available for an account.
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.available_actions.retrieve()
-
-```
-
-
-
-
-
-#### βοΈ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.knowledgebase.containers.list(...)
+## Hris Employments
+client.hris.employments.list(...)
-
@@ -36406,7 +40831,7 @@ client.knowledgebase.available_actions.retrieve()
-
-Returns a list of `Container` objects.
+Returns a list of `Employment` objects.
@@ -36424,16 +40849,17 @@ Returns a list of `Container` objects.
import datetime
from merge import Merge
-from merge.resources.knowledgebase.resources.containers import (
- ContainersListRequestExpand,
- ContainersListRequestType,
+from merge.resources.hris.resources.employments import (
+ EmploymentsListRequestOrderBy,
+ EmploymentsListRequestRemoteFields,
+ EmploymentsListRequestShowEnumOrigins,
)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.containers.list(
+client.hris.employments.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -36441,7 +40867,7 @@ client.knowledgebase.containers.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ContainersListRequestExpand.PARENT_ARTICLE,
+ employee_id="employee_id",
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
@@ -36451,11 +40877,11 @@ client.knowledgebase.containers.list(
modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
+ order_by=EmploymentsListRequestOrderBy.EFFECTIVE_DATE_DESCENDING,
page_size=1,
- parent_article_id="parent_article_id",
- parent_container_id="parent_container_id",
+ remote_fields=EmploymentsListRequestRemoteFields.EMPLOYMENT_TYPE,
remote_id="remote_id",
- type=ContainersListRequestType.EMPTY,
+ show_enum_origins=EmploymentsListRequestShowEnumOrigins.EMPLOYMENT_TYPE,
)
```
@@ -36496,164 +40922,20 @@ 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.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**parent_article_id:** `typing.Optional[str]` β If provided, will only return sub containers of the parent_article_id.
-
-
-
-
-
--
-
-**parent_container_id:** `typing.Optional[str]` β If provided, will only return sub containers of the parent_container_id.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
-
-
-
-
--
-
-**type:** `typing.Optional[ContainersListRequestType]` β If provided, will only return containers of the given type.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**employee_id:** `typing.Optional[str]` β If provided, will only return employments for this employee.
-
-
-
-
-
-
-
-
-client.knowledgebase.containers.retrieve(...)
-
--
-
-#### π Description
-
-
--
-
-
--
-
-Returns a `Container` object with the given `id`.
-
-
-
-
-
-#### π Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.knowledgebase.resources.containers import (
- ContainersRetrieveRequestExpand,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.containers.retrieve(
- id="id",
- expand=ContainersRetrieveRequestExpand.PARENT_ARTICLE,
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-#### βοΈ Parameters
-
-
--
-
-
-**id:** `str`
+**expand:** `typing.Optional[
+ typing.Union[
+ EmploymentsListRequestExpandItem,
+ typing.Sequence[EmploymentsListRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -36661,7 +40943,7 @@ client.knowledgebase.containers.retrieve(
-
-**expand:** `typing.Optional[ContainersRetrieveRequestExpand]` β 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/).
@@ -36685,126 +40967,59 @@ client.knowledgebase.containers.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.
-
-
-
-
-
-
-client.knowledgebase.scopes.default_scopes_retrieve()
-
-#### π Description
-
-
--
-
-
--
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
-#### π Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.scopes.default_scopes_retrieve()
-
-```
-
-
+**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` β Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
+
-#### βοΈ Parameters
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
-client.knowledgebase.scopes.linked_account_scopes_retrieve()
-
-#### π Description
-
-
--
+**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+
+
+
-
-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_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
-#### π Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.scopes.linked_account_scopes_retrieve()
-
-```
-
-
+**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)
+
-#### βοΈ Parameters
-
-
--
-
-
@@ -36820,7 +41035,7 @@ client.knowledgebase.scopes.linked_account_scopes_retrieve()
client.knowledgebase.scopes.linked_account_scopes_create(...)
+client.hris.employments.retrieve(...)
-
@@ -36832,7 +41047,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 an `Employment` object with the given `id`.
@@ -36848,42 +41063,21 @@ 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,
+from merge.resources.hris.resources.employments import (
+ EmploymentsRetrieveRequestRemoteFields,
+ EmploymentsRetrieveRequestShowEnumOrigins,
)
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.hris.employments.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+ remote_fields=EmploymentsRetrieveRequestRemoteFields.EMPLOYMENT_TYPE,
+ show_enum_origins=EmploymentsRetrieveRequestShowEnumOrigins.EMPLOYMENT_TYPE,
)
```
@@ -36900,7 +41094,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 +41102,48 @@ client.knowledgebase.scopes.linked_account_scopes_create(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**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.
-
-
+
+-
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
-client.knowledgebase.delete_account.delete()
-
-#### π Description
-
-
--
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-
-Delete a linked account.
-
-
+**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+
-#### π Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.delete_account.delete()
-
-```
-
-
+**show_enum_origins:** `typing.Optional[EmploymentsRetrieveRequestShowEnumOrigins]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
-#### βοΈ Parameters
-
-
--
-
-
@@ -36982,8 +41159,8 @@ client.knowledgebase.delete_account.delete()
client.knowledgebase.field_mapping.field_mappings_retrieve(...)
+## Hris FieldMapping
+client.hris.field_mapping.field_mappings_retrieve(...)
-
@@ -37016,7 +41193,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.field_mappings_retrieve(
+client.hris.field_mapping.field_mappings_retrieve(
exclude_remote_field_metadata=True,
)
@@ -37054,7 +41231,7 @@ client.knowledgebase.field_mapping.field_mappings_retrieve(
client.knowledgebase.field_mapping.field_mappings_create(...)
+client.hris.field_mapping.field_mappings_create(...)
-
@@ -37087,7 +41264,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.field_mappings_create(
+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",
@@ -37187,7 +41364,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
client.knowledgebase.field_mapping.field_mappings_destroy(...)
+client.hris.field_mapping.field_mappings_destroy(...)
-
@@ -37220,7 +41397,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.field_mappings_destroy(
+client.hris.field_mapping.field_mappings_destroy(
field_mapping_id="field_mapping_id",
)
@@ -37258,7 +41435,7 @@ client.knowledgebase.field_mapping.field_mappings_destroy(
client.knowledgebase.field_mapping.field_mappings_partial_update(...)
+client.hris.field_mapping.field_mappings_partial_update(...)
-
@@ -37291,8 +41468,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.field_mappings_partial_update(
+client.hris.field_mapping.field_mappings_partial_update(
field_mapping_id="field_mapping_id",
+ remote_data_iteration_count=1,
)
```
@@ -37317,6 +41495,14 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-
+**remote_data_iteration_count:** `typing.Optional[int]` β Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided.
+
+
+
+
+
+-
+
**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.
@@ -37361,7 +41547,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
client.knowledgebase.field_mapping.remote_fields_retrieve(...)
+client.hris.field_mapping.remote_fields_retrieve(...)
-
@@ -37394,7 +41580,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.remote_fields_retrieve(
+client.hris.field_mapping.remote_fields_retrieve(
common_models="common_models",
include_example_values="include_example_values",
)
@@ -37441,7 +41627,7 @@ client.knowledgebase.field_mapping.remote_fields_retrieve(
client.knowledgebase.field_mapping.target_fields_retrieve()
+client.hris.field_mapping.target_fields_retrieve()
-
@@ -37474,7 +41660,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.target_fields_retrieve()
+client.hris.field_mapping.target_fields_retrieve()
```
@@ -37502,8 +41688,8 @@ client.knowledgebase.field_mapping.target_fields_retrieve()
client.knowledgebase.generate_key.create(...)
+## Hris GenerateKey
+client.hris.generate_key.create(...)
-
@@ -37536,7 +41722,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.generate_key.create(
+client.hris.generate_key.create(
name="Remote Deployment Key 1",
)
@@ -37574,8 +41760,8 @@ client.knowledgebase.generate_key.create(
client.knowledgebase.groups.list(...)
+## Hris Groups
+client.hris.groups.list(...)
-
@@ -37605,15 +41791,12 @@ Returns a list of `Group` objects.
import datetime
from merge import Merge
-from merge.resources.knowledgebase.resources.groups import (
- GroupsListRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.groups.list(
+client.hris.groups.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -37621,18 +41804,20 @@ client.knowledgebase.groups.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=GroupsListRequestExpand.PARENT_GROUP,
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
+ 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",
)
```
@@ -37673,7 +41858,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.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -37681,7 +41866,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/).
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -37689,7 +41874,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.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -37697,7 +41882,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).
+**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.
@@ -37721,6 +41906,14 @@ client.knowledgebase.groups.list(
-
+**names:** `typing.Optional[str]` β If provided, will only return groups with these names. Multiple values can be separated by commas.
+
+
+
+
+
+-
+
**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -37729,6 +41922,14 @@ client.knowledgebase.groups.list(
-
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` β Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -37737,6 +41938,22 @@ client.knowledgebase.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)
+
+
+
+
+
+-
+
+**types:** `typing.Optional[str]` β If provided, will only return groups of these types. Multiple values can be separated by commas.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -37749,7 +41966,7 @@ client.knowledgebase.groups.list(
client.knowledgebase.groups.retrieve(...)
+client.hris.groups.retrieve(...)
-
@@ -37777,17 +41994,13 @@ Returns a `Group` object with the given `id`.
```python
from merge import Merge
-from merge.resources.knowledgebase.resources.groups import (
- GroupsRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.groups.retrieve(
+client.hris.groups.retrieve(
id="id",
- expand=GroupsRetrieveRequestExpand.PARENT_GROUP,
include_remote_data=True,
include_shell_data=True,
)
@@ -37814,7 +42027,7 @@ client.knowledgebase.groups.retrieve(
-
-**expand:** `typing.Optional[GroupsRetrieveRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -37822,7 +42035,7 @@ client.knowledgebase.groups.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -37830,7 +42043,15 @@ client.knowledgebase.groups.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**remote_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)
@@ -37850,8 +42071,88 @@ client.knowledgebase.groups.retrieve(
client.knowledgebase.issues.list(...)
+client.hris.groups.types_list(...)
+
+-
+
+#### π Description
+
+
+-
+
+
+-
+
+Returns a list of distinct group type values from the Groups common model.
+
+
+
+
+
+#### π Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.groups.types_list(
+ include_deleted_data=True,
+ show_enum_origins="show_enum_origins",
+)
+
+```
+
+
+
+
+
+#### βοΈ Parameters
+
+
+-
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` β Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[str]` β A comma separated list of enum field names for which you'd like the original values instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.issues.list(...)
-
@@ -37881,15 +42182,13 @@ Gets all issues for Organization.
import datetime
from merge import Merge
-from merge.resources.knowledgebase.resources.issues import (
- IssuesListRequestStatus,
-)
+from merge.resources.hris.resources.issues import IssuesListRequestStatus
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.issues.list(
+client.hris.issues.list(
account_token="account_token",
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
end_date="end_date",
@@ -38057,7 +42356,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
client.knowledgebase.issues.retrieve(...)
+client.hris.issues.retrieve(...)
-
@@ -38090,7 +42389,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.issues.retrieve(
+client.hris.issues.retrieve(
id="id",
)
@@ -38128,8 +42427,8 @@ client.knowledgebase.issues.retrieve(
client.knowledgebase.link_token.create(...)
+## Hris LinkToken
+client.hris.link_token.create(...)
-
@@ -38141,7 +42440,7 @@ client.knowledgebase.issues.retrieve(
-
-Creates a link token to be used when linking a new end user.
+Creates a link token to be used when linking a new end user. The link token expires after single use.
@@ -38157,13 +42456,13 @@ Creates a link token to be used when linking a new end user.
```python
from merge import Merge
-from merge.resources.knowledgebase import CategoriesEnum
+from merge.resources.hris import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.link_token.create(
+client.hris.link_token.create(
end_user_email_address="example@gmail.com",
end_user_organization_name="Test Organization",
end_user_origin_id="12345",
@@ -38300,11 +42599,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
+**linked_destination_id:** `typing.Optional[str]` β The UUID of the linked destination that you want this Linked Account to be tied to.
@@ -38324,8 +42619,8 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
client.knowledgebase.linked_accounts.list(...)
+## Hris LinkedAccounts
+client.hris.linked_accounts.list(...)
-
@@ -38353,7 +42648,7 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.knowledgebase.resources.linked_accounts import (
+from merge.resources.hris.resources.linked_accounts import (
LinkedAccountsListRequestCategory,
)
@@ -38361,7 +42656,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.linked_accounts.list(
+client.hris.linked_accounts.list(
category=LinkedAccountsListRequestCategory.ACCOUNTING,
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
end_user_email_address="end_user_email_address",
@@ -38393,7 +42688,7 @@ client.knowledgebase.linked_accounts.list(
**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing`
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
* `hris` - hris
* `ats` - ats
@@ -38402,7 +42697,6 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
* `crm` - crm
* `mktg` - mktg
* `filestorage` - filestorage
-* `knowledgebase` - knowledgebase
@@ -38518,8 +42812,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
client.knowledgebase.passthrough.create(...)
+## Hris Locations
+client.hris.locations.list(...)
-
@@ -38531,7 +42825,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-Pull data from an endpoint not currently supported by Merge.
+Returns a list of `Location` objects.
@@ -38546,18 +42840,41 @@ Pull data from an endpoint not currently supported by Merge.
-
```python
+import datetime
+
from merge import Merge
-from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum
+from merge.resources.hris.resources.locations import (
+ LocationsListRequestLocationType,
+ LocationsListRequestRemoteFields,
+ LocationsListRequestShowEnumOrigins,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
+client.hris.locations.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ location_type=LocationsListRequestLocationType.HOME,
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ page_size=1,
+ remote_fields=LocationsListRequestRemoteFields.COUNTRY,
+ remote_id="remote_id",
+ show_enum_origins=LocationsListRequestShowEnumOrigins.COUNTRY,
)
```
@@ -38574,7 +42891,7 @@ client.knowledgebase.passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -38582,71 +42899,100 @@ client.knowledgebase.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.knowledgebase.regenerate_key.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.
+
+
+
+
-
-Exchange remote keys.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+-
+
+**location_type:** `typing.Optional[LocationsListRequestLocationType]`
+
+If provided, will only return locations with this location type
+
+* `HOME` - HOME
+* `WORK` - WORK
+
-#### π 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
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.regenerate_key.create(
- name="Remote Deployment Key 1",
-)
+
+-
-```
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+-
+
+**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+
-#### βοΈ Parameters
-
-
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
+
+
+
-
-**name:** `str` β The name of the remote key
+**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)
@@ -38666,8 +43012,7 @@ client.knowledgebase.regenerate_key.create(
client.knowledgebase.sync_status.list(...)
+client.hris.locations.retrieve(...)
-
@@ -38679,7 +43024,7 @@ client.knowledgebase.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 `Location` object with the given `id`.
@@ -38695,14 +43040,21 @@ Get sync status for the current sync and the most recently finished sync. `last_
```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.knowledgebase.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
+client.hris.locations.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+ remote_fields=LocationsRetrieveRequestRemoteFields.COUNTRY,
+ show_enum_origins=LocationsRetrieveRequestShowEnumOrigins.COUNTRY,
)
```
@@ -38719,7 +43071,7 @@ client.knowledgebase.sync_status.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**id:** `str`
@@ -38727,7 +43079,31 @@ client.knowledgebase.sync_status.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[LocationsRetrieveRequestShowEnumOrigins]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -38747,8 +43123,8 @@ client.knowledgebase.sync_status.list(
client.knowledgebase.force_resync.sync_status_resync_create()
+## Hris Passthrough
+client.hris.passthrough.create(...)
-
@@ -38760,7 +43136,7 @@ client.knowledgebase.sync_status.list(
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+Pull data from an endpoint not currently supported by Merge.
@@ -38776,12 +43152,18 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```python
from merge import Merge
+from merge.resources.hris import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.force_resync.sync_status_resync_create()
+client.hris.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
```
@@ -38797,6 +43179,14 @@ client.knowledgebase.force_resync.sync_status_resync_create()
-
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -38809,8 +43199,8 @@ client.knowledgebase.force_resync.sync_status_resync_create()
client.knowledgebase.users.list(...)
+## Hris PayGroups
+client.hris.pay_groups.list(...)
-
@@ -38822,7 +43212,7 @@ client.knowledgebase.force_resync.sync_status_resync_create()
-
-Returns a list of `User` objects.
+Returns a list of `PayGroup` objects.
@@ -38845,7 +43235,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.users.list(
+client.hris.pay_groups.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -38972,7 +43362,7 @@ client.knowledgebase.users.list(
client.knowledgebase.users.retrieve(...)
+client.hris.pay_groups.retrieve(...)
-
@@ -38984,7 +43374,7 @@ client.knowledgebase.users.list(
-
-Returns a `User` object with the given `id`.
+Returns a `PayGroup` object with the given `id`.
@@ -39005,7 +43395,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.users.retrieve(
+client.hris.pay_groups.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -39061,8 +43451,8 @@ client.knowledgebase.users.retrieve(
client.knowledgebase.webhook_receivers.list()
+## Hris PayrollRuns
+client.hris.payroll_runs.list(...)
-
@@ -39074,7 +43464,7 @@ client.knowledgebase.users.retrieve(
-
-Returns a list of `WebhookReceiver` objects.
+Returns a list of `PayrollRun` objects.
@@ -39089,13 +43479,54 @@ Returns a list of `WebhookReceiver` objects.
-
```python
+import datetime
+
from merge import Merge
+from merge.resources.hris.resources.payroll_runs import (
+ PayrollRunsListRequestRemoteFields,
+ PayrollRunsListRequestRunType,
+ PayrollRunsListRequestShowEnumOrigins,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.webhook_receivers.list()
+client.hris.payroll_runs.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ ended_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ ended_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ page_size=1,
+ remote_fields=PayrollRunsListRequestRemoteFields.RUN_STATE,
+ remote_id="remote_id",
+ run_type=PayrollRunsListRequestRunType.CORRECTION,
+ show_enum_origins=PayrollRunsListRequestShowEnumOrigins.RUN_STATE,
+ started_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ started_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+)
```
@@ -39111,71 +43542,127 @@ client.knowledgebase.webhook_receivers.list()
-
-**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.knowledgebase.webhook_receivers.create(...)
-
-#### π Description
+**ended_after:** `typing.Optional[dt.datetime]` β If provided, will only return payroll runs ended after this datetime.
+
+
+
-
+**ended_before:** `typing.Optional[dt.datetime]` β If provided, will only return payroll runs ended before this datetime.
+
+
+
+
-
-Creates a `WebhookReceiver` 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/).
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### π Usage
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
-
-```python
-from merge import Merge
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.webhook_receivers.create(
- event="event",
- is_active=True,
-)
+
+-
-```
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+
+
+
+-
+
+**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+
-#### βοΈ Parameters
+
+-
+
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
+
+
-
+**run_type:** `typing.Optional[PayrollRunsListRequestRunType]`
+
+If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
+
+* `REGULAR` - REGULAR
+* `OFF_CYCLE` - OFF_CYCLE
+* `CORRECTION` - CORRECTION
+* `TERMINATION` - TERMINATION
+* `SIGN_ON_BONUS` - SIGN_ON_BONUS
+
+
+
+
-
-**event:** `str`
+**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)
@@ -39183,7 +43670,7 @@ client.knowledgebase.webhook_receivers.create(
-
-**is_active:** `bool`
+**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return payroll runs started after this datetime.
@@ -39191,7 +43678,7 @@ client.knowledgebase.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return payroll runs started before this datetime.
@@ -39211,8 +43698,7 @@ client.knowledgebase.webhook_receivers.create(
client.ticketing.account_details.retrieve()
+client.hris.payroll_runs.retrieve(...)
-
@@ -39224,7 +43710,7 @@ client.knowledgebase.webhook_receivers.create(
-
-Get details for a linked account.
+Returns a `PayrollRun` object with the given `id`.
@@ -39240,12 +43726,22 @@ Get details for a linked account.
```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.ticketing.account_details.retrieve()
+client.hris.payroll_runs.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+ remote_fields=PayrollRunsRetrieveRequestRemoteFields.RUN_STATE,
+ show_enum_origins=PayrollRunsRetrieveRequestShowEnumOrigins.RUN_STATE,
+)
```
@@ -39261,6 +43757,46 @@ client.ticketing.account_details.retrieve()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -39273,8 +43809,8 @@ client.ticketing.account_details.retrieve()
client.ticketing.account_token.retrieve(...)
+## Hris RegenerateKey
+client.hris.regenerate_key.create(...)
-
@@ -39286,7 +43822,7 @@ client.ticketing.account_details.retrieve()
-
-Returns the account token for the end user with the provided public token.
+Exchange remote keys.
@@ -39307,8 +43843,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.account_token.retrieve(
- public_token="public_token",
+client.hris.regenerate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -39325,7 +43861,7 @@ client.ticketing.account_token.retrieve(
-
-**public_token:** `str`
+**name:** `str` β The name of the remote key
@@ -39345,8 +43881,8 @@ client.ticketing.account_token.retrieve(
client.ticketing.accounts.list(...)
+## Hris SyncStatus
+client.hris.sync_status.list(...)
-
@@ -39358,7 +43894,7 @@ client.ticketing.account_token.retrieve(
-
-Returns a list of `Account` objects.
+Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -39373,33 +43909,15 @@ Returns a list of `Account` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.accounts.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+client.hris.sync_status.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
page_size=1,
- remote_id="remote_id",
)
```
@@ -39416,7 +43934,7 @@ client.ticketing.accounts.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -39424,7 +43942,7 @@ client.ticketing.accounts.list(
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -39432,67 +43950,65 @@ client.ticketing.accounts.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
-
--
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
+client.hris.force_resync.sync_status_resync_create()
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
+#### π Description
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
+Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+
+
+#### π Usage
+
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.force_resync.sync_status_resync_create()
+
+```
+
+
+#### βοΈ Parameters
+
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
-
-
-
-
-
@@ -39508,7 +44024,8 @@ client.ticketing.accounts.list(
client.ticketing.accounts.retrieve(...)
+## Hris Teams
+client.hris.teams.list(...)
-
@@ -39520,7 +44037,7 @@ client.ticketing.accounts.list(
-
-Returns an `Account` object with the given `id`.
+Returns a list of `Team` objects.
@@ -39535,16 +44052,34 @@ Returns an `Account` object with the given `id`.
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.accounts.retrieve(
- id="id",
+client.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",
)
```
@@ -39561,7 +44096,44 @@ client.ticketing.accounts.retrieve(
-
-**id:** `str`
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["parent_team"],
+ typing.Sequence[typing.Literal["parent_team"]],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -39585,75 +44157,39 @@ client.ticketing.accounts.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.
-
-
-
-
-
-client.ticketing.async_passthrough.create(...)
-
-#### π Description
-
-
--
+**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.
+
-#### π 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",
- ),
-)
-
-```
-
-
+**parent_team_id:** `typing.Optional[str]` β If provided, will only return teams with this parent team.
+
-#### βοΈ Parameters
-
-
-
--
-
-**request:** `DataPassthroughRequest`
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -39673,7 +44209,7 @@ client.ticketing.async_passthrough.create(
client.ticketing.async_passthrough.retrieve(...)
+client.hris.teams.retrieve(...)
-
@@ -39685,7 +44221,7 @@ client.ticketing.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns a `Team` object with the given `id`.
@@ -39706,8 +44242,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_id",
+client.hris.teams.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -39724,7 +44262,36 @@ client.ticketing.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["parent_team"],
+ typing.Sequence[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).
@@ -39744,8 +44311,8 @@ client.ticketing.async_passthrough.retrieve(
client.ticketing.attachments.list(...)
+## Hris TimeOff
+client.hris.time_off.list(...)
-
@@ -39757,7 +44324,7 @@ client.ticketing.async_passthrough.retrieve(
-
-Returns a list of `Attachment` objects.
+Returns a list of `TimeOff` objects.
@@ -39775,12 +44342,19 @@ Returns a list of `Attachment` objects.
import datetime
from merge import Merge
+from merge.resources.hris.resources.time_off import (
+ TimeOffListRequestRemoteFields,
+ TimeOffListRequestRequestType,
+ TimeOffListRequestShowEnumOrigins,
+ TimeOffListRequestStatus,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.attachments.list(
+client.hris.time_off.list(
+ approver_id="approver_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -39788,6 +44362,13 @@ client.ticketing.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,
@@ -39798,11 +44379,17 @@ client.ticketing.attachments.list(
"2024-01-15 09:30:00+00:00",
),
page_size=1,
- remote_created_after=datetime.datetime.fromisoformat(
+ 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",
),
- remote_id="remote_id",
- ticket_id="ticket_id",
+ started_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ status=TimeOffListRequestStatus.APPROVED,
)
```
@@ -39819,7 +44406,7 @@ client.ticketing.attachments.list(
-
-**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
+**approver_id:** `typing.Optional[str]` β If provided, will only return time off for this approver.
@@ -39827,7 +44414,7 @@ client.ticketing.attachments.list(
-
-**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -39835,7 +44422,7 @@ client.ticketing.attachments.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -39843,7 +44430,7 @@ client.ticketing.attachments.list(
-
-**expand:** `typing.Optional[typing.Literal["ticket"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -39851,7 +44438,7 @@ client.ticketing.attachments.list(
-
-**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**employee_id:** `typing.Optional[str]` β If provided, will only return time off for this employee.
@@ -39859,7 +44446,7 @@ client.ticketing.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 employees that ended after this datetime.
@@ -39867,7 +44454,7 @@ client.ticketing.attachments.list(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**ended_before:** `typing.Optional[dt.datetime]` β If provided, will only return time-offs that ended before this datetime.
@@ -39875,7 +44462,12 @@ client.ticketing.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[
+ TimeOffListRequestExpandItem,
+ typing.Sequence[TimeOffListRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -39883,7 +44475,7 @@ client.ticketing.attachments.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -39891,7 +44483,7 @@ client.ticketing.attachments.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -39899,7 +44491,7 @@ client.ticketing.attachments.list(
-
-**remote_created_after:** `typing.Optional[dt.datetime]` β If provided, will only return attachments created in the third party platform after this datetime.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -39907,7 +44499,7 @@ client.ticketing.attachments.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.
@@ -39915,7 +44507,7 @@ client.ticketing.attachments.list(
-
-**ticket_id:** `typing.Optional[str]` β If provided, will only return comments for this ticket.
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -39923,73 +44515,56 @@ client.ticketing.attachments.list(
-
-**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+**page_size:** `typing.Optional[int]` β Number of results to return per page.
-
-
-
-
-
-
-client.ticketing.attachments.create(...)
-
-#### π Description
-
-
--
+**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` β Deprecated. Use show_enum_origins.
+
+
+
-
-Creates an `Attachment` object with the given values.
-
-
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
-#### π Usage
-
-
--
-
-
-```python
-from merge import Merge
-from merge.resources.ticketing import AttachmentRequest
+**request_type:** `typing.Optional[TimeOffListRequestRequestType]`
-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(),
-)
+If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
-```
-
-
+* `VACATION` - VACATION
+* `SICK` - SICK
+* `PERSONAL` - PERSONAL
+* `JURY_DUTY` - JURY_DUTY
+* `VOLUNTEER` - VOLUNTEER
+* `BEREAVEMENT` - BEREAVEMENT
+
-#### βοΈ Parameters
-
-
+**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)
+
+
+
+
-
-**model:** `AttachmentRequest`
+**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return time-offs that started after this datetime.
@@ -39997,7 +44572,7 @@ client.ticketing.attachments.create(
-
-**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
+**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return time-offs that started before this datetime.
@@ -40005,7 +44580,15 @@ client.ticketing.attachments.create(
-
-**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
+**status:** `typing.Optional[TimeOffListRequestStatus]`
+
+If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')
+
+* `REQUESTED` - REQUESTED
+* `APPROVED` - APPROVED
+* `DECLINED` - DECLINED
+* `CANCELLED` - CANCELLED
+* `DELETED` - DELETED
@@ -40025,7 +44608,7 @@ client.ticketing.attachments.create(
client.ticketing.attachments.retrieve(...)
+client.hris.time_off.create(...)
-
@@ -40037,7 +44620,7 @@ client.ticketing.attachments.create(
-
-Returns an `Attachment` object with the given `id`.
+Creates a `TimeOff` object with the given values.
@@ -40053,15 +44636,16 @@ Returns an `Attachment` object with the given `id`.
```python
from merge import Merge
+from merge.resources.hris import TimeOffRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.attachments.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.hris.time_off.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=TimeOffRequest(),
)
```
@@ -40078,15 +44662,7 @@ client.ticketing.attachments.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["ticket"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**model:** `TimeOffRequest`
@@ -40094,7 +44670,7 @@ client.ticketing.attachments.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -40102,7 +44678,7 @@ client.ticketing.attachments.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -40122,7 +44698,7 @@ client.ticketing.attachments.retrieve(
client.ticketing.attachments.meta_post_retrieve()
+client.hris.time_off.retrieve(...)
-
@@ -40134,7 +44710,7 @@ client.ticketing.attachments.retrieve(
-
-Returns metadata for `TicketingAttachment` POSTs.
+Returns a `TimeOff` object with the given `id`.
@@ -40150,80 +44726,21 @@ Returns metadata for `TicketingAttachment` POSTs.
```python
from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
+from merge.resources.hris.resources.time_off import (
+ TimeOffRetrieveRequestRemoteFields,
+ TimeOffRetrieveRequestShowEnumOrigins,
)
-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",
+client.hris.time_off.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+ remote_fields=TimeOffRetrieveRequestRemoteFields.REQUEST_TYPE,
+ show_enum_origins=TimeOffRetrieveRequestShowEnumOrigins.REQUEST_TYPE,
)
```
@@ -40240,7 +44757,7 @@ client.ticketing.audit_trail.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**id:** `str`
@@ -40248,7 +44765,12 @@ client.ticketing.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[
+ TimeOffRetrieveRequestExpandItem,
+ typing.Sequence[TimeOffRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -40256,7 +44778,7 @@ client.ticketing.audit_trail.list(
-
-**event_type:** `typing.Optional[str]` β If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -40264,7 +44786,7 @@ client.ticketing.audit_trail.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -40272,7 +44794,7 @@ client.ticketing.audit_trail.list(
-
-**start_date:** `typing.Optional[str]` β If included, will only include audit trail events that occurred after this time
+**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` β Deprecated. Use show_enum_origins.
@@ -40280,7 +44802,7 @@ client.ticketing.audit_trail.list(
-
-**user_email:** `typing.Optional[str]` β If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+**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)
@@ -40300,8 +44822,7 @@ client.ticketing.audit_trail.list(
client.ticketing.available_actions.retrieve()
+client.hris.time_off.meta_post_retrieve()
-
@@ -40313,7 +44834,7 @@ client.ticketing.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Returns metadata for `TimeOff` POSTs.
@@ -40334,7 +44855,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.available_actions.retrieve()
+client.hris.time_off.meta_post_retrieve()
```
@@ -40362,8 +44883,8 @@ client.ticketing.available_actions.retrieve()
client.ticketing.collections.list(...)
+## Hris TimeOffBalances
+client.hris.time_off_balances.list(...)
-
@@ -40375,7 +44896,7 @@ client.ticketing.available_actions.retrieve()
-
-Returns a list of `Collection` objects.
+Returns a list of `TimeOffBalance` objects.
@@ -40393,16 +44914,15 @@ Returns a list of `Collection` objects.
import datetime
from merge import Merge
-from merge.resources.ticketing.resources.collections import (
- CollectionsListRequestCollectionType,
+from merge.resources.hris.resources.time_off_balances import (
+ TimeOffBalancesListRequestPolicyType,
)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.collections.list(
- collection_type=CollectionsListRequestCollectionType.EMPTY,
+client.hris.time_off_balances.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -40410,6 +44930,7 @@ client.ticketing.collections.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,
@@ -40419,9 +44940,8 @@ client.ticketing.collections.list(
modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- name="name",
page_size=1,
- parent_collection_id="parent_collection_id",
+ policy_type=TimeOffBalancesListRequestPolicyType.BEREAVEMENT,
remote_id="remote_id",
)
@@ -40439,7 +44959,7 @@ client.ticketing.collections.list(
-
-**collection_type:** `typing.Optional[CollectionsListRequestCollectionType]` β If provided, will only return collections of the given type.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -40447,7 +44967,7 @@ client.ticketing.collections.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.
@@ -40455,7 +44975,7 @@ client.ticketing.collections.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.
@@ -40463,7 +44983,7 @@ client.ticketing.collections.list(
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**employee_id:** `typing.Optional[str]` β If provided, will only return time off balances for this employee.
@@ -40471,7 +44991,11 @@ client.ticketing.collections.list(
-
-**expand:** `typing.Optional[typing.Literal["parent_collection"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.
@@ -40519,7 +45043,7 @@ client.ticketing.collections.list(
-
-**name:** `typing.Optional[str]` β If provided, will only return collections with this name.
+**page_size:** `typing.Optional[int]` β Number of results to return per page.
@@ -40527,15 +45051,16 @@ client.ticketing.collections.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
-
-
-
+**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]`
-
--
+If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
-**parent_collection_id:** `typing.Optional[str]` β If provided, will only return collections whose parent collection matches the given id.
+* `VACATION` - VACATION
+* `SICK` - SICK
+* `PERSONAL` - PERSONAL
+* `JURY_DUTY` - JURY_DUTY
+* `VOLUNTEER` - VOLUNTEER
+* `BEREAVEMENT` - BEREAVEMENT
@@ -40543,7 +45068,7 @@ client.ticketing.collections.list(
-
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` β Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` β Deprecated. Use show_enum_origins.
@@ -40559,135 +45084,7 @@ client.ticketing.collections.list(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["collection_type"]]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
-**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.
+**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)
@@ -40707,7 +45104,7 @@ client.ticketing.collections.viewers_list(
client.ticketing.collections.retrieve(...)
+client.hris.time_off_balances.retrieve(...)
-
@@ -40719,7 +45116,7 @@ client.ticketing.collections.viewers_list(
-
-Returns a `Collection` object with the given `id`.
+Returns a `TimeOffBalance` object with the given `id`.
@@ -40740,7 +45137,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.collections.retrieve(
+client.hris.time_off_balances.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -40768,7 +45165,11 @@ client.ticketing.collections.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["parent_collection"]]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.
@@ -40792,7 +45193,7 @@ client.ticketing.collections.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` β Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` β Deprecated. Use show_enum_origins.
@@ -40800,7 +45201,7 @@ client.ticketing.collections.retrieve(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["collection_type"]]` β A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**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)
@@ -40820,8 +45221,8 @@ client.ticketing.collections.retrieve(
client.ticketing.comments.list(...)
+## Hris TimesheetEntries
+client.hris.timesheet_entries.list(...)
-
@@ -40833,7 +45234,7 @@ client.ticketing.collections.retrieve(
-
-Returns a list of `Comment` objects.
+Returns a list of `TimesheetEntry` objects.
@@ -40851,15 +45252,15 @@ Returns a list of `Comment` objects.
import datetime
from merge import Merge
-from merge.resources.ticketing.resources.comments import (
- CommentsListRequestExpand,
+from merge.resources.hris.resources.timesheet_entries import (
+ TimesheetEntriesListRequestOrderBy,
)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.comments.list(
+client.hris.timesheet_entries.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -40867,7 +45268,13 @@ client.ticketing.comments.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=CommentsListRequestExpand.CONTACT,
+ 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,
@@ -40877,12 +45284,15 @@ client.ticketing.comments.list(
modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
+ order_by=TimesheetEntriesListRequestOrderBy.START_TIME_DESCENDING,
page_size=1,
- remote_created_after=datetime.datetime.fromisoformat(
+ 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",
),
- remote_id="remote_id",
- ticket_id="ticket_id",
)
```
@@ -40923,7 +45333,35 @@ client.ticketing.comments.list(
-
-**expand:** `typing.Optional[CommentsListRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**employee_id:** `typing.Optional[str]` β If provided, will only return timesheet entries for this employee.
+
+
+
+
+
+-
+
+**ended_after:** `typing.Optional[dt.datetime]` β If provided, will only return timesheet entries ended after this datetime.
+
+
+
+
+
+-
+
+**ended_before:** `typing.Optional[dt.datetime]` β If provided, will only return timesheet entries ended before this datetime.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.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.
@@ -40971,7 +45409,7 @@ client.ticketing.comments.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` β Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
@@ -40979,7 +45417,7 @@ client.ticketing.comments.list(
-
-**remote_created_after:** `typing.Optional[dt.datetime]` β If provided, will only return Comments created in the third party platform after this datetime.
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -40995,7 +45433,15 @@ client.ticketing.comments.list(
-
-**ticket_id:** `typing.Optional[str]` β If provided, will only return comments for this ticket.
+**started_after:** `typing.Optional[dt.datetime]` β If provided, will only return timesheet entries started after this datetime.
+
+
+
+
+
+-
+
+**started_before:** `typing.Optional[dt.datetime]` β If provided, will only return timesheet entries started before this datetime.
@@ -41015,7 +45461,7 @@ client.ticketing.comments.list(
client.ticketing.comments.create(...)
+client.hris.timesheet_entries.create(...)
-
@@ -41027,7 +45473,7 @@ client.ticketing.comments.list(
-
-Creates a `Comment` object with the given values.
+Creates a `TimesheetEntry` object with the given values.
@@ -41043,16 +45489,16 @@ Creates a `Comment` object with the given values.
```python
from merge import Merge
-from merge.resources.ticketing import CommentRequest
+from merge.resources.hris import TimesheetEntryRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.comments.create(
+client.hris.timesheet_entries.create(
is_debug_mode=True,
run_async=True,
- model=CommentRequest(),
+ model=TimesheetEntryRequest(),
)
```
@@ -41069,7 +45515,7 @@ client.ticketing.comments.create(
-
-**model:** `CommentRequest`
+**model:** `TimesheetEntryRequest`
@@ -41105,7 +45551,7 @@ client.ticketing.comments.create(
client.ticketing.comments.retrieve(...)
+client.hris.timesheet_entries.retrieve(...)
-
@@ -41117,7 +45563,7 @@ client.ticketing.comments.create(
-
-Returns a `Comment` object with the given `id`.
+Returns a `TimesheetEntry` object with the given `id`.
@@ -41133,17 +45579,13 @@ Returns a `Comment` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ticketing.resources.comments import (
- CommentsRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.comments.retrieve(
+client.hris.timesheet_entries.retrieve(
id="id",
- expand=CommentsRetrieveRequestExpand.CONTACT,
include_remote_data=True,
include_shell_data=True,
)
@@ -41170,7 +45612,11 @@ client.ticketing.comments.retrieve(
-
-**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ 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.
@@ -41206,7 +45652,7 @@ client.ticketing.comments.retrieve(
client.ticketing.comments.meta_post_retrieve()
+client.hris.timesheet_entries.meta_post_retrieve()
-
@@ -41218,7 +45664,7 @@ client.ticketing.comments.retrieve(
-
-Returns metadata for `Comment` POSTs.
+Returns metadata for `TimesheetEntry` POSTs.
@@ -41239,7 +45685,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.comments.meta_post_retrieve()
+client.hris.timesheet_entries.meta_post_retrieve()
```
@@ -41267,8 +45713,8 @@ client.ticketing.comments.meta_post_retrieve()
client.ticketing.contacts.list(...)
+## Hris WebhookReceivers
+client.hris.webhook_receivers.list()
-
@@ -41280,7 +45726,7 @@ client.ticketing.comments.meta_post_retrieve()
-
-Returns a list of `Contact` objects.
+Returns a list of `WebhookReceiver` objects.
@@ -41295,35 +45741,13 @@ Returns a list of `Contact` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.contacts.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- email_address="email_address",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
+client.hris.webhook_receivers.list()
```
@@ -41339,79 +45763,71 @@ client.ticketing.contacts.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.webhook_receivers.create(...)
-
-**email_address:** `typing.Optional[str]` β If provided, will only return Contacts that match this email.
-
-
-
+#### π Description
-
-**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/).
-
+Creates a `WebhookReceiver` object with the given values.
+
+
+#### π Usage
+
-
-**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
-**include_shell_data:** `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.webhook_receivers.create(
+ event="event",
+ is_active=True,
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
-**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
+**event:** `str`
@@ -41419,7 +45835,7 @@ client.ticketing.contacts.list(
-
-**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
+**is_active:** `bool`
@@ -41427,7 +45843,7 @@ client.ticketing.contacts.list(
-
-**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+**key:** `typing.Optional[str]`
@@ -41447,7 +45863,8 @@ client.ticketing.contacts.list(
client.ticketing.contacts.create(...)
+## Ticketing AccountDetails
+client.ticketing.account_details.retrieve()
-
@@ -41459,7 +45876,7 @@ client.ticketing.contacts.list(
-
-Creates a `Contact` object with the given values.
+Get details for a linked account.
@@ -41475,17 +45892,12 @@ Creates a `Contact` object with the given values.
```python
from merge import Merge
-from merge.resources.ticketing import ContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.contacts.create(
- is_debug_mode=True,
- run_async=True,
- model=ContactRequest(),
-)
+client.ticketing.account_details.retrieve()
```
@@ -41501,30 +45913,6 @@ client.ticketing.contacts.create(
-
-**model:** `ContactRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -41537,7 +45925,8 @@ client.ticketing.contacts.create(
client.ticketing.contacts.retrieve(...)
+## Ticketing AccountToken
+client.ticketing.account_token.retrieve(...)
-
@@ -41549,7 +45938,7 @@ client.ticketing.contacts.create(
-
-Returns a `Contact` object with the given `id`.
+Returns the account token for the end user with the provided public token.
@@ -41570,10 +45959,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.contacts.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.ticketing.account_token.retrieve(
+ public_token="public_token",
)
```
@@ -41590,31 +45977,7 @@ client.ticketing.contacts.retrieve(
-
-**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).
+**public_token:** `str`
@@ -41634,7 +45997,7 @@ client.ticketing.contacts.retrieve(
client.ticketing.contacts.meta_post_retrieve()
+client.ticketing.account_token.regenerate_create()
-
@@ -41646,7 +46009,7 @@ client.ticketing.contacts.retrieve(
-
-Returns metadata for `TicketingContact` POSTs.
+Exchange Linked Account account tokens.
@@ -41667,7 +46030,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.contacts.meta_post_retrieve()
+client.ticketing.account_token.regenerate_create()
```
@@ -41695,8 +46058,8 @@ client.ticketing.contacts.meta_post_retrieve()
client.ticketing.scopes.default_scopes_retrieve()
+## Ticketing Accounts
+client.ticketing.accounts.list(...)
-
@@ -41708,7 +46071,7 @@ client.ticketing.contacts.meta_post_retrieve()
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a list of `Account` objects.
@@ -41723,13 +46086,34 @@ 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.ticketing.scopes.default_scopes_retrieve()
+client.ticketing.accounts.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ modified_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ modified_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ page_size=1,
+ remote_id="remote_id",
+)
```
@@ -41745,64 +46129,83 @@ client.ticketing.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.ticketing.scopes.linked_account_scopes_retrieve()
-
-#### π Description
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
+
+
+
-
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### π 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.ticketing.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. The maximum limit is 100.
+
-#### βοΈ Parameters
-
-
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
+
+
+
+
-
@@ -41818,7 +46221,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
client.ticketing.scopes.linked_account_scopes_create(...)
+client.ticketing.accounts.retrieve(...)
-
@@ -41830,7 +46233,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+Returns an `Account` object with the given `id`.
@@ -41846,42 +46249,15 @@ Update permissions for any Common Model or field for a single Linked Account. An
```python
from merge import Merge
-from merge.resources.ticketing import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.scopes.linked_account_scopes_create(
- common_models=[
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Employee",
- model_permissions={
- "READ": ModelPermissionDeserializerRequest(
- is_enabled=True,
- ),
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- ),
- },
- field_permissions=FieldPermissionDeserializerRequest(
- enabled_fields=["avatar", "home_location"],
- disabled_fields=["work_location"],
- ),
- ),
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Benefit",
- model_permissions={
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- )
- },
- ),
- ],
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.accounts.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -41898,7 +46274,23 @@ client.ticketing.scopes.linked_account_scopes_create(
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` β The common models you want to update the scopes for
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -41918,8 +46310,8 @@ client.ticketing.scopes.linked_account_scopes_create(
client.ticketing.delete_account.delete()
+## Ticketing AsyncPassthrough
+client.ticketing.async_passthrough.create(...)
-
@@ -41931,7 +46323,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -41947,12 +46339,18 @@ Delete a linked account.
```python
from merge import Merge
+from merge.resources.ticketing import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.delete_account.delete()
+client.ticketing.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
```
@@ -41968,6 +46366,14 @@ client.ticketing.delete_account.delete()
-
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -41980,8 +46386,7 @@ client.ticketing.delete_account.delete()
client.ticketing.field_mapping.field_mappings_retrieve(...)
+client.ticketing.async_passthrough.retrieve(...)
-
@@ -41993,7 +46398,7 @@ client.ticketing.delete_account.delete()
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Retrieves data from earlier async-passthrough POST request
@@ -42014,8 +46419,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
+client.ticketing.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
)
```
@@ -42032,7 +46437,7 @@ client.ticketing.field_mapping.field_mappings_retrieve(
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` β If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+**async_passthrough_receipt_id:** `str`
@@ -42052,7 +46457,8 @@ client.ticketing.field_mapping.field_mappings_retrieve(
client.ticketing.field_mapping.field_mappings_create(...)
+## Ticketing Attachments
+client.ticketing.attachments.list(...)
-
@@ -42064,7 +46470,7 @@ client.ticketing.field_mapping.field_mappings_retrieve(
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `Attachment` objects.
@@ -42079,20 +46485,37 @@ 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.ticketing.field_mapping.field_mappings_create(
- exclude_remote_field_metadata=True,
- target_field_name="example_target_field_name",
- target_field_description="this is a example description of the target field",
- remote_field_traversal_path=["example_remote_field"],
- remote_method="GET",
- remote_url_path="/example-url-path",
- common_model_name="ExampleCommonModel",
+client.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",
)
```
@@ -42109,7 +46532,7 @@ client.ticketing.field_mapping.field_mappings_create(
-
-**target_field_name:** `str` β The name of the target field you want this remote field to map to.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -42117,7 +46540,7 @@ client.ticketing.field_mapping.field_mappings_create(
-
-**target_field_description:** `str` β The description of the target field you want this remote field to map to.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -42125,7 +46548,7 @@ client.ticketing.field_mapping.field_mappings_create(
-
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` β The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -42133,7 +46556,11 @@ client.ticketing.field_mapping.field_mappings_create(
-
-**remote_method:** `str` β The method of the remote endpoint where the remote field is coming from.
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["ticket"], typing.Sequence[typing.Literal["ticket"]]
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -42141,7 +46568,7 @@ client.ticketing.field_mapping.field_mappings_create(
-
-**remote_url_path:** `str` β The path of the remote endpoint where the remote field is coming from.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -42149,7 +46576,7 @@ client.ticketing.field_mapping.field_mappings_create(
-
-**common_model_name:** `str` β The name of the Common Model that the remote field corresponds to in a given category.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -42157,7 +46584,7 @@ client.ticketing.field_mapping.field_mappings_create(
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` β If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -42165,7 +46592,47 @@ client.ticketing.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.
+
+
+
+
+
+-
+
+**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_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.
@@ -42185,7 +46652,7 @@ client.ticketing.field_mapping.field_mappings_create(
client.ticketing.field_mapping.field_mappings_destroy(...)
+client.ticketing.attachments.create(...)
-
@@ -42197,7 +46664,7 @@ client.ticketing.field_mapping.field_mappings_create(
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Creates an `Attachment` object with the given values.
@@ -42213,13 +46680,16 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
```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.field_mapping.field_mappings_destroy(
- field_mapping_id="field_mapping_id",
+client.ticketing.attachments.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=AttachmentRequest(),
)
```
@@ -42236,7 +46706,23 @@ client.ticketing.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**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.
@@ -42256,7 +46742,7 @@ client.ticketing.field_mapping.field_mappings_destroy(
client.ticketing.field_mapping.field_mappings_partial_update(...)
+client.ticketing.attachments.retrieve(...)
-
@@ -42268,7 +46754,7 @@ client.ticketing.field_mapping.field_mappings_destroy(
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns an `Attachment` object with the given `id`.
@@ -42289,8 +46775,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.field_mapping.field_mappings_partial_update(
- field_mapping_id="field_mapping_id",
+client.ticketing.attachments.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -42307,15 +46795,7 @@ client.ticketing.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.
+**id:** `str`
@@ -42323,7 +46803,11 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-
-**remote_method:** `typing.Optional[str]` β The method of the remote endpoint where the remote field is coming from.
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["ticket"], typing.Sequence[typing.Literal["ticket"]]
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -42331,7 +46815,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-
-**remote_url_path:** `typing.Optional[str]` β The path of the remote endpoint where the remote field is coming from.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -42339,7 +46823,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-
-**jmes_path:** `typing.Optional[str]` β JMES path to specify json query expression to be used on field mapping.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -42359,7 +46843,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
client.ticketing.field_mapping.remote_fields_retrieve(...)
+client.ticketing.attachments.meta_post_retrieve()
-
@@ -42371,7 +46855,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns metadata for `TicketingAttachment` POSTs.
@@ -42392,10 +46876,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
-)
+client.ticketing.attachments.meta_post_retrieve()
```
@@ -42411,22 +46892,6 @@ client.ticketing.field_mapping.remote_fields_retrieve(
-
-**common_models:** `typing.Optional[str]` β A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
-
-
-
-
-
--
-
-**include_example_values:** `typing.Optional[str]` β If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -42439,7 +46904,8 @@ client.ticketing.field_mapping.remote_fields_retrieve(
client.ticketing.field_mapping.target_fields_retrieve()
+## Ticketing AuditTrail
+client.ticketing.audit_trail.list(...)
-
@@ -42451,7 +46917,7 @@ client.ticketing.field_mapping.remote_fields_retrieve(
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Gets a list of audit trail events.
@@ -42472,7 +46938,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.field_mapping.target_fields_retrieve()
+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",
+)
```
@@ -42488,6 +46961,54 @@ client.ticketing.field_mapping.target_fields_retrieve()
-
+**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.
@@ -42500,8 +47021,8 @@ client.ticketing.field_mapping.target_fields_retrieve()
client.ticketing.generate_key.create(...)
+## Ticketing AvailableActions
+client.ticketing.available_actions.retrieve()
-
@@ -42513,7 +47034,7 @@ client.ticketing.field_mapping.target_fields_retrieve()
-
-Create a remote key.
+Returns a list of models and actions available for an account.
@@ -42534,9 +47055,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.generate_key.create(
- name="Remote Deployment Key 1",
-)
+client.ticketing.available_actions.retrieve()
```
@@ -42552,14 +47071,6 @@ client.ticketing.generate_key.create(
-
-**name:** `str` β The name of the remote key
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -42572,8 +47083,8 @@ client.ticketing.generate_key.create(
client.ticketing.issues.list(...)
+## Ticketing Collections
+client.ticketing.collections.list(...)
-
@@ -42585,7 +47096,7 @@ client.ticketing.generate_key.create(
-
-Gets all issues for Organization.
+Returns a list of `Collection` objects.
@@ -42603,35 +47114,36 @@ Gets all issues for Organization.
import datetime
from merge import Merge
-from merge.resources.ticketing.resources.issues import IssuesListRequestStatus
+from merge.resources.ticketing.resources.collections import (
+ CollectionsListRequestCollectionType,
+)
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(
+client.ticketing.collections.list(
+ collection_type=CollectionsListRequestCollectionType.EMPTY,
+ 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",
+ name="name",
page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
+ parent_collection_id="parent_collection_id",
+ remote_id="remote_id",
)
```
@@ -42648,7 +47160,7 @@ client.ticketing.issues.list(
-
-**account_token:** `typing.Optional[str]`
+**collection_type:** `typing.Optional[CollectionsListRequestCollectionType]` β If provided, will only return collections of the given type.
@@ -42656,7 +47168,7 @@ client.ticketing.issues.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.
@@ -42664,7 +47176,7 @@ client.ticketing.issues.list(
-
-**end_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred before this time
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -42672,7 +47184,7 @@ client.ticketing.issues.list(
-
-**end_user_organization_name:** `typing.Optional[str]`
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -42680,7 +47192,12 @@ client.ticketing.issues.list(
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose first incident time was after this datetime.
+**expand:** `typing.Optional[
+ typing.Union[
+ CollectionsListRequestExpandItem,
+ typing.Sequence[CollectionsListRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -42688,7 +47205,7 @@ client.ticketing.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/).
@@ -42696,7 +47213,7 @@ client.ticketing.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.
@@ -42704,7 +47221,7 @@ client.ticketing.issues.list(
-
-**integration_name:** `typing.Optional[str]`
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -42712,7 +47229,7 @@ client.ticketing.issues.list(
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was after this datetime.
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -42720,7 +47237,7 @@ client.ticketing.issues.list(
-
-**last_incident_time_before:** `typing.Optional[dt.datetime]` β If provided, will only return issues whose last incident time was before this datetime.
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -42728,7 +47245,7 @@ client.ticketing.issues.list(
-
-**linked_account_id:** `typing.Optional[str]` β If provided, will only include issues pertaining to the linked account passed in.
+**name:** `typing.Optional[str]` β If provided, will only return collections with this name.
@@ -42744,7 +47261,152 @@ client.ticketing.issues.list(
-
-**start_date:** `typing.Optional[str]` β If included, will only include issues whose most recent action occurred after this time
+**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
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.collections.viewers_list(
+ collection_id="collection_id",
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ 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[
+ typing.Union[
+ CollectionsViewersListRequestExpandItem,
+ typing.Sequence[CollectionsViewersListRequestExpandItem],
+ ]
+]` β 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).
@@ -42752,12 +47414,7 @@ client.ticketing.issues.list(
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
-
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -42777,7 +47434,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
client.ticketing.issues.retrieve(...)
+client.ticketing.collections.retrieve(...)
-
@@ -42789,7 +47446,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Returns a `Collection` object with the given `id`.
@@ -42810,8 +47467,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.issues.retrieve(
+client.ticketing.collections.retrieve(
id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -42836,6 +47495,51 @@ client.ticketing.issues.retrieve(
-
+**expand:** `typing.Optional[
+ typing.Union[
+ CollectionsRetrieveRequestExpandItem,
+ typing.Sequence[CollectionsRetrieveRequestExpandItem],
+ ]
+]` β 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.
@@ -42848,8 +47552,8 @@ client.ticketing.issues.retrieve(
client.ticketing.link_token.create(...)
+## Ticketing Comments
+client.ticketing.comments.list(...)
-
@@ -42861,7 +47565,7 @@ client.ticketing.issues.retrieve(
-
-Creates a link token to be used when linking a new end user.
+Returns a list of `Comment` objects.
@@ -42876,18 +47580,37 @@ Creates a link token to be used when linking a new end user.
-
```python
+import datetime
+
from merge import Merge
-from merge.resources.ticketing import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.link_token.create(
- end_user_email_address="example@gmail.com",
- end_user_organization_name="Test Organization",
- end_user_origin_id="12345",
- categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+client.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",
+ 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",
)
```
@@ -42904,15 +47627,7 @@ client.ticketing.link_token.create(
-
-**end_user_email_address:** `str` β Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
-
-
-
-
-
--
-
-**end_user_organization_name:** `str` β Your end user's organization.
+**created_after:** `typing.Optional[dt.datetime]` β If provided, will only return objects created after this datetime.
@@ -42920,7 +47635,7 @@ client.ticketing.link_token.create(
-
-**end_user_origin_id:** `str` β This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+**created_before:** `typing.Optional[dt.datetime]` β If provided, will only return objects created before this datetime.
@@ -42928,7 +47643,7 @@ client.ticketing.link_token.create(
-
-**categories:** `typing.Sequence[CategoriesEnum]` β The integration categories to show in Merge Link.
+**cursor:** `typing.Optional[str]` β The pagination cursor value.
@@ -42936,7 +47651,12 @@ client.ticketing.link_token.create(
-
-**integration:** `typing.Optional[str]` β The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+**expand:** `typing.Optional[
+ typing.Union[
+ CommentsListRequestExpandItem,
+ typing.Sequence[CommentsListRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -42944,7 +47664,7 @@ client.ticketing.link_token.create(
-
-**link_expiry_mins:** `typing.Optional[int]` β An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+**include_deleted_data:** `typing.Optional[bool]` β Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -42952,7 +47672,7 @@ client.ticketing.link_token.create(
-
-**should_create_magic_link_url:** `typing.Optional[bool]` β Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -42960,7 +47680,7 @@ client.ticketing.link_token.create(
-
-**hide_admin_magic_link:** `typing.Optional[bool]` β Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+**include_shell_data:** `typing.Optional[bool]` β Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -42968,7 +47688,7 @@ client.ticketing.link_token.create(
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` β An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+**modified_after:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge after this date time will be returned.
@@ -42976,14 +47696,7 @@ client.ticketing.link_token.create(
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
- ]
-]` β When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+**modified_before:** `typing.Optional[dt.datetime]` β If provided, only objects synced by Merge before this date time will be returned.
@@ -42991,12 +47704,7 @@ client.ticketing.link_token.create(
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
-
-The following subset of IETF language tags can be used to configure localization.
-
-* `en` - en
-* `de` - de
+**page_size:** `typing.Optional[int]` β Number of results to return per page. The maximum limit is 100.
@@ -43004,7 +47712,7 @@ The following subset of IETF language tags can be used to configure localization
-
-**are_syncs_disabled:** `typing.Optional[bool]` β The boolean that indicates whether initial, periodic, and force syncs will be disabled.
+**remote_created_after:** `typing.Optional[dt.datetime]` β If provided, will only return Comments created in the third party platform after this datetime.
@@ -43012,7 +47720,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.
+**remote_id:** `typing.Optional[str]` β The API provider's ID for the given object.
@@ -43020,11 +47728,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
+**ticket_id:** `typing.Optional[str]` β If provided, will only return comments for this ticket.
@@ -43044,8 +47748,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
client.ticketing.linked_accounts.list(...)
+client.ticketing.comments.create(...)
-
@@ -43057,7 +47760,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-
-List linked accounts for your organization.
+Creates a `Comment` object with the given values.
@@ -43073,28 +47776,16 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.ticketing.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
+from merge.resources.ticketing import CommentRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_user_email_address="end_user_email_address",
- end_user_organization_name="end_user_organization_name",
- end_user_origin_id="end_user_origin_id",
- end_user_origin_ids="end_user_origin_ids",
- id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
+client.ticketing.comments.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=CommentRequest(),
)
```
@@ -43111,17 +47802,7 @@ client.ticketing.linked_accounts.list(
-
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-* `hris` - hris
-* `ats` - ats
-* `accounting` - accounting
-* `ticketing` - ticketing
-* `crm` - crm
-* `mktg` - mktg
-* `filestorage` - filestorage
+**model:** `CommentRequest`
@@ -43129,7 +47810,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**cursor:** `typing.Optional[str]` β The pagination cursor value.
+**is_debug_mode:** `typing.Optional[bool]` β Whether to include debug fields (such as log file links) in the response.
@@ -43137,7 +47818,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**end_user_email_address:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given email address.
+**run_async:** `typing.Optional[bool]` β Whether or not third-party updates should be run asynchronously.
@@ -43145,55 +47826,72 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**end_user_organization_name:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given organization name.
+**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
+
+
-
--
-**end_user_origin_id:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given origin ID.
-
+client.ticketing.comments.retrieve(...)
-
-**end_user_origin_ids:** `typing.Optional[str]` β Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
-
-
-
+#### π Description
-
-**id:** `typing.Optional[str]`
-
-
-
-
-
-**ids:** `typing.Optional[str]` β Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
-
+Returns a `Comment` object with the given `id`.
+
+
+
+#### π Usage
-
-**include_duplicates:** `typing.Optional[bool]` β If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.comments.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+#### βοΈ Parameters
+
-
-**integration_name:** `typing.Optional[str]` β If provided, will only return linked accounts associated with the given integration name.
+
+-
+
+**id:** `str`
@@ -43201,7 +47899,12 @@ 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[
+ CommentsRetrieveRequestExpandItem,
+ typing.Sequence[CommentsRetrieveRequestExpandItem],
+ ]
+]` β Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -43209,7 +47912,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.
+**include_remote_data:** `typing.Optional[bool]` β Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -43217,7 +47920,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).
@@ -43237,8 +47940,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
client.ticketing.passthrough.create(...)
+client.ticketing.comments.meta_post_retrieve()
-
@@ -43250,7 +47952,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-Pull data from an endpoint not currently supported by Merge.
+Returns metadata for `Comment` POSTs.
@@ -43266,18 +47968,12 @@ Pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.ticketing import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
-)
+client.ticketing.comments.meta_post_retrieve()
```
@@ -43293,14 +47989,6 @@ client.ticketing.passthrough.create(
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` β Request-specific configuration.
@@ -43313,8 +48001,8 @@ client.ticketing.passthrough.create(
client.ticketing.projects.list(...)
+## Ticketing Contacts
+client.ticketing.contacts.list(...)
-
@@ -43326,7 +48014,7 @@ client.ticketing.passthrough.create(
-
-Returns a list of `Project` objects.
+Returns a list of `Contact` objects.
@@ -43349,7 +48037,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.projects.list(
+client.ticketing.contacts.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -43357,6 +48045,7 @@ client.ticketing.projects.list(
"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,
@@ -43408,6 +48097,26 @@ client.ticketing.projects.list(
-
+**email_address:** `typing.Optional[str]` β If provided, will only return Contacts that match this email.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["account"], typing.Sequence[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/).
@@ -43476,7 +48185,7 @@ client.ticketing.projects.list(
client.ticketing.projects.retrieve(...)
+client.ticketing.contacts.create(...)
-
@@ -43488,7 +48197,7 @@ client.ticketing.projects.list(