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

egain_api_python/models/topic.py

@@ -0,0 +1,113 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .createdby import CreatedBy, CreatedByTypedDict
+from .customattribute import CustomAttribute, CustomAttributeTypedDict
+from .link import Link, LinkTypedDict
+from .modifiedby import ModifiedBy, ModifiedByTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Any, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class TopicTypedDict(TypedDict):
+    r"""This schema contains general information about the topic."""
+
+    id: str
+    r"""The alphanumeric ID of the topic.<br><br>A topic ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits."""
+    name: Any
+    r"""The name of the topic."""
+    description: NotRequired[str]
+    r"""A description of the topic."""
+    article_count_in_topic: NotRequired[int]
+    r"""Number of articles in this topic."""
+    article_count_in_topic_tree: NotRequired[int]
+    r"""Number of articles in this topic and all sub-topics."""
+    created_by: NotRequired[CreatedByTypedDict]
+    created_date: NotRequired[str]
+    department_id: NotRequired[str]
+    r"""ID of the topic's department."""
+    image_url: NotRequired[str]
+    r"""The URL of an image to be associated with the topic."""
+    modified_by: NotRequired[ModifiedByTypedDict]
+    modified_date: NotRequired[str]
+    r"""The date on which the topic was last modified."""
+    child_count: NotRequired[int]
+    r"""Number of sub-topics below this topic."""
+    sub_topic_ids: NotRequired[List[str]]
+    r"""Array with the list of sub-topics. <br><br>Valid IDs are composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    parent_topic_id: NotRequired[str]
+    r"""ID of the parent topic. -1 if it is the root topic. <br><br>Valid IDs are composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    custom_attributes: NotRequired[List[CustomAttributeTypedDict]]
+    r"""Custom attributes for the Topic."""
+    topic_home_article_id: NotRequired[str]
+    r"""The ID of the article used as the home page of this topic. <br><br>Valid IDs are composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class Topic(BaseModel):
+    r"""This schema contains general information about the topic."""
+
+    id: str
+    r"""The alphanumeric ID of the topic.<br><br>A topic ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits."""
+
+    name: Any
+    r"""The name of the topic."""
+
+    description: Optional[str] = None
+    r"""A description of the topic."""
+
+    article_count_in_topic: Annotated[
+        Optional[int], pydantic.Field(alias="articleCountInTopic")
+    ] = None
+    r"""Number of articles in this topic."""
+
+    article_count_in_topic_tree: Annotated[
+        Optional[int], pydantic.Field(alias="articleCountInTopicTree")
+    ] = None
+    r"""Number of articles in this topic and all sub-topics."""
+
+    created_by: Annotated[Optional[CreatedBy], pydantic.Field(alias="createdBy")] = None
+
+    created_date: Annotated[Optional[str], pydantic.Field(alias="createdDate")] = None
+
+    department_id: Annotated[Optional[str], pydantic.Field(alias="departmentId")] = None
+    r"""ID of the topic's department."""
+
+    image_url: Annotated[Optional[str], pydantic.Field(alias="imageUrl")] = None
+    r"""The URL of an image to be associated with the topic."""
+
+    modified_by: Annotated[Optional[ModifiedBy], pydantic.Field(alias="modifiedBy")] = (
+        None
+    )
+
+    modified_date: Annotated[Optional[str], pydantic.Field(alias="modifiedDate")] = None
+    r"""The date on which the topic was last modified."""
+
+    child_count: Annotated[Optional[int], pydantic.Field(alias="childCount")] = None
+    r"""Number of sub-topics below this topic."""
+
+    sub_topic_ids: Annotated[
+        Optional[List[str]], pydantic.Field(alias="subTopicIds")
+    ] = None
+    r"""Array with the list of sub-topics. <br><br>Valid IDs are composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    parent_topic_id: Annotated[Optional[str], pydantic.Field(alias="parentTopicId")] = (
+        None
+    )
+    r"""ID of the parent topic. -1 if it is the root topic. <br><br>Valid IDs are composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    custom_attributes: Annotated[
+        Optional[List[CustomAttribute]], pydantic.Field(alias="customAttributes")
+    ] = None
+    r"""Custom attributes for the Topic."""
+
+    topic_home_article_id: Annotated[
+        Optional[str], pydantic.Field(alias="topicHomeArticleId")
+    ] = None
+    r"""The ID of the article used as the home page of this topic. <br><br>Valid IDs are composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/topicadditionalattributes.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+TopicAdditionalAttributes = Literal[
+    "description",
+    "createdBy.userName",
+    "createdBy.firstName",
+    "createdBy.lastName",
+    "createdBy.middleName",
+    "modifiedBy.userName",
+    "modifiedBy.firstName",
+    "modifiedBy.lastName",
+    "modifiedBy.middleName",
+    "imageUrl",
+    "textMetaData",
+    "all",
+]

egain_api_python/models/topicaisearchresult.py

@@ -0,0 +1,67 @@
+"""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 TopicAISearchResultTypedDict(TypedDict):
+    r"""This schema contains general information about the topic."""
+
+    name: str
+    r"""Name of Topic."""
+    id: str
+    article_count_in_topic: NotRequired[int]
+    r"""Number of articles within the topic."""
+    article_count_in_topic_tree: NotRequired[int]
+    r"""Number of articles in this topic and all sub-topics."""
+    created_by: NotRequired[int]
+    r"""The ID of the user that created this resource."""
+    created_date: NotRequired[datetime]
+    department_id: NotRequired[str]
+    last_modified_by: NotRequired[int]
+    r"""The ID of the user that modified this resource."""
+    last_modified_date: NotRequired[datetime]
+    child_count: NotRequired[int]
+
+
+class TopicAISearchResult(BaseModel):
+    r"""This schema contains general information about the topic."""
+
+    name: str
+    r"""Name of Topic."""
+
+    id: str
+
+    article_count_in_topic: Annotated[
+        Optional[int], pydantic.Field(alias="articleCountInTopic")
+    ] = None
+    r"""Number of articles within the topic."""
+
+    article_count_in_topic_tree: Annotated[
+        Optional[int], pydantic.Field(alias="articleCountInTopicTree")
+    ] = None
+    r"""Number of articles in this topic and all sub-topics."""
+
+    created_by: Annotated[Optional[int], pydantic.Field(alias="createdBy")] = None
+    r"""The ID of the user that created this resource."""
+
+    created_date: Annotated[Optional[datetime], pydantic.Field(alias="createdDate")] = (
+        None
+    )
+
+    department_id: Annotated[Optional[str], pydantic.Field(alias="departmentId")] = None
+
+    last_modified_by: Annotated[
+        Optional[int], pydantic.Field(alias="lastModifiedBy")
+    ] = None
+    r"""The ID of the user that modified this resource."""
+
+    last_modified_date: Annotated[
+        Optional[datetime], pydantic.Field(alias="lastModifiedDate")
+    ] = None
+
+    child_count: Annotated[Optional[int], pydantic.Field(alias="childCount")] = None

egain_api_python/models/topicbreadcrumb.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .topicsummary import TopicSummary, TopicSummaryTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class TopicBreadcrumbTypedDict(TypedDict):
+    r"""This schema contains one or more TopicSummary instances."""
+
+    topic_summary: NotRequired[List[TopicSummaryTypedDict]]
+    r"""An instance of TopicSummary."""
+
+
+class TopicBreadcrumb(BaseModel):
+    r"""This schema contains one or more TopicSummary instances."""
+
+    topic_summary: Annotated[
+        Optional[List[TopicSummary]], pydantic.Field(alias="topicSummary")
+    ] = None
+    r"""An instance of TopicSummary."""

egain_api_python/models/topicresult.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
+from .topic import Topic, TopicTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class TopicResultTypedDict(TypedDict):
+    r"""A TopicResult defines a response from any of the Topic APIs."""
+
+    topic: NotRequired[List[TopicTypedDict]]
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class TopicResult(BaseModel):
+    r"""A TopicResult defines a response from any of the Topic APIs."""
+
+    topic: Optional[List[Topic]] = None
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/topicsummary.py

@@ -0,0 +1,31 @@
+"""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 TopicSummaryTypedDict(TypedDict):
+    r"""This schema contains the topic ID and name of the topics. This is used by TopicBreadcrumb."""
+
+    id: NotRequired[str]
+    r"""The alphanumeric ID of the topic.<br><br>A topic 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 topic."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class TopicSummary(BaseModel):
+    r"""This schema contains the topic ID and name of the topics. This is used by TopicBreadcrumb."""
+
+    id: Optional[str] = None
+    r"""The alphanumeric ID of the topic.<br><br>A topic 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 topic."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/topictreenode.py

@@ -0,0 +1,27 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .topic import Topic, TopicTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class TopicTreeNodeTypedDict(TypedDict):
+    r"""This schema contains general information about the TopicTree."""
+
+    topic: NotRequired[TopicTypedDict]
+    r"""This schema contains general information about the topic."""
+    topic_tree: NotRequired[List[TopicTreeNodeTypedDict]]
+
+
+class TopicTreeNode(BaseModel):
+    r"""This schema contains general information about the TopicTree."""
+
+    topic: Optional[Topic] = None
+    r"""This schema contains general information about the topic."""
+
+    topic_tree: Annotated[
+        Optional[List[TopicTreeNode]], pydantic.Field(alias="topicTree")
+    ] = None

egain_api_python/models/topictreeresult.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
+from .topictreenode import TopicTreeNode, TopicTreeNodeTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class TopicTreeResultTypedDict(TypedDict):
+    r"""This schema contains the result of topic tree"""
+
+    topic_tree: NotRequired[List[TopicTreeNodeTypedDict]]
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class TopicTreeResult(BaseModel):
+    r"""This schema contains the result of topic tree"""
+
+    topic_tree: Annotated[
+        Optional[List[TopicTreeNode]], pydantic.Field(alias="topicTree")
+    ] = None
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/unsubscribearticleop.py

@@ -0,0 +1,55 @@
+"""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,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UnsubscribeArticleRequestTypedDict(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."""
+    unsubscription_token: NotRequired[str]
+    r"""An encrypted token that contains information about \"object/userId/userType/userProfileId\". This is used to unsubscribe the user from Article change notifications sent via email, without necessitating that the user be logged into the eGain application."""
+
+
+class UnsubscribeArticleRequest(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."""
+
+    unsubscription_token: Annotated[
+        Optional[str],
+        pydantic.Field(alias="unsubscriptionToken"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""An encrypted token that contains information about \"object/userId/userType/userProfileId\". This is used to unsubscribe the user from Article change notifications sent via email, without necessitating that the user be logged into the eGain application."""

egain_api_python/models/uploadattachmentop.py

@@ -0,0 +1,36 @@
+"""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, QueryParamMetadata
+import io
+import pydantic
+from typing import IO, Union
+from typing_extensions import Annotated, TypedDict
+
+
+class UploadAttachmentRequestTypedDict(TypedDict):
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+    signature: str
+    r"""Signature data to upload attachment."""
+    request_body: Union[bytes, IO[bytes], io.BufferedReader]
+
+
+class UploadAttachmentRequest(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)."""
+
+    signature: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Signature data to upload attachment."""
+
+    request_body: Annotated[
+        Union[bytes, IO[bytes], io.BufferedReader], FieldMetadata(request=True)
+    ]

egain_api_python/models/userdetails.py

@@ -0,0 +1,44 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .role import Role, RoleTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UserDetailsTypedDict(TypedDict):
+    r"""Success"""
+
+    id: NotRequired[str]
+    r"""The numerical ID of the User"""
+    roles: NotRequired[List[RoleTypedDict]]
+    r"""Roles of the User"""
+    first_name: NotRequired[str]
+    r"""First Name of the User"""
+    last_name: NotRequired[str]
+    r"""Last Name of the User"""
+    has_email_configured: NotRequired[bool]
+    r"""Indicates if user has email"""
+
+
+class UserDetails(BaseModel):
+    r"""Success"""
+
+    id: Optional[str] = None
+    r"""The numerical ID of the User"""
+
+    roles: Optional[List[Role]] = None
+    r"""Roles of the User"""
+
+    first_name: Annotated[Optional[str], pydantic.Field(alias="firstName")] = None
+    r"""First Name of the User"""
+
+    last_name: Annotated[Optional[str], pydantic.Field(alias="lastName")] = None
+    r"""Last Name of the User"""
+
+    has_email_configured: Annotated[
+        Optional[bool], pydantic.Field(alias="hasEmailConfigured")
+    ] = None
+    r"""Indicates if user has email"""

egain_api_python/models/userprofile.py

@@ -0,0 +1,33 @@
+"""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 UserProfileTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The Readable ID of the user profile.<br>
+
+    """
+    name: NotRequired[str]
+    r"""Name given to the user profile"""
+    is_last_used_in_portal: NotRequired[bool]
+    r"""Indicates if the profile was the last one used by the current user in the portal."""
+
+
+class UserProfile(BaseModel):
+    id: Optional[str] = None
+    r"""The Readable ID of the user profile.<br>
+
+    """
+
+    name: Optional[str] = None
+    r"""Name given to the user profile"""
+
+    is_last_used_in_portal: Annotated[
+        Optional[bool], pydantic.Field(alias="isLastUsedInPortal")
+    ] = None
+    r"""Indicates if the profile was the last one used by the current user in the portal."""

egain_api_python/models/userprofiles.py

@@ -0,0 +1,21 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .userprofile import UserProfile, UserProfileTypedDict
+from egain_api_python.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class UserProfilesTypedDict(TypedDict):
+    r"""Success"""
+
+    profile: NotRequired[List[UserProfileTypedDict]]
+    r"""User profiles assigend to user."""
+
+
+class UserProfiles(BaseModel):
+    r"""Success"""
+
+    profile: Optional[List[UserProfile]] = None
+    r"""User profiles assigend to user."""

egain_api_python/models/userview.py

@@ -0,0 +1,33 @@
+"""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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UserViewTypedDict(TypedDict):
+    link: NotRequired[List[LinkTypedDict]]
+    r"""The link to the user."""
+    first_name: NotRequired[str]
+    r"""The first name of the user."""
+    last_name: NotRequired[str]
+    r"""The last name of the user."""
+    id: NotRequired[str]
+    r"""The ID of the user."""
+
+
+class UserView(BaseModel):
+    link: Optional[List[Link]] = None
+    r"""The link to the user."""
+
+    first_name: Annotated[Optional[str], pydantic.Field(alias="firstName")] = None
+    r"""The first name of the user."""
+
+    last_name: Annotated[Optional[str], pydantic.Field(alias="lastName")] = None
+    r"""The last name of the user."""
+
+    id: Optional[str] = None
+    r"""The ID of the user."""

egain_api_python/models/validateimportcontent.py

@@ -0,0 +1,58 @@
+"""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
+
+
+ValidateImportContentType = Literal[
+    "AWS S3 bucket",
+    "Shared file path",
+]
+r"""Type of data source"""
+
+
+class ValidateImportContentCredentialsTypedDict(TypedDict):
+    access_key: NotRequired[str]
+    secret_key: NotRequired[str]
+
+
+class ValidateImportContentCredentials(BaseModel):
+    access_key: Annotated[Optional[str], pydantic.Field(alias="accessKey")] = None
+
+    secret_key: Annotated[Optional[str], pydantic.Field(alias="secretKey")] = None
+
+
+class ValidateImportContentDataSourceTypedDict(TypedDict):
+    type: ValidateImportContentType
+    r"""Type of data source"""
+    path: str
+    r"""Path of the data source"""
+    region: NotRequired[str]
+    r"""Region of the data source"""
+    credentials: NotRequired[ValidateImportContentCredentialsTypedDict]
+
+
+class ValidateImportContentDataSource(BaseModel):
+    type: ValidateImportContentType
+    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[ValidateImportContentCredentials] = None
+
+
+class ValidateImportContentTypedDict(TypedDict):
+    data_source: ValidateImportContentDataSourceTypedDict
+
+
+class ValidateImportContent(BaseModel):
+    data_source: Annotated[
+        ValidateImportContentDataSource, pydantic.Field(alias="dataSource")
+    ]