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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. egain_api_python/_version.py +3 -3
  2. egain_api_python/answers.py +26 -38
  3. egain_api_python/articlelists.py +10 -10
  4. egain_api_python/connectorssearchevents.py +4 -4
  5. egain_api_python/errors/gethealthop.py +33 -19
  6. egain_api_python/escalation.py +8 -8
  7. egain_api_python/export.py +6 -6
  8. egain_api_python/federatedsearchevent.py +2 -2
  9. egain_api_python/general.py +8 -8
  10. egain_api_python/guidedhelp.py +26 -26
  11. egain_api_python/health.py +2 -8
  12. egain_api_python/import_.py +56 -74
  13. egain_api_python/models/__init__.py +106 -95
  14. egain_api_python/models/aisearchop.py +6 -34
  15. egain_api_python/models/aisearchresponse.py +0 -4
  16. egain_api_python/models/answersrequest.py +0 -31
  17. egain_api_python/models/answersresponse.py +9 -11
  18. egain_api_python/models/articleaisearchresult.py +16 -45
  19. egain_api_python/models/articletype.py +3 -5
  20. egain_api_python/models/{getimportcontentop.py → cancelimportop.py} +3 -3
  21. egain_api_python/models/{createimportop.py → createimportjobop.py} +3 -3
  22. egain_api_python/models/{createimportvalidationop.py → createimportvalidationjobop.py} +3 -3
  23. egain_api_python/models/exportstatus.py +15 -8
  24. egain_api_python/models/getannouncementarticlesop.py +2 -2
  25. egain_api_python/models/getarticlelistdetailsop.py +2 -2
  26. egain_api_python/models/getarticlesintopicop.py +4 -4
  27. egain_api_python/models/getbestanswerop.py +6 -6
  28. egain_api_python/models/gethealthop.py +134 -7
  29. egain_api_python/models/{patchimportcontentvalidationop.py → getimportstatusop.py} +3 -3
  30. egain_api_python/models/getpopulararticlesop.py +4 -4
  31. egain_api_python/models/getrelatedarticlesop.py +2 -2
  32. egain_api_python/models/importstatus.py +116 -0
  33. egain_api_python/models/knowledgeexport.py +3 -5
  34. egain_api_python/models/referenceresponse.py +7 -23
  35. egain_api_python/models/retrievechunksop.py +6 -6
  36. egain_api_python/models/retrieveresponse.py +10 -12
  37. egain_api_python/models/searchresult.py +7 -23
  38. egain_api_python/populararticles.py +14 -14
  39. egain_api_python/portal_article.py +64 -64
  40. egain_api_python/portal_attachment.py +4 -4
  41. egain_api_python/portal_bookmark.py +6 -6
  42. egain_api_python/portal_suggestion.py +18 -18
  43. egain_api_python/portal_topic.py +8 -8
  44. egain_api_python/portal_userdetails.py +2 -2
  45. egain_api_python/portal_userprofile.py +4 -4
  46. egain_api_python/retrieve.py +22 -28
  47. egain_api_python/sdk.py +25 -24
  48. egain_api_python/sdkconfiguration.py +3 -4
  49. egain_api_python/search.py +24 -40
  50. egain_api_python/usermilestones.py +2 -2
  51. {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/METADATA +44 -78
  52. {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/RECORD +55 -57
  53. egain_api_python/models/resourcetype_parameter.py +0 -10
  54. egain_api_python/models/topicaisearchresult.py +0 -67
  55. {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/WHEEL +0 -0
  56. {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/licenses/LICENSE +0 -0
  57. {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/top_level.txt +0 -0
@@ -15,9 +15,9 @@ class Populararticles(BaseSDK):
15
15
  *,
16
16
  accept_language: models.AcceptLanguage,
17
17
  portal_id: str,
18
- dollar_filter_topic_id: Optional[str] = None,
18
+ filter_topic_id: Optional[str] = None,
19
19
  language: Optional[models.LanguageQueryParameter] = None,
20
- dollar_filter_tags: Optional[str] = None,
20
+ filter_tags: Optional[str] = None,
21
21
  pagenum: Optional[int] = 1,
22
22
  pagesize: Optional[int] = 10,
23
23
  article_result_additional_attributes: Optional[
@@ -51,9 +51,9 @@ class Populararticles(BaseSDK):
51
51
 
52
52
  :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
53
53
  :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.
54
- :param dollar_filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
54
+ :param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
55
55
  :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>
56
- :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.
56
+ :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.
57
57
  :param pagenum: Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
58
58
  :param pagesize: Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
59
59
  :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):
75
75
  request = models.GetpopulararticlesRequest(
76
76
  accept_language=accept_language,
77
77
  portal_id=portal_id,
78
- dollar_filter_topic_id=dollar_filter_topic_id,
78
+ filter_topic_id=filter_topic_id,
79
79
  language=language,
80
- dollar_filter_tags=dollar_filter_tags,
80
+ filter_tags=filter_tags,
81
81
  pagenum=pagenum,
82
82
  pagesize=pagesize,
83
83
  article_result_additional_attributes=article_result_additional_attributes,
@@ -112,7 +112,7 @@ class Populararticles(BaseSDK):
112
112
  config=self.sdk_configuration,
113
113
  base_url=base_url or "",
114
114
  operation_id="getpopulararticles",
115
- oauth2_scopes=[],
115
+ oauth2_scopes=None,
116
116
  security_source=get_security_from_env(
117
117
  self.sdk_configuration.security, models.Security
118
118
  ),
@@ -153,9 +153,9 @@ class Populararticles(BaseSDK):
153
153
  *,
154
154
  accept_language: models.AcceptLanguage,
155
155
  portal_id: str,
156
- dollar_filter_topic_id: Optional[str] = None,
156
+ filter_topic_id: Optional[str] = None,
157
157
  language: Optional[models.LanguageQueryParameter] = None,
158
- dollar_filter_tags: Optional[str] = None,
158
+ filter_tags: Optional[str] = None,
159
159
  pagenum: Optional[int] = 1,
160
160
  pagesize: Optional[int] = 10,
161
161
  article_result_additional_attributes: Optional[
@@ -189,9 +189,9 @@ class Populararticles(BaseSDK):
189
189
 
190
190
  :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
191
191
  :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.
192
- :param dollar_filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
192
+ :param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
193
193
  :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>
194
- :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.
194
+ :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.
195
195
  :param pagenum: Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
196
196
  :param pagesize: Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
197
197
  :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):
213
213
  request = models.GetpopulararticlesRequest(
214
214
  accept_language=accept_language,
215
215
  portal_id=portal_id,
216
- dollar_filter_topic_id=dollar_filter_topic_id,
216
+ filter_topic_id=filter_topic_id,
217
217
  language=language,
218
- dollar_filter_tags=dollar_filter_tags,
218
+ filter_tags=filter_tags,
219
219
  pagenum=pagenum,
220
220
  pagesize=pagesize,
221
221
  article_result_additional_attributes=article_result_additional_attributes,
@@ -250,7 +250,7 @@ class Populararticles(BaseSDK):
250
250
  config=self.sdk_configuration,
251
251
  base_url=base_url or "",
252
252
  operation_id="getpopulararticles",
253
- oauth2_scopes=[],
253
+ oauth2_scopes=None,
254
254
  security_source=get_security_from_env(
255
255
  self.sdk_configuration.security, models.Security
256
256
  ),
@@ -120,7 +120,7 @@ class PortalArticle(BaseSDK):
120
120
  config=self.sdk_configuration,
121
121
  base_url=base_url or "",
122
122
  operation_id="getArticleById",
123
- oauth2_scopes=[],
123
+ oauth2_scopes=None,
124
124
  security_source=get_security_from_env(
125
125
  self.sdk_configuration.security, models.Security
126
126
  ),
@@ -266,7 +266,7 @@ class PortalArticle(BaseSDK):
266
266
  config=self.sdk_configuration,
267
267
  base_url=base_url or "",
268
268
  operation_id="getArticleById",
269
- oauth2_scopes=[],
269
+ oauth2_scopes=None,
270
270
  security_source=get_security_from_env(
271
271
  self.sdk_configuration.security, models.Security
272
272
  ),
@@ -373,7 +373,7 @@ class PortalArticle(BaseSDK):
373
373
  config=self.sdk_configuration,
374
374
  base_url=base_url or "",
375
375
  operation_id="getArticleByIdWithEditions",
376
- oauth2_scopes=[],
376
+ oauth2_scopes=None,
377
377
  security_source=get_security_from_env(
378
378
  self.sdk_configuration.security, models.Security
379
379
  ),
@@ -478,7 +478,7 @@ class PortalArticle(BaseSDK):
478
478
  config=self.sdk_configuration,
479
479
  base_url=base_url or "",
480
480
  operation_id="getArticleByIdWithEditions",
481
- oauth2_scopes=[],
481
+ oauth2_scopes=None,
482
482
  security_source=get_security_from_env(
483
483
  self.sdk_configuration.security, models.Security
484
484
  ),
@@ -585,7 +585,7 @@ class PortalArticle(BaseSDK):
585
585
  config=self.sdk_configuration,
586
586
  base_url=base_url or "",
587
587
  operation_id="getArticleEditionDetails",
588
- oauth2_scopes=[],
588
+ oauth2_scopes=None,
589
589
  security_source=get_security_from_env(
590
590
  self.sdk_configuration.security, models.Security
591
591
  ),
@@ -692,7 +692,7 @@ class PortalArticle(BaseSDK):
692
692
  config=self.sdk_configuration,
693
693
  base_url=base_url or "",
694
694
  operation_id="getArticleEditionDetails",
695
- oauth2_scopes=[],
695
+ oauth2_scopes=None,
696
696
  security_source=get_security_from_env(
697
697
  self.sdk_configuration.security, models.Security
698
698
  ),
@@ -824,7 +824,7 @@ class PortalArticle(BaseSDK):
824
824
  config=self.sdk_configuration,
825
825
  base_url=base_url or "",
826
826
  operation_id="AddToReply",
827
- oauth2_scopes=[],
827
+ oauth2_scopes=None,
828
828
  security_source=get_security_from_env(
829
829
  self.sdk_configuration.security, models.Security
830
830
  ),
@@ -966,7 +966,7 @@ class PortalArticle(BaseSDK):
966
966
  config=self.sdk_configuration,
967
967
  base_url=base_url or "",
968
968
  operation_id="AddToReply",
969
- oauth2_scopes=[],
969
+ oauth2_scopes=None,
970
970
  security_source=get_security_from_env(
971
971
  self.sdk_configuration.security, models.Security
972
972
  ),
@@ -1108,7 +1108,7 @@ class PortalArticle(BaseSDK):
1108
1108
  config=self.sdk_configuration,
1109
1109
  base_url=base_url or "",
1110
1110
  operation_id="AddAsReference",
1111
- oauth2_scopes=[],
1111
+ oauth2_scopes=None,
1112
1112
  security_source=get_security_from_env(
1113
1113
  self.sdk_configuration.security, models.Security
1114
1114
  ),
@@ -1250,7 +1250,7 @@ class PortalArticle(BaseSDK):
1250
1250
  config=self.sdk_configuration,
1251
1251
  base_url=base_url or "",
1252
1252
  operation_id="AddAsReference",
1253
- oauth2_scopes=[],
1253
+ oauth2_scopes=None,
1254
1254
  security_source=get_security_from_env(
1255
1255
  self.sdk_configuration.security, models.Security
1256
1256
  ),
@@ -1299,12 +1299,12 @@ class PortalArticle(BaseSDK):
1299
1299
  *,
1300
1300
  accept_language: models.AcceptLanguage,
1301
1301
  portal_id: str,
1302
- dollar_filter_topic_id: str,
1302
+ filter_topic_id: str,
1303
1303
  search_profile_id: Optional[str] = None,
1304
1304
  article_result_additional_attributes: Optional[
1305
1305
  List[models.ArticleResultAdditionalAttributes]
1306
1306
  ] = None,
1307
- dollar_filter_tags: Optional[str] = None,
1307
+ filter_tags: Optional[str] = None,
1308
1308
  workflow_milestone: Optional[models.WorkflowMilestone] = None,
1309
1309
  language: Optional[models.LanguageQueryParameter] = None,
1310
1310
  pagenum: Optional[int] = 1,
@@ -1342,10 +1342,10 @@ class PortalArticle(BaseSDK):
1342
1342
 
1343
1343
  :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
1344
1344
  :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.
1345
- :param dollar_filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
1345
+ :param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
1346
1346
  :param search_profile_id: Search Profile ID
1347
1347
  :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.
1348
- :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.
1348
+ :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.
1349
1349
  :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>
1350
1350
  :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>
1351
1351
  :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):
1371
1371
  accept_language=accept_language,
1372
1372
  portal_id=portal_id,
1373
1373
  search_profile_id=search_profile_id,
1374
- dollar_filter_topic_id=dollar_filter_topic_id,
1374
+ filter_topic_id=filter_topic_id,
1375
1375
  article_result_additional_attributes=article_result_additional_attributes,
1376
- dollar_filter_tags=dollar_filter_tags,
1376
+ filter_tags=filter_tags,
1377
1377
  workflow_milestone=workflow_milestone,
1378
1378
  language=language,
1379
1379
  pagenum=pagenum,
@@ -1411,7 +1411,7 @@ class PortalArticle(BaseSDK):
1411
1411
  config=self.sdk_configuration,
1412
1412
  base_url=base_url or "",
1413
1413
  operation_id="getArticlesInTopic",
1414
- oauth2_scopes=[],
1414
+ oauth2_scopes=None,
1415
1415
  security_source=get_security_from_env(
1416
1416
  self.sdk_configuration.security, models.Security
1417
1417
  ),
@@ -1452,12 +1452,12 @@ class PortalArticle(BaseSDK):
1452
1452
  *,
1453
1453
  accept_language: models.AcceptLanguage,
1454
1454
  portal_id: str,
1455
- dollar_filter_topic_id: str,
1455
+ filter_topic_id: str,
1456
1456
  search_profile_id: Optional[str] = None,
1457
1457
  article_result_additional_attributes: Optional[
1458
1458
  List[models.ArticleResultAdditionalAttributes]
1459
1459
  ] = None,
1460
- dollar_filter_tags: Optional[str] = None,
1460
+ filter_tags: Optional[str] = None,
1461
1461
  workflow_milestone: Optional[models.WorkflowMilestone] = None,
1462
1462
  language: Optional[models.LanguageQueryParameter] = None,
1463
1463
  pagenum: Optional[int] = 1,
@@ -1495,10 +1495,10 @@ class PortalArticle(BaseSDK):
1495
1495
 
1496
1496
  :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
1497
1497
  :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.
1498
- :param dollar_filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
1498
+ :param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
1499
1499
  :param search_profile_id: Search Profile ID
1500
1500
  :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.
1501
- :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.
1501
+ :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.
1502
1502
  :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>
1503
1503
  :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>
1504
1504
  :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):
1524
1524
  accept_language=accept_language,
1525
1525
  portal_id=portal_id,
1526
1526
  search_profile_id=search_profile_id,
1527
- dollar_filter_topic_id=dollar_filter_topic_id,
1527
+ filter_topic_id=filter_topic_id,
1528
1528
  article_result_additional_attributes=article_result_additional_attributes,
1529
- dollar_filter_tags=dollar_filter_tags,
1529
+ filter_tags=filter_tags,
1530
1530
  workflow_milestone=workflow_milestone,
1531
1531
  language=language,
1532
1532
  pagenum=pagenum,
@@ -1564,7 +1564,7 @@ class PortalArticle(BaseSDK):
1564
1564
  config=self.sdk_configuration,
1565
1565
  base_url=base_url or "",
1566
1566
  operation_id="getArticlesInTopic",
1567
- oauth2_scopes=[],
1567
+ oauth2_scopes=None,
1568
1568
  security_source=get_security_from_env(
1569
1569
  self.sdk_configuration.security, models.Security
1570
1570
  ),
@@ -1667,7 +1667,7 @@ class PortalArticle(BaseSDK):
1667
1667
  config=self.sdk_configuration,
1668
1668
  base_url=base_url or "",
1669
1669
  operation_id="getArticleAttachmentById",
1670
- oauth2_scopes=[],
1670
+ oauth2_scopes=None,
1671
1671
  security_source=get_security_from_env(
1672
1672
  self.sdk_configuration.security, models.Security
1673
1673
  ),
@@ -1768,7 +1768,7 @@ class PortalArticle(BaseSDK):
1768
1768
  config=self.sdk_configuration,
1769
1769
  base_url=base_url or "",
1770
1770
  operation_id="getArticleAttachmentById",
1771
- oauth2_scopes=[],
1771
+ oauth2_scopes=None,
1772
1772
  security_source=get_security_from_env(
1773
1773
  self.sdk_configuration.security, models.Security
1774
1774
  ),
@@ -1875,7 +1875,7 @@ class PortalArticle(BaseSDK):
1875
1875
  config=self.sdk_configuration,
1876
1876
  base_url=base_url or "",
1877
1877
  operation_id="getAttachmentByIdInPortal",
1878
- oauth2_scopes=[],
1878
+ oauth2_scopes=None,
1879
1879
  security_source=get_security_from_env(
1880
1880
  self.sdk_configuration.security, models.Security
1881
1881
  ),
@@ -1984,7 +1984,7 @@ class PortalArticle(BaseSDK):
1984
1984
  config=self.sdk_configuration,
1985
1985
  base_url=base_url or "",
1986
1986
  operation_id="getAttachmentByIdInPortal",
1987
- oauth2_scopes=[],
1987
+ oauth2_scopes=None,
1988
1988
  security_source=get_security_from_env(
1989
1989
  self.sdk_configuration.security, models.Security
1990
1990
  ),
@@ -2026,7 +2026,7 @@ class PortalArticle(BaseSDK):
2026
2026
  accept_language: models.AcceptLanguage,
2027
2027
  portal_id: str,
2028
2028
  article_id: str,
2029
- dollar_filter_tags: Optional[str] = None,
2029
+ filter_tags: Optional[str] = None,
2030
2030
  article_result_additional_attributes: Optional[
2031
2031
  List[models.ArticleResultAdditionalAttributes]
2032
2032
  ] = None,
@@ -2066,7 +2066,7 @@ class PortalArticle(BaseSDK):
2066
2066
  :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
2067
2067
  :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.
2068
2068
  :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.
2069
- :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.
2069
+ :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.
2070
2070
  :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.
2071
2071
  :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>
2072
2072
  :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):
2091
2091
  accept_language=accept_language,
2092
2092
  portal_id=portal_id,
2093
2093
  article_id=article_id,
2094
- dollar_filter_tags=dollar_filter_tags,
2094
+ filter_tags=filter_tags,
2095
2095
  article_result_additional_attributes=article_result_additional_attributes,
2096
2096
  workflow_milestone=workflow_milestone,
2097
2097
  language=language,
@@ -2128,7 +2128,7 @@ class PortalArticle(BaseSDK):
2128
2128
  config=self.sdk_configuration,
2129
2129
  base_url=base_url or "",
2130
2130
  operation_id="getRelatedArticles",
2131
- oauth2_scopes=[],
2131
+ oauth2_scopes=None,
2132
2132
  security_source=get_security_from_env(
2133
2133
  self.sdk_configuration.security, models.Security
2134
2134
  ),
@@ -2170,7 +2170,7 @@ class PortalArticle(BaseSDK):
2170
2170
  accept_language: models.AcceptLanguage,
2171
2171
  portal_id: str,
2172
2172
  article_id: str,
2173
- dollar_filter_tags: Optional[str] = None,
2173
+ filter_tags: Optional[str] = None,
2174
2174
  article_result_additional_attributes: Optional[
2175
2175
  List[models.ArticleResultAdditionalAttributes]
2176
2176
  ] = None,
@@ -2210,7 +2210,7 @@ class PortalArticle(BaseSDK):
2210
2210
  :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
2211
2211
  :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.
2212
2212
  :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.
2213
- :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.
2213
+ :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.
2214
2214
  :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.
2215
2215
  :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>
2216
2216
  :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):
2235
2235
  accept_language=accept_language,
2236
2236
  portal_id=portal_id,
2237
2237
  article_id=article_id,
2238
- dollar_filter_tags=dollar_filter_tags,
2238
+ filter_tags=filter_tags,
2239
2239
  article_result_additional_attributes=article_result_additional_attributes,
2240
2240
  workflow_milestone=workflow_milestone,
2241
2241
  language=language,
@@ -2272,7 +2272,7 @@ class PortalArticle(BaseSDK):
2272
2272
  config=self.sdk_configuration,
2273
2273
  base_url=base_url or "",
2274
2274
  operation_id="getRelatedArticles",
2275
- oauth2_scopes=[],
2275
+ oauth2_scopes=None,
2276
2276
  security_source=get_security_from_env(
2277
2277
  self.sdk_configuration.security, models.Security
2278
2278
  ),
@@ -2313,7 +2313,7 @@ class PortalArticle(BaseSDK):
2313
2313
  *,
2314
2314
  accept_language: models.AcceptLanguage,
2315
2315
  portal_id: str,
2316
- dollar_filter_tags: Optional[str] = None,
2316
+ filter_tags: Optional[str] = None,
2317
2317
  article_result_additional_attributes: Optional[
2318
2318
  List[models.ArticleResultAdditionalAttributes]
2319
2319
  ] = None,
@@ -2353,7 +2353,7 @@ class PortalArticle(BaseSDK):
2353
2353
 
2354
2354
  :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
2355
2355
  :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.
2356
- :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.
2356
+ :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.
2357
2357
  :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.
2358
2358
  :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>
2359
2359
  :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):
2377
2377
  request = models.GetAnnouncementArticlesRequest(
2378
2378
  accept_language=accept_language,
2379
2379
  portal_id=portal_id,
2380
- dollar_filter_tags=dollar_filter_tags,
2380
+ filter_tags=filter_tags,
2381
2381
  article_result_additional_attributes=article_result_additional_attributes,
2382
2382
  workflow_milestone=workflow_milestone,
2383
2383
  language=language,
@@ -2414,7 +2414,7 @@ class PortalArticle(BaseSDK):
2414
2414
  config=self.sdk_configuration,
2415
2415
  base_url=base_url or "",
2416
2416
  operation_id="getAnnouncementArticles",
2417
- oauth2_scopes=[],
2417
+ oauth2_scopes=None,
2418
2418
  security_source=get_security_from_env(
2419
2419
  self.sdk_configuration.security, models.Security
2420
2420
  ),
@@ -2455,7 +2455,7 @@ class PortalArticle(BaseSDK):
2455
2455
  *,
2456
2456
  accept_language: models.AcceptLanguage,
2457
2457
  portal_id: str,
2458
- dollar_filter_tags: Optional[str] = None,
2458
+ filter_tags: Optional[str] = None,
2459
2459
  article_result_additional_attributes: Optional[
2460
2460
  List[models.ArticleResultAdditionalAttributes]
2461
2461
  ] = None,
@@ -2495,7 +2495,7 @@ class PortalArticle(BaseSDK):
2495
2495
 
2496
2496
  :param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
2497
2497
  :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.
2498
- :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.
2498
+ :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.
2499
2499
  :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.
2500
2500
  :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>
2501
2501
  :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):
2519
2519
  request = models.GetAnnouncementArticlesRequest(
2520
2520
  accept_language=accept_language,
2521
2521
  portal_id=portal_id,
2522
- dollar_filter_tags=dollar_filter_tags,
2522
+ filter_tags=filter_tags,
2523
2523
  article_result_additional_attributes=article_result_additional_attributes,
2524
2524
  workflow_milestone=workflow_milestone,
2525
2525
  language=language,
@@ -2556,7 +2556,7 @@ class PortalArticle(BaseSDK):
2556
2556
  config=self.sdk_configuration,
2557
2557
  base_url=base_url or "",
2558
2558
  operation_id="getAnnouncementArticles",
2559
- oauth2_scopes=[],
2559
+ oauth2_scopes=None,
2560
2560
  security_source=get_security_from_env(
2561
2561
  self.sdk_configuration.security, models.Security
2562
2562
  ),
@@ -2671,7 +2671,7 @@ class PortalArticle(BaseSDK):
2671
2671
  config=self.sdk_configuration,
2672
2672
  base_url=base_url or "",
2673
2673
  operation_id="getArticleRatings",
2674
- oauth2_scopes=[],
2674
+ oauth2_scopes=None,
2675
2675
  security_source=get_security_from_env(
2676
2676
  self.sdk_configuration.security, models.Security
2677
2677
  ),
@@ -2786,7 +2786,7 @@ class PortalArticle(BaseSDK):
2786
2786
  config=self.sdk_configuration,
2787
2787
  base_url=base_url or "",
2788
2788
  operation_id="getArticleRatings",
2789
- oauth2_scopes=[],
2789
+ oauth2_scopes=None,
2790
2790
  security_source=get_security_from_env(
2791
2791
  self.sdk_configuration.security, models.Security
2792
2792
  ),
@@ -2901,7 +2901,7 @@ class PortalArticle(BaseSDK):
2901
2901
  config=self.sdk_configuration,
2902
2902
  base_url=base_url or "",
2903
2903
  operation_id="rateArticle",
2904
- oauth2_scopes=[],
2904
+ oauth2_scopes=None,
2905
2905
  security_source=get_security_from_env(
2906
2906
  self.sdk_configuration.security, models.Security
2907
2907
  ),
@@ -3024,7 +3024,7 @@ class PortalArticle(BaseSDK):
3024
3024
  config=self.sdk_configuration,
3025
3025
  base_url=base_url or "",
3026
3026
  operation_id="rateArticle",
3027
- oauth2_scopes=[],
3027
+ oauth2_scopes=None,
3028
3028
  security_source=get_security_from_env(
3029
3029
  self.sdk_configuration.security, models.Security
3030
3030
  ),
@@ -3154,7 +3154,7 @@ class PortalArticle(BaseSDK):
3154
3154
  config=self.sdk_configuration,
3155
3155
  base_url=base_url or "",
3156
3156
  operation_id="getPendingComplianceArticles",
3157
- oauth2_scopes=[],
3157
+ oauth2_scopes=None,
3158
3158
  security_source=get_security_from_env(
3159
3159
  self.sdk_configuration.security, models.Security
3160
3160
  ),
@@ -3276,7 +3276,7 @@ class PortalArticle(BaseSDK):
3276
3276
  config=self.sdk_configuration,
3277
3277
  base_url=base_url or "",
3278
3278
  operation_id="getPendingComplianceArticles",
3279
- oauth2_scopes=[],
3279
+ oauth2_scopes=None,
3280
3280
  security_source=get_security_from_env(
3281
3281
  self.sdk_configuration.security, models.Security
3282
3282
  ),
@@ -3401,7 +3401,7 @@ class PortalArticle(BaseSDK):
3401
3401
  config=self.sdk_configuration,
3402
3402
  base_url=base_url or "",
3403
3403
  operation_id="getAcknowledgedComplianceArticles",
3404
- oauth2_scopes=[],
3404
+ oauth2_scopes=None,
3405
3405
  security_source=get_security_from_env(
3406
3406
  self.sdk_configuration.security, models.Security
3407
3407
  ),
@@ -3526,7 +3526,7 @@ class PortalArticle(BaseSDK):
3526
3526
  config=self.sdk_configuration,
3527
3527
  base_url=base_url or "",
3528
3528
  operation_id="getAcknowledgedComplianceArticles",
3529
- oauth2_scopes=[],
3529
+ oauth2_scopes=None,
3530
3530
  security_source=get_security_from_env(
3531
3531
  self.sdk_configuration.security, models.Security
3532
3532
  ),
@@ -3640,7 +3640,7 @@ class PortalArticle(BaseSDK):
3640
3640
  config=self.sdk_configuration,
3641
3641
  base_url=base_url or "",
3642
3642
  operation_id="complyArticle",
3643
- oauth2_scopes=[],
3643
+ oauth2_scopes=None,
3644
3644
  security_source=get_security_from_env(
3645
3645
  self.sdk_configuration.security, models.Security
3646
3646
  ),
@@ -3752,7 +3752,7 @@ class PortalArticle(BaseSDK):
3752
3752
  config=self.sdk_configuration,
3753
3753
  base_url=base_url or "",
3754
3754
  operation_id="complyArticle",
3755
- oauth2_scopes=[],
3755
+ oauth2_scopes=None,
3756
3756
  security_source=get_security_from_env(
3757
3757
  self.sdk_configuration.security, models.Security
3758
3758
  ),
@@ -3867,7 +3867,7 @@ class PortalArticle(BaseSDK):
3867
3867
  config=self.sdk_configuration,
3868
3868
  base_url=base_url or "",
3869
3869
  operation_id="getMySubscription",
3870
- oauth2_scopes=[],
3870
+ oauth2_scopes=None,
3871
3871
  security_source=get_security_from_env(
3872
3872
  self.sdk_configuration.security, models.Security
3873
3873
  ),
@@ -3984,7 +3984,7 @@ class PortalArticle(BaseSDK):
3984
3984
  config=self.sdk_configuration,
3985
3985
  base_url=base_url or "",
3986
3986
  operation_id="getMySubscription",
3987
- oauth2_scopes=[],
3987
+ oauth2_scopes=None,
3988
3988
  security_source=get_security_from_env(
3989
3989
  self.sdk_configuration.security, models.Security
3990
3990
  ),
@@ -4116,7 +4116,7 @@ class PortalArticle(BaseSDK):
4116
4116
  config=self.sdk_configuration,
4117
4117
  base_url=base_url or "",
4118
4118
  operation_id="subscribeArticle",
4119
- oauth2_scopes=[],
4119
+ oauth2_scopes=None,
4120
4120
  security_source=get_security_from_env(
4121
4121
  self.sdk_configuration.security, models.Security
4122
4122
  ),
@@ -4246,7 +4246,7 @@ class PortalArticle(BaseSDK):
4246
4246
  config=self.sdk_configuration,
4247
4247
  base_url=base_url or "",
4248
4248
  operation_id="subscribeArticle",
4249
- oauth2_scopes=[],
4249
+ oauth2_scopes=None,
4250
4250
  security_source=get_security_from_env(
4251
4251
  self.sdk_configuration.security, models.Security
4252
4252
  ),
@@ -4353,7 +4353,7 @@ class PortalArticle(BaseSDK):
4353
4353
  config=self.sdk_configuration,
4354
4354
  base_url=base_url or "",
4355
4355
  operation_id="unsubscribeArticle",
4356
- oauth2_scopes=[],
4356
+ oauth2_scopes=None,
4357
4357
  security_source=get_security_from_env(
4358
4358
  self.sdk_configuration.security, models.Security
4359
4359
  ),
@@ -4460,7 +4460,7 @@ class PortalArticle(BaseSDK):
4460
4460
  config=self.sdk_configuration,
4461
4461
  base_url=base_url or "",
4462
4462
  operation_id="unsubscribeArticle",
4463
- oauth2_scopes=[],
4463
+ oauth2_scopes=None,
4464
4464
  security_source=get_security_from_env(
4465
4465
  self.sdk_configuration.security, models.Security
4466
4466
  ),
@@ -4564,7 +4564,7 @@ class PortalArticle(BaseSDK):
4564
4564
  config=self.sdk_configuration,
4565
4565
  base_url=base_url or "",
4566
4566
  operation_id="getArticlePermissionsById",
4567
- oauth2_scopes=[],
4567
+ oauth2_scopes=None,
4568
4568
  security_source=get_security_from_env(
4569
4569
  self.sdk_configuration.security, models.Security
4570
4570
  ),
@@ -4670,7 +4670,7 @@ class PortalArticle(BaseSDK):
4670
4670
  config=self.sdk_configuration,
4671
4671
  base_url=base_url or "",
4672
4672
  operation_id="getArticlePermissionsById",
4673
- oauth2_scopes=[],
4673
+ oauth2_scopes=None,
4674
4674
  security_source=get_security_from_env(
4675
4675
  self.sdk_configuration.security, models.Security
4676
4676
  ),
@@ -4784,7 +4784,7 @@ class PortalArticle(BaseSDK):
4784
4784
  config=self.sdk_configuration,
4785
4785
  base_url=base_url or "",
4786
4786
  operation_id="getArticlePersonalization",
4787
- oauth2_scopes=[],
4787
+ oauth2_scopes=None,
4788
4788
  security_source=get_security_from_env(
4789
4789
  self.sdk_configuration.security, models.Security
4790
4790
  ),
@@ -4898,7 +4898,7 @@ class PortalArticle(BaseSDK):
4898
4898
  config=self.sdk_configuration,
4899
4899
  base_url=base_url or "",
4900
4900
  operation_id="getArticlePersonalization",
4901
- oauth2_scopes=[],
4901
+ oauth2_scopes=None,
4902
4902
  security_source=get_security_from_env(
4903
4903
  self.sdk_configuration.security, models.Security
4904
4904
  ),