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

egain_api_python/portal_suggestion.py

@@ -135,7 +135,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="makeSuggestion",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -304,7 +304,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="makeSuggestion",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -463,7 +463,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="modifySuggestions",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -622,7 +622,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="modifySuggestions",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -752,7 +752,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="searchSuggestion",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -874,7 +874,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="searchSuggestion",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -994,7 +994,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getSuggestion",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -1114,7 +1114,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getSuggestion",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -1226,7 +1226,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="deleteSuggestion",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -1336,7 +1336,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="deleteSuggestion",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -1450,7 +1450,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getRelatedArticlesForSuggestion",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -1568,7 +1568,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getRelatedArticlesForSuggestion",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -1681,7 +1681,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getSuggestionComments",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -1792,7 +1792,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getSuggestionComments",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -1903,7 +1903,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getSuggestionAttachments",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -2014,7 +2014,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getSuggestionAttachments",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -2130,7 +2130,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getSuggestionAttachmentById",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -2246,7 +2246,7 @@ class PortalSuggestion(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getSuggestionAttachmentById",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),

egain_api_python/portal_topic.py

@@ -83,7 +83,7 @@ class PortalTopic(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getTopicBreadcrumbForArticle",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -190,7 +190,7 @@ class PortalTopic(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getTopicBreadcrumbForArticle",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -317,7 +317,7 @@ class PortalTopic(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getchildtopics",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -446,7 +446,7 @@ class PortalTopic(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getchildtopics",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -569,7 +569,7 @@ class PortalTopic(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getancestortopics",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -692,7 +692,7 @@ class PortalTopic(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getancestortopics",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -815,7 +815,7 @@ class PortalTopic(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getalltopics",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -938,7 +938,7 @@ class PortalTopic(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getalltopics",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),

egain_api_python/portal_userdetails.py

@@ -74,7 +74,7 @@ class PortalUserdetails(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getUserDetails",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -174,7 +174,7 @@ class PortalUserdetails(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getUserDetails",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),

egain_api_python/portal_userprofile.py

@@ -80,7 +80,7 @@ class PortalUserprofile(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getAllUserProfiles",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -186,7 +186,7 @@ class PortalUserprofile(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getAllUserProfiles",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -292,7 +292,7 @@ class PortalUserprofile(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="selectUserProfile",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -396,7 +396,7 @@ class PortalUserprofile(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="selectUserProfile",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),

egain_api_python/retrieve.py

@@ -31,7 +31,7 @@ class Retrieve(BaseSDK):
     ) -> models.RetrieveResponse:
         r"""Retrieve Chunks
 
-        The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines. <br><br> In addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility. By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.
+        The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines. <br><br> In addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility. By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material. <br>**This endpoint is only available for Self Service environments.**
 
         :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.
@@ -56,9 +56,6 @@ class Retrieve(BaseSDK):
             base_url = server_url
         else:
             base_url = models.RETRIEVE_CHUNKS_OP_SERVERS[0]
-            url_variables = {
-                "API_DOMAIN": "api.egain.cloud",
-            }
 
         request = models.RetrieveChunksRequest(
             q=q,
@@ -112,7 +109,7 @@ class Retrieve(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="retrieveChunks",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -158,7 +155,7 @@ class Retrieve(BaseSDK):
     ) -> models.RetrieveResponse:
         r"""Retrieve Chunks
 
-        The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines. <br><br> In addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility. By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.
+        The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines. <br><br> In addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility. By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material. <br>**This endpoint is only available for Self Service environments.**
 
         :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.
@@ -183,9 +180,6 @@ class Retrieve(BaseSDK):
             base_url = server_url
         else:
             base_url = models.RETRIEVE_CHUNKS_OP_SERVERS[0]
-            url_variables = {
-                "API_DOMAIN": "api.egain.cloud",
-            }
 
         request = models.RetrieveChunksRequest(
             q=q,
@@ -239,7 +233,7 @@ class Retrieve(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="retrieveChunks",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),

egain_api_python/sdk.py

@@ -11,7 +11,7 @@ from egain_api_python.types import OptionalNullable, UNSET
 import httpx
 import importlib
 import sys
-from typing import Any, Callable, Dict, List, Optional, TYPE_CHECKING, Union, cast
+from typing import Any, Callable, Dict, Optional, TYPE_CHECKING, Union, cast
 import weakref
 
 if TYPE_CHECKING:
@@ -25,23 +25,31 @@ class Egain(BaseSDK):
     The following licenses are required to use the Knowledge Access APIs:
     * If the user is an agent, then the *Knowledge + AI* license is required.
     * If the user is a customer, the *Self-Service* and *Advanced Self-Service* licenses must be available.
+
+    ### Tiers
+
+    | Tier	|Tier Name|	Named Users |	Description
+    | ---------- | ---------- | ---------- | ----------------------------
+    | Tier 1 |  Starter |	Up to 10|	Designed for small-scale implementations or pilot environments
+    | Tier 2 |	Growth	| Up to 1000|	Suitable for mid-scale deployments requiring moderate scalability
+    | Tier 3 |	Enterprise	| Greater than 1000|	Supports large-scale environments with extended configuration options
+
     ### API Resource Limits
-    The following Resources have predefined limits for specific access attributes for Enterprise use.
+    The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.
 
-    | Resource | Attribute | Enterprise
-    | ---------------- | ---------------------------- | ----------
-    | Article Reference Limits |Number of attachments used in any article | 50
-    |  |Number of custom attributes in an article | 15
-    |  |Number of publish views used in an article version | 20
-    | Topic Reference Limits |User-defined topics in a department| 50000
-    |  |Depth of topics  | 20
-    |  |Topics at any level | 2500
-    |  |Number of custom attributes in a topic | 15
-    | Portal Reference Limits | Tag categories in a portal | 15
-    |  |Topics to be included in a portal | 2500
-    |  |Number of articles to display in announcements | 25
-    |  |Maximum related articles in portal setting | 100
-    |  |Usage links and link groups setup for a portal | 25
+    | Resource | Limits | Starter | Growth | Enterprise
+    | ---------------- | ---------------------------- | ---------- | ---------- | ----------
+    | Article Reference |Number of attachments used in any article | 25 | 50 |50
+    |  |Number of custom attributes in an article | 10 | 25| 50
+    |  |Number of publish views used in an article version | 20 | 20 | 20
+    | Topic Reference |User-defined topics in a department| 1000| 5000 | 50000
+    |  |Depth of topics  | 5 | 20 | 20
+    |  |Topics at any level | 500 | 2500 | 2500
+    |  |Number of custom attributes in a topic | 10 | 10 | 10
+    | Portal Reference | Tag categories in a portal | 15 | 15 | 15
+    |  |Topics to be included in a portal | 100 | 500 | 5000
+    |  |Number of articles to display in announcements | 10 | 25 | 25
+    |  |Usage links and link groups setup for a portal | 5 | 10 | 25
 
 
 
@@ -62,7 +70,6 @@ class Egain(BaseSDK):
         access_token: Optional[
             Union[Optional[str], Callable[[], Optional[str]]]
         ] = None,
-        api_domain: Optional[str] = None,
         server_idx: Optional[int] = None,
         server_url: Optional[str] = None,
         url_params: Optional[Dict[str, str]] = None,
@@ -75,7 +82,6 @@ class Egain(BaseSDK):
         r"""Instantiates the SDK configuring it with the provided parameters.
 
         :param access_token: The access_token required for authentication
-        :param api_domain: Allows setting the API_DOMAIN variable for url substitution
         :param server_idx: The index of the server to use for all methods
         :param server_url: The server URL to use for all methods
         :param url_params: Parameters to optionally template the server URL with
@@ -115,11 +121,6 @@ class Egain(BaseSDK):
         if server_url is not None:
             if url_params is not None:
                 server_url = utils.template_url(server_url, url_params)
-        server_defaults: List[Dict[str, str]] = [
-            {
-                "API_DOMAIN": api_domain or "api.egain.cloud",
-            },
-        ]
 
         BaseSDK.__init__(
             self,
@@ -131,7 +132,6 @@ class Egain(BaseSDK):
                 security=security,
                 server_url=server_url,
                 server_idx=server_idx,
-                server_defaults=server_defaults,
                 retry_config=retry_config,
                 timeout_ms=timeout_ms,
                 debug_logger=debug_logger,

egain_api_python/sdkconfiguration.py

@@ -8,11 +8,11 @@ from ._version import (
 )
 from .httpclient import AsyncHttpClient, HttpClient
 from .utils import Logger, RetryConfig, remove_suffix
-from dataclasses import dataclass, field
+from dataclasses import dataclass
 from egain_api_python import models
 from egain_api_python.types import OptionalNullable, UNSET
 from pydantic import Field
-from typing import Callable, Dict, List, Optional, Tuple, Union
+from typing import Callable, Dict, Optional, Tuple, Union
 
 
 SERVERS = [
@@ -32,7 +32,6 @@ class SDKConfiguration:
     security: Optional[Union[models.Security, Callable[[], models.Security]]] = None
     server_url: Optional[str] = ""
     server_idx: Optional[int] = 0
-    server_defaults: List[Dict[str, str]] = field(default_factory=List)
     language: str = "python"
     openapi_doc_version: str = __openapi_doc_version__
     sdk_version: str = __version__
@@ -47,4 +46,4 @@ class SDKConfiguration:
         if self.server_idx is None:
             self.server_idx = 0
 
-        return SERVERS[self.server_idx], self.server_defaults[self.server_idx]
+        return SERVERS[self.server_idx], {}

egain_api_python/search.py

@@ -29,7 +29,8 @@ class Search(BaseSDK):
     ) -> models.AISearchResponse:
         r"""Get the best search results for a user query
 
-        Submit a user query and receive a list of search results.
+        The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores. <br>**This endpoint is only available for Self Service environments.**
+
 
         :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.
@@ -96,7 +97,7 @@ class Search(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="aiSearch",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -140,7 +141,8 @@ class Search(BaseSDK):
     ) -> models.AISearchResponse:
         r"""Get the best search results for a user query
 
-        Submit a user query and receive a list of search results.
+        The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores. <br>**This endpoint is only available for Self Service environments.**
+
 
         :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.
@@ -207,7 +209,7 @@ class Search(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="aiSearch",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),

egain_api_python/usermilestones.py

@@ -78,7 +78,7 @@ class Usermilestones(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getUserMilestones",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),
@@ -182,7 +182,7 @@ class Usermilestones(BaseSDK):
                 config=self.sdk_configuration,
                 base_url=base_url or "",
                 operation_id="getUserMilestones",
-                oauth2_scopes=[],
+                oauth2_scopes=None,
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
                 ),