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

egain_api_python/models/publishview.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .tagcategory import TagCategory, TagCategoryTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PublishViewTagCategoryTypedDict(TypedDict):
+    tag_category: NotRequired[List[TagCategoryTypedDict]]
+
+
+class PublishViewTagCategory(BaseModel):
+    tag_category: Annotated[
+        Optional[List[TagCategory]], pydantic.Field(alias="tagCategory")
+    ] = None
+
+
+class PublishViewTypedDict(TypedDict):
+    name: NotRequired[str]
+    r"""name of the publish view"""
+    id: NotRequired[str]
+    tag_categories: NotRequired[List[PublishViewTagCategoryTypedDict]]
+    r"""Tag categories are comprised of both tags and tag groups.<br><br>Note that the total number of tag and tag groups cannot exceed 20."""
+
+
+class PublishView(BaseModel):
+    name: Optional[str] = None
+    r"""name of the publish view"""
+
+    id: Optional[str] = None
+
+    tag_categories: Annotated[
+        Optional[List[PublishViewTagCategory]], pydantic.Field(alias="tagCategories")
+    ] = None
+    r"""Tag categories are comprised of both tags and tag groups.<br><br>Note that the total number of tag and tag groups cannot exceed 20."""

egain_api_python/models/question.py

@@ -0,0 +1,101 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .answerrange import AnswerRange, AnswerRangeTypedDict
+from .metadata import Metadata, MetadataTypedDict
+from .schemas_answer import SchemasAnswer, SchemasAnswerTypedDict
+from .schemas_customattribute import (
+    SchemasCustomAttribute,
+    SchemasCustomAttributeTypedDict,
+)
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+QuestionType = Literal[
+    "numeric",
+    "enumerated",
+    "list",
+    "text",
+]
+r"""type of the question"""
+
+
+QuestionFormat = Literal[
+    "radioButton",
+    "dropdown",
+    "checkbox",
+    "mutliSelect",
+    "number",
+    "singleLineTextField",
+    "multiLineTextField",
+]
+r"""format of the question"""
+
+
+class QuestionTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The numerical ID of the question"""
+    title: NotRequired[str]
+    r"""Title of the question"""
+    type: NotRequired[QuestionType]
+    r"""type of the question"""
+    format_: NotRequired[QuestionFormat]
+    r"""format of the question"""
+    short_name: NotRequired[str]
+    r"""short name"""
+    has_additional_info: NotRequired[bool]
+    r"""indicates if question has additional information"""
+    has_action: NotRequired[bool]
+    r"""indicates if question has action"""
+    valid_answer: NotRequired[List[SchemasAnswerTypedDict]]
+    r"""valid answers for question"""
+    valid_answer_range: NotRequired[AnswerRangeTypedDict]
+    metadata: NotRequired[List[MetadataTypedDict]]
+    r"""Metadata on question"""
+    custom_attributes: NotRequired[List[SchemasCustomAttributeTypedDict]]
+    r"""Custom attributes of question"""
+
+
+class Question(BaseModel):
+    id: Optional[str] = None
+    r"""The numerical ID of the question"""
+
+    title: Optional[str] = None
+    r"""Title of the question"""
+
+    type: Optional[QuestionType] = None
+    r"""type of the question"""
+
+    format_: Annotated[Optional[QuestionFormat], pydantic.Field(alias="format")] = None
+    r"""format of the question"""
+
+    short_name: Annotated[Optional[str], pydantic.Field(alias="shortName")] = None
+    r"""short name"""
+
+    has_additional_info: Annotated[
+        Optional[bool], pydantic.Field(alias="hasAdditionalInfo")
+    ] = None
+    r"""indicates if question has additional information"""
+
+    has_action: Annotated[Optional[bool], pydantic.Field(alias="hasAction")] = None
+    r"""indicates if question has action"""
+
+    valid_answer: Annotated[
+        Optional[List[SchemasAnswer]], pydantic.Field(alias="validAnswer")
+    ] = None
+    r"""valid answers for question"""
+
+    valid_answer_range: Annotated[
+        Optional[AnswerRange], pydantic.Field(alias="validAnswerRange")
+    ] = None
+
+    metadata: Optional[List[Metadata]] = None
+    r"""Metadata on question"""
+
+    custom_attributes: Annotated[
+        Optional[List[SchemasCustomAttribute]], pydantic.Field(alias="customAttributes")
+    ] = None
+    r"""Custom attributes of question"""

egain_api_python/models/questionandanswer.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, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class QuestionAndAnswerTypedDict(TypedDict):
+    r"""Questions and answers of the Casebase"""
+
+    id: str
+    r"""ID of question"""
+    answers: NotRequired[List[AnswerTypedDict]]
+    r"""Answers of question"""
+
+
+class QuestionAndAnswer(BaseModel):
+    r"""Questions and answers of the Casebase"""
+
+    id: str
+    r"""ID of question"""
+
+    answers: Optional[List[Answer]] = None
+    r"""Answers of question"""

egain_api_python/models/quickpickrating.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_extensions import Annotated, TypedDict
+
+
+class QuickpickRatingTypedDict(TypedDict):
+    id: str
+    r"""The numerical ID of the Casebase Release."""
+    name: str
+    r"""name of the case or article"""
+    profile_id: str
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+
+
+class QuickpickRating(BaseModel):
+    id: str
+    r"""The numerical ID of the Casebase Release."""
+
+    name: str
+    r"""name of the case or article"""
+
+    profile_id: Annotated[str, pydantic.Field(alias="profileId")]
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """

egain_api_python/models/quickpickresult.py

@@ -0,0 +1,38 @@
+"""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 QuickpickResultTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The ID of the Quickpick being accessed.
+
+    """
+    name: NotRequired[str]
+    r"""name of the quick pick"""
+    comment: NotRequired[str]
+    r"""comment about quick pick"""
+    casebase_release_id: NotRequired[str]
+    r"""The numerical ID of the Casebase Release."""
+
+
+class QuickpickResult(BaseModel):
+    id: Optional[str] = None
+    r"""The ID of the Quickpick being accessed.
+
+    """
+
+    name: Optional[str] = None
+    r"""name of the quick pick"""
+
+    comment: Optional[str] = None
+    r"""comment about quick pick"""
+
+    casebase_release_id: Annotated[
+        Optional[str], pydantic.Field(alias="casebaseReleaseId")
+    ] = None
+    r"""The numerical ID of the Casebase Release."""

egain_api_python/models/quickpickresults.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 .quickpickresult import QuickpickResult, QuickpickResultTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class QuickpickResultsTypedDict(TypedDict):
+    r"""Success"""
+
+    quickpick: NotRequired[List[QuickpickResultTypedDict]]
+    r"""quick picks"""
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class QuickpickResults(BaseModel):
+    r"""Success"""
+
+    quickpick: Optional[List[QuickpickResult]] = None
+    r"""quick picks"""
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/ratearticleop.py

@@ -0,0 +1,71 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .languagequeryparameter import LanguageQueryParameter
+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 RateArticleRequestTypedDict(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."""
+    score: int
+    r"""A positive number. Each portal can have its own scoring guidelines."""
+    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>"""
+    comments: NotRequired[str]
+    r"""A comment about the Article rating."""
+
+
+class RateArticleRequest(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."""
+
+    score: Annotated[
+        int, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""A positive number. Each portal can have its own scoring guidelines."""
+
+    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>"""
+
+    comments: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""A comment about the Article rating."""

egain_api_python/models/referenceresponse.py

@@ -0,0 +1,80 @@
+"""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
+
+
+ReferenceResponseDocType = Literal[
+    "HTML",
+    "Doc",
+    "PDF",
+]
+r"""Format of the source document (HTML, Doc, or PDF)."""
+
+
+ReferenceResponseSource = Literal[
+    "eGain Article",
+    "eGain Attachment",
+]
+r"""Source Type"""
+
+
+class ReferenceResponseLinkTypedDict(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 ReferenceResponseLink(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 ReferenceResponseTypedDict(TypedDict):
+    r"""One document used in generated response"""
+
+    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: ReferenceResponseDocType
+    r"""Format of the source document (HTML, Doc, or PDF)."""
+    source: ReferenceResponseSource
+    r"""Source Type"""
+    doc_name: NotRequired[str]
+    r"""Name of the attachment, if an attachment was used as the source content."""
+    link: NotRequired[ReferenceResponseLinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class ReferenceResponse(BaseModel):
+    r"""One document used in generated response"""
+
+    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[ReferenceResponseDocType, pydantic.Field(alias="docType")]
+    r"""Format of the source document (HTML, Doc, or PDF)."""
+
+    source: ReferenceResponseSource
+    r"""Source Type"""
+
+    doc_name: Annotated[Optional[str], pydantic.Field(alias="docName")] = None
+    r"""Name of the attachment, if an attachment was used as the source content."""
+
+    link: Optional[ReferenceResponseLink] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/rejectghsolutionop.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 RejectGHSolutionRequestTypedDict(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 RejectGHSolutionRequest(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/relatedquestions.py

@@ -0,0 +1,28 @@
+"""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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class RelatedQuestionsTypedDict(TypedDict):
+    r"""Related questions for the article."""
+
+    related_question: NotRequired[List[str]]
+    r"""An array of related questions."""
+    count: NotRequired[int]
+    r"""The total count of related questions for the article."""
+
+
+class RelatedQuestions(BaseModel):
+    r"""Related questions for the article."""
+
+    related_question: Annotated[
+        Optional[List[str]], pydantic.Field(alias="relatedQuestion")
+    ] = None
+    r"""An array of related questions."""
+
+    count: Optional[int] = None
+    r"""The total count of related questions for the article."""

egain_api_python/models/resourcetype_parameter.py

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

egain_api_python/models/restorequickpickop.py

@@ -0,0 +1,63 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .languagequeryparameter import LanguageQueryParameter
+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 RestoreQuickpickRequestTypedDict(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."""
+    quickpick_id: str
+    r"""The ID of the quickpick."""
+    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 RestoreQuickpickRequest(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."""
+
+    quickpick_id: Annotated[
+        str,
+        pydantic.Field(alias="quickpickID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the quickpick."""
+
+    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

egain_api_python/models/retrieverequest.py

@@ -0,0 +1,47 @@
+"""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
+
+
+RetrieveRequestType = Literal[
+    "portal",
+    "custom",
+]
+r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+
+
+class RetrieveRequestChannelTypedDict(TypedDict):
+    type: NotRequired[RetrieveRequestType]
+    r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+    name: NotRequired[str]
+    r"""A descriptive name for the channel (e.g., \"web\", \"mobile app\", \"agent console\")."""
+
+
+class RetrieveRequestChannel(BaseModel):
+    type: Optional[RetrieveRequestType] = "custom"
+    r"""The channel where the query originated, e.g., directly from the portal or via a custom integration."""
+
+    name: Optional[str] = None
+    r"""A descriptive name for the channel (e.g., \"web\", \"mobile app\", \"agent console\")."""
+
+
+class RetrieveRequestTypedDict(TypedDict):
+    channel: NotRequired[RetrieveRequestChannelTypedDict]
+    event_id: NotRequired[str]
+    r"""Unique ID for this specific API call or event."""
+    session_id: NotRequired[str]
+    r"""ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session."""
+
+
+class RetrieveRequest(BaseModel):
+    channel: Optional[RetrieveRequestChannel] = None
+
+    event_id: Annotated[Optional[str], pydantic.Field(alias="eventId")] = None
+    r"""Unique ID for this specific API call or event."""
+
+    session_id: Annotated[Optional[str], pydantic.Field(alias="sessionId")] = None
+    r"""ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session."""