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

egain_api_python/models/getsuggestionop.py

@@ -0,0 +1,107 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .suggestionadditionalattributes import SuggestionAdditionalAttributes
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GetSuggestionRequestTypedDict(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."""
+    suggestion_id: str
+    r"""The ID of the Suggestion.<br><br>A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    suggestion_additional_attributes: NotRequired[List[SuggestionAdditionalAttributes]]
+    r"""The attributes of a Suggestion to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' returns all attributes.
+
+    #### Default Attributes
+    These Suggestion attributes are always returned:
+
+    | Name | Description
+    | ---- | -----------
+    | id | The ID of the Suggestion.
+    | name  | The name of the Suggestion.
+    | status | The status of the Suggestion.
+    | description | The description of the Suggestion.
+    | language | Details about the language of the Suggestion.
+    | modifiedBy.id | The ID of the user that last modified the Suggestion.
+    | modifiedBy.firstName | The Suggestion's last modified user's first name.
+    | modifiedBy.middleName | The Suggestion's last modified user's middle name.
+    | modifiedBy.lastName | The Suggestion's last modified user's last name.
+    | modifiedDate | The Suggestion's last modified date <u>and</u> information about the user that last modified the Suggestion.
+    | link | The link object, used to retrieve the details of the Suggestion.
+    | hasComments | The Suggestion has one or more comments
+    | hasAttachments | The Suggestion has one or more attachments
+    | hasRelatedArticles | The Suggestion has related articles
+
+    """
+    custom_additional_attributes: NotRequired[str]
+
+
+class GetSuggestionRequest(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."""
+
+    suggestion_id: Annotated[
+        str,
+        pydantic.Field(alias="suggestionID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the Suggestion.<br><br>A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    suggestion_additional_attributes: Annotated[
+        Optional[List[SuggestionAdditionalAttributes]],
+        pydantic.Field(alias="suggestionAdditionalAttributes"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),
+    ] = None
+    r"""The attributes of a Suggestion to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' returns all attributes.
+
+    #### Default Attributes
+    These Suggestion attributes are always returned:
+
+    | Name | Description
+    | ---- | -----------
+    | id | The ID of the Suggestion.
+    | name  | The name of the Suggestion.
+    | status | The status of the Suggestion.
+    | description | The description of the Suggestion.
+    | language | Details about the language of the Suggestion.
+    | modifiedBy.id | The ID of the user that last modified the Suggestion.
+    | modifiedBy.firstName | The Suggestion's last modified user's first name.
+    | modifiedBy.middleName | The Suggestion's last modified user's middle name.
+    | modifiedBy.lastName | The Suggestion's last modified user's last name.
+    | modifiedDate | The Suggestion's last modified date <u>and</u> information about the user that last modified the Suggestion.
+    | link | The link object, used to retrieve the details of the Suggestion.
+    | hasComments | The Suggestion has one or more comments
+    | hasAttachments | The Suggestion has one or more attachments
+    | hasRelatedArticles | The Suggestion has related articles
+
+    """
+
+    custom_additional_attributes: Annotated[
+        Optional[str],
+        pydantic.Field(alias="$customAdditionalAttributes"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None

egain_api_python/models/gettagcategoriesforinterestforportalop.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .mandatorylanguagequeryparameter import MandatoryLanguageQueryParameter
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class GetTagCategoriesForInterestForPortalRequestTypedDict(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."""
+    language: MandatoryLanguageQueryParameter
+    r"""The language used for fetching the details of a resource. Resources available in different languages may differ from each other."""
+
+
+class GetTagCategoriesForInterestForPortalRequest(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."""
+
+    language: Annotated[
+        MandatoryLanguageQueryParameter,
+        pydantic.Field(alias="$lang"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""The language used for fetching the details of a resource. Resources available in different languages may differ from each other."""

egain_api_python/models/gettopicbreadcrumbforarticleop.py

@@ -0,0 +1,55 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .mandatorylanguagequeryparameter import MandatoryLanguageQueryParameter
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class GetTopicBreadcrumbForArticleRequestTypedDict(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."""
+    language: MandatoryLanguageQueryParameter
+    r"""The language used for fetching the details of a resource. Resources available in different languages may differ from each other."""
+
+
+class GetTopicBreadcrumbForArticleRequest(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."""
+
+    language: Annotated[
+        MandatoryLanguageQueryParameter,
+        pydantic.Field(alias="$lang"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""The language used for fetching the details of a resource. Resources available in different languages may differ from each other."""

egain_api_python/models/getuserdetailsop.py

@@ -0,0 +1,22 @@
+"""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
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class GetUserDetailsRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+
+
+class GetUserDetailsRequest(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)."""

egain_api_python/models/getusermilestonesop.py

@@ -0,0 +1,22 @@
+"""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
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class GetUserMilestonesRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+
+
+class GetUserMilestonesRequest(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)."""

egain_api_python/models/ghsearchrequest.py

@@ -0,0 +1,67 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .sessioncontextvariable import (
+    SessionContextVariable,
+    SessionContextVariableTypedDict,
+)
+from .startquestionandanswer import (
+    StartQuestionAndAnswer,
+    StartQuestionAndAnswerTypedDict,
+)
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GHSearchRequestTypedDict(TypedDict):
+    casebase_id: str
+    r"""The numerical ID of the Casebase."""
+    questions: NotRequired[List[StartQuestionAndAnswerTypedDict]]
+    r"""Pre-answered Questions in Guided Help search"""
+    profile_id: NotRequired[str]
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+    session_variable: NotRequired[List[SessionContextVariableTypedDict]]
+    r"""Session variables used to give Guided Help additional context."""
+    start_over: NotRequired[bool]
+    r"""Restart the current Guided Help search with the existing context along with session variable context."""
+    use_live_release: NotRequired[bool]
+    r"""Use current live release snapshot of the Casebase otherwise use the authoring release."""
+    ghs_article_id: NotRequired[str]
+    r"""Numeric ID of the guided help session article used for starting search."""
+
+
+class GHSearchRequest(BaseModel):
+    casebase_id: Annotated[str, pydantic.Field(alias="casebaseId")]
+    r"""The numerical ID of the Casebase."""
+
+    questions: Optional[List[StartQuestionAndAnswer]] = None
+    r"""Pre-answered Questions in Guided Help search"""
+
+    profile_id: Annotated[Optional[str], pydantic.Field(alias="profileId")] = None
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+
+    session_variable: Annotated[
+        Optional[List[SessionContextVariable]], pydantic.Field(alias="sessionVariable")
+    ] = None
+    r"""Session variables used to give Guided Help additional context."""
+
+    start_over: Annotated[Optional[bool], pydantic.Field(alias="startOver")] = None
+    r"""Restart the current Guided Help search with the existing context along with session variable context."""
+
+    use_live_release: Annotated[
+        Optional[bool], pydantic.Field(alias="useLiveRelease")
+    ] = None
+    r"""Use current live release snapshot of the Casebase otherwise use the authoring release."""
+
+    ghs_article_id: Annotated[Optional[str], pydantic.Field(alias="ghsArticleId")] = (
+        None
+    )
+    r"""Numeric ID of the guided help session article used for starting search."""

egain_api_python/models/ghsearchresult.py

@@ -0,0 +1,75 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .actionsearch import ActionSearch, ActionSearchTypedDict
+from .answeredquestion import AnsweredQuestion, AnsweredQuestionTypedDict
+from .casebase import Casebase, CasebaseTypedDict
+from .casesearch import CaseSearch, CaseSearchTypedDict
+from .clusterid import ClusterID, ClusterIDTypedDict
+from .dynamicsearch import DynamicSearch, DynamicSearchTypedDict
+from .question import Question, QuestionTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GHSearchResultTypedDict(TypedDict):
+    r"""Success"""
+
+    casebase: NotRequired[CasebaseTypedDict]
+    action_search: NotRequired[List[ActionSearchTypedDict]]
+    r"""actions in the search"""
+    answered_question: NotRequired[List[AnsweredQuestionTypedDict]]
+    r"""questions answered in the search"""
+    case_search: NotRequired[List[CaseSearchTypedDict]]
+    r"""cases in the search"""
+    dynamic_search: NotRequired[List[DynamicSearchTypedDict]]
+    r"""dynamic cases in the search"""
+    unanswered_question: NotRequired[List[QuestionTypedDict]]
+    r"""unanswered questions in the search"""
+    startup_question: NotRequired[List[QuestionTypedDict]]
+    r"""startup questions in the search"""
+    target_clusters: NotRequired[List[ClusterIDTypedDict]]
+    r"""active clusters in the search"""
+
+
+class GHSearchResult(BaseModel):
+    r"""Success"""
+
+    casebase: Optional[Casebase] = None
+
+    action_search: Annotated[
+        Optional[List[ActionSearch]], pydantic.Field(alias="actionSearch")
+    ] = None
+    r"""actions in the search"""
+
+    answered_question: Annotated[
+        Optional[List[AnsweredQuestion]], pydantic.Field(alias="answeredQuestion")
+    ] = None
+    r"""questions answered in the search"""
+
+    case_search: Annotated[
+        Optional[List[CaseSearch]], pydantic.Field(alias="caseSearch")
+    ] = None
+    r"""cases in the search"""
+
+    dynamic_search: Annotated[
+        Optional[List[DynamicSearch]], pydantic.Field(alias="dynamicSearch")
+    ] = None
+    r"""dynamic cases in the search"""
+
+    unanswered_question: Annotated[
+        Optional[List[Question]], pydantic.Field(alias="unansweredQuestion")
+    ] = None
+    r"""unanswered questions in the search"""
+
+    startup_question: Annotated[
+        Optional[List[Question]], pydantic.Field(alias="startupQuestion")
+    ] = None
+    r"""startup questions in the search"""
+
+    target_clusters: Annotated[
+        Optional[List[ClusterID]], pydantic.Field(alias="targetClusters")
+    ] = None
+    r"""active clusters in the search"""

egain_api_python/models/ghstepsearchrequest.py

@@ -0,0 +1,64 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .questionandanswer import QuestionAndAnswer, QuestionAndAnswerTypedDict
+from .sessioncontextvariable import (
+    SessionContextVariable,
+    SessionContextVariableTypedDict,
+)
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class GHStepSearchRequestTypedDict(TypedDict):
+    casebase_id: str
+    r"""The numerical ID of the Casebase."""
+    questions: List[QuestionAndAnswerTypedDict]
+    r"""Pre-answered Questions in Guided Help search"""
+    profile_id: NotRequired[str]
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+    session_variable: NotRequired[List[SessionContextVariableTypedDict]]
+    r"""Session variables used to give Guided Help additional context."""
+    start_over: NotRequired[bool]
+    r"""Restart the current Guided Help search with the existing context along with session variable context."""
+    use_live_release: NotRequired[bool]
+    r"""Use current live release snapshot of the Casebase otherwise use the authoring release."""
+    ghs_article_id: NotRequired[str]
+    r"""Numeric ID of the guided help session article used for starting search."""
+
+
+class GHStepSearchRequest(BaseModel):
+    casebase_id: Annotated[str, pydantic.Field(alias="casebaseId")]
+    r"""The numerical ID of the Casebase."""
+
+    questions: List[QuestionAndAnswer]
+    r"""Pre-answered Questions in Guided Help search"""
+
+    profile_id: Annotated[Optional[str], pydantic.Field(alias="profileId")] = None
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+
+    session_variable: Annotated[
+        Optional[List[SessionContextVariable]], pydantic.Field(alias="sessionVariable")
+    ] = None
+    r"""Session variables used to give Guided Help additional context."""
+
+    start_over: Annotated[Optional[bool], pydantic.Field(alias="startOver")] = None
+    r"""Restart the current Guided Help search with the existing context along with session variable context."""
+
+    use_live_release: Annotated[
+        Optional[bool], pydantic.Field(alias="useLiveRelease")
+    ] = None
+    r"""Use current live release snapshot of the Casebase otherwise use the authoring release."""
+
+    ghs_article_id: Annotated[Optional[str], pydantic.Field(alias="ghsArticleId")] = (
+        None
+    )
+    r"""Numeric ID of the guided help session article used for starting search."""

egain_api_python/models/image.py

@@ -0,0 +1,17 @@
+"""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
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class ImageTypedDict(TypedDict):
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class Image(BaseModel):
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/importcontent.py

@@ -0,0 +1,79 @@
+"""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 Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+ImportContentType = Literal[
+    "AWS S3 bucket",
+    "Shared file path",
+]
+r"""Type of data source"""
+
+
+class ImportContentCredentialsTypedDict(TypedDict):
+    access_key: NotRequired[str]
+    secret_key: NotRequired[str]
+
+
+class ImportContentCredentials(BaseModel):
+    access_key: Annotated[Optional[str], pydantic.Field(alias="accessKey")] = None
+
+    secret_key: Annotated[Optional[str], pydantic.Field(alias="secretKey")] = None
+
+
+class ImportContentDataSourceTypedDict(TypedDict):
+    type: ImportContentType
+    r"""Type of data source"""
+    path: str
+    r"""Path of the data source"""
+    region: NotRequired[str]
+    r"""Region of the data source"""
+    credentials: NotRequired[ImportContentCredentialsTypedDict]
+
+
+class ImportContentDataSource(BaseModel):
+    type: ImportContentType
+    r"""Type of data source"""
+
+    path: str
+    r"""Path of the data source"""
+
+    region: Optional[str] = None
+    r"""Region of the data source"""
+
+    credentials: Optional[ImportContentCredentials] = None
+
+
+Operation = Literal[
+    "import",
+    "reimport",
+]
+
+
+class ScheduleTimeTypedDict(TypedDict):
+    date_: datetime
+
+
+class ScheduleTime(BaseModel):
+    date_: Annotated[datetime, pydantic.Field(alias="date")]
+
+
+class ImportContentTypedDict(TypedDict):
+    data_source: ImportContentDataSourceTypedDict
+    operation: Operation
+    schedule_time: NotRequired[ScheduleTimeTypedDict]
+
+
+class ImportContent(BaseModel):
+    data_source: Annotated[ImportContentDataSource, pydantic.Field(alias="dataSource")]
+
+    operation: Operation
+
+    schedule_time: Annotated[
+        Optional[ScheduleTime], pydantic.Field(alias="scheduleTime")
+    ] = None

egain_api_python/models/importstatus.py

@@ -0,0 +1,29 @@
+"""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
+
+
+ImportStatusStatus = Literal[
+    "Scheduled",
+    "In Progress",
+    "Successful",
+    "Failed",
+    "Cancelled",
+]
+
+
+class ImportStatusTypedDict(TypedDict):
+    status: ImportStatusStatus
+    log_file_location: NotRequired[str]
+
+
+class ImportStatus(BaseModel):
+    status: ImportStatusStatus
+
+    log_file_location: Annotated[
+        Optional[str], pydantic.Field(alias="logFileLocation")
+    ] = None

egain_api_python/models/kblanguage.py

@@ -0,0 +1,63 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+from typing import Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+Name = Literal[
+    "English (United States)",
+    "English (United Kingdom)",
+    "French (France)",
+    "Spanish (Spain)",
+    "Italian (Italy)",
+    "German (Germany)",
+    "Dutch (Netherlands)",
+    "Portuguese (Brazil)",
+    "Portuguese (Portugal)",
+    "Danish (Denmark)",
+    "Swedish (Sweden)",
+    "Russian (Russia)",
+    "French (Canada)",
+    "Chinese (Simplified)",
+    "Japanese (Japan)",
+    "Korean (South Korea)",
+]
+r"""Name of the language."""
+
+
+KbLanguageCode1 = Literal[
+    "en-US",
+    "en-GB",
+    "fr-FR",
+    "es-ES",
+    "it-IT",
+    "de-DE",
+    "nl-NL",
+    "pt-BR",
+    "pt-PT",
+    "da-DK",
+    "sv-SE",
+    "ru-RU",
+    "fr-CA",
+    "zh-CN",
+    "ja-JP",
+    "ko-KR",
+]
+r"""IETF code of the language."""
+
+
+class KbLanguageTypedDict(TypedDict):
+    name: NotRequired[Name]
+    r"""Name of the language."""
+    code: NotRequired[KbLanguageCode1]
+    r"""IETF code of the language."""
+
+
+class KbLanguage(BaseModel):
+    name: Optional[Name] = None
+    r"""Name of the language."""
+
+    code: Optional[KbLanguageCode1] = None
+    r"""IETF code of the language."""