purecloud-platform-client-v2 213.1.0 → 215.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 (93) hide show
  1. package/README.md +31 -3
  2. package/dist/node/purecloud-platform-client-v2.js +446 -118
  3. package/dist/web-amd/purecloud-platform-client-v2.js +446 -118
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +213 -149
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +223 -156
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +369 -229
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/AbstractHttpClient.js +29 -0
  11. package/src/purecloud-platform-client-v2/ApiClient.js +21 -1
  12. package/src/purecloud-platform-client-v2/DefaultHttpClient.js +41 -0
  13. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AlertingApi.js +45 -1
  17. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -6
  44. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -31
  67. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +107 -1
  74. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -2
  83. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UsersApi.js +125 -1
  86. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  93. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -46,6 +46,35 @@ define(['axios', 'qs'], (function (axios, qs) { 'use strict';
46
46
  request(httpRequestOptions) {
47
47
  throw new Error("method must be implemented");
48
48
  }
49
+
50
+ enableHooks() {
51
+ throw new Error("method must be implemented");
52
+ }
53
+
54
+ /**
55
+ * Set a PreHook function that modifies the request config before execution.
56
+ * @param {(config: object) => object | Promise<object> | void} hookFunction
57
+ */
58
+ setPreHook(hookFunction) {
59
+ if (typeof hookFunction !== "function" || hookFunction.length !== 1) {
60
+ throw new Error("preHook must be a function that accepts (config)");
61
+ }
62
+ this.preHook = hookFunction;
63
+ this.enableHooks();
64
+ }
65
+
66
+ /**
67
+ * Set a PostHook function that processes the response or error after execution.
68
+ * @param {(response: object | null, error: Error | null) => object | Promise<object> | void} hookFunction
69
+ */
70
+ setPostHook(hookFunction) {
71
+ if (typeof hookFunction !== "function" || hookFunction.length !== 1) {
72
+ throw new Error("postHook must be a function that accepts (response)");
73
+ }
74
+ this.postHook = hookFunction;
75
+ this.enableHooks();
76
+ }
77
+
49
78
  }
50
79
 
51
80
  class HttpRequestOptions {
@@ -124,6 +153,47 @@ define(['axios', 'qs'], (function (axios, qs) { 'use strict';
124
153
  this._axiosInstance = axios__default["default"].create({});
125
154
  }
126
155
 
156
+
157
+ enableHooks() {
158
+ if (this.preHook && typeof this.preHook === 'function') {
159
+
160
+ if (this.requestInterceptorId !== undefined) {
161
+ axios__default["default"].interceptors.request.eject(this.requestInterceptorId);
162
+ }
163
+
164
+ this.requestInterceptorId = this._axiosInstance.interceptors.request.use(
165
+ async (config) => {
166
+ config = await this.preHook(config); // Call the custom pre-hook
167
+ return config
168
+ },
169
+ (error) => {
170
+ // Handle errors before the request is sent
171
+ console.error('Request Pre-Hook Error:', error.message);
172
+ return Promise.reject(error);
173
+ }
174
+ );
175
+ }
176
+
177
+ if (this.postHook && typeof this.postHook === 'function') {
178
+ // Response interceptor (for post-hooks)
179
+ if (this.responseInterceptorId !== undefined) {
180
+ axios__default["default"].interceptors.response.eject(this.responseInterceptorId);
181
+ }
182
+
183
+ this.responseInterceptorId = this._axiosInstance.interceptors.response.use(
184
+ async (response) => {
185
+ response = await this.postHook(response); // Call the custom post-hook
186
+ return response
187
+ },
188
+ async (error) => {
189
+ console.error('Post-Hook: Response Error', error.message);
190
+ // Optionally call post-hook in case of errors
191
+ return Promise.reject(error);
192
+ }
193
+ );
194
+ }
195
+ }
196
+
127
197
  request(httpRequestOptions) {
128
198
  if(!(httpRequestOptions instanceof HttpRequestOptions)) {
129
199
  throw new Error(`httpRequestOptions must be instance of HttpRequestOptions `);
@@ -617,7 +687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
617
687
 
618
688
  /**
619
689
  * @module purecloud-platform-client-v2/ApiClient
620
- * @version 213.1.0
690
+ * @version 215.0.0
621
691
  */
622
692
  class ApiClient {
623
693
  /**
@@ -872,6 +942,24 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
872
942
  }
873
943
  }
874
944
 
945
+ /**
946
+ * @description Sets preHook functions for the httpClient
947
+ * @param {string} preHook - method definition for prehook
948
+ */
949
+ setPreHook(preHook) {
950
+ const httpClient = this.getHttpClient();
951
+ httpClient.setPreHook(preHook);
952
+ }
953
+
954
+ /**
955
+ * @description Sets postHook functions for the httpClient
956
+ * @param {string} postHook - method definition for posthook
957
+ */
958
+ setPostHook(postHook) {
959
+ const httpClient = this.getHttpClient();
960
+ httpClient.setPostHook(postHook);
961
+ }
962
+
875
963
  /**
876
964
  * @description Sets the certificate content if MTLS authentication is needed
877
965
  * @param {string} certContent - content for certs
@@ -903,6 +991,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
903
991
  }
904
992
  }
905
993
 
994
+
995
+
906
996
  /**
907
997
  * @description Sets the gateway used by the session
908
998
  * @param {object} gateway - Gateway Configuration interface
@@ -2141,7 +2231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2141
2231
  /**
2142
2232
  * AgentAssistants service.
2143
2233
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
2144
- * @version 213.1.0
2234
+ * @version 215.0.0
2145
2235
  */
2146
2236
 
2147
2237
  /**
@@ -2517,7 +2607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2517
2607
  /**
2518
2608
  * AgentCopilot service.
2519
2609
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
2520
- * @version 213.1.0
2610
+ * @version 215.0.0
2521
2611
  */
2522
2612
 
2523
2613
  /**
@@ -2593,7 +2683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2593
2683
  /**
2594
2684
  * AgentUI service.
2595
2685
  * @module purecloud-platform-client-v2/api/AgentUIApi
2596
- * @version 213.1.0
2686
+ * @version 215.0.0
2597
2687
  */
2598
2688
 
2599
2689
  /**
@@ -2724,7 +2814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2724
2814
  /**
2725
2815
  * Alerting service.
2726
2816
  * @module purecloud-platform-client-v2/api/AlertingApi
2727
- * @version 213.1.0
2817
+ * @version 215.0.0
2728
2818
  */
2729
2819
 
2730
2820
  /**
@@ -2764,6 +2854,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2764
2854
  );
2765
2855
  }
2766
2856
 
2857
+ /**
2858
+ * Delete all alerts for the user
2859
+ *
2860
+ */
2861
+ deleteAlertingAlertsAll() {
2862
+
2863
+ return this.apiClient.callApi(
2864
+ '/api/v2/alerting/alerts/all',
2865
+ 'DELETE',
2866
+ { },
2867
+ { },
2868
+ { },
2869
+ { },
2870
+ null,
2871
+ ['PureCloud OAuth'],
2872
+ ['application/json'],
2873
+ ['application/json']
2874
+ );
2875
+ }
2876
+
2767
2877
  /**
2768
2878
  * Delete an interaction stats alert
2769
2879
  * Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
@@ -3072,6 +3182,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3072
3182
  );
3073
3183
  }
3074
3184
 
3185
+ /**
3186
+ * Updates all alerts
3187
+ *
3188
+ * @param {Object} opts Optional parameters
3189
+ * @param {Object} opts.body
3190
+ */
3191
+ patchAlertingAlertsAll(opts) {
3192
+ opts = opts || {};
3193
+
3194
+
3195
+ return this.apiClient.callApi(
3196
+ '/api/v2/alerting/alerts/all',
3197
+ 'PATCH',
3198
+ { },
3199
+ { },
3200
+ { },
3201
+ { },
3202
+ opts['body'],
3203
+ ['PureCloud OAuth'],
3204
+ ['application/json'],
3205
+ ['application/json']
3206
+ );
3207
+ }
3208
+
3075
3209
  /**
3076
3210
  * Bulk alert updates
3077
3211
  *
@@ -3385,7 +3519,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3385
3519
  /**
3386
3520
  * Analytics service.
3387
3521
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3388
- * @version 213.1.0
3522
+ * @version 215.0.0
3389
3523
  */
3390
3524
 
3391
3525
  /**
@@ -6210,7 +6344,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6210
6344
  /**
6211
6345
  * Architect service.
6212
6346
  * @module purecloud-platform-client-v2/api/ArchitectApi
6213
- * @version 213.1.0
6347
+ * @version 215.0.0
6214
6348
  */
6215
6349
 
6216
6350
  /**
@@ -10332,7 +10466,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10332
10466
  /**
10333
10467
  * Audit service.
10334
10468
  * @module purecloud-platform-client-v2/api/AuditApi
10335
- * @version 213.1.0
10469
+ * @version 215.0.0
10336
10470
  */
10337
10471
 
10338
10472
  /**
@@ -10533,7 +10667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10533
10667
  /**
10534
10668
  * Authorization service.
10535
10669
  * @module purecloud-platform-client-v2/api/AuthorizationApi
10536
- * @version 213.1.0
10670
+ * @version 215.0.0
10537
10671
  */
10538
10672
 
10539
10673
  /**
@@ -11816,7 +11950,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11816
11950
  /**
11817
11951
  * Billing service.
11818
11952
  * @module purecloud-platform-client-v2/api/BillingApi
11819
- * @version 213.1.0
11953
+ * @version 215.0.0
11820
11954
  */
11821
11955
 
11822
11956
  /**
@@ -11896,7 +12030,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11896
12030
  /**
11897
12031
  * CarrierServices service.
11898
12032
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
11899
- * @version 213.1.0
12033
+ * @version 215.0.0
11900
12034
  */
11901
12035
 
11902
12036
  /**
@@ -11966,7 +12100,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11966
12100
  /**
11967
12101
  * Chat service.
11968
12102
  * @module purecloud-platform-client-v2/api/ChatApi
11969
- * @version 213.1.0
12103
+ * @version 215.0.0
11970
12104
  */
11971
12105
 
11972
12106
  /**
@@ -12902,7 +13036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12902
13036
  /**
12903
13037
  * Coaching service.
12904
13038
  * @module purecloud-platform-client-v2/api/CoachingApi
12905
- * @version 213.1.0
13039
+ * @version 215.0.0
12906
13040
  */
12907
13041
 
12908
13042
  /**
@@ -13479,7 +13613,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13479
13613
  /**
13480
13614
  * ContentManagement service.
13481
13615
  * @module purecloud-platform-client-v2/api/ContentManagementApi
13482
- * @version 213.1.0
13616
+ * @version 215.0.0
13483
13617
  */
13484
13618
 
13485
13619
  /**
@@ -14560,7 +14694,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14560
14694
  /**
14561
14695
  * Conversations service.
14562
14696
  * @module purecloud-platform-client-v2/api/ConversationsApi
14563
- * @version 213.1.0
14697
+ * @version 215.0.0
14564
14698
  */
14565
14699
 
14566
14700
  /**
@@ -21722,7 +21856,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21722
21856
  /**
21723
21857
  * DataExtensions service.
21724
21858
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
21725
- * @version 213.1.0
21859
+ * @version 215.0.0
21726
21860
  */
21727
21861
 
21728
21862
  /**
@@ -21808,7 +21942,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21808
21942
  /**
21809
21943
  * DataPrivacy service.
21810
21944
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
21811
- * @version 213.1.0
21945
+ * @version 215.0.0
21812
21946
  */
21813
21947
 
21814
21948
  /**
@@ -21978,7 +22112,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21978
22112
  /**
21979
22113
  * Downloads service.
21980
22114
  * @module purecloud-platform-client-v2/api/DownloadsApi
21981
- * @version 213.1.0
22115
+ * @version 215.0.0
21982
22116
  */
21983
22117
 
21984
22118
  /**
@@ -22030,7 +22164,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22030
22164
  /**
22031
22165
  * Emails service.
22032
22166
  * @module purecloud-platform-client-v2/api/EmailsApi
22033
- * @version 213.1.0
22167
+ * @version 215.0.0
22034
22168
  */
22035
22169
 
22036
22170
  /**
@@ -22095,7 +22229,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22095
22229
  /**
22096
22230
  * EmployeeEngagement service.
22097
22231
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
22098
- * @version 213.1.0
22232
+ * @version 215.0.0
22099
22233
  */
22100
22234
 
22101
22235
  /**
@@ -22246,7 +22380,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22246
22380
  /**
22247
22381
  * Events service.
22248
22382
  * @module purecloud-platform-client-v2/api/EventsApi
22249
- * @version 213.1.0
22383
+ * @version 215.0.0
22250
22384
  */
22251
22385
 
22252
22386
  /**
@@ -22342,7 +22476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22342
22476
  /**
22343
22477
  * ExternalContacts service.
22344
22478
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
22345
- * @version 213.1.0
22479
+ * @version 215.0.0
22346
22480
  */
22347
22481
 
22348
22482
  /**
@@ -24907,7 +25041,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24907
25041
  /**
24908
25042
  * Fax service.
24909
25043
  * @module purecloud-platform-client-v2/api/FaxApi
24910
- * @version 213.1.0
25044
+ * @version 215.0.0
24911
25045
  */
24912
25046
 
24913
25047
  /**
@@ -25122,7 +25256,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25122
25256
  /**
25123
25257
  * Flows service.
25124
25258
  * @module purecloud-platform-client-v2/api/FlowsApi
25125
- * @version 213.1.0
25259
+ * @version 215.0.0
25126
25260
  */
25127
25261
 
25128
25262
  /**
@@ -25305,7 +25439,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25305
25439
  /**
25306
25440
  * Gamification service.
25307
25441
  * @module purecloud-platform-client-v2/api/GamificationApi
25308
- * @version 213.1.0
25442
+ * @version 215.0.0
25309
25443
  */
25310
25444
 
25311
25445
  /**
@@ -27447,7 +27581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27447
27581
  /**
27448
27582
  * GeneralDataProtectionRegulation service.
27449
27583
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
27450
- * @version 213.1.0
27584
+ * @version 215.0.0
27451
27585
  */
27452
27586
 
27453
27587
  /**
@@ -27577,7 +27711,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27577
27711
  /**
27578
27712
  * Geolocation service.
27579
27713
  * @module purecloud-platform-client-v2/api/GeolocationApi
27580
- * @version 213.1.0
27714
+ * @version 215.0.0
27581
27715
  */
27582
27716
 
27583
27717
  /**
@@ -27708,7 +27842,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27708
27842
  /**
27709
27843
  * Greetings service.
27710
27844
  * @module purecloud-platform-client-v2/api/GreetingsApi
27711
- * @version 213.1.0
27845
+ * @version 215.0.0
27712
27846
  */
27713
27847
 
27714
27848
  /**
@@ -28163,7 +28297,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28163
28297
  /**
28164
28298
  * Groups service.
28165
28299
  * @module purecloud-platform-client-v2/api/GroupsApi
28166
- * @version 213.1.0
28300
+ * @version 215.0.0
28167
28301
  */
28168
28302
 
28169
28303
  /**
@@ -28682,7 +28816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28682
28816
  /**
28683
28817
  * IdentityProvider service.
28684
28818
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
28685
- * @version 213.1.0
28819
+ * @version 215.0.0
28686
28820
  */
28687
28821
 
28688
28822
  /**
@@ -29543,7 +29677,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29543
29677
  /**
29544
29678
  * InfrastructureAsCode service.
29545
29679
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
29546
- * @version 213.1.0
29680
+ * @version 215.0.0
29547
29681
  */
29548
29682
 
29549
29683
  /**
@@ -29710,7 +29844,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29710
29844
  /**
29711
29845
  * Integrations service.
29712
29846
  * @module purecloud-platform-client-v2/api/IntegrationsApi
29713
- * @version 213.1.0
29847
+ * @version 215.0.0
29714
29848
  */
29715
29849
 
29716
29850
  /**
@@ -29977,7 +30111,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29977
30111
  * Get draft function settings for Action
29978
30112
  *
29979
30113
  * @param {String} actionId actionId
29980
- * getIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29981
30114
  */
29982
30115
  getIntegrationsActionDraftFunction(actionId) {
29983
30116
  // verify the required parameter 'actionId' is set
@@ -30092,7 +30225,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30092
30225
  * Get published function settings for Action
30093
30226
  *
30094
30227
  * @param {String} actionId actionId
30095
- * getIntegrationsActionFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30096
30228
  */
30097
30229
  getIntegrationsActionFunction(actionId) {
30098
30230
  // verify the required parameter 'actionId' is set
@@ -30324,7 +30456,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30324
30456
  /**
30325
30457
  * Get action function settings for Action
30326
30458
  *
30327
- * getIntegrationsActionsFunctionsRuntimes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30328
30459
  */
30329
30460
  getIntegrationsActionsFunctionsRuntimes() {
30330
30461
 
@@ -31614,7 +31745,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31614
31745
  *
31615
31746
  * @param {String} actionId actionId
31616
31747
  * @param {Object} body Input used to request URL upload.
31617
- * postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
31618
31748
  */
31619
31749
  postIntegrationsActionDraftFunctionUpload(actionId, body) {
31620
31750
  // verify the required parameter 'actionId' is set
@@ -31976,7 +32106,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31976
32106
  *
31977
32107
  * @param {String} actionId actionId
31978
32108
  * @param {Object} body Input used to update function settings.
31979
- * putIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
31980
32109
  */
31981
32110
  putIntegrationsActionDraftFunction(actionId, body) {
31982
32111
  // verify the required parameter 'actionId' is set
@@ -32152,7 +32281,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32152
32281
  /**
32153
32282
  * Journey service.
32154
32283
  * @module purecloud-platform-client-v2/api/JourneyApi
32155
- * @version 213.1.0
32284
+ * @version 215.0.0
32156
32285
  */
32157
32286
 
32158
32287
  /**
@@ -34117,7 +34246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34117
34246
  /**
34118
34247
  * Knowledge service.
34119
34248
  * @module purecloud-platform-client-v2/api/KnowledgeApi
34120
- * @version 213.1.0
34249
+ * @version 215.0.0
34121
34250
  */
34122
34251
 
34123
34252
  /**
@@ -37993,7 +38122,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37993
38122
  /**
37994
38123
  * LanguageUnderstanding service.
37995
38124
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
37996
- * @version 213.1.0
38125
+ * @version 215.0.0
37997
38126
  */
37998
38127
 
37999
38128
  /**
@@ -39026,7 +39155,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39026
39155
  /**
39027
39156
  * Languages service.
39028
39157
  * @module purecloud-platform-client-v2/api/LanguagesApi
39029
- * @version 213.1.0
39158
+ * @version 215.0.0
39030
39159
  */
39031
39160
 
39032
39161
  /**
@@ -39248,7 +39377,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39248
39377
  /**
39249
39378
  * Learning service.
39250
39379
  * @module purecloud-platform-client-v2/api/LearningApi
39251
- * @version 213.1.0
39380
+ * @version 215.0.0
39252
39381
  */
39253
39382
 
39254
39383
  /**
@@ -40277,7 +40406,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40277
40406
  /**
40278
40407
  * License service.
40279
40408
  * @module purecloud-platform-client-v2/api/LicenseApi
40280
- * @version 213.1.0
40409
+ * @version 215.0.0
40281
40410
  */
40282
40411
 
40283
40412
  /**
@@ -40515,7 +40644,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40515
40644
  /**
40516
40645
  * Locations service.
40517
40646
  * @module purecloud-platform-client-v2/api/LocationsApi
40518
- * @version 213.1.0
40647
+ * @version 215.0.0
40519
40648
  */
40520
40649
 
40521
40650
  /**
@@ -40751,7 +40880,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40751
40880
  /**
40752
40881
  * LogCapture service.
40753
40882
  * @module purecloud-platform-client-v2/api/LogCaptureApi
40754
- * @version 213.1.0
40883
+ * @version 215.0.0
40755
40884
  */
40756
40885
 
40757
40886
  /**
@@ -40951,7 +41080,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40951
41080
  /**
40952
41081
  * Messaging service.
40953
41082
  * @module purecloud-platform-client-v2/api/MessagingApi
40954
- * @version 213.1.0
41083
+ * @version 215.0.0
40955
41084
  */
40956
41085
 
40957
41086
  /**
@@ -41310,7 +41439,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41310
41439
  /**
41311
41440
  * MobileDevices service.
41312
41441
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
41313
- * @version 213.1.0
41442
+ * @version 215.0.0
41314
41443
  */
41315
41444
 
41316
41445
  /**
@@ -41461,7 +41590,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41461
41590
  /**
41462
41591
  * Notifications service.
41463
41592
  * @module purecloud-platform-client-v2/api/NotificationsApi
41464
- * @version 213.1.0
41593
+ * @version 215.0.0
41465
41594
  */
41466
41595
 
41467
41596
  /**
@@ -41694,7 +41823,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41694
41823
  /**
41695
41824
  * OAuth service.
41696
41825
  * @module purecloud-platform-client-v2/api/OAuthApi
41697
- * @version 213.1.0
41826
+ * @version 215.0.0
41698
41827
  */
41699
41828
 
41700
41829
  /**
@@ -42060,7 +42189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42060
42189
  /**
42061
42190
  * Objects service.
42062
42191
  * @module purecloud-platform-client-v2/api/ObjectsApi
42063
- * @version 213.1.0
42192
+ * @version 215.0.0
42064
42193
  */
42065
42194
 
42066
42195
  /**
@@ -42330,7 +42459,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42330
42459
  /**
42331
42460
  * OperationalEvents service.
42332
42461
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
42333
- * @version 213.1.0
42462
+ * @version 215.0.0
42334
42463
  */
42335
42464
 
42336
42465
  /**
@@ -42447,7 +42576,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42447
42576
  /**
42448
42577
  * Organization service.
42449
42578
  * @module purecloud-platform-client-v2/api/OrganizationApi
42450
- * @version 213.1.0
42579
+ * @version 215.0.0
42451
42580
  */
42452
42581
 
42453
42582
  /**
@@ -42989,7 +43118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
42989
43118
  /**
42990
43119
  * OrganizationAuthorization service.
42991
43120
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
42992
- * @version 213.1.0
43121
+ * @version 215.0.0
42993
43122
  */
42994
43123
 
42995
43124
  /**
@@ -44383,7 +44512,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44383
44512
  /**
44384
44513
  * Outbound service.
44385
44514
  * @module purecloud-platform-client-v2/api/OutboundApi
44386
- * @version 213.1.0
44515
+ * @version 215.0.0
44387
44516
  */
44388
44517
 
44389
44518
  /**
@@ -48934,7 +49063,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48934
49063
  /**
48935
49064
  * Presence service.
48936
49065
  * @module purecloud-platform-client-v2/api/PresenceApi
48937
- * @version 213.1.0
49066
+ * @version 215.0.0
48938
49067
  */
48939
49068
 
48940
49069
  /**
@@ -49678,7 +49807,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49678
49807
  /**
49679
49808
  * ProcessAutomation service.
49680
49809
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
49681
- * @version 213.1.0
49810
+ * @version 215.0.0
49682
49811
  */
49683
49812
 
49684
49813
  /**
@@ -49917,7 +50046,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49917
50046
  /**
49918
50047
  * Quality service.
49919
50048
  * @module purecloud-platform-client-v2/api/QualityApi
49920
- * @version 213.1.0
50049
+ * @version 215.0.0
49921
50050
  */
49922
50051
 
49923
50052
  /**
@@ -51705,7 +51834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51705
51834
  /**
51706
51835
  * Recording service.
51707
51836
  * @module purecloud-platform-client-v2/api/RecordingApi
51708
- * @version 213.1.0
51837
+ * @version 215.0.0
51709
51838
  */
51710
51839
 
51711
51840
  /**
@@ -53364,7 +53493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53364
53493
  /**
53365
53494
  * ResponseManagement service.
53366
53495
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
53367
- * @version 213.1.0
53496
+ * @version 215.0.0
53368
53497
  */
53369
53498
 
53370
53499
  /**
@@ -53874,7 +54003,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53874
54003
  /**
53875
54004
  * Routing service.
53876
54005
  * @module purecloud-platform-client-v2/api/RoutingApi
53877
- * @version 213.1.0
54006
+ * @version 215.0.0
53878
54007
  */
53879
54008
 
53880
54009
  /**
@@ -57780,36 +57909,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57780
57909
  );
57781
57910
  }
57782
57911
 
57783
- /**
57784
- * Update a phone number provisioned for SMS.
57785
- *
57786
- * @param {String} phoneNumberId phone number
57787
- * @param {Object} body SmsPhoneNumber
57788
- */
57789
- putRoutingSmsPhonenumber(phoneNumberId, body) {
57790
- // verify the required parameter 'phoneNumberId' is set
57791
- if (phoneNumberId === undefined || phoneNumberId === null) {
57792
- throw 'Missing the required parameter "phoneNumberId" when calling putRoutingSmsPhonenumber';
57793
- }
57794
- // verify the required parameter 'body' is set
57795
- if (body === undefined || body === null) {
57796
- throw 'Missing the required parameter "body" when calling putRoutingSmsPhonenumber';
57797
- }
57798
-
57799
- return this.apiClient.callApi(
57800
- '/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
57801
- 'PUT',
57802
- { 'phoneNumberId': phoneNumberId },
57803
- { },
57804
- { },
57805
- { },
57806
- body,
57807
- ['PureCloud OAuth'],
57808
- ['application/json'],
57809
- ['application/json']
57810
- );
57811
- }
57812
-
57813
57912
  /**
57814
57913
  * Update the user's Direct Routing Backup settings.
57815
57914
  *
@@ -58026,7 +58125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58026
58125
  /**
58027
58126
  * SCIM service.
58028
58127
  * @module purecloud-platform-client-v2/api/SCIMApi
58029
- * @version 213.1.0
58128
+ * @version 215.0.0
58030
58129
  */
58031
58130
 
58032
58131
  /**
@@ -58903,7 +59002,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58903
59002
  /**
58904
59003
  * ScreenRecording service.
58905
59004
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
58906
- * @version 213.1.0
59005
+ * @version 215.0.0
58907
59006
  */
58908
59007
 
58909
59008
  /**
@@ -58948,7 +59047,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58948
59047
  /**
58949
59048
  * Scripts service.
58950
59049
  * @module purecloud-platform-client-v2/api/ScriptsApi
58951
- * @version 213.1.0
59050
+ * @version 215.0.0
58952
59051
  */
58953
59052
 
58954
59053
  /**
@@ -59392,7 +59491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59392
59491
  /**
59393
59492
  * Search service.
59394
59493
  * @module purecloud-platform-client-v2/api/SearchApi
59395
- * @version 213.1.0
59494
+ * @version 215.0.0
59396
59495
  */
59397
59496
 
59398
59497
  /**
@@ -60135,7 +60234,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60135
60234
  /**
60136
60235
  * Settings service.
60137
60236
  * @module purecloud-platform-client-v2/api/SettingsApi
60138
- * @version 213.1.0
60237
+ * @version 215.0.0
60139
60238
  */
60140
60239
 
60141
60240
  /**
@@ -60355,7 +60454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60355
60454
  /**
60356
60455
  * SocialMedia service.
60357
60456
  * @module purecloud-platform-client-v2/api/SocialMediaApi
60358
- * @version 213.1.0
60457
+ * @version 215.0.0
60359
60458
  */
60360
60459
 
60361
60460
  /**
@@ -61260,7 +61359,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61260
61359
  /**
61261
61360
  * SpeechTextAnalytics service.
61262
61361
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
61263
- * @version 213.1.0
61362
+ * @version 215.0.0
61264
61363
  */
61265
61364
 
61266
61365
  /**
@@ -61593,6 +61692,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61593
61692
  );
61594
61693
  }
61595
61694
 
61695
+ /**
61696
+ * Get conversation summaries by conversation id.
61697
+ *
61698
+ * @param {String} conversationId The conversation ID of the summaries
61699
+ */
61700
+ getSpeechandtextanalyticsConversationSummaries(conversationId) {
61701
+ // verify the required parameter 'conversationId' is set
61702
+ if (conversationId === undefined || conversationId === null) {
61703
+ throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationSummaries';
61704
+ }
61705
+
61706
+ return this.apiClient.callApi(
61707
+ '/api/v2/speechandtextanalytics/conversations/{conversationId}/summaries',
61708
+ 'GET',
61709
+ { 'conversationId': conversationId },
61710
+ { },
61711
+ { },
61712
+ { },
61713
+ null,
61714
+ ['PureCloud OAuth'],
61715
+ ['application/json'],
61716
+ ['application/json']
61717
+ );
61718
+ }
61719
+
61596
61720
  /**
61597
61721
  * Get the list of Speech and Text Analytics dictionary feedbacks
61598
61722
  *
@@ -61694,6 +61818,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61694
61818
  );
61695
61819
  }
61696
61820
 
61821
+ /**
61822
+ * Get AI Insights settings of a program
61823
+ *
61824
+ * @param {String} programId The id of the program
61825
+ */
61826
+ getSpeechandtextanalyticsProgramSettingsInsights(programId) {
61827
+ // verify the required parameter 'programId' is set
61828
+ if (programId === undefined || programId === null) {
61829
+ throw 'Missing the required parameter "programId" when calling getSpeechandtextanalyticsProgramSettingsInsights';
61830
+ }
61831
+
61832
+ return this.apiClient.callApi(
61833
+ '/api/v2/speechandtextanalytics/programs/{programId}/settings/insights',
61834
+ 'GET',
61835
+ { 'programId': programId },
61836
+ { },
61837
+ { },
61838
+ { },
61839
+ null,
61840
+ ['PureCloud OAuth'],
61841
+ ['application/json'],
61842
+ ['application/json']
61843
+ );
61844
+ }
61845
+
61697
61846
  /**
61698
61847
  * Get transcription engine settings of a program
61699
61848
  *
@@ -61820,6 +61969,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
61820
61969
  );
61821
61970
  }
61822
61971
 
61972
+ /**
61973
+ * Get the list of program AI Insights settings for the organization
61974
+ *
61975
+ * @param {Object} opts Optional parameters
61976
+ * @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 100. (default to 100)
61977
+ * @param {Number} opts.pageNumber The page number for the listing (default to 1)
61978
+ * @param {Array.<String>} opts.programIds Comma separated Program IDs to filter by. Maximum of 50 IDs allowed.
61979
+ */
61980
+ getSpeechandtextanalyticsProgramsSettingsInsights(opts) {
61981
+ opts = opts || {};
61982
+
61983
+
61984
+ return this.apiClient.callApi(
61985
+ '/api/v2/speechandtextanalytics/programs/settings/insights',
61986
+ 'GET',
61987
+ { },
61988
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'programIds': this.apiClient.buildCollectionParam(opts['programIds'], 'multi') },
61989
+ { },
61990
+ { },
61991
+ null,
61992
+ ['PureCloud OAuth'],
61993
+ ['application/json'],
61994
+ ['application/json']
61995
+ );
61996
+ }
61997
+
61823
61998
  /**
61824
61999
  * Get supported dialects for each transcription engine
61825
62000
  *
@@ -62504,6 +62679,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62504
62679
  );
62505
62680
  }
62506
62681
 
62682
+ /**
62683
+ * Update AI Insights settings of a program
62684
+ *
62685
+ * @param {String} programId The id of the program
62686
+ * @param {Object} body Program AI Insights setting
62687
+ */
62688
+ putSpeechandtextanalyticsProgramSettingsInsights(programId, body) {
62689
+ // verify the required parameter 'programId' is set
62690
+ if (programId === undefined || programId === null) {
62691
+ throw 'Missing the required parameter "programId" when calling putSpeechandtextanalyticsProgramSettingsInsights';
62692
+ }
62693
+ // verify the required parameter 'body' is set
62694
+ if (body === undefined || body === null) {
62695
+ throw 'Missing the required parameter "body" when calling putSpeechandtextanalyticsProgramSettingsInsights';
62696
+ }
62697
+
62698
+ return this.apiClient.callApi(
62699
+ '/api/v2/speechandtextanalytics/programs/{programId}/settings/insights',
62700
+ 'PUT',
62701
+ { 'programId': programId },
62702
+ { },
62703
+ { },
62704
+ { },
62705
+ body,
62706
+ ['PureCloud OAuth'],
62707
+ ['application/json'],
62708
+ ['application/json']
62709
+ );
62710
+ }
62711
+
62507
62712
  /**
62508
62713
  * Update transcription engine settings of a program
62509
62714
  *
@@ -62595,7 +62800,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62595
62800
  /**
62596
62801
  * Stations service.
62597
62802
  * @module purecloud-platform-client-v2/api/StationsApi
62598
- * @version 213.1.0
62803
+ * @version 215.0.0
62599
62804
  */
62600
62805
 
62601
62806
  /**
@@ -62697,7 +62902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62697
62902
  /**
62698
62903
  * Suggest service.
62699
62904
  * @module purecloud-platform-client-v2/api/SuggestApi
62700
- * @version 213.1.0
62905
+ * @version 215.0.0
62701
62906
  */
62702
62907
 
62703
62908
  /**
@@ -62836,7 +63041,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62836
63041
  /**
62837
63042
  * TaskManagement service.
62838
63043
  * @module purecloud-platform-client-v2/api/TaskManagementApi
62839
- * @version 213.1.0
63044
+ * @version 215.0.0
62840
63045
  */
62841
63046
 
62842
63047
  /**
@@ -64942,7 +65147,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64942
65147
  /**
64943
65148
  * Teams service.
64944
65149
  * @module purecloud-platform-client-v2/api/TeamsApi
64945
- * @version 213.1.0
65150
+ * @version 215.0.0
64946
65151
  */
64947
65152
 
64948
65153
  /**
@@ -65247,7 +65452,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65247
65452
  /**
65248
65453
  * Telephony service.
65249
65454
  * @module purecloud-platform-client-v2/api/TelephonyApi
65250
- * @version 213.1.0
65455
+ * @version 215.0.0
65251
65456
  */
65252
65457
 
65253
65458
  /**
@@ -65429,7 +65634,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65429
65634
  /**
65430
65635
  * TelephonyProvidersEdge service.
65431
65636
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
65432
- * @version 213.1.0
65637
+ * @version 215.0.0
65433
65638
  */
65434
65639
 
65435
65640
  /**
@@ -68880,7 +69085,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68880
69085
  /**
68881
69086
  * Textbots service.
68882
69087
  * @module purecloud-platform-client-v2/api/TextbotsApi
68883
- * @version 213.1.0
69088
+ * @version 215.0.0
68884
69089
  */
68885
69090
 
68886
69091
  /**
@@ -69008,7 +69213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69008
69213
  /**
69009
69214
  * Tokens service.
69010
69215
  * @module purecloud-platform-client-v2/api/TokensApi
69011
- * @version 213.1.0
69216
+ * @version 215.0.0
69012
69217
  */
69013
69218
 
69014
69219
  /**
@@ -69162,7 +69367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69162
69367
  /**
69163
69368
  * Uploads service.
69164
69369
  * @module purecloud-platform-client-v2/api/UploadsApi
69165
- * @version 213.1.0
69370
+ * @version 215.0.0
69166
69371
  */
69167
69372
 
69168
69373
  /**
@@ -69213,7 +69418,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69213
69418
  *
69214
69419
  * @param {String} actionId actionId
69215
69420
  * @param {Object} body Input used to request URL upload.
69216
- * postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69217
69421
  */
69218
69422
  postIntegrationsActionDraftFunctionUpload(actionId, body) {
69219
69423
  // verify the required parameter 'actionId' is set
@@ -69431,7 +69635,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69431
69635
  /**
69432
69636
  * Usage service.
69433
69637
  * @module purecloud-platform-client-v2/api/UsageApi
69434
- * @version 213.1.0
69638
+ * @version 215.0.0
69435
69639
  */
69436
69640
 
69437
69641
  /**
@@ -69646,7 +69850,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69646
69850
  /**
69647
69851
  * UserRecordings service.
69648
69852
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
69649
- * @version 213.1.0
69853
+ * @version 215.0.0
69650
69854
  */
69651
69855
 
69652
69856
  /**
@@ -69861,7 +70065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69861
70065
  /**
69862
70066
  * Users service.
69863
70067
  * @module purecloud-platform-client-v2/api/UsersApi
69864
- * @version 213.1.0
70068
+ * @version 215.0.0
69865
70069
  */
69866
70070
 
69867
70071
  /**
@@ -70031,6 +70235,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70031
70235
  );
70032
70236
  }
70033
70237
 
70238
+ /**
70239
+ * Delete the external identifier for user.
70240
+ *
70241
+ * @param {String} userId User ID
70242
+ * @param {String} authorityName Authority Name
70243
+ * @param {String} externalKey External Key
70244
+ */
70245
+ deleteUserExternalidAuthorityNameExternalKey(userId, authorityName, externalKey) {
70246
+ // verify the required parameter 'userId' is set
70247
+ if (userId === undefined || userId === null) {
70248
+ throw 'Missing the required parameter "userId" when calling deleteUserExternalidAuthorityNameExternalKey';
70249
+ }
70250
+ // verify the required parameter 'authorityName' is set
70251
+ if (authorityName === undefined || authorityName === null) {
70252
+ throw 'Missing the required parameter "authorityName" when calling deleteUserExternalidAuthorityNameExternalKey';
70253
+ }
70254
+ // verify the required parameter 'externalKey' is set
70255
+ if (externalKey === undefined || externalKey === null) {
70256
+ throw 'Missing the required parameter "externalKey" when calling deleteUserExternalidAuthorityNameExternalKey';
70257
+ }
70258
+
70259
+ return this.apiClient.callApi(
70260
+ '/api/v2/users/{userId}/externalid/{authorityName}/{externalKey}',
70261
+ 'DELETE',
70262
+ { 'userId': userId,'authorityName': authorityName,'externalKey': externalKey },
70263
+ { },
70264
+ { },
70265
+ { },
70266
+ null,
70267
+ ['PureCloud OAuth'],
70268
+ ['application/json'],
70269
+ ['application/json']
70270
+ );
70271
+ }
70272
+
70034
70273
  /**
70035
70274
  * Remove a routing language from a user
70036
70275
  *
@@ -70692,6 +70931,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70692
70931
  );
70693
70932
  }
70694
70933
 
70934
+ /**
70935
+ * Get the external identifiers for a user.
70936
+ *
70937
+ * @param {String} userId User ID
70938
+ */
70939
+ getUserExternalid(userId) {
70940
+ // verify the required parameter 'userId' is set
70941
+ if (userId === undefined || userId === null) {
70942
+ throw 'Missing the required parameter "userId" when calling getUserExternalid';
70943
+ }
70944
+
70945
+ return this.apiClient.callApi(
70946
+ '/api/v2/users/{userId}/externalid',
70947
+ 'GET',
70948
+ { 'userId': userId },
70949
+ { },
70950
+ { },
70951
+ { },
70952
+ null,
70953
+ ['PureCloud OAuth'],
70954
+ ['application/json'],
70955
+ ['application/json']
70956
+ );
70957
+ }
70958
+
70959
+ /**
70960
+ * Get the external identifier of user for an authority.
70961
+ * Authority name and external key are case sensitive.
70962
+ * @param {String} userId User ID
70963
+ * @param {String} authorityName Authority Name
70964
+ */
70965
+ getUserExternalidAuthorityName(userId, authorityName) {
70966
+ // verify the required parameter 'userId' is set
70967
+ if (userId === undefined || userId === null) {
70968
+ throw 'Missing the required parameter "userId" when calling getUserExternalidAuthorityName';
70969
+ }
70970
+ // verify the required parameter 'authorityName' is set
70971
+ if (authorityName === undefined || authorityName === null) {
70972
+ throw 'Missing the required parameter "authorityName" when calling getUserExternalidAuthorityName';
70973
+ }
70974
+
70975
+ return this.apiClient.callApi(
70976
+ '/api/v2/users/{userId}/externalid/{authorityName}',
70977
+ 'GET',
70978
+ { 'userId': userId,'authorityName': authorityName },
70979
+ { },
70980
+ { },
70981
+ { },
70982
+ null,
70983
+ ['PureCloud OAuth'],
70984
+ ['application/json'],
70985
+ ['application/json']
70986
+ );
70987
+ }
70988
+
70695
70989
  /**
70696
70990
  * Deprecated; will be revived with new contract
70697
70991
  *
@@ -71301,6 +71595,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
71301
71595
  );
71302
71596
  }
71303
71597
 
71598
+ /**
71599
+ * Get the user associated with external identifier.
71600
+ * Authority name and external key are case sensitive.
71601
+ * @param {String} authorityName Authority Name
71602
+ * @param {String} externalKey External Key
71603
+ * @param {Object} opts Optional parameters
71604
+ * @param {Array.<String>} opts.expand Which fields, if any, to expand
71605
+ */
71606
+ getUsersExternalidAuthorityNameExternalKey(authorityName, externalKey, opts) {
71607
+ opts = opts || {};
71608
+
71609
+ // verify the required parameter 'authorityName' is set
71610
+ if (authorityName === undefined || authorityName === null) {
71611
+ throw 'Missing the required parameter "authorityName" when calling getUsersExternalidAuthorityNameExternalKey';
71612
+ }
71613
+ // verify the required parameter 'externalKey' is set
71614
+ if (externalKey === undefined || externalKey === null) {
71615
+ throw 'Missing the required parameter "externalKey" when calling getUsersExternalidAuthorityNameExternalKey';
71616
+ }
71617
+
71618
+ return this.apiClient.callApi(
71619
+ '/api/v2/users/externalid/{authorityName}/{externalKey}',
71620
+ 'GET',
71621
+ { 'authorityName': authorityName,'externalKey': externalKey },
71622
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
71623
+ { },
71624
+ { },
71625
+ null,
71626
+ ['PureCloud OAuth'],
71627
+ ['application/json'],
71628
+ ['application/json']
71629
+ );
71630
+ }
71631
+
71304
71632
  /**
71305
71633
  * Get current user details.
71306
71634
  * This request is not valid when using the Client Credentials OAuth grant.
@@ -72690,7 +73018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72690
73018
  /**
72691
73019
  * Utilities service.
72692
73020
  * @module purecloud-platform-client-v2/api/UtilitiesApi
72693
- * @version 213.1.0
73021
+ * @version 215.0.0
72694
73022
  */
72695
73023
 
72696
73024
  /**
@@ -72801,7 +73129,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72801
73129
  /**
72802
73130
  * Voicemail service.
72803
73131
  * @module purecloud-platform-client-v2/api/VoicemailApi
72804
- * @version 213.1.0
73132
+ * @version 215.0.0
72805
73133
  */
72806
73134
 
72807
73135
  /**
@@ -73523,7 +73851,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
73523
73851
  /**
73524
73852
  * WebChat service.
73525
73853
  * @module purecloud-platform-client-v2/api/WebChatApi
73526
- * @version 213.1.0
73854
+ * @version 215.0.0
73527
73855
  */
73528
73856
 
73529
73857
  /**
@@ -74074,7 +74402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74074
74402
  /**
74075
74403
  * WebDeployments service.
74076
74404
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
74077
- * @version 213.1.0
74405
+ * @version 215.0.0
74078
74406
  */
74079
74407
 
74080
74408
  /**
@@ -74601,7 +74929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74601
74929
  /**
74602
74930
  * WebMessaging service.
74603
74931
  * @module purecloud-platform-client-v2/api/WebMessagingApi
74604
- * @version 213.1.0
74932
+ * @version 215.0.0
74605
74933
  */
74606
74934
 
74607
74935
  /**
@@ -74647,7 +74975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74647
74975
  /**
74648
74976
  * Widgets service.
74649
74977
  * @module purecloud-platform-client-v2/api/WidgetsApi
74650
- * @version 213.1.0
74978
+ * @version 215.0.0
74651
74979
  */
74652
74980
 
74653
74981
  /**
@@ -74793,7 +75121,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74793
75121
  /**
74794
75122
  * WorkforceManagement service.
74795
75123
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
74796
- * @version 213.1.0
75124
+ * @version 215.0.0
74797
75125
  */
74798
75126
 
74799
75127
  /**
@@ -82117,7 +82445,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
82117
82445
  * </pre>
82118
82446
  * </p>
82119
82447
  * @module purecloud-platform-client-v2/index
82120
- * @version 213.1.0
82448
+ * @version 215.0.0
82121
82449
  */
82122
82450
  class platformClient {
82123
82451
  constructor() {