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

egain_api_python/models/searchresult.py

@@ -0,0 +1,101 @@
+"""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
+
+
+SearchResultDocType = Literal[
+    "HTML",
+    "Doc",
+    "Pdf",
+]
+r"""Format of the source document (HTML, Doc, or PDF)."""
+
+
+SearchResultSource = Literal[
+    "eGain Article",
+    "eGain Attachment",
+]
+r"""The repository or system where the content originated (e.g., eGain Article, eGain Attachment)."""
+
+
+SnippetType = Literal[
+    "chunks",
+    "articleContent",
+]
+
+
+class SearchResultLinkTypedDict(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 SearchResultLink(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 SearchResultTypedDict(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: SearchResultDocType
+    r"""Format of the source document (HTML, Doc, or PDF)."""
+    source: SearchResultSource
+    r"""The repository or system where the content originated (e.g., eGain Article, eGain Attachment)."""
+    snippet: str
+    r"""Retrieved text returned for the query. This may be a **chunk of an article** or the **entire article content** if the content is small enough."""
+    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."""
+    snippet_type: NotRequired[SnippetType]
+    link: NotRequired[SearchResultLinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class SearchResult(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[SearchResultDocType, pydantic.Field(alias="docType")]
+    r"""Format of the source document (HTML, Doc, or PDF)."""
+
+    source: SearchResultSource
+    r"""The repository or system where the content originated (e.g., eGain Article, eGain Attachment)."""
+
+    snippet: str
+    r"""Retrieved text returned for the query. This may be a **chunk of an article** or the **entire article content** if the content is small enough."""
+
+    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."""
+
+    snippet_type: Annotated[
+        Optional[SnippetType], pydantic.Field(alias="snippetType")
+    ] = None
+
+    link: Optional[SearchResultLink] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/searchsuggestionop.py

@@ -0,0 +1,93 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .order import Order
+from .sortidname import SortIDName
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+FilterStatus = Literal[
+    "suggested",
+    "pending",
+    "declined",
+    "approved",
+]
+r"""The search filter applied to the list of suggestions by a user."""
+
+
+class SearchSuggestionRequestTypedDict(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."""
+    filter_status: FilterStatus
+    r"""The search filter applied to the list of suggestions by a user."""
+    sort: NotRequired[SortIDName]
+    r"""Objects returned in server response are sorted based on the attribute supplied under $sort."""
+    order: NotRequired[Order]
+    r"""Common query parameter $order."""
+    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.<br>Valid range of 5-75<br>_Default value_: 25"""
+
+
+class SearchSuggestionRequest(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."""
+
+    filter_status: Annotated[
+        FilterStatus,
+        pydantic.Field(alias="filter[status]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""The search filter applied to the list of suggestions by a user."""
+
+    sort: Annotated[
+        Optional[SortIDName],
+        pydantic.Field(alias="$sort"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Objects returned in server response are sorted based on the attribute supplied under $sort."""
+
+    order: Annotated[
+        Optional[Order],
+        pydantic.Field(alias="$order"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Common query parameter $order."""
+
+    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)),
+    ] = 25
+    r"""Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.<br>Valid range of 5-75<br>_Default value_: 25"""

egain_api_python/models/security.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 egain_api_python.utils import FieldMetadata, SecurityMetadata
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class SecurityTypedDict(TypedDict):
+    access_token: NotRequired[str]
+
+
+class Security(BaseModel):
+    access_token: Annotated[
+        Optional[str],
+        FieldMetadata(
+            security=SecurityMetadata(
+                scheme=True,
+                scheme_type="http",
+                sub_type="bearer",
+                field_name="Authorization",
+            )
+        ),
+    ] = None

egain_api_python/models/selectuserprofileop.py

@@ -0,0 +1,44 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import FieldMetadata, HeaderMetadata, PathParamMetadata
+import pydantic
+from typing_extensions import Annotated, TypedDict
+
+
+class SelectUserProfileRequestTypedDict(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."""
+    user_profile_id: str
+    r"""The ID of the user profile.
+
+    """
+
+
+class SelectUserProfileRequest(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."""
+
+    user_profile_id: Annotated[
+        str,
+        pydantic.Field(alias="userProfileID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the user profile.
+
+    """

egain_api_python/models/sessioncontextvariable.py

@@ -0,0 +1,17 @@
+"""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 SessionContextVariableTypedDict(TypedDict):
+    name: NotRequired[str]
+    value: NotRequired[str]
+
+
+class SessionContextVariable(BaseModel):
+    name: Optional[str] = None
+
+    value: Optional[str] = None

egain_api_python/models/shorturl.py

@@ -0,0 +1,32 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ShortURLTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The alphanumeric ID of the short URL.<br><br>A topic ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    template_name: NotRequired[str]
+    r"""Name of template"""
+    short_url_name: NotRequired[str]
+    r"""Name of ShortURL"""
+    is_default: NotRequired[bool]
+
+
+class ShortURL(BaseModel):
+    id: Optional[str] = None
+    r"""The alphanumeric ID of the short URL.<br><br>A topic ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    template_name: Annotated[Optional[str], pydantic.Field(alias="templateName")] = None
+    r"""Name of template"""
+
+    short_url_name: Annotated[Optional[str], pydantic.Field(alias="shortURLName")] = (
+        None
+    )
+    r"""Name of ShortURL"""
+
+    is_default: Annotated[Optional[bool], pydantic.Field(alias="isDefault")] = None

egain_api_python/models/sortidname.py

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

egain_api_python/models/sortidnamedepartment.py

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

egain_api_python/models/stage.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .milestone import Milestone, MilestoneTypedDict
+from egain_api_python.types import BaseModel
+from typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class StageTypedDict(TypedDict):
+    r"""A stage in the Article's workflow."""
+
+    name: NotRequired[str]
+    r"""The name of the stage."""
+    milestone: NotRequired[MilestoneTypedDict]
+    r"""A resource's workflow milestone."""
+
+
+class Stage(BaseModel):
+    r"""A stage in the Article's workflow."""
+
+    name: Optional[str] = None
+    r"""The name of the stage."""
+
+    milestone: Optional[Milestone] = None
+    r"""A resource's workflow milestone."""

egain_api_python/models/startcustomerescalationop.py

@@ -0,0 +1,66 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .mandatorylanguagequeryparameter import MandatoryLanguageQueryParameter
+from .startescalationrequest import (
+    StartEscalationRequest,
+    StartEscalationRequestTypedDict,
+)
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing import Dict, List
+from typing_extensions import Annotated, TypedDict
+
+
+class StartCustomerEscalationRequestTypedDict(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."""
+    language: MandatoryLanguageQueryParameter
+    r"""The language used for fetching the details of a resource. Resources available in different languages may differ from each other."""
+    start_escalation_request: StartEscalationRequestTypedDict
+
+
+class StartCustomerEscalationRequest(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."""
+
+    language: Annotated[
+        MandatoryLanguageQueryParameter,
+        pydantic.Field(alias="$lang"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""The language used for fetching the details of a resource. Resources available in different languages may differ from each other."""
+
+    start_escalation_request: Annotated[
+        StartEscalationRequest,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]
+
+
+class StartCustomerEscalationResponseTypedDict(TypedDict):
+    headers: Dict[str, List[str]]
+
+
+class StartCustomerEscalationResponse(BaseModel):
+    headers: Dict[str, List[str]]

egain_api_python/models/startescalationrequest.py

@@ -0,0 +1,94 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .contacts import Contacts, ContactsTypedDict
+from egain_api_python.types import BaseModel
+from typing import Literal, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class CustomerTypedDict(TypedDict):
+    r"""The contact point details of the customer who is starting the escalation."""
+
+    contacts: NotRequired[ContactsTypedDict]
+    r"""Contacts"""
+
+
+class Customer(BaseModel):
+    r"""The contact point details of the customer who is starting the escalation."""
+
+    contacts: Optional[Contacts] = None
+    r"""Contacts"""
+
+
+ChannelEnum = Literal["email",]
+r"""The type of escalation
+
+"""
+
+
+class CaptchaTypedDict(TypedDict):
+    r"""Only required when captcha is enabled for portal."""
+
+    response: str
+
+
+class Captcha(BaseModel):
+    r"""Only required when captcha is enabled for portal."""
+
+    response: str
+
+
+class StartEscalationRequestTypedDict(TypedDict):
+    subject: str
+    r"""The subject of the email message.
+
+    """
+    body: str
+    r"""The body of the email message.
+
+    """
+    channel: ChannelEnum
+    r"""The type of escalation
+
+    """
+    url: str
+    r"""The url of the page that the customer was viewing at the time when the ecalation started.
+
+    """
+    customer: NotRequired[CustomerTypedDict]
+    r"""The contact point details of the customer who is starting the escalation."""
+    captcha: NotRequired[CaptchaTypedDict]
+    r"""Only required when captcha is enabled for portal.
+
+    """
+
+
+class StartEscalationRequest(BaseModel):
+    subject: str
+    r"""The subject of the email message.
+
+    """
+
+    body: str
+    r"""The body of the email message.
+
+    """
+
+    channel: ChannelEnum
+    r"""The type of escalation
+
+    """
+
+    url: str
+    r"""The url of the page that the customer was viewing at the time when the ecalation started.
+
+    """
+
+    customer: Optional[Customer] = None
+    r"""The contact point details of the customer who is starting the escalation."""
+
+    captcha: Optional[Captcha] = None
+    r"""Only required when captcha is enabled for portal.
+
+    """

egain_api_python/models/startghsearchop.py

@@ -0,0 +1,74 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .ghsearchrequest import GHSearchRequest, GHSearchRequestTypedDict
+from .ghsearchresult import GHSearchResult, GHSearchResultTypedDict
+from .languagequeryparameter import LanguageQueryParameter
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing import Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class StartGHSearchRequestTypedDict(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."""
+    gh_search_request: GHSearchRequestTypedDict
+    language: NotRequired[LanguageQueryParameter]
+    r"""The language that describes the details of a resource. Resources available in different languages may differ from each other.<li>If <code>lang</code> is not passed, then the portal's default language is used.</li>"""
+    gh_custom_additional_attributes: NotRequired[str]
+
+
+class StartGHSearchRequest(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."""
+
+    gh_search_request: Annotated[
+        GHSearchRequest,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]
+
+    language: Annotated[
+        Optional[LanguageQueryParameter],
+        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.<li>If <code>lang</code> is not passed, then the portal's default language is used.</li>"""
+
+    gh_custom_additional_attributes: Annotated[
+        Optional[str],
+        pydantic.Field(alias="ghCustomAdditionalAttributes"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+
+
+class StartGHSearchResponseTypedDict(TypedDict):
+    headers: Dict[str, List[str]]
+    result: GHSearchResultTypedDict
+
+
+class StartGHSearchResponse(BaseModel):
+    headers: Dict[str, List[str]]
+
+    result: GHSearchResult

egain_api_python/models/startquestionandanswer.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .answer import Answer, AnswerTypedDict
+from egain_api_python.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class StartQuestionAndAnswerTypedDict(TypedDict):
+    r"""Questions and answers of the Casebase"""
+
+    id: str
+    r"""ID of question"""
+    answers: List[AnswerTypedDict]
+    r"""Answers of question"""
+
+
+class StartQuestionAndAnswer(BaseModel):
+    r"""Questions and answers of the Casebase"""
+
+    id: str
+    r"""ID of question"""
+
+    answers: List[Answer]
+    r"""Answers of question"""