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

merge/resources/knowledgebase/resources/containers/raw_client.py

@@ -0,0 +1,364 @@
+# 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.container import Container
+from ...types.paginated_container_list import PaginatedContainerList
+from .types.containers_list_request_expand import ContainersListRequestExpand
+from .types.containers_list_request_type import ContainersListRequestType
+from .types.containers_retrieve_request_expand import ContainersRetrieveRequestExpand
+
+
+class RawContainersClient:
+    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[ContainersListRequestExpand] = 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[ContainersListRequestType] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[PaginatedContainerList]:
+        """
+        Returns a list of `Container` 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[ContainersListRequestExpand]
+            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. The maximum limit is 100.
+
+        parent_article_id : typing.Optional[str]
+            If provided, will only return sub containers of the parent_article_id.
+
+        parent_container_id : typing.Optional[str]
+            If provided, will only return sub containers of the parent_container_id.
+
+        remote_id : typing.Optional[str]
+            The API provider's ID for the given object.
+
+        type : typing.Optional[ContainersListRequestType]
+            If provided, will only return containers of the given type.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PaginatedContainerList]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "knowledgebase/v1/containers",
+            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(
+                    PaginatedContainerList,
+                    construct_type(
+                        type_=PaginatedContainerList,  # 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[ContainersRetrieveRequestExpand] = None,
+        include_remote_data: typing.Optional[bool] = None,
+        include_shell_data: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[Container]:
+        """
+        Returns a `Container` object with the given `id`.
+
+        Parameters
+        ----------
+        id : str
+
+        expand : typing.Optional[ContainersRetrieveRequestExpand]
+            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[Container]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"knowledgebase/v1/containers/{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(
+                    Container,
+                    construct_type(
+                        type_=Container,  # 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 AsyncRawContainersClient:
+    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[ContainersListRequestExpand] = 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[ContainersListRequestType] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[PaginatedContainerList]:
+        """
+        Returns a list of `Container` 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[ContainersListRequestExpand]
+            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. The maximum limit is 100.
+
+        parent_article_id : typing.Optional[str]
+            If provided, will only return sub containers of the parent_article_id.
+
+        parent_container_id : typing.Optional[str]
+            If provided, will only return sub containers of the parent_container_id.
+
+        remote_id : typing.Optional[str]
+            The API provider's ID for the given object.
+
+        type : typing.Optional[ContainersListRequestType]
+            If provided, will only return containers of the given type.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PaginatedContainerList]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "knowledgebase/v1/containers",
+            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(
+                    PaginatedContainerList,
+                    construct_type(
+                        type_=PaginatedContainerList,  # 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[ContainersRetrieveRequestExpand] = None,
+        include_remote_data: typing.Optional[bool] = None,
+        include_shell_data: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[Container]:
+        """
+        Returns a `Container` object with the given `id`.
+
+        Parameters
+        ----------
+        id : str
+
+        expand : typing.Optional[ContainersRetrieveRequestExpand]
+            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[Container]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"knowledgebase/v1/containers/{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(
+                    Container,
+                    construct_type(
+                        type_=Container,  # 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/containers/types/__init__.py

@@ -0,0 +1,38 @@
+# 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 .containers_list_request_expand import ContainersListRequestExpand
+    from .containers_list_request_type import ContainersListRequestType
+    from .containers_retrieve_request_expand import ContainersRetrieveRequestExpand
+_dynamic_imports: typing.Dict[str, str] = {
+    "ContainersListRequestExpand": ".containers_list_request_expand",
+    "ContainersListRequestType": ".containers_list_request_type",
+    "ContainersRetrieveRequestExpand": ".containers_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__ = ["ContainersListRequestExpand", "ContainersListRequestType", "ContainersRetrieveRequestExpand"]

merge/resources/knowledgebase/resources/containers/types/containers_list_request_expand.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class ContainersListRequestExpand(str, enum.Enum):
+    PARENT_ARTICLE = "parent_article"
+    PARENT_ARTICLE_PARENT_CONTAINER = "parent_article,parent_container"
+    PARENT_CONTAINER = "parent_container"
+    PERMISSIONS = "permissions"
+    PERMISSIONS_PARENT_ARTICLE = "permissions,parent_article"
+    PERMISSIONS_PARENT_ARTICLE_PARENT_CONTAINER = "permissions,parent_article,parent_container"
+    PERMISSIONS_PARENT_CONTAINER = "permissions,parent_container"
+
+    def visit(
+        self,
+        parent_article: typing.Callable[[], T_Result],
+        parent_article_parent_container: typing.Callable[[], T_Result],
+        parent_container: typing.Callable[[], T_Result],
+        permissions: typing.Callable[[], T_Result],
+        permissions_parent_article: typing.Callable[[], T_Result],
+        permissions_parent_article_parent_container: typing.Callable[[], T_Result],
+        permissions_parent_container: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is ContainersListRequestExpand.PARENT_ARTICLE:
+            return parent_article()
+        if self is ContainersListRequestExpand.PARENT_ARTICLE_PARENT_CONTAINER:
+            return parent_article_parent_container()
+        if self is ContainersListRequestExpand.PARENT_CONTAINER:
+            return parent_container()
+        if self is ContainersListRequestExpand.PERMISSIONS:
+            return permissions()
+        if self is ContainersListRequestExpand.PERMISSIONS_PARENT_ARTICLE:
+            return permissions_parent_article()
+        if self is ContainersListRequestExpand.PERMISSIONS_PARENT_ARTICLE_PARENT_CONTAINER:
+            return permissions_parent_article_parent_container()
+        if self is ContainersListRequestExpand.PERMISSIONS_PARENT_CONTAINER:
+            return permissions_parent_container()

merge/resources/knowledgebase/resources/containers/types/containers_list_request_type.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class ContainersListRequestType(str, enum.Enum):
+    EMPTY = ""
+    CATEGORY = "CATEGORY"
+    COLLECTION = "COLLECTION"
+    DATABASE = "DATABASE"
+    FOLDER = "FOLDER"
+    SECTION = "SECTION"
+    SPACE = "SPACE"
+
+    def visit(
+        self,
+        empty: typing.Callable[[], T_Result],
+        category: typing.Callable[[], T_Result],
+        collection: typing.Callable[[], T_Result],
+        database: typing.Callable[[], T_Result],
+        folder: typing.Callable[[], T_Result],
+        section: typing.Callable[[], T_Result],
+        space: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is ContainersListRequestType.EMPTY:
+            return empty()
+        if self is ContainersListRequestType.CATEGORY:
+            return category()
+        if self is ContainersListRequestType.COLLECTION:
+            return collection()
+        if self is ContainersListRequestType.DATABASE:
+            return database()
+        if self is ContainersListRequestType.FOLDER:
+            return folder()
+        if self is ContainersListRequestType.SECTION:
+            return section()
+        if self is ContainersListRequestType.SPACE:
+            return space()

merge/resources/knowledgebase/resources/containers/types/containers_retrieve_request_expand.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class ContainersRetrieveRequestExpand(str, enum.Enum):
+    PARENT_ARTICLE = "parent_article"
+    PARENT_ARTICLE_PARENT_CONTAINER = "parent_article,parent_container"
+    PARENT_CONTAINER = "parent_container"
+    PERMISSIONS = "permissions"
+    PERMISSIONS_PARENT_ARTICLE = "permissions,parent_article"
+    PERMISSIONS_PARENT_ARTICLE_PARENT_CONTAINER = "permissions,parent_article,parent_container"
+    PERMISSIONS_PARENT_CONTAINER = "permissions,parent_container"
+
+    def visit(
+        self,
+        parent_article: typing.Callable[[], T_Result],
+        parent_article_parent_container: typing.Callable[[], T_Result],
+        parent_container: typing.Callable[[], T_Result],
+        permissions: typing.Callable[[], T_Result],
+        permissions_parent_article: typing.Callable[[], T_Result],
+        permissions_parent_article_parent_container: typing.Callable[[], T_Result],
+        permissions_parent_container: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is ContainersRetrieveRequestExpand.PARENT_ARTICLE:
+            return parent_article()
+        if self is ContainersRetrieveRequestExpand.PARENT_ARTICLE_PARENT_CONTAINER:
+            return parent_article_parent_container()
+        if self is ContainersRetrieveRequestExpand.PARENT_CONTAINER:
+            return parent_container()
+        if self is ContainersRetrieveRequestExpand.PERMISSIONS:
+            return permissions()
+        if self is ContainersRetrieveRequestExpand.PERMISSIONS_PARENT_ARTICLE:
+            return permissions_parent_article()
+        if self is ContainersRetrieveRequestExpand.PERMISSIONS_PARENT_ARTICLE_PARENT_CONTAINER:
+            return permissions_parent_article_parent_container()
+        if self is ContainersRetrieveRequestExpand.PERMISSIONS_PARENT_CONTAINER:
+            return permissions_parent_container()

merge/resources/knowledgebase/resources/delete_account/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+

merge/resources/knowledgebase/resources/delete_account/client.py

@@ -0,0 +1,99 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .....core.request_options import RequestOptions
+from .raw_client import AsyncRawDeleteAccountClient, RawDeleteAccountClient
+
+
+class DeleteAccountClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawDeleteAccountClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawDeleteAccountClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawDeleteAccountClient
+        """
+        return self._raw_client
+
+    def delete(self, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Delete a linked account.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from merge import Merge
+
+        client = Merge(
+            account_token="YOUR_ACCOUNT_TOKEN",
+            api_key="YOUR_API_KEY",
+        )
+        client.knowledgebase.delete_account.delete()
+        """
+        _response = self._raw_client.delete(request_options=request_options)
+        return _response.data
+
+
+class AsyncDeleteAccountClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawDeleteAccountClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawDeleteAccountClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawDeleteAccountClient
+        """
+        return self._raw_client
+
+    async def delete(self, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Delete a linked account.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from merge import AsyncMerge
+
+        client = AsyncMerge(
+            account_token="YOUR_ACCOUNT_TOKEN",
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.knowledgebase.delete_account.delete()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(request_options=request_options)
+        return _response.data