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.
- egain_api_python/_version.py +3 -3
- egain_api_python/answers.py +26 -38
- egain_api_python/articlelists.py +10 -10
- egain_api_python/connectorssearchevents.py +4 -4
- egain_api_python/errors/gethealthop.py +33 -19
- egain_api_python/escalation.py +8 -8
- egain_api_python/export.py +6 -6
- egain_api_python/federatedsearchevent.py +2 -2
- egain_api_python/general.py +8 -8
- egain_api_python/guidedhelp.py +26 -26
- egain_api_python/health.py +2 -8
- egain_api_python/import_.py +56 -74
- egain_api_python/models/__init__.py +106 -95
- egain_api_python/models/aisearchop.py +6 -34
- egain_api_python/models/aisearchresponse.py +0 -4
- egain_api_python/models/answersrequest.py +0 -31
- egain_api_python/models/answersresponse.py +9 -11
- egain_api_python/models/articleaisearchresult.py +16 -45
- egain_api_python/models/articletype.py +3 -5
- egain_api_python/models/{getimportcontentop.py → cancelimportop.py} +3 -3
- egain_api_python/models/{createimportop.py → createimportjobop.py} +3 -3
- egain_api_python/models/{createimportvalidationop.py → createimportvalidationjobop.py} +3 -3
- egain_api_python/models/exportstatus.py +15 -8
- egain_api_python/models/getannouncementarticlesop.py +2 -2
- egain_api_python/models/getarticlelistdetailsop.py +2 -2
- egain_api_python/models/getarticlesintopicop.py +4 -4
- egain_api_python/models/getbestanswerop.py +6 -6
- egain_api_python/models/gethealthop.py +134 -7
- egain_api_python/models/{patchimportcontentvalidationop.py → getimportstatusop.py} +3 -3
- egain_api_python/models/getpopulararticlesop.py +4 -4
- egain_api_python/models/getrelatedarticlesop.py +2 -2
- egain_api_python/models/importstatus.py +116 -0
- egain_api_python/models/knowledgeexport.py +3 -5
- egain_api_python/models/referenceresponse.py +7 -23
- egain_api_python/models/retrievechunksop.py +6 -6
- egain_api_python/models/retrieveresponse.py +10 -12
- egain_api_python/models/searchresult.py +7 -23
- egain_api_python/populararticles.py +14 -14
- egain_api_python/portal_article.py +64 -64
- egain_api_python/portal_attachment.py +4 -4
- egain_api_python/portal_bookmark.py +6 -6
- egain_api_python/portal_suggestion.py +18 -18
- egain_api_python/portal_topic.py +8 -8
- egain_api_python/portal_userdetails.py +2 -2
- egain_api_python/portal_userprofile.py +4 -4
- egain_api_python/retrieve.py +22 -28
- egain_api_python/sdk.py +25 -24
- egain_api_python/sdkconfiguration.py +3 -4
- egain_api_python/search.py +24 -40
- egain_api_python/usermilestones.py +2 -2
- {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/METADATA +44 -78
- {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/RECORD +55 -57
- egain_api_python/models/resourcetype_parameter.py +0 -10
- egain_api_python/models/topicaisearchresult.py +0 -67
- {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/WHEEL +0 -0
- {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/licenses/LICENSE +0 -0
- {egain_api_python-0.1.2.dist-info → egain_api_python-0.1.4.dist-info}/top_level.txt +0 -0
egain_api_python/_version.py
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
import importlib.metadata
|
4
4
|
|
5
5
|
__title__: str = "egain-api-python"
|
6
|
-
__version__: str = "0.1.
|
6
|
+
__version__: str = "0.1.4"
|
7
7
|
__openapi_doc_version__: str = "4.0.0"
|
8
|
-
__gen_version__: str = "2.
|
9
|
-
__user_agent__: str = "speakeasy-sdk/python 0.1.
|
8
|
+
__gen_version__: str = "2.723.2"
|
9
|
+
__user_agent__: str = "speakeasy-sdk/python 0.1.4 2.723.2 4.0.0 egain-api-python"
|
10
10
|
|
11
11
|
try:
|
12
12
|
if __package__ is not None:
|
egain_api_python/answers.py
CHANGED
@@ -15,14 +15,13 @@ class Answers(BaseSDK):
|
|
15
15
|
*,
|
16
16
|
q: str,
|
17
17
|
portal_id: str,
|
18
|
-
|
18
|
+
filter_user_profile_id: Optional[str] = None,
|
19
19
|
language: Optional[models.LanguageCodeParameter] = None,
|
20
|
-
|
21
|
-
|
20
|
+
filter_tags: Optional[Dict[str, List[str]]] = None,
|
21
|
+
filter_topic_ids: Optional[List[str]] = None,
|
22
22
|
channel: Optional[
|
23
23
|
Union[models.AnswersRequestChannel, models.AnswersRequestChannelTypedDict]
|
24
24
|
] = None,
|
25
|
-
context: Optional[Union[models.Context, models.ContextTypedDict]] = None,
|
26
25
|
event_id: Optional[str] = None,
|
27
26
|
session_id: Optional[str] = None,
|
28
27
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
@@ -33,20 +32,19 @@ class Answers(BaseSDK):
|
|
33
32
|
r"""Get the best answer for a user query
|
34
33
|
|
35
34
|
The **Answers API** allows enterprises to deliver fast, accurate, and contextual responses powered by their organizational knowledge. It supports two complementary approaches:
|
36
|
-
|
37
|
-
|
35
|
+
- **Certified Answers**: Direct snippets retrieved from enterprise-authored content.
|
36
|
+
- **Generative Answers**: Natural language responses synthesized by a large language model (LLM).
|
38
37
|
|
39
|
-
Every response includes supporting search results, references, and confidence scores—ensuring transparency, trust, and traceability. The API is built for secure, scalable integration across enterprise environments.
|
38
|
+
Every response includes supporting search results, references, and confidence scores—ensuring transparency, trust, and traceability. The API is built for secure, scalable integration across enterprise environments. <br>**This endpoint is only available for Self Service environments.**
|
40
39
|
|
41
40
|
|
42
41
|
:param q: The search query string. The string must be escaped as required by the URL syntax rules.
|
43
42
|
: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.
|
44
|
-
:param
|
43
|
+
:param filter_user_profile_id:
|
45
44
|
: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.
|
46
|
-
:param
|
47
|
-
:param
|
45
|
+
: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.
|
46
|
+
:param filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
|
48
47
|
:param channel:
|
49
|
-
:param context: Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response.
|
50
48
|
:param event_id: Unique ID for this specific API call or event.
|
51
49
|
: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.
|
52
50
|
:param retries: Override the default retry configuration for this method
|
@@ -63,22 +61,18 @@ class Answers(BaseSDK):
|
|
63
61
|
base_url = server_url
|
64
62
|
else:
|
65
63
|
base_url = models.GET_BEST_ANSWER_OP_SERVERS[0]
|
66
|
-
url_variables = {
|
67
|
-
"API_DOMAIN": "api.egain.cloud",
|
68
|
-
}
|
69
64
|
|
70
65
|
request = models.GetBestAnswerRequest(
|
71
66
|
q=q,
|
72
67
|
portal_id=portal_id,
|
73
|
-
|
68
|
+
filter_user_profile_id=filter_user_profile_id,
|
74
69
|
language=language,
|
75
|
-
|
76
|
-
|
70
|
+
filter_tags=filter_tags,
|
71
|
+
filter_topic_ids=filter_topic_ids,
|
77
72
|
answers_request=models.AnswersRequest(
|
78
73
|
channel=utils.get_pydantic_model(
|
79
74
|
channel, Optional[models.AnswersRequestChannel]
|
80
75
|
),
|
81
|
-
context=utils.get_pydantic_model(context, Optional[models.Context]),
|
82
76
|
event_id=event_id,
|
83
77
|
session_id=session_id,
|
84
78
|
),
|
@@ -120,7 +114,7 @@ class Answers(BaseSDK):
|
|
120
114
|
config=self.sdk_configuration,
|
121
115
|
base_url=base_url or "",
|
122
116
|
operation_id="getBestAnswer",
|
123
|
-
oauth2_scopes=
|
117
|
+
oauth2_scopes=None,
|
124
118
|
security_source=get_security_from_env(
|
125
119
|
self.sdk_configuration.security, models.Security
|
126
120
|
),
|
@@ -150,14 +144,13 @@ class Answers(BaseSDK):
|
|
150
144
|
*,
|
151
145
|
q: str,
|
152
146
|
portal_id: str,
|
153
|
-
|
147
|
+
filter_user_profile_id: Optional[str] = None,
|
154
148
|
language: Optional[models.LanguageCodeParameter] = None,
|
155
|
-
|
156
|
-
|
149
|
+
filter_tags: Optional[Dict[str, List[str]]] = None,
|
150
|
+
filter_topic_ids: Optional[List[str]] = None,
|
157
151
|
channel: Optional[
|
158
152
|
Union[models.AnswersRequestChannel, models.AnswersRequestChannelTypedDict]
|
159
153
|
] = None,
|
160
|
-
context: Optional[Union[models.Context, models.ContextTypedDict]] = None,
|
161
154
|
event_id: Optional[str] = None,
|
162
155
|
session_id: Optional[str] = None,
|
163
156
|
retries: OptionalNullable[utils.RetryConfig] = UNSET,
|
@@ -168,20 +161,19 @@ class Answers(BaseSDK):
|
|
168
161
|
r"""Get the best answer for a user query
|
169
162
|
|
170
163
|
The **Answers API** allows enterprises to deliver fast, accurate, and contextual responses powered by their organizational knowledge. It supports two complementary approaches:
|
171
|
-
|
172
|
-
|
164
|
+
- **Certified Answers**: Direct snippets retrieved from enterprise-authored content.
|
165
|
+
- **Generative Answers**: Natural language responses synthesized by a large language model (LLM).
|
173
166
|
|
174
|
-
Every response includes supporting search results, references, and confidence scores—ensuring transparency, trust, and traceability. The API is built for secure, scalable integration across enterprise environments.
|
167
|
+
Every response includes supporting search results, references, and confidence scores—ensuring transparency, trust, and traceability. The API is built for secure, scalable integration across enterprise environments. <br>**This endpoint is only available for Self Service environments.**
|
175
168
|
|
176
169
|
|
177
170
|
:param q: The search query string. The string must be escaped as required by the URL syntax rules.
|
178
171
|
: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.
|
179
|
-
:param
|
172
|
+
:param filter_user_profile_id:
|
180
173
|
: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.
|
181
|
-
:param
|
182
|
-
:param
|
174
|
+
: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.
|
175
|
+
:param filter_topic_ids: An array of topic IDs. It is used to restrict search results to specific topics.
|
183
176
|
:param channel:
|
184
|
-
:param context: Additional contextual metadata that enriches the query, providing the LLM with relevant details for tailoring the response.
|
185
177
|
:param event_id: Unique ID for this specific API call or event.
|
186
178
|
: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.
|
187
179
|
:param retries: Override the default retry configuration for this method
|
@@ -198,22 +190,18 @@ class Answers(BaseSDK):
|
|
198
190
|
base_url = server_url
|
199
191
|
else:
|
200
192
|
base_url = models.GET_BEST_ANSWER_OP_SERVERS[0]
|
201
|
-
url_variables = {
|
202
|
-
"API_DOMAIN": "api.egain.cloud",
|
203
|
-
}
|
204
193
|
|
205
194
|
request = models.GetBestAnswerRequest(
|
206
195
|
q=q,
|
207
196
|
portal_id=portal_id,
|
208
|
-
|
197
|
+
filter_user_profile_id=filter_user_profile_id,
|
209
198
|
language=language,
|
210
|
-
|
211
|
-
|
199
|
+
filter_tags=filter_tags,
|
200
|
+
filter_topic_ids=filter_topic_ids,
|
212
201
|
answers_request=models.AnswersRequest(
|
213
202
|
channel=utils.get_pydantic_model(
|
214
203
|
channel, Optional[models.AnswersRequestChannel]
|
215
204
|
),
|
216
|
-
context=utils.get_pydantic_model(context, Optional[models.Context]),
|
217
205
|
event_id=event_id,
|
218
206
|
session_id=session_id,
|
219
207
|
),
|
@@ -255,7 +243,7 @@ class Answers(BaseSDK):
|
|
255
243
|
config=self.sdk_configuration,
|
256
244
|
base_url=base_url or "",
|
257
245
|
operation_id="getBestAnswer",
|
258
|
-
oauth2_scopes=
|
246
|
+
oauth2_scopes=None,
|
259
247
|
security_source=get_security_from_env(
|
260
248
|
self.sdk_configuration.security, models.Security
|
261
249
|
),
|
egain_api_python/articlelists.py
CHANGED
@@ -80,7 +80,7 @@ class Articlelists(BaseSDK):
|
|
80
80
|
config=self.sdk_configuration,
|
81
81
|
base_url=base_url or "",
|
82
82
|
operation_id="getAllArticleLists",
|
83
|
-
oauth2_scopes=
|
83
|
+
oauth2_scopes=None,
|
84
84
|
security_source=get_security_from_env(
|
85
85
|
self.sdk_configuration.security, models.Security
|
86
86
|
),
|
@@ -186,7 +186,7 @@ class Articlelists(BaseSDK):
|
|
186
186
|
config=self.sdk_configuration,
|
187
187
|
base_url=base_url or "",
|
188
188
|
operation_id="getAllArticleLists",
|
189
|
-
oauth2_scopes=
|
189
|
+
oauth2_scopes=None,
|
190
190
|
security_source=get_security_from_env(
|
191
191
|
self.sdk_configuration.security, models.Security
|
192
192
|
),
|
@@ -228,7 +228,7 @@ class Articlelists(BaseSDK):
|
|
228
228
|
accept_language: models.AcceptLanguage,
|
229
229
|
portal_id: str,
|
230
230
|
list_id: str,
|
231
|
-
|
231
|
+
filter_topic_id: Optional[str] = None,
|
232
232
|
article_result_additional_attributes: Optional[
|
233
233
|
List[models.ArticleResultAdditionalAttributes]
|
234
234
|
] = None,
|
@@ -253,7 +253,7 @@ class Articlelists(BaseSDK):
|
|
253
253
|
:param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
|
254
254
|
: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.
|
255
255
|
:param list_id: The ID of the list to be returned.
|
256
|
-
:param
|
256
|
+
:param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
|
257
257
|
: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.
|
258
258
|
: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>
|
259
259
|
:param retries: Override the default retry configuration for this method
|
@@ -275,7 +275,7 @@ class Articlelists(BaseSDK):
|
|
275
275
|
accept_language=accept_language,
|
276
276
|
portal_id=portal_id,
|
277
277
|
list_id=list_id,
|
278
|
-
|
278
|
+
filter_topic_id=filter_topic_id,
|
279
279
|
article_result_additional_attributes=article_result_additional_attributes,
|
280
280
|
language=language,
|
281
281
|
)
|
@@ -309,7 +309,7 @@ class Articlelists(BaseSDK):
|
|
309
309
|
config=self.sdk_configuration,
|
310
310
|
base_url=base_url or "",
|
311
311
|
operation_id="getArticleListDetails",
|
312
|
-
oauth2_scopes=
|
312
|
+
oauth2_scopes=None,
|
313
313
|
security_source=get_security_from_env(
|
314
314
|
self.sdk_configuration.security, models.Security
|
315
315
|
),
|
@@ -351,7 +351,7 @@ class Articlelists(BaseSDK):
|
|
351
351
|
accept_language: models.AcceptLanguage,
|
352
352
|
portal_id: str,
|
353
353
|
list_id: str,
|
354
|
-
|
354
|
+
filter_topic_id: Optional[str] = None,
|
355
355
|
article_result_additional_attributes: Optional[
|
356
356
|
List[models.ArticleResultAdditionalAttributes]
|
357
357
|
] = None,
|
@@ -376,7 +376,7 @@ class Articlelists(BaseSDK):
|
|
376
376
|
:param accept_language: The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
|
377
377
|
: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.
|
378
378
|
:param list_id: The ID of the list to be returned.
|
379
|
-
:param
|
379
|
+
:param filter_topic_id: The ID of the topic. It is used to restrict to a specific topic.
|
380
380
|
: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.
|
381
381
|
: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>
|
382
382
|
:param retries: Override the default retry configuration for this method
|
@@ -398,7 +398,7 @@ class Articlelists(BaseSDK):
|
|
398
398
|
accept_language=accept_language,
|
399
399
|
portal_id=portal_id,
|
400
400
|
list_id=list_id,
|
401
|
-
|
401
|
+
filter_topic_id=filter_topic_id,
|
402
402
|
article_result_additional_attributes=article_result_additional_attributes,
|
403
403
|
language=language,
|
404
404
|
)
|
@@ -432,7 +432,7 @@ class Articlelists(BaseSDK):
|
|
432
432
|
config=self.sdk_configuration,
|
433
433
|
base_url=base_url or "",
|
434
434
|
operation_id="getArticleListDetails",
|
435
|
-
oauth2_scopes=
|
435
|
+
oauth2_scopes=None,
|
436
436
|
security_source=get_security_from_env(
|
437
437
|
self.sdk_configuration.security, models.Security
|
438
438
|
),
|
@@ -96,7 +96,7 @@ class Connectorssearchevents(BaseSDK):
|
|
96
96
|
config=self.sdk_configuration,
|
97
97
|
base_url=base_url or "",
|
98
98
|
operation_id="createSearchResultEventForConnectors",
|
99
|
-
oauth2_scopes=
|
99
|
+
oauth2_scopes=None,
|
100
100
|
security_source=get_security_from_env(
|
101
101
|
self.sdk_configuration.security, models.Security
|
102
102
|
),
|
@@ -226,7 +226,7 @@ class Connectorssearchevents(BaseSDK):
|
|
226
226
|
config=self.sdk_configuration,
|
227
227
|
base_url=base_url or "",
|
228
228
|
operation_id="createSearchResultEventForConnectors",
|
229
|
-
oauth2_scopes=
|
229
|
+
oauth2_scopes=None,
|
230
230
|
security_source=get_security_from_env(
|
231
231
|
self.sdk_configuration.security, models.Security
|
232
232
|
),
|
@@ -359,7 +359,7 @@ class Connectorssearchevents(BaseSDK):
|
|
359
359
|
config=self.sdk_configuration,
|
360
360
|
base_url=base_url or "",
|
361
361
|
operation_id="createViewedSearchResultsEventForConnectors",
|
362
|
-
oauth2_scopes=
|
362
|
+
oauth2_scopes=None,
|
363
363
|
security_source=get_security_from_env(
|
364
364
|
self.sdk_configuration.security, models.Security
|
365
365
|
),
|
@@ -492,7 +492,7 @@ class Connectorssearchevents(BaseSDK):
|
|
492
492
|
config=self.sdk_configuration,
|
493
493
|
base_url=base_url or "",
|
494
494
|
operation_id="createViewedSearchResultsEventForConnectors",
|
495
|
-
oauth2_scopes=
|
495
|
+
oauth2_scopes=None,
|
496
496
|
security_source=get_security_from_env(
|
497
497
|
self.sdk_configuration.security, models.Security
|
498
498
|
),
|
@@ -2,44 +2,58 @@
|
|
2
2
|
|
3
3
|
from __future__ import annotations
|
4
4
|
from dataclasses import dataclass, field
|
5
|
-
from datetime import datetime
|
6
5
|
from egain_api_python.errors import EgainError
|
6
|
+
from egain_api_python.models import gethealthop as models_gethealthop
|
7
7
|
from egain_api_python.types import BaseModel
|
8
8
|
import httpx
|
9
|
-
from typing import Optional
|
9
|
+
from typing import Any, List, Optional
|
10
10
|
|
11
11
|
|
12
12
|
class ServiceUnavailableErrorData(BaseModel):
|
13
|
-
status: Optional[
|
13
|
+
status: Optional[models_gethealthop.ServiceUnavailableStatus] = None
|
14
14
|
r"""**Health Status**
|
15
15
|
|
16
|
-
The overall health status of the service.
|
17
|
-
- Service
|
18
|
-
-
|
19
|
-
-
|
20
|
-
-
|
16
|
+
The overall health status of the service. Possible values:
|
17
|
+
- **healthy**: Service is operating normally
|
18
|
+
- **degraded**: Service is functional but with performance issues
|
19
|
+
- **unhealthy**: Service is experiencing critical issues
|
20
|
+
- **maintenance**: Service is under planned maintenance
|
21
21
|
|
22
22
|
"""
|
23
23
|
|
24
|
-
timestamp: Optional[
|
24
|
+
timestamp: Optional[Any] = None
|
25
25
|
r"""**Health Check Timestamp**
|
26
26
|
|
27
|
-
The exact date and time when this health check was performed. This
|
28
|
-
-
|
29
|
-
-
|
30
|
-
-
|
31
|
-
- Historical
|
27
|
+
The exact date and time when this health check was performed. This is useful for:
|
28
|
+
- Tracking health check frequency
|
29
|
+
- Correlating with other system events
|
30
|
+
- Monitoring health check response times
|
31
|
+
- Historical health trend analysis
|
32
32
|
|
33
33
|
"""
|
34
34
|
|
35
35
|
version: Optional[str] = None
|
36
36
|
r"""**API Version**
|
37
37
|
|
38
|
-
The current version of the Import Content API. This
|
39
|
-
-
|
40
|
-
-
|
41
|
-
-
|
42
|
-
-
|
38
|
+
The current version of the Import Content API. This helps with:
|
39
|
+
- Version compatibility checking
|
40
|
+
- Feature availability verification
|
41
|
+
- Upgrade planning and coordination
|
42
|
+
- Support and troubleshooting
|
43
|
+
|
44
|
+
"""
|
45
|
+
|
46
|
+
issues: Optional[List[str]] = None
|
47
|
+
r"""**Issues**:
|
48
|
+
|
49
|
+
List of detected health problems
|
50
|
+
|
51
|
+
"""
|
52
|
+
|
53
|
+
components: Optional[models_gethealthop.Components] = None
|
54
|
+
r"""**Comonents**:
|
55
|
+
|
56
|
+
Health status of import service componenets
|
43
57
|
|
44
58
|
"""
|
45
59
|
|
egain_api_python/escalation.py
CHANGED
@@ -111,7 +111,7 @@ class Escalation(BaseSDK):
|
|
111
111
|
config=self.sdk_configuration,
|
112
112
|
base_url=base_url or "",
|
113
113
|
operation_id="startCustomerEscalation",
|
114
|
-
oauth2_scopes=
|
114
|
+
oauth2_scopes=None,
|
115
115
|
security_source=get_security_from_env(
|
116
116
|
self.sdk_configuration.security, models.Security
|
117
117
|
),
|
@@ -248,7 +248,7 @@ class Escalation(BaseSDK):
|
|
248
248
|
config=self.sdk_configuration,
|
249
249
|
base_url=base_url or "",
|
250
250
|
operation_id="startCustomerEscalation",
|
251
|
-
oauth2_scopes=
|
251
|
+
oauth2_scopes=None,
|
252
252
|
security_source=get_security_from_env(
|
253
253
|
self.sdk_configuration.security, models.Security
|
254
254
|
),
|
@@ -369,7 +369,7 @@ class Escalation(BaseSDK):
|
|
369
369
|
config=self.sdk_configuration,
|
370
370
|
base_url=base_url or "",
|
371
371
|
operation_id="searchPriorToEscalation",
|
372
|
-
oauth2_scopes=
|
372
|
+
oauth2_scopes=None,
|
373
373
|
security_source=get_security_from_env(
|
374
374
|
self.sdk_configuration.security, models.Security
|
375
375
|
),
|
@@ -490,7 +490,7 @@ class Escalation(BaseSDK):
|
|
490
490
|
config=self.sdk_configuration,
|
491
491
|
base_url=base_url or "",
|
492
492
|
operation_id="searchPriorToEscalation",
|
493
|
-
oauth2_scopes=
|
493
|
+
oauth2_scopes=None,
|
494
494
|
security_source=get_security_from_env(
|
495
495
|
self.sdk_configuration.security, models.Security
|
496
496
|
),
|
@@ -599,7 +599,7 @@ class Escalation(BaseSDK):
|
|
599
599
|
config=self.sdk_configuration,
|
600
600
|
base_url=base_url or "",
|
601
601
|
operation_id="completeCustomerEscalation",
|
602
|
-
oauth2_scopes=
|
602
|
+
oauth2_scopes=None,
|
603
603
|
security_source=get_security_from_env(
|
604
604
|
self.sdk_configuration.security, models.Security
|
605
605
|
),
|
@@ -706,7 +706,7 @@ class Escalation(BaseSDK):
|
|
706
706
|
config=self.sdk_configuration,
|
707
707
|
base_url=base_url or "",
|
708
708
|
operation_id="completeCustomerEscalation",
|
709
|
-
oauth2_scopes=
|
709
|
+
oauth2_scopes=None,
|
710
710
|
security_source=get_security_from_env(
|
711
711
|
self.sdk_configuration.security, models.Security
|
712
712
|
),
|
@@ -813,7 +813,7 @@ class Escalation(BaseSDK):
|
|
813
813
|
config=self.sdk_configuration,
|
814
814
|
base_url=base_url or "",
|
815
815
|
operation_id="avertCustomerEscalation",
|
816
|
-
oauth2_scopes=
|
816
|
+
oauth2_scopes=None,
|
817
817
|
security_source=get_security_from_env(
|
818
818
|
self.sdk_configuration.security, models.Security
|
819
819
|
),
|
@@ -920,7 +920,7 @@ class Escalation(BaseSDK):
|
|
920
920
|
config=self.sdk_configuration,
|
921
921
|
base_url=base_url or "",
|
922
922
|
operation_id="avertCustomerEscalation",
|
923
|
-
oauth2_scopes=
|
923
|
+
oauth2_scopes=None,
|
924
924
|
security_source=get_security_from_env(
|
925
925
|
self.sdk_configuration.security, models.Security
|
926
926
|
),
|
egain_api_python/export.py
CHANGED
@@ -17,7 +17,7 @@ class Export(BaseSDK):
|
|
17
17
|
language: Union[
|
18
18
|
models.KnowledgeExportLanguage, models.KnowledgeExportLanguageTypedDict
|
19
19
|
],
|
20
|
-
resource_types: List[models.
|
20
|
+
resource_types: List[models.ResourceType],
|
21
21
|
data_destination: Union[
|
22
22
|
models.DataDestination, models.DataDestinationTypedDict
|
23
23
|
],
|
@@ -101,7 +101,7 @@ class Export(BaseSDK):
|
|
101
101
|
config=self.sdk_configuration,
|
102
102
|
base_url=base_url or "",
|
103
103
|
operation_id="exportContent",
|
104
|
-
oauth2_scopes=
|
104
|
+
oauth2_scopes=None,
|
105
105
|
security_source=get_security_from_env(
|
106
106
|
self.sdk_configuration.security, models.Security
|
107
107
|
),
|
@@ -142,7 +142,7 @@ class Export(BaseSDK):
|
|
142
142
|
language: Union[
|
143
143
|
models.KnowledgeExportLanguage, models.KnowledgeExportLanguageTypedDict
|
144
144
|
],
|
145
|
-
resource_types: List[models.
|
145
|
+
resource_types: List[models.ResourceType],
|
146
146
|
data_destination: Union[
|
147
147
|
models.DataDestination, models.DataDestinationTypedDict
|
148
148
|
],
|
@@ -226,7 +226,7 @@ class Export(BaseSDK):
|
|
226
226
|
config=self.sdk_configuration,
|
227
227
|
base_url=base_url or "",
|
228
228
|
operation_id="exportContent",
|
229
|
-
oauth2_scopes=
|
229
|
+
oauth2_scopes=None,
|
230
230
|
security_source=get_security_from_env(
|
231
231
|
self.sdk_configuration.security, models.Security
|
232
232
|
),
|
@@ -339,7 +339,7 @@ class Export(BaseSDK):
|
|
339
339
|
config=self.sdk_configuration,
|
340
340
|
base_url=base_url or "",
|
341
341
|
operation_id="exportStatus",
|
342
|
-
oauth2_scopes=
|
342
|
+
oauth2_scopes=None,
|
343
343
|
security_source=get_security_from_env(
|
344
344
|
self.sdk_configuration.security, models.Security
|
345
345
|
),
|
@@ -452,7 +452,7 @@ class Export(BaseSDK):
|
|
452
452
|
config=self.sdk_configuration,
|
453
453
|
base_url=base_url or "",
|
454
454
|
operation_id="exportStatus",
|
455
|
-
oauth2_scopes=
|
455
|
+
oauth2_scopes=None,
|
456
456
|
security_source=get_security_from_env(
|
457
457
|
self.sdk_configuration.security, models.Security
|
458
458
|
),
|
@@ -104,7 +104,7 @@ class Federatedsearchevent(BaseSDK):
|
|
104
104
|
config=self.sdk_configuration,
|
105
105
|
base_url=base_url or "",
|
106
106
|
operation_id="createFederatedSearchResultEvent",
|
107
|
-
oauth2_scopes=
|
107
|
+
oauth2_scopes=None,
|
108
108
|
security_source=get_security_from_env(
|
109
109
|
self.sdk_configuration.security, models.Security
|
110
110
|
),
|
@@ -242,7 +242,7 @@ class Federatedsearchevent(BaseSDK):
|
|
242
242
|
config=self.sdk_configuration,
|
243
243
|
base_url=base_url or "",
|
244
244
|
operation_id="createFederatedSearchResultEvent",
|
245
|
-
oauth2_scopes=
|
245
|
+
oauth2_scopes=None,
|
246
246
|
security_source=get_security_from_env(
|
247
247
|
self.sdk_configuration.security, models.Security
|
248
248
|
),
|
egain_api_python/general.py
CHANGED
@@ -86,7 +86,7 @@ class General(BaseSDK):
|
|
86
86
|
config=self.sdk_configuration,
|
87
87
|
base_url=base_url or "",
|
88
88
|
operation_id="getAllPortals",
|
89
|
-
oauth2_scopes=
|
89
|
+
oauth2_scopes=None,
|
90
90
|
security_source=get_security_from_env(
|
91
91
|
self.sdk_configuration.security, models.Security
|
92
92
|
),
|
@@ -198,7 +198,7 @@ class General(BaseSDK):
|
|
198
198
|
config=self.sdk_configuration,
|
199
199
|
base_url=base_url or "",
|
200
200
|
operation_id="getAllPortals",
|
201
|
-
oauth2_scopes=
|
201
|
+
oauth2_scopes=None,
|
202
202
|
security_source=get_security_from_env(
|
203
203
|
self.sdk_configuration.security, models.Security
|
204
204
|
),
|
@@ -328,7 +328,7 @@ class General(BaseSDK):
|
|
328
328
|
config=self.sdk_configuration,
|
329
329
|
base_url=base_url or "",
|
330
330
|
operation_id="getMyPortals",
|
331
|
-
oauth2_scopes=
|
331
|
+
oauth2_scopes=None,
|
332
332
|
security_source=get_security_from_env(
|
333
333
|
self.sdk_configuration.security, models.Security
|
334
334
|
),
|
@@ -458,7 +458,7 @@ class General(BaseSDK):
|
|
458
458
|
config=self.sdk_configuration,
|
459
459
|
base_url=base_url or "",
|
460
460
|
operation_id="getMyPortals",
|
461
|
-
oauth2_scopes=
|
461
|
+
oauth2_scopes=None,
|
462
462
|
security_source=get_security_from_env(
|
463
463
|
self.sdk_configuration.security, models.Security
|
464
464
|
),
|
@@ -564,7 +564,7 @@ class General(BaseSDK):
|
|
564
564
|
config=self.sdk_configuration,
|
565
565
|
base_url=base_url or "",
|
566
566
|
operation_id="getPortalDetailsById",
|
567
|
-
oauth2_scopes=
|
567
|
+
oauth2_scopes=None,
|
568
568
|
security_source=get_security_from_env(
|
569
569
|
self.sdk_configuration.security, models.Security
|
570
570
|
),
|
@@ -670,7 +670,7 @@ class General(BaseSDK):
|
|
670
670
|
config=self.sdk_configuration,
|
671
671
|
base_url=base_url or "",
|
672
672
|
operation_id="getPortalDetailsById",
|
673
|
-
oauth2_scopes=
|
673
|
+
oauth2_scopes=None,
|
674
674
|
security_source=get_security_from_env(
|
675
675
|
self.sdk_configuration.security, models.Security
|
676
676
|
),
|
@@ -779,7 +779,7 @@ class General(BaseSDK):
|
|
779
779
|
config=self.sdk_configuration,
|
780
780
|
base_url=base_url or "",
|
781
781
|
operation_id="getTagCategoriesForInterestForPortal",
|
782
|
-
oauth2_scopes=
|
782
|
+
oauth2_scopes=None,
|
783
783
|
security_source=get_security_from_env(
|
784
784
|
self.sdk_configuration.security, models.Security
|
785
785
|
),
|
@@ -888,7 +888,7 @@ class General(BaseSDK):
|
|
888
888
|
config=self.sdk_configuration,
|
889
889
|
base_url=base_url or "",
|
890
890
|
operation_id="getTagCategoriesForInterestForPortal",
|
891
|
-
oauth2_scopes=
|
891
|
+
oauth2_scopes=None,
|
892
892
|
security_source=get_security_from_env(
|
893
893
|
self.sdk_configuration.security, models.Security
|
894
894
|
),
|