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

egain_api_python/models/importstatus.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from datetime import datetime
 from egain_api_python.types import BaseModel
 import pydantic
 from typing import Literal, Optional
@@ -14,16 +15,131 @@ ImportStatusStatus = Literal[
     "Failed",
     "Cancelled",
 ]
+r"""Status of the job."""
+
+
+JobType = Literal[
+    "Import",
+    "Validation",
+]
+
+
+class ImportStatusProgressTypedDict(TypedDict):
+    r"""Progress of the job."""
+
+    processed: NotRequired[float]
+    r"""Number of items processed."""
+    total: NotRequired[float]
+    r"""Number of total items to process."""
+    percentage: NotRequired[float]
+    r"""Percentage of total items that have been processed."""
+
+
+class ImportStatusProgress(BaseModel):
+    r"""Progress of the job."""
+
+    processed: Optional[float] = None
+    r"""Number of items processed."""
+
+    total: Optional[float] = None
+    r"""Number of total items to process."""
+
+    percentage: Optional[float] = None
+    r"""Percentage of total items that have been processed."""
+
+
+class ImportStatusResultsTypedDict(TypedDict):
+    r"""Result of job."""
+
+    succesfull: NotRequired[float]
+    r"""Number of item succesfully processed by job."""
+    warnings: NotRequired[float]
+    r"""Number of warnings encountered during job."""
+    errors: NotRequired[float]
+    r"""Number of errors encountered during job."""
+
+
+class ImportStatusResults(BaseModel):
+    r"""Result of job."""
+
+    succesfull: Optional[float] = None
+    r"""Number of item succesfully processed by job."""
+
+    warnings: Optional[float] = None
+    r"""Number of warnings encountered during job."""
+
+    errors: Optional[float] = None
+    r"""Number of errors encountered during job."""
 
 
 class ImportStatusTypedDict(TypedDict):
     status: ImportStatusStatus
+    r"""Status of the job."""
+    job_type: JobType
+    progress: NotRequired[ImportStatusProgressTypedDict]
+    r"""Progress of the job."""
     log_file_location: NotRequired[str]
+    r"""Location of the job log file."""
+    start_time: NotRequired[datetime]
+    r"""Start time of job."""
+    estimated_completion: NotRequired[datetime]
+    r"""Estimated completion time of job."""
+    current_operation: NotRequired[str]
+    r"""Current operation of job being processed."""
+    completion_time: NotRequired[datetime]
+    r"""Completion time of job."""
+    failure_time: NotRequired[datetime]
+    r"""Failure time of job."""
+    results: NotRequired[ImportStatusResultsTypedDict]
+    r"""Result of job."""
+    error: NotRequired[str]
+    r"""Error of job."""
+    retryable: NotRequired[bool]
+    r"""Indicates if job is retryable."""
 
 
 class ImportStatus(BaseModel):
     status: ImportStatusStatus
+    r"""Status of the job."""
+
+    job_type: Annotated[JobType, pydantic.Field(alias="jobType")]
+
+    progress: Optional[ImportStatusProgress] = None
+    r"""Progress of the job."""
 
     log_file_location: Annotated[
         Optional[str], pydantic.Field(alias="logFileLocation")
     ] = None
+    r"""Location of the job log file."""
+
+    start_time: Annotated[Optional[datetime], pydantic.Field(alias="startTime")] = None
+    r"""Start time of job."""
+
+    estimated_completion: Annotated[
+        Optional[datetime], pydantic.Field(alias="estimatedCompletion")
+    ] = None
+    r"""Estimated completion time of job."""
+
+    current_operation: Annotated[
+        Optional[str], pydantic.Field(alias="currentOperation")
+    ] = None
+    r"""Current operation of job being processed."""
+
+    completion_time: Annotated[
+        Optional[datetime], pydantic.Field(alias="completionTime")
+    ] = None
+    r"""Completion time of job."""
+
+    failure_time: Annotated[Optional[datetime], pydantic.Field(alias="failureTime")] = (
+        None
+    )
+    r"""Failure time of job."""
+
+    results: Optional[ImportStatusResults] = None
+    r"""Result of job."""
+
+    error: Optional[str] = None
+    r"""Error of job."""
+
+    retryable: Optional[bool] = None
+    r"""Indicates if job is retryable."""

egain_api_python/models/knowledgeexport.py

@@ -48,7 +48,7 @@ class KnowledgeExportLanguage(BaseModel):
     r"""The code of the language."""
 
 
-KnowledgeExportResourceType = Literal[
+ResourceType = Literal[
     "articles",
     "topics",
     "portals",
@@ -104,7 +104,7 @@ class KnowledgeExportTypedDict(TypedDict):
     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."""
     language: KnowledgeExportLanguageTypedDict
     r"""The Knowledge Base language in which the content is created."""
-    resource_types: List[KnowledgeExportResourceType]
+    resource_types: List[ResourceType]
     r"""Types of Knowledge Hub resources to export. Multiple values can be specified using a comma-separated list. Details of a single portal are exported.
     Articles whose state is Published are returned.
     | Portal Attribute Name | Description
@@ -170,9 +170,7 @@ class KnowledgeExport(BaseModel):
     language: KnowledgeExportLanguage
     r"""The Knowledge Base language in which the content is created."""
 
-    resource_types: Annotated[
-        List[KnowledgeExportResourceType], pydantic.Field(alias="resourceTypes")
-    ]
+    resource_types: Annotated[List[ResourceType], pydantic.Field(alias="resourceTypes")]
     r"""Types of Knowledge Hub resources to export. Multiple values can be specified using a comma-separated list. Details of a single portal are exported.
     Articles whose state is Published are returned.
     | Portal Attribute Name | Description

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/retrievechunksop.py

@@ -26,15 +26,15 @@ class RetrieveChunksRequestTypedDict(TypedDict):
     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]
 
@@ -52,7 +52,7 @@ class RetrieveChunksRequest(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 RetrieveChunksRequest(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 RetrieveChunksRequest(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,