mergepythonclient 2.3.2__py3-none-any.whl → 2.5.0__py3-none-any.whl

merge/resources/knowledgebase/types/audit_log_event_role.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .role_enum import RoleEnum
+
+AuditLogEventRole = typing.Union[RoleEnum, str]

merge/resources/knowledgebase/types/available_actions.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .account_integration import AccountIntegration
+from .model_operation import ModelOperation
+
+
+class AvailableActions(UncheckedBaseModel):
+    """
+    # The AvailableActions Object
+    ### Description
+    The `Activity` object is used to see all available model/operation combinations for an integration.
+
+    ### Usage Example
+    Fetch all the actions available for the `Zenefits` integration.
+    """
+
+    integration: AccountIntegration
+    passthrough_available: bool
+    available_model_operations: typing.Optional[typing.List[ModelOperation]] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

merge/resources/knowledgebase/types/categories_enum.py

@@ -0,0 +1,56 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class CategoriesEnum(str, enum.Enum):
+    """
+    * `hris` - hris
+    * `ats` - ats
+    * `accounting` - accounting
+    * `ticketing` - ticketing
+    * `crm` - crm
+    * `mktg` - mktg
+    * `filestorage` - filestorage
+    * `knowledgebase` - knowledgebase
+    """
+
+    HRIS = "hris"
+    ATS = "ats"
+    ACCOUNTING = "accounting"
+    TICKETING = "ticketing"
+    CRM = "crm"
+    MKTG = "mktg"
+    FILESTORAGE = "filestorage"
+    KNOWLEDGEBASE = "knowledgebase"
+
+    def visit(
+        self,
+        hris: typing.Callable[[], T_Result],
+        ats: typing.Callable[[], T_Result],
+        accounting: typing.Callable[[], T_Result],
+        ticketing: typing.Callable[[], T_Result],
+        crm: typing.Callable[[], T_Result],
+        mktg: typing.Callable[[], T_Result],
+        filestorage: typing.Callable[[], T_Result],
+        knowledgebase: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is CategoriesEnum.HRIS:
+            return hris()
+        if self is CategoriesEnum.ATS:
+            return ats()
+        if self is CategoriesEnum.ACCOUNTING:
+            return accounting()
+        if self is CategoriesEnum.TICKETING:
+            return ticketing()
+        if self is CategoriesEnum.CRM:
+            return crm()
+        if self is CategoriesEnum.MKTG:
+            return mktg()
+        if self is CategoriesEnum.FILESTORAGE:
+            return filestorage()
+        if self is CategoriesEnum.KNOWLEDGEBASE:
+            return knowledgebase()

merge/resources/knowledgebase/types/category_enum.py

@@ -0,0 +1,56 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class CategoryEnum(str, enum.Enum):
+    """
+    * `hris` - hris
+    * `ats` - ats
+    * `accounting` - accounting
+    * `ticketing` - ticketing
+    * `crm` - crm
+    * `mktg` - mktg
+    * `filestorage` - filestorage
+    * `knowledgebase` - knowledgebase
+    """
+
+    HRIS = "hris"
+    ATS = "ats"
+    ACCOUNTING = "accounting"
+    TICKETING = "ticketing"
+    CRM = "crm"
+    MKTG = "mktg"
+    FILESTORAGE = "filestorage"
+    KNOWLEDGEBASE = "knowledgebase"
+
+    def visit(
+        self,
+        hris: typing.Callable[[], T_Result],
+        ats: typing.Callable[[], T_Result],
+        accounting: typing.Callable[[], T_Result],
+        ticketing: typing.Callable[[], T_Result],
+        crm: typing.Callable[[], T_Result],
+        mktg: typing.Callable[[], T_Result],
+        filestorage: typing.Callable[[], T_Result],
+        knowledgebase: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is CategoryEnum.HRIS:
+            return hris()
+        if self is CategoryEnum.ATS:
+            return ats()
+        if self is CategoryEnum.ACCOUNTING:
+            return accounting()
+        if self is CategoryEnum.TICKETING:
+            return ticketing()
+        if self is CategoryEnum.CRM:
+            return crm()
+        if self is CategoryEnum.MKTG:
+            return mktg()
+        if self is CategoryEnum.FILESTORAGE:
+            return filestorage()
+        if self is CategoryEnum.KNOWLEDGEBASE:
+            return knowledgebase()

merge/resources/knowledgebase/types/common_model_scope_api.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .individual_common_model_scope_deserializer import IndividualCommonModelScopeDeserializer
+
+
+class CommonModelScopeApi(UncheckedBaseModel):
+    common_models: typing.List[IndividualCommonModelScopeDeserializer] = pydantic.Field()
+    """
+    The common models you want to update the scopes for
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

merge/resources/knowledgebase/types/common_model_scopes_body_request.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .enabled_actions_enum import EnabledActionsEnum
+
+
+class CommonModelScopesBodyRequest(UncheckedBaseModel):
+    model_id: str
+    enabled_actions: typing.List[EnabledActionsEnum]
+    disabled_fields: typing.List[str]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

merge/resources/knowledgebase/types/completed_account_initial_screen_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CompletedAccountInitialScreenEnum = typing.Literal["SELECTIVE_SYNC"]

merge/resources/knowledgebase/types/container.py

@@ -0,0 +1,130 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .container_permissions_item import ContainerPermissionsItem
+from .container_status import ContainerStatus
+from .container_type import ContainerType
+from .container_visibility import ContainerVisibility
+from .remote_data import RemoteData
+
+
+class Container(UncheckedBaseModel):
+    """
+    # The Container Object
+    ### Description
+    The Container object is used to represent a grouping of articles in the knowledge base. This can include Spaces, Folders, Databases, etc.
+    ### Usage Example
+    Fetch from the `GET /api/knowledgebase/v1/containers` endpoint and view their containers.
+    """
+
+    id: typing.Optional[str] = None
+    remote_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The third-party API ID of the matching object.
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The datetime that this object was created by Merge.
+    """
+
+    modified_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The datetime that this object was modified by Merge.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Name of the container.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Description of the container.
+    """
+
+    status: typing.Optional[ContainerStatus] = pydantic.Field(default=None)
+    """
+    The container's status.
+    
+    * `DRAFT` - DRAFT
+    * `PUBLISHED` - PUBLISHED
+    * `ARCHIVED` - ARCHIVED
+    * `TRASH` - TRASH
+    """
+
+    container_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The URL to the webpage of the container.
+    """
+
+    type: typing.Optional[ContainerType] = pydantic.Field(default=None)
+    """
+    The container's type.
+    
+    * `FOLDER` - FOLDER
+    * `SPACE` - SPACE
+    * `COLLECTION` - COLLECTION
+    * `SECTION` - SECTION
+    * `CATEGORY` - CATEGORY
+    * `DATABASE` - DATABASE
+    """
+
+    visibility: typing.Optional[ContainerVisibility] = pydantic.Field(default=None)
+    """
+    The container's visibility.
+    
+    * `PUBLIC` - PUBLIC
+    * `INTERNAL` - INTERNAL
+    * `RESTRICTED` - RESTRICTED
+    """
+
+    remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    When the third party's container was created.
+    """
+
+    remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    When the third party's container was updated.
+    """
+
+    parent_article: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The parent article a container is nested within.
+    """
+
+    parent_container: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The parent container a container is nested within.
+    """
+
+    permissions: typing.Optional[typing.List[ContainerPermissionsItem]] = None
+    remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+    """
+
+    field_mappings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    remote_data: typing.Optional[typing.List[RemoteData]] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow
+
+
+from .group import Group  # noqa: E402, F401, I001
+
+update_forward_refs(Container)

merge/resources/knowledgebase/types/container_permissions_item.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .permission import Permission
+
+ContainerPermissionsItem = typing.Union[str, Permission]

merge/resources/knowledgebase/types/container_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .status_3_c_6_enum import Status3C6Enum
+
+ContainerStatus = typing.Union[Status3C6Enum, str]

merge/resources/knowledgebase/types/container_type.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .container_type_enum import ContainerTypeEnum
+
+ContainerType = typing.Union[ContainerTypeEnum, str]

merge/resources/knowledgebase/types/container_type_enum.py

@@ -0,0 +1,46 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class ContainerTypeEnum(str, enum.Enum):
+    """
+    * `FOLDER` - FOLDER
+    * `SPACE` - SPACE
+    * `COLLECTION` - COLLECTION
+    * `SECTION` - SECTION
+    * `CATEGORY` - CATEGORY
+    * `DATABASE` - DATABASE
+    """
+
+    FOLDER = "FOLDER"
+    SPACE = "SPACE"
+    COLLECTION = "COLLECTION"
+    SECTION = "SECTION"
+    CATEGORY = "CATEGORY"
+    DATABASE = "DATABASE"
+
+    def visit(
+        self,
+        folder: typing.Callable[[], T_Result],
+        space: typing.Callable[[], T_Result],
+        collection: typing.Callable[[], T_Result],
+        section: typing.Callable[[], T_Result],
+        category: typing.Callable[[], T_Result],
+        database: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is ContainerTypeEnum.FOLDER:
+            return folder()
+        if self is ContainerTypeEnum.SPACE:
+            return space()
+        if self is ContainerTypeEnum.COLLECTION:
+            return collection()
+        if self is ContainerTypeEnum.SECTION:
+            return section()
+        if self is ContainerTypeEnum.CATEGORY:
+            return category()
+        if self is ContainerTypeEnum.DATABASE:
+            return database()

merge/resources/knowledgebase/types/container_visibility.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .visibility_enum import VisibilityEnum
+
+ContainerVisibility = typing.Union[VisibilityEnum, str]

merge/resources/knowledgebase/types/data_passthrough_request.py

@@ -0,0 +1,62 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .data_passthrough_request_method import DataPassthroughRequestMethod
+from .data_passthrough_request_request_format import DataPassthroughRequestRequestFormat
+from .multipart_form_field_request import MultipartFormFieldRequest
+
+
+class DataPassthroughRequest(UncheckedBaseModel):
+    """
+    # The DataPassthrough Object
+    ### Description
+    The `DataPassthrough` object is used to send information to an otherwise-unsupported third-party endpoint.
+
+    ### Usage Example
+    Create a `DataPassthrough` to get team hierarchies from your Rippling integration.
+    """
+
+    method: DataPassthroughRequestMethod
+    path: str = pydantic.Field()
+    """
+    The path of the request in the third party's platform.
+    """
+
+    base_url_override: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    An optional override of the third party's base url for the request.
+    """
+
+    data: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The data with the request. You must include a `request_format` parameter matching the data's format
+    """
+
+    multipart_form_data: typing.Optional[typing.List[MultipartFormFieldRequest]] = pydantic.Field(default=None)
+    """
+    Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`.
+    """
+
+    headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    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.
+    """
+
+    request_format: typing.Optional[DataPassthroughRequestRequestFormat] = None
+    normalize_response: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    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`.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

merge/resources/knowledgebase/types/data_passthrough_request_method.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .method_enum import MethodEnum
+
+DataPassthroughRequestMethod = typing.Union[MethodEnum, str]

merge/resources/knowledgebase/types/data_passthrough_request_request_format.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .request_format_enum import RequestFormatEnum
+
+DataPassthroughRequestRequestFormat = typing.Union[RequestFormatEnum, str]

merge/resources/knowledgebase/types/debug_mode_log.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .debug_model_log_summary import DebugModelLogSummary
+
+
+class DebugModeLog(UncheckedBaseModel):
+    log_id: str
+    dashboard_view: str
+    log_summary: DebugModelLogSummary
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

merge/resources/knowledgebase/types/debug_model_log_summary.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class DebugModelLogSummary(UncheckedBaseModel):
+    url: str
+    method: str
+    status_code: int
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

merge/resources/knowledgebase/types/enabled_actions_enum.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class EnabledActionsEnum(str, enum.Enum):
+    """
+    * `READ` - READ
+    * `WRITE` - WRITE
+    """
+
+    READ = "READ"
+    WRITE = "WRITE"
+
+    def visit(self, read: typing.Callable[[], T_Result], write: typing.Callable[[], T_Result]) -> T_Result:
+        if self is EnabledActionsEnum.READ:
+            return read()
+        if self is EnabledActionsEnum.WRITE:
+            return write()

merge/resources/knowledgebase/types/encoding_enum.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class EncodingEnum(str, enum.Enum):
+    """
+    * `RAW` - RAW
+    * `BASE64` - BASE64
+    * `GZIP_BASE64` - GZIP_BASE64
+    """
+
+    RAW = "RAW"
+    BASE_64 = "BASE64"
+    GZIP_BASE_64 = "GZIP_BASE64"
+
+    def visit(
+        self,
+        raw: typing.Callable[[], T_Result],
+        base_64: typing.Callable[[], T_Result],
+        gzip_base_64: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is EncodingEnum.RAW:
+            return raw()
+        if self is EncodingEnum.BASE_64:
+            return base_64()
+        if self is EncodingEnum.GZIP_BASE_64:
+            return gzip_base_64()

merge/resources/knowledgebase/types/error_validation_problem.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .validation_problem_source import ValidationProblemSource
+
+
+class ErrorValidationProblem(UncheckedBaseModel):
+    source: typing.Optional[ValidationProblemSource] = None
+    title: str
+    detail: str
+    problem_type: str
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow