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

merge/resources/knowledgebase/types/permission_type_enum.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class PermissionTypeEnum(str, enum.Enum):
+    """
+    * `USER` - USER
+    * `GROUP` - GROUP
+    * `COMPANY` - COMPANY
+    * `ANYONE` - ANYONE
+    """
+
+    USER = "USER"
+    GROUP = "GROUP"
+    COMPANY = "COMPANY"
+    ANYONE = "ANYONE"
+
+    def visit(
+        self,
+        user: typing.Callable[[], T_Result],
+        group: typing.Callable[[], T_Result],
+        company: typing.Callable[[], T_Result],
+        anyone: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is PermissionTypeEnum.USER:
+            return user()
+        if self is PermissionTypeEnum.GROUP:
+            return group()
+        if self is PermissionTypeEnum.COMPANY:
+            return company()
+        if self is PermissionTypeEnum.ANYONE:
+            return anyone()

merge/resources/knowledgebase/types/permission_user.py

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

merge/resources/knowledgebase/types/remote_data.py

@@ -0,0 +1,34 @@
+# 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 RemoteData(UncheckedBaseModel):
+    """
+    # The RemoteData Object
+    ### Description
+    The `RemoteData` object is used to represent the full data pulled from the third-party API for an object.
+
+    ### Usage Example
+    TODO
+    """
+
+    path: str = pydantic.Field()
+    """
+    The third-party API path that is being called.
+    """
+
+    data: typing.Optional[typing.Optional[typing.Any]] = 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/remote_endpoint_info.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 RemoteEndpointInfo(UncheckedBaseModel):
+    method: str
+    url_path: str
+    field_traversal_path: typing.List[typing.Optional[typing.Any]]
+
+    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/remote_field_api.py

@@ -0,0 +1,28 @@
+# 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 .remote_endpoint_info import RemoteEndpointInfo
+from .remote_field_api_advanced_metadata import RemoteFieldApiAdvancedMetadata
+from .remote_field_api_coverage import RemoteFieldApiCoverage
+
+
+class RemoteFieldApi(UncheckedBaseModel):
+    schema_: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field(alias="schema")
+    remote_key_name: str
+    remote_endpoint_info: RemoteEndpointInfo
+    example_values: typing.Optional[typing.List[typing.Optional[typing.Any]]] = None
+    advanced_metadata: typing.Optional[RemoteFieldApiAdvancedMetadata] = None
+    coverage: typing.Optional[RemoteFieldApiCoverage] = 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/remote_field_api_advanced_metadata.py

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

merge/resources/knowledgebase/types/remote_field_api_coverage.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RemoteFieldApiCoverage = typing.Union[int, float]

merge/resources/knowledgebase/types/remote_field_api_response.py

@@ -0,0 +1,25 @@
+# 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 .remote_field_api import RemoteFieldApi
+
+
+class RemoteFieldApiResponse(UncheckedBaseModel):
+    container: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Container", default=None)
+    article: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Article", default=None)
+    attachment: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Attachment", default=None)
+    user: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="User", default=None)
+    group: typing.Optional[typing.List[RemoteFieldApi]] = pydantic.Field(alias="Group", default=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/remote_key.py

@@ -0,0 +1,30 @@
+# 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 RemoteKey(UncheckedBaseModel):
+    """
+    # The RemoteKey Object
+    ### Description
+    The `RemoteKey` object is used to represent a request for a new remote key.
+
+    ### Usage Example
+    Post a `GenerateRemoteKey` to receive a new `RemoteKey`.
+    """
+
+    name: str
+    key: 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/remote_response.py

@@ -0,0 +1,36 @@
+# 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 .remote_response_response_type import RemoteResponseResponseType
+
+
+class RemoteResponse(UncheckedBaseModel):
+    """
+    # The RemoteResponse Object
+    ### Description
+    The `RemoteResponse` object is used to represent information returned from a third-party endpoint.
+
+    ### Usage Example
+    View the `RemoteResponse` returned from your `DataPassthrough`.
+    """
+
+    method: str
+    path: str
+    status: int
+    response: typing.Optional[typing.Any] = None
+    response_headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    response_type: typing.Optional[RemoteResponseResponseType] = None
+    headers: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = 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/remote_response_response_type.py

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

merge/resources/knowledgebase/types/request_format_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 RequestFormatEnum(str, enum.Enum):
+    """
+    * `JSON` - JSON
+    * `XML` - XML
+    * `MULTIPART` - MULTIPART
+    """
+
+    JSON = "JSON"
+    XML = "XML"
+    MULTIPART = "MULTIPART"
+
+    def visit(
+        self,
+        json: typing.Callable[[], T_Result],
+        xml: typing.Callable[[], T_Result],
+        multipart: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is RequestFormatEnum.JSON:
+            return json()
+        if self is RequestFormatEnum.XML:
+            return xml()
+        if self is RequestFormatEnum.MULTIPART:
+            return multipart()

merge/resources/knowledgebase/types/response_type_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 ResponseTypeEnum(str, enum.Enum):
+    """
+    * `JSON` - JSON
+    * `BASE64_GZIP` - BASE64_GZIP
+    """
+
+    JSON = "JSON"
+    BASE_64_GZIP = "BASE64_GZIP"
+
+    def visit(self, json: typing.Callable[[], T_Result], base_64_gzip: typing.Callable[[], T_Result]) -> T_Result:
+        if self is ResponseTypeEnum.JSON:
+            return json()
+        if self is ResponseTypeEnum.BASE_64_GZIP:
+            return base_64_gzip()

merge/resources/knowledgebase/types/role_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 RoleEnum(str, enum.Enum):
+    """
+    * `ADMIN` - ADMIN
+    * `DEVELOPER` - DEVELOPER
+    * `MEMBER` - MEMBER
+    * `API` - API
+    * `SYSTEM` - SYSTEM
+    * `MERGE_TEAM` - MERGE_TEAM
+    """
+
+    ADMIN = "ADMIN"
+    DEVELOPER = "DEVELOPER"
+    MEMBER = "MEMBER"
+    API = "API"
+    SYSTEM = "SYSTEM"
+    MERGE_TEAM = "MERGE_TEAM"
+
+    def visit(
+        self,
+        admin: typing.Callable[[], T_Result],
+        developer: typing.Callable[[], T_Result],
+        member: typing.Callable[[], T_Result],
+        api: typing.Callable[[], T_Result],
+        system: typing.Callable[[], T_Result],
+        merge_team: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is RoleEnum.ADMIN:
+            return admin()
+        if self is RoleEnum.DEVELOPER:
+            return developer()
+        if self is RoleEnum.MEMBER:
+            return member()
+        if self is RoleEnum.API:
+            return api()
+        if self is RoleEnum.SYSTEM:
+            return system()
+        if self is RoleEnum.MERGE_TEAM:
+            return merge_team()

merge/resources/knowledgebase/types/roles_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 RolesEnum(str, enum.Enum):
+    """
+    * `READ` - READ
+    * `WRITE` - WRITE
+    * `OWNER` - OWNER
+    """
+
+    READ = "READ"
+    WRITE = "WRITE"
+    OWNER = "OWNER"
+
+    def visit(
+        self,
+        read: typing.Callable[[], T_Result],
+        write: typing.Callable[[], T_Result],
+        owner: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is RolesEnum.READ:
+            return read()
+        if self is RolesEnum.WRITE:
+            return write()
+        if self is RolesEnum.OWNER:
+            return owner()

merge/resources/knowledgebase/types/selective_sync_configurations_usage_enum.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class SelectiveSyncConfigurationsUsageEnum(str, enum.Enum):
+    """
+    * `IN_NEXT_SYNC` - IN_NEXT_SYNC
+    * `IN_LAST_SYNC` - IN_LAST_SYNC
+    """
+
+    IN_NEXT_SYNC = "IN_NEXT_SYNC"
+    IN_LAST_SYNC = "IN_LAST_SYNC"
+
+    def visit(
+        self, in_next_sync: typing.Callable[[], T_Result], in_last_sync: typing.Callable[[], T_Result]
+    ) -> T_Result:
+        if self is SelectiveSyncConfigurationsUsageEnum.IN_NEXT_SYNC:
+            return in_next_sync()
+        if self is SelectiveSyncConfigurationsUsageEnum.IN_LAST_SYNC:
+            return in_last_sync()

merge/resources/knowledgebase/types/status_3_c_6_enum.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class Status3C6Enum(str, enum.Enum):
+    """
+    * `DRAFT` - DRAFT
+    * `PUBLISHED` - PUBLISHED
+    * `ARCHIVED` - ARCHIVED
+    * `TRASH` - TRASH
+    """
+
+    DRAFT = "DRAFT"
+    PUBLISHED = "PUBLISHED"
+    ARCHIVED = "ARCHIVED"
+    TRASH = "TRASH"
+
+    def visit(
+        self,
+        draft: typing.Callable[[], T_Result],
+        published: typing.Callable[[], T_Result],
+        archived: typing.Callable[[], T_Result],
+        trash: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is Status3C6Enum.DRAFT:
+            return draft()
+        if self is Status3C6Enum.PUBLISHED:
+            return published()
+        if self is Status3C6Enum.ARCHIVED:
+            return archived()
+        if self is Status3C6Enum.TRASH:
+            return trash()

merge/resources/knowledgebase/types/status_fd_5_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 StatusFd5Enum(str, enum.Enum):
+    """
+    * `SYNCING` - SYNCING
+    * `DONE` - DONE
+    * `FAILED` - FAILED
+    * `DISABLED` - DISABLED
+    * `PAUSED` - PAUSED
+    * `PARTIALLY_SYNCED` - PARTIALLY_SYNCED
+    """
+
+    SYNCING = "SYNCING"
+    DONE = "DONE"
+    FAILED = "FAILED"
+    DISABLED = "DISABLED"
+    PAUSED = "PAUSED"
+    PARTIALLY_SYNCED = "PARTIALLY_SYNCED"
+
+    def visit(
+        self,
+        syncing: typing.Callable[[], T_Result],
+        done: typing.Callable[[], T_Result],
+        failed: typing.Callable[[], T_Result],
+        disabled: typing.Callable[[], T_Result],
+        paused: typing.Callable[[], T_Result],
+        partially_synced: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is StatusFd5Enum.SYNCING:
+            return syncing()
+        if self is StatusFd5Enum.DONE:
+            return done()
+        if self is StatusFd5Enum.FAILED:
+            return failed()
+        if self is StatusFd5Enum.DISABLED:
+            return disabled()
+        if self is StatusFd5Enum.PAUSED:
+            return paused()
+        if self is StatusFd5Enum.PARTIALLY_SYNCED:
+            return partially_synced()

merge/resources/knowledgebase/types/sync_status.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .selective_sync_configurations_usage_enum import SelectiveSyncConfigurationsUsageEnum
+from .sync_status_last_sync_result import SyncStatusLastSyncResult
+from .sync_status_status import SyncStatusStatus
+
+
+class SyncStatus(UncheckedBaseModel):
+    """
+    # The SyncStatus Object
+    ### Description
+    The `SyncStatus` object is used to represent the syncing state of an account
+
+    ### Usage Example
+    View the `SyncStatus` for an account to see how recently its models were synced.
+    """
+
+    model_name: str
+    model_id: str
+    last_sync_start: typing.Optional[dt.datetime] = None
+    next_sync_start: typing.Optional[dt.datetime] = None
+    last_sync_result: typing.Optional[SyncStatusLastSyncResult] = None
+    last_sync_finished: typing.Optional[dt.datetime] = None
+    status: SyncStatusStatus
+    is_initial_sync: bool
+    selective_sync_configurations_usage: typing.Optional[SelectiveSyncConfigurationsUsageEnum] = 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/sync_status_last_sync_result.py

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

merge/resources/knowledgebase/types/sync_status_status.py

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

merge/resources/knowledgebase/types/user.py

@@ -0,0 +1,60 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class User(UncheckedBaseModel):
+    """
+    # The User Object
+    ### Description
+    The `User` object is used to represent a user within the Knowledge Base account.
+    ### Usage Example
+    Fetch from the `GET /api/knowledgebase/v1/users` endpoint and view their users.
+    """
+
+    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)
+    """
+    The user's name.
+    """
+
+    email_address: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The user's email address.
+    """
+
+    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
+
+    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/validation_problem_source.py

@@ -0,0 +1,20 @@
+# 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 ValidationProblemSource(UncheckedBaseModel):
+    pointer: 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/visibility_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 VisibilityEnum(str, enum.Enum):
+    """
+    * `PUBLIC` - PUBLIC
+    * `INTERNAL` - INTERNAL
+    * `RESTRICTED` - RESTRICTED
+    """
+
+    PUBLIC = "PUBLIC"
+    INTERNAL = "INTERNAL"
+    RESTRICTED = "RESTRICTED"
+
+    def visit(
+        self,
+        public: typing.Callable[[], T_Result],
+        internal: typing.Callable[[], T_Result],
+        restricted: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is VisibilityEnum.PUBLIC:
+            return public()
+        if self is VisibilityEnum.INTERNAL:
+            return internal()
+        if self is VisibilityEnum.RESTRICTED:
+            return restricted()