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

egain_api_python/models/stepghsearchop.py

@@ -0,0 +1,62 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .ghstepsearchrequest import GHStepSearchRequest, GHStepSearchRequestTypedDict
+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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class StepGHSearchRequestTypedDict(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_step_search_request: GHStepSearchRequestTypedDict
+    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 StepGHSearchRequest(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_step_search_request: Annotated[
+        GHStepSearchRequest,
+        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

egain_api_python/models/stringattributevalue.py

@@ -0,0 +1,30 @@
+"""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 StringAttributeValueTypedDict(TypedDict):
+    r"""An attribute can have an external value such as a readable label, and an internal value such as a unique ID. This schema provides both the internal and external values for one attribute."""
+
+    internal_value: NotRequired[str]
+    r"""The internal value of the attribute."""
+    external_value: NotRequired[str]
+    r"""The external or public value of the attribute."""
+
+
+class StringAttributeValue(BaseModel):
+    r"""An attribute can have an external value such as a readable label, and an internal value such as a unique ID. This schema provides both the internal and external values for one attribute."""
+
+    internal_value: Annotated[Optional[str], pydantic.Field(alias="internalValue")] = (
+        None
+    )
+    r"""The internal value of the attribute."""
+
+    external_value: Annotated[Optional[str], pydantic.Field(alias="externalValue")] = (
+        None
+    )
+    r"""The external or public value of the attribute."""

egain_api_python/models/structuredauthoringfields.py

@@ -0,0 +1,33 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .l10nstring import L10NString, L10NStringTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class StructuredAuthoringFieldsTypedDict(TypedDict):
+    confidence_level: NotRequired[L10NStringTypedDict]
+    issue: NotRequired[str]
+    r"""Describes the problem, symptom, or question the article addresses."""
+    environment: NotRequired[str]
+    r"""Specifies the relevant product(s), category, or business process tied to the issue."""
+    cause: NotRequired[str]
+    r"""Identifies the underlying cause of the issue."""
+
+
+class StructuredAuthoringFields(BaseModel):
+    confidence_level: Annotated[
+        Optional[L10NString], pydantic.Field(alias="confidenceLevel")
+    ] = None
+
+    issue: Optional[str] = None
+    r"""Describes the problem, symptom, or question the article addresses."""
+
+    environment: Optional[str] = None
+    r"""Specifies the relevant product(s), category, or business process tied to the issue."""
+
+    cause: Optional[str] = None
+    r"""Identifies the underlying cause of the issue."""

egain_api_python/models/subscribearticleop.py

@@ -0,0 +1,40 @@
+"""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 SubscribeArticleRequestTypedDict(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."""
+
+
+class SubscribeArticleRequest(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."""

egain_api_python/models/suggestion.py

@@ -0,0 +1,190 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .customattribute import CustomAttribute, CustomAttributeTypedDict
+from .link import Link, LinkTypedDict
+from .modifiedby import ModifiedBy, ModifiedByTypedDict
+from datetime import datetime
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class SuggestionL10NStringTypedDict(TypedDict):
+    r"""The status of the Suggestion.
+    <li>1 : suggested.</li>
+    <li>2 : pending</li>
+    <li>3 : declined</li>
+    <li>4 : approved</li>
+    """
+
+    value: NotRequired[str]
+    r"""A string that indicates the value."""
+    display_value: NotRequired[str]
+    r"""Localized string of the value element."""
+
+
+class SuggestionL10NString(BaseModel):
+    r"""The status of the Suggestion.
+    <li>1 : suggested.</li>
+    <li>2 : pending</li>
+    <li>3 : declined</li>
+    <li>4 : approved</li>
+    """
+
+    value: Optional[str] = None
+    r"""A string that indicates the value."""
+
+    display_value: Annotated[Optional[str], pydantic.Field(alias="displayValue")] = None
+    r"""Localized string of the value element."""
+
+
+SuggestionCode = Literal[
+    "en-US",
+    "en-GB",
+    "fr-FR",
+    "es-ES",
+    "it-IT",
+    "de-DE",
+    "nl-NL",
+    "pt-BR",
+    "pt-PT",
+    "da-DK",
+    "sv-SE",
+    "ru-RU",
+    "fr-CA",
+    "zh-CN",
+    "ja-JP",
+    "ko-KR",
+]
+r"""The language that describes the details of the resource. Resources available in different languages may differ from each other."""
+
+
+Label = Literal[
+    "English",
+    "French",
+    "Spanish",
+    "Italian",
+    "German",
+    "Dutch",
+    "Portuguese",
+    "Danish",
+    "Swedish",
+    "Russian",
+    "Chinese",
+    "Japanese",
+    "Korean",
+]
+r"""The name of the language."""
+
+
+class SuggestionLanguageTypedDict(TypedDict):
+    r"""The knowledge base language in which the Suggestion was created."""
+
+    code: SuggestionCode
+    r"""The language that describes the details of the resource. Resources available in different languages may differ from each other."""
+    label: NotRequired[Label]
+    r"""The name of the language."""
+
+
+class SuggestionLanguage(BaseModel):
+    r"""The knowledge base language in which the Suggestion was created."""
+
+    code: SuggestionCode
+    r"""The language that describes the details of the resource. Resources available in different languages may differ from each other."""
+
+    label: Optional[Label] = None
+    r"""The name of the language."""
+
+
+class SuggestionTypedDict(TypedDict):
+    r"""This schema contains information about a Suggestion."""
+
+    id: str
+    r"""The ID of the Suggestion. A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    name: str
+    r"""The name of the Suggestion."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+    description: NotRequired[str]
+    r"""The description of the Suggestion."""
+    content: NotRequired[str]
+    r"""The content of the Suggestion."""
+    has_related_articles: NotRequired[bool]
+    r"""If true, the Suggestion has one or more Related Articles."""
+    status: NotRequired[SuggestionL10NStringTypedDict]
+    r"""The status of the Suggestion.
+    <li>1 : suggested.</li>
+    <li>2 : pending</li>
+    <li>3 : declined</li>
+    <li>4 : approved</li>
+    """
+    modified_by: NotRequired[ModifiedByTypedDict]
+    modified_date: NotRequired[datetime]
+    r"""The last modified date and last modifying user of the Suggestion."""
+    has_attachments: NotRequired[bool]
+    r"""Indicates whether the Suggestion has any Attachments."""
+    has_comments: NotRequired[bool]
+    r"""Indicates whether the Suggestion has any comments."""
+    language: NotRequired[SuggestionLanguageTypedDict]
+    r"""The knowledge base language in which the Suggestion was created."""
+    custom_attributes: NotRequired[List[CustomAttributeTypedDict]]
+    r"""Custom Attributes of the Suggestion."""
+
+
+class Suggestion(BaseModel):
+    r"""This schema contains information about a Suggestion."""
+
+    id: str
+    r"""The ID of the Suggestion. A Suggestion ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    name: str
+    r"""The name of the Suggestion."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""
+
+    description: Optional[str] = None
+    r"""The description of the Suggestion."""
+
+    content: Optional[str] = None
+    r"""The content of the Suggestion."""
+
+    has_related_articles: Annotated[
+        Optional[bool], pydantic.Field(alias="hasRelatedArticles")
+    ] = None
+    r"""If true, the Suggestion has one or more Related Articles."""
+
+    status: Optional[SuggestionL10NString] = None
+    r"""The status of the Suggestion.
+    <li>1 : suggested.</li>
+    <li>2 : pending</li>
+    <li>3 : declined</li>
+    <li>4 : approved</li>
+    """
+
+    modified_by: Annotated[Optional[ModifiedBy], pydantic.Field(alias="modifiedBy")] = (
+        None
+    )
+
+    modified_date: Annotated[
+        Optional[datetime], pydantic.Field(alias="modifiedDate")
+    ] = None
+    r"""The last modified date and last modifying user of the Suggestion."""
+
+    has_attachments: Annotated[
+        Optional[bool], pydantic.Field(alias="hasAttachments")
+    ] = None
+    r"""Indicates whether the Suggestion has any Attachments."""
+
+    has_comments: Annotated[Optional[bool], pydantic.Field(alias="hasComments")] = None
+    r"""Indicates whether the Suggestion has any comments."""
+
+    language: Optional[SuggestionLanguage] = None
+    r"""The knowledge base language in which the Suggestion was created."""
+
+    custom_attributes: Annotated[
+        Optional[List[CustomAttribute]], pydantic.Field(alias="customAttributes")
+    ] = None
+    r"""Custom Attributes of the Suggestion."""

egain_api_python/models/suggestionadditionalattributes.py

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

egain_api_python/models/suggestionattachment.py

@@ -0,0 +1,46 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .link import Link, LinkTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class SuggestionAttachmentTypedDict(TypedDict):
+    r"""This schema contains the definition of an Attachment."""
+
+    id: NotRequired[str]
+    r"""The ID of the Attachment."""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+    file_name: NotRequired[str]
+    r"""The name of the Attachment file.<li>This must not exceed 255 characters.</li>"""
+    size: NotRequired[int]
+    r"""The size of the Attachment.<li>Limited to 25MB.</li>"""
+    content_url: NotRequired[str]
+    r"""The content URL of the Attachment. Download immediately, as this unique URL exists temporarily and can only be retrieved once before deletion.
+
+    """
+
+
+class SuggestionAttachment(BaseModel):
+    r"""This schema contains the definition of an Attachment."""
+
+    id: Optional[str] = None
+    r"""The ID of the Attachment."""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""
+
+    file_name: Annotated[Optional[str], pydantic.Field(alias="fileName")] = None
+    r"""The name of the Attachment file.<li>This must not exceed 255 characters.</li>"""
+
+    size: Optional[int] = None
+    r"""The size of the Attachment.<li>Limited to 25MB.</li>"""
+
+    content_url: Annotated[Optional[str], pydantic.Field(alias="contentUrl")] = None
+    r"""The content URL of the Attachment. Download immediately, as this unique URL exists temporarily and can only be retrieved once before deletion.
+
+    """

egain_api_python/models/suggestions.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 .suggestion import Suggestion, SuggestionTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class SuggestionsTypedDict(TypedDict):
+    r"""One or more instances of Suggestion."""
+
+    suggestion: NotRequired[List[SuggestionTypedDict]]
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class Suggestions(BaseModel):
+    r"""One or more instances of Suggestion."""
+
+    suggestion: Annotated[
+        Optional[List[Suggestion]], pydantic.Field(alias="Suggestion")
+    ] = None
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/tag.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 TagTypedDict(TypedDict):
+    name: NotRequired[str]
+    id: NotRequired[str]
+
+
+class Tag(BaseModel):
+    name: Optional[str] = None
+
+    id: Optional[str] = None

egain_api_python/models/tagcategoriesforinterest.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .components_schemas_tagcategory import (
+    ComponentsSchemasTagCategory,
+    ComponentsSchemasTagCategoryTypedDict,
+)
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class TagCategoriesForInterestTypedDict(TypedDict):
+    tag_category: NotRequired[List[ComponentsSchemasTagCategoryTypedDict]]
+
+
+class TagCategoriesForInterest(BaseModel):
+    tag_category: Annotated[
+        Optional[List[ComponentsSchemasTagCategory]],
+        pydantic.Field(alias="tagCategory"),
+    ] = None

egain_api_python/models/tagcategory.py

@@ -0,0 +1,34 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .taggroups import TagGroups, TagGroupsTypedDict
+from .tags import Tags, TagsTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class TagCategoryTypedDict(TypedDict):
+    r"""A tag category is a grouping of tags and tag groups."""
+
+    name: NotRequired[str]
+    r"""The name of the tag category."""
+    id: NotRequired[str]
+    r"""The ID of the tag category. A tag category ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits."""
+    tags: NotRequired[TagsTypedDict]
+    tag_groups: NotRequired[TagGroupsTypedDict]
+
+
+class TagCategory(BaseModel):
+    r"""A tag category is a grouping of tags and tag groups."""
+
+    name: Optional[str] = None
+    r"""The name of the tag category."""
+
+    id: Optional[str] = None
+    r"""The ID of the tag category. A tag category ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits."""
+
+    tags: Optional[Tags] = None
+
+    tag_groups: Annotated[Optional[TagGroups], pydantic.Field(alias="tagGroups")] = None

egain_api_python/models/taggroup.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 TagGroupTypedDict(TypedDict):
+    name: NotRequired[str]
+    id: NotRequired[str]
+
+
+class TagGroup(BaseModel):
+    name: Optional[str] = None
+
+    id: Optional[str] = None

egain_api_python/models/taggroups.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .taggroup import TagGroup, TagGroupTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class TagGroupsTypedDict(TypedDict):
+    tag_group: NotRequired[List[TagGroupTypedDict]]
+    r"""An array of tag groups."""
+
+
+class TagGroups(BaseModel):
+    tag_group: Annotated[Optional[List[TagGroup]], pydantic.Field(alias="tagGroup")] = (
+        None
+    )
+    r"""An array of tag groups."""

egain_api_python/models/tags.py

@@ -0,0 +1,17 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .tag import Tag, TagTypedDict
+from egain_api_python.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class TagsTypedDict(TypedDict):
+    tag: NotRequired[List[TagTypedDict]]
+    r"""An array of tags."""
+
+
+class Tags(BaseModel):
+    tag: Optional[List[Tag]] = None
+    r"""An array of tags."""