purecloud-platform-client-v2 183.0.0 → 185.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.
Files changed (84) hide show
  1. package/README.md +68 -2
  2. package/dist/node/purecloud-platform-client-v2.js +1395 -92
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1395 -92
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +411 -107
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +411 -107
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +823 -54
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +334 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +109 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -3
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +8 -9
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +75 -0
  45. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +7 -8
  50. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OutboundApi.js +401 -1
  54. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RoutingApi.js +168 -1
  60. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
  71. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +222 -1
  84. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class OutboundApi {
5
5
  /**
6
6
  * Outbound service.
7
7
  * @module purecloud-platform-client-v2/api/OutboundApi
8
- * @version 183.0.0
8
+ * @version 185.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -305,6 +305,56 @@ class OutboundApi {
305
305
  );
306
306
  }
307
307
 
308
+ /**
309
+ * Delete Contact List Template
310
+ *
311
+ * @param {String} contactListTemplateId ContactListTemplate ID
312
+ */
313
+ deleteOutboundContactlisttemplate(contactListTemplateId) {
314
+ // verify the required parameter 'contactListTemplateId' is set
315
+ if (contactListTemplateId === undefined || contactListTemplateId === null) {
316
+ throw 'Missing the required parameter "contactListTemplateId" when calling deleteOutboundContactlisttemplate';
317
+ }
318
+
319
+ return this.apiClient.callApi(
320
+ '/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
321
+ 'DELETE',
322
+ { 'contactListTemplateId': contactListTemplateId },
323
+ { },
324
+ { },
325
+ { },
326
+ null,
327
+ ['PureCloud OAuth'],
328
+ ['application/json'],
329
+ ['application/json']
330
+ );
331
+ }
332
+
333
+ /**
334
+ * Delete multiple contact list templates.
335
+ *
336
+ * @param {Array.<String>} id contact list template id(s) to delete
337
+ */
338
+ deleteOutboundContactlisttemplates(id) {
339
+ // verify the required parameter 'id' is set
340
+ if (id === undefined || id === null) {
341
+ throw 'Missing the required parameter "id" when calling deleteOutboundContactlisttemplates';
342
+ }
343
+
344
+ return this.apiClient.callApi(
345
+ '/api/v2/outbound/contactlisttemplates',
346
+ 'DELETE',
347
+ { },
348
+ { 'id': this.apiClient.buildCollectionParam(id, 'multi') },
349
+ { },
350
+ { },
351
+ null,
352
+ ['PureCloud OAuth'],
353
+ ['application/json'],
354
+ ['application/json']
355
+ );
356
+ }
357
+
308
358
  /**
309
359
  * Delete an Outbound Digital Rule Set
310
360
  *
@@ -442,6 +492,56 @@ class OutboundApi {
442
492
  );
443
493
  }
444
494
 
495
+ /**
496
+ * Delete Import Template
497
+ *
498
+ * @param {String} importTemplateId Import Template ID
499
+ */
500
+ deleteOutboundImporttemplate(importTemplateId) {
501
+ // verify the required parameter 'importTemplateId' is set
502
+ if (importTemplateId === undefined || importTemplateId === null) {
503
+ throw 'Missing the required parameter "importTemplateId" when calling deleteOutboundImporttemplate';
504
+ }
505
+
506
+ return this.apiClient.callApi(
507
+ '/api/v2/outbound/importtemplates/{importTemplateId}',
508
+ 'DELETE',
509
+ { 'importTemplateId': importTemplateId },
510
+ { },
511
+ { },
512
+ { },
513
+ null,
514
+ ['PureCloud OAuth'],
515
+ ['application/json'],
516
+ ['application/json']
517
+ );
518
+ }
519
+
520
+ /**
521
+ * Delete multiple import templates.
522
+ *
523
+ * @param {Array.<String>} id import template id(s) to delete
524
+ */
525
+ deleteOutboundImporttemplates(id) {
526
+ // verify the required parameter 'id' is set
527
+ if (id === undefined || id === null) {
528
+ throw 'Missing the required parameter "id" when calling deleteOutboundImporttemplates';
529
+ }
530
+
531
+ return this.apiClient.callApi(
532
+ '/api/v2/outbound/importtemplates',
533
+ 'DELETE',
534
+ { },
535
+ { 'id': this.apiClient.buildCollectionParam(id, 'multi') },
536
+ { },
537
+ { },
538
+ null,
539
+ ['PureCloud OAuth'],
540
+ ['application/json'],
541
+ ['application/json']
542
+ );
543
+ }
544
+
445
545
  /**
446
546
  * Delete an Outbound Messaging Campaign
447
547
  *
@@ -1454,6 +1554,61 @@ class OutboundApi {
1454
1554
  );
1455
1555
  }
1456
1556
 
1557
+ /**
1558
+ * Get Contact List Template
1559
+ *
1560
+ * @param {String} contactListTemplateId ContactListTemplate ID
1561
+ */
1562
+ getOutboundContactlisttemplate(contactListTemplateId) {
1563
+ // verify the required parameter 'contactListTemplateId' is set
1564
+ if (contactListTemplateId === undefined || contactListTemplateId === null) {
1565
+ throw 'Missing the required parameter "contactListTemplateId" when calling getOutboundContactlisttemplate';
1566
+ }
1567
+
1568
+ return this.apiClient.callApi(
1569
+ '/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
1570
+ 'GET',
1571
+ { 'contactListTemplateId': contactListTemplateId },
1572
+ { },
1573
+ { },
1574
+ { },
1575
+ null,
1576
+ ['PureCloud OAuth'],
1577
+ ['application/json'],
1578
+ ['application/json']
1579
+ );
1580
+ }
1581
+
1582
+ /**
1583
+ * Query a list of contact list templates
1584
+ *
1585
+ * @param {Object} opts Optional parameters
1586
+ * @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
1587
+ * @param {Number} opts.pageNumber Page number (default to 1)
1588
+ * @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
1589
+ * @param {Object} opts.filterType Filter type (default to Prefix)
1590
+ * @param {String} opts.name Name
1591
+ * @param {String} opts.sortBy Sort by
1592
+ * @param {Object} opts.sortOrder Sort order (default to a)
1593
+ */
1594
+ getOutboundContactlisttemplates(opts) {
1595
+ opts = opts || {};
1596
+
1597
+
1598
+ return this.apiClient.callApi(
1599
+ '/api/v2/outbound/contactlisttemplates',
1600
+ 'GET',
1601
+ { },
1602
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
1603
+ { },
1604
+ { },
1605
+ null,
1606
+ ['PureCloud OAuth'],
1607
+ ['application/json'],
1608
+ ['application/json']
1609
+ );
1610
+ }
1611
+
1457
1612
  /**
1458
1613
  * Get an Outbound Digital Rule Set
1459
1614
  *
@@ -1744,6 +1899,91 @@ class OutboundApi {
1744
1899
  );
1745
1900
  }
1746
1901
 
1902
+ /**
1903
+ * Get Import Template
1904
+ *
1905
+ * @param {String} importTemplateId Import Template ID
1906
+ */
1907
+ getOutboundImporttemplate(importTemplateId) {
1908
+ // verify the required parameter 'importTemplateId' is set
1909
+ if (importTemplateId === undefined || importTemplateId === null) {
1910
+ throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplate';
1911
+ }
1912
+
1913
+ return this.apiClient.callApi(
1914
+ '/api/v2/outbound/importtemplates/{importTemplateId}',
1915
+ 'GET',
1916
+ { 'importTemplateId': importTemplateId },
1917
+ { },
1918
+ { },
1919
+ { },
1920
+ null,
1921
+ ['PureCloud OAuth'],
1922
+ ['application/json'],
1923
+ ['application/json']
1924
+ );
1925
+ }
1926
+
1927
+ /**
1928
+ * Get the import status for an import template.
1929
+ *
1930
+ * @param {String} importTemplateId importTemplateId
1931
+ * @param {Object} opts Optional parameters
1932
+ * @param {String} opts.listNamePrefix listNamePrefix
1933
+ */
1934
+ getOutboundImporttemplateImportstatus(importTemplateId, opts) {
1935
+ opts = opts || {};
1936
+
1937
+ // verify the required parameter 'importTemplateId' is set
1938
+ if (importTemplateId === undefined || importTemplateId === null) {
1939
+ throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplateImportstatus';
1940
+ }
1941
+
1942
+ return this.apiClient.callApi(
1943
+ '/api/v2/outbound/importtemplates/{importTemplateId}/importstatus',
1944
+ 'GET',
1945
+ { 'importTemplateId': importTemplateId },
1946
+ { 'listNamePrefix': opts['listNamePrefix'] },
1947
+ { },
1948
+ { },
1949
+ null,
1950
+ ['PureCloud OAuth'],
1951
+ ['application/json'],
1952
+ ['application/json']
1953
+ );
1954
+ }
1955
+
1956
+ /**
1957
+ * Query Import Templates
1958
+ *
1959
+ * @param {Object} opts Optional parameters
1960
+ * @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
1961
+ * @param {Number} opts.pageNumber Page number (default to 1)
1962
+ * @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
1963
+ * @param {Object} opts.filterType Filter type (default to Prefix)
1964
+ * @param {String} opts.name Name
1965
+ * @param {String} opts.sortBy Sort by
1966
+ * @param {Object} opts.sortOrder Sort order (default to a)
1967
+ * @param {String} opts.contactListTemplateId Contact List Template ID
1968
+ */
1969
+ getOutboundImporttemplates(opts) {
1970
+ opts = opts || {};
1971
+
1972
+
1973
+ return this.apiClient.callApi(
1974
+ '/api/v2/outbound/importtemplates',
1975
+ 'GET',
1976
+ { },
1977
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'contactListTemplateId': opts['contactListTemplateId'] },
1978
+ { },
1979
+ { },
1980
+ null,
1981
+ ['PureCloud OAuth'],
1982
+ ['application/json'],
1983
+ ['application/json']
1984
+ );
1985
+ }
1986
+
1747
1987
  /**
1748
1988
  * Get an Outbound Messaging Campaign
1749
1989
  *
@@ -2782,6 +3022,56 @@ class OutboundApi {
2782
3022
  );
2783
3023
  }
2784
3024
 
3025
+ /**
3026
+ * Create Contact List Template
3027
+ *
3028
+ * @param {Object} body ContactListTemplate
3029
+ */
3030
+ postOutboundContactlisttemplates(body) {
3031
+ // verify the required parameter 'body' is set
3032
+ if (body === undefined || body === null) {
3033
+ throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplates';
3034
+ }
3035
+
3036
+ return this.apiClient.callApi(
3037
+ '/api/v2/outbound/contactlisttemplates',
3038
+ 'POST',
3039
+ { },
3040
+ { },
3041
+ { },
3042
+ { },
3043
+ body,
3044
+ ['PureCloud OAuth'],
3045
+ ['application/json'],
3046
+ ['application/json']
3047
+ );
3048
+ }
3049
+
3050
+ /**
3051
+ * Add multiple contact list templates
3052
+ *
3053
+ * @param {Array.<Object>} body contact list template(s) to add
3054
+ */
3055
+ postOutboundContactlisttemplatesBulkAdd(body) {
3056
+ // verify the required parameter 'body' is set
3057
+ if (body === undefined || body === null) {
3058
+ throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkAdd';
3059
+ }
3060
+
3061
+ return this.apiClient.callApi(
3062
+ '/api/v2/outbound/contactlisttemplates/bulk/add',
3063
+ 'POST',
3064
+ { },
3065
+ { },
3066
+ { },
3067
+ { },
3068
+ body,
3069
+ ['PureCloud OAuth'],
3070
+ ['application/json'],
3071
+ ['application/json']
3072
+ );
3073
+ }
3074
+
2785
3075
  /**
2786
3076
  * Add phone numbers to a Dialer DNC list.
2787
3077
  *
@@ -2946,6 +3236,56 @@ class OutboundApi {
2946
3236
  );
2947
3237
  }
2948
3238
 
3239
+ /**
3240
+ * Create Import Template
3241
+ *
3242
+ * @param {Object} body ImportTemplate
3243
+ */
3244
+ postOutboundImporttemplates(body) {
3245
+ // verify the required parameter 'body' is set
3246
+ if (body === undefined || body === null) {
3247
+ throw 'Missing the required parameter "body" when calling postOutboundImporttemplates';
3248
+ }
3249
+
3250
+ return this.apiClient.callApi(
3251
+ '/api/v2/outbound/importtemplates',
3252
+ 'POST',
3253
+ { },
3254
+ { },
3255
+ { },
3256
+ { },
3257
+ body,
3258
+ ['PureCloud OAuth'],
3259
+ ['application/json'],
3260
+ ['application/json']
3261
+ );
3262
+ }
3263
+
3264
+ /**
3265
+ * Add multiple import templates
3266
+ *
3267
+ * @param {Array.<Object>} body import template(s) to add
3268
+ */
3269
+ postOutboundImporttemplatesBulkAdd(body) {
3270
+ // verify the required parameter 'body' is set
3271
+ if (body === undefined || body === null) {
3272
+ throw 'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';
3273
+ }
3274
+
3275
+ return this.apiClient.callApi(
3276
+ '/api/v2/outbound/importtemplates/bulk/add',
3277
+ 'POST',
3278
+ { },
3279
+ { },
3280
+ { },
3281
+ { },
3282
+ body,
3283
+ ['PureCloud OAuth'],
3284
+ ['application/json'],
3285
+ ['application/json']
3286
+ );
3287
+ }
3288
+
2949
3289
  /**
2950
3290
  * Create a Messaging Campaign
2951
3291
  *
@@ -3326,6 +3666,36 @@ class OutboundApi {
3326
3666
  );
3327
3667
  }
3328
3668
 
3669
+ /**
3670
+ * Update a contact list template.
3671
+ *
3672
+ * @param {String} contactListTemplateId ContactListTemplate ID
3673
+ * @param {Object} body ContactListTemplate
3674
+ */
3675
+ putOutboundContactlisttemplate(contactListTemplateId, body) {
3676
+ // verify the required parameter 'contactListTemplateId' is set
3677
+ if (contactListTemplateId === undefined || contactListTemplateId === null) {
3678
+ throw 'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';
3679
+ }
3680
+ // verify the required parameter 'body' is set
3681
+ if (body === undefined || body === null) {
3682
+ throw 'Missing the required parameter "body" when calling putOutboundContactlisttemplate';
3683
+ }
3684
+
3685
+ return this.apiClient.callApi(
3686
+ '/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
3687
+ 'PUT',
3688
+ { 'contactListTemplateId': contactListTemplateId },
3689
+ { },
3690
+ { },
3691
+ { },
3692
+ body,
3693
+ ['PureCloud OAuth'],
3694
+ ['application/json'],
3695
+ ['application/json']
3696
+ );
3697
+ }
3698
+
3329
3699
  /**
3330
3700
  * Update an Outbound Digital Rule Set
3331
3701
  *
@@ -3386,6 +3756,36 @@ class OutboundApi {
3386
3756
  );
3387
3757
  }
3388
3758
 
3759
+ /**
3760
+ * Update Import Template
3761
+ *
3762
+ * @param {String} importTemplateId Import Template ID
3763
+ * @param {Object} body importTemplate
3764
+ */
3765
+ putOutboundImporttemplate(importTemplateId, body) {
3766
+ // verify the required parameter 'importTemplateId' is set
3767
+ if (importTemplateId === undefined || importTemplateId === null) {
3768
+ throw 'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';
3769
+ }
3770
+ // verify the required parameter 'body' is set
3771
+ if (body === undefined || body === null) {
3772
+ throw 'Missing the required parameter "body" when calling putOutboundImporttemplate';
3773
+ }
3774
+
3775
+ return this.apiClient.callApi(
3776
+ '/api/v2/outbound/importtemplates/{importTemplateId}',
3777
+ 'PUT',
3778
+ { 'importTemplateId': importTemplateId },
3779
+ { },
3780
+ { },
3781
+ { },
3782
+ body,
3783
+ ['PureCloud OAuth'],
3784
+ ['application/json'],
3785
+ ['application/json']
3786
+ );
3787
+ }
3788
+
3389
3789
  /**
3390
3790
  * Update an Outbound Messaging Campaign
3391
3791
  *
@@ -5,7 +5,7 @@ class PresenceApi {
5
5
  /**
6
6
  * Presence service.
7
7
  * @module purecloud-platform-client-v2/api/PresenceApi
8
- * @version 183.0.0
8
+ * @version 185.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ProcessAutomationApi {
5
5
  /**
6
6
  * ProcessAutomation service.
7
7
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
8
- * @version 183.0.0
8
+ * @version 185.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class QualityApi {
5
5
  /**
6
6
  * Quality service.
7
7
  * @module purecloud-platform-client-v2/api/QualityApi
8
- * @version 183.0.0
8
+ * @version 185.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class RecordingApi {
5
5
  /**
6
6
  * Recording service.
7
7
  * @module purecloud-platform-client-v2/api/RecordingApi
8
- * @version 183.0.0
8
+ * @version 185.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ResponseManagementApi {
5
5
  /**
6
6
  * ResponseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
8
- * @version 183.0.0
8
+ * @version 185.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class RoutingApi {
5
5
  /**
6
6
  * Routing service.
7
7
  * @module purecloud-platform-client-v2/api/RoutingApi
8
- * @version 183.0.0
8
+ * @version 185.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -460,6 +460,36 @@ class RoutingApi {
460
460
  );
461
461
  }
462
462
 
463
+ /**
464
+ * Delete a utilization label
465
+ *
466
+ * @param {String} labelId Utilization Label ID
467
+ * @param {Object} opts Optional parameters
468
+ * @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
469
+ * deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
470
+ */
471
+ deleteRoutingUtilizationLabel(labelId, opts) {
472
+ opts = opts || {};
473
+
474
+ // verify the required parameter 'labelId' is set
475
+ if (labelId === undefined || labelId === null) {
476
+ throw 'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';
477
+ }
478
+
479
+ return this.apiClient.callApi(
480
+ '/api/v2/routing/utilization/labels/{labelId}',
481
+ 'DELETE',
482
+ { 'labelId': labelId },
483
+ { 'forceDelete': opts['forceDelete'] },
484
+ { },
485
+ { },
486
+ null,
487
+ ['PureCloud OAuth'],
488
+ ['application/json'],
489
+ ['application/json']
490
+ );
491
+ }
492
+
463
493
  /**
464
494
  * Delete an utilization tag
465
495
  *
@@ -1950,6 +1980,86 @@ class RoutingApi {
1950
1980
  );
1951
1981
  }
1952
1982
 
1983
+ /**
1984
+ * Get details about this utilization label
1985
+ *
1986
+ * @param {String} labelId Utilization Label ID
1987
+ * getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1988
+ */
1989
+ getRoutingUtilizationLabel(labelId) {
1990
+ // verify the required parameter 'labelId' is set
1991
+ if (labelId === undefined || labelId === null) {
1992
+ throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';
1993
+ }
1994
+
1995
+ return this.apiClient.callApi(
1996
+ '/api/v2/routing/utilization/labels/{labelId}',
1997
+ 'GET',
1998
+ { 'labelId': labelId },
1999
+ { },
2000
+ { },
2001
+ { },
2002
+ null,
2003
+ ['PureCloud OAuth'],
2004
+ ['application/json'],
2005
+ ['application/json']
2006
+ );
2007
+ }
2008
+
2009
+ /**
2010
+ * Get list of agent ids associated with a utilization label
2011
+ *
2012
+ * @param {String} labelId Utilization Label ID
2013
+ * getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2014
+ */
2015
+ getRoutingUtilizationLabelAgents(labelId) {
2016
+ // verify the required parameter 'labelId' is set
2017
+ if (labelId === undefined || labelId === null) {
2018
+ throw 'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';
2019
+ }
2020
+
2021
+ return this.apiClient.callApi(
2022
+ '/api/v2/routing/utilization/labels/{labelId}/agents',
2023
+ 'GET',
2024
+ { 'labelId': labelId },
2025
+ { },
2026
+ { },
2027
+ { },
2028
+ null,
2029
+ ['PureCloud OAuth'],
2030
+ ['application/json'],
2031
+ ['application/json']
2032
+ );
2033
+ }
2034
+
2035
+ /**
2036
+ * Get list of utilization labels
2037
+ *
2038
+ * @param {Object} opts Optional parameters
2039
+ * @param {Number} opts.pageSize Page size (default to 25)
2040
+ * @param {Number} opts.pageNumber Page number (default to 1)
2041
+ * @param {Object} opts.sortOrder Sort order by name (default to ascending)
2042
+ * @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
2043
+ * getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2044
+ */
2045
+ getRoutingUtilizationLabels(opts) {
2046
+ opts = opts || {};
2047
+
2048
+
2049
+ return this.apiClient.callApi(
2050
+ '/api/v2/routing/utilization/labels',
2051
+ 'GET',
2052
+ { },
2053
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
2054
+ { },
2055
+ { },
2056
+ null,
2057
+ ['PureCloud OAuth'],
2058
+ ['application/json'],
2059
+ ['application/json']
2060
+ );
2061
+ }
2062
+
1953
2063
  /**
1954
2064
  * Get details about this utilization tag
1955
2065
  *
@@ -3246,6 +3356,32 @@ class RoutingApi {
3246
3356
  );
3247
3357
  }
3248
3358
 
3359
+ /**
3360
+ * Create a utilization label
3361
+ *
3362
+ * @param {Object} body UtilizationLabel
3363
+ * postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3364
+ */
3365
+ postRoutingUtilizationLabels(body) {
3366
+ // verify the required parameter 'body' is set
3367
+ if (body === undefined || body === null) {
3368
+ throw 'Missing the required parameter "body" when calling postRoutingUtilizationLabels';
3369
+ }
3370
+
3371
+ return this.apiClient.callApi(
3372
+ '/api/v2/routing/utilization/labels',
3373
+ 'POST',
3374
+ { },
3375
+ { },
3376
+ { },
3377
+ { },
3378
+ body,
3379
+ ['PureCloud OAuth'],
3380
+ ['application/json'],
3381
+ ['application/json']
3382
+ );
3383
+ }
3384
+
3249
3385
  /**
3250
3386
  * Create an utilization tag
3251
3387
  *
@@ -3612,6 +3748,37 @@ class RoutingApi {
3612
3748
  );
3613
3749
  }
3614
3750
 
3751
+ /**
3752
+ * Update a utilization label
3753
+ *
3754
+ * @param {String} labelId Utilization Label ID
3755
+ * @param {Object} body UtilizationLabel
3756
+ * putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3757
+ */
3758
+ putRoutingUtilizationLabel(labelId, body) {
3759
+ // verify the required parameter 'labelId' is set
3760
+ if (labelId === undefined || labelId === null) {
3761
+ throw 'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';
3762
+ }
3763
+ // verify the required parameter 'body' is set
3764
+ if (body === undefined || body === null) {
3765
+ throw 'Missing the required parameter "body" when calling putRoutingUtilizationLabel';
3766
+ }
3767
+
3768
+ return this.apiClient.callApi(
3769
+ '/api/v2/routing/utilization/labels/{labelId}',
3770
+ 'PUT',
3771
+ { 'labelId': labelId },
3772
+ { },
3773
+ { },
3774
+ { },
3775
+ body,
3776
+ ['PureCloud OAuth'],
3777
+ ['application/json'],
3778
+ ['application/json']
3779
+ );
3780
+ }
3781
+
3615
3782
  /**
3616
3783
  * Update wrap-up code
3617
3784
  *