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

egain_api_python/models/modifiedby.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 ModifiedByTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The ID of the user that modified this resource."""
+    user_name: NotRequired[str]
+    r"""The resource modifier's username."""
+    first_name: NotRequired[str]
+    r"""The resource modifier's first name."""
+    middle_name: NotRequired[str]
+    r"""The resource modifier's middle name."""
+    last_name: NotRequired[str]
+    r"""The resource modifier's last name."""
+
+
+class ModifiedBy(BaseModel):
+    id: Optional[str] = None
+    r"""The ID of the user that modified this resource."""
+
+    user_name: Annotated[Optional[str], pydantic.Field(alias="userName")] = None
+    r"""The resource modifier's username."""
+
+    first_name: Annotated[Optional[str], pydantic.Field(alias="firstName")] = None
+    r"""The resource modifier's first name."""
+
+    middle_name: Annotated[Optional[str], pydantic.Field(alias="middleName")] = None
+    r"""The resource modifier's middle name."""
+
+    last_name: Annotated[Optional[str], pydantic.Field(alias="lastName")] = None
+    r"""The resource modifier's last name."""

egain_api_python/models/modifysuggestion.py

@@ -0,0 +1,78 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .attachmentforcreatesuggestion import (
+    AttachmentForCreateSuggestion,
+    AttachmentForCreateSuggestionTypedDict,
+)
+from .customattribute import CustomAttribute, CustomAttributeTypedDict
+from .link import Link, LinkTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ModifySuggestionAttachmentsTypedDict(TypedDict):
+    r"""Details of Attachments for the Suggestion."""
+
+    attachment: NotRequired[List[AttachmentForCreateSuggestionTypedDict]]
+    r"""The list of Attachments.<br><br>Required if <code>content</code> and <code>Attachments.unlink</code> are both _not_ provided."""
+    unlink: NotRequired[List[LinkTypedDict]]
+    r"""If provided with references to Attachments, <code>unlink</code> removes the Attachment from the Suggestion.<br><br>If the Attachment has no associated objects, it will be deleted.<br><br>Required if <code>content</code> and <code>Attachments.Attachment</code> are both _not_ provided."""
+
+
+class ModifySuggestionAttachments(BaseModel):
+    r"""Details of Attachments for the Suggestion."""
+
+    attachment: Optional[List[AttachmentForCreateSuggestion]] = None
+    r"""The list of Attachments.<br><br>Required if <code>content</code> and <code>Attachments.unlink</code> are both _not_ provided."""
+
+    unlink: Optional[List[Link]] = None
+    r"""If provided with references to Attachments, <code>unlink</code> removes the Attachment from the Suggestion.<br><br>If the Attachment has no associated objects, it will be deleted.<br><br>Required if <code>content</code> and <code>Attachments.Attachment</code> are both _not_ provided."""
+
+
+class ModifySuggestionTypedDict(TypedDict):
+    r"""This schema contains information about modifying 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."""
+    modified_date: str
+    r"""The date on which the Suggestion was last modified."""
+    name: NotRequired[str]
+    r"""The name of the Suggestion."""
+    description: NotRequired[str]
+    r"""The description of the Suggestion."""
+    content: NotRequired[str]
+    r"""The content of the Suggestion."""
+    attachments: NotRequired[ModifySuggestionAttachmentsTypedDict]
+    r"""Details of Attachments for the Suggestion."""
+    custom_attributes: NotRequired[List[CustomAttributeTypedDict]]
+    r"""Custom Attributes of the Suggestion."""
+
+
+class ModifySuggestion(BaseModel):
+    r"""This schema contains information about modifying 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."""
+
+    modified_date: Annotated[str, pydantic.Field(alias="modifiedDate")]
+    r"""The date on which the Suggestion was last modified."""
+
+    name: Optional[str] = None
+    r"""The name of the Suggestion."""
+
+    description: Optional[str] = None
+    r"""The description of the Suggestion."""
+
+    content: Optional[str] = None
+    r"""The content of the Suggestion."""
+
+    attachments: Optional[ModifySuggestionAttachments] = None
+    r"""Details of Attachments for the Suggestion."""
+
+    custom_attributes: Annotated[
+        Optional[List[CustomAttribute]], pydantic.Field(alias="customAttributes")
+    ] = None
+    r"""Custom Attributes of the Suggestion."""

egain_api_python/models/modifysuggestionsop.py

@@ -0,0 +1,44 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .acceptlanguage import AcceptLanguage
+from .modifysuggestion import ModifySuggestion, ModifySuggestionTypedDict
+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 ModifySuggestionsRequestTypedDict(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."""
+    modify_suggestion: NotRequired[ModifySuggestionTypedDict]
+
+
+class ModifySuggestionsRequest(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."""
+
+    modify_suggestion: Annotated[
+        Optional[ModifySuggestion],
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ] = None

egain_api_python/models/optionalarticleattributes.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from typing import Literal
+
+
+OptionalArticleAttributes = Literal[
+    "articleMacro",
+    "availabilityDate",
+    "averageRating",
+    "contentText",
+    "orderNumber",
+    "suggestionType",
+    "timesRated",
+    "availableEditions",
+    "articleTypeAttributes",
+    "milestone",
+    "all",
+]
+r"""The fields of the article to be returned."""

egain_api_python/models/order.py

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

egain_api_python/models/ownedby.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 OwnedByTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""The ID of the user that owns this resource."""
+    user_name: NotRequired[str]
+    r"""The resource owner's username."""
+    first_name: NotRequired[str]
+    r"""The resource owner's first name."""
+    middle_name: NotRequired[str]
+    r"""The resource owner's middle name."""
+    last_name: NotRequired[str]
+    r"""The resource owner's last name."""
+
+
+class OwnedBy(BaseModel):
+    id: Optional[str] = None
+    r"""The ID of the user that owns this resource."""
+
+    user_name: Annotated[Optional[str], pydantic.Field(alias="userName")] = None
+    r"""The resource owner's username."""
+
+    first_name: Annotated[Optional[str], pydantic.Field(alias="firstName")] = None
+    r"""The resource owner's first name."""
+
+    middle_name: Annotated[Optional[str], pydantic.Field(alias="middleName")] = None
+    r"""The resource owner's middle name."""
+
+    last_name: Annotated[Optional[str], pydantic.Field(alias="lastName")] = None
+    r"""The resource owner's last name."""

egain_api_python/models/paginationinfo.py

@@ -0,0 +1,32 @@
+"""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
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class PaginationInfoTypedDict(TypedDict):
+    count: int
+    r"""The total number of pages."""
+    pagenum: int
+    r"""The page number requested. Page numbers start from 1."""
+    pagesize: int
+    r"""The number of objects requested per page. The maximum number of objects per page is 75."""
+    link: NotRequired[List[LinkTypedDict]]
+    r"""Can include the *prev* and *next* link."""
+
+
+class PaginationInfo(BaseModel):
+    count: int
+    r"""The total number of pages."""
+
+    pagenum: int
+    r"""The page number requested. Page numbers start from 1."""
+
+    pagesize: int
+    r"""The number of objects requested per page. The maximum number of objects per page is 75."""
+
+    link: Optional[List[Link]] = None
+    r"""Can include the *prev* and *next* link."""

egain_api_python/models/patchimportcontentvalidationop.py

@@ -0,0 +1,46 @@
+"""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, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS = [
+    # Production Server
+    "https://${API_DOMAIN}/knowledge/contentmgr/v4",
+]
+
+
+class PatchImportContentValidationRequestTypedDict(TypedDict):
+    job_id: str
+    r"""**Job ID Parameter**
+
+    The unique identifier for the import or validation job. This ID was returned when the job was created via the Import or Validate API.
+
+    **Format:** UUID v4 (e.g., 7A84B875-6F75-4C7B-B137-0632B62DB0BD)
+
+    **Example Usage:**
+    ```bash
+    GET /import/content/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status
+    ```
+
+    """
+
+
+class PatchImportContentValidationRequest(BaseModel):
+    job_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""**Job ID Parameter**
+
+    The unique identifier for the import or validation job. This ID was returned when the job was created via the Import or Validate API.
+
+    **Format:** UUID v4 (e.g., 7A84B875-6F75-4C7B-B137-0632B62DB0BD)
+
+    **Example Usage:**
+    ```bash
+    GET /import/content/7A84B875-6F75-4C7B-B137-0632B62DB0BD/status
+    ```
+
+    """

egain_api_python/models/personalization.py

@@ -0,0 +1,67 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .publishview import PublishView, PublishViewTypedDict
+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 PersonalizationAccessTagsTypedDict(TypedDict):
+    tag_category: NotRequired[List[TagCategoryTypedDict]]
+    r"""An array of tag categories. Note that the total number of tag categories cannot exceed 20."""
+
+
+class PersonalizationAccessTags(BaseModel):
+    tag_category: Annotated[
+        Optional[List[TagCategory]], pydantic.Field(alias="tagCategory")
+    ] = None
+    r"""An array of tag categories. Note that the total number of tag categories cannot exceed 20."""
+
+
+class FiltersTypedDict(TypedDict):
+    tag_category: NotRequired[List[TagCategoryTypedDict]]
+    r"""An array of tag categories. Note that the total number of tag categories cannot exceed 20."""
+
+
+class Filters(BaseModel):
+    tag_category: Annotated[
+        Optional[List[TagCategory]], pydantic.Field(alias="tagCategory")
+    ] = None
+    r"""An array of tag categories. Note that the total number of tag categories cannot exceed 20."""
+
+
+class PublishViewsTypedDict(TypedDict):
+    publish_view: NotRequired[List[PublishViewTypedDict]]
+    r"""Publish views allow authors to tailor the contents of an article to different audiences by controlling visibility of certain article content using tags.<br><br>The total number of publish views is limited to 20."""
+
+
+class PublishViews(BaseModel):
+    publish_view: Annotated[
+        Optional[List[PublishView]], pydantic.Field(alias="publishView")
+    ] = None
+    r"""Publish views allow authors to tailor the contents of an article to different audiences by controlling visibility of certain article content using tags.<br><br>The total number of publish views is limited to 20."""
+
+
+class PersonalizationTypedDict(TypedDict):
+    r"""Personalization allows the filtering of search results and controls the access to articles and article editions."""
+
+    access_tags: NotRequired[PersonalizationAccessTagsTypedDict]
+    filters: NotRequired[FiltersTypedDict]
+    publish_views: NotRequired[PublishViewsTypedDict]
+
+
+class Personalization(BaseModel):
+    r"""Personalization allows the filtering of search results and controls the access to articles and article editions."""
+
+    access_tags: Annotated[
+        Optional[PersonalizationAccessTags], pydantic.Field(alias="accessTags")
+    ] = None
+
+    filters: Optional[Filters] = None
+
+    publish_views: Annotated[
+        Optional[PublishViews], pydantic.Field(alias="publishViews")
+    ] = None

egain_api_python/models/phone.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
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PhoneTypedDict(TypedDict):
+    r"""Phone"""
+
+    phone_no: NotRequired[str]
+    r"""Phone number of customer"""
+
+
+class Phone(BaseModel):
+    r"""Phone"""
+
+    phone_no: Annotated[Optional[str], pydantic.Field(alias="phoneNo")] = None
+    r"""Phone number of customer"""

egain_api_python/models/portal.py

@@ -0,0 +1,102 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .createdby import CreatedBy, CreatedByTypedDict
+from .kblanguages import KbLanguages, KbLanguagesTypedDict
+from .link import Link, LinkTypedDict
+from .modifiedby import ModifiedBy, ModifiedByTypedDict
+from .portalsettings import PortalSettings, PortalSettingsTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PortalTypedDict(TypedDict):
+    id: str
+    r"""The alphanumeric ID of the portal.<br><br>A topic ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    name: str
+    r"""The name of the portal."""
+    department_id: NotRequired[str]
+    r"""The ID of the department."""
+    description: NotRequired[str]
+    r"""The description of the portal."""
+    default_content_language_id: NotRequired[str]
+    r"""The default ID of the language for the portal content."""
+    default_content_language_code: NotRequired[str]
+    r"""The IETF code of the default language for the portal content."""
+    created_by: NotRequired[CreatedByTypedDict]
+    created_date: NotRequired[str]
+    r"""The date that the portal was created."""
+    modified_by: NotRequired[ModifiedByTypedDict]
+    modified_date: NotRequired[str]
+    r"""The date on which the portal was last modified."""
+    is_structured_authoring_enabled: NotRequired[bool]
+    r"""Indicates if Structured Authoring is enabled for the portal."""
+    enable_draft_search_in_portal: NotRequired[bool]
+    r"""Indicates if Enable Portal Search for Draft and Staging Articles is enabled for the portal."""
+    portal_settings: NotRequired[PortalSettingsTypedDict]
+    r"""The settings for this portal."""
+    kb_languages: NotRequired[KbLanguagesTypedDict]
+    r"""KB languages"""
+    link: NotRequired[LinkTypedDict]
+    r"""Defines the relationship between this resource and another object."""
+
+
+class Portal(BaseModel):
+    id: str
+    r"""The alphanumeric ID of the portal.<br><br>A topic ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    name: str
+    r"""The name of the portal."""
+
+    department_id: Annotated[Optional[str], pydantic.Field(alias="departmentId")] = None
+    r"""The ID of the department."""
+
+    description: Optional[str] = None
+    r"""The description of the portal."""
+
+    default_content_language_id: Annotated[
+        Optional[str], pydantic.Field(alias="defaultContentLanguageId")
+    ] = None
+    r"""The default ID of the language for the portal content."""
+
+    default_content_language_code: Annotated[
+        Optional[str], pydantic.Field(alias="defaultContentLanguageCode")
+    ] = None
+    r"""The IETF code of the default language for the portal content."""
+
+    created_by: Annotated[Optional[CreatedBy], pydantic.Field(alias="createdBy")] = None
+
+    created_date: Annotated[Optional[str], pydantic.Field(alias="createdDate")] = None
+    r"""The date that the portal was created."""
+
+    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 portal was last modified."""
+
+    is_structured_authoring_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isStructuredAuthoringEnabled")
+    ] = None
+    r"""Indicates if Structured Authoring is enabled for the portal."""
+
+    enable_draft_search_in_portal: Annotated[
+        Optional[bool], pydantic.Field(alias="enableDraftSearchInPortal")
+    ] = None
+    r"""Indicates if Enable Portal Search for Draft and Staging Articles is enabled for the portal."""
+
+    portal_settings: Annotated[
+        Optional[PortalSettings], pydantic.Field(alias="portalSettings")
+    ] = None
+    r"""The settings for this portal."""
+
+    kb_languages: Annotated[
+        Optional[KbLanguages], pydantic.Field(alias="kbLanguages")
+    ] = None
+    r"""KB languages"""
+
+    link: Optional[Link] = None
+    r"""Defines the relationship between this resource and another object."""

egain_api_python/models/portalresult.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 .portal import Portal, PortalTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PortalResultTypedDict(TypedDict):
+    r"""Success"""
+
+    portal: NotRequired[List[PortalTypedDict]]
+    r"""portals"""
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class PortalResult(BaseModel):
+    r"""Success"""
+
+    portal: Optional[List[Portal]] = None
+    r"""portals"""
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None