mergepythonclient 0.0.1__py3-none-any.whl

merge/types/ticketing/collection.py

@@ -0,0 +1,42 @@
+# 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__ = ["Collection"]
+
+
+class Collection(BaseModel):
+    collection_type: Optional[Literal["LIST", "PROJECT"]]
+    """
+    - `LIST` - LIST
+    - `PROJECT` - PROJECT
+    """
+
+    description: Optional[str]
+    """The collection's description."""
+
+    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 collection's name."""
+
+    parent_collection: Optional[str]
+    """The parent collection for this collection."""
+
+    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."""

merge/types/ticketing/collection_list_params.py

@@ -0,0 +1,73 @@
+# 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__ = ["CollectionListParams"]
+
+
+class CollectionListParams(TypedDict, total=False):
+    collection_type: Optional[Literal["LIST", "PROJECT"]]
+    """If provided, will only return collections of the given type.
+
+    - `LIST` - LIST
+    - `PROJECT` - PROJECT
+    """
+
+    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["parent_collection"]]
+    """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."""
+
+    parent_collection_id: str
+    """
+    If provided, will only return collections whose parent collection matches the
+    given id.
+    """
+
+    remote_fields: Literal["collection_type"]
+    """Deprecated. Use show_enum_origins."""
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""
+
+    show_enum_origins: Literal["collection_type"]
+    """Which fields should be returned in non-normalized form."""

merge/types/ticketing/collection_list_users_params.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["CollectionListUsersParams"]
+
+
+class CollectionListUsersParams(TypedDict, total=False):
+    cursor: str
+    """The pagination cursor value."""
+
+    expand: List[Literal["teams"]]
+    """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.
+    """
+
+    page_size: int
+    """Number of results to return per page."""

merge/types/ticketing/collection_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__ = ["CollectionRetrieveParams"]
+
+
+class CollectionRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["parent_collection"]]
+    """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["collection_type"]
+    """Deprecated. Use show_enum_origins."""
+
+    show_enum_origins: Literal["collection_type"]
+    """Which fields should be returned in non-normalized form."""

merge/types/ticketing/comment.py

@@ -0,0 +1,46 @@
+# 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__ = ["Comment"]
+
+
+class Comment(BaseModel):
+    body: Optional[str]
+    """The comment's text body."""
+
+    contact: Optional[str]
+    """The author of the Comment, if the author is a Contact."""
+
+    field_mappings: Optional[object]
+
+    html_body: Optional[str]
+    """The comment's text body formatted as html."""
+
+    id: Optional[str]
+
+    is_private: Optional[bool]
+    """Whether or not the comment is internal."""
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    remote_created_at: Optional[datetime]
+    """When the third party's comment was created."""
+
+    remote_data: Optional[List[shared.RemoteData]]
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""
+
+    remote_was_deleted: Optional[bool]
+
+    ticket: Optional[str]
+    """The ticket associated with the comment."""
+
+    user: Optional[str]
+    """The author of the Comment, if the author is a User."""

merge/types/ticketing/comment_create_params.py

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["CommentCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    body: Optional[str]
+    """The comment's text body."""
+
+    contact: Optional[str]
+    """The author of the Comment, if the author is a Contact."""
+
+    html_body: Optional[str]
+    """The comment's text body formatted as html."""
+
+    integration_params: Optional[object]
+
+    is_private: Optional[bool]
+    """Whether or not the comment is internal."""
+
+    linked_account_params: Optional[object]
+
+    ticket: Optional[str]
+    """The ticket associated with the comment."""
+
+    user: Optional[str]
+    """The author of the Comment, if the author is a User."""
+
+
+class CommentCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Comment Object
+
+    ### Description
+
+    The `Comment` object is used to represent a comment on a ticket.
+
+    ### Usage Example
+
+    TODO
+    """

merge/types/ticketing/comment_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__ = ["CommentListParams"]
+
+
+class CommentListParams(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["contact", "ticket", "user"]]
+    """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."""
+
+    ticket_id: str
+    """If provided, will only return comments for this ticket."""

merge/types/ticketing/comment_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.ticketing import comment
+
+__all__ = ["CommentResponse"]
+
+
+class CommentResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: comment.Comment
+    """# The Comment Object
+
+    ### Description
+
+    The `Comment` object is used to represent a comment on a ticket.
+
+    ### Usage Example
+
+    TODO
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/ticketing/comment_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__ = ["CommentRetrieveParams"]
+
+
+class CommentRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["contact", "ticket", "user"]]
+    """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/ticketing/comments/__init__.py

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

merge/types/ticketing/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/ticketing/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/ticketing/contact_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__ = ["ContactListParams"]
+
+
+class ContactListParams(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"]]
+    """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/ticketing/contact_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__ = ["ContactRetrieveParams"]
+
+
+class ContactRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["account"]]
+    """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/ticketing/issue_list_params.py

@@ -0,0 +1,72 @@
+# 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, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["IssueListParams"]
+
+
+class IssueListParams(TypedDict, total=False):
+    account_token: str
+
+    cursor: str
+    """The pagination cursor value."""
+
+    end_date: str
+    """
+    If included, will only include issues whose most recent action occurred before
+    this time
+    """
+
+    end_user_organization_name: str
+
+    first_incident_time_after: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    If provided, will only return issues whose first incident time was after this
+    datetime.
+    """
+
+    first_incident_time_before: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    If provided, will only return issues whose first incident time was before this
+    datetime.
+    """
+
+    include_muted: str
+    """If True, will include muted issues"""
+
+    integration_name: str
+
+    last_incident_time_after: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    If provided, will only return issues whose first incident time was after this
+    datetime.
+    """
+
+    last_incident_time_before: Annotated[Optional[Union[str, datetime]], PropertyInfo(format="iso8601")]
+    """
+    If provided, will only return issues whose first incident time was before this
+    datetime.
+    """
+
+    page_size: int
+    """Number of results to return per page."""
+
+    start_date: str
+    """
+    If included, will only include issues whose most recent action occurred after
+    this time
+    """
+
+    status: Literal["ONGOING", "RESOLVED"]
+    """- `ONGOING` - ONGOING
+    - `RESOLVED` - RESOLVED
+
+    - `ONGOING` - ONGOING
+    - `RESOLVED` - RESOLVED
+    """

merge/types/ticketing/link_token_create_params.py

@@ -0,0 +1,66 @@
+# 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__ = ["LinkTokenCreateParams", "CommonModel"]
+
+
+class CommonModel(TypedDict, total=False):
+    disabled_fields: Required[List[str]]
+
+    enabled_actions: Required[List[Literal["READ", "WRITE"]]]
+
+    model_id: Required[str]
+
+
+class LinkTokenCreateParams(TypedDict, total=False):
+    categories: Required[List[Literal["hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage"]]]
+    """The integration categories to show in Merge Link."""
+
+    end_user_email_address: Required[str]
+    """Your end user's email address.
+
+    This is purely for identification purposes - setting this value will not cause
+    any emails to be sent.
+    """
+
+    end_user_organization_name: Required[str]
+    """Your end user's organization."""
+
+    end_user_origin_id: Required[str]
+    """
+    This unique identifier typically represents the ID for your end user in your
+    product's database. This value must be distinct from other Linked Accounts'
+    unique identifiers.
+    """
+
+    common_models: Optional[List[CommonModel]]
+    """
+    An array of objects to specify the models and fields that will be disabled for a
+    given Linked Account. Each object uses model_id, enabled_actions, and
+    disabled_fields to specify the model, method, and fields that are scoped for a
+    given Linked Account.
+    """
+
+    integration: Optional[str]
+    """The slug of a specific pre-selected integration for this linking flow token.
+
+    For examples of slugs, see
+    https://www.merge.dev/docs/basics/integration-metadata/.
+    """
+
+    link_expiry_mins: int
+    """
+    An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL]
+    for how long this token is valid. Defaults to 30.
+    """
+
+    should_create_magic_link_url: Optional[bool]
+    """Whether to generate a Magic Link URL.
+
+    Defaults to false. For more information on Magic Link, see
+    https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/.
+    """