mergepythonclient 0.0.1__py3-none-any.whl

merge/types/crm/lead_create_params.py

@@ -0,0 +1,386 @@
+# 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 ...types import shared_params
+from ..._utils import PropertyInfo
+
+__all__ = ["LeadCreateParams", "Model", "ModelAddress", "ModelEmailAddress", "ModelPhoneNumber"]
+
+
+class ModelAddress(TypedDict, total=False):
+    address_type: Literal["BILLING", "SHIPPING"]
+    """
+    - `BILLING` - BILLING
+    - `SHIPPING` - SHIPPING
+    """
+
+    city: Optional[str]
+    """The address's city."""
+
+    country: shared_params.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
+    """
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    postal_code: Optional[str]
+    """The address's postal code."""
+
+    state: Optional[str]
+    """The address's state."""
+
+    street_1: Optional[str]
+    """Line 1 of the address's street."""
+
+    street_2: Optional[str]
+    """Line 2 of the address's street."""
+
+
+class ModelEmailAddress(TypedDict, total=False):
+    email_address: Optional[str]
+    """The email address."""
+
+    email_address_type: Literal["PERSONAL", "WORK", "OTHER"]
+    """
+    - `PERSONAL` - PERSONAL
+    - `WORK` - WORK
+    - `OTHER` - OTHER
+    """
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    value: Optional[str]
+    """The email address."""
+
+
+class ModelPhoneNumber(TypedDict, total=False):
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    phone_number: Optional[str]
+    """The phone number."""
+
+    phone_number_type: Literal["HOME", "WORK", "MOBILE", "SKYPE", "OTHER"]
+    """
+    - `HOME` - HOME
+    - `WORK` - WORK
+    - `MOBILE` - MOBILE
+    - `SKYPE` - SKYPE
+    - `OTHER` - OTHER
+    """
+
+    value: Optional[str]
+    """The phone number."""
+
+
+class Model(TypedDict, total=False):
+    addresses: List[ModelAddress]
+
+    company: Optional[str]
+    """The lead's company."""
+
+    converted_account: Optional[str]
+    """The account of the converted lead."""
+
+    converted_contact: Optional[str]
+    """The contact of the converted lead."""
+
+    converted_date: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """When the lead was converted."""
+
+    email_addresses: List[ModelEmailAddress]
+
+    first_name: Optional[str]
+    """The lead's first name."""
+
+    integration_params: Optional[object]
+
+    last_name: Optional[str]
+    """The lead's last name."""
+
+    lead_source: Optional[str]
+    """The lead's source."""
+
+    linked_account_params: Optional[object]
+
+    owner: Optional[str]
+    """The lead's owner."""
+
+    phone_numbers: List[ModelPhoneNumber]
+
+    title: Optional[str]
+    """The lead's title."""
+
+
+class LeadCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Lead Object
+
+    ### Description
+
+    The `Lead` object is used to represent an individual who is a potential
+    customer.
+
+    ### Usage Example
+
+    TODO
+    """

merge/types/crm/lead_list_params.py

@@ -0,0 +1,69 @@
+# 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__ = ["LeadListParams"]
+
+
+class LeadListParams(TypedDict, total=False):
+    converted_account_id: str
+    """If provided, will only return leads with this account."""
+
+    converted_contact_id: str
+    """If provided, will only return leads with this contact."""
+
+    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["converted_account", "converted_contact", "owner"]]
+    """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.
+    """
+
+    include_remote_fields: bool
+    """
+    Whether to include all remote fields, including fields that Merge did not map to
+    common models, in a normalized format.
+    """
+
+    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.
+    """
+
+    owner_id: str
+    """If provided, will only return leads with this owner."""
+
+    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/crm/lead_list_remote_field_classes_params.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["LeadListRemoteFieldClassesParams"]
+
+
+class LeadListRemoteFieldClassesParams(TypedDict, total=False):
+    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.
+    """
+
+    include_remote_fields: bool
+    """
+    Whether to include all remote fields, including fields that Merge did not map to
+    common models, in a normalized format.
+    """
+
+    page_size: int
+    """Number of results to return per page."""

merge/types/crm/lead_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.crm import lead
+
+__all__ = ["LeadResponse"]
+
+
+class LeadResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: lead.Lead
+    """# The Lead Object
+
+    ### Description
+
+    The `Lead` object is used to represent an individual who is a potential
+    customer.
+
+    ### Usage Example
+
+    TODO
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/crm/lead_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__ = ["LeadRetrieveParams"]
+
+
+class LeadRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["converted_account", "converted_contact", "owner"]]
+    """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.
+    """
+
+    include_remote_fields: bool
+    """
+    Whether to include all remote fields, including fields that Merge did not map to
+    common models, in a normalized format.
+    """

merge/types/crm/leads/__init__.py

@@ -0,0 +1,3 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations

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