mergepythonclient 0.0.1__py3-none-any.whl

merge/resources/ats/jobs.py

@@ -0,0 +1,354 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._utils import maybe_transform
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ...types.ats import Job, job_list_params, job_retrieve_params
+from ...pagination import SyncPage, AsyncPage
+from ..._base_client import AsyncPaginator, make_request_options
+
+__all__ = ["Jobs", "AsyncJobs"]
+
+
+class Jobs(SyncAPIResource):
+    def retrieve(
+        self,
+        id: str,
+        *,
+        expand: List[Literal["departments", "hiring_managers", "offices", "recruiters"]] | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        remote_fields: Literal["status"] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["status"] | 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,
+    ) -> Job:
+        """
+        Returns a `Job` object with the given `id`.
+
+        Args:
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          remote_fields: Deprecated. Use show_enum_origins.
+
+          show_enum_origins: Which fields should be returned in non-normalized form.
+
+          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"/ats/v1/jobs/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "expand": expand,
+                        "include_remote_data": include_remote_data,
+                        "remote_fields": remote_fields,
+                        "show_enum_origins": show_enum_origins,
+                    },
+                    job_retrieve_params.JobRetrieveParams,
+                ),
+            ),
+            cast_to=Job,
+        )
+
+    def list(
+        self,
+        *,
+        code: Optional[str] | NotGiven = NOT_GIVEN,
+        created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        cursor: str | NotGiven = NOT_GIVEN,
+        expand: List[Literal["departments", "hiring_managers", "offices", "recruiters"]] | NotGiven = NOT_GIVEN,
+        include_deleted_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        modified_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        modified_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        offices: str | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        remote_fields: Literal["status"] | NotGiven = NOT_GIVEN,
+        remote_id: Optional[str] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["status"] | NotGiven = NOT_GIVEN,
+        status: Optional[Literal["ARCHIVED", "CLOSED", "DRAFT", "OPEN", "PENDING"]] | 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[Job]:
+        """
+        Returns a list of `Job` objects.
+
+        Args:
+          code: If provided, will only return jobs with this code.
+
+          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.
+
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          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.
+
+          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.
+
+          offices: If provided, will only return jobs for this office; multiple offices can be
+              separated by commas.
+
+          page_size: Number of results to return per page.
+
+          remote_fields: Deprecated. Use show_enum_origins.
+
+          remote_id: The API provider's ID for the given object.
+
+          show_enum_origins: Which fields should be returned in non-normalized form.
+
+          status: If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED',
+              'DRAFT', 'ARCHIVED', 'PENDING')
+
+              - `OPEN` - OPEN
+              - `CLOSED` - CLOSED
+              - `DRAFT` - DRAFT
+              - `ARCHIVED` - ARCHIVED
+              - `PENDING` - PENDING
+
+          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(
+            "/ats/v1/jobs",
+            page=SyncPage[Job],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "code": code,
+                        "created_after": created_after,
+                        "created_before": created_before,
+                        "cursor": cursor,
+                        "expand": expand,
+                        "include_deleted_data": include_deleted_data,
+                        "include_remote_data": include_remote_data,
+                        "modified_after": modified_after,
+                        "modified_before": modified_before,
+                        "offices": offices,
+                        "page_size": page_size,
+                        "remote_fields": remote_fields,
+                        "remote_id": remote_id,
+                        "show_enum_origins": show_enum_origins,
+                        "status": status,
+                    },
+                    job_list_params.JobListParams,
+                ),
+            ),
+            model=Job,
+        )
+
+
+class AsyncJobs(AsyncAPIResource):
+    async def retrieve(
+        self,
+        id: str,
+        *,
+        expand: List[Literal["departments", "hiring_managers", "offices", "recruiters"]] | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        remote_fields: Literal["status"] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["status"] | 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,
+    ) -> Job:
+        """
+        Returns a `Job` object with the given `id`.
+
+        Args:
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          include_remote_data: Whether to include the original data Merge fetched from the third-party to
+              produce these models.
+
+          remote_fields: Deprecated. Use show_enum_origins.
+
+          show_enum_origins: Which fields should be returned in non-normalized form.
+
+          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"/ats/v1/jobs/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "expand": expand,
+                        "include_remote_data": include_remote_data,
+                        "remote_fields": remote_fields,
+                        "show_enum_origins": show_enum_origins,
+                    },
+                    job_retrieve_params.JobRetrieveParams,
+                ),
+            ),
+            cast_to=Job,
+        )
+
+    def list(
+        self,
+        *,
+        code: Optional[str] | NotGiven = NOT_GIVEN,
+        created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        cursor: str | NotGiven = NOT_GIVEN,
+        expand: List[Literal["departments", "hiring_managers", "offices", "recruiters"]] | NotGiven = NOT_GIVEN,
+        include_deleted_data: bool | NotGiven = NOT_GIVEN,
+        include_remote_data: bool | NotGiven = NOT_GIVEN,
+        modified_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        modified_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
+        offices: str | NotGiven = NOT_GIVEN,
+        page_size: int | NotGiven = NOT_GIVEN,
+        remote_fields: Literal["status"] | NotGiven = NOT_GIVEN,
+        remote_id: Optional[str] | NotGiven = NOT_GIVEN,
+        show_enum_origins: Literal["status"] | NotGiven = NOT_GIVEN,
+        status: Optional[Literal["ARCHIVED", "CLOSED", "DRAFT", "OPEN", "PENDING"]] | 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[Job, AsyncPage[Job]]:
+        """
+        Returns a list of `Job` objects.
+
+        Args:
+          code: If provided, will only return jobs with this code.
+
+          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.
+
+          expand: Which relations should be returned in expanded form. Multiple relation names
+              should be comma separated without spaces.
+
+          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.
+
+          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.
+
+          offices: If provided, will only return jobs for this office; multiple offices can be
+              separated by commas.
+
+          page_size: Number of results to return per page.
+
+          remote_fields: Deprecated. Use show_enum_origins.
+
+          remote_id: The API provider's ID for the given object.
+
+          show_enum_origins: Which fields should be returned in non-normalized form.
+
+          status: If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED',
+              'DRAFT', 'ARCHIVED', 'PENDING')
+
+              - `OPEN` - OPEN
+              - `CLOSED` - CLOSED
+              - `DRAFT` - DRAFT
+              - `ARCHIVED` - ARCHIVED
+              - `PENDING` - PENDING
+
+          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(
+            "/ats/v1/jobs",
+            page=AsyncPage[Job],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "code": code,
+                        "created_after": created_after,
+                        "created_before": created_before,
+                        "cursor": cursor,
+                        "expand": expand,
+                        "include_deleted_data": include_deleted_data,
+                        "include_remote_data": include_remote_data,
+                        "modified_after": modified_after,
+                        "modified_before": modified_before,
+                        "offices": offices,
+                        "page_size": page_size,
+                        "remote_fields": remote_fields,
+                        "remote_id": remote_id,
+                        "show_enum_origins": show_enum_origins,
+                        "status": status,
+                    },
+                    job_list_params.JobListParams,
+                ),
+            ),
+            model=Job,
+        )

merge/resources/ats/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.ats 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(
+            "/ats/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(
+            "/ats/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,
+        )