mergepythonclient 0.0.1__py3-none-any.whl

merge/types/crm/custom_object_classes/__init__.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from .association_type import AssociationType as AssociationType
+from .association_type_response import (
+    AssociationTypeResponse as AssociationTypeResponse,
+)
+from .association_type_list_params import (
+    AssociationTypeListParams as AssociationTypeListParams,
+)
+from .association_type_create_params import (
+    AssociationTypeCreateParams as AssociationTypeCreateParams,
+)
+from .association_type_retrieve_params import (
+    AssociationTypeRetrieveParams as AssociationTypeRetrieveParams,
+)

merge/types/crm/custom_object_classes/association_type.py

@@ -0,0 +1,46 @@
+# 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__ = ["AssociationType", "TargetObjectClass"]
+
+
+class TargetObjectClass(BaseModel):
+    id: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    origin_type: Optional[str]
+
+
+class AssociationType(BaseModel):
+    cardinality: Optional[Literal["ONE_TO_ONE", "MANY_TO_ONE", "MANY_TO_MANY", "ONE_TO_MANY"]]
+    """
+    - `ONE_TO_ONE` - ONE_TO_ONE
+    - `MANY_TO_ONE` - MANY_TO_ONE
+    - `MANY_TO_MANY` - MANY_TO_MANY
+    - `ONE_TO_MANY` - ONE_TO_MANY
+    """
+
+    display_name: Optional[str]
+
+    id: Optional[str]
+
+    is_required: Optional[bool]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""
+
+    remote_key_name: Optional[str]
+
+    source_object_class: Optional[object]
+
+    target_object_classes: Optional[List[TargetObjectClass]]

merge/types/crm/custom_object_classes/association_type_create_params.py

@@ -0,0 +1,54 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["AssociationTypeCreateParams", "Model", "ModelSourceObjectClass", "ModelTargetObjectClass"]
+
+
+class ModelSourceObjectClass(TypedDict, total=False):
+    id: Required[str]
+
+    origin_type: Required[Literal["CUSTOM_OBJECT", "COMMON_MODEL", "REMOTE_ONLY_MODEL"]]
+    """
+    - `CUSTOM_OBJECT` - CUSTOM_OBJECT
+    - `COMMON_MODEL` - COMMON_MODEL
+    - `REMOTE_ONLY_MODEL` - REMOTE_ONLY_MODEL
+    """
+
+
+class ModelTargetObjectClass(TypedDict, total=False):
+    id: Required[str]
+
+    origin_type: Required[Literal["CUSTOM_OBJECT", "COMMON_MODEL", "REMOTE_ONLY_MODEL"]]
+    """
+    - `CUSTOM_OBJECT` - CUSTOM_OBJECT
+    - `COMMON_MODEL` - COMMON_MODEL
+    - `REMOTE_ONLY_MODEL` - REMOTE_ONLY_MODEL
+    """
+
+
+class Model(TypedDict, total=False):
+    remote_key_name: Required[str]
+
+    source_object_class: Required[ModelSourceObjectClass]
+
+    target_object_classes: Required[List[ModelTargetObjectClass]]
+
+    cardinality: Literal["ONE_TO_ONE", "MANY_TO_ONE", "MANY_TO_MANY", "ONE_TO_MANY"]
+    """
+    - `ONE_TO_ONE` - ONE_TO_ONE
+    - `MANY_TO_ONE` - MANY_TO_ONE
+    - `MANY_TO_MANY` - MANY_TO_MANY
+    - `ONE_TO_MANY` - ONE_TO_MANY
+    """
+
+    display_name: str
+
+    is_required: bool
+
+
+class AssociationTypeCreateParams(TypedDict, total=False):
+    model: Required[Model]

merge/types/crm/custom_object_classes/association_type_list_params.py

@@ -0,0 +1,54 @@
+# 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__ = ["AssociationTypeListParams"]
+
+
+class AssociationTypeListParams(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."""
+
+    expand: List[Literal["target_object_classes"]]
+    """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.
+    """
+
+    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/crm/custom_object_classes/association_type_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.crm.custom_object_classes import association_type
+
+__all__ = ["AssociationTypeResponse"]
+
+
+class AssociationTypeResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: association_type.AssociationType
+    """# The AssociationType Object
+
+    ### Description
+
+    The `Association Type` object represents the relationship between two objects.
+
+    ### Usage Example
+
+    TODO
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/crm/custom_object_classes/association_type_retrieve_params.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["AssociationTypeRetrieveParams"]
+
+
+class AssociationTypeRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["target_object_classes"]]
+    """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.
+    """

merge/types/crm/custom_object_classes/association_types/__init__.py

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

merge/types/crm/custom_object_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__ = ["CustomObjectCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    fields: Required[object]
+
+
+class CustomObjectCreateParams(TypedDict, total=False):
+    model: Required[Model]

merge/types/crm/custom_object_list_params.py

@@ -0,0 +1,54 @@
+# 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__ = ["CustomObjectListParams"]
+
+
+class CustomObjectListParams(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.
+    """
+
+    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.
+    """
+
+    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/custom_object_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.crm import custom_object
+
+__all__ = ["CustomObjectResponse"]
+
+
+class CustomObjectResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: custom_object.CustomObject
+    """# The CustomObject Object
+
+    ### Description
+
+    The `Custom Object` record refers to an instance of a Custom Object Class.
+
+    ### Usage Example
+
+    TODO
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/crm/custom_object_retrieve_params.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["CustomObjectRetrieveParams"]
+
+
+class CustomObjectRetrieveParams(TypedDict, total=False):
+    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/custom_object_update_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__ = ["CustomObjectUpdateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    fields: Required[object]
+
+
+class CustomObjectUpdateParams(TypedDict, total=False):
+    model: Required[Model]

merge/types/crm/custom_objects/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from .association import Association as Association
+from .association_list_params import AssociationListParams as AssociationListParams

merge/types/crm/custom_objects/association.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import Optional
+from datetime import datetime
+
+from ...._models import BaseModel
+
+__all__ = ["Association"]
+
+
+class Association(BaseModel):
+    association_type: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    source_object: Optional[object]
+
+    target_object: Optional[object]

merge/types/crm/custom_objects/association_list_params.py

@@ -0,0 +1,57 @@
+# 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__ = ["AssociationListParams"]
+
+
+class AssociationListParams(TypedDict, total=False):
+    association_type_id: str
+    """If provided, will only return opportunities with this association_type."""
+
+    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["association_type"]]
+    """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.
+    """
+
+    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/crm/engagement.py

@@ -0,0 +1,64 @@
+# 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__ = ["Engagement", "RemoteField"]
+
+
+class RemoteField(BaseModel):
+    remote_field_class: shared.RemoteFieldClass
+
+    value: Optional[object]
+
+
+class Engagement(BaseModel):
+    account: Optional[str]
+    """The account of the engagement."""
+
+    contacts: Optional[List[Optional[str]]]
+
+    content: Optional[str]
+    """The engagement's content."""
+
+    direction: Optional[Literal["INBOUND", "OUTBOUND"]]
+    """
+    - `INBOUND` - INBOUND
+    - `OUTBOUND` - OUTBOUND
+    """
+
+    end_time: Optional[datetime]
+    """The time at which the engagement ended."""
+
+    engagement_type: Optional[str]
+    """The engagement type of the engagement."""
+
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    owner: Optional[str]
+    """The engagement's owner."""
+
+    remote_data: Optional[List[shared.RemoteData]]
+
+    remote_fields: Optional[List[RemoteField]]
+
+    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_time: Optional[datetime]
+    """The time at which the engagement started."""
+
+    subject: Optional[str]
+    """The engagement's subject."""

merge/types/crm/engagement_create_params.py

@@ -0,0 +1,61 @@
+# 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__ = ["EngagementCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    account: Optional[str]
+    """The account of the engagement."""
+
+    contacts: List[Optional[str]]
+
+    content: Optional[str]
+    """The engagement's content."""
+
+    direction: Literal["INBOUND", "OUTBOUND"]
+    """
+    - `INBOUND` - INBOUND
+    - `OUTBOUND` - OUTBOUND
+    """
+
+    end_time: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """The time at which the engagement ended."""
+
+    engagement_type: Optional[str]
+    """The engagement type of the engagement."""
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    owner: Optional[str]
+    """The engagement's owner."""
+
+    start_time: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """The time at which the engagement started."""
+
+    subject: Optional[str]
+    """The engagement's subject."""
+
+
+class EngagementCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Engagement Object
+
+    ### Description
+
+    The `Engagement` object is used to represent an interaction noted in a CRM
+    system.
+
+    ### Usage Example
+
+    TODO
+    """

merge/types/crm/engagement_list_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, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["EngagementListParams"]
+
+
+class EngagementListParams(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."""
+
+    expand: List[Literal["account", "contacts", "engagement_type", "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.
+    """
+
+    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/engagement_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__ = ["EngagementListRemoteFieldClassesParams"]
+
+
+class EngagementListRemoteFieldClassesParams(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."""