mergepythonclient 0.0.1__py3-none-any.whl

merge/resources/crm/stages.py

@@ -0,0 +1,409 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from datetime import datetime
+
+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 (
+    Stage,
+    stage_list_params,
+    stage_retrieve_params,
+    stage_list_remote_field_classes_params,
+)
+from ...pagination import SyncPage, AsyncPage
+from ..._base_client import AsyncPaginator, make_request_options
+
+__all__ = ["Stages", "AsyncStages"]
+
+
+class Stages(SyncAPIResource):
+    def retrieve(
+        self,
+        id: str,
+        *,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_fields: 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,
+    ) -> Stage:
+        """
+        Returns a `Stage` object with the given `id`.
+
+        Args:
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
+              common models, in a normalized format.
+
+          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(
+            f"/crm/v1/stages/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "include_remote_data": include_remote_data,
+                        "include_remote_fields": include_remote_fields,
+                    },
+                    stage_retrieve_params.StageRetrieveParams,
+                ),
+            ),
+            cast_to=Stage,
+        )
+
+    def list(
+        self,
+        *,
+        created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        cursor: str | NotGiven = NOT_GIVEN,
+        include_deleted_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_fields: bool | NotGiven = NOT_GIVEN,
+        modified_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        modified_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        remote_id: Optional[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[Stage]:
+        """
+        Returns a list of `Stage` objects.
+
+        Args:
+          created_after: If provided, will only return objects created after this datetime.
+
+          created_before: If provided, will only return objects created before this datetime.
+
+          cursor: The pagination cursor value.
+
+          include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
+              common models, in a normalized format.
+
+          modified_after: If provided, only objects synced by Merge after this date time will be returned.
+
+          modified_before: If provided, only objects synced by Merge before this date time will be
+              returned.
+
+          page_size: Number of results to return per page.
+
+          remote_id: The API provider's ID for the given object.
+
+          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/stages",
+            page=SyncPage[Stage],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "created_after": created_after,
+                        "created_before": created_before,
+                        "cursor": cursor,
+                        "include_deleted_data": include_deleted_data,
+                        "include_remote_data": include_remote_data,
+                        "include_remote_fields": include_remote_fields,
+                        "modified_after": modified_after,
+                        "modified_before": modified_before,
+                        "page_size": page_size,
+                        "remote_id": remote_id,
+                    },
+                    stage_list_params.StageListParams,
+                ),
+            ),
+            model=Stage,
+        )
+
+    def list_remote_field_classes(
+        self,
+        *,
+        cursor: str | NotGiven = NOT_GIVEN,
+        include_deleted_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_fields: bool | NotGiven = NOT_GIVEN,
+        page_size: int | 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.RemoteFieldClass]:
+        """
+        Returns a list of `RemoteFieldClass` objects.
+
+        Args:
+          cursor: The pagination cursor value.
+
+          include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
+              common models, in a normalized format.
+
+          page_size: Number of results to return per page.
+
+          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/stages/remote-field-classes",
+            page=SyncPage[shared.RemoteFieldClass],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "include_deleted_data": include_deleted_data,
+                        "include_remote_data": include_remote_data,
+                        "include_remote_fields": include_remote_fields,
+                        "page_size": page_size,
+                    },
+                    stage_list_remote_field_classes_params.StageListRemoteFieldClassesParams,
+                ),
+            ),
+            model=shared.RemoteFieldClass,
+        )
+
+
+class AsyncStages(AsyncAPIResource):
+    async def retrieve(
+        self,
+        id: str,
+        *,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_fields: 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,
+    ) -> Stage:
+        """
+        Returns a `Stage` object with the given `id`.
+
+        Args:
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
+              common models, in a normalized format.
+
+          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._get(
+            f"/crm/v1/stages/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "include_remote_data": include_remote_data,
+                        "include_remote_fields": include_remote_fields,
+                    },
+                    stage_retrieve_params.StageRetrieveParams,
+                ),
+            ),
+            cast_to=Stage,
+        )
+
+    def list(
+        self,
+        *,
+        created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        cursor: str | NotGiven = NOT_GIVEN,
+        include_deleted_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_fields: bool | NotGiven = NOT_GIVEN,
+        modified_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        modified_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        remote_id: Optional[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[Stage, AsyncPage[Stage]]:
+        """
+        Returns a list of `Stage` objects.
+
+        Args:
+          created_after: If provided, will only return objects created after this datetime.
+
+          created_before: If provided, will only return objects created before this datetime.
+
+          cursor: The pagination cursor value.
+
+          include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
+              common models, in a normalized format.
+
+          modified_after: If provided, only objects synced by Merge after this date time will be returned.
+
+          modified_before: If provided, only objects synced by Merge before this date time will be
+              returned.
+
+          page_size: Number of results to return per page.
+
+          remote_id: The API provider's ID for the given object.
+
+          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/stages",
+            page=AsyncPage[Stage],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "created_after": created_after,
+                        "created_before": created_before,
+                        "cursor": cursor,
+                        "include_deleted_data": include_deleted_data,
+                        "include_remote_data": include_remote_data,
+                        "include_remote_fields": include_remote_fields,
+                        "modified_after": modified_after,
+                        "modified_before": modified_before,
+                        "page_size": page_size,
+                        "remote_id": remote_id,
+                    },
+                    stage_list_params.StageListParams,
+                ),
+            ),
+            model=Stage,
+        )
+
+    def list_remote_field_classes(
+        self,
+        *,
+        cursor: str | NotGiven = NOT_GIVEN,
+        include_deleted_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_fields: bool | NotGiven = NOT_GIVEN,
+        page_size: int | 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.RemoteFieldClass, AsyncPage[shared.RemoteFieldClass]]:
+        """
+        Returns a list of `RemoteFieldClass` objects.
+
+        Args:
+          cursor: The pagination cursor value.
+
+          include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
+              common models, in a normalized format.
+
+          page_size: Number of results to return per page.
+
+          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/stages/remote-field-classes",
+            page=AsyncPage[shared.RemoteFieldClass],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "include_deleted_data": include_deleted_data,
+                        "include_remote_data": include_remote_data,
+                        "include_remote_fields": include_remote_fields,
+                        "page_size": page_size,
+                    },
+                    stage_list_remote_field_classes_params.StageListRemoteFieldClassesParams,
+                ),
+            ),
+            model=shared.RemoteFieldClass,
+        )

merge/resources/crm/sync_status.py

@@ -0,0 +1,167 @@
+# 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 ..._utils import maybe_transform
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ...types.crm import SyncStatusResyncResponse, sync_status_list_params
+from ...pagination import SyncPage, AsyncPage
+from ..._base_client import AsyncPaginator, make_request_options
+
+__all__ = ["SyncStatus", "AsyncSyncStatus"]
+
+
+class SyncStatus(SyncAPIResource):
+    def list(
+        self,
+        *,
+        cursor: str | NotGiven = NOT_GIVEN,
+        page_size: int | 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.SyncStatus]:
+        """Get syncing status.
+
+        Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`,
+        `SYNCING`
+
+        Args:
+          cursor: The pagination cursor value.
+
+          page_size: Number of results to return per page.
+
+          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/sync-status",
+            page=SyncPage[shared.SyncStatus],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "page_size": page_size,
+                    },
+                    sync_status_list_params.SyncStatusListParams,
+                ),
+            ),
+            model=shared.SyncStatus,
+        )
+
+    def resync(
+        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,
+    ) -> SyncStatusResyncResponse:
+        """Force re-sync of all models.
+
+        This is available for all organizations via the
+        dashboard. Force re-sync is also available programmatically via API for monthly,
+        quarterly, and highest sync frequency customers on the Core, Professional, or
+        Enterprise plans. Doing so will consume a sync credit for the relevant linked
+        account.
+        """
+        return self._post(
+            "/crm/v1/sync-status/resync",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SyncStatusResyncResponse,
+        )
+
+
+class AsyncSyncStatus(AsyncAPIResource):
+    def list(
+        self,
+        *,
+        cursor: str | NotGiven = NOT_GIVEN,
+        page_size: int | 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.SyncStatus, AsyncPage[shared.SyncStatus]]:
+        """Get syncing status.
+
+        Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`,
+        `SYNCING`
+
+        Args:
+          cursor: The pagination cursor value.
+
+          page_size: Number of results to return per page.
+
+          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/sync-status",
+            page=AsyncPage[shared.SyncStatus],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "page_size": page_size,
+                    },
+                    sync_status_list_params.SyncStatusListParams,
+                ),
+            ),
+            model=shared.SyncStatus,
+        )
+
+    async def resync(
+        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,
+    ) -> SyncStatusResyncResponse:
+        """Force re-sync of all models.
+
+        This is available for all organizations via the
+        dashboard. Force re-sync is also available programmatically via API for monthly,
+        quarterly, and highest sync frequency customers on the Core, Professional, or
+        Enterprise plans. Doing so will consume a sync credit for the relevant linked
+        account.
+        """
+        return await self._post(
+            "/crm/v1/sync-status/resync",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SyncStatusResyncResponse,
+        )

merge/resources/crm/tasks/__init__.py

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

merge/resources/crm/tasks/meta.py

@@ -0,0 +1,92 @@
+# 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 `Task` POSTs."""
+        return self._get(
+            "/crm/v1/tasks/meta/post",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=shared.MetaResponse,
+        )
+
+    def for_update(
+        self,
+        id: str,
+        *,
+        # 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 `Task` PATCHs."""
+        return self._get(
+            f"/crm/v1/tasks/meta/patch/{id}",
+            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 `Task` POSTs."""
+        return await self._get(
+            "/crm/v1/tasks/meta/post",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=shared.MetaResponse,
+        )
+
+    async def for_update(
+        self,
+        id: str,
+        *,
+        # 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 `Task` PATCHs."""
+        return await self._get(
+            f"/crm/v1/tasks/meta/patch/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=shared.MetaResponse,
+        )