mergepythonclient 0.0.1__py3-none-any.whl

merge/types/file_storage/folder.py

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ..._models import BaseModel
+
+__all__ = ["Folder"]
+
+
+class Folder(BaseModel):
+    permissions: List[str]
+    """
+    The Permission object is used to represent a user's or group's access to a File
+    or Folder. Permissions are unexpanded by default. Use the query param
+    `expand=permissions` to see more details under `GET /folders`.
+    """
+
+    description: Optional[str]
+    """The folder's description."""
+
+    drive: Optional[str]
+    """The drive that the folder belongs to."""
+
+    field_mappings: Optional[object]
+
+    folder_url: Optional[str]
+    """The URL to access the folder."""
+
+    id: Optional[str]
+
+    modified_at: Optional[datetime]
+    """This is the datetime that this object was last updated by Merge"""
+
+    name: Optional[str]
+    """The folder's name."""
+
+    parent_folder: Optional[str]
+    """The folder that the folder belongs to."""
+
+    remote_created_at: Optional[datetime]
+    """When the third party's folder was created."""
+
+    remote_data: Optional[List[Optional[object]]]
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""
+
+    remote_updated_at: Optional[datetime]
+    """When the third party's folder was updated."""
+
+    size: Optional[int]
+    """The folder's size, in bytes."""

merge/types/file_storage/folder_create_params.py

@@ -0,0 +1,55 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["FolderCreateParams", "Model"]
+
+
+class Model(TypedDict, total=False):
+    permissions: Required[List[str]]
+    """
+    The Permission object is used to represent a user's or group's access to a File
+    or Folder. Permissions are unexpanded by default. Use the query param
+    `expand=permissions` to see more details under `GET /folders`.
+    """
+
+    description: Optional[str]
+    """The folder's description."""
+
+    drive: Optional[str]
+    """The drive that the folder belongs to."""
+
+    folder_url: Optional[str]
+    """The URL to access the folder."""
+
+    integration_params: Optional[object]
+
+    linked_account_params: Optional[object]
+
+    name: Optional[str]
+    """The folder's name."""
+
+    parent_folder: Optional[str]
+    """The folder that the folder belongs to."""
+
+    size: Optional[int]
+    """The folder's size, in bytes."""
+
+
+class FolderCreateParams(TypedDict, total=False):
+    model: Required[Model]
+    """# The Folder Object
+
+    ### Description
+
+    The `Folder` object is used to represent a collection of files and/or folders in
+    the workspace. Could be within a drive, if it exsts.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/filestorage/v1/folders` endpoint and view their
+    folders.
+    """

merge/types/file_storage/folder_list_params.py

@@ -0,0 +1,69 @@
+# 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__ = ["FolderListParams"]
+
+
+class FolderListParams(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."""
+
+    drive_id: str
+    """If provided, will only return folders in this drive."""
+
+    expand: List[Literal["drive", "parent_folder", "permissions"]]
+    """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.
+    """
+
+    name: Optional[str]
+    """If provided, will only return folders with this name.
+
+    This performs an exact match.
+    """
+
+    page_size: int
+    """Number of results to return per page."""
+
+    parent_folder_id: str
+    """If provided, will only return folders in this parent folder.
+
+    If null, will return folders in root directory.
+    """
+
+    remote_id: Optional[str]
+    """The API provider's ID for the given object."""

merge/types/file_storage/folder_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.file_storage import folder
+
+__all__ = ["FolderResponse"]
+
+
+class FolderResponse(BaseModel):
+    errors: List[shared.ValidationError]
+
+    model: folder.Folder
+    """# The Folder Object
+
+    ### Description
+
+    The `Folder` object is used to represent a collection of files and/or folders in
+    the workspace. Could be within a drive, if it exsts.
+
+    ### Usage Example
+
+    Fetch from the `GET /api/filestorage/v1/folders` endpoint and view their
+    folders.
+    """
+
+    warnings: List[shared.ValidationWarning]
+
+    logs: Optional[List[shared.DebugLog]]

merge/types/file_storage/folder_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__ = ["FolderRetrieveParams"]
+
+
+class FolderRetrieveParams(TypedDict, total=False):
+    expand: List[Literal["drive", "parent_folder", "permissions"]]
+    """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/file_storage/folders/__init__.py

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

merge/types/file_storage/group.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ..._models import BaseModel
+
+__all__ = ["Group"]
+
+
+class Group(BaseModel):
+    users: List[str]
+    """The users that belong in the group.
+
+    If null, this typically means it's either a domain or the third-party platform
+    does not surface this information.
+    """
+
+    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 group's name."""
+
+    remote_data: Optional[List[Optional[object]]]
+
+    remote_id: Optional[str]
+    """The third-party API ID of the matching object."""

merge/types/file_storage/group_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__ = ["GroupListParams"]
+
+
+class GroupListParams(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/file_storage/group_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__ = ["GroupRetrieveParams"]
+
+
+class GroupRetrieveParams(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/file_storage/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/file_storage/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/.
+    """

merge/types/file_storage/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/file_storage/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/file_storage/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/file_storage/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/file_storage/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
+]