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

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

@@ -0,0 +1,363 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+from json.decoder import JSONDecodeError
+
+from .....core.api_error import ApiError
+from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .....core.datetime_utils import serialize_datetime
+from .....core.http_response import AsyncHttpResponse, HttpResponse
+from .....core.jsonable_encoder import jsonable_encoder
+from .....core.request_options import RequestOptions
+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_retrieve_request_expand import ArticlesRetrieveRequestExpand
+
+
+class RawArticlesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self,
+        *,
+        created_after: typing.Optional[dt.datetime] = None,
+        created_before: typing.Optional[dt.datetime] = None,
+        cursor: typing.Optional[str] = None,
+        expand: typing.Optional[ArticlesListRequestExpand] = None,
+        include_deleted_data: typing.Optional[bool] = None,
+        include_remote_data: typing.Optional[bool] = None,
+        include_shell_data: typing.Optional[bool] = None,
+        modified_after: typing.Optional[dt.datetime] = None,
+        modified_before: typing.Optional[dt.datetime] = None,
+        page_size: typing.Optional[int] = None,
+        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,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[PaginatedArticleList]:
+        """
+        Returns a list of `Article` objects.
+
+        Parameters
+        ----------
+        created_after : typing.Optional[dt.datetime]
+            If provided, will only return objects created after this datetime.
+
+        created_before : typing.Optional[dt.datetime]
+            If provided, will only return objects created before this datetime.
+
+        cursor : typing.Optional[str]
+            The pagination cursor value.
+
+        expand : typing.Optional[ArticlesListRequestExpand]
+            Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+        include_deleted_data : typing.Optional[bool]
+            Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+        include_remote_data : typing.Optional[bool]
+            Whether to include the original data Merge fetched from the third-party to produce these models.
+
+        include_shell_data : typing.Optional[bool]
+            Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+        modified_after : typing.Optional[dt.datetime]
+            If provided, only objects synced by Merge after this date time will be returned.
+
+        modified_before : typing.Optional[dt.datetime]
+            If provided, only objects synced by Merge before this date time will be returned.
+
+        page_size : typing.Optional[int]
+            Number of results to return per page.
+
+        parent_article_id : typing.Optional[str]
+            If provided, will only return sub articles of the parent_article_id.
+
+        parent_container_id : typing.Optional[str]
+            If provided, will only return sub articles of the parent_container_id.
+
+        remote_id : typing.Optional[str]
+            The API provider's ID for the given object.
+
+        type : typing.Optional[str]
+            If provided, will only return articles of the given type.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PaginatedArticleList]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "knowledgebase/v1/articles",
+            method="GET",
+            params={
+                "created_after": serialize_datetime(created_after) if created_after is not None else None,
+                "created_before": serialize_datetime(created_before) if created_before is not None else None,
+                "cursor": cursor,
+                "expand": expand,
+                "include_deleted_data": include_deleted_data,
+                "include_remote_data": include_remote_data,
+                "include_shell_data": include_shell_data,
+                "modified_after": serialize_datetime(modified_after) if modified_after is not None else None,
+                "modified_before": serialize_datetime(modified_before) if modified_before is not None else None,
+                "page_size": page_size,
+                "parent_article_id": parent_article_id,
+                "parent_container_id": parent_container_id,
+                "remote_id": remote_id,
+                "type": type,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaginatedArticleList,
+                    construct_type(
+                        type_=PaginatedArticleList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def retrieve(
+        self,
+        id: str,
+        *,
+        expand: typing.Optional[ArticlesRetrieveRequestExpand] = None,
+        include_remote_data: typing.Optional[bool] = None,
+        include_shell_data: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[Article]:
+        """
+        Returns an `Article` object with the given `id`.
+
+        Parameters
+        ----------
+        id : str
+
+        expand : typing.Optional[ArticlesRetrieveRequestExpand]
+            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.
+
+        Returns
+        -------
+        HttpResponse[Article]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"knowledgebase/v1/articles/{jsonable_encoder(id)}",
+            method="GET",
+            params={
+                "expand": expand,
+                "include_remote_data": include_remote_data,
+                "include_shell_data": include_shell_data,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    Article,
+                    construct_type(
+                        type_=Article,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawArticlesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self,
+        *,
+        created_after: typing.Optional[dt.datetime] = None,
+        created_before: typing.Optional[dt.datetime] = None,
+        cursor: typing.Optional[str] = None,
+        expand: typing.Optional[ArticlesListRequestExpand] = None,
+        include_deleted_data: typing.Optional[bool] = None,
+        include_remote_data: typing.Optional[bool] = None,
+        include_shell_data: typing.Optional[bool] = None,
+        modified_after: typing.Optional[dt.datetime] = None,
+        modified_before: typing.Optional[dt.datetime] = None,
+        page_size: typing.Optional[int] = None,
+        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,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[PaginatedArticleList]:
+        """
+        Returns a list of `Article` objects.
+
+        Parameters
+        ----------
+        created_after : typing.Optional[dt.datetime]
+            If provided, will only return objects created after this datetime.
+
+        created_before : typing.Optional[dt.datetime]
+            If provided, will only return objects created before this datetime.
+
+        cursor : typing.Optional[str]
+            The pagination cursor value.
+
+        expand : typing.Optional[ArticlesListRequestExpand]
+            Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+        include_deleted_data : typing.Optional[bool]
+            Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+        include_remote_data : typing.Optional[bool]
+            Whether to include the original data Merge fetched from the third-party to produce these models.
+
+        include_shell_data : typing.Optional[bool]
+            Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+        modified_after : typing.Optional[dt.datetime]
+            If provided, only objects synced by Merge after this date time will be returned.
+
+        modified_before : typing.Optional[dt.datetime]
+            If provided, only objects synced by Merge before this date time will be returned.
+
+        page_size : typing.Optional[int]
+            Number of results to return per page.
+
+        parent_article_id : typing.Optional[str]
+            If provided, will only return sub articles of the parent_article_id.
+
+        parent_container_id : typing.Optional[str]
+            If provided, will only return sub articles of the parent_container_id.
+
+        remote_id : typing.Optional[str]
+            The API provider's ID for the given object.
+
+        type : typing.Optional[str]
+            If provided, will only return articles of the given type.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PaginatedArticleList]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "knowledgebase/v1/articles",
+            method="GET",
+            params={
+                "created_after": serialize_datetime(created_after) if created_after is not None else None,
+                "created_before": serialize_datetime(created_before) if created_before is not None else None,
+                "cursor": cursor,
+                "expand": expand,
+                "include_deleted_data": include_deleted_data,
+                "include_remote_data": include_remote_data,
+                "include_shell_data": include_shell_data,
+                "modified_after": serialize_datetime(modified_after) if modified_after is not None else None,
+                "modified_before": serialize_datetime(modified_before) if modified_before is not None else None,
+                "page_size": page_size,
+                "parent_article_id": parent_article_id,
+                "parent_container_id": parent_container_id,
+                "remote_id": remote_id,
+                "type": type,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaginatedArticleList,
+                    construct_type(
+                        type_=PaginatedArticleList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def retrieve(
+        self,
+        id: str,
+        *,
+        expand: typing.Optional[ArticlesRetrieveRequestExpand] = None,
+        include_remote_data: typing.Optional[bool] = None,
+        include_shell_data: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[Article]:
+        """
+        Returns an `Article` object with the given `id`.
+
+        Parameters
+        ----------
+        id : str
+
+        expand : typing.Optional[ArticlesRetrieveRequestExpand]
+            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.
+
+        Returns
+        -------
+        AsyncHttpResponse[Article]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"knowledgebase/v1/articles/{jsonable_encoder(id)}",
+            method="GET",
+            params={
+                "expand": expand,
+                "include_remote_data": include_remote_data,
+                "include_shell_data": include_shell_data,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    Article,
+                    construct_type(
+                        type_=Article,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

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

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .articles_list_request_expand import ArticlesListRequestExpand
+    from .articles_retrieve_request_expand import ArticlesRetrieveRequestExpand
+_dynamic_imports: typing.Dict[str, str] = {
+    "ArticlesListRequestExpand": ".articles_list_request_expand",
+    "ArticlesRetrieveRequestExpand": ".articles_retrieve_request_expand",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        result = getattr(module, attr_name)
+        return result
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["ArticlesListRequestExpand", "ArticlesRetrieveRequestExpand"]