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

merge/resources/knowledgebase/resources/linked_accounts/raw_client.py

@@ -0,0 +1,248 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from .....core.api_error import ApiError
+from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .....core.http_response import AsyncHttpResponse, HttpResponse
+from .....core.request_options import RequestOptions
+from .....core.unchecked_base_model import construct_type
+from ...types.paginated_account_details_and_actions_list import PaginatedAccountDetailsAndActionsList
+from .types.linked_accounts_list_request_category import LinkedAccountsListRequestCategory
+
+
+class RawLinkedAccountsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self,
+        *,
+        category: typing.Optional[LinkedAccountsListRequestCategory] = None,
+        cursor: typing.Optional[str] = None,
+        end_user_email_address: typing.Optional[str] = None,
+        end_user_organization_name: typing.Optional[str] = None,
+        end_user_origin_id: typing.Optional[str] = None,
+        end_user_origin_ids: typing.Optional[str] = None,
+        id: typing.Optional[str] = None,
+        ids: typing.Optional[str] = None,
+        include_duplicates: typing.Optional[bool] = None,
+        integration_name: typing.Optional[str] = None,
+        is_test_account: typing.Optional[str] = None,
+        page_size: typing.Optional[int] = None,
+        status: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[PaginatedAccountDetailsAndActionsList]:
+        """
+        List linked accounts for your organization.
+
+        Parameters
+        ----------
+        category : typing.Optional[LinkedAccountsListRequestCategory]
+            Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing`
+
+            * `hris` - hris
+            * `ats` - ats
+            * `accounting` - accounting
+            * `ticketing` - ticketing
+            * `crm` - crm
+            * `mktg` - mktg
+            * `filestorage` - filestorage
+            * `knowledgebase` - knowledgebase
+
+        cursor : typing.Optional[str]
+            The pagination cursor value.
+
+        end_user_email_address : typing.Optional[str]
+            If provided, will only return linked accounts associated with the given email address.
+
+        end_user_organization_name : typing.Optional[str]
+            If provided, will only return linked accounts associated with the given organization name.
+
+        end_user_origin_id : typing.Optional[str]
+            If provided, will only return linked accounts associated with the given origin ID.
+
+        end_user_origin_ids : typing.Optional[str]
+            Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+
+        id : typing.Optional[str]
+
+        ids : typing.Optional[str]
+            Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+
+        include_duplicates : typing.Optional[bool]
+            If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+
+        integration_name : typing.Optional[str]
+            If provided, will only return linked accounts associated with the given integration name.
+
+        is_test_account : typing.Optional[str]
+            If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+        page_size : typing.Optional[int]
+            Number of results to return per page.
+
+        status : typing.Optional[str]
+            Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PaginatedAccountDetailsAndActionsList]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "knowledgebase/v1/linked-accounts",
+            method="GET",
+            params={
+                "category": category,
+                "cursor": cursor,
+                "end_user_email_address": end_user_email_address,
+                "end_user_organization_name": end_user_organization_name,
+                "end_user_origin_id": end_user_origin_id,
+                "end_user_origin_ids": end_user_origin_ids,
+                "id": id,
+                "ids": ids,
+                "include_duplicates": include_duplicates,
+                "integration_name": integration_name,
+                "is_test_account": is_test_account,
+                "page_size": page_size,
+                "status": status,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaginatedAccountDetailsAndActionsList,
+                    construct_type(
+                        type_=PaginatedAccountDetailsAndActionsList,  # 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 AsyncRawLinkedAccountsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self,
+        *,
+        category: typing.Optional[LinkedAccountsListRequestCategory] = None,
+        cursor: typing.Optional[str] = None,
+        end_user_email_address: typing.Optional[str] = None,
+        end_user_organization_name: typing.Optional[str] = None,
+        end_user_origin_id: typing.Optional[str] = None,
+        end_user_origin_ids: typing.Optional[str] = None,
+        id: typing.Optional[str] = None,
+        ids: typing.Optional[str] = None,
+        include_duplicates: typing.Optional[bool] = None,
+        integration_name: typing.Optional[str] = None,
+        is_test_account: typing.Optional[str] = None,
+        page_size: typing.Optional[int] = None,
+        status: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[PaginatedAccountDetailsAndActionsList]:
+        """
+        List linked accounts for your organization.
+
+        Parameters
+        ----------
+        category : typing.Optional[LinkedAccountsListRequestCategory]
+            Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing`
+
+            * `hris` - hris
+            * `ats` - ats
+            * `accounting` - accounting
+            * `ticketing` - ticketing
+            * `crm` - crm
+            * `mktg` - mktg
+            * `filestorage` - filestorage
+            * `knowledgebase` - knowledgebase
+
+        cursor : typing.Optional[str]
+            The pagination cursor value.
+
+        end_user_email_address : typing.Optional[str]
+            If provided, will only return linked accounts associated with the given email address.
+
+        end_user_organization_name : typing.Optional[str]
+            If provided, will only return linked accounts associated with the given organization name.
+
+        end_user_origin_id : typing.Optional[str]
+            If provided, will only return linked accounts associated with the given origin ID.
+
+        end_user_origin_ids : typing.Optional[str]
+            Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+
+        id : typing.Optional[str]
+
+        ids : typing.Optional[str]
+            Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+
+        include_duplicates : typing.Optional[bool]
+            If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+
+        integration_name : typing.Optional[str]
+            If provided, will only return linked accounts associated with the given integration name.
+
+        is_test_account : typing.Optional[str]
+            If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+        page_size : typing.Optional[int]
+            Number of results to return per page.
+
+        status : typing.Optional[str]
+            Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PaginatedAccountDetailsAndActionsList]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "knowledgebase/v1/linked-accounts",
+            method="GET",
+            params={
+                "category": category,
+                "cursor": cursor,
+                "end_user_email_address": end_user_email_address,
+                "end_user_organization_name": end_user_organization_name,
+                "end_user_origin_id": end_user_origin_id,
+                "end_user_origin_ids": end_user_origin_ids,
+                "id": id,
+                "ids": ids,
+                "include_duplicates": include_duplicates,
+                "integration_name": integration_name,
+                "is_test_account": is_test_account,
+                "page_size": page_size,
+                "status": status,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaginatedAccountDetailsAndActionsList,
+                    construct_type(
+                        type_=PaginatedAccountDetailsAndActionsList,  # 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/linked_accounts/types/__init__.py

@@ -0,0 +1,34 @@
+# 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 .linked_accounts_list_request_category import LinkedAccountsListRequestCategory
+_dynamic_imports: typing.Dict[str, str] = {
+    "LinkedAccountsListRequestCategory": ".linked_accounts_list_request_category"
+}
+
+
+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__ = ["LinkedAccountsListRequestCategory"]

merge/resources/knowledgebase/resources/linked_accounts/types/linked_accounts_list_request_category.py

@@ -0,0 +1,45 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class LinkedAccountsListRequestCategory(str, enum.Enum):
+    ACCOUNTING = "accounting"
+    ATS = "ats"
+    CRM = "crm"
+    FILESTORAGE = "filestorage"
+    HRIS = "hris"
+    KNOWLEDGEBASE = "knowledgebase"
+    MKTG = "mktg"
+    TICKETING = "ticketing"
+
+    def visit(
+        self,
+        accounting: typing.Callable[[], T_Result],
+        ats: typing.Callable[[], T_Result],
+        crm: typing.Callable[[], T_Result],
+        filestorage: typing.Callable[[], T_Result],
+        hris: typing.Callable[[], T_Result],
+        knowledgebase: typing.Callable[[], T_Result],
+        mktg: typing.Callable[[], T_Result],
+        ticketing: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is LinkedAccountsListRequestCategory.ACCOUNTING:
+            return accounting()
+        if self is LinkedAccountsListRequestCategory.ATS:
+            return ats()
+        if self is LinkedAccountsListRequestCategory.CRM:
+            return crm()
+        if self is LinkedAccountsListRequestCategory.FILESTORAGE:
+            return filestorage()
+        if self is LinkedAccountsListRequestCategory.HRIS:
+            return hris()
+        if self is LinkedAccountsListRequestCategory.KNOWLEDGEBASE:
+            return knowledgebase()
+        if self is LinkedAccountsListRequestCategory.MKTG:
+            return mktg()
+        if self is LinkedAccountsListRequestCategory.TICKETING:
+            return ticketing()

merge/resources/knowledgebase/resources/passthrough/__init__.py

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

merge/resources/knowledgebase/resources/passthrough/client.py

@@ -0,0 +1,126 @@
+# 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 ...types.data_passthrough_request import DataPassthroughRequest
+from ...types.remote_response import RemoteResponse
+from .raw_client import AsyncRawPassthroughClient, RawPassthroughClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class PassthroughClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawPassthroughClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawPassthroughClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawPassthroughClient
+        """
+        return self._raw_client
+
+    def create(
+        self, *, request: DataPassthroughRequest, request_options: typing.Optional[RequestOptions] = None
+    ) -> RemoteResponse:
+        """
+        Pull data from an endpoint not currently supported by Merge.
+
+        Parameters
+        ----------
+        request : DataPassthroughRequest
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        RemoteResponse
+
+
+        Examples
+        --------
+        from merge import Merge
+        from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum
+
+        client = Merge(
+            account_token="YOUR_ACCOUNT_TOKEN",
+            api_key="YOUR_API_KEY",
+        )
+        client.knowledgebase.passthrough.create(
+            request=DataPassthroughRequest(
+                method=MethodEnum.GET,
+                path="/scooters",
+            ),
+        )
+        """
+        _response = self._raw_client.create(request=request, request_options=request_options)
+        return _response.data
+
+
+class AsyncPassthroughClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawPassthroughClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawPassthroughClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawPassthroughClient
+        """
+        return self._raw_client
+
+    async def create(
+        self, *, request: DataPassthroughRequest, request_options: typing.Optional[RequestOptions] = None
+    ) -> RemoteResponse:
+        """
+        Pull data from an endpoint not currently supported by Merge.
+
+        Parameters
+        ----------
+        request : DataPassthroughRequest
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        RemoteResponse
+
+
+        Examples
+        --------
+        import asyncio
+
+        from merge import AsyncMerge
+        from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum
+
+        client = AsyncMerge(
+            account_token="YOUR_ACCOUNT_TOKEN",
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.knowledgebase.passthrough.create(
+                request=DataPassthroughRequest(
+                    method=MethodEnum.GET,
+                    path="/scooters",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(request=request, request_options=request_options)
+        return _response.data

merge/resources/knowledgebase/resources/passthrough/raw_client.py

@@ -0,0 +1,111 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from .....core.api_error import ApiError
+from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .....core.http_response import AsyncHttpResponse, HttpResponse
+from .....core.request_options import RequestOptions
+from .....core.unchecked_base_model import construct_type
+from ...types.data_passthrough_request import DataPassthroughRequest
+from ...types.remote_response import RemoteResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawPassthroughClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def create(
+        self, *, request: DataPassthroughRequest, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[RemoteResponse]:
+        """
+        Pull data from an endpoint not currently supported by Merge.
+
+        Parameters
+        ----------
+        request : DataPassthroughRequest
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[RemoteResponse]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "knowledgebase/v1/passthrough",
+            method="POST",
+            json=request,
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    RemoteResponse,
+                    construct_type(
+                        type_=RemoteResponse,  # 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 AsyncRawPassthroughClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def create(
+        self, *, request: DataPassthroughRequest, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[RemoteResponse]:
+        """
+        Pull data from an endpoint not currently supported by Merge.
+
+        Parameters
+        ----------
+        request : DataPassthroughRequest
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[RemoteResponse]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "knowledgebase/v1/passthrough",
+            method="POST",
+            json=request,
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    RemoteResponse,
+                    construct_type(
+                        type_=RemoteResponse,  # 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/regenerate_key/__init__.py

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

merge/resources/knowledgebase/resources/regenerate_key/client.py

@@ -0,0 +1,115 @@
+# 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 ...types.remote_key import RemoteKey
+from .raw_client import AsyncRawRegenerateKeyClient, RawRegenerateKeyClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RegenerateKeyClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawRegenerateKeyClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawRegenerateKeyClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawRegenerateKeyClient
+        """
+        return self._raw_client
+
+    def create(self, *, name: str, request_options: typing.Optional[RequestOptions] = None) -> RemoteKey:
+        """
+        Exchange remote keys.
+
+        Parameters
+        ----------
+        name : str
+            The name of the remote key
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        RemoteKey
+
+
+        Examples
+        --------
+        from merge import Merge
+
+        client = Merge(
+            account_token="YOUR_ACCOUNT_TOKEN",
+            api_key="YOUR_API_KEY",
+        )
+        client.knowledgebase.regenerate_key.create(
+            name="Remote Deployment Key 1",
+        )
+        """
+        _response = self._raw_client.create(name=name, request_options=request_options)
+        return _response.data
+
+
+class AsyncRegenerateKeyClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawRegenerateKeyClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawRegenerateKeyClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawRegenerateKeyClient
+        """
+        return self._raw_client
+
+    async def create(self, *, name: str, request_options: typing.Optional[RequestOptions] = None) -> RemoteKey:
+        """
+        Exchange remote keys.
+
+        Parameters
+        ----------
+        name : str
+            The name of the remote key
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        RemoteKey
+
+
+        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.regenerate_key.create(
+                name="Remote Deployment Key 1",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(name=name, request_options=request_options)
+        return _response.data