mergepythonclient 2.3.2__py3-none-any.whl → 2.5.0__py3-none-any.whl

merge/resources/ticketing/resources/collections/client.py

@@ -9,6 +9,7 @@ from ...types.collection import Collection
 from ...types.paginated_collection_list import PaginatedCollectionList
 from ...types.paginated_viewer_list import PaginatedViewerList
 from .raw_client import AsyncRawCollectionsClient, RawCollectionsClient
+from .types.collections_list_request_collection_type import CollectionsListRequestCollectionType
 from .types.collections_viewers_list_request_expand import CollectionsViewersListRequestExpand
 
 
@@ -30,7 +31,7 @@ class CollectionsClient:
     def list(
         self,
         *,
-        collection_type: typing.Optional[str] = None,
+        collection_type: typing.Optional[CollectionsListRequestCollectionType] = None,
         created_after: typing.Optional[dt.datetime] = None,
         created_before: typing.Optional[dt.datetime] = None,
         cursor: typing.Optional[str] = None,
@@ -53,7 +54,7 @@ class CollectionsClient:
 
         Parameters
         ----------
-        collection_type : typing.Optional[str]
+        collection_type : typing.Optional[CollectionsListRequestCollectionType]
             If provided, will only return collections of the given type.
 
         created_after : typing.Optional[dt.datetime]
@@ -87,7 +88,7 @@ class CollectionsClient:
             If provided, will only return collections with this name.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         parent_collection_id : typing.Optional[str]
             If provided, will only return collections whose parent collection matches the given id.
@@ -111,14 +112,39 @@ class CollectionsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.ticketing.resources.collections import (
+            CollectionsListRequestCollectionType,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.ticketing.collections.list(
+            collection_type=CollectionsListRequestCollectionType.EMPTY,
+            created_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            created_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            modified_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            modified_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            name="name",
+            page_size=1,
+            parent_collection_id="parent_collection_id",
+            remote_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -190,6 +216,9 @@ class CollectionsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.ticketing.resources.collections import (
+            CollectionsViewersListRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -198,6 +227,11 @@ class CollectionsClient:
         client.ticketing.collections.viewers_list(
             collection_id="collection_id",
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            expand=CollectionsViewersListRequestExpand.TEAM,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            page_size=1,
         )
         """
         _response = self._raw_client.viewers_list(
@@ -263,6 +297,8 @@ class CollectionsClient:
         )
         client.ticketing.collections.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -295,7 +331,7 @@ class AsyncCollectionsClient:
     async def list(
         self,
         *,
-        collection_type: typing.Optional[str] = None,
+        collection_type: typing.Optional[CollectionsListRequestCollectionType] = None,
         created_after: typing.Optional[dt.datetime] = None,
         created_before: typing.Optional[dt.datetime] = None,
         cursor: typing.Optional[str] = None,
@@ -318,7 +354,7 @@ class AsyncCollectionsClient:
 
         Parameters
         ----------
-        collection_type : typing.Optional[str]
+        collection_type : typing.Optional[CollectionsListRequestCollectionType]
             If provided, will only return collections of the given type.
 
         created_after : typing.Optional[dt.datetime]
@@ -352,7 +388,7 @@ class AsyncCollectionsClient:
             If provided, will only return collections with this name.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         parent_collection_id : typing.Optional[str]
             If provided, will only return collections whose parent collection matches the given id.
@@ -377,8 +413,12 @@ class AsyncCollectionsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.ticketing.resources.collections import (
+            CollectionsListRequestCollectionType,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -388,7 +428,27 @@ class AsyncCollectionsClient:
 
         async def main() -> None:
             await client.ticketing.collections.list(
+                collection_type=CollectionsListRequestCollectionType.EMPTY,
+                created_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                created_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                modified_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                modified_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                name="name",
+                page_size=1,
+                parent_collection_id="parent_collection_id",
+                remote_id="remote_id",
             )
 
 
@@ -465,6 +525,9 @@ class AsyncCollectionsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.ticketing.resources.collections import (
+            CollectionsViewersListRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -476,6 +539,11 @@ class AsyncCollectionsClient:
             await client.ticketing.collections.viewers_list(
                 collection_id="collection_id",
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                expand=CollectionsViewersListRequestExpand.TEAM,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                page_size=1,
             )
 
 
@@ -549,6 +617,8 @@ class AsyncCollectionsClient:
         async def main() -> None:
             await client.ticketing.collections.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/ticketing/resources/collections/raw_client.py

@@ -14,6 +14,7 @@ from .....core.unchecked_base_model import construct_type
 from ...types.collection import Collection
 from ...types.paginated_collection_list import PaginatedCollectionList
 from ...types.paginated_viewer_list import PaginatedViewerList
+from .types.collections_list_request_collection_type import CollectionsListRequestCollectionType
 from .types.collections_viewers_list_request_expand import CollectionsViewersListRequestExpand
 
 
@@ -24,7 +25,7 @@ class RawCollectionsClient:
     def list(
         self,
         *,
-        collection_type: typing.Optional[str] = None,
+        collection_type: typing.Optional[CollectionsListRequestCollectionType] = None,
         created_after: typing.Optional[dt.datetime] = None,
         created_before: typing.Optional[dt.datetime] = None,
         cursor: typing.Optional[str] = None,
@@ -47,7 +48,7 @@ class RawCollectionsClient:
 
         Parameters
         ----------
-        collection_type : typing.Optional[str]
+        collection_type : typing.Optional[CollectionsListRequestCollectionType]
             If provided, will only return collections of the given type.
 
         created_after : typing.Optional[dt.datetime]
@@ -81,7 +82,7 @@ class RawCollectionsClient:
             If provided, will only return collections with this name.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         parent_collection_id : typing.Optional[str]
             If provided, will only return collections whose parent collection matches the given id.
@@ -290,7 +291,7 @@ class AsyncRawCollectionsClient:
     async def list(
         self,
         *,
-        collection_type: typing.Optional[str] = None,
+        collection_type: typing.Optional[CollectionsListRequestCollectionType] = None,
         created_after: typing.Optional[dt.datetime] = None,
         created_before: typing.Optional[dt.datetime] = None,
         cursor: typing.Optional[str] = None,
@@ -313,7 +314,7 @@ class AsyncRawCollectionsClient:
 
         Parameters
         ----------
-        collection_type : typing.Optional[str]
+        collection_type : typing.Optional[CollectionsListRequestCollectionType]
             If provided, will only return collections of the given type.
 
         created_after : typing.Optional[dt.datetime]
@@ -347,7 +348,7 @@ class AsyncRawCollectionsClient:
             If provided, will only return collections with this name.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         parent_collection_id : typing.Optional[str]
             If provided, will only return collections whose parent collection matches the given id.

merge/resources/ticketing/resources/collections/types/__init__.py

@@ -6,9 +6,11 @@ import typing
 from importlib import import_module
 
 if typing.TYPE_CHECKING:
+    from .collections_list_request_collection_type import CollectionsListRequestCollectionType
     from .collections_viewers_list_request_expand import CollectionsViewersListRequestExpand
 _dynamic_imports: typing.Dict[str, str] = {
-    "CollectionsViewersListRequestExpand": ".collections_viewers_list_request_expand"
+    "CollectionsListRequestCollectionType": ".collections_list_request_collection_type",
+    "CollectionsViewersListRequestExpand": ".collections_viewers_list_request_expand",
 }
 
 
@@ -31,4 +33,4 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["CollectionsViewersListRequestExpand"]
+__all__ = ["CollectionsListRequestCollectionType", "CollectionsViewersListRequestExpand"]

merge/resources/ticketing/resources/collections/types/collections_list_request_collection_type.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class CollectionsListRequestCollectionType(str, enum.Enum):
+    EMPTY = ""
+    LIST = "LIST"
+    PROJECT = "PROJECT"
+
+    def visit(
+        self,
+        empty: typing.Callable[[], T_Result],
+        list_: typing.Callable[[], T_Result],
+        project: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is CollectionsListRequestCollectionType.EMPTY:
+            return empty()
+        if self is CollectionsListRequestCollectionType.LIST:
+            return list_()
+        if self is CollectionsListRequestCollectionType.PROJECT:
+            return project()

merge/resources/ticketing/resources/comments/client.py

@@ -84,7 +84,7 @@ class CommentsClient:
             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_created_after : typing.Optional[dt.datetime]
             If provided, will only return Comments created in the third party platform after this datetime.
@@ -105,14 +105,41 @@ class CommentsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.ticketing.resources.comments import (
+            CommentsListRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.ticketing.comments.list(
+            created_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            created_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            expand=CommentsListRequestExpand.CONTACT,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            modified_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            modified_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            page_size=1,
+            remote_created_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            remote_id="remote_id",
+            ticket_id="ticket_id",
         )
         """
         _response = self._raw_client.list(
@@ -172,6 +199,8 @@ class CommentsClient:
             api_key="YOUR_API_KEY",
         )
         client.ticketing.comments.create(
+            is_debug_mode=True,
+            run_async=True,
             model=CommentRequest(),
         )
         """
@@ -216,6 +245,9 @@ class CommentsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.ticketing.resources.comments import (
+            CommentsRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -223,6 +255,9 @@ class CommentsClient:
         )
         client.ticketing.comments.retrieve(
             id="id",
+            expand=CommentsRetrieveRequestExpand.CONTACT,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -328,7 +363,7 @@ class AsyncCommentsClient:
             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_created_after : typing.Optional[dt.datetime]
             If provided, will only return Comments created in the third party platform after this datetime.
@@ -350,8 +385,12 @@ class AsyncCommentsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.ticketing.resources.comments import (
+            CommentsListRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -361,7 +400,29 @@ class AsyncCommentsClient:
 
         async def main() -> None:
             await client.ticketing.comments.list(
+                created_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                created_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                expand=CommentsListRequestExpand.CONTACT,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                modified_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                modified_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                page_size=1,
+                remote_created_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                remote_id="remote_id",
+                ticket_id="ticket_id",
             )
 
 
@@ -429,6 +490,8 @@ class AsyncCommentsClient:
 
         async def main() -> None:
             await client.ticketing.comments.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=CommentRequest(),
             )
 
@@ -478,6 +541,9 @@ class AsyncCommentsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.ticketing.resources.comments import (
+            CommentsRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -488,6 +554,9 @@ class AsyncCommentsClient:
         async def main() -> None:
             await client.ticketing.comments.retrieve(
                 id="id",
+                expand=CommentsRetrieveRequestExpand.CONTACT,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/ticketing/resources/comments/raw_client.py

@@ -78,7 +78,7 @@ class RawCommentsClient:
             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_created_after : typing.Optional[dt.datetime]
             If provided, will only return Comments created in the third party platform after this datetime.
@@ -344,7 +344,7 @@ class AsyncRawCommentsClient:
             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_created_after : typing.Optional[dt.datetime]
             If provided, will only return Comments created in the third party platform after this datetime.

merge/resources/ticketing/resources/contacts/client.py

@@ -84,7 +84,7 @@ class ContactsClient:
             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,6 +99,8 @@ class ContactsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -106,7 +108,25 @@ class ContactsClient:
             api_key="YOUR_API_KEY",
         )
         client.ticketing.contacts.list(
+            created_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            created_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            email_address="email_address",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            modified_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            modified_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            page_size=1,
+            remote_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -165,6 +185,8 @@ class ContactsClient:
             api_key="YOUR_API_KEY",
         )
         client.ticketing.contacts.create(
+            is_debug_mode=True,
+            run_async=True,
             model=ContactRequest(),
         )
         """
@@ -216,6 +238,8 @@ class ContactsClient:
         )
         client.ticketing.contacts.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -323,7 +347,7 @@ class AsyncContactsClient:
             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.
@@ -339,6 +363,7 @@ class AsyncContactsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -350,7 +375,25 @@ class AsyncContactsClient:
 
         async def main() -> None:
             await client.ticketing.contacts.list(
+                created_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                created_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                email_address="email_address",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                modified_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                modified_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                page_size=1,
+                remote_id="remote_id",
             )
 
 
@@ -417,6 +460,8 @@ class AsyncContactsClient:
 
         async def main() -> None:
             await client.ticketing.contacts.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=ContactRequest(),
             )
 
@@ -476,6 +521,8 @@ class AsyncContactsClient:
         async def main() -> None:
             await client.ticketing.contacts.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/ticketing/resources/contacts/raw_client.py

@@ -78,7 +78,7 @@ class RawContactsClient:
             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.
@@ -337,7 +337,7 @@ class AsyncRawContactsClient:
             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.