mergepythonclient 0.0.1__py3-none-any.whl

merge/types/hris/payroll_run_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__ = ["PayrollRunRetrieveParams"]
+
+
+class PayrollRunRetrieveParams(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["run_state", "run_state,run_type", "run_type"]
+    """Deprecated. Use show_enum_origins."""
+
+    show_enum_origins: Literal["run_state", "run_state,run_type", "run_type"]
+    """Which fields should be returned in non-normalized form."""

merge/types/hris/remote_key_generate_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["RemoteKeyGenerateParams"]
+
+
+class RemoteKeyGenerateParams(TypedDict, total=False):
+    name: Required[str]

merge/types/hris/remote_key_regenerate_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["RemoteKeyRegenerateParams"]
+
+
+class RemoteKeyRegenerateParams(TypedDict, total=False):
+    name: Required[str]

merge/types/hris/selective_sync_list_configurations_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List
+
+from ...types.shared import linked_account_selective_sync_configuration
+
+__all__ = ["SelectiveSyncListConfigurationsResponse"]
+
+SelectiveSyncListConfigurationsResponse = List[
+    linked_account_selective_sync_configuration.LinkedAccountSelectiveSyncConfiguration
+]

merge/types/hris/selective_sync_list_metadata_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["SelectiveSyncListMetadataParams"]
+
+
+class SelectiveSyncListMetadataParams(TypedDict, total=False):
+    common_model: str
+
+    cursor: str
+    """The pagination cursor value."""
+
+    page_size: int
+    """Number of results to return per page."""

merge/types/hris/selective_sync_replace_configurations_params.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Required, TypedDict
+
+__all__ = ["SelectiveSyncReplaceConfigurationsParams", "SyncConfiguration", "SyncConfigurationLinkedAccountCondition"]
+
+
+class SyncConfigurationLinkedAccountCondition(TypedDict, total=False):
+    condition_schema_id: Required[str]
+    """The ID indicating which condition schema to use for a specific condition."""
+
+    operator: Required[str]
+    """The operator for a specific condition."""
+
+    value: Required[object]
+    """The value for a specific condition."""
+
+
+class SyncConfiguration(TypedDict, total=False):
+    linked_account_conditions: Required[List[SyncConfigurationLinkedAccountCondition]]
+    """The conditions belonging to a selective sync."""
+
+
+class SelectiveSyncReplaceConfigurationsParams(TypedDict, total=False):
+    sync_configurations: Required[List[SyncConfiguration]]
+    """The selective syncs associated with a linked account."""

merge/types/hris/selective_sync_replace_configurations_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List
+
+from ...types.shared import linked_account_selective_sync_configuration
+
+__all__ = ["SelectiveSyncReplaceConfigurationsResponse"]
+
+SelectiveSyncReplaceConfigurationsResponse = List[
+    linked_account_selective_sync_configuration.LinkedAccountSelectiveSyncConfiguration
+]

merge/types/hris/sync_status_list_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["SyncStatusListParams"]
+
+
+class SyncStatusListParams(TypedDict, total=False):
+    cursor: str
+    """The pagination cursor value."""
+
+    page_size: int
+    """Number of results to return per page."""

merge/types/hris/sync_status_resync_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List
+
+from ...types.shared import sync_status
+
+__all__ = ["SyncStatusResyncResponse"]
+
+SyncStatusResyncResponse = List[sync_status.SyncStatus]

merge/types/hris/team_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__ = ["TeamListParams"]
+
+
+class TeamListParams(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["parent_team"]]
+    """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."""
+
+    parent_team_id: str
+    """If provided, will only return teams with this parent team."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""

merge/types/hris/team_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__ = ["TeamRetrieveParams"]
+
+
+class TeamRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["parent_team"]]
+    """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/hris/time_off/__init__.py

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

merge/types/hris/time_off/time_off.py

@@ -0,0 +1,69 @@
+# 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__ = ["TimeOff"]
+
+
+class TimeOff(BaseModel):
+    amount: Optional[float]
+    """The time off quantity measured by the prescribed “units”."""
+
+    approver: Optional[str]
+    """The Merge ID of the employee with the ability to approve the time off request."""
+
+    employee: Optional[str]
+    """The employee requesting time off."""
+
+    employee_note: Optional[str]
+    """The employee note for this time off request."""
+
+    end_time: Optional[datetime]
+    """The day and time of the end of the time requested off."""
+
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    remote_data: Optional[List[shared.RemoteData]]
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""
+
+    remote_was_deleted: Optional[bool]
+
+    request_type: Optional[Literal["VACATION", "SICK", "PERSONAL", "JURY_DUTY", "VOLUNTEER", "BEREAVEMENT"]]
+    """
+    - `VACATION` - VACATION
+    - `SICK` - SICK
+    - `PERSONAL` - PERSONAL
+    - `JURY_DUTY` - JURY_DUTY
+    - `VOLUNTEER` - VOLUNTEER
+    - `BEREAVEMENT` - BEREAVEMENT
+    """
+
+    start_time: Optional[datetime]
+    """The day and time of the start of the time requested off."""
+
+    status: Optional[Literal["REQUESTED", "APPROVED", "DECLINED", "CANCELLED", "DELETED"]]
+    """
+    - `REQUESTED` - REQUESTED
+    - `APPROVED` - APPROVED
+    - `DECLINED` - DECLINED
+    - `CANCELLED` - CANCELLED
+    - `DELETED` - DELETED
+    """
+
+    units: Optional[Literal["HOURS", "DAYS"]]
+    """
+    - `HOURS` - HOURS
+    - `DAYS` - DAYS
+    """

merge/types/hris/time_off_balance.py

@@ -0,0 +1,46 @@
+# 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__ = ["TimeOffBalance"]
+
+
+class TimeOffBalance(BaseModel):
+    balance: Optional[float]
+    """The current remaining PTO balance, always measured in terms of hours."""
+
+    employee: Optional[str]
+    """The employee the balance belongs to."""
+
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    policy_type: Optional[Literal["VACATION", "SICK", "PERSONAL", "JURY_DUTY", "VOLUNTEER", "BEREAVEMENT"]]
+    """
+    - `VACATION` - VACATION
+    - `SICK` - SICK
+    - `PERSONAL` - PERSONAL
+    - `JURY_DUTY` - JURY_DUTY
+    - `VOLUNTEER` - VOLUNTEER
+    - `BEREAVEMENT` - BEREAVEMENT
+    """
+
+    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."""
+
+    used: Optional[float]
+    """The amount of PTO used in terms of hours."""

merge/types/hris/time_off_balance_list_params.py

@@ -0,0 +1,77 @@
+# 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__ = ["TimeOffBalanceListParams"]
+
+
+class TimeOffBalanceListParams(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 time off balances for this employee."""
+
+    expand: List[Literal["employee"]]
+    """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."""
+
+    policy_type: Optional[Literal["BEREAVEMENT", "JURY_DUTY", "PERSONAL", "SICK", "VACATION", "VOLUNTEER"]]
+    """If provided, will only return TimeOffBalance with this policy type.
+
+    Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER',
+    'BEREAVEMENT')
+
+    - `VACATION` - VACATION
+    - `SICK` - SICK
+    - `PERSONAL` - PERSONAL
+    - `JURY_DUTY` - JURY_DUTY
+    - `VOLUNTEER` - VOLUNTEER
+    - `BEREAVEMENT` - BEREAVEMENT
+    """
+
+    remote_fields: Literal["policy_type"]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    show_enum_origins: Literal["policy_type"]
+    """Which fields should be returned in non-normalized form."""

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

merge/types/hris/time_off_create_params.py

@@ -0,0 +1,75 @@
+# 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, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["TimeOffCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    amount: Optional[float]
+    """The time off quantity measured by the prescribed “units”."""
+
+    approver: Optional[str]
+    """The Merge ID of the employee with the ability to approve the time off request."""
+
+    employee: Optional[str]
+    """The employee requesting time off."""
+
+    employee_note: Optional[str]
+    """The employee note for this time off request."""
+
+    end_time: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """The day and time of the end of the time requested off."""
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    request_type: Literal["VACATION", "SICK", "PERSONAL", "JURY_DUTY", "VOLUNTEER", "BEREAVEMENT"]
+    """
+    - `VACATION` - VACATION
+    - `SICK` - SICK
+    - `PERSONAL` - PERSONAL
+    - `JURY_DUTY` - JURY_DUTY
+    - `VOLUNTEER` - VOLUNTEER
+    - `BEREAVEMENT` - BEREAVEMENT
+    """
+
+    start_time: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """The day and time of the start of the time requested off."""
+
+    status: Literal["REQUESTED", "APPROVED", "DECLINED", "CANCELLED", "DELETED"]
+    """
+    - `REQUESTED` - REQUESTED
+    - `APPROVED` - APPROVED
+    - `DECLINED` - DECLINED
+    - `CANCELLED` - CANCELLED
+    - `DELETED` - DELETED
+    """
+
+    units: Literal["HOURS", "DAYS"]
+    """
+    - `HOURS` - HOURS
+    - `DAYS` - DAYS
+    """
+
+
+class TimeOffCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The TimeOff Object
+
+    ### Description
+
+    The `TimeOff` object is used to represent all employees' Time Off entries.
+
+    ### Usage Example
+
+    Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off
+    requests.
+    """

merge/types/hris/time_off_list_params.py

@@ -0,0 +1,108 @@
+# 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__ = ["TimeOffListParams"]
+
+
+class TimeOffListParams(TypedDict, total=False):
+    approver_id: str
+    """If provided, will only return time off for this approver."""
+
+    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 time off for this employee."""
+
+    expand: List[Literal["approver", "employee"]]
+    """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[
+        "request_type",
+        "request_type,status",
+        "request_type,status,units",
+        "request_type,units",
+        "status",
+        "status,units",
+        "units",
+    ]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    request_type: Optional[Literal["BEREAVEMENT", "JURY_DUTY", "PERSONAL", "SICK", "VACATION", "VOLUNTEER"]]
+    """If provided, will only return TimeOff with this request type.
+
+    Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER',
+    'BEREAVEMENT')
+
+    - `VACATION` - VACATION
+    - `SICK` - SICK
+    - `PERSONAL` - PERSONAL
+    - `JURY_DUTY` - JURY_DUTY
+    - `VOLUNTEER` - VOLUNTEER
+    - `BEREAVEMENT` - BEREAVEMENT
+    """
+
+    show_enum_origins: Literal[
+        "request_type",
+        "request_type,status",
+        "request_type,status,units",
+        "request_type,units",
+        "status",
+        "status,units",
+        "units",
+    ]
+    """Which fields should be returned in non-normalized form."""
+
+    status: Optional[Literal["APPROVED", "CANCELLED", "DECLINED", "DELETED", "REQUESTED"]]
+    """If provided, will only return TimeOff with this status.
+
+    Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')
+
+    - `REQUESTED` - REQUESTED
+    - `APPROVED` - APPROVED
+    - `DECLINED` - DECLINED
+    - `CANCELLED` - CANCELLED
+    - `DELETED` - DELETED
+    """

merge/types/hris/time_off_response.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+
+from ...types import shared
+from ..._models import BaseModel
+from ...types.hris import time_off
+
+__all__ = ["TimeOffResponse"]
+
+
+class TimeOffResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: time_off.TimeOff
+    """# The TimeOff Object
+
+    ### Description
+
+    The `TimeOff` object is used to represent all employees' Time Off entries.
+
+    ### Usage Example
+
+    Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off
+    requests.
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]