purecloud-platform-client-v2 213.1.0 → 215.0.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 +31 -3
- package/dist/node/purecloud-platform-client-v2.js +446 -118
- package/dist/web-amd/purecloud-platform-client-v2.js +446 -118
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +213 -149
- package/dist/web-cjs/purecloud-platform-client-v2.js +223 -156
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +369 -229
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/AbstractHttpClient.js +29 -0
- package/src/purecloud-platform-client-v2/ApiClient.js +21 -1
- package/src/purecloud-platform-client-v2/DefaultHttpClient.js +41 -0
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +45 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -6
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -31
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +107 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +125 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class RoutingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Routing service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 215.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -3911,36 +3911,6 @@ class RoutingApi {
|
|
|
3911
3911
|
);
|
|
3912
3912
|
}
|
|
3913
3913
|
|
|
3914
|
-
/**
|
|
3915
|
-
* Update a phone number provisioned for SMS.
|
|
3916
|
-
*
|
|
3917
|
-
* @param {String} phoneNumberId phone number
|
|
3918
|
-
* @param {Object} body SmsPhoneNumber
|
|
3919
|
-
*/
|
|
3920
|
-
putRoutingSmsPhonenumber(phoneNumberId, body) {
|
|
3921
|
-
// verify the required parameter 'phoneNumberId' is set
|
|
3922
|
-
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
3923
|
-
throw 'Missing the required parameter "phoneNumberId" when calling putRoutingSmsPhonenumber';
|
|
3924
|
-
}
|
|
3925
|
-
// verify the required parameter 'body' is set
|
|
3926
|
-
if (body === undefined || body === null) {
|
|
3927
|
-
throw 'Missing the required parameter "body" when calling putRoutingSmsPhonenumber';
|
|
3928
|
-
}
|
|
3929
|
-
|
|
3930
|
-
return this.apiClient.callApi(
|
|
3931
|
-
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
3932
|
-
'PUT',
|
|
3933
|
-
{ 'phoneNumberId': phoneNumberId },
|
|
3934
|
-
{ },
|
|
3935
|
-
{ },
|
|
3936
|
-
{ },
|
|
3937
|
-
body,
|
|
3938
|
-
['PureCloud OAuth'],
|
|
3939
|
-
['application/json'],
|
|
3940
|
-
['application/json']
|
|
3941
|
-
);
|
|
3942
|
-
}
|
|
3943
|
-
|
|
3944
3914
|
/**
|
|
3945
3915
|
* Update the user's Direct Routing Backup settings.
|
|
3946
3916
|
*
|
|
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* SpeechTextAnalytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 215.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -338,6 +338,31 @@ class SpeechTextAnalyticsApi {
|
|
|
338
338
|
);
|
|
339
339
|
}
|
|
340
340
|
|
|
341
|
+
/**
|
|
342
|
+
* Get conversation summaries by conversation id.
|
|
343
|
+
*
|
|
344
|
+
* @param {String} conversationId The conversation ID of the summaries
|
|
345
|
+
*/
|
|
346
|
+
getSpeechandtextanalyticsConversationSummaries(conversationId) {
|
|
347
|
+
// verify the required parameter 'conversationId' is set
|
|
348
|
+
if (conversationId === undefined || conversationId === null) {
|
|
349
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationSummaries';
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
return this.apiClient.callApi(
|
|
353
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/summaries',
|
|
354
|
+
'GET',
|
|
355
|
+
{ 'conversationId': conversationId },
|
|
356
|
+
{ },
|
|
357
|
+
{ },
|
|
358
|
+
{ },
|
|
359
|
+
null,
|
|
360
|
+
['PureCloud OAuth'],
|
|
361
|
+
['application/json'],
|
|
362
|
+
['application/json']
|
|
363
|
+
);
|
|
364
|
+
}
|
|
365
|
+
|
|
341
366
|
/**
|
|
342
367
|
* Get the list of Speech and Text Analytics dictionary feedbacks
|
|
343
368
|
*
|
|
@@ -439,6 +464,31 @@ class SpeechTextAnalyticsApi {
|
|
|
439
464
|
);
|
|
440
465
|
}
|
|
441
466
|
|
|
467
|
+
/**
|
|
468
|
+
* Get AI Insights settings of a program
|
|
469
|
+
*
|
|
470
|
+
* @param {String} programId The id of the program
|
|
471
|
+
*/
|
|
472
|
+
getSpeechandtextanalyticsProgramSettingsInsights(programId) {
|
|
473
|
+
// verify the required parameter 'programId' is set
|
|
474
|
+
if (programId === undefined || programId === null) {
|
|
475
|
+
throw 'Missing the required parameter "programId" when calling getSpeechandtextanalyticsProgramSettingsInsights';
|
|
476
|
+
}
|
|
477
|
+
|
|
478
|
+
return this.apiClient.callApi(
|
|
479
|
+
'/api/v2/speechandtextanalytics/programs/{programId}/settings/insights',
|
|
480
|
+
'GET',
|
|
481
|
+
{ 'programId': programId },
|
|
482
|
+
{ },
|
|
483
|
+
{ },
|
|
484
|
+
{ },
|
|
485
|
+
null,
|
|
486
|
+
['PureCloud OAuth'],
|
|
487
|
+
['application/json'],
|
|
488
|
+
['application/json']
|
|
489
|
+
);
|
|
490
|
+
}
|
|
491
|
+
|
|
442
492
|
/**
|
|
443
493
|
* Get transcription engine settings of a program
|
|
444
494
|
*
|
|
@@ -565,6 +615,32 @@ class SpeechTextAnalyticsApi {
|
|
|
565
615
|
);
|
|
566
616
|
}
|
|
567
617
|
|
|
618
|
+
/**
|
|
619
|
+
* Get the list of program AI Insights settings for the organization
|
|
620
|
+
*
|
|
621
|
+
* @param {Object} opts Optional parameters
|
|
622
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 100. (default to 100)
|
|
623
|
+
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
624
|
+
* @param {Array.<String>} opts.programIds Comma separated Program IDs to filter by. Maximum of 50 IDs allowed.
|
|
625
|
+
*/
|
|
626
|
+
getSpeechandtextanalyticsProgramsSettingsInsights(opts) {
|
|
627
|
+
opts = opts || {};
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
return this.apiClient.callApi(
|
|
631
|
+
'/api/v2/speechandtextanalytics/programs/settings/insights',
|
|
632
|
+
'GET',
|
|
633
|
+
{ },
|
|
634
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'programIds': this.apiClient.buildCollectionParam(opts['programIds'], 'multi') },
|
|
635
|
+
{ },
|
|
636
|
+
{ },
|
|
637
|
+
null,
|
|
638
|
+
['PureCloud OAuth'],
|
|
639
|
+
['application/json'],
|
|
640
|
+
['application/json']
|
|
641
|
+
);
|
|
642
|
+
}
|
|
643
|
+
|
|
568
644
|
/**
|
|
569
645
|
* Get supported dialects for each transcription engine
|
|
570
646
|
*
|
|
@@ -1249,6 +1325,36 @@ class SpeechTextAnalyticsApi {
|
|
|
1249
1325
|
);
|
|
1250
1326
|
}
|
|
1251
1327
|
|
|
1328
|
+
/**
|
|
1329
|
+
* Update AI Insights settings of a program
|
|
1330
|
+
*
|
|
1331
|
+
* @param {String} programId The id of the program
|
|
1332
|
+
* @param {Object} body Program AI Insights setting
|
|
1333
|
+
*/
|
|
1334
|
+
putSpeechandtextanalyticsProgramSettingsInsights(programId, body) {
|
|
1335
|
+
// verify the required parameter 'programId' is set
|
|
1336
|
+
if (programId === undefined || programId === null) {
|
|
1337
|
+
throw 'Missing the required parameter "programId" when calling putSpeechandtextanalyticsProgramSettingsInsights';
|
|
1338
|
+
}
|
|
1339
|
+
// verify the required parameter 'body' is set
|
|
1340
|
+
if (body === undefined || body === null) {
|
|
1341
|
+
throw 'Missing the required parameter "body" when calling putSpeechandtextanalyticsProgramSettingsInsights';
|
|
1342
|
+
}
|
|
1343
|
+
|
|
1344
|
+
return this.apiClient.callApi(
|
|
1345
|
+
'/api/v2/speechandtextanalytics/programs/{programId}/settings/insights',
|
|
1346
|
+
'PUT',
|
|
1347
|
+
{ 'programId': programId },
|
|
1348
|
+
{ },
|
|
1349
|
+
{ },
|
|
1350
|
+
{ },
|
|
1351
|
+
body,
|
|
1352
|
+
['PureCloud OAuth'],
|
|
1353
|
+
['application/json'],
|
|
1354
|
+
['application/json']
|
|
1355
|
+
);
|
|
1356
|
+
}
|
|
1357
|
+
|
|
1252
1358
|
/**
|
|
1253
1359
|
* Update transcription engine settings of a program
|
|
1254
1360
|
*
|
|
@@ -5,7 +5,7 @@ class UploadsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Uploads service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 215.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -56,7 +56,6 @@ class UploadsApi {
|
|
|
56
56
|
*
|
|
57
57
|
* @param {String} actionId actionId
|
|
58
58
|
* @param {Object} body Input used to request URL upload.
|
|
59
|
-
* postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60
59
|
*/
|
|
61
60
|
postIntegrationsActionDraftFunctionUpload(actionId, body) {
|
|
62
61
|
// verify the required parameter 'actionId' is set
|
|
@@ -5,7 +5,7 @@ class UsersApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Users service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 215.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -175,6 +175,41 @@ class UsersApi {
|
|
|
175
175
|
);
|
|
176
176
|
}
|
|
177
177
|
|
|
178
|
+
/**
|
|
179
|
+
* Delete the external identifier for user.
|
|
180
|
+
*
|
|
181
|
+
* @param {String} userId User ID
|
|
182
|
+
* @param {String} authorityName Authority Name
|
|
183
|
+
* @param {String} externalKey External Key
|
|
184
|
+
*/
|
|
185
|
+
deleteUserExternalidAuthorityNameExternalKey(userId, authorityName, externalKey) {
|
|
186
|
+
// verify the required parameter 'userId' is set
|
|
187
|
+
if (userId === undefined || userId === null) {
|
|
188
|
+
throw 'Missing the required parameter "userId" when calling deleteUserExternalidAuthorityNameExternalKey';
|
|
189
|
+
}
|
|
190
|
+
// verify the required parameter 'authorityName' is set
|
|
191
|
+
if (authorityName === undefined || authorityName === null) {
|
|
192
|
+
throw 'Missing the required parameter "authorityName" when calling deleteUserExternalidAuthorityNameExternalKey';
|
|
193
|
+
}
|
|
194
|
+
// verify the required parameter 'externalKey' is set
|
|
195
|
+
if (externalKey === undefined || externalKey === null) {
|
|
196
|
+
throw 'Missing the required parameter "externalKey" when calling deleteUserExternalidAuthorityNameExternalKey';
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
return this.apiClient.callApi(
|
|
200
|
+
'/api/v2/users/{userId}/externalid/{authorityName}/{externalKey}',
|
|
201
|
+
'DELETE',
|
|
202
|
+
{ 'userId': userId,'authorityName': authorityName,'externalKey': externalKey },
|
|
203
|
+
{ },
|
|
204
|
+
{ },
|
|
205
|
+
{ },
|
|
206
|
+
null,
|
|
207
|
+
['PureCloud OAuth'],
|
|
208
|
+
['application/json'],
|
|
209
|
+
['application/json']
|
|
210
|
+
);
|
|
211
|
+
}
|
|
212
|
+
|
|
178
213
|
/**
|
|
179
214
|
* Remove a routing language from a user
|
|
180
215
|
*
|
|
@@ -836,6 +871,61 @@ class UsersApi {
|
|
|
836
871
|
);
|
|
837
872
|
}
|
|
838
873
|
|
|
874
|
+
/**
|
|
875
|
+
* Get the external identifiers for a user.
|
|
876
|
+
*
|
|
877
|
+
* @param {String} userId User ID
|
|
878
|
+
*/
|
|
879
|
+
getUserExternalid(userId) {
|
|
880
|
+
// verify the required parameter 'userId' is set
|
|
881
|
+
if (userId === undefined || userId === null) {
|
|
882
|
+
throw 'Missing the required parameter "userId" when calling getUserExternalid';
|
|
883
|
+
}
|
|
884
|
+
|
|
885
|
+
return this.apiClient.callApi(
|
|
886
|
+
'/api/v2/users/{userId}/externalid',
|
|
887
|
+
'GET',
|
|
888
|
+
{ 'userId': userId },
|
|
889
|
+
{ },
|
|
890
|
+
{ },
|
|
891
|
+
{ },
|
|
892
|
+
null,
|
|
893
|
+
['PureCloud OAuth'],
|
|
894
|
+
['application/json'],
|
|
895
|
+
['application/json']
|
|
896
|
+
);
|
|
897
|
+
}
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* Get the external identifier of user for an authority.
|
|
901
|
+
* Authority name and external key are case sensitive.
|
|
902
|
+
* @param {String} userId User ID
|
|
903
|
+
* @param {String} authorityName Authority Name
|
|
904
|
+
*/
|
|
905
|
+
getUserExternalidAuthorityName(userId, authorityName) {
|
|
906
|
+
// verify the required parameter 'userId' is set
|
|
907
|
+
if (userId === undefined || userId === null) {
|
|
908
|
+
throw 'Missing the required parameter "userId" when calling getUserExternalidAuthorityName';
|
|
909
|
+
}
|
|
910
|
+
// verify the required parameter 'authorityName' is set
|
|
911
|
+
if (authorityName === undefined || authorityName === null) {
|
|
912
|
+
throw 'Missing the required parameter "authorityName" when calling getUserExternalidAuthorityName';
|
|
913
|
+
}
|
|
914
|
+
|
|
915
|
+
return this.apiClient.callApi(
|
|
916
|
+
'/api/v2/users/{userId}/externalid/{authorityName}',
|
|
917
|
+
'GET',
|
|
918
|
+
{ 'userId': userId,'authorityName': authorityName },
|
|
919
|
+
{ },
|
|
920
|
+
{ },
|
|
921
|
+
{ },
|
|
922
|
+
null,
|
|
923
|
+
['PureCloud OAuth'],
|
|
924
|
+
['application/json'],
|
|
925
|
+
['application/json']
|
|
926
|
+
);
|
|
927
|
+
}
|
|
928
|
+
|
|
839
929
|
/**
|
|
840
930
|
* Deprecated; will be revived with new contract
|
|
841
931
|
*
|
|
@@ -1445,6 +1535,40 @@ class UsersApi {
|
|
|
1445
1535
|
);
|
|
1446
1536
|
}
|
|
1447
1537
|
|
|
1538
|
+
/**
|
|
1539
|
+
* Get the user associated with external identifier.
|
|
1540
|
+
* Authority name and external key are case sensitive.
|
|
1541
|
+
* @param {String} authorityName Authority Name
|
|
1542
|
+
* @param {String} externalKey External Key
|
|
1543
|
+
* @param {Object} opts Optional parameters
|
|
1544
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1545
|
+
*/
|
|
1546
|
+
getUsersExternalidAuthorityNameExternalKey(authorityName, externalKey, opts) {
|
|
1547
|
+
opts = opts || {};
|
|
1548
|
+
|
|
1549
|
+
// verify the required parameter 'authorityName' is set
|
|
1550
|
+
if (authorityName === undefined || authorityName === null) {
|
|
1551
|
+
throw 'Missing the required parameter "authorityName" when calling getUsersExternalidAuthorityNameExternalKey';
|
|
1552
|
+
}
|
|
1553
|
+
// verify the required parameter 'externalKey' is set
|
|
1554
|
+
if (externalKey === undefined || externalKey === null) {
|
|
1555
|
+
throw 'Missing the required parameter "externalKey" when calling getUsersExternalidAuthorityNameExternalKey';
|
|
1556
|
+
}
|
|
1557
|
+
|
|
1558
|
+
return this.apiClient.callApi(
|
|
1559
|
+
'/api/v2/users/externalid/{authorityName}/{externalKey}',
|
|
1560
|
+
'GET',
|
|
1561
|
+
{ 'authorityName': authorityName,'externalKey': externalKey },
|
|
1562
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
1563
|
+
{ },
|
|
1564
|
+
{ },
|
|
1565
|
+
null,
|
|
1566
|
+
['PureCloud OAuth'],
|
|
1567
|
+
['application/json'],
|
|
1568
|
+
['application/json']
|
|
1569
|
+
);
|
|
1570
|
+
}
|
|
1571
|
+
|
|
1448
1572
|
/**
|
|
1449
1573
|
* Get current user details.
|
|
1450
1574
|
* This request is not valid when using the Client Credentials OAuth grant.
|