mergepythonclient 0.0.1__py3-none-any.whl

merge/types/hris/location.py

@@ -0,0 +1,309 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ...types import shared
+from ..._models import BaseModel
+
+__all__ = ["Location"]
+
+
+class Location(BaseModel):
+    city: Optional[str]
+    """The location's city."""
+
+    country: Optional[shared.Country]
+    """
+    - `AF` - Afghanistan
+    - `AX` - Åland Islands
+    - `AL` - Albania
+    - `DZ` - Algeria
+    - `AS` - American Samoa
+    - `AD` - Andorra
+    - `AO` - Angola
+    - `AI` - Anguilla
+    - `AQ` - Antarctica
+    - `AG` - Antigua and Barbuda
+    - `AR` - Argentina
+    - `AM` - Armenia
+    - `AW` - Aruba
+    - `AU` - Australia
+    - `AT` - Austria
+    - `AZ` - Azerbaijan
+    - `BS` - Bahamas
+    - `BH` - Bahrain
+    - `BD` - Bangladesh
+    - `BB` - Barbados
+    - `BY` - Belarus
+    - `BE` - Belgium
+    - `BZ` - Belize
+    - `BJ` - Benin
+    - `BM` - Bermuda
+    - `BT` - Bhutan
+    - `BO` - Bolivia
+    - `BQ` - Bonaire, Sint Eustatius and Saba
+    - `BA` - Bosnia and Herzegovina
+    - `BW` - Botswana
+    - `BV` - Bouvet Island
+    - `BR` - Brazil
+    - `IO` - British Indian Ocean Territory
+    - `BN` - Brunei
+    - `BG` - Bulgaria
+    - `BF` - Burkina Faso
+    - `BI` - Burundi
+    - `CV` - Cabo Verde
+    - `KH` - Cambodia
+    - `CM` - Cameroon
+    - `CA` - Canada
+    - `KY` - Cayman Islands
+    - `CF` - Central African Republic
+    - `TD` - Chad
+    - `CL` - Chile
+    - `CN` - China
+    - `CX` - Christmas Island
+    - `CC` - Cocos (Keeling) Islands
+    - `CO` - Colombia
+    - `KM` - Comoros
+    - `CG` - Congo
+    - `CD` - Congo (the Democratic Republic of the)
+    - `CK` - Cook Islands
+    - `CR` - Costa Rica
+    - `CI` - Côte d'Ivoire
+    - `HR` - Croatia
+    - `CU` - Cuba
+    - `CW` - Curaçao
+    - `CY` - Cyprus
+    - `CZ` - Czechia
+    - `DK` - Denmark
+    - `DJ` - Djibouti
+    - `DM` - Dominica
+    - `DO` - Dominican Republic
+    - `EC` - Ecuador
+    - `EG` - Egypt
+    - `SV` - El Salvador
+    - `GQ` - Equatorial Guinea
+    - `ER` - Eritrea
+    - `EE` - Estonia
+    - `SZ` - Eswatini
+    - `ET` - Ethiopia
+    - `FK` - Falkland Islands (Malvinas)
+    - `FO` - Faroe Islands
+    - `FJ` - Fiji
+    - `FI` - Finland
+    - `FR` - France
+    - `GF` - French Guiana
+    - `PF` - French Polynesia
+    - `TF` - French Southern Territories
+    - `GA` - Gabon
+    - `GM` - Gambia
+    - `GE` - Georgia
+    - `DE` - Germany
+    - `GH` - Ghana
+    - `GI` - Gibraltar
+    - `GR` - Greece
+    - `GL` - Greenland
+    - `GD` - Grenada
+    - `GP` - Guadeloupe
+    - `GU` - Guam
+    - `GT` - Guatemala
+    - `GG` - Guernsey
+    - `GN` - Guinea
+    - `GW` - Guinea-Bissau
+    - `GY` - Guyana
+    - `HT` - Haiti
+    - `HM` - Heard Island and McDonald Islands
+    - `VA` - Holy See
+    - `HN` - Honduras
+    - `HK` - Hong Kong
+    - `HU` - Hungary
+    - `IS` - Iceland
+    - `IN` - India
+    - `ID` - Indonesia
+    - `IR` - Iran
+    - `IQ` - Iraq
+    - `IE` - Ireland
+    - `IM` - Isle of Man
+    - `IL` - Israel
+    - `IT` - Italy
+    - `JM` - Jamaica
+    - `JP` - Japan
+    - `JE` - Jersey
+    - `JO` - Jordan
+    - `KZ` - Kazakhstan
+    - `KE` - Kenya
+    - `KI` - Kiribati
+    - `KW` - Kuwait
+    - `KG` - Kyrgyzstan
+    - `LA` - Laos
+    - `LV` - Latvia
+    - `LB` - Lebanon
+    - `LS` - Lesotho
+    - `LR` - Liberia
+    - `LY` - Libya
+    - `LI` - Liechtenstein
+    - `LT` - Lithuania
+    - `LU` - Luxembourg
+    - `MO` - Macao
+    - `MG` - Madagascar
+    - `MW` - Malawi
+    - `MY` - Malaysia
+    - `MV` - Maldives
+    - `ML` - Mali
+    - `MT` - Malta
+    - `MH` - Marshall Islands
+    - `MQ` - Martinique
+    - `MR` - Mauritania
+    - `MU` - Mauritius
+    - `YT` - Mayotte
+    - `MX` - Mexico
+    - `FM` - Micronesia (Federated States of)
+    - `MD` - Moldova
+    - `MC` - Monaco
+    - `MN` - Mongolia
+    - `ME` - Montenegro
+    - `MS` - Montserrat
+    - `MA` - Morocco
+    - `MZ` - Mozambique
+    - `MM` - Myanmar
+    - `NA` - Namibia
+    - `NR` - Nauru
+    - `NP` - Nepal
+    - `NL` - Netherlands
+    - `NC` - New Caledonia
+    - `NZ` - New Zealand
+    - `NI` - Nicaragua
+    - `NE` - Niger
+    - `NG` - Nigeria
+    - `NU` - Niue
+    - `NF` - Norfolk Island
+    - `KP` - North Korea
+    - `MK` - North Macedonia
+    - `MP` - Northern Mariana Islands
+    - `NO` - Norway
+    - `OM` - Oman
+    - `PK` - Pakistan
+    - `PW` - Palau
+    - `PS` - Palestine, State of
+    - `PA` - Panama
+    - `PG` - Papua New Guinea
+    - `PY` - Paraguay
+    - `PE` - Peru
+    - `PH` - Philippines
+    - `PN` - Pitcairn
+    - `PL` - Poland
+    - `PT` - Portugal
+    - `PR` - Puerto Rico
+    - `QA` - Qatar
+    - `RE` - Réunion
+    - `RO` - Romania
+    - `RU` - Russia
+    - `RW` - Rwanda
+    - `BL` - Saint Barthélemy
+    - `SH` - Saint Helena, Ascension and Tristan da Cunha
+    - `KN` - Saint Kitts and Nevis
+    - `LC` - Saint Lucia
+    - `MF` - Saint Martin (French part)
+    - `PM` - Saint Pierre and Miquelon
+    - `VC` - Saint Vincent and the Grenadines
+    - `WS` - Samoa
+    - `SM` - San Marino
+    - `ST` - Sao Tome and Principe
+    - `SA` - Saudi Arabia
+    - `SN` - Senegal
+    - `RS` - Serbia
+    - `SC` - Seychelles
+    - `SL` - Sierra Leone
+    - `SG` - Singapore
+    - `SX` - Sint Maarten (Dutch part)
+    - `SK` - Slovakia
+    - `SI` - Slovenia
+    - `SB` - Solomon Islands
+    - `SO` - Somalia
+    - `ZA` - South Africa
+    - `GS` - South Georgia and the South Sandwich Islands
+    - `KR` - South Korea
+    - `SS` - South Sudan
+    - `ES` - Spain
+    - `LK` - Sri Lanka
+    - `SD` - Sudan
+    - `SR` - Suriname
+    - `SJ` - Svalbard and Jan Mayen
+    - `SE` - Sweden
+    - `CH` - Switzerland
+    - `SY` - Syria
+    - `TW` - Taiwan
+    - `TJ` - Tajikistan
+    - `TZ` - Tanzania
+    - `TH` - Thailand
+    - `TL` - Timor-Leste
+    - `TG` - Togo
+    - `TK` - Tokelau
+    - `TO` - Tonga
+    - `TT` - Trinidad and Tobago
+    - `TN` - Tunisia
+    - `TR` - Turkey
+    - `TM` - Turkmenistan
+    - `TC` - Turks and Caicos Islands
+    - `TV` - Tuvalu
+    - `UG` - Uganda
+    - `UA` - Ukraine
+    - `AE` - United Arab Emirates
+    - `GB` - United Kingdom
+    - `UM` - United States Minor Outlying Islands
+    - `US` - United States of America
+    - `UY` - Uruguay
+    - `UZ` - Uzbekistan
+    - `VU` - Vanuatu
+    - `VE` - Venezuela
+    - `VN` - Vietnam
+    - `VG` - Virgin Islands (British)
+    - `VI` - Virgin Islands (U.S.)
+    - `WF` - Wallis and Futuna
+    - `EH` - Western Sahara
+    - `YE` - Yemen
+    - `ZM` - Zambia
+    - `ZW` - Zimbabwe
+    """
+
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    location_type: Optional[Literal["HOME", "WORK"]]
+    """
+    - `HOME` - HOME
+    - `WORK` - WORK
+    """
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    name: Optional[str]
+    """The location's name."""
+
+    phone_number: Optional[str]
+    """The location's phone number."""
+
+    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."""
+
+    state: Optional[str]
+    """The location's state. Represents a region if outside of the US."""
+
+    street1: Optional[str] = FieldInfo(alias="street_1")
+    """Line 1 of the location's street address."""
+
+    street2: Optional[str] = FieldInfo(alias="street_2")
+    """Line 2 of the location's street address."""
+
+    zip_code: Optional[str]
+    """The location's zip code or postal code."""

merge/types/hris/location_list_params.py

@@ -0,0 +1,54 @@
+# 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__ = ["LocationListParams"]
+
+
+class LocationListParams(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["location_type"]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    show_enum_origins: Literal["location_type"]
+    """Which fields should be returned in non-normalized form."""

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

merge/types/hris/passthrough_request_send_params.py

@@ -0,0 +1,76 @@
+# 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__ = ["PassthroughRequestSendParams", "Multipartformdata"]
+
+
+class Multipartformdata(TypedDict, total=False):
+    data: Required[str]
+    """The data for the form field."""
+
+    name: Required[str]
+    """The name of the form field"""
+
+    content_type: Optional[str]
+    """The MIME type of the file, if the field is for a file."""
+
+    encoding: Literal["RAW", "BASE64", "GZIP_BASE64"]
+    """
+    - `RAW` - RAW
+    - `BASE64` - BASE64
+    - `GZIP_BASE64` - GZIP_BASE64
+    """
+
+    file_name: Optional[str]
+    """The file name of the form field, if the field is for a file."""
+
+
+class PassthroughRequestSendParams(TypedDict, total=False):
+    method: Required[Literal["GET", "OPTIONS", "HEAD", "POST", "PUT", "PATCH", "DELETE"]]
+    """
+    - `GET` - GET
+    - `OPTIONS` - OPTIONS
+    - `HEAD` - HEAD
+    - `POST` - POST
+    - `PUT` - PUT
+    - `PATCH` - PATCH
+    - `DELETE` - DELETE
+    """
+
+    path: Required[str]
+
+    base_url_override: Optional[str]
+
+    data: Optional[str]
+
+    headers: Optional[object]
+    """
+    The headers to use for the request (Merge will handle the account's
+    authorization headers). `Content-Type` header is required for passthrough.
+    Choose content type corresponding to expected format of receiving server.
+    """
+
+    multipart_form_data: Optional[List[Multipartformdata]]
+    """
+    Pass an array of `MultipartFormField` objects in here instead of using the
+    `data` param if `request_format` is set to `MULTIPART`.
+    """
+
+    normalize_response: bool
+    """Optional.
+
+    If true, the response will always be an object of the form
+    `{"type": T, "value": ...}` where `T` will be one of
+    `string, boolean, number, null, array, object`.
+    """
+
+    request_format: Literal["JSON", "XML", "MULTIPART"]
+    """
+    - `JSON` - JSON
+    - `XML` - XML
+    - `MULTIPART` - MULTIPART
+    """

merge/types/hris/pay_group.py

@@ -0,0 +1,29 @@
+# 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__ = ["PayGroup"]
+
+
+class PayGroup(BaseModel):
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    pay_group_name: Optional[str]
+    """The pay group 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."""

merge/types/hris/pay_group_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__ = ["PayGroupListParams"]
+
+
+class PayGroupListParams(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/pay_group_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__ = ["PayGroupRetrieveParams"]
+
+
+class PayGroupRetrieveParams(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/payroll_run.py

@@ -0,0 +1,54 @@
+# 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__ = ["PayrollRun"]
+
+
+class PayrollRun(BaseModel):
+    check_date: Optional[datetime]
+    """The day and time the payroll run was checked."""
+
+    end_date: Optional[datetime]
+    """The day and time the payroll run ended."""
+
+    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]
+    """Indicates whether or not this object has been deleted by third party webhooks."""
+
+    run_state: Optional[Literal["PAID", "DRAFT", "APPROVED", "FAILED", "CLOSED"]]
+    """
+    - `PAID` - PAID
+    - `DRAFT` - DRAFT
+    - `APPROVED` - APPROVED
+    - `FAILED` - FAILED
+    - `CLOSED` - CLOSED
+    """
+
+    run_type: Optional[Literal["REGULAR", "OFF_CYCLE", "CORRECTION", "TERMINATION", "SIGN_ON_BONUS"]]
+    """
+    - `REGULAR` - REGULAR
+    - `OFF_CYCLE` - OFF_CYCLE
+    - `CORRECTION` - CORRECTION
+    - `TERMINATION` - TERMINATION
+    - `SIGN_ON_BONUS` - SIGN_ON_BONUS
+    """
+
+    start_date: Optional[datetime]
+    """The day and time the payroll run started."""

merge/types/hris/payroll_run_list_params.py

@@ -0,0 +1,78 @@
+# 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__ = ["PayrollRunListParams"]
+
+
+class PayrollRunListParams(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."""
+
+    ended_after: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """If provided, will only return payroll runs ended after this datetime."""
+
+    ended_before: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """If provided, will only return payroll runs ended before this datetime."""
+
+    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["run_state", "run_state,run_type", "run_type"]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    run_type: Optional[Literal["CORRECTION", "OFF_CYCLE", "REGULAR", "SIGN_ON_BONUS", "TERMINATION"]]
+    """If provided, will only return PayrollRun's with this status.
+
+    Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
+
+    - `REGULAR` - REGULAR
+    - `OFF_CYCLE` - OFF_CYCLE
+    - `CORRECTION` - CORRECTION
+    - `TERMINATION` - TERMINATION
+    - `SIGN_ON_BONUS` - SIGN_ON_BONUS
+    """
+
+    show_enum_origins: Literal["run_state", "run_state,run_type", "run_type"]
+    """Which fields should be returned in non-normalized form."""
+
+    started_after: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """If provided, will only return payroll runs started after this datetime."""
+
+    started_before: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """If provided, will only return payroll runs started before this datetime."""