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 NotificationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Notifications service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 137.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -34,13 +34,13 @@ class NotificationsApi {
|
|
|
34
34
|
return this.apiClient.callApi(
|
|
35
35
|
'/api/v2/notifications/channels/{channelId}/subscriptions',
|
|
36
36
|
'DELETE',
|
|
37
|
-
{ 'channelId': channelId },
|
|
38
|
-
{ },
|
|
39
|
-
{ },
|
|
40
|
-
{ },
|
|
37
|
+
{ 'channelId': channelId },
|
|
38
|
+
{ },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
41
|
null,
|
|
42
42
|
['PureCloud OAuth'],
|
|
43
|
-
['application/json'],
|
|
43
|
+
['application/json'],
|
|
44
44
|
['application/json']
|
|
45
45
|
);
|
|
46
46
|
}
|
|
@@ -59,13 +59,13 @@ class NotificationsApi {
|
|
|
59
59
|
return this.apiClient.callApi(
|
|
60
60
|
'/api/v2/notifications/availabletopics',
|
|
61
61
|
'GET',
|
|
62
|
-
{ },
|
|
63
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includePreview': opts['includePreview'] },
|
|
64
|
-
{ },
|
|
65
|
-
{ },
|
|
62
|
+
{ },
|
|
63
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includePreview': opts['includePreview'] },
|
|
64
|
+
{ },
|
|
65
|
+
{ },
|
|
66
66
|
null,
|
|
67
67
|
['PureCloud OAuth'],
|
|
68
|
-
['application/json'],
|
|
68
|
+
['application/json'],
|
|
69
69
|
['application/json']
|
|
70
70
|
);
|
|
71
71
|
}
|
|
@@ -84,13 +84,13 @@ class NotificationsApi {
|
|
|
84
84
|
return this.apiClient.callApi(
|
|
85
85
|
'/api/v2/notifications/channels/{channelId}/subscriptions',
|
|
86
86
|
'GET',
|
|
87
|
-
{ 'channelId': channelId },
|
|
88
|
-
{ },
|
|
89
|
-
{ },
|
|
90
|
-
{ },
|
|
87
|
+
{ 'channelId': channelId },
|
|
88
|
+
{ },
|
|
89
|
+
{ },
|
|
90
|
+
{ },
|
|
91
91
|
null,
|
|
92
92
|
['PureCloud OAuth'],
|
|
93
|
-
['application/json'],
|
|
93
|
+
['application/json'],
|
|
94
94
|
['application/json']
|
|
95
95
|
);
|
|
96
96
|
}
|
|
@@ -99,7 +99,7 @@ class NotificationsApi {
|
|
|
99
99
|
* The list of existing channels
|
|
100
100
|
*
|
|
101
101
|
* @param {Object} opts Optional parameters
|
|
102
|
-
* @param {Object} opts.includechannels Show user
|
|
102
|
+
* @param {Object} opts.includechannels Show user's channels for this specific token or across all tokens for this user and app. Channel Ids for other access tokens will not be shown, but will be presented to show their existence. (default to token)
|
|
103
103
|
*/
|
|
104
104
|
getNotificationsChannels(opts) {
|
|
105
105
|
opts = opts || {};
|
|
@@ -108,20 +108,20 @@ class NotificationsApi {
|
|
|
108
108
|
return this.apiClient.callApi(
|
|
109
109
|
'/api/v2/notifications/channels',
|
|
110
110
|
'GET',
|
|
111
|
-
{ },
|
|
112
|
-
{ 'includechannels': opts['includechannels'] },
|
|
113
|
-
{ },
|
|
114
|
-
{ },
|
|
111
|
+
{ },
|
|
112
|
+
{ 'includechannels': opts['includechannels'] },
|
|
113
|
+
{ },
|
|
114
|
+
{ },
|
|
115
115
|
null,
|
|
116
116
|
['PureCloud OAuth'],
|
|
117
|
-
['application/json'],
|
|
117
|
+
['application/json'],
|
|
118
118
|
['application/json']
|
|
119
119
|
);
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
123
|
* Verify a channel still exists and is valid
|
|
124
|
-
* Returns a 200 OK if channel exists, and a 404 Not Found if it
|
|
124
|
+
* Returns a 200 OK if channel exists, and a 404 Not Found if it doesnt
|
|
125
125
|
* @param {String} channelId Channel ID
|
|
126
126
|
*/
|
|
127
127
|
headNotificationsChannel(channelId) {
|
|
@@ -133,13 +133,13 @@ class NotificationsApi {
|
|
|
133
133
|
return this.apiClient.callApi(
|
|
134
134
|
'/api/v2/notifications/channels/{channelId}',
|
|
135
135
|
'HEAD',
|
|
136
|
-
{ 'channelId': channelId },
|
|
137
|
-
{ },
|
|
138
|
-
{ },
|
|
139
|
-
{ },
|
|
136
|
+
{ 'channelId': channelId },
|
|
137
|
+
{ },
|
|
138
|
+
{ },
|
|
139
|
+
{ },
|
|
140
140
|
null,
|
|
141
141
|
['PureCloud OAuth'],
|
|
142
|
-
['application/json'],
|
|
142
|
+
['application/json'],
|
|
143
143
|
['application/json']
|
|
144
144
|
);
|
|
145
145
|
}
|
|
@@ -163,13 +163,13 @@ class NotificationsApi {
|
|
|
163
163
|
return this.apiClient.callApi(
|
|
164
164
|
'/api/v2/notifications/channels/{channelId}/subscriptions',
|
|
165
165
|
'POST',
|
|
166
|
-
{ 'channelId': channelId },
|
|
167
|
-
{ },
|
|
168
|
-
{ },
|
|
169
|
-
{ },
|
|
166
|
+
{ 'channelId': channelId },
|
|
167
|
+
{ },
|
|
168
|
+
{ },
|
|
169
|
+
{ },
|
|
170
170
|
body,
|
|
171
171
|
['PureCloud OAuth'],
|
|
172
|
-
['application/json'],
|
|
172
|
+
['application/json'],
|
|
173
173
|
['application/json']
|
|
174
174
|
);
|
|
175
175
|
}
|
|
@@ -183,13 +183,13 @@ class NotificationsApi {
|
|
|
183
183
|
return this.apiClient.callApi(
|
|
184
184
|
'/api/v2/notifications/channels',
|
|
185
185
|
'POST',
|
|
186
|
-
{ },
|
|
187
|
-
{ },
|
|
188
|
-
{ },
|
|
189
|
-
{ },
|
|
186
|
+
{ },
|
|
187
|
+
{ },
|
|
188
|
+
{ },
|
|
189
|
+
{ },
|
|
190
190
|
null,
|
|
191
191
|
['PureCloud OAuth'],
|
|
192
|
-
['application/json'],
|
|
192
|
+
['application/json'],
|
|
193
193
|
['application/json']
|
|
194
194
|
);
|
|
195
195
|
}
|
|
@@ -213,13 +213,13 @@ class NotificationsApi {
|
|
|
213
213
|
return this.apiClient.callApi(
|
|
214
214
|
'/api/v2/notifications/channels/{channelId}/subscriptions',
|
|
215
215
|
'PUT',
|
|
216
|
-
{ 'channelId': channelId },
|
|
217
|
-
{ },
|
|
218
|
-
{ },
|
|
219
|
-
{ },
|
|
216
|
+
{ 'channelId': channelId },
|
|
217
|
+
{ },
|
|
218
|
+
{ },
|
|
219
|
+
{ },
|
|
220
220
|
body,
|
|
221
221
|
['PureCloud OAuth'],
|
|
222
|
-
['application/json'],
|
|
222
|
+
['application/json'],
|
|
223
223
|
['application/json']
|
|
224
224
|
);
|
|
225
225
|
}
|
|
@@ -5,7 +5,7 @@ class OAuthApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* OAuth service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 137.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -34,13 +34,13 @@ class OAuthApi {
|
|
|
34
34
|
return this.apiClient.callApi(
|
|
35
35
|
'/api/v2/oauth/clients/{clientId}',
|
|
36
36
|
'DELETE',
|
|
37
|
-
{ 'clientId': clientId },
|
|
38
|
-
{ },
|
|
39
|
-
{ },
|
|
40
|
-
{ },
|
|
37
|
+
{ 'clientId': clientId },
|
|
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,13 +63,13 @@ class OAuthApi {
|
|
|
63
63
|
return this.apiClient.callApi(
|
|
64
64
|
'/api/v2/oauth/authorizations/{clientId}',
|
|
65
65
|
'GET',
|
|
66
|
-
{ 'clientId': clientId },
|
|
67
|
-
{ },
|
|
68
|
-
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
69
|
-
{ },
|
|
66
|
+
{ 'clientId': clientId },
|
|
67
|
+
{ },
|
|
68
|
+
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
69
|
+
{ },
|
|
70
70
|
null,
|
|
71
71
|
['PureCloud OAuth'],
|
|
72
|
-
['application/json'],
|
|
72
|
+
['application/json'],
|
|
73
73
|
['application/json']
|
|
74
74
|
);
|
|
75
75
|
}
|
|
@@ -87,13 +87,13 @@ class OAuthApi {
|
|
|
87
87
|
return this.apiClient.callApi(
|
|
88
88
|
'/api/v2/oauth/authorizations',
|
|
89
89
|
'GET',
|
|
90
|
-
{ },
|
|
91
|
-
{ },
|
|
92
|
-
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
93
|
-
{ },
|
|
90
|
+
{ },
|
|
91
|
+
{ },
|
|
92
|
+
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
93
|
+
{ },
|
|
94
94
|
null,
|
|
95
95
|
['PureCloud OAuth'],
|
|
96
|
-
['application/json'],
|
|
96
|
+
['application/json'],
|
|
97
97
|
['application/json']
|
|
98
98
|
);
|
|
99
99
|
}
|
|
@@ -112,13 +112,13 @@ class OAuthApi {
|
|
|
112
112
|
return this.apiClient.callApi(
|
|
113
113
|
'/api/v2/oauth/clients/{clientId}',
|
|
114
114
|
'GET',
|
|
115
|
-
{ 'clientId': clientId },
|
|
116
|
-
{ },
|
|
117
|
-
{ },
|
|
118
|
-
{ },
|
|
115
|
+
{ 'clientId': clientId },
|
|
116
|
+
{ },
|
|
117
|
+
{ },
|
|
118
|
+
{ },
|
|
119
119
|
null,
|
|
120
120
|
['PureCloud OAuth'],
|
|
121
|
-
['application/json'],
|
|
121
|
+
['application/json'],
|
|
122
122
|
['application/json']
|
|
123
123
|
);
|
|
124
124
|
}
|
|
@@ -142,13 +142,13 @@ class OAuthApi {
|
|
|
142
142
|
return this.apiClient.callApi(
|
|
143
143
|
'/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}',
|
|
144
144
|
'GET',
|
|
145
|
-
{ 'executionId': executionId,'clientId': clientId },
|
|
146
|
-
{ },
|
|
147
|
-
{ },
|
|
148
|
-
{ },
|
|
145
|
+
{ 'executionId': executionId,'clientId': clientId },
|
|
146
|
+
{ },
|
|
147
|
+
{ },
|
|
148
|
+
{ },
|
|
149
149
|
null,
|
|
150
150
|
['PureCloud OAuth'],
|
|
151
|
-
['application/json'],
|
|
151
|
+
['application/json'],
|
|
152
152
|
['application/json']
|
|
153
153
|
);
|
|
154
154
|
}
|
|
@@ -171,13 +171,13 @@ class OAuthApi {
|
|
|
171
171
|
return this.apiClient.callApi(
|
|
172
172
|
'/api/v2/oauth/clients/{clientId}/usage/summary',
|
|
173
173
|
'GET',
|
|
174
|
-
{ 'clientId': clientId },
|
|
175
|
-
{ 'days': opts['days'] },
|
|
176
|
-
{ },
|
|
177
|
-
{ },
|
|
174
|
+
{ 'clientId': clientId },
|
|
175
|
+
{ 'days': opts['days'] },
|
|
176
|
+
{ },
|
|
177
|
+
{ },
|
|
178
178
|
null,
|
|
179
179
|
['PureCloud OAuth'],
|
|
180
|
-
['application/json'],
|
|
180
|
+
['application/json'],
|
|
181
181
|
['application/json']
|
|
182
182
|
);
|
|
183
183
|
}
|
|
@@ -191,13 +191,13 @@ class OAuthApi {
|
|
|
191
191
|
return this.apiClient.callApi(
|
|
192
192
|
'/api/v2/oauth/clients',
|
|
193
193
|
'GET',
|
|
194
|
-
{ },
|
|
195
|
-
{ },
|
|
196
|
-
{ },
|
|
197
|
-
{ },
|
|
194
|
+
{ },
|
|
195
|
+
{ },
|
|
196
|
+
{ },
|
|
197
|
+
{ },
|
|
198
198
|
null,
|
|
199
199
|
['PureCloud OAuth'],
|
|
200
|
-
['application/json'],
|
|
200
|
+
['application/json'],
|
|
201
201
|
['application/json']
|
|
202
202
|
);
|
|
203
203
|
}
|
|
@@ -220,13 +220,13 @@ class OAuthApi {
|
|
|
220
220
|
return this.apiClient.callApi(
|
|
221
221
|
'/api/v2/oauth/scopes/{scopeId}',
|
|
222
222
|
'GET',
|
|
223
|
-
{ 'scopeId': scopeId },
|
|
224
|
-
{ },
|
|
225
|
-
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
226
|
-
{ },
|
|
223
|
+
{ 'scopeId': scopeId },
|
|
224
|
+
{ },
|
|
225
|
+
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
226
|
+
{ },
|
|
227
227
|
null,
|
|
228
228
|
['PureCloud OAuth'],
|
|
229
|
-
['application/json'],
|
|
229
|
+
['application/json'],
|
|
230
230
|
['application/json']
|
|
231
231
|
);
|
|
232
232
|
}
|
|
@@ -244,13 +244,13 @@ class OAuthApi {
|
|
|
244
244
|
return this.apiClient.callApi(
|
|
245
245
|
'/api/v2/oauth/scopes',
|
|
246
246
|
'GET',
|
|
247
|
-
{ },
|
|
248
|
-
{ },
|
|
249
|
-
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
250
|
-
{ },
|
|
247
|
+
{ },
|
|
248
|
+
{ },
|
|
249
|
+
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
250
|
+
{ },
|
|
251
251
|
null,
|
|
252
252
|
['PureCloud OAuth'],
|
|
253
|
-
['application/json'],
|
|
253
|
+
['application/json'],
|
|
254
254
|
['application/json']
|
|
255
255
|
);
|
|
256
256
|
}
|
|
@@ -269,13 +269,13 @@ class OAuthApi {
|
|
|
269
269
|
return this.apiClient.callApi(
|
|
270
270
|
'/api/v2/oauth/clients/{clientId}/secret',
|
|
271
271
|
'POST',
|
|
272
|
-
{ 'clientId': clientId },
|
|
273
|
-
{ },
|
|
274
|
-
{ },
|
|
275
|
-
{ },
|
|
272
|
+
{ 'clientId': clientId },
|
|
273
|
+
{ },
|
|
274
|
+
{ },
|
|
275
|
+
{ },
|
|
276
276
|
null,
|
|
277
277
|
['PureCloud OAuth'],
|
|
278
|
-
['application/json'],
|
|
278
|
+
['application/json'],
|
|
279
279
|
['application/json']
|
|
280
280
|
);
|
|
281
281
|
}
|
|
@@ -299,20 +299,20 @@ class OAuthApi {
|
|
|
299
299
|
return this.apiClient.callApi(
|
|
300
300
|
'/api/v2/oauth/clients/{clientId}/usage/query',
|
|
301
301
|
'POST',
|
|
302
|
-
{ 'clientId': clientId },
|
|
303
|
-
{ },
|
|
304
|
-
{ },
|
|
305
|
-
{ },
|
|
302
|
+
{ 'clientId': clientId },
|
|
303
|
+
{ },
|
|
304
|
+
{ },
|
|
305
|
+
{ },
|
|
306
306
|
body,
|
|
307
307
|
['PureCloud OAuth'],
|
|
308
|
-
['application/json'],
|
|
308
|
+
['application/json'],
|
|
309
309
|
['application/json']
|
|
310
310
|
);
|
|
311
311
|
}
|
|
312
312
|
|
|
313
313
|
/**
|
|
314
314
|
* Create OAuth client
|
|
315
|
-
* The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is
|
|
315
|
+
* The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is CODE which requires applications to send a client ID and client secret. This is typically a web server. If the client is unable to secure the client secret then the TOKEN grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. If a client is to be used outside of the context of a user then the CLIENT-CREDENTIALS grant may be used. In this case the client must be granted roles via the roleIds field.
|
|
316
316
|
* @param {Object} body Client
|
|
317
317
|
*/
|
|
318
318
|
postOauthClients(body) {
|
|
@@ -324,13 +324,13 @@ class OAuthApi {
|
|
|
324
324
|
return this.apiClient.callApi(
|
|
325
325
|
'/api/v2/oauth/clients',
|
|
326
326
|
'POST',
|
|
327
|
-
{ },
|
|
328
|
-
{ },
|
|
329
|
-
{ },
|
|
330
|
-
{ },
|
|
327
|
+
{ },
|
|
328
|
+
{ },
|
|
329
|
+
{ },
|
|
330
|
+
{ },
|
|
331
331
|
body,
|
|
332
332
|
['PureCloud OAuth'],
|
|
333
|
-
['application/json'],
|
|
333
|
+
['application/json'],
|
|
334
334
|
['application/json']
|
|
335
335
|
);
|
|
336
336
|
}
|
|
@@ -354,13 +354,13 @@ class OAuthApi {
|
|
|
354
354
|
return this.apiClient.callApi(
|
|
355
355
|
'/api/v2/oauth/clients/{clientId}',
|
|
356
356
|
'PUT',
|
|
357
|
-
{ 'clientId': clientId },
|
|
358
|
-
{ },
|
|
359
|
-
{ },
|
|
360
|
-
{ },
|
|
357
|
+
{ 'clientId': clientId },
|
|
358
|
+
{ },
|
|
359
|
+
{ },
|
|
360
|
+
{ },
|
|
361
361
|
body,
|
|
362
362
|
['PureCloud OAuth'],
|
|
363
|
-
['application/json'],
|
|
363
|
+
['application/json'],
|
|
364
364
|
['application/json']
|
|
365
365
|
);
|
|
366
366
|
}
|
|
@@ -5,7 +5,7 @@ class ObjectsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Objects service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 137.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -38,13 +38,13 @@ class ObjectsApi {
|
|
|
38
38
|
return this.apiClient.callApi(
|
|
39
39
|
'/api/v2/authorization/divisions/{divisionId}',
|
|
40
40
|
'DELETE',
|
|
41
|
-
{ 'divisionId': divisionId },
|
|
42
|
-
{ 'force': opts['force'] },
|
|
43
|
-
{ },
|
|
44
|
-
{ },
|
|
41
|
+
{ 'divisionId': divisionId },
|
|
42
|
+
{ 'force': opts['force'] },
|
|
43
|
+
{ },
|
|
44
|
+
{ },
|
|
45
45
|
null,
|
|
46
46
|
['PureCloud OAuth'],
|
|
47
|
-
['application/json'],
|
|
47
|
+
['application/json'],
|
|
48
48
|
['application/json']
|
|
49
49
|
);
|
|
50
50
|
}
|
|
@@ -54,7 +54,7 @@ class ObjectsApi {
|
|
|
54
54
|
*
|
|
55
55
|
* @param {String} divisionId Division ID
|
|
56
56
|
* @param {Object} opts Optional parameters
|
|
57
|
-
* @param {
|
|
57
|
+
* @param {Object} opts.objectCount Get count of objects in this division, grouped by type (default to false)
|
|
58
58
|
*/
|
|
59
59
|
getAuthorizationDivision(divisionId, opts) {
|
|
60
60
|
opts = opts || {};
|
|
@@ -67,20 +67,20 @@ class ObjectsApi {
|
|
|
67
67
|
return this.apiClient.callApi(
|
|
68
68
|
'/api/v2/authorization/divisions/{divisionId}',
|
|
69
69
|
'GET',
|
|
70
|
-
{ 'divisionId': divisionId },
|
|
71
|
-
{ 'objectCount': opts['objectCount'] },
|
|
72
|
-
{ },
|
|
73
|
-
{ },
|
|
70
|
+
{ 'divisionId': divisionId },
|
|
71
|
+
{ 'objectCount': opts['objectCount'] },
|
|
72
|
+
{ },
|
|
73
|
+
{ },
|
|
74
74
|
null,
|
|
75
75
|
['PureCloud OAuth'],
|
|
76
|
-
['application/json'],
|
|
76
|
+
['application/json'],
|
|
77
77
|
['application/json']
|
|
78
78
|
);
|
|
79
79
|
}
|
|
80
80
|
|
|
81
81
|
/**
|
|
82
82
|
* Retrieve a list of all divisions defined for the organization
|
|
83
|
-
* Request specific divisions by id using a query param
|
|
83
|
+
* Request specific divisions by id using a query param "id", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3
|
|
84
84
|
* @param {Object} opts Optional parameters
|
|
85
85
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
86
86
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -99,13 +99,13 @@ class ObjectsApi {
|
|
|
99
99
|
return this.apiClient.callApi(
|
|
100
100
|
'/api/v2/authorization/divisions',
|
|
101
101
|
'GET',
|
|
102
|
-
{ },
|
|
103
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
104
|
-
{ },
|
|
105
|
-
{ },
|
|
102
|
+
{ },
|
|
103
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
104
|
+
{ },
|
|
105
|
+
{ },
|
|
106
106
|
null,
|
|
107
107
|
['PureCloud OAuth'],
|
|
108
|
-
['application/json'],
|
|
108
|
+
['application/json'],
|
|
109
109
|
['application/json']
|
|
110
110
|
);
|
|
111
111
|
}
|
|
@@ -119,13 +119,13 @@ class ObjectsApi {
|
|
|
119
119
|
return this.apiClient.callApi(
|
|
120
120
|
'/api/v2/authorization/divisions/home',
|
|
121
121
|
'GET',
|
|
122
|
-
{ },
|
|
123
|
-
{ },
|
|
124
|
-
{ },
|
|
125
|
-
{ },
|
|
122
|
+
{ },
|
|
123
|
+
{ },
|
|
124
|
+
{ },
|
|
125
|
+
{ },
|
|
126
126
|
null,
|
|
127
127
|
['PureCloud OAuth'],
|
|
128
|
-
['application/json'],
|
|
128
|
+
['application/json'],
|
|
129
129
|
['application/json']
|
|
130
130
|
);
|
|
131
131
|
}
|
|
@@ -139,23 +139,23 @@ class ObjectsApi {
|
|
|
139
139
|
return this.apiClient.callApi(
|
|
140
140
|
'/api/v2/authorization/divisions/limit',
|
|
141
141
|
'GET',
|
|
142
|
-
{ },
|
|
143
|
-
{ },
|
|
144
|
-
{ },
|
|
145
|
-
{ },
|
|
142
|
+
{ },
|
|
143
|
+
{ },
|
|
144
|
+
{ },
|
|
145
|
+
{ },
|
|
146
146
|
null,
|
|
147
147
|
['PureCloud OAuth'],
|
|
148
|
-
['application/json'],
|
|
148
|
+
['application/json'],
|
|
149
149
|
['application/json']
|
|
150
150
|
);
|
|
151
151
|
}
|
|
152
152
|
|
|
153
153
|
/**
|
|
154
154
|
* Assign a list of objects to a division
|
|
155
|
-
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [
|
|
155
|
+
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
156
156
|
* @param {String} divisionId Division ID
|
|
157
157
|
* @param {Object} objectType The type of the objects. Must be one of the valid object types
|
|
158
|
-
* @param {Array.<
|
|
158
|
+
* @param {Array.<String>} body Object Id List
|
|
159
159
|
*/
|
|
160
160
|
postAuthorizationDivisionObject(divisionId, objectType, body) {
|
|
161
161
|
// verify the required parameter 'divisionId' is set
|
|
@@ -174,13 +174,13 @@ class ObjectsApi {
|
|
|
174
174
|
return this.apiClient.callApi(
|
|
175
175
|
'/api/v2/authorization/divisions/{divisionId}/objects/{objectType}',
|
|
176
176
|
'POST',
|
|
177
|
-
{ 'divisionId': divisionId,'objectType': objectType },
|
|
178
|
-
{ },
|
|
179
|
-
{ },
|
|
180
|
-
{ },
|
|
177
|
+
{ 'divisionId': divisionId,'objectType': objectType },
|
|
178
|
+
{ },
|
|
179
|
+
{ },
|
|
180
|
+
{ },
|
|
181
181
|
body,
|
|
182
182
|
['PureCloud OAuth'],
|
|
183
|
-
['application/json'],
|
|
183
|
+
['application/json'],
|
|
184
184
|
['application/json']
|
|
185
185
|
);
|
|
186
186
|
}
|
|
@@ -204,13 +204,13 @@ class ObjectsApi {
|
|
|
204
204
|
return this.apiClient.callApi(
|
|
205
205
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
206
206
|
'POST',
|
|
207
|
-
{ 'divisionId': divisionId },
|
|
208
|
-
{ },
|
|
209
|
-
{ },
|
|
210
|
-
{ },
|
|
207
|
+
{ 'divisionId': divisionId },
|
|
208
|
+
{ },
|
|
209
|
+
{ },
|
|
210
|
+
{ },
|
|
211
211
|
body,
|
|
212
212
|
['PureCloud OAuth'],
|
|
213
|
-
['application/json'],
|
|
213
|
+
['application/json'],
|
|
214
214
|
['application/json']
|
|
215
215
|
);
|
|
216
216
|
}
|
|
@@ -229,13 +229,13 @@ class ObjectsApi {
|
|
|
229
229
|
return this.apiClient.callApi(
|
|
230
230
|
'/api/v2/authorization/divisions',
|
|
231
231
|
'POST',
|
|
232
|
-
{ },
|
|
233
|
-
{ },
|
|
234
|
-
{ },
|
|
235
|
-
{ },
|
|
232
|
+
{ },
|
|
233
|
+
{ },
|
|
234
|
+
{ },
|
|
235
|
+
{ },
|
|
236
236
|
body,
|
|
237
237
|
['PureCloud OAuth'],
|
|
238
|
-
['application/json'],
|
|
238
|
+
['application/json'],
|
|
239
239
|
['application/json']
|
|
240
240
|
);
|
|
241
241
|
}
|
|
@@ -259,13 +259,13 @@ class ObjectsApi {
|
|
|
259
259
|
return this.apiClient.callApi(
|
|
260
260
|
'/api/v2/authorization/divisions/{divisionId}',
|
|
261
261
|
'PUT',
|
|
262
|
-
{ 'divisionId': divisionId },
|
|
263
|
-
{ },
|
|
264
|
-
{ },
|
|
265
|
-
{ },
|
|
262
|
+
{ 'divisionId': divisionId },
|
|
263
|
+
{ },
|
|
264
|
+
{ },
|
|
265
|
+
{ },
|
|
266
266
|
body,
|
|
267
267
|
['PureCloud OAuth'],
|
|
268
|
-
['application/json'],
|
|
268
|
+
['application/json'],
|
|
269
269
|
['application/json']
|
|
270
270
|
);
|
|
271
271
|
}
|