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

egain_api_python/models/acceptghsolutionop.py

@@ -0,0 +1,52 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .quickpickrating import QuickpickRating, QuickpickRatingTypedDict
+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 AcceptGHSolutionRequestTypedDict(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."""
+    case_id: str
+    r"""The numerical ID of the Case for which details is to be fetched."""
+    quickpick_rating: QuickpickRatingTypedDict
+
+
+class AcceptGHSolutionRequest(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."""
+
+    case_id: Annotated[
+        str,
+        pydantic.Field(alias="caseID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The numerical ID of the Case for which details is to be fetched."""
+
+    quickpick_rating: Annotated[
+        QuickpickRating,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]

egain_api_python/models/acceptlanguage.py

@@ -0,0 +1,23 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+AcceptLanguage = Literal[
+    "en-US",
+    "es-ES",
+    "fr-FR",
+    "it-IT",
+    "de-DE",
+    "nl-NL",
+    "pt-BR",
+    "pt-PT",
+    "da-DK",
+    "ru-RU",
+    "fr-CA",
+    "zh-CN",
+    "ja-JP",
+    "ko-KR",
+    "sv-SE",
+]

egain_api_python/models/accessibleportal.py

@@ -0,0 +1,37 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .department import Department, DepartmentTypedDict
+from .shorturl import ShortURL, ShortURLTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AccessiblePortalTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""ID of portal. <br>A Portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    name: NotRequired[str]
+    r"""Name of portal"""
+    description: NotRequired[str]
+    r"""Description of portal"""
+    department: NotRequired[DepartmentTypedDict]
+    short_url: NotRequired[List[ShortURLTypedDict]]
+
+
+class AccessiblePortal(BaseModel):
+    id: Optional[str] = None
+    r"""ID of portal. <br>A Portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    name: Optional[str] = None
+    r"""Name of portal"""
+
+    description: Optional[str] = None
+    r"""Description of portal"""
+
+    department: Optional[Department] = None
+
+    short_url: Annotated[Optional[List[ShortURL]], pydantic.Field(alias="shortURL")] = (
+        None
+    )

egain_api_python/models/action.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articletype import ArticleType, ArticleTypeTypedDict
+from .metadata import Metadata, MetadataTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ActionTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""ID of the action"""
+    title: NotRequired[str]
+    r"""Name of the action"""
+    type: NotRequired[str]
+    r"""type of the action"""
+    short_name: NotRequired[str]
+    r"""short name of the action"""
+    reject_count: NotRequired[int]
+    r"""number of times action was rejected."""
+    accept_count: NotRequired[int]
+    r"""number of times action was accepted."""
+    metadata: NotRequired[List[MetadataTypedDict]]
+    r"""Metadata of action"""
+    article_type: NotRequired[ArticleTypeTypedDict]
+    r"""The type of the Article and its attributes."""
+
+
+class Action(BaseModel):
+    id: Optional[str] = None
+    r"""ID of the action"""
+
+    title: Optional[str] = None
+    r"""Name of the action"""
+
+    type: Optional[str] = None
+    r"""type of the action"""
+
+    short_name: Annotated[Optional[str], pydantic.Field(alias="shortName")] = None
+    r"""short name of the action"""
+
+    reject_count: Annotated[Optional[int], pydantic.Field(alias="rejectCount")] = None
+    r"""number of times action was rejected."""
+
+    accept_count: Annotated[Optional[int], pydantic.Field(alias="acceptCount")] = None
+    r"""number of times action was accepted."""
+
+    metadata: Optional[List[Metadata]] = None
+    r"""Metadata of action"""
+
+    article_type: Annotated[
+        Optional[ArticleType], pydantic.Field(alias="articleType")
+    ] = None
+    r"""The type of the Article and its attributes."""

egain_api_python/models/actionsearch.py

@@ -0,0 +1,92 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articletype import ArticleType, ArticleTypeTypedDict
+from .metadata import Metadata, MetadataTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+ActionSearchType = Literal[
+    "control",
+    "article",
+]
+r"""type of the action"""
+
+
+class ActionSearchTypedDict(TypedDict):
+    accept_count: NotRequired[int]
+    r"""number of times action was accepted"""
+    has_additional_info: NotRequired[bool]
+    r"""indicates if action has additional information"""
+    metadata: NotRequired[List[MetadataTypedDict]]
+    r"""Metadata in action search."""
+    article_id: NotRequired[str]
+    r"""The ID of the Article .<br>The ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    case_id: NotRequired[str]
+    r"""The numerical ID of the case."""
+    passed_threshold_value: NotRequired[bool]
+    r"""indicates if the case has passed the threshold value"""
+    reject_count: NotRequired[int]
+    r"""The number of times action was rejected"""
+    short_name: NotRequired[str]
+    r"""short name"""
+    score: NotRequired[int]
+    r"""score of the case"""
+    name: NotRequired[str]
+    r"""name of the case"""
+    action_id: NotRequired[str]
+    r"""The ID of the Action."""
+    type: NotRequired[ActionSearchType]
+    r"""type of the action"""
+    article_type: NotRequired[ArticleTypeTypedDict]
+    r"""The type of the Article and its attributes."""
+
+
+class ActionSearch(BaseModel):
+    accept_count: Annotated[Optional[int], pydantic.Field(alias="acceptCount")] = None
+    r"""number of times action was accepted"""
+
+    has_additional_info: Annotated[
+        Optional[bool], pydantic.Field(alias="hasAdditionalInfo")
+    ] = None
+    r"""indicates if action has additional information"""
+
+    metadata: Optional[List[Metadata]] = None
+    r"""Metadata in action search."""
+
+    article_id: Annotated[Optional[str], pydantic.Field(alias="articleId")] = None
+    r"""The ID of the Article .<br>The ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    case_id: Annotated[Optional[str], pydantic.Field(alias="caseId")] = None
+    r"""The numerical ID of the case."""
+
+    passed_threshold_value: Annotated[
+        Optional[bool], pydantic.Field(alias="passedThresholdValue")
+    ] = None
+    r"""indicates if the case has passed the threshold value"""
+
+    reject_count: Annotated[Optional[int], pydantic.Field(alias="rejectCount")] = None
+    r"""The number of times action was rejected"""
+
+    short_name: Annotated[Optional[str], pydantic.Field(alias="shortName")] = None
+    r"""short name"""
+
+    score: Optional[int] = None
+    r"""score of the case"""
+
+    name: Optional[str] = None
+    r"""name of the case"""
+
+    action_id: Annotated[Optional[str], pydantic.Field(alias="actionId")] = None
+    r"""The ID of the Action."""
+
+    type: Optional[ActionSearchType] = None
+    r"""type of the action"""
+
+    article_type: Annotated[
+        Optional[ArticleType], pydantic.Field(alias="articleType")
+    ] = None
+    r"""The type of the Article and its attributes."""

egain_api_python/models/addasreferenceop.py

@@ -0,0 +1,52 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .articleactivitylink import ArticleActivityLink, ArticleActivityLinkTypedDict
+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 AddAsReferenceRequestTypedDict(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."""
+    article_activity_link: ArticleActivityLinkTypedDict
+
+
+class AddAsReferenceRequest(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."""
+
+    article_activity_link: Annotated[
+        ArticleActivityLink,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]

egain_api_python/models/addbookmarkop.py

@@ -0,0 +1,43 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .createbookmark import CreateBookmark, CreateBookmarkTypedDict
+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 AddbookmarkRequestTypedDict(TypedDict):
+    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."""
+    accept_language: AcceptLanguage
+    r"""The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses)."""
+    create_bookmark: CreateBookmarkTypedDict
+
+
+class AddbookmarkRequest(BaseModel):
+    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."""
+
+    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)."""
+
+    create_bookmark: Annotated[
+        CreateBookmark,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]

egain_api_python/models/additionalsnippets.py

@@ -0,0 +1,57 @@
+"""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
+
+
+AdditionalSnippetsDocType = Literal[
+    "HTML",
+    "Doc",
+    "Pdf",
+]
+r"""Format of the source document (HTML, Doc, or PDF)."""
+
+
+class AdditionalSnippetsTypedDict(TypedDict):
+    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: AdditionalSnippetsDocType
+    r"""Format of the source document (HTML, Doc, or PDF)."""
+    doc_name: str
+    r"""Name of the attachment, if an attachment was used as the source content."""
+    snippet: str
+    r"""A snippet of the article content."""
+    relevance_score: float
+    r"""Generated confidence score (0.0-1.0) for the snippet's relevance to the query."""
+    keyword_snippet: NotRequired[str]
+    r"""A keyword snippet of the article content."""
+
+
+class AdditionalSnippets(BaseModel):
+    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[AdditionalSnippetsDocType, pydantic.Field(alias="docType")]
+    r"""Format of the source document (HTML, Doc, or PDF)."""
+
+    doc_name: Annotated[str, pydantic.Field(alias="docName")]
+    r"""Name of the attachment, if an attachment was used as the source content."""
+
+    snippet: str
+    r"""A snippet of the article content."""
+
+    relevance_score: Annotated[float, pydantic.Field(alias="relevanceScore")]
+    r"""Generated confidence score (0.0-1.0) for the snippet's relevance to the query."""
+
+    keyword_snippet: Annotated[
+        Optional[str], pydantic.Field(alias="keywordSnippet")
+    ] = None
+    r"""A keyword snippet of the article content."""

egain_api_python/models/addtoreplyop.py

@@ -0,0 +1,52 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .articleactivitylink import ArticleActivityLink, ArticleActivityLinkTypedDict
+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 AddToReplyRequestTypedDict(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."""
+    article_activity_link: ArticleActivityLinkTypedDict
+
+
+class AddToReplyRequest(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."""
+
+    article_activity_link: Annotated[
+        ArticleActivityLink,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]

egain_api_python/models/aisearchop.py

@@ -0,0 +1,131 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .languagecode_parameter import LanguageCodeParameter
+from .resourcetype_parameter import ResourceTypeParameter
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
+import pydantic
+from typing import Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AiSearchRequestTypedDict(TypedDict):
+    q: str
+    r"""The search query string. The string must be escaped as required by the URL syntax rules."""
+    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."""
+    dollar_filter_user_profile_id: NotRequired[str]
+    r"""The ID of the user profile.
+
+    """
+    language: NotRequired[LanguageCodeParameter]
+    r"""The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used."""
+    dollar_filter_tags: NotRequired[Dict[str, List[str]]]
+    r"""An object where each key is a **Category Tag ID** (numeric string),
+    and each value is an array of **Tag IDs** for that category.
+
+    """
+    dollar_filter_topic_ids: NotRequired[List[str]]
+    r"""An array of topic IDs. It is used to restrict search results to specific topics."""
+    dollar_filter_exclude_topic_ids: NotRequired[List[str]]
+    r"""An array of topic IDs that will be excluded from the search. It includes articles that belong to the topic."""
+    resource_type: NotRequired[ResourceTypeParameter]
+    r"""Type of resource to be fetched."""
+    article_custom_additional_attributes: NotRequired[str]
+    r"""One or more comma-separated names for article custom attributes defined by the user to be returned."""
+    topic_custom_additional_attributes: NotRequired[str]
+    r"""One or more comma-separated names for topic custom attributes defined by the user to be returned."""
+    pagenum: NotRequired[int]
+    r"""Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."""
+    pagesize: NotRequired[int]
+    r"""Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum."""
+
+
+class AiSearchRequest(BaseModel):
+    q: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""The search query string. The string must be escaped as required by the URL syntax rules."""
+
+    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."""
+
+    dollar_filter_user_profile_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="$filter[userProfileID]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The ID of the user profile.
+
+    """
+
+    language: Annotated[
+        Optional[LanguageCodeParameter],
+        pydantic.Field(alias="$lang"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used."""
+
+    dollar_filter_tags: Annotated[
+        Optional[Dict[str, List[str]]],
+        pydantic.Field(alias="$filter[tags]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""An object where each key is a **Category Tag ID** (numeric string),
+    and each value is an array of **Tag IDs** for that category.
+
+    """
+
+    dollar_filter_topic_ids: Annotated[
+        Optional[List[str]],
+        pydantic.Field(alias="$filter[topicIds]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""An array of topic IDs. It is used to restrict search results to specific topics."""
+
+    dollar_filter_exclude_topic_ids: Annotated[
+        Optional[List[str]],
+        pydantic.Field(alias="$filter[excludeTopicIds]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""An array of topic IDs that will be excluded from the search. It includes articles that belong to the topic."""
+
+    resource_type: Annotated[
+        Optional[ResourceTypeParameter],
+        pydantic.Field(alias="resourceType"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Type of resource to be fetched."""
+
+    article_custom_additional_attributes: Annotated[
+        Optional[str],
+        pydantic.Field(alias="articleCustomAdditionalAttributes"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""One or more comma-separated names for article custom attributes defined by the user to be returned."""
+
+    topic_custom_additional_attributes: Annotated[
+        Optional[str],
+        pydantic.Field(alias="topicCustomAdditionalAttributes"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""One or more comma-separated names for topic custom attributes defined by the user to be returned."""
+
+    pagenum: Annotated[
+        Optional[int],
+        pydantic.Field(alias="$pagenum"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 1
+    r"""Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."""
+
+    pagesize: Annotated[
+        Optional[int],
+        pydantic.Field(alias="$pagesize"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 10
+    r"""Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum."""

egain_api_python/models/aisearchresponse.py

@@ -0,0 +1,67 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .articleaisearchresult import ArticleAISearchResult, ArticleAISearchResultTypedDict
+from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
+from .topicaisearchresult import TopicAISearchResult, TopicAISearchResultTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+AISearchResponseType = Literal[
+    "portal",
+    "custom",
+]
+r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+
+
+class AISearchResponseChannelTypedDict(TypedDict):
+    type: AISearchResponseType
+    r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+    name: NotRequired[str]
+    r"""The name of the channel."""
+
+
+class AISearchResponseChannel(BaseModel):
+    type: AISearchResponseType
+    r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+
+    name: Optional[str] = None
+    r"""The name of the channel."""
+
+
+class SearchResultsTypedDict(TypedDict):
+    r"""Top search results with relevance scores"""
+
+    article: NotRequired[List[ArticleAISearchResultTypedDict]]
+    topic: NotRequired[List[TopicAISearchResultTypedDict]]
+
+
+class SearchResults(BaseModel):
+    r"""Top search results with relevance scores"""
+
+    article: Optional[List[ArticleAISearchResult]] = None
+
+    topic: Optional[List[TopicAISearchResult]] = None
+
+
+class AISearchResponseTypedDict(TypedDict):
+    channel: NotRequired[AISearchResponseChannelTypedDict]
+    search_results: NotRequired[SearchResultsTypedDict]
+    r"""Top search results with relevance scores"""
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class AISearchResponse(BaseModel):
+    channel: Optional[AISearchResponseChannel] = None
+
+    search_results: Annotated[
+        Optional[SearchResults], pydantic.Field(alias="searchResults")
+    ] = None
+    r"""Top search results with relevance scores"""
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None