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

egain_api_python/models/createviewedsearchresultseventforconnectorsop.py

@@ -0,0 +1,48 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .createviewedsearchresulteventforconnectors import (
+    CreateViewedSearchResultEventForConnectors,
+    CreateViewedSearchResultEventForConnectorsTypedDict,
+)
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class CreateViewedSearchResultsEventForConnectorsRequestTypedDict(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."""
+    create_viewed_search_result_event_for_connectors: (
+        CreateViewedSearchResultEventForConnectorsTypedDict
+    )
+
+
+class CreateViewedSearchResultsEventForConnectorsRequest(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."""
+
+    create_viewed_search_result_event_for_connectors: Annotated[
+        CreateViewedSearchResultEventForConnectors,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]

egain_api_python/models/customattribute.py

@@ -0,0 +1,35 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+from typing import List, Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+CustomAttributeType = Literal[
+    "STRING",
+    "INTEGER",
+    "BOOLEAN",
+    "DATETIME",
+]
+r"""The custom attribute's type."""
+
+
+class CustomAttributeTypedDict(TypedDict):
+    name: NotRequired[str]
+    r"""The custom attribute's name."""
+    value: NotRequired[List[str]]
+    r"""The custom attribute's values."""
+    type: NotRequired[CustomAttributeType]
+    r"""The custom attribute's type."""
+
+
+class CustomAttribute(BaseModel):
+    name: Optional[str] = None
+    r"""The custom attribute's name."""
+
+    value: Optional[List[str]] = None
+    r"""The custom attribute's values."""
+
+    type: Optional[CustomAttributeType] = None
+    r"""The custom attribute's type."""

egain_api_python/models/deletebookmarkop.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 DeletebookmarkRequestTypedDict(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."""
+    bookmark_id: str
+    r"""The ID of the bookmark."""
+
+
+class DeletebookmarkRequest(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."""
+
+    bookmark_id: Annotated[
+        str,
+        pydantic.Field(alias="bookmarkID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the bookmark."""

egain_api_python/models/deletesuggestionop.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 DeleteSuggestionRequestTypedDict(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."""
+
+
+class DeleteSuggestionRequest(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."""

egain_api_python/models/department.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 DepartmentTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""ID of department"""
+    name: NotRequired[str]
+    r"""Name of Department"""
+
+
+class Department(BaseModel):
+    id: Optional[str] = None
+    r"""ID of department"""
+
+    name: Optional[str] = None
+    r"""Name of Department"""

egain_api_python/models/detailfield.py

@@ -0,0 +1,32 @@
+"""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 DetailFieldTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The ID of the Detail Field.<br>The ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    detail_link: NotRequired[str]
+    r"""link of the detail"""
+    detail_type: NotRequired[str]
+    r"""type of the detail"""
+    field_name: NotRequired[str]
+    r"""name of the field"""
+
+
+class DetailField(BaseModel):
+    id: Optional[str] = None
+    r"""The ID of the Detail Field.<br>The ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    detail_link: Annotated[Optional[str], pydantic.Field(alias="detailLink")] = None
+    r"""link of the detail"""
+
+    detail_type: Annotated[Optional[str], pydantic.Field(alias="detailType")] = None
+    r"""type of the detail"""
+
+    field_name: Annotated[Optional[str], pydantic.Field(alias="fieldName")] = None
+    r"""name of the field"""

egain_api_python/models/displayfield.py

@@ -0,0 +1,27 @@
+"""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 Any, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class DisplayFieldTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The ID of the Display Field.<br>The ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    content: NotRequired[str]
+    r"""content in bytes. 2 MB max"""
+    field_name: NotRequired[Any]
+    r"""name of the field"""
+
+
+class DisplayField(BaseModel):
+    id: Optional[str] = None
+    r"""The ID of the Display Field.<br>The ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    content: Optional[str] = None
+    r"""content in bytes. 2 MB max"""
+
+    field_name: Annotated[Optional[Any], pydantic.Field(alias="fieldName")] = None
+    r"""name of the field"""

egain_api_python/models/dynamiccluster.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 DynamicClusterTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""Id of the cluster"""
+    title: NotRequired[str]
+    r"""name of the cluster"""
+
+
+class DynamicCluster(BaseModel):
+    id: Optional[str] = None
+    r"""Id of the cluster"""
+
+    title: Optional[str] = None
+    r"""name of the cluster"""

egain_api_python/models/dynamicsearch.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .dynamiccluster import DynamicCluster, DynamicClusterTypedDict
+from .virtualcase import VirtualCase, VirtualCaseTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class DynamicSearchTypedDict(TypedDict):
+    dynamic_cluster: NotRequired[List[DynamicClusterTypedDict]]
+    r"""clusters in search"""
+    parent_cluster_id: NotRequired[str]
+    r"""Parent cluster"""
+    type: NotRequired[str]
+    r"""type of search"""
+    virtual_case: NotRequired[List[VirtualCaseTypedDict]]
+    r"""cases in search"""
+
+
+class DynamicSearch(BaseModel):
+    dynamic_cluster: Annotated[
+        Optional[List[DynamicCluster]], pydantic.Field(alias="dynamicCluster")
+    ] = None
+    r"""clusters in search"""
+
+    parent_cluster_id: Annotated[
+        Optional[str], pydantic.Field(alias="parentClusterId")
+    ] = None
+    r"""Parent cluster"""
+
+    type: Optional[str] = None
+    r"""type of search"""
+
+    virtual_case: Annotated[
+        Optional[List[VirtualCase]], pydantic.Field(alias="virtualCase")
+    ] = None
+    r"""cases in search"""

egain_api_python/models/edition.py

@@ -0,0 +1,79 @@
+"""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 EditionPublishProfileTypedDict(TypedDict):
+    r"""The publish view associated with this edition."""
+
+    id: str
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+    name: str
+    r"""The name of the profile."""
+
+
+class EditionPublishProfile(BaseModel):
+    r"""The publish view associated with this edition."""
+
+    id: str
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+
+    name: str
+    r"""The name of the profile."""
+
+
+class EditionTypedDict(TypedDict):
+    r"""This schema contains information about an article edition."""
+
+    id: NotRequired[str]
+    r"""The ID of the article edition.<br>An edition ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits."""
+    name: NotRequired[str]
+    r"""The alphanumeric name of the edition."""
+    is_content_edition: NotRequired[bool]
+    r"""<li>The presence of this element indicates that this edition is the one corresponding to the returned content.</li>
+    <li>This can only be true for at most one <edition> element in the list of editions.</li>
+    <li>This parameter must only be returned if article content is returned as well.</li>
+    <li>The only allowed value is *true*. The absence of this parameter in the response indicates *false*.</li>
+    """
+    publish_profile: NotRequired[EditionPublishProfileTypedDict]
+    r"""The publish view associated with this edition."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class Edition(BaseModel):
+    r"""This schema contains information about an article edition."""
+
+    id: Optional[str] = None
+    r"""The ID of the article edition.<br>An edition ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits."""
+
+    name: Optional[str] = None
+    r"""The alphanumeric name of the edition."""
+
+    is_content_edition: Annotated[
+        Optional[bool], pydantic.Field(alias="isContentEdition")
+    ] = None
+    r"""<li>The presence of this element indicates that this edition is the one corresponding to the returned content.</li>
+    <li>This can only be true for at most one <edition> element in the list of editions.</li>
+    <li>This parameter must only be returned if article content is returned as well.</li>
+    <li>The only allowed value is *true*. The absence of this parameter in the response indicates *false*.</li>
+    """
+
+    publish_profile: Annotated[
+        Optional[EditionPublishProfile], pydantic.Field(alias="publishProfile")
+    ] = None
+    r"""The publish view associated with this edition."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/editionwithcontent.py

@@ -0,0 +1,68 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .link import Link, LinkTypedDict
+from .publishprofile import PublishProfile, PublishProfileTypedDict
+from .schemas_tagcategory import SchemasTagCategory, SchemasTagCategoryTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class EditionWithContentAccessTagsTypedDict(TypedDict):
+    tag_category: NotRequired[List[SchemasTagCategoryTypedDict]]
+    r"""An array of tag categories. Note that the total number of tag categories cannot exceed 20."""
+
+
+class EditionWithContentAccessTags(BaseModel):
+    tag_category: Annotated[
+        Optional[List[SchemasTagCategory]], pydantic.Field(alias="tagCategory")
+    ] = None
+    r"""An array of tag categories. Note that the total number of tag categories cannot exceed 20."""
+
+
+class EditionWithContentTypedDict(TypedDict):
+    r"""This schema contains information about article edition."""
+
+    id: NotRequired[str]
+    r"""ID of the edition."""
+    name: NotRequired[str]
+    r"""Name of the edition."""
+    publish_profile: NotRequired[PublishProfileTypedDict]
+    r"""This schema contains information about Profile."""
+    content: NotRequired[str]
+    r"""The raw content of the article. The maximum allowed Article content size is 5 MB."""
+    content_text: NotRequired[str]
+    r"""Plain text version of the content. The maximum allowed Article content size is 5 MB."""
+    access_tags: NotRequired[EditionWithContentAccessTagsTypedDict]
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class EditionWithContent(BaseModel):
+    r"""This schema contains information about article edition."""
+
+    id: Optional[str] = None
+    r"""ID of the edition."""
+
+    name: Optional[str] = None
+    r"""Name of the edition."""
+
+    publish_profile: Annotated[
+        Optional[PublishProfile], pydantic.Field(alias="publishProfile")
+    ] = None
+    r"""This schema contains information about Profile."""
+
+    content: Optional[str] = None
+    r"""The raw content of the article. The maximum allowed Article content size is 5 MB."""
+
+    content_text: Annotated[Optional[str], pydantic.Field(alias="contentText")] = None
+    r"""Plain text version of the content. The maximum allowed Article content size is 5 MB."""
+
+    access_tags: Annotated[
+        Optional[EditionWithContentAccessTags], pydantic.Field(alias="accessTags")
+    ] = None
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/email.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
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class EmailTypedDict(TypedDict):
+    r"""Email"""
+
+    email_address: NotRequired[str]
+    r"""Email address of customer"""
+
+
+class Email(BaseModel):
+    r"""Email"""
+
+    email_address: Annotated[Optional[str], pydantic.Field(alias="emailAddress")] = None
+    r"""Email address of customer"""

egain_api_python/models/exportcontentop.py

@@ -0,0 +1,14 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+from typing import Dict, List
+from typing_extensions import TypedDict
+
+
+class ExportContentResponseTypedDict(TypedDict):
+    headers: Dict[str, List[str]]
+
+
+class ExportContentResponse(BaseModel):
+    headers: Dict[str, List[str]]

egain_api_python/models/exportstatus.py

@@ -0,0 +1,106 @@
+"""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
+
+
+ExportStatusStatus = Literal[
+    "Pending",
+    "In Progress",
+    "Successful",
+    "Failed",
+]
+
+
+class ProgressTypedDict(TypedDict):
+    r"""Details about the job's progress."""
+
+    processed: NotRequired[int]
+    r"""The number of items processed so far."""
+    total: NotRequired[int]
+    r"""The total number of items to process."""
+    percentage: NotRequired[float]
+    r"""The percentage of the job that is complete."""
+
+
+class Progress(BaseModel):
+    r"""Details about the job's progress."""
+
+    processed: Optional[int] = None
+    r"""The number of items processed so far."""
+
+    total: Optional[int] = None
+    r"""The total number of items to process."""
+
+    percentage: Optional[float] = None
+    r"""The percentage of the job that is complete."""
+
+
+class ResultsTypedDict(TypedDict):
+    r"""Breakdown of completed job results."""
+
+    successful: NotRequired[int]
+    r"""The count of successfully processed items."""
+    warnings: NotRequired[int]
+    r"""The count of items with warnings."""
+    errors: NotRequired[int]
+    r"""The count of items with errors."""
+
+
+class Results(BaseModel):
+    r"""Breakdown of completed job results."""
+
+    successful: Optional[int] = None
+    r"""The count of successfully processed items."""
+
+    warnings: Optional[int] = None
+    r"""The count of items with warnings."""
+
+    errors: Optional[int] = None
+    r"""The count of items with errors."""
+
+
+class ExportStatusTypedDict(TypedDict):
+    status: ExportStatusStatus
+    progress: NotRequired[ProgressTypedDict]
+    r"""Details about the job's progress."""
+    start_time: NotRequired[datetime]
+    r"""The timestamp when the job started."""
+    estimated_completion: NotRequired[datetime]
+    r"""The estimated timestamp when the job is expected to finish."""
+    failure_time: NotRequired[datetime]
+    r"""The timestamp when the job failed."""
+    results: NotRequired[ResultsTypedDict]
+    r"""Breakdown of completed job results."""
+    error: NotRequired[str]
+    r"""A description of the job failure reason."""
+
+
+class ExportStatus(BaseModel):
+    status: ExportStatusStatus
+
+    progress: Optional[Progress] = None
+    r"""Details about the job's progress."""
+
+    start_time: Annotated[Optional[datetime], pydantic.Field(alias="startTime")] = None
+    r"""The timestamp when the job started."""
+
+    estimated_completion: Annotated[
+        Optional[datetime], pydantic.Field(alias="estimatedCompletion")
+    ] = None
+    r"""The estimated timestamp when the job is expected to finish."""
+
+    failure_time: Annotated[Optional[datetime], pydantic.Field(alias="failureTime")] = (
+        None
+    )
+    r"""The timestamp when the job failed."""
+
+    results: Optional[Results] = None
+    r"""Breakdown of completed job results."""
+
+    error: Optional[str] = None
+    r"""A description of the job failure reason."""

egain_api_python/models/exportstatusop.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
+from egain_api_python.utils import FieldMetadata, PathParamMetadata
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class ExportStatusRequestTypedDict(TypedDict):
+    job_id: str
+    r"""**Example Usage:**
+    ```bash
+    GET /content/export/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status
+    ```
+
+    """
+
+
+class ExportStatusRequest(BaseModel):
+    job_id: Annotated[
+        str,
+        pydantic.Field(alias="jobID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""**Example Usage:**
+    ```bash
+    GET /content/export/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status
+    ```
+
+    """

egain_api_python/models/feedbackarticleforsuggestion.py

@@ -0,0 +1,34 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articleresult import ArticleResult, ArticleResultTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class FeedbackArticleForSuggestionTypedDict(TypedDict):
+    r"""This schema contains information about a Suggestion."""
+
+    id: NotRequired[str]
+    r"""The ID of the Suggestion. A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    name: NotRequired[str]
+    r"""The name of the Suggestion."""
+    related_articles: NotRequired[List[ArticleResultTypedDict]]
+    r"""Related Articles for the Suggestion."""
+
+
+class FeedbackArticleForSuggestion(BaseModel):
+    r"""This schema contains information about a Suggestion."""
+
+    id: Optional[str] = None
+    r"""The ID of the Suggestion. A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    name: Optional[str] = None
+    r"""The name of the Suggestion."""
+
+    related_articles: Annotated[
+        Optional[List[ArticleResult]], pydantic.Field(alias="relatedArticles")
+    ] = None
+    r"""Related Articles for the Suggestion."""