mergepythonclient 0.0.1__py3-none-any.whl

merge/types/hris/time_off_retrieve_params.py

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["TimeOffRetrieveParams"]
+
+
+class TimeOffRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["approver", "employee"]]
+    """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.
+    """
+
+    remote_fields: Literal[
+        "request_type",
+        "request_type,status",
+        "request_type,status,units",
+        "request_type,units",
+        "status",
+        "status,units",
+        "units",
+    ]
+    """Deprecated. Use show_enum_origins."""
+
+    show_enum_origins: Literal[
+        "request_type",
+        "request_type,status",
+        "request_type,status,units",
+        "request_type,units",
+        "status",
+        "status,units",
+        "units",
+    ]
+    """Which fields should be returned in non-normalized form."""

merge/types/hris/webhook_receiver_create_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["WebhookReceiverCreateParams"]
+
+
+class WebhookReceiverCreateParams(TypedDict, total=False):
+    event: Required[str]
+
+    is_active: Required[bool]
+
+    key: str

merge/types/hris/webhook_receiver_list_response.py

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

merge/types/marketing/__init__.py

@@ -0,0 +1,113 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from .user import User as User
+from .email import Email as Email
+from .event import Event as Event
+from .action import Action as Action
+from .message import Message as Message
+from .campaign import Campaign as Campaign
+from .template import Template as Template
+from .automation import Automation as Automation
+from .contact_list import ContactList as ContactList
+from .action_response import ActionResponse as ActionResponse
+from .contact_response import ContactResponse as ContactResponse
+from .user_list_params import UserListParams as UserListParams
+from .campaign_response import CampaignResponse as CampaignResponse
+from .email_list_params import EmailListParams as EmailListParams
+from .event_list_params import EventListParams as EventListParams
+from .issue_list_params import IssueListParams as IssueListParams
+from .template_response import TemplateResponse as TemplateResponse
+from .action_list_params import ActionListParams as ActionListParams
+from .automation_response import AutomationResponse as AutomationResponse
+from .contact_list_params import ContactListParams as ContactListParams
+from .message_list_params import MessageListParams as MessageListParams
+from .action_create_params import ActionCreateParams as ActionCreateParams
+from .campaign_list_params import CampaignListParams as CampaignListParams
+from .template_list_params import TemplateListParams as TemplateListParams
+from .user_retrieve_params import UserRetrieveParams as UserRetrieveParams
+from .contact_create_params import ContactCreateParams as ContactCreateParams
+from .email_retrieve_params import EmailRetrieveParams as EmailRetrieveParams
+from .event_retrieve_params import EventRetrieveParams as EventRetrieveParams
+from .action_retrieve_params import ActionRetrieveParams as ActionRetrieveParams
+from .automation_list_params import AutomationListParams as AutomationListParams
+from .campaign_create_params import CampaignCreateParams as CampaignCreateParams
+from .template_create_params import TemplateCreateParams as TemplateCreateParams
+from .contact_retrieve_params import ContactRetrieveParams as ContactRetrieveParams
+from .message_retrieve_params import MessageRetrieveParams as MessageRetrieveParams
+from .sync_status_list_params import SyncStatusListParams as SyncStatusListParams
+from .automation_create_params import AutomationCreateParams as AutomationCreateParams
+from .campaign_retrieve_params import CampaignRetrieveParams as CampaignRetrieveParams
+from .contact_list_list_params import ContactListListParams as ContactListListParams
+from .link_token_create_params import LinkTokenCreateParams as LinkTokenCreateParams
+from .template_retrieve_params import TemplateRetrieveParams as TemplateRetrieveParams
+from .automation_retrieve_params import (
+    AutomationRetrieveParams as AutomationRetrieveParams,
+)
+from .contact_list_create_params import (
+    ContactListCreateParams as ContactListCreateParams,
+)
+from .event_list_contacts_params import (
+    EventListContactsParams as EventListContactsParams,
+)
+from .linked_account_list_params import (
+    LinkedAccountListParams as LinkedAccountListParams,
+)
+from .remote_key_generate_params import (
+    RemoteKeyGenerateParams as RemoteKeyGenerateParams,
+)
+from .sync_status_resync_response import (
+    SyncStatusResyncResponse as SyncStatusResyncResponse,
+)
+from .contact_list_create_response import (
+    ContactListCreateResponse as ContactListCreateResponse,
+)
+from .contact_list_retrieve_params import (
+    ContactListRetrieveParams as ContactListRetrieveParams,
+)
+from .email_list_recipients_params import (
+    EmailListRecipientsParams as EmailListRecipientsParams,
+)
+from .remote_key_regenerate_params import (
+    RemoteKeyRegenerateParams as RemoteKeyRegenerateParams,
+)
+from .campaign_list_contacts_params import (
+    CampaignListContactsParams as CampaignListContactsParams,
+)
+from .message_list_recipients_params import (
+    MessageListRecipientsParams as MessageListRecipientsParams,
+)
+from .webhook_receiver_create_params import (
+    WebhookReceiverCreateParams as WebhookReceiverCreateParams,
+)
+from .webhook_receiver_list_response import (
+    WebhookReceiverListResponse as WebhookReceiverListResponse,
+)
+from .passthrough_request_send_params import (
+    PassthroughRequestSendParams as PassthroughRequestSendParams,
+)
+from .common_model_scope_update_params import (
+    CommonModelScopeUpdateParams as CommonModelScopeUpdateParams,
+)
+from .automation_list_recipients_params import (
+    AutomationListRecipientsParams as AutomationListRecipientsParams,
+)
+from .common_model_scope_retrieve_params import (
+    CommonModelScopeRetrieveParams as CommonModelScopeRetrieveParams,
+)
+from .selective_sync_list_metadata_params import (
+    SelectiveSyncListMetadataParams as SelectiveSyncListMetadataParams,
+)
+from .contact_list_list_subscribers_params import (
+    ContactListListSubscribersParams as ContactListListSubscribersParams,
+)
+from .selective_sync_list_configurations_response import (
+    SelectiveSyncListConfigurationsResponse as SelectiveSyncListConfigurationsResponse,
+)
+from .selective_sync_replace_configurations_params import (
+    SelectiveSyncReplaceConfigurationsParams as SelectiveSyncReplaceConfigurationsParams,
+)
+from .selective_sync_replace_configurations_response import (
+    SelectiveSyncReplaceConfigurationsResponse as SelectiveSyncReplaceConfigurationsResponse,
+)

merge/types/marketing/action.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["Action"]
+
+
+class Action(BaseModel):
+    emails: List[str]
+    """The marketing emails sent by this action."""
+
+    messages: List[str]
+    """The messages sent by this action."""
+
+    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 action's name."""
+
+    remote_data: Optional[List[Optional[object]]]
+
+    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."""
+
+    type: Optional[Literal["EMAIL", "MESSAGE"]]
+    """
+    - `EMAIL` - EMAIL
+    - `MESSAGE` - MESSAGE
+    """

merge/types/marketing/action_create_params.py

@@ -0,0 +1,44 @@
+# 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__ = ["ActionCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    emails: Required[List[str]]
+    """The marketing emails sent by this action."""
+
+    messages: Required[List[str]]
+    """The messages sent by this action."""
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    name: Optional[str]
+    """The action's name."""
+
+    type: Literal["EMAIL", "MESSAGE"]
+    """
+    - `EMAIL` - EMAIL
+    - `MESSAGE` - MESSAGE
+    """
+
+
+class ActionCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Action Object
+
+    ### Description
+
+    The `Action` object is used to represent an action executed within an
+    automation.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/actions` endpoint and view their types.
+    """

merge/types/marketing/action_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__ = ["ActionListParams"]
+
+
+class ActionListParams(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/action_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.marketing import action
+
+__all__ = ["ActionResponse"]
+
+
+class ActionResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: action.Action
+    """# The Action Object
+
+    ### Description
+
+    The `Action` object is used to represent an action executed within an
+    automation.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/actions` endpoint and view their types.
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/marketing/action_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__ = ["ActionRetrieveParams"]
+
+
+class ActionRetrieveParams(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/actions/__init__.py

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

merge/types/marketing/automation.py

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["Automation"]
+
+
+class Automation(BaseModel):
+    actions: List[str]
+    """The actions performed by this automation."""
+
+    automation_trigger: Optional[object]
+    """The trigger configuraton for the automation."""
+
+    description: Optional[str]
+    """The automation’s description."""
+
+    end_date: Optional[datetime]
+    """The automation's end date."""
+
+    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 automation's name."""
+
+    remote_data: Optional[List[Optional[object]]]
+
+    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."""
+
+    start_date: Optional[datetime]
+    """The automation's start date."""
+
+    status: Optional[str]
+    """The automation's status."""
+
+    trigger_type: Optional[Literal["TRIGGER_EVENT", "RECURRENCE"]]
+    """
+    - `TRIGGER_EVENT` - TRIGGER_EVENT
+    - `RECURRENCE` - RECURRENCE
+    """

merge/types/marketing/automation_create_params.py

@@ -0,0 +1,60 @@
+# 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 ..._utils import PropertyInfo
+
+__all__ = ["AutomationCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    actions: Required[List[str]]
+    """The actions performed by this automation."""
+
+    automation_trigger: Optional[object]
+    """The trigger configuraton for the automation."""
+
+    description: Optional[str]
+    """The automation’s description."""
+
+    end_date: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """The automation's end date."""
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    name: Optional[str]
+    """The automation's name."""
+
+    start_date: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """The automation's start date."""
+
+    status: Optional[str]
+    """The automation's status."""
+
+    trigger_type: Literal["TRIGGER_EVENT", "RECURRENCE"]
+    """
+    - `TRIGGER_EVENT` - TRIGGER_EVENT
+    - `RECURRENCE` - RECURRENCE
+    """
+
+
+class AutomationCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Automation Object
+
+    ### Description
+
+    The `Automation` object is used to represent an automation, workflow or custom
+    event in the remote system.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/automations` endpoint and view their
+    automation_trigger configurations.
+    """

merge/types/marketing/automation_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__ = ["AutomationListParams"]
+
+
+class AutomationListParams(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/automation_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__ = ["AutomationListRecipientsParams"]
+
+
+class AutomationListRecipientsParams(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/automation_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 automation
+
+__all__ = ["AutomationResponse"]
+
+
+class AutomationResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: automation.Automation
+    """# The Automation Object
+
+    ### Description
+
+    The `Automation` object is used to represent an automation, workflow or custom
+    event in the remote system.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/mktg/v1/automations` endpoint and view their
+    automation_trigger configurations.
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/marketing/automation_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__ = ["AutomationRetrieveParams"]
+
+
+class AutomationRetrieveParams(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/automations/__init__.py

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

merge/types/marketing/campaign.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__ = ["Campaign"]
+
+
+class Campaign(BaseModel):
+    emails_sent: Optional[int]
+    """The campaign's number of emails sent."""
+
+    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 campaign's name."""
+
+    remote_created_at: Optional[datetime]
+    """When the campaign 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_was_deleted: Optional[bool]
+    """Indicates whether or not this object has been deleted by third party webhooks."""
+
+    unique_opens: Optional[int]
+    """The campaign's unique opens."""