mergepythonclient 2.4.0__py3-none-any.whl → 2.6.0__py3-none-any.whl

merge/resources/ticketing/resources/users/client.py

@@ -81,7 +81,7 @@ class UsersClient:
             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.
+            Number of results to return per page. The maximum limit is 100.
 
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.
@@ -99,14 +99,37 @@ class UsersClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.ticketing.resources.users import UsersListRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.ticketing.users.list(
+            created_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            created_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            email_address="email_address",
+            expand=UsersListRequestExpand.ROLES,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            modified_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            modified_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            page_size=1,
+            remote_id="remote_id",
+            team="team",
         )
         """
         _response = self._raw_client.list(
@@ -163,6 +186,7 @@ class UsersClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.ticketing.resources.users import UsersRetrieveRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -170,6 +194,9 @@ class UsersClient:
         )
         client.ticketing.users.retrieve(
             id="id",
+            expand=UsersRetrieveRequestExpand.ROLES,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -251,7 +278,7 @@ class AsyncUsersClient:
             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.
+            Number of results to return per page. The maximum limit is 100.
 
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.
@@ -270,8 +297,10 @@ class AsyncUsersClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.ticketing.resources.users import UsersListRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -281,7 +310,27 @@ class AsyncUsersClient:
 
         async def main() -> None:
             await client.ticketing.users.list(
+                created_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                created_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                email_address="email_address",
+                expand=UsersListRequestExpand.ROLES,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                modified_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                modified_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                page_size=1,
+                remote_id="remote_id",
+                team="team",
             )
 
 
@@ -343,6 +392,7 @@ class AsyncUsersClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.ticketing.resources.users import UsersRetrieveRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -353,6 +403,9 @@ class AsyncUsersClient:
         async def main() -> None:
             await client.ticketing.users.retrieve(
                 id="id",
+                expand=UsersRetrieveRequestExpand.ROLES,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/ticketing/resources/users/raw_client.py

@@ -75,7 +75,7 @@ class RawUsersClient:
             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.
+            Number of results to return per page. The maximum limit is 100.
 
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.
@@ -243,7 +243,7 @@ class AsyncRawUsersClient:
             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.
+            Number of results to return per page. The maximum limit is 100.
 
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.

merge/resources/ticketing/types/__init__.py

@@ -45,6 +45,7 @@ if typing.TYPE_CHECKING:
     from .comment_user import CommentUser
     from .common_model_scope_api import CommonModelScopeApi
     from .common_model_scopes_body_request import CommonModelScopesBodyRequest
+    from .completed_account_initial_screen_enum import CompletedAccountInitialScreenEnum
     from .contact import Contact
     from .contact_account import ContactAccount
     from .contact_request import ContactRequest
@@ -219,6 +220,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "CommentUser": ".comment_user",
     "CommonModelScopeApi": ".common_model_scope_api",
     "CommonModelScopesBodyRequest": ".common_model_scopes_body_request",
+    "CompletedAccountInitialScreenEnum": ".completed_account_initial_screen_enum",
     "Contact": ".contact",
     "ContactAccount": ".contact_account",
     "ContactRequest": ".contact_request",
@@ -413,6 +415,7 @@ __all__ = [
     "CommentUser",
     "CommonModelScopeApi",
     "CommonModelScopesBodyRequest",
+    "CompletedAccountInitialScreenEnum",
     "Contact",
     "ContactAccount",
     "ContactRequest",

merge/resources/ticketing/types/categories_enum.py

@@ -15,6 +15,7 @@ class CategoriesEnum(str, enum.Enum):
     * `crm` - crm
     * `mktg` - mktg
     * `filestorage` - filestorage
+    * `knowledgebase` - knowledgebase
     """
 
     HRIS = "hris"
@@ -24,6 +25,7 @@ class CategoriesEnum(str, enum.Enum):
     CRM = "crm"
     MKTG = "mktg"
     FILESTORAGE = "filestorage"
+    KNOWLEDGEBASE = "knowledgebase"
 
     def visit(
         self,
@@ -34,6 +36,7 @@ class CategoriesEnum(str, enum.Enum):
         crm: typing.Callable[[], T_Result],
         mktg: typing.Callable[[], T_Result],
         filestorage: typing.Callable[[], T_Result],
+        knowledgebase: typing.Callable[[], T_Result],
     ) -> T_Result:
         if self is CategoriesEnum.HRIS:
             return hris()
@@ -49,3 +52,5 @@ class CategoriesEnum(str, enum.Enum):
             return mktg()
         if self is CategoriesEnum.FILESTORAGE:
             return filestorage()
+        if self is CategoriesEnum.KNOWLEDGEBASE:
+            return knowledgebase()

merge/resources/ticketing/types/category_enum.py

@@ -15,6 +15,7 @@ class CategoryEnum(str, enum.Enum):
     * `crm` - crm
     * `mktg` - mktg
     * `filestorage` - filestorage
+    * `knowledgebase` - knowledgebase
     """
 
     HRIS = "hris"
@@ -24,6 +25,7 @@ class CategoryEnum(str, enum.Enum):
     CRM = "crm"
     MKTG = "mktg"
     FILESTORAGE = "filestorage"
+    KNOWLEDGEBASE = "knowledgebase"
 
     def visit(
         self,
@@ -34,6 +36,7 @@ class CategoryEnum(str, enum.Enum):
         crm: typing.Callable[[], T_Result],
         mktg: typing.Callable[[], T_Result],
         filestorage: typing.Callable[[], T_Result],
+        knowledgebase: typing.Callable[[], T_Result],
     ) -> T_Result:
         if self is CategoryEnum.HRIS:
             return hris()
@@ -49,3 +52,5 @@ class CategoryEnum(str, enum.Enum):
             return mktg()
         if self is CategoryEnum.FILESTORAGE:
             return filestorage()
+        if self is CategoryEnum.KNOWLEDGEBASE:
+            return knowledgebase()

merge/resources/ticketing/types/completed_account_initial_screen_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CompletedAccountInitialScreenEnum = typing.Literal["SELECTIVE_SYNC"]

merge/resources/ticketing/types/field_mapping_api_instance.py

@@ -14,6 +14,7 @@ class FieldMappingApiInstance(UncheckedBaseModel):
     is_integration_wide: typing.Optional[bool] = None
     target_field: typing.Optional[FieldMappingApiInstanceTargetField] = None
     remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] = None
+    jmes_path: typing.Optional[str] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

{mergepythonclient-2.4.0.dist-info → mergepythonclient-2.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mergepythonclient
-Version: 2.4.0
+Version: 2.6.0
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers
@@ -31,6 +31,25 @@ Description-Content-Type: text/markdown
 
 The Merge Python library provides convenient access to the Merge APIs from Python.
 
+## Table of Contents
+
+- [Documentation](#documentation)
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Instantiation](#instantiation)
+- [Categories](#categories)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+- [File Download](#file-download)
+- [Pagination](#pagination)
+
 ## Documentation
 
 API reference documentation is available [here](https://docs.merge.dev/).
@@ -58,6 +77,8 @@ client = Merge(
     api_key="YOUR_API_KEY",
 )
 client.ats.activities.create(
+    is_debug_mode=True,
+    run_async=True,
     model=ActivityRequest(),
     remote_user_id="remote_user_id",
 )
@@ -104,6 +125,8 @@ client = AsyncMerge(
 
 async def main() -> None:
     await client.ats.activities.create(
+        is_debug_mode=True,
+        run_async=True,
         model=ActivityRequest(),
         remote_user_id="remote_user_id",
     )
@@ -262,3 +285,5 @@ while response.next is not None:
 
 
 
+
+