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

egain_api_python/models/articleactivitylink.py

@@ -0,0 +1,62 @@
+"""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
+
+
+ArticleActivityLinkCode = 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"""The code of the language."""
+
+
+class ArticleActivityLinkLanguageTypedDict(TypedDict):
+    r"""The knowledge base language in which the version is created."""
+
+    code: ArticleActivityLinkCode
+    r"""The code of the language."""
+
+
+class ArticleActivityLinkLanguage(BaseModel):
+    r"""The knowledge base language in which the version is created."""
+
+    code: ArticleActivityLinkCode
+    r"""The code of the language."""
+
+
+class ArticleActivityLinkTypedDict(TypedDict):
+    version_id: str
+    r"""An Article version's ID."""
+    language: ArticleActivityLinkLanguageTypedDict
+    r"""The knowledge base language in which the version is created."""
+    edition_id: NotRequired[str]
+    r"""An Article edition's ID."""
+
+
+class ArticleActivityLink(BaseModel):
+    version_id: Annotated[str, pydantic.Field(alias="versionId")]
+    r"""An Article version's ID."""
+
+    language: ArticleActivityLinkLanguage
+    r"""The knowledge base language in which the version is created."""
+
+    edition_id: Annotated[Optional[str], pydantic.Field(alias="editionId")] = None
+    r"""An Article edition's ID."""

egain_api_python/models/articleadditionalattributes.py

@@ -0,0 +1,23 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+ArticleAdditionalAttributes = Literal[
+    "articleMacro",
+    "availabilityDate",
+    "availableEditions",
+    "averageRating",
+    "bookmarkStatus",
+    "content",
+    "contentText",
+    "compliance",
+    "timesRated",
+    "createdBy.userName",
+    "modifiedBy.userName",
+    "ownedBy",
+    "ownedBy.userName",
+    "workflow",
+    "all",
+]

egain_api_python/models/articleaisearchresult.py

@@ -0,0 +1,254 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .additionalsnippets import AdditionalSnippets, AdditionalSnippetsTypedDict
+from .schemas_tags import SchemasTags, SchemasTagsTypedDict
+from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+ArticleAISearchResultDocType = Literal[
+    "HTML",
+    "Doc",
+    "Pdf",
+]
+r"""Format of the source document (HTML, Doc, or PDF)."""
+
+
+ArticleAISearchResultSource = Literal[
+    "eGain Article",
+    "eGain Attachment",
+]
+r"""The source type."""
+
+
+ArticleAISearchResultType = Literal[
+    "STRING",
+    "INTEGER",
+    "BOOLEAN",
+    "DATETIME",
+]
+r"""The custom attribute's type."""
+
+
+class ArticleAISearchResultCustomAttributeTypedDict(TypedDict):
+    name: NotRequired[str]
+    r"""The custom attribute's name."""
+    value: NotRequired[List[str]]
+    r"""The custom attribute's values."""
+    type: NotRequired[ArticleAISearchResultType]
+    r"""The custom attribute's type."""
+
+
+class ArticleAISearchResultCustomAttribute(BaseModel):
+    name: Optional[str] = None
+    r"""The custom attribute's name."""
+
+    value: Optional[List[str]] = None
+    r"""The custom attribute's values."""
+
+    type: Optional[ArticleAISearchResultType] = None
+    r"""The custom attribute's type."""
+
+
+class OpensearchHighlightingRawTypedDict(TypedDict):
+    r"""Article content used for highlighting a keyword search result"""
+
+    article_content: NotRequired[List[str]]
+
+
+class OpensearchHighlightingRaw(BaseModel):
+    r"""Article content used for highlighting a keyword search result"""
+
+    article_content: Annotated[
+        Optional[List[str]], pydantic.Field(alias="articleContent")
+    ] = None
+
+
+ArticleAISearchResultTypeName = Literal[
+    "General",
+    "Guided Help",
+    "Data Link",
+    "Topic Home",
+    "Suggestion",
+    "Virtaul Assistant Action",
+    "Rich Message",
+]
+r"""Indicates the article category name."""
+
+
+class ArticleTypeAttributesTypedDict(TypedDict):
+    r"""The type of the Article."""
+
+    type_name: NotRequired[ArticleAISearchResultTypeName]
+    r"""Indicates the article category name."""
+
+
+class ArticleTypeAttributes(BaseModel):
+    r"""The type of the Article."""
+
+    type_name: Annotated[
+        Optional[ArticleAISearchResultTypeName], pydantic.Field(alias="typeName")
+    ] = None
+    r"""Indicates the article category name."""
+
+
+class ArticleAISearchResultLinkTypedDict(TypedDict):
+    r"""Defines the relationship between this resource and another object."""
+
+    rel: NotRequired[str]
+    r"""Defines the relationship between a linked resource and the current object. <br><br> For example: self, prev, next or an object name such as 'user', 'folder' etc."""
+    href: NotRequired[str]
+    r"""The URL that specifies the link's destination."""
+
+
+class ArticleAISearchResultLink(BaseModel):
+    r"""Defines the relationship between this resource and another object."""
+
+    rel: Optional[str] = None
+    r"""Defines the relationship between a linked resource and the current object. <br><br> For example: self, prev, next or an object name such as 'user', 'folder' etc."""
+
+    href: Optional[str] = None
+    r"""The URL that specifies the link's destination."""
+
+
+class ArticleAISearchResultTypedDict(TypedDict):
+    r"""Represents a single document or snippet returned by search, along with its metadata and relevance score."""
+
+    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."""
+    name: str
+    r"""The name of the Article or source content."""
+    doc_type: ArticleAISearchResultDocType
+    r"""Format of the source document (HTML, Doc, or PDF)."""
+    source: ArticleAISearchResultSource
+    r"""The source type."""
+    snippet: str
+    r"""A snippet of the article content."""
+    topic_breadcrumb: List[TopicBreadcrumbTypedDict]
+    r"""A list of topics from the root topic to this Article. There may be multiple paths."""
+    relevance_score: float
+    r"""Generated confidence score (0.0-1.0) for the snippet's relevance to the query."""
+    doc_name: NotRequired[str]
+    r"""Name of the attachment, if an attachment was used as the source content."""
+    custom_attributes: NotRequired[List[ArticleAISearchResultCustomAttributeTypedDict]]
+    r"""Custom attributes assigned to an article"""
+    keyword_snippet: NotRequired[str]
+    r"""A keyword search snippet of article content."""
+    additional_snippets: NotRequired[List[AdditionalSnippetsTypedDict]]
+    r"""An array of snippets belonging to the same article."""
+    additional_snippet_count: NotRequired[int]
+    r"""Number of additional snippets."""
+    opensearch_highlighting_raw: NotRequired[OpensearchHighlightingRawTypedDict]
+    r"""Article content used for highlighting a keyword search result"""
+    contextual_summary: NotRequired[str]
+    r"""Contextual Summary generated as part of metadata for embedding."""
+    description: NotRequired[str]
+    r"""A description of the Article. The maximum allowed Article description size is 1 KB."""
+    summary: NotRequired[str]
+    r"""A brief summary of the Article, provided as metadata. 1 KB max size limit."""
+    last_modified_date: NotRequired[str]
+    r"""The date on which the Article was last modified."""
+    header_path: NotRequired[str]
+    r"""The header path of the snippet retrieved."""
+    tag_categories: NotRequired[List[SchemasTagsTypedDict]]
+    r"""An array of tag categories. Note that the total number of tag categories cannot exceed 20."""
+    keywords: NotRequired[str]
+    article_type_attributes: NotRequired[ArticleTypeAttributesTypedDict]
+    r"""The type of the Article."""
+    link: NotRequired[ArticleAISearchResultLinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class ArticleAISearchResult(BaseModel):
+    r"""Represents a single document or snippet returned by search, along with its metadata and relevance score."""
+
+    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."""
+
+    name: str
+    r"""The name of the Article or source content."""
+
+    doc_type: Annotated[ArticleAISearchResultDocType, pydantic.Field(alias="docType")]
+    r"""Format of the source document (HTML, Doc, or PDF)."""
+
+    source: ArticleAISearchResultSource
+    r"""The source type."""
+
+    snippet: str
+    r"""A snippet of the article content."""
+
+    topic_breadcrumb: Annotated[
+        List[TopicBreadcrumb], pydantic.Field(alias="topicBreadcrumb")
+    ]
+    r"""A list of topics from the root topic to this Article. There may be multiple paths."""
+
+    relevance_score: Annotated[float, pydantic.Field(alias="relevanceScore")]
+    r"""Generated confidence score (0.0-1.0) for the snippet's relevance to the query."""
+
+    doc_name: Annotated[Optional[str], pydantic.Field(alias="docName")] = None
+    r"""Name of the attachment, if an attachment was used as the source content."""
+
+    custom_attributes: Annotated[
+        Optional[List[ArticleAISearchResultCustomAttribute]],
+        pydantic.Field(alias="customAttributes"),
+    ] = None
+    r"""Custom attributes assigned to an article"""
+
+    keyword_snippet: Annotated[
+        Optional[str], pydantic.Field(alias="keywordSnippet")
+    ] = None
+    r"""A keyword search snippet of article content."""
+
+    additional_snippets: Annotated[
+        Optional[List[AdditionalSnippets]], pydantic.Field(alias="additionalSnippets")
+    ] = None
+    r"""An array of snippets belonging to the same article."""
+
+    additional_snippet_count: Annotated[
+        Optional[int], pydantic.Field(alias="additionalSnippetCount")
+    ] = None
+    r"""Number of additional snippets."""
+
+    opensearch_highlighting_raw: Annotated[
+        Optional[OpensearchHighlightingRaw],
+        pydantic.Field(alias="opensearchHighlightingRaw"),
+    ] = None
+    r"""Article content used for highlighting a keyword search result"""
+
+    contextual_summary: Annotated[
+        Optional[str], pydantic.Field(alias="contextualSummary")
+    ] = None
+    r"""Contextual Summary generated as part of metadata for embedding."""
+
+    description: Optional[str] = None
+    r"""A description of the Article. The maximum allowed Article description size is 1 KB."""
+
+    summary: Optional[str] = None
+    r"""A brief summary of the Article, provided as metadata. 1 KB max size limit."""
+
+    last_modified_date: Annotated[
+        Optional[str], pydantic.Field(alias="lastModifiedDate")
+    ] = None
+    r"""The date on which the Article was last modified."""
+
+    header_path: Annotated[Optional[str], pydantic.Field(alias="headerPath")] = None
+    r"""The header path of the snippet retrieved."""
+
+    tag_categories: Annotated[
+        Optional[List[SchemasTags]], pydantic.Field(alias="tagCategories")
+    ] = None
+    r"""An array of tag categories. Note that the total number of tag categories cannot exceed 20."""
+
+    keywords: Optional[str] = None
+
+    article_type_attributes: Annotated[
+        Optional[ArticleTypeAttributes], pydantic.Field(alias="articleTypeAttributes")
+    ] = None
+    r"""The type of the Article."""
+
+    link: Optional[ArticleAISearchResultLink] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/articleattachment.py

@@ -0,0 +1,44 @@
+"""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 Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+ArticleAttachmentType = Literal[
+    "INTERNAL",
+    "EXTERNAL",
+]
+r"""The type of attachment."""
+
+
+class ArticleAttachmentTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The ID of the attachment."""
+    name: NotRequired[str]
+    r"""The name of the attachment."""
+    size: NotRequired[int]
+    r"""The size of the attachment in bytes. The maximum size is limited to 25MB."""
+    type: NotRequired[ArticleAttachmentType]
+    r"""The type of attachment."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class ArticleAttachment(BaseModel):
+    id: Optional[str] = None
+    r"""The ID of the attachment."""
+
+    name: Optional[str] = None
+    r"""The name of the attachment."""
+
+    size: Optional[int] = None
+    r"""The size of the attachment in bytes. The maximum size is limited to 25MB."""
+
+    type: Optional[ArticleAttachmentType] = None
+    r"""The type of attachment."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/articlelist.py

@@ -0,0 +1,48 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articleresult import ArticleResult, ArticleResultTypedDict
+from .link import Link, LinkTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ArticleListTypedDict(TypedDict):
+    r"""Success"""
+
+    name: str
+    r"""The name of the article list."""
+    id: str
+    r"""The ID of the article list.<br><br>An article list ID is either a 4-digit number or composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    description: NotRequired[str]
+    r"""The description of the article list. The maximum allowed article list description size is 1 KB."""
+    type_id: NotRequired[str]
+    r"""The type of the article list."""
+    articles: NotRequired[List[ArticleResultTypedDict]]
+    r"""An array of articles that belong to the article list."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class ArticleList(BaseModel):
+    r"""Success"""
+
+    name: str
+    r"""The name of the article list."""
+
+    id: str
+    r"""The ID of the article list.<br><br>An article list ID is either a 4-digit number or composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    description: Optional[str] = None
+    r"""The description of the article list. The maximum allowed article list description size is 1 KB."""
+
+    type_id: Annotated[Optional[str], pydantic.Field(alias="typeId")] = None
+    r"""The type of the article list."""
+
+    articles: Optional[List[ArticleResult]] = None
+    r"""An array of articles that belong to the article list."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/articlelistresult.py

@@ -0,0 +1,38 @@
+"""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 ArticleListResultTypedDict(TypedDict):
+    name: str
+    r"""The name of the article list."""
+    id: str
+    r"""The ID of the article list.<br><br>An article list ID is either a 4-digit number or composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    description: NotRequired[str]
+    r"""The description of the article list. The maximum allowed article list description size is 1 KB."""
+    type_id: NotRequired[str]
+    r"""The type of the article list."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class ArticleListResult(BaseModel):
+    name: str
+    r"""The name of the article list."""
+
+    id: str
+    r"""The ID of the article list.<br><br>An article list ID is either a 4-digit number or composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    description: Optional[str] = None
+    r"""The description of the article list. The maximum allowed article list description size is 1 KB."""
+
+    type_id: Annotated[Optional[str], pydantic.Field(alias="typeId")] = None
+    r"""The type of the article list."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/articlelistsresult.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articlelistresult import ArticleListResult, ArticleListResultTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ArticleListsResultTypedDict(TypedDict):
+    r"""Instances of Artice List"""
+
+    article_lists: NotRequired[List[ArticleListResultTypedDict]]
+
+
+class ArticleListsResult(BaseModel):
+    r"""Instances of Artice List"""
+
+    article_lists: Annotated[
+        Optional[List[ArticleListResult]], pydantic.Field(alias="articleLists")
+    ] = None

egain_api_python/models/articlepermissions.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 ArticlePermissionsTypedDict(TypedDict):
+    r"""User permissions on the parent folder."""
+
+    view: NotRequired[bool]
+    r"""User has 'View Folder' permission on the parent folder."""
+    edit: NotRequired[bool]
+    r"""User has 'Edit Article' permission on the parent folder."""
+
+
+class ArticlePermissions(BaseModel):
+    r"""User permissions on the parent folder."""
+
+    view: Optional[bool] = None
+    r"""User has 'View Folder' permission on the parent folder."""
+
+    edit: Optional[bool] = None
+    r"""User has 'Edit Article' permission on the parent folder."""

egain_api_python/models/articlepermissionsresult.py

@@ -0,0 +1,27 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articlepermissions import ArticlePermissions, ArticlePermissionsTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ArticlePermissionsResultTypedDict(TypedDict):
+    r"""User permissions on the parent folder."""
+
+    article_id: NotRequired[str]
+    r"""ID of Article"""
+    permissions: NotRequired[ArticlePermissionsTypedDict]
+    r"""User permissions on the parent folder."""
+
+
+class ArticlePermissionsResult(BaseModel):
+    r"""User permissions on the parent folder."""
+
+    article_id: Annotated[Optional[str], pydantic.Field(alias="articleID")] = None
+    r"""ID of Article"""
+
+    permissions: Optional[ArticlePermissions] = None
+    r"""User permissions on the parent folder."""

egain_api_python/models/articlerating.py

@@ -0,0 +1,51 @@
+"""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 ArticleRatingTypedDict(TypedDict):
+    r"""This schema contains general information about the article rating."""
+
+    id: NotRequired[str]
+    r"""The ID of the rating."""
+    article_id: NotRequired[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."""
+    rating_value: NotRequired[int]
+    r"""The score value of the rating. This must be a value between 0 and 100."""
+    rating_comments: NotRequired[str]
+    r"""Comments about the rating."""
+    user_id: NotRequired[str]
+    r"""The ID of the user that rated the article."""
+    rating_timestamp: NotRequired[datetime]
+    r"""The timestamp for when the article was rated."""
+
+
+class ArticleRating(BaseModel):
+    r"""This schema contains general information about the article rating."""
+
+    id: Optional[str] = None
+    r"""The ID of the rating."""
+
+    article_id: Annotated[Optional[str], pydantic.Field(alias="articleId")] = None
+    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."""
+
+    rating_value: Annotated[Optional[int], pydantic.Field(alias="ratingValue")] = None
+    r"""The score value of the rating. This must be a value between 0 and 100."""
+
+    rating_comments: Annotated[
+        Optional[str], pydantic.Field(alias="ratingComments")
+    ] = None
+    r"""Comments about the rating."""
+
+    user_id: Annotated[Optional[str], pydantic.Field(alias="userId")] = None
+    r"""The ID of the user that rated the article."""
+
+    rating_timestamp: Annotated[
+        Optional[datetime], pydantic.Field(alias="ratingTimestamp")
+    ] = None
+    r"""The timestamp for when the article was rated."""

egain_api_python/models/articleratingsresponse.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articlerating import ArticleRating, ArticleRatingTypedDict
+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 ArticleRatingsResponseTypedDict(TypedDict):
+    r"""Success"""
+
+    article_ratings: NotRequired[List[ArticleRatingTypedDict]]
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class ArticleRatingsResponse(BaseModel):
+    r"""Success"""
+
+    article_ratings: Annotated[
+        Optional[List[ArticleRating]], pydantic.Field(alias="articleRatings")
+    ] = None
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None