mergepythonclient 0.0.1__py3-none-any.whl

merge/types/marketing/campaign_create_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["CampaignCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    emails_sent: Optional[int]
+    """The campaign's number of emails sent."""
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    name: Optional[str]
+    """The campaign's name."""
+
+    unique_opens: Optional[int]
+    """The campaign's unique opens."""
+
+
+class CampaignCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Campaign Object
+
+    ### Description
+
+    The `Campaign` object is used to represent a marketing campaign in the remote
+    system.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/campaigns` endpoint and view their unique
+    opens.
+    """

merge/types/marketing/campaign_list_contacts_params.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["CampaignListContactsParams"]
+
+
+class CampaignListContactsParams(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.
+    """
+
+    page_size: int
+    """Number of results to return per page."""

merge/types/marketing/campaign_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__ = ["CampaignListParams"]
+
+
+class CampaignListParams(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/marketing/campaign_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.marketing import campaign
+
+__all__ = ["CampaignResponse"]
+
+
+class CampaignResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: campaign.Campaign
+    """# The Campaign Object
+
+    ### Description
+
+    The `Campaign` object is used to represent a marketing campaign in the remote
+    system.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/campaigns` endpoint and view their unique
+    opens.
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/marketing/campaign_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__ = ["CampaignRetrieveParams"]
+
+
+class CampaignRetrieveParams(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/marketing/campaigns/__init__.py

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

merge/types/marketing/common_model_scope_retrieve_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["CommonModelScopeRetrieveParams"]
+
+
+class CommonModelScopeRetrieveParams(TypedDict, total=False):
+    linked_account_id: str
+    """ID of specific linked account to fetch"""

merge/types/marketing/common_model_scope_update_params.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["CommonModelScopeUpdateParams", "CommonModel"]
+
+
+class CommonModel(TypedDict, total=False):
+    disabled_fields: Required[List[str]]
+
+    enabled_actions: Required[List[Literal["READ", "WRITE"]]]
+
+    model_id: Required[str]
+
+
+class CommonModelScopeUpdateParams(TypedDict, total=False):
+    common_models: Required[List[CommonModel]]
+    """The common model scopes to update."""

merge/types/marketing/contact_create_params.py

@@ -0,0 +1,384 @@
+# 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__ = ["ContactCreateParams", "Model", "ModelPhoneNumber", "ModelEmailAddress"]
+
+
+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 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 Model(TypedDict, total=False):
+    account: Optional[str]
+    """The contact's account."""
+
+    addresses: List[Optional[str]]
+    """`Address` object IDs for the given `Contacts` object."""
+
+    company: Optional[str]
+    """The company the contact belongs to."""
+
+    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
+    """
+
+    currency: Optional[str]
+    """The currency the contact's transactions are in."""
+
+    email: Optional[str]
+    """The contact's email."""
+
+    email_address: Optional[str]
+    """The contact's email address."""
+
+    email_addresses: List[ModelEmailAddress]
+
+    first_name: Optional[str]
+    """The contact's first name."""
+
+    integration_params: Optional[object]
+
+    is_customer: Optional[bool]
+    """Whether the contact is a customer."""
+
+    is_supplier: Optional[bool]
+    """Whether the contact is a supplier."""
+
+    last_activity_at: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """When the contact's last activity occurred."""
+
+    last_name: Optional[str]
+    """The contact's last name."""
+
+    linked_account_params: Optional[object]
+
+    name: Optional[str]
+    """The contact's name."""
+
+    phone: Optional[str]
+    """The contact's phone."""
+
+    phone_numbers: List[ModelPhoneNumber]
+    """`AccountingPhoneNumber` object for the given `Contacts` object."""
+
+    postal_code: Optional[str]
+    """The contact's postal code."""
+
+    state: Optional[str]
+    """The contact's state."""
+
+    status: Literal["ACTIVE", "ARCHIVED"]
+    """
+    - `ACTIVE` - ACTIVE
+    - `ARCHIVED` - ARCHIVED
+    """
+
+    tax_number: Optional[str]
+    """The contact's tax number."""
+
+
+class ContactCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Contact Object
+
+    ### Description
+
+    The `Contact` object is used to represent a contact in the remote system.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/contact` endpoint and view their phone numbers.
+    """

merge/types/marketing/contact_list.py

@@ -0,0 +1,38 @@
+# 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__ = ["ContactList"]
+
+
+class ContactList(BaseModel):
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    name: Optional[str]
+    """The list's name."""
+
+    remote_created_at: Optional[datetime]
+    """When the list was created in the remote system."""
+
+    remote_data: Optional[List[shared.RemoteData]]
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""
+
+    remote_updated_at: Optional[datetime]
+    """When the list was last updated in the remote system."""
+
+    remote_was_deleted: Optional[bool]
+    """Indicates whether or not this object has been deleted by third party webhooks."""
+
+    type: Optional[str]
+    """The list's type."""

merge/types/marketing/contact_list_create_params.py

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ContactListCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    name: Optional[str]
+    """The list's name."""
+
+    type: Optional[str]
+    """The list's type."""
+
+
+class ContactListCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The List Object
+
+    ### Description
+
+    The `List` object is used to represent a list of contacts in the remote system.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/lists` endpoint and view their names.
+    """

merge/types/marketing/contact_list_create_response.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+
+from ...types import shared
+from ..._models import BaseModel
+from ...types.marketing import contact_list
+
+__all__ = ["ContactListCreateResponse"]
+
+
+class ContactListCreateResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: contact_list.ContactList
+    """# The List Object
+
+    ### Description
+
+    The `List` object is used to represent a list of contacts in the remote system.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/lists` endpoint and view their names.
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]