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

merge/resources/knowledgebase/resources/link_token/raw_client.py

@@ -0,0 +1,256 @@
+# 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.categories_enum import CategoriesEnum
+from ...types.common_model_scopes_body_request import CommonModelScopesBodyRequest
+from ...types.individual_common_model_scope_deserializer_request import IndividualCommonModelScopeDeserializerRequest
+from ...types.link_token import LinkToken
+from .types.end_user_details_request_language import EndUserDetailsRequestLanguage
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawLinkTokenClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def create(
+        self,
+        *,
+        end_user_email_address: str,
+        end_user_organization_name: str,
+        end_user_origin_id: str,
+        categories: typing.Sequence[CategoriesEnum],
+        integration: typing.Optional[str] = OMIT,
+        link_expiry_mins: typing.Optional[int] = OMIT,
+        should_create_magic_link_url: typing.Optional[bool] = OMIT,
+        hide_admin_magic_link: typing.Optional[bool] = OMIT,
+        common_models: typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]] = OMIT,
+        category_common_model_scopes: typing.Optional[
+            typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]]
+        ] = OMIT,
+        language: typing.Optional[EndUserDetailsRequestLanguage] = OMIT,
+        are_syncs_disabled: typing.Optional[bool] = OMIT,
+        integration_specific_config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[LinkToken]:
+        """
+        Creates a link token to be used when linking a new end user.
+
+        Parameters
+        ----------
+        end_user_email_address : str
+            Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+
+        end_user_organization_name : str
+            Your end user's organization.
+
+        end_user_origin_id : str
+            This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+
+        categories : typing.Sequence[CategoriesEnum]
+            The integration categories to show in Merge Link.
+
+        integration : typing.Optional[str]
+            The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+
+        link_expiry_mins : typing.Optional[int]
+            An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+
+        should_create_magic_link_url : typing.Optional[bool]
+            Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+        hide_admin_magic_link : typing.Optional[bool]
+            Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+        common_models : typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]
+            An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+        category_common_model_scopes : typing.Optional[typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]]]
+            When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+        language : typing.Optional[EndUserDetailsRequestLanguage]
+            The following subset of IETF language tags can be used to configure localization.
+
+            * `en` - en
+            * `de` - de
+
+        are_syncs_disabled : typing.Optional[bool]
+            The boolean that indicates whether initial, periodic, and force syncs will be disabled.
+
+        integration_specific_config : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            A JSON object containing integration-specific configuration options.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[LinkToken]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "knowledgebase/v1/link-token",
+            method="POST",
+            json={
+                "end_user_email_address": end_user_email_address,
+                "end_user_organization_name": end_user_organization_name,
+                "end_user_origin_id": end_user_origin_id,
+                "categories": categories,
+                "integration": integration,
+                "link_expiry_mins": link_expiry_mins,
+                "should_create_magic_link_url": should_create_magic_link_url,
+                "hide_admin_magic_link": hide_admin_magic_link,
+                "common_models": common_models,
+                "category_common_model_scopes": category_common_model_scopes,
+                "language": language,
+                "are_syncs_disabled": are_syncs_disabled,
+                "integration_specific_config": integration_specific_config,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    LinkToken,
+                    construct_type(
+                        type_=LinkToken,  # 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 AsyncRawLinkTokenClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def create(
+        self,
+        *,
+        end_user_email_address: str,
+        end_user_organization_name: str,
+        end_user_origin_id: str,
+        categories: typing.Sequence[CategoriesEnum],
+        integration: typing.Optional[str] = OMIT,
+        link_expiry_mins: typing.Optional[int] = OMIT,
+        should_create_magic_link_url: typing.Optional[bool] = OMIT,
+        hide_admin_magic_link: typing.Optional[bool] = OMIT,
+        common_models: typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]] = OMIT,
+        category_common_model_scopes: typing.Optional[
+            typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]]
+        ] = OMIT,
+        language: typing.Optional[EndUserDetailsRequestLanguage] = OMIT,
+        are_syncs_disabled: typing.Optional[bool] = OMIT,
+        integration_specific_config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[LinkToken]:
+        """
+        Creates a link token to be used when linking a new end user.
+
+        Parameters
+        ----------
+        end_user_email_address : str
+            Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+
+        end_user_organization_name : str
+            Your end user's organization.
+
+        end_user_origin_id : str
+            This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+
+        categories : typing.Sequence[CategoriesEnum]
+            The integration categories to show in Merge Link.
+
+        integration : typing.Optional[str]
+            The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+
+        link_expiry_mins : typing.Optional[int]
+            An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+
+        should_create_magic_link_url : typing.Optional[bool]
+            Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+        hide_admin_magic_link : typing.Optional[bool]
+            Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+        common_models : typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]
+            An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+        category_common_model_scopes : typing.Optional[typing.Dict[str, typing.Optional[typing.Sequence[IndividualCommonModelScopeDeserializerRequest]]]]
+            When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+        language : typing.Optional[EndUserDetailsRequestLanguage]
+            The following subset of IETF language tags can be used to configure localization.
+
+            * `en` - en
+            * `de` - de
+
+        are_syncs_disabled : typing.Optional[bool]
+            The boolean that indicates whether initial, periodic, and force syncs will be disabled.
+
+        integration_specific_config : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            A JSON object containing integration-specific configuration options.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[LinkToken]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "knowledgebase/v1/link-token",
+            method="POST",
+            json={
+                "end_user_email_address": end_user_email_address,
+                "end_user_organization_name": end_user_organization_name,
+                "end_user_origin_id": end_user_origin_id,
+                "categories": categories,
+                "integration": integration,
+                "link_expiry_mins": link_expiry_mins,
+                "should_create_magic_link_url": should_create_magic_link_url,
+                "hide_admin_magic_link": hide_admin_magic_link,
+                "common_models": common_models,
+                "category_common_model_scopes": category_common_model_scopes,
+                "language": language,
+                "are_syncs_disabled": are_syncs_disabled,
+                "integration_specific_config": integration_specific_config,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    LinkToken,
+                    construct_type(
+                        type_=LinkToken,  # 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/link_token/types/__init__.py

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

merge/resources/knowledgebase/resources/link_token/types/end_user_details_request_language.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ....types.language_enum import LanguageEnum
+
+EndUserDetailsRequestLanguage = typing.Union[LanguageEnum, str]

merge/resources/knowledgebase/resources/linked_accounts/__init__.py

@@ -0,0 +1,32 @@
+# 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 .types import LinkedAccountsListRequestCategory
+_dynamic_imports: typing.Dict[str, str] = {"LinkedAccountsListRequestCategory": ".types"}
+
+
+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/client.py

@@ -0,0 +1,265 @@
+# 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.paginated_account_details_and_actions_list import PaginatedAccountDetailsAndActionsList
+from .raw_client import AsyncRawLinkedAccountsClient, RawLinkedAccountsClient
+from .types.linked_accounts_list_request_category import LinkedAccountsListRequestCategory
+
+
+class LinkedAccountsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawLinkedAccountsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawLinkedAccountsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawLinkedAccountsClient
+        """
+        return self._raw_client
+
+    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,
+    ) -> 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
+        -------
+        PaginatedAccountDetailsAndActionsList
+
+
+        Examples
+        --------
+        from merge import Merge
+
+        client = Merge(
+            account_token="YOUR_ACCOUNT_TOKEN",
+            api_key="YOUR_API_KEY",
+        )
+        client.knowledgebase.linked_accounts.list(
+            cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+        )
+        """
+        _response = self._raw_client.list(
+            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,
+        )
+        return _response.data
+
+
+class AsyncLinkedAccountsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawLinkedAccountsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawLinkedAccountsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawLinkedAccountsClient
+        """
+        return self._raw_client
+
+    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,
+    ) -> 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
+        -------
+        PaginatedAccountDetailsAndActionsList
+
+
+        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.linked_accounts.list(
+                cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(
+            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,
+        )
+        return _response.data