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

merge/resources/knowledgebase/resources/articles/client.py

@@ -9,6 +9,7 @@ from ...types.article import Article
 from ...types.paginated_article_list import PaginatedArticleList
 from .raw_client import AsyncRawArticlesClient, RawArticlesClient
 from .types.articles_list_request_expand import ArticlesListRequestExpand
+from .types.articles_list_request_type import ArticlesListRequestType
 from .types.articles_retrieve_request_expand import ArticlesRetrieveRequestExpand
 
 
@@ -43,7 +44,9 @@ class ArticlesClient:
         parent_article_id: typing.Optional[str] = None,
         parent_container_id: typing.Optional[str] = None,
         remote_id: typing.Optional[str] = None,
-        type: typing.Optional[str] = None,
+        root_container_id: typing.Optional[str] = None,
+        status: typing.Optional[str] = None,
+        type: typing.Optional[ArticlesListRequestType] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> PaginatedArticleList:
         """
@@ -79,7 +82,7 @@ class ArticlesClient:
             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.
 
         parent_article_id : typing.Optional[str]
             If provided, will only return sub articles of the parent_article_id.
@@ -90,7 +93,13 @@ class ArticlesClient:
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.
 
-        type : typing.Optional[str]
+        root_container_id : typing.Optional[str]
+            If provided, will only return sub articles of the root_container_id.
+
+        status : typing.Optional[str]
+            If provided, will only return articles of the given status; multiple statuses can be separated by commas.
+
+        type : typing.Optional[ArticlesListRequestType]
             If provided, will only return articles of the given type.
 
         request_options : typing.Optional[RequestOptions]
@@ -103,14 +112,43 @@ class ArticlesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.knowledgebase.resources.articles import (
+            ArticlesListRequestExpand,
+            ArticlesListRequestType,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.knowledgebase.articles.list(
+            created_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            created_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            expand=ArticlesListRequestExpand.ATTACHMENTS,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            modified_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            modified_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            page_size=1,
+            parent_article_id="parent_article_id",
+            parent_container_id="parent_container_id",
+            remote_id="remote_id",
+            root_container_id="root_container_id",
+            status="status",
+            type=ArticlesListRequestType.EMPTY,
         )
         """
         _response = self._raw_client.list(
@@ -127,6 +165,8 @@ class ArticlesClient:
             parent_article_id=parent_article_id,
             parent_container_id=parent_container_id,
             remote_id=remote_id,
+            root_container_id=root_container_id,
+            status=status,
             type=type,
             request_options=request_options,
         )
@@ -168,6 +208,9 @@ class ArticlesClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.knowledgebase.resources.articles import (
+            ArticlesRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -175,6 +218,9 @@ class ArticlesClient:
         )
         client.knowledgebase.articles.retrieve(
             id="id",
+            expand=ArticlesRetrieveRequestExpand.ATTACHMENTS,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -218,7 +264,9 @@ class AsyncArticlesClient:
         parent_article_id: typing.Optional[str] = None,
         parent_container_id: typing.Optional[str] = None,
         remote_id: typing.Optional[str] = None,
-        type: typing.Optional[str] = None,
+        root_container_id: typing.Optional[str] = None,
+        status: typing.Optional[str] = None,
+        type: typing.Optional[ArticlesListRequestType] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> PaginatedArticleList:
         """
@@ -254,7 +302,7 @@ class AsyncArticlesClient:
             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.
 
         parent_article_id : typing.Optional[str]
             If provided, will only return sub articles of the parent_article_id.
@@ -265,7 +313,13 @@ class AsyncArticlesClient:
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.
 
-        type : typing.Optional[str]
+        root_container_id : typing.Optional[str]
+            If provided, will only return sub articles of the root_container_id.
+
+        status : typing.Optional[str]
+            If provided, will only return articles of the given status; multiple statuses can be separated by commas.
+
+        type : typing.Optional[ArticlesListRequestType]
             If provided, will only return articles of the given type.
 
         request_options : typing.Optional[RequestOptions]
@@ -279,8 +333,13 @@ class AsyncArticlesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.knowledgebase.resources.articles import (
+            ArticlesListRequestExpand,
+            ArticlesListRequestType,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -290,7 +349,30 @@ class AsyncArticlesClient:
 
         async def main() -> None:
             await client.knowledgebase.articles.list(
+                created_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                created_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                expand=ArticlesListRequestExpand.ATTACHMENTS,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                modified_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                modified_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                page_size=1,
+                parent_article_id="parent_article_id",
+                parent_container_id="parent_container_id",
+                remote_id="remote_id",
+                root_container_id="root_container_id",
+                status="status",
+                type=ArticlesListRequestType.EMPTY,
             )
 
 
@@ -310,6 +392,8 @@ class AsyncArticlesClient:
             parent_article_id=parent_article_id,
             parent_container_id=parent_container_id,
             remote_id=remote_id,
+            root_container_id=root_container_id,
+            status=status,
             type=type,
             request_options=request_options,
         )
@@ -353,6 +437,9 @@ class AsyncArticlesClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.knowledgebase.resources.articles import (
+            ArticlesRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -363,6 +450,9 @@ class AsyncArticlesClient:
         async def main() -> None:
             await client.knowledgebase.articles.retrieve(
                 id="id",
+                expand=ArticlesRetrieveRequestExpand.ATTACHMENTS,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/knowledgebase/resources/articles/raw_client.py

@@ -14,6 +14,7 @@ from .....core.unchecked_base_model import construct_type
 from ...types.article import Article
 from ...types.paginated_article_list import PaginatedArticleList
 from .types.articles_list_request_expand import ArticlesListRequestExpand
+from .types.articles_list_request_type import ArticlesListRequestType
 from .types.articles_retrieve_request_expand import ArticlesRetrieveRequestExpand
 
 
@@ -37,7 +38,9 @@ class RawArticlesClient:
         parent_article_id: typing.Optional[str] = None,
         parent_container_id: typing.Optional[str] = None,
         remote_id: typing.Optional[str] = None,
-        type: typing.Optional[str] = None,
+        root_container_id: typing.Optional[str] = None,
+        status: typing.Optional[str] = None,
+        type: typing.Optional[ArticlesListRequestType] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[PaginatedArticleList]:
         """
@@ -73,7 +76,7 @@ class RawArticlesClient:
             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.
 
         parent_article_id : typing.Optional[str]
             If provided, will only return sub articles of the parent_article_id.
@@ -84,7 +87,13 @@ class RawArticlesClient:
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.
 
-        type : typing.Optional[str]
+        root_container_id : typing.Optional[str]
+            If provided, will only return sub articles of the root_container_id.
+
+        status : typing.Optional[str]
+            If provided, will only return articles of the given status; multiple statuses can be separated by commas.
+
+        type : typing.Optional[ArticlesListRequestType]
             If provided, will only return articles of the given type.
 
         request_options : typing.Optional[RequestOptions]
@@ -112,6 +121,8 @@ class RawArticlesClient:
                 "parent_article_id": parent_article_id,
                 "parent_container_id": parent_container_id,
                 "remote_id": remote_id,
+                "root_container_id": root_container_id,
+                "status": status,
                 "type": type,
             },
             request_options=request_options,
@@ -210,7 +221,9 @@ class AsyncRawArticlesClient:
         parent_article_id: typing.Optional[str] = None,
         parent_container_id: typing.Optional[str] = None,
         remote_id: typing.Optional[str] = None,
-        type: typing.Optional[str] = None,
+        root_container_id: typing.Optional[str] = None,
+        status: typing.Optional[str] = None,
+        type: typing.Optional[ArticlesListRequestType] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[PaginatedArticleList]:
         """
@@ -246,7 +259,7 @@ class AsyncRawArticlesClient:
             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.
 
         parent_article_id : typing.Optional[str]
             If provided, will only return sub articles of the parent_article_id.
@@ -257,7 +270,13 @@ class AsyncRawArticlesClient:
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.
 
-        type : typing.Optional[str]
+        root_container_id : typing.Optional[str]
+            If provided, will only return sub articles of the root_container_id.
+
+        status : typing.Optional[str]
+            If provided, will only return articles of the given status; multiple statuses can be separated by commas.
+
+        type : typing.Optional[ArticlesListRequestType]
             If provided, will only return articles of the given type.
 
         request_options : typing.Optional[RequestOptions]
@@ -285,6 +304,8 @@ class AsyncRawArticlesClient:
                 "parent_article_id": parent_article_id,
                 "parent_container_id": parent_container_id,
                 "remote_id": remote_id,
+                "root_container_id": root_container_id,
+                "status": status,
                 "type": type,
             },
             request_options=request_options,

merge/resources/knowledgebase/resources/articles/types/__init__.py

@@ -7,9 +7,11 @@ from importlib import import_module
 
 if typing.TYPE_CHECKING:
     from .articles_list_request_expand import ArticlesListRequestExpand
+    from .articles_list_request_type import ArticlesListRequestType
     from .articles_retrieve_request_expand import ArticlesRetrieveRequestExpand
 _dynamic_imports: typing.Dict[str, str] = {
     "ArticlesListRequestExpand": ".articles_list_request_expand",
+    "ArticlesListRequestType": ".articles_list_request_type",
     "ArticlesRetrieveRequestExpand": ".articles_retrieve_request_expand",
 }
 
@@ -33,4 +35,4 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["ArticlesListRequestExpand", "ArticlesRetrieveRequestExpand"]
+__all__ = ["ArticlesListRequestExpand", "ArticlesListRequestType", "ArticlesRetrieveRequestExpand"]

merge/resources/knowledgebase/resources/articles/types/articles_list_request_type.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class ArticlesListRequestType(str, enum.Enum):
+    EMPTY = ""
+    BLOG_POST = "BLOG_POST"
+    PAGE = "PAGE"
+    SMART_LINK = "SMART_LINK"
+
+    def visit(
+        self,
+        empty: typing.Callable[[], T_Result],
+        blog_post: typing.Callable[[], T_Result],
+        page: typing.Callable[[], T_Result],
+        smart_link: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is ArticlesListRequestType.EMPTY:
+            return empty()
+        if self is ArticlesListRequestType.BLOG_POST:
+            return blog_post()
+        if self is ArticlesListRequestType.PAGE:
+            return page()
+        if self is ArticlesListRequestType.SMART_LINK:
+            return smart_link()

merge/resources/knowledgebase/resources/attachments/client.py

@@ -70,7 +70,7 @@ class AttachmentsClient:
             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.
@@ -85,6 +85,8 @@ class AttachmentsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -92,7 +94,24 @@ class AttachmentsClient:
             api_key="YOUR_API_KEY",
         )
         client.knowledgebase.attachments.list(
+            created_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            created_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
             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",
         )
         """
         _response = self._raw_client.list(
@@ -149,6 +168,8 @@ class AttachmentsClient:
         )
         client.knowledgebase.attachments.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -220,7 +241,7 @@ class AsyncAttachmentsClient:
             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.
@@ -236,6 +257,7 @@ class AsyncAttachmentsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -247,7 +269,24 @@ class AsyncAttachmentsClient:
 
         async def main() -> None:
             await client.knowledgebase.attachments.list(
+                created_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                created_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
                 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",
             )
 
 
@@ -312,6 +351,8 @@ class AsyncAttachmentsClient:
         async def main() -> None:
             await client.knowledgebase.attachments.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/knowledgebase/resources/attachments/raw_client.py

@@ -64,7 +64,7 @@ class RawAttachmentsClient:
             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.
@@ -212,7 +212,7 @@ class AsyncRawAttachmentsClient:
             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/knowledgebase/resources/audit_trail/client.py

@@ -75,6 +75,11 @@ class AuditTrailClient:
         )
         client.knowledgebase.audit_trail.list(
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            end_date="end_date",
+            event_type="event_type",
+            page_size=1,
+            start_date="start_date",
+            user_email="user_email",
         )
         """
         _response = self._raw_client.list(
@@ -161,6 +166,11 @@ class AsyncAuditTrailClient:
         async def main() -> None:
             await client.knowledgebase.audit_trail.list(
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                end_date="end_date",
+                event_type="event_type",
+                page_size=1,
+                start_date="start_date",
+                user_email="user_email",
             )
 
 

merge/resources/knowledgebase/resources/containers/__init__.py

@@ -6,9 +6,10 @@ import typing
 from importlib import import_module
 
 if typing.TYPE_CHECKING:
-    from .types import ContainersListRequestExpand, ContainersRetrieveRequestExpand
+    from .types import ContainersListRequestExpand, ContainersListRequestType, ContainersRetrieveRequestExpand
 _dynamic_imports: typing.Dict[str, str] = {
     "ContainersListRequestExpand": ".types",
+    "ContainersListRequestType": ".types",
     "ContainersRetrieveRequestExpand": ".types",
 }
 
@@ -32,4 +33,4 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["ContainersListRequestExpand", "ContainersRetrieveRequestExpand"]
+__all__ = ["ContainersListRequestExpand", "ContainersListRequestType", "ContainersRetrieveRequestExpand"]