purecloud-platform-client-v2 255.0.0 → 256.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +693 -93
- package/dist/web-amd/purecloud-platform-client-v2.js +693 -93
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +254 -94
- package/dist/web-cjs/purecloud-platform-client-v2.js +254 -94
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +362 -30
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +35 -1
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.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/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.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 +151 -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 +3 -2
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -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 +2 -4
- 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 +2 -2
- 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 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenMonitoringApi.js +381 -0
- 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 +1 -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 -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/UsersRulesApi.js +1 -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 +37 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -745,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
747
|
* @module purecloud-platform-client-v2/ApiClient
|
|
748
|
-
* @version
|
|
748
|
+
* @version 256.0.0
|
|
749
749
|
*/
|
|
750
750
|
class ApiClient {
|
|
751
751
|
/**
|
|
@@ -2437,7 +2437,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2437
2437
|
/**
|
|
2438
2438
|
* AIStudio service.
|
|
2439
2439
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2440
|
-
* @version
|
|
2440
|
+
* @version 256.0.0
|
|
2441
2441
|
*/
|
|
2442
2442
|
|
|
2443
2443
|
/**
|
|
@@ -3152,7 +3152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3152
3152
|
/**
|
|
3153
3153
|
* AgentAssistants service.
|
|
3154
3154
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3155
|
-
* @version
|
|
3155
|
+
* @version 256.0.0
|
|
3156
3156
|
*/
|
|
3157
3157
|
|
|
3158
3158
|
/**
|
|
@@ -3957,7 +3957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3957
3957
|
/**
|
|
3958
3958
|
* AgentCopilot service.
|
|
3959
3959
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3960
|
-
* @version
|
|
3960
|
+
* @version 256.0.0
|
|
3961
3961
|
*/
|
|
3962
3962
|
|
|
3963
3963
|
/**
|
|
@@ -4069,7 +4069,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4069
4069
|
/**
|
|
4070
4070
|
* AgentUI service.
|
|
4071
4071
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
4072
|
-
* @version
|
|
4072
|
+
* @version 256.0.0
|
|
4073
4073
|
*/
|
|
4074
4074
|
|
|
4075
4075
|
/**
|
|
@@ -4220,7 +4220,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4220
4220
|
/**
|
|
4221
4221
|
* Alerting service.
|
|
4222
4222
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
4223
|
-
* @version
|
|
4223
|
+
* @version 256.0.0
|
|
4224
4224
|
*/
|
|
4225
4225
|
|
|
4226
4226
|
/**
|
|
@@ -4681,7 +4681,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4681
4681
|
/**
|
|
4682
4682
|
* Analytics service.
|
|
4683
4683
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4684
|
-
* @version
|
|
4684
|
+
* @version 256.0.0
|
|
4685
4685
|
*/
|
|
4686
4686
|
|
|
4687
4687
|
/**
|
|
@@ -8906,7 +8906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8906
8906
|
/**
|
|
8907
8907
|
* Architect service.
|
|
8908
8908
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8909
|
-
* @version
|
|
8909
|
+
* @version 256.0.0
|
|
8910
8910
|
*/
|
|
8911
8911
|
|
|
8912
8912
|
/**
|
|
@@ -11743,6 +11743,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11743
11743
|
);
|
|
11744
11744
|
}
|
|
11745
11745
|
|
|
11746
|
+
/**
|
|
11747
|
+
* Look up flows by ID
|
|
11748
|
+
* Returns only flows matching the specified ID(s). Returns an empty listing if no flows match the given IDs.
|
|
11749
|
+
* @param {Array.<String>} id Flow ID(s)
|
|
11750
|
+
* @param {Object} opts Optional parameters
|
|
11751
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11752
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11753
|
+
* @param {String} opts.sortBy Sort by (default to id)
|
|
11754
|
+
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
11755
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11756
|
+
*/
|
|
11757
|
+
getFlowsLookup(id, opts) {
|
|
11758
|
+
opts = opts || {};
|
|
11759
|
+
|
|
11760
|
+
// verify the required parameter 'id' is set
|
|
11761
|
+
if (id === undefined || id === null) {
|
|
11762
|
+
throw 'Missing the required parameter "id" when calling getFlowsLookup';
|
|
11763
|
+
}
|
|
11764
|
+
|
|
11765
|
+
return this.apiClient.callApi(
|
|
11766
|
+
'/api/v2/flows/lookup',
|
|
11767
|
+
'GET',
|
|
11768
|
+
{ },
|
|
11769
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi'),'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
11770
|
+
{ },
|
|
11771
|
+
{ },
|
|
11772
|
+
null,
|
|
11773
|
+
['PureCloud OAuth'],
|
|
11774
|
+
['application/json'],
|
|
11775
|
+
['application/json'],
|
|
11776
|
+
opts['customHeaders']
|
|
11777
|
+
);
|
|
11778
|
+
}
|
|
11779
|
+
|
|
11746
11780
|
/**
|
|
11747
11781
|
* Get a flow milestone
|
|
11748
11782
|
* Returns a specified flow milestone
|
|
@@ -13829,7 +13863,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13829
13863
|
/**
|
|
13830
13864
|
* AssistantCopilotVariations service.
|
|
13831
13865
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
13832
|
-
* @version
|
|
13866
|
+
* @version 256.0.0
|
|
13833
13867
|
*/
|
|
13834
13868
|
|
|
13835
13869
|
/**
|
|
@@ -14025,7 +14059,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14025
14059
|
/**
|
|
14026
14060
|
* Audit service.
|
|
14027
14061
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14028
|
-
* @version
|
|
14062
|
+
* @version 256.0.0
|
|
14029
14063
|
*/
|
|
14030
14064
|
|
|
14031
14065
|
/**
|
|
@@ -14252,7 +14286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14252
14286
|
/**
|
|
14253
14287
|
* Authorization service.
|
|
14254
14288
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
14255
|
-
* @version
|
|
14289
|
+
* @version 256.0.0
|
|
14256
14290
|
*/
|
|
14257
14291
|
|
|
14258
14292
|
/**
|
|
@@ -16177,7 +16211,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16177
16211
|
/**
|
|
16178
16212
|
* BackgroundAssistant service.
|
|
16179
16213
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
16180
|
-
* @version
|
|
16214
|
+
* @version 256.0.0
|
|
16181
16215
|
*/
|
|
16182
16216
|
|
|
16183
16217
|
/**
|
|
@@ -16251,7 +16285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16251
16285
|
/**
|
|
16252
16286
|
* Billing service.
|
|
16253
16287
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16254
|
-
* @version
|
|
16288
|
+
* @version 256.0.0
|
|
16255
16289
|
*/
|
|
16256
16290
|
|
|
16257
16291
|
/**
|
|
@@ -16535,7 +16569,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16535
16569
|
/**
|
|
16536
16570
|
* BusinessRules service.
|
|
16537
16571
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
16538
|
-
* @version
|
|
16572
|
+
* @version 256.0.0
|
|
16539
16573
|
*/
|
|
16540
16574
|
|
|
16541
16575
|
/**
|
|
@@ -17983,7 +18017,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17983
18017
|
/**
|
|
17984
18018
|
* CarrierServices service.
|
|
17985
18019
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17986
|
-
* @version
|
|
18020
|
+
* @version 256.0.0
|
|
17987
18021
|
*/
|
|
17988
18022
|
|
|
17989
18023
|
/**
|
|
@@ -18060,7 +18094,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18060
18094
|
/**
|
|
18061
18095
|
* CaseManagement service.
|
|
18062
18096
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
18063
|
-
* @version
|
|
18097
|
+
* @version 256.0.0
|
|
18064
18098
|
*/
|
|
18065
18099
|
|
|
18066
18100
|
/**
|
|
@@ -19435,7 +19469,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19435
19469
|
/**
|
|
19436
19470
|
* Chat service.
|
|
19437
19471
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
19438
|
-
* @version
|
|
19472
|
+
* @version 256.0.0
|
|
19439
19473
|
*/
|
|
19440
19474
|
|
|
19441
19475
|
/**
|
|
@@ -20574,7 +20608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20574
20608
|
/**
|
|
20575
20609
|
* Coaching service.
|
|
20576
20610
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
20577
|
-
* @version
|
|
20611
|
+
* @version 256.0.0
|
|
20578
20612
|
*/
|
|
20579
20613
|
|
|
20580
20614
|
/**
|
|
@@ -21288,7 +21322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21288
21322
|
/**
|
|
21289
21323
|
* ContentManagement service.
|
|
21290
21324
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
21291
|
-
* @version
|
|
21325
|
+
* @version 256.0.0
|
|
21292
21326
|
*/
|
|
21293
21327
|
|
|
21294
21328
|
/**
|
|
@@ -22483,7 +22517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22483
22517
|
/**
|
|
22484
22518
|
* Conversations service.
|
|
22485
22519
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
22486
|
-
* @version
|
|
22520
|
+
* @version 256.0.0
|
|
22487
22521
|
*/
|
|
22488
22522
|
|
|
22489
22523
|
/**
|
|
@@ -33585,7 +33619,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33585
33619
|
/**
|
|
33586
33620
|
* DataExtensions service.
|
|
33587
33621
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
33588
|
-
* @version
|
|
33622
|
+
* @version 256.0.0
|
|
33589
33623
|
*/
|
|
33590
33624
|
|
|
33591
33625
|
/**
|
|
@@ -33686,7 +33720,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33686
33720
|
/**
|
|
33687
33721
|
* DataPrivacy service.
|
|
33688
33722
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
33689
|
-
* @version
|
|
33723
|
+
* @version 256.0.0
|
|
33690
33724
|
*/
|
|
33691
33725
|
|
|
33692
33726
|
/**
|
|
@@ -33883,7 +33917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33883
33917
|
/**
|
|
33884
33918
|
* Downloads service.
|
|
33885
33919
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
33886
|
-
* @version
|
|
33920
|
+
* @version 256.0.0
|
|
33887
33921
|
*/
|
|
33888
33922
|
|
|
33889
33923
|
/**
|
|
@@ -33937,7 +33971,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33937
33971
|
/**
|
|
33938
33972
|
* Emails service.
|
|
33939
33973
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
33940
|
-
* @version
|
|
33974
|
+
* @version 256.0.0
|
|
33941
33975
|
*/
|
|
33942
33976
|
|
|
33943
33977
|
/**
|
|
@@ -34085,7 +34119,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34085
34119
|
/**
|
|
34086
34120
|
* EmployeeEngagement service.
|
|
34087
34121
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
34088
|
-
* @version
|
|
34122
|
+
* @version 256.0.0
|
|
34089
34123
|
*/
|
|
34090
34124
|
|
|
34091
34125
|
/**
|
|
@@ -34289,7 +34323,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34289
34323
|
/**
|
|
34290
34324
|
* Events service.
|
|
34291
34325
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
34292
|
-
* @version
|
|
34326
|
+
* @version 256.0.0
|
|
34293
34327
|
*/
|
|
34294
34328
|
|
|
34295
34329
|
/**
|
|
@@ -34431,7 +34465,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34431
34465
|
/**
|
|
34432
34466
|
* ExternalContacts service.
|
|
34433
34467
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
34434
|
-
* @version
|
|
34468
|
+
* @version 256.0.0
|
|
34435
34469
|
*/
|
|
34436
34470
|
|
|
34437
34471
|
/**
|
|
@@ -36356,6 +36390,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36356
36390
|
);
|
|
36357
36391
|
}
|
|
36358
36392
|
|
|
36393
|
+
/**
|
|
36394
|
+
* Update a Contact Note
|
|
36395
|
+
*
|
|
36396
|
+
* @param {String} contactId ExternalContact Id
|
|
36397
|
+
* @param {String} noteId Note Id
|
|
36398
|
+
* @param {Object} body Note field to update
|
|
36399
|
+
* @param {Object} opts Optional parameters
|
|
36400
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36401
|
+
*/
|
|
36402
|
+
patchExternalcontactsContactNote(contactId, noteId, body, opts) {
|
|
36403
|
+
opts = opts || {};
|
|
36404
|
+
|
|
36405
|
+
// verify the required parameter 'contactId' is set
|
|
36406
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
36407
|
+
throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContactNote';
|
|
36408
|
+
}
|
|
36409
|
+
// verify the required parameter 'noteId' is set
|
|
36410
|
+
if (noteId === undefined || noteId === null || noteId === '') {
|
|
36411
|
+
throw 'Missing the required parameter "noteId" when calling patchExternalcontactsContactNote';
|
|
36412
|
+
}
|
|
36413
|
+
// verify the required parameter 'body' is set
|
|
36414
|
+
if (body === undefined || body === null) {
|
|
36415
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsContactNote';
|
|
36416
|
+
}
|
|
36417
|
+
|
|
36418
|
+
return this.apiClient.callApi(
|
|
36419
|
+
'/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}',
|
|
36420
|
+
'PATCH',
|
|
36421
|
+
{ 'contactId': contactId,'noteId': noteId },
|
|
36422
|
+
{ },
|
|
36423
|
+
{ },
|
|
36424
|
+
{ },
|
|
36425
|
+
body,
|
|
36426
|
+
['PureCloud OAuth'],
|
|
36427
|
+
['application/json'],
|
|
36428
|
+
['application/json'],
|
|
36429
|
+
opts['customHeaders']
|
|
36430
|
+
);
|
|
36431
|
+
}
|
|
36432
|
+
|
|
36433
|
+
/**
|
|
36434
|
+
* Update specific fields of an external organization
|
|
36435
|
+
*
|
|
36436
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
36437
|
+
* @param {Object} body External Organization fields to update
|
|
36438
|
+
* @param {Object} opts Optional parameters
|
|
36439
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36440
|
+
*/
|
|
36441
|
+
patchExternalcontactsOrganization(externalOrganizationId, body, opts) {
|
|
36442
|
+
opts = opts || {};
|
|
36443
|
+
|
|
36444
|
+
// verify the required parameter 'externalOrganizationId' is set
|
|
36445
|
+
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
36446
|
+
throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganization';
|
|
36447
|
+
}
|
|
36448
|
+
// verify the required parameter 'body' is set
|
|
36449
|
+
if (body === undefined || body === null) {
|
|
36450
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganization';
|
|
36451
|
+
}
|
|
36452
|
+
|
|
36453
|
+
return this.apiClient.callApi(
|
|
36454
|
+
'/api/v2/externalcontacts/organizations/{externalOrganizationId}',
|
|
36455
|
+
'PATCH',
|
|
36456
|
+
{ 'externalOrganizationId': externalOrganizationId },
|
|
36457
|
+
{ },
|
|
36458
|
+
{ },
|
|
36459
|
+
{ },
|
|
36460
|
+
body,
|
|
36461
|
+
['PureCloud OAuth'],
|
|
36462
|
+
['application/json'],
|
|
36463
|
+
['application/json'],
|
|
36464
|
+
opts['customHeaders']
|
|
36465
|
+
);
|
|
36466
|
+
}
|
|
36467
|
+
|
|
36359
36468
|
/**
|
|
36360
36469
|
* Claim or release identifiers for an external organization
|
|
36361
36470
|
*
|
|
@@ -36391,6 +36500,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36391
36500
|
);
|
|
36392
36501
|
}
|
|
36393
36502
|
|
|
36503
|
+
/**
|
|
36504
|
+
* Update an External Organization Note
|
|
36505
|
+
*
|
|
36506
|
+
* @param {String} externalOrganizationId External Organization Id
|
|
36507
|
+
* @param {String} noteId Note Id
|
|
36508
|
+
* @param {Object} body Note field to update
|
|
36509
|
+
* @param {Object} opts Optional parameters
|
|
36510
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36511
|
+
*/
|
|
36512
|
+
patchExternalcontactsOrganizationNote(externalOrganizationId, noteId, body, opts) {
|
|
36513
|
+
opts = opts || {};
|
|
36514
|
+
|
|
36515
|
+
// verify the required parameter 'externalOrganizationId' is set
|
|
36516
|
+
if (externalOrganizationId === undefined || externalOrganizationId === null || externalOrganizationId === '') {
|
|
36517
|
+
throw 'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationNote';
|
|
36518
|
+
}
|
|
36519
|
+
// verify the required parameter 'noteId' is set
|
|
36520
|
+
if (noteId === undefined || noteId === null || noteId === '') {
|
|
36521
|
+
throw 'Missing the required parameter "noteId" when calling patchExternalcontactsOrganizationNote';
|
|
36522
|
+
}
|
|
36523
|
+
// verify the required parameter 'body' is set
|
|
36524
|
+
if (body === undefined || body === null) {
|
|
36525
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsOrganizationNote';
|
|
36526
|
+
}
|
|
36527
|
+
|
|
36528
|
+
return this.apiClient.callApi(
|
|
36529
|
+
'/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}',
|
|
36530
|
+
'PATCH',
|
|
36531
|
+
{ 'externalOrganizationId': externalOrganizationId,'noteId': noteId },
|
|
36532
|
+
{ },
|
|
36533
|
+
{ },
|
|
36534
|
+
{ },
|
|
36535
|
+
body,
|
|
36536
|
+
['PureCloud OAuth'],
|
|
36537
|
+
['application/json'],
|
|
36538
|
+
['application/json'],
|
|
36539
|
+
opts['customHeaders']
|
|
36540
|
+
);
|
|
36541
|
+
}
|
|
36542
|
+
|
|
36543
|
+
/**
|
|
36544
|
+
* Update specific fields of a relationship
|
|
36545
|
+
*
|
|
36546
|
+
* @param {String} relationshipId Relationship Id
|
|
36547
|
+
* @param {Object} body Relationship fields to update
|
|
36548
|
+
* @param {Object} opts Optional parameters
|
|
36549
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36550
|
+
*/
|
|
36551
|
+
patchExternalcontactsRelationship(relationshipId, body, opts) {
|
|
36552
|
+
opts = opts || {};
|
|
36553
|
+
|
|
36554
|
+
// verify the required parameter 'relationshipId' is set
|
|
36555
|
+
if (relationshipId === undefined || relationshipId === null || relationshipId === '') {
|
|
36556
|
+
throw 'Missing the required parameter "relationshipId" when calling patchExternalcontactsRelationship';
|
|
36557
|
+
}
|
|
36558
|
+
// verify the required parameter 'body' is set
|
|
36559
|
+
if (body === undefined || body === null) {
|
|
36560
|
+
throw 'Missing the required parameter "body" when calling patchExternalcontactsRelationship';
|
|
36561
|
+
}
|
|
36562
|
+
|
|
36563
|
+
return this.apiClient.callApi(
|
|
36564
|
+
'/api/v2/externalcontacts/relationships/{relationshipId}',
|
|
36565
|
+
'PATCH',
|
|
36566
|
+
{ 'relationshipId': relationshipId },
|
|
36567
|
+
{ },
|
|
36568
|
+
{ },
|
|
36569
|
+
{ },
|
|
36570
|
+
body,
|
|
36571
|
+
['PureCloud OAuth'],
|
|
36572
|
+
['application/json'],
|
|
36573
|
+
['application/json'],
|
|
36574
|
+
opts['customHeaders']
|
|
36575
|
+
);
|
|
36576
|
+
}
|
|
36577
|
+
|
|
36394
36578
|
/**
|
|
36395
36579
|
* Bulk fetch contacts
|
|
36396
36580
|
*
|
|
@@ -38202,7 +38386,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38202
38386
|
/**
|
|
38203
38387
|
* Fax service.
|
|
38204
38388
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
38205
|
-
* @version
|
|
38389
|
+
* @version 256.0.0
|
|
38206
38390
|
*/
|
|
38207
38391
|
|
|
38208
38392
|
/**
|
|
@@ -38451,7 +38635,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38451
38635
|
/**
|
|
38452
38636
|
* Flows service.
|
|
38453
38637
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
38454
|
-
* @version
|
|
38638
|
+
* @version 256.0.0
|
|
38455
38639
|
*/
|
|
38456
38640
|
|
|
38457
38641
|
/**
|
|
@@ -38685,7 +38869,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38685
38869
|
/**
|
|
38686
38870
|
* Gamification service.
|
|
38687
38871
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
38688
|
-
* @version
|
|
38872
|
+
* @version 256.0.0
|
|
38689
38873
|
*/
|
|
38690
38874
|
|
|
38691
38875
|
/**
|
|
@@ -41537,7 +41721,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41537
41721
|
/**
|
|
41538
41722
|
* GeneralDataProtectionRegulation service.
|
|
41539
41723
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
41540
|
-
* @version
|
|
41724
|
+
* @version 256.0.0
|
|
41541
41725
|
*/
|
|
41542
41726
|
|
|
41543
41727
|
/**
|
|
@@ -41681,7 +41865,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41681
41865
|
/**
|
|
41682
41866
|
* Geolocation service.
|
|
41683
41867
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
41684
|
-
* @version
|
|
41868
|
+
* @version 256.0.0
|
|
41685
41869
|
*/
|
|
41686
41870
|
|
|
41687
41871
|
/**
|
|
@@ -41832,7 +42016,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41832
42016
|
/**
|
|
41833
42017
|
* Greetings service.
|
|
41834
42018
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
41835
|
-
* @version
|
|
42019
|
+
* @version 256.0.0
|
|
41836
42020
|
*/
|
|
41837
42021
|
|
|
41838
42022
|
/**
|
|
@@ -42448,7 +42632,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42448
42632
|
/**
|
|
42449
42633
|
* Groups service.
|
|
42450
42634
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
42451
|
-
* @version
|
|
42635
|
+
* @version 256.0.0
|
|
42452
42636
|
*/
|
|
42453
42637
|
|
|
42454
42638
|
/**
|
|
@@ -43039,7 +43223,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43039
43223
|
/**
|
|
43040
43224
|
* IdentityProvider service.
|
|
43041
43225
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
43042
|
-
* @version
|
|
43226
|
+
* @version 256.0.0
|
|
43043
43227
|
*/
|
|
43044
43228
|
|
|
43045
43229
|
/**
|
|
@@ -44090,7 +44274,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44090
44274
|
/**
|
|
44091
44275
|
* InfrastructureAsCode service.
|
|
44092
44276
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
44093
|
-
* @version
|
|
44277
|
+
* @version 256.0.0
|
|
44094
44278
|
*/
|
|
44095
44279
|
|
|
44096
44280
|
/**
|
|
@@ -44270,7 +44454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44270
44454
|
/**
|
|
44271
44455
|
* Integrations service.
|
|
44272
44456
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
44273
|
-
* @version
|
|
44457
|
+
* @version 256.0.0
|
|
44274
44458
|
*/
|
|
44275
44459
|
|
|
44276
44460
|
/**
|
|
@@ -44484,6 +44668,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44484
44668
|
* @param {Array.<String>} opts.ids Comma-separated list of integration IDs to filter by (max 100)
|
|
44485
44669
|
* @param {String} opts.integrationType Filter integrations by integration type ID
|
|
44486
44670
|
* @param {Object} opts.reportedState Filter integrations by reported state (case-insensitive)
|
|
44671
|
+
* @param {String} opts.credentialId Filter integrations by credential ID
|
|
44487
44672
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
44488
44673
|
*/
|
|
44489
44674
|
getIntegrations(opts) {
|
|
@@ -44494,7 +44679,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44494
44679
|
'/api/v2/integrations',
|
|
44495
44680
|
'GET',
|
|
44496
44681
|
{ },
|
|
44497
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'integrationType': opts['integrationType'],'reportedState': opts['reportedState'] },
|
|
44682
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'integrationType': opts['integrationType'],'reportedState': opts['reportedState'],'credentialId': opts['credentialId'] },
|
|
44498
44683
|
{ },
|
|
44499
44684
|
{ },
|
|
44500
44685
|
null,
|
|
@@ -47242,7 +47427,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47242
47427
|
/**
|
|
47243
47428
|
* Intents service.
|
|
47244
47429
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
47245
|
-
* @version
|
|
47430
|
+
* @version 256.0.0
|
|
47246
47431
|
*/
|
|
47247
47432
|
|
|
47248
47433
|
/**
|
|
@@ -47774,7 +47959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47774
47959
|
/**
|
|
47775
47960
|
* Journey service.
|
|
47776
47961
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
47777
|
-
* @version
|
|
47962
|
+
* @version 256.0.0
|
|
47778
47963
|
*/
|
|
47779
47964
|
|
|
47780
47965
|
/**
|
|
@@ -50750,7 +50935,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50750
50935
|
/**
|
|
50751
50936
|
* Knowledge service.
|
|
50752
50937
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
50753
|
-
* @version
|
|
50938
|
+
* @version 256.0.0
|
|
50754
50939
|
*/
|
|
50755
50940
|
|
|
50756
50941
|
/**
|
|
@@ -55001,7 +55186,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55001
55186
|
/**
|
|
55002
55187
|
* LanguageUnderstanding service.
|
|
55003
55188
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
55004
|
-
* @version
|
|
55189
|
+
* @version 256.0.0
|
|
55005
55190
|
*/
|
|
55006
55191
|
|
|
55007
55192
|
/**
|
|
@@ -56375,7 +56560,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56375
56560
|
/**
|
|
56376
56561
|
* Languages service.
|
|
56377
56562
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
56378
|
-
* @version
|
|
56563
|
+
* @version 256.0.0
|
|
56379
56564
|
*/
|
|
56380
56565
|
|
|
56381
56566
|
/**
|
|
@@ -56634,7 +56819,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56634
56819
|
/**
|
|
56635
56820
|
* Learning service.
|
|
56636
56821
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
56637
|
-
* @version
|
|
56822
|
+
* @version 256.0.0
|
|
56638
56823
|
*/
|
|
56639
56824
|
|
|
56640
56825
|
/**
|
|
@@ -57023,7 +57208,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57023
57208
|
* Get all learning modules of an organization
|
|
57024
57209
|
*
|
|
57025
57210
|
* @param {Object} opts Optional parameters
|
|
57026
|
-
* @param {Boolean} opts.isArchived Archive status (default to false)
|
|
57027
57211
|
* @param {Array.<String>} opts.types Specifies the module types. Informational, AssessedContent and Assessment are deprecated
|
|
57028
57212
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
57029
57213
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -57031,7 +57215,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57031
57215
|
* @param {Object} opts.sortBy Sort by (default to name)
|
|
57032
57216
|
* @param {String} opts.searchTerm Search Term (searchable by name)
|
|
57033
57217
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
57034
|
-
* @param {Object} opts.isPublished Specifies if only the Unpublished (isPublished is False) or Published (isPublished is True) modules are returned. If isPublished is Any or omitted, both types are returned (default to Any)
|
|
57035
57218
|
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
57036
57219
|
* @param {Array.<String>} opts.externalIds Specifies the module external IDs to filter by. Only one ID is allowed
|
|
57037
57220
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
@@ -57044,7 +57227,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57044
57227
|
'/api/v2/learning/modules',
|
|
57045
57228
|
'GET',
|
|
57046
57229
|
{ },
|
|
57047
|
-
{ '
|
|
57230
|
+
{ 'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'externalIds': this.apiClient.buildCollectionParam(opts['externalIds'], 'multi') },
|
|
57048
57231
|
{ },
|
|
57049
57232
|
{ },
|
|
57050
57233
|
null,
|
|
@@ -57882,7 +58065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57882
58065
|
/**
|
|
57883
58066
|
* License service.
|
|
57884
58067
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
57885
|
-
* @version
|
|
58068
|
+
* @version 256.0.0
|
|
57886
58069
|
*/
|
|
57887
58070
|
|
|
57888
58071
|
/**
|
|
@@ -58180,7 +58363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58180
58363
|
/**
|
|
58181
58364
|
* Locations service.
|
|
58182
58365
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
58183
|
-
* @version
|
|
58366
|
+
* @version 256.0.0
|
|
58184
58367
|
*/
|
|
58185
58368
|
|
|
58186
58369
|
/**
|
|
@@ -58447,7 +58630,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58447
58630
|
/**
|
|
58448
58631
|
* LogCapture service.
|
|
58449
58632
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
58450
|
-
* @version
|
|
58633
|
+
* @version 256.0.0
|
|
58451
58634
|
*/
|
|
58452
58635
|
|
|
58453
58636
|
/**
|
|
@@ -58669,7 +58852,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58669
58852
|
/**
|
|
58670
58853
|
* Messaging service.
|
|
58671
58854
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
58672
|
-
* @version
|
|
58855
|
+
* @version 256.0.0
|
|
58673
58856
|
*/
|
|
58674
58857
|
|
|
58675
58858
|
/**
|
|
@@ -59087,7 +59270,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59087
59270
|
/**
|
|
59088
59271
|
* MobileDevices service.
|
|
59089
59272
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
59090
|
-
* @version
|
|
59273
|
+
* @version 256.0.0
|
|
59091
59274
|
*/
|
|
59092
59275
|
|
|
59093
59276
|
/**
|
|
@@ -59257,7 +59440,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59257
59440
|
/**
|
|
59258
59441
|
* Notifications service.
|
|
59259
59442
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
59260
|
-
* @version
|
|
59443
|
+
* @version 256.0.0
|
|
59261
59444
|
*/
|
|
59262
59445
|
|
|
59263
59446
|
/**
|
|
@@ -59518,7 +59701,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59518
59701
|
/**
|
|
59519
59702
|
* OAuth service.
|
|
59520
59703
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
59521
|
-
* @version
|
|
59704
|
+
* @version 256.0.0
|
|
59522
59705
|
*/
|
|
59523
59706
|
|
|
59524
59707
|
/**
|
|
@@ -59934,7 +60117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59934
60117
|
/**
|
|
59935
60118
|
* Objects service.
|
|
59936
60119
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
59937
|
-
* @version
|
|
60120
|
+
* @version 256.0.0
|
|
59938
60121
|
*/
|
|
59939
60122
|
|
|
59940
60123
|
/**
|
|
@@ -60298,7 +60481,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60298
60481
|
/**
|
|
60299
60482
|
* OperationalEvents service.
|
|
60300
60483
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
60301
|
-
* @version
|
|
60484
|
+
* @version 256.0.0
|
|
60302
60485
|
*/
|
|
60303
60486
|
|
|
60304
60487
|
/**
|
|
@@ -60429,7 +60612,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60429
60612
|
/**
|
|
60430
60613
|
* Organization service.
|
|
60431
60614
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
60432
|
-
* @version
|
|
60615
|
+
* @version 256.0.0
|
|
60433
60616
|
*/
|
|
60434
60617
|
|
|
60435
60618
|
/**
|
|
@@ -60990,7 +61173,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60990
61173
|
/**
|
|
60991
61174
|
* OrganizationAuthorization service.
|
|
60992
61175
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
60993
|
-
* @version
|
|
61176
|
+
* @version 256.0.0
|
|
60994
61177
|
*/
|
|
60995
61178
|
|
|
60996
61179
|
/**
|
|
@@ -62594,7 +62777,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62594
62777
|
/**
|
|
62595
62778
|
* Outbound service.
|
|
62596
62779
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
62597
|
-
* @version
|
|
62780
|
+
* @version 256.0.0
|
|
62598
62781
|
*/
|
|
62599
62782
|
|
|
62600
62783
|
/**
|
|
@@ -64531,7 +64714,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64531
64714
|
|
|
64532
64715
|
/**
|
|
64533
64716
|
* Query a list of contact lists.
|
|
64534
|
-
*
|
|
64717
|
+
* Any ContactList field can be used as a query parameter to filter results. Multiple values can be specified for a field, and filter type prefixes can be used inline. Example: dateCreated=greaterthan:2025-01-01T00:00:00.000Z&dateCreated=lessthan:2027-01-01T00:00:00.000Z. See https://developer.genesys.cloud/routing/outbound/filter-type for available filter types.
|
|
64535
64718
|
* @param {Object} opts Optional parameters
|
|
64536
64719
|
* @param {Boolean} opts.includeImportStatus Include import status (default to false)
|
|
64537
64720
|
* @param {Boolean} opts.includeSize Include size (default to false)
|
|
@@ -68181,7 +68364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68181
68364
|
/**
|
|
68182
68365
|
* Presence service.
|
|
68183
68366
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
68184
|
-
* @version
|
|
68367
|
+
* @version 256.0.0
|
|
68185
68368
|
*/
|
|
68186
68369
|
|
|
68187
68370
|
/**
|
|
@@ -69039,7 +69222,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69039
69222
|
/**
|
|
69040
69223
|
* ProcessAutomation service.
|
|
69041
69224
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
69042
|
-
* @version
|
|
69225
|
+
* @version 256.0.0
|
|
69043
69226
|
*/
|
|
69044
69227
|
|
|
69045
69228
|
/**
|
|
@@ -69460,7 +69643,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69460
69643
|
/**
|
|
69461
69644
|
* Quality service.
|
|
69462
69645
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
69463
|
-
* @version
|
|
69646
|
+
* @version 256.0.0
|
|
69464
69647
|
*/
|
|
69465
69648
|
|
|
69466
69649
|
/**
|
|
@@ -71810,7 +71993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71810
71993
|
/**
|
|
71811
71994
|
* Recording service.
|
|
71812
71995
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
71813
|
-
* @version
|
|
71996
|
+
* @version 256.0.0
|
|
71814
71997
|
*/
|
|
71815
71998
|
|
|
71816
71999
|
/**
|
|
@@ -73658,7 +73841,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73658
73841
|
/**
|
|
73659
73842
|
* ResponseManagement service.
|
|
73660
73843
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
73661
|
-
* @version
|
|
73844
|
+
* @version 256.0.0
|
|
73662
73845
|
*/
|
|
73663
73846
|
|
|
73664
73847
|
/**
|
|
@@ -74302,7 +74485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74302
74485
|
/**
|
|
74303
74486
|
* Routing service.
|
|
74304
74487
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
74305
|
-
* @version
|
|
74488
|
+
* @version 256.0.0
|
|
74306
74489
|
*/
|
|
74307
74490
|
|
|
74308
74491
|
/**
|
|
@@ -79864,7 +80047,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79864
80047
|
/**
|
|
79865
80048
|
* SCIM service.
|
|
79866
80049
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
79867
|
-
* @version
|
|
80050
|
+
* @version 256.0.0
|
|
79868
80051
|
*/
|
|
79869
80052
|
|
|
79870
80053
|
/**
|
|
@@ -80821,11 +81004,387 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80821
81004
|
|
|
80822
81005
|
}
|
|
80823
81006
|
|
|
81007
|
+
class ScreenMonitoringApi {
|
|
81008
|
+
/**
|
|
81009
|
+
* ScreenMonitoring service.
|
|
81010
|
+
* @module purecloud-platform-client-v2/api/ScreenMonitoringApi
|
|
81011
|
+
* @version 256.0.0
|
|
81012
|
+
*/
|
|
81013
|
+
|
|
81014
|
+
/**
|
|
81015
|
+
* Constructs a new ScreenMonitoringApi.
|
|
81016
|
+
* @alias module:purecloud-platform-client-v2/api/ScreenMonitoringApi
|
|
81017
|
+
* @class
|
|
81018
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
81019
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
81020
|
+
*/
|
|
81021
|
+
constructor(apiClient) {
|
|
81022
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
81023
|
+
}
|
|
81024
|
+
|
|
81025
|
+
|
|
81026
|
+
/**
|
|
81027
|
+
* Stop a conversation-level screen monitoring session.
|
|
81028
|
+
*
|
|
81029
|
+
* @param {String} conversationId Conversation ID
|
|
81030
|
+
* @param {String} participantId Participant ID
|
|
81031
|
+
* @param {String} screenMonitoringId Screen Monitoring ID
|
|
81032
|
+
* @param {Object} opts Optional parameters
|
|
81033
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81034
|
+
*/
|
|
81035
|
+
deleteConversationParticipantScreenmonitorsSession(conversationId, participantId, screenMonitoringId, opts) {
|
|
81036
|
+
opts = opts || {};
|
|
81037
|
+
|
|
81038
|
+
// verify the required parameter 'conversationId' is set
|
|
81039
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
81040
|
+
throw 'Missing the required parameter "conversationId" when calling deleteConversationParticipantScreenmonitorsSession';
|
|
81041
|
+
}
|
|
81042
|
+
// verify the required parameter 'participantId' is set
|
|
81043
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
81044
|
+
throw 'Missing the required parameter "participantId" when calling deleteConversationParticipantScreenmonitorsSession';
|
|
81045
|
+
}
|
|
81046
|
+
// verify the required parameter 'screenMonitoringId' is set
|
|
81047
|
+
if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
|
|
81048
|
+
throw 'Missing the required parameter "screenMonitoringId" when calling deleteConversationParticipantScreenmonitorsSession';
|
|
81049
|
+
}
|
|
81050
|
+
|
|
81051
|
+
return this.apiClient.callApi(
|
|
81052
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions/{screenMonitoringId}',
|
|
81053
|
+
'DELETE',
|
|
81054
|
+
{ 'conversationId': conversationId,'participantId': participantId,'screenMonitoringId': screenMonitoringId },
|
|
81055
|
+
{ },
|
|
81056
|
+
{ },
|
|
81057
|
+
{ },
|
|
81058
|
+
null,
|
|
81059
|
+
['PureCloud OAuth'],
|
|
81060
|
+
['application/json'],
|
|
81061
|
+
['application/json'],
|
|
81062
|
+
opts['customHeaders']
|
|
81063
|
+
);
|
|
81064
|
+
}
|
|
81065
|
+
|
|
81066
|
+
/**
|
|
81067
|
+
* Stop an agent-level screen monitoring session.
|
|
81068
|
+
*
|
|
81069
|
+
* @param {String} userId User ID
|
|
81070
|
+
* @param {String} screenMonitoringId Screen Monitoring ID
|
|
81071
|
+
* @param {Object} opts Optional parameters
|
|
81072
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81073
|
+
*/
|
|
81074
|
+
deleteUserScreenmonitorsSession(userId, screenMonitoringId, opts) {
|
|
81075
|
+
opts = opts || {};
|
|
81076
|
+
|
|
81077
|
+
// verify the required parameter 'userId' is set
|
|
81078
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
81079
|
+
throw 'Missing the required parameter "userId" when calling deleteUserScreenmonitorsSession';
|
|
81080
|
+
}
|
|
81081
|
+
// verify the required parameter 'screenMonitoringId' is set
|
|
81082
|
+
if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
|
|
81083
|
+
throw 'Missing the required parameter "screenMonitoringId" when calling deleteUserScreenmonitorsSession';
|
|
81084
|
+
}
|
|
81085
|
+
|
|
81086
|
+
return this.apiClient.callApi(
|
|
81087
|
+
'/api/v2/users/{userId}/screenmonitors/sessions/{screenMonitoringId}',
|
|
81088
|
+
'DELETE',
|
|
81089
|
+
{ 'userId': userId,'screenMonitoringId': screenMonitoringId },
|
|
81090
|
+
{ },
|
|
81091
|
+
{ },
|
|
81092
|
+
{ },
|
|
81093
|
+
null,
|
|
81094
|
+
['PureCloud OAuth'],
|
|
81095
|
+
['application/json'],
|
|
81096
|
+
['application/json'],
|
|
81097
|
+
opts['customHeaders']
|
|
81098
|
+
);
|
|
81099
|
+
}
|
|
81100
|
+
|
|
81101
|
+
/**
|
|
81102
|
+
* Get a conversation-level screen monitoring session object using the supplied screenMonitoringId.
|
|
81103
|
+
*
|
|
81104
|
+
* @param {String} conversationId Conversation ID
|
|
81105
|
+
* @param {String} participantId Participant ID
|
|
81106
|
+
* @param {String} screenMonitoringId Screen Monitoring ID
|
|
81107
|
+
* @param {Object} opts Optional parameters
|
|
81108
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81109
|
+
*/
|
|
81110
|
+
getConversationParticipantScreenmonitorsSession(conversationId, participantId, screenMonitoringId, opts) {
|
|
81111
|
+
opts = opts || {};
|
|
81112
|
+
|
|
81113
|
+
// verify the required parameter 'conversationId' is set
|
|
81114
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
81115
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationParticipantScreenmonitorsSession';
|
|
81116
|
+
}
|
|
81117
|
+
// verify the required parameter 'participantId' is set
|
|
81118
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
81119
|
+
throw 'Missing the required parameter "participantId" when calling getConversationParticipantScreenmonitorsSession';
|
|
81120
|
+
}
|
|
81121
|
+
// verify the required parameter 'screenMonitoringId' is set
|
|
81122
|
+
if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
|
|
81123
|
+
throw 'Missing the required parameter "screenMonitoringId" when calling getConversationParticipantScreenmonitorsSession';
|
|
81124
|
+
}
|
|
81125
|
+
|
|
81126
|
+
return this.apiClient.callApi(
|
|
81127
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions/{screenMonitoringId}',
|
|
81128
|
+
'GET',
|
|
81129
|
+
{ 'conversationId': conversationId,'participantId': participantId,'screenMonitoringId': screenMonitoringId },
|
|
81130
|
+
{ },
|
|
81131
|
+
{ },
|
|
81132
|
+
{ },
|
|
81133
|
+
null,
|
|
81134
|
+
['PureCloud OAuth'],
|
|
81135
|
+
['application/json'],
|
|
81136
|
+
['application/json'],
|
|
81137
|
+
opts['customHeaders']
|
|
81138
|
+
);
|
|
81139
|
+
}
|
|
81140
|
+
|
|
81141
|
+
/**
|
|
81142
|
+
* Get the details of all screen monitoring sessions for the current organization.
|
|
81143
|
+
*
|
|
81144
|
+
* @param {Object} opts Optional parameters
|
|
81145
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81146
|
+
*/
|
|
81147
|
+
getScreenmonitorsSessionsDetails(opts) {
|
|
81148
|
+
opts = opts || {};
|
|
81149
|
+
|
|
81150
|
+
|
|
81151
|
+
return this.apiClient.callApi(
|
|
81152
|
+
'/api/v2/screenmonitors/sessions/details',
|
|
81153
|
+
'GET',
|
|
81154
|
+
{ },
|
|
81155
|
+
{ },
|
|
81156
|
+
{ },
|
|
81157
|
+
{ },
|
|
81158
|
+
null,
|
|
81159
|
+
['PureCloud OAuth'],
|
|
81160
|
+
['application/json'],
|
|
81161
|
+
['application/json'],
|
|
81162
|
+
opts['customHeaders']
|
|
81163
|
+
);
|
|
81164
|
+
}
|
|
81165
|
+
|
|
81166
|
+
/**
|
|
81167
|
+
* Get the Screen Monitor Settings for the Organization
|
|
81168
|
+
*
|
|
81169
|
+
* @param {Object} opts Optional parameters
|
|
81170
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81171
|
+
*/
|
|
81172
|
+
getScreenmonitorsSettings(opts) {
|
|
81173
|
+
opts = opts || {};
|
|
81174
|
+
|
|
81175
|
+
|
|
81176
|
+
return this.apiClient.callApi(
|
|
81177
|
+
'/api/v2/screenmonitors/settings',
|
|
81178
|
+
'GET',
|
|
81179
|
+
{ },
|
|
81180
|
+
{ },
|
|
81181
|
+
{ },
|
|
81182
|
+
{ },
|
|
81183
|
+
null,
|
|
81184
|
+
['PureCloud OAuth'],
|
|
81185
|
+
['application/json'],
|
|
81186
|
+
['application/json'],
|
|
81187
|
+
opts['customHeaders']
|
|
81188
|
+
);
|
|
81189
|
+
}
|
|
81190
|
+
|
|
81191
|
+
/**
|
|
81192
|
+
* Get all screen monitoring sessions for the supplied userId.
|
|
81193
|
+
*
|
|
81194
|
+
* @param {String} userId User ID
|
|
81195
|
+
* @param {Object} opts Optional parameters
|
|
81196
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81197
|
+
*/
|
|
81198
|
+
getScreenmonitorsUserSessions(userId, opts) {
|
|
81199
|
+
opts = opts || {};
|
|
81200
|
+
|
|
81201
|
+
// verify the required parameter 'userId' is set
|
|
81202
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
81203
|
+
throw 'Missing the required parameter "userId" when calling getScreenmonitorsUserSessions';
|
|
81204
|
+
}
|
|
81205
|
+
|
|
81206
|
+
return this.apiClient.callApi(
|
|
81207
|
+
'/api/v2/screenmonitors/users/{userId}/sessions',
|
|
81208
|
+
'GET',
|
|
81209
|
+
{ 'userId': userId },
|
|
81210
|
+
{ },
|
|
81211
|
+
{ },
|
|
81212
|
+
{ },
|
|
81213
|
+
null,
|
|
81214
|
+
['PureCloud OAuth'],
|
|
81215
|
+
['application/json'],
|
|
81216
|
+
['application/json'],
|
|
81217
|
+
opts['customHeaders']
|
|
81218
|
+
);
|
|
81219
|
+
}
|
|
81220
|
+
|
|
81221
|
+
/**
|
|
81222
|
+
* Get an agent-level screen monitoring session object using the supplied screenMonitoringId.
|
|
81223
|
+
*
|
|
81224
|
+
* @param {String} userId User ID
|
|
81225
|
+
* @param {String} screenMonitoringId Screen Monitoring ID
|
|
81226
|
+
* @param {Object} opts Optional parameters
|
|
81227
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81228
|
+
*/
|
|
81229
|
+
getUserScreenmonitorsSession(userId, screenMonitoringId, opts) {
|
|
81230
|
+
opts = opts || {};
|
|
81231
|
+
|
|
81232
|
+
// verify the required parameter 'userId' is set
|
|
81233
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
81234
|
+
throw 'Missing the required parameter "userId" when calling getUserScreenmonitorsSession';
|
|
81235
|
+
}
|
|
81236
|
+
// verify the required parameter 'screenMonitoringId' is set
|
|
81237
|
+
if (screenMonitoringId === undefined || screenMonitoringId === null || screenMonitoringId === '') {
|
|
81238
|
+
throw 'Missing the required parameter "screenMonitoringId" when calling getUserScreenmonitorsSession';
|
|
81239
|
+
}
|
|
81240
|
+
|
|
81241
|
+
return this.apiClient.callApi(
|
|
81242
|
+
'/api/v2/users/{userId}/screenmonitors/sessions/{screenMonitoringId}',
|
|
81243
|
+
'GET',
|
|
81244
|
+
{ 'userId': userId,'screenMonitoringId': screenMonitoringId },
|
|
81245
|
+
{ },
|
|
81246
|
+
{ },
|
|
81247
|
+
{ },
|
|
81248
|
+
null,
|
|
81249
|
+
['PureCloud OAuth'],
|
|
81250
|
+
['application/json'],
|
|
81251
|
+
['application/json'],
|
|
81252
|
+
opts['customHeaders']
|
|
81253
|
+
);
|
|
81254
|
+
}
|
|
81255
|
+
|
|
81256
|
+
/**
|
|
81257
|
+
* Start a conversation-level screen monitoring session.
|
|
81258
|
+
*
|
|
81259
|
+
* @param {String} conversationId Conversation ID
|
|
81260
|
+
* @param {String} participantId Participant ID
|
|
81261
|
+
* @param {Object} opts Optional parameters
|
|
81262
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81263
|
+
*/
|
|
81264
|
+
postConversationParticipantScreenmonitorsSessions(conversationId, participantId, opts) {
|
|
81265
|
+
opts = opts || {};
|
|
81266
|
+
|
|
81267
|
+
// verify the required parameter 'conversationId' is set
|
|
81268
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
81269
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationParticipantScreenmonitorsSessions';
|
|
81270
|
+
}
|
|
81271
|
+
// verify the required parameter 'participantId' is set
|
|
81272
|
+
if (participantId === undefined || participantId === null || participantId === '') {
|
|
81273
|
+
throw 'Missing the required parameter "participantId" when calling postConversationParticipantScreenmonitorsSessions';
|
|
81274
|
+
}
|
|
81275
|
+
|
|
81276
|
+
return this.apiClient.callApi(
|
|
81277
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions',
|
|
81278
|
+
'POST',
|
|
81279
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
81280
|
+
{ },
|
|
81281
|
+
{ },
|
|
81282
|
+
{ },
|
|
81283
|
+
null,
|
|
81284
|
+
['PureCloud OAuth'],
|
|
81285
|
+
['application/json'],
|
|
81286
|
+
['application/json'],
|
|
81287
|
+
opts['customHeaders']
|
|
81288
|
+
);
|
|
81289
|
+
}
|
|
81290
|
+
|
|
81291
|
+
/**
|
|
81292
|
+
* Get screen monitor session details for one or more users.
|
|
81293
|
+
*
|
|
81294
|
+
* @param {Array.<String>} body List of target user IDs
|
|
81295
|
+
* @param {Object} opts Optional parameters
|
|
81296
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81297
|
+
*/
|
|
81298
|
+
postScreenmonitorsSessionsUsersDetails(body, opts) {
|
|
81299
|
+
opts = opts || {};
|
|
81300
|
+
|
|
81301
|
+
// verify the required parameter 'body' is set
|
|
81302
|
+
if (body === undefined || body === null) {
|
|
81303
|
+
throw 'Missing the required parameter "body" when calling postScreenmonitorsSessionsUsersDetails';
|
|
81304
|
+
}
|
|
81305
|
+
|
|
81306
|
+
return this.apiClient.callApi(
|
|
81307
|
+
'/api/v2/screenmonitors/sessions/users/details',
|
|
81308
|
+
'POST',
|
|
81309
|
+
{ },
|
|
81310
|
+
{ },
|
|
81311
|
+
{ },
|
|
81312
|
+
{ },
|
|
81313
|
+
body,
|
|
81314
|
+
['PureCloud OAuth'],
|
|
81315
|
+
['application/json'],
|
|
81316
|
+
['application/json'],
|
|
81317
|
+
opts['customHeaders']
|
|
81318
|
+
);
|
|
81319
|
+
}
|
|
81320
|
+
|
|
81321
|
+
/**
|
|
81322
|
+
* Start an agent-level screen monitoring session.
|
|
81323
|
+
*
|
|
81324
|
+
* @param {String} userId User ID
|
|
81325
|
+
* @param {Object} opts Optional parameters
|
|
81326
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81327
|
+
*/
|
|
81328
|
+
postUserScreenmonitorsSessions(userId, opts) {
|
|
81329
|
+
opts = opts || {};
|
|
81330
|
+
|
|
81331
|
+
// verify the required parameter 'userId' is set
|
|
81332
|
+
if (userId === undefined || userId === null || userId === '') {
|
|
81333
|
+
throw 'Missing the required parameter "userId" when calling postUserScreenmonitorsSessions';
|
|
81334
|
+
}
|
|
81335
|
+
|
|
81336
|
+
return this.apiClient.callApi(
|
|
81337
|
+
'/api/v2/users/{userId}/screenmonitors/sessions',
|
|
81338
|
+
'POST',
|
|
81339
|
+
{ 'userId': userId },
|
|
81340
|
+
{ },
|
|
81341
|
+
{ },
|
|
81342
|
+
{ },
|
|
81343
|
+
null,
|
|
81344
|
+
['PureCloud OAuth'],
|
|
81345
|
+
['application/json'],
|
|
81346
|
+
['application/json'],
|
|
81347
|
+
opts['customHeaders']
|
|
81348
|
+
);
|
|
81349
|
+
}
|
|
81350
|
+
|
|
81351
|
+
/**
|
|
81352
|
+
* Update the Screen Monitor Settings for the Organization
|
|
81353
|
+
*
|
|
81354
|
+
* @param {Object} body Screen Monitor settings
|
|
81355
|
+
* @param {Object} opts Optional parameters
|
|
81356
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
81357
|
+
*/
|
|
81358
|
+
putScreenmonitorsSettings(body, opts) {
|
|
81359
|
+
opts = opts || {};
|
|
81360
|
+
|
|
81361
|
+
// verify the required parameter 'body' is set
|
|
81362
|
+
if (body === undefined || body === null) {
|
|
81363
|
+
throw 'Missing the required parameter "body" when calling putScreenmonitorsSettings';
|
|
81364
|
+
}
|
|
81365
|
+
|
|
81366
|
+
return this.apiClient.callApi(
|
|
81367
|
+
'/api/v2/screenmonitors/settings',
|
|
81368
|
+
'PUT',
|
|
81369
|
+
{ },
|
|
81370
|
+
{ },
|
|
81371
|
+
{ },
|
|
81372
|
+
{ },
|
|
81373
|
+
body,
|
|
81374
|
+
['PureCloud OAuth'],
|
|
81375
|
+
['application/json'],
|
|
81376
|
+
['application/json'],
|
|
81377
|
+
opts['customHeaders']
|
|
81378
|
+
);
|
|
81379
|
+
}
|
|
81380
|
+
|
|
81381
|
+
}
|
|
81382
|
+
|
|
80824
81383
|
class ScriptsApi {
|
|
80825
81384
|
/**
|
|
80826
81385
|
* Scripts service.
|
|
80827
81386
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
80828
|
-
* @version
|
|
81387
|
+
* @version 256.0.0
|
|
80829
81388
|
*/
|
|
80830
81389
|
|
|
80831
81390
|
/**
|
|
@@ -81334,7 +81893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81334
81893
|
/**
|
|
81335
81894
|
* Search service.
|
|
81336
81895
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
81337
|
-
* @version
|
|
81896
|
+
* @version 256.0.0
|
|
81338
81897
|
*/
|
|
81339
81898
|
|
|
81340
81899
|
/**
|
|
@@ -82150,7 +82709,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82150
82709
|
/**
|
|
82151
82710
|
* Settings service.
|
|
82152
82711
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
82153
|
-
* @version
|
|
82712
|
+
* @version 256.0.0
|
|
82154
82713
|
*/
|
|
82155
82714
|
|
|
82156
82715
|
/**
|
|
@@ -82559,7 +83118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82559
83118
|
/**
|
|
82560
83119
|
* SocialMedia service.
|
|
82561
83120
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
82562
|
-
* @version
|
|
83121
|
+
* @version 256.0.0
|
|
82563
83122
|
*/
|
|
82564
83123
|
|
|
82565
83124
|
/**
|
|
@@ -84544,7 +85103,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84544
85103
|
/**
|
|
84545
85104
|
* SpeechTextAnalytics service.
|
|
84546
85105
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
84547
|
-
* @version
|
|
85106
|
+
* @version 256.0.0
|
|
84548
85107
|
*/
|
|
84549
85108
|
|
|
84550
85109
|
/**
|
|
@@ -86496,7 +87055,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86496
87055
|
/**
|
|
86497
87056
|
* Stations service.
|
|
86498
87057
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
86499
|
-
* @version
|
|
87058
|
+
* @version 256.0.0
|
|
86500
87059
|
*/
|
|
86501
87060
|
|
|
86502
87061
|
/**
|
|
@@ -86610,7 +87169,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86610
87169
|
/**
|
|
86611
87170
|
* Suggest service.
|
|
86612
87171
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
86613
|
-
* @version
|
|
87172
|
+
* @version 256.0.0
|
|
86614
87173
|
*/
|
|
86615
87174
|
|
|
86616
87175
|
/**
|
|
@@ -86757,7 +87316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86757
87316
|
/**
|
|
86758
87317
|
* TaskManagement service.
|
|
86759
87318
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
86760
|
-
* @version
|
|
87319
|
+
* @version 256.0.0
|
|
86761
87320
|
*/
|
|
86762
87321
|
|
|
86763
87322
|
/**
|
|
@@ -89253,7 +89812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
89253
89812
|
/**
|
|
89254
89813
|
* Teams service.
|
|
89255
89814
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
89256
|
-
* @version
|
|
89815
|
+
* @version 256.0.0
|
|
89257
89816
|
*/
|
|
89258
89817
|
|
|
89259
89818
|
/**
|
|
@@ -89596,7 +90155,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
89596
90155
|
/**
|
|
89597
90156
|
* Telephony service.
|
|
89598
90157
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
89599
|
-
* @version
|
|
90158
|
+
* @version 256.0.0
|
|
89600
90159
|
*/
|
|
89601
90160
|
|
|
89602
90161
|
/**
|
|
@@ -90270,7 +90829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
90270
90829
|
/**
|
|
90271
90830
|
* TelephonyProvidersEdge service.
|
|
90272
90831
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
90273
|
-
* @version
|
|
90832
|
+
* @version 256.0.0
|
|
90274
90833
|
*/
|
|
90275
90834
|
|
|
90276
90835
|
/**
|
|
@@ -94248,7 +94807,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94248
94807
|
/**
|
|
94249
94808
|
* Textbots service.
|
|
94250
94809
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
94251
|
-
* @version
|
|
94810
|
+
* @version 256.0.0
|
|
94252
94811
|
*/
|
|
94253
94812
|
|
|
94254
94813
|
/**
|
|
@@ -94394,7 +94953,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94394
94953
|
/**
|
|
94395
94954
|
* Tokens service.
|
|
94396
94955
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
94397
|
-
* @version
|
|
94956
|
+
* @version 256.0.0
|
|
94398
94957
|
*/
|
|
94399
94958
|
|
|
94400
94959
|
/**
|
|
@@ -94572,7 +95131,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94572
95131
|
/**
|
|
94573
95132
|
* Uploads service.
|
|
94574
95133
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
94575
|
-
* @version
|
|
95134
|
+
* @version 256.0.0
|
|
94576
95135
|
*/
|
|
94577
95136
|
|
|
94578
95137
|
/**
|
|
@@ -94943,7 +95502,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94943
95502
|
/**
|
|
94944
95503
|
* Usage service.
|
|
94945
95504
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
94946
|
-
* @version
|
|
95505
|
+
* @version 256.0.0
|
|
94947
95506
|
*/
|
|
94948
95507
|
|
|
94949
95508
|
/**
|
|
@@ -95321,7 +95880,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95321
95880
|
/**
|
|
95322
95881
|
* UserRecordings service.
|
|
95323
95882
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
95324
|
-
* @version
|
|
95883
|
+
* @version 256.0.0
|
|
95325
95884
|
*/
|
|
95326
95885
|
|
|
95327
95886
|
/**
|
|
@@ -95523,7 +96082,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95523
96082
|
/**
|
|
95524
96083
|
* Users service.
|
|
95525
96084
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
95526
|
-
* @version
|
|
96085
|
+
* @version 256.0.0
|
|
95527
96086
|
*/
|
|
95528
96087
|
|
|
95529
96088
|
/**
|
|
@@ -99538,7 +100097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99538
100097
|
/**
|
|
99539
100098
|
* UsersRules service.
|
|
99540
100099
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
99541
|
-
* @version
|
|
100100
|
+
* @version 256.0.0
|
|
99542
100101
|
*/
|
|
99543
100102
|
|
|
99544
100103
|
/**
|
|
@@ -99855,7 +100414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99855
100414
|
/**
|
|
99856
100415
|
* Utilities service.
|
|
99857
100416
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
99858
|
-
* @version
|
|
100417
|
+
* @version 256.0.0
|
|
99859
100418
|
*/
|
|
99860
100419
|
|
|
99861
100420
|
/**
|
|
@@ -99983,7 +100542,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99983
100542
|
/**
|
|
99984
100543
|
* Voicemail service.
|
|
99985
100544
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
99986
|
-
* @version
|
|
100545
|
+
* @version 256.0.0
|
|
99987
100546
|
*/
|
|
99988
100547
|
|
|
99989
100548
|
/**
|
|
@@ -100813,7 +101372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100813
101372
|
/**
|
|
100814
101373
|
* WebChat service.
|
|
100815
101374
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
100816
|
-
* @version
|
|
101375
|
+
* @version 256.0.0
|
|
100817
101376
|
*/
|
|
100818
101377
|
|
|
100819
101378
|
/**
|
|
@@ -101465,7 +102024,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101465
102024
|
/**
|
|
101466
102025
|
* WebDeployments service.
|
|
101467
102026
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
101468
|
-
* @version
|
|
102027
|
+
* @version 256.0.0
|
|
101469
102028
|
*/
|
|
101470
102029
|
|
|
101471
102030
|
/**
|
|
@@ -102143,7 +102702,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
102143
102702
|
/**
|
|
102144
102703
|
* WebMessaging service.
|
|
102145
102704
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
102146
|
-
* @version
|
|
102705
|
+
* @version 256.0.0
|
|
102147
102706
|
*/
|
|
102148
102707
|
|
|
102149
102708
|
/**
|
|
@@ -102306,7 +102865,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
102306
102865
|
/**
|
|
102307
102866
|
* Widgets service.
|
|
102308
102867
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
102309
|
-
* @version
|
|
102868
|
+
* @version 256.0.0
|
|
102310
102869
|
*/
|
|
102311
102870
|
|
|
102312
102871
|
/**
|
|
@@ -102482,7 +103041,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
102482
103041
|
/**
|
|
102483
103042
|
* WorkforceManagement service.
|
|
102484
103043
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
102485
|
-
* @version
|
|
103044
|
+
* @version 256.0.0
|
|
102486
103045
|
*/
|
|
102487
103046
|
|
|
102488
103047
|
/**
|
|
@@ -104073,6 +104632,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
104073
104632
|
);
|
|
104074
104633
|
}
|
|
104075
104634
|
|
|
104635
|
+
/**
|
|
104636
|
+
* Get a capacity plan's forecast inputs
|
|
104637
|
+
*
|
|
104638
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
104639
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
104640
|
+
* @param {Object} opts Optional parameters
|
|
104641
|
+
* @param {Object} opts.granularity Granularity to access capacity plan forecast data, defaults to weekly
|
|
104642
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
104643
|
+
*/
|
|
104644
|
+
getWorkforcemanagementBusinessunitCapacityplanForecast(businessUnitId, capacityPlanId, opts) {
|
|
104645
|
+
opts = opts || {};
|
|
104646
|
+
|
|
104647
|
+
// verify the required parameter 'businessUnitId' is set
|
|
104648
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
104649
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanForecast';
|
|
104650
|
+
}
|
|
104651
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
104652
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
104653
|
+
throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplanForecast';
|
|
104654
|
+
}
|
|
104655
|
+
|
|
104656
|
+
return this.apiClient.callApi(
|
|
104657
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/forecast',
|
|
104658
|
+
'GET',
|
|
104659
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
104660
|
+
{ 'granularity': opts['granularity'] },
|
|
104661
|
+
{ },
|
|
104662
|
+
{ },
|
|
104663
|
+
null,
|
|
104664
|
+
['PureCloud OAuth'],
|
|
104665
|
+
['application/json'],
|
|
104666
|
+
['application/json'],
|
|
104667
|
+
opts['customHeaders']
|
|
104668
|
+
);
|
|
104669
|
+
}
|
|
104670
|
+
|
|
104076
104671
|
/**
|
|
104077
104672
|
* Get a capacity plan's staffing group allocations
|
|
104078
104673
|
*
|
|
@@ -113913,7 +114508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
113913
114508
|
* </pre>
|
|
113914
114509
|
* </p>
|
|
113915
114510
|
* @module purecloud-platform-client-v2/index
|
|
113916
|
-
* @version
|
|
114511
|
+
* @version 256.0.0
|
|
113917
114512
|
*/
|
|
113918
114513
|
class platformClient {
|
|
113919
114514
|
constructor() {
|
|
@@ -114232,6 +114827,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
114232
114827
|
* @property {module:purecloud-platform-client-v2/api/SCIMApi}
|
|
114233
114828
|
*/
|
|
114234
114829
|
this.SCIMApi = SCIMApi;
|
|
114830
|
+
/**
|
|
114831
|
+
* The ScreenMonitoringApi service constructor.
|
|
114832
|
+
* @property {module:purecloud-platform-client-v2/api/ScreenMonitoringApi}
|
|
114833
|
+
*/
|
|
114834
|
+
this.ScreenMonitoringApi = ScreenMonitoringApi;
|
|
114235
114835
|
/**
|
|
114236
114836
|
* The ScriptsApi service constructor.
|
|
114237
114837
|
* @property {module:purecloud-platform-client-v2/api/ScriptsApi}
|