mergepythonclient 0.0.1__py3-none-any.whl

merge/types/crm/note.py

@@ -0,0 +1,54 @@
+# 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__ = ["Note", "RemoteField"]
+
+
+class RemoteField(BaseModel):
+    remote_field_class: shared.RemoteFieldClass
+
+    value: Optional[object]
+
+
+class Note(BaseModel):
+    account: Optional[str]
+    """The note's account."""
+
+    contact: Optional[str]
+    """The note's contact."""
+
+    content: Optional[str]
+    """The note's content."""
+
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    opportunity: Optional[str]
+    """The note's opportunity."""
+
+    owner: Optional[str]
+    """The note's owner."""
+
+    remote_created_at: Optional[datetime]
+    """When the third party's lead was created."""
+
+    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_updated_at: Optional[datetime]
+    """When the third party's lead was updated."""
+
+    remote_was_deleted: Optional[bool]

merge/types/crm/note_create_params.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["NoteCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    account: Optional[str]
+    """The note's account."""
+
+    contact: Optional[str]
+    """The note's contact."""
+
+    content: Optional[str]
+    """The note's content."""
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    opportunity: Optional[str]
+    """The note's opportunity."""
+
+    owner: Optional[str]
+    """The note's owner."""
+
+
+class NoteCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Note Object
+
+    ### Description
+
+    The `Note` object is used to represent a note on another object.
+
+    ### Usage Example
+
+    TODO
+    """

merge/types/crm/note_list_params.py

@@ -0,0 +1,72 @@
+# 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__ = ["NoteListParams"]
+
+
+class NoteListParams(TypedDict, total=False):
+    account_id: str
+    """If provided, will only return notes with this account."""
+
+    contact_id: str
+    """If provided, will only return notes 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["account", "contact", "opportunity", "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.
+    """
+
+    opportunity_id: str
+    """If provided, will only return notes with this opportunity."""
+
+    owner_id: str
+    """If provided, will only return notes 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/note_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__ = ["NoteListRemoteFieldClassesParams"]
+
+
+class NoteListRemoteFieldClassesParams(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/note_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 note
+
+__all__ = ["NoteResponse"]
+
+
+class NoteResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: note.Note
+    """# The Note Object
+
+    ### Description
+
+    The `Note` object is used to represent a note on another object.
+
+    ### Usage Example
+
+    TODO
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/crm/note_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__ = ["NoteRetrieveParams"]
+
+
+class NoteRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["account", "contact", "opportunity", "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/notes/__init__.py

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

merge/types/crm/opportunities/__init__.py

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

merge/types/crm/opportunity.py

@@ -0,0 +1,68 @@
+# 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__ = ["Opportunity", "RemoteField"]
+
+
+class RemoteField(BaseModel):
+    remote_field_class: shared.RemoteFieldClass
+
+    value: Optional[object]
+
+
+class Opportunity(BaseModel):
+    account: Optional[str]
+    """The account of the opportunity."""
+
+    amount: Optional[int]
+    """The opportunity's amount."""
+
+    close_date: Optional[datetime]
+    """When the opportunity was closed."""
+
+    description: Optional[str]
+    """The opportunity's description."""
+
+    field_mappings: Optional[object]
+
+    id: Optional[str]
+
+    last_activity_at: Optional[datetime]
+    """When the opportunity's last activity occurred."""
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    name: Optional[str]
+    """The opportunity's name."""
+
+    owner: Optional[str]
+    """The opportunity's owner."""
+
+    remote_created_at: Optional[datetime]
+    """When the third party's opportunity was created."""
+
+    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]
+
+    stage: Optional[str]
+    """The stage of the opportunity."""
+
+    status: Optional[Literal["OPEN", "WON", "LOST"]]
+    """
+    - `OPEN` - OPEN
+    - `WON` - WON
+    - `LOST` - LOST
+    """

merge/types/crm/opportunity_create_params.py

@@ -0,0 +1,63 @@
+# 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 Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["OpportunityCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    account: Optional[str]
+    """The account of the opportunity."""
+
+    amount: Optional[int]
+    """The opportunity's amount."""
+
+    close_date: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """When the opportunity was closed."""
+
+    description: Optional[str]
+    """The opportunity's description."""
+
+    integration_params: Optional[object]
+
+    last_activity_at: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """When the opportunity's last activity occurred."""
+
+    linked_account_params: Optional[object]
+
+    name: Optional[str]
+    """The opportunity's name."""
+
+    owner: Optional[str]
+    """The opportunity's owner."""
+
+    stage: Optional[str]
+    """The stage of the opportunity."""
+
+    status: Literal["OPEN", "WON", "LOST"]
+    """
+    - `OPEN` - OPEN
+    - `WON` - WON
+    - `LOST` - LOST
+    """
+
+
+class OpportunityCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Opportunity Object
+
+    ### Description
+
+    The `Opportunity` object is used to represent a deal opportunity in a CRM
+    system.
+
+    ### Usage Example
+
+    TODO
+    """

merge/types/crm/opportunity_list_params.py

@@ -0,0 +1,85 @@
+# 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__ = ["OpportunityListParams"]
+
+
+class OpportunityListParams(TypedDict, total=False):
+    account_id: str
+    """If provided, will only return opportunities with this account."""
+
+    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", "owner", "stage"]]
+    """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 opportunities with this owner."""
+
+    page_size: int
+    """Number of results to return per page."""
+
+    remote_fields: Literal["status"]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    show_enum_origins: Literal["status"]
+    """Which fields should be returned in non-normalized form."""
+
+    stage_id: str
+    """If provided, will only return opportunities with this stage."""
+
+    status: Optional[Literal["LOST", "OPEN", "WON"]]
+    """If provided, will only return opportunities with this status.
+
+    Options: ('OPEN', 'WON', 'LOST')
+
+    - `OPEN` - OPEN
+    - `WON` - WON
+    - `LOST` - LOST
+    """

merge/types/crm/opportunity_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__ = ["OpportunityListRemoteFieldClassesParams"]
+
+
+class OpportunityListRemoteFieldClassesParams(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/opportunity_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 opportunity
+
+__all__ = ["OpportunityResponse"]
+
+
+class OpportunityResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: opportunity.Opportunity
+    """# The Opportunity Object
+
+    ### Description
+
+    The `Opportunity` object is used to represent a deal opportunity in a CRM
+    system.
+
+    ### Usage Example
+
+    TODO
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/crm/opportunity_retrieve_params.py

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

merge/types/crm/opportunity_update_params.py

@@ -0,0 +1,63 @@
+# 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 Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["OpportunityUpdateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    account: Optional[str]
+    """The account of the opportunity."""
+
+    amount: Optional[int]
+    """The opportunity's amount."""
+
+    close_date: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """When the opportunity was closed."""
+
+    description: Optional[str]
+    """The opportunity's description."""
+
+    integration_params: Optional[object]
+
+    last_activity_at: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """When the opportunity's last activity occurred."""
+
+    linked_account_params: Optional[object]
+
+    name: Optional[str]
+    """The opportunity's name."""
+
+    owner: Optional[str]
+    """The opportunity's owner."""
+
+    stage: Optional[str]
+    """The stage of the opportunity."""
+
+    status: Literal["OPEN", "WON", "LOST"]
+    """
+    - `OPEN` - OPEN
+    - `WON` - WON
+    - `LOST` - LOST
+    """
+
+
+class OpportunityUpdateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Opportunity Object
+
+    ### Description
+
+    The `Opportunity` object is used to represent a deal opportunity in a CRM
+    system.
+
+    ### Usage Example
+
+    TODO
+    """