purecloud-platform-client-v2 136.1.0 → 137.1.0
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.
- package/README.md +9 -12
- package/dist/node/purecloud-platform-client-v2.js +9667 -9635
- package/dist/web-amd/purecloud-platform-client-v2.js +9667 -9635
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +9674 -9635
- package/dist/web-cjs/purecloud-platform-client-v2.js +11469 -13867
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +92 -76
- package/package.json +2 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +197 -169
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +56 -56
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +231 -231
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +534 -534
- package/src/purecloud-platform-client-v2/api/AuditApi.js +31 -31
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +212 -212
- package/src/purecloud-platform-client-v2/api/BillingApi.js +12 -12
- package/src/purecloud-platform-client-v2/api/ChatApi.js +16 -16
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +96 -96
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +192 -192
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +808 -808
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +17 -17
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +337 -337
- package/src/purecloud-platform-client-v2/api/FaxApi.js +31 -31
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +11 -11
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +246 -246
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -21
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +88 -88
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +72 -72
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +171 -171
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +311 -311
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +146 -146
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +131 -131
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +151 -151
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +51 -51
- package/src/purecloud-platform-client-v2/api/LearningApi.js +107 -107
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +49 -49
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +41 -41
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +43 -43
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +67 -67
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +50 -50
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +81 -81
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +162 -162
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +608 -608
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +64 -64
- package/src/purecloud-platform-client-v2/api/QualityApi.js +285 -285
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +302 -302
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +86 -86
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +536 -536
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +195 -195
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +66 -66
- package/src/purecloud-platform-client-v2/api/SearchApi.js +96 -96
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +194 -194
- package/src/purecloud-platform-client-v2/api/StationsApi.js +28 -28
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +21 -21
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +16 -16
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +657 -657
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +23 -23
- package/src/purecloud-platform-client-v2/api/TokensApi.js +21 -21
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/UsageApi.js +11 -11
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +31 -31
- package/src/purecloud-platform-client-v2/api/UsersApi.js +413 -413
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +21 -21
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +140 -140
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +97 -97
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +66 -66
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +765 -765
- package/src/purecloud-platform-client-v2/index.js +2 -1
- package/src/purecloud-platform-client-v2/logger.js +17 -13
|
@@ -5,7 +5,7 @@ class PresenceApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Presence service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 137.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -34,13 +34,13 @@ class PresenceApi {
|
|
|
34
34
|
return this.apiClient.callApi(
|
|
35
35
|
'/api/v2/presencedefinitions/{presenceId}',
|
|
36
36
|
'DELETE',
|
|
37
|
-
{ 'presenceId': presenceId },
|
|
38
|
-
{ },
|
|
39
|
-
{ },
|
|
40
|
-
{ },
|
|
37
|
+
{ 'presenceId': presenceId },
|
|
38
|
+
{ },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
41
|
null,
|
|
42
42
|
['PureCloud OAuth'],
|
|
43
|
-
['application/json'],
|
|
43
|
+
['application/json'],
|
|
44
44
|
['application/json']
|
|
45
45
|
);
|
|
46
46
|
}
|
|
@@ -63,19 +63,19 @@ class PresenceApi {
|
|
|
63
63
|
return this.apiClient.callApi(
|
|
64
64
|
'/api/v2/presencedefinitions/{presenceId}',
|
|
65
65
|
'GET',
|
|
66
|
-
{ 'presenceId': presenceId },
|
|
67
|
-
{ 'localeCode': opts['localeCode'] },
|
|
68
|
-
{ },
|
|
69
|
-
{ },
|
|
66
|
+
{ 'presenceId': presenceId },
|
|
67
|
+
{ 'localeCode': opts['localeCode'] },
|
|
68
|
+
{ },
|
|
69
|
+
{ },
|
|
70
70
|
null,
|
|
71
71
|
['PureCloud OAuth'],
|
|
72
|
-
['application/json'],
|
|
72
|
+
['application/json'],
|
|
73
73
|
['application/json']
|
|
74
74
|
);
|
|
75
75
|
}
|
|
76
76
|
|
|
77
77
|
/**
|
|
78
|
-
* Get an Organization
|
|
78
|
+
* Get an Organization's list of Presence Definitions
|
|
79
79
|
*
|
|
80
80
|
* @param {Object} opts Optional parameters
|
|
81
81
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -90,13 +90,13 @@ class PresenceApi {
|
|
|
90
90
|
return this.apiClient.callApi(
|
|
91
91
|
'/api/v2/presencedefinitions',
|
|
92
92
|
'GET',
|
|
93
|
-
{ },
|
|
94
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'deleted': opts['deleted'],'localeCode': opts['localeCode'] },
|
|
95
|
-
{ },
|
|
96
|
-
{ },
|
|
93
|
+
{ },
|
|
94
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'deleted': opts['deleted'],'localeCode': opts['localeCode'] },
|
|
95
|
+
{ },
|
|
96
|
+
{ },
|
|
97
97
|
null,
|
|
98
98
|
['PureCloud OAuth'],
|
|
99
|
-
['application/json'],
|
|
99
|
+
['application/json'],
|
|
100
100
|
['application/json']
|
|
101
101
|
);
|
|
102
102
|
}
|
|
@@ -110,20 +110,20 @@ class PresenceApi {
|
|
|
110
110
|
return this.apiClient.callApi(
|
|
111
111
|
'/api/v2/systempresences',
|
|
112
112
|
'GET',
|
|
113
|
-
{ },
|
|
114
|
-
{ },
|
|
115
|
-
{ },
|
|
116
|
-
{ },
|
|
113
|
+
{ },
|
|
114
|
+
{ },
|
|
115
|
+
{ },
|
|
116
|
+
{ },
|
|
117
117
|
null,
|
|
118
118
|
['PureCloud OAuth'],
|
|
119
|
-
['application/json'],
|
|
119
|
+
['application/json'],
|
|
120
120
|
['application/json']
|
|
121
121
|
);
|
|
122
122
|
}
|
|
123
123
|
|
|
124
124
|
/**
|
|
125
|
-
* Get a user
|
|
126
|
-
* Get a
|
|
125
|
+
* Get a user's Presence
|
|
126
|
+
* Get a users presence for the specified source that is not specifically listed. Used to support custom presence sources.
|
|
127
127
|
* @param {String} userId user Id
|
|
128
128
|
* @param {String} sourceId Presence source ID
|
|
129
129
|
*/
|
|
@@ -140,19 +140,19 @@ class PresenceApi {
|
|
|
140
140
|
return this.apiClient.callApi(
|
|
141
141
|
'/api/v2/users/{userId}/presences/{sourceId}',
|
|
142
142
|
'GET',
|
|
143
|
-
{ 'userId': userId,'sourceId': sourceId },
|
|
144
|
-
{ },
|
|
145
|
-
{ },
|
|
146
|
-
{ },
|
|
143
|
+
{ 'userId': userId,'sourceId': sourceId },
|
|
144
|
+
{ },
|
|
145
|
+
{ },
|
|
146
|
+
{ },
|
|
147
147
|
null,
|
|
148
148
|
['PureCloud OAuth'],
|
|
149
|
-
['application/json'],
|
|
149
|
+
['application/json'],
|
|
150
150
|
['application/json']
|
|
151
151
|
);
|
|
152
152
|
}
|
|
153
153
|
|
|
154
154
|
/**
|
|
155
|
-
* Get a user
|
|
155
|
+
* Get a user's Genesys Cloud presence.
|
|
156
156
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
157
157
|
* @param {String} userId user Id
|
|
158
158
|
*/
|
|
@@ -165,20 +165,20 @@ class PresenceApi {
|
|
|
165
165
|
return this.apiClient.callApi(
|
|
166
166
|
'/api/v2/users/{userId}/presences/purecloud',
|
|
167
167
|
'GET',
|
|
168
|
-
{ 'userId': userId },
|
|
169
|
-
{ },
|
|
170
|
-
{ },
|
|
171
|
-
{ },
|
|
168
|
+
{ 'userId': userId },
|
|
169
|
+
{ },
|
|
170
|
+
{ },
|
|
171
|
+
{ },
|
|
172
172
|
null,
|
|
173
173
|
['PureCloud OAuth'],
|
|
174
|
-
['application/json'],
|
|
174
|
+
['application/json'],
|
|
175
175
|
['application/json']
|
|
176
176
|
);
|
|
177
177
|
}
|
|
178
178
|
|
|
179
179
|
/**
|
|
180
|
-
* Patch a user
|
|
181
|
-
* Patch a
|
|
180
|
+
* Patch a user's Presence
|
|
181
|
+
* Patch a users presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the primary property to true. This will set the source defined in the path as the users primary presence source. Option 2: Provide the presenceDefinition value. The id is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
182
182
|
* @param {String} userId user Id
|
|
183
183
|
* @param {String} sourceId Presence source ID
|
|
184
184
|
* @param {Object} body User presence
|
|
@@ -200,20 +200,20 @@ class PresenceApi {
|
|
|
200
200
|
return this.apiClient.callApi(
|
|
201
201
|
'/api/v2/users/{userId}/presences/{sourceId}',
|
|
202
202
|
'PATCH',
|
|
203
|
-
{ 'userId': userId,'sourceId': sourceId },
|
|
204
|
-
{ },
|
|
205
|
-
{ },
|
|
206
|
-
{ },
|
|
203
|
+
{ 'userId': userId,'sourceId': sourceId },
|
|
204
|
+
{ },
|
|
205
|
+
{ },
|
|
206
|
+
{ },
|
|
207
207
|
body,
|
|
208
208
|
['PureCloud OAuth'],
|
|
209
|
-
['application/json'],
|
|
209
|
+
['application/json'],
|
|
210
210
|
['application/json']
|
|
211
211
|
);
|
|
212
212
|
}
|
|
213
213
|
|
|
214
214
|
/**
|
|
215
|
-
* Patch a Genesys Cloud user
|
|
216
|
-
* The presence object can be patched one of three ways. Option 1: Set the
|
|
215
|
+
* Patch a Genesys Cloud user's presence
|
|
216
|
+
* The presence object can be patched one of three ways. Option 1: Set the primary property to true. This will set the PURECLOUD source as the users primary presence source. Option 2: Provide the presenceDefinition value. The id is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
217
217
|
* @param {String} userId user Id
|
|
218
218
|
* @param {Object} body User presence
|
|
219
219
|
*/
|
|
@@ -230,13 +230,13 @@ class PresenceApi {
|
|
|
230
230
|
return this.apiClient.callApi(
|
|
231
231
|
'/api/v2/users/{userId}/presences/purecloud',
|
|
232
232
|
'PATCH',
|
|
233
|
-
{ 'userId': userId },
|
|
234
|
-
{ },
|
|
235
|
-
{ },
|
|
236
|
-
{ },
|
|
233
|
+
{ 'userId': userId },
|
|
234
|
+
{ },
|
|
235
|
+
{ },
|
|
236
|
+
{ },
|
|
237
237
|
body,
|
|
238
238
|
['PureCloud OAuth'],
|
|
239
|
-
['application/json'],
|
|
239
|
+
['application/json'],
|
|
240
240
|
['application/json']
|
|
241
241
|
);
|
|
242
242
|
}
|
|
@@ -255,13 +255,13 @@ class PresenceApi {
|
|
|
255
255
|
return this.apiClient.callApi(
|
|
256
256
|
'/api/v2/presencedefinitions',
|
|
257
257
|
'POST',
|
|
258
|
-
{ },
|
|
259
|
-
{ },
|
|
260
|
-
{ },
|
|
261
|
-
{ },
|
|
258
|
+
{ },
|
|
259
|
+
{ },
|
|
260
|
+
{ },
|
|
261
|
+
{ },
|
|
262
262
|
body,
|
|
263
263
|
['PureCloud OAuth'],
|
|
264
|
-
['application/json'],
|
|
264
|
+
['application/json'],
|
|
265
265
|
['application/json']
|
|
266
266
|
);
|
|
267
267
|
}
|
|
@@ -285,13 +285,13 @@ class PresenceApi {
|
|
|
285
285
|
return this.apiClient.callApi(
|
|
286
286
|
'/api/v2/presencedefinitions/{presenceId}',
|
|
287
287
|
'PUT',
|
|
288
|
-
{ 'presenceId': presenceId },
|
|
289
|
-
{ },
|
|
290
|
-
{ },
|
|
291
|
-
{ },
|
|
288
|
+
{ 'presenceId': presenceId },
|
|
289
|
+
{ },
|
|
290
|
+
{ },
|
|
291
|
+
{ },
|
|
292
292
|
body,
|
|
293
293
|
['PureCloud OAuth'],
|
|
294
|
-
['application/json'],
|
|
294
|
+
['application/json'],
|
|
295
295
|
['application/json']
|
|
296
296
|
);
|
|
297
297
|
}
|
|
@@ -310,13 +310,13 @@ class PresenceApi {
|
|
|
310
310
|
return this.apiClient.callApi(
|
|
311
311
|
'/api/v2/users/presences/bulk',
|
|
312
312
|
'PUT',
|
|
313
|
-
{ },
|
|
314
|
-
{ },
|
|
315
|
-
{ },
|
|
316
|
-
{ },
|
|
313
|
+
{ },
|
|
314
|
+
{ },
|
|
315
|
+
{ },
|
|
316
|
+
{ },
|
|
317
317
|
body,
|
|
318
318
|
['PureCloud OAuth'],
|
|
319
|
-
['application/json'],
|
|
319
|
+
['application/json'],
|
|
320
320
|
['application/json']
|
|
321
321
|
);
|
|
322
322
|
}
|