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

egain_api_python/models/case.py

@@ -0,0 +1,158 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .action import Action, ActionTypedDict
+from .casequestiondetail import CaseQuestionDetail, CaseQuestionDetailTypedDict
+from .createdby import CreatedBy, CreatedByTypedDict
+from .link import Link, LinkTypedDict
+from .metadata import Metadata, MetadataTypedDict
+from .modifiedby import ModifiedBy, ModifiedByTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+ThresholdType = Literal[
+    "Default",
+    "Custom",
+]
+r"""Threshold type indicating if thresholdValue is default or custom."""
+
+
+CaseType = Literal[
+    "Control",
+    "Content",
+]
+r"""Type of the case. Control or Content type"""
+
+
+class CaseTypedDict(TypedDict):
+    r"""Success"""
+
+    id: NotRequired[str]
+    r"""The numerical ID of the case."""
+    short_name: NotRequired[str]
+    r"""short name of the case."""
+    title: NotRequired[str]
+    r"""title of the case"""
+    comments: NotRequired[str]
+    r"""comments on the case"""
+    profile_id: NotRequired[str]
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+    release_id: NotRequired[str]
+    r"""The numerical ID of the Casebase Release in which case in created"""
+    cluster_id: NotRequired[str]
+    r"""ID of the cluster in which case is created"""
+    created_date: NotRequired[str]
+    r"""The date on which the Case was created."""
+    created_by: NotRequired[CreatedByTypedDict]
+    modified_by: NotRequired[ModifiedByTypedDict]
+    modified_date: NotRequired[str]
+    r"""The date on which the Case was last modified."""
+    is_visible: NotRequired[bool]
+    r"""Flag indicating if the case is visible"""
+    reject_count: NotRequired[int]
+    r"""number of times case was rejected."""
+    accept_count: NotRequired[int]
+    r"""number of times case was accepted."""
+    action: NotRequired[List[ActionTypedDict]]
+    r"""actions in the case"""
+    metadata: NotRequired[List[MetadataTypedDict]]
+    r"""Metadata of the case"""
+    threshold_value: NotRequired[int]
+    r"""Threshold value of the case"""
+    threshold_type: NotRequired[ThresholdType]
+    r"""Threshold type indicating if thresholdValue is default or custom."""
+    threshold_value_from_cluster: NotRequired[float]
+    r"""Threshold value of the cluster in which case is created"""
+    case_type: NotRequired[CaseType]
+    r"""Type of the case. Control or Content type"""
+    question_detail: NotRequired[List[CaseQuestionDetailTypedDict]]
+    r"""Questions in the case"""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class Case(BaseModel):
+    r"""Success"""
+
+    id: Optional[str] = None
+    r"""The numerical ID of the case."""
+
+    short_name: Annotated[Optional[str], pydantic.Field(alias="shortName")] = None
+    r"""short name of the case."""
+
+    title: Optional[str] = None
+    r"""title of the case"""
+
+    comments: Optional[str] = None
+    r"""comments on the case"""
+
+    profile_id: Annotated[Optional[str], pydantic.Field(alias="profileId")] = None
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+
+    release_id: Annotated[Optional[str], pydantic.Field(alias="releaseId")] = None
+    r"""The numerical ID of the Casebase Release in which case in created"""
+
+    cluster_id: Annotated[Optional[str], pydantic.Field(alias="clusterId")] = None
+    r"""ID of the cluster in which case is created"""
+
+    created_date: Annotated[Optional[str], pydantic.Field(alias="createdDate")] = None
+    r"""The date on which the Case was created."""
+
+    created_by: Annotated[Optional[CreatedBy], pydantic.Field(alias="createdBy")] = None
+
+    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 Case was last modified."""
+
+    is_visible: Annotated[Optional[bool], pydantic.Field(alias="isVisible")] = None
+    r"""Flag indicating if the case is visible"""
+
+    reject_count: Annotated[Optional[int], pydantic.Field(alias="rejectCount")] = None
+    r"""number of times case was rejected."""
+
+    accept_count: Annotated[Optional[int], pydantic.Field(alias="acceptCount")] = None
+    r"""number of times case was accepted."""
+
+    action: Optional[List[Action]] = None
+    r"""actions in the case"""
+
+    metadata: Optional[List[Metadata]] = None
+    r"""Metadata of the case"""
+
+    threshold_value: Annotated[
+        Optional[int], pydantic.Field(alias="thresholdValue")
+    ] = None
+    r"""Threshold value of the case"""
+
+    threshold_type: Annotated[
+        Optional[ThresholdType], pydantic.Field(alias="thresholdType")
+    ] = None
+    r"""Threshold type indicating if thresholdValue is default or custom."""
+
+    threshold_value_from_cluster: Annotated[
+        Optional[float], pydantic.Field(alias="thresholdValueFromCluster")
+    ] = None
+    r"""Threshold value of the cluster in which case is created"""
+
+    case_type: Annotated[Optional[CaseType], pydantic.Field(alias="caseType")] = None
+    r"""Type of the case. Control or Content type"""
+
+    question_detail: Annotated[
+        Optional[List[CaseQuestionDetail]], pydantic.Field(alias="questionDetail")
+    ] = None
+    r"""Questions in the case"""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/caseadditionalattributes.py

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

egain_api_python/models/caseanswer.py

@@ -0,0 +1,21 @@
+"""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 CaseAnswerTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""ID of the answer"""
+    text: NotRequired[str]
+    r"""Text of the answer"""
+
+
+class CaseAnswer(BaseModel):
+    id: Optional[str] = None
+    r"""ID of the answer"""
+
+    text: Optional[str] = None
+    r"""Text of the answer"""

egain_api_python/models/casebase.py

@@ -0,0 +1,67 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .casebasesearchsettings import (
+    CasebaseSearchSettings,
+    CasebaseSearchSettingsTypedDict,
+)
+from .kblanguages import KbLanguages, KbLanguagesTypedDict
+from .link import Link, LinkTypedDict
+from .profileresult import ProfileResult, ProfileResultTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+CasebaseStatus = Literal[
+    "author",
+    "live",
+    "qa",
+]
+r"""status of the Casebase"""
+
+
+class CasebaseTypedDict(TypedDict):
+    casebase_id: NotRequired[str]
+    r"""The numerical ID of the Casebase."""
+    name: NotRequired[str]
+    r"""name of the Casebase Release."""
+    id: NotRequired[str]
+    r"""The numerical ID of the Casebase Release."""
+    status: NotRequired[CasebaseStatus]
+    r"""status of the Casebase"""
+    profiles: NotRequired[List[ProfileResultTypedDict]]
+    r"""All Guided Help Profiles associated with Casebase release"""
+    search_settings: NotRequired[CasebaseSearchSettingsTypedDict]
+    languages: NotRequired[KbLanguagesTypedDict]
+    r"""KB languages"""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class Casebase(BaseModel):
+    casebase_id: Annotated[Optional[str], pydantic.Field(alias="casebaseId")] = None
+    r"""The numerical ID of the Casebase."""
+
+    name: Optional[str] = None
+    r"""name of the Casebase Release."""
+
+    id: Optional[str] = None
+    r"""The numerical ID of the Casebase Release."""
+
+    status: Optional[CasebaseStatus] = None
+    r"""status of the Casebase"""
+
+    profiles: Optional[List[ProfileResult]] = None
+    r"""All Guided Help Profiles associated with Casebase release"""
+
+    search_settings: Annotated[
+        Optional[CasebaseSearchSettings], pydantic.Field(alias="searchSettings")
+    ] = None
+
+    languages: Optional[KbLanguages] = None
+    r"""KB languages"""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/casebaseresult.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .casebase import Casebase, CasebaseTypedDict
+from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CasebaseResultTypedDict(TypedDict):
+    r"""Success"""
+
+    casebase: NotRequired[List[CasebaseTypedDict]]
+    r"""Casebase releases"""
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class CasebaseResult(BaseModel):
+    r"""Success"""
+
+    casebase: Optional[List[Casebase]] = None
+    r"""Casebase releases"""
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/casebasesearchsettings.py

@@ -0,0 +1,26 @@
+"""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 CasebaseSearchSettingsTypedDict(TypedDict):
+    close_session_on_accept: NotRequired[bool]
+    r"""indicates whether to close the Guided Help session upon acceptance of answer"""
+    close_session_on_reject: NotRequired[bool]
+    r"""indicates wheather to reject the Guided Helo session upon rejection of answer"""
+
+
+class CasebaseSearchSettings(BaseModel):
+    close_session_on_accept: Annotated[
+        Optional[bool], pydantic.Field(alias="closeSessionOnAccept")
+    ] = None
+    r"""indicates whether to close the Guided Help session upon acceptance of answer"""
+
+    close_session_on_reject: Annotated[
+        Optional[bool], pydantic.Field(alias="closeSessionOnReject")
+    ] = None
+    r"""indicates wheather to reject the Guided Helo session upon rejection of answer"""

egain_api_python/models/caselistresult.py

@@ -0,0 +1,74 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .createdby import CreatedBy, CreatedByTypedDict
+from .link import Link, LinkTypedDict
+from .modifiedby import ModifiedBy, ModifiedByTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CaseListResultTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The numerical ID of the case."""
+    short_name: NotRequired[str]
+    r"""short name of the case."""
+    title: NotRequired[str]
+    r"""title of the case"""
+    profile_id: NotRequired[str]
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+    release_id: NotRequired[str]
+    r"""The numerical ID of the Casebase Release in which case in created"""
+    cluster_id: NotRequired[str]
+    r"""ID of the cluster in which case is created"""
+    created_date: NotRequired[str]
+    r"""The date on which the Case was created."""
+    created_by: NotRequired[CreatedByTypedDict]
+    modified_by: NotRequired[ModifiedByTypedDict]
+    modified_date: NotRequired[str]
+    r"""The date on which the Case was last modified."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class CaseListResult(BaseModel):
+    id: Optional[str] = None
+    r"""The numerical ID of the case."""
+
+    short_name: Annotated[Optional[str], pydantic.Field(alias="shortName")] = None
+    r"""short name of the case."""
+
+    title: Optional[str] = None
+    r"""title of the case"""
+
+    profile_id: Annotated[Optional[str], pydantic.Field(alias="profileId")] = None
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+
+    release_id: Annotated[Optional[str], pydantic.Field(alias="releaseId")] = None
+    r"""The numerical ID of the Casebase Release in which case in created"""
+
+    cluster_id: Annotated[Optional[str], pydantic.Field(alias="clusterId")] = None
+    r"""ID of the cluster in which case is created"""
+
+    created_date: Annotated[Optional[str], pydantic.Field(alias="createdDate")] = None
+    r"""The date on which the Case was created."""
+
+    created_by: Annotated[Optional[CreatedBy], pydantic.Field(alias="createdBy")] = None
+
+    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 Case was last modified."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/caselistresults.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .caselistresult import CaseListResult, CaseListResultTypedDict
+from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CaseListResultsTypedDict(TypedDict):
+    r"""Success"""
+
+    case: NotRequired[List[CaseListResultTypedDict]]
+    r"""Cases"""
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class CaseListResults(BaseModel):
+    r"""Success"""
+
+    case: Optional[List[CaseListResult]] = None
+    r"""Cases"""
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/casequestion.py

@@ -0,0 +1,16 @@
+"""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 CaseQuestionTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The numerical ID of the question"""
+
+
+class CaseQuestion(BaseModel):
+    id: Optional[str] = None
+    r"""The numerical ID of the question"""

egain_api_python/models/casequestiondetail.py

@@ -0,0 +1,29 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .caseanswer import CaseAnswer, CaseAnswerTypedDict
+from .casequestion import CaseQuestion, CaseQuestionTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CaseQuestionDetailTypedDict(TypedDict):
+    question: CaseQuestionTypedDict
+    answer: List[CaseAnswerTypedDict]
+    r"""Answer of the question"""
+    scoring_value: NotRequired[float]
+    r"""Weightage of the question"""
+
+
+class CaseQuestionDetail(BaseModel):
+    question: CaseQuestion
+
+    answer: List[CaseAnswer]
+    r"""Answer of the question"""
+
+    scoring_value: Annotated[Optional[float], pydantic.Field(alias="scoringValue")] = (
+        None
+    )
+    r"""Weightage of the question"""

egain_api_python/models/casesearch.py

@@ -0,0 +1,80 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .action import Action, ActionTypedDict
+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
+
+
+CaseSearchType = Literal[
+    "Control",
+    "Article",
+]
+r"""The type of the action"""
+
+
+class CaseSearchTypedDict(TypedDict):
+    accept_count: NotRequired[int]
+    r"""The number of times action was accepted"""
+    action: NotRequired[List[ActionTypedDict]]
+    r"""actions in search"""
+    additional_info: NotRequired[bool]
+    r"""This field indicates if action has additional information"""
+    metadata: NotRequired[List[MetadataTypedDict]]
+    r"""Metadata in search"""
+    case_id: NotRequired[str]
+    r"""case Id"""
+    passed_threshold_value: NotRequired[bool]
+    r"""This field 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"""The short name"""
+    score: NotRequired[float]
+    r"""The score of the case"""
+    title: NotRequired[str]
+    r"""The title of the case"""
+    type: NotRequired[CaseSearchType]
+    r"""The type of the action"""
+
+
+class CaseSearch(BaseModel):
+    accept_count: Annotated[Optional[int], pydantic.Field(alias="acceptCount")] = None
+    r"""The number of times action was accepted"""
+
+    action: Optional[List[Action]] = None
+    r"""actions in search"""
+
+    additional_info: Annotated[
+        Optional[bool], pydantic.Field(alias="additionalInfo")
+    ] = None
+    r"""This field indicates if action has additional information"""
+
+    metadata: Optional[List[Metadata]] = None
+    r"""Metadata in search"""
+
+    case_id: Annotated[Optional[str], pydantic.Field(alias="caseId")] = None
+    r"""case Id"""
+
+    passed_threshold_value: Annotated[
+        Optional[bool], pydantic.Field(alias="passedThresholdValue")
+    ] = None
+    r"""This field 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"""The short name"""
+
+    score: Optional[float] = None
+    r"""The score of the case"""
+
+    title: Optional[str] = None
+    r"""The title of the case"""
+
+    type: Optional[CaseSearchType] = None
+    r"""The type of the action"""

egain_api_python/models/clusterid.py

@@ -0,0 +1,16 @@
+"""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 ClusterIDTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The numerical Cluster ID"""
+
+
+class ClusterID(BaseModel):
+    id: Optional[str] = None
+    r"""The numerical Cluster ID"""

egain_api_python/models/clusterresult.py

@@ -0,0 +1,37 @@
+"""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 ClusterResultTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""id of the cluster"""
+    short_name: NotRequired[str]
+    r"""short name of the cluster"""
+    name: NotRequired[str]
+    r"""name of the cluster"""
+    startup: NotRequired[bool]
+    r"""indicates if the cluster is startup cluster of the release"""
+    depth: NotRequired[int]
+    r"""depth of the cluster"""
+
+
+class ClusterResult(BaseModel):
+    id: Optional[str] = None
+    r"""id of the cluster"""
+
+    short_name: Annotated[Optional[str], pydantic.Field(alias="shortName")] = None
+    r"""short name of the cluster"""
+
+    name: Optional[str] = None
+    r"""name of the cluster"""
+
+    startup: Optional[bool] = None
+    r"""indicates if the cluster is startup cluster of the release"""
+
+    depth: Optional[int] = None
+    r"""depth of the cluster"""

egain_api_python/models/clusterresults.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .clusterresult import ClusterResult, ClusterResultTypedDict
+from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ClusterResultsTypedDict(TypedDict):
+    r"""Success"""
+
+    cluster: NotRequired[List[ClusterResultTypedDict]]
+    r"""Clusters"""
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class ClusterResults(BaseModel):
+    r"""Success"""
+
+    cluster: Optional[List[ClusterResult]] = None
+    r"""Clusters"""
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/comment.py

@@ -0,0 +1,33 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .createdby import CreatedBy, CreatedByTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CommentTypedDict(TypedDict):
+    r"""This schema contains the definition of a comment object."""
+
+    id: NotRequired[str]
+    r"""The ID of the comment."""
+    content: NotRequired[str]
+    r"""The content of the comment."""
+    created_by: NotRequired[CreatedByTypedDict]
+    created_date: NotRequired[str]
+
+
+class Comment(BaseModel):
+    r"""This schema contains the definition of a comment object."""
+
+    id: Optional[str] = None
+    r"""The ID of the comment."""
+
+    content: Optional[str] = None
+    r"""The content of the comment."""
+
+    created_by: Annotated[Optional[CreatedBy], pydantic.Field(alias="createdBy")] = None
+
+    created_date: Annotated[Optional[str], pydantic.Field(alias="createdDate")] = None