mergepythonclient 0.0.1__py3-none-any.whl

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

merge/types/marketing/message.py

@@ -0,0 +1,35 @@
+# 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__ = ["Message"]
+
+
+class Message(BaseModel):
+    body: Optional[str]
+    """The message's body."""
+
+    field_mappings: Optional[object]
+
+    from_name: Optional[str]
+    """The message's from-name."""
+
+    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."""
+
+    send_date: Optional[datetime]
+    """When the message was sent."""

merge/types/marketing/message_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__ = ["MessageListParams"]
+
+
+class MessageListParams(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/message_list_recipients_params.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["MessageListRecipientsParams"]
+
+
+class MessageListRecipientsParams(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/message_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__ = ["MessageRetrieveParams"]
+
+
+class MessageRetrieveParams(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/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/marketing/remote_key_generate_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["RemoteKeyGenerateParams"]
+
+
+class RemoteKeyGenerateParams(TypedDict, total=False):
+    name: Required[str]

merge/types/marketing/remote_key_regenerate_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["RemoteKeyRegenerateParams"]
+
+
+class RemoteKeyRegenerateParams(TypedDict, total=False):
+    name: Required[str]

merge/types/marketing/selective_sync_list_configurations_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List
+
+from ...types.shared import linked_account_selective_sync_configuration
+
+__all__ = ["SelectiveSyncListConfigurationsResponse"]
+
+SelectiveSyncListConfigurationsResponse = List[
+    linked_account_selective_sync_configuration.LinkedAccountSelectiveSyncConfiguration
+]

merge/types/marketing/selective_sync_list_metadata_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["SelectiveSyncListMetadataParams"]
+
+
+class SelectiveSyncListMetadataParams(TypedDict, total=False):
+    common_model: str
+
+    cursor: str
+    """The pagination cursor value."""
+
+    page_size: int
+    """Number of results to return per page."""

merge/types/marketing/selective_sync_replace_configurations_params.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Required, TypedDict
+
+__all__ = ["SelectiveSyncReplaceConfigurationsParams", "SyncConfiguration", "SyncConfigurationLinkedAccountCondition"]
+
+
+class SyncConfigurationLinkedAccountCondition(TypedDict, total=False):
+    condition_schema_id: Required[str]
+    """The ID indicating which condition schema to use for a specific condition."""
+
+    operator: Required[str]
+    """The operator for a specific condition."""
+
+    value: Required[object]
+    """The value for a specific condition."""
+
+
+class SyncConfiguration(TypedDict, total=False):
+    linked_account_conditions: Required[List[SyncConfigurationLinkedAccountCondition]]
+    """The conditions belonging to a selective sync."""
+
+
+class SelectiveSyncReplaceConfigurationsParams(TypedDict, total=False):
+    sync_configurations: Required[List[SyncConfiguration]]
+    """The selective syncs associated with a linked account."""

merge/types/marketing/selective_sync_replace_configurations_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List
+
+from ...types.shared import linked_account_selective_sync_configuration
+
+__all__ = ["SelectiveSyncReplaceConfigurationsResponse"]
+
+SelectiveSyncReplaceConfigurationsResponse = List[
+    linked_account_selective_sync_configuration.LinkedAccountSelectiveSyncConfiguration
+]

merge/types/marketing/sync_status_list_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["SyncStatusListParams"]
+
+
+class SyncStatusListParams(TypedDict, total=False):
+    cursor: str
+    """The pagination cursor value."""
+
+    page_size: int
+    """Number of results to return per page."""

merge/types/marketing/sync_status_resync_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List
+
+from ...types.shared import sync_status
+
+__all__ = ["SyncStatusResyncResponse"]
+
+SyncStatusResyncResponse = List[sync_status.SyncStatus]

merge/types/marketing/template.py

@@ -0,0 +1,48 @@
+# 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__ = ["Template"]
+
+
+class Template(BaseModel):
+    contents: Optional[str]
+    """The template contents."""
+
+    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 template's name."""
+
+    owner: Optional[str]
+    """The template's owner."""
+
+    remote_created_at: Optional[datetime]
+    """When the template 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 template 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[Literal["EMAIL", "MESSAGE"]]
+    """
+    - `EMAIL` - EMAIL
+    - `MESSAGE` - MESSAGE
+    """

merge/types/marketing/template_create_params.py

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["TemplateCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    contents: Optional[str]
+    """The template contents."""
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    name: Optional[str]
+    """The template's name."""
+
+    owner: Optional[str]
+    """The template's owner."""
+
+    type: Literal["EMAIL", "MESSAGE"]
+    """
+    - `EMAIL` - EMAIL
+    - `MESSAGE` - MESSAGE
+    """
+
+
+class TemplateCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Template Object
+
+    ### Description
+
+    The `Template` object is used to represent a template for a marketing asset in
+    the remote system.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/templates` endpoint and view their content
+    properties.
+    """

merge/types/marketing/template_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__ = ["TemplateListParams"]
+
+
+class TemplateListParams(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/template_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 template
+
+__all__ = ["TemplateResponse"]
+
+
+class TemplateResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: template.Template
+    """# The Template Object
+
+    ### Description
+
+    The `Template` object is used to represent a template for a marketing asset in
+    the remote system.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/templates` endpoint and view their content
+    properties.
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/marketing/template_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__ = ["TemplateRetrieveParams"]
+
+
+class TemplateRetrieveParams(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/templates/__init__.py

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

merge/types/marketing/user.py

@@ -0,0 +1,47 @@
+# 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__ = ["User"]
+
+
+class User(BaseModel):
+    email: Optional[str]
+    """The user's email."""
+
+    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 user's full 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."""
+
+    role: Optional[Literal["ADMIN", "MANAGER", "CONTRIBUTOR", "VIEWER"]]
+    """
+    - `ADMIN` - ADMIN
+    - `MANAGER` - MANAGER
+    - `CONTRIBUTOR` - CONTRIBUTOR
+    - `VIEWER` - VIEWER
+    """
+
+    timezone: Optional[str]
+    """The user's timezone."""
+
+    username: Optional[str]
+    """The user's username."""