mergepythonclient 0.0.1__py3-none-any.whl

merge/resources/marketing/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 ..._base_client import make_request_options
+from ...types.marketing import link_token_create_params
+
+__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(
+            "/mktg/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(
+            "/mktg/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/marketing/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 ...pagination import SyncPage, AsyncPage
+from ..._base_client import AsyncPaginator, make_request_options
+from ...types.marketing import linked_account_list_params
+
+__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(
+            "/mktg/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(
+            "/mktg/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(
+            "/mktg/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(
+            "/mktg/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/marketing/marketing.py

@@ -0,0 +1,134 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from .users import Users, AsyncUsers
+from .emails import Emails, AsyncEmails
+from .events import Events, AsyncEvents
+from .issues import Issues, AsyncIssues
+from .actions import Actions, AsyncActions
+from .contacts import Contacts, AsyncContacts
+from .messages import Messages, AsyncMessages
+from .campaigns import Campaigns, AsyncCampaigns
+from .templates import Templates, AsyncTemplates
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from .automations import Automations, AsyncAutomations
+from .link_tokens import LinkTokens, AsyncLinkTokens
+from .remote_keys import RemoteKeys, AsyncRemoteKeys
+from .sync_status import SyncStatus, AsyncSyncStatus
+from .contact_lists import ContactLists, AsyncContactLists
+from .account_tokens import AccountTokens, AsyncAccountTokens
+from .selective_sync import SelectiveSync, AsyncSelectiveSync
+from .account_details import AccountDetails, AsyncAccountDetails
+from .linked_accounts import LinkedAccounts, AsyncLinkedAccounts
+from .available_actions import AvailableActions, AsyncAvailableActions
+from .webhook_receivers import WebhookReceivers, AsyncWebhookReceivers
+from .common_model_scopes import CommonModelScopes, AsyncCommonModelScopes
+from .passthrough_requests import PassthroughRequests, AsyncPassthroughRequests
+
+if TYPE_CHECKING:
+    from ..._client import Merge, AsyncMerge
+
+__all__ = ["Marketing", "AsyncMarketing"]
+
+
+class Marketing(SyncAPIResource):
+    actions: Actions
+    automations: Automations
+    campaigns: Campaigns
+    contacts: Contacts
+    emails: Emails
+    events: Events
+    contact_lists: ContactLists
+    messages: Messages
+    templates: Templates
+    users: Users
+    account_details: AccountDetails
+    account_tokens: AccountTokens
+    link_tokens: LinkTokens
+    available_actions: AvailableActions
+    remote_keys: RemoteKeys
+    issues: Issues
+    common_model_scopes: CommonModelScopes
+    passthrough_requests: PassthroughRequests
+    sync_status: SyncStatus
+    webhook_receivers: WebhookReceivers
+    linked_accounts: LinkedAccounts
+    selective_sync: SelectiveSync
+
+    def __init__(self, client: Merge) -> None:
+        super().__init__(client)
+        self.actions = Actions(client)
+        self.automations = Automations(client)
+        self.campaigns = Campaigns(client)
+        self.contacts = Contacts(client)
+        self.emails = Emails(client)
+        self.events = Events(client)
+        self.contact_lists = ContactLists(client)
+        self.messages = Messages(client)
+        self.templates = Templates(client)
+        self.users = Users(client)
+        self.account_details = AccountDetails(client)
+        self.account_tokens = AccountTokens(client)
+        self.link_tokens = LinkTokens(client)
+        self.available_actions = AvailableActions(client)
+        self.remote_keys = RemoteKeys(client)
+        self.issues = Issues(client)
+        self.common_model_scopes = CommonModelScopes(client)
+        self.passthrough_requests = PassthroughRequests(client)
+        self.sync_status = SyncStatus(client)
+        self.webhook_receivers = WebhookReceivers(client)
+        self.linked_accounts = LinkedAccounts(client)
+        self.selective_sync = SelectiveSync(client)
+
+
+class AsyncMarketing(AsyncAPIResource):
+    actions: AsyncActions
+    automations: AsyncAutomations
+    campaigns: AsyncCampaigns
+    contacts: AsyncContacts
+    emails: AsyncEmails
+    events: AsyncEvents
+    contact_lists: AsyncContactLists
+    messages: AsyncMessages
+    templates: AsyncTemplates
+    users: AsyncUsers
+    account_details: AsyncAccountDetails
+    account_tokens: AsyncAccountTokens
+    link_tokens: AsyncLinkTokens
+    available_actions: AsyncAvailableActions
+    remote_keys: AsyncRemoteKeys
+    issues: AsyncIssues
+    common_model_scopes: AsyncCommonModelScopes
+    passthrough_requests: AsyncPassthroughRequests
+    sync_status: AsyncSyncStatus
+    webhook_receivers: AsyncWebhookReceivers
+    linked_accounts: AsyncLinkedAccounts
+    selective_sync: AsyncSelectiveSync
+
+    def __init__(self, client: AsyncMerge) -> None:
+        super().__init__(client)
+        self.actions = AsyncActions(client)
+        self.automations = AsyncAutomations(client)
+        self.campaigns = AsyncCampaigns(client)
+        self.contacts = AsyncContacts(client)
+        self.emails = AsyncEmails(client)
+        self.events = AsyncEvents(client)
+        self.contact_lists = AsyncContactLists(client)
+        self.messages = AsyncMessages(client)
+        self.templates = AsyncTemplates(client)
+        self.users = AsyncUsers(client)
+        self.account_details = AsyncAccountDetails(client)
+        self.account_tokens = AsyncAccountTokens(client)
+        self.link_tokens = AsyncLinkTokens(client)
+        self.available_actions = AsyncAvailableActions(client)
+        self.remote_keys = AsyncRemoteKeys(client)
+        self.issues = AsyncIssues(client)
+        self.common_model_scopes = AsyncCommonModelScopes(client)
+        self.passthrough_requests = AsyncPassthroughRequests(client)
+        self.sync_status = AsyncSyncStatus(client)
+        self.webhook_receivers = AsyncWebhookReceivers(client)
+        self.linked_accounts = AsyncLinkedAccounts(client)
+        self.selective_sync = AsyncSelectiveSync(client)