python-openarch-api 0.1.0__py3-none-any.whl

python_openarch_api/models/generated.py

@@ -0,0 +1,1380 @@
+# generated by datamodel-codegen:
+#   filename:  openarch-api.yaml
+
+from __future__ import annotations
+
+from datetime import datetime
+from enum import Enum
+from typing import Annotated, Any
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class CopyCommand(BaseModel):
+    """
+    Represents Copy API's HTTP Post body.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    name: str
+    """
+    Name of the document after copying.  Example: "name": "Copied file name"
+    """
+    target_parent_id: Annotated[str, Field(alias="targetParentId")]
+    """
+    Target parent id where the document will be copied.  Example: "targetParentId": "097d50d7-f839-440a-b72c-f2a51ea214b7"
+    """
+
+
+class ExternalUserRelationsSecurityPolicyUser(BaseModel):
+    """
+    User for the External User Relations Security Policy data
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    id: str
+    relations: dict[str, list[str]]
+
+
+class FalseAsNullEnum(Enum):
+    STORE = "STORE"
+    REST = "REST"
+    INDEX = "INDEX"
+
+
+class NotOutputEnum(Enum):
+    STORE = "STORE"
+    REST = "REST"
+    INDEX = "INDEX"
+
+
+class Source(Enum):
+    COMPUTED = "COMPUTED"
+    QUERY_VIRTUAL = "QUERY_VIRTUAL"
+
+
+class FieldCharacteristics(BaseModel):
+    """
+    Repository-managed access, query and output behavior for a field.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    false_as_null: Annotated[
+        list[FalseAsNullEnum] | None, Field(alias="falseAsNull")
+    ] = None
+    no_auto_checkout: Annotated[bool | None, Field(alias="noAutoCheckout")] = None
+    not_output: Annotated[list[NotOutputEnum] | None, Field(alias="notOutput")] = None
+    not_projectable: Annotated[bool | None, Field(alias="notProjectable")] = None
+    not_queryable: Annotated[bool | None, Field(alias="notQueryable")] = None
+    read_permission: Annotated[str | None, Field(alias="readPermission")] = None
+    source: Source | None = None
+    system_owned: Annotated[bool | None, Field(alias="systemOwned")] = None
+    version_write_permission: Annotated[
+        str | None, Field(alias="versionWritePermission")
+    ] = None
+    write_permission: Annotated[str | None, Field(alias="writePermission")] = None
+
+
+class Group(BaseModel):
+    """
+    Represents a group.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    id: str | None = None
+    """
+    UUID of the group.
+    """
+    name: str | None = None
+    """
+    Name of the group.
+    """
+
+
+class ImageLocation(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    bottom: int | None = None
+    left: int | None = None
+    right: int | None = None
+    top: int | None = None
+
+
+class ListEffectivePermissionsPerUserDTO(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    user_id: Annotated[str | None, Field(alias="userId")] = None
+    user_permissions: Annotated[list[str] | None, Field(alias="userPermissions")] = None
+
+
+class MixinType(BaseModel):
+    """
+    Represents a mixin.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    no_per_document_query: Annotated[bool | None, Field(alias="noPerDocumentQuery")] = (
+        None
+    )
+    project_id: Annotated[str | None, Field(alias="projectId")] = None
+    schemas: list[str] | None = None
+
+
+class MoveCommand(BaseModel):
+    """
+    Represents the Move API's HTTP Post body.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    target_parent_id: Annotated[str, Field(alias="targetParentId")]
+    """
+    Target parent id where the document will be moved.  Example: "targetParentId": "097d50d7-f839-440a-b72c-f2a51ea214b7"
+    """
+
+
+class NamedQuery(BaseModel):
+    """
+    Represents a query referencing a pre-defined named query definition by name.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    limit: Annotated[int | None, Field(examples=[100])] = 10
+    """
+    Max number of documents retrieved by the given query.
+    """
+    offset: Annotated[int | None, Field(examples=[0])] = 0
+    """
+    The initial document offset; for pagination support.
+    """
+    parameters: dict[str, Any] | None = None
+    query_name: Annotated[str | None, Field(alias="queryName")] = None
+    """
+    Name of the query.
+    """
+    repository_id: Annotated[str | None, Field(alias="repositoryId")] = "default"
+    """
+    The id of the internal repository.
+    """
+    search_after: Annotated[str | None, Field(alias="searchAfter")] = None
+    """
+    Opaque cursor token for efficient pagination. Use the nextSearchAfter value from a previous response. When provided, offset is ignored.
+    """
+    selected_quick_filters: Annotated[
+        list[str] | None,
+        Field(
+            alias="selectedQuickFilters",
+            examples=[
+                "exclude documents that are not article: mydc_nature != 'article'"
+            ],
+        ),
+    ] = None
+    """
+    List of filters to be applied to the result.
+    """
+    sort: Annotated[list[str] | None, Field(examples=[["sys_title"]])] = None
+    """
+    List of fields used to sort the result.
+    """
+    track_total_count: Annotated[bool | None, Field(alias="trackTotalCount")] = None
+    """
+    If true, the total count of documents retrieved by the query will be computed.
+    """
+    track_total_count_up_to: Annotated[
+        int | None, Field(alias="trackTotalCountUpTo", examples=[100])
+    ] = None
+    """
+    Max number of documents to count. This can be set to -1 to remove the limit but it will be expensive on large indexes.
+    """
+
+
+class PredicateParameter(BaseModel):
+    """
+    Represents an advanced query predicate parameter definition.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    default_value: Annotated[dict[str, Any] | None, Field(alias="defaultValue")] = None
+    name: str | None = None
+
+
+class PrimaryType(BaseModel):
+    """
+    Represents a primary type.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    extends: str | None = None
+    mixins: list[str] | None = None
+    project_id: Annotated[str | None, Field(alias="projectId")] = None
+    schemas: list[str] | None = None
+    special: Annotated[bool | None, Field(deprecated=True)] = None
+    """
+    Deprecated: the special flag is obsolete and will be removed in a future version.
+    """
+    subtypes: list[str] | None = None
+
+
+class QuerySyntax(Enum):
+    """
+    The syntax the query is expressed in; absent for the default hxql syntax.
+    """
+
+    HXQL = "hxql"
+    EXPR = "expr"
+
+
+class QuickFilter(BaseModel):
+    """
+    Represents an advanced query quick filter definition.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    clause: str | None = None
+    name: str | None = None
+    sort: list[str] | None = None
+
+
+class StackTraceItem(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    class_loader_name: Annotated[str | None, Field(alias="classLoaderName")] = None
+    class_name: Annotated[str | None, Field(alias="className")] = None
+    file_name: Annotated[str | None, Field(alias="fileName")] = None
+    line_number: Annotated[int | None, Field(alias="lineNumber")] = None
+    method_name: Annotated[str | None, Field(alias="methodName")] = None
+    module_name: Annotated[str | None, Field(alias="moduleName")] = None
+    module_version: Annotated[str | None, Field(alias="moduleVersion")] = None
+    native_method: Annotated[bool | None, Field(alias="nativeMethod")] = None
+
+
+class SuppressedItem(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    localized_message: Annotated[str | None, Field(alias="localizedMessage")] = None
+    message: str | None = None
+    stack_trace: Annotated[list[StackTraceItem] | None, Field(alias="stackTrace")] = (
+        None
+    )
+
+
+class Cause(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    localized_message: Annotated[str | None, Field(alias="localizedMessage")] = None
+    message: str | None = None
+    stack_trace: Annotated[list[StackTraceItem] | None, Field(alias="stackTrace")] = (
+        None
+    )
+    suppressed: list[SuppressedItem] | None = None
+
+
+class SuppressedItem1(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    localized_message: Annotated[str | None, Field(alias="localizedMessage")] = None
+    message: str | None = None
+    stack_trace: Annotated[list[StackTraceItem] | None, Field(alias="stackTrace")] = (
+        None
+    )
+
+
+class Exception(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    cause: Cause | None = None
+    localized_message: Annotated[str | None, Field(alias="localizedMessage")] = None
+    message: str | None = None
+    stack_trace: Annotated[list[StackTraceItem] | None, Field(alias="stackTrace")] = (
+        None
+    )
+    suppressed: list[SuppressedItem1] | None = None
+
+
+class RepositoryErrorResponse(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    entity_type: Annotated[str | None, Field(alias="entity-type")] = None
+    exception: Exception | None = None
+    message: str | None = None
+    stack_trace: Annotated[list[StackTraceItem] | None, Field(alias="stackTrace")] = (
+        None
+    )
+    status: int | None = None
+
+
+class Resolver(BaseModel):
+    """
+    Represents a resolver. Beyond "name" and "validation", the properties are resolver-specific parameters, e.g. "vocabulary", "repository", "store" or "type".
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    name: str | None = None
+    repository: str | None = None
+    store: str | None = None
+    type: str | None = None
+    validation: bool | None = None
+    vocabulary: str | None = None
+
+
+class SecurityPolicyConfig(BaseModel):
+    """
+    Configuration for a Security Policy
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    content_types: Annotated[list[str] | None, Field(alias="contentTypes")] = None
+    engine: str | None = None
+    expression: str | None = None
+    mixin: str | None = None
+    permissions: list[str] | None = None
+    project_id: Annotated[str | None, Field(alias="projectId")] = None
+    relations: list[str] | None = None
+    user_attribute: Annotated[str | None, Field(alias="userAttribute")] = None
+
+
+class SpreadSheetLocation(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    column: int | None = None
+    row: int | None = None
+    sheet: str | None = None
+
+
+class Status(Enum):
+    """
+    The current status of the application of the ACE rule.
+    """
+
+    PENDING = "PENDING"
+    EFFECTIVE = "EFFECTIVE"
+    ARCHIVED = "ARCHIVED"
+
+
+class StringTermsBucket(BaseModel):
+    """
+    The list of aggregation buckets computed for the query.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+
+
+class TextLocation(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    page: int | None = None
+    paragraph: int | None = None
+
+
+class AttachStatus(Enum):
+    """
+    Status of the blob attachment phase.
+    """
+
+    PENDING = "PENDING"
+    PROCESSING = "PROCESSING"
+    READY = "READY"
+    ERROR = "ERROR"
+
+
+class Status1(Enum):
+    """
+    Status of the upload.
+    """
+
+    INCOMPLETE = "INCOMPLETE"
+    PROCESSING = "PROCESSING"
+    READY = "READY"
+    ERROR = "ERROR"
+
+
+class Upload(BaseModel):
+    """
+    UploadAPI response object
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    attach_doc_id: Annotated[str | None, Field(alias="attachDocId")] = None
+    """
+    Id of the document to which the blob has been attached. Available when attachStatus is READY.
+    """
+    attach_status: Annotated[AttachStatus | None, Field(alias="attachStatus")] = None
+    """
+    Status of the blob attachment phase.
+    """
+    chunk_count: Annotated[int | None, Field(alias="chunkCount")] = None
+    """
+    Number of chunks uploaded.
+    """
+    chunk_indexes: Annotated[list[int] | None, Field(alias="chunkIndexes")] = None
+    """
+    The chunks that compose the Upload.
+    """
+    chunks_completed: Annotated[bool | None, Field(alias="chunksCompleted")] = None
+    """
+    True if the number of loaded chunks is equals to the number of chunks size.
+    """
+    encoding: Annotated[str | None, Field(examples=["UTF-8"])] = None
+    """
+    Encoding of the content.
+    """
+    file_name: Annotated[str | None, Field(alias="fileName")] = None
+    """
+    Name of the associated file of the upload.
+    """
+    file_size: Annotated[int | None, Field(alias="fileSize")] = None
+    """
+    File size in bytes; -1 is returned if the size in unknown.
+    """
+    has_content: Annotated[bool | None, Field(alias="hasContent")] = None
+    """
+    If the upload has associated content is true
+    """
+    id: str | None = None
+    """
+    Upload identifier.
+    """
+    mime_type: Annotated[
+        str | None, Field(alias="mimeType", examples=["plain/text"])
+    ] = None
+    """
+    Mime type of the content.
+    """
+    partial_file_size: Annotated[int | None, Field(alias="partialFileSize")] = None
+    """
+    Partial size in bytes. Amount of bytes for all uploaded chunks.
+    """
+    properties: dict[str, dict[str, Any]] | None = None
+    status: Annotated[Status1 | None, Field(examples=["INCOMPLETE"])] = None
+    """
+    Status of the upload.
+    """
+
+
+class UploadFileInfo(BaseModel):
+    """
+    Represents an uploaded file.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    file_key: Annotated[str | None, Field(alias="fileKey")] = None
+    """
+    file key
+    """
+    file_name: Annotated[
+        str | None, Field(alias="fileName", examples=["myFile.txt"])
+    ] = None
+    """
+    file name
+    """
+    mime_type: Annotated[
+        str | None, Field(alias="mimeType", examples=["text/plain"])
+    ] = None
+    """
+    mimeType
+    """
+
+
+class User(BaseModel):
+    """
+    Represents a user.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    email: str | None = None
+    """
+    Email address of the user.
+    """
+    first_name: Annotated[str | None, Field(alias="firstName")] = None
+    """
+    First name of the user.
+    """
+    id: str | None = None
+    """
+    UUID of the user.
+    """
+    last_name: Annotated[str | None, Field(alias="lastName")] = None
+    """
+    Last name of the user.
+    """
+    properties: dict[str, dict[str, Any]] | None = None
+    username: str | None = None
+    """
+    Login username of the user.
+    """
+
+
+class VectorQuery(BaseModel):
+    """
+    Represents a vector search query.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    chunk_fts: Annotated[str | None, Field(alias="chunkFTS")] = None
+    """
+    An optional space-separated list of terms to search for in the chunk.
+    """
+    embedding_type: Annotated[str | None, Field(alias="embeddingType")] = "*"
+    """
+    A wildcard query for the embedding type.
+    """
+    limit: Annotated[int | None, Field(examples=[100])] = 10
+    """
+    Max number of embeddings retrieved by the given query.
+    """
+    offset: Annotated[int | None, Field(examples=[0])] = 0
+    """
+    The initial embedding offset; for pagination support.
+    """
+    query: Annotated[str | None, Field(examples=["SELECT * FROM SysContent"])] = (
+        "SELECT * FROM SysContent"
+    )
+    """
+    The query used to filter the embeddings by the corresponding document, in the syntax given by the syntax field.
+    """
+    repository_id: Annotated[str | None, Field(alias="repositoryId")] = "default"
+    """
+    The id of the internal repository.
+    """
+    syntax: QuerySyntax | None = None
+    track_total_count: Annotated[bool | None, Field(alias="trackTotalCount")] = False
+    """
+    If true, the total count of embeddings retrieved by the query will be computed.
+    """
+    track_total_count_up_to: Annotated[
+        int | None, Field(alias="trackTotalCountUpTo", examples=[100])
+    ] = None
+    """
+    Max number of embeddings to count. This can be set to -1 to remove the limit but it will be expensive on large indexes.
+    """
+    vector: list[float]
+    """
+    The vector to search for.
+    """
+
+
+class VideoLocation(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    end: float | None = None
+    start: float | None = None
+
+
+class Vocabulary(BaseModel):
+    """
+    Represents a Vocabulary
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    sysvocab_id: str | None = None
+
+
+class VocabularyEntry(BaseModel):
+    """
+    Represents a VocabularyEntry.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    sysvocab_id: str | None = None
+    sysvocab_key: str | None = None
+    sysvocab_label: str | None = None
+
+
+class VocabularyEntryRequest(BaseModel):
+    """
+    Represents a request to create VocabularyEntry.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    sysvocab_key: str | None = None
+    sysvocab_label: str | None = None
+
+
+class VocabularyId(BaseModel):
+    """
+    Represents a Vocabulary ID
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    sysvocab_id: str | None = None
+
+
+class ACE(BaseModel):
+    """
+    REST representation of ACEs.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    begin: datetime | None = None
+    """
+    The date and time when the ACE rule starts being applied.
+    """
+    creator: str | None = None
+    """
+    Name of the user who created the ACE.
+    """
+    end: datetime | None = None
+    """
+    The date and time when the ACE rule stops being applied.
+    """
+    granted: bool | None = None
+    """
+    True/false indicator of whether the specified permission has been granted to the ACE members.
+    """
+    group: Group | None = None
+    permission: str | None = None
+    """
+    The permission assigned to members of the ACE.
+    """
+    status: Status | None = None
+    user: User | None = None
+
+
+class Constraint(BaseModel):
+    """
+    Represents a constraint.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    enumeration: list[dict[str, Any]] | None = None
+    max_exclusive: Annotated[dict[str, Any] | None, Field(alias="maxExclusive")] = None
+    max_inclusive: Annotated[dict[str, Any] | None, Field(alias="maxInclusive")] = None
+    max_length: Annotated[int | None, Field(alias="maxLength")] = None
+    min_exclusive: Annotated[dict[str, Any] | None, Field(alias="minExclusive")] = None
+    min_inclusive: Annotated[dict[str, Any] | None, Field(alias="minInclusive")] = None
+    min_length: Annotated[int | None, Field(alias="minLength")] = None
+    nullable: bool | None = None
+    pattern: str | None = None
+    resolver: Resolver | None = None
+
+
+class Document(BaseModel):
+    """
+    Represents a document.
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+        populate_by_name=True,
+    )
+    sys_acl: list[ACE] | None = None
+    """
+    A list of associations between a user (or group of users) and the permissions that are granted or denied.
+
+    Only included in responses when the user has the `ManageSecurity` permission.
+
+    """
+    sys_ancestor_ids: Annotated[list[str] | None, Field(alias="sys_ancestorIds")] = None
+    """
+    List of UUIDs of the document's ancestors.
+    """
+    sys_change_token: Annotated[str | None, Field(alias="sys_changeToken")] = None
+    """
+    String bundle of the generation and the user generation, as `"<generation>-<userGeneration>"`.
+
+    **Note:** This is a computed property, kept for clients that expect a single opaque change token. New code should use `sys_gen` and `sys_ugen` directly.
+
+    """
+    sys_contributors: list[User] | None = None
+    """
+    List of users who created or modified the document.
+    """
+    sys_created: datetime | None = None
+    """
+    The date and time when the document was created.
+    """
+    sys_creator: User | None = None
+    sys_description: str | None = None
+    """
+    Description of the document.
+    """
+    sys_effective_acl: Annotated[list[ACE] | None, Field(alias="sys_effectiveAcl")] = (
+        None
+    )
+    """
+    A list of associations between a user (or group of users) and the permissions that are granted or denied, including those inherited from the document's ancestors.
+
+    Only included in responses when the user has the `ManageSecurity` permission.
+
+    """
+    sys_effective_permissions: Annotated[
+        list[str] | None, Field(alias="sys_effectivePermissions")
+    ] = None
+    sys_fulltext_binary: Annotated[str | None, Field(alias="sys_fulltextBinary")] = None
+    """
+    The full text extracted from blobs of the current document.
+    """
+    sys_gen: int | None = None
+    """
+    The generation of the document.
+
+    **Note:** The generation is incremented on each update (system or not) to the document.
+
+    """
+    sys_id: str | None = None
+    """
+    UUID of the document.
+
+    **Note:** When included in request bodies for document creation, the sys_id element can be set to match one in an external system, ensuring unicity.
+    Character restrictions include the following:
+    * 200 characters maximum
+    * Characters must be -, _, ., or alphanumeric.
+
+    """
+    sys_is_folderish: Annotated[bool | None, Field(alias="sys_isFolderish")] = None
+    """
+    True/false indicator of whether the document contains the SysFolderish mixin.
+    """
+    sys_is_trashed: Annotated[bool | None, Field(alias="sys_isTrashed")] = None
+    """
+    True when the document is trashed; omitted otherwise.
+    """
+    sys_last_contributor: Annotated[User | None, Field(alias="sys_lastContributor")] = (
+        None
+    )
+    sys_lifecycle_state: Annotated[str | None, Field(alias="sys_lifecycleState")] = None
+    """
+    The lifecycle state of the document.
+    """
+    sys_lock_created: Annotated[datetime | None, Field(alias="sys_lockCreated")] = None
+    """
+    The date and time when the document was locked by a user.
+    """
+    sys_lock_owner: Annotated[User | None, Field(alias="sys_lockOwner")] = None
+    sys_mixin_types: Annotated[list[str] | None, Field(alias="sys_mixinTypes")] = None
+    """
+    Restricted list of the document mixins.
+
+    **Note:** Restrictions include the following:
+    * SysFolderish facet is never seen on document instances (only seen on the type).
+    * In HXQL queries, sys_mixinTypes can only be used with the =, < >, IN, and NOT IN operators.
+
+    """
+    sys_modified: datetime | None = None
+    """
+    The date and time when the document was last modified.
+    """
+    sys_name: str | None = None
+    """
+    The name of the document.
+
+    **Note:** Can be up to 100 characters.
+
+    """
+    sys_parent_id: Annotated[str | None, Field(alias="sys_parentId")] = None
+    """
+    UUID of the document's parent.
+    """
+    sys_parent_path: Annotated[str | None, Field(alias="sys_parentPath")] = None
+    """
+    The path to the document's parent in the repository.
+    """
+    sys_path: str | None = None
+    """
+    The path to the document in the repository.
+
+    **Note:** Computed from the sys_name of the document's ancestors. Cannot be used in all HXQL query contexts.
+
+    """
+    sys_path_depth: Annotated[int | None, Field(alias="sys_pathDepth")] = None
+    """
+    The number of folder levels deep into the repository the document is located.
+    """
+    sys_pos: int | None = None
+    """
+    The position of the document within its parent.
+
+    **Note:** Value is NULL in unordered folders.
+
+    """
+    sys_primary_type: Annotated[str, Field(alias="sys_primaryType")]
+    """
+    The document type of the document.
+
+    **Note:** Required in request bodies for document creation.
+
+    """
+    sys_racl: list[str] | None = None
+    """
+    The denormalized list of principals that can read the document.
+
+    Only included in responses when the user has the `ManageSecurity` permission.
+
+    """
+    sys_repository: str | None = None
+    """
+    Name of the repository where the document resides.
+    """
+    sys_secpol: list[str] | None = None
+    """
+    Names of the security policies associated with the document.
+
+    Only included in responses when the user has the `ManageSecurity` permission.
+
+    """
+    sys_title: str | None = None
+    """
+    The title of the document.
+    """
+    sys_ugen: int | None = None
+    """
+    The user generation of the document.
+
+    **Note:** The user generation is incremented on each client update to the document.
+
+    """
+    sysgov_has_legal_hold: Annotated[
+        bool | None, Field(alias="sysgov_hasLegalHold")
+    ] = None
+    """
+    True/false indicator of whether the document contains the legal hold schema.
+    """
+    sysgov_is_record: Annotated[bool | None, Field(alias="sysgov_isRecord")] = None
+    """
+    True/false indicator of whether the document is a record.
+    """
+    sysgov_retain_until: Annotated[
+        datetime | None, Field(alias="sysgov_retainUntil")
+    ] = None
+    """
+    The date until which the document should be retained.
+    """
+
+
+class DocumentAncestors(BaseModel):
+    """
+    Represents a document's ancestors list.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    ancestors: list[Document] | None = None
+
+
+class ExternalUserRelationsSecurityPolicyRelations(BaseModel):
+    """
+    Configuration for the External User Relations Security Policy relations data
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    users: list[ExternalUserRelationsSecurityPolicyUser] | None = None
+
+
+class FieldModel(BaseModel):
+    """
+    Represents a field.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    constraints: Constraint | None = None
+    default: Annotated[str | None, Field(deprecated=True)] = None
+    """
+    Deprecated: default values are not supported and this property will be removed in a future version.
+    """
+    extends: str | None = None
+    """
+    Name of the referenced type, when the field also declares constraints, a default value or a nested type.
+    """
+    fields: dict[str, FieldModel] | None = None
+    full_text_indexed: Annotated[bool | None, Field(alias="fullTextIndexed")] = None
+    list: FieldModel | None = None
+    managed: FieldCharacteristics | None = None
+    project_id: Annotated[str | None, Field(alias="projectId")] = None
+    type: str | None = None
+    """
+    Name of the referenced type, when the field declares nothing else.
+    """
+
+
+class ListEffectiveACLPerUserDTO(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    user_acl: Annotated[list[ACE] | None, Field(alias="userAcl")] = None
+    user_id: Annotated[str | None, Field(alias="userId")] = None
+
+
+class ListEffectivePermissionsDTO(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    full_effective_permissions: Annotated[
+        list[ListEffectivePermissionsPerUserDTO] | None,
+        Field(alias="fullEffectivePermissions"),
+    ] = None
+    sys_id: str | None = None
+
+
+class LocationModel(BaseModel):
+    """
+    Location the vector is derived from within the original document. For example this could be the page and paragraph number or coordinates of a bounding box.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    position: ImageLocation | None = None
+    spreadsheet: SpreadSheetLocation | None = None
+    text: TextLocation | None = None
+    timestamp: VideoLocation | None = None
+
+
+class Predicate(BaseModel):
+    """
+    Represents an advanced query predicate definition.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    operator: str | None = None
+    parameters: list[PredicateParameter] | None = None
+    search_parameter: Annotated[str | None, Field(alias="searchParameter")] = None
+
+
+class Query(BaseModel):
+    """
+    Represents a query.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    limit: Annotated[int | None, Field(examples=[100])] = 10
+    """
+    Max number of documents retrieved by the given query.
+    """
+    offset: Annotated[int | None, Field(examples=[0])] = 0
+    """
+    The initial document offset; for pagination support.
+    """
+    query: Annotated[str | None, Field(examples=["SELECT * FROM SysContent"])] = None
+    """
+    The query, in the syntax given by the syntax field.
+    """
+    repository_id: Annotated[str | None, Field(alias="repositoryId")] = "default"
+    """
+    The id of the internal repository.
+    """
+    search_after: Annotated[str | None, Field(alias="searchAfter")] = None
+    """
+    Opaque cursor token for efficient pagination. Use the nextSearchAfter value from a previous response. When provided, offset is ignored.
+    """
+    sort: Annotated[list[str] | None, Field(examples=[["sys_title"]])] = None
+    """
+    List of fields used to sort the result.
+    """
+    syntax: QuerySyntax | None = None
+    track_total_count: Annotated[bool | None, Field(alias="trackTotalCount")] = None
+    """
+    If true, the total count of documents retrieved by the query will be computed.
+    """
+    track_total_count_up_to: Annotated[
+        int | None, Field(alias="trackTotalCountUpTo", examples=[100])
+    ] = None
+    """
+    Max number of documents to count. This can be set to -1 to remove the limit but it will be expensive on large indexes.
+    """
+
+
+class QueryResult(BaseModel):
+    """
+    Represents a query result.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    aggregations_buckets: Annotated[
+        list[StringTermsBucket] | None, Field(alias="aggregationsBuckets")
+    ] = None
+    """
+    The list of aggregation buckets computed for the query.
+    """
+    count: int | None = None
+    documents: list[Document] | None = None
+    """
+    The list of retrieved documents by the given query.
+    """
+    limit: Annotated[int | None, Field(examples=[100])] = 0
+    """
+    Max number of documents retrieved by the given query.
+    """
+    offset: Annotated[int | None, Field(examples=[0])] = 0
+    """
+    Actual document offset; for pagination support.
+    """
+    query: Annotated[str | None, Field(examples=["SELECT * FROM SysContent"])] = None
+    """
+    The query, in the syntax it was expressed in.
+    """
+    repository_id: Annotated[str | None, Field(alias="repositoryId")] = "default"
+    """
+    The id of the internal repository.
+    """
+    syntax: QuerySyntax | None = None
+    total_count: Annotated[int | None, Field(alias="totalCount")] = None
+    """
+    The total number of documents that match the query: is approximated if trackTotalCount is set to false.
+    """
+    total_count_is_truncated: Annotated[
+        bool | None, Field(alias="totalCountIsTruncated")
+    ] = None
+    """
+    If true the total count of the query was truncated.
+    """
+    track_total_count: Annotated[bool | None, Field(alias="trackTotalCount")] = None
+    """
+    If true the total count of the query was computed.
+    """
+
+
+class Schema(BaseModel):
+    """
+    Represents a schema.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    fields: dict[str, FieldModel] | None = None
+    prefix: str | None = None
+    """
+    Field name prefix. Read-only: it is derived from the field names.
+    """
+    project_id: Annotated[str | None, Field(alias="projectId")] = None
+    version_writable: Annotated[bool | None, Field(alias="versionWritable")] = None
+
+
+class SecurityPolicies(BaseModel):
+    """
+    Represents the security policies and their version.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    policies: dict[str, SecurityPolicyConfig] | None = None
+    version: int | None = None
+    """
+    Optimistic-locking version, present on the v2 API only.
+    """
+
+
+class TermsAggregationsQuery(BaseModel):
+    """
+    Represents a terms aggregations query.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    limit: Annotated[int | None, Field(examples=[100])] = 10
+    """
+    Max number of aggregation buckets retrieved by the given query.
+    """
+    query: Query
+    search_term: Annotated[str | None, Field(alias="searchTerm")] = None
+    """
+    The search term to filter the terms aggregation results.
+    """
+    terms_aggregation_property: Annotated[str, Field(alias="termsAggregationProperty")]
+    """
+    The property containing the array of keys to run the terms aggregation on.
+    """
+
+
+class Type(BaseModel):
+    """
+    Represents a type.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    constraints: Constraint | None = None
+    extends: str | None = None
+    fields: dict[str, FieldModel] | None = None
+    list: FieldModel | None = None
+    project_id: Annotated[str | None, Field(alias="projectId")] = None
+
+
+class WhereClause(BaseModel):
+    """
+    Represents an advanced query where clause definition.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    predicates: list[Predicate] | None = None
+    query: Annotated[str | None, Field(examples=["SELECT * FROM SysContent"])] = None
+    """
+    The query, in the syntax given by the syntax field. An hxql query provides the statement the request selects from, an expr query only filters it.
+    """
+    syntax: QuerySyntax | None = None
+
+
+class AdvancedQuery(BaseModel):
+    """
+    Represents an advanced query.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    limit: Annotated[int | None, Field(examples=[100])] = 10
+    """
+    Max number of documents retrieved by the given query.
+    """
+    offset: Annotated[int | None, Field(examples=[0])] = 0
+    """
+    The initial document offset; for pagination support.
+    """
+    parameters: dict[str, dict[str, Any]] | None = None
+    query: Annotated[str | None, Field(examples=["SELECT * FROM SysContent"])] = None
+    """
+    The query, in the syntax given by the syntax field.
+    """
+    quick_filter_clauses: Annotated[
+        list[str] | None,
+        Field(
+            alias="quickFilterClauses",
+            examples=[
+                "exclude documents that are not article: mydc_nature != 'article'"
+            ],
+        ),
+    ] = None
+    """
+    List of filters to be applied to the result.
+    """
+    repository_id: Annotated[str | None, Field(alias="repositoryId")] = "default"
+    """
+    The id of the internal repository
+    """
+    search_after: Annotated[str | None, Field(alias="searchAfter")] = None
+    """
+    Opaque cursor token for efficient pagination. Use the nextSearchAfter value from a previous response. When provided, offset is ignored.
+    """
+    sort: Annotated[list[str] | None, Field(examples=[["sys_title"]])] = None
+    """
+    List of fields used to sort the result.
+    """
+    syntax: QuerySyntax | None = None
+    track_total_count: Annotated[bool | None, Field(alias="trackTotalCount")] = None
+    """
+    If true, the total count of documents retrieved by the query will be computed.
+    """
+    track_total_count_up_to: Annotated[
+        int | None, Field(alias="trackTotalCountUpTo", examples=[100])
+    ] = None
+    """
+    Max number of documents to count. This can be set to -1 to remove the limit but it will be expensive on large indexes.
+    """
+    where_clause_definition: Annotated[
+        WhereClause | None, Field(alias="whereClauseDefinition")
+    ] = None
+
+
+class Embedding(BaseModel):
+    """
+    Represents the Embedding API's HTTP Post body.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    sysembed_blobref: str | None = None
+    """
+    Blob label for embeddings.
+    """
+    sysembed_doc_id: Annotated[str, Field(alias="sysembed_docId")]
+    """
+    The unique identifier for the document the embedding is associated with.
+    """
+    sysembed_id: str
+    """
+    The unique identifier for the embedding.
+    """
+    sysembed_location: LocationModel | None = None
+    sysembed_score: float | None = None
+    """
+    A score representing the relevance of the hit
+    """
+    sysembed_text: str
+    """
+    Text label for the vector or the original chunk for text embeddings.
+    """
+    sysembed_type: Annotated[str, Field(max_length=256)]
+    """
+    A label for the embedding type (used to ensure semantic queries are against vectors of the same type).
+    """
+    sysembed_vector: list[float]
+    """
+    The vector as a list of floating point numbers.
+    """
+
+
+class ListEffectiveACLDTO(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    full_effective_acl: Annotated[
+        list[ListEffectiveACLPerUserDTO] | None, Field(alias="fullEffectiveACL")
+    ] = None
+    sys_id: str | None = None
+
+
+class Model(BaseModel):
+    """
+    Represents a model.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    mixin_types: Annotated[dict[str, MixinType] | None, Field(alias="mixinTypes")] = (
+        None
+    )
+    primary_types: Annotated[
+        dict[str, PrimaryType] | None, Field(alias="primaryTypes")
+    ] = None
+    schemas: dict[str, Schema] | None = None
+    types: dict[str, Type] | None = None
+    version: int | None = None
+    """
+    Optimistic-locking version, present on the v2 API only.
+    """
+
+
+class NamedQueryDefinition(BaseModel):
+    """
+    Represents a named query definition.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    aliases: list[str] | None = None
+    name: str | None = None
+    quick_filters: Annotated[list[QuickFilter] | None, Field(alias="quickFilters")] = (
+        None
+    )
+    sort: list[str] | None = None
+    where_clause_definition: Annotated[
+        WhereClause | None, Field(alias="whereClauseDefinition")
+    ] = None
+
+
+class VectorSearchResult(BaseModel):
+    """
+    The results of a vector search query.
+    """
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    count: int | None = None
+    embeddings: list[Embedding] | None = None
+    """
+    The list of retrieved embeddings.
+    """
+    limit: Annotated[int | None, Field(examples=[100])] = 0
+    """
+    Max number of embeddings retrieved by the given query.
+    """
+    offset: Annotated[int | None, Field(examples=[0])] = 0
+    """
+    Actual embedding offset; for pagination support.
+    """
+    query: Annotated[str | None, Field(examples=["SELECT * FROM SysContent"])] = None
+    """
+    The query, in the syntax it was expressed in.
+    """
+    repository_id: Annotated[str | None, Field(alias="repositoryId")] = "default"
+    """
+    The id of the internal repository.
+    """
+    syntax: QuerySyntax | None = None
+    total_count: Annotated[int | None, Field(alias="totalCount")] = None
+    """
+    The total number of embeddings that match the query: is approximated if trackTotalCount is set to false.
+    """
+    total_count_is_truncated: Annotated[
+        bool | None, Field(alias="totalCountIsTruncated")
+    ] = None
+    """
+    If true the total count of the query was truncated.
+    """
+    track_total_count: Annotated[bool | None, Field(alias="trackTotalCount")] = None
+    """
+    If true the total count of the query was computed.
+    """
+    vector: list[float] | None = None
+    """
+    The supplied vector
+    """
+
+
+FieldModel.model_rebuild()