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

egain_api_python/models/kblanguagecode.py

@@ -0,0 +1,48 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+KbLanguageCode = 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",
+    "nn-NO",
+]
+r"""A short language code. A list of codes can be found below:
+
+|Code|Description
+|----|-----------
+|en-US|English (United States)
+|en-GB|English (United Kingdom)
+|fr-FR|French (France)
+|es-ES|Spanish (Spain)
+|it-IT|Italian (Italy)
+|de-DE|German (Germany)
+|nl-NL|Dutch (Netherlands)
+|pt-BR|Portuguese (Brazil)
+|pt-PT|Portuguese (Portugal)
+|da-DK|Danish (Denmark)
+|sv-SE|Swedish (Sweden)
+|ru-RU|Russian (Russia)
+|fr-CA|French (Canada)
+|zh-CN|Chinese (Simplified, China)
+|ja-JP|Japanese (Japan)
+|ko-KR|Korean (South Korea)
+|nn-NO|Norwegian Nynorsk (Norway)
+
+"""

egain_api_python/models/kblanguages.py

@@ -0,0 +1,22 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .kblanguage import KbLanguage, KbLanguageTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class KbLanguagesTypedDict(TypedDict):
+    r"""KB languages"""
+
+    kb_language: NotRequired[List[KbLanguageTypedDict]]
+
+
+class KbLanguages(BaseModel):
+    r"""KB languages"""
+
+    kb_language: Annotated[
+        Optional[List[KbLanguage]], pydantic.Field(alias="KbLanguage")
+    ] = None

egain_api_python/models/knowledgeexport.py

@@ -0,0 +1,237 @@
+"""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, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+ArticleCategories = Literal[
+    "searchable",
+    "all",
+]
+r"""Category of articles to return. All includes browsable and searchable."""
+
+
+KnowledgeExportCode = 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",
+]
+r"""The code of the language."""
+
+
+class KnowledgeExportLanguageTypedDict(TypedDict):
+    r"""The Knowledge Base language in which the content is created."""
+
+    code: KnowledgeExportCode
+    r"""The code of the language."""
+
+
+class KnowledgeExportLanguage(BaseModel):
+    r"""The Knowledge Base language in which the content is created."""
+
+    code: KnowledgeExportCode
+    r"""The code of the language."""
+
+
+KnowledgeExportResourceType = Literal[
+    "articles",
+    "topics",
+    "portals",
+    "all",
+]
+
+
+DestinationType = Literal[
+    "AWS S3 bucket",
+    "Shared file path",
+]
+r"""Type of data destination"""
+
+
+class KnowledgeExportCredentialsTypedDict(TypedDict):
+    access_key: NotRequired[str]
+    secret_key: NotRequired[str]
+
+
+class KnowledgeExportCredentials(BaseModel):
+    access_key: Annotated[Optional[str], pydantic.Field(alias="accessKey")] = None
+
+    secret_key: Annotated[Optional[str], pydantic.Field(alias="secretKey")] = None
+
+
+class DataDestinationTypedDict(TypedDict):
+    destination_type: DestinationType
+    r"""Type of data destination"""
+    path: str
+    r"""Path of the data destination"""
+    region: NotRequired[str]
+    r"""Region of the data destination"""
+    credentials: NotRequired[KnowledgeExportCredentialsTypedDict]
+
+
+class DataDestination(BaseModel):
+    destination_type: Annotated[
+        DestinationType, pydantic.Field(alias="destinationType")
+    ]
+    r"""Type of data destination"""
+
+    path: str
+    r"""Path of the data destination"""
+
+    region: Optional[str] = None
+    r"""Region of the data destination"""
+
+    credentials: Optional[KnowledgeExportCredentials] = None
+
+
+class KnowledgeExportTypedDict(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."""
+    language: KnowledgeExportLanguageTypedDict
+    r"""The Knowledge Base language in which the content is created."""
+    resource_types: List[KnowledgeExportResourceType]
+    r"""Types of Knowledge Hub resources to export. Multiple values can be specified using a comma-separated list. Details of a single portal are exported.
+    Articles whose state is Published are returned.
+    | Portal Attribute Name | Description
+    | ------------------------------- | -----------
+    | id | The ID of the Portal in Readable format.
+    | alternateId | The system-generated ID of the Portal in long format.
+    | name  | The name of the Portal.
+    | description | The Portal's description.
+    | departmentId | ID of the department this Portal belongs to.
+    | defaultContentLanguageId | The default ID of the language for the portal content.
+
+    | Topic Attribute Name | Description
+    | ------------------------------ | -----------
+    | id | The ID of the Topic in Readable form.
+    | alternateId | The system-generated ID of the Topic in long form.
+    | name  | The name of the Topic.
+    | departmentId | ID of the department this Topic belongs to.
+    | modifiedDate | The date when the Topic was last modified on.
+    | topicHomeArticleId | The ID of the Article used as the home page of this Topic.
+    | childCount | Total number of children sub-topis below the current Topic.
+    | subTopicIds | Array with the list of sub-topics (all levels of the topic hierarchy).
+    | parentTopicId | ID of the parent Topic. -1 if it is the root Topic.
+    | imageURL | URL of the inline Topic image.
+    | customAttributes | One or more comma-separated names for Topic custom attributes defined by the user to be returned.
+
+    | Article Attribute Name | Description
+    | ---------------------- | -----------
+    | id | The ID of the Article in Readable form.
+    | alternateId | The system-generated ID of the Article in long form.
+    | name  | The name of the Article.
+    | additionalInfo | Additional information provided as Article metadata.
+    | type | The Article type object and its attributes.
+    | keywords | A comma-separated list of keywords associated with this Article, provided as metadata.
+    | summary | A brief summary of the Article, provided as metadata.
+    | state | The state of the Article. State P (Published).
+    | departmentId | ID of the department this Article belongs to.
+    | description | The description of the Article.
+    | imageURL | The URL of the image that is present in the Article version. It is used as the thumbnail image for the Article.
+    | attachements | The Article's uploaded attachments and their IDs.
+    | includeInGenAI  | Indicates whether this Article is used for eGain's generative AI features.
+    | topicBreadcrumb | Contains a list of topics from the top-level topic to this Article. There may be multiple paths.
+    | versionId | The ID of the Article version that is returned.
+    | expirationDate | The date that the Article is set to expire.
+    | averageRating | Average rating of the Article.
+    | timesRated | Number or times the Article was rated.
+    | availabilityDate | The date the Article is set to be available.
+    | articleMacro | The macro of the Article.
+    | content | path to the Article content in .html format.
+    | customAttributes | One or more comma-separated names for Article custom attributes defined by the user to be returned.
+    | personalization | Article personalization details, incuding tag categories.
+    | editions | The editions of the Article, including the publish profile (view) associated with each edition.
+
+    """
+    data_destination: DataDestinationTypedDict
+    article_categories: NotRequired[ArticleCategories]
+    r"""Category of articles to return. All includes browsable and searchable."""
+
+
+class KnowledgeExport(BaseModel):
+    portal_id: Annotated[str, pydantic.Field(alias="portalID")]
+    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: KnowledgeExportLanguage
+    r"""The Knowledge Base language in which the content is created."""
+
+    resource_types: Annotated[
+        List[KnowledgeExportResourceType], pydantic.Field(alias="resourceTypes")
+    ]
+    r"""Types of Knowledge Hub resources to export. Multiple values can be specified using a comma-separated list. Details of a single portal are exported.
+    Articles whose state is Published are returned.
+    | Portal Attribute Name | Description
+    | ------------------------------- | -----------
+    | id | The ID of the Portal in Readable format.
+    | alternateId | The system-generated ID of the Portal in long format.
+    | name  | The name of the Portal.
+    | description | The Portal's description.
+    | departmentId | ID of the department this Portal belongs to.
+    | defaultContentLanguageId | The default ID of the language for the portal content.
+
+    | Topic Attribute Name | Description
+    | ------------------------------ | -----------
+    | id | The ID of the Topic in Readable form.
+    | alternateId | The system-generated ID of the Topic in long form.
+    | name  | The name of the Topic.
+    | departmentId | ID of the department this Topic belongs to.
+    | modifiedDate | The date when the Topic was last modified on.
+    | topicHomeArticleId | The ID of the Article used as the home page of this Topic.
+    | childCount | Total number of children sub-topis below the current Topic.
+    | subTopicIds | Array with the list of sub-topics (all levels of the topic hierarchy).
+    | parentTopicId | ID of the parent Topic. -1 if it is the root Topic.
+    | imageURL | URL of the inline Topic image.
+    | customAttributes | One or more comma-separated names for Topic custom attributes defined by the user to be returned.
+
+    | Article Attribute Name | Description
+    | ---------------------- | -----------
+    | id | The ID of the Article in Readable form.
+    | alternateId | The system-generated ID of the Article in long form.
+    | name  | The name of the Article.
+    | additionalInfo | Additional information provided as Article metadata.
+    | type | The Article type object and its attributes.
+    | keywords | A comma-separated list of keywords associated with this Article, provided as metadata.
+    | summary | A brief summary of the Article, provided as metadata.
+    | state | The state of the Article. State P (Published).
+    | departmentId | ID of the department this Article belongs to.
+    | description | The description of the Article.
+    | imageURL | The URL of the image that is present in the Article version. It is used as the thumbnail image for the Article.
+    | attachements | The Article's uploaded attachments and their IDs.
+    | includeInGenAI  | Indicates whether this Article is used for eGain's generative AI features.
+    | topicBreadcrumb | Contains a list of topics from the top-level topic to this Article. There may be multiple paths.
+    | versionId | The ID of the Article version that is returned.
+    | expirationDate | The date that the Article is set to expire.
+    | averageRating | Average rating of the Article.
+    | timesRated | Number or times the Article was rated.
+    | availabilityDate | The date the Article is set to be available.
+    | articleMacro | The macro of the Article.
+    | content | path to the Article content in .html format.
+    | customAttributes | One or more comma-separated names for Article custom attributes defined by the user to be returned.
+    | personalization | Article personalization details, incuding tag categories.
+    | editions | The editions of the Article, including the publish profile (view) associated with each edition.
+
+    """
+
+    data_destination: Annotated[
+        DataDestination, pydantic.Field(alias="dataDestination")
+    ]
+
+    article_categories: Annotated[
+        Optional[ArticleCategories], pydantic.Field(alias="articleCategories")
+    ] = "searchable"
+    r"""Category of articles to return. All includes browsable and searchable."""

egain_api_python/models/l10nstring.py

@@ -0,0 +1,22 @@
+"""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 L10NStringTypedDict(TypedDict):
+    value: NotRequired[str]
+    r"""A string that indicates the value."""
+    display_value: NotRequired[str]
+    r"""Localized string of the value element."""
+
+
+class L10NString(BaseModel):
+    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."""

egain_api_python/models/languagecode.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+LanguageCode = Literal[
+    "en-US",
+    "fr-FR",
+    "en-GB",
+    "es-ES",
+    "it-IT",
+    "nl-NL",
+    "da-DA",
+    "sv-SE",
+    "pt-PT",
+    "fi-FI",
+    "no-NB",
+    "no-NN",
+    "ja-JA",
+    "de-DE",
+    "pt-BR",
+    "zh-CN",
+    "zh-TW",
+    "ko-KO",
+    "ru-RU",
+    "el-EL",
+    "tr-TR",
+    "pl-PL",
+    "cs-CS",
+    "sk-SK",
+    "hu-HU",
+    "sr-SR",
+    "ar-SA",
+    "hr-HR",
+    "ro-RO",
+    "th-TH",
+]
+r"""Language code of the resource's language."""

egain_api_python/models/languagecode_parameter.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+LanguageCodeParameter = Literal[
+    "en-US",
+    "fr-FR",
+    "en-GB",
+    "es-ES",
+    "it-IT",
+    "nl-NL",
+    "da-DA",
+    "sv-SE",
+    "pt-PT",
+    "fi-FI",
+    "no-NB",
+    "no-NN",
+    "ja-JA",
+    "de-DE",
+    "pt-BR",
+    "zh-CN",
+    "zh-TW",
+    "ko-KO",
+    "ru-RU",
+    "el-EL",
+    "tr-TR",
+    "pl-PL",
+    "cs-CS",
+    "sk-SK",
+    "hu-HU",
+    "sr-SR",
+    "ar-SA",
+    "hr-HR",
+    "ro-RO",
+    "th-TH",
+    "xx-XX",
+]

egain_api_python/models/languagequeryparameter.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+LanguageQueryParameter = Literal[
+    "en-US",
+    "fr-FR",
+    "en-GB",
+    "es-ES",
+    "it-IT",
+    "nl-NL",
+    "da-DA",
+    "sv-SE",
+    "pt-PT",
+    "fi-FI",
+    "no-NB",
+    "no-NN",
+    "ja-JA",
+    "de-DE",
+    "pt-BR",
+    "zh-CN",
+    "zh-TW",
+    "ko-KO",
+    "ru-RU",
+    "el-EL",
+    "tr-TR",
+    "pl-PL",
+    "cs-CS",
+    "sk-SK",
+    "hu-HU",
+    "sr-SR",
+    "ar-SA",
+    "hr-HR",
+    "ro-RO",
+    "th-TH",
+    "xx-XX",
+]

egain_api_python/models/link.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 typing import Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class LinkTypedDict(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 Link(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."""

egain_api_python/models/makesuggestionop.py

@@ -0,0 +1,44 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .createsuggestion import CreateSuggestion, CreateSuggestionTypedDict
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class MakeSuggestionRequestTypedDict(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."""
+    create_suggestion: NotRequired[CreateSuggestionTypedDict]
+
+
+class MakeSuggestionRequest(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."""
+
+    create_suggestion: Annotated[
+        Optional[CreateSuggestion],
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ] = None

egain_api_python/models/mandatorylanguagequeryparameter.py

@@ -0,0 +1,38 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+MandatoryLanguageQueryParameter = Literal[
+    "en-US",
+    "fr-FR",
+    "en-GB",
+    "es-ES",
+    "it-IT",
+    "nl-NL",
+    "da-DA",
+    "sv-SE",
+    "pt-PT",
+    "fi-FI",
+    "no-NB",
+    "no-NN",
+    "ja-JA",
+    "de-DE",
+    "pt-BR",
+    "zh-CN",
+    "zh-TW",
+    "ko-KO",
+    "ru-RU",
+    "el-EL",
+    "tr-TR",
+    "pl-PL",
+    "cs-CS",
+    "sk-SK",
+    "hu-HU",
+    "sr-SR",
+    "ar-SA",
+    "hr-HR",
+    "ro-RO",
+    "th-TH",
+]

egain_api_python/models/metadata.py

@@ -0,0 +1,29 @@
+"""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 MetadataTypedDict(TypedDict):
+    title: NotRequired[str]
+    r"""content of the title"""
+    additional_information: NotRequired[str]
+    r"""content of the additional information"""
+    action: NotRequired[str]
+    r"""content of the action"""
+
+
+class Metadata(BaseModel):
+    title: Optional[str] = None
+    r"""content of the title"""
+
+    additional_information: Annotated[
+        Optional[str], pydantic.Field(alias="additionalInformation")
+    ] = None
+    r"""content of the additional information"""
+
+    action: Optional[str] = None
+    r"""content of the action"""

egain_api_python/models/milestone.py

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

egain_api_python/models/milestonename.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 MilestoneNameTypedDict(TypedDict):
+    r"""The identifiers of the milestone."""
+
+    value: NotRequired[str]
+    r"""The name of the milestone."""
+    display_value: NotRequired[str]
+    r"""The readable name of the milestone."""
+
+
+class MilestoneName(BaseModel):
+    r"""The identifiers of the milestone."""
+
+    value: Optional[str] = None
+    r"""The name of the milestone."""
+
+    display_value: Annotated[Optional[str], pydantic.Field(alias="displayValue")] = None
+    r"""The readable name of the milestone."""

egain_api_python/models/milestones.py

@@ -0,0 +1,21 @@
+"""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 List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class MilestonesTypedDict(TypedDict):
+    r"""Success"""
+
+    milestone: NotRequired[List[MilestoneTypedDict]]
+    r"""milestones"""
+
+
+class Milestones(BaseModel):
+    r"""Success"""
+
+    milestone: Optional[List[Milestone]] = None
+    r"""milestones"""