mergepythonclient 0.0.1__py3-none-any.whl

merge/types/shared_params/account_details_and_actions.py

@@ -0,0 +1,78 @@
+# 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__ = ["AccountDetailsAndActions", "Integration", "IntegrationAvailableModelOperation"]
+
+
+class IntegrationAvailableModelOperation(TypedDict, total=False):
+    available_operations: Required[List[str]]
+
+    model_name: Required[str]
+
+    required_post_parameters: Required[List[str]]
+
+    supported_fields: Required[List[str]]
+
+
+class Integration(TypedDict, total=False):
+    categories: Required[List[Literal["hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage"]]]
+
+    color: Required[str]
+
+    name: Required[str]
+
+    passthrough_available: Required[bool]
+
+    slug: Required[str]
+
+    available_model_operations: List[IntegrationAvailableModelOperation]
+
+    image: str
+
+    square_image: str
+
+
+class AccountDetailsAndActions(TypedDict, total=False):
+    end_user_email_address: Required[str]
+
+    end_user_organization_name: Required[str]
+
+    id: Required[str]
+
+    status: Required[Literal["COMPLETE", "INCOMPLETE", "RELINK_NEEDED"]]
+    """
+    - `COMPLETE` - COMPLETE
+    - `INCOMPLETE` - INCOMPLETE
+    - `RELINK_NEEDED` - RELINK_NEEDED
+    """
+
+    webhook_listener_url: Required[str]
+
+    category: Literal["hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage"]
+    """
+    - `hris` - hris
+    - `ats` - ats
+    - `accounting` - accounting
+    - `ticketing` - ticketing
+    - `crm` - crm
+    - `mktg` - mktg
+    - `filestorage` - filestorage
+    """
+
+    end_user_origin_id: str
+
+    integration: Integration
+
+    is_duplicate: Optional[bool]
+    """
+    Whether a Production Linked Account's credentials match another existing
+    Production Linked Account. This field is `null` for Test Linked Accounts,
+    incomplete Production Linked Accounts, and ignored duplicate Production Linked
+    Account sets.
+    """
+
+    status_detail: str

merge/types/shared_params/account_token.py

@@ -0,0 +1,54 @@
+# 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__ = ["AccountToken", "Integration"]
+
+
+class Integration(TypedDict, total=False):
+    name: Required[str]
+    """Company name."""
+
+    api_endpoints_to_documentation_urls: object
+    """Mapping of API endpoints to documentation urls for support.
+
+    Example: {'GET':
+    [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']],
+    'POST': []}
+    """
+
+    categories: List[Literal["hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage"]]
+    """Category or categories this integration belongs to.
+
+    Multiple categories should be comma separated, i.e. [ats, hris].
+    """
+
+    color: str
+    """
+    The color of this integration used for buttons and text throughout the app and
+    landing pages. <b>Choose a darker, saturated color.</b>
+    """
+
+    image: Optional[str]
+    """Company logo in rectangular shape.
+
+    <b>Upload an image with a clear background.</b>
+    """
+
+    is_in_beta: bool
+    """
+    If checked, this integration will not appear in the linking flow, and will
+    appear elsewhere with a Beta tag.
+    """
+
+    square_image: Optional[str]
+    """Company logo in square shape. <b>Upload an image with a white background.</b>"""
+
+
+class AccountToken(TypedDict, total=False):
+    account_token: Required[str]
+
+    integration: Required[Integration]

merge/types/shared_params/address.py

@@ -0,0 +1,295 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, TypedDict
+
+from .country import Country
+
+__all__ = ["Address"]
+
+
+class Address(TypedDict, total=False):
+    address_type: Literal["BILLING", "SHIPPING"]
+    """
+    - `BILLING` - BILLING
+    - `SHIPPING` - SHIPPING
+    """
+
+    city: Optional[str]
+    """The address's city."""
+
+    country: 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
+    """
+
+    country_subdivision: Optional[str]
+    """The address's state or region."""
+
+    postal_code: Optional[str]
+    """The address's postal code."""
+
+    street_1: Optional[str]
+    """Line 1 of the address's street."""
+
+    street_2: Optional[str]
+    """Line 2 of the address's street."""
+
+    type: Literal["BILLING", "SHIPPING"]
+    """
+    - `BILLING` - BILLING
+    - `SHIPPING` - SHIPPING
+    """
+
+    zip_code: Optional[str]
+    """The address's zip code."""

merge/types/shared_params/attachment.py

@@ -0,0 +1,50 @@
+# 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__ = ["Attachment"]
+
+
+class Attachment(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.
+    """
+
+    remote_created_at: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """When the third party's attachment was created."""
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""
+
+    ticket: Optional[str]
+    """The ticket associated with the attachment."""
+
+    uploaded_by: Optional[str]
+    """The user who uploaded the attachment."""

merge/types/shared_params/available_action.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__ = ["AvailableAction", "Integration", "AvailableModelOperation"]
+
+
+class Integration(TypedDict, total=False):
+    name: Required[str]
+    """Company name."""
+
+    api_endpoints_to_documentation_urls: object
+    """Mapping of API endpoints to documentation urls for support.
+
+    Example: {'GET':
+    [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']],
+    'POST': []}
+    """
+
+    categories: List[Literal["hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage"]]
+    """Category or categories this integration belongs to.
+
+    Multiple categories should be comma separated, i.e. [ats, hris].
+    """
+
+    color: str
+    """
+    The color of this integration used for buttons and text throughout the app and
+    landing pages. <b>Choose a darker, saturated color.</b>
+    """
+
+    image: Optional[str]
+    """Company logo in rectangular shape.
+
+    <b>Upload an image with a clear background.</b>
+    """
+
+    is_in_beta: bool
+    """
+    If checked, this integration will not appear in the linking flow, and will
+    appear elsewhere with a Beta tag.
+    """
+
+    square_image: Optional[str]
+    """Company logo in square shape. <b>Upload an image with a white background.</b>"""
+
+
+class AvailableModelOperation(TypedDict, total=False):
+    available_operations: Required[List[str]]
+
+    model_name: Required[str]
+
+    required_post_parameters: Required[List[str]]
+
+    supported_fields: Required[List[str]]
+
+
+class AvailableAction(TypedDict, total=False):
+    integration: Required[Integration]
+
+    passthrough_available: Required[bool]
+
+    available_model_operations: List[AvailableModelOperation]

merge/types/shared_params/common_model_scope.py

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = [
+    "CommonModelScope",
+    "ScopeOverride",
+    "ScopeOverrideCommonModel",
+    "OrganizationLevelScopes",
+    "OrganizationLevelScopesCommonModel",
+]
+
+
+class ScopeOverrideCommonModel(TypedDict, total=False):
+    disabled_fields: Required[List[str]]
+
+    enabled_actions: Required[List[Literal["ENABLED_ACTION_READ", "ENABLED_ACTION_WRITE"]]]
+
+    is_disabled: Required[bool]
+
+    model_id: Required[str]
+
+    model_name: Required[str]
+
+
+class ScopeOverride(TypedDict, total=False):
+    common_models: Required[List[ScopeOverrideCommonModel]]
+
+    linked_account_id: str
+
+
+class OrganizationLevelScopesCommonModel(TypedDict, total=False):
+    disabled_fields: Required[List[str]]
+
+    enabled_actions: Required[List[Literal["ENABLED_ACTION_READ", "ENABLED_ACTION_WRITE"]]]
+
+    is_disabled: Required[bool]
+
+    model_id: Required[str]
+
+    model_name: Required[str]
+
+
+class OrganizationLevelScopes(TypedDict, total=False):
+    common_models: Required[List[OrganizationLevelScopesCommonModel]]
+
+    linked_account_id: str
+
+
+class CommonModelScope(TypedDict, total=False):
+    scope_overrides: Required[List[ScopeOverride]]
+
+    organization_level_scopes: OrganizationLevelScopes

merge/types/shared_params/condition_schema.py

@@ -0,0 +1,49 @@
+# 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__ = ["ConditionSchema", "Operator"]
+
+
+class Operator(TypedDict, total=False):
+    pass
+
+
+class ConditionSchema(TypedDict, total=False):
+    condition_type: Required[Literal["BOOLEAN", "DATE", "DATE_TIME", "INTEGER", "FLOAT", "STRING", "LIST_OF_STRINGS"]]
+    """
+    - `BOOLEAN` - BOOLEAN
+    - `DATE` - DATE
+    - `DATE_TIME` - DATE_TIME
+    - `INTEGER` - INTEGER
+    - `FLOAT` - FLOAT
+    - `STRING` - STRING
+    - `LIST_OF_STRINGS` - LIST_OF_STRINGS
+    """
+
+    field_name: Required[Optional[str]]
+    """
+    The name of the field on the common model that this condition corresponds to, if
+    they conceptually match. e.g. "location_type".
+    """
+
+    id: Required[str]
+    """The ID of the condition schema.
+
+    This ID is used when updating selective syncs for a linked account.
+    """
+
+    native_name: Required[Optional[str]]
+    """User-facing _native condition_ name. e.g. "Skip Manager"."""
+
+    operators: Required[List[Operator]]
+    """The schemas for the operators that can be used on a condition."""
+
+    is_unique: bool
+    """Whether this condition can only be applied once.
+
+    If false, the condition can be AND'd together multiple times.
+    """