mergepythonclient 0.0.1__py3-none-any.whl

merge/types/hris/company_list_params.py

@@ -0,0 +1,48 @@
+# 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 Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["CompanyListParams"]
+
+
+class CompanyListParams(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_id: Optional[str]
+    """The API provider's ID for the given object."""

merge/types/hris/company_retrieve_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["CompanyRetrieveParams"]
+
+
+class CompanyRetrieveParams(TypedDict, total=False):
+    include_remote_data: bool
+    """
+    Whether to include the original data Merge fetched from the third-party to
+    produce these models.
+    """

merge/types/hris/created_employee_response.py

@@ -0,0 +1,31 @@
+# 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 employee
+
+__all__ = ["CreatedEmployeeResponse"]
+
+
+class CreatedEmployeeResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: employee.Employee
+    """# The Employee Object
+
+    ### Description
+
+    The `Employee` object is used to represent any person who has been employed by a
+    company.
+
+    ### Usage Example
+
+    Fetch from the `LIST Employee` endpoint and filter by `ID` to show all
+    employees.
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/hris/employee.py

@@ -0,0 +1,167 @@
+# 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__ = ["Employee"]
+
+
+class Employee(BaseModel):
+    avatar: Optional[str]
+    """The URL of the employee's avatar image."""
+
+    company: Optional[str]
+    """The ID of the employee's company."""
+
+    custom_fields: Optional[object]
+    """Custom fields configured for a given model."""
+
+    date_of_birth: Optional[datetime]
+    """The employee's date of birth."""
+
+    display_full_name: Optional[str]
+    """The employee's full name, to use for display purposes.
+
+    If a preferred first name is available, the full name will include the preferred
+    first name.
+    """
+
+    employee_number: Optional[str]
+    """The employee's number that appears in the third-party integration's UI."""
+
+    employment_status: Optional[Literal["ACTIVE", "PENDING", "INACTIVE"]]
+    """
+    - `ACTIVE` - ACTIVE
+    - `PENDING` - PENDING
+    - `INACTIVE` - INACTIVE
+    """
+
+    employments: Optional[List[Optional[str]]]
+    """Array of `Employment` IDs for this Employee."""
+
+    ethnicity: Optional[
+        Literal[
+            "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
+            "ASIAN_OR_INDIAN_SUBCONTINENT",
+            "BLACK_OR_AFRICAN_AMERICAN",
+            "HISPANIC_OR_LATINO",
+            "NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER",
+            "TWO_OR_MORE_RACES",
+            "WHITE",
+            "PREFER_NOT_TO_DISCLOSE",
+        ]
+    ]
+    """
+    - `AMERICAN_INDIAN_OR_ALASKA_NATIVE` - AMERICAN_INDIAN_OR_ALASKA_NATIVE
+    - `ASIAN_OR_INDIAN_SUBCONTINENT` - ASIAN_OR_INDIAN_SUBCONTINENT
+    - `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN
+    - `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO
+    - `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` -
+      NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
+    - `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES
+    - `WHITE` - WHITE
+    - `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
+    """
+
+    field_mappings: Optional[object]
+
+    first_name: Optional[str]
+    """The employee's first name."""
+
+    gender: Optional[Literal["MALE", "FEMALE", "NON-BINARY", "OTHER", "DECLINE_TO_SELF_IDENTIFY"]]
+    """
+    - `MALE` - MALE
+    - `FEMALE` - FEMALE
+    - `NON-BINARY` - NON-BINARY
+    - `OTHER` - OTHER
+    - `DECLINE_TO_SELF_IDENTIFY` - DECLINE_TO_SELF_IDENTIFY
+    """
+
+    groups: Optional[List[Optional[str]]]
+
+    hire_date: Optional[datetime]
+    """
+    The date that the employee was hired, usually the day that an offer letter is
+    signed. If an employee has multiple hire dates from previous employments, this
+    represents the most recent hire date. Note: If you're looking for the employee's
+    start date, refer to the start_date field.
+    """
+
+    home_location: Optional[str]
+    """The employee's home address."""
+
+    id: Optional[str]
+
+    last_name: Optional[str]
+    """The employee's last name."""
+
+    manager: Optional[str]
+    """The employee ID of the employee's manager."""
+
+    marital_status: Optional[
+        Literal[
+            "SINGLE",
+            "MARRIED_FILING_JOINTLY",
+            "MARRIED_FILING_SEPARATELY",
+            "HEAD_OF_HOUSEHOLD",
+            "QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD",
+        ]
+    ]
+    """
+    - `SINGLE` - SINGLE
+    - `MARRIED_FILING_JOINTLY` - MARRIED_FILING_JOINTLY
+    - `MARRIED_FILING_SEPARATELY` - MARRIED_FILING_SEPARATELY
+    - `HEAD_OF_HOUSEHOLD` - HEAD_OF_HOUSEHOLD
+    - `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` -
+      QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD
+    """
+
+    mobile_phone_number: Optional[str]
+    """The employee's mobile phone number."""
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    pay_group: Optional[str]
+    """The employee's pay group"""
+
+    personal_email: Optional[str]
+    """The employee's personal email."""
+
+    remote_created_at: Optional[datetime]
+    """When the third party's employee 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]
+
+    ssn: Optional[str]
+    """The employee's social security number."""
+
+    start_date: Optional[datetime]
+    """The date that the employee started working.
+
+    If an employee was rehired, the most recent start date will be returned.
+    """
+
+    team: Optional[str]
+    """The employee's team."""
+
+    termination_date: Optional[datetime]
+    """The employee's termination date."""
+
+    username: Optional[str]
+    """The employee's username that appears in the remote UI."""
+
+    work_email: Optional[str]
+    """The employee's work email."""
+
+    work_location: Optional[str]
+    """The employee's work address."""

merge/types/hris/employee_create_params.py

@@ -0,0 +1,164 @@
+# 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__ = ["EmployeeCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    avatar: Optional[str]
+    """The URL of the employee's avatar image."""
+
+    company: Optional[str]
+    """The ID of the employee's company."""
+
+    date_of_birth: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """The employee's date of birth."""
+
+    display_full_name: Optional[str]
+    """The employee's full name, to use for display purposes.
+
+    If a preferred first name is available, the full name will include the preferred
+    first name.
+    """
+
+    employee_number: Optional[str]
+    """The employee's number that appears in the third-party integration's UI."""
+
+    employment_status: Literal["ACTIVE", "PENDING", "INACTIVE"]
+    """
+    - `ACTIVE` - ACTIVE
+    - `PENDING` - PENDING
+    - `INACTIVE` - INACTIVE
+    """
+
+    employments: List[Optional[str]]
+    """Array of `Employment` IDs for this Employee."""
+
+    ethnicity: Literal[
+        "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
+        "ASIAN_OR_INDIAN_SUBCONTINENT",
+        "BLACK_OR_AFRICAN_AMERICAN",
+        "HISPANIC_OR_LATINO",
+        "NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER",
+        "TWO_OR_MORE_RACES",
+        "WHITE",
+        "PREFER_NOT_TO_DISCLOSE",
+    ]
+    """
+    - `AMERICAN_INDIAN_OR_ALASKA_NATIVE` - AMERICAN_INDIAN_OR_ALASKA_NATIVE
+    - `ASIAN_OR_INDIAN_SUBCONTINENT` - ASIAN_OR_INDIAN_SUBCONTINENT
+    - `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN
+    - `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO
+    - `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` -
+      NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
+    - `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES
+    - `WHITE` - WHITE
+    - `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
+    """
+
+    first_name: Optional[str]
+    """The employee's first name."""
+
+    gender: Literal["MALE", "FEMALE", "NON-BINARY", "OTHER", "DECLINE_TO_SELF_IDENTIFY"]
+    """
+    - `MALE` - MALE
+    - `FEMALE` - FEMALE
+    - `NON-BINARY` - NON-BINARY
+    - `OTHER` - OTHER
+    - `DECLINE_TO_SELF_IDENTIFY` - DECLINE_TO_SELF_IDENTIFY
+    """
+
+    groups: List[Optional[str]]
+
+    hire_date: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    The date that the employee was hired, usually the day that an offer letter is
+    signed. If an employee has multiple hire dates from previous employments, this
+    represents the most recent hire date. Note: If you're looking for the employee's
+    start date, refer to the start_date field.
+    """
+
+    home_location: Optional[str]
+    """The employee's home address."""
+
+    integration_params: Optional[object]
+
+    last_name: Optional[str]
+    """The employee's last name."""
+
+    linked_account_params: Optional[object]
+
+    manager: Optional[str]
+    """The employee ID of the employee's manager."""
+
+    marital_status: Literal[
+        "SINGLE",
+        "MARRIED_FILING_JOINTLY",
+        "MARRIED_FILING_SEPARATELY",
+        "HEAD_OF_HOUSEHOLD",
+        "QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD",
+    ]
+    """
+    - `SINGLE` - SINGLE
+    - `MARRIED_FILING_JOINTLY` - MARRIED_FILING_JOINTLY
+    - `MARRIED_FILING_SEPARATELY` - MARRIED_FILING_SEPARATELY
+    - `HEAD_OF_HOUSEHOLD` - HEAD_OF_HOUSEHOLD
+    - `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` -
+      QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD
+    """
+
+    mobile_phone_number: Optional[str]
+    """The employee's mobile phone number."""
+
+    pay_group: Optional[str]
+    """The employee's pay group"""
+
+    personal_email: Optional[str]
+    """The employee's personal email."""
+
+    ssn: Optional[str]
+    """The employee's social security number."""
+
+    start_date: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """The date that the employee started working.
+
+    If an employee was rehired, the most recent start date will be returned.
+    """
+
+    team: Optional[str]
+    """The employee's team."""
+
+    termination_date: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """The employee's termination date."""
+
+    username: Optional[str]
+    """The employee's username that appears in the remote UI."""
+
+    work_email: Optional[str]
+    """The employee's work email."""
+
+    work_location: Optional[str]
+    """The employee's work address."""
+
+
+class EmployeeCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Employee Object
+
+    ### Description
+
+    The `Employee` object is used to represent any person who has been employed by a
+    company.
+
+    ### Usage Example
+
+    Fetch from the `LIST Employee` endpoint and filter by `ID` to show all
+    employees.
+    """

merge/types/hris/employee_ignore_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__ = ["EmployeeIgnoreParams"]
+
+
+class EmployeeIgnoreParams(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/hris/employee_list_params.py

@@ -0,0 +1,162 @@
+# 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__ = ["EmployeeListParams"]
+
+
+class EmployeeListParams(TypedDict, total=False):
+    company_id: str
+    """If provided, will only return employees for this company."""
+
+    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."""
+
+    display_full_name: Optional[str]
+    """If provided, will only return employees with this display name."""
+
+    employment_status: Optional[Literal["ACTIVE", "INACTIVE", "PENDING"]]
+    """If provided, will only return employees with this employment status.
+
+    - `ACTIVE` - ACTIVE
+    - `PENDING` - PENDING
+    - `INACTIVE` - INACTIVE
+    """
+
+    expand: List[
+        Literal["company", "employments", "groups", "home_location", "manager", "pay_group", "team", "work_location"]
+    ]
+    """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 employees with this first name."""
+
+    groups: str
+    """
+    If provided, will only return employees matching the group ids; multiple groups
+    can be separated by commas.
+    """
+
+    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.
+    """
+
+    include_sensitive_fields: bool
+    """
+    Whether to include sensitive fields (such as social security numbers) in the
+    response.
+    """
+
+    last_name: Optional[str]
+    """If provided, will only return employees with this last name."""
+
+    manager_id: str
+    """If provided, will only return employees for this manager."""
+
+    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."""
+
+    pay_group_id: str
+    """If provided, will only return employees for this pay group"""
+
+    personal_email: Optional[str]
+    """If provided, will only return Employees with this personal email"""
+
+    remote_fields: Literal[
+        "employment_status",
+        "employment_status,ethnicity",
+        "employment_status,ethnicity,gender",
+        "employment_status,ethnicity,gender,marital_status",
+        "employment_status,ethnicity,marital_status",
+        "employment_status,gender",
+        "employment_status,gender,marital_status",
+        "employment_status,marital_status",
+        "ethnicity",
+        "ethnicity,gender",
+        "ethnicity,gender,marital_status",
+        "ethnicity,marital_status",
+        "gender",
+        "gender,marital_status",
+        "marital_status",
+    ]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    show_enum_origins: Literal[
+        "employment_status",
+        "employment_status,ethnicity",
+        "employment_status,ethnicity,gender",
+        "employment_status,ethnicity,gender,marital_status",
+        "employment_status,ethnicity,marital_status",
+        "employment_status,gender",
+        "employment_status,gender,marital_status",
+        "employment_status,marital_status",
+        "ethnicity",
+        "ethnicity,gender",
+        "ethnicity,gender,marital_status",
+        "ethnicity,marital_status",
+        "gender",
+        "gender,marital_status",
+        "marital_status",
+    ]
+    """Which fields should be returned in non-normalized form."""
+
+    started_after: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """If provided, will only return employees that started after this datetime."""
+
+    started_before: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """If provided, will only return employees that started before this datetime."""
+
+    team_id: str
+    """If provided, will only return employees for this team."""
+
+    terminated_after: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    If provided, will only return employees that were terminated after this
+    datetime.
+    """
+
+    terminated_before: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    If provided, will only return employees that were terminated before this
+    datetime.
+    """
+
+    work_email: Optional[str]
+    """If provided, will only return Employees with this work email"""
+
+    work_location_id: str
+    """If provided, will only return employees for this location."""