mergepythonclient 0.0.1__py3-none-any.whl

merge/types/ats/job.py

@@ -0,0 +1,91 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ...types import shared
+from ..._models import BaseModel
+
+__all__ = ["Job", "JobPostingURL"]
+
+
+class JobPostingURL(BaseModel):
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    url_type: Optional[Literal["PERSONAL", "COMPANY", "PORTFOLIO", "BLOG", "SOCIAL_MEDIA", "OTHER", "JOB_POSTING"]]
+    """
+    - `PERSONAL` - PERSONAL
+    - `COMPANY` - COMPANY
+    - `PORTFOLIO` - PORTFOLIO
+    - `BLOG` - BLOG
+    - `SOCIAL_MEDIA` - SOCIAL_MEDIA
+    - `OTHER` - OTHER
+    - `JOB_POSTING` - JOB_POSTING
+    """
+
+    value: Optional[str]
+    """The site's url."""
+
+
+class Job(BaseModel):
+    code: Optional[str]
+    """The job's code.
+
+    Typically an additional identifier used to reference the particular job that is
+    displayed on the ATS.
+    """
+
+    confidential: Optional[bool]
+    """Whether the job is confidential."""
+
+    departments: Optional[List[Optional[str]]]
+    """IDs of `Department` objects for this `Job`."""
+
+    description: Optional[str]
+    """The job's description."""
+
+    field_mappings: Optional[object]
+
+    hiring_managers: Optional[List[Optional[str]]]
+    """IDs of `RemoteUser` objects that serve as hiring managers for this `Job`."""
+
+    id: Optional[str]
+
+    job_posting_urls: Optional[List[JobPostingURL]]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    name: Optional[str]
+    """The job's name."""
+
+    offices: Optional[List[Optional[str]]]
+    """IDs of `Office` objects for this `Job`."""
+
+    recruiters: Optional[List[Optional[str]]]
+    """IDs of `RemoteUser` objects that serve as recruiters for this `Job`."""
+
+    remote_created_at: Optional[datetime]
+    """When the third party's job was created."""
+
+    remote_data: Optional[List[shared.RemoteData]]
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""
+
+    remote_updated_at: Optional[datetime]
+    """When the third party's job was updated."""
+
+    remote_was_deleted: Optional[bool]
+    """Indicates whether or not this object has been deleted by third party webhooks."""
+
+    status: Optional[Literal["OPEN", "CLOSED", "DRAFT", "ARCHIVED", "PENDING"]]
+    """
+    - `OPEN` - OPEN
+    - `CLOSED` - CLOSED
+    - `DRAFT` - DRAFT
+    - `ARCHIVED` - ARCHIVED
+    - `PENDING` - PENDING
+    """

merge/types/ats/job_interview_stage.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ...types import shared
+from ..._models import BaseModel
+
+__all__ = ["JobInterviewStage"]
+
+
+class JobInterviewStage(BaseModel):
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    job: Optional[str]
+    """This field is populated only if the stage is specific to a particular job.
+
+    If the stage is generic, this field will not be populated.
+    """
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    name: Optional[str]
+    """Standard stage names are offered by ATS systems but can be modified by users."""
+
+    remote_data: Optional[List[shared.RemoteData]]
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""
+
+    remote_was_deleted: Optional[bool]
+    """Indicates whether or not this object has been deleted by third party webhooks."""

merge/types/ats/job_interview_stage_list_params.py

@@ -0,0 +1,57 @@
+# 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, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["JobInterviewStageListParams"]
+
+
+class JobInterviewStageListParams(TypedDict, total=False):
+    created_after: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """If provided, will only return objects created after this datetime."""
+
+    created_before: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """If provided, will only return objects created before this datetime."""
+
+    cursor: str
+    """The pagination cursor value."""
+
+    expand: List[Literal["job"]]
+    """Which relations should be returned in expanded form.
+
+    Multiple relation names should be comma separated without spaces.
+    """
+
+    include_deleted_data: bool
+    """Whether to include data that was marked as deleted by third party webhooks."""
+
+    include_remote_data: bool
+    """
+    Whether to include the original data Merge fetched from the third-party to
+    produce these models.
+    """
+
+    job_id: str
+    """If provided, will only return interview stages for this job."""
+
+    modified_after: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """
+    If provided, only objects synced by Merge after this date time will be returned.
+    """
+
+    modified_before: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """
+    If provided, only objects synced by Merge before this date time will be
+    returned.
+    """
+
+    page_size: int
+    """Number of results to return per page."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""

merge/types/ats/job_interview_stage_retrieve_params.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["JobInterviewStageRetrieveParams"]
+
+
+class JobInterviewStageRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["job"]]
+    """Which relations should be returned in expanded form.
+
+    Multiple relation names should be comma separated without spaces.
+    """
+
+    include_remote_data: bool
+    """
+    Whether to include the original data Merge fetched from the third-party to
+    produce these models.
+    """

merge/types/ats/job_list_params.py

@@ -0,0 +1,81 @@
+# 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, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["JobListParams"]
+
+
+class JobListParams(TypedDict, total=False):
+    code: Optional[str]
+    """If provided, will only return jobs with this code."""
+
+    created_after: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """If provided, will only return objects created after this datetime."""
+
+    created_before: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """If provided, will only return objects created before this datetime."""
+
+    cursor: str
+    """The pagination cursor value."""
+
+    expand: List[Literal["departments", "hiring_managers", "offices", "recruiters"]]
+    """Which relations should be returned in expanded form.
+
+    Multiple relation names should be comma separated without spaces.
+    """
+
+    include_deleted_data: bool
+    """Whether to include data that was marked as deleted by third party webhooks."""
+
+    include_remote_data: bool
+    """
+    Whether to include the original data Merge fetched from the third-party to
+    produce these models.
+    """
+
+    modified_after: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """
+    If provided, only objects synced by Merge after this date time will be returned.
+    """
+
+    modified_before: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """
+    If provided, only objects synced by Merge before this date time will be
+    returned.
+    """
+
+    offices: str
+    """
+    If provided, will only return jobs for this office; multiple offices can be
+    separated by commas.
+    """
+
+    page_size: int
+    """Number of results to return per page."""
+
+    remote_fields: Literal["status"]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    show_enum_origins: Literal["status"]
+    """Which fields should be returned in non-normalized form."""
+
+    status: Optional[Literal["ARCHIVED", "CLOSED", "DRAFT", "OPEN", "PENDING"]]
+    """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
+    """

merge/types/ats/job_retrieve_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["JobRetrieveParams"]
+
+
+class JobRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["departments", "hiring_managers", "offices", "recruiters"]]
+    """Which relations should be returned in expanded form.
+
+    Multiple relation names should be comma separated without spaces.
+    """
+
+    include_remote_data: bool
+    """
+    Whether to include the original data Merge fetched from the third-party to
+    produce these models.
+    """
+
+    remote_fields: Literal["status"]
+    """Deprecated. Use show_enum_origins."""
+
+    show_enum_origins: Literal["status"]
+    """Which fields should be returned in non-normalized form."""

merge/types/ats/link_token_create_params.py

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["LinkTokenCreateParams", "CommonModel"]
+
+
+class CommonModel(TypedDict, total=False):
+    disabled_fields: Required[List[str]]
+
+    enabled_actions: Required[List[Literal["READ", "WRITE"]]]
+
+    model_id: Required[str]
+
+
+class LinkTokenCreateParams(TypedDict, total=False):
+    categories: Required[List[Literal["hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage"]]]
+    """The integration categories to show in Merge Link."""
+
+    end_user_email_address: Required[str]
+    """Your end user's email address.
+
+    This is purely for identification purposes - setting this value will not cause
+    any emails to be sent.
+    """
+
+    end_user_organization_name: Required[str]
+    """Your end user's organization."""
+
+    end_user_origin_id: Required[str]
+    """
+    This unique identifier typically represents the ID for your end user in your
+    product's database. This value must be distinct from other Linked Accounts'
+    unique identifiers.
+    """
+
+    common_models: Optional[List[CommonModel]]
+    """
+    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: Optional[str]
+    """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: int
+    """
+    An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL]
+    for how long this token is valid. Defaults to 30.
+    """
+
+    should_create_magic_link_url: Optional[bool]
+    """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/.
+    """

merge/types/ats/linked_account_list_params.py

@@ -0,0 +1,89 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["LinkedAccountListParams"]
+
+
+class LinkedAccountListParams(TypedDict, total=False):
+    category: Optional[Literal["accounting", "ats", "crm", "filestorage", "hris", "mktg", "ticketing"]]
+    """
+    - `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: str
+    """The pagination cursor value."""
+
+    end_user_email_address: str
+    """
+    If provided, will only return linked accounts associated with the given email
+    address.
+    """
+
+    end_user_organization_name: str
+    """
+    If provided, will only return linked accounts associated with the given
+    organization name.
+    """
+
+    end_user_origin_id: str
+    """
+    If provided, will only return linked accounts associated with the given origin
+    ID.
+    """
+
+    end_user_origin_ids: str
+    """
+    Comma-separated list of EndUser origin IDs, making it possible to specify
+    multiple EndUsers at once.
+    """
+
+    id: str
+
+    ids: str
+    """
+    Comma-separated list of LinkedAccount IDs, making it possible to specify
+    multiple LinkedAccounts at once.
+    """
+
+    include_duplicates: bool
+    """
+    If `true`, will include complete production duplicates of the account specified
+    by the `id` query parameter in the response. `id` must be for a complete
+    production linked account.
+    """
+
+    integration_name: str
+    """
+    If provided, will only return linked accounts associated with the given
+    integration name.
+    """
+
+    is_test_account: str
+    """If included, will only include test linked accounts.
+
+    If not included, will only include non-test linked accounts.
+    """
+
+    page_size: int
+    """Number of results to return per page."""
+
+    status: str
+    """Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`"""

merge/types/ats/offer.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ...types import shared
+from ..._models import BaseModel
+
+__all__ = ["Offer"]
+
+
+class Offer(BaseModel):
+    application: Optional[str]
+    """The application who is receiving the offer."""
+
+    closed_at: Optional[datetime]
+    """When the offer was closed."""
+
+    creator: Optional[str]
+    """The user who created the offer."""
+
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    remote_created_at: Optional[datetime]
+    """When the third party's offer was created."""
+
+    remote_data: Optional[List[shared.RemoteData]]
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""
+
+    remote_was_deleted: Optional[bool]
+    """Indicates whether or not this object has been deleted by third party webhooks."""
+
+    sent_at: Optional[datetime]
+    """When the offer was sent."""
+
+    start_date: Optional[datetime]
+    """The employment start date on the offer."""
+
+    status: Optional[
+        Literal[
+            "DRAFT", "APPROVAL-SENT", "APPROVED", "SENT", "SENT-MANUALLY", "OPENED", "DENIED", "SIGNED", "DEPRECATED"
+        ]
+    ]
+    """
+    - `DRAFT` - DRAFT
+    - `APPROVAL-SENT` - APPROVAL-SENT
+    - `APPROVED` - APPROVED
+    - `SENT` - SENT
+    - `SENT-MANUALLY` - SENT-MANUALLY
+    - `OPENED` - OPENED
+    - `DENIED` - DENIED
+    - `SIGNED` - SIGNED
+    - `DEPRECATED` - DEPRECATED
+    """

merge/types/ats/offer_list_params.py

@@ -0,0 +1,66 @@
+# 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, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["OfferListParams"]
+
+
+class OfferListParams(TypedDict, total=False):
+    application_id: str
+    """If provided, will only return offers for this application."""
+
+    created_after: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """If provided, will only return objects created after this datetime."""
+
+    created_before: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """If provided, will only return objects created before this datetime."""
+
+    creator_id: str
+    """If provided, will only return offers created by this user."""
+
+    cursor: str
+    """The pagination cursor value."""
+
+    expand: List[Literal["application", "creator"]]
+    """Which relations should be returned in expanded form.
+
+    Multiple relation names should be comma separated without spaces.
+    """
+
+    include_deleted_data: bool
+    """Whether to include data that was marked as deleted by third party webhooks."""
+
+    include_remote_data: bool
+    """
+    Whether to include the original data Merge fetched from the third-party to
+    produce these models.
+    """
+
+    modified_after: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """
+    If provided, only objects synced by Merge after this date time will be returned.
+    """
+
+    modified_before: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """
+    If provided, only objects synced by Merge before this date time will be
+    returned.
+    """
+
+    page_size: int
+    """Number of results to return per page."""
+
+    remote_fields: Literal["status"]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    show_enum_origins: Literal["status"]
+    """Which fields should be returned in non-normalized form."""

merge/types/ats/offer_retrieve_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["OfferRetrieveParams"]
+
+
+class OfferRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["application", "creator"]]
+    """Which relations should be returned in expanded form.
+
+    Multiple relation names should be comma separated without spaces.
+    """
+
+    include_remote_data: bool
+    """
+    Whether to include the original data Merge fetched from the third-party to
+    produce these models.
+    """
+
+    remote_fields: Literal["status"]
+    """Deprecated. Use show_enum_origins."""
+
+    show_enum_origins: Literal["status"]
+    """Which fields should be returned in non-normalized form."""

merge/types/ats/office.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ...types import shared
+from ..._models import BaseModel
+
+__all__ = ["Office"]
+
+
+class Office(BaseModel):
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    location: Optional[str]
+    """The office's location."""
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    name: Optional[str]
+    """The office's name."""
+
+    remote_data: Optional[List[shared.RemoteData]]
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""
+
+    remote_was_deleted: Optional[bool]
+    """Indicates whether or not this object has been deleted by third party webhooks."""