purecloud-platform-client-v2 249.0.0 → 250.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 (97) hide show
  1. package/README.md +34 -3
  2. package/dist/node/purecloud-platform-client-v2.js +20042 -5569
  3. package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +11159 -5369
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +10600 -2242
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
  11. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
  18. package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
  19. package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
  20. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
  21. package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
  22. package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
  23. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
  25. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
  26. package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
  27. package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
  28. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
  29. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
  30. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
  31. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
  32. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
  33. package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
  34. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
  35. package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
  36. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
  37. package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
  38. package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
  39. package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
  40. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
  41. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
  42. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
  43. package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
  44. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
  45. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
  46. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
  47. package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
  48. package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
  49. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
  50. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
  51. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
  52. package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
  53. package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
  54. package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
  55. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
  56. package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
  57. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
  58. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
  59. package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
  60. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
  61. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
  62. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
  63. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
  64. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
  65. package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
  66. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
  67. package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
  68. package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
  69. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
  70. package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
  71. package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
  72. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
  73. package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
  74. package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
  75. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
  76. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
  77. package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
  78. package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
  79. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
  80. package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
  81. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
  82. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
  83. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
  84. package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
  85. package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
  86. package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
  87. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
  88. package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
  89. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
  90. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
  91. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
  92. package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
  93. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
  94. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
  95. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
  96. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
  97. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class UsersRulesApi {
5
5
  /**
6
6
  * UsersRules service.
7
7
  * @module purecloud-platform-client-v2/api/UsersRulesApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -24,8 +24,12 @@ class UsersRulesApi {
24
24
  * Delete an existing users rule
25
25
  *
26
26
  * @param {String} ruleId The id of the rule
27
+ * @param {Object} opts Optional parameters
28
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
27
29
  */
28
- deleteUsersRule(ruleId) {
30
+ deleteUsersRule(ruleId, opts) {
31
+ opts = opts || {};
32
+
29
33
  // verify the required parameter 'ruleId' is set
30
34
  if (ruleId === undefined || ruleId === null || ruleId === '') {
31
35
  throw 'Missing the required parameter "ruleId" when calling deleteUsersRule';
@@ -41,7 +45,8 @@ class UsersRulesApi {
41
45
  null,
42
46
  ['PureCloud OAuth'],
43
47
  ['application/json'],
44
- ['application/json']
48
+ ['application/json'],
49
+ opts['customHeaders']
45
50
  );
46
51
  }
47
52
 
@@ -49,8 +54,12 @@ class UsersRulesApi {
49
54
  * Get a users rule
50
55
  *
51
56
  * @param {String} ruleId The ID of the rule to retrieve
57
+ * @param {Object} opts Optional parameters
58
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
52
59
  */
53
- getUsersRule(ruleId) {
60
+ getUsersRule(ruleId, opts) {
61
+ opts = opts || {};
62
+
54
63
  // verify the required parameter 'ruleId' is set
55
64
  if (ruleId === undefined || ruleId === null || ruleId === '') {
56
65
  throw 'Missing the required parameter "ruleId" when calling getUsersRule';
@@ -66,7 +75,8 @@ class UsersRulesApi {
66
75
  null,
67
76
  ['PureCloud OAuth'],
68
77
  ['application/json'],
69
- ['application/json']
78
+ ['application/json'],
79
+ opts['customHeaders']
70
80
  );
71
81
  }
72
82
 
@@ -76,8 +86,12 @@ class UsersRulesApi {
76
86
  * @param {String} ruleId The ID of the rule for which to retrieve dependents
77
87
  * @param {Object} ruleType The type of the dependent
78
88
  * @param {String} typeId The type ID of the dependent
89
+ * @param {Object} opts Optional parameters
90
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
79
91
  */
80
- getUsersRuleDependentTypeId(ruleId, ruleType, typeId) {
92
+ getUsersRuleDependentTypeId(ruleId, ruleType, typeId, opts) {
93
+ opts = opts || {};
94
+
81
95
  // verify the required parameter 'ruleId' is set
82
96
  if (ruleId === undefined || ruleId === null || ruleId === '') {
83
97
  throw 'Missing the required parameter "ruleId" when calling getUsersRuleDependentTypeId';
@@ -101,7 +115,8 @@ class UsersRulesApi {
101
115
  null,
102
116
  ['PureCloud OAuth'],
103
117
  ['application/json'],
104
- ['application/json']
118
+ ['application/json'],
119
+ opts['customHeaders']
105
120
  );
106
121
  }
107
122
 
@@ -113,6 +128,7 @@ class UsersRulesApi {
113
128
  * @param {Number} opts.pageSize Number of results per page (default to 25)
114
129
  * @param {Number} opts.pageNumber Page number (default to 1)
115
130
  * @param {Object} opts.sortOrder Sort order for dependents (by last run date, then created date) (default to descending)
131
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
116
132
  */
117
133
  getUsersRuleDependents(ruleId, opts) {
118
134
  opts = opts || {};
@@ -132,7 +148,8 @@ class UsersRulesApi {
132
148
  null,
133
149
  ['PureCloud OAuth'],
134
150
  ['application/json'],
135
- ['application/json']
151
+ ['application/json'],
152
+ opts['customHeaders']
136
153
  );
137
154
  }
138
155
 
@@ -147,6 +164,7 @@ class UsersRulesApi {
147
164
  * @param {Boolean} opts.enabled Whether to list enabled or disabled rules
148
165
  * @param {String} opts.searchTerm a search term for finding a rule by name
149
166
  * @param {Object} opts.sortOrder sort rules by name, ascending, descending (default to ascending)
167
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
150
168
  */
151
169
  getUsersRules(types, opts) {
152
170
  opts = opts || {};
@@ -166,7 +184,8 @@ class UsersRulesApi {
166
184
  null,
167
185
  ['PureCloud OAuth'],
168
186
  ['application/json'],
169
- ['application/json']
187
+ ['application/json'],
188
+ opts['customHeaders']
170
189
  );
171
190
  }
172
191
 
@@ -174,8 +193,12 @@ class UsersRulesApi {
174
193
  * Get the settings for a specific users rule type
175
194
  *
176
195
  * @param {Object} ruleType The type of the rule
196
+ * @param {Object} opts Optional parameters
197
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
177
198
  */
178
- getUsersRulesSetting(ruleType) {
199
+ getUsersRulesSetting(ruleType, opts) {
200
+ opts = opts || {};
201
+
179
202
  // verify the required parameter 'ruleType' is set
180
203
  if (ruleType === undefined || ruleType === null || ruleType === '') {
181
204
  throw 'Missing the required parameter "ruleType" when calling getUsersRulesSetting';
@@ -191,7 +214,8 @@ class UsersRulesApi {
191
214
  null,
192
215
  ['PureCloud OAuth'],
193
216
  ['application/json'],
194
- ['application/json']
217
+ ['application/json'],
218
+ opts['customHeaders']
195
219
  );
196
220
  }
197
221
 
@@ -200,8 +224,12 @@ class UsersRulesApi {
200
224
  * This will update an existing users rule with the specified fields.
201
225
  * @param {String} ruleId The ID of the rule to update
202
226
  * @param {Object} body updateRuleRequest
227
+ * @param {Object} opts Optional parameters
228
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
203
229
  */
204
- patchUsersRule(ruleId, body) {
230
+ patchUsersRule(ruleId, body, opts) {
231
+ opts = opts || {};
232
+
205
233
  // verify the required parameter 'ruleId' is set
206
234
  if (ruleId === undefined || ruleId === null || ruleId === '') {
207
235
  throw 'Missing the required parameter "ruleId" when calling patchUsersRule';
@@ -221,7 +249,8 @@ class UsersRulesApi {
221
249
  body,
222
250
  ['PureCloud OAuth'],
223
251
  ['application/json'],
224
- ['application/json']
252
+ ['application/json'],
253
+ opts['customHeaders']
225
254
  );
226
255
  }
227
256
 
@@ -229,8 +258,12 @@ class UsersRulesApi {
229
258
  * Create a new rule
230
259
  * This will create a new rule with the specified fields.
231
260
  * @param {Object} body usersRulesCreateRuleRequest
261
+ * @param {Object} opts Optional parameters
262
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
232
263
  */
233
- postUsersRules(body) {
264
+ postUsersRules(body, opts) {
265
+ opts = opts || {};
266
+
234
267
  // verify the required parameter 'body' is set
235
268
  if (body === undefined || body === null) {
236
269
  throw 'Missing the required parameter "body" when calling postUsersRules';
@@ -246,7 +279,8 @@ class UsersRulesApi {
246
279
  body,
247
280
  ['PureCloud OAuth'],
248
281
  ['application/json'],
249
- ['application/json']
282
+ ['application/json'],
283
+ opts['customHeaders']
250
284
  );
251
285
  }
252
286
 
@@ -257,6 +291,7 @@ class UsersRulesApi {
257
291
  * @param {Object} opts Optional parameters
258
292
  * @param {Number} opts.pageNumber Page number (default to 1)
259
293
  * @param {Number} opts.pageSize Number of results per page (default to 25)
294
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
260
295
  */
261
296
  postUsersRulesQuery(body, opts) {
262
297
  opts = opts || {};
@@ -276,7 +311,8 @@ class UsersRulesApi {
276
311
  body,
277
312
  ['PureCloud OAuth'],
278
313
  ['application/json'],
279
- ['application/json']
314
+ ['application/json'],
315
+ opts['customHeaders']
280
316
  );
281
317
  }
282
318
 
@@ -5,7 +5,7 @@ class UtilitiesApi {
5
5
  /**
6
6
  * Utilities service.
7
7
  * @module purecloud-platform-client-v2/api/UtilitiesApi
8
- * @version 249.0.0
8
+ * @version 250.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -23,8 +23,12 @@ class UtilitiesApi {
23
23
  /**
24
24
  * Get the current system date/time
25
25
  *
26
+ * @param {Object} opts Optional parameters
27
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
26
28
  */
27
- getDate() {
29
+ getDate(opts) {
30
+ opts = opts || {};
31
+
28
32
 
29
33
  return this.apiClient.callApi(
30
34
  '/api/v2/date',
@@ -36,15 +40,20 @@ class UtilitiesApi {
36
40
  null,
37
41
  ['PureCloud OAuth'],
38
42
  ['application/json'],
39
- ['application/json']
43
+ ['application/json'],
44
+ opts['customHeaders']
40
45
  );
41
46
  }
42
47
 
43
48
  /**
44
49
  * Get public ip address ranges for Genesys Cloud
45
50
  *
51
+ * @param {Object} opts Optional parameters
52
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
46
53
  */
47
- getIpranges() {
54
+ getIpranges(opts) {
55
+ opts = opts || {};
56
+
48
57
 
49
58
  return this.apiClient.callApi(
50
59
  '/api/v2/ipranges',
@@ -56,7 +65,8 @@ class UtilitiesApi {
56
65
  null,
57
66
  ['PureCloud OAuth'],
58
67
  ['application/json'],
59
- ['application/json']
68
+ ['application/json'],
69
+ opts['customHeaders']
60
70
  );
61
71
  }
62
72
 
@@ -66,6 +76,7 @@ class UtilitiesApi {
66
76
  * @param {Object} opts Optional parameters
67
77
  * @param {Number} opts.pageSize Page size (default to 25)
68
78
  * @param {Number} opts.pageNumber Page number (default to 1)
79
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
69
80
  */
70
81
  getTimezones(opts) {
71
82
  opts = opts || {};
@@ -81,7 +92,8 @@ class UtilitiesApi {
81
92
  null,
82
93
  ['PureCloud OAuth'],
83
94
  ['application/json'],
84
- ['application/json']
95
+ ['application/json'],
96
+ opts['customHeaders']
85
97
  );
86
98
  }
87
99
 
@@ -89,8 +101,12 @@ class UtilitiesApi {
89
101
  * Returns the information about an X509 PEM encoded certificate or certificate chain.
90
102
  *
91
103
  * @param {Object} body Certificate
104
+ * @param {Object} opts Optional parameters
105
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
92
106
  */
93
- postCertificateDetails(body) {
107
+ postCertificateDetails(body, opts) {
108
+ opts = opts || {};
109
+
94
110
  // verify the required parameter 'body' is set
95
111
  if (body === undefined || body === null) {
96
112
  throw 'Missing the required parameter "body" when calling postCertificateDetails';
@@ -106,7 +122,8 @@ class UtilitiesApi {
106
122
  body,
107
123
  ['PureCloud OAuth'],
108
124
  ['application/json'],
109
- ['application/json']
125
+ ['application/json'],
126
+ opts['customHeaders']
110
127
  );
111
128
  }
112
129