mergepythonclient 0.0.1__py3-none-any.whl

merge/types/hris/employment_list_params.py

@@ -0,0 +1,98 @@
+# 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__ = ["EmploymentListParams"]
+
+
+class EmploymentListParams(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."""
+
+    employee_id: str
+    """If provided, will only return employments for this employee."""
+
+    expand: List[Literal["employee", "pay_group"]]
+    """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.
+    """
+
+    order_by: Literal["-effective_date", "effective_date"]
+    """Overrides the default ordering for this endpoint."""
+
+    page_size: int
+    """Number of results to return per page."""
+
+    remote_fields: Literal[
+        "employment_type",
+        "employment_type,flsa_status",
+        "employment_type,flsa_status,pay_frequency",
+        "employment_type,flsa_status,pay_frequency,pay_period",
+        "employment_type,flsa_status,pay_period",
+        "employment_type,pay_frequency",
+        "employment_type,pay_frequency,pay_period",
+        "employment_type,pay_period",
+        "flsa_status",
+        "flsa_status,pay_frequency",
+        "flsa_status,pay_frequency,pay_period",
+        "flsa_status,pay_period",
+        "pay_frequency",
+        "pay_frequency,pay_period",
+        "pay_period",
+    ]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    show_enum_origins: Literal[
+        "employment_type",
+        "employment_type,flsa_status",
+        "employment_type,flsa_status,pay_frequency",
+        "employment_type,flsa_status,pay_frequency,pay_period",
+        "employment_type,flsa_status,pay_period",
+        "employment_type,pay_frequency",
+        "employment_type,pay_frequency,pay_period",
+        "employment_type,pay_period",
+        "flsa_status",
+        "flsa_status,pay_frequency",
+        "flsa_status,pay_frequency,pay_period",
+        "flsa_status,pay_period",
+        "pay_frequency",
+        "pay_frequency,pay_period",
+        "pay_period",
+    ]
+    """Which fields should be returned in non-normalized form."""

merge/types/hris/employment_retrieve_params.py

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["EmploymentRetrieveParams"]
+
+
+class EmploymentRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["employee", "pay_group"]]
+    """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[
+        "employment_type",
+        "employment_type,flsa_status",
+        "employment_type,flsa_status,pay_frequency",
+        "employment_type,flsa_status,pay_frequency,pay_period",
+        "employment_type,flsa_status,pay_period",
+        "employment_type,pay_frequency",
+        "employment_type,pay_frequency,pay_period",
+        "employment_type,pay_period",
+        "flsa_status",
+        "flsa_status,pay_frequency",
+        "flsa_status,pay_frequency,pay_period",
+        "flsa_status,pay_period",
+        "pay_frequency",
+        "pay_frequency,pay_period",
+        "pay_period",
+    ]
+    """Deprecated. Use show_enum_origins."""
+
+    show_enum_origins: Literal[
+        "employment_type",
+        "employment_type,flsa_status",
+        "employment_type,flsa_status,pay_frequency",
+        "employment_type,flsa_status,pay_frequency,pay_period",
+        "employment_type,flsa_status,pay_period",
+        "employment_type,pay_frequency",
+        "employment_type,pay_frequency,pay_period",
+        "employment_type,pay_period",
+        "flsa_status",
+        "flsa_status,pay_frequency",
+        "flsa_status,pay_frequency,pay_period",
+        "flsa_status,pay_period",
+        "pay_frequency",
+        "pay_frequency,pay_period",
+        "pay_period",
+    ]
+    """Which fields should be returned in non-normalized form."""

merge/types/hris/group.py

@@ -0,0 +1,42 @@
+# 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__ = ["Group"]
+
+
+class Group(BaseModel):
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    name: Optional[str]
+    """The group name."""
+
+    parent_group: Optional[str]
+    """The parent group for this group."""
+
+    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."""
+
+    type: Optional[Literal["TEAM", "DEPARTMENT", "COST_CENTER", "BUSINESS_UNIT", "GROUP"]]
+    """
+    - `TEAM` - TEAM
+    - `DEPARTMENT` - DEPARTMENT
+    - `COST_CENTER` - COST_CENTER
+    - `BUSINESS_UNIT` - BUSINESS_UNIT
+    - `GROUP` - GROUP
+    """

merge/types/hris/group_list_params.py

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["GroupListParams"]
+
+
+class GroupListParams(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."""
+
+    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["type"]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    show_enum_origins: Literal["type"]
+    """Which fields should be returned in non-normalized form."""
+
+    types: str
+    """If provided, will only return groups of these types.
+
+    Multiple values can be separated by commas.
+    """

merge/types/hris/group_retrieve_params.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["GroupRetrieveParams"]
+
+
+class GroupRetrieveParams(TypedDict, total=False):
+    include_remote_data: bool
+    """
+    Whether to include the original data Merge fetched from the third-party to
+    produce these models.
+    """
+
+    remote_fields: Literal["type"]
+    """Deprecated. Use show_enum_origins."""
+
+    show_enum_origins: Literal["type"]
+    """Which fields should be returned in non-normalized form."""

merge/types/hris/issue_list_params.py

@@ -0,0 +1,72 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["IssueListParams"]
+
+
+class IssueListParams(TypedDict, total=False):
+    account_token: str
+
+    cursor: str
+    """The pagination cursor value."""
+
+    end_date: str
+    """
+    If included, will only include issues whose most recent action occurred before
+    this time
+    """
+
+    end_user_organization_name: str
+
+    first_incident_time_after: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    If provided, will only return issues whose first incident time was after this
+    datetime.
+    """
+
+    first_incident_time_before: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    If provided, will only return issues whose first incident time was before this
+    datetime.
+    """
+
+    include_muted: str
+    """If True, will include muted issues"""
+
+    integration_name: str
+
+    last_incident_time_after: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    If provided, will only return issues whose first incident time was after this
+    datetime.
+    """
+
+    last_incident_time_before: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    If provided, will only return issues whose first incident time was before this
+    datetime.
+    """
+
+    page_size: int
+    """Number of results to return per page."""
+
+    start_date: str
+    """
+    If included, will only include issues whose most recent action occurred after
+    this time
+    """
+
+    status: Literal["ONGOING", "RESOLVED"]
+    """- `ONGOING` - ONGOING
+    - `RESOLVED` - RESOLVED
+
+    - `ONGOING` - ONGOING
+    - `RESOLVED` - RESOLVED
+    """

merge/types/hris/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/hris/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`"""