mergepythonclient 0.0.1__py3-none-any.whl

merge/types/ats/application_response.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+
+from ...types import shared
+from ..._models import BaseModel
+from ...types.ats import application
+
+__all__ = ["ApplicationResponse"]
+
+
+class ApplicationResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: application.Application
+    """# The Application Object
+
+    ### Description
+
+    The Application Object is used to represent a candidate's journey through a
+    particular Job's recruiting process. If a Candidate applies for multiple Jobs,
+    there will be a separate Application for each Job if the third-party integration
+    allows it.
+
+    ### Usage Example
+
+    Fetch from the `LIST Applications` endpoint and filter by `ID` to show all
+    applications.
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/ats/application_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__ = ["ApplicationRetrieveParams"]
+
+
+class ApplicationRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["candidate", "credited_to", "current_stage", "job", "reject_reason"]]
+    """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/applications/__init__.py

@@ -0,0 +1,5 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from .meta_for_create_params import MetaForCreateParams as MetaForCreateParams

merge/types/ats/applications/meta_for_create_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["MetaForCreateParams"]
+
+
+class MetaForCreateParams(TypedDict, total=False):
+    application_remote_template_id: str
+    """The template ID associated with the nested application in the request."""

merge/types/ats/attachment_create_params.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["AttachmentCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    attachment_type: Literal["RESUME", "COVER_LETTER", "OFFER_LETTER", "OTHER"]
+    """
+    - `RESUME` - RESUME
+    - `COVER_LETTER` - COVER_LETTER
+    - `OFFER_LETTER` - OFFER_LETTER
+    - `OTHER` - OTHER
+    """
+
+    candidate: Optional[str]
+
+    content_type: Optional[str]
+    """The attachment's file format."""
+
+    file_name: Optional[str]
+    """The attachment's name.
+
+    It is required to include the file extension in the attachment's name.
+    """
+
+    file_url: Optional[str]
+    """The attachment's url.
+
+    It is required to include the file extension in the file's URL.
+    """
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    ticket: Optional[str]
+    """The ticket associated with the attachment."""
+
+    uploaded_by: Optional[str]
+    """The user who uploaded the attachment."""
+
+
+class AttachmentCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Attachment Object
+
+    ### Description
+
+    The `Attachment` object is used to represent an attachment for a ticket.
+
+    ### Usage Example
+
+    TODO
+    """
+
+    remote_user_id: Required[str]

merge/types/ats/attachment_list_params.py

@@ -0,0 +1,63 @@
+# 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__ = ["AttachmentListParams"]
+
+
+class AttachmentListParams(TypedDict, total=False):
+    candidate_id: str
+    """If provided, will only return attachments for this candidate."""
+
+    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["candidate"]]
+    """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["attachment_type"]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    show_enum_origins: Literal["attachment_type"]
+    """Which fields should be returned in non-normalized form."""

merge/types/ats/attachment_response.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+
+from ...types import shared
+from ..._models import BaseModel
+
+__all__ = ["AttachmentResponse"]
+
+
+class AttachmentResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: shared.Attachment
+    """# The Attachment Object
+
+    ### Description
+
+    The `Attachment` object is used to represent an attachment for a ticket.
+
+    ### Usage Example
+
+    TODO
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/ats/attachment_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__ = ["AttachmentRetrieveParams"]
+
+
+class AttachmentRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["candidate"]]
+    """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["attachment_type"]
+    """Deprecated. Use show_enum_origins."""
+
+    show_enum_origins: Literal["attachment_type"]
+    """Which fields should be returned in non-normalized form."""

merge/types/ats/attachments/__init__.py

@@ -0,0 +1,3 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations

merge/types/ats/candidate.py

@@ -0,0 +1,128 @@
+# 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__ = ["Candidate", "PhoneNumber", "EmailAddress", "URL"]
+
+
+class PhoneNumber(BaseModel):
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    phone_number: Optional[str]
+    """The phone number."""
+
+    phone_number_type: Optional[Literal["HOME", "WORK", "MOBILE", "SKYPE", "OTHER"]]
+    """
+    - `HOME` - HOME
+    - `WORK` - WORK
+    - `MOBILE` - MOBILE
+    - `SKYPE` - SKYPE
+    - `OTHER` - OTHER
+    """
+
+    value: Optional[str]
+    """The phone number."""
+
+
+class EmailAddress(BaseModel):
+    email_address: Optional[str]
+    """The email address."""
+
+    email_address_type: Optional[Literal["PERSONAL", "WORK", "OTHER"]]
+    """
+    - `PERSONAL` - PERSONAL
+    - `WORK` - WORK
+    - `OTHER` - OTHER
+    """
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    value: Optional[str]
+    """The email address."""
+
+
+class URL(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 Candidate(BaseModel):
+    applications: Optional[List[Optional[str]]]
+    """Array of `Application` object IDs."""
+
+    attachments: Optional[List[Optional[str]]]
+    """Array of `Attachment` object IDs."""
+
+    can_email: Optional[bool]
+    """Whether or not the candidate can be emailed."""
+
+    company: Optional[str]
+    """The candidate's current company."""
+
+    email_addresses: Optional[List[EmailAddress]]
+
+    field_mappings: Optional[object]
+
+    first_name: Optional[str]
+    """The candidate's first name."""
+
+    id: Optional[str]
+
+    is_private: Optional[bool]
+    """Whether or not the candidate is private."""
+
+    last_interaction_at: Optional[datetime]
+    """When the most recent interaction with the candidate occurred."""
+
+    last_name: Optional[str]
+    """The candidate's last name."""
+
+    locations: Optional[List[Optional[str]]]
+    """The candidate's locations."""
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    phone_numbers: Optional[List[PhoneNumber]]
+
+    remote_created_at: Optional[datetime]
+    """When the third party's candidate 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 candidate was updated."""
+
+    remote_was_deleted: Optional[bool]
+
+    tags: Optional[List[Optional[str]]]
+    """Array of `Tag` names as strings."""
+
+    title: Optional[str]
+    """The candidate's current title."""
+
+    urls: Optional[List[URL]]

merge/types/ats/candidate_create_params.py

@@ -0,0 +1,137 @@
+# 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, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["CandidateCreateParams", "Model", "ModelPhoneNumber", "ModelEmailAddress", "ModelURL"]
+
+
+class ModelPhoneNumber(TypedDict, total=False):
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    phone_number: Optional[str]
+    """The phone number."""
+
+    phone_number_type: Literal["HOME", "WORK", "MOBILE", "SKYPE", "OTHER"]
+    """
+    - `HOME` - HOME
+    - `WORK` - WORK
+    - `MOBILE` - MOBILE
+    - `SKYPE` - SKYPE
+    - `OTHER` - OTHER
+    """
+
+    value: Optional[str]
+    """The phone number."""
+
+
+class ModelEmailAddress(TypedDict, total=False):
+    email_address: Optional[str]
+    """The email address."""
+
+    email_address_type: Literal["PERSONAL", "WORK", "OTHER"]
+    """
+    - `PERSONAL` - PERSONAL
+    - `WORK` - WORK
+    - `OTHER` - OTHER
+    """
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    value: Optional[str]
+    """The email address."""
+
+
+class ModelURL(TypedDict, total=False):
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    url_type: 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 Model(TypedDict, total=False):
+    applications: List[Optional[str]]
+    """Array of `Application` object IDs."""
+
+    attachments: List[Optional[str]]
+    """Array of `Attachment` object IDs."""
+
+    can_email: Optional[bool]
+    """Whether or not the candidate can be emailed."""
+
+    company: Optional[str]
+    """The candidate's current company."""
+
+    email_addresses: List[ModelEmailAddress]
+
+    first_name: Optional[str]
+    """The candidate's first name."""
+
+    integration_params: Optional[object]
+
+    is_private: Optional[bool]
+    """Whether or not the candidate is private."""
+
+    last_interaction_at: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """When the most recent interaction with the candidate occurred."""
+
+    last_name: Optional[str]
+    """The candidate's last name."""
+
+    linked_account_params: Optional[object]
+
+    locations: Optional[List[Optional[str]]]
+    """The candidate's locations."""
+
+    phone_numbers: List[ModelPhoneNumber]
+
+    remote_template_id: Optional[str]
+
+    tags: List[Optional[str]]
+    """Array of `Tag` names as strings."""
+
+    title: Optional[str]
+    """The candidate's current title."""
+
+    urls: List[ModelURL]
+
+
+class CandidateCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Candidate Object
+
+    ### Description
+
+    The `Candidate` object is used to represent profile information about a given
+    Candidate. Because it is specific to a Candidate, this information stays
+    constant across applications.
+
+    ### Usage Example
+
+    Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all
+    candidates.
+    """
+
+    remote_user_id: Required[str]

merge/types/ats/candidate_ignore_row_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["CandidateIgnoreRowParams"]
+
+
+class CandidateIgnoreRowParams(TypedDict, total=False):
+    reason: Required[Literal["GENERAL_CUSTOMER_REQUEST", "GDPR", "OTHER"]]
+    """
+    - `GENERAL_CUSTOMER_REQUEST` - GENERAL_CUSTOMER_REQUEST
+    - `GDPR` - GDPR
+    - `OTHER` - OTHER
+    """
+
+    message: str

merge/types/ats/candidate_list_params.py

@@ -0,0 +1,72 @@
+# 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__ = ["CandidateListParams"]
+
+
+class CandidateListParams(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."""
+
+    email_addresses: str
+    """
+    If provided, will only return candidates with these email addresses; multiple
+    addresses can be separated by commas.
+    """
+
+    expand: List[Literal["applications", "attachments"]]
+    """Which relations should be returned in expanded form.
+
+    Multiple relation names should be comma separated without spaces.
+    """
+
+    first_name: Optional[str]
+    """If provided, will only return candidates with this first name."""
+
+    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.
+    """
+
+    last_name: Optional[str]
+    """If provided, will only return candidates with this last name."""
+
+    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."""
+
+    tags: str
+    """
+    If provided, will only return candidates with these tags; multiple tags can be
+    separated by commas.
+    """

merge/types/ats/candidate_response.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+
+from ...types import shared
+from ..._models import BaseModel
+from ...types.ats import candidate
+
+__all__ = ["CandidateResponse"]
+
+
+class CandidateResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: candidate.Candidate
+    """# The Candidate Object
+
+    ### Description
+
+    The `Candidate` object is used to represent profile information about a given
+    Candidate. Because it is specific to a Candidate, this information stays
+    constant across applications.
+
+    ### Usage Example
+
+    Fetch from the `LIST Candidates` endpoint and filter by `ID` to show all
+    candidates.
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/ats/candidate_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__ = ["CandidateRetrieveParams"]
+
+
+class CandidateRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["applications", "attachments"]]
+    """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/candidates/__init__.py

@@ -0,0 +1,3 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations