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

egain_api_python/models/referenceresponse.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
 from egain_api_python.types import BaseModel
 import pydantic
 from typing import Literal, Optional
@@ -22,25 +23,6 @@ ReferenceResponseSource = Literal[
 r"""Source Type"""
 
 
-class ReferenceResponseLinkTypedDict(TypedDict):
-    r"""Defines the relationship between this resource and another object."""
-
-    rel: NotRequired[str]
-    r"""Defines the relationship between a linked resource and the current object. <br><br> For example: self, prev, next or an object name such as 'user', 'folder' etc."""
-    href: NotRequired[str]
-    r"""The URL that specifies the link's destination."""
-
-
-class ReferenceResponseLink(BaseModel):
-    r"""Defines the relationship between this resource and another object."""
-
-    rel: Optional[str] = None
-    r"""Defines the relationship between a linked resource and the current object. <br><br> For example: self, prev, next or an object name such as 'user', 'folder' etc."""
-
-    href: Optional[str] = None
-    r"""The URL that specifies the link's destination."""
-
-
 class ReferenceResponseTypedDict(TypedDict):
     r"""One document used in generated response"""
 
@@ -54,8 +36,8 @@ class ReferenceResponseTypedDict(TypedDict):
     r"""Source Type"""
     doc_name: NotRequired[str]
     r"""Name of the attachment, if an attachment was used as the source content."""
-    link: NotRequired[ReferenceResponseLinkTypedDict]
-    r"""Defines the relationship between this resource and another object."""
+    topic_bread_crumb: NotRequired[TopicBreadcrumbTypedDict]
+    r"""This schema contains one or more TopicSummary instances."""
 
 
 class ReferenceResponse(BaseModel):
@@ -76,5 +58,7 @@ class ReferenceResponse(BaseModel):
     doc_name: Annotated[Optional[str], pydantic.Field(alias="docName")] = None
     r"""Name of the attachment, if an attachment was used as the source content."""
 
-    link: Optional[ReferenceResponseLink] = None
-    r"""Defines the relationship between this resource and another object."""
+    topic_bread_crumb: Annotated[
+        Optional[TopicBreadcrumb], pydantic.Field(alias="topicBreadCrumb")
+    ] = None
+    r"""This schema contains one or more TopicSummary instances."""

egain_api_python/models/{post_portalid_retrieveop.py → retrievechunksop.py}

@@ -15,31 +15,31 @@ from typing import Dict, List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-POST_PORTAL_ID_RETRIEVE_OP_SERVERS = [
+RETRIEVE_CHUNKS_OP_SERVERS = [
     # aiservices
     "https://${API_DOMAIN}/core/aiservices/v4",
 ]
 
 
-class PostPortalIDRetrieveRequestTypedDict(TypedDict):
+class RetrieveChunksRequestTypedDict(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]
+    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]]]
+    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]]
+    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):
+class RetrieveChunksRequest(BaseModel):
     q: Annotated[
         str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
     ]
@@ -52,7 +52,7 @@ class PostPortalIDRetrieveRequest(BaseModel):
     ]
     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[
+    filter_user_profile_id: Annotated[
         Optional[str],
         pydantic.Field(alias="$filter[userProfileID]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -65,7 +65,7 @@ class PostPortalIDRetrieveRequest(BaseModel):
     ] = 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[
+    filter_tags: Annotated[
         Optional[Dict[str, List[str]]],
         pydantic.Field(alias="$filter[tags]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -75,7 +75,7 @@ class PostPortalIDRetrieveRequest(BaseModel):
 
     """
 
-    dollar_filter_topic_ids: Annotated[
+    filter_topic_ids: Annotated[
         Optional[List[str]],
         pydantic.Field(alias="$filter[topicIds]"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),

egain_api_python/models/searchresult.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
 from egain_api_python.types import BaseModel
 import pydantic
 from typing import Literal, Optional
@@ -28,25 +29,6 @@ SnippetType = Literal[
 ]
 
 
-class SearchResultLinkTypedDict(TypedDict):
-    r"""Defines the relationship between this resource and another object."""
-
-    rel: NotRequired[str]
-    r"""Defines the relationship between a linked resource and the current object. <br><br> For example: self, prev, next or an object name such as 'user', 'folder' etc."""
-    href: NotRequired[str]
-    r"""The URL that specifies the link's destination."""
-
-
-class SearchResultLink(BaseModel):
-    r"""Defines the relationship between this resource and another object."""
-
-    rel: Optional[str] = None
-    r"""Defines the relationship between a linked resource and the current object. <br><br> For example: self, prev, next or an object name such as 'user', 'folder' etc."""
-
-    href: Optional[str] = None
-    r"""The URL that specifies the link's destination."""
-
-
 class SearchResultTypedDict(TypedDict):
     r"""Represents a single document or snippet returned by search, along with its metadata and relevance score."""
 
@@ -65,8 +47,8 @@ class SearchResultTypedDict(TypedDict):
     doc_name: NotRequired[str]
     r"""Name of the attachment, if an attachment was used as the source content."""
     snippet_type: NotRequired[SnippetType]
-    link: NotRequired[SearchResultLinkTypedDict]
-    r"""Defines the relationship between this resource and another object."""
+    topic_bread_crumb: NotRequired[TopicBreadcrumbTypedDict]
+    r"""This schema contains one or more TopicSummary instances."""
 
 
 class SearchResult(BaseModel):
@@ -97,5 +79,7 @@ class SearchResult(BaseModel):
         Optional[SnippetType], pydantic.Field(alias="snippetType")
     ] = None
 
-    link: Optional[SearchResultLink] = None
-    r"""Defines the relationship between this resource and another object."""
+    topic_bread_crumb: Annotated[
+        Optional[TopicBreadcrumb], pydantic.Field(alias="topicBreadCrumb")
+    ] = None
+    r"""This schema contains one or more TopicSummary instances."""

egain_api_python/populararticles.py

@@ -15,9 +15,9 @@ class Populararticles(BaseSDK):
         *,
         accept_language: models.AcceptLanguage,
         portal_id: str,
-        dollar_filter_topic_id: Optional[str] = None,
+        filter_topic_id: Optional[str] = None,
         language: Optional[models.LanguageQueryParameter] = None,
-        dollar_filter_tags: Optional[str] = None,
+        filter_tags: Optional[str] = None,
         pagenum: Optional[int] = 1,
         pagesize: Optional[int] = 10,
         article_result_additional_attributes: Optional[
@@ -51,9 +51,9 @@ class Populararticles(BaseSDK):
 
         :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
-        :param dollar_filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
+        :param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
         :param 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 dollar_filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
+        :param filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
         :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 article_result_additional_attributes: The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.
@@ -75,9 +75,9 @@ class Populararticles(BaseSDK):
         request = models.GetpopulararticlesRequest(
             accept_language=accept_language,
             portal_id=portal_id,
-            dollar_filter_topic_id=dollar_filter_topic_id,
+            filter_topic_id=filter_topic_id,
             language=language,
-            dollar_filter_tags=dollar_filter_tags,
+            filter_tags=filter_tags,
             pagenum=pagenum,
             pagesize=pagesize,
             article_result_additional_attributes=article_result_additional_attributes,
@@ -153,9 +153,9 @@ class Populararticles(BaseSDK):
         *,
         accept_language: models.AcceptLanguage,
         portal_id: str,
-        dollar_filter_topic_id: Optional[str] = None,
+        filter_topic_id: Optional[str] = None,
         language: Optional[models.LanguageQueryParameter] = None,
-        dollar_filter_tags: Optional[str] = None,
+        filter_tags: Optional[str] = None,
         pagenum: Optional[int] = 1,
         pagesize: Optional[int] = 10,
         article_result_additional_attributes: Optional[
@@ -189,9 +189,9 @@ class Populararticles(BaseSDK):
 
         :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
-        :param dollar_filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
+        :param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
         :param 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 dollar_filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
+        :param filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
         :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 article_result_additional_attributes: The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.
@@ -213,9 +213,9 @@ class Populararticles(BaseSDK):
         request = models.GetpopulararticlesRequest(
             accept_language=accept_language,
             portal_id=portal_id,
-            dollar_filter_topic_id=dollar_filter_topic_id,
+            filter_topic_id=filter_topic_id,
             language=language,
-            dollar_filter_tags=dollar_filter_tags,
+            filter_tags=filter_tags,
             pagenum=pagenum,
             pagesize=pagesize,
             article_result_additional_attributes=article_result_additional_attributes,

egain_api_python/portal_article.py

@@ -1299,12 +1299,12 @@ class PortalArticle(BaseSDK):
         *,
         accept_language: models.AcceptLanguage,
         portal_id: str,
-        dollar_filter_topic_id: str,
+        filter_topic_id: str,
         search_profile_id: Optional[str] = None,
         article_result_additional_attributes: Optional[
             List[models.ArticleResultAdditionalAttributes]
         ] = None,
-        dollar_filter_tags: Optional[str] = None,
+        filter_tags: Optional[str] = None,
         workflow_milestone: Optional[models.WorkflowMilestone] = None,
         language: Optional[models.LanguageQueryParameter] = None,
         pagenum: Optional[int] = 1,
@@ -1342,10 +1342,10 @@ class PortalArticle(BaseSDK):
 
         :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
-        :param dollar_filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
+        :param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
         :param search_profile_id: Search Profile ID
         :param article_result_additional_attributes: The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.
-        :param dollar_filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
+        :param filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
         :param workflow_milestone: For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>'Authoring' returns the most recent version of an Article checked-in by an author.</li><li>'Staging' returns the updated version currently being processed in a workflow.</li><li>'Publish' returns the most recently published version.</li>
         :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.
@@ -1371,9 +1371,9 @@ class PortalArticle(BaseSDK):
             accept_language=accept_language,
             portal_id=portal_id,
             search_profile_id=search_profile_id,
-            dollar_filter_topic_id=dollar_filter_topic_id,
+            filter_topic_id=filter_topic_id,
             article_result_additional_attributes=article_result_additional_attributes,
-            dollar_filter_tags=dollar_filter_tags,
+            filter_tags=filter_tags,
             workflow_milestone=workflow_milestone,
             language=language,
             pagenum=pagenum,
@@ -1452,12 +1452,12 @@ class PortalArticle(BaseSDK):
         *,
         accept_language: models.AcceptLanguage,
         portal_id: str,
-        dollar_filter_topic_id: str,
+        filter_topic_id: str,
         search_profile_id: Optional[str] = None,
         article_result_additional_attributes: Optional[
             List[models.ArticleResultAdditionalAttributes]
         ] = None,
-        dollar_filter_tags: Optional[str] = None,
+        filter_tags: Optional[str] = None,
         workflow_milestone: Optional[models.WorkflowMilestone] = None,
         language: Optional[models.LanguageQueryParameter] = None,
         pagenum: Optional[int] = 1,
@@ -1495,10 +1495,10 @@ class PortalArticle(BaseSDK):
 
         :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
-        :param dollar_filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
+        :param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
         :param search_profile_id: Search Profile ID
         :param article_result_additional_attributes: The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.
-        :param dollar_filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
+        :param filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
         :param workflow_milestone: For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>'Authoring' returns the most recent version of an Article checked-in by an author.</li><li>'Staging' returns the updated version currently being processed in a workflow.</li><li>'Publish' returns the most recently published version.</li>
         :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.
@@ -1524,9 +1524,9 @@ class PortalArticle(BaseSDK):
             accept_language=accept_language,
             portal_id=portal_id,
             search_profile_id=search_profile_id,
-            dollar_filter_topic_id=dollar_filter_topic_id,
+            filter_topic_id=filter_topic_id,
             article_result_additional_attributes=article_result_additional_attributes,
-            dollar_filter_tags=dollar_filter_tags,
+            filter_tags=filter_tags,
             workflow_milestone=workflow_milestone,
             language=language,
             pagenum=pagenum,
@@ -2026,7 +2026,7 @@ class PortalArticle(BaseSDK):
         accept_language: models.AcceptLanguage,
         portal_id: str,
         article_id: str,
-        dollar_filter_tags: Optional[str] = None,
+        filter_tags: Optional[str] = None,
         article_result_additional_attributes: Optional[
             List[models.ArticleResultAdditionalAttributes]
         ] = None,
@@ -2066,7 +2066,7 @@ class PortalArticle(BaseSDK):
         :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
         :param article_id: The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.
-        :param dollar_filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
+        :param filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
         :param article_result_additional_attributes: The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.
         :param workflow_milestone: For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>'Authoring' returns the most recent version of an Article checked-in by an author.</li><li>'Staging' returns the updated version currently being processed in a workflow.</li><li>'Publish' returns the most recently published version.</li>
         :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>
@@ -2091,7 +2091,7 @@ class PortalArticle(BaseSDK):
             accept_language=accept_language,
             portal_id=portal_id,
             article_id=article_id,
-            dollar_filter_tags=dollar_filter_tags,
+            filter_tags=filter_tags,
             article_result_additional_attributes=article_result_additional_attributes,
             workflow_milestone=workflow_milestone,
             language=language,
@@ -2170,7 +2170,7 @@ class PortalArticle(BaseSDK):
         accept_language: models.AcceptLanguage,
         portal_id: str,
         article_id: str,
-        dollar_filter_tags: Optional[str] = None,
+        filter_tags: Optional[str] = None,
         article_result_additional_attributes: Optional[
             List[models.ArticleResultAdditionalAttributes]
         ] = None,
@@ -2210,7 +2210,7 @@ class PortalArticle(BaseSDK):
         :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
         :param article_id: The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.
-        :param dollar_filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
+        :param filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
         :param article_result_additional_attributes: The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.
         :param workflow_milestone: For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>'Authoring' returns the most recent version of an Article checked-in by an author.</li><li>'Staging' returns the updated version currently being processed in a workflow.</li><li>'Publish' returns the most recently published version.</li>
         :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>
@@ -2235,7 +2235,7 @@ class PortalArticle(BaseSDK):
             accept_language=accept_language,
             portal_id=portal_id,
             article_id=article_id,
-            dollar_filter_tags=dollar_filter_tags,
+            filter_tags=filter_tags,
             article_result_additional_attributes=article_result_additional_attributes,
             workflow_milestone=workflow_milestone,
             language=language,
@@ -2313,7 +2313,7 @@ class PortalArticle(BaseSDK):
         *,
         accept_language: models.AcceptLanguage,
         portal_id: str,
-        dollar_filter_tags: Optional[str] = None,
+        filter_tags: Optional[str] = None,
         article_result_additional_attributes: Optional[
             List[models.ArticleResultAdditionalAttributes]
         ] = None,
@@ -2353,7 +2353,7 @@ class PortalArticle(BaseSDK):
 
         :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
-        :param dollar_filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
+        :param filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
         :param article_result_additional_attributes: The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.
         :param workflow_milestone: For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>'Authoring' returns the most recent version of an Article checked-in by an author.</li><li>'Staging' returns the updated version currently being processed in a workflow.</li><li>'Publish' returns the most recently published version.</li>
         :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>
@@ -2377,7 +2377,7 @@ class PortalArticle(BaseSDK):
         request = models.GetAnnouncementArticlesRequest(
             accept_language=accept_language,
             portal_id=portal_id,
-            dollar_filter_tags=dollar_filter_tags,
+            filter_tags=filter_tags,
             article_result_additional_attributes=article_result_additional_attributes,
             workflow_milestone=workflow_milestone,
             language=language,
@@ -2455,7 +2455,7 @@ class PortalArticle(BaseSDK):
         *,
         accept_language: models.AcceptLanguage,
         portal_id: str,
-        dollar_filter_tags: Optional[str] = None,
+        filter_tags: Optional[str] = None,
         article_result_additional_attributes: Optional[
             List[models.ArticleResultAdditionalAttributes]
         ] = None,
@@ -2495,7 +2495,7 @@ class PortalArticle(BaseSDK):
 
         :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
-        :param dollar_filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
+        :param filter_tags: A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.
         :param article_result_additional_attributes: The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.  #### Default Attributes These Article attributes are always returned:  | Name | Description  | ---- | ----------- | id | The ID of the Article. | name  | The name of the Article. | articleType | The Article Type and its attributes. | createdBy | The ID, first name, middle name and last name of the user that created the Article. | createdDate | The date that the Article was created. | hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments. | languageCode | The language code of the Article language.  | modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. | modifiedDate | The date that the Article was last modified on. | link | The link object, used to retrieve the details of the Article. | versionId | The ID of the Article version that is returned.
         :param workflow_milestone: For agents with the View Author Portal or View Staging Portal actions, this determines which version of the Article is returned.<li>'Authoring' returns the most recent version of an Article checked-in by an author.</li><li>'Staging' returns the updated version currently being processed in a workflow.</li><li>'Publish' returns the most recently published version.</li>
         :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>
@@ -2519,7 +2519,7 @@ class PortalArticle(BaseSDK):
         request = models.GetAnnouncementArticlesRequest(
             accept_language=accept_language,
             portal_id=portal_id,
-            dollar_filter_tags=dollar_filter_tags,
+            filter_tags=filter_tags,
             article_result_additional_attributes=article_result_additional_attributes,
             workflow_milestone=workflow_milestone,
             language=language,

egain_api_python/retrieve.py

@@ -10,15 +10,15 @@ from typing import Dict, List, Mapping, Optional, Union
 
 
 class Retrieve(BaseSDK):
-    def post_portal_id_retrieve(
+    def retrieve_chunks(
         self,
         *,
         q: str,
         portal_id: str,
-        dollar_filter_user_profile_id: Optional[str] = None,
+        filter_user_profile_id: Optional[str] = None,
         language: Optional[models.LanguageCodeParameter] = None,
-        dollar_filter_tags: Optional[Dict[str, List[str]]] = None,
-        dollar_filter_topic_ids: Optional[List[str]] = None,
+        filter_tags: Optional[Dict[str, List[str]]] = None,
+        filter_topic_ids: Optional[List[str]] = None,
         channel: Optional[
             Union[models.RetrieveRequestChannel, models.RetrieveRequestChannelTypedDict]
         ] = None,
@@ -35,10 +35,10 @@ class Retrieve(BaseSDK):
 
         :param q: The search query string. The string must be escaped as required by the URL syntax rules.
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
-        :param dollar_filter_user_profile_id:
+        :param filter_user_profile_id:
         :param language: The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used.
-        :param dollar_filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.
-        :param dollar_filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
+        :param filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.
+        :param filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
         :param channel:
         :param event_id: Unique ID for this specific API call or event.
         :param session_id: ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session.
@@ -55,18 +55,18 @@ class Retrieve(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.POST_PORTAL_ID_RETRIEVE_OP_SERVERS[0]
+            base_url = models.RETRIEVE_CHUNKS_OP_SERVERS[0]
             url_variables = {
                 "API_DOMAIN": "api.egain.cloud",
             }
 
-        request = models.PostPortalIDRetrieveRequest(
+        request = models.RetrieveChunksRequest(
             q=q,
             portal_id=portal_id,
-            dollar_filter_user_profile_id=dollar_filter_user_profile_id,
+            filter_user_profile_id=filter_user_profile_id,
             language=language,
-            dollar_filter_tags=dollar_filter_tags,
-            dollar_filter_topic_ids=dollar_filter_topic_ids,
+            filter_tags=filter_tags,
+            filter_topic_ids=filter_topic_ids,
             retrieve_request=models.RetrieveRequest(
                 channel=utils.get_pydantic_model(
                     channel, Optional[models.RetrieveRequestChannel]
@@ -111,7 +111,7 @@ class Retrieve(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="post_/{portalID}/retrieve",
+                operation_id="retrieveChunks",
                 oauth2_scopes=[],
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security
@@ -137,15 +137,15 @@ class Retrieve(BaseSDK):
 
         raise errors.EgainDefaultError("Unexpected response received", http_res)
 
-    async def post_portal_id_retrieve_async(
+    async def retrieve_chunks_async(
         self,
         *,
         q: str,
         portal_id: str,
-        dollar_filter_user_profile_id: Optional[str] = None,
+        filter_user_profile_id: Optional[str] = None,
         language: Optional[models.LanguageCodeParameter] = None,
-        dollar_filter_tags: Optional[Dict[str, List[str]]] = None,
-        dollar_filter_topic_ids: Optional[List[str]] = None,
+        filter_tags: Optional[Dict[str, List[str]]] = None,
+        filter_topic_ids: Optional[List[str]] = None,
         channel: Optional[
             Union[models.RetrieveRequestChannel, models.RetrieveRequestChannelTypedDict]
         ] = None,
@@ -162,10 +162,10 @@ class Retrieve(BaseSDK):
 
         :param q: The search query string. The string must be escaped as required by the URL syntax rules.
         :param portal_id: The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
-        :param dollar_filter_user_profile_id:
+        :param filter_user_profile_id:
         :param language: The language that describes the details of a resource. Resources available in different languages may differ from each other. <br><br> If lang is not passed, then the portal's default language is used.
-        :param dollar_filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.
-        :param dollar_filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
+        :param filter_tags: An object where each key is a **Category Tag ID** (numeric string),   and each value is an array of **Tag IDs** for that category.
+        :param filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
         :param channel:
         :param event_id: Unique ID for this specific API call or event.
         :param session_id: ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session.
@@ -182,18 +182,18 @@ class Retrieve(BaseSDK):
         if server_url is not None:
             base_url = server_url
         else:
-            base_url = models.POST_PORTAL_ID_RETRIEVE_OP_SERVERS[0]
+            base_url = models.RETRIEVE_CHUNKS_OP_SERVERS[0]
             url_variables = {
                 "API_DOMAIN": "api.egain.cloud",
             }
 
-        request = models.PostPortalIDRetrieveRequest(
+        request = models.RetrieveChunksRequest(
             q=q,
             portal_id=portal_id,
-            dollar_filter_user_profile_id=dollar_filter_user_profile_id,
+            filter_user_profile_id=filter_user_profile_id,
             language=language,
-            dollar_filter_tags=dollar_filter_tags,
-            dollar_filter_topic_ids=dollar_filter_topic_ids,
+            filter_tags=filter_tags,
+            filter_topic_ids=filter_topic_ids,
             retrieve_request=models.RetrieveRequest(
                 channel=utils.get_pydantic_model(
                     channel, Optional[models.RetrieveRequestChannel]
@@ -238,7 +238,7 @@ class Retrieve(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="post_/{portalID}/retrieve",
+                operation_id="retrieveChunks",
                 oauth2_scopes=[],
                 security_source=get_security_from_env(
                     self.sdk_configuration.security, models.Security

egain_api_python/sdk.py

@@ -45,6 +45,7 @@ class Egain(BaseSDK):
 
 
 
+    https://github.com/eGain/egain-api-python - Full SDK Documentation
     """
 
     aiservices: "Aiservices"