egain-api-python 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

egain_api_python/models/gethealthop.py

@@ -1,10 +1,10 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from datetime import datetime
 from egain_api_python.types import BaseModel
-from typing import Optional
-from typing_extensions import NotRequired, TypedDict
+import pydantic
+from typing import Any, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 GET_HEALTH_OP_SERVERS = [
@@ -13,6 +13,133 @@ GET_HEALTH_OP_SERVERS = [
 ]
 
 
+ServiceUnavailableStatus = Literal[
+    "healthy",
+    "degraded",
+    "unhealthy",
+    "maintenance",
+]
+r"""**Health Status**
+
+The overall health status of the service. Possible values:
+- **healthy**: Service is operating normally
+- **degraded**: Service is functional but with performance issues
+- **unhealthy**: Service is experiencing critical issues
+- **maintenance**: Service is under planned maintenance
+
+"""
+
+
+Database = Literal[
+    "healthy",
+    "degraded",
+    "unhealthy",
+    "maintenance",
+]
+r"""Health status of database component."""
+
+
+FileSystem = Literal[
+    "healthy",
+    "degraded",
+    "unhealthy",
+    "maintenance",
+]
+r"""Health status of file system component."""
+
+
+ExternalServices = Literal[
+    "healthy",
+    "degraded",
+    "unhealthy",
+    "maintenance",
+]
+r"""Health status of external services components."""
+
+
+ProcessingEngine = Literal[
+    "healthy",
+    "degraded",
+    "unhealthy",
+    "maintenance",
+]
+r"""Health status of processing engine component."""
+
+
+Storage = Literal[
+    "healthy",
+    "degraded",
+    "unhealthy",
+    "maintenance",
+]
+r"""Health status of storage component."""
+
+
+class ComponentsTypedDict(TypedDict):
+    r"""**Comonents**:
+
+    Health status of import service componenets
+
+    """
+
+    database: NotRequired[Database]
+    r"""Health status of database component."""
+    file_system: NotRequired[FileSystem]
+    r"""Health status of file system component."""
+    external_services: NotRequired[ExternalServices]
+    r"""Health status of external services components."""
+    processing_engine: NotRequired[ProcessingEngine]
+    r"""Health status of processing engine component."""
+    storage: NotRequired[Storage]
+    r"""Health status of storage component."""
+
+
+class Components(BaseModel):
+    r"""**Comonents**:
+
+    Health status of import service componenets
+
+    """
+
+    database: Optional[Database] = None
+    r"""Health status of database component."""
+
+    file_system: Annotated[Optional[FileSystem], pydantic.Field(alias="fileSystem")] = (
+        None
+    )
+    r"""Health status of file system component."""
+
+    external_services: Annotated[
+        Optional[ExternalServices], pydantic.Field(alias="externalServices")
+    ] = None
+    r"""Health status of external services components."""
+
+    processing_engine: Annotated[
+        Optional[ProcessingEngine], pydantic.Field(alias="processingEngine")
+    ] = None
+    r"""Health status of processing engine component."""
+
+    storage: Optional[Storage] = None
+    r"""Health status of storage component."""
+
+
+GetHealthStatus = Literal[
+    "healthy",
+    "degraded",
+    "unhealthy",
+    "maintenance",
+]
+r"""**Health Status**
+
+The overall health status of the service. Possible values:
+- **healthy**: Service is operating normally
+- **degraded**: Service is functional but with performance issues
+- **unhealthy**: Service is experiencing critical issues
+- **maintenance**: Service is under planned maintenance
+
+"""
+
+
 class GetHealthResponseTypedDict(TypedDict):
     r"""## Service is Healthy
 
@@ -28,7 +155,7 @@ class GetHealthResponseTypedDict(TypedDict):
 
     """
 
-    status: NotRequired[str]
+    status: NotRequired[GetHealthStatus]
     r"""**Health Status**
 
     The overall health status of the service. Possible values:
@@ -38,7 +165,7 @@ class GetHealthResponseTypedDict(TypedDict):
     - **maintenance**: Service is under planned maintenance
 
     """
-    timestamp: NotRequired[datetime]
+    timestamp: NotRequired[Any]
     r"""**Health Check Timestamp**
 
     The exact date and time when this health check was performed. This is useful for:
@@ -85,7 +212,7 @@ class GetHealthResponse(BaseModel):
 
     """
 
-    status: Optional[str] = None
+    status: Optional[GetHealthStatus] = None
     r"""**Health Status**
 
     The overall health status of the service. Possible values:
@@ -96,7 +223,7 @@ class GetHealthResponse(BaseModel):
 
     """
 
-    timestamp: Optional[datetime] = None
+    timestamp: Optional[Any] = None
     r"""**Health Check Timestamp**
 
     The exact date and time when this health check was performed. This is useful for:

egain_api_python/models/{patchimportcontentvalidationop.py → getimportstatusop.py}

@@ -6,13 +6,13 @@ from egain_api_python.utils import FieldMetadata, PathParamMetadata
 from typing_extensions import Annotated, TypedDict
 
 
-PATCH_IMPORT_CONTENT_VALIDATION_OP_SERVERS = [
+GET_IMPORT_STATUS_OP_SERVERS = [
     # Production Server
     "https://${API_DOMAIN}/knowledge/contentmgr/v4",
 ]
 
 
-class PatchImportContentValidationRequestTypedDict(TypedDict):
+class GetImportStatusRequestTypedDict(TypedDict):
     job_id: str
     r"""**Job ID Parameter**
 
@@ -28,7 +28,7 @@ class PatchImportContentValidationRequestTypedDict(TypedDict):
     """
 
 
-class PatchImportContentValidationRequest(BaseModel):
+class GetImportStatusRequest(BaseModel):
     job_id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]

egain_api_python/models/getpopulararticlesop.py

@@ -21,11 +21,11 @@ class GetpopulararticlesRequestTypedDict(TypedDict):
     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."""
-    dollar_filter_topic_id: NotRequired[str]
+    filter_topic_id: NotRequired[str]
     r"""The ID of the topic. It is used to restrict to a specific topic."""
     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>"""
-    dollar_filter_tags: NotRequired[str]
+    filter_tags: NotRequired[str]
     r"""A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together."""
     pagenum: NotRequired[int]
     r"""Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."""
@@ -71,7 +71,7 @@ class GetpopulararticlesRequest(BaseModel):
     ]
     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."""
 
-    dollar_filter_topic_id: Annotated[
+    filter_topic_id: Annotated[
         Optional[str],
         pydantic.Field(alias="$filter[topicId]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -85,7 +85,7 @@ class GetpopulararticlesRequest(BaseModel):
     ] = 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>"""
 
-    dollar_filter_tags: Annotated[
+    filter_tags: Annotated[
         Optional[str],
         pydantic.Field(alias="$filter[tags]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),

egain_api_python/models/getrelatedarticlesop.py

@@ -24,7 +24,7 @@ class GetRelatedArticlesRequestTypedDict(TypedDict):
     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."""
-    dollar_filter_tags: NotRequired[str]
+    filter_tags: NotRequired[str]
     r"""A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together."""
     article_result_additional_attributes: NotRequired[
         List[ArticleResultAdditionalAttributes]
@@ -81,7 +81,7 @@ class GetRelatedArticlesRequest(BaseModel):
     ]
     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."""
 
-    dollar_filter_tags: Annotated[
+    filter_tags: Annotated[
         Optional[str],
         pydantic.Field(alias="$filter[tags]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),

egain_api_python/models/importstatus.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from datetime import datetime
 from egain_api_python.types import BaseModel
 import pydantic
 from typing import Literal, Optional
@@ -14,16 +15,131 @@ ImportStatusStatus = Literal[
     "Failed",
     "Cancelled",
 ]
+r"""Status of the job."""
+
+
+JobType = Literal[
+    "Import",
+    "Validation",
+]
+
+
+class ImportStatusProgressTypedDict(TypedDict):
+    r"""Progress of the job."""
+
+    processed: NotRequired[float]
+    r"""Number of items processed."""
+    total: NotRequired[float]
+    r"""Number of total items to process."""
+    percentage: NotRequired[float]
+    r"""Percentage of total items that have been processed."""
+
+
+class ImportStatusProgress(BaseModel):
+    r"""Progress of the job."""
+
+    processed: Optional[float] = None
+    r"""Number of items processed."""
+
+    total: Optional[float] = None
+    r"""Number of total items to process."""
+
+    percentage: Optional[float] = None
+    r"""Percentage of total items that have been processed."""
+
+
+class ImportStatusResultsTypedDict(TypedDict):
+    r"""Result of job."""
+
+    succesfull: NotRequired[float]
+    r"""Number of item succesfully processed by job."""
+    warnings: NotRequired[float]
+    r"""Number of warnings encountered during job."""
+    errors: NotRequired[float]
+    r"""Number of errors encountered during job."""
+
+
+class ImportStatusResults(BaseModel):
+    r"""Result of job."""
+
+    succesfull: Optional[float] = None
+    r"""Number of item succesfully processed by job."""
+
+    warnings: Optional[float] = None
+    r"""Number of warnings encountered during job."""
+
+    errors: Optional[float] = None
+    r"""Number of errors encountered during job."""
 
 
 class ImportStatusTypedDict(TypedDict):
     status: ImportStatusStatus
+    r"""Status of the job."""
+    job_type: JobType
+    progress: NotRequired[ImportStatusProgressTypedDict]
+    r"""Progress of the job."""
     log_file_location: NotRequired[str]
+    r"""Location of the job log file."""
+    start_time: NotRequired[datetime]
+    r"""Start time of job."""
+    estimated_completion: NotRequired[datetime]
+    r"""Estimated completion time of job."""
+    current_operation: NotRequired[str]
+    r"""Current operation of job being processed."""
+    completion_time: NotRequired[datetime]
+    r"""Completion time of job."""
+    failure_time: NotRequired[datetime]
+    r"""Failure time of job."""
+    results: NotRequired[ImportStatusResultsTypedDict]
+    r"""Result of job."""
+    error: NotRequired[str]
+    r"""Error of job."""
+    retryable: NotRequired[bool]
+    r"""Indicates if job is retryable."""
 
 
 class ImportStatus(BaseModel):
     status: ImportStatusStatus
+    r"""Status of the job."""
+
+    job_type: Annotated[JobType, pydantic.Field(alias="jobType")]
+
+    progress: Optional[ImportStatusProgress] = None
+    r"""Progress of the job."""
 
     log_file_location: Annotated[
         Optional[str], pydantic.Field(alias="logFileLocation")
     ] = None
+    r"""Location of the job log file."""
+
+    start_time: Annotated[Optional[datetime], pydantic.Field(alias="startTime")] = None
+    r"""Start time of job."""
+
+    estimated_completion: Annotated[
+        Optional[datetime], pydantic.Field(alias="estimatedCompletion")
+    ] = None
+    r"""Estimated completion time of job."""
+
+    current_operation: Annotated[
+        Optional[str], pydantic.Field(alias="currentOperation")
+    ] = None
+    r"""Current operation of job being processed."""
+
+    completion_time: Annotated[
+        Optional[datetime], pydantic.Field(alias="completionTime")
+    ] = None
+    r"""Completion time of job."""
+
+    failure_time: Annotated[Optional[datetime], pydantic.Field(alias="failureTime")] = (
+        None
+    )
+    r"""Failure time of job."""
+
+    results: Optional[ImportStatusResults] = None
+    r"""Result of job."""
+
+    error: Optional[str] = None
+    r"""Error of job."""
+
+    retryable: Optional[bool] = None
+    r"""Indicates if job is retryable."""

egain_api_python/models/knowledgeexport.py

@@ -48,7 +48,7 @@ class KnowledgeExportLanguage(BaseModel):
     r"""The code of the language."""
 
 
-KnowledgeExportResourceType = Literal[
+ResourceType = Literal[
     "articles",
     "topics",
     "portals",
@@ -104,7 +104,7 @@ class KnowledgeExportTypedDict(TypedDict):
     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]
+    resource_types: List[ResourceType]
     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
@@ -170,9 +170,7 @@ class KnowledgeExport(BaseModel):
     language: KnowledgeExportLanguage
     r"""The Knowledge Base language in which the content is created."""
 
-    resource_types: Annotated[
-        List[KnowledgeExportResourceType], pydantic.Field(alias="resourceTypes")
-    ]
+    resource_types: Annotated[List[ResourceType], 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

egain_api_python/models/referenceresponse.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
 from egain_api_python.types import BaseModel
 import pydantic
 from typing import Literal, Optional
@@ -22,25 +23,6 @@ ReferenceResponseSource = Literal[
 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"""
 
@@ -54,8 +36,8 @@ class ReferenceResponseTypedDict(TypedDict):
     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."""
+    topic_bread_crumb: NotRequired[TopicBreadcrumbTypedDict]
+    r"""This schema contains one or more TopicSummary instances."""
 
 
 class ReferenceResponse(BaseModel):
@@ -76,5 +58,7 @@ class ReferenceResponse(BaseModel):
     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."""
+    topic_bread_crumb: Annotated[
+        Optional[TopicBreadcrumb], pydantic.Field(alias="topicBreadCrumb")
+    ] = None
+    r"""This schema contains one or more TopicSummary instances."""

egain_api_python/models/retrievechunksop.py

@@ -26,15 +26,15 @@ class RetrieveChunksRequestTypedDict(TypedDict):
     r"""The search query string. The string must be escaped as required by the URL syntax rules."""
     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."""
-    dollar_filter_user_profile_id: NotRequired[str]
+    filter_user_profile_id: NotRequired[str]
     language: NotRequired[LanguageCodeParameter]
     r"""The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used."""
-    dollar_filter_tags: NotRequired[Dict[str, List[str]]]
+    filter_tags: NotRequired[Dict[str, List[str]]]
     r"""An object where each key is a **Category Tag ID** (numeric string),
     and each value is an array of **Tag IDs** for that category.
 
     """
-    dollar_filter_topic_ids: NotRequired[List[str]]
+    filter_topic_ids: NotRequired[List[str]]
     r"""An array of topic IDs. It is used to restrict search results to specific topics."""
     retrieve_request: NotRequired[RetrieveRequestTypedDict]
 
@@ -52,7 +52,7 @@ class RetrieveChunksRequest(BaseModel):
     ]
     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."""
 
-    dollar_filter_user_profile_id: Annotated[
+    filter_user_profile_id: Annotated[
         Optional[str],
         pydantic.Field(alias="$filter[userProfileID]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -65,7 +65,7 @@ class RetrieveChunksRequest(BaseModel):
     ] = None
     r"""The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used."""
 
-    dollar_filter_tags: Annotated[
+    filter_tags: Annotated[
         Optional[Dict[str, List[str]]],
         pydantic.Field(alias="$filter[tags]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -75,7 +75,7 @@ class RetrieveChunksRequest(BaseModel):
 
     """
 
-    dollar_filter_topic_ids: Annotated[
+    filter_topic_ids: Annotated[
         Optional[List[str]],
         pydantic.Field(alias="$filter[topicIds]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),

egain_api_python/models/retrieveresponse.py

@@ -67,30 +67,28 @@ class RetrieveResponseChannel(BaseModel):
 
 
 class RetrieveResponseTypedDict(TypedDict):
+    search_results: List[SearchResultTypedDict]
+    r"""Top search results with relevance scores and metadata."""
+    session_id: 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."""
     answer: NotRequired[RetrieveResponseAnswerTypedDict]
     r"""If a certified answer is given. The answer object will be present. <br><br> This will be shown only if certified answers are configured and the certified answer meets the configured threshold."""
-    search_results: NotRequired[List[SearchResultTypedDict]]
-    r"""Top search results with relevance scores and metadata."""
     channel: NotRequired[RetrieveResponseChannelTypedDict]
     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 RetrieveResponse(BaseModel):
+    search_results: Annotated[List[SearchResult], pydantic.Field(alias="searchResults")]
+    r"""Top search results with relevance scores and metadata."""
+
+    session_id: Annotated[str, pydantic.Field(alias="sessionId")]
+    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."""
+
     answer: Optional[RetrieveResponseAnswer] = None
     r"""If a certified answer is given. The answer object will be present. <br><br> This will be shown only if certified answers are configured and the certified answer meets the configured threshold."""
 
-    search_results: Annotated[
-        Optional[List[SearchResult]], pydantic.Field(alias="searchResults")
-    ] = None
-    r"""Top search results with relevance scores and metadata."""
-
     channel: Optional[RetrieveResponseChannel] = 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."""

egain_api_python/models/searchresult.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
 from egain_api_python.types import BaseModel
 import pydantic
 from typing import Literal, Optional
@@ -28,25 +29,6 @@ SnippetType = Literal[
 ]
 
 
-class SearchResultLinkTypedDict(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 SearchResultLink(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 SearchResultTypedDict(TypedDict):
     r"""Represents a single document or snippet returned by search, along with its metadata and relevance score."""
 
@@ -65,8 +47,8 @@ class SearchResultTypedDict(TypedDict):
     doc_name: NotRequired[str]
     r"""Name of the attachment, if an attachment was used as the source content."""
     snippet_type: NotRequired[SnippetType]
-    link: NotRequired[SearchResultLinkTypedDict]
-    r"""Defines the relationship between this resource and another object."""
+    topic_bread_crumb: NotRequired[TopicBreadcrumbTypedDict]
+    r"""This schema contains one or more TopicSummary instances."""
 
 
 class SearchResult(BaseModel):
@@ -97,5 +79,7 @@ class SearchResult(BaseModel):
         Optional[SnippetType], pydantic.Field(alias="snippetType")
     ] = None
 
-    link: Optional[SearchResultLink] = None
-    r"""Defines the relationship between this resource and another object."""
+    topic_bread_crumb: Annotated[
+        Optional[TopicBreadcrumb], pydantic.Field(alias="topicBreadCrumb")
+    ] = None
+    r"""This schema contains one or more TopicSummary instances."""