mergepythonclient 0.0.1__py3-none-any.whl

merge/resources/crm/link_tokens.py

@@ -0,0 +1,173 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ...types import shared
+from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._utils import maybe_transform
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ...types.crm import link_token_create_params
+from ..._base_client import make_request_options
+
+__all__ = ["LinkTokens", "AsyncLinkTokens"]
+
+
+class LinkTokens(SyncAPIResource):
+    def create(
+        self,
+        *,
+        categories: List[Literal["hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage"]],
+        end_user_email_address: str,
+        end_user_organization_name: str,
+        end_user_origin_id: str,
+        common_models: List[link_token_create_params.CommonModel] | NotGiven = NOT_GIVEN,
+        integration: Optional[str] | NotGiven = NOT_GIVEN,
+        link_expiry_mins: int | NotGiven = NOT_GIVEN,
+        should_create_magic_link_url: Optional[bool] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> shared.LinkToken:
+        """
+        Creates a link token to be used when linking a new end user.
+
+        Args:
+          categories: The integration categories to show in Merge Link.
+
+          end_user_email_address: 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: Your end user's organization.
+
+          end_user_origin_id: 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.
+
+          common_models: 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.
+
+          integration: The slug of a specific pre-selected integration for this linking flow token. For
+              examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/.
+
+          link_expiry_mins: 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: Whether to generate a Magic Link URL. Defaults to false. For more information on
+              Magic Link, see
+              https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._post(
+            "/crm/v1/link-token",
+            body=maybe_transform(
+                {
+                    "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,
+                    "common_models": common_models,
+                },
+                link_token_create_params.LinkTokenCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=shared.LinkToken,
+        )
+
+
+class AsyncLinkTokens(AsyncAPIResource):
+    async def create(
+        self,
+        *,
+        categories: List[Literal["hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage"]],
+        end_user_email_address: str,
+        end_user_organization_name: str,
+        end_user_origin_id: str,
+        common_models: List[link_token_create_params.CommonModel] | NotGiven = NOT_GIVEN,
+        integration: Optional[str] | NotGiven = NOT_GIVEN,
+        link_expiry_mins: int | NotGiven = NOT_GIVEN,
+        should_create_magic_link_url: Optional[bool] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> shared.LinkToken:
+        """
+        Creates a link token to be used when linking a new end user.
+
+        Args:
+          categories: The integration categories to show in Merge Link.
+
+          end_user_email_address: 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: Your end user's organization.
+
+          end_user_origin_id: 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.
+
+          common_models: 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.
+
+          integration: The slug of a specific pre-selected integration for this linking flow token. For
+              examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/.
+
+          link_expiry_mins: 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: Whether to generate a Magic Link URL. Defaults to false. For more information on
+              Magic Link, see
+              https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._post(
+            "/crm/v1/link-token",
+            body=maybe_transform(
+                {
+                    "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,
+                    "common_models": common_models,
+                },
+                link_token_create_params.LinkTokenCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=shared.LinkToken,
+        )

merge/resources/crm/linked_accounts.py

@@ -0,0 +1,286 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ...types import shared
+from ..._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+from ..._utils import maybe_transform
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ...types.crm import linked_account_list_params
+from ...pagination import SyncPage, AsyncPage
+from ..._base_client import AsyncPaginator, make_request_options
+
+__all__ = ["LinkedAccounts", "AsyncLinkedAccounts"]
+
+
+class LinkedAccounts(SyncAPIResource):
+    def list(
+        self,
+        *,
+        category: Optional[Literal["accounting", "ats", "crm", "filestorage", "hris", "mktg", "ticketing"]]
+        | NotGiven = NOT_GIVEN,
+        cursor: str | NotGiven = NOT_GIVEN,
+        end_user_email_address: str | NotGiven = NOT_GIVEN,
+        end_user_organization_name: str | NotGiven = NOT_GIVEN,
+        end_user_origin_id: str | NotGiven = NOT_GIVEN,
+        end_user_origin_ids: str | NotGiven = NOT_GIVEN,
+        id: str | NotGiven = NOT_GIVEN,
+        ids: str | NotGiven = NOT_GIVEN,
+        include_duplicates: bool | NotGiven = NOT_GIVEN,
+        integration_name: str | NotGiven = NOT_GIVEN,
+        is_test_account: str | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        status: str | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> SyncPage[shared.AccountDetailsAndActions]:
+        """
+        List linked accounts for your organization.
+
+        Args:
+          category: - `hris` - hris
+              - `ats` - ats
+              - `accounting` - accounting
+              - `ticketing` - ticketing
+              - `crm` - crm
+              - `mktg` - mktg
+              - `filestorage` - filestorage
+
+              - `hris` - hris
+              - `ats` - ats
+              - `accounting` - accounting
+              - `ticketing` - ticketing
+              - `crm` - crm
+              - `mktg` - mktg
+              - `filestorage` - filestorage
+
+          cursor: The pagination cursor value.
+
+          end_user_email_address: If provided, will only return linked accounts associated with the given email
+              address.
+
+          end_user_organization_name: If provided, will only return linked accounts associated with the given
+              organization name.
+
+          end_user_origin_id: If provided, will only return linked accounts associated with the given origin
+              ID.
+
+          end_user_origin_ids: Comma-separated list of EndUser origin IDs, making it possible to specify
+              multiple EndUsers at once.
+
+          ids: Comma-separated list of LinkedAccount IDs, making it possible to specify
+              multiple LinkedAccounts at once.
+
+          include_duplicates: 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: If provided, will only return linked accounts associated with the given
+              integration name.
+
+          is_test_account: If included, will only include test linked accounts. If not included, will only
+              include non-test linked accounts.
+
+          page_size: Number of results to return per page.
+
+          status: Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
+            "/crm/v1/linked-accounts",
+            page=SyncPage[shared.AccountDetailsAndActions],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "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,
+                    },
+                    linked_account_list_params.LinkedAccountListParams,
+                ),
+            ),
+            model=shared.AccountDetailsAndActions,
+        )
+
+    def delete(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Delete a linked account."""
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._post(
+            "/crm/v1/delete-account",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AsyncLinkedAccounts(AsyncAPIResource):
+    def list(
+        self,
+        *,
+        category: Optional[Literal["accounting", "ats", "crm", "filestorage", "hris", "mktg", "ticketing"]]
+        | NotGiven = NOT_GIVEN,
+        cursor: str | NotGiven = NOT_GIVEN,
+        end_user_email_address: str | NotGiven = NOT_GIVEN,
+        end_user_organization_name: str | NotGiven = NOT_GIVEN,
+        end_user_origin_id: str | NotGiven = NOT_GIVEN,
+        end_user_origin_ids: str | NotGiven = NOT_GIVEN,
+        id: str | NotGiven = NOT_GIVEN,
+        ids: str | NotGiven = NOT_GIVEN,
+        include_duplicates: bool | NotGiven = NOT_GIVEN,
+        integration_name: str | NotGiven = NOT_GIVEN,
+        is_test_account: str | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        status: str | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> AsyncPaginator[shared.AccountDetailsAndActions, AsyncPage[shared.AccountDetailsAndActions]]:
+        """
+        List linked accounts for your organization.
+
+        Args:
+          category: - `hris` - hris
+              - `ats` - ats
+              - `accounting` - accounting
+              - `ticketing` - ticketing
+              - `crm` - crm
+              - `mktg` - mktg
+              - `filestorage` - filestorage
+
+              - `hris` - hris
+              - `ats` - ats
+              - `accounting` - accounting
+              - `ticketing` - ticketing
+              - `crm` - crm
+              - `mktg` - mktg
+              - `filestorage` - filestorage
+
+          cursor: The pagination cursor value.
+
+          end_user_email_address: If provided, will only return linked accounts associated with the given email
+              address.
+
+          end_user_organization_name: If provided, will only return linked accounts associated with the given
+              organization name.
+
+          end_user_origin_id: If provided, will only return linked accounts associated with the given origin
+              ID.
+
+          end_user_origin_ids: Comma-separated list of EndUser origin IDs, making it possible to specify
+              multiple EndUsers at once.
+
+          ids: Comma-separated list of LinkedAccount IDs, making it possible to specify
+              multiple LinkedAccounts at once.
+
+          include_duplicates: 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: If provided, will only return linked accounts associated with the given
+              integration name.
+
+          is_test_account: If included, will only include test linked accounts. If not included, will only
+              include non-test linked accounts.
+
+          page_size: Number of results to return per page.
+
+          status: Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
+            "/crm/v1/linked-accounts",
+            page=AsyncPage[shared.AccountDetailsAndActions],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "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,
+                    },
+                    linked_account_list_params.LinkedAccountListParams,
+                ),
+            ),
+            model=shared.AccountDetailsAndActions,
+        )
+
+    async def delete(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Delete a linked account."""
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._post(
+            "/crm/v1/delete-account",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )

merge/resources/crm/notes/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from .meta import Meta, AsyncMeta
+from .notes import Notes, AsyncNotes
+
+__all__ = ["Meta", "AsyncMeta", "Notes", "AsyncNotes"]

merge/resources/crm/notes/meta.py

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from ....types import shared
+from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ...._resource import SyncAPIResource, AsyncAPIResource
+from ...._base_client import make_request_options
+
+__all__ = ["Meta", "AsyncMeta"]
+
+
+class Meta(SyncAPIResource):
+    def for_create(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> shared.MetaResponse:
+        """Returns metadata for `Note` POSTs."""
+        return self._get(
+            "/crm/v1/notes/meta/post",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=shared.MetaResponse,
+        )
+
+
+class AsyncMeta(AsyncAPIResource):
+    async def for_create(
+        self,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | None | NotGiven = NOT_GIVEN,
+    ) -> shared.MetaResponse:
+        """Returns metadata for `Note` POSTs."""
+        return await self._get(
+            "/crm/v1/notes/meta/post",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=shared.MetaResponse,
+        )