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

egain_api_python/models/portalsettings.py

@@ -0,0 +1,398 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .configurableattributes import (
+    ConfigurableAttributes,
+    ConfigurableAttributesTypedDict,
+)
+from .searchfilterattribute import SearchFilterAttribute, SearchFilterAttributeTypedDict
+from .tagcategoriesforinterest import (
+    TagCategoriesForInterest,
+    TagCategoriesForInterestTypedDict,
+)
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+SearchLearningLevel = Literal[
+    0,
+    1,
+    2,
+    3,
+    4,
+]
+r"""Affects the influence of learning on search rankings. 0 = off, 1 = low, 2 = medium, 3 = high, 4 = custom."""
+
+
+class PortalSettingsTypedDict(TypedDict):
+    r"""The settings for this portal."""
+
+    is_annoucements_enabled: NotRequired[bool]
+    r"""Whether the announcements section is enabled on this portal."""
+    is_article_feedback_enabled: NotRequired[bool]
+    r"""Whether article feedback is allowed."""
+    is_article_feedback_comments_enabled: NotRequired[bool]
+    r"""Whether comments should be included in the feedback."""
+    is_article_feedback_summary_enabled: NotRequired[bool]
+    r"""Whether a summary of feedback ratings should be displayed."""
+    is_related_articles_in_same_topic_enabled: NotRequired[bool]
+    r"""Whether all articles in the same topic are automatically treated as related articles."""
+    is_related_articles_enabled: NotRequired[bool]
+    r"""Whether the related articles section is shown."""
+    is_authentication_required: NotRequired[bool]
+    r"""Whether the portal requires authentication for access."""
+    is_agents_sso_enabled: NotRequired[bool]
+    r"""Whether SSO is enabled for agents"""
+    is_agents_delegated_authentication_enabled: NotRequired[bool]
+    r"""Whether delegated authentication is enabled for agents"""
+    customer_profile_attributes: NotRequired[ConfigurableAttributesTypedDict]
+    is_popular_articles_list_enabled: NotRequired[bool]
+    r"""Whether the popular articles list is displayed. Maximum of 50 popular articles will be dislpayed."""
+    popular_articles_list_influence_weight: NotRequired[float]
+    r"""The weight assigned to the influence of related articles on the ranking of popular articles in the ranking formula."""
+    popular_articles_list_influence_period: NotRequired[int]
+    r"""The timeframe in days that related articles affect the ranking of popular articles in the ranking formula."""
+    append_session_journey_to_email: NotRequired[bool]
+    r"""Whether the session transcript should be appended to the email message."""
+    is_article_suggestions_before_escalation_enabled: NotRequired[bool]
+    r"""Whether a user is  shown suggested articles before escalating."""
+    is_escalation_to_email_enabled: NotRequired[bool]
+    r"""Whether the user can ask a question via email if Guided Help doesn’t provide an answer, triggering a search before escalation."""
+    number_of_suggested_articles_before_escalation: NotRequired[int]
+    r"""The number of articles to show to a customer before escalation."""
+    is_gh_enabled: NotRequired[bool]
+    r"""Whether guided help is enabled."""
+    is_gh_in_search_results_enabled: NotRequired[bool]
+    r"""Whether to show guided help results in search results."""
+    is_gh_startup_questions_before_unanswered_questions_enabled: NotRequired[bool]
+    r"""Whether startup questions should be presented before unanswered questions in Guided Help."""
+    is_gh_details_for_search_enabled: NotRequired[bool]
+    r"""Whether additional information should be shown in search results."""
+    is_gh_short_name_in_search_enabled: NotRequired[bool]
+    r"""When enabled it shows the short names in results."""
+    is_gh_cluster_scope_diagnostics_enabled: NotRequired[bool]
+    r"""Whether to show Cluster scope diagnostics during execution."""
+    is_gh_results_shown_on_successful_search: NotRequired[bool]
+    r"""Whether to automatically display results on search success."""
+    is_gh_control_action_diagnostics_enabled: NotRequired[bool]
+    r"""isGHControlActionDiagnosticsEnabled"""
+    gh_failure_success_threshold: NotRequired[float]
+    r"""A value from range that indicates the failure-success score"""
+    max_gh_answered_questions: NotRequired[int]
+    r"""A value indicating the maximum number of answered questions."""
+    max_gh_unanswered_questions: NotRequired[int]
+    r"""A value indicating the maximum number of unanswered questions."""
+    max_gh_search_results: NotRequired[int]
+    r"""Maximum number of guided help results to return."""
+    is_search_autocomplete_enabled: NotRequired[bool]
+    r"""Whether the autocomplete interface should be enabled."""
+    is_web_search_enabled: NotRequired[bool]
+    r"""Whether web searches should be performed as part of multi-search."""
+    max_web_search_results: NotRequired[int]
+    r"""The maximum number of results from the web search to return."""
+    web_search_domain: NotRequired[str]
+    r"""Use this to restrict web search results to a specific domain."""
+    is_intranet_search_enabled: NotRequired[bool]
+    r"""Whether intranet results should be returned as part of multi-search."""
+    max_intranet_search_results: NotRequired[int]
+    r"""The maximum number of results from an intranet search to return."""
+    intranet_search_url: NotRequired[str]
+    r"""The URL for the Intranet Search."""
+    is_spellcheck_enabled: NotRequired[bool]
+    r"""Whether spell-correction should be performed on search queries. The corrected query is returned with the results, but is not automatically used."""
+    question_matching_engine_url: NotRequired[str]
+    r"""The URL for the question matching engine."""
+    is_custom_attributes_filtering_enabled: NotRequired[bool]
+    r"""Whether search results should be filtered by custom attribute values."""
+    custom_attributes_for_search_filter: NotRequired[
+        List[SearchFilterAttributeTypedDict]
+    ]
+    search_learning_inclusion_threshold: NotRequired[int]
+    r"""The minimum number of accepts and rejects of an article before article ranking is affected."""
+    search_learning_influence: NotRequired[int]
+    r"""A ranking multiplier for learned scoring."""
+    search_learning_level: NotRequired[SearchLearningLevel]
+    r"""Affects the influence of learning on search rankings. 0 = off, 1 = low, 2 = medium, 3 = high, 4 = custom."""
+    search_learning_max_influence: NotRequired[int]
+    r"""The maximum influence allowed for learned scoring."""
+    search_related_term_weight: NotRequired[float]
+    r"""The weight assigned to related terms during search."""
+    search_related_terms_min_results_threshold: NotRequired[int]
+    r"""If the number of search results is less than or equal to this value, a search with related terms will be used to fill in results."""
+    is_article_suggestions_enabled: NotRequired[bool]
+    r"""Whether users can make suggestions on an article."""
+    is_my_suggestions_enabled: NotRequired[bool]
+    r"""Whether a user can view their suggestions."""
+    is_captcha_enabled: NotRequired[bool]
+    r"""Whether CAPTCHA is enabled or not in the portal."""
+    captcha_site_key: NotRequired[str]
+    r"""The configured CAPTCHA site key."""
+    is_article_sharing_enabled: NotRequired[bool]
+    r"""Whether the article sharing is enabled."""
+    tag_categories_for_search_filter: NotRequired[TagCategoriesForInterestTypedDict]
+
+
+class PortalSettings(BaseModel):
+    r"""The settings for this portal."""
+
+    is_annoucements_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isAnnoucementsEnabled")
+    ] = None
+    r"""Whether the announcements section is enabled on this portal."""
+
+    is_article_feedback_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isArticleFeedbackEnabled")
+    ] = None
+    r"""Whether article feedback is allowed."""
+
+    is_article_feedback_comments_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isArticleFeedbackCommentsEnabled")
+    ] = None
+    r"""Whether comments should be included in the feedback."""
+
+    is_article_feedback_summary_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isArticleFeedbackSummaryEnabled")
+    ] = None
+    r"""Whether a summary of feedback ratings should be displayed."""
+
+    is_related_articles_in_same_topic_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isRelatedArticlesInSameTopicEnabled")
+    ] = None
+    r"""Whether all articles in the same topic are automatically treated as related articles."""
+
+    is_related_articles_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isRelatedArticlesEnabled")
+    ] = None
+    r"""Whether the related articles section is shown."""
+
+    is_authentication_required: Annotated[
+        Optional[bool], pydantic.Field(alias="isAuthenticationRequired")
+    ] = None
+    r"""Whether the portal requires authentication for access."""
+
+    is_agents_sso_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isAgentsSSOEnabled")
+    ] = None
+    r"""Whether SSO is enabled for agents"""
+
+    is_agents_delegated_authentication_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isAgentsDelegatedAuthenticationEnabled")
+    ] = None
+    r"""Whether delegated authentication is enabled for agents"""
+
+    customer_profile_attributes: Annotated[
+        Optional[ConfigurableAttributes],
+        pydantic.Field(alias="customerProfileAttributes"),
+    ] = None
+
+    is_popular_articles_list_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isPopularArticlesListEnabled")
+    ] = None
+    r"""Whether the popular articles list is displayed. Maximum of 50 popular articles will be dislpayed."""
+
+    popular_articles_list_influence_weight: Annotated[
+        Optional[float], pydantic.Field(alias="popularArticlesListInfluenceWeight")
+    ] = None
+    r"""The weight assigned to the influence of related articles on the ranking of popular articles in the ranking formula."""
+
+    popular_articles_list_influence_period: Annotated[
+        Optional[int], pydantic.Field(alias="popularArticlesListInfluencePeriod")
+    ] = None
+    r"""The timeframe in days that related articles affect the ranking of popular articles in the ranking formula."""
+
+    append_session_journey_to_email: Annotated[
+        Optional[bool], pydantic.Field(alias="appendSessionJourneyToEmail")
+    ] = None
+    r"""Whether the session transcript should be appended to the email message."""
+
+    is_article_suggestions_before_escalation_enabled: Annotated[
+        Optional[bool],
+        pydantic.Field(alias="isArticleSuggestionsBeforeEscalationEnabled"),
+    ] = None
+    r"""Whether a user is  shown suggested articles before escalating."""
+
+    is_escalation_to_email_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isEscalationToEmailEnabled")
+    ] = None
+    r"""Whether the user can ask a question via email if Guided Help doesn’t provide an answer, triggering a search before escalation."""
+
+    number_of_suggested_articles_before_escalation: Annotated[
+        Optional[int], pydantic.Field(alias="numberOfSuggestedArticlesBeforeEscalation")
+    ] = None
+    r"""The number of articles to show to a customer before escalation."""
+
+    is_gh_enabled: Annotated[Optional[bool], pydantic.Field(alias="isGHEnabled")] = None
+    r"""Whether guided help is enabled."""
+
+    is_gh_in_search_results_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isGHInSearchResultsEnabled")
+    ] = None
+    r"""Whether to show guided help results in search results."""
+
+    is_gh_startup_questions_before_unanswered_questions_enabled: Annotated[
+        Optional[bool],
+        pydantic.Field(alias="isGHStartupQuestionsBeforeUnansweredQuestionsEnabled"),
+    ] = None
+    r"""Whether startup questions should be presented before unanswered questions in Guided Help."""
+
+    is_gh_details_for_search_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isGHDetailsForSearchEnabled")
+    ] = None
+    r"""Whether additional information should be shown in search results."""
+
+    is_gh_short_name_in_search_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isGHShortNameInSearchEnabled")
+    ] = None
+    r"""When enabled it shows the short names in results."""
+
+    is_gh_cluster_scope_diagnostics_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isGHClusterScopeDiagnosticsEnabled")
+    ] = None
+    r"""Whether to show Cluster scope diagnostics during execution."""
+
+    is_gh_results_shown_on_successful_search: Annotated[
+        Optional[bool], pydantic.Field(alias="isGHResultsShownOnSuccessfulSearch")
+    ] = None
+    r"""Whether to automatically display results on search success."""
+
+    is_gh_control_action_diagnostics_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isGHControlActionDiagnosticsEnabled")
+    ] = None
+    r"""isGHControlActionDiagnosticsEnabled"""
+
+    gh_failure_success_threshold: Annotated[
+        Optional[float], pydantic.Field(alias="GHFailureSuccessThreshold")
+    ] = None
+    r"""A value from range that indicates the failure-success score"""
+
+    max_gh_answered_questions: Annotated[
+        Optional[int], pydantic.Field(alias="maxGHAnsweredQuestions")
+    ] = None
+    r"""A value indicating the maximum number of answered questions."""
+
+    max_gh_unanswered_questions: Annotated[
+        Optional[int], pydantic.Field(alias="maxGHUnansweredQuestions")
+    ] = None
+    r"""A value indicating the maximum number of unanswered questions."""
+
+    max_gh_search_results: Annotated[
+        Optional[int], pydantic.Field(alias="maxGHSearchResults")
+    ] = None
+    r"""Maximum number of guided help results to return."""
+
+    is_search_autocomplete_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isSearchAutocompleteEnabled")
+    ] = None
+    r"""Whether the autocomplete interface should be enabled."""
+
+    is_web_search_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isWebSearchEnabled")
+    ] = None
+    r"""Whether web searches should be performed as part of multi-search."""
+
+    max_web_search_results: Annotated[
+        Optional[int], pydantic.Field(alias="maxWebSearchResults")
+    ] = None
+    r"""The maximum number of results from the web search to return."""
+
+    web_search_domain: Annotated[
+        Optional[str], pydantic.Field(alias="webSearchDomain")
+    ] = None
+    r"""Use this to restrict web search results to a specific domain."""
+
+    is_intranet_search_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isIntranetSearchEnabled")
+    ] = None
+    r"""Whether intranet results should be returned as part of multi-search."""
+
+    max_intranet_search_results: Annotated[
+        Optional[int], pydantic.Field(alias="maxIntranetSearchResults")
+    ] = None
+    r"""The maximum number of results from an intranet search to return."""
+
+    intranet_search_url: Annotated[
+        Optional[str], pydantic.Field(alias="intranetSearchURL")
+    ] = None
+    r"""The URL for the Intranet Search."""
+
+    is_spellcheck_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isSpellcheckEnabled")
+    ] = None
+    r"""Whether spell-correction should be performed on search queries. The corrected query is returned with the results, but is not automatically used."""
+
+    question_matching_engine_url: Annotated[
+        Optional[str], pydantic.Field(alias="questionMatchingEngineURL")
+    ] = None
+    r"""The URL for the question matching engine."""
+
+    is_custom_attributes_filtering_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isCustomAttributesFilteringEnabled")
+    ] = None
+    r"""Whether search results should be filtered by custom attribute values."""
+
+    custom_attributes_for_search_filter: Annotated[
+        Optional[List[SearchFilterAttribute]],
+        pydantic.Field(alias="customAttributesForSearchFilter"),
+    ] = None
+
+    search_learning_inclusion_threshold: Annotated[
+        Optional[int], pydantic.Field(alias="searchLearningInclusionThreshold")
+    ] = None
+    r"""The minimum number of accepts and rejects of an article before article ranking is affected."""
+
+    search_learning_influence: Annotated[
+        Optional[int], pydantic.Field(alias="searchLearningInfluence")
+    ] = None
+    r"""A ranking multiplier for learned scoring."""
+
+    search_learning_level: Annotated[
+        Optional[SearchLearningLevel], pydantic.Field(alias="searchLearningLevel")
+    ] = None
+    r"""Affects the influence of learning on search rankings. 0 = off, 1 = low, 2 = medium, 3 = high, 4 = custom."""
+
+    search_learning_max_influence: Annotated[
+        Optional[int], pydantic.Field(alias="searchLearningMaxInfluence")
+    ] = None
+    r"""The maximum influence allowed for learned scoring."""
+
+    search_related_term_weight: Annotated[
+        Optional[float], pydantic.Field(alias="searchRelatedTermWeight")
+    ] = None
+    r"""The weight assigned to related terms during search."""
+
+    search_related_terms_min_results_threshold: Annotated[
+        Optional[int], pydantic.Field(alias="searchRelatedTermsMinResultsThreshold")
+    ] = None
+    r"""If the number of search results is less than or equal to this value, a search with related terms will be used to fill in results."""
+
+    is_article_suggestions_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isArticleSuggestionsEnabled")
+    ] = None
+    r"""Whether users can make suggestions on an article."""
+
+    is_my_suggestions_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isMySuggestionsEnabled")
+    ] = None
+    r"""Whether a user can view their suggestions."""
+
+    is_captcha_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isCaptchaEnabled")
+    ] = None
+    r"""Whether CAPTCHA is enabled or not in the portal."""
+
+    captcha_site_key: Annotated[
+        Optional[str], pydantic.Field(alias="captchaSiteKey")
+    ] = None
+    r"""The configured CAPTCHA site key."""
+
+    is_article_sharing_enabled: Annotated[
+        Optional[bool], pydantic.Field(alias="isArticleSharingEnabled")
+    ] = None
+    r"""Whether the article sharing is enabled."""
+
+    tag_categories_for_search_filter: Annotated[
+        Optional[TagCategoriesForInterest],
+        pydantic.Field(alias="tagCategoriesForSearchFilter"),
+    ] = None

egain_api_python/models/post_portalid_answersop.py

@@ -0,0 +1,88 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .answersrequest import AnswersRequest, AnswersRequestTypedDict
+from .languagecode_parameter import LanguageCodeParameter
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing import Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+POST_PORTAL_ID_ANSWERS_OP_SERVERS = [
+    # aiservices
+    "https://${API_DOMAIN}/core/aiservices/v4",
+]
+
+
+class PostPortalIDAnswersRequestTypedDict(TypedDict):
+    q: str
+    r"""The search query string. The string must be escaped as required by the URL syntax rules."""
+    portal_id: str
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    dollar_filter_user_profile_id: NotRequired[str]
+    language: NotRequired[LanguageCodeParameter]
+    r"""The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used."""
+    dollar_filter_tags: NotRequired[Dict[str, List[str]]]
+    r"""An object where each key is a **Category Tag ID** (numeric string),
+    and each value is an array of **Tag IDs** for that category.
+
+    """
+    dollar_filter_topic_ids: NotRequired[List[str]]
+    r"""An array of topic IDs. It is used to restrict search results to specific topics."""
+    answers_request: NotRequired[AnswersRequestTypedDict]
+
+
+class PostPortalIDAnswersRequest(BaseModel):
+    q: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""The search query string. The string must be escaped as required by the URL syntax rules."""
+
+    portal_id: Annotated[
+        str,
+        pydantic.Field(alias="portalID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    dollar_filter_user_profile_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="$filter[userProfileID]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+
+    language: Annotated[
+        Optional[LanguageCodeParameter],
+        pydantic.Field(alias="$lang"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used."""
+
+    dollar_filter_tags: Annotated[
+        Optional[Dict[str, List[str]]],
+        pydantic.Field(alias="$filter[tags]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""An object where each key is a **Category Tag ID** (numeric string),
+    and each value is an array of **Tag IDs** for that category.
+
+    """
+
+    dollar_filter_topic_ids: Annotated[
+        Optional[List[str]],
+        pydantic.Field(alias="$filter[topicIds]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""An array of topic IDs. It is used to restrict search results to specific topics."""
+
+    answers_request: Annotated[
+        Optional[AnswersRequest],
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ] = None

egain_api_python/models/post_portalid_retrieveop.py

@@ -0,0 +1,88 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .languagecode_parameter import LanguageCodeParameter
+from .retrieverequest import RetrieveRequest, RetrieveRequestTypedDict
+from egain_api_python.types import BaseModel
+from egain_api_python.utils import (
+    FieldMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing import Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+POST_PORTAL_ID_RETRIEVE_OP_SERVERS = [
+    # aiservices
+    "https://${API_DOMAIN}/core/aiservices/v4",
+]
+
+
+class PostPortalIDRetrieveRequestTypedDict(TypedDict):
+    q: str
+    r"""The search query string. The string must be escaped as required by the URL syntax rules."""
+    portal_id: str
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+    dollar_filter_user_profile_id: NotRequired[str]
+    language: NotRequired[LanguageCodeParameter]
+    r"""The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used."""
+    dollar_filter_tags: NotRequired[Dict[str, List[str]]]
+    r"""An object where each key is a **Category Tag ID** (numeric string),
+    and each value is an array of **Tag IDs** for that category.
+
+    """
+    dollar_filter_topic_ids: NotRequired[List[str]]
+    r"""An array of topic IDs. It is used to restrict search results to specific topics."""
+    retrieve_request: NotRequired[RetrieveRequestTypedDict]
+
+
+class PostPortalIDRetrieveRequest(BaseModel):
+    q: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""The search query string. The string must be escaped as required by the URL syntax rules."""
+
+    portal_id: Annotated[
+        str,
+        pydantic.Field(alias="portalID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits."""
+
+    dollar_filter_user_profile_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="$filter[userProfileID]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+
+    language: Annotated[
+        Optional[LanguageCodeParameter],
+        pydantic.Field(alias="$lang"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used."""
+
+    dollar_filter_tags: Annotated[
+        Optional[Dict[str, List[str]]],
+        pydantic.Field(alias="$filter[tags]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""An object where each key is a **Category Tag ID** (numeric string),
+    and each value is an array of **Tag IDs** for that category.
+
+    """
+
+    dollar_filter_topic_ids: Annotated[
+        Optional[List[str]],
+        pydantic.Field(alias="$filter[topicIds]"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""An array of topic IDs. It is used to restrict search results to specific topics."""
+
+    retrieve_request: Annotated[
+        Optional[RetrieveRequest],
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ] = None

egain_api_python/models/profile.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class ProfileTypedDict(TypedDict):
+    id: str
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+    name: str
+    r"""Name of the profile"""
+
+
+class Profile(BaseModel):
+    id: str
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+
+    name: str
+    r"""Name of the profile"""

egain_api_python/models/profileresult.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paginationinfo import PaginationInfo, PaginationInfoTypedDict
+from .profile import Profile, ProfileTypedDict
+from egain_api_python.types import BaseModel
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ProfileResultTypedDict(TypedDict):
+    profile: NotRequired[List[ProfileTypedDict]]
+    r"""profiles"""
+    pagination_info: NotRequired[PaginationInfoTypedDict]
+
+
+class ProfileResult(BaseModel):
+    profile: Optional[List[Profile]] = None
+    r"""profiles"""
+
+    pagination_info: Annotated[
+        Optional[PaginationInfo], pydantic.Field(alias="paginationInfo")
+    ] = None

egain_api_python/models/publishprofile.py

@@ -0,0 +1,30 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from egain_api_python.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class PublishProfileTypedDict(TypedDict):
+    r"""This schema contains information about Profile."""
+
+    id: str
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+    name: str
+    r"""The name of the profile."""
+
+
+class PublishProfile(BaseModel):
+    r"""This schema contains information about Profile."""
+
+    id: str
+    r"""The ID of the guided help profile.<br>
+    1 will always be the **system profile**.
+
+    """
+
+    name: str
+    r"""The name of the profile."""