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

egain_api_python/models/articleresult.py

@@ -0,0 +1,159 @@
+"""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 ArticleResultTypedDict(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."""
+    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 ArticleResult(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."""
+
+    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/articleresultadditionalattributes.py

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

egain_api_python/models/articleresults.py

@@ -0,0 +1,32 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articleresult import ArticleResult, ArticleResultTypedDict
+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 ArticleResultsTypedDict(TypedDict):
+    r"""One or more instances of an Article result."""
+
+    articles: NotRequired[List[ArticleResultTypedDict]]
+    r"""Article details
+
+    """
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class ArticleResults(BaseModel):
+    r"""One or more instances of an Article result."""
+
+    articles: Optional[List[ArticleResult]] = None
+    r"""Article details
+
+    """
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/articlesearchresult.py

@@ -0,0 +1,243 @@
+"""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 .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 .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 SnippetForStructuredAuthoringTypedDict(TypedDict):
+    issue: NotRequired[str]
+    r"""Describes the problem, symptom, or question the article addresses"""
+    environment: NotRequired[str]
+    r"""Specifies the relevant product(s), category, or business process tied to the issue."""
+    cause: NotRequired[str]
+    r"""Identifies the underlying cause of the issue."""
+
+
+class SnippetForStructuredAuthoring(BaseModel):
+    issue: Optional[str] = None
+    r"""Describes the problem, symptom, or question the article addresses"""
+
+    environment: Optional[str] = None
+    r"""Specifies the relevant product(s), category, or business process tied to the issue."""
+
+    cause: Optional[str] = None
+    r"""Identifies the underlying cause of the issue."""
+
+
+class ArticleSearchResultTypedDict(TypedDict):
+    r"""Article search result."""
+
+    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."""
+    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."""
+    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."""
+    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."""
+    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."""
+    has_attachments: NotRequired[bool]
+    r"""Indicates whether the Article has any attachments."""
+    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."""
+    name: NotRequired[str]
+    r"""The name of the Article."""
+    snippet: NotRequired[str]
+    r"""A returned matching snippet within article content when searching for a search term."""
+    snippet_for_structured_authoring: NotRequired[
+        SnippetForStructuredAuthoringTypedDict
+    ]
+    article_state: NotRequired[str]
+    r"""The Article's state."""
+    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 ArticleSearchResult(BaseModel):
+    r"""Article search result."""
+
+    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."""
+
+    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."""
+
+    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."""
+
+    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."""
+
+    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."""
+
+    has_attachments: Annotated[
+        Optional[bool], pydantic.Field(alias="hasAttachments")
+    ] = None
+    r"""Indicates whether the Article has any attachments."""
+
+    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."""
+
+    name: Optional[str] = None
+    r"""The name of the Article."""
+
+    snippet: Optional[str] = None
+    r"""A returned matching snippet within article content when searching for a search term."""
+
+    snippet_for_structured_authoring: Annotated[
+        Optional[SnippetForStructuredAuthoring],
+        pydantic.Field(alias="snippetForStructuredAuthoring"),
+    ] = 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."""
+
+    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/articlesearchresults.py

@@ -0,0 +1,32 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articlesearchresult import ArticleSearchResult, ArticleSearchResultTypedDict
+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 ArticleSearchResultsTypedDict(TypedDict):
+    r"""One or more instances of an Article search result."""
+
+    articles: NotRequired[List[ArticleSearchResultTypedDict]]
+    r"""Article details
+
+    """
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class ArticleSearchResults(BaseModel):
+    r"""One or more instances of an Article search result."""
+
+    articles: Optional[List[ArticleSearchResult]] = None
+    r"""Article details
+
+    """
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/articlesort.py

@@ -0,0 +1,11 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+ArticleSort = Literal[
+    "availabilityDate",
+    "popularity",
+    "name",
+]

egain_api_python/models/articlesortorder.py

@@ -0,0 +1,11 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+ArticleSortOrder = Literal[
+    "asc",
+    "desc",
+]
+r"""Sort order of articles."""

egain_api_python/models/articletype.py

@@ -0,0 +1,56 @@
+"""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
+
+
+ArticleTypeTypeName = Literal[
+    "General",
+    "Guided Help",
+    "Data Link",
+    "Topic Home",
+    "Suggestion",
+    "Virtual Assistant Action",
+    "Rich Message",
+]
+r"""Indicates the article category name."""
+
+
+class ArticleTypeTypedDict(TypedDict):
+    r"""The type of the Article and its attributes."""
+
+    article_category_id: NotRequired[int]
+    r"""Specifies the article category ID."""
+    type_name: NotRequired[ArticleTypeTypeName]
+    r"""Indicates the article category name."""
+    use_structured_authoring: NotRequired[bool]
+    r"""Indicates whether to use Structured Authoring for the Article Type."""
+    article_type_id: NotRequired[str]
+    r"""The ID of the Article Type."""
+
+
+class ArticleType(BaseModel):
+    r"""The type of the Article and its attributes."""
+
+    article_category_id: Annotated[
+        Optional[int], pydantic.Field(alias="articleCategoryId")
+    ] = None
+    r"""Specifies the article category ID."""
+
+    type_name: Annotated[
+        Optional[ArticleTypeTypeName], pydantic.Field(alias="typeName")
+    ] = None
+    r"""Indicates the article category name."""
+
+    use_structured_authoring: Annotated[
+        Optional[bool], pydantic.Field(alias="useStructuredAuthoring")
+    ] = None
+    r"""Indicates whether to use Structured Authoring for the Article Type."""
+
+    article_type_id: Annotated[Optional[str], pydantic.Field(alias="articleTypeId")] = (
+        None
+    )
+    r"""The ID of the Article Type."""