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

egain_api_python/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "egain-api-python"
-__version__: str = "0.1.1"
+__version__: str = "0.1.3"
 __openapi_doc_version__: str = "4.0.0"
-__gen_version__: str = "2.721.3"
-__user_agent__: str = "speakeasy-sdk/python 0.1.1 2.721.3 4.0.0 egain-api-python"
+__gen_version__: str = "2.722.2"
+__user_agent__: str = "speakeasy-sdk/python 0.1.3 2.722.2 4.0.0 egain-api-python"
 
 try:
     if __package__ is not None:

egain_api_python/answers.py

@@ -10,15 +10,15 @@ from typing import Dict, List, Mapping, Optional, Union
 
 
 class Answers(BaseSDK):
-    def post_portal_id_answers(
+    def get_best_answer(
         self,
         *,
         q: str,
         portal_id: str,
-        dollar_filter_user_profile_id: Optional[str] = None,
+        filter_user_profile_id: Optional[str] = None,
         language: Optional[models.LanguageCodeParameter] = None,
-        dollar_filter_tags: Optional[Dict[str, List[str]]] = None,
-        dollar_filter_topic_ids: Optional[List[str]] = None,
+        filter_tags: Optional[Dict[str, List[str]]] = None,
+        filter_topic_ids: Optional[List[str]] = None,
         channel: Optional[
             Union[models.AnswersRequestChannel, models.AnswersRequestChannelTypedDict]
         ] = None,
@@ -41,10 +41,10 @@ class Answers(BaseSDK):
 
         :param q: The search query string. The string must be escaped as required by the URL syntax rules.
         :param portal_id: 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.
-        :param dollar_filter_user_profile_id:
+        :param filter_user_profile_id:
         :param language: 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.
-        :param dollar_filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.
-        :param dollar_filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
+        :param filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.
+        :param filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
         :param channel:
         :param context: Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response.
         :param event_id: Unique ID for this specific API call or event.
@@ -62,18 +62,18 @@ class Answers(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.POST_PORTAL_ID_ANSWERS_OP_SERVERS[0]
+            base_url = models.GET_BEST_ANSWER_OP_SERVERS[0]
             url_variables = {
                 "API_DOMAIN": "api.egain.cloud",
             }
 
-        request = models.PostPortalIDAnswersRequest(
+        request = models.GetBestAnswerRequest(
             q=q,
             portal_id=portal_id,
-            dollar_filter_user_profile_id=dollar_filter_user_profile_id,
+            filter_user_profile_id=filter_user_profile_id,
             language=language,
-            dollar_filter_tags=dollar_filter_tags,
-            dollar_filter_topic_ids=dollar_filter_topic_ids,
+            filter_tags=filter_tags,
+            filter_topic_ids=filter_topic_ids,
             answers_request=models.AnswersRequest(
                 channel=utils.get_pydantic_model(
                     channel, Optional[models.AnswersRequestChannel]
@@ -119,7 +119,7 @@ class Answers(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="post_/{portalID}/answers",
+                operation_id="getBestAnswer",
                 oauth2_scopes=[],
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
@@ -145,15 +145,15 @@ class Answers(BaseSDK):
 
         raise errors.EgainDefaultError("Unexpected response received", http_res)
 
-    async def post_portal_id_answers_async(
+    async def get_best_answer_async(
         self,
         *,
         q: str,
         portal_id: str,
-        dollar_filter_user_profile_id: Optional[str] = None,
+        filter_user_profile_id: Optional[str] = None,
         language: Optional[models.LanguageCodeParameter] = None,
-        dollar_filter_tags: Optional[Dict[str, List[str]]] = None,
-        dollar_filter_topic_ids: Optional[List[str]] = None,
+        filter_tags: Optional[Dict[str, List[str]]] = None,
+        filter_topic_ids: Optional[List[str]] = None,
         channel: Optional[
             Union[models.AnswersRequestChannel, models.AnswersRequestChannelTypedDict]
         ] = None,
@@ -176,10 +176,10 @@ class Answers(BaseSDK):
 
         :param q: The search query string. The string must be escaped as required by the URL syntax rules.
         :param portal_id: 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.
-        :param dollar_filter_user_profile_id:
+        :param filter_user_profile_id:
         :param language: 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.
-        :param dollar_filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.
-        :param dollar_filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
+        :param filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.
+        :param filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
         :param channel:
         :param context: Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response.
         :param event_id: Unique ID for this specific API call or event.
@@ -197,18 +197,18 @@ class Answers(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.POST_PORTAL_ID_ANSWERS_OP_SERVERS[0]
+            base_url = models.GET_BEST_ANSWER_OP_SERVERS[0]
             url_variables = {
                 "API_DOMAIN": "api.egain.cloud",
             }
 
-        request = models.PostPortalIDAnswersRequest(
+        request = models.GetBestAnswerRequest(
             q=q,
             portal_id=portal_id,
-            dollar_filter_user_profile_id=dollar_filter_user_profile_id,
+            filter_user_profile_id=filter_user_profile_id,
             language=language,
-            dollar_filter_tags=dollar_filter_tags,
-            dollar_filter_topic_ids=dollar_filter_topic_ids,
+            filter_tags=filter_tags,
+            filter_topic_ids=filter_topic_ids,
             answers_request=models.AnswersRequest(
                 channel=utils.get_pydantic_model(
                     channel, Optional[models.AnswersRequestChannel]
@@ -254,7 +254,7 @@ class Answers(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="post_/{portalID}/answers",
+                operation_id="getBestAnswer",
                 oauth2_scopes=[],
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security

egain_api_python/articlelists.py

@@ -228,7 +228,7 @@ class Articlelists(BaseSDK):
         accept_language: models.AcceptLanguage,
         portal_id: str,
         list_id: str,
-        dollar_filter_topic_id: Optional[str] = None,
+        filter_topic_id: Optional[str] = None,
         article_result_additional_attributes: Optional[
             List[models.ArticleResultAdditionalAttributes]
         ] = None,
@@ -253,7 +253,7 @@ class Articlelists(BaseSDK):
         :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
         :param portal_id: 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.
         :param list_id: The ID of the list to be returned.
-        :param dollar_filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
+        :param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
         :param article_result_additional_attributes: The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.
         :param language: 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>
         :param retries: Override the default retry configuration for this method
@@ -275,7 +275,7 @@ class Articlelists(BaseSDK):
             accept_language=accept_language,
             portal_id=portal_id,
             list_id=list_id,
-            dollar_filter_topic_id=dollar_filter_topic_id,
+            filter_topic_id=filter_topic_id,
             article_result_additional_attributes=article_result_additional_attributes,
             language=language,
         )
@@ -351,7 +351,7 @@ class Articlelists(BaseSDK):
         accept_language: models.AcceptLanguage,
         portal_id: str,
         list_id: str,
-        dollar_filter_topic_id: Optional[str] = None,
+        filter_topic_id: Optional[str] = None,
         article_result_additional_attributes: Optional[
             List[models.ArticleResultAdditionalAttributes]
         ] = None,
@@ -376,7 +376,7 @@ class Articlelists(BaseSDK):
         :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
         :param portal_id: 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.
         :param list_id: The ID of the list to be returned.
-        :param dollar_filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
+        :param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
         :param article_result_additional_attributes: The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.
         :param language: 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>
         :param retries: Override the default retry configuration for this method
@@ -398,7 +398,7 @@ class Articlelists(BaseSDK):
             accept_language=accept_language,
             portal_id=portal_id,
             list_id=list_id,
-            dollar_filter_topic_id=dollar_filter_topic_id,
+            filter_topic_id=filter_topic_id,
             article_result_additional_attributes=article_result_additional_attributes,
             language=language,
         )

egain_api_python/errors/gethealthop.py

@@ -2,44 +2,58 @@
 
 from __future__ import annotations
 from dataclasses import dataclass, field
-from datetime import datetime
 from egain_api_python.errors import EgainError
+from egain_api_python.models import gethealthop as models_gethealthop
 from egain_api_python.types import BaseModel
 import httpx
-from typing import Optional
+from typing import Any, List, Optional
 
 
 class ServiceUnavailableErrorData(BaseModel):
-    status: Optional[str] = None
+    status: Optional[models_gethealthop.ServiceUnavailableStatus] = None
     r"""**Health Status**
 
-    The overall health status of the service. When unhealthy:
-    - Service may not process requests correctly
-    - Performance may be significantly degraded
-    - Some features may be unavailable
-    - Immediate attention is required
+    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
 
     """
 
-    timestamp: Optional[datetime] = None
+    timestamp: Optional[Any] = None
     r"""**Health Check Timestamp**
 
-    The exact date and time when this health check was performed. This helps with:
-    - Incident timeline analysis
-    - Problem duration tracking
-    - Recovery time measurement
-    - Historical incident analysis
+    The exact date and time when this health check was performed. This is useful for:
+    - Tracking health check frequency
+    - Correlating with other system events
+    - Monitoring health check response times
+    - Historical health trend analysis
 
     """
 
     version: Optional[str] = None
     r"""**API Version**
 
-    The current version of the Import Content API. This information is useful for:
-    - Support team identification
-    - Known issue correlation
-    - Version-specific troubleshooting
-    - Upgrade planning
+    The current version of the Import Content API. This helps with:
+    - Version compatibility checking
+    - Feature availability verification
+    - Upgrade planning and coordination
+    - Support and troubleshooting
+
+    """
+
+    issues: Optional[List[str]] = None
+    r"""**Issues**:
+
+    List of detected health problems
+
+    """
+
+    components: Optional[models_gethealthop.Components] = None
+    r"""**Comonents**:
+
+    Health status of import service componenets
 
     """
 

egain_api_python/export.py

@@ -17,7 +17,7 @@ class Export(BaseSDK):
         language: Union[
             models.KnowledgeExportLanguage, models.KnowledgeExportLanguageTypedDict
         ],
-        resource_types: List[models.KnowledgeExportResourceType],
+        resource_types: List[models.ResourceType],
         data_destination: Union[
             models.DataDestination, models.DataDestinationTypedDict
         ],
@@ -142,7 +142,7 @@ class Export(BaseSDK):
         language: Union[
             models.KnowledgeExportLanguage, models.KnowledgeExportLanguageTypedDict
         ],
-        resource_types: List[models.KnowledgeExportResourceType],
+        resource_types: List[models.ResourceType],
         data_destination: Union[
             models.DataDestination, models.DataDestinationTypedDict
         ],