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

egain_api_python/general.py

@@ -0,0 +1,925 @@
+"""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 General(BaseSDK):
+    def get_all_portals(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        department_id: Optional[str] = None,
+        language: Optional[models.LanguageQueryParameter] = 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,
+    ) -> Optional[models.PortalResult]:
+        r"""Get All Portals
+
+        ## Overview
+        The Get All Portals API returns all portals in a partition or department.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param department_id: The ID of the department.
+        :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 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.GetAllPortalsRequest(
+            accept_language=accept_language,
+            department_id=department_id,
+            language=language,
+            pagenum=pagenum,
+            pagesize=pagesize,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/portals",
+            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="getAllPortals",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "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.PortalResult, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "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_all_portals_async(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        department_id: Optional[str] = None,
+        language: Optional[models.LanguageQueryParameter] = 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,
+    ) -> Optional[models.PortalResult]:
+        r"""Get All Portals
+
+        ## Overview
+        The Get All Portals API returns all portals in a partition or department.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param department_id: The ID of the department.
+        :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 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.GetAllPortalsRequest(
+            accept_language=accept_language,
+            department_id=department_id,
+            language=language,
+            pagenum=pagenum,
+            pagesize=pagesize,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/portals",
+            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="getAllPortals",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "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.PortalResult, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "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)
+
+    def get_my_portals(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        language: models.MandatoryLanguageQueryParameter,
+        department: Optional[str] = None,
+        filter_text: Optional[str] = None,
+        short_url_template: Optional[str] = None,
+        sort: Optional[models.SortIDNameDepartment] = None,
+        order: Optional[models.Order] = None,
+        pagenum: Optional[int] = 1,
+        pagesize: Optional[int] = 25,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Optional[models.AllAccessiblePortals]:
+        r"""Get All Portals Accessible To User
+
+        ## Overview
+        The Get All Portals Accessible to User API allows a user to fetch all portals accessible to user across all department.
+        * If no access tags are specified for a portal, then any user can access the portal.
+        * If access tags are specified for a portal, users with a user profile that allows access have access to the portal. For users with multiple user profiles, the user profile that allows access does not need to be the active user profile.
+        * All the global users(partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.
+        * The only articles returned are associated to an Article type when the parameter, “Include in browse on portals” is set to \"Yes\".
+        * When the \"shortUrlTemplate\" query parameter is provided, the API filters accessible portals according to the specified language and template name. Portal Short URL specific to to the \"shortUrlTemplate\" query parameter value is returned in the response.
+        * When there is no short URL available for a specific language, the API returns a portal object with an empty \"shortURL\" field.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param language: The language used for fetching the details of a resource. Resources available in different languages may differ from each other.
+        :param department: The Name of the department for which portals are to be fetched
+        :param filter_text: Portal name starting with a specific character are considered to filter the result.
+        :param short_url_template: The Name of the template used while creating Short URL.
+        :param sort: Objects returned in server response are sorted based on the attribute supplied under $sort. <br>_Default value_: name.
+        :param order: Common query parameter $order.
+        :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.<br>Valid range of 5-75<br>_Default value_: 25
+        :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.GetMyPortalsRequest(
+            accept_language=accept_language,
+            language=language,
+            department=department,
+            filter_text=filter_text,
+            short_url_template=short_url_template,
+            sort=sort,
+            order=order,
+            pagenum=pagenum,
+            pagesize=pagesize,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/myportals",
+            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="getMyPortals",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "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.AllAccessiblePortals, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "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_my_portals_async(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        language: models.MandatoryLanguageQueryParameter,
+        department: Optional[str] = None,
+        filter_text: Optional[str] = None,
+        short_url_template: Optional[str] = None,
+        sort: Optional[models.SortIDNameDepartment] = None,
+        order: Optional[models.Order] = None,
+        pagenum: Optional[int] = 1,
+        pagesize: Optional[int] = 25,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Optional[models.AllAccessiblePortals]:
+        r"""Get All Portals Accessible To User
+
+        ## Overview
+        The Get All Portals Accessible to User API allows a user to fetch all portals accessible to user across all department.
+        * If no access tags are specified for a portal, then any user can access the portal.
+        * If access tags are specified for a portal, users with a user profile that allows access have access to the portal. For users with multiple user profiles, the user profile that allows access does not need to be the active user profile.
+        * All the global users(partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.
+        * The only articles returned are associated to an Article type when the parameter, “Include in browse on portals” is set to \"Yes\".
+        * When the \"shortUrlTemplate\" query parameter is provided, the API filters accessible portals according to the specified language and template name. Portal Short URL specific to to the \"shortUrlTemplate\" query parameter value is returned in the response.
+        * When there is no short URL available for a specific language, the API returns a portal object with an empty \"shortURL\" field.
+
+
+        :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
+        :param language: The language used for fetching the details of a resource. Resources available in different languages may differ from each other.
+        :param department: The Name of the department for which portals are to be fetched
+        :param filter_text: Portal name starting with a specific character are considered to filter the result.
+        :param short_url_template: The Name of the template used while creating Short URL.
+        :param sort: Objects returned in server response are sorted based on the attribute supplied under $sort. <br>_Default value_: name.
+        :param order: Common query parameter $order.
+        :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.<br>Valid range of 5-75<br>_Default value_: 25
+        :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.GetMyPortalsRequest(
+            accept_language=accept_language,
+            language=language,
+            department=department,
+            filter_text=filter_text,
+            short_url_template=short_url_template,
+            sort=sort,
+            order=order,
+            pagenum=pagenum,
+            pagesize=pagesize,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/myportals",
+            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="getMyPortals",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "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.AllAccessiblePortals, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "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)
+
+    def get_portal_details_by_id(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        language: Optional[models.LanguageQueryParameter] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Optional[models.Portal]:
+        r"""Get Portal Details By ID
+
+        ## Overview
+        The Get Portal Details By ID API allows a user to fetch details of a portal by the ID.
+
+
+        :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 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
+        :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.GetPortalDetailsByIDRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            language=language,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/portals/{portalID}",
+            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="getPortalDetailsById",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "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.Portal, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "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_portal_details_by_id_async(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        language: Optional[models.LanguageQueryParameter] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Optional[models.Portal]:
+        r"""Get Portal Details By ID
+
+        ## Overview
+        The Get Portal Details By ID API allows a user to fetch details of a portal by the ID.
+
+
+        :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 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
+        :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.GetPortalDetailsByIDRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            language=language,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/portals/{portalID}",
+            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="getPortalDetailsById",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "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.Portal, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "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)
+
+    def get_tag_categories_for_interest_for_portal(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        language: models.MandatoryLanguageQueryParameter,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Optional[models.TagCategoriesForInterest]:
+        r"""Get Tag Categories for Interest for a Portal
+
+        ## Overview
+        The Get Tag Categories for Interest for a Portal API retrieves the Tag Categories for Interest configured for a portal.
+        * Tag Categories are ordered in order of their addition in the \"Tag Categories for Interest\" in the Portal configuration.
+        * Tags are ordered as per their order defined in their Tag Category.
+        * Tag Groups are sorted by their name, in ascending order.
+
+
+        :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 language: The language used for fetching the details of a resource. Resources available in different languages may differ from each other.
+        :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.GetTagCategoriesForInterestForPortalRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            language=language,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/portals/{portalID}/tagcategoriesforinterest",
+            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="getTagCategoriesForInterestForPortal",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "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.TagCategoriesForInterest, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "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_tag_categories_for_interest_for_portal_async(
+        self,
+        *,
+        accept_language: models.AcceptLanguage,
+        portal_id: str,
+        language: models.MandatoryLanguageQueryParameter,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> Optional[models.TagCategoriesForInterest]:
+        r"""Get Tag Categories for Interest for a Portal
+
+        ## Overview
+        The Get Tag Categories for Interest for a Portal API retrieves the Tag Categories for Interest configured for a portal.
+        * Tag Categories are ordered in order of their addition in the \"Tag Categories for Interest\" in the Portal configuration.
+        * Tags are ordered as per their order defined in their Tag Category.
+        * Tag Groups are sorted by their name, in ascending order.
+
+
+        :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 language: The language used for fetching the details of a resource. Resources available in different languages may differ from each other.
+        :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.GetTagCategoriesForInterestForPortalRequest(
+            accept_language=accept_language,
+            portal_id=portal_id,
+            language=language,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/portals/{portalID}/tagcategoriesforinterest",
+            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="getTagCategoriesForInterestForPortal",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "404", "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.TagCategoriesForInterest, http_res)
+        if utils.match_response(http_res, "204", "*"):
+            return None
+        if utils.match_response(
+            http_res, ["400", "401", "403", "404", "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)