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

egain_api_python/search.py

@@ -0,0 +1,251 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from egain_api_python import errors, models, utils
+from egain_api_python._hooks import HookContext
+from egain_api_python.types import OptionalNullable, UNSET
+from egain_api_python.utils import get_security_from_env
+from egain_api_python.utils.unmarshal_json_response import unmarshal_json_response
+from typing import Dict, List, Mapping, Optional
+
+
+class Search(BaseSDK):
+    def ai_search(
+        self,
+        *,
+        q: str,
+        portal_id: str,
+        dollar_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,
+        dollar_filter_exclude_topic_ids: Optional[List[str]] = None,
+        resource_type: Optional[models.ResourceTypeParameter] = None,
+        article_custom_additional_attributes: Optional[str] = None,
+        topic_custom_additional_attributes: Optional[str] = None,
+        pagenum: Optional[int] = 1,
+        pagesize: Optional[int] = 10,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.AISearchResponse:
+        r"""Get the best search results for a user query
+
+        Submit a user query and receive a list of search results.
+
+        :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: The ID of the user profile.
+        :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 dollar_filter_exclude_topic_ids: An array of topic IDs that will be excluded from the search. It includes articles that belong to the topic.
+        :param resource_type: Type of resource to be fetched.
+        :param article_custom_additional_attributes: One or more comma-separated names for article custom attributes defined by the user to be returned.
+        :param topic_custom_additional_attributes: One or more comma-separated names for topic custom attributes defined by the user to be returned.
+        :param pagenum: Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
+        :param pagesize: Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.AiSearchRequest(
+            q=q,
+            portal_id=portal_id,
+            dollar_filter_user_profile_id=dollar_filter_user_profile_id,
+            language=language,
+            dollar_filter_tags=dollar_filter_tags,
+            dollar_filter_topic_ids=dollar_filter_topic_ids,
+            dollar_filter_exclude_topic_ids=dollar_filter_exclude_topic_ids,
+            resource_type=resource_type,
+            article_custom_additional_attributes=article_custom_additional_attributes,
+            topic_custom_additional_attributes=topic_custom_additional_attributes,
+            pagenum=pagenum,
+            pagesize=pagesize,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/{portalID}/search",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="aiSearch",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.AISearchResponse, http_res)
+        if utils.match_response(http_res, ["400", "4XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, ["500", "5XX"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)
+
+    async def ai_search_async(
+        self,
+        *,
+        q: str,
+        portal_id: str,
+        dollar_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,
+        dollar_filter_exclude_topic_ids: Optional[List[str]] = None,
+        resource_type: Optional[models.ResourceTypeParameter] = None,
+        article_custom_additional_attributes: Optional[str] = None,
+        topic_custom_additional_attributes: Optional[str] = None,
+        pagenum: Optional[int] = 1,
+        pagesize: Optional[int] = 10,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.AISearchResponse:
+        r"""Get the best search results for a user query
+
+        Submit a user query and receive a list of search results.
+
+        :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: The ID of the user profile.
+        :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 dollar_filter_exclude_topic_ids: An array of topic IDs that will be excluded from the search. It includes articles that belong to the topic.
+        :param resource_type: Type of resource to be fetched.
+        :param article_custom_additional_attributes: One or more comma-separated names for article custom attributes defined by the user to be returned.
+        :param topic_custom_additional_attributes: One or more comma-separated names for topic custom attributes defined by the user to be returned.
+        :param pagenum: Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
+        :param pagesize: Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.AiSearchRequest(
+            q=q,
+            portal_id=portal_id,
+            dollar_filter_user_profile_id=dollar_filter_user_profile_id,
+            language=language,
+            dollar_filter_tags=dollar_filter_tags,
+            dollar_filter_topic_ids=dollar_filter_topic_ids,
+            dollar_filter_exclude_topic_ids=dollar_filter_exclude_topic_ids,
+            resource_type=resource_type,
+            article_custom_additional_attributes=article_custom_additional_attributes,
+            topic_custom_additional_attributes=topic_custom_additional_attributes,
+            pagenum=pagenum,
+            pagesize=pagesize,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/{portalID}/search",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="aiSearch",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.AISearchResponse, http_res)
+        if utils.match_response(http_res, ["400", "4XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, ["500", "5XX"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)

egain_api_python/types/__init__.py

@@ -0,0 +1,21 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basemodel import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UnrecognizedInt,
+    UnrecognizedStr,
+    UNSET,
+    UNSET_SENTINEL,
+)
+
+__all__ = [
+    "BaseModel",
+    "Nullable",
+    "OptionalNullable",
+    "UnrecognizedInt",
+    "UnrecognizedStr",
+    "UNSET",
+    "UNSET_SENTINEL",
+]

egain_api_python/types/basemodel.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from pydantic import ConfigDict, model_serializer
+from pydantic import BaseModel as PydanticBaseModel
+from typing import TYPE_CHECKING, Literal, Optional, TypeVar, Union
+from typing_extensions import TypeAliasType, TypeAlias
+
+
+class BaseModel(PydanticBaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True, arbitrary_types_allowed=True, protected_namespaces=()
+    )
+
+
+class Unset(BaseModel):
+    @model_serializer(mode="plain")
+    def serialize_model(self):
+        return UNSET_SENTINEL
+
+    def __bool__(self) -> Literal[False]:
+        return False
+
+
+UNSET = Unset()
+UNSET_SENTINEL = "~?~unset~?~sentinel~?~"
+
+
+T = TypeVar("T")
+if TYPE_CHECKING:
+    Nullable: TypeAlias = Union[T, None]
+    OptionalNullable: TypeAlias = Union[Optional[Nullable[T]], Unset]
+else:
+    Nullable = TypeAliasType("Nullable", Union[T, None], type_params=(T,))
+    OptionalNullable = TypeAliasType(
+        "OptionalNullable", Union[Optional[Nullable[T]], Unset], type_params=(T,)
+    )
+
+UnrecognizedInt: TypeAlias = int
+UnrecognizedStr: TypeAlias = str

egain_api_python/usermilestones.py

@@ -0,0 +1,219 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from egain_api_python import errors, models, utils
+from egain_api_python._hooks import HookContext
+from egain_api_python.types import OptionalNullable, UNSET
+from egain_api_python.utils import get_security_from_env
+from egain_api_python.utils.unmarshal_json_response import unmarshal_json_response
+from typing import Any, Mapping, Optional
+
+
+class Usermilestones(BaseSDK):
+    def get_user_milestones(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Optional[models.Milestones]:
+        r"""Get User Milestones
+
+        ## Overview
+        The User Milestones API provides information about the milestones of an agent within the article workflow.
+        This API helps track the progress of articles by grouping them into relevant milestones based on their current stage.
+
+        For example, an article might go through Knowledge Workflow Stages like Draft, Initial Review, Staging, Final Review and Publish.
+        Articles in the Draft and Initial Review stages are part of the \"authoring milestone\", while articles in the Staging and Final Review stages are part of the \"staging milestone\".
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.GetUserMilestonesRequest(
+            accept_language=accept_language,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/portals/user/milestones",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="getUserMilestones",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "406", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.Milestones, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "406"], "application/json"
+        ):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)
+
+    async def get_user_milestones_async(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Optional[models.Milestones]:
+        r"""Get User Milestones
+
+        ## Overview
+        The User Milestones API provides information about the milestones of an agent within the article workflow.
+        This API helps track the progress of articles by grouping them into relevant milestones based on their current stage.
+
+        For example, an article might go through Knowledge Workflow Stages like Draft, Initial Review, Staging, Final Review and Publish.
+        Articles in the Draft and Initial Review stages are part of the \"authoring milestone\", while articles in the Staging and Final Review stages are part of the \"staging milestone\".
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.GetUserMilestonesRequest(
+            accept_language=accept_language,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/portals/user/milestones",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="getUserMilestones",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "406", "4XX", "500", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.Milestones, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "406"], "application/json"
+        ):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.WSErrorCommonData, http_res)
+            raise errors.WSErrorCommon(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.EgainDefaultError(
+                "API error occurred", http_res, http_res_text
+            )
+
+        raise errors.EgainDefaultError("Unexpected response received", http_res)