purecloud-platform-client-v2 231.0.0 → 233.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 +22 -3
- package/dist/node/purecloud-platform-client-v2.js +378 -111
- package/dist/web-amd/purecloud-platform-client-v2.js +378 -111
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +183 -112
- package/dist/web-cjs/purecloud-platform-client-v2.js +183 -112
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1090 -522
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +31 -6
- 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 +25 -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 +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/BusinessRulesApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +173 -4
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +11 -5
- 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 +5 -2
- 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 +7 -3
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
- 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 +6 -4
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +3 -2
- 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 +3 -3
- 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/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +7 -4
- 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 +31 -1
- package/src/purecloud-platform-client-v2/index.js +1 -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 233.0.0
|
|
749
749
|
*/
|
|
750
750
|
class ApiClient {
|
|
751
751
|
/**
|
|
@@ -811,6 +811,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
811
811
|
MULTI: 'multi'
|
|
812
812
|
};
|
|
813
813
|
|
|
814
|
+
this.useLegacyParameterFilter = true;
|
|
815
|
+
|
|
814
816
|
/**
|
|
815
817
|
* @description Value is `true` if local storage exists. Otherwise, false.
|
|
816
818
|
*/
|
|
@@ -1929,12 +1931,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1929
1931
|
return Object.keys(query).reduce((url, key) => !query[key] ? url : `${url}&${key}=${query[key]}`, `${loginBasePath}/${path}?`);
|
|
1930
1932
|
}
|
|
1931
1933
|
|
|
1934
|
+
/**
|
|
1935
|
+
* @description If set to `true`, the ApiClient will continue to use its legacy approach for filtering method parameters (mapped to an API Endpoint's query parameter). This is option is meant to facilitate transition from legacy to current and accurate parameters filtering.
|
|
1936
|
+
* @param {boolean} useLegacyParameterFilter - `false` to use modern/accurate approach (default value), `true` to use legacy approach (i.e. parameters of boolean type and equal to false are ignored/filtered, parameters of type integer/number and equal to 0 are ignored/filtered)
|
|
1937
|
+
*/
|
|
1938
|
+
setUseLegacyParameterFilter(useLegacyParameterFilter) {
|
|
1939
|
+
this.useLegacyParameterFilter = useLegacyParameterFilter;
|
|
1940
|
+
}
|
|
1941
|
+
|
|
1942
|
+
getUseLegacyParameterFilter() {
|
|
1943
|
+
return this.useLegacyParameterFilter;
|
|
1944
|
+
}
|
|
1945
|
+
|
|
1932
1946
|
/**
|
|
1933
1947
|
* Returns a string representation for an actual parameter.
|
|
1934
1948
|
* @param param The actual parameter.
|
|
1935
1949
|
* @returns {String} The string representation of <code>param</code>.
|
|
1936
1950
|
*/
|
|
1937
1951
|
paramToString(param) {
|
|
1952
|
+
if (this.useLegacyParameterFilter !== true) {
|
|
1953
|
+
if (param !== null && param !== undefined) {
|
|
1954
|
+
if (typeof param === "boolean") {
|
|
1955
|
+
return param.toString().toLowerCase();
|
|
1956
|
+
} else if (param instanceof Boolean) {
|
|
1957
|
+
return param.toString().toLowerCase();
|
|
1958
|
+
} else if (typeof param === "number") {
|
|
1959
|
+
return param.toString();
|
|
1960
|
+
}
|
|
1961
|
+
}
|
|
1962
|
+
}
|
|
1938
1963
|
if (!param) {
|
|
1939
1964
|
return '';
|
|
1940
1965
|
}
|
|
@@ -2098,16 +2123,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2098
2123
|
|
|
2099
2124
|
switch (collectionFormat) {
|
|
2100
2125
|
case 'csv':
|
|
2101
|
-
return param.map(this.paramToString).join(',');
|
|
2126
|
+
return param.map((x) => this.paramToString(x)).join(',');
|
|
2102
2127
|
case 'ssv':
|
|
2103
|
-
return param.map(this.paramToString).join(' ');
|
|
2128
|
+
return param.map((x) => this.paramToString(x)).join(' ');
|
|
2104
2129
|
case 'tsv':
|
|
2105
|
-
return param.map(this.paramToString).join('\t');
|
|
2130
|
+
return param.map((x) => this.paramToString(x)).join('\t');
|
|
2106
2131
|
case 'pipes':
|
|
2107
|
-
return param.map(this.paramToString).join('|');
|
|
2132
|
+
return param.map((x) => this.paramToString(x)).join('|');
|
|
2108
2133
|
case 'multi':
|
|
2109
2134
|
// return the array directly as axios will handle it as expected
|
|
2110
|
-
return param.map(this.paramToString);
|
|
2135
|
+
return param.map((x) => this.paramToString(x));
|
|
2111
2136
|
default:
|
|
2112
2137
|
throw new Error(`Unknown collection format: ${collectionFormat}`);
|
|
2113
2138
|
}
|
|
@@ -2289,7 +2314,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2289
2314
|
/**
|
|
2290
2315
|
* AIStudio service.
|
|
2291
2316
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2292
|
-
* @version
|
|
2317
|
+
* @version 233.0.0
|
|
2293
2318
|
*/
|
|
2294
2319
|
|
|
2295
2320
|
/**
|
|
@@ -2861,7 +2886,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2861
2886
|
/**
|
|
2862
2887
|
* AgentAssistants service.
|
|
2863
2888
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2864
|
-
* @version
|
|
2889
|
+
* @version 233.0.0
|
|
2865
2890
|
*/
|
|
2866
2891
|
|
|
2867
2892
|
/**
|
|
@@ -3347,7 +3372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3347
3372
|
/**
|
|
3348
3373
|
* AgentCopilot service.
|
|
3349
3374
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3350
|
-
* @version
|
|
3375
|
+
* @version 233.0.0
|
|
3351
3376
|
*/
|
|
3352
3377
|
|
|
3353
3378
|
/**
|
|
@@ -3387,6 +3412,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3387
3412
|
);
|
|
3388
3413
|
}
|
|
3389
3414
|
|
|
3415
|
+
/**
|
|
3416
|
+
* Get information about the support of features for all the languages or only for a certain language.
|
|
3417
|
+
*
|
|
3418
|
+
* @param {Object} opts Optional parameters
|
|
3419
|
+
* @param {String} opts.language Which language are the features supported for
|
|
3420
|
+
*/
|
|
3421
|
+
getAssistantsCopilotFeaturesupport(opts) {
|
|
3422
|
+
opts = opts || {};
|
|
3423
|
+
|
|
3424
|
+
|
|
3425
|
+
return this.apiClient.callApi(
|
|
3426
|
+
'/api/v2/assistants/copilot/featuresupport',
|
|
3427
|
+
'GET',
|
|
3428
|
+
{ },
|
|
3429
|
+
{ 'language': opts['language'] },
|
|
3430
|
+
{ },
|
|
3431
|
+
{ },
|
|
3432
|
+
null,
|
|
3433
|
+
['PureCloud OAuth'],
|
|
3434
|
+
['application/json'],
|
|
3435
|
+
['application/json']
|
|
3436
|
+
);
|
|
3437
|
+
}
|
|
3438
|
+
|
|
3390
3439
|
/**
|
|
3391
3440
|
* Update agent copilot configuration
|
|
3392
3441
|
*
|
|
@@ -3423,7 +3472,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3423
3472
|
/**
|
|
3424
3473
|
* AgentUI service.
|
|
3425
3474
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3426
|
-
* @version
|
|
3475
|
+
* @version 233.0.0
|
|
3427
3476
|
*/
|
|
3428
3477
|
|
|
3429
3478
|
/**
|
|
@@ -3554,7 +3603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3554
3603
|
/**
|
|
3555
3604
|
* Alerting service.
|
|
3556
3605
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3557
|
-
* @version
|
|
3606
|
+
* @version 233.0.0
|
|
3558
3607
|
*/
|
|
3559
3608
|
|
|
3560
3609
|
/**
|
|
@@ -3955,7 +4004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3955
4004
|
/**
|
|
3956
4005
|
* Analytics service.
|
|
3957
4006
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3958
|
-
* @version
|
|
4007
|
+
* @version 233.0.0
|
|
3959
4008
|
*/
|
|
3960
4009
|
|
|
3961
4010
|
/**
|
|
@@ -7223,7 +7272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7223
7272
|
/**
|
|
7224
7273
|
* Architect service.
|
|
7225
7274
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7226
|
-
* @version
|
|
7275
|
+
* @version 233.0.0
|
|
7227
7276
|
*/
|
|
7228
7277
|
|
|
7229
7278
|
/**
|
|
@@ -11518,7 +11567,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11518
11567
|
/**
|
|
11519
11568
|
* Audit service.
|
|
11520
11569
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11521
|
-
* @version
|
|
11570
|
+
* @version 233.0.0
|
|
11522
11571
|
*/
|
|
11523
11572
|
|
|
11524
11573
|
/**
|
|
@@ -11719,7 +11768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11719
11768
|
/**
|
|
11720
11769
|
* Authorization service.
|
|
11721
11770
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11722
|
-
* @version
|
|
11771
|
+
* @version 233.0.0
|
|
11723
11772
|
*/
|
|
11724
11773
|
|
|
11725
11774
|
/**
|
|
@@ -13434,7 +13483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13434
13483
|
/**
|
|
13435
13484
|
* Billing service.
|
|
13436
13485
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13437
|
-
* @version
|
|
13486
|
+
* @version 233.0.0
|
|
13438
13487
|
*/
|
|
13439
13488
|
|
|
13440
13489
|
/**
|
|
@@ -13690,7 +13739,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13690
13739
|
/**
|
|
13691
13740
|
* BusinessRules service.
|
|
13692
13741
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13693
|
-
* @version
|
|
13742
|
+
* @version 233.0.0
|
|
13694
13743
|
*/
|
|
13695
13744
|
|
|
13696
13745
|
/**
|
|
@@ -14474,7 +14523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14474
14523
|
/**
|
|
14475
14524
|
* Create a schema
|
|
14476
14525
|
*
|
|
14477
|
-
* @param {Object} body Schema
|
|
14526
|
+
* @param {Object} body Business Rules Schema Create Request
|
|
14478
14527
|
* postBusinessrulesSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14479
14528
|
*/
|
|
14480
14529
|
postBusinessrulesSchemas(body) {
|
|
@@ -14573,7 +14622,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14573
14622
|
* Update a schema
|
|
14574
14623
|
*
|
|
14575
14624
|
* @param {String} schemaId Schema ID
|
|
14576
|
-
* @param {Object} body
|
|
14625
|
+
* @param {Object} body Business Rules Schema Update Request
|
|
14577
14626
|
* putBusinessrulesSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14578
14627
|
*/
|
|
14579
14628
|
putBusinessrulesSchema(schemaId, body) {
|
|
@@ -14606,7 +14655,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14606
14655
|
/**
|
|
14607
14656
|
* CarrierServices service.
|
|
14608
14657
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14609
|
-
* @version
|
|
14658
|
+
* @version 233.0.0
|
|
14610
14659
|
*/
|
|
14611
14660
|
|
|
14612
14661
|
/**
|
|
@@ -14676,7 +14725,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14676
14725
|
/**
|
|
14677
14726
|
* Chat service.
|
|
14678
14727
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14679
|
-
* @version
|
|
14728
|
+
* @version 233.0.0
|
|
14680
14729
|
*/
|
|
14681
14730
|
|
|
14682
14731
|
/**
|
|
@@ -15657,7 +15706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15657
15706
|
/**
|
|
15658
15707
|
* Coaching service.
|
|
15659
15708
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15660
|
-
* @version
|
|
15709
|
+
* @version 233.0.0
|
|
15661
15710
|
*/
|
|
15662
15711
|
|
|
15663
15712
|
/**
|
|
@@ -16234,7 +16283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16234
16283
|
/**
|
|
16235
16284
|
* ContentManagement service.
|
|
16236
16285
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
16237
|
-
* @version
|
|
16286
|
+
* @version 233.0.0
|
|
16238
16287
|
*/
|
|
16239
16288
|
|
|
16240
16289
|
/**
|
|
@@ -17315,7 +17364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17315
17364
|
/**
|
|
17316
17365
|
* Conversations service.
|
|
17317
17366
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
17318
|
-
* @version
|
|
17367
|
+
* @version 233.0.0
|
|
17319
17368
|
*/
|
|
17320
17369
|
|
|
17321
17370
|
/**
|
|
@@ -17556,6 +17605,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17556
17605
|
);
|
|
17557
17606
|
}
|
|
17558
17607
|
|
|
17608
|
+
/**
|
|
17609
|
+
* Delete an Apple messaging integration
|
|
17610
|
+
*
|
|
17611
|
+
* @param {String} integrationId Integration ID
|
|
17612
|
+
*/
|
|
17613
|
+
deleteConversationsMessagingIntegrationsAppleIntegrationId(integrationId) {
|
|
17614
|
+
// verify the required parameter 'integrationId' is set
|
|
17615
|
+
if (integrationId === undefined || integrationId === null || integrationId === '') {
|
|
17616
|
+
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsAppleIntegrationId';
|
|
17617
|
+
}
|
|
17618
|
+
|
|
17619
|
+
return this.apiClient.callApi(
|
|
17620
|
+
'/api/v2/conversations/messaging/integrations/apple/{integrationId}',
|
|
17621
|
+
'DELETE',
|
|
17622
|
+
{ 'integrationId': integrationId },
|
|
17623
|
+
{ },
|
|
17624
|
+
{ },
|
|
17625
|
+
{ },
|
|
17626
|
+
null,
|
|
17627
|
+
['PureCloud OAuth'],
|
|
17628
|
+
['application/json'],
|
|
17629
|
+
['application/json']
|
|
17630
|
+
);
|
|
17631
|
+
}
|
|
17632
|
+
|
|
17559
17633
|
/**
|
|
17560
17634
|
* Delete a Facebook messaging integration
|
|
17561
17635
|
*
|
|
@@ -19691,7 +19765,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19691
19765
|
* Get Apple messaging integration identity resolution settings
|
|
19692
19766
|
*
|
|
19693
19767
|
* @param {String} integrationId Integration ID
|
|
19694
|
-
* getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19695
19768
|
*/
|
|
19696
19769
|
getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId) {
|
|
19697
19770
|
// verify the required parameter 'integrationId' is set
|
|
@@ -19891,6 +19964,63 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19891
19964
|
);
|
|
19892
19965
|
}
|
|
19893
19966
|
|
|
19967
|
+
/**
|
|
19968
|
+
* Get a list of Apple Integrations
|
|
19969
|
+
*
|
|
19970
|
+
* @param {Object} opts Optional parameters
|
|
19971
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
19972
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19973
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
19974
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
19975
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
19976
|
+
*/
|
|
19977
|
+
getConversationsMessagingIntegrationsApple(opts) {
|
|
19978
|
+
opts = opts || {};
|
|
19979
|
+
|
|
19980
|
+
|
|
19981
|
+
return this.apiClient.callApi(
|
|
19982
|
+
'/api/v2/conversations/messaging/integrations/apple',
|
|
19983
|
+
'GET',
|
|
19984
|
+
{ },
|
|
19985
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
19986
|
+
{ },
|
|
19987
|
+
{ },
|
|
19988
|
+
null,
|
|
19989
|
+
['PureCloud OAuth'],
|
|
19990
|
+
['application/json'],
|
|
19991
|
+
['application/json']
|
|
19992
|
+
);
|
|
19993
|
+
}
|
|
19994
|
+
|
|
19995
|
+
/**
|
|
19996
|
+
* Get an Apple messaging integration
|
|
19997
|
+
*
|
|
19998
|
+
* @param {String} integrationId Integration ID
|
|
19999
|
+
* @param {Object} opts Optional parameters
|
|
20000
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
20001
|
+
*/
|
|
20002
|
+
getConversationsMessagingIntegrationsAppleIntegrationId(integrationId, opts) {
|
|
20003
|
+
opts = opts || {};
|
|
20004
|
+
|
|
20005
|
+
// verify the required parameter 'integrationId' is set
|
|
20006
|
+
if (integrationId === undefined || integrationId === null || integrationId === '') {
|
|
20007
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsAppleIntegrationId';
|
|
20008
|
+
}
|
|
20009
|
+
|
|
20010
|
+
return this.apiClient.callApi(
|
|
20011
|
+
'/api/v2/conversations/messaging/integrations/apple/{integrationId}',
|
|
20012
|
+
'GET',
|
|
20013
|
+
{ 'integrationId': integrationId },
|
|
20014
|
+
{ 'expand': opts['expand'] },
|
|
20015
|
+
{ },
|
|
20016
|
+
{ },
|
|
20017
|
+
null,
|
|
20018
|
+
['PureCloud OAuth'],
|
|
20019
|
+
['application/json'],
|
|
20020
|
+
['application/json']
|
|
20021
|
+
);
|
|
20022
|
+
}
|
|
20023
|
+
|
|
19894
20024
|
/**
|
|
19895
20025
|
* Get a list of Facebook Integrations
|
|
19896
20026
|
*
|
|
@@ -20196,6 +20326,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20196
20326
|
);
|
|
20197
20327
|
}
|
|
20198
20328
|
|
|
20329
|
+
/**
|
|
20330
|
+
* Call Authentication provider callback to validate state and code
|
|
20331
|
+
*
|
|
20332
|
+
* @param {String} code The authorization code to be sent to the authentication server during the token request.
|
|
20333
|
+
* @param {String} state The state/nonce value generated by Genesys Auth-Client Service.
|
|
20334
|
+
* @param {Object} opts Optional parameters
|
|
20335
|
+
* @param {String} opts.error Error parameter from OAuth provider
|
|
20336
|
+
*/
|
|
20337
|
+
getConversationsMessagingOauthAppleCallback(code, state, opts) {
|
|
20338
|
+
opts = opts || {};
|
|
20339
|
+
|
|
20340
|
+
// verify the required parameter 'code' is set
|
|
20341
|
+
if (code === undefined || code === null) {
|
|
20342
|
+
throw 'Missing the required parameter "code" when calling getConversationsMessagingOauthAppleCallback';
|
|
20343
|
+
}
|
|
20344
|
+
// verify the required parameter 'state' is set
|
|
20345
|
+
if (state === undefined || state === null) {
|
|
20346
|
+
throw 'Missing the required parameter "state" when calling getConversationsMessagingOauthAppleCallback';
|
|
20347
|
+
}
|
|
20348
|
+
|
|
20349
|
+
return this.apiClient.callApi(
|
|
20350
|
+
'/api/v2/conversations/messaging/oauth/apple/callback',
|
|
20351
|
+
'GET',
|
|
20352
|
+
{ },
|
|
20353
|
+
{ 'code': code,'state': state,'error': opts['error'] },
|
|
20354
|
+
{ },
|
|
20355
|
+
{ },
|
|
20356
|
+
null,
|
|
20357
|
+
['PureCloud OAuth'],
|
|
20358
|
+
['application/json'],
|
|
20359
|
+
['application/json']
|
|
20360
|
+
);
|
|
20361
|
+
}
|
|
20362
|
+
|
|
20199
20363
|
/**
|
|
20200
20364
|
* Get a messaging setting
|
|
20201
20365
|
*
|
|
@@ -21814,6 +21978,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21814
21978
|
);
|
|
21815
21979
|
}
|
|
21816
21980
|
|
|
21981
|
+
/**
|
|
21982
|
+
* Update an Apple messaging integration
|
|
21983
|
+
*
|
|
21984
|
+
* @param {String} integrationId Integration ID
|
|
21985
|
+
* @param {Object} body AppleIntegrationUpdateRequest
|
|
21986
|
+
*/
|
|
21987
|
+
patchConversationsMessagingIntegrationsAppleIntegrationId(integrationId, body) {
|
|
21988
|
+
// verify the required parameter 'integrationId' is set
|
|
21989
|
+
if (integrationId === undefined || integrationId === null || integrationId === '') {
|
|
21990
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';
|
|
21991
|
+
}
|
|
21992
|
+
// verify the required parameter 'body' is set
|
|
21993
|
+
if (body === undefined || body === null) {
|
|
21994
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';
|
|
21995
|
+
}
|
|
21996
|
+
|
|
21997
|
+
return this.apiClient.callApi(
|
|
21998
|
+
'/api/v2/conversations/messaging/integrations/apple/{integrationId}',
|
|
21999
|
+
'PATCH',
|
|
22000
|
+
{ 'integrationId': integrationId },
|
|
22001
|
+
{ },
|
|
22002
|
+
{ },
|
|
22003
|
+
{ },
|
|
22004
|
+
body,
|
|
22005
|
+
['PureCloud OAuth'],
|
|
22006
|
+
['application/json'],
|
|
22007
|
+
['application/json']
|
|
22008
|
+
);
|
|
22009
|
+
}
|
|
22010
|
+
|
|
21817
22011
|
/**
|
|
21818
22012
|
* Update Facebook messaging integration
|
|
21819
22013
|
*
|
|
@@ -23268,7 +23462,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23268
23462
|
}
|
|
23269
23463
|
|
|
23270
23464
|
/**
|
|
23271
|
-
* Add participants to a conversation
|
|
23465
|
+
* Add participants to a conversation on behalf of a user
|
|
23272
23466
|
*
|
|
23273
23467
|
* @param {String} conversationId conversationId
|
|
23274
23468
|
* @param {String} userId userId
|
|
@@ -24577,6 +24771,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24577
24771
|
);
|
|
24578
24772
|
}
|
|
24579
24773
|
|
|
24774
|
+
/**
|
|
24775
|
+
* Create Apple Integration
|
|
24776
|
+
*
|
|
24777
|
+
* @param {Object} body AppleIntegrationRequest
|
|
24778
|
+
*/
|
|
24779
|
+
postConversationsMessagingIntegrationsApple(body) {
|
|
24780
|
+
// verify the required parameter 'body' is set
|
|
24781
|
+
if (body === undefined || body === null) {
|
|
24782
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsApple';
|
|
24783
|
+
}
|
|
24784
|
+
|
|
24785
|
+
return this.apiClient.callApi(
|
|
24786
|
+
'/api/v2/conversations/messaging/integrations/apple',
|
|
24787
|
+
'POST',
|
|
24788
|
+
{ },
|
|
24789
|
+
{ },
|
|
24790
|
+
{ },
|
|
24791
|
+
{ },
|
|
24792
|
+
body,
|
|
24793
|
+
['PureCloud OAuth'],
|
|
24794
|
+
['application/json'],
|
|
24795
|
+
['application/json']
|
|
24796
|
+
);
|
|
24797
|
+
}
|
|
24798
|
+
|
|
24580
24799
|
/**
|
|
24581
24800
|
* Create a Facebook Integration
|
|
24582
24801
|
*
|
|
@@ -25355,7 +25574,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25355
25574
|
*
|
|
25356
25575
|
* @param {String} integrationId Integration ID
|
|
25357
25576
|
* @param {Object} body IdentityResolutionConfig
|
|
25358
|
-
* putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25359
25577
|
*/
|
|
25360
25578
|
putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId, body) {
|
|
25361
25579
|
// verify the required parameter 'integrationId' is set
|
|
@@ -25703,7 +25921,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25703
25921
|
/**
|
|
25704
25922
|
* DataExtensions service.
|
|
25705
25923
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
25706
|
-
* @version
|
|
25924
|
+
* @version 233.0.0
|
|
25707
25925
|
*/
|
|
25708
25926
|
|
|
25709
25927
|
/**
|
|
@@ -25789,7 +26007,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25789
26007
|
/**
|
|
25790
26008
|
* DataPrivacy service.
|
|
25791
26009
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
25792
|
-
* @version
|
|
26010
|
+
* @version 233.0.0
|
|
25793
26011
|
*/
|
|
25794
26012
|
|
|
25795
26013
|
/**
|
|
@@ -25959,7 +26177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25959
26177
|
/**
|
|
25960
26178
|
* Downloads service.
|
|
25961
26179
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
25962
|
-
* @version
|
|
26180
|
+
* @version 233.0.0
|
|
25963
26181
|
*/
|
|
25964
26182
|
|
|
25965
26183
|
/**
|
|
@@ -26011,7 +26229,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26011
26229
|
/**
|
|
26012
26230
|
* Emails service.
|
|
26013
26231
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
26014
|
-
* @version
|
|
26232
|
+
* @version 233.0.0
|
|
26015
26233
|
*/
|
|
26016
26234
|
|
|
26017
26235
|
/**
|
|
@@ -26140,7 +26358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26140
26358
|
/**
|
|
26141
26359
|
* EmployeeEngagement service.
|
|
26142
26360
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
26143
|
-
* @version
|
|
26361
|
+
* @version 233.0.0
|
|
26144
26362
|
*/
|
|
26145
26363
|
|
|
26146
26364
|
/**
|
|
@@ -26291,7 +26509,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26291
26509
|
/**
|
|
26292
26510
|
* Events service.
|
|
26293
26511
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26294
|
-
* @version
|
|
26512
|
+
* @version 233.0.0
|
|
26295
26513
|
*/
|
|
26296
26514
|
|
|
26297
26515
|
/**
|
|
@@ -26387,7 +26605,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26387
26605
|
/**
|
|
26388
26606
|
* ExternalContacts service.
|
|
26389
26607
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26390
|
-
* @version
|
|
26608
|
+
* @version 233.0.0
|
|
26391
26609
|
*/
|
|
26392
26610
|
|
|
26393
26611
|
/**
|
|
@@ -29634,7 +29852,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29634
29852
|
/**
|
|
29635
29853
|
* Fax service.
|
|
29636
29854
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
29637
|
-
* @version
|
|
29855
|
+
* @version 233.0.0
|
|
29638
29856
|
*/
|
|
29639
29857
|
|
|
29640
29858
|
/**
|
|
@@ -29849,7 +30067,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29849
30067
|
/**
|
|
29850
30068
|
* Flows service.
|
|
29851
30069
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
29852
|
-
* @version
|
|
30070
|
+
* @version 233.0.0
|
|
29853
30071
|
*/
|
|
29854
30072
|
|
|
29855
30073
|
/**
|
|
@@ -30058,7 +30276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30058
30276
|
/**
|
|
30059
30277
|
* Gamification service.
|
|
30060
30278
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
30061
|
-
* @version
|
|
30279
|
+
* @version 233.0.0
|
|
30062
30280
|
*/
|
|
30063
30281
|
|
|
30064
30282
|
/**
|
|
@@ -30418,6 +30636,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30418
30636
|
* @param {String} opts.sortMetricId Sort Metric Id
|
|
30419
30637
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
30420
30638
|
* @param {String} opts.userIds A list of up to 100 comma-separated user Ids
|
|
30639
|
+
* @param {String} opts.reportsTo The reportsTo used by ABAC policies.
|
|
30421
30640
|
*/
|
|
30422
30641
|
getGamificationInsights(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, opts) {
|
|
30423
30642
|
opts = opts || {};
|
|
@@ -30447,7 +30666,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30447
30666
|
'/api/v2/gamification/insights',
|
|
30448
30667
|
'GET',
|
|
30449
30668
|
{ },
|
|
30450
|
-
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortKey': opts['sortKey'],'sortMetricId': opts['sortMetricId'],'sortOrder': opts['sortOrder'],'userIds': opts['userIds'] },
|
|
30669
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortKey': opts['sortKey'],'sortMetricId': opts['sortMetricId'],'sortOrder': opts['sortOrder'],'userIds': opts['userIds'],'reportsTo': opts['reportsTo'] },
|
|
30451
30670
|
{ },
|
|
30452
30671
|
{ },
|
|
30453
30672
|
null,
|
|
@@ -30619,8 +30838,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30619
30838
|
* @param {String} filterId ID for the filter type.
|
|
30620
30839
|
* @param {Object} granularity Granularity
|
|
30621
30840
|
* @param {String} startWorkday The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30841
|
+
* @param {Object} opts Optional parameters
|
|
30842
|
+
* @param {String} opts.reportsTo The reportsTo used by ABAC policies.
|
|
30622
30843
|
*/
|
|
30623
|
-
getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday) {
|
|
30844
|
+
getGamificationInsightsMembers(filterType, filterId, granularity, startWorkday, opts) {
|
|
30845
|
+
opts = opts || {};
|
|
30846
|
+
|
|
30624
30847
|
// verify the required parameter 'filterType' is set
|
|
30625
30848
|
if (filterType === undefined || filterType === null) {
|
|
30626
30849
|
throw 'Missing the required parameter "filterType" when calling getGamificationInsightsMembers';
|
|
@@ -30642,7 +30865,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30642
30865
|
'/api/v2/gamification/insights/members',
|
|
30643
30866
|
'GET',
|
|
30644
30867
|
{ },
|
|
30645
|
-
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday },
|
|
30868
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'startWorkday': startWorkday,'reportsTo': opts['reportsTo'] },
|
|
30646
30869
|
{ },
|
|
30647
30870
|
{ },
|
|
30648
30871
|
null,
|
|
@@ -30665,6 +30888,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30665
30888
|
* @param {String} opts.sortMetricId Sort Metric Id
|
|
30666
30889
|
* @param {Number} opts.sectionSize The number of top and bottom users to return before ties
|
|
30667
30890
|
* @param {String} opts.userIds A list of up to 100 comma-separated user Ids
|
|
30891
|
+
* @param {String} opts.reportsTo The reportsTo used by ABAC policies.
|
|
30668
30892
|
*/
|
|
30669
30893
|
getGamificationInsightsRankings(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, sortKey, opts) {
|
|
30670
30894
|
opts = opts || {};
|
|
@@ -30698,7 +30922,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30698
30922
|
'/api/v2/gamification/insights/rankings',
|
|
30699
30923
|
'GET',
|
|
30700
30924
|
{ },
|
|
30701
|
-
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'sortKey': sortKey,'sortMetricId': opts['sortMetricId'],'sectionSize': opts['sectionSize'],'userIds': opts['userIds'] },
|
|
30925
|
+
{ 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'sortKey': sortKey,'sortMetricId': opts['sortMetricId'],'sectionSize': opts['sectionSize'],'userIds': opts['userIds'],'reportsTo': opts['reportsTo'] },
|
|
30702
30926
|
{ },
|
|
30703
30927
|
{ },
|
|
30704
30928
|
null,
|
|
@@ -32565,7 +32789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32565
32789
|
/**
|
|
32566
32790
|
* GeneralDataProtectionRegulation service.
|
|
32567
32791
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32568
|
-
* @version
|
|
32792
|
+
* @version 233.0.0
|
|
32569
32793
|
*/
|
|
32570
32794
|
|
|
32571
32795
|
/**
|
|
@@ -32695,7 +32919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32695
32919
|
/**
|
|
32696
32920
|
* Geolocation service.
|
|
32697
32921
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
32698
|
-
* @version
|
|
32922
|
+
* @version 233.0.0
|
|
32699
32923
|
*/
|
|
32700
32924
|
|
|
32701
32925
|
/**
|
|
@@ -32826,7 +33050,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32826
33050
|
/**
|
|
32827
33051
|
* Greetings service.
|
|
32828
33052
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
32829
|
-
* @version
|
|
33053
|
+
* @version 233.0.0
|
|
32830
33054
|
*/
|
|
32831
33055
|
|
|
32832
33056
|
/**
|
|
@@ -33368,7 +33592,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33368
33592
|
/**
|
|
33369
33593
|
* Groups service.
|
|
33370
33594
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33371
|
-
* @version
|
|
33595
|
+
* @version 233.0.0
|
|
33372
33596
|
*/
|
|
33373
33597
|
|
|
33374
33598
|
/**
|
|
@@ -33887,7 +34111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33887
34111
|
/**
|
|
33888
34112
|
* IdentityProvider service.
|
|
33889
34113
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
33890
|
-
* @version
|
|
34114
|
+
* @version 233.0.0
|
|
33891
34115
|
*/
|
|
33892
34116
|
|
|
33893
34117
|
/**
|
|
@@ -34748,7 +34972,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34748
34972
|
/**
|
|
34749
34973
|
* InfrastructureAsCode service.
|
|
34750
34974
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
34751
|
-
* @version
|
|
34975
|
+
* @version 233.0.0
|
|
34752
34976
|
*/
|
|
34753
34977
|
|
|
34754
34978
|
/**
|
|
@@ -34915,7 +35139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34915
35139
|
/**
|
|
34916
35140
|
* Integrations service.
|
|
34917
35141
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
34918
|
-
* @version
|
|
35142
|
+
* @version 233.0.0
|
|
34919
35143
|
*/
|
|
34920
35144
|
|
|
34921
35145
|
/**
|
|
@@ -35099,6 +35323,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35099
35323
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
35100
35324
|
* @param {String} opts.nextPage next page token
|
|
35101
35325
|
* @param {String} opts.previousPage Previous page token
|
|
35326
|
+
* @param {Array.<String>} opts.ids Comma-separated list of integration IDs to filter by (max 100)
|
|
35327
|
+
* @param {String} opts.integrationType Filter integrations by integration type ID
|
|
35328
|
+
* @param {Object} opts.reportedState Filter integrations by reported state (case-insensitive)
|
|
35102
35329
|
*/
|
|
35103
35330
|
getIntegrations(opts) {
|
|
35104
35331
|
opts = opts || {};
|
|
@@ -35108,7 +35335,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35108
35335
|
'/api/v2/integrations',
|
|
35109
35336
|
'GET',
|
|
35110
35337
|
{ },
|
|
35111
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
|
|
35338
|
+
{ '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'] },
|
|
35112
35339
|
{ },
|
|
35113
35340
|
{ },
|
|
35114
35341
|
null,
|
|
@@ -37560,7 +37787,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37560
37787
|
/**
|
|
37561
37788
|
* Journey service.
|
|
37562
37789
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37563
|
-
* @version
|
|
37790
|
+
* @version 233.0.0
|
|
37564
37791
|
*/
|
|
37565
37792
|
|
|
37566
37793
|
/**
|
|
@@ -39657,7 +39884,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39657
39884
|
/**
|
|
39658
39885
|
* Knowledge service.
|
|
39659
39886
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
39660
|
-
* @version
|
|
39887
|
+
* @version 233.0.0
|
|
39661
39888
|
*/
|
|
39662
39889
|
|
|
39663
39890
|
/**
|
|
@@ -43559,7 +43786,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43559
43786
|
/**
|
|
43560
43787
|
* LanguageUnderstanding service.
|
|
43561
43788
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43562
|
-
* @version
|
|
43789
|
+
* @version 233.0.0
|
|
43563
43790
|
*/
|
|
43564
43791
|
|
|
43565
43792
|
/**
|
|
@@ -44778,7 +45005,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44778
45005
|
/**
|
|
44779
45006
|
* Languages service.
|
|
44780
45007
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44781
|
-
* @version
|
|
45008
|
+
* @version 233.0.0
|
|
44782
45009
|
*/
|
|
44783
45010
|
|
|
44784
45011
|
/**
|
|
@@ -45000,7 +45227,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45000
45227
|
/**
|
|
45001
45228
|
* Learning service.
|
|
45002
45229
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
45003
|
-
* @version
|
|
45230
|
+
* @version 233.0.0
|
|
45004
45231
|
*/
|
|
45005
45232
|
|
|
45006
45233
|
/**
|
|
@@ -45998,8 +46225,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45998
46225
|
* This will update a learning module rule with the specified fields.
|
|
45999
46226
|
* @param {String} moduleId The ID of the learning module
|
|
46000
46227
|
* @param {Object} body The learning module rule to be updated
|
|
46228
|
+
* @param {Object} opts Optional parameters
|
|
46229
|
+
* @param {Boolean} opts.assign Whether to assign the module to users or not (default to true)
|
|
46001
46230
|
*/
|
|
46002
|
-
putLearningModuleRule(moduleId, body) {
|
|
46231
|
+
putLearningModuleRule(moduleId, body, opts) {
|
|
46232
|
+
opts = opts || {};
|
|
46233
|
+
|
|
46003
46234
|
// verify the required parameter 'moduleId' is set
|
|
46004
46235
|
if (moduleId === undefined || moduleId === null || moduleId === '') {
|
|
46005
46236
|
throw 'Missing the required parameter "moduleId" when calling putLearningModuleRule';
|
|
@@ -46013,7 +46244,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46013
46244
|
'/api/v2/learning/modules/{moduleId}/rule',
|
|
46014
46245
|
'PUT',
|
|
46015
46246
|
{ 'moduleId': moduleId },
|
|
46016
|
-
{
|
|
46247
|
+
{ 'assign': opts['assign'] },
|
|
46017
46248
|
{ },
|
|
46018
46249
|
{ },
|
|
46019
46250
|
body,
|
|
@@ -46029,7 +46260,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46029
46260
|
/**
|
|
46030
46261
|
* License service.
|
|
46031
46262
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
46032
|
-
* @version
|
|
46263
|
+
* @version 233.0.0
|
|
46033
46264
|
*/
|
|
46034
46265
|
|
|
46035
46266
|
/**
|
|
@@ -46267,7 +46498,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46267
46498
|
/**
|
|
46268
46499
|
* Locations service.
|
|
46269
46500
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
46270
|
-
* @version
|
|
46501
|
+
* @version 233.0.0
|
|
46271
46502
|
*/
|
|
46272
46503
|
|
|
46273
46504
|
/**
|
|
@@ -46503,7 +46734,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46503
46734
|
/**
|
|
46504
46735
|
* LogCapture service.
|
|
46505
46736
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
46506
|
-
* @version
|
|
46737
|
+
* @version 233.0.0
|
|
46507
46738
|
*/
|
|
46508
46739
|
|
|
46509
46740
|
/**
|
|
@@ -46702,7 +46933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46702
46933
|
/**
|
|
46703
46934
|
* Messaging service.
|
|
46704
46935
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46705
|
-
* @version
|
|
46936
|
+
* @version 233.0.0
|
|
46706
46937
|
*/
|
|
46707
46938
|
|
|
46708
46939
|
/**
|
|
@@ -47061,7 +47292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47061
47292
|
/**
|
|
47062
47293
|
* MobileDevices service.
|
|
47063
47294
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
47064
|
-
* @version
|
|
47295
|
+
* @version 233.0.0
|
|
47065
47296
|
*/
|
|
47066
47297
|
|
|
47067
47298
|
/**
|
|
@@ -47212,7 +47443,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47212
47443
|
/**
|
|
47213
47444
|
* Notifications service.
|
|
47214
47445
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
47215
|
-
* @version
|
|
47446
|
+
* @version 233.0.0
|
|
47216
47447
|
*/
|
|
47217
47448
|
|
|
47218
47449
|
/**
|
|
@@ -47445,7 +47676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47445
47676
|
/**
|
|
47446
47677
|
* OAuth service.
|
|
47447
47678
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
47448
|
-
* @version
|
|
47679
|
+
* @version 233.0.0
|
|
47449
47680
|
*/
|
|
47450
47681
|
|
|
47451
47682
|
/**
|
|
@@ -47811,7 +48042,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47811
48042
|
/**
|
|
47812
48043
|
* Objects service.
|
|
47813
48044
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47814
|
-
* @version
|
|
48045
|
+
* @version 233.0.0
|
|
47815
48046
|
*/
|
|
47816
48047
|
|
|
47817
48048
|
/**
|
|
@@ -48135,7 +48366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48135
48366
|
/**
|
|
48136
48367
|
* OperationalEvents service.
|
|
48137
48368
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
48138
|
-
* @version
|
|
48369
|
+
* @version 233.0.0
|
|
48139
48370
|
*/
|
|
48140
48371
|
|
|
48141
48372
|
/**
|
|
@@ -48252,7 +48483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48252
48483
|
/**
|
|
48253
48484
|
* Organization service.
|
|
48254
48485
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
48255
|
-
* @version
|
|
48486
|
+
* @version 233.0.0
|
|
48256
48487
|
*/
|
|
48257
48488
|
|
|
48258
48489
|
/**
|
|
@@ -48727,7 +48958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48727
48958
|
/**
|
|
48728
48959
|
* OrganizationAuthorization service.
|
|
48729
48960
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48730
|
-
* @version
|
|
48961
|
+
* @version 233.0.0
|
|
48731
48962
|
*/
|
|
48732
48963
|
|
|
48733
48964
|
/**
|
|
@@ -50121,7 +50352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50121
50352
|
/**
|
|
50122
50353
|
* Outbound service.
|
|
50123
50354
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
50124
|
-
* @version
|
|
50355
|
+
* @version 233.0.0
|
|
50125
50356
|
*/
|
|
50126
50357
|
|
|
50127
50358
|
/**
|
|
@@ -54843,7 +55074,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54843
55074
|
/**
|
|
54844
55075
|
* Presence service.
|
|
54845
55076
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54846
|
-
* @version
|
|
55077
|
+
* @version 233.0.0
|
|
54847
55078
|
*/
|
|
54848
55079
|
|
|
54849
55080
|
/**
|
|
@@ -55587,7 +55818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55587
55818
|
/**
|
|
55588
55819
|
* ProcessAutomation service.
|
|
55589
55820
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55590
|
-
* @version
|
|
55821
|
+
* @version 233.0.0
|
|
55591
55822
|
*/
|
|
55592
55823
|
|
|
55593
55824
|
/**
|
|
@@ -55826,7 +56057,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55826
56057
|
/**
|
|
55827
56058
|
* Quality service.
|
|
55828
56059
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55829
|
-
* @version
|
|
56060
|
+
* @version 233.0.0
|
|
55830
56061
|
*/
|
|
55831
56062
|
|
|
55832
56063
|
/**
|
|
@@ -56409,7 +56640,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56409
56640
|
}
|
|
56410
56641
|
|
|
56411
56642
|
/**
|
|
56412
|
-
* Get an evaluator activity
|
|
56643
|
+
* Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.
|
|
56413
56644
|
*
|
|
56414
56645
|
* @param {Object} opts Optional parameters
|
|
56415
56646
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
@@ -57771,7 +58002,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57771
58002
|
/**
|
|
57772
58003
|
* Recording service.
|
|
57773
58004
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
57774
|
-
* @version
|
|
58005
|
+
* @version 233.0.0
|
|
57775
58006
|
*/
|
|
57776
58007
|
|
|
57777
58008
|
/**
|
|
@@ -59376,7 +59607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59376
59607
|
/**
|
|
59377
59608
|
* ResponseManagement service.
|
|
59378
59609
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
59379
|
-
* @version
|
|
59610
|
+
* @version 233.0.0
|
|
59380
59611
|
*/
|
|
59381
59612
|
|
|
59382
59613
|
/**
|
|
@@ -59886,7 +60117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59886
60117
|
/**
|
|
59887
60118
|
* Routing service.
|
|
59888
60119
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59889
|
-
* @version
|
|
60120
|
+
* @version 233.0.0
|
|
59890
60121
|
*/
|
|
59891
60122
|
|
|
59892
60123
|
/**
|
|
@@ -61120,6 +61351,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61120
61351
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
61121
61352
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
61122
61353
|
* @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
|
|
61354
|
+
* @param {String} opts.kpiId Standard or custom KPI id used to filter predictors.
|
|
61355
|
+
* @param {Object} opts.state The state used to filter predictors.
|
|
61123
61356
|
*/
|
|
61124
61357
|
getRoutingPredictors(opts) {
|
|
61125
61358
|
opts = opts || {};
|
|
@@ -61129,7 +61362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61129
61362
|
'/api/v2/routing/predictors',
|
|
61130
61363
|
'GET',
|
|
61131
61364
|
{ },
|
|
61132
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi') },
|
|
61365
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'queueId': this.apiClient.buildCollectionParam(opts['queueId'], 'multi'),'kpiId': opts['kpiId'],'state': opts['state'] },
|
|
61133
61366
|
{ },
|
|
61134
61367
|
{ },
|
|
61135
61368
|
null,
|
|
@@ -61198,7 +61431,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61198
61431
|
*
|
|
61199
61432
|
* @param {String} queueId Queue ID
|
|
61200
61433
|
* @param {Object} opts Optional parameters
|
|
61201
|
-
* @param {
|
|
61434
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
61202
61435
|
*/
|
|
61203
61436
|
getRoutingQueueAssistant(queueId, opts) {
|
|
61204
61437
|
opts = opts || {};
|
|
@@ -61212,7 +61445,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61212
61445
|
'/api/v2/routing/queues/{queueId}/assistant',
|
|
61213
61446
|
'GET',
|
|
61214
61447
|
{ 'queueId': queueId },
|
|
61215
|
-
{ 'expand': opts['expand'] },
|
|
61448
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
61216
61449
|
{ },
|
|
61217
61450
|
{ },
|
|
61218
61451
|
null,
|
|
@@ -64212,7 +64445,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64212
64445
|
/**
|
|
64213
64446
|
* SCIM service.
|
|
64214
64447
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
64215
|
-
* @version
|
|
64448
|
+
* @version 233.0.0
|
|
64216
64449
|
*/
|
|
64217
64450
|
|
|
64218
64451
|
/**
|
|
@@ -65089,7 +65322,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65089
65322
|
/**
|
|
65090
65323
|
* ScreenRecording service.
|
|
65091
65324
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
65092
|
-
* @version
|
|
65325
|
+
* @version 233.0.0
|
|
65093
65326
|
*/
|
|
65094
65327
|
|
|
65095
65328
|
/**
|
|
@@ -65134,7 +65367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65134
65367
|
/**
|
|
65135
65368
|
* Scripts service.
|
|
65136
65369
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
65137
|
-
* @version
|
|
65370
|
+
* @version 233.0.0
|
|
65138
65371
|
*/
|
|
65139
65372
|
|
|
65140
65373
|
/**
|
|
@@ -65610,7 +65843,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65610
65843
|
/**
|
|
65611
65844
|
* Search service.
|
|
65612
65845
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
65613
|
-
* @version
|
|
65846
|
+
* @version 233.0.0
|
|
65614
65847
|
*/
|
|
65615
65848
|
|
|
65616
65849
|
/**
|
|
@@ -66328,7 +66561,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66328
66561
|
/**
|
|
66329
66562
|
* Settings service.
|
|
66330
66563
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
66331
|
-
* @version
|
|
66564
|
+
* @version 233.0.0
|
|
66332
66565
|
*/
|
|
66333
66566
|
|
|
66334
66567
|
/**
|
|
@@ -66676,7 +66909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66676
66909
|
/**
|
|
66677
66910
|
* SocialMedia service.
|
|
66678
66911
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66679
|
-
* @version
|
|
66912
|
+
* @version 233.0.0
|
|
66680
66913
|
*/
|
|
66681
66914
|
|
|
66682
66915
|
/**
|
|
@@ -68267,7 +68500,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68267
68500
|
/**
|
|
68268
68501
|
* SpeechTextAnalytics service.
|
|
68269
68502
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
68270
|
-
* @version
|
|
68503
|
+
* @version 233.0.0
|
|
68271
68504
|
*/
|
|
68272
68505
|
|
|
68273
68506
|
/**
|
|
@@ -69174,6 +69407,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69174
69407
|
* @param {Object} opts Optional parameters
|
|
69175
69408
|
* @param {String} opts.nextPage The key for listing the next page
|
|
69176
69409
|
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 500. (default to 20)
|
|
69410
|
+
* @param {Number} opts.pageNumber The page number for the listing
|
|
69177
69411
|
* @param {Object} opts.state Topic state. Defaults to latest
|
|
69178
69412
|
* @param {String} opts.name Case insensitive partial name to filter by
|
|
69179
69413
|
* @param {Array.<String>} opts.ids Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
@@ -69189,7 +69423,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69189
69423
|
'/api/v2/speechandtextanalytics/topics',
|
|
69190
69424
|
'GET',
|
|
69191
69425
|
{ },
|
|
69192
|
-
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'],'name': opts['name'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'dialects': this.apiClient.buildCollectionParam(opts['dialects'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
69426
|
+
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'state': opts['state'],'name': opts['name'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'dialects': this.apiClient.buildCollectionParam(opts['dialects'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
69193
69427
|
{ },
|
|
69194
69428
|
{ },
|
|
69195
69429
|
null,
|
|
@@ -69913,7 +70147,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69913
70147
|
/**
|
|
69914
70148
|
* Stations service.
|
|
69915
70149
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
69916
|
-
* @version
|
|
70150
|
+
* @version 233.0.0
|
|
69917
70151
|
*/
|
|
69918
70152
|
|
|
69919
70153
|
/**
|
|
@@ -70015,7 +70249,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70015
70249
|
/**
|
|
70016
70250
|
* Suggest service.
|
|
70017
70251
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
70018
|
-
* @version
|
|
70252
|
+
* @version 233.0.0
|
|
70019
70253
|
*/
|
|
70020
70254
|
|
|
70021
70255
|
/**
|
|
@@ -70154,7 +70388,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70154
70388
|
/**
|
|
70155
70389
|
* TaskManagement service.
|
|
70156
70390
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
70157
|
-
* @version
|
|
70391
|
+
* @version 233.0.0
|
|
70158
70392
|
*/
|
|
70159
70393
|
|
|
70160
70394
|
/**
|
|
@@ -70561,7 +70795,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70561
70795
|
*
|
|
70562
70796
|
* @param {String} workitemId Workitem ID
|
|
70563
70797
|
* @param {Object} opts Optional parameters
|
|
70564
|
-
* @param {
|
|
70798
|
+
* @param {Array.<String>} opts.expands Which fields to expand. Comma separated if more than one.
|
|
70565
70799
|
*/
|
|
70566
70800
|
getTaskmanagementWorkitem(workitemId, opts) {
|
|
70567
70801
|
opts = opts || {};
|
|
@@ -70575,7 +70809,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70575
70809
|
'/api/v2/taskmanagement/workitems/{workitemId}',
|
|
70576
70810
|
'GET',
|
|
70577
70811
|
{ 'workitemId': workitemId },
|
|
70578
|
-
{ 'expands': opts['expands'] },
|
|
70812
|
+
{ 'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
|
|
70579
70813
|
{ },
|
|
70580
70814
|
{ },
|
|
70581
70815
|
null,
|
|
@@ -72316,7 +72550,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72316
72550
|
/**
|
|
72317
72551
|
* Teams service.
|
|
72318
72552
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
72319
|
-
* @version
|
|
72553
|
+
* @version 233.0.0
|
|
72320
72554
|
*/
|
|
72321
72555
|
|
|
72322
72556
|
/**
|
|
@@ -72621,7 +72855,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72621
72855
|
/**
|
|
72622
72856
|
* Telephony service.
|
|
72623
72857
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
72624
|
-
* @version
|
|
72858
|
+
* @version 233.0.0
|
|
72625
72859
|
*/
|
|
72626
72860
|
|
|
72627
72861
|
/**
|
|
@@ -72907,7 +73141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72907
73141
|
/**
|
|
72908
73142
|
* TelephonyProvidersEdge service.
|
|
72909
73143
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
72910
|
-
* @version
|
|
73144
|
+
* @version 233.0.0
|
|
72911
73145
|
*/
|
|
72912
73146
|
|
|
72913
73147
|
/**
|
|
@@ -76400,7 +76634,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76400
76634
|
/**
|
|
76401
76635
|
* Textbots service.
|
|
76402
76636
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
76403
|
-
* @version
|
|
76637
|
+
* @version 233.0.0
|
|
76404
76638
|
*/
|
|
76405
76639
|
|
|
76406
76640
|
/**
|
|
@@ -76529,7 +76763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76529
76763
|
/**
|
|
76530
76764
|
* Tokens service.
|
|
76531
76765
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
76532
|
-
* @version
|
|
76766
|
+
* @version 233.0.0
|
|
76533
76767
|
*/
|
|
76534
76768
|
|
|
76535
76769
|
/**
|
|
@@ -76683,7 +76917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76683
76917
|
/**
|
|
76684
76918
|
* Uploads service.
|
|
76685
76919
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
76686
|
-
* @version
|
|
76920
|
+
* @version 233.0.0
|
|
76687
76921
|
*/
|
|
76688
76922
|
|
|
76689
76923
|
/**
|
|
@@ -76974,7 +77208,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76974
77208
|
/**
|
|
76975
77209
|
* Usage service.
|
|
76976
77210
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
76977
|
-
* @version
|
|
77211
|
+
* @version 233.0.0
|
|
76978
77212
|
*/
|
|
76979
77213
|
|
|
76980
77214
|
/**
|
|
@@ -77309,7 +77543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77309
77543
|
/**
|
|
77310
77544
|
* UserRecordings service.
|
|
77311
77545
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
77312
|
-
* @version
|
|
77546
|
+
* @version 233.0.0
|
|
77313
77547
|
*/
|
|
77314
77548
|
|
|
77315
77549
|
/**
|
|
@@ -77493,7 +77727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77493
77727
|
/**
|
|
77494
77728
|
* Users service.
|
|
77495
77729
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
77496
|
-
* @version
|
|
77730
|
+
* @version 233.0.0
|
|
77497
77731
|
*/
|
|
77498
77732
|
|
|
77499
77733
|
/**
|
|
@@ -80502,7 +80736,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80502
80736
|
/**
|
|
80503
80737
|
* Utilities service.
|
|
80504
80738
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
80505
|
-
* @version
|
|
80739
|
+
* @version 233.0.0
|
|
80506
80740
|
*/
|
|
80507
80741
|
|
|
80508
80742
|
/**
|
|
@@ -80613,7 +80847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80613
80847
|
/**
|
|
80614
80848
|
* Voicemail service.
|
|
80615
80849
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
80616
|
-
* @version
|
|
80850
|
+
* @version 233.0.0
|
|
80617
80851
|
*/
|
|
80618
80852
|
|
|
80619
80853
|
/**
|
|
@@ -81335,7 +81569,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81335
81569
|
/**
|
|
81336
81570
|
* WebChat service.
|
|
81337
81571
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
81338
|
-
* @version
|
|
81572
|
+
* @version 233.0.0
|
|
81339
81573
|
*/
|
|
81340
81574
|
|
|
81341
81575
|
/**
|
|
@@ -81409,7 +81643,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81409
81643
|
|
|
81410
81644
|
/**
|
|
81411
81645
|
* Remove WebChat deployment settings
|
|
81412
|
-
*
|
|
81646
|
+
* This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
|
|
81647
|
+
* @deprecated
|
|
81413
81648
|
*/
|
|
81414
81649
|
deleteWebchatSettings() {
|
|
81415
81650
|
|
|
@@ -81660,7 +81895,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81660
81895
|
|
|
81661
81896
|
/**
|
|
81662
81897
|
* Get WebChat deployment settings
|
|
81663
|
-
*
|
|
81898
|
+
* This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
|
|
81899
|
+
* @deprecated
|
|
81664
81900
|
*/
|
|
81665
81901
|
getWebchatSettings() {
|
|
81666
81902
|
|
|
@@ -81866,8 +82102,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81866
82102
|
|
|
81867
82103
|
/**
|
|
81868
82104
|
* Update WebChat deployment settings
|
|
81869
|
-
*
|
|
82105
|
+
* This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
|
|
81870
82106
|
* @param {Object} body webChatSettings
|
|
82107
|
+
* @deprecated
|
|
81871
82108
|
*/
|
|
81872
82109
|
putWebchatSettings(body) {
|
|
81873
82110
|
// verify the required parameter 'body' is set
|
|
@@ -81895,7 +82132,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81895
82132
|
/**
|
|
81896
82133
|
* WebDeployments service.
|
|
81897
82134
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
81898
|
-
* @version
|
|
82135
|
+
* @version 233.0.0
|
|
81899
82136
|
*/
|
|
81900
82137
|
|
|
81901
82138
|
/**
|
|
@@ -82477,7 +82714,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82477
82714
|
/**
|
|
82478
82715
|
* WebMessaging service.
|
|
82479
82716
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
82480
|
-
* @version
|
|
82717
|
+
* @version 233.0.0
|
|
82481
82718
|
*/
|
|
82482
82719
|
|
|
82483
82720
|
/**
|
|
@@ -82623,7 +82860,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82623
82860
|
/**
|
|
82624
82861
|
* Widgets service.
|
|
82625
82862
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
82626
|
-
* @version
|
|
82863
|
+
* @version 233.0.0
|
|
82627
82864
|
*/
|
|
82628
82865
|
|
|
82629
82866
|
/**
|
|
@@ -82774,7 +83011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82774
83011
|
/**
|
|
82775
83012
|
* WorkforceManagement service.
|
|
82776
83013
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
82777
|
-
* @version
|
|
83014
|
+
* @version 233.0.0
|
|
82778
83015
|
*/
|
|
82779
83016
|
|
|
82780
83017
|
/**
|
|
@@ -87910,6 +88147,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
87910
88147
|
);
|
|
87911
88148
|
}
|
|
87912
88149
|
|
|
88150
|
+
/**
|
|
88151
|
+
* Fetch agent schedules for the logged in user's management unit
|
|
88152
|
+
*
|
|
88153
|
+
* @param {Object} body body
|
|
88154
|
+
* @param {Object} opts Optional parameters
|
|
88155
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
88156
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
88157
|
+
*/
|
|
88158
|
+
postWorkforcemanagementAgentschedulesManagementunitsMine(body, opts) {
|
|
88159
|
+
opts = opts || {};
|
|
88160
|
+
|
|
88161
|
+
// verify the required parameter 'body' is set
|
|
88162
|
+
if (body === undefined || body === null) {
|
|
88163
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentschedulesManagementunitsMine';
|
|
88164
|
+
}
|
|
88165
|
+
|
|
88166
|
+
return this.apiClient.callApi(
|
|
88167
|
+
'/api/v2/workforcemanagement/agentschedules/managementunits/mine',
|
|
88168
|
+
'POST',
|
|
88169
|
+
{ },
|
|
88170
|
+
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
88171
|
+
{ },
|
|
88172
|
+
{ },
|
|
88173
|
+
body,
|
|
88174
|
+
['PureCloud OAuth'],
|
|
88175
|
+
['application/json'],
|
|
88176
|
+
['application/json']
|
|
88177
|
+
);
|
|
88178
|
+
}
|
|
88179
|
+
|
|
87913
88180
|
/**
|
|
87914
88181
|
* Get published schedule for the current user
|
|
87915
88182
|
*
|
|
@@ -90744,7 +91011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
90744
91011
|
* </pre>
|
|
90745
91012
|
* </p>
|
|
90746
91013
|
* @module purecloud-platform-client-v2/index
|
|
90747
|
-
* @version
|
|
91014
|
+
* @version 233.0.0
|
|
90748
91015
|
*/
|
|
90749
91016
|
class platformClient {
|
|
90750
91017
|
constructor() {
|