purecloud-platform-client-v2 253.0.0 → 254.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 +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +1159 -304
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1159 -304
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +438 -304
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +438 -304
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +462 -15
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -62
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.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/BackgroundAssistantApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +435 -1
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +207 -125
  26. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -6
  30. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -5
  39. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -5
  49. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -9
  68. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/RoutingApi.js +155 -3
  71. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +268 -1
  82. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -5
  89. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  93. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  94. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  95. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  96. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +10 -5
  97. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5,7 +5,7 @@ class CaseManagementApi {
5
5
  /**
6
6
  * CaseManagement service.
7
7
  * @module purecloud-platform-client-v2/api/CaseManagementApi
8
- * @version 253.0.0
8
+ * @version 254.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -23,10 +23,9 @@ class CaseManagementApi {
23
23
  /**
24
24
  * Delete a Case.
25
25
  *
26
- * @param {String} caseId Case ID
26
+ * @param {String} caseId Case identifier.
27
27
  * @param {Object} opts Optional parameters
28
28
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
29
- * deleteCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30
29
  */
31
30
  deleteCasemanagementCase(caseId, opts) {
32
31
  opts = opts || {};
@@ -54,10 +53,9 @@ class CaseManagementApi {
54
53
  /**
55
54
  * Delete a Caseplan.
56
55
  *
57
- * @param {String} caseplanId Caseplan ID
56
+ * @param {String} caseplanId Caseplan identifier.
58
57
  * @param {Object} opts Optional parameters
59
58
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
60
- * deleteCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61
59
  */
62
60
  deleteCasemanagementCaseplan(caseplanId, opts) {
63
61
  opts = opts || {};
@@ -82,14 +80,48 @@ class CaseManagementApi {
82
80
  );
83
81
  }
84
82
 
83
+ /**
84
+ * Remove a data schema from a draft Caseplan.
85
+ *
86
+ * @param {String} caseplanId Caseplan identifier.
87
+ * @param {String} schemaKeyName Schema key (for example default).
88
+ * @param {Object} opts Optional parameters
89
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
90
+ */
91
+ deleteCasemanagementCaseplanDataschema(caseplanId, schemaKeyName, opts) {
92
+ opts = opts || {};
93
+
94
+ // verify the required parameter 'caseplanId' is set
95
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
96
+ throw 'Missing the required parameter "caseplanId" when calling deleteCasemanagementCaseplanDataschema';
97
+ }
98
+ // verify the required parameter 'schemaKeyName' is set
99
+ if (schemaKeyName === undefined || schemaKeyName === null || schemaKeyName === '') {
100
+ throw 'Missing the required parameter "schemaKeyName" when calling deleteCasemanagementCaseplanDataschema';
101
+ }
102
+
103
+ return this.apiClient.callApi(
104
+ '/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}',
105
+ 'DELETE',
106
+ { 'caseplanId': caseplanId,'schemaKeyName': schemaKeyName },
107
+ { },
108
+ { },
109
+ { },
110
+ null,
111
+ ['PureCloud OAuth'],
112
+ ['application/json'],
113
+ ['application/json'],
114
+ opts['customHeaders']
115
+ );
116
+ }
117
+
85
118
  /**
86
119
  * Get a Case.
87
120
  *
88
- * @param {String} caseId Case ID
121
+ * @param {String} caseId Case identifier.
89
122
  * @param {Object} opts Optional parameters
90
- * @param {Object} opts.expands Which fields to expand.
123
+ * @param {Object} opts.expands Fields to expand.
91
124
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
92
- * getCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
93
125
  */
94
126
  getCasemanagementCase(caseId, opts) {
95
127
  opts = opts || {};
@@ -117,11 +149,10 @@ class CaseManagementApi {
117
149
  /**
118
150
  * Get a Case Association.
119
151
  *
120
- * @param {String} caseId Case ID
121
- * @param {String} associationId Case Association ID
152
+ * @param {String} caseId Case identifier.
153
+ * @param {String} associationId Case association identifier.
122
154
  * @param {Object} opts Optional parameters
123
155
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
124
- * getCasemanagementCaseAssociation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
125
156
  */
126
157
  getCasemanagementCaseAssociation(caseId, associationId, opts) {
127
158
  opts = opts || {};
@@ -151,15 +182,14 @@ class CaseManagementApi {
151
182
  }
152
183
 
153
184
  /**
154
- * Get a list of case associations for a provided case.
185
+ * Get a list of Case associations for the Case.
155
186
  *
156
- * @param {String} caseId Case ID.
187
+ * @param {String} caseId Case identifier.
157
188
  * @param {Object} opts Optional parameters
158
189
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
159
190
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
160
191
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
161
192
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
162
- * getCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
163
193
  */
164
194
  getCasemanagementCaseAssociations(caseId, opts) {
165
195
  opts = opts || {};
@@ -187,11 +217,10 @@ class CaseManagementApi {
187
217
  /**
188
218
  * Get a Stage.
189
219
  *
190
- * @param {String} caseId Case ID
191
- * @param {String} stageId Stage ID
220
+ * @param {String} caseId Case identifier.
221
+ * @param {String} stageId Stage identifier.
192
222
  * @param {Object} opts Optional parameters
193
223
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
194
- * getCasemanagementCaseStage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
195
224
  */
196
225
  getCasemanagementCaseStage(caseId, stageId, opts) {
197
226
  opts = opts || {};
@@ -223,12 +252,11 @@ class CaseManagementApi {
223
252
  /**
224
253
  * Get a Step.
225
254
  *
226
- * @param {String} caseId Case ID
227
- * @param {String} stageId Stage ID
228
- * @param {String} stepId Step ID
255
+ * @param {String} caseId Case identifier.
256
+ * @param {String} stageId Stage identifier.
257
+ * @param {String} stepId Step identifier.
229
258
  * @param {Object} opts Optional parameters
230
259
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
231
- * getCasemanagementCaseStageStep is a preview method and is subject to both breaking and non-breaking changes at any time without notice
232
260
  */
233
261
  getCasemanagementCaseStageStep(caseId, stageId, stepId, opts) {
234
262
  opts = opts || {};
@@ -264,14 +292,13 @@ class CaseManagementApi {
264
292
  /**
265
293
  * Get a list of Steps.
266
294
  *
267
- * @param {String} caseId Case ID
268
- * @param {String} stageId Stage ID
295
+ * @param {String} caseId Case identifier.
296
+ * @param {String} stageId Stage identifier.
269
297
  * @param {Object} opts Optional parameters
270
298
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
271
299
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
272
300
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
273
301
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
274
- * getCasemanagementCaseStageSteps is a preview method and is subject to both breaking and non-breaking changes at any time without notice
275
302
  */
276
303
  getCasemanagementCaseStageSteps(caseId, stageId, opts) {
277
304
  opts = opts || {};
@@ -303,13 +330,12 @@ class CaseManagementApi {
303
330
  /**
304
331
  * Get a list of Stages.
305
332
  *
306
- * @param {String} caseId Case ID
333
+ * @param {String} caseId Case identifier.
307
334
  * @param {Object} opts Optional parameters
308
335
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
309
336
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
310
337
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
311
338
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
312
- * getCasemanagementCaseStages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
313
339
  */
314
340
  getCasemanagementCaseStages(caseId, opts) {
315
341
  opts = opts || {};
@@ -337,11 +363,10 @@ class CaseManagementApi {
337
363
  /**
338
364
  * Get a Terminate Job for a Case.
339
365
  *
340
- * @param {String} caseId Case ID
341
- * @param {String} jobId Job ID
366
+ * @param {String} caseId Case identifier.
367
+ * @param {String} jobId Terminate Job identifier.
342
368
  * @param {Object} opts Optional parameters
343
369
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
344
- * getCasemanagementCaseTerminateJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
345
370
  */
346
371
  getCasemanagementCaseTerminateJob(caseId, jobId, opts) {
347
372
  opts = opts || {};
@@ -373,10 +398,9 @@ class CaseManagementApi {
373
398
  /**
374
399
  * Get a Caseplan.
375
400
  *
376
- * @param {String} caseplanId Caseplan ID
401
+ * @param {String} caseplanId Caseplan identifier.
377
402
  * @param {Object} opts Optional parameters
378
403
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
379
- * getCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
380
404
  */
381
405
  getCasemanagementCaseplan(caseplanId, opts) {
382
406
  opts = opts || {};
@@ -404,11 +428,10 @@ class CaseManagementApi {
404
428
  /**
405
429
  * Get a Caseplan version.
406
430
  *
407
- * @param {String} caseplanId Caseplan ID
408
- * @param {String} versionId Version of the caseplan
431
+ * @param {String} caseplanId Caseplan identifier.
432
+ * @param {String} versionId Caseplan version identifier.
409
433
  * @param {Object} opts Optional parameters
410
434
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
411
- * getCasemanagementCaseplanVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
412
435
  */
413
436
  getCasemanagementCaseplanVersion(caseplanId, versionId, opts) {
414
437
  opts = opts || {};
@@ -438,13 +461,12 @@ class CaseManagementApi {
438
461
  }
439
462
 
440
463
  /**
441
- * Get the dataSchemas for a caseplan version.
464
+ * Get the data schemas for a Caseplan version.
442
465
  *
443
- * @param {String} caseplanId Caseplan ID
444
- * @param {String} versionId Version of the caseplan
466
+ * @param {String} caseplanId Caseplan identifier.
467
+ * @param {String} versionId Caseplan version identifier.
445
468
  * @param {Object} opts Optional parameters
446
469
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
447
- * getCasemanagementCaseplanVersionDataschemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
448
470
  */
449
471
  getCasemanagementCaseplanVersionDataschemas(caseplanId, versionId, opts) {
450
472
  opts = opts || {};
@@ -476,11 +498,10 @@ class CaseManagementApi {
476
498
  /**
477
499
  * Get the intake settings for a Caseplan version.
478
500
  *
479
- * @param {String} caseplanId Caseplan ID
480
- * @param {String} versionId Version of the caseplan
501
+ * @param {String} caseplanId Caseplan identifier.
502
+ * @param {String} versionId Caseplan version identifier.
481
503
  * @param {Object} opts Optional parameters
482
504
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
483
- * getCasemanagementCaseplanVersionIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
484
505
  */
485
506
  getCasemanagementCaseplanVersionIntakesettings(caseplanId, versionId, opts) {
486
507
  opts = opts || {};
@@ -512,13 +533,12 @@ class CaseManagementApi {
512
533
  /**
513
534
  * Get a Stageplan.
514
535
  *
515
- * @param {String} caseplanId Caseplan ID
516
- * @param {String} versionId Version ID
517
- * @param {String} stageplanId Stageplan ID
536
+ * @param {String} caseplanId Caseplan identifier.
537
+ * @param {String} versionId Caseplan version identifier.
538
+ * @param {String} stageplanId Stageplan identifier.
518
539
  * @param {Object} opts Optional parameters
519
- * @param {Array.<String>} opts.expands Which fields to expand.
540
+ * @param {Array.<String>} opts.expands Fields to expand.
520
541
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
521
- * getCasemanagementCaseplanVersionStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
522
542
  */
523
543
  getCasemanagementCaseplanVersionStageplan(caseplanId, versionId, stageplanId, opts) {
524
544
  opts = opts || {};
@@ -554,14 +574,13 @@ class CaseManagementApi {
554
574
  /**
555
575
  * Get a Stepplan.
556
576
  *
557
- * @param {String} caseplanId Caseplan ID
558
- * @param {String} versionId Version ID
559
- * @param {String} stageplanId Stageplan ID
560
- * @param {String} stepplanId Stepplan ID
577
+ * @param {String} caseplanId Caseplan identifier.
578
+ * @param {String} versionId Caseplan version identifier.
579
+ * @param {String} stageplanId Stageplan identifier.
580
+ * @param {String} stepplanId Stepplan identifier.
561
581
  * @param {Object} opts Optional parameters
562
- * @param {Array.<String>} opts.expands Which fields to expand.
582
+ * @param {Array.<String>} opts.expands Fields to expand.
563
583
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
564
- * getCasemanagementCaseplanVersionStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
565
584
  */
566
585
  getCasemanagementCaseplanVersionStageplanStepplan(caseplanId, versionId, stageplanId, stepplanId, opts) {
567
586
  opts = opts || {};
@@ -601,16 +620,15 @@ class CaseManagementApi {
601
620
  /**
602
621
  * Get a list of Stepplans.
603
622
  *
604
- * @param {String} caseplanId Caseplan ID
605
- * @param {String} versionId Version ID
606
- * @param {String} stageplanId Stageplan ID
623
+ * @param {String} caseplanId Caseplan identifier.
624
+ * @param {String} versionId Caseplan version identifier.
625
+ * @param {String} stageplanId Stageplan identifier.
607
626
  * @param {Object} opts Optional parameters
608
627
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
609
628
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
610
629
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
611
- * @param {Array.<String>} opts.expands Which fields to expand.
630
+ * @param {Array.<String>} opts.expands Fields to expand.
612
631
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
613
- * getCasemanagementCaseplanVersionStageplanStepplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
614
632
  */
615
633
  getCasemanagementCaseplanVersionStageplanStepplans(caseplanId, versionId, stageplanId, opts) {
616
634
  opts = opts || {};
@@ -646,15 +664,14 @@ class CaseManagementApi {
646
664
  /**
647
665
  * Get a list of Stageplans.
648
666
  *
649
- * @param {String} caseplanId Caseplan ID
650
- * @param {String} versionId Version ID
667
+ * @param {String} caseplanId Caseplan identifier.
668
+ * @param {String} versionId Caseplan version identifier.
651
669
  * @param {Object} opts Optional parameters
652
670
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
653
671
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
654
672
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
655
- * @param {Array.<String>} opts.expands Which fields to expand.
673
+ * @param {Array.<String>} opts.expands Fields to expand.
656
674
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
657
- * getCasemanagementCaseplanVersionStageplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
658
675
  */
659
676
  getCasemanagementCaseplanVersionStageplans(caseplanId, versionId, opts) {
660
677
  opts = opts || {};
@@ -687,12 +704,11 @@ class CaseManagementApi {
687
704
  * Get a list of Caseplans.
688
705
  *
689
706
  * @param {Object} opts Optional parameters
690
- * @param {String} opts.after The cursor that points to the end of the set of caseplans that has been returned.
691
- * @param {Number} opts.pageSize Number of caseplans to return. Maximum of 200.
692
- * @param {String} opts.customerIntentId Filter by Customer Intent.
693
- * @param {String} opts.divisionIds Filter by Divisions.
707
+ * @param {String} opts.after Cursor that points to the end of the previously returned set of Caseplans.
708
+ * @param {Number} opts.pageSize Number of Caseplans to return. Maximum is 200.
709
+ * @param {String} opts.customerIntentId Filter by customer intent.
710
+ * @param {String} opts.divisionIds Filter by divisions.
694
711
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
695
- * getCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
696
712
  */
697
713
  getCasemanagementCaseplans(opts) {
698
714
  opts = opts || {};
@@ -714,16 +730,15 @@ class CaseManagementApi {
714
730
  }
715
731
 
716
732
  /**
717
- * Get a list of cases for provided external contact id.
733
+ * Get a list of Cases for an External Contact.
718
734
  *
719
- * @param {String} externalContactId External Contact ID
735
+ * @param {String} externalContactId External contact identifier.
720
736
  * @param {Object} opts Optional parameters
721
- * @param {String} opts.after The cursor that points to the end of the set of cases that has been returned.
722
- * @param {Number} opts.pageSize Number of cases to return. Maximum of 200.
723
- * @param {String} opts.divisionIds Filter by Divisions
724
- * @param {Array.<String>} opts.expands Which fields to expand.
737
+ * @param {String} opts.after Cursor pointing to the end of the previously returned page of Cases.
738
+ * @param {Number} opts.pageSize Number of Cases to return (maximum 200).
739
+ * @param {String} opts.divisionIds Filter by divisions.
740
+ * @param {Array.<String>} opts.expands Fields to expand.
725
741
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
726
- * getCasemanagementCasesExternalcontact is a preview method and is subject to both breaking and non-breaking changes at any time without notice
727
742
  */
728
743
  getCasemanagementCasesExternalcontact(externalContactId, opts) {
729
744
  opts = opts || {};
@@ -751,11 +766,10 @@ class CaseManagementApi {
751
766
  /**
752
767
  * Get a Case by reference.
753
768
  *
754
- * @param {String} referenceId Reference
769
+ * @param {String} referenceId Case reference.
755
770
  * @param {Object} opts Optional parameters
756
- * @param {Object} opts.expands Which fields to expand.
771
+ * @param {Object} opts.expands Fields to expand.
757
772
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
758
- * getCasemanagementCasesReference is a preview method and is subject to both breaking and non-breaking changes at any time without notice
759
773
  */
760
774
  getCasemanagementCasesReference(referenceId, opts) {
761
775
  opts = opts || {};
@@ -781,13 +795,12 @@ class CaseManagementApi {
781
795
  }
782
796
 
783
797
  /**
784
- * Update date due of a Case.
798
+ * Update the due date of a Case.
785
799
  *
786
- * @param {String} caseId Case ID
787
- * @param {Object} body Date due
800
+ * @param {String} caseId Case identifier.
801
+ * @param {Object} body Due date update.
788
802
  * @param {Object} opts Optional parameters
789
803
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
790
- * patchCasemanagementCaseDatedue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
791
804
  */
792
805
  patchCasemanagementCaseDatedue(caseId, body, opts) {
793
806
  opts = opts || {};
@@ -819,11 +832,10 @@ class CaseManagementApi {
819
832
  /**
820
833
  * Update priority of a Case.
821
834
  *
822
- * @param {String} caseId Case ID
823
- * @param {Object} body Priority
835
+ * @param {String} caseId Case identifier.
836
+ * @param {Object} body Priority update.
824
837
  * @param {Object} opts Optional parameters
825
838
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
826
- * patchCasemanagementCasePriority is a preview method and is subject to both breaking and non-breaking changes at any time without notice
827
839
  */
828
840
  patchCasemanagementCasePriority(caseId, body, opts) {
829
841
  opts = opts || {};
@@ -855,11 +867,10 @@ class CaseManagementApi {
855
867
  /**
856
868
  * Update summary of a Case.
857
869
  *
858
- * @param {String} caseId Case ID
859
- * @param {Object} body Summary
870
+ * @param {String} caseId Case identifier.
871
+ * @param {Object} body Summary update.
860
872
  * @param {Object} opts Optional parameters
861
873
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
862
- * patchCasemanagementCaseSummary is a preview method and is subject to both breaking and non-breaking changes at any time without notice
863
874
  */
864
875
  patchCasemanagementCaseSummary(caseId, body, opts) {
865
876
  opts = opts || {};
@@ -891,11 +902,10 @@ class CaseManagementApi {
891
902
  /**
892
903
  * Update the attributes of a Caseplan.
893
904
  *
894
- * @param {String} caseplanId Caseplan ID
895
- * @param {Object} body Caseplan
905
+ * @param {String} caseplanId Caseplan identifier.
906
+ * @param {Object} body Caseplan update.
896
907
  * @param {Object} opts Optional parameters
897
908
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
898
- * patchCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
899
909
  */
900
910
  patchCasemanagementCaseplan(caseplanId, body, opts) {
901
911
  opts = opts || {};
@@ -927,12 +937,11 @@ class CaseManagementApi {
927
937
  /**
928
938
  * Update the attributes of a Stageplan.
929
939
  *
930
- * @param {String} caseplanId Caseplan ID
931
- * @param {String} stageplanId Stageplan ID
932
- * @param {Object} body Stageplan
940
+ * @param {String} caseplanId Caseplan identifier.
941
+ * @param {String} stageplanId Stageplan identifier.
942
+ * @param {Object} body Stageplan update.
933
943
  * @param {Object} opts Optional parameters
934
944
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
935
- * patchCasemanagementCaseplanStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
936
945
  */
937
946
  patchCasemanagementCaseplanStageplan(caseplanId, stageplanId, body, opts) {
938
947
  opts = opts || {};
@@ -968,13 +977,12 @@ class CaseManagementApi {
968
977
  /**
969
978
  * Update the attributes of a Stepplan.
970
979
  *
971
- * @param {String} caseplanId Caseplan ID
972
- * @param {String} stageplanId Stageplan ID
973
- * @param {String} stepplanId Stepplan ID
974
- * @param {Object} body Stepplan
980
+ * @param {String} caseplanId Caseplan identifier.
981
+ * @param {String} stageplanId Stageplan identifier.
982
+ * @param {String} stepplanId Stepplan identifier.
983
+ * @param {Object} body Stepplan update.
975
984
  * @param {Object} opts Optional parameters
976
985
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
977
- * patchCasemanagementCaseplanStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
978
986
  */
979
987
  patchCasemanagementCaseplanStageplanStepplan(caseplanId, stageplanId, stepplanId, body, opts) {
980
988
  opts = opts || {};
@@ -1012,21 +1020,24 @@ class CaseManagementApi {
1012
1020
  }
1013
1021
 
1014
1022
  /**
1015
- * Create a case association.
1023
+ * Create a Case association.
1016
1024
  *
1017
- * @param {String} caseId Case ID.
1025
+ * @param {String} caseId Case identifier.
1026
+ * @param {Object} body Case association create request.
1018
1027
  * @param {Object} opts Optional parameters
1019
- * @param {Object} opts.body Case Association
1020
1028
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1021
- * postCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1022
1029
  */
1023
- postCasemanagementCaseAssociations(caseId, opts) {
1030
+ postCasemanagementCaseAssociations(caseId, body, opts) {
1024
1031
  opts = opts || {};
1025
1032
 
1026
1033
  // verify the required parameter 'caseId' is set
1027
1034
  if (caseId === undefined || caseId === null || caseId === '') {
1028
1035
  throw 'Missing the required parameter "caseId" when calling postCasemanagementCaseAssociations';
1029
1036
  }
1037
+ // verify the required parameter 'body' is set
1038
+ if (body === undefined || body === null) {
1039
+ throw 'Missing the required parameter "body" when calling postCasemanagementCaseAssociations';
1040
+ }
1030
1041
 
1031
1042
  return this.apiClient.callApi(
1032
1043
  '/api/v2/casemanagement/cases/{caseId}/associations',
@@ -1035,7 +1046,7 @@ class CaseManagementApi {
1035
1046
  { },
1036
1047
  { },
1037
1048
  { },
1038
- opts['body'],
1049
+ body,
1039
1050
  ['PureCloud OAuth'],
1040
1051
  ['application/json'],
1041
1052
  ['application/json'],
@@ -1046,10 +1057,9 @@ class CaseManagementApi {
1046
1057
  /**
1047
1058
  * Create a Terminate Job for a Case.
1048
1059
  *
1049
- * @param {String} caseId Case ID
1060
+ * @param {String} caseId Case identifier.
1050
1061
  * @param {Object} opts Optional parameters
1051
1062
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1052
- * postCasemanagementCaseTerminateJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1053
1063
  */
1054
1064
  postCasemanagementCaseTerminateJobs(caseId, opts) {
1055
1065
  opts = opts || {};
@@ -1074,13 +1084,47 @@ class CaseManagementApi {
1074
1084
  );
1075
1085
  }
1076
1086
 
1087
+ /**
1088
+ * Add a data schema to a draft Caseplan.
1089
+ *
1090
+ * @param {String} caseplanId Caseplan identifier.
1091
+ * @param {Object} body Data schema reference.
1092
+ * @param {Object} opts Optional parameters
1093
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1094
+ */
1095
+ postCasemanagementCaseplanDataschemas(caseplanId, body, opts) {
1096
+ opts = opts || {};
1097
+
1098
+ // verify the required parameter 'caseplanId' is set
1099
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
1100
+ throw 'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanDataschemas';
1101
+ }
1102
+ // verify the required parameter 'body' is set
1103
+ if (body === undefined || body === null) {
1104
+ throw 'Missing the required parameter "body" when calling postCasemanagementCaseplanDataschemas';
1105
+ }
1106
+
1107
+ return this.apiClient.callApi(
1108
+ '/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas',
1109
+ 'POST',
1110
+ { 'caseplanId': caseplanId },
1111
+ { },
1112
+ { },
1113
+ { },
1114
+ body,
1115
+ ['PureCloud OAuth'],
1116
+ ['application/json'],
1117
+ ['application/json'],
1118
+ opts['customHeaders']
1119
+ );
1120
+ }
1121
+
1077
1122
  /**
1078
1123
  * Publish Caseplan.
1079
1124
  *
1080
- * @param {String} caseplanId Caseplan ID
1125
+ * @param {String} caseplanId Caseplan identifier.
1081
1126
  * @param {Object} opts Optional parameters
1082
1127
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1083
- * postCasemanagementCaseplanPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1084
1128
  */
1085
1129
  postCasemanagementCaseplanPublish(caseplanId, opts) {
1086
1130
  opts = opts || {};
@@ -1108,10 +1152,9 @@ class CaseManagementApi {
1108
1152
  /**
1109
1153
  * Create Caseplan version.
1110
1154
  *
1111
- * @param {String} caseplanId Caseplan ID
1155
+ * @param {String} caseplanId Caseplan identifier.
1112
1156
  * @param {Object} opts Optional parameters
1113
1157
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1114
- * postCasemanagementCaseplanVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1115
1158
  */
1116
1159
  postCasemanagementCaseplanVersions(caseplanId, opts) {
1117
1160
  opts = opts || {};
@@ -1139,10 +1182,9 @@ class CaseManagementApi {
1139
1182
  /**
1140
1183
  * Create a Caseplan.
1141
1184
  *
1142
- * @param {Object} body Caseplan
1185
+ * @param {Object} body Caseplan create request.
1143
1186
  * @param {Object} opts Optional parameters
1144
1187
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1145
- * postCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1146
1188
  */
1147
1189
  postCasemanagementCaseplans(body, opts) {
1148
1190
  opts = opts || {};
@@ -1168,12 +1210,11 @@ class CaseManagementApi {
1168
1210
  }
1169
1211
 
1170
1212
  /**
1171
- * Query for caseplans
1213
+ * Query for Caseplans.
1172
1214
  *
1173
- * @param {Object} body CaseplanQueryRequest
1215
+ * @param {Object} body Caseplan query request.
1174
1216
  * @param {Object} opts Optional parameters
1175
1217
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1176
- * postCasemanagementCaseplansQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1177
1218
  */
1178
1219
  postCasemanagementCaseplansQuery(body, opts) {
1179
1220
  opts = opts || {};
@@ -1201,10 +1242,9 @@ class CaseManagementApi {
1201
1242
  /**
1202
1243
  * Create a Case.
1203
1244
  *
1204
- * @param {Object} body Case
1245
+ * @param {Object} body Case create request.
1205
1246
  * @param {Object} opts Optional parameters
1206
1247
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1207
- * postCasemanagementCases is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1208
1248
  */
1209
1249
  postCasemanagementCases(body, opts) {
1210
1250
  opts = opts || {};
@@ -1230,16 +1270,19 @@ class CaseManagementApi {
1230
1270
  }
1231
1271
 
1232
1272
  /**
1233
- * Query for case associations
1273
+ * Query for Case associations by interaction.
1234
1274
  *
1275
+ * @param {Object} body Case association query request.
1235
1276
  * @param {Object} opts Optional parameters
1236
- * @param {Object} opts.body Case Association
1237
1277
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1238
- * postCasemanagementCasesAssociationsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1239
1278
  */
1240
- postCasemanagementCasesAssociationsQuery(opts) {
1279
+ postCasemanagementCasesAssociationsQuery(body, opts) {
1241
1280
  opts = opts || {};
1242
1281
 
1282
+ // verify the required parameter 'body' is set
1283
+ if (body === undefined || body === null) {
1284
+ throw 'Missing the required parameter "body" when calling postCasemanagementCasesAssociationsQuery';
1285
+ }
1243
1286
 
1244
1287
  return this.apiClient.callApi(
1245
1288
  '/api/v2/casemanagement/cases/associations/query',
@@ -1248,7 +1291,47 @@ class CaseManagementApi {
1248
1291
  { },
1249
1292
  { },
1250
1293
  { },
1251
- opts['body'],
1294
+ body,
1295
+ ['PureCloud OAuth'],
1296
+ ['application/json'],
1297
+ ['application/json'],
1298
+ opts['customHeaders']
1299
+ );
1300
+ }
1301
+
1302
+ /**
1303
+ * Update a data schema on a draft Caseplan.
1304
+ *
1305
+ * @param {String} caseplanId Caseplan identifier.
1306
+ * @param {String} schemaKeyName Schema key (for example default).
1307
+ * @param {Object} body Data schema reference.
1308
+ * @param {Object} opts Optional parameters
1309
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1310
+ */
1311
+ putCasemanagementCaseplanDataschema(caseplanId, schemaKeyName, body, opts) {
1312
+ opts = opts || {};
1313
+
1314
+ // verify the required parameter 'caseplanId' is set
1315
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
1316
+ throw 'Missing the required parameter "caseplanId" when calling putCasemanagementCaseplanDataschema';
1317
+ }
1318
+ // verify the required parameter 'schemaKeyName' is set
1319
+ if (schemaKeyName === undefined || schemaKeyName === null || schemaKeyName === '') {
1320
+ throw 'Missing the required parameter "schemaKeyName" when calling putCasemanagementCaseplanDataschema';
1321
+ }
1322
+ // verify the required parameter 'body' is set
1323
+ if (body === undefined || body === null) {
1324
+ throw 'Missing the required parameter "body" when calling putCasemanagementCaseplanDataschema';
1325
+ }
1326
+
1327
+ return this.apiClient.callApi(
1328
+ '/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}',
1329
+ 'PUT',
1330
+ { 'caseplanId': caseplanId,'schemaKeyName': schemaKeyName },
1331
+ { },
1332
+ { },
1333
+ { },
1334
+ body,
1252
1335
  ['PureCloud OAuth'],
1253
1336
  ['application/json'],
1254
1337
  ['application/json'],
@@ -1259,11 +1342,10 @@ class CaseManagementApi {
1259
1342
  /**
1260
1343
  * Update the intake settings for a Caseplan.
1261
1344
  *
1262
- * @param {String} caseplanId Caseplan ID
1263
- * @param {Object} body Intake Settings
1345
+ * @param {String} caseplanId Caseplan identifier.
1346
+ * @param {Object} body Intake settings update.
1264
1347
  * @param {Object} opts Optional parameters
1265
1348
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
1266
- * putCasemanagementCaseplanIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1267
1349
  */
1268
1350
  putCasemanagementCaseplanIntakesettings(caseplanId, body, opts) {
1269
1351
  opts = opts || {};