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

egain_api_python/models/articlewitheditions.py

@@ -0,0 +1,227 @@
+"""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 .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 .relatedquestions import RelatedQuestions, RelatedQuestionsTypedDict
+from .structuredauthoringfields import (
+    StructuredAuthoringFields,
+    StructuredAuthoringFieldsTypedDict,
+)
+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 ArticleWithEditionsTypedDict(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."""
+    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."""
+    related_questions: NotRequired[RelatedQuestionsTypedDict]
+    r"""Related questions for the article."""
+    version_id: NotRequired[str]
+    r"""The ID of this version of the Article."""
+    workflow: NotRequired[WorkflowTypedDict]
+    r"""The Article's workflow."""
+    personalization: NotRequired[PersonalizationTypedDict]
+    r"""Personalization allows the filtering of search results and controls the access to articles and article editions."""
+
+
+class ArticleWithEditions(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."""
+
+    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."""
+
+    related_questions: Annotated[
+        Optional[RelatedQuestions], pydantic.Field(alias="relatedQuestions")
+    ] = None
+    r"""Related questions for the article."""
+
+    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."""
+
+    personalization: Optional[Personalization] = None
+    r"""Personalization allows the filtering of search results and controls the access to articles and article editions."""

egain_api_python/models/attachment.py

@@ -0,0 +1,31 @@
+"""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 AttachmentTypedDict(TypedDict):
+    r"""Success"""
+
+    alt_id: NotRequired[str]
+    r"""The ID of the attachment."""
+    name: NotRequired[str]
+    r"""The name of the attachment."""
+    content_url: NotRequired[str]
+    r"""The content URL to upload an attachment."""
+
+
+class Attachment(BaseModel):
+    r"""Success"""
+
+    alt_id: Annotated[Optional[str], pydantic.Field(alias="altId")] = None
+    r"""The ID of the attachment."""
+
+    name: Optional[str] = None
+    r"""The name of the attachment."""
+
+    content_url: Annotated[Optional[str], pydantic.Field(alias="contentUrl")] = None
+    r"""The content URL to upload an attachment."""

egain_api_python/models/attachmentadditionalattributes.py

@@ -0,0 +1,10 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+AttachmentAdditionalAttributes = Literal[
+    "contentUrl",
+    "all",
+]

egain_api_python/models/attachmentcontent.py

@@ -0,0 +1,57 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .link import Link, LinkTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+AttachmentContentType = Literal[
+    "INTERNAL",
+    "EXTERNAL",
+]
+r"""The type of attachment."""
+
+
+class AttachmentContentTypedDict(TypedDict):
+    attachment_id: NotRequired[str]
+    r"""The ID of the attachment."""
+    name: NotRequired[str]
+    r"""The name of the attachment."""
+    size: NotRequired[int]
+    r"""The size of the attachment in bytes. The maximum size is limited to 25MB."""
+    type: NotRequired[AttachmentContentType]
+    r"""The type of attachment."""
+    attachment_content_type: NotRequired[str]
+    r"""The type of the content."""
+    streaming_url: NotRequired[str]
+    r"""The streaming URL of the attachment."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class AttachmentContent(BaseModel):
+    attachment_id: Annotated[Optional[str], pydantic.Field(alias="attachmentId")] = None
+    r"""The ID of the attachment."""
+
+    name: Optional[str] = None
+    r"""The name of the attachment."""
+
+    size: Optional[int] = None
+    r"""The size of the attachment in bytes. The maximum size is limited to 25MB."""
+
+    type: Optional[AttachmentContentType] = None
+    r"""The type of attachment."""
+
+    attachment_content_type: Annotated[
+        Optional[str], pydantic.Field(alias="attachmentContentType")
+    ] = None
+    r"""The type of the content."""
+
+    streaming_url: Annotated[Optional[str], pydantic.Field(alias="streamingUrl")] = None
+    r"""The streaming URL of the attachment."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/attachmentcontentresult.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .attachmentcontent import AttachmentContent, AttachmentContentTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AttachmentContentResultTypedDict(TypedDict):
+    r"""The returned attachment content."""
+
+    attachment_content: NotRequired[List[AttachmentContentTypedDict]]
+
+
+class AttachmentContentResult(BaseModel):
+    r"""The returned attachment content."""
+
+    attachment_content: Annotated[
+        Optional[List[AttachmentContent]], pydantic.Field(alias="attachmentContent")
+    ] = None

egain_api_python/models/attachmentforcreatesuggestion.py

@@ -0,0 +1,25 @@
+"""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 AttachmentForCreateSuggestionTypedDict(TypedDict):
+    r"""This schema contains the definition of an Attachment."""
+
+    alt_id: NotRequired[str]
+    r"""The alternate Id of the Attachment that was obtained after calling **[Generate signed URL to upload an attachment](https://apidev.egain.com/api-catalog/core-filemgr/api-bundled/operation/generatePreUploadURL/)**.
+
+    """
+
+
+class AttachmentForCreateSuggestion(BaseModel):
+    r"""This schema contains the definition of an Attachment."""
+
+    alt_id: Annotated[Optional[str], pydantic.Field(alias="altId")] = None
+    r"""The alternate Id of the Attachment that was obtained after calling **[Generate signed URL to upload an attachment](https://apidev.egain.com/api-catalog/core-filemgr/api-bundled/operation/generatePreUploadURL/)**.
+
+    """

egain_api_python/models/attachments.py

@@ -0,0 +1,35 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .attachmentsummary import AttachmentSummary, AttachmentSummaryTypedDict
+from .link import Link, LinkTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AttachmentsTypedDict(TypedDict):
+    r"""This schema contains the definition of Attachments."""
+
+    count: NotRequired[int]
+    r"""The number of Attachments in the list."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+    attachments: NotRequired[List[AttachmentSummaryTypedDict]]
+    r"""The list of Attachments."""
+
+
+class Attachments(BaseModel):
+    r"""This schema contains the definition of Attachments."""
+
+    count: Optional[int] = None
+    r"""The number of Attachments in the list."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""
+
+    attachments: Annotated[
+        Optional[List[AttachmentSummary]], pydantic.Field(alias="Attachments")
+    ] = None
+    r"""The list of Attachments."""

egain_api_python/models/attachmentsummary.py

@@ -0,0 +1,37 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .link import Link, LinkTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AttachmentSummaryTypedDict(TypedDict):
+    r"""Summary attributes for an Attachment."""
+
+    id: NotRequired[str]
+    r"""The ID of the Attachment."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+    file_name: NotRequired[str]
+    r"""The name of the Attachment file.<li>This must not exceed 255 characters.</li>"""
+    size: NotRequired[int]
+    r"""The size of the Attachment.<li>Limited to 25MB.</li>"""
+
+
+class AttachmentSummary(BaseModel):
+    r"""Summary attributes for an Attachment."""
+
+    id: Optional[str] = None
+    r"""The ID of the Attachment."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""
+
+    file_name: Annotated[Optional[str], pydantic.Field(alias="fileName")] = None
+    r"""The name of the Attachment file.<li>This must not exceed 255 characters.</li>"""
+
+    size: Optional[int] = None
+    r"""The size of the Attachment.<li>Limited to 25MB.</li>"""

egain_api_python/models/attachmentupload.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class AttachmentUploadTypedDict(TypedDict):
+    name: str
+    r"""The name of the attachment."""
+    size: int
+    r"""The size of the attachment in bytes. The maximum size is limited to 25MB."""
+
+
+class AttachmentUpload(BaseModel):
+    name: str
+    r"""The name of the attachment."""
+
+    size: int
+    r"""The size of the attachment in bytes. The maximum size is limited to 25MB."""

egain_api_python/models/avertcustomerescalationop.py

@@ -0,0 +1,44 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import FieldMetadata, HeaderMetadata, PathParamMetadata
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class AvertCustomerEscalationRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+    portal_id: str
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    escalation_id: str
+    r"""The ID (uuid) of the customer escalation.
+
+    """
+
+
+class AvertCustomerEscalationRequest(BaseModel):
+    accept_language: Annotated[
+        AcceptLanguage,
+        pydantic.Field(alias="Accept-Language"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ]
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+
+    portal_id: Annotated[
+        str,
+        pydantic.Field(alias="portalID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    escalation_id: Annotated[
+        str,
+        pydantic.Field(alias="escalationId"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID (uuid) of the customer escalation.
+
+    """

egain_api_python/models/bookmark.py

@@ -0,0 +1,57 @@
+"""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 BookmarkTypedDict(TypedDict):
+    resource_id: str
+    r"""The ID of the article or topic associated with this bookmark. A case ID or an article ID is composed of a 2-4 letter prefix, followed by a dash and 15 digits."""
+    portal_id: NotRequired[str]
+    r"""The ID of the portal associated with the bookmark.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 2-4 15 digits."""
+    id: NotRequired[str]
+    r"""The ID of the bookmark."""
+    bookmark_name: NotRequired[str]
+    r"""The name of the bookmark."""
+    resource_type: NotRequired[int]
+    r"""Determines the type of resource:
+    <li>1 - Article</li>
+    <li>2 - Topic</li>
+    <li>3 - External Content</li>
+    """
+    resource_name: NotRequired[str]
+    r"""The name of the resource associated with the bookmark.<br><br>This attribute is only available for article and topic bookmarks."""
+    external_content_id: NotRequired[str]
+    r"""The ID of the external content.<br><br>This attribute must be provided if <code>resourceType</code> is set to \"3 - External Content\"."""
+
+
+class Bookmark(BaseModel):
+    resource_id: Annotated[str, pydantic.Field(alias="resourceId")]
+    r"""The ID of the article or topic associated with this bookmark. A case ID or an article ID is composed of a 2-4 letter prefix, followed by a dash and 15 digits."""
+
+    portal_id: Annotated[Optional[str], pydantic.Field(alias="portalId")] = None
+    r"""The ID of the portal associated with the bookmark.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 2-4 15 digits."""
+
+    id: Optional[str] = None
+    r"""The ID of the bookmark."""
+
+    bookmark_name: Annotated[Optional[str], pydantic.Field(alias="bookmarkName")] = None
+    r"""The name of the bookmark."""
+
+    resource_type: Annotated[Optional[int], pydantic.Field(alias="resourceType")] = None
+    r"""Determines the type of resource:
+    <li>1 - Article</li>
+    <li>2 - Topic</li>
+    <li>3 - External Content</li>
+    """
+
+    resource_name: Annotated[Optional[str], pydantic.Field(alias="resourceName")] = None
+    r"""The name of the resource associated with the bookmark.<br><br>This attribute is only available for article and topic bookmarks."""
+
+    external_content_id: Annotated[
+        Optional[str], pydantic.Field(alias="externalContentId")
+    ] = None
+    r"""The ID of the external content.<br><br>This attribute must be provided if <code>resourceType</code> is set to \"3 - External Content\"."""

egain_api_python/models/bookmarkresult.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .bookmark import Bookmark, BookmarkTypedDict
+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 BookmarkResultTypedDict(TypedDict):
+    r"""One or more instances of Bookmark."""
+
+    bookmarks: NotRequired[List[BookmarkTypedDict]]
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class BookmarkResult(BaseModel):
+    r"""One or more instances of Bookmark."""
+
+    bookmarks: Optional[List[Bookmark]] = None
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/bookmarkstatus.py

@@ -0,0 +1,34 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .folderbreadcrumb import FolderBreadcrumb, FolderBreadcrumbTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class BookmarkStatusTypedDict(TypedDict):
+    r"""Article Bookmark Status"""
+
+    is_bookmarked: bool
+    r"""Indicates whether the Article is bookmarked"""
+    bookmark_id: NotRequired[int]
+    r"""The ID of the Bookmark, if Article is bookmarked."""
+    folder_breadcrumb: NotRequired[FolderBreadcrumbTypedDict]
+    r"""This schema contains one or more FolderSummary instances."""
+
+
+class BookmarkStatus(BaseModel):
+    r"""Article Bookmark Status"""
+
+    is_bookmarked: Annotated[bool, pydantic.Field(alias="isBookmarked")]
+    r"""Indicates whether the Article is bookmarked"""
+
+    bookmark_id: Annotated[Optional[int], pydantic.Field(alias="bookmarkID")] = None
+    r"""The ID of the Bookmark, if Article is bookmarked."""
+
+    folder_breadcrumb: Annotated[
+        Optional[FolderBreadcrumb], pydantic.Field(alias="folderBreadcrumb")
+    ] = None
+    r"""This schema contains one or more FolderSummary instances."""