purecloud-platform-client-v2 126.1.0 → 130.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +305 -79
- package/dist/web-amd/purecloud-platform-client-v2.js +305 -79
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +305 -79
- package/dist/web-cjs/purecloud-platform-client-v2.js +305 -79
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +411 -215
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -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/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +5 -3
- 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/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 +121 -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/IntegrationsApi.js +30 -1
- 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/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/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/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +14 -10
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -4
- package/src/purecloud-platform-client-v2/api/SCIMApi.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/SpeechTextAnalyticsApi.js +21 -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/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +21 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +28 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +2 -2
- 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
|
@@ -391,7 +391,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
391
391
|
|
|
392
392
|
/**
|
|
393
393
|
* @module purecloud-platform-client-v2/ApiClient
|
|
394
|
-
* @version
|
|
394
|
+
* @version 130.0.0
|
|
395
395
|
*/
|
|
396
396
|
class ApiClient {
|
|
397
397
|
/**
|
|
@@ -1338,7 +1338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1338
1338
|
|
|
1339
1339
|
// set header parameters
|
|
1340
1340
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1341
|
-
//request.set({ 'purecloud-sdk': '
|
|
1341
|
+
//request.set({ 'purecloud-sdk': '130.0.0' });
|
|
1342
1342
|
|
|
1343
1343
|
// set request timeout
|
|
1344
1344
|
request.timeout(that.timeout);
|
|
@@ -1438,7 +1438,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1438
1438
|
/**
|
|
1439
1439
|
* Alerting service.
|
|
1440
1440
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1441
|
-
* @version
|
|
1441
|
+
* @version 130.0.0
|
|
1442
1442
|
*/
|
|
1443
1443
|
|
|
1444
1444
|
/**
|
|
@@ -1752,7 +1752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1752
1752
|
/**
|
|
1753
1753
|
* Analytics service.
|
|
1754
1754
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1755
|
-
* @version
|
|
1755
|
+
* @version 130.0.0
|
|
1756
1756
|
*/
|
|
1757
1757
|
|
|
1758
1758
|
/**
|
|
@@ -2889,7 +2889,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2889
2889
|
/**
|
|
2890
2890
|
* Architect service.
|
|
2891
2891
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2892
|
-
* @version
|
|
2892
|
+
* @version 130.0.0
|
|
2893
2893
|
*/
|
|
2894
2894
|
|
|
2895
2895
|
/**
|
|
@@ -5885,7 +5885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5885
5885
|
/**
|
|
5886
5886
|
* Audit service.
|
|
5887
5887
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5888
|
-
* @version
|
|
5888
|
+
* @version 130.0.0
|
|
5889
5889
|
*/
|
|
5890
5890
|
|
|
5891
5891
|
/**
|
|
@@ -6056,7 +6056,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6056
6056
|
/**
|
|
6057
6057
|
* Authorization service.
|
|
6058
6058
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6059
|
-
* @version
|
|
6059
|
+
* @version 130.0.0
|
|
6060
6060
|
*/
|
|
6061
6061
|
|
|
6062
6062
|
/**
|
|
@@ -7239,7 +7239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7239
7239
|
/**
|
|
7240
7240
|
* Billing service.
|
|
7241
7241
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7242
|
-
* @version
|
|
7242
|
+
* @version 130.0.0
|
|
7243
7243
|
*/
|
|
7244
7244
|
|
|
7245
7245
|
/**
|
|
@@ -7319,7 +7319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7319
7319
|
/**
|
|
7320
7320
|
* Chat service.
|
|
7321
7321
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7322
|
-
* @version
|
|
7322
|
+
* @version 130.0.0
|
|
7323
7323
|
*/
|
|
7324
7324
|
|
|
7325
7325
|
/**
|
|
@@ -7410,7 +7410,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7410
7410
|
/**
|
|
7411
7411
|
* Coaching service.
|
|
7412
7412
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7413
|
-
* @version
|
|
7413
|
+
* @version 130.0.0
|
|
7414
7414
|
*/
|
|
7415
7415
|
|
|
7416
7416
|
/**
|
|
@@ -7609,6 +7609,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7609
7609
|
* @param {Array.<String>} opts.relationships Relationships to filter by
|
|
7610
7610
|
* @param {String} opts.completionInterval Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
7611
7611
|
* @param {Object} opts.overdue Overdue status to filter by
|
|
7612
|
+
* @param {Object} opts.intervalCondition Filter condition for interval
|
|
7612
7613
|
*/
|
|
7613
7614
|
getCoachingAppointments(userIds, opts) {
|
|
7614
7615
|
opts = opts || {};
|
|
@@ -7622,7 +7623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7622
7623
|
'/api/v2/coaching/appointments',
|
|
7623
7624
|
'GET',
|
|
7624
7625
|
{ },
|
|
7625
|
-
{ 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'] },
|
|
7626
|
+
{ 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'intervalCondition': opts['intervalCondition'] },
|
|
7626
7627
|
{ },
|
|
7627
7628
|
{ },
|
|
7628
7629
|
null,
|
|
@@ -7645,6 +7646,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7645
7646
|
* @param {Array.<String>} opts.relationships Relationships to filter by
|
|
7646
7647
|
* @param {String} opts.completionInterval Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
7647
7648
|
* @param {Object} opts.overdue Overdue status to filter by
|
|
7649
|
+
* @param {Object} opts.intervalCondition Filter condition for interval
|
|
7648
7650
|
*/
|
|
7649
7651
|
getCoachingAppointmentsMe(opts) {
|
|
7650
7652
|
opts = opts || {};
|
|
@@ -7654,7 +7656,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7654
7656
|
'/api/v2/coaching/appointments/me',
|
|
7655
7657
|
'GET',
|
|
7656
7658
|
{ },
|
|
7657
|
-
{ 'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'] },
|
|
7659
|
+
{ 'interval': opts['interval'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'facilitatorIds': this.apiClient.buildCollectionParam(opts['facilitatorIds'], 'multi'),'sortOrder': opts['sortOrder'],'relationships': this.apiClient.buildCollectionParam(opts['relationships'], 'multi'),'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'intervalCondition': opts['intervalCondition'] },
|
|
7658
7660
|
{ },
|
|
7659
7661
|
{ },
|
|
7660
7662
|
null,
|
|
@@ -7985,7 +7987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7985
7987
|
/**
|
|
7986
7988
|
* ContentManagement service.
|
|
7987
7989
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
7988
|
-
* @version
|
|
7990
|
+
* @version 130.0.0
|
|
7989
7991
|
*/
|
|
7990
7992
|
|
|
7991
7993
|
/**
|
|
@@ -9125,7 +9127,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9125
9127
|
/**
|
|
9126
9128
|
* Conversations service.
|
|
9127
9129
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9128
|
-
* @version
|
|
9130
|
+
* @version 130.0.0
|
|
9129
9131
|
*/
|
|
9130
9132
|
|
|
9131
9133
|
/**
|
|
@@ -13514,7 +13516,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13514
13516
|
/**
|
|
13515
13517
|
* DataExtensions service.
|
|
13516
13518
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13517
|
-
* @version
|
|
13519
|
+
* @version 130.0.0
|
|
13518
13520
|
*/
|
|
13519
13521
|
|
|
13520
13522
|
/**
|
|
@@ -13600,7 +13602,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13600
13602
|
/**
|
|
13601
13603
|
* ExternalContacts service.
|
|
13602
13604
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13603
|
-
* @version
|
|
13605
|
+
* @version 130.0.0
|
|
13604
13606
|
*/
|
|
13605
13607
|
|
|
13606
13608
|
/**
|
|
@@ -15343,7 +15345,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15343
15345
|
/**
|
|
15344
15346
|
* Fax service.
|
|
15345
15347
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15346
|
-
* @version
|
|
15348
|
+
* @version 130.0.0
|
|
15347
15349
|
*/
|
|
15348
15350
|
|
|
15349
15351
|
/**
|
|
@@ -15514,7 +15516,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15514
15516
|
/**
|
|
15515
15517
|
* Flows service.
|
|
15516
15518
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15517
|
-
* @version
|
|
15519
|
+
* @version 130.0.0
|
|
15518
15520
|
*/
|
|
15519
15521
|
|
|
15520
15522
|
/**
|
|
@@ -15585,7 +15587,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15585
15587
|
/**
|
|
15586
15588
|
* Gamification service.
|
|
15587
15589
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15588
|
-
* @version
|
|
15590
|
+
* @version 130.0.0
|
|
15589
15591
|
*/
|
|
15590
15592
|
|
|
15591
15593
|
/**
|
|
@@ -15853,6 +15855,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15853
15855
|
);
|
|
15854
15856
|
}
|
|
15855
15857
|
|
|
15858
|
+
/**
|
|
15859
|
+
* Members of a given performance profile
|
|
15860
|
+
*
|
|
15861
|
+
* @param {String} performanceProfileId Performance Profile Id
|
|
15862
|
+
*/
|
|
15863
|
+
getGamificationProfileMembers(performanceProfileId) {
|
|
15864
|
+
// verify the required parameter 'performanceProfileId' is set
|
|
15865
|
+
if (performanceProfileId === undefined || performanceProfileId === null) {
|
|
15866
|
+
throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
|
|
15867
|
+
}
|
|
15868
|
+
|
|
15869
|
+
return this.apiClient.callApi(
|
|
15870
|
+
'/api/v2/gamification/profiles/{performanceProfileId}/members',
|
|
15871
|
+
'GET',
|
|
15872
|
+
{ 'performanceProfileId': performanceProfileId },
|
|
15873
|
+
{ },
|
|
15874
|
+
{ },
|
|
15875
|
+
{ },
|
|
15876
|
+
null,
|
|
15877
|
+
['PureCloud OAuth'],
|
|
15878
|
+
['application/json'],
|
|
15879
|
+
['application/json']
|
|
15880
|
+
);
|
|
15881
|
+
}
|
|
15882
|
+
|
|
15856
15883
|
/**
|
|
15857
15884
|
* Performance profile gamified metric by id
|
|
15858
15885
|
*
|
|
@@ -16707,6 +16734,101 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16707
16734
|
);
|
|
16708
16735
|
}
|
|
16709
16736
|
|
|
16737
|
+
/**
|
|
16738
|
+
* Assign members to a given performance profile
|
|
16739
|
+
*
|
|
16740
|
+
* @param {String} performanceProfileId Performance Profile Id
|
|
16741
|
+
* @param {Object} body assignUsers
|
|
16742
|
+
*/
|
|
16743
|
+
postGamificationProfileMembers(performanceProfileId, body) {
|
|
16744
|
+
// verify the required parameter 'performanceProfileId' is set
|
|
16745
|
+
if (performanceProfileId === undefined || performanceProfileId === null) {
|
|
16746
|
+
throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
|
|
16747
|
+
}
|
|
16748
|
+
// verify the required parameter 'body' is set
|
|
16749
|
+
if (body === undefined || body === null) {
|
|
16750
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfileMembers';
|
|
16751
|
+
}
|
|
16752
|
+
|
|
16753
|
+
return this.apiClient.callApi(
|
|
16754
|
+
'/api/v2/gamification/profiles/{performanceProfileId}/members',
|
|
16755
|
+
'POST',
|
|
16756
|
+
{ 'performanceProfileId': performanceProfileId },
|
|
16757
|
+
{ },
|
|
16758
|
+
{ },
|
|
16759
|
+
{ },
|
|
16760
|
+
body,
|
|
16761
|
+
['PureCloud OAuth'],
|
|
16762
|
+
['application/json'],
|
|
16763
|
+
['application/json']
|
|
16764
|
+
);
|
|
16765
|
+
}
|
|
16766
|
+
|
|
16767
|
+
/**
|
|
16768
|
+
* Validate member assignment
|
|
16769
|
+
*
|
|
16770
|
+
* @param {String} performanceProfileId Performance Profile Id
|
|
16771
|
+
* @param {Object} body memberAssignments
|
|
16772
|
+
*/
|
|
16773
|
+
postGamificationProfileMembersValidate(performanceProfileId, body) {
|
|
16774
|
+
// verify the required parameter 'performanceProfileId' is set
|
|
16775
|
+
if (performanceProfileId === undefined || performanceProfileId === null) {
|
|
16776
|
+
throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
|
|
16777
|
+
}
|
|
16778
|
+
// verify the required parameter 'body' is set
|
|
16779
|
+
if (body === undefined || body === null) {
|
|
16780
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfileMembersValidate';
|
|
16781
|
+
}
|
|
16782
|
+
|
|
16783
|
+
return this.apiClient.callApi(
|
|
16784
|
+
'/api/v2/gamification/profiles/{performanceProfileId}/members/validate',
|
|
16785
|
+
'POST',
|
|
16786
|
+
{ 'performanceProfileId': performanceProfileId },
|
|
16787
|
+
{ },
|
|
16788
|
+
{ },
|
|
16789
|
+
{ },
|
|
16790
|
+
body,
|
|
16791
|
+
['PureCloud OAuth'],
|
|
16792
|
+
['application/json'],
|
|
16793
|
+
['application/json']
|
|
16794
|
+
);
|
|
16795
|
+
}
|
|
16796
|
+
|
|
16797
|
+
/**
|
|
16798
|
+
* Creates a linked metric
|
|
16799
|
+
*
|
|
16800
|
+
* @param {String} sourceProfileId Source Performance Profile Id
|
|
16801
|
+
* @param {String} sourceMetricId Source Metric Id
|
|
16802
|
+
* @param {Object} body linkedMetric
|
|
16803
|
+
*/
|
|
16804
|
+
postGamificationProfileMetricLink(sourceProfileId, sourceMetricId, body) {
|
|
16805
|
+
// verify the required parameter 'sourceProfileId' is set
|
|
16806
|
+
if (sourceProfileId === undefined || sourceProfileId === null) {
|
|
16807
|
+
throw 'Missing the required parameter "sourceProfileId" when calling postGamificationProfileMetricLink';
|
|
16808
|
+
}
|
|
16809
|
+
// verify the required parameter 'sourceMetricId' is set
|
|
16810
|
+
if (sourceMetricId === undefined || sourceMetricId === null) {
|
|
16811
|
+
throw 'Missing the required parameter "sourceMetricId" when calling postGamificationProfileMetricLink';
|
|
16812
|
+
}
|
|
16813
|
+
// verify the required parameter 'body' is set
|
|
16814
|
+
if (body === undefined || body === null) {
|
|
16815
|
+
throw 'Missing the required parameter "body" when calling postGamificationProfileMetricLink';
|
|
16816
|
+
}
|
|
16817
|
+
|
|
16818
|
+
return this.apiClient.callApi(
|
|
16819
|
+
'/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link',
|
|
16820
|
+
'POST',
|
|
16821
|
+
{ 'sourceProfileId': sourceProfileId,'sourceMetricId': sourceMetricId },
|
|
16822
|
+
{ },
|
|
16823
|
+
{ },
|
|
16824
|
+
{ },
|
|
16825
|
+
body,
|
|
16826
|
+
['PureCloud OAuth'],
|
|
16827
|
+
['application/json'],
|
|
16828
|
+
['application/json']
|
|
16829
|
+
);
|
|
16830
|
+
}
|
|
16831
|
+
|
|
16710
16832
|
/**
|
|
16711
16833
|
* Creates a gamified metric with a given metric definition and metric objective under in a performance profile
|
|
16712
16834
|
*
|
|
@@ -16891,7 +17013,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16891
17013
|
/**
|
|
16892
17014
|
* GeneralDataProtectionRegulation service.
|
|
16893
17015
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
16894
|
-
* @version
|
|
17016
|
+
* @version 130.0.0
|
|
16895
17017
|
*/
|
|
16896
17018
|
|
|
16897
17019
|
/**
|
|
@@ -17021,7 +17143,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17021
17143
|
/**
|
|
17022
17144
|
* Geolocation service.
|
|
17023
17145
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17024
|
-
* @version
|
|
17146
|
+
* @version 130.0.0
|
|
17025
17147
|
*/
|
|
17026
17148
|
|
|
17027
17149
|
/**
|
|
@@ -17152,7 +17274,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17152
17274
|
/**
|
|
17153
17275
|
* Greetings service.
|
|
17154
17276
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17155
|
-
* @version
|
|
17277
|
+
* @version 130.0.0
|
|
17156
17278
|
*/
|
|
17157
17279
|
|
|
17158
17280
|
/**
|
|
@@ -17607,7 +17729,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17607
17729
|
/**
|
|
17608
17730
|
* Groups service.
|
|
17609
17731
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
17610
|
-
* @version
|
|
17732
|
+
* @version 130.0.0
|
|
17611
17733
|
*/
|
|
17612
17734
|
|
|
17613
17735
|
/**
|
|
@@ -18012,7 +18134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18012
18134
|
/**
|
|
18013
18135
|
* IdentityProvider service.
|
|
18014
18136
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18015
|
-
* @version
|
|
18137
|
+
* @version 130.0.0
|
|
18016
18138
|
*/
|
|
18017
18139
|
|
|
18018
18140
|
/**
|
|
@@ -18768,7 +18890,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18768
18890
|
/**
|
|
18769
18891
|
* Integrations service.
|
|
18770
18892
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
18771
|
-
* @version
|
|
18893
|
+
* @version 130.0.0
|
|
18772
18894
|
*/
|
|
18773
18895
|
|
|
18774
18896
|
/**
|
|
@@ -19425,6 +19547,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19425
19547
|
);
|
|
19426
19548
|
}
|
|
19427
19549
|
|
|
19550
|
+
/**
|
|
19551
|
+
* UC integration client application configuration.
|
|
19552
|
+
* This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled for the current organization.
|
|
19553
|
+
* @param {Object} opts Optional parameters
|
|
19554
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
19555
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
19556
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
19557
|
+
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
19558
|
+
* @param {String} opts.nextPage next page token
|
|
19559
|
+
* @param {String} opts.previousPage Previous page token
|
|
19560
|
+
*/
|
|
19561
|
+
getIntegrationsClientappsUnifiedcommunications(opts) {
|
|
19562
|
+
opts = opts || {};
|
|
19563
|
+
|
|
19564
|
+
|
|
19565
|
+
return this.apiClient.callApi(
|
|
19566
|
+
'/api/v2/integrations/clientapps/unifiedcommunications',
|
|
19567
|
+
'GET',
|
|
19568
|
+
{ },
|
|
19569
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
|
|
19570
|
+
{ },
|
|
19571
|
+
{ },
|
|
19572
|
+
null,
|
|
19573
|
+
['PureCloud OAuth'],
|
|
19574
|
+
['application/json'],
|
|
19575
|
+
['application/json']
|
|
19576
|
+
);
|
|
19577
|
+
}
|
|
19578
|
+
|
|
19428
19579
|
/**
|
|
19429
19580
|
* Get a single credential with sensitive fields redacted
|
|
19430
19581
|
*
|
|
@@ -20414,7 +20565,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20414
20565
|
/**
|
|
20415
20566
|
* Journey service.
|
|
20416
20567
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20417
|
-
* @version
|
|
20568
|
+
* @version 130.0.0
|
|
20418
20569
|
*/
|
|
20419
20570
|
|
|
20420
20571
|
/**
|
|
@@ -21125,7 +21276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21125
21276
|
/**
|
|
21126
21277
|
* Knowledge service.
|
|
21127
21278
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21128
|
-
* @version
|
|
21279
|
+
* @version 130.0.0
|
|
21129
21280
|
*/
|
|
21130
21281
|
|
|
21131
21282
|
/**
|
|
@@ -22025,7 +22176,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22025
22176
|
/**
|
|
22026
22177
|
* LanguageUnderstanding service.
|
|
22027
22178
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22028
|
-
* @version
|
|
22179
|
+
* @version 130.0.0
|
|
22029
22180
|
*/
|
|
22030
22181
|
|
|
22031
22182
|
/**
|
|
@@ -22929,7 +23080,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22929
23080
|
/**
|
|
22930
23081
|
* Languages service.
|
|
22931
23082
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
22932
|
-
* @version
|
|
23083
|
+
* @version 130.0.0
|
|
22933
23084
|
*/
|
|
22934
23085
|
|
|
22935
23086
|
/**
|
|
@@ -23197,7 +23348,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23197
23348
|
/**
|
|
23198
23349
|
* Learning service.
|
|
23199
23350
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23200
|
-
* @version
|
|
23351
|
+
* @version 130.0.0
|
|
23201
23352
|
*/
|
|
23202
23353
|
|
|
23203
23354
|
/**
|
|
@@ -23788,7 +23939,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23788
23939
|
/**
|
|
23789
23940
|
* License service.
|
|
23790
23941
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
23791
|
-
* @version
|
|
23942
|
+
* @version 130.0.0
|
|
23792
23943
|
*/
|
|
23793
23944
|
|
|
23794
23945
|
/**
|
|
@@ -24026,7 +24177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24026
24177
|
/**
|
|
24027
24178
|
* Locations service.
|
|
24028
24179
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24029
|
-
* @version
|
|
24180
|
+
* @version 130.0.0
|
|
24030
24181
|
*/
|
|
24031
24182
|
|
|
24032
24183
|
/**
|
|
@@ -24262,7 +24413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24262
24413
|
/**
|
|
24263
24414
|
* MobileDevices service.
|
|
24264
24415
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24265
|
-
* @version
|
|
24416
|
+
* @version 130.0.0
|
|
24266
24417
|
*/
|
|
24267
24418
|
|
|
24268
24419
|
/**
|
|
@@ -24413,7 +24564,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24413
24564
|
/**
|
|
24414
24565
|
* Notifications service.
|
|
24415
24566
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
24416
|
-
* @version
|
|
24567
|
+
* @version 130.0.0
|
|
24417
24568
|
*/
|
|
24418
24569
|
|
|
24419
24570
|
/**
|
|
@@ -24638,7 +24789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24638
24789
|
/**
|
|
24639
24790
|
* OAuth service.
|
|
24640
24791
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
24641
|
-
* @version
|
|
24792
|
+
* @version 130.0.0
|
|
24642
24793
|
*/
|
|
24643
24794
|
|
|
24644
24795
|
/**
|
|
@@ -24996,7 +25147,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24996
25147
|
/**
|
|
24997
25148
|
* Objects service.
|
|
24998
25149
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
24999
|
-
* @version
|
|
25150
|
+
* @version 130.0.0
|
|
25000
25151
|
*/
|
|
25001
25152
|
|
|
25002
25153
|
/**
|
|
@@ -25267,7 +25418,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25267
25418
|
/**
|
|
25268
25419
|
* Organization service.
|
|
25269
25420
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25270
|
-
* @version
|
|
25421
|
+
* @version 130.0.0
|
|
25271
25422
|
*/
|
|
25272
25423
|
|
|
25273
25424
|
/**
|
|
@@ -25670,7 +25821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25670
25821
|
/**
|
|
25671
25822
|
* OrganizationAuthorization service.
|
|
25672
25823
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
25673
|
-
* @version
|
|
25824
|
+
* @version 130.0.0
|
|
25674
25825
|
*/
|
|
25675
25826
|
|
|
25676
25827
|
/**
|
|
@@ -26595,7 +26746,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26595
26746
|
/**
|
|
26596
26747
|
* Outbound service.
|
|
26597
26748
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
26598
|
-
* @version
|
|
26749
|
+
* @version 130.0.0
|
|
26599
26750
|
*/
|
|
26600
26751
|
|
|
26601
26752
|
/**
|
|
@@ -29621,7 +29772,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29621
29772
|
/**
|
|
29622
29773
|
* Presence service.
|
|
29623
29774
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
29624
|
-
* @version
|
|
29775
|
+
* @version 130.0.0
|
|
29625
29776
|
*/
|
|
29626
29777
|
|
|
29627
29778
|
/**
|
|
@@ -29993,7 +30144,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29993
30144
|
/**
|
|
29994
30145
|
* Quality service.
|
|
29995
30146
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
29996
|
-
* @version
|
|
30147
|
+
* @version 130.0.0
|
|
29997
30148
|
*/
|
|
29998
30149
|
|
|
29999
30150
|
/**
|
|
@@ -31521,7 +31672,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31521
31672
|
/**
|
|
31522
31673
|
* Recording service.
|
|
31523
31674
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
31524
|
-
* @version
|
|
31675
|
+
* @version 130.0.0
|
|
31525
31676
|
*/
|
|
31526
31677
|
|
|
31527
31678
|
/**
|
|
@@ -31727,11 +31878,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31727
31878
|
* @param {String} conversationId Conversation ID
|
|
31728
31879
|
* @param {String} recordingId Recording ID
|
|
31729
31880
|
* @param {Object} opts Optional parameters
|
|
31730
|
-
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
31731
|
-
* @param {Object} opts.emailFormatId The desired media format when downloading an email recording. (default to EML)
|
|
31732
|
-
* @param {Object} opts.chatFormatId The desired media format when downloading a chat recording. (default to ZIP)
|
|
31733
|
-
* @param {Object} opts.messageFormatId The desired media format when downloading a message recording. (default to ZIP)
|
|
31734
|
-
* @param {Boolean} opts.download requesting a download format of the recording (default to false)
|
|
31881
|
+
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE (default to WEBM)
|
|
31882
|
+
* @param {Object} opts.emailFormatId The desired media format when downloading an email recording. Valid values:EML,NONE (default to EML)
|
|
31883
|
+
* @param {Object} opts.chatFormatId The desired media format when downloading a chat recording. Valid values:ZIP,NONE (default to ZIP)
|
|
31884
|
+
* @param {Object} opts.messageFormatId The desired media format when downloading a message recording. Valid values:ZIP,NONE (default to ZIP)
|
|
31885
|
+
* @param {Boolean} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
|
|
31735
31886
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
31736
31887
|
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
31737
31888
|
*/
|
|
@@ -31827,7 +31978,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31827
31978
|
}
|
|
31828
31979
|
|
|
31829
31980
|
/**
|
|
31830
|
-
* Get recording metadata for a conversation. Does not return playable media.
|
|
31981
|
+
* Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if recording:recording:view permission is missing.
|
|
31831
31982
|
*
|
|
31832
31983
|
* @param {String} conversationId Conversation ID
|
|
31833
31984
|
*/
|
|
@@ -31887,7 +32038,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31887
32038
|
* @param {String} conversationId Conversation ID
|
|
31888
32039
|
* @param {Object} opts Optional parameters
|
|
31889
32040
|
* @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
|
|
31890
|
-
* @param {Object} opts.formatId The desired media format (default to WEBM)
|
|
32041
|
+
* @param {Object} opts.formatId The desired media format . Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
31891
32042
|
*/
|
|
31892
32043
|
getConversationRecordings(conversationId, opts) {
|
|
31893
32044
|
opts = opts || {};
|
|
@@ -32117,6 +32268,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32117
32268
|
* @param {Object} opts Optional parameters
|
|
32118
32269
|
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
32119
32270
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
32271
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
32272
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
32120
32273
|
*/
|
|
32121
32274
|
getRecordingJobFailedrecordings(jobId, opts) {
|
|
32122
32275
|
opts = opts || {};
|
|
@@ -32130,7 +32283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32130
32283
|
'/api/v2/recording/jobs/{jobId}/failedrecordings',
|
|
32131
32284
|
'GET',
|
|
32132
32285
|
{ 'jobId': jobId },
|
|
32133
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
32286
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
32134
32287
|
{ },
|
|
32135
32288
|
{ },
|
|
32136
32289
|
null,
|
|
@@ -32150,6 +32303,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32150
32303
|
* @param {Object} opts.state Filter by state
|
|
32151
32304
|
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
32152
32305
|
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
32306
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
32307
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
32153
32308
|
*/
|
|
32154
32309
|
getRecordingJobs(opts) {
|
|
32155
32310
|
opts = opts || {};
|
|
@@ -32159,7 +32314,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32159
32314
|
'/api/v2/recording/jobs',
|
|
32160
32315
|
'GET',
|
|
32161
32316
|
{ },
|
|
32162
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'] },
|
|
32317
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
32163
32318
|
{ },
|
|
32164
32319
|
{ },
|
|
32165
32320
|
null,
|
|
@@ -33040,7 +33195,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33040
33195
|
/**
|
|
33041
33196
|
* ResponseManagement service.
|
|
33042
33197
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33043
|
-
* @version
|
|
33198
|
+
* @version 130.0.0
|
|
33044
33199
|
*/
|
|
33045
33200
|
|
|
33046
33201
|
/**
|
|
@@ -33365,7 +33520,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33365
33520
|
/**
|
|
33366
33521
|
* Routing service.
|
|
33367
33522
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33368
|
-
* @version
|
|
33523
|
+
* @version 130.0.0
|
|
33369
33524
|
*/
|
|
33370
33525
|
|
|
33371
33526
|
/**
|
|
@@ -34803,10 +34958,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34803
34958
|
*
|
|
34804
34959
|
* @param {Object} opts Optional parameters
|
|
34805
34960
|
* @param {String} opts.phoneNumber Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.
|
|
34806
|
-
* @param {
|
|
34807
|
-
* @param {
|
|
34961
|
+
* @param {Array.<String>} opts.phoneNumberType Filter on phone number type
|
|
34962
|
+
* @param {Array.<String>} opts.phoneNumberStatus Filter on phone number status
|
|
34963
|
+
* @param {Array.<String>} opts.countryCode Filter on country code
|
|
34808
34964
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
34809
34965
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34966
|
+
* @param {Object} opts.sortBy Optional field to sort results
|
|
34967
|
+
* @param {Object} opts.sortOrder Sort order
|
|
34968
|
+
* @param {String} opts.language A language tag (which is sometimes referred to as a \"locale identifier\") to use to localize country field and sort operations (default to en-US)
|
|
34810
34969
|
*/
|
|
34811
34970
|
getRoutingSmsPhonenumbers(opts) {
|
|
34812
34971
|
opts = opts || {};
|
|
@@ -34816,7 +34975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34816
34975
|
'/api/v2/routing/sms/phonenumbers',
|
|
34817
34976
|
'GET',
|
|
34818
34977
|
{ },
|
|
34819
|
-
{ 'phoneNumber': opts['phoneNumber'],'phoneNumberType': opts['phoneNumberType'],'phoneNumberStatus': opts['phoneNumberStatus'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
34978
|
+
{ 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'] },
|
|
34820
34979
|
{ },
|
|
34821
34980
|
{ },
|
|
34822
34981
|
null,
|
|
@@ -36284,7 +36443,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36284
36443
|
/**
|
|
36285
36444
|
* SCIM service.
|
|
36286
36445
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36287
|
-
* @version
|
|
36446
|
+
* @version 130.0.0
|
|
36288
36447
|
*/
|
|
36289
36448
|
|
|
36290
36449
|
/**
|
|
@@ -37161,7 +37320,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37161
37320
|
/**
|
|
37162
37321
|
* Scripts service.
|
|
37163
37322
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
37164
|
-
* @version
|
|
37323
|
+
* @version 130.0.0
|
|
37165
37324
|
*/
|
|
37166
37325
|
|
|
37167
37326
|
/**
|
|
@@ -37514,7 +37673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37514
37673
|
/**
|
|
37515
37674
|
* Search service.
|
|
37516
37675
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37517
|
-
* @version
|
|
37676
|
+
* @version 130.0.0
|
|
37518
37677
|
*/
|
|
37519
37678
|
|
|
37520
37679
|
/**
|
|
@@ -38049,7 +38208,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38049
38208
|
/**
|
|
38050
38209
|
* SpeechTextAnalytics service.
|
|
38051
38210
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38052
|
-
* @version
|
|
38211
|
+
* @version 130.0.0
|
|
38053
38212
|
*/
|
|
38054
38213
|
|
|
38055
38214
|
/**
|
|
@@ -38413,6 +38572,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38413
38572
|
);
|
|
38414
38573
|
}
|
|
38415
38574
|
|
|
38575
|
+
/**
|
|
38576
|
+
* Get the list of Speech & Text Analytics sentiment supported dialects
|
|
38577
|
+
*
|
|
38578
|
+
*/
|
|
38579
|
+
getSpeechandtextanalyticsSentimentDialects() {
|
|
38580
|
+
|
|
38581
|
+
return this.apiClient.callApi(
|
|
38582
|
+
'/api/v2/speechandtextanalytics/sentiment/dialects',
|
|
38583
|
+
'GET',
|
|
38584
|
+
{ },
|
|
38585
|
+
{ },
|
|
38586
|
+
{ },
|
|
38587
|
+
{ },
|
|
38588
|
+
null,
|
|
38589
|
+
['PureCloud OAuth'],
|
|
38590
|
+
['application/json'],
|
|
38591
|
+
['application/json']
|
|
38592
|
+
);
|
|
38593
|
+
}
|
|
38594
|
+
|
|
38416
38595
|
/**
|
|
38417
38596
|
* Get the list of Speech & Text Analytics SentimentFeedback
|
|
38418
38597
|
*
|
|
@@ -38902,7 +39081,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38902
39081
|
/**
|
|
38903
39082
|
* Stations service.
|
|
38904
39083
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38905
|
-
* @version
|
|
39084
|
+
* @version 130.0.0
|
|
38906
39085
|
*/
|
|
38907
39086
|
|
|
38908
39087
|
/**
|
|
@@ -39049,7 +39228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39049
39228
|
/**
|
|
39050
39229
|
* Suggest service.
|
|
39051
39230
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
39052
|
-
* @version
|
|
39231
|
+
* @version 130.0.0
|
|
39053
39232
|
*/
|
|
39054
39233
|
|
|
39055
39234
|
/**
|
|
@@ -39188,7 +39367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39188
39367
|
/**
|
|
39189
39368
|
* Telephony service.
|
|
39190
39369
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
39191
|
-
* @version
|
|
39370
|
+
* @version 130.0.0
|
|
39192
39371
|
*/
|
|
39193
39372
|
|
|
39194
39373
|
/**
|
|
@@ -39296,7 +39475,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39296
39475
|
/**
|
|
39297
39476
|
* TelephonyProvidersEdge service.
|
|
39298
39477
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
39299
|
-
* @version
|
|
39478
|
+
* @version 130.0.0
|
|
39300
39479
|
*/
|
|
39301
39480
|
|
|
39302
39481
|
/**
|
|
@@ -40634,6 +40813,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40634
40813
|
);
|
|
40635
40814
|
}
|
|
40636
40815
|
|
|
40816
|
+
/**
|
|
40817
|
+
* List of edges more than 4 edge versions behind the latest software.
|
|
40818
|
+
*
|
|
40819
|
+
*/
|
|
40820
|
+
getTelephonyProvidersEdgesExpired() {
|
|
40821
|
+
|
|
40822
|
+
return this.apiClient.callApi(
|
|
40823
|
+
'/api/v2/telephony/providers/edges/expired',
|
|
40824
|
+
'GET',
|
|
40825
|
+
{ },
|
|
40826
|
+
{ },
|
|
40827
|
+
{ },
|
|
40828
|
+
{ },
|
|
40829
|
+
null,
|
|
40830
|
+
['PureCloud OAuth'],
|
|
40831
|
+
['application/json'],
|
|
40832
|
+
['application/json']
|
|
40833
|
+
);
|
|
40834
|
+
}
|
|
40835
|
+
|
|
40637
40836
|
/**
|
|
40638
40837
|
* Get an extension by ID.
|
|
40639
40838
|
*
|
|
@@ -42909,7 +43108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42909
43108
|
/**
|
|
42910
43109
|
* Textbots service.
|
|
42911
43110
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42912
|
-
* @version
|
|
43111
|
+
* @version 130.0.0
|
|
42913
43112
|
*/
|
|
42914
43113
|
|
|
42915
43114
|
/**
|
|
@@ -42924,6 +43123,33 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42924
43123
|
}
|
|
42925
43124
|
|
|
42926
43125
|
|
|
43126
|
+
/**
|
|
43127
|
+
* Find bots using the currently configured friendly name or ID.
|
|
43128
|
+
* The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100
|
|
43129
|
+
* @param {Object} opts Optional parameters
|
|
43130
|
+
* @param {Array.<String>} opts.botType Bot types
|
|
43131
|
+
* @param {String} opts.botName Bot name
|
|
43132
|
+
* @param {Array.<String>} opts.botId Bot IDs
|
|
43133
|
+
* @param {Number} opts.pageSize The maximum results to return (default to 25)
|
|
43134
|
+
*/
|
|
43135
|
+
getTextbotsBotsSearch(opts) {
|
|
43136
|
+
opts = opts || {};
|
|
43137
|
+
|
|
43138
|
+
|
|
43139
|
+
return this.apiClient.callApi(
|
|
43140
|
+
'/api/v2/textbots/bots/search',
|
|
43141
|
+
'GET',
|
|
43142
|
+
{ },
|
|
43143
|
+
{ 'botType': this.apiClient.buildCollectionParam(opts['botType'], 'multi'),'botName': opts['botName'],'botId': this.apiClient.buildCollectionParam(opts['botId'], 'multi'),'pageSize': opts['pageSize'] },
|
|
43144
|
+
{ },
|
|
43145
|
+
{ },
|
|
43146
|
+
null,
|
|
43147
|
+
['PureCloud OAuth'],
|
|
43148
|
+
['application/json'],
|
|
43149
|
+
['application/json']
|
|
43150
|
+
);
|
|
43151
|
+
}
|
|
43152
|
+
|
|
42927
43153
|
/**
|
|
42928
43154
|
* Issue a bot flow turn event
|
|
42929
43155
|
* Send a turn event to an executing bot flow and produce the next action to take.
|
|
@@ -43010,7 +43236,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43010
43236
|
/**
|
|
43011
43237
|
* Tokens service.
|
|
43012
43238
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
43013
|
-
* @version
|
|
43239
|
+
* @version 130.0.0
|
|
43014
43240
|
*/
|
|
43015
43241
|
|
|
43016
43242
|
/**
|
|
@@ -43116,7 +43342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43116
43342
|
/**
|
|
43117
43343
|
* Uploads service.
|
|
43118
43344
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
43119
|
-
* @version
|
|
43345
|
+
* @version 130.0.0
|
|
43120
43346
|
*/
|
|
43121
43347
|
|
|
43122
43348
|
/**
|
|
@@ -43292,7 +43518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43292
43518
|
/**
|
|
43293
43519
|
* Usage service.
|
|
43294
43520
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
43295
|
-
* @version
|
|
43521
|
+
* @version 130.0.0
|
|
43296
43522
|
*/
|
|
43297
43523
|
|
|
43298
43524
|
/**
|
|
@@ -43363,7 +43589,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43363
43589
|
/**
|
|
43364
43590
|
* UserRecordings service.
|
|
43365
43591
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
43366
|
-
* @version
|
|
43592
|
+
* @version 130.0.0
|
|
43367
43593
|
*/
|
|
43368
43594
|
|
|
43369
43595
|
/**
|
|
@@ -43547,7 +43773,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43547
43773
|
/**
|
|
43548
43774
|
* Users service.
|
|
43549
43775
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
43550
|
-
* @version
|
|
43776
|
+
* @version 130.0.0
|
|
43551
43777
|
*/
|
|
43552
43778
|
|
|
43553
43779
|
/**
|
|
@@ -45849,7 +46075,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45849
46075
|
/**
|
|
45850
46076
|
* Utilities service.
|
|
45851
46077
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
45852
|
-
* @version
|
|
46078
|
+
* @version 130.0.0
|
|
45853
46079
|
*/
|
|
45854
46080
|
|
|
45855
46081
|
/**
|
|
@@ -45885,7 +46111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45885
46111
|
}
|
|
45886
46112
|
|
|
45887
46113
|
/**
|
|
45888
|
-
* Get public ip address ranges for
|
|
46114
|
+
* Get public ip address ranges for Genesys Cloud
|
|
45889
46115
|
*
|
|
45890
46116
|
*/
|
|
45891
46117
|
getIpranges() {
|
|
@@ -45960,7 +46186,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45960
46186
|
/**
|
|
45961
46187
|
* Voicemail service.
|
|
45962
46188
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
45963
|
-
* @version
|
|
46189
|
+
* @version 130.0.0
|
|
45964
46190
|
*/
|
|
45965
46191
|
|
|
45966
46192
|
/**
|
|
@@ -46627,7 +46853,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46627
46853
|
/**
|
|
46628
46854
|
* WebChat service.
|
|
46629
46855
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
46630
|
-
* @version
|
|
46856
|
+
* @version 130.0.0
|
|
46631
46857
|
*/
|
|
46632
46858
|
|
|
46633
46859
|
/**
|
|
@@ -47171,7 +47397,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47171
47397
|
/**
|
|
47172
47398
|
* WebDeployments service.
|
|
47173
47399
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
47174
|
-
* @version
|
|
47400
|
+
* @version 130.0.0
|
|
47175
47401
|
*/
|
|
47176
47402
|
|
|
47177
47403
|
/**
|
|
@@ -47526,7 +47752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47526
47752
|
/**
|
|
47527
47753
|
* WebMessaging service.
|
|
47528
47754
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
47529
|
-
* @version
|
|
47755
|
+
* @version 130.0.0
|
|
47530
47756
|
*/
|
|
47531
47757
|
|
|
47532
47758
|
/**
|
|
@@ -47572,7 +47798,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47572
47798
|
/**
|
|
47573
47799
|
* Widgets service.
|
|
47574
47800
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
47575
|
-
* @version
|
|
47801
|
+
* @version 130.0.0
|
|
47576
47802
|
*/
|
|
47577
47803
|
|
|
47578
47804
|
/**
|
|
@@ -47718,7 +47944,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47718
47944
|
/**
|
|
47719
47945
|
* WorkforceManagement service.
|
|
47720
47946
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
47721
|
-
* @version
|
|
47947
|
+
* @version 130.0.0
|
|
47722
47948
|
*/
|
|
47723
47949
|
|
|
47724
47950
|
/**
|
|
@@ -51749,7 +51975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51749
51975
|
* </pre>
|
|
51750
51976
|
* </p>
|
|
51751
51977
|
* @module purecloud-platform-client-v2/index
|
|
51752
|
-
* @version
|
|
51978
|
+
* @version 130.0.0
|
|
51753
51979
|
*/
|
|
51754
51980
|
class platformClient {
|
|
51755
51981
|
constructor() {
|