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

egain_api_python/models/comments.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .comment import Comment, CommentTypedDict
+from egain_api_python.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class CommentsTypedDict(TypedDict):
+    r"""This schema contains the definition of an array of comments."""
+
+    count: NotRequired[int]
+    r"""The number of comments."""
+    comments: NotRequired[List[CommentTypedDict]]
+    r"""The list of comments."""
+
+
+class Comments(BaseModel):
+    r"""This schema contains the definition of an array of comments."""
+
+    count: Optional[int] = None
+    r"""The number of comments."""
+
+    comments: Optional[List[Comment]] = None
+    r"""The list of comments."""

egain_api_python/models/completecustomerescalationop.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 CompleteCustomerEscalationRequestTypedDict(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 CompleteCustomerEscalationRequest(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/compliancearticleresult.py

@@ -0,0 +1,166 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articletype import ArticleType, ArticleTypeTypedDict
+from .complianceforarticle import ComplianceForArticle, ComplianceForArticleTypedDict
+from .createdby import CreatedBy, CreatedByTypedDict
+from .customattribute import CustomAttribute, CustomAttributeTypedDict
+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 .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 ComplianceArticleResultTypedDict(TypedDict):
+    r"""Article search result, a subset of Article that does not contain content and contentText."""
+
+    id: NotRequired[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."""
+    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."""
+    average_rating: NotRequired[float]
+    r"""The average rating of the Article."""
+    created_by: NotRequired[CreatedByTypedDict]
+    modified_by: NotRequired[ModifiedByTypedDict]
+    owned_by: NotRequired[OwnedByTypedDict]
+    created_date: NotRequired[str]
+    custom_attributes: NotRequired[List[CustomAttributeTypedDict]]
+    r"""A list of custom attributes."""
+    description: NotRequired[str]
+    r"""A description of the Article. The maximum allowed Article description size is 1 KB."""
+    has_attachments: NotRequired[bool]
+    r"""Indicates whether the Article has any attachments."""
+    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."""
+    update_summary: NotRequired[str]
+    r"""Summary of latest update change to article."""
+    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."""
+    image_url: NotRequired[str]
+    r"""The URL of the image that is present in the Article version. It is used as the thumbnail image for the Article."""
+    name: NotRequired[str]
+    r"""The name of the Article."""
+    times_rated: NotRequired[int]
+    r"""The number of times that this Article has been rated."""
+    topic_breadcrumb: NotRequired[List[TopicBreadcrumbTypedDict]]
+    r"""A list of topics from the root topic to this Article. There may be multiple paths."""
+    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."""
+
+
+class ComplianceArticleResult(BaseModel):
+    r"""Article search result, a subset of Article that does not contain content and contentText."""
+
+    id: Optional[str] = None
+    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."""
+
+    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."""
+
+    average_rating: Annotated[
+        Optional[float], pydantic.Field(alias="averageRating")
+    ] = None
+    r"""The average rating of the Article."""
+
+    created_by: Annotated[Optional[CreatedBy], pydantic.Field(alias="createdBy")] = None
+
+    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."""
+
+    description: Optional[str] = None
+    r"""A description of the Article. The maximum allowed Article description size is 1 KB."""
+
+    has_attachments: Annotated[
+        Optional[bool], pydantic.Field(alias="hasAttachments")
+    ] = None
+    r"""Indicates whether the Article has any attachments."""
+
+    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."""
+
+    update_summary: Annotated[Optional[str], pydantic.Field(alias="updateSummary")] = (
+        None
+    )
+    r"""Summary of latest update change to article."""
+
+    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."""
+
+    image_url: Annotated[Optional[str], pydantic.Field(alias="imageURL")] = None
+    r"""The URL of the image that is present in the Article version. It is used as the thumbnail image for the Article."""
+
+    name: Optional[str] = None
+    r"""The name of the Article."""
+
+    times_rated: Annotated[Optional[int], pydantic.Field(alias="timesRated")] = None
+    r"""The number of times that this Article has been rated."""
+
+    topic_breadcrumb: Annotated[
+        Optional[List[TopicBreadcrumb]], pydantic.Field(alias="topicBreadcrumb")
+    ] = None
+    r"""A list of topics from the root topic to this Article. There may be multiple paths."""
+
+    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."""

egain_api_python/models/compliancearticleresultadditionalattributes.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+ComplianceArticleResultAdditionalAttributes = Literal[
+    "averageRating",
+    "articleSummary",
+    "customAttributes",
+    "description",
+    "imageURL",
+    "isSubscribed",
+    "timesRated",
+    "topicBreadcrumb",
+    "ownedBy",
+    "ownedBy.userName",
+    "workflow",
+    "compliance",
+    "personalization",
+    "all",
+]

egain_api_python/models/compliancearticleresults.py

@@ -0,0 +1,35 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .compliancearticleresult import (
+    ComplianceArticleResult,
+    ComplianceArticleResultTypedDict,
+)
+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 ComplianceArticleResultsTypedDict(TypedDict):
+    r"""One or more instances of Compliance Article."""
+
+    article: NotRequired[List[ComplianceArticleResultTypedDict]]
+    r"""Article details
+
+    """
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class ComplianceArticleResults(BaseModel):
+    r"""One or more instances of Compliance Article."""
+
+    article: Optional[List[ComplianceArticleResult]] = None
+    r"""Article details
+
+    """
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/complianceforarticle.py

@@ -0,0 +1,59 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import datetime
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class StartDateDateAndTimeTypedDict(TypedDict):
+    r"""The start date for the Article."""
+
+    date_: datetime
+    r"""The date in the format <code>YYYY-MM-DDTHH:MM:SS</code>."""
+
+
+class StartDateDateAndTime(BaseModel):
+    r"""The start date for the Article."""
+
+    date_: Annotated[datetime, pydantic.Field(alias="date")]
+    r"""The date in the format <code>YYYY-MM-DDTHH:MM:SS</code>."""
+
+
+class DueDateDateAndTimeTypedDict(TypedDict):
+    r"""The end date for the Article."""
+
+    date_: datetime
+    r"""The date in the format <code>YYYY-MM-DDTHH:MM:SS</code>."""
+
+
+class DueDateDateAndTime(BaseModel):
+    r"""The end date for the Article."""
+
+    date_: Annotated[datetime, pydantic.Field(alias="date")]
+    r"""The date in the format <code>YYYY-MM-DDTHH:MM:SS</code>."""
+
+
+class ComplianceForArticleTypedDict(TypedDict):
+    r"""This schema contains the compliance details for an Article."""
+
+    start_date: NotRequired[StartDateDateAndTimeTypedDict]
+    r"""The start date for the Article."""
+    due_date: NotRequired[DueDateDateAndTimeTypedDict]
+    r"""The end date for the Article."""
+
+
+class ComplianceForArticle(BaseModel):
+    r"""This schema contains the compliance details for an Article."""
+
+    start_date: Annotated[
+        Optional[StartDateDateAndTime], pydantic.Field(alias="startDate")
+    ] = None
+    r"""The start date for the Article."""
+
+    due_date: Annotated[
+        Optional[DueDateDateAndTime], pydantic.Field(alias="dueDate")
+    ] = None
+    r"""The end date for the Article."""

egain_api_python/models/complyarticleop.py

@@ -0,0 +1,40 @@
+"""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 ComplyArticleRequestTypedDict(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."""
+    article_id: str
+    r"""The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits."""
+
+
+class ComplyArticleRequest(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."""
+
+    article_id: Annotated[
+        str,
+        pydantic.Field(alias="articleID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits."""

egain_api_python/models/components_schemas_tag.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
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class ComponentsSchemasTagTypedDict(TypedDict):
+    r"""Tag"""
+
+    name: NotRequired[str]
+    r"""Name of the Tag"""
+    id: NotRequired[str]
+    r"""The ID of the Tag .<br>A Tag ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+
+class ComponentsSchemasTag(BaseModel):
+    r"""Tag"""
+
+    name: Optional[str] = None
+    r"""Name of the Tag"""
+
+    id: Optional[str] = None
+    r"""The ID of the Tag .<br>A Tag ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""

egain_api_python/models/components_schemas_tagcategory.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .components_schemas_tag import ComponentsSchemasTag, ComponentsSchemasTagTypedDict
+from .components_schemas_taggroup import (
+    ComponentsSchemasTagGroup,
+    ComponentsSchemasTagGroupTypedDict,
+)
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ComponentsSchemasTagCategoryTypedDict(TypedDict):
+    r"""Tag Categories for Interest configured for a portal."""
+
+    name: NotRequired[str]
+    r"""Name of the Tag Category"""
+    id: NotRequired[str]
+    r"""The ID of the Tag Category.<br>A Tag Category ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    tag: NotRequired[List[ComponentsSchemasTagTypedDict]]
+    tag_group: NotRequired[List[ComponentsSchemasTagGroupTypedDict]]
+
+
+class ComponentsSchemasTagCategory(BaseModel):
+    r"""Tag Categories for Interest configured for a portal."""
+
+    name: Optional[str] = None
+    r"""Name of the Tag Category"""
+
+    id: Optional[str] = None
+    r"""The ID of the Tag Category.<br>A Tag Category ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    tag: Optional[List[ComponentsSchemasTag]] = None
+
+    tag_group: Annotated[
+        Optional[List[ComponentsSchemasTagGroup]], pydantic.Field(alias="tagGroup")
+    ] = None

egain_api_python/models/components_schemas_taggroup.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
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class ComponentsSchemasTagGroupTypedDict(TypedDict):
+    r"""Group of Tags"""
+
+    name: NotRequired[str]
+    r"""Name of the Tag Group"""
+    id: NotRequired[str]
+    r"""The ID of the Tag Group.<br>A Tag Group ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+
+class ComponentsSchemasTagGroup(BaseModel):
+    r"""Group of Tags"""
+
+    name: Optional[str] = None
+    r"""Name of the Tag Group"""
+
+    id: Optional[str] = None
+    r"""The ID of the Tag Group.<br>A Tag Group ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""

egain_api_python/models/configurableattribute.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
+from typing_extensions import TypedDict
+
+
+class ConfigurableAttributeTypedDict(TypedDict):
+    name: str
+    r"""The name of the attribute."""
+    mandatory: bool
+    r"""Indicates if the attribute is mandatory."""
+    editable: bool
+    r"""Indicates if the attribute is editable."""
+
+
+class ConfigurableAttribute(BaseModel):
+    name: str
+    r"""The name of the attribute."""
+
+    mandatory: bool
+    r"""Indicates if the attribute is mandatory."""
+
+    editable: bool
+    r"""Indicates if the attribute is editable."""

egain_api_python/models/configurableattributes.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .configurableattribute import ConfigurableAttribute, ConfigurableAttributeTypedDict
+from egain_api_python.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class ConfigurableAttributesTypedDict(TypedDict):
+    attribute: NotRequired[List[ConfigurableAttributeTypedDict]]
+
+
+class ConfigurableAttributes(BaseModel):
+    attribute: Optional[List[ConfigurableAttribute]] = None

egain_api_python/models/contactperson.py

@@ -0,0 +1,43 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .email import Email, EmailTypedDict
+from .phone import Phone, PhoneTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ContactPersonTypedDict(TypedDict):
+    r"""ContactPerson"""
+
+    first_name: str
+    r"""First name of the customer"""
+    email: List[EmailTypedDict]
+    r"""Email details"""
+    middle_name: NotRequired[str]
+    r"""Middle name of the customer"""
+    last_name: NotRequired[str]
+    r"""Last name of the customer"""
+    phone: NotRequired[List[PhoneTypedDict]]
+    r"""Phone details"""
+
+
+class ContactPerson(BaseModel):
+    r"""ContactPerson"""
+
+    first_name: Annotated[str, pydantic.Field(alias="firstName")]
+    r"""First name of the customer"""
+
+    email: List[Email]
+    r"""Email details"""
+
+    middle_name: Annotated[Optional[str], pydantic.Field(alias="middleName")] = None
+    r"""Middle name of the customer"""
+
+    last_name: Annotated[Optional[str], pydantic.Field(alias="lastName")] = None
+    r"""Last name of the customer"""
+
+    phone: Optional[List[Phone]] = None
+    r"""Phone details"""

egain_api_python/models/contacts.py

@@ -0,0 +1,21 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .contactperson import ContactPerson, ContactPersonTypedDict
+from egain_api_python.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class ContactsTypedDict(TypedDict):
+    r"""Contacts"""
+
+    contact: NotRequired[List[ContactPersonTypedDict]]
+    r"""Contact Person"""
+
+
+class Contacts(BaseModel):
+    r"""Contacts"""
+
+    contact: Optional[List[ContactPerson]] = None
+    r"""Contact Person"""

egain_api_python/models/createbookmark.py

@@ -0,0 +1,64 @@
+"""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
+
+
+UserType = Literal[
+    "customer",
+    "agent",
+]
+r"""The type of the user associated with the bookmark."""
+
+
+class CreateBookmarkTypedDict(TypedDict):
+    resource_id: NotRequired[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.<br><br>This attribute must be provided if <code>resourceType</code> is set to \"1 - Article\" or \"2 - Topic\"."""
+    user_id: NotRequired[str]
+    r"""The ID of the user associated with the bookmark."""
+    user_type: NotRequired[UserType]
+    r"""The type of the user associated with 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 CreateBookmark(BaseModel):
+    resource_id: Annotated[Optional[str], pydantic.Field(alias="resourceId")] = None
+    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.<br><br>This attribute must be provided if <code>resourceType</code> is set to \"1 - Article\" or \"2 - Topic\"."""
+
+    user_id: Annotated[Optional[str], pydantic.Field(alias="userId")] = None
+    r"""The ID of the user associated with the bookmark."""
+
+    user_type: Annotated[Optional[UserType], pydantic.Field(alias="userType")] = None
+    r"""The type of the user associated with 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\"."""