egain-api-python 0.1.1__py3-none-any.whl

egain_api_python/models/allaccessibleportals.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .accessibleportal import AccessiblePortal, AccessiblePortalTypedDict
+from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AllAccessiblePortalsTypedDict(TypedDict):
+    r"""Success"""
+
+    portal: NotRequired[List[AccessiblePortalTypedDict]]
+    r"""portals"""
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class AllAccessiblePortals(BaseModel):
+    r"""Success"""
+
+    portal: Optional[List[AccessiblePortal]] = None
+    r"""portals"""
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/answer.py

@@ -0,0 +1,21 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class AnswerTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""ID of answer"""
+    value: NotRequired[str]
+    r"""Value of answer"""
+
+
+class Answer(BaseModel):
+    id: Optional[str] = None
+    r"""ID of answer"""
+
+    value: Optional[str] = None
+    r"""Value of answer"""

egain_api_python/models/answeredquestion.py

@@ -0,0 +1,125 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .answerrange import AnswerRange, AnswerRangeTypedDict
+from .metadata import Metadata, MetadataTypedDict
+from .schemas_answer import SchemasAnswer, SchemasAnswerTypedDict
+from .schemas_customattribute import (
+    SchemasCustomAttribute,
+    SchemasCustomAttributeTypedDict,
+)
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+AnsweredQuestionType = Literal[
+    "numeric",
+    "enumerated",
+    "list",
+    "text",
+]
+r"""type of the question"""
+
+
+AnsweredQuestionFormat = Literal[
+    "radioButton",
+    "dropdown",
+    "checkbox",
+    "mutliSelect",
+    "number",
+    "singleLineTextField",
+    "multiLineTextField",
+]
+r"""format of the question"""
+
+
+AnswerSource = Literal[
+    "rule",
+    "data_link_article",
+    "user",
+]
+r"""source of the provided answer"""
+
+
+class AnsweredQuestionTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The numerical ID of the question"""
+    title: NotRequired[str]
+    r"""Title of the question"""
+    type: NotRequired[AnsweredQuestionType]
+    r"""type of the question"""
+    format_: NotRequired[AnsweredQuestionFormat]
+    r"""format of the question"""
+    short_name: NotRequired[str]
+    r"""short name"""
+    has_additional_info: NotRequired[bool]
+    r"""indicates if question has additional information"""
+    has_action: NotRequired[bool]
+    r"""indicates if question has action"""
+    valid_answer: NotRequired[List[SchemasAnswerTypedDict]]
+    r"""valid answers for question"""
+    previous_answer: NotRequired[List[SchemasAnswerTypedDict]]
+    r"""answers provided for question"""
+    valid_answer_range: NotRequired[AnswerRangeTypedDict]
+    metadata: NotRequired[List[MetadataTypedDict]]
+    r"""Metadata on question"""
+    custom_attributes: NotRequired[List[SchemasCustomAttributeTypedDict]]
+    r"""Custom attributes of question"""
+    answer_source: NotRequired[AnswerSource]
+    r"""source of the provided answer"""
+
+
+class AnsweredQuestion(BaseModel):
+    id: Optional[str] = None
+    r"""The numerical ID of the question"""
+
+    title: Optional[str] = None
+    r"""Title of the question"""
+
+    type: Optional[AnsweredQuestionType] = None
+    r"""type of the question"""
+
+    format_: Annotated[
+        Optional[AnsweredQuestionFormat], pydantic.Field(alias="format")
+    ] = None
+    r"""format of the question"""
+
+    short_name: Annotated[Optional[str], pydantic.Field(alias="shortName")] = None
+    r"""short name"""
+
+    has_additional_info: Annotated[
+        Optional[bool], pydantic.Field(alias="hasAdditionalInfo")
+    ] = None
+    r"""indicates if question has additional information"""
+
+    has_action: Annotated[Optional[bool], pydantic.Field(alias="hasAction")] = None
+    r"""indicates if question has action"""
+
+    valid_answer: Annotated[
+        Optional[List[SchemasAnswer]], pydantic.Field(alias="validAnswer")
+    ] = None
+    r"""valid answers for question"""
+
+    previous_answer: Annotated[
+        Optional[List[SchemasAnswer]], pydantic.Field(alias="previousAnswer")
+    ] = None
+    r"""answers provided for question"""
+
+    valid_answer_range: Annotated[
+        Optional[AnswerRange], pydantic.Field(alias="validAnswerRange")
+    ] = None
+
+    metadata: Optional[List[Metadata]] = None
+    r"""Metadata on question"""
+
+    custom_attributes: Annotated[
+        Optional[List[SchemasCustomAttribute]], pydantic.Field(alias="customAttributes")
+    ] = None
+    r"""Custom attributes of question"""
+
+    answer_source: Annotated[
+        Optional[AnswerSource], pydantic.Field(alias="answerSource")
+    ] = None
+    r"""source of the provided answer"""

egain_api_python/models/answerrange.py

@@ -0,0 +1,41 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AnswerRangeTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""Id of the answer range"""
+    min: NotRequired[float]
+    r"""minimum value of range"""
+    max: NotRequired[float]
+    r"""maximum value of range"""
+    min_inclusive: NotRequired[bool]
+    r"""flag indicating if minimum value is included"""
+    max_inclusive: NotRequired[bool]
+    r"""flag indicating if maximim value is included"""
+
+
+class AnswerRange(BaseModel):
+    id: Optional[str] = None
+    r"""Id of the answer range"""
+
+    min: Optional[float] = None
+    r"""minimum value of range"""
+
+    max: Optional[float] = None
+    r"""maximum value of range"""
+
+    min_inclusive: Annotated[Optional[bool], pydantic.Field(alias="minInclusive")] = (
+        None
+    )
+    r"""flag indicating if minimum value is included"""
+
+    max_inclusive: Annotated[Optional[bool], pydantic.Field(alias="maxInclusive")] = (
+        None
+    )
+    r"""flag indicating if maximim value is included"""

egain_api_python/models/answersrequest.py

@@ -0,0 +1,78 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+AnswersRequestType = Literal[
+    "portal",
+    "custom",
+]
+r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+
+
+class AnswersRequestChannelTypedDict(TypedDict):
+    type: NotRequired[AnswersRequestType]
+    r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+    name: NotRequired[str]
+    r"""A descriptive name for the channel (e.g., \"web\", \"mobile app\", \"agent console\")."""
+
+
+class AnswersRequestChannel(BaseModel):
+    type: Optional[AnswersRequestType] = "custom"
+    r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+
+    name: Optional[str] = None
+    r"""A descriptive name for the channel (e.g., \"web\", \"mobile app\", \"agent console\")."""
+
+
+class ContextTypedDict(TypedDict):
+    r"""Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response."""
+
+    user_context: NotRequired[str]
+    r"""Information about the end user (e.g., preferences, profile data, or behavioral signals)."""
+    page_context: NotRequired[str]
+    r"""Details about the UI or page where the query was initiated (e.g., page URL, section, or component)."""
+    company_context: NotRequired[str]
+    r"""Information about the organization associated with the user, used for tailoring responses in enterprise environments."""
+
+
+class Context(BaseModel):
+    r"""Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response."""
+
+    user_context: Annotated[Optional[str], pydantic.Field(alias="userContext")] = None
+    r"""Information about the end user (e.g., preferences, profile data, or behavioral signals)."""
+
+    page_context: Annotated[Optional[str], pydantic.Field(alias="pageContext")] = None
+    r"""Details about the UI or page where the query was initiated (e.g., page URL, section, or component)."""
+
+    company_context: Annotated[
+        Optional[str], pydantic.Field(alias="companyContext")
+    ] = None
+    r"""Information about the organization associated with the user, used for tailoring responses in enterprise environments."""
+
+
+class AnswersRequestTypedDict(TypedDict):
+    channel: NotRequired[AnswersRequestChannelTypedDict]
+    context: NotRequired[ContextTypedDict]
+    r"""Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response."""
+    event_id: NotRequired[str]
+    r"""Unique ID for this specific API call or event."""
+    session_id: NotRequired[str]
+    r"""ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session."""
+
+
+class AnswersRequest(BaseModel):
+    channel: Optional[AnswersRequestChannel] = None
+
+    context: Optional[Context] = None
+    r"""Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response."""
+
+    event_id: Annotated[Optional[str], pydantic.Field(alias="eventId")] = None
+    r"""Unique ID for this specific API call or event."""
+
+    session_id: Annotated[Optional[str], pydantic.Field(alias="sessionId")] = None
+    r"""ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session."""

egain_api_python/models/answersresponse.py

@@ -0,0 +1,93 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .referenceresponse import ReferenceResponse, ReferenceResponseTypedDict
+from .searchresult import SearchResult, SearchResultTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+AnswersResponseAnswerType = Literal[
+    "certified",
+    "generative",
+]
+r"""Indicates whether the answer was extracted directly from documents or generated by the LLM."""
+
+
+class AnswersResponseAnswerTypedDict(TypedDict):
+    answer_value: str
+    r"""The main response text. May be a certified answer or a generative answer produced by the LLM."""
+    references: List[ReferenceResponseTypedDict]
+    r"""Supporting sources that were used to produce the answer."""
+    answer_type: AnswersResponseAnswerType
+    r"""Indicates whether the answer was extracted directly from documents or generated by the LLM."""
+    relevance_score: float
+    r"""Confidence score (0.0-1.0) reflecting how well the answer matches the query."""
+
+
+class AnswersResponseAnswer(BaseModel):
+    answer_value: Annotated[str, pydantic.Field(alias="answerValue")]
+    r"""The main response text. May be a certified answer or a generative answer produced by the LLM."""
+
+    references: List[ReferenceResponse]
+    r"""Supporting sources that were used to produce the answer."""
+
+    answer_type: Annotated[
+        AnswersResponseAnswerType, pydantic.Field(alias="answerType")
+    ]
+    r"""Indicates whether the answer was extracted directly from documents or generated by the LLM."""
+
+    relevance_score: Annotated[float, pydantic.Field(alias="relevanceScore")]
+    r"""Confidence score (0.0-1.0) reflecting how well the answer matches the query."""
+
+
+AnswersResponseType = Literal[
+    "portal",
+    "custom",
+]
+r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+
+
+class AnswersResponseChannelTypedDict(TypedDict):
+    type: AnswersResponseType
+    r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+    name: NotRequired[str]
+    r"""The channel name."""
+
+
+class AnswersResponseChannel(BaseModel):
+    type: AnswersResponseType
+    r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+
+    name: Optional[str] = None
+    r"""The channel name."""
+
+
+class AnswersResponseTypedDict(TypedDict):
+    answer: NotRequired[AnswersResponseAnswerTypedDict]
+    search_results: NotRequired[List[SearchResultTypedDict]]
+    r"""List of top search results used to support the answer. Includes snippets, metadata, and relevance scores."""
+    channel: NotRequired[AnswersResponseChannelTypedDict]
+    session_id: NotRequired[str]
+    r"""ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session."""
+    event_id: NotRequired[str]
+    r"""Unique ID for this specific API call or event."""
+
+
+class AnswersResponse(BaseModel):
+    answer: Optional[AnswersResponseAnswer] = None
+
+    search_results: Annotated[
+        Optional[List[SearchResult]], pydantic.Field(alias="searchResults")
+    ] = None
+    r"""List of top search results used to support the answer. Includes snippets, metadata, and relevance scores."""
+
+    channel: Optional[AnswersResponseChannel] = None
+
+    session_id: Annotated[Optional[str], pydantic.Field(alias="sessionId")] = None
+    r"""ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session."""
+
+    event_id: Annotated[Optional[str], pydantic.Field(alias="eventId")] = None
+    r"""Unique ID for this specific API call or event."""

egain_api_python/models/article.py

@@ -0,0 +1,241 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articleattachment import ArticleAttachment, ArticleAttachmentTypedDict
+from .articletype import ArticleType, ArticleTypeTypedDict
+from .bookmarkstatus import BookmarkStatus, BookmarkStatusTypedDict
+from .complianceforarticle import ComplianceForArticle, ComplianceForArticleTypedDict
+from .createdby import CreatedBy, CreatedByTypedDict
+from .customattribute import CustomAttribute, CustomAttributeTypedDict
+from .edition import Edition, EditionTypedDict
+from .languagecode import LanguageCode
+from .link import Link, LinkTypedDict
+from .modifiedby import ModifiedBy, ModifiedByTypedDict
+from .ownedby import OwnedBy, OwnedByTypedDict
+from .personalization import Personalization, PersonalizationTypedDict
+from .structuredauthoringfields import (
+    StructuredAuthoringFields,
+    StructuredAuthoringFieldsTypedDict,
+)
+from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
+from .workflow import Workflow, WorkflowTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ArticleTypedDict(TypedDict):
+    r"""Success"""
+
+    id: str
+    r"""The ID of the Article.<br>An Article ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    created_by: CreatedByTypedDict
+    name: str
+    r"""The name of the Article."""
+    topic_breadcrumb: List[TopicBreadcrumbTypedDict]
+    r"""A list of topics from the root topic to this Article. There may be multiple paths."""
+    additional_info: NotRequired[str]
+    r"""Additional information about the Article. Max 1 KB."""
+    article_macro: NotRequired[str]
+    r"""The name of the macro associated with this Article."""
+    article_type: NotRequired[ArticleTypeTypedDict]
+    r"""The type of the Article and its attributes."""
+    article_keywords: NotRequired[str]
+    r"""A comma-separated list of keywords associated with this Article. 1 KB max size limit."""
+    article_summary: NotRequired[str]
+    r"""A brief summary of the Article, provided as metadata. 1 KB max size limit."""
+    attachments: NotRequired[List[ArticleAttachmentTypedDict]]
+    r"""The attachments of the Article.
+
+    """
+    availability_date: NotRequired[str]
+    r"""The date on which the Article version is available."""
+    available_editions: NotRequired[List[EditionTypedDict]]
+    r"""The editions of this Article that are available to the user."""
+    average_rating: NotRequired[float]
+    r"""The average rating of the Article."""
+    content: NotRequired[str]
+    r"""The Article content. The maximum allowed Article content size is 5 MB."""
+    content_text: NotRequired[str]
+    r"""The plaintext version of the Article content, which does not have the HTML tags and rich formatting present in *content*. The maximum allowed Article content size is 5 MB."""
+    modified_by: NotRequired[ModifiedByTypedDict]
+    owned_by: NotRequired[OwnedByTypedDict]
+    created_date: NotRequired[str]
+    custom_attributes: NotRequired[List[CustomAttributeTypedDict]]
+    r"""A list of custom attributes."""
+    department_id: NotRequired[str]
+    r"""ID of the Article's department."""
+    description: NotRequired[str]
+    r"""A description of the Article. The maximum allowed Article description size is 1 KB."""
+    expiration_date: NotRequired[str]
+    r"""Date of Article expiration if Article expires otherwise empty."""
+    image_url: NotRequired[str]
+    r"""The URL of an image to be associated with the Article."""
+    include_in_gen_ai: NotRequired[bool]
+    r"""Indicates whether the Article is included for Generative AI."""
+    is_subscribed: NotRequired[bool]
+    r"""Indicates whether the Article is subscribed for notifications."""
+    modified_date: NotRequired[str]
+    r"""The date on which the Article was last modified."""
+    language_code: NotRequired[LanguageCode]
+    r"""Language code of the resource's language."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+    structured_authoring_fields: NotRequired[StructuredAuthoringFieldsTypedDict]
+    article_state: NotRequired[str]
+    r"""The Article's state."""
+    times_rated: NotRequired[int]
+    r"""The number of times that this Article has been rated."""
+    version_id: NotRequired[str]
+    r"""The ID of this version of the Article."""
+    workflow: NotRequired[WorkflowTypedDict]
+    r"""The Article's workflow."""
+    compliance: NotRequired[ComplianceForArticleTypedDict]
+    r"""This schema contains the compliance details for an Article."""
+    personalization: NotRequired[PersonalizationTypedDict]
+    r"""Personalization allows the filtering of search results and controls the access to articles and article editions."""
+    bookmark_status: NotRequired[BookmarkStatusTypedDict]
+    r"""Article Bookmark Status"""
+
+
+class Article(BaseModel):
+    r"""Success"""
+
+    id: str
+    r"""The ID of the Article.<br>An Article ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    created_by: Annotated[CreatedBy, pydantic.Field(alias="createdBy")]
+
+    name: str
+    r"""The name of the Article."""
+
+    topic_breadcrumb: Annotated[
+        List[TopicBreadcrumb], pydantic.Field(alias="topicBreadcrumb")
+    ]
+    r"""A list of topics from the root topic to this Article. There may be multiple paths."""
+
+    additional_info: Annotated[
+        Optional[str], pydantic.Field(alias="additionalInfo")
+    ] = None
+    r"""Additional information about the Article. Max 1 KB."""
+
+    article_macro: Annotated[Optional[str], pydantic.Field(alias="articleMacro")] = None
+    r"""The name of the macro associated with this Article."""
+
+    article_type: Annotated[
+        Optional[ArticleType], pydantic.Field(alias="articleType")
+    ] = None
+    r"""The type of the Article and its attributes."""
+
+    article_keywords: Annotated[
+        Optional[str], pydantic.Field(alias="articleKeywords")
+    ] = None
+    r"""A comma-separated list of keywords associated with this Article. 1 KB max size limit."""
+
+    article_summary: Annotated[
+        Optional[str], pydantic.Field(alias="articleSummary")
+    ] = None
+    r"""A brief summary of the Article, provided as metadata. 1 KB max size limit."""
+
+    attachments: Optional[List[ArticleAttachment]] = None
+    r"""The attachments of the Article.
+
+    """
+
+    availability_date: Annotated[
+        Optional[str], pydantic.Field(alias="availabilityDate")
+    ] = None
+    r"""The date on which the Article version is available."""
+
+    available_editions: Annotated[
+        Optional[List[Edition]], pydantic.Field(alias="availableEditions")
+    ] = None
+    r"""The editions of this Article that are available to the user."""
+
+    average_rating: Annotated[
+        Optional[float], pydantic.Field(alias="averageRating")
+    ] = None
+    r"""The average rating of the Article."""
+
+    content: Optional[str] = None
+    r"""The Article content. The maximum allowed Article content size is 5 MB."""
+
+    content_text: Annotated[Optional[str], pydantic.Field(alias="contentText")] = None
+    r"""The plaintext version of the Article content, which does not have the HTML tags and rich formatting present in *content*. The maximum allowed Article content size is 5 MB."""
+
+    modified_by: Annotated[Optional[ModifiedBy], pydantic.Field(alias="modifiedBy")] = (
+        None
+    )
+
+    owned_by: Annotated[Optional[OwnedBy], pydantic.Field(alias="ownedBy")] = None
+
+    created_date: Annotated[Optional[str], pydantic.Field(alias="createdDate")] = None
+
+    custom_attributes: Annotated[
+        Optional[List[CustomAttribute]], pydantic.Field(alias="customAttributes")
+    ] = None
+    r"""A list of custom attributes."""
+
+    department_id: Annotated[Optional[str], pydantic.Field(alias="departmentID")] = None
+    r"""ID of the Article's department."""
+
+    description: Optional[str] = None
+    r"""A description of the Article. The maximum allowed Article description size is 1 KB."""
+
+    expiration_date: Annotated[
+        Optional[str], pydantic.Field(alias="expirationDate")
+    ] = None
+    r"""Date of Article expiration if Article expires otherwise empty."""
+
+    image_url: Annotated[Optional[str], pydantic.Field(alias="imageURL")] = None
+    r"""The URL of an image to be associated with the Article."""
+
+    include_in_gen_ai: Annotated[
+        Optional[bool], pydantic.Field(alias="includeInGenAI")
+    ] = None
+    r"""Indicates whether the Article is included for Generative AI."""
+
+    is_subscribed: Annotated[Optional[bool], pydantic.Field(alias="isSubscribed")] = (
+        None
+    )
+    r"""Indicates whether the Article is subscribed for notifications."""
+
+    modified_date: Annotated[Optional[str], pydantic.Field(alias="modifiedDate")] = None
+    r"""The date on which the Article was last modified."""
+
+    language_code: Annotated[
+        Optional[LanguageCode], pydantic.Field(alias="languageCode")
+    ] = None
+    r"""Language code of the resource's language."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""
+
+    structured_authoring_fields: Annotated[
+        Optional[StructuredAuthoringFields],
+        pydantic.Field(alias="structuredAuthoringFields"),
+    ] = None
+
+    article_state: Annotated[Optional[str], pydantic.Field(alias="articleState")] = None
+    r"""The Article's state."""
+
+    times_rated: Annotated[Optional[int], pydantic.Field(alias="timesRated")] = None
+    r"""The number of times that this Article has been rated."""
+
+    version_id: Annotated[Optional[str], pydantic.Field(alias="versionId")] = None
+    r"""The ID of this version of the Article."""
+
+    workflow: Optional[Workflow] = None
+    r"""The Article's workflow."""
+
+    compliance: Optional[ComplianceForArticle] = None
+    r"""This schema contains the compliance details for an Article."""
+
+    personalization: Optional[Personalization] = None
+    r"""Personalization allows the filtering of search results and controls the access to articles and article editions."""
+
+    bookmark_status: Annotated[
+        Optional[BookmarkStatus], pydantic.Field(alias="bookmarkStatus")
+    ] = None
+    r"""Article Bookmark Status"""