purecloud-platform-client-v2 212.0.0 → 213.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 (91) hide show
  1. package/README.md +18 -4
  2. package/dist/node/purecloud-platform-client-v2.js +767 -255
  3. package/dist/web-amd/purecloud-platform-client-v2.js +768 -255
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +430 -293
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +660 -6380
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +441 -2
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +21 -18
  11. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +28 -2
  16. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +35 -18
  25. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GamificationApi.js +57 -1
  35. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GroupsApi.js +2 -2
  39. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OutboundApi.js +7 -3
  59. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +288 -1
  75. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +119 -1
  91. package/src/purecloud-platform-client-v2/index.js +8 -3
@@ -1,8 +1,7 @@
1
- define(['https', 'axios', 'qs'], (function (https, axios, qs) { 'use strict';
1
+ define(['axios', 'qs'], (function (axios, qs) { 'use strict';
2
2
 
3
3
  function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
4
4
 
5
- var https__default = /*#__PURE__*/_interopDefaultLegacy(https);
6
5
  var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
7
6
  var qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
8
7
 
@@ -24,6 +23,138 @@ define(['https', 'axios', 'qs'], (function (https, axios, qs) { 'use strict';
24
23
  eu_central_2: 'euc2.pure.cloud',
25
24
  };
26
25
 
26
+ class AbstractHttpClient {
27
+
28
+ constructor() {
29
+ this.timeout = 16000;
30
+ }
31
+
32
+ setTimeout(timeout) {
33
+ if (timeout === null || timeout === undefined || typeof timeout !== 'number') {
34
+ throw new Error("The 'timeout' property must be a number");
35
+ }
36
+ this.timeout = timeout;
37
+ }
38
+
39
+ setHttpsAgent(httpsAgent) {
40
+ if (httpsAgent && typeof httpsAgent !== 'object') {
41
+ throw new Error("The 'httpsAgent' property must be an object");
42
+ }
43
+ this.httpsAgent = httpsAgent;
44
+ }
45
+
46
+ request(httpRequestOptions) {
47
+ throw new Error("method must be implemented");
48
+ }
49
+ }
50
+
51
+ class HttpRequestOptions {
52
+
53
+ constructor(url, method, headers, params, data, timeout) {
54
+ this.setUrl(url);
55
+ this.setMethod(method);
56
+ if (headers) {
57
+ this.setHeaders(headers);
58
+ }
59
+ if (params) {
60
+ this.setParams(params);
61
+ }
62
+ if (data) {
63
+ this.setData(data);
64
+ }
65
+ if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
66
+ else this.timeout = 16000;
67
+ }
68
+
69
+ // Mandatory fields with validation
70
+ setUrl(url) {
71
+ if (!url) throw new Error("The 'url' property is required");
72
+ this.url = url;
73
+ }
74
+
75
+ setMethod(method) {
76
+ const validMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD'];
77
+ if (!method || !validMethods.includes(method.toUpperCase())) {
78
+ throw new Error("The 'method' property is invalid or missing");
79
+ }
80
+ this.method = method.toUpperCase();
81
+ }
82
+
83
+ setData(data) {
84
+ if (data === undefined || data === null) {
85
+ throw new Error("The 'data' property is required");
86
+ }
87
+ this.data = data;
88
+ }
89
+
90
+ // Optional fields
91
+ setParams(params) {
92
+ if (params && typeof params !== 'object') {
93
+ throw new Error("The 'params' property must be an object");
94
+ }
95
+ this.params = params;
96
+ }
97
+
98
+ // Optional fields
99
+ setHeaders(headers) {
100
+ if (headers && typeof headers !== 'object') {
101
+ throw new Error("The 'headers' property must be an object");
102
+ }
103
+ this.headers = headers;
104
+ }
105
+
106
+ setTimeout(timeout) {
107
+ if (timeout === undefined || timeout === null || typeof timeout !== 'number') {
108
+ throw new Error("The 'timeout' property must be a number");
109
+ }
110
+ this.timeout = timeout;
111
+ }
112
+
113
+ }
114
+
115
+ // Default client is Axios
116
+ class DefaultHttpClient extends AbstractHttpClient{
117
+
118
+ constructor(timeout, httpsAgent) {
119
+ super();
120
+ if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
121
+ else this.timeout = 16000;
122
+ if (httpsAgent !== null && httpsAgent !== undefined) this.setHttpsAgent(httpsAgent);
123
+ else this.httpsAgent;
124
+ this._axiosInstance = axios__default["default"].create({});
125
+ }
126
+
127
+ request(httpRequestOptions) {
128
+ if(!(httpRequestOptions instanceof HttpRequestOptions)) {
129
+ throw new Error(`httpRequestOptions must be instance of HttpRequestOptions `);
130
+ }
131
+ const config = this.toAxiosConfig(httpRequestOptions);
132
+ return this._axiosInstance.request(config);
133
+ }
134
+
135
+ // Method to generate Axios-compatible config
136
+ toAxiosConfig(httpRequestOptions) {
137
+ if (!httpRequestOptions.url || !httpRequestOptions.method) {
138
+ throw new Error(
139
+ "Mandatory fields 'url' and 'method' must be set before making a request"
140
+ );
141
+ }
142
+
143
+ var config = {
144
+ url: httpRequestOptions.url,
145
+ method: httpRequestOptions.method
146
+ };
147
+
148
+ if (httpRequestOptions.params) config.params = httpRequestOptions.params;
149
+ if (httpRequestOptions.headers) config.headers = httpRequestOptions.headers;
150
+ if(httpRequestOptions.data) config.data = httpRequestOptions.data;
151
+ if (this.timeout != null && this.timeout != undefined) config.timeout = this.timeout;
152
+ if (this.httpsAgent) config.httpsAgent = this.httpsAgent;
153
+
154
+ return config;
155
+ }
156
+ }
157
+
27
158
  const logLevels = {
28
159
  levels: {
29
160
  none: 0,
@@ -484,141 +615,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
484
615
  }
485
616
  }
486
617
 
487
- class AbstractHttpClient {
488
-
489
- constructor() {
490
- this.timeout = 16000;
491
- }
492
-
493
- setTimeout(timeout) {
494
- if (timeout === null || timeout === undefined || typeof timeout !== 'number') {
495
- throw new Error("The 'timeout' property must be a number");
496
- }
497
- this.timeout = timeout;
498
- }
499
-
500
- setHttpsAgent(httpsAgent) {
501
- if (httpsAgent && typeof httpsAgent !== 'object') {
502
- throw new Error("The 'httpsAgent' property must be an object");
503
- }
504
- this.httpsAgent = httpsAgent;
505
- }
506
-
507
- request(httpRequestOptions) {
508
- throw new Error("method must be implemented");
509
- }
510
- }
511
-
512
- class HttpRequestOptions {
513
-
514
- constructor(url, method, headers, params, data, timeout) {
515
- this.setUrl(url);
516
- this.setMethod(method);
517
- if (headers) {
518
- this.setHeaders(headers);
519
- }
520
- if (params) {
521
- this.setParams(params);
522
- }
523
- if (data) {
524
- this.setData(data);
525
- }
526
- if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
527
- else this.timeout = 16000;
528
- }
529
-
530
- // Mandatory fields with validation
531
- setUrl(url) {
532
- if (!url) throw new Error("The 'url' property is required");
533
- this.url = url;
534
- }
535
-
536
- setMethod(method) {
537
- const validMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS', 'HEAD'];
538
- if (!method || !validMethods.includes(method.toUpperCase())) {
539
- throw new Error("The 'method' property is invalid or missing");
540
- }
541
- this.method = method.toUpperCase();
542
- }
543
-
544
- setData(data) {
545
- if (data === undefined || data === null) {
546
- throw new Error("The 'data' property is required");
547
- }
548
- this.data = data;
549
- }
550
-
551
- // Optional fields
552
- setParams(params) {
553
- if (params && typeof params !== 'object') {
554
- throw new Error("The 'params' property must be an object");
555
- }
556
- this.params = params;
557
- }
558
-
559
- // Optional fields
560
- setHeaders(headers) {
561
- if (headers && typeof headers !== 'object') {
562
- throw new Error("The 'headers' property must be an object");
563
- }
564
- this.headers = headers;
565
- }
566
-
567
- setTimeout(timeout) {
568
- if (timeout === undefined || timeout === null || typeof timeout !== 'number') {
569
- throw new Error("The 'timeout' property must be a number");
570
- }
571
- this.timeout = timeout;
572
- }
573
-
574
- }
575
-
576
- // Default client is Axios
577
- class DefaultHttpClient extends AbstractHttpClient{
578
-
579
- constructor(timeout, httpsAgent) {
580
- super();
581
- if (timeout !== null && timeout !== undefined) this.setTimeout(timeout);
582
- else this.timeout = 16000;
583
- if (httpsAgent !== null && httpsAgent !== undefined) this.setHttpsAgent(httpsAgent);
584
- else this.httpsAgent;
585
- this._axiosInstance = axios__default["default"].create({});
586
- }
587
-
588
- request(httpRequestOptions) {
589
- if(!(httpRequestOptions instanceof HttpRequestOptions)) {
590
- throw new Error(`httpRequestOptions must be instance of HttpRequestOptions `);
591
- }
592
- const config = this.toAxiosConfig(httpRequestOptions);
593
- return this._axiosInstance.request(config);
594
- }
595
-
596
- // Method to generate Axios-compatible config
597
- toAxiosConfig(httpRequestOptions) {
598
- if (!httpRequestOptions.url || !httpRequestOptions.method) {
599
- throw new Error(
600
- "Mandatory fields 'url' and 'method' must be set before making a request"
601
- );
602
- }
603
-
604
- var config = {
605
- url: httpRequestOptions.url,
606
- method: httpRequestOptions.method
607
- };
608
-
609
- if (httpRequestOptions.params) config.params = httpRequestOptions.params;
610
- if (httpRequestOptions.headers) config.headers = httpRequestOptions.headers;
611
- if(httpRequestOptions.data) config.data = httpRequestOptions.data;
612
- if (this.timeout != null && this.timeout != undefined) config.timeout = this.timeout;
613
- if (this.httpsAgent) config.httpsAgent = this.httpsAgent;
614
-
615
- return config;
616
- }
617
- }
618
-
619
618
  /**
620
619
  * @module purecloud-platform-client-v2/ApiClient
621
- * @version 212.0.0
620
+ * @version 213.0.0
622
621
  */
623
622
  class ApiClient {
624
623
  /**
@@ -865,11 +864,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
865
864
 
866
865
  agentOptions.rejectUnauthorized = true;
867
866
 
868
- this.proxyAgent = new https__default["default"].Agent(agentOptions);
867
+ this.proxyAgent = new require('https').Agent(agentOptions);
869
868
  const httpClient = this.getHttpClient();
870
869
  httpClient.setHttpsAgent(this.proxyAgent);
871
870
  } else {
872
- throw new Error("Custom Agent Paths/ File System Access are not supported on Browser. Use setMTLSContents instead");
871
+ throw new Error("MTLS authentication is managed by the Browser itself. MTLS certificates cannot be set via code on Browser.");
873
872
  }
874
873
  }
875
874
 
@@ -880,24 +879,28 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
880
879
  * @param {string} caContent - content for public certs
881
880
  */
882
881
  setMTLSContents(certContent, keyContent, caContent) {
883
- const agentOptions = {};
884
- if (certContent) {
885
- agentOptions.cert = certContent;
886
- }
882
+ if (typeof window === 'undefined') {
883
+ const agentOptions = {};
884
+ if (certContent) {
885
+ agentOptions.cert = certContent;
886
+ }
887
887
 
888
- if (keyContent) {
889
- agentOptions.key = keyContent;
890
- }
888
+ if (keyContent) {
889
+ agentOptions.key = keyContent;
890
+ }
891
891
 
892
- if (caContent) {
893
- agentOptions.ca = caContent;
894
- }
892
+ if (caContent) {
893
+ agentOptions.ca = caContent;
894
+ }
895
895
 
896
- agentOptions.rejectUnauthorized = true;
896
+ agentOptions.rejectUnauthorized = true;
897
897
 
898
- this.proxyAgent = new https__default["default"].Agent(agentOptions);
899
- const httpClient = this.getHttpClient();
900
- httpClient.setHttpsAgent(this.proxyAgent);
898
+ this.proxyAgent = new require('https').Agent(agentOptions);
899
+ const httpClient = this.getHttpClient();
900
+ httpClient.setHttpsAgent(this.proxyAgent);
901
+ } else {
902
+ throw new Error("MTLS authentication is managed by the Browser itself. MTLS certificates cannot be set via code on Browser.");
903
+ }
901
904
  }
902
905
 
903
906
  /**
@@ -2138,7 +2141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2138
2141
  /**
2139
2142
  * AgentAssistants service.
2140
2143
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
2141
- * @version 212.0.0
2144
+ * @version 213.0.0
2142
2145
  */
2143
2146
 
2144
2147
  /**
@@ -2514,7 +2517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2514
2517
  /**
2515
2518
  * AgentCopilot service.
2516
2519
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
2517
- * @version 212.0.0
2520
+ * @version 213.0.0
2518
2521
  */
2519
2522
 
2520
2523
  /**
@@ -2590,7 +2593,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2590
2593
  /**
2591
2594
  * AgentUI service.
2592
2595
  * @module purecloud-platform-client-v2/api/AgentUIApi
2593
- * @version 212.0.0
2596
+ * @version 213.0.0
2594
2597
  */
2595
2598
 
2596
2599
  /**
@@ -2721,7 +2724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2721
2724
  /**
2722
2725
  * Alerting service.
2723
2726
  * @module purecloud-platform-client-v2/api/AlertingApi
2724
- * @version 212.0.0
2727
+ * @version 213.0.0
2725
2728
  */
2726
2729
 
2727
2730
  /**
@@ -3382,7 +3385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3382
3385
  /**
3383
3386
  * Analytics service.
3384
3387
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3385
- * @version 212.0.0
3388
+ * @version 213.0.0
3386
3389
  */
3387
3390
 
3388
3391
  /**
@@ -4351,6 +4354,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4351
4354
  * @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard
4352
4355
  * @param {Object} opts Optional parameters
4353
4356
  * @param {String} opts.name name of the dashboard
4357
+ * @param {Object} opts.dashboardState List dashboard of given state (default to Active)
4354
4358
  * @param {String} opts.sortBy (default to desc)
4355
4359
  * @param {Number} opts.pageNumber (default to 1)
4356
4360
  * @param {Number} opts.pageSize (default to 9)
@@ -4371,7 +4375,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4371
4375
  '/api/v2/analytics/reporting/settings/dashboards/query',
4372
4376
  'GET',
4373
4377
  { },
4374
- { 'name': opts['name'],'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
4378
+ { 'name': opts['name'],'dashboardType': dashboardType,'dashboardState': opts['dashboardState'],'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
4375
4379
  { },
4376
4380
  { },
4377
4381
  null,
@@ -5729,6 +5733,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
5729
5733
  );
5730
5734
  }
5731
5735
 
5736
+ /**
5737
+ * Query for resolution aggregates
5738
+ *
5739
+ * @param {Object} body query
5740
+ */
5741
+ postAnalyticsResolutionsAggregatesQuery(body) {
5742
+ // verify the required parameter 'body' is set
5743
+ if (body === undefined || body === null) {
5744
+ throw 'Missing the required parameter "body" when calling postAnalyticsResolutionsAggregatesQuery';
5745
+ }
5746
+
5747
+ return this.apiClient.callApi(
5748
+ '/api/v2/analytics/resolutions/aggregates/query',
5749
+ 'POST',
5750
+ { },
5751
+ { },
5752
+ { },
5753
+ { },
5754
+ body,
5755
+ ['PureCloud OAuth'],
5756
+ ['application/json'],
5757
+ ['application/json']
5758
+ );
5759
+ }
5760
+
5732
5761
  /**
5733
5762
  * Query for user activity observations
5734
5763
  *
@@ -6181,7 +6210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6181
6210
  /**
6182
6211
  * Architect service.
6183
6212
  * @module purecloud-platform-client-v2/api/ArchitectApi
6184
- * @version 212.0.0
6213
+ * @version 213.0.0
6185
6214
  */
6186
6215
 
6187
6216
  /**
@@ -10303,7 +10332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10303
10332
  /**
10304
10333
  * Audit service.
10305
10334
  * @module purecloud-platform-client-v2/api/AuditApi
10306
- * @version 212.0.0
10335
+ * @version 213.0.0
10307
10336
  */
10308
10337
 
10309
10338
  /**
@@ -10504,7 +10533,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10504
10533
  /**
10505
10534
  * Authorization service.
10506
10535
  * @module purecloud-platform-client-v2/api/AuthorizationApi
10507
- * @version 212.0.0
10536
+ * @version 213.0.0
10508
10537
  */
10509
10538
 
10510
10539
  /**
@@ -11787,7 +11816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11787
11816
  /**
11788
11817
  * Billing service.
11789
11818
  * @module purecloud-platform-client-v2/api/BillingApi
11790
- * @version 212.0.0
11819
+ * @version 213.0.0
11791
11820
  */
11792
11821
 
11793
11822
  /**
@@ -11867,7 +11896,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11867
11896
  /**
11868
11897
  * CarrierServices service.
11869
11898
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
11870
- * @version 212.0.0
11899
+ * @version 213.0.0
11871
11900
  */
11872
11901
 
11873
11902
  /**
@@ -11937,7 +11966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11937
11966
  /**
11938
11967
  * Chat service.
11939
11968
  * @module purecloud-platform-client-v2/api/ChatApi
11940
- * @version 212.0.0
11969
+ * @version 213.0.0
11941
11970
  */
11942
11971
 
11943
11972
  /**
@@ -12873,7 +12902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12873
12902
  /**
12874
12903
  * Coaching service.
12875
12904
  * @module purecloud-platform-client-v2/api/CoachingApi
12876
- * @version 212.0.0
12905
+ * @version 213.0.0
12877
12906
  */
12878
12907
 
12879
12908
  /**
@@ -13450,7 +13479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13450
13479
  /**
13451
13480
  * ContentManagement service.
13452
13481
  * @module purecloud-platform-client-v2/api/ContentManagementApi
13453
- * @version 212.0.0
13482
+ * @version 213.0.0
13454
13483
  */
13455
13484
 
13456
13485
  /**
@@ -14531,7 +14560,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14531
14560
  /**
14532
14561
  * Conversations service.
14533
14562
  * @module purecloud-platform-client-v2/api/ConversationsApi
14534
- * @version 212.0.0
14563
+ * @version 213.0.0
14535
14564
  */
14536
14565
 
14537
14566
  /**
@@ -15707,8 +15736,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15707
15736
 
15708
15737
  /**
15709
15738
  * Get chat conversation
15710
- *
15739
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
15711
15740
  * @param {String} conversationId conversationId
15741
+ * @deprecated
15712
15742
  */
15713
15743
  getConversationsChat(conversationId) {
15714
15744
  // verify the required parameter 'conversationId' is set
@@ -15732,9 +15762,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15732
15762
 
15733
15763
  /**
15734
15764
  * Get a web chat conversation message
15735
- * The current user must be involved with the conversation to get its messages.
15765
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
15736
15766
  * @param {String} conversationId conversationId
15737
15767
  * @param {String} messageId messageId
15768
+ * @deprecated
15738
15769
  */
15739
15770
  getConversationsChatMessage(conversationId, messageId) {
15740
15771
  // verify the required parameter 'conversationId' is set
@@ -15762,13 +15793,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15762
15793
 
15763
15794
  /**
15764
15795
  * Get the messages of a chat conversation.
15765
- * The current user must be involved with the conversation to get its messages.
15796
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
15766
15797
  * @param {String} conversationId conversationId
15767
15798
  * @param {Object} opts Optional parameters
15768
15799
  * @param {String} opts.after If specified, get the messages chronologically after the id of this message
15769
15800
  * @param {String} opts.before If specified, get the messages chronologically before the id of this message
15770
15801
  * @param {Object} opts.sortOrder Sort order (default to ascending)
15771
15802
  * @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
15803
+ * @deprecated
15772
15804
  */
15773
15805
  getConversationsChatMessages(conversationId, opts) {
15774
15806
  opts = opts || {};
@@ -15794,12 +15826,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15794
15826
 
15795
15827
  /**
15796
15828
  * Get the wrap-up for this conversation communication.
15797
- *
15829
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
15798
15830
  * @param {String} conversationId conversationId
15799
15831
  * @param {String} participantId participantId
15800
15832
  * @param {String} communicationId communicationId
15801
15833
  * @param {Object} opts Optional parameters
15802
15834
  * @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
15835
+ * @deprecated
15803
15836
  */
15804
15837
  getConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
15805
15838
  opts = opts || {};
@@ -15833,11 +15866,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15833
15866
 
15834
15867
  /**
15835
15868
  * Get the wrap-up for this conversation participant.
15836
- *
15869
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
15837
15870
  * @param {String} conversationId conversationId
15838
15871
  * @param {String} participantId participantId
15839
15872
  * @param {Object} opts Optional parameters
15840
15873
  * @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
15874
+ * @deprecated
15841
15875
  */
15842
15876
  getConversationsChatParticipantWrapup(conversationId, participantId, opts) {
15843
15877
  opts = opts || {};
@@ -15867,9 +15901,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15867
15901
 
15868
15902
  /**
15869
15903
  * Get list of wrapup codes for this conversation participant
15870
- *
15904
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
15871
15905
  * @param {String} conversationId conversationId
15872
15906
  * @param {String} participantId participantId
15907
+ * @deprecated
15873
15908
  */
15874
15909
  getConversationsChatParticipantWrapupcodes(conversationId, participantId) {
15875
15910
  // verify the required parameter 'conversationId' is set
@@ -15897,7 +15932,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15897
15932
 
15898
15933
  /**
15899
15934
  * Get active chat conversations for the logged in user
15900
- *
15935
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
15936
+ * @deprecated
15901
15937
  */
15902
15938
  getConversationsChats() {
15903
15939
 
@@ -17819,9 +17855,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17819
17855
 
17820
17856
  /**
17821
17857
  * Update a conversation by disconnecting all of the participants
17822
- *
17858
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
17823
17859
  * @param {String} conversationId conversationId
17824
17860
  * @param {Object} body Conversation
17861
+ * @deprecated
17825
17862
  */
17826
17863
  patchConversationsChat(conversationId, body) {
17827
17864
  // verify the required parameter 'conversationId' is set
@@ -17849,10 +17886,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17849
17886
 
17850
17887
  /**
17851
17888
  * Update conversation participant
17852
- *
17889
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
17853
17890
  * @param {String} conversationId conversationId
17854
17891
  * @param {String} participantId participantId
17855
17892
  * @param {Object} body Update request
17893
+ * @deprecated
17856
17894
  */
17857
17895
  patchConversationsChatParticipant(conversationId, participantId, body) {
17858
17896
  // verify the required parameter 'conversationId' is set
@@ -17884,10 +17922,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17884
17922
 
17885
17923
  /**
17886
17924
  * Update the attributes on a conversation participant.
17887
- *
17925
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
17888
17926
  * @param {String} conversationId conversationId
17889
17927
  * @param {String} participantId participantId
17890
17928
  * @param {Object} body Participant attributes
17929
+ * @deprecated
17891
17930
  */
17892
17931
  patchConversationsChatParticipantAttributes(conversationId, participantId, body) {
17893
17932
  // verify the required parameter 'conversationId' is set
@@ -17919,11 +17958,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17919
17958
 
17920
17959
  /**
17921
17960
  * Update conversation participant's communication by disconnecting it.
17922
- *
17961
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
17923
17962
  * @param {String} conversationId conversationId
17924
17963
  * @param {String} participantId participantId
17925
17964
  * @param {String} communicationId communicationId
17926
17965
  * @param {Object} body Participant
17966
+ * @deprecated
17927
17967
  */
17928
17968
  patchConversationsChatParticipantCommunication(conversationId, participantId, communicationId, body) {
17929
17969
  // verify the required parameter 'conversationId' is set
@@ -19826,10 +19866,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19826
19866
 
19827
19867
  /**
19828
19868
  * Send a message on behalf of a communication in a chat conversation.
19829
- *
19869
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
19830
19870
  * @param {String} conversationId conversationId
19831
19871
  * @param {String} communicationId communicationId
19832
19872
  * @param {Object} body Message
19873
+ * @deprecated
19833
19874
  */
19834
19875
  postConversationsChatCommunicationMessages(conversationId, communicationId, body) {
19835
19876
  // verify the required parameter 'conversationId' is set
@@ -19861,9 +19902,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19861
19902
 
19862
19903
  /**
19863
19904
  * Send a typing-indicator on behalf of a communication in a chat conversation.
19864
- *
19905
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
19865
19906
  * @param {String} conversationId conversationId
19866
19907
  * @param {String} communicationId communicationId
19908
+ * @deprecated
19867
19909
  */
19868
19910
  postConversationsChatCommunicationTyping(conversationId, communicationId) {
19869
19911
  // verify the required parameter 'conversationId' is set
@@ -19891,12 +19933,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19891
19933
 
19892
19934
  /**
19893
19935
  * Apply wrap-up for this conversation communication
19894
- *
19936
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
19895
19937
  * @param {String} conversationId conversationId
19896
19938
  * @param {String} participantId participantId
19897
19939
  * @param {String} communicationId communicationId
19898
19940
  * @param {Object} opts Optional parameters
19899
19941
  * @param {Object} opts.body Wrap-up
19942
+ * @deprecated
19900
19943
  */
19901
19944
  postConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
19902
19945
  opts = opts || {};
@@ -19930,10 +19973,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19930
19973
 
19931
19974
  /**
19932
19975
  * Replace this participant with the specified user and/or address
19933
- *
19976
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
19934
19977
  * @param {String} conversationId conversationId
19935
19978
  * @param {String} participantId participantId
19936
19979
  * @param {Object} body Transfer request
19980
+ * @deprecated
19937
19981
  */
19938
19982
  postConversationsChatParticipantReplace(conversationId, participantId, body) {
19939
19983
  // verify the required parameter 'conversationId' is set
@@ -19965,8 +20009,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19965
20009
 
19966
20010
  /**
19967
20011
  * Create a web chat conversation
19968
- *
20012
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
19969
20013
  * @param {Object} body Create web chat request
20014
+ * @deprecated
19970
20015
  */
19971
20016
  postConversationsChats(body) {
19972
20017
  // verify the required parameter 'body' is set
@@ -21326,9 +21371,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21326
21371
 
21327
21372
  /**
21328
21373
  * Update a conversation by setting its recording state
21329
- *
21374
+ * This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
21330
21375
  * @param {String} conversationId conversationId
21331
21376
  * @param {Object} body SetRecordingState
21377
+ * @deprecated
21332
21378
  */
21333
21379
  putConversationsChatRecordingstate(conversationId, body) {
21334
21380
  // verify the required parameter 'conversationId' is set
@@ -21676,7 +21722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21676
21722
  /**
21677
21723
  * DataExtensions service.
21678
21724
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
21679
- * @version 212.0.0
21725
+ * @version 213.0.0
21680
21726
  */
21681
21727
 
21682
21728
  /**
@@ -21762,7 +21808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21762
21808
  /**
21763
21809
  * DataPrivacy service.
21764
21810
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
21765
- * @version 212.0.0
21811
+ * @version 213.0.0
21766
21812
  */
21767
21813
 
21768
21814
  /**
@@ -21932,7 +21978,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21932
21978
  /**
21933
21979
  * Downloads service.
21934
21980
  * @module purecloud-platform-client-v2/api/DownloadsApi
21935
- * @version 212.0.0
21981
+ * @version 213.0.0
21936
21982
  */
21937
21983
 
21938
21984
  /**
@@ -21984,7 +22030,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21984
22030
  /**
21985
22031
  * Emails service.
21986
22032
  * @module purecloud-platform-client-v2/api/EmailsApi
21987
- * @version 212.0.0
22033
+ * @version 213.0.0
21988
22034
  */
21989
22035
 
21990
22036
  /**
@@ -22049,7 +22095,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22049
22095
  /**
22050
22096
  * EmployeeEngagement service.
22051
22097
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
22052
- * @version 212.0.0
22098
+ * @version 213.0.0
22053
22099
  */
22054
22100
 
22055
22101
  /**
@@ -22200,7 +22246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22200
22246
  /**
22201
22247
  * Events service.
22202
22248
  * @module purecloud-platform-client-v2/api/EventsApi
22203
- * @version 212.0.0
22249
+ * @version 213.0.0
22204
22250
  */
22205
22251
 
22206
22252
  /**
@@ -22296,7 +22342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22296
22342
  /**
22297
22343
  * ExternalContacts service.
22298
22344
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
22299
- * @version 212.0.0
22345
+ * @version 213.0.0
22300
22346
  */
22301
22347
 
22302
22348
  /**
@@ -24861,7 +24907,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24861
24907
  /**
24862
24908
  * Fax service.
24863
24909
  * @module purecloud-platform-client-v2/api/FaxApi
24864
- * @version 212.0.0
24910
+ * @version 213.0.0
24865
24911
  */
24866
24912
 
24867
24913
  /**
@@ -25076,7 +25122,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25076
25122
  /**
25077
25123
  * Flows service.
25078
25124
  * @module purecloud-platform-client-v2/api/FlowsApi
25079
- * @version 212.0.0
25125
+ * @version 213.0.0
25080
25126
  */
25081
25127
 
25082
25128
  /**
@@ -25259,7 +25305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25259
25305
  /**
25260
25306
  * Gamification service.
25261
25307
  * @module purecloud-platform-client-v2/api/GamificationApi
25262
- * @version 212.0.0
25308
+ * @version 213.0.0
25263
25309
  */
25264
25310
 
25265
25311
  /**
@@ -25598,6 +25644,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25598
25644
  );
25599
25645
  }
25600
25646
 
25647
+ /**
25648
+ * Get insights rankings
25649
+ *
25650
+ * @param {Object} filterType Filter type for the query request.
25651
+ * @param {String} filterId ID for the filter type.
25652
+ * @param {Object} granularity Granularity
25653
+ * @param {String} comparativePeriodStartWorkday The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
25654
+ * @param {String} primaryPeriodStartWorkday The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
25655
+ * @param {Object} sortKey Sort key
25656
+ * @param {Object} opts Optional parameters
25657
+ * @param {String} opts.sortMetricId Sort Metric Id
25658
+ * @param {Number} opts.sectionSize The number of top and bottom users to return before ties
25659
+ * @param {String} opts.userIds A list of up to 100 comma-separated user Ids
25660
+ */
25661
+ getGamificationInsightsRankings(filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, sortKey, opts) {
25662
+ opts = opts || {};
25663
+
25664
+ // verify the required parameter 'filterType' is set
25665
+ if (filterType === undefined || filterType === null) {
25666
+ throw 'Missing the required parameter "filterType" when calling getGamificationInsightsRankings';
25667
+ }
25668
+ // verify the required parameter 'filterId' is set
25669
+ if (filterId === undefined || filterId === null) {
25670
+ throw 'Missing the required parameter "filterId" when calling getGamificationInsightsRankings';
25671
+ }
25672
+ // verify the required parameter 'granularity' is set
25673
+ if (granularity === undefined || granularity === null) {
25674
+ throw 'Missing the required parameter "granularity" when calling getGamificationInsightsRankings';
25675
+ }
25676
+ // verify the required parameter 'comparativePeriodStartWorkday' is set
25677
+ if (comparativePeriodStartWorkday === undefined || comparativePeriodStartWorkday === null) {
25678
+ throw 'Missing the required parameter "comparativePeriodStartWorkday" when calling getGamificationInsightsRankings';
25679
+ }
25680
+ // verify the required parameter 'primaryPeriodStartWorkday' is set
25681
+ if (primaryPeriodStartWorkday === undefined || primaryPeriodStartWorkday === null) {
25682
+ throw 'Missing the required parameter "primaryPeriodStartWorkday" when calling getGamificationInsightsRankings';
25683
+ }
25684
+ // verify the required parameter 'sortKey' is set
25685
+ if (sortKey === undefined || sortKey === null) {
25686
+ throw 'Missing the required parameter "sortKey" when calling getGamificationInsightsRankings';
25687
+ }
25688
+
25689
+ return this.apiClient.callApi(
25690
+ '/api/v2/gamification/insights/rankings',
25691
+ 'GET',
25692
+ { },
25693
+ { 'filterType': filterType,'filterId': filterId,'granularity': granularity,'comparativePeriodStartWorkday': comparativePeriodStartWorkday,'primaryPeriodStartWorkday': primaryPeriodStartWorkday,'sortKey': sortKey,'sortMetricId': opts['sortMetricId'],'sectionSize': opts['sectionSize'],'userIds': opts['userIds'] },
25694
+ { },
25695
+ { },
25696
+ null,
25697
+ ['PureCloud OAuth'],
25698
+ ['application/json'],
25699
+ ['application/json']
25700
+ );
25701
+ }
25702
+
25601
25703
  /**
25602
25704
  * Get insights user trend for the current user
25603
25705
  *
@@ -27345,7 +27447,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27345
27447
  /**
27346
27448
  * GeneralDataProtectionRegulation service.
27347
27449
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
27348
- * @version 212.0.0
27450
+ * @version 213.0.0
27349
27451
  */
27350
27452
 
27351
27453
  /**
@@ -27475,7 +27577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27475
27577
  /**
27476
27578
  * Geolocation service.
27477
27579
  * @module purecloud-platform-client-v2/api/GeolocationApi
27478
- * @version 212.0.0
27580
+ * @version 213.0.0
27479
27581
  */
27480
27582
 
27481
27583
  /**
@@ -27606,7 +27708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27606
27708
  /**
27607
27709
  * Greetings service.
27608
27710
  * @module purecloud-platform-client-v2/api/GreetingsApi
27609
- * @version 212.0.0
27711
+ * @version 213.0.0
27610
27712
  */
27611
27713
 
27612
27714
  /**
@@ -28061,7 +28163,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28061
28163
  /**
28062
28164
  * Groups service.
28063
28165
  * @module purecloud-platform-client-v2/api/GroupsApi
28064
- * @version 212.0.0
28166
+ * @version 213.0.0
28065
28167
  */
28066
28168
 
28067
28169
  /**
@@ -28131,7 +28233,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28131
28233
  * Remove members
28132
28234
  *
28133
28235
  * @param {String} groupId Group ID
28134
- * @param {String} ids Comma separated list of userIds to remove
28236
+ * @param {String} ids Comma separated list of userIds to remove. A maximum of 50 members are allowed per request.
28135
28237
  */
28136
28238
  deleteGroupMembers(groupId, ids) {
28137
28239
  // verify the required parameter 'groupId' is set
@@ -28580,7 +28682,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28580
28682
  /**
28581
28683
  * IdentityProvider service.
28582
28684
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
28583
- * @version 212.0.0
28685
+ * @version 213.0.0
28584
28686
  */
28585
28687
 
28586
28688
  /**
@@ -29441,7 +29543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29441
29543
  /**
29442
29544
  * InfrastructureAsCode service.
29443
29545
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
29444
- * @version 212.0.0
29546
+ * @version 213.0.0
29445
29547
  */
29446
29548
 
29447
29549
  /**
@@ -29608,7 +29710,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29608
29710
  /**
29609
29711
  * Integrations service.
29610
29712
  * @module purecloud-platform-client-v2/api/IntegrationsApi
29611
- * @version 212.0.0
29713
+ * @version 213.0.0
29612
29714
  */
29613
29715
 
29614
29716
  /**
@@ -32050,7 +32152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32050
32152
  /**
32051
32153
  * Journey service.
32052
32154
  * @module purecloud-platform-client-v2/api/JourneyApi
32053
- * @version 212.0.0
32155
+ * @version 213.0.0
32054
32156
  */
32055
32157
 
32056
32158
  /**
@@ -34015,7 +34117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34015
34117
  /**
34016
34118
  * Knowledge service.
34017
34119
  * @module purecloud-platform-client-v2/api/KnowledgeApi
34018
- * @version 212.0.0
34120
+ * @version 213.0.0
34019
34121
  */
34020
34122
 
34021
34123
  /**
@@ -37891,7 +37993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37891
37993
  /**
37892
37994
  * LanguageUnderstanding service.
37893
37995
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
37894
- * @version 212.0.0
37996
+ * @version 213.0.0
37895
37997
  */
37896
37998
 
37897
37999
  /**
@@ -38924,7 +39026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38924
39026
  /**
38925
39027
  * Languages service.
38926
39028
  * @module purecloud-platform-client-v2/api/LanguagesApi
38927
- * @version 212.0.0
39029
+ * @version 213.0.0
38928
39030
  */
38929
39031
 
38930
39032
  /**
@@ -39146,7 +39248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39146
39248
  /**
39147
39249
  * Learning service.
39148
39250
  * @module purecloud-platform-client-v2/api/LearningApi
39149
- * @version 212.0.0
39251
+ * @version 213.0.0
39150
39252
  */
39151
39253
 
39152
39254
  /**
@@ -40175,7 +40277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40175
40277
  /**
40176
40278
  * License service.
40177
40279
  * @module purecloud-platform-client-v2/api/LicenseApi
40178
- * @version 212.0.0
40280
+ * @version 213.0.0
40179
40281
  */
40180
40282
 
40181
40283
  /**
@@ -40413,7 +40515,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40413
40515
  /**
40414
40516
  * Locations service.
40415
40517
  * @module purecloud-platform-client-v2/api/LocationsApi
40416
- * @version 212.0.0
40518
+ * @version 213.0.0
40417
40519
  */
40418
40520
 
40419
40521
  /**
@@ -40649,7 +40751,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40649
40751
  /**
40650
40752
  * LogCapture service.
40651
40753
  * @module purecloud-platform-client-v2/api/LogCaptureApi
40652
- * @version 212.0.0
40754
+ * @version 213.0.0
40653
40755
  */
40654
40756
 
40655
40757
  /**
@@ -40849,7 +40951,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40849
40951
  /**
40850
40952
  * Messaging service.
40851
40953
  * @module purecloud-platform-client-v2/api/MessagingApi
40852
- * @version 212.0.0
40954
+ * @version 213.0.0
40853
40955
  */
40854
40956
 
40855
40957
  /**
@@ -41208,7 +41310,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41208
41310
  /**
41209
41311
  * MobileDevices service.
41210
41312
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
41211
- * @version 212.0.0
41313
+ * @version 213.0.0
41212
41314
  */
41213
41315
 
41214
41316
  /**
@@ -41359,7 +41461,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41359
41461
  /**
41360
41462
  * Notifications service.
41361
41463
  * @module purecloud-platform-client-v2/api/NotificationsApi
41362
- * @version 212.0.0
41464
+ * @version 213.0.0
41363
41465
  */
41364
41466
 
41365
41467
  /**
@@ -41592,7 +41694,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41592
41694
  /**
41593
41695
  * OAuth service.
41594
41696
  * @module purecloud-platform-client-v2/api/OAuthApi
41595
- * @version 212.0.0
41697
+ * @version 213.0.0
41596
41698
  */
41597
41699
 
41598
41700
  /**
@@ -41958,7 +42060,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41958
42060
  /**
41959
42061
  * Objects service.
41960
42062
  * @module purecloud-platform-client-v2/api/ObjectsApi
41961
- * @version 212.0.0
42063
+ * @version 213.0.0
41962
42064
  */
41963
42065
 
41964
42066
  /**
@@ -42228,7 +42330,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42228
42330
  /**
42229
42331
  * OperationalEvents service.
42230
42332
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
42231
- * @version 212.0.0
42333
+ * @version 213.0.0
42232
42334
  */
42233
42335
 
42234
42336
  /**
@@ -42345,7 +42447,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42345
42447
  /**
42346
42448
  * Organization service.
42347
42449
  * @module purecloud-platform-client-v2/api/OrganizationApi
42348
- * @version 212.0.0
42450
+ * @version 213.0.0
42349
42451
  */
42350
42452
 
42351
42453
  /**
@@ -42887,7 +42989,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42887
42989
  /**
42888
42990
  * OrganizationAuthorization service.
42889
42991
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
42890
- * @version 212.0.0
42992
+ * @version 213.0.0
42891
42993
  */
42892
42994
 
42893
42995
  /**
@@ -44281,7 +44383,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44281
44383
  /**
44282
44384
  * Outbound service.
44283
44385
  * @module purecloud-platform-client-v2/api/OutboundApi
44284
- * @version 212.0.0
44386
+ * @version 213.0.0
44285
44387
  */
44286
44388
 
44287
44389
  /**
@@ -46578,6 +46680,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46578
46680
  * @param {Object} opts.type Campaign Type
46579
46681
  * @param {String} opts.senderSmsPhoneNumber Sender SMS Phone Number
46580
46682
  * @param {Array.<String>} opts.id A list of messaging campaign ids to bulk fetch
46683
+ * @param {String} opts.contentTemplateId Content template ID
46684
+ * @param {Object} opts.campaignStatus Campaign Status
46581
46685
  */
46582
46686
  getOutboundMessagingcampaigns(opts) {
46583
46687
  opts = opts || {};
@@ -46587,7 +46691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46587
46691
  '/api/v2/outbound/messagingcampaigns',
46588
46692
  'GET',
46589
46693
  { },
46590
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'contactListId': opts['contactListId'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'type': opts['type'],'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
46694
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'contactListId': opts['contactListId'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'type': opts['type'],'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'contentTemplateId': opts['contentTemplateId'],'campaignStatus': opts['campaignStatus'] },
46591
46695
  { },
46592
46696
  { },
46593
46697
  null,
@@ -46633,6 +46737,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46633
46737
  * @param {Object} opts.type Campaign Type
46634
46738
  * @param {Array.<String>} opts.id id
46635
46739
  * @param {String} opts.senderSmsPhoneNumber Sender SMS Phone Number
46740
+ * @param {String} opts.contentTemplateId Content template ID
46741
+ * @param {Object} opts.campaignStatus Campaign Status
46636
46742
  */
46637
46743
  getOutboundMessagingcampaignsDivisionviews(opts) {
46638
46744
  opts = opts || {};
@@ -46642,7 +46748,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46642
46748
  '/api/v2/outbound/messagingcampaigns/divisionviews',
46643
46749
  'GET',
46644
46750
  { },
46645
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'],'type': opts['type'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'] },
46751
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'],'type': opts['type'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'contentTemplateId': opts['contentTemplateId'],'campaignStatus': opts['campaignStatus'] },
46646
46752
  { },
46647
46753
  { },
46648
46754
  null,
@@ -48828,7 +48934,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48828
48934
  /**
48829
48935
  * Presence service.
48830
48936
  * @module purecloud-platform-client-v2/api/PresenceApi
48831
- * @version 212.0.0
48937
+ * @version 213.0.0
48832
48938
  */
48833
48939
 
48834
48940
  /**
@@ -49572,7 +49678,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49572
49678
  /**
49573
49679
  * ProcessAutomation service.
49574
49680
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
49575
- * @version 212.0.0
49681
+ * @version 213.0.0
49576
49682
  */
49577
49683
 
49578
49684
  /**
@@ -49811,7 +49917,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49811
49917
  /**
49812
49918
  * Quality service.
49813
49919
  * @module purecloud-platform-client-v2/api/QualityApi
49814
- * @version 212.0.0
49920
+ * @version 213.0.0
49815
49921
  */
49816
49922
 
49817
49923
  /**
@@ -51599,7 +51705,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51599
51705
  /**
51600
51706
  * Recording service.
51601
51707
  * @module purecloud-platform-client-v2/api/RecordingApi
51602
- * @version 212.0.0
51708
+ * @version 213.0.0
51603
51709
  */
51604
51710
 
51605
51711
  /**
@@ -53258,7 +53364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53258
53364
  /**
53259
53365
  * ResponseManagement service.
53260
53366
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
53261
- * @version 212.0.0
53367
+ * @version 213.0.0
53262
53368
  */
53263
53369
 
53264
53370
  /**
@@ -53768,7 +53874,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53768
53874
  /**
53769
53875
  * Routing service.
53770
53876
  * @module purecloud-platform-client-v2/api/RoutingApi
53771
- * @version 212.0.0
53877
+ * @version 213.0.0
53772
53878
  */
53773
53879
 
53774
53880
  /**
@@ -57920,7 +58026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57920
58026
  /**
57921
58027
  * SCIM service.
57922
58028
  * @module purecloud-platform-client-v2/api/SCIMApi
57923
- * @version 212.0.0
58029
+ * @version 213.0.0
57924
58030
  */
57925
58031
 
57926
58032
  /**
@@ -58797,7 +58903,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58797
58903
  /**
58798
58904
  * ScreenRecording service.
58799
58905
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
58800
- * @version 212.0.0
58906
+ * @version 213.0.0
58801
58907
  */
58802
58908
 
58803
58909
  /**
@@ -58842,7 +58948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58842
58948
  /**
58843
58949
  * Scripts service.
58844
58950
  * @module purecloud-platform-client-v2/api/ScriptsApi
58845
- * @version 212.0.0
58951
+ * @version 213.0.0
58846
58952
  */
58847
58953
 
58848
58954
  /**
@@ -59286,7 +59392,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59286
59392
  /**
59287
59393
  * Search service.
59288
59394
  * @module purecloud-platform-client-v2/api/SearchApi
59289
- * @version 212.0.0
59395
+ * @version 213.0.0
59290
59396
  */
59291
59397
 
59292
59398
  /**
@@ -60029,7 +60135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60029
60135
  /**
60030
60136
  * Settings service.
60031
60137
  * @module purecloud-platform-client-v2/api/SettingsApi
60032
- * @version 212.0.0
60138
+ * @version 213.0.0
60033
60139
  */
60034
60140
 
60035
60141
  /**
@@ -60249,7 +60355,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60249
60355
  /**
60250
60356
  * SocialMedia service.
60251
60357
  * @module purecloud-platform-client-v2/api/SocialMediaApi
60252
- * @version 212.0.0
60358
+ * @version 213.0.0
60253
60359
  */
60254
60360
 
60255
60361
  /**
@@ -61154,7 +61260,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61154
61260
  /**
61155
61261
  * SpeechTextAnalytics service.
61156
61262
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
61157
- * @version 212.0.0
61263
+ * @version 213.0.0
61158
61264
  */
61159
61265
 
61160
61266
  /**
@@ -62489,7 +62595,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62489
62595
  /**
62490
62596
  * Stations service.
62491
62597
  * @module purecloud-platform-client-v2/api/StationsApi
62492
- * @version 212.0.0
62598
+ * @version 213.0.0
62493
62599
  */
62494
62600
 
62495
62601
  /**
@@ -62591,7 +62697,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62591
62697
  /**
62592
62698
  * Suggest service.
62593
62699
  * @module purecloud-platform-client-v2/api/SuggestApi
62594
- * @version 212.0.0
62700
+ * @version 213.0.0
62595
62701
  */
62596
62702
 
62597
62703
  /**
@@ -62730,7 +62836,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62730
62836
  /**
62731
62837
  * TaskManagement service.
62732
62838
  * @module purecloud-platform-client-v2/api/TaskManagementApi
62733
- * @version 212.0.0
62839
+ * @version 213.0.0
62734
62840
  */
62735
62841
 
62736
62842
  /**
@@ -62795,6 +62901,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62795
62901
  );
62796
62902
  }
62797
62903
 
62904
+ /**
62905
+ * Delete a bulk add job
62906
+ *
62907
+ * @param {String} bulkJobId Bulk job id
62908
+ */
62909
+ deleteTaskmanagementWorkitemsBulkAddJob(bulkJobId) {
62910
+ // verify the required parameter 'bulkJobId' is set
62911
+ if (bulkJobId === undefined || bulkJobId === null) {
62912
+ throw 'Missing the required parameter "bulkJobId" when calling deleteTaskmanagementWorkitemsBulkAddJob';
62913
+ }
62914
+
62915
+ return this.apiClient.callApi(
62916
+ '/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}',
62917
+ 'DELETE',
62918
+ { 'bulkJobId': bulkJobId },
62919
+ { },
62920
+ { },
62921
+ { },
62922
+ null,
62923
+ ['PureCloud OAuth'],
62924
+ ['application/json'],
62925
+ ['application/json']
62926
+ );
62927
+ }
62928
+
62929
+ /**
62930
+ * Delete a Bulk job
62931
+ *
62932
+ * @param {String} bulkJobId Bulk job id
62933
+ */
62934
+ deleteTaskmanagementWorkitemsBulkTerminateJob(bulkJobId) {
62935
+ // verify the required parameter 'bulkJobId' is set
62936
+ if (bulkJobId === undefined || bulkJobId === null) {
62937
+ throw 'Missing the required parameter "bulkJobId" when calling deleteTaskmanagementWorkitemsBulkTerminateJob';
62938
+ }
62939
+
62940
+ return this.apiClient.callApi(
62941
+ '/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}',
62942
+ 'DELETE',
62943
+ { 'bulkJobId': bulkJobId },
62944
+ { },
62945
+ { },
62946
+ { },
62947
+ null,
62948
+ ['PureCloud OAuth'],
62949
+ ['application/json'],
62950
+ ['application/json']
62951
+ );
62952
+ }
62953
+
62798
62954
  /**
62799
62955
  * Delete a schema
62800
62956
  *
@@ -63278,6 +63434,133 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63278
63434
  );
63279
63435
  }
63280
63436
 
63437
+ /**
63438
+ * Get the bulk add job associated with the job id.
63439
+ *
63440
+ * @param {String} bulkJobId Bulk job id
63441
+ */
63442
+ getTaskmanagementWorkitemsBulkAddJob(bulkJobId) {
63443
+ // verify the required parameter 'bulkJobId' is set
63444
+ if (bulkJobId === undefined || bulkJobId === null) {
63445
+ throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkAddJob';
63446
+ }
63447
+
63448
+ return this.apiClient.callApi(
63449
+ '/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}',
63450
+ 'GET',
63451
+ { 'bulkJobId': bulkJobId },
63452
+ { },
63453
+ { },
63454
+ { },
63455
+ null,
63456
+ ['PureCloud OAuth'],
63457
+ ['application/json'],
63458
+ ['application/json']
63459
+ );
63460
+ }
63461
+
63462
+ /**
63463
+ * Get bulk add job results.
63464
+ *
63465
+ * @param {String} bulkJobId Bulk job id
63466
+ */
63467
+ getTaskmanagementWorkitemsBulkAddJobResults(bulkJobId) {
63468
+ // verify the required parameter 'bulkJobId' is set
63469
+ if (bulkJobId === undefined || bulkJobId === null) {
63470
+ throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkAddJobResults';
63471
+ }
63472
+
63473
+ return this.apiClient.callApi(
63474
+ '/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}/results',
63475
+ 'GET',
63476
+ { 'bulkJobId': bulkJobId },
63477
+ { },
63478
+ { },
63479
+ { },
63480
+ null,
63481
+ ['PureCloud OAuth'],
63482
+ ['application/json'],
63483
+ ['application/json']
63484
+ );
63485
+ }
63486
+
63487
+ /**
63488
+ * Get bulk jobs created by the currently logged in user.
63489
+ *
63490
+ * @param {Object} opts Optional parameters
63491
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
63492
+ * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
63493
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
63494
+ * @param {Object} opts.action The bulk job action.
63495
+ */
63496
+ getTaskmanagementWorkitemsBulkJobsUsersMe(opts) {
63497
+ opts = opts || {};
63498
+
63499
+
63500
+ return this.apiClient.callApi(
63501
+ '/api/v2/taskmanagement/workitems/bulk/jobs/users/me',
63502
+ 'GET',
63503
+ { },
63504
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'action': opts['action'] },
63505
+ { },
63506
+ { },
63507
+ null,
63508
+ ['PureCloud OAuth'],
63509
+ ['application/json'],
63510
+ ['application/json']
63511
+ );
63512
+ }
63513
+
63514
+ /**
63515
+ * Get the bulk job associated with the job id.
63516
+ *
63517
+ * @param {String} bulkJobId Bulk job id
63518
+ */
63519
+ getTaskmanagementWorkitemsBulkTerminateJob(bulkJobId) {
63520
+ // verify the required parameter 'bulkJobId' is set
63521
+ if (bulkJobId === undefined || bulkJobId === null) {
63522
+ throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkTerminateJob';
63523
+ }
63524
+
63525
+ return this.apiClient.callApi(
63526
+ '/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}',
63527
+ 'GET',
63528
+ { 'bulkJobId': bulkJobId },
63529
+ { },
63530
+ { },
63531
+ { },
63532
+ null,
63533
+ ['PureCloud OAuth'],
63534
+ ['application/json'],
63535
+ ['application/json']
63536
+ );
63537
+ }
63538
+
63539
+ /**
63540
+ * Get bulk terminate job results.
63541
+ *
63542
+ * @param {String} bulkJobId Bulk job id
63543
+ */
63544
+ getTaskmanagementWorkitemsBulkTerminateJobResults(bulkJobId) {
63545
+ // verify the required parameter 'bulkJobId' is set
63546
+ if (bulkJobId === undefined || bulkJobId === null) {
63547
+ throw 'Missing the required parameter "bulkJobId" when calling getTaskmanagementWorkitemsBulkTerminateJobResults';
63548
+ }
63549
+
63550
+ return this.apiClient.callApi(
63551
+ '/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}/results',
63552
+ 'GET',
63553
+ { 'bulkJobId': bulkJobId },
63554
+ { },
63555
+ { },
63556
+ { },
63557
+ null,
63558
+ ['PureCloud OAuth'],
63559
+ ['application/json'],
63560
+ ['application/json']
63561
+ );
63562
+ }
63563
+
63281
63564
  /**
63282
63565
  * Get the workitem query job associated with the job id.
63283
63566
  *
@@ -63943,6 +64226,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63943
64226
  );
63944
64227
  }
63945
64228
 
64229
+ /**
64230
+ * Update workitem bulk add job.
64231
+ *
64232
+ * @param {String} bulkJobId Bulk job id
64233
+ * @param {Object} body Bulk add job update request
64234
+ */
64235
+ patchTaskmanagementWorkitemsBulkAddJob(bulkJobId, body) {
64236
+ // verify the required parameter 'bulkJobId' is set
64237
+ if (bulkJobId === undefined || bulkJobId === null) {
64238
+ throw 'Missing the required parameter "bulkJobId" when calling patchTaskmanagementWorkitemsBulkAddJob';
64239
+ }
64240
+ // verify the required parameter 'body' is set
64241
+ if (body === undefined || body === null) {
64242
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkitemsBulkAddJob';
64243
+ }
64244
+
64245
+ return this.apiClient.callApi(
64246
+ '/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}',
64247
+ 'PATCH',
64248
+ { 'bulkJobId': bulkJobId },
64249
+ { },
64250
+ { },
64251
+ { },
64252
+ body,
64253
+ ['PureCloud OAuth'],
64254
+ ['application/json'],
64255
+ ['application/json']
64256
+ );
64257
+ }
64258
+
64259
+ /**
64260
+ * Update workitem bulk terminate job.
64261
+ *
64262
+ * @param {String} bulkJobId Bulk job id
64263
+ * @param {Object} body Bulk job update request
64264
+ */
64265
+ patchTaskmanagementWorkitemsBulkTerminateJob(bulkJobId, body) {
64266
+ // verify the required parameter 'bulkJobId' is set
64267
+ if (bulkJobId === undefined || bulkJobId === null) {
64268
+ throw 'Missing the required parameter "bulkJobId" when calling patchTaskmanagementWorkitemsBulkTerminateJob';
64269
+ }
64270
+ // verify the required parameter 'body' is set
64271
+ if (body === undefined || body === null) {
64272
+ throw 'Missing the required parameter "body" when calling patchTaskmanagementWorkitemsBulkTerminateJob';
64273
+ }
64274
+
64275
+ return this.apiClient.callApi(
64276
+ '/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}',
64277
+ 'PATCH',
64278
+ { 'bulkJobId': bulkJobId },
64279
+ { },
64280
+ { },
64281
+ { },
64282
+ body,
64283
+ ['PureCloud OAuth'],
64284
+ ['application/json'],
64285
+ ['application/json']
64286
+ );
64287
+ }
64288
+
63946
64289
  /**
63947
64290
  * Update the attributes of a worktype
63948
64291
  *
@@ -64267,6 +64610,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64267
64610
  );
64268
64611
  }
64269
64612
 
64613
+ /**
64614
+ * Create a workitem bulk add job.
64615
+ *
64616
+ * @param {Object} body Bulk job definition.
64617
+ */
64618
+ postTaskmanagementWorkitemsBulkAddJobs(body) {
64619
+ // verify the required parameter 'body' is set
64620
+ if (body === undefined || body === null) {
64621
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsBulkAddJobs';
64622
+ }
64623
+
64624
+ return this.apiClient.callApi(
64625
+ '/api/v2/taskmanagement/workitems/bulk/add/jobs',
64626
+ 'POST',
64627
+ { },
64628
+ { },
64629
+ { },
64630
+ { },
64631
+ body,
64632
+ ['PureCloud OAuth'],
64633
+ ['application/json'],
64634
+ ['application/json']
64635
+ );
64636
+ }
64637
+
64638
+ /**
64639
+ * Create a workitem bulk terminate job.
64640
+ *
64641
+ * @param {Object} body Bulk job definition.
64642
+ */
64643
+ postTaskmanagementWorkitemsBulkTerminateJobs(body) {
64644
+ // verify the required parameter 'body' is set
64645
+ if (body === undefined || body === null) {
64646
+ throw 'Missing the required parameter "body" when calling postTaskmanagementWorkitemsBulkTerminateJobs';
64647
+ }
64648
+
64649
+ return this.apiClient.callApi(
64650
+ '/api/v2/taskmanagement/workitems/bulk/terminate/jobs',
64651
+ 'POST',
64652
+ { },
64653
+ { },
64654
+ { },
64655
+ { },
64656
+ body,
64657
+ ['PureCloud OAuth'],
64658
+ ['application/json'],
64659
+ ['application/json']
64660
+ );
64661
+ }
64662
+
64270
64663
  /**
64271
64664
  * Query for workitems
64272
64665
  * This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
@@ -64549,7 +64942,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64549
64942
  /**
64550
64943
  * Teams service.
64551
64944
  * @module purecloud-platform-client-v2/api/TeamsApi
64552
- * @version 212.0.0
64945
+ * @version 213.0.0
64553
64946
  */
64554
64947
 
64555
64948
  /**
@@ -64854,7 +65247,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64854
65247
  /**
64855
65248
  * Telephony service.
64856
65249
  * @module purecloud-platform-client-v2/api/TelephonyApi
64857
- * @version 212.0.0
65250
+ * @version 213.0.0
64858
65251
  */
64859
65252
 
64860
65253
  /**
@@ -65036,7 +65429,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65036
65429
  /**
65037
65430
  * TelephonyProvidersEdge service.
65038
65431
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
65039
- * @version 212.0.0
65432
+ * @version 213.0.0
65040
65433
  */
65041
65434
 
65042
65435
  /**
@@ -68487,7 +68880,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68487
68880
  /**
68488
68881
  * Textbots service.
68489
68882
  * @module purecloud-platform-client-v2/api/TextbotsApi
68490
- * @version 212.0.0
68883
+ * @version 213.0.0
68491
68884
  */
68492
68885
 
68493
68886
  /**
@@ -68615,7 +69008,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68615
69008
  /**
68616
69009
  * Tokens service.
68617
69010
  * @module purecloud-platform-client-v2/api/TokensApi
68618
- * @version 212.0.0
69011
+ * @version 213.0.0
68619
69012
  */
68620
69013
 
68621
69014
  /**
@@ -68769,7 +69162,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68769
69162
  /**
68770
69163
  * Uploads service.
68771
69164
  * @module purecloud-platform-client-v2/api/UploadsApi
68772
- * @version 212.0.0
69165
+ * @version 213.0.0
68773
69166
  */
68774
69167
 
68775
69168
  /**
@@ -69038,7 +69431,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69038
69431
  /**
69039
69432
  * Usage service.
69040
69433
  * @module purecloud-platform-client-v2/api/UsageApi
69041
- * @version 212.0.0
69434
+ * @version 213.0.0
69042
69435
  */
69043
69436
 
69044
69437
  /**
@@ -69253,7 +69646,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69253
69646
  /**
69254
69647
  * UserRecordings service.
69255
69648
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
69256
- * @version 212.0.0
69649
+ * @version 213.0.0
69257
69650
  */
69258
69651
 
69259
69652
  /**
@@ -69468,7 +69861,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69468
69861
  /**
69469
69862
  * Users service.
69470
69863
  * @module purecloud-platform-client-v2/api/UsersApi
69471
- * @version 212.0.0
69864
+ * @version 213.0.0
69472
69865
  */
69473
69866
 
69474
69867
  /**
@@ -72297,7 +72690,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72297
72690
  /**
72298
72691
  * Utilities service.
72299
72692
  * @module purecloud-platform-client-v2/api/UtilitiesApi
72300
- * @version 212.0.0
72693
+ * @version 213.0.0
72301
72694
  */
72302
72695
 
72303
72696
  /**
@@ -72408,7 +72801,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72408
72801
  /**
72409
72802
  * Voicemail service.
72410
72803
  * @module purecloud-platform-client-v2/api/VoicemailApi
72411
- * @version 212.0.0
72804
+ * @version 213.0.0
72412
72805
  */
72413
72806
 
72414
72807
  /**
@@ -73130,7 +73523,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73130
73523
  /**
73131
73524
  * WebChat service.
73132
73525
  * @module purecloud-platform-client-v2/api/WebChatApi
73133
- * @version 212.0.0
73526
+ * @version 213.0.0
73134
73527
  */
73135
73528
 
73136
73529
  /**
@@ -73681,7 +74074,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73681
74074
  /**
73682
74075
  * WebDeployments service.
73683
74076
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
73684
- * @version 212.0.0
74077
+ * @version 213.0.0
73685
74078
  */
73686
74079
 
73687
74080
  /**
@@ -74208,7 +74601,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74208
74601
  /**
74209
74602
  * WebMessaging service.
74210
74603
  * @module purecloud-platform-client-v2/api/WebMessagingApi
74211
- * @version 212.0.0
74604
+ * @version 213.0.0
74212
74605
  */
74213
74606
 
74214
74607
  /**
@@ -74254,7 +74647,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74254
74647
  /**
74255
74648
  * Widgets service.
74256
74649
  * @module purecloud-platform-client-v2/api/WidgetsApi
74257
- * @version 212.0.0
74650
+ * @version 213.0.0
74258
74651
  */
74259
74652
 
74260
74653
  /**
@@ -74400,7 +74793,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74400
74793
  /**
74401
74794
  * WorkforceManagement service.
74402
74795
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
74403
- * @version 212.0.0
74796
+ * @version 213.0.0
74404
74797
  */
74405
74798
 
74406
74799
  /**
@@ -75641,6 +76034,99 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
75641
76034
  );
75642
76035
  }
75643
76036
 
76037
+ /**
76038
+ * Get the latest session for the business unit ID
76039
+ *
76040
+ * @param {String} businessUnitId
76041
+ * getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession is a preview method and is subject to both breaking and non-breaking changes at any time without notice
76042
+ */
76043
+ getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession(businessUnitId) {
76044
+ // verify the required parameter 'businessUnitId' is set
76045
+ if (businessUnitId === undefined || businessUnitId === null) {
76046
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSession';
76047
+ }
76048
+
76049
+ return this.apiClient.callApi(
76050
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session',
76051
+ 'GET',
76052
+ { 'businessUnitId': businessUnitId },
76053
+ { },
76054
+ { },
76055
+ { },
76056
+ null,
76057
+ ['PureCloud OAuth'],
76058
+ ['application/json'],
76059
+ ['application/json']
76060
+ );
76061
+ }
76062
+
76063
+ /**
76064
+ * Get the session details for the session ID
76065
+ *
76066
+ * @param {String} businessUnitId
76067
+ * @param {String} sessionId
76068
+ * getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
76069
+ */
76070
+ getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId(businessUnitId, sessionId) {
76071
+ // verify the required parameter 'businessUnitId' is set
76072
+ if (businessUnitId === undefined || businessUnitId === null) {
76073
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId';
76074
+ }
76075
+ // verify the required parameter 'sessionId' is set
76076
+ if (sessionId === undefined || sessionId === null) {
76077
+ throw 'Missing the required parameter "sessionId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionId';
76078
+ }
76079
+
76080
+ return this.apiClient.callApi(
76081
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/{sessionId}',
76082
+ 'GET',
76083
+ { 'businessUnitId': businessUnitId,'sessionId': sessionId },
76084
+ { },
76085
+ { },
76086
+ { },
76087
+ null,
76088
+ ['PureCloud OAuth'],
76089
+ ['application/json'],
76090
+ ['application/json']
76091
+ );
76092
+ }
76093
+
76094
+ /**
76095
+ * Get the snapshot details for the snapshot ID
76096
+ *
76097
+ * @param {String} businessUnitId
76098
+ * @param {String} sessionId
76099
+ * @param {String} snapshotId
76100
+ * getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
76101
+ */
76102
+ getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId(businessUnitId, sessionId, snapshotId) {
76103
+ // verify the required parameter 'businessUnitId' is set
76104
+ if (businessUnitId === undefined || businessUnitId === null) {
76105
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId';
76106
+ }
76107
+ // verify the required parameter 'sessionId' is set
76108
+ if (sessionId === undefined || sessionId === null) {
76109
+ throw 'Missing the required parameter "sessionId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId';
76110
+ }
76111
+ // verify the required parameter 'snapshotId' is set
76112
+ if (snapshotId === undefined || snapshotId === null) {
76113
+ throw 'Missing the required parameter "snapshotId" when calling getWorkforcemanagementBusinessunitMainforecastContinuousforecastSessionSessionIdSnapshotSnapshotId';
76114
+ }
76115
+
76116
+ return this.apiClient.callApi(
76117
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/{sessionId}/snapshot/{snapshotId}',
76118
+ 'GET',
76119
+ { 'businessUnitId': businessUnitId,'sessionId': sessionId,'snapshotId': snapshotId },
76120
+ { },
76121
+ { },
76122
+ { },
76123
+ null,
76124
+ ['PureCloud OAuth'],
76125
+ ['application/json'],
76126
+ ['application/json']
76127
+ );
76128
+ }
76129
+
75644
76130
  /**
75645
76131
  * Get all authorized management units in the business unit
75646
76132
  *
@@ -76871,6 +77357,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
76871
77357
  );
76872
77358
  }
76873
77359
 
77360
+ /**
77361
+ * Retrieves status of the historical data imports associated with job id
77362
+ *
77363
+ * @param {String} jobId The job Id of the historical data import request
77364
+ */
77365
+ getWorkforcemanagementHistoricaldataImportstatusJobId(jobId) {
77366
+ // verify the required parameter 'jobId' is set
77367
+ if (jobId === undefined || jobId === null) {
77368
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementHistoricaldataImportstatusJobId';
77369
+ }
77370
+
77371
+ return this.apiClient.callApi(
77372
+ '/api/v2/workforcemanagement/historicaldata/importstatus/{jobId}',
77373
+ 'GET',
77374
+ { 'jobId': jobId },
77375
+ { },
77376
+ { },
77377
+ { },
77378
+ null,
77379
+ ['PureCloud OAuth'],
77380
+ ['application/json'],
77381
+ ['application/json']
77382
+ );
77383
+ }
77384
+
76874
77385
  /**
76875
77386
  * Get integrations
76876
77387
  *
@@ -81606,7 +82117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
81606
82117
  * </pre>
81607
82118
  * </p>
81608
82119
  * @module purecloud-platform-client-v2/index
81609
- * @version 212.0.0
82120
+ * @version 213.0.0
81610
82121
  */
81611
82122
  class platformClient {
81612
82123
  constructor() {
@@ -82025,8 +82536,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82025
82536
  * @property {module:purecloud-platform-client-v2/MyPureCloudRegionHost}
82026
82537
  */
82027
82538
  this.PureCloudRegionHosts = PureCloudRegionHosts;
82028
-
82029
-
82539
+
82540
+ this.AbstractHttpClient = AbstractHttpClient;
82541
+ this.DefaultHttpClient = DefaultHttpClient;
82542
+ this.HttpRequestOptions = HttpRequestOptions;
82030
82543
  }
82031
82544
  }
82032
82545