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

merge/resources/knowledgebase/types/issue_status.py

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

merge/resources/knowledgebase/types/issue_status_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 IssueStatusEnum(str, enum.Enum):
+    """
+    * `ONGOING` - ONGOING
+    * `RESOLVED` - RESOLVED
+    """
+
+    ONGOING = "ONGOING"
+    RESOLVED = "RESOLVED"
+
+    def visit(self, ongoing: typing.Callable[[], T_Result], resolved: typing.Callable[[], T_Result]) -> T_Result:
+        if self is IssueStatusEnum.ONGOING:
+            return ongoing()
+        if self is IssueStatusEnum.RESOLVED:
+            return resolved()

merge/resources/knowledgebase/types/language_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 LanguageEnum(str, enum.Enum):
+    """
+    * `en` - en
+    * `de` - de
+    """
+
+    EN = "en"
+    DE = "de"
+
+    def visit(self, en: typing.Callable[[], T_Result], de: typing.Callable[[], T_Result]) -> T_Result:
+        if self is LanguageEnum.EN:
+            return en()
+        if self is LanguageEnum.DE:
+            return de()

merge/resources/knowledgebase/types/last_sync_result_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 LastSyncResultEnum(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 LastSyncResultEnum.SYNCING:
+            return syncing()
+        if self is LastSyncResultEnum.DONE:
+            return done()
+        if self is LastSyncResultEnum.FAILED:
+            return failed()
+        if self is LastSyncResultEnum.DISABLED:
+            return disabled()
+        if self is LastSyncResultEnum.PAUSED:
+            return paused()
+        if self is LastSyncResultEnum.PARTIALLY_SYNCED:
+            return partially_synced()

merge/resources/knowledgebase/types/link_token.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 LinkToken(UncheckedBaseModel):
+    link_token: str
+    integration_name: typing.Optional[str] = None
+    magic_link_url: typing.Optional[str] = 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/method_enum.py

@@ -0,0 +1,51 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class MethodEnum(str, enum.Enum):
+    """
+    * `GET` - GET
+    * `OPTIONS` - OPTIONS
+    * `HEAD` - HEAD
+    * `POST` - POST
+    * `PUT` - PUT
+    * `PATCH` - PATCH
+    * `DELETE` - DELETE
+    """
+
+    GET = "GET"
+    OPTIONS = "OPTIONS"
+    HEAD = "HEAD"
+    POST = "POST"
+    PUT = "PUT"
+    PATCH = "PATCH"
+    DELETE = "DELETE"
+
+    def visit(
+        self,
+        get: typing.Callable[[], T_Result],
+        options: typing.Callable[[], T_Result],
+        head: typing.Callable[[], T_Result],
+        post: typing.Callable[[], T_Result],
+        put: typing.Callable[[], T_Result],
+        patch: typing.Callable[[], T_Result],
+        delete: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is MethodEnum.GET:
+            return get()
+        if self is MethodEnum.OPTIONS:
+            return options()
+        if self is MethodEnum.HEAD:
+            return head()
+        if self is MethodEnum.POST:
+            return post()
+        if self is MethodEnum.PUT:
+            return put()
+        if self is MethodEnum.PATCH:
+            return patch()
+        if self is MethodEnum.DELETE:
+            return delete()

merge/resources/knowledgebase/types/model_operation.py

@@ -0,0 +1,32 @@
+# 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 ModelOperation(UncheckedBaseModel):
+    """
+    # The ModelOperation Object
+    ### Description
+    The `ModelOperation` object is used to represent the operations that are currently supported for a given model.
+
+    ### Usage Example
+    View what operations are supported for the `Candidate` endpoint.
+    """
+
+    model_name: str
+    available_operations: typing.List[str]
+    required_post_parameters: typing.List[str]
+    supported_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/model_permission_deserializer.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 ModelPermissionDeserializer(UncheckedBaseModel):
+    is_enabled: typing.Optional[bool] = 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/model_permission_deserializer_request.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 ModelPermissionDeserializerRequest(UncheckedBaseModel):
+    is_enabled: typing.Optional[bool] = 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/multipart_form_field_request.py

@@ -0,0 +1,57 @@
+# 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 .multipart_form_field_request_encoding import MultipartFormFieldRequestEncoding
+
+
+class MultipartFormFieldRequest(UncheckedBaseModel):
+    """
+    # The MultipartFormField Object
+    ### Description
+    The `MultipartFormField` object is used to represent fields in an HTTP request using `multipart/form-data`.
+
+    ### Usage Example
+    Create a `MultipartFormField` to define a multipart form entry.
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the form field
+    """
+
+    data: str = pydantic.Field()
+    """
+    The data for the form field.
+    """
+
+    encoding: typing.Optional[MultipartFormFieldRequestEncoding] = pydantic.Field(default=None)
+    """
+    The encoding of the value of `data`. Defaults to `RAW` if not defined.
+    
+    * `RAW` - RAW
+    * `BASE64` - BASE64
+    * `GZIP_BASE64` - GZIP_BASE64
+    """
+
+    file_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The file name of the form field, if the field is for a file.
+    """
+
+    content_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The MIME type of the file, if the field is for a file.
+    """
+
+    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/multipart_form_field_request_encoding.py

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

merge/resources/knowledgebase/types/paginated_account_details_and_actions_list.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 .account_details_and_actions import AccountDetailsAndActions
+
+
+class PaginatedAccountDetailsAndActionsList(UncheckedBaseModel):
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.Optional[typing.List[AccountDetailsAndActions]] = 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/paginated_article_list.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class PaginatedArticleList(UncheckedBaseModel):
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.Optional[typing.List["Article"]] = 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 .article import Article  # noqa: E402, F401, I001
+from .group import Group  # noqa: E402, F401, I001
+
+update_forward_refs(PaginatedArticleList)

merge/resources/knowledgebase/types/paginated_attachment_list.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 .attachment import Attachment
+
+
+class PaginatedAttachmentList(UncheckedBaseModel):
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.Optional[typing.List[Attachment]] = 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/paginated_audit_log_event_list.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 .audit_log_event import AuditLogEvent
+
+
+class PaginatedAuditLogEventList(UncheckedBaseModel):
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.Optional[typing.List[AuditLogEvent]] = 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/paginated_container_list.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs
+from ....core.unchecked_base_model import UncheckedBaseModel
+from .container import Container
+
+
+class PaginatedContainerList(UncheckedBaseModel):
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.Optional[typing.List[Container]] = 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(PaginatedContainerList)

merge/resources/knowledgebase/types/paginated_group_list.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs
+from ....core.unchecked_base_model import UncheckedBaseModel
+
+
+class PaginatedGroupList(UncheckedBaseModel):
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.Optional[typing.List["Group"]] = 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(PaginatedGroupList)

merge/resources/knowledgebase/types/paginated_issue_list.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 .issue import Issue
+
+
+class PaginatedIssueList(UncheckedBaseModel):
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.Optional[typing.List[Issue]] = 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/paginated_sync_status_list.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 .sync_status import SyncStatus
+
+
+class PaginatedSyncStatusList(UncheckedBaseModel):
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.Optional[typing.List[SyncStatus]] = 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/paginated_user_list.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 .user import User
+
+
+class PaginatedUserList(UncheckedBaseModel):
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.Optional[typing.List[User]] = 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/permission.py

@@ -0,0 +1,77 @@
+# 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 .permission_group import PermissionGroup
+from .permission_type import PermissionType
+from .permission_user import PermissionUser
+from .roles_enum import RolesEnum
+
+
+class Permission(UncheckedBaseModel):
+    """
+    # The Permission Object
+    ### Description
+    The `Permission` object is used to represent a user's or group's access to an article or container. Permissions are unexpanded by default.
+    ### Usage Example
+    """
+
+    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.
+    """
+
+    user: typing.Optional[PermissionUser] = None
+    group: typing.Optional[PermissionGroup] = None
+    type: typing.Optional[PermissionType] = pydantic.Field(default=None)
+    """
+    Denotes what type of people have access to the Article or Container.
+    
+    * `USER` - USER
+    * `GROUP` - GROUP
+    * `COMPANY` - COMPANY
+    * `ANYONE` - ANYONE
+    """
+
+    roles: typing.Optional[typing.List[typing.Optional[RolesEnum]]] = pydantic.Field(default=None)
+    """
+    The permissions that the user or group has for the Article or Container. It is possible for a user or group to have multiple roles, such as viewing & uploading.
+    """
+
+    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
+
+
+from .group import Group  # noqa: E402, F401, I001
+
+update_forward_refs(Permission)

merge/resources/knowledgebase/types/permission_group.py

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

merge/resources/knowledgebase/types/permission_type.py

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