From eb397a8053e159c71d77d7dbd308fd3807508f49 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Wed, 8 Apr 2026 23:31:44 +0000 Subject: [PATCH] SDK regeneration --- README.md | 1 + pyproject.toml | 2 +- reference.md | 6980 ++++++++--------- src/merge/client.py | 36 +- src/merge/core/client_wrapper.py | 4 +- src/merge/resources/chat/__init__.py | 15 + src/merge/resources/chat/types/__init__.py | 15 + .../resources/chat/types/conversation.py | 16 +- .../chat/types/conversation_members_item.py | 7 + src/merge/resources/chat/types/group.py | 12 +- .../resources/chat/types/group_users_item.py | 9 + src/merge/resources/chat/types/member.py | 16 +- .../resources/chat/types/member_group.py | 7 + src/merge/resources/chat/types/member_user.py | 7 + .../chat/types/paginated_conversation_list.py | 10 +- .../chat/types/paginated_group_list.py | 13 +- .../chat/types/paginated_member_list.py | 10 +- .../chat/types/paginated_user_list.py | 13 +- src/merge/resources/chat/types/type_enum.py | 15 + src/merge/resources/chat/types/user.py | 12 +- .../resources/chat/types/user_groups_item.py | 9 + .../resources/filestorage/types/drive.py | 5 - 22 files changed, 3681 insertions(+), 3533 deletions(-) create mode 100644 src/merge/resources/chat/types/conversation_members_item.py create mode 100644 src/merge/resources/chat/types/group_users_item.py create mode 100644 src/merge/resources/chat/types/member_group.py create mode 100644 src/merge/resources/chat/types/member_user.py create mode 100644 src/merge/resources/chat/types/user_groups_item.py diff --git a/README.md b/README.md index 73bd2a65..982a1757 100644 --- a/README.md +++ b/README.md @@ -263,3 +263,4 @@ while response.next is not None: + diff --git a/pyproject.toml b/pyproject.toml index 62139c69..ad028ac0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "MergePythonClient" [tool.poetry] name = "MergePythonClient" -version = "2.6.2" +version = "2.6.3" description = "" readme = "README.md" authors = [] diff --git a/reference.md b/reference.md index 72c3f6b5..3bf686bb 100644 --- a/reference.md +++ b/reference.md @@ -12220,8 +12220,8 @@ client.chat.webhook_receivers.create( -## Crm AccountDetails -
client.crm.account_details.retrieve() +## Filestorage AccountDetails +
client.filestorage.account_details.retrieve()
@@ -12254,7 +12254,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_details.retrieve() +client.filestorage.account_details.retrieve() ```
@@ -12282,8 +12282,8 @@ client.crm.account_details.retrieve()
-## Crm AccountToken -
client.crm.account_token.retrieve(...) +## Filestorage AccountToken +
client.filestorage.account_token.retrieve(...)
@@ -12316,7 +12316,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_token.retrieve( +client.filestorage.account_token.retrieve( public_token="public_token", ) @@ -12354,8 +12354,8 @@ client.crm.account_token.retrieve(
-## Crm Accounts -
client.crm.accounts.list(...) +## Filestorage AsyncPassthrough +
client.filestorage.async_passthrough.create(...)
@@ -12367,7 +12367,7 @@ client.crm.account_token.retrieve(
-Returns a list of `Account` objects. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -12382,36 +12382,18 @@ Returns a list of `Account` objects.
```python -import datetime - from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", +client.filestorage.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", ), - name="name", - owner_id="owner_id", - page_size=1, - remote_id="remote_id", ) ``` @@ -12428,7 +12410,7 @@ client.crm.accounts.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request:** `DataPassthroughRequest`
@@ -12436,103 +12418,70 @@ client.crm.accounts.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. -
-
-
-**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.filestorage.async_passthrough.retrieve(...)
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
+#### 📝 Description
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - +Retrieves data from earlier async-passthrough POST request
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). -
+#### 🔌 Usage +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
-
-**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.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) -**name:** `typing.Optional[str]` — If provided, will only return accounts with this name. - +```
- -
-
- -**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner. -
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**async_passthrough_receipt_id:** `str`
@@ -12552,7 +12501,8 @@ client.crm.accounts.list(
-
client.crm.accounts.create(...) +## Filestorage AuditTrail +
client.filestorage.audit_trail.list(...)
@@ -12564,7 +12514,7 @@ client.crm.accounts.list(
-Creates an `Account` object with the given values. +Gets a list of audit trail events.
@@ -12580,16 +12530,18 @@ Creates an `Account` object with the given values. ```python from merge import Merge -from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.create( - is_debug_mode=True, - run_async=True, - model=AccountRequest(), +client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_date="end_date", + event_type="event_type", + page_size=1, + start_date="start_date", + user_email="user_email", ) ``` @@ -12606,7 +12558,7 @@ client.crm.accounts.create(
-**model:** `AccountRequest` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -12614,7 +12566,7 @@ client.crm.accounts.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -12622,7 +12574,31 @@ client.crm.accounts.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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.
@@ -12642,7 +12618,8 @@ client.crm.accounts.create(
-
client.crm.accounts.retrieve(...) +## Filestorage AvailableActions +
client.filestorage.available_actions.retrieve()
@@ -12654,7 +12631,7 @@ client.crm.accounts.create(
-Returns an `Account` object with the given `id`. +Returns a list of models and actions available for an account.
@@ -12675,12 +12652,7 @@ 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.filestorage.available_actions.retrieve() ``` @@ -12696,43 +12668,65 @@ client.crm.accounts.retrieve(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+## Filestorage Scopes +
client.filestorage.scopes.default_scopes_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - +
+
+ +Get 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 +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.scopes.default_scopes_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -12748,7 +12742,7 @@ client.crm.accounts.retrieve(
-
client.crm.accounts.partial_update(...) +
client.filestorage.scopes.linked_account_scopes_retrieve()
@@ -12760,7 +12754,7 @@ client.crm.accounts.retrieve(
-Updates an `Account` object with the given `id`. +Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -12776,18 +12770,12 @@ Updates an `Account` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedAccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.partial_update( - id="id", - is_debug_mode=True, - run_async=True, - model=PatchedAccountRequest(), -) +client.filestorage.scopes.linked_account_scopes_retrieve() ``` @@ -12803,55 +12791,23 @@ client.crm.accounts.partial_update(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**model:** `PatchedAccountRequest` -
+
+
client.filestorage.scopes.linked_account_scopes_create(...)
-**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.accounts.meta_patch_retrieve(...) -
-
- -#### 📝 Description +#### 📝 Description
@@ -12859,7 +12815,7 @@ client.crm.accounts.partial_update(
-Returns metadata for `CRMAccount` PATCHs. +Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -12875,13 +12831,42 @@ Returns metadata for `CRMAccount` PATCHs. ```python from merge import Merge +from merge.resources.filestorage import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_patch_retrieve( - id="id", +client.filestorage.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], ) ``` @@ -12898,7 +12883,7 @@ client.crm.accounts.meta_patch_retrieve(
-**id:** `str` +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -12918,7 +12903,8 @@ client.crm.accounts.meta_patch_retrieve(
-
client.crm.accounts.meta_post_retrieve() +## Filestorage DeleteAccount +
client.filestorage.delete_account.delete()
@@ -12930,7 +12916,7 @@ client.crm.accounts.meta_patch_retrieve(
-Returns metadata for `CRMAccount` POSTs. +Delete a linked account.
@@ -12951,7 +12937,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_post_retrieve() +client.filestorage.delete_account.delete() ``` @@ -12979,7 +12965,8 @@ client.crm.accounts.meta_post_retrieve()
-
client.crm.accounts.remote_field_classes_list(...) +## Filestorage Drives +
client.filestorage.drives.list(...)
@@ -12991,7 +12978,7 @@ client.crm.accounts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Drive` objects.
@@ -13006,21 +12993,34 @@ 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( +client.filestorage.drives.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, include_remote_data=True, - include_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", + ), + name="name", page_size=1, + remote_id="remote_id", ) ``` @@ -13037,6 +13037,22 @@ client.crm.accounts.remote_field_classes_list(
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13061,7 +13077,7 @@ client.crm.accounts.remote_field_classes_list(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -13069,7 +13085,7 @@ client.crm.accounts.remote_field_classes_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -13077,7 +13093,7 @@ client.crm.accounts.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -13085,7 +13101,7 @@ client.crm.accounts.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match.
@@ -13101,6 +13117,14 @@ client.crm.accounts.remote_field_classes_list(
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13113,8 +13137,7 @@ client.crm.accounts.remote_field_classes_list(
-## Crm AsyncPassthrough -
client.crm.async_passthrough.create(...) +
client.filestorage.drives.retrieve(...)
@@ -13126,7 +13149,7 @@ client.crm.accounts.remote_field_classes_list(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a `Drive` object with the given `id`.
@@ -13142,17 +13165,15 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.filestorage.drives.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -13169,7 +13190,23 @@ client.crm.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -13189,7 +13226,8 @@ client.crm.async_passthrough.create(
-
client.crm.async_passthrough.retrieve(...) +## Filestorage FieldMapping +
client.filestorage.field_mapping.field_mappings_retrieve(...)
@@ -13201,7 +13239,7 @@ client.crm.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -13222,8 +13260,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", +client.filestorage.field_mapping.field_mappings_retrieve( + exclude_remote_field_metadata=True, ) ``` @@ -13240,7 +13278,7 @@ client.crm.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -13260,8 +13298,7 @@ client.crm.async_passthrough.retrieve(
-## Crm AuditTrail -
client.crm.audit_trail.list(...) +
client.filestorage.field_mapping.field_mappings_create(...)
@@ -13273,7 +13310,7 @@ client.crm.async_passthrough.retrieve(
-Gets a list of audit trail events. +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -13294,13 +13331,14 @@ 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.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", ) ``` @@ -13317,7 +13355,7 @@ client.crm.audit_trail.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -13325,7 +13363,7 @@ client.crm.audit_trail.list(
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -13333,7 +13371,7 @@ client.crm.audit_trail.list(
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -13341,7 +13379,7 @@ client.crm.audit_trail.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -13349,7 +13387,7 @@ client.crm.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -13357,7 +13395,15 @@ client.crm.audit_trail.list(
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. + +
+
+ +
+
+ +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -13377,8 +13423,7 @@ client.crm.audit_trail.list(
-## Crm AvailableActions -
client.crm.available_actions.retrieve() +
client.filestorage.field_mapping.field_mappings_destroy(...)
@@ -13390,7 +13435,7 @@ client.crm.audit_trail.list(
-Returns a list of models and actions available for an account. +Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -13411,7 +13456,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.available_actions.retrieve() +client.filestorage.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -13427,6 +13474,14 @@ client.crm.available_actions.retrieve()
+**field_mapping_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13439,8 +13494,7 @@ client.crm.available_actions.retrieve()
-## Crm Contacts -
client.crm.contacts.list(...) +
client.filestorage.field_mapping.field_mappings_partial_update(...)
@@ -13452,7 +13506,7 @@ client.crm.available_actions.retrieve()
-Returns a list of `Contact` objects. +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -13467,39 +13521,14 @@ Returns a list of `Contact` objects.
```python -import datetime - from merge import Merge -from merge.resources.crm.resources.contacts import ContactsListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.list( - account_id="account_id", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - email_addresses="email_addresses", - expand=ContactsListRequestExpand.ACCOUNT, - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - phone_numbers="phone_numbers", - remote_id="remote_id", +client.filestorage.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -13516,7 +13545,7 @@ client.crm.contacts.list(
-**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account. +**field_mapping_id:** `str`
@@ -13524,7 +13553,7 @@ client.crm.contacts.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -13532,7 +13561,7 @@ client.crm.contacts.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -13540,7 +13569,7 @@ client.crm.contacts.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -13548,79 +13577,71 @@ client.crm.contacts.list(
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+
client.filestorage.field_mapping.remote_fields_retrieve(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+ + + +#### 🔌 Usage
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.field_mapping.remote_fields_retrieve( + common_models="common_models", + include_example_values="include_example_values", +) + +```
+ + + +#### ⚙️ Parameters
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -13628,7 +13649,7 @@ client.crm.contacts.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
@@ -13648,7 +13669,7 @@ client.crm.contacts.list(
-
client.crm.contacts.create(...) +
client.filestorage.field_mapping.target_fields_retrieve()
@@ -13660,7 +13681,7 @@ client.crm.contacts.list(
-Creates a `Contact` object with the given values. +Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
@@ -13676,17 +13697,12 @@ Creates a `Contact` object with the given values. ```python from merge import Merge -from merge.resources.crm import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.create( - is_debug_mode=True, - run_async=True, - model=ContactRequest(), -) +client.filestorage.field_mapping.target_fields_retrieve() ``` @@ -13702,30 +13718,6 @@ client.crm.contacts.create(
-**model:** `ContactRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13738,7 +13730,8 @@ client.crm.contacts.create(
-
client.crm.contacts.retrieve(...) +## Filestorage Files +
client.filestorage.files.list(...)
@@ -13750,7 +13743,7 @@ client.crm.contacts.create(
-Returns a `Contact` object with the given `id`. +Returns a list of `File` objects.
@@ -13765,19 +13758,49 @@ Returns a `Contact` object with the given `id`.
```python +import datetime + from merge import Merge -from merge.resources.crm.resources.contacts import ContactsRetrieveRequestExpand +from merge.resources.filestorage.resources.files import ( + FilesListRequestExpand, + FilesListRequestOrderBy, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.retrieve( - id="id", - expand=ContactsRetrieveRequestExpand.ACCOUNT, +client.filestorage.files.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + drive_id="drive_id", + expand=FilesListRequestExpand.DRIVE, + folder_id="folder_id", + include_deleted_data=True, include_remote_data=True, - include_remote_fields=True, include_shell_data=True, + mime_type="mime_type", + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + name="name", + order_by=FilesListRequestOrderBy.CREATED_AT_DESCENDING, + page_size=1, + remote_created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + remote_created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + remote_id="remote_id", ) ``` @@ -13794,7 +13817,7 @@ client.crm.contacts.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13802,7 +13825,7 @@ client.crm.contacts.retrieve(
-**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13810,7 +13833,7 @@ client.crm.contacts.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13818,7 +13841,7 @@ client.crm.contacts.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**drive_id:** `typing.Optional[str]` — Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive.
@@ -13826,7 +13849,7 @@ client.crm.contacts.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13834,74 +13857,79 @@ client.crm.contacts.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**folder_id:** `typing.Optional[str]` — Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory.
-
-
+
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-
-
client.crm.contacts.partial_update(...)
-#### 📝 Description +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-Updates a `Contact` object with the given `id`. -
-
+**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas. + -#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge -from merge.resources.crm import PatchedContactRequest - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.contacts.partial_update( - id="id", - is_debug_mode=True, - run_async=True, - model=PatchedContactRequest(), -) - -``` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match. +
-#### ⚙️ Parameters -
+**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. + +
+
+
-**id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -13909,7 +13937,7 @@ client.crm.contacts.partial_update(
-**model:** `PatchedContactRequest` +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform after this datetime.
@@ -13917,7 +13945,7 @@ client.crm.contacts.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform before this datetime.
@@ -13925,7 +13953,7 @@ client.crm.contacts.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -13945,7 +13973,7 @@ client.crm.contacts.partial_update(
-
client.crm.contacts.ignore_create(...) +
client.filestorage.files.create(...)
@@ -13957,7 +13985,7 @@ client.crm.contacts.partial_update(
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +Creates a `File` object with the given values.
@@ -13973,20 +14001,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 +from merge.resources.filestorage import FileRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.ignore_create( - model_id="model_id", - request=IgnoreCommonModelRequest( - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, - ), -) - -``` +client.filestorage.files.create( + is_debug_mode=True, + run_async=True, + model=FileRequest(), +) + +```
@@ -14000,7 +14027,7 @@ client.crm.contacts.ignore_create(
-**model_id:** `str` +**model:** `FileRequest`
@@ -14008,7 +14035,15 @@ client.crm.contacts.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -14028,7 +14063,7 @@ client.crm.contacts.ignore_create(
-
client.crm.contacts.meta_patch_retrieve(...) +
client.filestorage.files.retrieve(...)
@@ -14040,7 +14075,7 @@ client.crm.contacts.ignore_create(
-Returns metadata for `CRMContact` PATCHs. +Returns a `File` object with the given `id`.
@@ -14056,13 +14091,19 @@ Returns metadata for `CRMContact` PATCHs. ```python from merge import Merge +from merge.resources.filestorage.resources.files import ( + FilesRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_patch_retrieve( +client.filestorage.files.retrieve( id="id", + expand=FilesRetrieveRequestExpand.DRIVE, + include_remote_data=True, + include_shell_data=True, ) ``` @@ -14087,6 +14128,30 @@ client.crm.contacts.meta_patch_retrieve(
+**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -14099,7 +14164,7 @@ client.crm.contacts.meta_patch_retrieve(
-
client.crm.contacts.meta_post_retrieve() +
client.filestorage.files.download_request_meta_retrieve(...)
@@ -14111,7 +14176,7 @@ client.crm.contacts.meta_patch_retrieve(
-Returns metadata for `CRMContact` POSTs. +Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -14132,7 +14197,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_post_retrieve() +client.filestorage.files.download_request_meta_retrieve( + id="id", + mime_type="mime_type", +) ``` @@ -14148,6 +14216,22 @@ client.crm.contacts.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -14160,7 +14244,7 @@ client.crm.contacts.meta_post_retrieve()
-
client.crm.contacts.remote_field_classes_list(...) +
client.filestorage.files.download_request_meta_list(...)
@@ -14172,7 +14256,7 @@ client.crm.contacts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -14188,19 +14272,23 @@ Returns a list of `RemoteFieldClass` objects. ```python from merge import Merge +from merge.resources.filestorage.resources.files import ( + FilesDownloadRequestMetaListRequestOrderBy, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.remote_field_classes_list( +client.filestorage.files.download_request_meta_list( + created_after="created_after", + created_before="created_before", 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, + mime_types="mime_types", + modified_after="modified_after", + modified_before="modified_before", + order_by=FilesDownloadRequestMetaListRequestOrderBy.CREATED_AT_DESCENDING, page_size=1, ) @@ -14218,6 +14306,22 @@ client.crm.contacts.remote_field_classes_list(
+**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -14226,7 +14330,7 @@ client.crm.contacts.remote_field_classes_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — If provided, will only return objects with the given IDs. Comma-separated list of strings.
@@ -14234,7 +14338,7 @@ client.crm.contacts.remote_field_classes_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -14242,7 +14346,7 @@ client.crm.contacts.remote_field_classes_list(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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.
@@ -14250,7 +14354,7 @@ client.crm.contacts.remote_field_classes_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime.
@@ -14258,7 +14362,7 @@ client.crm.contacts.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime.
@@ -14266,7 +14370,7 @@ client.crm.contacts.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
@@ -14294,8 +14398,7 @@ client.crm.contacts.remote_field_classes_list(
-## Crm CustomObjectClasses -
client.crm.custom_object_classes.list(...) +
client.filestorage.files.meta_post_retrieve()
@@ -14307,7 +14410,69 @@ client.crm.contacts.remote_field_classes_list(
-Returns a list of `CustomObjectClass` objects. +Returns metadata for `FileStorageFile` POSTs. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.files.meta_post_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Filestorage Folders +
client.filestorage.folders.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Folder` objects.
@@ -14325,12 +14490,15 @@ Returns a list of `CustomObjectClass` objects. import datetime from merge import Merge +from merge.resources.filestorage.resources.folders import ( + FoldersListRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.list( +client.filestorage.folders.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -14338,6 +14506,8 @@ client.crm.custom_object_classes.list( "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, @@ -14347,7 +14517,9 @@ client.crm.custom_object_classes.list( 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", ) @@ -14389,7 +14561,15 @@ client.crm.custom_object_classes.list(
-**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive. + +
+
+ +
+
+ +**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14437,6 +14617,14 @@ client.crm.custom_object_classes.list(
+**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match. + +
+
+ +
+
+ **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -14445,6 +14633,14 @@ client.crm.custom_object_classes.list(
+**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -14465,7 +14661,7 @@ client.crm.custom_object_classes.list(
-
client.crm.custom_object_classes.retrieve(...) +
client.filestorage.folders.create(...)
@@ -14477,7 +14673,7 @@ client.crm.custom_object_classes.list(
-Returns a `CustomObjectClass` object with the given `id`. +Creates a `Folder` object with the given values.
@@ -14493,15 +14689,16 @@ Returns a `CustomObjectClass` object with the given `id`. ```python from merge import Merge +from merge.resources.filestorage import FolderRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, +client.filestorage.folders.create( + is_debug_mode=True, + run_async=True, + model=FolderRequest(), ) ``` @@ -14518,7 +14715,7 @@ client.crm.custom_object_classes.retrieve(
-**id:** `str` +**model:** `FolderRequest`
@@ -14526,7 +14723,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. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -14534,7 +14731,7 @@ client.crm.custom_object_classes.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -14542,18 +14739,10 @@ client.crm.custom_object_classes.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
+ +
@@ -14562,8 +14751,7 @@ client.crm.custom_object_classes.retrieve(
-## Crm AssociationTypes -
client.crm.association_types.custom_object_classes_association_types_list(...) +
client.filestorage.folders.retrieve(...)
@@ -14575,7 +14763,7 @@ client.crm.custom_object_classes.retrieve(
-Returns a list of `AssociationType` objects. +Returns a `Folder` object with the given `id`.
@@ -14590,34 +14778,20 @@ Returns a list of `AssociationType` objects.
```python -import datetime - 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.crm.association_types.custom_object_classes_association_types_list( - custom_object_class_id="custom_object_class_id", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, +client.filestorage.folders.retrieve( + id="id", + expand=FoldersRetrieveRequestExpand.DRIVE, 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", ) ``` @@ -14634,7 +14808,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**custom_object_class_id:** `str` +**id:** `str`
@@ -14642,7 +14816,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14650,7 +14824,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -14658,7 +14832,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -14666,67 +14840,64 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+
client.filestorage.folders.meta_post_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +Returns metadata for `FileStorageFolder` POSTs. +
+
+#### 🔌 Usage +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.folders.meta_post_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -14742,7 +14913,8 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
client.crm.association_types.custom_object_classes_association_types_create(...) +## Filestorage GenerateKey +
client.filestorage.generate_key.create(...)
@@ -14754,7 +14926,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-Creates an `AssociationType` object with the given values. +Create a remote key.
@@ -14770,33 +14942,13 @@ Creates an `AssociationType` object with the given values. ```python from merge import Merge -from merge.resources.crm import ( - AssociationTypeRequestRequest, - ObjectClassDescriptionRequest, - OriginTypeEnum, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_create( - custom_object_class_id="custom_object_class_id", - is_debug_mode=True, - run_async=True, - model=AssociationTypeRequestRequest( - source_object_class=ObjectClassDescriptionRequest( - id="id", - origin_type=OriginTypeEnum.CUSTOM_OBJECT, - ), - target_object_classes=[ - ObjectClassDescriptionRequest( - id="id", - origin_type=OriginTypeEnum.CUSTOM_OBJECT, - ) - ], - remote_key_name="remote_key_name", - ), +client.filestorage.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -14813,31 +14965,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**model:** `AssociationTypeRequestRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**name:** `str` — The name of the remote key
@@ -14857,7 +14985,8 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
client.crm.association_types.custom_object_classes_association_types_retrieve(...) +## Filestorage Groups +
client.filestorage.groups.list(...)
@@ -14869,7 +14998,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-Returns an `AssociationType` object with the given `id`. +Returns a list of `Group` objects.
@@ -14884,17 +15013,33 @@ Returns an `AssociationType` 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.crm.association_types.custom_object_classes_association_types_retrieve( - custom_object_class_id="custom_object_class_id", - id="id", +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", ) ``` @@ -14911,7 +15056,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**custom_object_class_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -14919,7 +15064,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**id:** `str` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -14927,7 +15072,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -14935,7 +15080,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. +**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14943,7 +15088,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -14951,70 +15096,47 @@ client.crm.association_types.custom_object_classes_association_types_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.
-
-
+
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-
-
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
-#### 📝 Description - -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-Returns metadata for `CRMAssociationType` POSTs. -
-
+**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.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( - custom_object_class_id="custom_object_class_id", -) - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters - -
-
-
-**custom_object_class_id:** `str` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -15034,8 +15156,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-## Crm CustomObjects -
client.crm.custom_objects.custom_object_classes_custom_objects_list(...) +
client.filestorage.groups.retrieve(...)
@@ -15047,7 +15168,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-Returns a list of `CustomObject` objects. +Returns a `Group` object with the given `id`.
@@ -15062,35 +15183,16 @@ 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, +client.filestorage.groups.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", ) ``` @@ -15107,31 +15209,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -15139,7 +15217,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15155,14 +15233,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15171,38 +15241,6 @@ 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. - -
-
- -
-
- -**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.
@@ -15215,7 +15253,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
client.crm.custom_objects.custom_object_classes_custom_objects_create(...) +## Filestorage Issues +
client.filestorage.issues.list(...)
@@ -15227,7 +15266,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-Creates a `CustomObject` object with the given values. +Gets all issues for Organization.
@@ -15242,20 +15281,38 @@ Creates a `CustomObject` object with the given values.
```python +import datetime + from merge import Merge -from merge.resources.crm import CustomObjectRequest +from merge.resources.filestorage.resources.issues import IssuesListRequestStatus 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.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( + "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, ) ``` @@ -15272,7 +15329,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**custom_object_class_id:** `str` +**account_token:** `typing.Optional[str]`
@@ -15280,7 +15337,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**model:** `CustomObjectRequest` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15288,7 +15345,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -15296,7 +15353,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**end_user_organization_name:** `typing.Optional[str]`
@@ -15304,74 +15361,47 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
-#### 📝 Description - -
-
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues + +
+
-Returns a `CustomObject` object with the given `id`. -
-
+**integration_name:** `typing.Optional[str]` +
-#### 🔌 Usage -
-
-
- -```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_retrieve( - custom_object_class_id="custom_object_class_id", - id="id", - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, -) - -``` -
-
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +
-#### ⚙️ Parameters - -
-
-
-**custom_object_class_id:** `str` +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -15379,7 +15409,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**id:** `str` +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -15387,7 +15417,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -15395,7 +15425,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. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -15403,7 +15433,12 @@ 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). +**status:** `typing.Optional[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -15423,7 +15458,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...) +
client.filestorage.issues.retrieve(...)
@@ -15435,7 +15470,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-Returns metadata for `CRMCustomObject` POSTs. +Get a specific issue.
@@ -15456,8 +15491,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.filestorage.issues.retrieve( + id="id", ) ``` @@ -15474,7 +15509,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-**custom_object_class_id:** `str` +**id:** `str`
@@ -15494,7 +15529,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...) +## Filestorage LinkToken +
client.filestorage.link_token.create(...)
@@ -15506,7 +15542,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-Returns a list of `RemoteFieldClass` objects. +Creates a link token to be used when linking a new end user.
@@ -15522,20 +15558,17 @@ Returns a list of `RemoteFieldClass` objects. ```python from merge import Merge +from merge.resources.filestorage import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_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.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], ) ``` @@ -15552,7 +15585,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
@@ -15560,7 +15593,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**end_user_organization_name:** `str` — Your end user's organization.
@@ -15568,7 +15601,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_user_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.
@@ -15576,7 +15609,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. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -15584,7 +15617,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). +**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/.
@@ -15592,7 +15625,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 +**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.
@@ -15600,7 +15633,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 +**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.
@@ -15608,7 +15641,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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.
@@ -15616,32 +15649,84 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
- -
- - - - -
-## Crm Associations -
client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
-#### 📝 Description - -
-
+**category_common_model_scopes:** `typing.Optional[ + typing.Dict[ + str, + typing.Optional[ + typing.Sequence[IndividualCommonModelScopeDeserializerRequest] + ], + ] +]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. + +
+
-Returns a list of `Association` objects. +**language:** `typing.Optional[LanguageEnum]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de + +
+
+ +
+
+ +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. + +
+
+ +
+
+ +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Filestorage LinkedAccounts +
client.filestorage.linked_accounts.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List linked accounts for your organization.
@@ -15656,36 +15741,29 @@ Returns a list of `Association` objects.
```python -import datetime - from merge import Merge +from merge.resources.filestorage.resources.linked_accounts import ( + LinkedAccountsListRequestCategory, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.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", - ), +client.filestorage.linked_accounts.list( + category=LinkedAccountsListRequestCategory.ACCOUNTING, cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), + end_user_email_address="end_user_email_address", + end_user_organization_name="end_user_organization_name", + end_user_origin_id="end_user_origin_id", + end_user_origin_ids="end_user_origin_ids", + id="id", + ids="ids", + include_duplicates=True, + integration_name="integration_name", + is_test_account="is_test_account", page_size=1, - remote_id="remote_id", + status="status", ) ``` @@ -15702,15 +15780,17 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**custom_object_class_id:** `str` - -
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]` -
-
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` -**object_id:** `str` +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage
@@ -15718,7 +15798,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15726,7 +15806,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -15734,7 +15814,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -15742,7 +15822,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -15750,7 +15830,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**expand:** `typing.Optional[typing.Literal["association_type"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -15758,7 +15838,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**id:** `typing.Optional[str]`
@@ -15766,7 +15846,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. +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -15774,7 +15854,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_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.
@@ -15782,7 +15862,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. +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -15790,7 +15870,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. +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -15806,7 +15886,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. +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -15826,7 +15906,8 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
client.crm.associations.custom_object_classes_custom_objects_associations_update(...) +## Filestorage Passthrough +
client.filestorage.passthrough.create(...)
@@ -15838,7 +15919,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`. +Pull data from an endpoint not currently supported by Merge.
@@ -15854,19 +15935,17 @@ Creates an Association between `source_object_id` and `target_object_id` of type ```python from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.associations.custom_object_classes_custom_objects_associations_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.filestorage.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -15883,7 +15962,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**source_class_id:** `str` +**request:** `DataPassthroughRequest`
@@ -15891,47 +15970,71 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**source_object_id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**target_class_id:** `str` -
+
+## Filestorage RegenerateKey +
client.filestorage.regenerate_key.create(...)
-**target_object_id:** `str` - -
-
+#### 📝 Description
-**association_type_id:** `str` - +
+
+ +Exchange remote keys. +
+
+#### 🔌 Usage +
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.regenerate_key.create( + name="Remote Deployment Key 1", +) + +``` +
+
+#### ⚙️ Parameters +
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +
+
+ +**name:** `str` — The name of the remote key
@@ -15951,8 +16054,8 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-## Crm Scopes -
client.crm.scopes.default_scopes_retrieve() +## Filestorage SyncStatus +
client.filestorage.sync_status.list(...)
@@ -15964,7 +16067,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 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).
@@ -15985,7 +16088,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.default_scopes_retrieve() +client.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + page_size=1, +) ``` @@ -16001,6 +16107,22 @@ client.crm.scopes.default_scopes_retrieve()
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -16013,7 +16135,8 @@ client.crm.scopes.default_scopes_retrieve()
-
client.crm.scopes.linked_account_scopes_retrieve() +## Filestorage ForceResync +
client.filestorage.force_resync.sync_status_resync_create()
@@ -16025,7 +16148,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). +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.
@@ -16046,7 +16169,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.linked_account_scopes_retrieve() +client.filestorage.force_resync.sync_status_resync_create() ``` @@ -16074,7 +16197,8 @@ client.crm.scopes.linked_account_scopes_retrieve()
-
client.crm.scopes.linked_account_scopes_create(...) +## Filestorage Users +
client.filestorage.users.list(...)
@@ -16086,7 +16210,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes) +Returns a list of `User` objects.
@@ -16101,43 +16225,34 @@ Update permissions for any Common Model or field for a single Linked Account. An
```python +import datetime + from merge import Merge -from merge.resources.crm import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +client.filestorage.users.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + is_me="is_me", + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -16154,7 +16269,7 @@ client.crm.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -16162,65 +16277,83 @@ client.crm.scopes.linked_account_scopes_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. +
-
-## Crm DeleteAccount -
client.crm.delete_account.delete()
-#### 📝 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. + +
+
+
-Delete a linked account. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + -#### 🔌 Usage -
+**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. + +
+
+
-```python -from merge import Merge +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.delete_account.delete() +
+
-``` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -16236,8 +16369,7 @@ client.crm.delete_account.delete()
-## Crm EngagementTypes -
client.crm.engagement_types.list(...) +
client.filestorage.users.retrieve(...)
@@ -16249,7 +16381,7 @@ client.crm.delete_account.delete()
-Returns a list of `EngagementType` objects. +Returns a `User` object with the given `id`.
@@ -16264,34 +16396,16 @@ Returns a list of `EngagementType` objects.
```python -import datetime - from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, +client.filestorage.users.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", ) ``` @@ -16308,7 +16422,7 @@ client.crm.engagement_types.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -16316,7 +16430,7 @@ client.crm.engagement_types.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -16324,7 +16438,7 @@ client.crm.engagement_types.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -16332,67 +16446,65 @@ client.crm.engagement_types.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+## Filestorage WebhookReceivers +
client.filestorage.webhook_receivers.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
+#### 📝 Description
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +Returns a list of `WebhookReceiver` objects.
+ + + +#### 🔌 Usage
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.webhook_receivers.list() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -16408,7 +16520,7 @@ client.crm.engagement_types.list(
-
client.crm.engagement_types.retrieve(...) +
client.filestorage.webhook_receivers.create(...)
@@ -16420,7 +16532,7 @@ client.crm.engagement_types.list(
-Returns an `EngagementType` object with the given `id`. +Creates a `WebhookReceiver` object with the given values.
@@ -16441,11 +16553,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.retrieve( - id="id", - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, +client.filestorage.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -16462,15 +16572,7 @@ client.crm.engagement_types.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**event:** `str`
@@ -16478,7 +16580,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. +**is_active:** `bool`
@@ -16486,7 +16588,7 @@ client.crm.engagement_types.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**key:** `typing.Optional[str]`
@@ -16506,7 +16608,8 @@ client.crm.engagement_types.retrieve(
-
client.crm.engagement_types.remote_field_classes_list(...) +## Crm AccountDetails +
client.crm.account_details.retrieve()
@@ -16518,7 +16621,7 @@ client.crm.engagement_types.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Get details for a linked account.
@@ -16539,16 +16642,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - is_common_model_field=True, - is_custom=True, - page_size=1, -) +client.crm.account_details.retrieve() ``` @@ -16564,63 +16658,71 @@ client.crm.engagement_types.remote_field_classes_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/). -
+
+## Crm AccountToken +
client.crm.account_token.retrieve(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Returns the account token for the end user with the provided public token.
+ + + +#### 🔌 Usage
-**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 - +```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. +
+
+ +**public_token:** `str`
@@ -16640,8 +16742,8 @@ client.crm.engagement_types.remote_field_classes_list(
-## Crm Engagements -
client.crm.engagements.list(...) +## Crm Accounts +
client.crm.accounts.list(...)
@@ -16653,7 +16755,7 @@ client.crm.engagement_types.remote_field_classes_list(
-Returns a list of `Engagement` objects. +Returns a list of `Account` objects.
@@ -16671,15 +16773,12 @@ Returns a list of `Engagement` objects. 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( +client.crm.accounts.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -16687,7 +16786,6 @@ client.crm.engagements.list( "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, @@ -16698,14 +16796,10 @@ client.crm.engagements.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + name="name", + owner_id="owner_id", page_size=1, remote_id="remote_id", - 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", - ), ) ``` @@ -16746,7 +16840,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. +**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -16802,7 +16896,7 @@ client.crm.engagements.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**name:** `typing.Optional[str]` — If provided, will only return accounts with this name.
@@ -16810,7 +16904,7 @@ client.crm.engagements.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner.
@@ -16818,7 +16912,7 @@ client.crm.engagements.list(
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -16826,7 +16920,7 @@ client.crm.engagements.list(
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -16846,7 +16940,7 @@ client.crm.engagements.list(
-
client.crm.engagements.create(...) +
client.crm.accounts.create(...)
@@ -16858,7 +16952,7 @@ client.crm.engagements.list(
-Creates an `Engagement` object with the given values. +Creates an `Account` object with the given values.
@@ -16874,16 +16968,16 @@ Creates an `Engagement` object with the given values. ```python from merge import Merge -from merge.resources.crm import EngagementRequest +from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.create( +client.crm.accounts.create( is_debug_mode=True, run_async=True, - model=EngagementRequest(), + model=AccountRequest(), ) ``` @@ -16900,7 +16994,7 @@ client.crm.engagements.create(
-**model:** `EngagementRequest` +**model:** `AccountRequest`
@@ -16936,7 +17030,7 @@ client.crm.engagements.create(
-
client.crm.engagements.retrieve(...) +
client.crm.accounts.retrieve(...)
@@ -16948,7 +17042,7 @@ client.crm.engagements.create(
-Returns an `Engagement` object with the given `id`. +Returns an `Account` object with the given `id`.
@@ -16964,17 +17058,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.crm.accounts.retrieve( id="id", - expand=EngagementsRetrieveRequestExpand.ACCOUNT, include_remote_data=True, include_remote_fields=True, include_shell_data=True, @@ -17002,7 +17092,7 @@ client.crm.engagements.retrieve(
-**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17046,7 +17136,7 @@ client.crm.engagements.retrieve(
-
client.crm.engagements.partial_update(...) +
client.crm.accounts.partial_update(...)
@@ -17058,7 +17148,7 @@ client.crm.engagements.retrieve(
-Updates an `Engagement` object with the given `id`. +Updates an `Account` object with the given `id`.
@@ -17074,17 +17164,17 @@ Updates an `Engagement` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedEngagementRequest +from merge.resources.crm import PatchedAccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.partial_update( +client.crm.accounts.partial_update( id="id", is_debug_mode=True, run_async=True, - model=PatchedEngagementRequest(), + model=PatchedAccountRequest(), ) ``` @@ -17109,7 +17199,7 @@ client.crm.engagements.partial_update(
-**model:** `PatchedEngagementRequest` +**model:** `PatchedAccountRequest`
@@ -17145,7 +17235,7 @@ client.crm.engagements.partial_update(
-
client.crm.engagements.meta_patch_retrieve(...) +
client.crm.accounts.meta_patch_retrieve(...)
@@ -17157,7 +17247,7 @@ client.crm.engagements.partial_update(
-Returns metadata for `Engagement` PATCHs. +Returns metadata for `CRMAccount` PATCHs.
@@ -17178,7 +17268,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.meta_patch_retrieve( +client.crm.accounts.meta_patch_retrieve( id="id", ) @@ -17216,7 +17306,7 @@ client.crm.engagements.meta_patch_retrieve(
-
client.crm.engagements.meta_post_retrieve() +
client.crm.accounts.meta_post_retrieve()
@@ -17228,7 +17318,7 @@ client.crm.engagements.meta_patch_retrieve(
-Returns metadata for `Engagement` POSTs. +Returns metadata for `CRMAccount` POSTs.
@@ -17249,7 +17339,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.meta_post_retrieve() +client.crm.accounts.meta_post_retrieve() ``` @@ -17277,7 +17367,7 @@ client.crm.engagements.meta_post_retrieve()
-
client.crm.engagements.remote_field_classes_list(...) +
client.crm.accounts.remote_field_classes_list(...)
@@ -17310,7 +17400,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.remote_field_classes_list( +client.crm.accounts.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, include_remote_data=True, @@ -17411,8 +17501,8 @@ client.crm.engagements.remote_field_classes_list(
-## Crm FieldMapping -
client.crm.field_mapping.field_mappings_retrieve(...) +## Crm AsyncPassthrough +
client.crm.async_passthrough.create(...)
@@ -17424,7 +17514,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/). +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -17440,13 +17530,17 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw ```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.field_mapping.field_mappings_retrieve( - exclude_remote_field_metadata=True, +client.crm.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -17463,7 +17557,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. +**request:** `DataPassthroughRequest`
@@ -17483,7 +17577,7 @@ client.crm.field_mapping.field_mappings_retrieve(
-
client.crm.field_mapping.field_mappings_create(...) +
client.crm.async_passthrough.retrieve(...)
@@ -17495,7 +17589,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. +Retrieves data from earlier async-passthrough POST request
@@ -17516,14 +17610,8 @@ 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.crm.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -17540,7 +17628,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. +**async_passthrough_receipt_id:** `str`
@@ -17548,15 +17636,76 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+ +## Crm AuditTrail +
client.crm.audit_trail.list(...) +
+
+ +#### 📝 Description
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +
+
+ +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.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", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -17564,7 +17713,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -17572,7 +17721,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. +**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`
@@ -17580,7 +17729,7 @@ client.crm.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -17588,7 +17737,15 @@ 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. +**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.
@@ -17608,7 +17765,8 @@ client.crm.field_mapping.field_mappings_create(
-
client.crm.field_mapping.field_mappings_destroy(...) +## Crm AvailableActions +
client.crm.available_actions.retrieve()
@@ -17620,7 +17778,7 @@ client.crm.field_mapping.field_mappings_create(
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a list of models and actions available for an account.
@@ -17641,9 +17799,7 @@ 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.crm.available_actions.retrieve() ``` @@ -17659,14 +17815,6 @@ client.crm.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17679,7 +17827,8 @@ client.crm.field_mapping.field_mappings_destroy(
-
client.crm.field_mapping.field_mappings_partial_update(...) +## Crm Contacts +
client.crm.contacts.list(...)
@@ -17691,7 +17840,7 @@ client.crm.field_mapping.field_mappings_destroy(
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a list of `Contact` objects.
@@ -17706,14 +17855,39 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```python +import datetime + from merge import Merge +from merge.resources.crm.resources.contacts import ContactsListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_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", + expand=ContactsListRequestExpand.ACCOUNT, + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + phone_numbers="phone_numbers", + remote_id="remote_id", ) ``` @@ -17730,7 +17904,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account.
@@ -17738,7 +17912,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -17746,7 +17920,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -17754,7 +17928,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -17762,71 +17936,79 @@ client.crm.field_mapping.field_mappings_partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
-
-
+
+
+**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-
client.crm.field_mapping.remote_fields_retrieve(...)
-#### 📝 Description +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + -#### 🔌 Usage -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.field_mapping.remote_fields_retrieve( - common_models="common_models", - include_example_values="include_example_values", -) - -``` +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -17834,7 +18016,7 @@ 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. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -17854,7 +18036,7 @@ client.crm.field_mapping.remote_fields_retrieve(
-
client.crm.field_mapping.target_fields_retrieve() +
client.crm.contacts.create(...)
@@ -17866,7 +18048,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 a `Contact` object with the given values.
@@ -17882,12 +18064,17 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun ```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.field_mapping.target_fields_retrieve() +client.crm.contacts.create( + is_debug_mode=True, + run_async=True, + model=ContactRequest(), +) ``` @@ -17903,6 +18090,30 @@ client.crm.field_mapping.target_fields_retrieve()
+**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.
@@ -17915,8 +18126,7 @@ client.crm.field_mapping.target_fields_retrieve()
-## Crm GenerateKey -
client.crm.generate_key.create(...) +
client.crm.contacts.retrieve(...)
@@ -17928,7 +18138,7 @@ client.crm.field_mapping.target_fields_retrieve()
-Create a remote key. +Returns a `Contact` object with the given `id`.
@@ -17944,13 +18154,18 @@ Create a remote key. ```python from merge import Merge +from merge.resources.crm.resources.contacts import ContactsRetrieveRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.generate_key.create( - name="Remote Deployment Key 1", +client.crm.contacts.retrieve( + id="id", + expand=ContactsRetrieveRequestExpand.ACCOUNT, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, ) ``` @@ -17967,7 +18182,39 @@ client.crm.generate_key.create(
-**name:** `str` — The name of the remote key +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — 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).
@@ -17987,8 +18234,7 @@ client.crm.generate_key.create(
-## Crm Issues -
client.crm.issues.list(...) +
client.crm.contacts.partial_update(...)
@@ -18000,7 +18246,7 @@ client.crm.generate_key.create(
-Gets all issues for Organization. +Updates a `Contact` object with the given `id`.
@@ -18015,38 +18261,18 @@ Gets all issues for Organization.
```python -import datetime - from merge import Merge -from merge.resources.crm.resources.issues import IssuesListRequestStatus +from merge.resources.crm import PatchedContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.list( - account_token="account_token", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - end_user_organization_name="end_user_organization_name", - first_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - first_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - include_muted="include_muted", - integration_name="integration_name", - last_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - last_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - linked_account_id="linked_account_id", - page_size=1, - start_date="start_date", - status=IssuesListRequestStatus.ONGOING, +client.crm.contacts.partial_update( + id="id", + is_debug_mode=True, + run_async=True, + model=PatchedContactRequest(), ) ``` @@ -18063,7 +18289,7 @@ client.crm.issues.list(
-**account_token:** `typing.Optional[str]` +**id:** `str`
@@ -18071,7 +18297,7 @@ client.crm.issues.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**model:** `PatchedContactRequest`
@@ -18079,7 +18305,7 @@ client.crm.issues.list(
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -18087,7 +18313,7 @@ client.crm.issues.list(
-**end_user_organization_name:** `typing.Optional[str]` +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -18095,71 +18321,74 @@ 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.
+
+
-
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. -
+
+
client.crm.contacts.ignore_create(...)
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues - -
-
+#### 📝 Description
-**integration_name:** `typing.Optional[str]` - -
-
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. - +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +
+
+#### 🔌 Usage +
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. - -
-
-
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. - +```python +from merge import Merge +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.contacts.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), +) + +```
+ + + +#### ⚙️ Parameters
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**model_id:** `str`
@@ -18167,12 +18396,7 @@ client.crm.issues.list(
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**request:** `IgnoreCommonModelRequest`
@@ -18192,7 +18416,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.crm.issues.retrieve(...) +
client.crm.contacts.meta_patch_retrieve(...)
@@ -18204,7 +18428,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns metadata for `CRMContact` PATCHs.
@@ -18225,7 +18449,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.retrieve( +client.crm.contacts.meta_patch_retrieve( id="id", ) @@ -18263,8 +18487,7 @@ client.crm.issues.retrieve(
-## Crm Leads -
client.crm.leads.list(...) +
client.crm.contacts.meta_post_retrieve()
@@ -18276,7 +18499,7 @@ client.crm.issues.retrieve(
-Returns a list of `Lead` objects. +Returns metadata for `CRMContact` POSTs.
@@ -18291,42 +18514,13 @@ Returns a list of `Lead` objects.
```python -import datetime - from merge import Merge -from merge.resources.crm.resources.leads import LeadsListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.list( - converted_account_id="converted_account_id", - converted_contact_id="converted_contact_id", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - email_addresses="email_addresses", - expand=LeadsListRequestExpand.CONVERTED_ACCOUNT, - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - owner_id="owner_id", - page_size=1, - phone_numbers="phone_numbers", - remote_id="remote_id", -) +client.crm.contacts.meta_post_retrieve() ```
@@ -18342,79 +18536,77 @@ client.crm.leads.list(
-**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**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. -
+
+
client.crm.contacts.remote_field_classes_list(...)
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
+#### 📝 Description
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
-
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. - +Returns a list of `RemoteFieldClass` objects. +
+
+#### 🔌 Usage +
-**expand:** `typing.Optional[LeadsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + is_common_model_field=True, + is_custom=True, + page_size=1, +) + +``` +
+
+#### ⚙️ Parameters +
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -18422,7 +18614,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). +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -18430,7 +18622,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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -18438,7 +18630,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. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -18446,7 +18638,7 @@ client.crm.leads.list(
-**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18454,7 +18646,7 @@ client.crm.leads.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -18462,7 +18654,7 @@ client.crm.leads.list(
-**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -18470,7 +18662,7 @@ client.crm.leads.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.
@@ -18490,7 +18682,8 @@ client.crm.leads.list(
-
client.crm.leads.create(...) +## Crm CustomObjectClasses +
client.crm.custom_object_classes.list(...)
@@ -18502,7 +18695,7 @@ client.crm.leads.list(
-Creates a `Lead` object with the given values. +Returns a list of `CustomObjectClass` objects.
@@ -18517,17 +18710,33 @@ Creates a `Lead` object with the given values.
```python +import datetime + from merge import Merge -from merge.resources.crm import LeadRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.create( - is_debug_mode=True, - run_async=True, - model=LeadRequest(), +client.crm.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", ) ``` @@ -18544,7 +18753,7 @@ client.crm.leads.create(
-**model:** `LeadRequest` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -18552,7 +18761,7 @@ client.crm.leads.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -18560,7 +18769,7 @@ client.crm.leads.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -18568,57 +18777,118 @@ client.crm.leads.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.leads.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). + +
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-Returns a `Lead` object with the given `id`. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### 🔌 Usage -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-```python -from merge import Merge -from merge.resources.crm.resources.leads import LeadsRetrieveRequestExpand +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+ + + + + + +
+ +
client.crm.custom_object_classes.retrieve(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a `CustomObjectClass` 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( +client.crm.custom_object_classes.retrieve( id="id", - expand=LeadsRetrieveRequestExpand.CONVERTED_ACCOUNT, include_remote_data=True, - include_remote_fields=True, include_shell_data=True, ) @@ -18644,7 +18914,7 @@ client.crm.leads.retrieve(
-**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -18660,14 +18930,6 @@ 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).
@@ -18688,7 +18950,8 @@ client.crm.leads.retrieve(
-
client.crm.leads.meta_post_retrieve() +## Crm AssociationTypes +
client.crm.association_types.custom_object_classes_association_types_list(...)
@@ -18700,7 +18963,7 @@ client.crm.leads.retrieve(
-Returns metadata for `Lead` POSTs. +Returns a list of `AssociationType` objects.
@@ -18715,13 +18978,35 @@ Returns metadata for `Lead` POSTs.
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.meta_post_retrieve() +client.crm.association_types.custom_object_classes_association_types_list( + custom_object_class_id="custom_object_class_id", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", +) ```
@@ -18737,77 +19022,39 @@ client.crm.leads.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**custom_object_class_id:** `str`
- -
- - - - -
-
client.crm.leads.remote_field_classes_list(...)
-#### 📝 Description - -
-
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
-Returns a list of `RemoteFieldClass` objects. -
-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.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, -) - -``` -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-#### ⚙️ Parameters - -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -18831,7 +19078,7 @@ client.crm.leads.remote_field_classes_list(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18839,7 +19086,7 @@ client.crm.leads.remote_field_classes_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -18847,7 +19094,7 @@ client.crm.leads.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -18855,7 +19102,7 @@ client.crm.leads.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -18863,7 +19110,7 @@ client.crm.leads.remote_field_classes_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -18883,8 +19130,7 @@ client.crm.leads.remote_field_classes_list(
-## Crm LinkToken -
client.crm.link_token.create(...) +
client.crm.association_types.custom_object_classes_association_types_create(...)
@@ -18896,7 +19142,7 @@ client.crm.leads.remote_field_classes_list(
-Creates a link token to be used when linking a new end user. +Creates an `AssociationType` object with the given values.
@@ -18912,17 +19158,33 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.crm import CategoriesEnum +from merge.resources.crm import ( + AssociationTypeRequestRequest, + ObjectClassDescriptionRequest, + OriginTypeEnum, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +client.crm.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", + ), ) ``` @@ -18939,7 +19201,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. +**custom_object_class_id:** `str`
@@ -18947,7 +19209,7 @@ client.crm.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**model:** `AssociationTypeRequestRequest`
@@ -18955,7 +19217,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. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -18963,7 +19225,7 @@ client.crm.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -18971,75 +19233,73 @@ 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/. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. -
+
+
client.crm.association_types.custom_object_classes_association_types_retrieve(...)
-**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. - -
-
+#### 📝 Description
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. - -
-
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. - +Returns an `AssociationType` object with the given `id`. +
+
+#### 🔌 Usage +
-**category_common_model_scopes:** `typing.Optional[ - typing.Dict[ - str, - typing.Optional[ - typing.Sequence[IndividualCommonModelScopeDeserializerRequest] - ], - ] -]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. - -
-
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +```python +from merge import Merge -The following subset of IETF language tags can be used to configure localization. +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.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, +) -* `en` - en -* `de` - de - +``` +
+
+#### ⚙️ Parameters +
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +
+
+ +**custom_object_class_id:** `str`
@@ -19047,7 +19307,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. +**id:** `str`
@@ -19055,192 +19315,94 @@ The following subset of IETF language tags can be used to configure localization
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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.
-
-
- - - - -
- -## Crm LinkedAccounts -
client.crm.linked_accounts.list(...) -
-
- -#### 📝 Description - -
-
-List linked accounts for your organization. -
-
+**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 -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", -) - -``` -
-
+**include_shell_data:** `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 -
-
-
- -**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 +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. -
-
-
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. -
+
+
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. - -
-
+#### 📝 Description
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. - -
-
-
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. - +Returns metadata for `CRMAssociationType` POSTs.
- -
-
- -**id:** `typing.Optional[str]` -
+#### 🔌 Usage +
-**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. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", +) -**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. -
+#### ⚙️ 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` +**custom_object_class_id:** `str`
@@ -19260,8 +19422,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Crm Notes -
client.crm.notes.list(...) +## Crm CustomObjects +
client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
@@ -19273,7 +19435,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Note` objects. +Returns a list of `CustomObject` objects.
@@ -19291,15 +19453,13 @@ Returns a list of `Note` objects. import datetime from merge import Merge -from merge.resources.crm.resources.notes import NotesListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.list( - account_id="account_id", - contact_id="contact_id", +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", ), @@ -19307,7 +19467,6 @@ client.crm.notes.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=NotesListRequestExpand.ACCOUNT, include_deleted_data=True, include_remote_data=True, include_remote_fields=True, @@ -19318,8 +19477,6 @@ client.crm.notes.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - opportunity_id="opportunity_id", - owner_id="owner_id", page_size=1, remote_id="remote_id", ) @@ -19338,15 +19495,7 @@ client.crm.notes.list(
-**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account. - -
-
- -
-
- -**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact. +**custom_object_class_id:** `str`
@@ -19378,14 +19527,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/).
@@ -19434,22 +19575,6 @@ client.crm.notes.list(
-**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.
@@ -19478,7 +19603,7 @@ client.crm.notes.list(
-
client.crm.notes.create(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
@@ -19490,7 +19615,7 @@ client.crm.notes.list(
-Creates a `Note` object with the given values. +Creates a `CustomObject` object with the given values.
@@ -19506,16 +19631,19 @@ Creates a `Note` object with the given values. ```python from merge import Merge -from merge.resources.crm import NoteRequest +from merge.resources.crm import CustomObjectRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.create( +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=NoteRequest(), + model=CustomObjectRequest( + fields={"test_field": "hello"}, + ), ) ``` @@ -19532,7 +19660,15 @@ client.crm.notes.create(
-**model:** `NoteRequest` +**custom_object_class_id:** `str` + +
+
+ +
+
+ +**model:** `CustomObjectRequest`
@@ -19568,7 +19704,7 @@ client.crm.notes.create(
-
client.crm.notes.retrieve(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
@@ -19580,7 +19716,7 @@ client.crm.notes.create(
-Returns a `Note` object with the given `id`. +Returns a `CustomObject` object with the given `id`.
@@ -19596,15 +19732,14 @@ Returns a `Note` object with the given `id`. ```python from merge import Merge -from merge.resources.crm.resources.notes import NotesRetrieveRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.retrieve( +client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( + custom_object_class_id="custom_object_class_id", id="id", - expand=NotesRetrieveRequestExpand.ACCOUNT, include_remote_data=True, include_remote_fields=True, include_shell_data=True, @@ -19624,7 +19759,7 @@ client.crm.notes.retrieve(
-**id:** `str` +**custom_object_class_id:** `str`
@@ -19632,7 +19767,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. +**id:** `str`
@@ -19676,7 +19811,7 @@ client.crm.notes.retrieve(
-
client.crm.notes.meta_post_retrieve() +
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
@@ -19688,7 +19823,7 @@ client.crm.notes.retrieve(
-Returns metadata for `Note` POSTs. +Returns metadata for `CRMCustomObject` POSTs.
@@ -19709,7 +19844,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.meta_post_retrieve() +client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", +) ``` @@ -19725,6 +19862,14 @@ client.crm.notes.meta_post_retrieve()
+**custom_object_class_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19737,7 +19882,7 @@ client.crm.notes.meta_post_retrieve()
-
client.crm.notes.remote_field_classes_list(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
@@ -19770,7 +19915,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.remote_field_classes_list( +client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, include_remote_data=True, @@ -19871,8 +20016,8 @@ client.crm.notes.remote_field_classes_list(
-## Crm Opportunities -
client.crm.opportunities.list(...) +## Crm Associations +
client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
@@ -19884,7 +20029,7 @@ client.crm.notes.remote_field_classes_list(
-Returns a list of `Opportunity` objects. +Returns a list of `Association` objects.
@@ -19902,17 +20047,15 @@ Returns a list of `Opportunity` objects. import datetime from merge import Merge -from merge.resources.crm.resources.opportunities import ( - OpportunitiesListRequestExpand, - OpportunitiesListRequestStatus, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.list( - account_id="account_id", +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", ), @@ -19920,10 +20063,8 @@ client.crm.opportunities.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=OpportunitiesListRequestExpand.ACCOUNT, include_deleted_data=True, include_remote_data=True, - include_remote_fields=True, include_shell_data=True, modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", @@ -19931,14 +20072,8 @@ client.crm.opportunities.list( 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, ) ``` @@ -19955,7 +20090,7 @@ client.crm.opportunities.list(
-**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account. +**custom_object_class_id:** `str`
@@ -19963,7 +20098,7 @@ client.crm.opportunities.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**object_id:** `str`
@@ -19971,7 +20106,7 @@ client.crm.opportunities.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type.
@@ -19979,7 +20114,7 @@ client.crm.opportunities.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.
@@ -19987,7 +20122,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -19995,7 +20130,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/). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -20003,7 +20138,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. +**expand:** `typing.Optional[typing.Literal["association_type"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20011,7 +20146,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. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -20019,7 +20154,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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -20027,7 +20162,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. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -20035,7 +20170,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -20043,7 +20178,7 @@ client.crm.opportunities.list(
-**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -20059,22 +20194,6 @@ 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. - -
-
- -
-
- -**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.
@@ -20083,36 +20202,6 @@ client.crm.opportunities.list(
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) - -
-
- -
-
- -**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.
@@ -20125,7 +20214,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-
client.crm.opportunities.create(...) +
client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
@@ -20137,7 +20226,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-Creates an `Opportunity` object with the given values. +Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -20153,16 +20242,19 @@ 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( +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, - model=OpportunityRequest(), ) ``` @@ -20179,7 +20271,39 @@ client.crm.opportunities.create(
-**model:** `OpportunityRequest` +**source_class_id:** `str` + +
+
+ +
+
+ +**source_object_id:** `str` + +
+
+ +
+
+ +**target_class_id:** `str` + +
+
+ +
+
+ +**target_object_id:** `str` + +
+
+ +
+
+ +**association_type_id:** `str`
@@ -20215,7 +20339,8 @@ client.crm.opportunities.create(
-
client.crm.opportunities.retrieve(...) +## Crm Scopes +
client.crm.scopes.default_scopes_retrieve()
@@ -20227,7 +20352,7 @@ client.crm.opportunities.create(
-Returns an `Opportunity` object with the given `id`. +Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -20243,21 +20368,12 @@ Returns an `Opportunity` object with the given `id`. ```python from merge import Merge -from merge.resources.crm.resources.opportunities import ( - OpportunitiesRetrieveRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.retrieve( - id="id", - expand=OpportunitiesRetrieveRequestExpand.ACCOUNT, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, -) +client.crm.scopes.default_scopes_retrieve() ``` @@ -20273,58 +20389,63 @@ client.crm.opportunities.retrieve(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.crm.scopes.linked_account_scopes_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +
+
+#### 🔌 Usage +
-**remote_fields:** `typing.Optional[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) - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.scopes.linked_account_scopes_retrieve() + +```
+ + + +#### ⚙️ Parameters + +
+
@@ -20341,7 +20462,7 @@ client.crm.opportunities.retrieve(
-
client.crm.opportunities.partial_update(...) +
client.crm.scopes.linked_account_scopes_create(...)
@@ -20353,7 +20474,7 @@ client.crm.opportunities.retrieve(
-Updates an `Opportunity` object with the given `id`. +Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -20369,17 +20490,42 @@ Updates an `Opportunity` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedOpportunityRequest +from merge.resources.crm import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) 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.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, + ) + }, + ), + ], ) ``` @@ -20396,7 +20542,7 @@ client.crm.opportunities.partial_update(
-**id:** `str` +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -20404,43 +20550,20 @@ client.crm.opportunities.partial_update(
-**model:** `PatchedOpportunityRequest` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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(...) +## Crm DeleteAccount +
client.crm.delete_account.delete()
@@ -20452,7 +20575,7 @@ client.crm.opportunities.partial_update(
-Returns metadata for `Opportunity` PATCHs. +Delete a linked account.
@@ -20473,9 +20596,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.meta_patch_retrieve( - id="id", -) +client.crm.delete_account.delete() ``` @@ -20491,14 +20612,6 @@ client.crm.opportunities.meta_patch_retrieve(
-**id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -20511,7 +20624,8 @@ client.crm.opportunities.meta_patch_retrieve(
-
client.crm.opportunities.meta_post_retrieve() +## Crm EngagementTypes +
client.crm.engagement_types.list(...)
@@ -20523,7 +20637,7 @@ client.crm.opportunities.meta_patch_retrieve(
-Returns metadata for `Opportunity` POSTs. +Returns a list of `EngagementType` objects.
@@ -20538,13 +20652,35 @@ Returns metadata for `Opportunity` POSTs.
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.meta_post_retrieve() +client.crm.engagement_types.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", +) ```
@@ -20560,73 +20696,19 @@ client.crm.opportunities.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
- - - - -
- -
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, -) - -``` -
-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-#### ⚙️ Parameters - -
-
-
@@ -20670,7 +20752,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 +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -20678,7 +20760,7 @@ client.crm.opportunities.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -20694,6 +20776,14 @@ client.crm.opportunities.remote_field_classes_list(
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -20706,8 +20796,7 @@ client.crm.opportunities.remote_field_classes_list(
-## Crm Passthrough -
client.crm.passthrough.create(...) +
client.crm.engagement_types.retrieve(...)
@@ -20719,7 +20808,7 @@ client.crm.opportunities.remote_field_classes_list(
-Pull data from an endpoint not currently supported by Merge. +Returns an `EngagementType` object with the given `id`.
@@ -20735,17 +20824,16 @@ 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.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.crm.engagement_types.retrieve( + id="id", + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, ) ``` @@ -20762,7 +20850,7 @@ client.crm.passthrough.create(
-**request:** `DataPassthroughRequest` +**id:** `str`
@@ -20770,71 +20858,23 @@ client.crm.passthrough.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.
- -
- - - - -
- -## Crm RegenerateKey -
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", -) - -``` -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the remote key +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -20854,8 +20894,7 @@ client.crm.regenerate_key.create(
-## Crm Stages -
client.crm.stages.list(...) +
client.crm.engagement_types.remote_field_classes_list(...)
@@ -20867,7 +20906,7 @@ client.crm.regenerate_key.create(
-Returns a list of `Stage` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -20882,34 +20921,21 @@ 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", - ), +client.crm.engagement_types.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", include_deleted_data=True, include_remote_data=True, include_remote_fields=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), + is_common_model_field=True, + is_custom=True, page_size=1, - remote_id="remote_id", ) ``` @@ -20926,7 +20952,7 @@ client.crm.stages.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.
@@ -20934,7 +20960,7 @@ client.crm.stages.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/).
@@ -20942,7 +20968,7 @@ client.crm.stages.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.
@@ -20950,7 +20976,7 @@ client.crm.stages.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -20958,7 +20984,7 @@ client.crm.stages.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -20966,7 +20992,7 @@ client.crm.stages.list(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -20974,7 +21000,7 @@ client.crm.stages.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -20982,7 +21008,7 @@ client.crm.stages.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -20990,31 +21016,7 @@ client.crm.stages.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
- -
-
- -**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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21026,7 +21028,8 @@ client.crm.stages.list(
-
client.crm.stages.retrieve(...) +## Crm Engagements +
client.crm.engagements.list(...)
@@ -21038,7 +21041,7 @@ client.crm.stages.list(
-Returns a `Stage` object with the given `id`. +Returns a list of `Engagement` objects.
@@ -21053,17 +21056,44 @@ Returns a `Stage` object with the given `id`.
```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.stages.retrieve( - id="id", +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", + ), ) ``` @@ -21080,7 +21110,7 @@ client.crm.stages.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -21088,7 +21118,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -21096,7 +21126,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -21104,7 +21134,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). +**expand:** `typing.Optional[EngagementsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21112,77 +21142,23 @@ client.crm.stages.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
- - - - -
- -
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, -) - -``` -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### ⚙️ Parameters - -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -21190,7 +21166,7 @@ client.crm.stages.remote_field_classes_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21198,7 +21174,7 @@ client.crm.stages.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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -21206,7 +21182,7 @@ client.crm.stages.remote_field_classes_list(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -21214,7 +21190,7 @@ client.crm.stages.remote_field_classes_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -21222,7 +21198,7 @@ client.crm.stages.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -21230,7 +21206,7 @@ client.crm.stages.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime.
@@ -21238,7 +21214,7 @@ client.crm.stages.remote_field_classes_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime.
@@ -21258,8 +21234,7 @@ client.crm.stages.remote_field_classes_list(
-## Crm SyncStatus -
client.crm.sync_status.list(...) +
client.crm.engagements.create(...)
@@ -21271,7 +21246,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). +Creates an `Engagement` object with the given values.
@@ -21287,14 +21262,16 @@ Get sync status for the current sync and the most recently finished sync. `last_ ```python from merge import Merge +from merge.resources.crm import EngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - page_size=1, +client.crm.engagements.create( + is_debug_mode=True, + run_async=True, + model=EngagementRequest(), ) ``` @@ -21311,7 +21288,7 @@ client.crm.sync_status.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**model:** `EngagementRequest`
@@ -21319,7 +21296,15 @@ client.crm.sync_status.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. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -21339,8 +21324,7 @@ client.crm.sync_status.list(
-## Crm ForceResync -
client.crm.force_resync.sync_status_resync_create() +
client.crm.engagements.retrieve(...)
@@ -21352,7 +21336,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 an `Engagement` object with the given `id`.
@@ -21368,12 +21352,21 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly, ```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.force_resync.sync_status_resync_create() +client.crm.engagements.retrieve( + id="id", + expand=EngagementsRetrieveRequestExpand.ACCOUNT, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, +) ``` @@ -21389,6 +21382,46 @@ client.crm.force_resync.sync_status_resync_create()
+**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — 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.
@@ -21401,8 +21434,7 @@ client.crm.force_resync.sync_status_resync_create()
-## Crm Tasks -
client.crm.tasks.list(...) +
client.crm.engagements.partial_update(...)
@@ -21414,7 +21446,7 @@ client.crm.force_resync.sync_status_resync_create()
-Returns a list of `Task` objects. +Updates an `Engagement` object with the given `id`.
@@ -21429,37 +21461,19 @@ Returns a list of `Task` objects.
```python -import datetime - from merge import Merge -from merge.resources.crm.resources.tasks import TasksListRequestExpand +from merge.resources.crm import PatchedEngagementRequest 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", - expand=TasksListRequestExpand.ACCOUNT, - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", -) +client.crm.engagements.partial_update( + id="id", + is_debug_mode=True, + run_async=True, + model=PatchedEngagementRequest(), +) ```
@@ -21475,7 +21489,7 @@ client.crm.tasks.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -21483,7 +21497,7 @@ client.crm.tasks.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**model:** `PatchedEngagementRequest`
@@ -21491,7 +21505,7 @@ client.crm.tasks.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.
@@ -21499,7 +21513,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. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -21507,63 +21521,70 @@ 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/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+
client.crm.engagements.meta_patch_retrieve(...)
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
+#### 📝 Description
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +Returns metadata for `Engagement` PATCHs. +
+
+#### 🔌 Usage +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.engagements.meta_patch_retrieve( + id="id", +) + +```
+ + + +#### ⚙️ Parameters
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**id:** `str`
@@ -21583,7 +21604,7 @@ client.crm.tasks.list(
-
client.crm.tasks.create(...) +
client.crm.engagements.meta_post_retrieve()
@@ -21595,7 +21616,7 @@ client.crm.tasks.list(
-Creates a `Task` object with the given values. +Returns metadata for `Engagement` POSTs.
@@ -21611,17 +21632,12 @@ Creates a `Task` object with the given values. ```python from merge import Merge -from merge.resources.crm import TaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.create( - is_debug_mode=True, - run_async=True, - model=TaskRequest(), -) +client.crm.engagements.meta_post_retrieve() ``` @@ -21637,30 +21653,6 @@ client.crm.tasks.create(
-**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.
@@ -21673,7 +21665,7 @@ client.crm.tasks.create(
-
client.crm.tasks.retrieve(...) +
client.crm.engagements.remote_field_classes_list(...)
@@ -21685,7 +21677,7 @@ client.crm.tasks.create(
-Returns a `Task` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -21701,18 +21693,20 @@ 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( - id="id", - expand=TasksRetrieveRequestExpand.ACCOUNT, +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, ) ``` @@ -21729,7 +21723,7 @@ client.crm.tasks.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -21737,7 +21731,7 @@ client.crm.tasks.retrieve(
-**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -21769,6 +21763,30 @@ client.crm.tasks.retrieve(
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+ +
+
+ +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21781,7 +21799,8 @@ client.crm.tasks.retrieve(
-
client.crm.tasks.partial_update(...) +## Crm FieldMapping +
client.crm.field_mapping.field_mappings_retrieve(...)
@@ -21793,7 +21812,7 @@ client.crm.tasks.retrieve(
-Updates a `Task` object with the given `id`. +Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -21809,17 +21828,13 @@ Updates a `Task` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedTaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.partial_update( - id="id", - is_debug_mode=True, - run_async=True, - model=PatchedTaskRequest(), +client.crm.field_mapping.field_mappings_retrieve( + exclude_remote_field_metadata=True, ) ``` @@ -21836,31 +21851,7 @@ client.crm.tasks.partial_update(
-**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. +**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.
@@ -21880,7 +21871,7 @@ client.crm.tasks.partial_update(
-
client.crm.tasks.meta_patch_retrieve(...) +
client.crm.field_mapping.field_mappings_create(...)
@@ -21892,7 +21883,7 @@ client.crm.tasks.partial_update(
-Returns metadata for `Task` PATCHs. +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.
@@ -21913,8 +21904,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.meta_patch_retrieve( - id="id", +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", ) ``` @@ -21931,7 +21928,7 @@ client.crm.tasks.meta_patch_retrieve(
-**id:** `str` +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -21939,64 +21936,51 @@ client.crm.tasks.meta_patch_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.tasks.meta_post_retrieve()
-#### 📝 Description - -
-
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. + +
+
-Returns metadata for `Task` POSTs. -
-
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.tasks.meta_post_retrieve() - -``` -
-
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +
-#### ⚙️ Parameters -
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. + +
+
+
@@ -22012,7 +21996,7 @@ client.crm.tasks.meta_post_retrieve()
-
client.crm.tasks.remote_field_classes_list(...) +
client.crm.field_mapping.field_mappings_destroy(...)
@@ -22024,7 +22008,7 @@ client.crm.tasks.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` 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.
@@ -22045,15 +22029,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - is_common_model_field=True, - is_custom=True, - page_size=1, +client.crm.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -22070,7 +22047,7 @@ client.crm.tasks.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**field_mapping_id:** `str`
@@ -22078,31 +22055,70 @@ client.crm.tasks.remote_field_classes_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+
client.crm.field_mapping.field_mappings_partial_update(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +#### 📝 Description + +
+
+ +
+
+ +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
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
+
+ +**field_mapping_id:** `str`
@@ -22110,7 +22126,7 @@ client.crm.tasks.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**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.
@@ -22118,7 +22134,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 +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -22126,7 +22142,7 @@ client.crm.tasks.remote_field_classes_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -22146,8 +22162,7 @@ client.crm.tasks.remote_field_classes_list(
-## Crm Users -
client.crm.users.list(...) +
client.crm.field_mapping.remote_fields_retrieve(...)
@@ -22159,7 +22174,7 @@ client.crm.tasks.remote_field_classes_list(
-Returns a list of `User` objects. +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -22174,35 +22189,15 @@ 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, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", +client.crm.field_mapping.remote_fields_retrieve( + common_models="common_models", + include_example_values="include_example_values", ) ``` @@ -22219,7 +22214,7 @@ client.crm.users.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -22227,7 +22222,7 @@ client.crm.users.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
@@ -22235,83 +22230,64 @@ client.crm.users.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**email:** `typing.Optional[str]` — If provided, will only return users with this email. -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+
client.crm.field_mapping.target_fields_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
- -
-
- -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. -
+#### 🔌 Usage +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.field_mapping.target_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -22327,7 +22303,8 @@ client.crm.users.list(
-
client.crm.users.retrieve(...) +## Crm GenerateKey +
client.crm.generate_key.create(...)
@@ -22339,7 +22316,7 @@ client.crm.users.list(
-Returns a `User` object with the given `id`. +Create a remote key.
@@ -22360,11 +22337,8 @@ 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, +client.crm.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -22381,31 +22355,7 @@ client.crm.users.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_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). +**name:** `str` — The name of the remote key
@@ -22425,7 +22375,8 @@ client.crm.users.retrieve(
-
client.crm.users.ignore_create(...) +## Crm Issues +
client.crm.issues.list(...)
@@ -22437,7 +22388,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. +Gets all issues for Organization.
@@ -22452,18 +22403,38 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```python +import datetime + from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum +from merge.resources.crm.resources.issues import IssuesListRequestStatus 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.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, ) ``` @@ -22480,7 +22451,7 @@ client.crm.users.ignore_create(
-**model_id:** `str` +**account_token:** `typing.Optional[str]`
@@ -22488,7 +22459,7 @@ client.crm.users.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -22496,77 +22467,47 @@ client.crm.users.ignore_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
-
-
+
+
+**end_user_organization_name:** `typing.Optional[str]` +
-
-
client.crm.users.remote_field_classes_list(...)
-#### 📝 Description +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. + +
+
-
-
- -Returns a list of `RemoteFieldClass` objects. -
-
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.users.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - is_common_model_field=True, - is_custom=True, - page_size=1, -) - -``` -
-
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues +
-#### ⚙️ Parameters - -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**integration_name:** `typing.Optional[str]`
@@ -22574,7 +22515,7 @@ client.crm.users.remote_field_classes_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -22582,7 +22523,7 @@ client.crm.users.remote_field_classes_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -22590,7 +22531,7 @@ 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. +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -22598,7 +22539,7 @@ client.crm.users.remote_field_classes_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -22606,7 +22547,7 @@ client.crm.users.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -22614,15 +22555,12 @@ client.crm.users.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
+**status:** `typing.Optional[IssuesListRequestStatus]` -
-
+Status of the issue. Options: ('ONGOING', 'RESOLVED') -**page_size:** `typing.Optional[int]` — Number of results to return per page. +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -22642,8 +22580,7 @@ client.crm.users.remote_field_classes_list(
-## Crm WebhookReceivers -
client.crm.webhook_receivers.list() +
client.crm.issues.retrieve(...)
@@ -22655,7 +22592,7 @@ client.crm.users.remote_field_classes_list(
-Returns a list of `WebhookReceiver` objects. +Get a specific issue.
@@ -22676,7 +22613,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.list() +client.crm.issues.retrieve( + id="id", +) ``` @@ -22692,6 +22631,14 @@ client.crm.webhook_receivers.list()
+**id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -22704,7 +22651,8 @@ client.crm.webhook_receivers.list()
-
client.crm.webhook_receivers.create(...) +## Crm Leads +
client.crm.leads.list(...)
@@ -22716,7 +22664,7 @@ client.crm.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns a list of `Lead` objects.
@@ -22731,15 +22679,41 @@ Creates a `WebhookReceiver` object with the given values.
```python +import datetime + from merge import Merge +from merge.resources.crm.resources.leads import LeadsListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.create( - event="event", - is_active=True, +client.crm.leads.list( + converted_account_id="converted_account_id", + converted_contact_id="converted_contact_id", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + email_addresses="email_addresses", + expand=LeadsListRequestExpand.CONVERTED_ACCOUNT, + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + owner_id="owner_id", + page_size=1, + phone_numbers="phone_numbers", + remote_id="remote_id", ) ``` @@ -22756,7 +22730,7 @@ client.crm.webhook_receivers.create(
-**event:** `str` +**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account.
@@ -22764,7 +22738,7 @@ client.crm.webhook_receivers.create(
-**is_active:** `bool` +**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact.
@@ -22772,7 +22746,7 @@ client.crm.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -22780,65 +22754,115 @@ client.crm.webhook_receivers.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. +
+
+
+**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. +
-
-## Filestorage AccountDetails -
client.filestorage.account_details.retrieve()
-#### 📝 Description +**expand:** `typing.Optional[LeadsListRequestExpand]` — 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/). + +
+
+
-Get details for a linked account. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
+ +
+
+ +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### 🔌 Usage +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+**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.account_details.retrieve() +
+
-``` +**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. +
-#### ⚙️ Parameters +
+
+ +**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. + +
+
+
@@ -22854,8 +22878,7 @@ client.filestorage.account_details.retrieve()
-## Filestorage AccountToken -
client.filestorage.account_token.retrieve(...) +
client.crm.leads.create(...)
@@ -22867,7 +22890,7 @@ client.filestorage.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Creates a `Lead` object with the given values.
@@ -22883,13 +22906,16 @@ Returns the account token for the end user with the provided public token. ```python from merge import Merge +from merge.resources.crm import LeadRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_token.retrieve( - public_token="public_token", +client.crm.leads.create( + is_debug_mode=True, + run_async=True, + model=LeadRequest(), ) ``` @@ -22906,7 +22932,23 @@ client.filestorage.account_token.retrieve(
-**public_token:** `str` +**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.
@@ -22926,8 +22968,7 @@ client.filestorage.account_token.retrieve(
-## Filestorage AsyncPassthrough -
client.filestorage.async_passthrough.create(...) +
client.crm.leads.retrieve(...)
@@ -22939,7 +22980,7 @@ client.filestorage.account_token.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a `Lead` object with the given `id`.
@@ -22955,17 +22996,18 @@ 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.crm.resources.leads import LeadsRetrieveRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.crm.leads.retrieve( + id="id", + expand=LeadsRetrieveRequestExpand.CONVERTED_ACCOUNT, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, ) ``` @@ -22982,7 +23024,39 @@ client.filestorage.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — 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).
@@ -23002,7 +23076,7 @@ client.filestorage.async_passthrough.create(
-
client.filestorage.async_passthrough.retrieve(...) +
client.crm.leads.meta_post_retrieve()
@@ -23014,7 +23088,7 @@ client.filestorage.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Returns metadata for `Lead` POSTs.
@@ -23035,9 +23109,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) +client.crm.leads.meta_post_retrieve() ``` @@ -23053,14 +23125,6 @@ client.filestorage.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23073,8 +23137,7 @@ client.filestorage.async_passthrough.retrieve(
-## Filestorage AuditTrail -
client.filestorage.audit_trail.list(...) +
client.crm.leads.remote_field_classes_list(...)
@@ -23086,7 +23149,7 @@ client.filestorage.async_passthrough.retrieve(
-Gets a list of audit trail events. +Returns a list of `RemoteFieldClass` objects.
@@ -23107,13 +23170,15 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.audit_trail.list( +client.crm.leads.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - event_type="event_type", + include_deleted_data=True, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + is_common_model_field=True, + is_custom=True, page_size=1, - start_date="start_date", - user_email="user_email", ) ``` @@ -23138,7 +23203,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 +23211,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 +23219,7 @@ client.filestorage.audit_trail.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -23162,7 +23227,7 @@ client.filestorage.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23170,7 +23235,23 @@ 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_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.
@@ -23190,8 +23271,8 @@ client.filestorage.audit_trail.list(
-## Filestorage AvailableActions -
client.filestorage.available_actions.retrieve() +## Crm LinkToken +
client.crm.link_token.create(...)
@@ -23203,7 +23284,7 @@ client.filestorage.audit_trail.list(
-Returns a list of models and actions available for an account. +Creates a link token to be used when linking a new end user.
@@ -23219,12 +23300,18 @@ Returns a list of models and actions available for an account. ```python from merge import Merge +from merge.resources.crm import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.available_actions.retrieve() +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], +) ``` @@ -23240,65 +23327,119 @@ client.filestorage.available_actions.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. +
+
+
+**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. +
-
-## Filestorage Scopes -
client.filestorage.scopes.default_scopes_retrieve()
-#### 📝 Description +**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. + +
+
+
-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). +**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +
+ +
+
+ +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +
-#### 🔌 Usage +
+
+ +**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. + +
+
+**category_common_model_scopes:** `typing.Optional[ + typing.Dict[ + str, + typing.Optional[ + typing.Sequence[IndividualCommonModelScopeDeserializerRequest] + ], + ] +]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. + +
+
+
-```python -from merge import Merge +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.scopes.default_scopes_retrieve() +The following subset of IETF language tags can be used to configure localization. -``` +* `en` - en +* `de` - de +
+ +
+
+ +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +
-#### ⚙️ Parameters -
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. + +
+
+
@@ -23314,7 +23455,8 @@ client.filestorage.scopes.default_scopes_retrieve()
-
client.filestorage.scopes.linked_account_scopes_retrieve() +## Crm LinkedAccounts +
client.crm.linked_accounts.list(...)
@@ -23326,7 +23468,7 @@ client.filestorage.scopes.default_scopes_retrieve()
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +List linked accounts for your organization.
@@ -23342,12 +23484,29 @@ Get all available permissions for Merge Common Models and fields for a single Li ```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.filestorage.scopes.linked_account_scopes_retrieve() +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", +) ``` @@ -23363,99 +23522,65 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.filestorage.scopes.linked_account_scopes_create(...)
-#### 📝 Description +**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. + +
+
+
-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) -
-
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. + -#### 🔌 Usage -
-
-
- -```python -from merge import Merge -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, - ) - }, - ), - ], -) - -``` -
-
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. +
-#### ⚙️ Parameters -
-
-
- -**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**id:** `typing.Optional[str]`
@@ -23463,65 +23588,51 @@ client.filestorage.scopes.linked_account_scopes_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
-
-
+
+
+**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. +
-
-## Filestorage DeleteAccount -
client.filestorage.delete_account.delete()
-#### 📝 Description - -
-
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. + +
+
-Delete a linked account. -
-
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.delete_account.delete() - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters -
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` + +
+
+
@@ -23537,8 +23648,8 @@ client.filestorage.delete_account.delete()
-## Filestorage Drives -
client.filestorage.drives.list(...) +## Crm Notes +
client.crm.notes.list(...)
@@ -23550,7 +23661,7 @@ client.filestorage.delete_account.delete()
-Returns a list of `Drive` objects. +Returns a list of `Note` objects.
@@ -23568,12 +23679,15 @@ Returns a list of `Drive` objects. import datetime from merge import Merge +from merge.resources.crm.resources.notes import NotesListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.list( +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", ), @@ -23581,8 +23695,10 @@ client.filestorage.drives.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=NotesListRequestExpand.ACCOUNT, include_deleted_data=True, include_remote_data=True, + include_remote_fields=True, include_shell_data=True, modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", @@ -23590,7 +23706,8 @@ client.filestorage.drives.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - name="name", + opportunity_id="opportunity_id", + owner_id="owner_id", page_size=1, remote_id="remote_id", ) @@ -23609,6 +23726,22 @@ client.filestorage.drives.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.
@@ -23633,6 +23766,14 @@ client.filestorage.drives.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/).
@@ -23649,6 +23790,14 @@ client.filestorage.drives.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).
@@ -23673,7 +23822,15 @@ client.filestorage.drives.list(
-**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match. +**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.
@@ -23709,7 +23866,7 @@ client.filestorage.drives.list(
-
client.filestorage.drives.retrieve(...) +
client.crm.notes.create(...)
@@ -23721,7 +23878,7 @@ client.filestorage.drives.list(
-Returns a `Drive` object with the given `id`. +Creates a `Note` object with the given values.
@@ -23737,15 +23894,16 @@ Returns a `Drive` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import NoteRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, +client.crm.notes.create( + is_debug_mode=True, + run_async=True, + model=NoteRequest(), ) ``` @@ -23762,7 +23920,7 @@ client.filestorage.drives.retrieve(
-**id:** `str` +**model:** `NoteRequest`
@@ -23770,7 +23928,7 @@ client.filestorage.drives.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -23778,7 +23936,7 @@ client.filestorage.drives.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -23798,8 +23956,7 @@ client.filestorage.drives.retrieve(
-## Filestorage FieldMapping -
client.filestorage.field_mapping.field_mappings_retrieve(...) +
client.crm.notes.retrieve(...)
@@ -23811,7 +23968,7 @@ client.filestorage.drives.retrieve(
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Returns a `Note` object with the given `id`.
@@ -23827,13 +23984,18 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw ```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.filestorage.field_mapping.field_mappings_retrieve( - exclude_remote_field_metadata=True, +client.crm.notes.retrieve( + id="id", + expand=NotesRetrieveRequestExpand.ACCOUNT, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, ) ``` @@ -23850,7 +24012,39 @@ client.filestorage.field_mapping.field_mappings_retrieve(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — 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).
@@ -23870,7 +24064,7 @@ client.filestorage.field_mapping.field_mappings_retrieve(
-
client.filestorage.field_mapping.field_mappings_create(...) +
client.crm.notes.meta_post_retrieve()
@@ -23882,7 +24076,7 @@ client.filestorage.field_mapping.field_mappings_retrieve(
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns metadata for `Note` POSTs.
@@ -23903,15 +24097,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_create( - exclude_remote_field_metadata=True, - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", -) +client.crm.notes.meta_post_retrieve() ``` @@ -23927,146 +24113,19 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**target_field_description:** `str` — The description of the target field you want this remote field to map to. -
-
-
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. -
+
-
-
- -**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. - -
-
- -
-
- -**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. - -
-
- -
-
- -**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. - -
-
- -
-
- -**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- - - - - - -
- -
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", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**field_mapping_id:** `str` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -
client.filestorage.field_mapping.field_mappings_partial_update(...) +
client.crm.notes.remote_field_classes_list(...)
@@ -24078,7 +24137,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a list of `RemoteFieldClass` objects.
@@ -24099,8 +24158,15 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", +client.crm.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, ) ``` @@ -24117,7 +24183,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24125,7 +24191,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. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -24133,7 +24199,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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -24141,7 +24207,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. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -24149,71 +24215,15 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). -
-
- -
- - - - -
- -
client.filestorage.field_mapping.remote_fields_retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). -
-
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.field_mapping.remote_fields_retrieve( - common_models="common_models", - include_example_values="include_example_values", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -24221,7 +24231,7 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -24229,63 +24239,10 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
- - -
-
-
- -
client.filestorage.field_mapping.target_fields_retrieve() -
-
- -#### 📝 Description - -
-
- -
-
- -Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/). -
-
-
-
- -#### 🔌 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() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
@@ -24302,8 +24259,8 @@ client.filestorage.field_mapping.target_fields_retrieve()
-## Filestorage Files -
client.filestorage.files.list(...) +## Crm Opportunities +
client.crm.opportunities.list(...)
@@ -24315,7 +24272,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-Returns a list of `File` objects. +Returns a list of `Opportunity` objects.
@@ -24333,16 +24290,17 @@ Returns a list of `File` objects. import datetime from merge import Merge -from merge.resources.filestorage.resources.files import ( - FilesListRequestExpand, - FilesListRequestOrderBy, +from merge.resources.crm.resources.opportunities import ( + OpportunitiesListRequestExpand, + OpportunitiesListRequestStatus, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.list( +client.crm.opportunities.list( + account_id="account_id", created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -24350,29 +24308,25 @@ 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", + expand=OpportunitiesListRequestExpand.ACCOUNT, include_deleted_data=True, include_remote_data=True, + include_remote_fields=True, include_shell_data=True, - mime_type="mime_type", modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - name="name", - order_by=FilesListRequestOrderBy.CREATED_AT_DESCENDING, + owner_id="owner_id", page_size=1, remote_created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - remote_created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), remote_id="remote_id", + stage_id="stage_id", + status=OpportunitiesListRequestStatus.LOST, ) ``` @@ -24389,6 +24343,14 @@ client.filestorage.files.list(
+**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account. + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24413,7 +24375,7 @@ client.filestorage.files.list(
-**drive_id:** `typing.Optional[str]` — Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive. +**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24421,7 +24383,7 @@ client.filestorage.files.list(
-**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -24429,7 +24391,7 @@ client.filestorage.files.list(
-**folder_id:** `typing.Optional[str]` — Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -24437,7 +24399,7 @@ client.filestorage.files.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -24445,7 +24407,7 @@ client.filestorage.files.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).
@@ -24453,7 +24415,7 @@ client.filestorage.files.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -24461,7 +24423,7 @@ client.filestorage.files.list(
-**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -24469,7 +24431,7 @@ client.filestorage.files.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner.
@@ -24477,7 +24439,7 @@ client.filestorage.files.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -24485,7 +24447,7 @@ client.filestorage.files.list(
-**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match. +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime.
@@ -24493,7 +24455,7 @@ client.filestorage.files.list(
-**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -24501,7 +24463,7 @@ client.filestorage.files.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -24509,7 +24471,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. +**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)
@@ -24517,7 +24479,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. +**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage.
@@ -24525,7 +24487,13 @@ client.filestorage.files.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**status:** `typing.Optional[OpportunitiesListRequestStatus]` + +If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') + +* `OPEN` - OPEN +* `WON` - WON +* `LOST` - LOST
@@ -24545,7 +24513,7 @@ client.filestorage.files.list(
-
client.filestorage.files.create(...) +
client.crm.opportunities.create(...)
@@ -24557,7 +24525,7 @@ client.filestorage.files.list(
-Creates a `File` object with the given values. +Creates an `Opportunity` object with the given values.
@@ -24573,16 +24541,16 @@ Creates a `File` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FileRequest +from merge.resources.crm import OpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.create( +client.crm.opportunities.create( is_debug_mode=True, run_async=True, - model=FileRequest(), + model=OpportunityRequest(), ) ``` @@ -24599,7 +24567,7 @@ client.filestorage.files.create(
-**model:** `FileRequest` +**model:** `OpportunityRequest`
@@ -24635,7 +24603,7 @@ client.filestorage.files.create(
-
client.filestorage.files.retrieve(...) +
client.crm.opportunities.retrieve(...)
@@ -24647,7 +24615,7 @@ client.filestorage.files.create(
-Returns a `File` object with the given `id`. +Returns an `Opportunity` object with the given `id`.
@@ -24663,18 +24631,19 @@ Returns a `File` object with the given `id`. ```python from merge import Merge -from merge.resources.filestorage.resources.files import ( - FilesRetrieveRequestExpand, +from merge.resources.crm.resources.opportunities import ( + OpportunitiesRetrieveRequestExpand, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.retrieve( +client.crm.opportunities.retrieve( id="id", - expand=FilesRetrieveRequestExpand.DRIVE, + expand=OpportunitiesRetrieveRequestExpand.ACCOUNT, include_remote_data=True, + include_remote_fields=True, include_shell_data=True, ) @@ -24700,7 +24669,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. +**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24716,7 +24685,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). +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -24724,71 +24693,15 @@ client.filestorage.files.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). -
-
- -
- - - - -
- -
client.filestorage.files.download_request_meta_retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```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", -) - -``` -
-
-#### ⚙️ Parameters - -
-
-
-**id:** `str` +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -24796,7 +24709,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. +**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)
@@ -24816,7 +24729,7 @@ client.filestorage.files.download_request_meta_retrieve(
-
client.filestorage.files.download_request_meta_list(...) +
client.crm.opportunities.partial_update(...)
@@ -24828,7 +24741,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. +Updates an `Opportunity` object with the given `id`.
@@ -24844,24 +24757,17 @@ Returns metadata to construct authenticated file download requests, allowing you ```python from merge import Merge -from merge.resources.filestorage.resources.files import ( - FilesDownloadRequestMetaListRequestOrderBy, -) +from merge.resources.crm import PatchedOpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_list( - created_after="created_after", - created_before="created_before", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - mime_types="mime_types", - modified_after="modified_after", - modified_before="modified_before", - order_by=FilesDownloadRequestMetaListRequestOrderBy.CREATED_AT_DESCENDING, - page_size=1, +client.crm.opportunities.partial_update( + id="id", + is_debug_mode=True, + run_async=True, + model=PatchedOpportunityRequest(), ) ``` @@ -24878,7 +24784,7 @@ client.filestorage.files.download_request_meta_list(
-**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -24886,7 +24792,7 @@ client.filestorage.files.download_request_meta_list(
-**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime. +**model:** `PatchedOpportunityRequest`
@@ -24894,7 +24800,7 @@ client.filestorage.files.download_request_meta_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.
@@ -24902,7 +24808,7 @@ client.filestorage.files.download_request_meta_list(
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — If provided, will only return objects with the given IDs. Comma-separated list of strings. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -24910,47 +24816,70 @@ client.filestorage.files.download_request_meta_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**mime_types:** `typing.Optional[str]` — A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article. -
+
+
client.crm.opportunities.meta_patch_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. - +
+
+ +Returns metadata for `Opportunity` PATCHs. +
+
+#### 🔌 Usage +
-**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.opportunities.meta_patch_retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**id:** `str`
@@ -24970,7 +24899,7 @@ client.filestorage.files.download_request_meta_list(
-
client.filestorage.files.meta_post_retrieve() +
client.crm.opportunities.meta_post_retrieve()
@@ -24982,7 +24911,7 @@ client.filestorage.files.download_request_meta_list(
-Returns metadata for `FileStorageFile` POSTs. +Returns metadata for `Opportunity` POSTs.
@@ -25003,7 +24932,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.meta_post_retrieve() +client.crm.opportunities.meta_post_retrieve() ``` @@ -25031,8 +24960,7 @@ client.filestorage.files.meta_post_retrieve()
-## Filestorage Folders -
client.filestorage.folders.list(...) +
client.crm.opportunities.remote_field_classes_list(...)
@@ -25044,7 +24972,7 @@ client.filestorage.files.meta_post_retrieve()
-Returns a list of `Folder` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -25059,40 +24987,21 @@ Returns a list of `Folder` objects.
```python -import datetime - from merge import Merge -from merge.resources.filestorage.resources.folders import ( - FoldersListRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.crm.opportunities.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - drive_id="drive_id", - expand=FoldersListRequestExpand.DRIVE, include_deleted_data=True, include_remote_data=True, + include_remote_fields=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - name="name", + is_common_model_field=True, + is_custom=True, page_size=1, - parent_folder_id="parent_folder_id", - remote_id="remote_id", ) ``` @@ -25109,7 +25018,7 @@ client.filestorage.folders.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25117,7 +25026,7 @@ client.filestorage.folders.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -25125,7 +25034,7 @@ client.filestorage.folders.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25133,7 +25042,7 @@ client.filestorage.folders.list(
-**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -25141,7 +25050,7 @@ client.filestorage.folders.list(
-**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25149,7 +25058,7 @@ client.filestorage.folders.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -25157,63 +25066,91 @@ client.filestorage.folders.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + + + +
+## Crm Passthrough +
client.crm.passthrough.create(...)
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### 📝 Description
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +Pull data from an endpoint not currently supported by Merge. +
+
+#### 🔌 Usage +
-**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +```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
-**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**request:** `DataPassthroughRequest`
@@ -25233,7 +25170,8 @@ client.filestorage.folders.list(
-
client.filestorage.folders.create(...) +## Crm RegenerateKey +
client.crm.regenerate_key.create(...)
@@ -25245,7 +25183,7 @@ client.filestorage.folders.list(
-Creates a `Folder` object with the given values. +Exchange remote keys.
@@ -25261,16 +25199,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.crm.regenerate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -25287,23 +25222,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. +**name:** `str` — The name of the remote key
@@ -25323,7 +25242,8 @@ client.filestorage.folders.create(
-
client.filestorage.folders.retrieve(...) +## Crm Stages +
client.crm.stages.list(...)
@@ -25335,7 +25255,7 @@ client.filestorage.folders.create(
-Returns a `Folder` object with the given `id`. +Returns a list of `Stage` objects.
@@ -25350,20 +25270,34 @@ Returns a `Folder` object with the given `id`.
```python +import datetime + 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, +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", ) ``` @@ -25380,7 +25314,7 @@ client.filestorage.folders.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -25388,7 +25322,7 @@ client.filestorage.folders.retrieve(
-**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -25396,7 +25330,7 @@ client.filestorage.folders.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.
@@ -25404,7 +25338,7 @@ client.filestorage.folders.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -25412,64 +25346,59 @@ client.filestorage.folders.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.
-
-
+
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-
-
client.filestorage.folders.meta_post_retrieve()
-#### 📝 Description - -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
-Returns metadata for `FileStorageFolder` POSTs. -
-
+**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.folders.meta_post_retrieve() - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + -#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -25485,8 +25414,7 @@ client.filestorage.folders.meta_post_retrieve()
-## Filestorage GenerateKey -
client.filestorage.generate_key.create(...) +
client.crm.stages.retrieve(...)
@@ -25498,7 +25426,7 @@ client.filestorage.folders.meta_post_retrieve()
-Create a remote key. +Returns a `Stage` object with the given `id`.
@@ -25519,8 +25447,11 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.generate_key.create( - name="Remote Deployment Key 1", +client.crm.stages.retrieve( + id="id", + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, ) ``` @@ -25537,7 +25468,31 @@ client.filestorage.generate_key.create(
-**name:** `str` — The name of the remote key +**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).
@@ -25557,8 +25512,7 @@ client.filestorage.generate_key.create(
-## Filestorage Groups -
client.filestorage.groups.list(...) +
client.crm.stages.remote_field_classes_list(...)
@@ -25570,7 +25524,7 @@ client.filestorage.generate_key.create(
-Returns a list of `Group` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -25585,74 +25539,38 @@ 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", - ), +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, - 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", ) ```
-
- - - -#### ⚙️ 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. - +
+#### ⚙️ Parameters +
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
-
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25676,7 +25594,7 @@ client.filestorage.groups.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -25684,7 +25602,7 @@ client.filestorage.groups.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25692,7 +25610,7 @@ client.filestorage.groups.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
@@ -25700,7 +25618,7 @@ client.filestorage.groups.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
@@ -25708,7 +25626,7 @@ client.filestorage.groups.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.
@@ -25728,7 +25646,8 @@ client.filestorage.groups.list(
-
client.filestorage.groups.retrieve(...) +## Crm SyncStatus +
client.crm.sync_status.list(...)
@@ -25740,7 +25659,7 @@ client.filestorage.groups.list(
-Returns a `Group` object with the given `id`. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -25761,10 +25680,9 @@ 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.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + page_size=1, ) ``` @@ -25781,7 +25699,7 @@ client.filestorage.groups.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25789,7 +25707,7 @@ client.filestorage.groups.retrieve(
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -25797,19 +25715,65 @@ client.filestorage.groups.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +## Crm ForceResync +
client.crm.force_resync.sync_status_resync_create()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +#### 📝 Description + +
+
+ +
+
+ +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 + +
+
+
@@ -25825,8 +25789,8 @@ client.filestorage.groups.retrieve(
-## Filestorage Issues -
client.filestorage.issues.list(...) +## Crm Tasks +
client.crm.tasks.list(...)
@@ -25838,7 +25802,7 @@ client.filestorage.groups.retrieve(
-Gets all issues for Organization. +Returns a list of `Task` objects.
@@ -25856,35 +25820,33 @@ Gets all issues for Organization. import datetime from merge import Merge -from merge.resources.filestorage.resources.issues import IssuesListRequestStatus +from merge.resources.crm.resources.tasks import TasksListRequestExpand 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.tasks.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", + 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", ), - last_incident_time_before=datetime.datetime.fromisoformat( + modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - linked_account_id="linked_account_id", page_size=1, - start_date="start_date", - status=IssuesListRequestStatus.ONGOING, + remote_id="remote_id", ) ``` @@ -25901,15 +25863,7 @@ client.filestorage.issues.list(
-**account_token:** `typing.Optional[str]` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -25917,7 +25871,7 @@ client.filestorage.issues.list(
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -25925,7 +25879,7 @@ client.filestorage.issues.list(
-**end_user_organization_name:** `typing.Optional[str]` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25933,7 +25887,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. +**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25941,7 +25895,7 @@ client.filestorage.issues.list(
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -25949,7 +25903,7 @@ client.filestorage.issues.list(
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25957,7 +25911,7 @@ client.filestorage.issues.list(
-**integration_name:** `typing.Optional[str]` +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -25965,7 +25919,7 @@ client.filestorage.issues.list(
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25973,7 +25927,7 @@ client.filestorage.issues.list(
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -25981,7 +25935,7 @@ client.filestorage.issues.list(
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -25997,20 +25951,7 @@ client.filestorage.issues.list(
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time - -
-
- -
-
- -**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -26030,7 +25971,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.filestorage.issues.retrieve(...) +
client.crm.tasks.create(...)
@@ -26042,7 +25983,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Creates a `Task` object with the given values.
@@ -26058,13 +25999,16 @@ Get a specific issue. ```python from merge import Merge +from merge.resources.crm import TaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.retrieve( - id="id", +client.crm.tasks.create( + is_debug_mode=True, + run_async=True, + model=TaskRequest(), ) ``` @@ -26081,7 +26025,7 @@ client.filestorage.issues.retrieve(
-**id:** `str` +**model:** `TaskRequest`
@@ -26089,139 +26033,91 @@ client.filestorage.issues.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
- -
- - - - -
- -## Filestorage LinkToken -
client.filestorage.link_token.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Creates a link token to be used when linking a new end user. -
-
-
-
- -#### 🔌 Usage
-
-
- -```python -from merge import Merge -from merge.resources.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], -) - -``` -
-
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +
-#### ⚙️ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**end_user_organization_name:** `str` — Your end user's organization. -
-
-
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. -
+
+
client.crm.tasks.retrieve(...)
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. - -
-
+#### 📝 Description + +
+
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. - +Returns a `Task` object with the given `id`. +
+
+#### 🔌 Usage +
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. - -
-
-
-**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. - +```python +from merge import Merge +from merge.resources.crm.resources.tasks import TasksRetrieveRequestExpand + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.tasks.retrieve( + id="id", + expand=TasksRetrieveRequestExpand.ACCOUNT, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, +) + +``` +
+
+#### ⚙️ 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. - -
-
-
-**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 +26125,7 @@ client.filestorage.link_token.create(
-**category_common_model_scopes:** `typing.Optional[ - typing.Dict[ - str, - typing.Optional[ - typing.Sequence[IndividualCommonModelScopeDeserializerRequest] - ], - ] -]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. +**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -26244,12 +26133,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 +26141,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 +26149,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 +26169,7 @@ The following subset of IETF language tags can be used to configure localization
-## Filestorage LinkedAccounts -
client.filestorage.linked_accounts.list(...) +
client.crm.tasks.partial_update(...)
@@ -26298,7 +26181,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Updates a `Task` object with the given `id`.
@@ -26314,28 +26197,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 PatchedTaskRequest 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.tasks.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=PatchedTaskRequest(), ) ``` @@ -26352,17 +26224,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 +26232,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**model:** `PatchedTaskRequest`
@@ -26378,7 +26240,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 +26248,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 +26256,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.tasks.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 `Task` 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.tasks.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 +26339,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Filestorage Passthrough -
client.filestorage.passthrough.create(...) +
client.crm.tasks.meta_post_retrieve()
@@ -26491,7 +26351,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +Returns metadata for `Task` POSTs.
@@ -26507,18 +26367,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.tasks.meta_post_retrieve() ``` @@ -26534,14 +26388,6 @@ client.filestorage.passthrough.create(
-**request:** `DataPassthroughRequest` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -26554,8 +26400,7 @@ client.filestorage.passthrough.create(
-## Filestorage RegenerateKey -
client.filestorage.regenerate_key.create(...) +
client.crm.tasks.remote_field_classes_list(...)
@@ -26567,7 +26412,7 @@ client.filestorage.passthrough.create(
-Exchange remote keys. +Returns a list of `RemoteFieldClass` objects.
@@ -26588,8 +26433,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.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, ) ``` @@ -26606,7 +26458,63 @@ client.filestorage.regenerate_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.
@@ -26626,8 +26534,8 @@ client.filestorage.regenerate_key.create(
-## Filestorage SyncStatus -
client.filestorage.sync_status.list(...) +## Crm Users +
client.crm.users.list(...)
@@ -26639,7 +26547,7 @@ client.filestorage.regenerate_key.create(
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +Returns a list of `User` objects.
@@ -26654,15 +26562,35 @@ Get sync status for the current sync and the most recently finished sync. `last_
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.sync_status.list( +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, + 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", ) ``` @@ -26679,7 +26607,7 @@ client.filestorage.sync_status.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.
@@ -26687,7 +26615,7 @@ client.filestorage.sync_status.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.
@@ -26695,65 +26623,83 @@ client.filestorage.sync_status.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
+
+
+**email:** `typing.Optional[str]` — If provided, will only return users with this email. +
-
-## Filestorage ForceResync -
client.filestorage.force_resync.sync_status_resync_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. + +
+
+
-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. -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + -#### 🔌 Usage -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.force_resync.sync_status_resync_create() +
+
-``` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -26769,8 +26715,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-## Filestorage Users -
client.filestorage.users.list(...) +
client.crm.users.retrieve(...)
@@ -26782,7 +26727,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-Returns a list of `User` objects. +Returns a `User` object with the given `id`.
@@ -26797,34 +26742,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.filestorage.users.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, +client.crm.users.retrieve( + id="id", include_remote_data=True, + include_remote_fields=True, include_shell_data=True, - is_me="is_me", - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", ) ``` @@ -26841,7 +26769,7 @@ client.filestorage.users.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -26849,7 +26777,7 @@ client.filestorage.users.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26857,7 +26785,7 @@ client.filestorage.users.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -26865,7 +26793,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/). +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -26873,47 +26801,74 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). -
+
+
client.crm.users.ignore_create(...)
-**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. - -
-
+#### 📝 Description
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +
+
+ +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +
+
+#### 🔌 Usage +
-**modified_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 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
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**model_id:** `str`
@@ -26921,7 +26876,7 @@ client.filestorage.users.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**request:** `IgnoreCommonModelRequest`
@@ -26941,7 +26896,7 @@ client.filestorage.users.list(
-
client.filestorage.users.retrieve(...) +
client.crm.users.remote_field_classes_list(...)
@@ -26953,7 +26908,7 @@ client.filestorage.users.list(
-Returns a `User` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -26974,10 +26929,15 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.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, + is_common_model_field=True, + is_custom=True, + page_size=1, ) ``` @@ -26994,7 +26954,15 @@ client.filestorage.users.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/).
@@ -27010,6 +26978,14 @@ client.filestorage.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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27018,6 +26994,30 @@ client.filestorage.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. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27030,8 +27030,8 @@ client.filestorage.users.retrieve(
-## Filestorage WebhookReceivers -
client.filestorage.webhook_receivers.list() +## Crm WebhookReceivers +
client.crm.webhook_receivers.list()
@@ -27064,7 +27064,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.webhook_receivers.list() +client.crm.webhook_receivers.list() ```
@@ -27092,7 +27092,7 @@ client.filestorage.webhook_receivers.list()
-
client.filestorage.webhook_receivers.create(...) +
client.crm.webhook_receivers.create(...)
@@ -27125,7 +27125,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.webhook_receivers.create( +client.crm.webhook_receivers.create( event="event", is_active=True, ) diff --git a/src/merge/client.py b/src/merge/client.py index 4350fe25..e064abf5 100644 --- a/src/merge/client.py +++ b/src/merge/client.py @@ -90,8 +90,8 @@ def __init__( ) self._ats: typing.Optional[AtsClient] = None self._chat: typing.Optional[ChatClient] = None - self._crm: typing.Optional[CrmClient] = None self._filestorage: typing.Optional[FilestorageClient] = None + self._crm: typing.Optional[CrmClient] = None self._hris: typing.Optional[HrisClient] = None self._knowledgebase: typing.Optional[KnowledgebaseClient] = None self._ticketing: typing.Optional[TicketingClient] = None @@ -113,14 +113,6 @@ def chat(self): self._chat = ChatClient(client_wrapper=self._client_wrapper) return self._chat - @property - def crm(self): - if self._crm is None: - from .resources.crm.client import CrmClient # noqa: E402 - - self._crm = CrmClient(client_wrapper=self._client_wrapper) - return self._crm - @property def filestorage(self): if self._filestorage is None: @@ -129,6 +121,14 @@ def filestorage(self): self._filestorage = FilestorageClient(client_wrapper=self._client_wrapper) return self._filestorage + @property + def crm(self): + if self._crm is None: + from .resources.crm.client import CrmClient # noqa: E402 + + self._crm = CrmClient(client_wrapper=self._client_wrapper) + return self._crm + @property def hris(self): if self._hris is None: @@ -233,8 +233,8 @@ def __init__( ) self._ats: typing.Optional[AsyncAtsClient] = None self._chat: typing.Optional[AsyncChatClient] = None - self._crm: typing.Optional[AsyncCrmClient] = None self._filestorage: typing.Optional[AsyncFilestorageClient] = None + self._crm: typing.Optional[AsyncCrmClient] = None self._hris: typing.Optional[AsyncHrisClient] = None self._knowledgebase: typing.Optional[AsyncKnowledgebaseClient] = None self._ticketing: typing.Optional[AsyncTicketingClient] = None @@ -256,14 +256,6 @@ def chat(self): self._chat = AsyncChatClient(client_wrapper=self._client_wrapper) return self._chat - @property - def crm(self): - if self._crm is None: - from .resources.crm.client import AsyncCrmClient # noqa: E402 - - self._crm = AsyncCrmClient(client_wrapper=self._client_wrapper) - return self._crm - @property def filestorage(self): if self._filestorage is None: @@ -272,6 +264,14 @@ def filestorage(self): self._filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) return self._filestorage + @property + def crm(self): + if self._crm is None: + from .resources.crm.client import AsyncCrmClient # noqa: E402 + + self._crm = AsyncCrmClient(client_wrapper=self._client_wrapper) + return self._crm + @property def hris(self): if self._hris is None: diff --git a/src/merge/core/client_wrapper.py b/src/merge/core/client_wrapper.py index af760778..3b87debd 100644 --- a/src/merge/core/client_wrapper.py +++ b/src/merge/core/client_wrapper.py @@ -24,10 +24,10 @@ def __init__( def get_headers(self) -> typing.Dict[str, str]: headers: typing.Dict[str, str] = { - "User-Agent": "MergePythonClient/2.6.2", + "User-Agent": "MergePythonClient/2.6.3", "X-Fern-Language": "Python", "X-Fern-SDK-Name": "MergePythonClient", - "X-Fern-SDK-Version": "2.6.2", + "X-Fern-SDK-Version": "2.6.3", **(self.get_custom_headers() or {}), } if self._account_token is not None: diff --git a/src/merge/resources/chat/__init__.py b/src/merge/resources/chat/__init__.py index da7e6d6f..4c992dad 100644 --- a/src/merge/resources/chat/__init__.py +++ b/src/merge/resources/chat/__init__.py @@ -28,6 +28,7 @@ CommonModelScopesBodyRequest, CompletedAccountInitialScreenEnum, Conversation, + ConversationMembersItem, ConversationType, DataPassthroughRequest, DataPassthroughRequestMethod, @@ -49,6 +50,7 @@ FieldPermissionDeserializer, FieldPermissionDeserializerRequest, Group, + GroupUsersItem, IndividualCommonModelScopeDeserializer, IndividualCommonModelScopeDeserializerRequest, Issue, @@ -58,6 +60,8 @@ LastSyncResultEnum, LinkToken, Member, + MemberGroup, + MemberUser, Message, MethodEnum, ModelOperation, @@ -93,6 +97,7 @@ SyncStatusStatus, TypeEnum, User, + UserGroupsItem, ValidationProblemSource, WarningValidationProblem, WebhookReceiver, @@ -151,6 +156,7 @@ "CommonModelScopesBodyRequest": ".types", "CompletedAccountInitialScreenEnum": ".types", "Conversation": ".types", + "ConversationMembersItem": ".types", "ConversationType": ".types", "ConversationsMembersListRequestExpand": ".resources", "DataPassthroughRequest": ".types", @@ -175,6 +181,7 @@ "FieldPermissionDeserializer": ".types", "FieldPermissionDeserializerRequest": ".types", "Group": ".types", + "GroupUsersItem": ".types", "IndividualCommonModelScopeDeserializer": ".types", "IndividualCommonModelScopeDeserializerRequest": ".types", "Issue": ".types", @@ -186,6 +193,8 @@ "LinkToken": ".types", "LinkedAccountsListRequestCategory": ".resources", "Member": ".types", + "MemberGroup": ".types", + "MemberUser": ".types", "Message": ".types", "MessagesListRequestOrderBy": ".resources", "MessagesRepliesListRequestOrderBy": ".resources", @@ -223,6 +232,7 @@ "SyncStatusStatus": ".types", "TypeEnum": ".types", "User": ".types", + "UserGroupsItem": ".types", "ValidationProblemSource": ".types", "WarningValidationProblem": ".types", "WebhookReceiver": ".types", @@ -292,6 +302,7 @@ def __dir__(): "CommonModelScopesBodyRequest", "CompletedAccountInitialScreenEnum", "Conversation", + "ConversationMembersItem", "ConversationType", "ConversationsMembersListRequestExpand", "DataPassthroughRequest", @@ -316,6 +327,7 @@ def __dir__(): "FieldPermissionDeserializer", "FieldPermissionDeserializerRequest", "Group", + "GroupUsersItem", "IndividualCommonModelScopeDeserializer", "IndividualCommonModelScopeDeserializerRequest", "Issue", @@ -327,6 +339,8 @@ def __dir__(): "LinkToken", "LinkedAccountsListRequestCategory", "Member", + "MemberGroup", + "MemberUser", "Message", "MessagesListRequestOrderBy", "MessagesRepliesListRequestOrderBy", @@ -364,6 +378,7 @@ def __dir__(): "SyncStatusStatus", "TypeEnum", "User", + "UserGroupsItem", "ValidationProblemSource", "WarningValidationProblem", "WebhookReceiver", diff --git a/src/merge/resources/chat/types/__init__.py b/src/merge/resources/chat/types/__init__.py index 83dc82b8..20b12b7d 100644 --- a/src/merge/resources/chat/types/__init__.py +++ b/src/merge/resources/chat/types/__init__.py @@ -27,6 +27,7 @@ from .common_model_scopes_body_request import CommonModelScopesBodyRequest from .completed_account_initial_screen_enum import CompletedAccountInitialScreenEnum from .conversation import Conversation + from .conversation_members_item import ConversationMembersItem from .conversation_type import ConversationType from .data_passthrough_request import DataPassthroughRequest from .data_passthrough_request_method import DataPassthroughRequestMethod @@ -50,6 +51,7 @@ from .field_permission_deserializer import FieldPermissionDeserializer from .field_permission_deserializer_request import FieldPermissionDeserializerRequest from .group import Group + from .group_users_item import GroupUsersItem from .individual_common_model_scope_deserializer import IndividualCommonModelScopeDeserializer from .individual_common_model_scope_deserializer_request import IndividualCommonModelScopeDeserializerRequest from .issue import Issue @@ -59,6 +61,8 @@ from .last_sync_result_enum import LastSyncResultEnum from .link_token import LinkToken from .member import Member + from .member_group import MemberGroup + from .member_user import MemberUser from .message import Message from .method_enum import MethodEnum from .model_operation import ModelOperation @@ -94,6 +98,7 @@ from .sync_status_status import SyncStatusStatus from .type_enum import TypeEnum from .user import User + from .user_groups_item import UserGroupsItem from .validation_problem_source import ValidationProblemSource from .warning_validation_problem import WarningValidationProblem from .webhook_receiver import WebhookReceiver @@ -119,6 +124,7 @@ "CommonModelScopesBodyRequest": ".common_model_scopes_body_request", "CompletedAccountInitialScreenEnum": ".completed_account_initial_screen_enum", "Conversation": ".conversation", + "ConversationMembersItem": ".conversation_members_item", "ConversationType": ".conversation_type", "DataPassthroughRequest": ".data_passthrough_request", "DataPassthroughRequestMethod": ".data_passthrough_request_method", @@ -140,6 +146,7 @@ "FieldPermissionDeserializer": ".field_permission_deserializer", "FieldPermissionDeserializerRequest": ".field_permission_deserializer_request", "Group": ".group", + "GroupUsersItem": ".group_users_item", "IndividualCommonModelScopeDeserializer": ".individual_common_model_scope_deserializer", "IndividualCommonModelScopeDeserializerRequest": ".individual_common_model_scope_deserializer_request", "Issue": ".issue", @@ -149,6 +156,8 @@ "LastSyncResultEnum": ".last_sync_result_enum", "LinkToken": ".link_token", "Member": ".member", + "MemberGroup": ".member_group", + "MemberUser": ".member_user", "Message": ".message", "MethodEnum": ".method_enum", "ModelOperation": ".model_operation", @@ -184,6 +193,7 @@ "SyncStatusStatus": ".sync_status_status", "TypeEnum": ".type_enum", "User": ".user", + "UserGroupsItem": ".user_groups_item", "ValidationProblemSource": ".validation_problem_source", "WarningValidationProblem": ".warning_validation_problem", "WebhookReceiver": ".webhook_receiver", @@ -231,6 +241,7 @@ def __dir__(): "CommonModelScopesBodyRequest", "CompletedAccountInitialScreenEnum", "Conversation", + "ConversationMembersItem", "ConversationType", "DataPassthroughRequest", "DataPassthroughRequestMethod", @@ -252,6 +263,7 @@ def __dir__(): "FieldPermissionDeserializer", "FieldPermissionDeserializerRequest", "Group", + "GroupUsersItem", "IndividualCommonModelScopeDeserializer", "IndividualCommonModelScopeDeserializerRequest", "Issue", @@ -261,6 +273,8 @@ def __dir__(): "LastSyncResultEnum", "LinkToken", "Member", + "MemberGroup", + "MemberUser", "Message", "MethodEnum", "ModelOperation", @@ -296,6 +310,7 @@ def __dir__(): "SyncStatusStatus", "TypeEnum", "User", + "UserGroupsItem", "ValidationProblemSource", "WarningValidationProblem", "WebhookReceiver", diff --git a/src/merge/resources/chat/types/conversation.py b/src/merge/resources/chat/types/conversation.py index 402823ad..d022614d 100644 --- a/src/merge/resources/chat/types/conversation.py +++ b/src/merge/resources/chat/types/conversation.py @@ -1,11 +1,14 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import datetime as dt import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel +from .conversation_members_item import ConversationMembersItem from .conversation_type import ConversationType from .remote_data import RemoteData @@ -59,9 +62,12 @@ class Conversation(UncheckedBaseModel): * `PRIVATE_EXTERNAL` - PRIVATE_EXTERNAL * `PUBLIC_INTERNAL` - PUBLIC_INTERNAL * `PUBLIC_EXTERNAL` - PUBLIC_EXTERNAL + * `ONE_ON_ONE_CHAT` - ONE_ON_ONE_CHAT + * `GROUP_CHAT` - GROUP_CHAT + * `MEETING_CHAT` - MEETING_CHAT """ - members: typing.Optional[typing.List[typing.Optional[str]]] = None + members: typing.Optional[typing.List[typing.Optional[ConversationMembersItem]]] = None remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's conversation was created. @@ -88,3 +94,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .group import Group # noqa: E402, F401, I001 +from .user import User # noqa: E402, F401, I001 + +update_forward_refs(Conversation) diff --git a/src/merge/resources/chat/types/conversation_members_item.py b/src/merge/resources/chat/types/conversation_members_item.py new file mode 100644 index 00000000..6da9eeeb --- /dev/null +++ b/src/merge/resources/chat/types/conversation_members_item.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .member import Member + +ConversationMembersItem = typing.Union[str, Member] diff --git a/src/merge/resources/chat/types/group.py b/src/merge/resources/chat/types/group.py index 732616f4..e1fa1539 100644 --- a/src/merge/resources/chat/types/group.py +++ b/src/merge/resources/chat/types/group.py @@ -1,10 +1,12 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import datetime as dt import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .remote_data import RemoteData @@ -39,7 +41,7 @@ class Group(UncheckedBaseModel): The name of the Group """ - users: typing.Optional[typing.List[typing.Optional[str]]] = None + users: typing.Optional[typing.List[typing.Optional["GroupUsersItem"]]] = None remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) """ When the third party's group was created. @@ -66,3 +68,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .user import User # noqa: E402, F401, I001 +from .group_users_item import GroupUsersItem # noqa: E402, F401, I001 + +update_forward_refs(Group) diff --git a/src/merge/resources/chat/types/group_users_item.py b/src/merge/resources/chat/types/group_users_item.py new file mode 100644 index 00000000..fe387a9a --- /dev/null +++ b/src/merge/resources/chat/types/group_users_item.py @@ -0,0 +1,9 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations + +import typing + +if typing.TYPE_CHECKING: + from .user import User +GroupUsersItem = typing.Union[str, "User"] diff --git a/src/merge/resources/chat/types/member.py b/src/merge/resources/chat/types/member.py index 40bea7ed..d859dc14 100644 --- a/src/merge/resources/chat/types/member.py +++ b/src/merge/resources/chat/types/member.py @@ -1,11 +1,15 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import datetime as dt import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel +from .member_group import MemberGroup +from .member_user import MemberUser from .remote_data import RemoteData @@ -35,12 +39,12 @@ class Member(UncheckedBaseModel): The datetime that this object was modified by Merge. """ - user: typing.Optional[str] = pydantic.Field(default=None) + user: typing.Optional[MemberUser] = pydantic.Field(default=None) """ The user that is a member of the conversation. Only populated if the member is a user. """ - group: typing.Optional[str] = pydantic.Field(default=None) + group: typing.Optional[MemberGroup] = pydantic.Field(default=None) """ The group that is a member of the conversation. Only populated if the member is a group. """ @@ -71,3 +75,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .group import Group # noqa: E402, F401, I001 +from .user import User # noqa: E402, F401, I001 + +update_forward_refs(Member) diff --git a/src/merge/resources/chat/types/member_group.py b/src/merge/resources/chat/types/member_group.py new file mode 100644 index 00000000..89decf28 --- /dev/null +++ b/src/merge/resources/chat/types/member_group.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .group import Group + +MemberGroup = typing.Union[str, Group] diff --git a/src/merge/resources/chat/types/member_user.py b/src/merge/resources/chat/types/member_user.py new file mode 100644 index 00000000..6a766ce3 --- /dev/null +++ b/src/merge/resources/chat/types/member_user.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .user import User + +MemberUser = typing.Union[str, User] diff --git a/src/merge/resources/chat/types/paginated_conversation_list.py b/src/merge/resources/chat/types/paginated_conversation_list.py index 66ae6ad4..3b95e565 100644 --- a/src/merge/resources/chat/types/paginated_conversation_list.py +++ b/src/merge/resources/chat/types/paginated_conversation_list.py @@ -1,9 +1,11 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .conversation import Conversation @@ -21,3 +23,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .group import Group # noqa: E402, F401, I001 +from .user import User # noqa: E402, F401, I001 + +update_forward_refs(PaginatedConversationList) diff --git a/src/merge/resources/chat/types/paginated_group_list.py b/src/merge/resources/chat/types/paginated_group_list.py index 90702e1f..1405b628 100644 --- a/src/merge/resources/chat/types/paginated_group_list.py +++ b/src/merge/resources/chat/types/paginated_group_list.py @@ -1,17 +1,18 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel -from .group import Group class PaginatedGroupList(UncheckedBaseModel): next: typing.Optional[str] = None previous: typing.Optional[str] = None - results: typing.Optional[typing.List[Group]] = None + results: typing.Optional[typing.List["Group"]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 @@ -21,3 +22,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .group import Group # noqa: E402, F401, I001 +from .user import User # noqa: E402, F401, I001 + +update_forward_refs(PaginatedGroupList) diff --git a/src/merge/resources/chat/types/paginated_member_list.py b/src/merge/resources/chat/types/paginated_member_list.py index 97a567c2..d3071471 100644 --- a/src/merge/resources/chat/types/paginated_member_list.py +++ b/src/merge/resources/chat/types/paginated_member_list.py @@ -1,9 +1,11 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .member import Member @@ -21,3 +23,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .group import Group # noqa: E402, F401, I001 +from .user import User # noqa: E402, F401, I001 + +update_forward_refs(PaginatedMemberList) diff --git a/src/merge/resources/chat/types/paginated_user_list.py b/src/merge/resources/chat/types/paginated_user_list.py index 809b285c..b7efd863 100644 --- a/src/merge/resources/chat/types/paginated_user_list.py +++ b/src/merge/resources/chat/types/paginated_user_list.py @@ -1,17 +1,18 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel -from .user import User class PaginatedUserList(UncheckedBaseModel): next: typing.Optional[str] = None previous: typing.Optional[str] = None - results: typing.Optional[typing.List[User]] = None + results: typing.Optional[typing.List["User"]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 @@ -21,3 +22,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .group import Group # noqa: E402, F401, I001 +from .user import User # noqa: E402, F401, I001 + +update_forward_refs(PaginatedUserList) diff --git a/src/merge/resources/chat/types/type_enum.py b/src/merge/resources/chat/types/type_enum.py index 37cdd1ef..6d258d7f 100644 --- a/src/merge/resources/chat/types/type_enum.py +++ b/src/merge/resources/chat/types/type_enum.py @@ -12,12 +12,18 @@ class TypeEnum(str, enum.Enum): * `PRIVATE_EXTERNAL` - PRIVATE_EXTERNAL * `PUBLIC_INTERNAL` - PUBLIC_INTERNAL * `PUBLIC_EXTERNAL` - PUBLIC_EXTERNAL + * `ONE_ON_ONE_CHAT` - ONE_ON_ONE_CHAT + * `GROUP_CHAT` - GROUP_CHAT + * `MEETING_CHAT` - MEETING_CHAT """ PRIVATE_INTERNAL = "PRIVATE_INTERNAL" PRIVATE_EXTERNAL = "PRIVATE_EXTERNAL" PUBLIC_INTERNAL = "PUBLIC_INTERNAL" PUBLIC_EXTERNAL = "PUBLIC_EXTERNAL" + ONE_ON_ONE_CHAT = "ONE_ON_ONE_CHAT" + GROUP_CHAT = "GROUP_CHAT" + MEETING_CHAT = "MEETING_CHAT" def visit( self, @@ -25,6 +31,9 @@ def visit( private_external: typing.Callable[[], T_Result], public_internal: typing.Callable[[], T_Result], public_external: typing.Callable[[], T_Result], + one_on_one_chat: typing.Callable[[], T_Result], + group_chat: typing.Callable[[], T_Result], + meeting_chat: typing.Callable[[], T_Result], ) -> T_Result: if self is TypeEnum.PRIVATE_INTERNAL: return private_internal() @@ -34,3 +43,9 @@ def visit( return public_internal() if self is TypeEnum.PUBLIC_EXTERNAL: return public_external() + if self is TypeEnum.ONE_ON_ONE_CHAT: + return one_on_one_chat() + if self is TypeEnum.GROUP_CHAT: + return group_chat() + if self is TypeEnum.MEETING_CHAT: + return meeting_chat() diff --git a/src/merge/resources/chat/types/user.py b/src/merge/resources/chat/types/user.py index 28eb5802..259dac10 100644 --- a/src/merge/resources/chat/types/user.py +++ b/src/merge/resources/chat/types/user.py @@ -1,10 +1,12 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import datetime as dt import typing import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs from ....core.unchecked_base_model import UncheckedBaseModel from .remote_data import RemoteData @@ -60,7 +62,7 @@ class User(UncheckedBaseModel): Returns true if the user is a bot """ - groups: typing.Optional[typing.List[typing.Optional[str]]] = None + groups: typing.Optional[typing.List[typing.Optional["UserGroupsItem"]]] = None avatar: typing.Optional[str] = pydantic.Field(default=None) """ The user's avatar image @@ -92,3 +94,9 @@ class Config: frozen = True smart_union = True extra = pydantic.Extra.allow + + +from .group import Group # noqa: E402, F401, I001 +from .user_groups_item import UserGroupsItem # noqa: E402, F401, I001 + +update_forward_refs(User) diff --git a/src/merge/resources/chat/types/user_groups_item.py b/src/merge/resources/chat/types/user_groups_item.py new file mode 100644 index 00000000..9f985386 --- /dev/null +++ b/src/merge/resources/chat/types/user_groups_item.py @@ -0,0 +1,9 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations + +import typing + +if typing.TYPE_CHECKING: + from .group import Group +UserGroupsItem = typing.Union[str, "Group"] diff --git a/src/merge/resources/filestorage/types/drive.py b/src/merge/resources/filestorage/types/drive.py index c0f931ee..50a5f2bf 100644 --- a/src/merge/resources/filestorage/types/drive.py +++ b/src/merge/resources/filestorage/types/drive.py @@ -49,11 +49,6 @@ class Drive(UncheckedBaseModel): The drive's url. """ - size: typing.Optional[int] = pydantic.Field(default=None) - """ - The drive's size, in bytes. - """ - remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None) """ Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).