purecloud-platform-client-v2 248.0.0 → 249.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 +2010 -100
  3. package/dist/web-amd/purecloud-platform-client-v2.js +2010 -100
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +602 -105
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +602 -105
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1061 -82
  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 -1
  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 +6 -6
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1100 -0
  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 +8 -4
  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 +31 -1
  37. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  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 -1
  49. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +477 -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 +26 -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 +37 -2
  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 -1
  68. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +57 -1
  70. package/src/purecloud-platform-client-v2/api/RoutingApi.js +5 -5
  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 +46 -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 -1
  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 +140 -1
  97. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -748,7 +748,7 @@ class Configuration {
748
748
 
749
749
  /**
750
750
  * @module purecloud-platform-client-v2/ApiClient
751
- * @version 248.0.0
751
+ * @version 249.0.0
752
752
  */
753
753
  class ApiClient {
754
754
  /**
@@ -2412,7 +2412,7 @@ class AIStudioApi {
2412
2412
  /**
2413
2413
  * AIStudio service.
2414
2414
  * @module purecloud-platform-client-v2/api/AIStudioApi
2415
- * @version 248.0.0
2415
+ * @version 249.0.0
2416
2416
  */
2417
2417
 
2418
2418
  /**
@@ -3031,7 +3031,7 @@ class AgentAssistantsApi {
3031
3031
  /**
3032
3032
  * AgentAssistants service.
3033
3033
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
3034
- * @version 248.0.0
3034
+ * @version 249.0.0
3035
3035
  */
3036
3036
 
3037
3037
  /**
@@ -3744,7 +3744,7 @@ class AgentCopilotApi {
3744
3744
  /**
3745
3745
  * AgentCopilot service.
3746
3746
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
3747
- * @version 248.0.0
3747
+ * @version 249.0.0
3748
3748
  */
3749
3749
 
3750
3750
  /**
@@ -3844,7 +3844,7 @@ class AgentUIApi {
3844
3844
  /**
3845
3845
  * AgentUI service.
3846
3846
  * @module purecloud-platform-client-v2/api/AgentUIApi
3847
- * @version 248.0.0
3847
+ * @version 249.0.0
3848
3848
  */
3849
3849
 
3850
3850
  /**
@@ -3975,7 +3975,7 @@ class AlertingApi {
3975
3975
  /**
3976
3976
  * Alerting service.
3977
3977
  * @module purecloud-platform-client-v2/api/AlertingApi
3978
- * @version 248.0.0
3978
+ * @version 249.0.0
3979
3979
  */
3980
3980
 
3981
3981
  /**
@@ -4376,7 +4376,7 @@ class AnalyticsApi {
4376
4376
  /**
4377
4377
  * Analytics service.
4378
4378
  * @module purecloud-platform-client-v2/api/AnalyticsApi
4379
- * @version 248.0.0
4379
+ * @version 249.0.0
4380
4380
  */
4381
4381
 
4382
4382
  /**
@@ -7813,7 +7813,7 @@ class ArchitectApi {
7813
7813
  /**
7814
7814
  * Architect service.
7815
7815
  * @module purecloud-platform-client-v2/api/ArchitectApi
7816
- * @version 248.0.0
7816
+ * @version 249.0.0
7817
7817
  */
7818
7818
 
7819
7819
  /**
@@ -12108,7 +12108,7 @@ class AssistantCopilotVariationsApi {
12108
12108
  /**
12109
12109
  * AssistantCopilotVariations service.
12110
12110
  * @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
12111
- * @version 248.0.0
12111
+ * @version 249.0.0
12112
12112
  */
12113
12113
 
12114
12114
  /**
@@ -12279,7 +12279,7 @@ class AuditApi {
12279
12279
  /**
12280
12280
  * Audit service.
12281
12281
  * @module purecloud-platform-client-v2/api/AuditApi
12282
- * @version 248.0.0
12282
+ * @version 249.0.0
12283
12283
  */
12284
12284
 
12285
12285
  /**
@@ -12480,7 +12480,7 @@ class AuthorizationApi {
12480
12480
  /**
12481
12481
  * Authorization service.
12482
12482
  * @module purecloud-platform-client-v2/api/AuthorizationApi
12483
- * @version 248.0.0
12483
+ * @version 249.0.0
12484
12484
  */
12485
12485
 
12486
12486
  /**
@@ -14194,7 +14194,7 @@ class BackgroundAssistantApi {
14194
14194
  /**
14195
14195
  * BackgroundAssistant service.
14196
14196
  * @module purecloud-platform-client-v2/api/BackgroundAssistantApi
14197
- * @version 248.0.0
14197
+ * @version 249.0.0
14198
14198
  */
14199
14199
 
14200
14200
  /**
@@ -14264,7 +14264,7 @@ class BillingApi {
14264
14264
  /**
14265
14265
  * Billing service.
14266
14266
  * @module purecloud-platform-client-v2/api/BillingApi
14267
- * @version 248.0.0
14267
+ * @version 249.0.0
14268
14268
  */
14269
14269
 
14270
14270
  /**
@@ -14520,7 +14520,7 @@ class BusinessRulesApi {
14520
14520
  /**
14521
14521
  * BusinessRules service.
14522
14522
  * @module purecloud-platform-client-v2/api/BusinessRulesApi
14523
- * @version 248.0.0
14523
+ * @version 249.0.0
14524
14524
  */
14525
14525
 
14526
14526
  /**
@@ -14596,7 +14596,7 @@ class BusinessRulesApi {
14596
14596
 
14597
14597
  /**
14598
14598
  * Delete a decision table row
14599
- *
14599
+ * Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
14600
14600
  * @param {String} tableId Table ID
14601
14601
  * @param {Number} tableVersion Table Version
14602
14602
  * @param {String} rowId Row ID
@@ -14958,7 +14958,7 @@ class BusinessRulesApi {
14958
14958
 
14959
14959
  /**
14960
14960
  * Update a decision table
14961
- *
14961
+ * Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
14962
14962
  * @param {String} tableId Table ID
14963
14963
  * @param {Object} body Decision Table
14964
14964
  */
@@ -15123,7 +15123,7 @@ class BusinessRulesApi {
15123
15123
 
15124
15124
  /**
15125
15125
  * Create a decision table row
15126
- *
15126
+ * Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
15127
15127
  * @param {String} tableId Table ID
15128
15128
  * @param {Number} tableVersion Table Version
15129
15129
  * @param {Object} body Create decision table row request
@@ -15253,7 +15253,7 @@ class BusinessRulesApi {
15253
15253
 
15254
15254
  /**
15255
15255
  * Create a decision table
15256
- *
15256
+ * Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
15257
15257
  * @param {Object} body Decision Table
15258
15258
  */
15259
15259
  postBusinessrulesDecisiontables(body) {
@@ -15333,7 +15333,7 @@ class BusinessRulesApi {
15333
15333
 
15334
15334
  /**
15335
15335
  * Full update a decision table row
15336
- *
15336
+ * Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
15337
15337
  * @param {String} tableId Table ID
15338
15338
  * @param {Number} tableVersion Table Version
15339
15339
  * @param {String} rowId Row ID
@@ -15407,7 +15407,7 @@ class CarrierServicesApi {
15407
15407
  /**
15408
15408
  * CarrierServices service.
15409
15409
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
15410
- * @version 248.0.0
15410
+ * @version 249.0.0
15411
15411
  */
15412
15412
 
15413
15413
  /**
@@ -15473,11 +15473,1106 @@ class CarrierServicesApi {
15473
15473
 
15474
15474
  }
15475
15475
 
15476
+ class CaseManagementApi {
15477
+ /**
15478
+ * CaseManagement service.
15479
+ * @module purecloud-platform-client-v2/api/CaseManagementApi
15480
+ * @version 249.0.0
15481
+ */
15482
+
15483
+ /**
15484
+ * Constructs a new CaseManagementApi.
15485
+ * @alias module:purecloud-platform-client-v2/api/CaseManagementApi
15486
+ * @class
15487
+ * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
15488
+ * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
15489
+ */
15490
+ constructor(apiClient) {
15491
+ this.apiClient = apiClient || ApiClient.instance;
15492
+ }
15493
+
15494
+
15495
+ /**
15496
+ * Delete a Case.
15497
+ *
15498
+ * @param {String} caseId Case ID
15499
+ * deleteCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15500
+ */
15501
+ deleteCasemanagementCase(caseId) {
15502
+ // verify the required parameter 'caseId' is set
15503
+ if (caseId === undefined || caseId === null || caseId === '') {
15504
+ throw 'Missing the required parameter "caseId" when calling deleteCasemanagementCase';
15505
+ }
15506
+
15507
+ return this.apiClient.callApi(
15508
+ '/api/v2/casemanagement/cases/{caseId}',
15509
+ 'DELETE',
15510
+ { 'caseId': caseId },
15511
+ { },
15512
+ { },
15513
+ { },
15514
+ null,
15515
+ ['PureCloud OAuth'],
15516
+ ['application/json'],
15517
+ ['application/json']
15518
+ );
15519
+ }
15520
+
15521
+ /**
15522
+ * Delete a Caseplan.
15523
+ *
15524
+ * @param {String} caseplanId Caseplan ID
15525
+ * deleteCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15526
+ */
15527
+ deleteCasemanagementCaseplan(caseplanId) {
15528
+ // verify the required parameter 'caseplanId' is set
15529
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
15530
+ throw 'Missing the required parameter "caseplanId" when calling deleteCasemanagementCaseplan';
15531
+ }
15532
+
15533
+ return this.apiClient.callApi(
15534
+ '/api/v2/casemanagement/caseplans/{caseplanId}',
15535
+ 'DELETE',
15536
+ { 'caseplanId': caseplanId },
15537
+ { },
15538
+ { },
15539
+ { },
15540
+ null,
15541
+ ['PureCloud OAuth'],
15542
+ ['application/json'],
15543
+ ['application/json']
15544
+ );
15545
+ }
15546
+
15547
+ /**
15548
+ * Get a Case.
15549
+ *
15550
+ * @param {String} caseId Case ID
15551
+ * @param {Object} opts Optional parameters
15552
+ * @param {Object} opts.expands Which fields to expand.
15553
+ * getCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15554
+ */
15555
+ getCasemanagementCase(caseId, opts) {
15556
+ opts = opts || {};
15557
+
15558
+ // verify the required parameter 'caseId' is set
15559
+ if (caseId === undefined || caseId === null || caseId === '') {
15560
+ throw 'Missing the required parameter "caseId" when calling getCasemanagementCase';
15561
+ }
15562
+
15563
+ return this.apiClient.callApi(
15564
+ '/api/v2/casemanagement/cases/{caseId}',
15565
+ 'GET',
15566
+ { 'caseId': caseId },
15567
+ { 'expands': opts['expands'] },
15568
+ { },
15569
+ { },
15570
+ null,
15571
+ ['PureCloud OAuth'],
15572
+ ['application/json'],
15573
+ ['application/json']
15574
+ );
15575
+ }
15576
+
15577
+ /**
15578
+ * Get a Case Association.
15579
+ *
15580
+ * @param {String} caseId Case ID
15581
+ * @param {String} associationId Case Association ID
15582
+ * getCasemanagementCaseAssociation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15583
+ */
15584
+ getCasemanagementCaseAssociation(caseId, associationId) {
15585
+ // verify the required parameter 'caseId' is set
15586
+ if (caseId === undefined || caseId === null || caseId === '') {
15587
+ throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseAssociation';
15588
+ }
15589
+ // verify the required parameter 'associationId' is set
15590
+ if (associationId === undefined || associationId === null || associationId === '') {
15591
+ throw 'Missing the required parameter "associationId" when calling getCasemanagementCaseAssociation';
15592
+ }
15593
+
15594
+ return this.apiClient.callApi(
15595
+ '/api/v2/casemanagement/cases/{caseId}/associations/{associationId}',
15596
+ 'GET',
15597
+ { 'caseId': caseId,'associationId': associationId },
15598
+ { },
15599
+ { },
15600
+ { },
15601
+ null,
15602
+ ['PureCloud OAuth'],
15603
+ ['application/json'],
15604
+ ['application/json']
15605
+ );
15606
+ }
15607
+
15608
+ /**
15609
+ * Get a list of case associations for a provided case.
15610
+ *
15611
+ * @param {String} caseId Case ID.
15612
+ * @param {Object} opts Optional parameters
15613
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
15614
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
15615
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
15616
+ * getCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15617
+ */
15618
+ getCasemanagementCaseAssociations(caseId, opts) {
15619
+ opts = opts || {};
15620
+
15621
+ // verify the required parameter 'caseId' is set
15622
+ if (caseId === undefined || caseId === null || caseId === '') {
15623
+ throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseAssociations';
15624
+ }
15625
+
15626
+ return this.apiClient.callApi(
15627
+ '/api/v2/casemanagement/cases/{caseId}/associations',
15628
+ 'GET',
15629
+ { 'caseId': caseId },
15630
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
15631
+ { },
15632
+ { },
15633
+ null,
15634
+ ['PureCloud OAuth'],
15635
+ ['application/json'],
15636
+ ['application/json']
15637
+ );
15638
+ }
15639
+
15640
+ /**
15641
+ * Get a Stage.
15642
+ *
15643
+ * @param {String} caseId Case ID
15644
+ * @param {String} stageId Stage ID
15645
+ * getCasemanagementCaseStage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15646
+ */
15647
+ getCasemanagementCaseStage(caseId, stageId) {
15648
+ // verify the required parameter 'caseId' is set
15649
+ if (caseId === undefined || caseId === null || caseId === '') {
15650
+ throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStage';
15651
+ }
15652
+ // verify the required parameter 'stageId' is set
15653
+ if (stageId === undefined || stageId === null || stageId === '') {
15654
+ throw 'Missing the required parameter "stageId" when calling getCasemanagementCaseStage';
15655
+ }
15656
+
15657
+ return this.apiClient.callApi(
15658
+ '/api/v2/casemanagement/cases/{caseId}/stages/{stageId}',
15659
+ 'GET',
15660
+ { 'caseId': caseId,'stageId': stageId },
15661
+ { },
15662
+ { },
15663
+ { },
15664
+ null,
15665
+ ['PureCloud OAuth'],
15666
+ ['application/json'],
15667
+ ['application/json']
15668
+ );
15669
+ }
15670
+
15671
+ /**
15672
+ * Get a Step.
15673
+ *
15674
+ * @param {String} caseId Case ID
15675
+ * @param {String} stageId Stage ID
15676
+ * @param {String} stepId Step ID
15677
+ * getCasemanagementCaseStageStep is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15678
+ */
15679
+ getCasemanagementCaseStageStep(caseId, stageId, stepId) {
15680
+ // verify the required parameter 'caseId' is set
15681
+ if (caseId === undefined || caseId === null || caseId === '') {
15682
+ throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStageStep';
15683
+ }
15684
+ // verify the required parameter 'stageId' is set
15685
+ if (stageId === undefined || stageId === null || stageId === '') {
15686
+ throw 'Missing the required parameter "stageId" when calling getCasemanagementCaseStageStep';
15687
+ }
15688
+ // verify the required parameter 'stepId' is set
15689
+ if (stepId === undefined || stepId === null || stepId === '') {
15690
+ throw 'Missing the required parameter "stepId" when calling getCasemanagementCaseStageStep';
15691
+ }
15692
+
15693
+ return this.apiClient.callApi(
15694
+ '/api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps/{stepId}',
15695
+ 'GET',
15696
+ { 'caseId': caseId,'stageId': stageId,'stepId': stepId },
15697
+ { },
15698
+ { },
15699
+ { },
15700
+ null,
15701
+ ['PureCloud OAuth'],
15702
+ ['application/json'],
15703
+ ['application/json']
15704
+ );
15705
+ }
15706
+
15707
+ /**
15708
+ * Get a list of Steps.
15709
+ *
15710
+ * @param {String} caseId Case ID
15711
+ * @param {String} stageId Stage ID
15712
+ * @param {Object} opts Optional parameters
15713
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
15714
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
15715
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
15716
+ * getCasemanagementCaseStageSteps is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15717
+ */
15718
+ getCasemanagementCaseStageSteps(caseId, stageId, opts) {
15719
+ opts = opts || {};
15720
+
15721
+ // verify the required parameter 'caseId' is set
15722
+ if (caseId === undefined || caseId === null || caseId === '') {
15723
+ throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStageSteps';
15724
+ }
15725
+ // verify the required parameter 'stageId' is set
15726
+ if (stageId === undefined || stageId === null || stageId === '') {
15727
+ throw 'Missing the required parameter "stageId" when calling getCasemanagementCaseStageSteps';
15728
+ }
15729
+
15730
+ return this.apiClient.callApi(
15731
+ '/api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps',
15732
+ 'GET',
15733
+ { 'caseId': caseId,'stageId': stageId },
15734
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
15735
+ { },
15736
+ { },
15737
+ null,
15738
+ ['PureCloud OAuth'],
15739
+ ['application/json'],
15740
+ ['application/json']
15741
+ );
15742
+ }
15743
+
15744
+ /**
15745
+ * Get a list of Stages.
15746
+ *
15747
+ * @param {String} caseId Case ID
15748
+ * @param {Object} opts Optional parameters
15749
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
15750
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
15751
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
15752
+ * getCasemanagementCaseStages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15753
+ */
15754
+ getCasemanagementCaseStages(caseId, opts) {
15755
+ opts = opts || {};
15756
+
15757
+ // verify the required parameter 'caseId' is set
15758
+ if (caseId === undefined || caseId === null || caseId === '') {
15759
+ throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseStages';
15760
+ }
15761
+
15762
+ return this.apiClient.callApi(
15763
+ '/api/v2/casemanagement/cases/{caseId}/stages',
15764
+ 'GET',
15765
+ { 'caseId': caseId },
15766
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
15767
+ { },
15768
+ { },
15769
+ null,
15770
+ ['PureCloud OAuth'],
15771
+ ['application/json'],
15772
+ ['application/json']
15773
+ );
15774
+ }
15775
+
15776
+ /**
15777
+ * Get a Terminate Job for a Case.
15778
+ *
15779
+ * @param {String} caseId Case ID
15780
+ * @param {String} jobId Job ID
15781
+ * getCasemanagementCaseTerminateJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15782
+ */
15783
+ getCasemanagementCaseTerminateJob(caseId, jobId) {
15784
+ // verify the required parameter 'caseId' is set
15785
+ if (caseId === undefined || caseId === null || caseId === '') {
15786
+ throw 'Missing the required parameter "caseId" when calling getCasemanagementCaseTerminateJob';
15787
+ }
15788
+ // verify the required parameter 'jobId' is set
15789
+ if (jobId === undefined || jobId === null || jobId === '') {
15790
+ throw 'Missing the required parameter "jobId" when calling getCasemanagementCaseTerminateJob';
15791
+ }
15792
+
15793
+ return this.apiClient.callApi(
15794
+ '/api/v2/casemanagement/cases/{caseId}/terminate/jobs/{jobId}',
15795
+ 'GET',
15796
+ { 'caseId': caseId,'jobId': jobId },
15797
+ { },
15798
+ { },
15799
+ { },
15800
+ null,
15801
+ ['PureCloud OAuth'],
15802
+ ['application/json'],
15803
+ ['application/json']
15804
+ );
15805
+ }
15806
+
15807
+ /**
15808
+ * Get a Caseplan.
15809
+ *
15810
+ * @param {String} caseplanId Caseplan ID
15811
+ * getCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15812
+ */
15813
+ getCasemanagementCaseplan(caseplanId) {
15814
+ // verify the required parameter 'caseplanId' is set
15815
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
15816
+ throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplan';
15817
+ }
15818
+
15819
+ return this.apiClient.callApi(
15820
+ '/api/v2/casemanagement/caseplans/{caseplanId}',
15821
+ 'GET',
15822
+ { 'caseplanId': caseplanId },
15823
+ { },
15824
+ { },
15825
+ { },
15826
+ null,
15827
+ ['PureCloud OAuth'],
15828
+ ['application/json'],
15829
+ ['application/json']
15830
+ );
15831
+ }
15832
+
15833
+ /**
15834
+ * Get a Caseplan version.
15835
+ *
15836
+ * @param {String} caseplanId Caseplan ID
15837
+ * @param {String} versionId Version of the caseplan
15838
+ * getCasemanagementCaseplanVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15839
+ */
15840
+ getCasemanagementCaseplanVersion(caseplanId, versionId) {
15841
+ // verify the required parameter 'caseplanId' is set
15842
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
15843
+ throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersion';
15844
+ }
15845
+ // verify the required parameter 'versionId' is set
15846
+ if (versionId === undefined || versionId === null || versionId === '') {
15847
+ throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersion';
15848
+ }
15849
+
15850
+ return this.apiClient.callApi(
15851
+ '/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}',
15852
+ 'GET',
15853
+ { 'caseplanId': caseplanId,'versionId': versionId },
15854
+ { },
15855
+ { },
15856
+ { },
15857
+ null,
15858
+ ['PureCloud OAuth'],
15859
+ ['application/json'],
15860
+ ['application/json']
15861
+ );
15862
+ }
15863
+
15864
+ /**
15865
+ * Get the dataSchemas for a caseplan version.
15866
+ *
15867
+ * @param {String} caseplanId Caseplan ID
15868
+ * @param {String} versionId Version of the caseplan
15869
+ * getCasemanagementCaseplanVersionDataschemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15870
+ */
15871
+ getCasemanagementCaseplanVersionDataschemas(caseplanId, versionId) {
15872
+ // verify the required parameter 'caseplanId' is set
15873
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
15874
+ throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionDataschemas';
15875
+ }
15876
+ // verify the required parameter 'versionId' is set
15877
+ if (versionId === undefined || versionId === null || versionId === '') {
15878
+ throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionDataschemas';
15879
+ }
15880
+
15881
+ return this.apiClient.callApi(
15882
+ '/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/dataschemas',
15883
+ 'GET',
15884
+ { 'caseplanId': caseplanId,'versionId': versionId },
15885
+ { },
15886
+ { },
15887
+ { },
15888
+ null,
15889
+ ['PureCloud OAuth'],
15890
+ ['application/json'],
15891
+ ['application/json']
15892
+ );
15893
+ }
15894
+
15895
+ /**
15896
+ * Get the intake settings for a Caseplan version.
15897
+ *
15898
+ * @param {String} caseplanId Caseplan ID
15899
+ * @param {String} versionId Version of the caseplan
15900
+ * getCasemanagementCaseplanVersionIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15901
+ */
15902
+ getCasemanagementCaseplanVersionIntakesettings(caseplanId, versionId) {
15903
+ // verify the required parameter 'caseplanId' is set
15904
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
15905
+ throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionIntakesettings';
15906
+ }
15907
+ // verify the required parameter 'versionId' is set
15908
+ if (versionId === undefined || versionId === null || versionId === '') {
15909
+ throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionIntakesettings';
15910
+ }
15911
+
15912
+ return this.apiClient.callApi(
15913
+ '/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/intakesettings',
15914
+ 'GET',
15915
+ { 'caseplanId': caseplanId,'versionId': versionId },
15916
+ { },
15917
+ { },
15918
+ { },
15919
+ null,
15920
+ ['PureCloud OAuth'],
15921
+ ['application/json'],
15922
+ ['application/json']
15923
+ );
15924
+ }
15925
+
15926
+ /**
15927
+ * Get a Stageplan.
15928
+ *
15929
+ * @param {String} caseplanId Caseplan ID
15930
+ * @param {String} versionId Version ID
15931
+ * @param {String} stageplanId Stageplan ID
15932
+ * @param {Object} opts Optional parameters
15933
+ * @param {Array.<String>} opts.expands Which fields to expand.
15934
+ * getCasemanagementCaseplanVersionStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15935
+ */
15936
+ getCasemanagementCaseplanVersionStageplan(caseplanId, versionId, stageplanId, opts) {
15937
+ opts = opts || {};
15938
+
15939
+ // verify the required parameter 'caseplanId' is set
15940
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
15941
+ throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplan';
15942
+ }
15943
+ // verify the required parameter 'versionId' is set
15944
+ if (versionId === undefined || versionId === null || versionId === '') {
15945
+ throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplan';
15946
+ }
15947
+ // verify the required parameter 'stageplanId' is set
15948
+ if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
15949
+ throw 'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplan';
15950
+ }
15951
+
15952
+ return this.apiClient.callApi(
15953
+ '/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}',
15954
+ 'GET',
15955
+ { 'caseplanId': caseplanId,'versionId': versionId,'stageplanId': stageplanId },
15956
+ { 'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
15957
+ { },
15958
+ { },
15959
+ null,
15960
+ ['PureCloud OAuth'],
15961
+ ['application/json'],
15962
+ ['application/json']
15963
+ );
15964
+ }
15965
+
15966
+ /**
15967
+ * Get a Stepplan.
15968
+ *
15969
+ * @param {String} caseplanId Caseplan ID
15970
+ * @param {String} versionId Version ID
15971
+ * @param {String} stageplanId Stageplan ID
15972
+ * @param {String} stepplanId Stepplan ID
15973
+ * @param {Object} opts Optional parameters
15974
+ * @param {Array.<String>} opts.expands Which fields to expand.
15975
+ * getCasemanagementCaseplanVersionStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15976
+ */
15977
+ getCasemanagementCaseplanVersionStageplanStepplan(caseplanId, versionId, stageplanId, stepplanId, opts) {
15978
+ opts = opts || {};
15979
+
15980
+ // verify the required parameter 'caseplanId' is set
15981
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
15982
+ throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
15983
+ }
15984
+ // verify the required parameter 'versionId' is set
15985
+ if (versionId === undefined || versionId === null || versionId === '') {
15986
+ throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
15987
+ }
15988
+ // verify the required parameter 'stageplanId' is set
15989
+ if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
15990
+ throw 'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
15991
+ }
15992
+ // verify the required parameter 'stepplanId' is set
15993
+ if (stepplanId === undefined || stepplanId === null || stepplanId === '') {
15994
+ throw 'Missing the required parameter "stepplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';
15995
+ }
15996
+
15997
+ return this.apiClient.callApi(
15998
+ '/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans/{stepplanId}',
15999
+ 'GET',
16000
+ { 'caseplanId': caseplanId,'versionId': versionId,'stageplanId': stageplanId,'stepplanId': stepplanId },
16001
+ { 'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
16002
+ { },
16003
+ { },
16004
+ null,
16005
+ ['PureCloud OAuth'],
16006
+ ['application/json'],
16007
+ ['application/json']
16008
+ );
16009
+ }
16010
+
16011
+ /**
16012
+ * Get a list of Stepplans.
16013
+ *
16014
+ * @param {String} caseplanId Caseplan ID
16015
+ * @param {String} versionId Version ID
16016
+ * @param {String} stageplanId Stageplan ID
16017
+ * @param {Object} opts Optional parameters
16018
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
16019
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
16020
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
16021
+ * @param {Array.<String>} opts.expands Which fields to expand.
16022
+ * getCasemanagementCaseplanVersionStageplanStepplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16023
+ */
16024
+ getCasemanagementCaseplanVersionStageplanStepplans(caseplanId, versionId, stageplanId, opts) {
16025
+ opts = opts || {};
16026
+
16027
+ // verify the required parameter 'caseplanId' is set
16028
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
16029
+ throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplanStepplans';
16030
+ }
16031
+ // verify the required parameter 'versionId' is set
16032
+ if (versionId === undefined || versionId === null || versionId === '') {
16033
+ throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplanStepplans';
16034
+ }
16035
+ // verify the required parameter 'stageplanId' is set
16036
+ if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
16037
+ throw 'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplanStepplans';
16038
+ }
16039
+
16040
+ return this.apiClient.callApi(
16041
+ '/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans',
16042
+ 'GET',
16043
+ { 'caseplanId': caseplanId,'versionId': versionId,'stageplanId': stageplanId },
16044
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
16045
+ { },
16046
+ { },
16047
+ null,
16048
+ ['PureCloud OAuth'],
16049
+ ['application/json'],
16050
+ ['application/json']
16051
+ );
16052
+ }
16053
+
16054
+ /**
16055
+ * Get a list of Stageplans.
16056
+ *
16057
+ * @param {String} caseplanId Caseplan ID
16058
+ * @param {String} versionId Version ID
16059
+ * @param {Object} opts Optional parameters
16060
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
16061
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
16062
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
16063
+ * @param {Array.<String>} opts.expands Which fields to expand.
16064
+ * getCasemanagementCaseplanVersionStageplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16065
+ */
16066
+ getCasemanagementCaseplanVersionStageplans(caseplanId, versionId, opts) {
16067
+ opts = opts || {};
16068
+
16069
+ // verify the required parameter 'caseplanId' is set
16070
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
16071
+ throw 'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplans';
16072
+ }
16073
+ // verify the required parameter 'versionId' is set
16074
+ if (versionId === undefined || versionId === null || versionId === '') {
16075
+ throw 'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplans';
16076
+ }
16077
+
16078
+ return this.apiClient.callApi(
16079
+ '/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans',
16080
+ 'GET',
16081
+ { 'caseplanId': caseplanId,'versionId': versionId },
16082
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
16083
+ { },
16084
+ { },
16085
+ null,
16086
+ ['PureCloud OAuth'],
16087
+ ['application/json'],
16088
+ ['application/json']
16089
+ );
16090
+ }
16091
+
16092
+ /**
16093
+ * Get a list of Caseplans.
16094
+ *
16095
+ * @param {Object} opts Optional parameters
16096
+ * @param {String} opts.after The cursor that points to the end of the set of caseplans that has been returned.
16097
+ * @param {Number} opts.pageSize Number of caseplans to return. Maximum of 200.
16098
+ * @param {String} opts.customerIntentId Filter by Customer Intent.
16099
+ * @param {String} opts.divisionIds Filter by Divisions.
16100
+ * getCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16101
+ */
16102
+ getCasemanagementCaseplans(opts) {
16103
+ opts = opts || {};
16104
+
16105
+
16106
+ return this.apiClient.callApi(
16107
+ '/api/v2/casemanagement/caseplans',
16108
+ 'GET',
16109
+ { },
16110
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'customerIntentId': opts['customerIntentId'],'divisionIds': opts['divisionIds'] },
16111
+ { },
16112
+ { },
16113
+ null,
16114
+ ['PureCloud OAuth'],
16115
+ ['application/json'],
16116
+ ['application/json']
16117
+ );
16118
+ }
16119
+
16120
+ /**
16121
+ * Get a list of cases for provided external contact id.
16122
+ *
16123
+ * @param {String} externalContactId External Contact ID
16124
+ * @param {Object} opts Optional parameters
16125
+ * @param {String} opts.after The cursor that points to the end of the set of cases that has been returned.
16126
+ * @param {Number} opts.pageSize Number of cases to return. Maximum of 200.
16127
+ * @param {String} opts.divisionIds Filter by Divisions
16128
+ * @param {Array.<String>} opts.expands Which fields to expand.
16129
+ * getCasemanagementCasesExternalcontact is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16130
+ */
16131
+ getCasemanagementCasesExternalcontact(externalContactId, opts) {
16132
+ opts = opts || {};
16133
+
16134
+ // verify the required parameter 'externalContactId' is set
16135
+ if (externalContactId === undefined || externalContactId === null || externalContactId === '') {
16136
+ throw 'Missing the required parameter "externalContactId" when calling getCasemanagementCasesExternalcontact';
16137
+ }
16138
+
16139
+ return this.apiClient.callApi(
16140
+ '/api/v2/casemanagement/cases/externalcontacts/{externalContactId}',
16141
+ 'GET',
16142
+ { 'externalContactId': externalContactId },
16143
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': opts['divisionIds'],'expands': this.apiClient.buildCollectionParam(opts['expands'], 'multi') },
16144
+ { },
16145
+ { },
16146
+ null,
16147
+ ['PureCloud OAuth'],
16148
+ ['application/json'],
16149
+ ['application/json']
16150
+ );
16151
+ }
16152
+
16153
+ /**
16154
+ * Get a Case by reference.
16155
+ *
16156
+ * @param {String} referenceId Reference
16157
+ * @param {Object} opts Optional parameters
16158
+ * @param {Object} opts.expands Which fields to expand.
16159
+ * getCasemanagementCasesReference is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16160
+ */
16161
+ getCasemanagementCasesReference(referenceId, opts) {
16162
+ opts = opts || {};
16163
+
16164
+ // verify the required parameter 'referenceId' is set
16165
+ if (referenceId === undefined || referenceId === null || referenceId === '') {
16166
+ throw 'Missing the required parameter "referenceId" when calling getCasemanagementCasesReference';
16167
+ }
16168
+
16169
+ return this.apiClient.callApi(
16170
+ '/api/v2/casemanagement/cases/references/{referenceId}',
16171
+ 'GET',
16172
+ { 'referenceId': referenceId },
16173
+ { 'expands': opts['expands'] },
16174
+ { },
16175
+ { },
16176
+ null,
16177
+ ['PureCloud OAuth'],
16178
+ ['application/json'],
16179
+ ['application/json']
16180
+ );
16181
+ }
16182
+
16183
+ /**
16184
+ * Update date due of a Case.
16185
+ *
16186
+ * @param {String} caseId Case ID
16187
+ * @param {Object} body Date due
16188
+ * patchCasemanagementCaseDatedue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16189
+ */
16190
+ patchCasemanagementCaseDatedue(caseId, body) {
16191
+ // verify the required parameter 'caseId' is set
16192
+ if (caseId === undefined || caseId === null || caseId === '') {
16193
+ throw 'Missing the required parameter "caseId" when calling patchCasemanagementCaseDatedue';
16194
+ }
16195
+ // verify the required parameter 'body' is set
16196
+ if (body === undefined || body === null) {
16197
+ throw 'Missing the required parameter "body" when calling patchCasemanagementCaseDatedue';
16198
+ }
16199
+
16200
+ return this.apiClient.callApi(
16201
+ '/api/v2/casemanagement/cases/{caseId}/datedue',
16202
+ 'PATCH',
16203
+ { 'caseId': caseId },
16204
+ { },
16205
+ { },
16206
+ { },
16207
+ body,
16208
+ ['PureCloud OAuth'],
16209
+ ['application/json'],
16210
+ ['application/json']
16211
+ );
16212
+ }
16213
+
16214
+ /**
16215
+ * Update priority of a Case.
16216
+ *
16217
+ * @param {String} caseId Case ID
16218
+ * @param {Object} body Priority
16219
+ * patchCasemanagementCasePriority is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16220
+ */
16221
+ patchCasemanagementCasePriority(caseId, body) {
16222
+ // verify the required parameter 'caseId' is set
16223
+ if (caseId === undefined || caseId === null || caseId === '') {
16224
+ throw 'Missing the required parameter "caseId" when calling patchCasemanagementCasePriority';
16225
+ }
16226
+ // verify the required parameter 'body' is set
16227
+ if (body === undefined || body === null) {
16228
+ throw 'Missing the required parameter "body" when calling patchCasemanagementCasePriority';
16229
+ }
16230
+
16231
+ return this.apiClient.callApi(
16232
+ '/api/v2/casemanagement/cases/{caseId}/priority',
16233
+ 'PATCH',
16234
+ { 'caseId': caseId },
16235
+ { },
16236
+ { },
16237
+ { },
16238
+ body,
16239
+ ['PureCloud OAuth'],
16240
+ ['application/json'],
16241
+ ['application/json']
16242
+ );
16243
+ }
16244
+
16245
+ /**
16246
+ * Update summary of a Case.
16247
+ *
16248
+ * @param {String} caseId Case ID
16249
+ * @param {Object} body Summary
16250
+ * patchCasemanagementCaseSummary is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16251
+ */
16252
+ patchCasemanagementCaseSummary(caseId, body) {
16253
+ // verify the required parameter 'caseId' is set
16254
+ if (caseId === undefined || caseId === null || caseId === '') {
16255
+ throw 'Missing the required parameter "caseId" when calling patchCasemanagementCaseSummary';
16256
+ }
16257
+ // verify the required parameter 'body' is set
16258
+ if (body === undefined || body === null) {
16259
+ throw 'Missing the required parameter "body" when calling patchCasemanagementCaseSummary';
16260
+ }
16261
+
16262
+ return this.apiClient.callApi(
16263
+ '/api/v2/casemanagement/cases/{caseId}/summary',
16264
+ 'PATCH',
16265
+ { 'caseId': caseId },
16266
+ { },
16267
+ { },
16268
+ { },
16269
+ body,
16270
+ ['PureCloud OAuth'],
16271
+ ['application/json'],
16272
+ ['application/json']
16273
+ );
16274
+ }
16275
+
16276
+ /**
16277
+ * Update the attributes of a Caseplan.
16278
+ *
16279
+ * @param {String} caseplanId Caseplan ID
16280
+ * @param {Object} body Caseplan
16281
+ * patchCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16282
+ */
16283
+ patchCasemanagementCaseplan(caseplanId, body) {
16284
+ // verify the required parameter 'caseplanId' is set
16285
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
16286
+ throw 'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplan';
16287
+ }
16288
+ // verify the required parameter 'body' is set
16289
+ if (body === undefined || body === null) {
16290
+ throw 'Missing the required parameter "body" when calling patchCasemanagementCaseplan';
16291
+ }
16292
+
16293
+ return this.apiClient.callApi(
16294
+ '/api/v2/casemanagement/caseplans/{caseplanId}',
16295
+ 'PATCH',
16296
+ { 'caseplanId': caseplanId },
16297
+ { },
16298
+ { },
16299
+ { },
16300
+ body,
16301
+ ['PureCloud OAuth'],
16302
+ ['application/json'],
16303
+ ['application/json']
16304
+ );
16305
+ }
16306
+
16307
+ /**
16308
+ * Update the attributes of a Stageplan.
16309
+ *
16310
+ * @param {String} caseplanId Caseplan ID
16311
+ * @param {String} stageplanId Stageplan ID
16312
+ * @param {Object} body Stageplan
16313
+ * patchCasemanagementCaseplanStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16314
+ */
16315
+ patchCasemanagementCaseplanStageplan(caseplanId, stageplanId, body) {
16316
+ // verify the required parameter 'caseplanId' is set
16317
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
16318
+ throw 'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplanStageplan';
16319
+ }
16320
+ // verify the required parameter 'stageplanId' is set
16321
+ if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
16322
+ throw 'Missing the required parameter "stageplanId" when calling patchCasemanagementCaseplanStageplan';
16323
+ }
16324
+ // verify the required parameter 'body' is set
16325
+ if (body === undefined || body === null) {
16326
+ throw 'Missing the required parameter "body" when calling patchCasemanagementCaseplanStageplan';
16327
+ }
16328
+
16329
+ return this.apiClient.callApi(
16330
+ '/api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}',
16331
+ 'PATCH',
16332
+ { 'caseplanId': caseplanId,'stageplanId': stageplanId },
16333
+ { },
16334
+ { },
16335
+ { },
16336
+ body,
16337
+ ['PureCloud OAuth'],
16338
+ ['application/json'],
16339
+ ['application/json']
16340
+ );
16341
+ }
16342
+
16343
+ /**
16344
+ * Update the attributes of a Stepplan.
16345
+ *
16346
+ * @param {String} caseplanId Caseplan ID
16347
+ * @param {String} stageplanId Stageplan ID
16348
+ * @param {String} stepplanId Stepplan ID
16349
+ * @param {Object} body Stepplan
16350
+ * patchCasemanagementCaseplanStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16351
+ */
16352
+ patchCasemanagementCaseplanStageplanStepplan(caseplanId, stageplanId, stepplanId, body) {
16353
+ // verify the required parameter 'caseplanId' is set
16354
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
16355
+ throw 'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplanStageplanStepplan';
16356
+ }
16357
+ // verify the required parameter 'stageplanId' is set
16358
+ if (stageplanId === undefined || stageplanId === null || stageplanId === '') {
16359
+ throw 'Missing the required parameter "stageplanId" when calling patchCasemanagementCaseplanStageplanStepplan';
16360
+ }
16361
+ // verify the required parameter 'stepplanId' is set
16362
+ if (stepplanId === undefined || stepplanId === null || stepplanId === '') {
16363
+ throw 'Missing the required parameter "stepplanId" when calling patchCasemanagementCaseplanStageplanStepplan';
16364
+ }
16365
+ // verify the required parameter 'body' is set
16366
+ if (body === undefined || body === null) {
16367
+ throw 'Missing the required parameter "body" when calling patchCasemanagementCaseplanStageplanStepplan';
16368
+ }
16369
+
16370
+ return this.apiClient.callApi(
16371
+ '/api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}/stepplans/{stepplanId}',
16372
+ 'PATCH',
16373
+ { 'caseplanId': caseplanId,'stageplanId': stageplanId,'stepplanId': stepplanId },
16374
+ { },
16375
+ { },
16376
+ { },
16377
+ body,
16378
+ ['PureCloud OAuth'],
16379
+ ['application/json'],
16380
+ ['application/json']
16381
+ );
16382
+ }
16383
+
16384
+ /**
16385
+ * Create a case association.
16386
+ *
16387
+ * @param {String} caseId Case ID.
16388
+ * @param {Object} opts Optional parameters
16389
+ * @param {Object} opts.body Case Association
16390
+ * postCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16391
+ */
16392
+ postCasemanagementCaseAssociations(caseId, opts) {
16393
+ opts = opts || {};
16394
+
16395
+ // verify the required parameter 'caseId' is set
16396
+ if (caseId === undefined || caseId === null || caseId === '') {
16397
+ throw 'Missing the required parameter "caseId" when calling postCasemanagementCaseAssociations';
16398
+ }
16399
+
16400
+ return this.apiClient.callApi(
16401
+ '/api/v2/casemanagement/cases/{caseId}/associations',
16402
+ 'POST',
16403
+ { 'caseId': caseId },
16404
+ { },
16405
+ { },
16406
+ { },
16407
+ opts['body'],
16408
+ ['PureCloud OAuth'],
16409
+ ['application/json'],
16410
+ ['application/json']
16411
+ );
16412
+ }
16413
+
16414
+ /**
16415
+ * Create a Terminate Job for a Case.
16416
+ *
16417
+ * @param {String} caseId Case ID
16418
+ * postCasemanagementCaseTerminateJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16419
+ */
16420
+ postCasemanagementCaseTerminateJobs(caseId) {
16421
+ // verify the required parameter 'caseId' is set
16422
+ if (caseId === undefined || caseId === null || caseId === '') {
16423
+ throw 'Missing the required parameter "caseId" when calling postCasemanagementCaseTerminateJobs';
16424
+ }
16425
+
16426
+ return this.apiClient.callApi(
16427
+ '/api/v2/casemanagement/cases/{caseId}/terminate/jobs',
16428
+ 'POST',
16429
+ { 'caseId': caseId },
16430
+ { },
16431
+ { },
16432
+ { },
16433
+ null,
16434
+ ['PureCloud OAuth'],
16435
+ ['application/json'],
16436
+ ['application/json']
16437
+ );
16438
+ }
16439
+
16440
+ /**
16441
+ * Publish Caseplan.
16442
+ *
16443
+ * @param {String} caseplanId Caseplan ID
16444
+ * postCasemanagementCaseplanPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16445
+ */
16446
+ postCasemanagementCaseplanPublish(caseplanId) {
16447
+ // verify the required parameter 'caseplanId' is set
16448
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
16449
+ throw 'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanPublish';
16450
+ }
16451
+
16452
+ return this.apiClient.callApi(
16453
+ '/api/v2/casemanagement/caseplans/{caseplanId}/publish',
16454
+ 'POST',
16455
+ { 'caseplanId': caseplanId },
16456
+ { },
16457
+ { },
16458
+ { },
16459
+ null,
16460
+ ['PureCloud OAuth'],
16461
+ ['application/json'],
16462
+ ['application/json']
16463
+ );
16464
+ }
16465
+
16466
+ /**
16467
+ * Create Caseplan version.
16468
+ *
16469
+ * @param {String} caseplanId Caseplan ID
16470
+ * postCasemanagementCaseplanVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16471
+ */
16472
+ postCasemanagementCaseplanVersions(caseplanId) {
16473
+ // verify the required parameter 'caseplanId' is set
16474
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
16475
+ throw 'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanVersions';
16476
+ }
16477
+
16478
+ return this.apiClient.callApi(
16479
+ '/api/v2/casemanagement/caseplans/{caseplanId}/versions',
16480
+ 'POST',
16481
+ { 'caseplanId': caseplanId },
16482
+ { },
16483
+ { },
16484
+ { },
16485
+ null,
16486
+ ['PureCloud OAuth'],
16487
+ ['application/json'],
16488
+ ['application/json']
16489
+ );
16490
+ }
16491
+
16492
+ /**
16493
+ * Create a Caseplan.
16494
+ *
16495
+ * @param {Object} body Caseplan
16496
+ * postCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16497
+ */
16498
+ postCasemanagementCaseplans(body) {
16499
+ // verify the required parameter 'body' is set
16500
+ if (body === undefined || body === null) {
16501
+ throw 'Missing the required parameter "body" when calling postCasemanagementCaseplans';
16502
+ }
16503
+
16504
+ return this.apiClient.callApi(
16505
+ '/api/v2/casemanagement/caseplans',
16506
+ 'POST',
16507
+ { },
16508
+ { },
16509
+ { },
16510
+ { },
16511
+ body,
16512
+ ['PureCloud OAuth'],
16513
+ ['application/json'],
16514
+ ['application/json']
16515
+ );
16516
+ }
16517
+
16518
+ /**
16519
+ * Create a Case.
16520
+ *
16521
+ * @param {Object} body Case
16522
+ * postCasemanagementCases is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16523
+ */
16524
+ postCasemanagementCases(body) {
16525
+ // verify the required parameter 'body' is set
16526
+ if (body === undefined || body === null) {
16527
+ throw 'Missing the required parameter "body" when calling postCasemanagementCases';
16528
+ }
16529
+
16530
+ return this.apiClient.callApi(
16531
+ '/api/v2/casemanagement/cases',
16532
+ 'POST',
16533
+ { },
16534
+ { },
16535
+ { },
16536
+ { },
16537
+ body,
16538
+ ['PureCloud OAuth'],
16539
+ ['application/json'],
16540
+ ['application/json']
16541
+ );
16542
+ }
16543
+
16544
+ /**
16545
+ * Query for case associations
16546
+ *
16547
+ * @param {Object} opts Optional parameters
16548
+ * @param {Object} opts.body Case Association
16549
+ * postCasemanagementCasesAssociationsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16550
+ */
16551
+ postCasemanagementCasesAssociationsQuery(opts) {
16552
+ opts = opts || {};
16553
+
16554
+
16555
+ return this.apiClient.callApi(
16556
+ '/api/v2/casemanagement/cases/associations/query',
16557
+ 'POST',
16558
+ { },
16559
+ { },
16560
+ { },
16561
+ { },
16562
+ opts['body'],
16563
+ ['PureCloud OAuth'],
16564
+ ['application/json'],
16565
+ ['application/json']
16566
+ );
16567
+ }
16568
+
16569
+ }
16570
+
15476
16571
  class ChatApi {
15477
16572
  /**
15478
16573
  * Chat service.
15479
16574
  * @module purecloud-platform-client-v2/api/ChatApi
15480
- * @version 248.0.0
16575
+ * @version 249.0.0
15481
16576
  */
15482
16577
 
15483
16578
  /**
@@ -16458,7 +17553,7 @@ class CoachingApi {
16458
17553
  /**
16459
17554
  * Coaching service.
16460
17555
  * @module purecloud-platform-client-v2/api/CoachingApi
16461
- * @version 248.0.0
17556
+ * @version 249.0.0
16462
17557
  */
16463
17558
 
16464
17559
  /**
@@ -17085,7 +18180,7 @@ class ContentManagementApi {
17085
18180
  /**
17086
18181
  * ContentManagement service.
17087
18182
  * @module purecloud-platform-client-v2/api/ContentManagementApi
17088
- * @version 248.0.0
18183
+ * @version 249.0.0
17089
18184
  */
17090
18185
 
17091
18186
  /**
@@ -18166,7 +19261,7 @@ class ConversationsApi {
18166
19261
  /**
18167
19262
  * Conversations service.
18168
19263
  * @module purecloud-platform-client-v2/api/ConversationsApi
18169
- * @version 248.0.0
19264
+ * @version 249.0.0
18170
19265
  */
18171
19266
 
18172
19267
  /**
@@ -20354,8 +21449,12 @@ class ConversationsApi {
20354
21449
  * Get conversation messages
20355
21450
  *
20356
21451
  * @param {String} conversationId conversationId
21452
+ * @param {Object} opts Optional parameters
21453
+ * @param {Boolean} opts.includeAgentlessStitchedMessages Whether to include Agentless 'api' type of messages, on stitched conversations. If you provide a conversationId in the agentless email request (/api/v2/conversations/emails/agentless) that matches an existing conversation, then that's a stitched agentless message. (default to false)
20357
21454
  */
20358
- getConversationsEmailMessages(conversationId) {
21455
+ getConversationsEmailMessages(conversationId, opts) {
21456
+ opts = opts || {};
21457
+
20359
21458
  // verify the required parameter 'conversationId' is set
20360
21459
  if (conversationId === undefined || conversationId === null || conversationId === '') {
20361
21460
  throw 'Missing the required parameter "conversationId" when calling getConversationsEmailMessages';
@@ -20365,7 +21464,7 @@ class ConversationsApi {
20365
21464
  '/api/v2/conversations/emails/{conversationId}/messages',
20366
21465
  'GET',
20367
21466
  { 'conversationId': conversationId },
20368
- { },
21467
+ { 'includeAgentlessStitchedMessages': opts['includeAgentlessStitchedMessages'] },
20369
21468
  { },
20370
21469
  { },
20371
21470
  null,
@@ -27639,7 +28738,7 @@ class ConversationsApi {
27639
28738
  /**
27640
28739
  * Set the organization's default supported content profile that may be assigned to an integration when it is created.
27641
28740
  * When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
27642
- * @param {Object} body SupportedContent
28741
+ * @param {Object} body Reference to supported content profile
27643
28742
  */
27644
28743
  putConversationsMessagingSupportedcontentDefault(body) {
27645
28744
  // verify the required parameter 'body' is set
@@ -27783,7 +28882,7 @@ class DataExtensionsApi {
27783
28882
  /**
27784
28883
  * DataExtensions service.
27785
28884
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
27786
- * @version 248.0.0
28885
+ * @version 249.0.0
27787
28886
  */
27788
28887
 
27789
28888
  /**
@@ -27869,7 +28968,7 @@ class DataPrivacyApi {
27869
28968
  /**
27870
28969
  * DataPrivacy service.
27871
28970
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
27872
- * @version 248.0.0
28971
+ * @version 249.0.0
27873
28972
  */
27874
28973
 
27875
28974
  /**
@@ -28039,7 +29138,7 @@ class DownloadsApi {
28039
29138
  /**
28040
29139
  * Downloads service.
28041
29140
  * @module purecloud-platform-client-v2/api/DownloadsApi
28042
- * @version 248.0.0
29141
+ * @version 249.0.0
28043
29142
  */
28044
29143
 
28045
29144
  /**
@@ -28091,7 +29190,7 @@ class EmailsApi {
28091
29190
  /**
28092
29191
  * Emails service.
28093
29192
  * @module purecloud-platform-client-v2/api/EmailsApi
28094
- * @version 248.0.0
29193
+ * @version 249.0.0
28095
29194
  */
28096
29195
 
28097
29196
  /**
@@ -28220,7 +29319,7 @@ class EmployeeEngagementApi {
28220
29319
  /**
28221
29320
  * EmployeeEngagement service.
28222
29321
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
28223
- * @version 248.0.0
29322
+ * @version 249.0.0
28224
29323
  */
28225
29324
 
28226
29325
  /**
@@ -28400,7 +29499,7 @@ class EventsApi {
28400
29499
  /**
28401
29500
  * Events service.
28402
29501
  * @module purecloud-platform-client-v2/api/EventsApi
28403
- * @version 248.0.0
29502
+ * @version 249.0.0
28404
29503
  */
28405
29504
 
28406
29505
  /**
@@ -28496,7 +29595,7 @@ class ExternalContactsApi {
28496
29595
  /**
28497
29596
  * ExternalContacts service.
28498
29597
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
28499
- * @version 248.0.0
29598
+ * @version 249.0.0
28500
29599
  */
28501
29600
 
28502
29601
  /**
@@ -30133,6 +31232,36 @@ class ExternalContactsApi {
30133
31232
  );
30134
31233
  }
30135
31234
 
31235
+ /**
31236
+ * Update specific fields of an external contact
31237
+ *
31238
+ * @param {String} contactId ExternalContact ID
31239
+ * @param {Object} body Contact fields to update
31240
+ */
31241
+ patchExternalcontactsContact(contactId, body) {
31242
+ // verify the required parameter 'contactId' is set
31243
+ if (contactId === undefined || contactId === null || contactId === '') {
31244
+ throw 'Missing the required parameter "contactId" when calling patchExternalcontactsContact';
31245
+ }
31246
+ // verify the required parameter 'body' is set
31247
+ if (body === undefined || body === null) {
31248
+ throw 'Missing the required parameter "body" when calling patchExternalcontactsContact';
31249
+ }
31250
+
31251
+ return this.apiClient.callApi(
31252
+ '/api/v2/externalcontacts/contacts/{contactId}',
31253
+ 'PATCH',
31254
+ { 'contactId': contactId },
31255
+ { },
31256
+ { },
31257
+ { },
31258
+ body,
31259
+ ['PureCloud OAuth'],
31260
+ ['application/json'],
31261
+ ['application/json']
31262
+ );
31263
+ }
31264
+
30136
31265
  /**
30137
31266
  * Claim or release identifiers for a contact
30138
31267
  *
@@ -31743,7 +32872,7 @@ class FaxApi {
31743
32872
  /**
31744
32873
  * Fax service.
31745
32874
  * @module purecloud-platform-client-v2/api/FaxApi
31746
- * @version 248.0.0
32875
+ * @version 249.0.0
31747
32876
  */
31748
32877
 
31749
32878
  /**
@@ -31958,7 +33087,7 @@ class FlowsApi {
31958
33087
  /**
31959
33088
  * Flows service.
31960
33089
  * @module purecloud-platform-client-v2/api/FlowsApi
31961
- * @version 248.0.0
33090
+ * @version 249.0.0
31962
33091
  */
31963
33092
 
31964
33093
  /**
@@ -32167,7 +33296,7 @@ class GamificationApi {
32167
33296
  /**
32168
33297
  * Gamification service.
32169
33298
  * @module purecloud-platform-client-v2/api/GamificationApi
32170
- * @version 248.0.0
33299
+ * @version 249.0.0
32171
33300
  */
32172
33301
 
32173
33302
  /**
@@ -34725,7 +35854,7 @@ class GeneralDataProtectionRegulationApi {
34725
35854
  /**
34726
35855
  * GeneralDataProtectionRegulation service.
34727
35856
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
34728
- * @version 248.0.0
35857
+ * @version 249.0.0
34729
35858
  */
34730
35859
 
34731
35860
  /**
@@ -34855,7 +35984,7 @@ class GeolocationApi {
34855
35984
  /**
34856
35985
  * Geolocation service.
34857
35986
  * @module purecloud-platform-client-v2/api/GeolocationApi
34858
- * @version 248.0.0
35987
+ * @version 249.0.0
34859
35988
  */
34860
35989
 
34861
35990
  /**
@@ -34986,7 +36115,7 @@ class GreetingsApi {
34986
36115
  /**
34987
36116
  * Greetings service.
34988
36117
  * @module purecloud-platform-client-v2/api/GreetingsApi
34989
- * @version 248.0.0
36118
+ * @version 249.0.0
34990
36119
  */
34991
36120
 
34992
36121
  /**
@@ -35528,7 +36657,7 @@ class GroupsApi {
35528
36657
  /**
35529
36658
  * Groups service.
35530
36659
  * @module purecloud-platform-client-v2/api/GroupsApi
35531
- * @version 248.0.0
36660
+ * @version 249.0.0
35532
36661
  */
35533
36662
 
35534
36663
  /**
@@ -36047,7 +37176,7 @@ class IdentityProviderApi {
36047
37176
  /**
36048
37177
  * IdentityProvider service.
36049
37178
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
36050
- * @version 248.0.0
37179
+ * @version 249.0.0
36051
37180
  */
36052
37181
 
36053
37182
  /**
@@ -36908,7 +38037,7 @@ class InfrastructureAsCodeApi {
36908
38037
  /**
36909
38038
  * InfrastructureAsCode service.
36910
38039
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
36911
- * @version 248.0.0
38040
+ * @version 249.0.0
36912
38041
  */
36913
38042
 
36914
38043
  /**
@@ -37075,7 +38204,7 @@ class IntegrationsApi {
37075
38204
  /**
37076
38205
  * Integrations service.
37077
38206
  * @module purecloud-platform-client-v2/api/IntegrationsApi
37078
- * @version 248.0.0
38207
+ * @version 249.0.0
37079
38208
  */
37080
38209
 
37081
38210
  /**
@@ -39725,7 +40854,7 @@ class IntentsApi {
39725
40854
  /**
39726
40855
  * Intents service.
39727
40856
  * @module purecloud-platform-client-v2/api/IntentsApi
39728
- * @version 248.0.0
40857
+ * @version 249.0.0
39729
40858
  */
39730
40859
 
39731
40860
  /**
@@ -40192,7 +41321,7 @@ class JourneyApi {
40192
41321
  /**
40193
41322
  * Journey service.
40194
41323
  * @module purecloud-platform-client-v2/api/JourneyApi
40195
- * @version 248.0.0
41324
+ * @version 249.0.0
40196
41325
  */
40197
41326
 
40198
41327
  /**
@@ -42289,7 +43418,7 @@ class KnowledgeApi {
42289
43418
  /**
42290
43419
  * Knowledge service.
42291
43420
  * @module purecloud-platform-client-v2/api/KnowledgeApi
42292
- * @version 248.0.0
43421
+ * @version 249.0.0
42293
43422
  */
42294
43423
 
42295
43424
  /**
@@ -42304,6 +43433,31 @@ class KnowledgeApi {
42304
43433
  }
42305
43434
 
42306
43435
 
43436
+ /**
43437
+ * Delete connection
43438
+ *
43439
+ * @param {String} connectionId Connection ID
43440
+ */
43441
+ deleteKnowledgeConnection(connectionId) {
43442
+ // verify the required parameter 'connectionId' is set
43443
+ if (connectionId === undefined || connectionId === null || connectionId === '') {
43444
+ throw 'Missing the required parameter "connectionId" when calling deleteKnowledgeConnection';
43445
+ }
43446
+
43447
+ return this.apiClient.callApi(
43448
+ '/api/v2/knowledge/connections/{connectionId}',
43449
+ 'DELETE',
43450
+ { 'connectionId': connectionId },
43451
+ { },
43452
+ { },
43453
+ { },
43454
+ null,
43455
+ ['PureCloud OAuth'],
43456
+ ['application/json'],
43457
+ ['application/json']
43458
+ );
43459
+ }
43460
+
42307
43461
  /**
42308
43462
  * Delete knowledge base
42309
43463
  *
@@ -42629,6 +43783,109 @@ class KnowledgeApi {
42629
43783
  );
42630
43784
  }
42631
43785
 
43786
+ /**
43787
+ * Delete source
43788
+ *
43789
+ * @param {String} sourceId Source ID
43790
+ */
43791
+ deleteKnowledgeSource(sourceId) {
43792
+ // verify the required parameter 'sourceId' is set
43793
+ if (sourceId === undefined || sourceId === null || sourceId === '') {
43794
+ throw 'Missing the required parameter "sourceId" when calling deleteKnowledgeSource';
43795
+ }
43796
+
43797
+ return this.apiClient.callApi(
43798
+ '/api/v2/knowledge/sources/{sourceId}',
43799
+ 'DELETE',
43800
+ { 'sourceId': sourceId },
43801
+ { },
43802
+ { },
43803
+ { },
43804
+ null,
43805
+ ['PureCloud OAuth'],
43806
+ ['application/json'],
43807
+ ['application/json']
43808
+ );
43809
+ }
43810
+
43811
+ /**
43812
+ * Get connection
43813
+ *
43814
+ * @param {String} connectionId Connection ID
43815
+ * @param {Object} opts Optional parameters
43816
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
43817
+ */
43818
+ getKnowledgeConnection(connectionId, opts) {
43819
+ opts = opts || {};
43820
+
43821
+ // verify the required parameter 'connectionId' is set
43822
+ if (connectionId === undefined || connectionId === null || connectionId === '') {
43823
+ throw 'Missing the required parameter "connectionId" when calling getKnowledgeConnection';
43824
+ }
43825
+
43826
+ return this.apiClient.callApi(
43827
+ '/api/v2/knowledge/connections/{connectionId}',
43828
+ 'GET',
43829
+ { 'connectionId': connectionId },
43830
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
43831
+ { },
43832
+ { },
43833
+ null,
43834
+ ['PureCloud OAuth'],
43835
+ ['application/json'],
43836
+ ['application/json']
43837
+ );
43838
+ }
43839
+
43840
+ /**
43841
+ * Get connection options
43842
+ *
43843
+ * @param {String} connectionId Connection ID
43844
+ * @param {Object} opts Optional parameters
43845
+ * @param {String} opts.parentId The id of the parent option whose children to be listed.
43846
+ */
43847
+ getKnowledgeConnectionOptions(connectionId, opts) {
43848
+ opts = opts || {};
43849
+
43850
+ // verify the required parameter 'connectionId' is set
43851
+ if (connectionId === undefined || connectionId === null || connectionId === '') {
43852
+ throw 'Missing the required parameter "connectionId" when calling getKnowledgeConnectionOptions';
43853
+ }
43854
+
43855
+ return this.apiClient.callApi(
43856
+ '/api/v2/knowledge/connections/{connectionId}/options',
43857
+ 'GET',
43858
+ { 'connectionId': connectionId },
43859
+ { 'parentId': opts['parentId'] },
43860
+ { },
43861
+ { },
43862
+ null,
43863
+ ['PureCloud OAuth'],
43864
+ ['application/json'],
43865
+ ['application/json']
43866
+ );
43867
+ }
43868
+
43869
+ /**
43870
+ * Get connections
43871
+ *
43872
+ */
43873
+ getKnowledgeConnections() {
43874
+
43875
+ return this.apiClient.callApi(
43876
+ '/api/v2/knowledge/connections',
43877
+ 'GET',
43878
+ { },
43879
+ { },
43880
+ { },
43881
+ { },
43882
+ null,
43883
+ ['PureCloud OAuth'],
43884
+ ['application/json'],
43885
+ ['application/json']
43886
+ );
43887
+ }
43888
+
42632
43889
  /**
42633
43890
  * Get categories
42634
43891
  *
@@ -43811,6 +45068,175 @@ class KnowledgeApi {
43811
45068
  );
43812
45069
  }
43813
45070
 
45071
+ /**
45072
+ * Get source
45073
+ *
45074
+ * @param {String} sourceId Source ID
45075
+ * @param {Object} opts Optional parameters
45076
+ * @param {Array.<String>} opts.expand Optional fields to expand for the Source.
45077
+ */
45078
+ getKnowledgeSource(sourceId, opts) {
45079
+ opts = opts || {};
45080
+
45081
+ // verify the required parameter 'sourceId' is set
45082
+ if (sourceId === undefined || sourceId === null || sourceId === '') {
45083
+ throw 'Missing the required parameter "sourceId" when calling getKnowledgeSource';
45084
+ }
45085
+
45086
+ return this.apiClient.callApi(
45087
+ '/api/v2/knowledge/sources/{sourceId}',
45088
+ 'GET',
45089
+ { 'sourceId': sourceId },
45090
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
45091
+ { },
45092
+ { },
45093
+ null,
45094
+ ['PureCloud OAuth'],
45095
+ ['application/json'],
45096
+ ['application/json']
45097
+ );
45098
+ }
45099
+
45100
+ /**
45101
+ * Get a specific synchronization of a source.
45102
+ *
45103
+ * @param {String} sourceId Source ID
45104
+ * @param {String} synchronizationId Synchronization ID
45105
+ */
45106
+ getKnowledgeSourceSynchronization(sourceId, synchronizationId) {
45107
+ // verify the required parameter 'sourceId' is set
45108
+ if (sourceId === undefined || sourceId === null || sourceId === '') {
45109
+ throw 'Missing the required parameter "sourceId" when calling getKnowledgeSourceSynchronization';
45110
+ }
45111
+ // verify the required parameter 'synchronizationId' is set
45112
+ if (synchronizationId === undefined || synchronizationId === null || synchronizationId === '') {
45113
+ throw 'Missing the required parameter "synchronizationId" when calling getKnowledgeSourceSynchronization';
45114
+ }
45115
+
45116
+ return this.apiClient.callApi(
45117
+ '/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}',
45118
+ 'GET',
45119
+ { 'sourceId': sourceId,'synchronizationId': synchronizationId },
45120
+ { },
45121
+ { },
45122
+ { },
45123
+ null,
45124
+ ['PureCloud OAuth'],
45125
+ ['application/json'],
45126
+ ['application/json']
45127
+ );
45128
+ }
45129
+
45130
+ /**
45131
+ * Get synchronizations of a source.
45132
+ *
45133
+ * @param {String} sourceId Source ID
45134
+ * @param {Object} opts Optional parameters
45135
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
45136
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
45137
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
45138
+ */
45139
+ getKnowledgeSourceSynchronizations(sourceId, opts) {
45140
+ opts = opts || {};
45141
+
45142
+ // verify the required parameter 'sourceId' is set
45143
+ if (sourceId === undefined || sourceId === null || sourceId === '') {
45144
+ throw 'Missing the required parameter "sourceId" when calling getKnowledgeSourceSynchronizations';
45145
+ }
45146
+
45147
+ return this.apiClient.callApi(
45148
+ '/api/v2/knowledge/sources/{sourceId}/synchronizations',
45149
+ 'GET',
45150
+ { 'sourceId': sourceId },
45151
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
45152
+ { },
45153
+ { },
45154
+ null,
45155
+ ['PureCloud OAuth'],
45156
+ ['application/json'],
45157
+ ['application/json']
45158
+ );
45159
+ }
45160
+
45161
+ /**
45162
+ * List sources
45163
+ *
45164
+ * @param {Object} opts Optional parameters
45165
+ * @param {Array.<String>} opts.expand Optional fields to expand for the Source.
45166
+ */
45167
+ getKnowledgeSources(opts) {
45168
+ opts = opts || {};
45169
+
45170
+
45171
+ return this.apiClient.callApi(
45172
+ '/api/v2/knowledge/sources',
45173
+ 'GET',
45174
+ { },
45175
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
45176
+ { },
45177
+ { },
45178
+ null,
45179
+ ['PureCloud OAuth'],
45180
+ ['application/json'],
45181
+ ['application/json']
45182
+ );
45183
+ }
45184
+
45185
+ /**
45186
+ * Get synchronizations of all sources of the organization.
45187
+ *
45188
+ * @param {Object} opts Optional parameters
45189
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
45190
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
45191
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
45192
+ */
45193
+ getKnowledgeSourcesSynchronizations(opts) {
45194
+ opts = opts || {};
45195
+
45196
+
45197
+ return this.apiClient.callApi(
45198
+ '/api/v2/knowledge/sources/synchronizations',
45199
+ 'GET',
45200
+ { },
45201
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
45202
+ { },
45203
+ { },
45204
+ null,
45205
+ ['PureCloud OAuth'],
45206
+ ['application/json'],
45207
+ ['application/json']
45208
+ );
45209
+ }
45210
+
45211
+ /**
45212
+ * Update connection
45213
+ *
45214
+ * @param {String} connectionId Connection ID
45215
+ * @param {Object} opts Optional parameters
45216
+ * @param {Object} opts.body
45217
+ */
45218
+ patchKnowledgeConnection(connectionId, opts) {
45219
+ opts = opts || {};
45220
+
45221
+ // verify the required parameter 'connectionId' is set
45222
+ if (connectionId === undefined || connectionId === null || connectionId === '') {
45223
+ throw 'Missing the required parameter "connectionId" when calling patchKnowledgeConnection';
45224
+ }
45225
+
45226
+ return this.apiClient.callApi(
45227
+ '/api/v2/knowledge/connections/{connectionId}',
45228
+ 'PATCH',
45229
+ { 'connectionId': connectionId },
45230
+ { },
45231
+ { },
45232
+ { },
45233
+ opts['body'],
45234
+ ['PureCloud OAuth'],
45235
+ ['application/json'],
45236
+ ['application/json']
45237
+ );
45238
+ }
45239
+
43814
45240
  /**
43815
45241
  * Update search result.
43816
45242
  *
@@ -44303,6 +45729,66 @@ class KnowledgeApi {
44303
45729
  );
44304
45730
  }
44305
45731
 
45732
+ /**
45733
+ * Update synchronization.
45734
+ *
45735
+ * @param {String} sourceId Source ID
45736
+ * @param {String} synchronizationId Synchronization ID
45737
+ * @param {Object} body
45738
+ */
45739
+ patchKnowledgeSourceSynchronization(sourceId, synchronizationId, body) {
45740
+ // verify the required parameter 'sourceId' is set
45741
+ if (sourceId === undefined || sourceId === null || sourceId === '') {
45742
+ throw 'Missing the required parameter "sourceId" when calling patchKnowledgeSourceSynchronization';
45743
+ }
45744
+ // verify the required parameter 'synchronizationId' is set
45745
+ if (synchronizationId === undefined || synchronizationId === null || synchronizationId === '') {
45746
+ throw 'Missing the required parameter "synchronizationId" when calling patchKnowledgeSourceSynchronization';
45747
+ }
45748
+ // verify the required parameter 'body' is set
45749
+ if (body === undefined || body === null) {
45750
+ throw 'Missing the required parameter "body" when calling patchKnowledgeSourceSynchronization';
45751
+ }
45752
+
45753
+ return this.apiClient.callApi(
45754
+ '/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}',
45755
+ 'PATCH',
45756
+ { 'sourceId': sourceId,'synchronizationId': synchronizationId },
45757
+ { },
45758
+ { },
45759
+ { },
45760
+ body,
45761
+ ['PureCloud OAuth'],
45762
+ ['application/json'],
45763
+ ['application/json']
45764
+ );
45765
+ }
45766
+
45767
+ /**
45768
+ * Create new connection
45769
+ *
45770
+ * @param {Object} body
45771
+ */
45772
+ postKnowledgeConnections(body) {
45773
+ // verify the required parameter 'body' is set
45774
+ if (body === undefined || body === null) {
45775
+ throw 'Missing the required parameter "body" when calling postKnowledgeConnections';
45776
+ }
45777
+
45778
+ return this.apiClient.callApi(
45779
+ '/api/v2/knowledge/connections',
45780
+ 'POST',
45781
+ { },
45782
+ { },
45783
+ { },
45784
+ { },
45785
+ body,
45786
+ ['PureCloud OAuth'],
45787
+ ['application/json'],
45788
+ ['application/json']
45789
+ );
45790
+ }
45791
+
44306
45792
  /**
44307
45793
  * Creates a presigned URL for uploading a knowledge import file with a set of documents
44308
45794
  *
@@ -45512,6 +46998,95 @@ class KnowledgeApi {
45512
46998
  );
45513
46999
  }
45514
47000
 
47001
+ /**
47002
+ * Create presigned URL for uploading a file in the synchronization.
47003
+ *
47004
+ * @param {String} sourceId Source ID
47005
+ * @param {String} synchronizationId Synchronization ID
47006
+ * @param {Object} body
47007
+ */
47008
+ postKnowledgeSourceSynchronizationUploads(sourceId, synchronizationId, body) {
47009
+ // verify the required parameter 'sourceId' is set
47010
+ if (sourceId === undefined || sourceId === null || sourceId === '') {
47011
+ throw 'Missing the required parameter "sourceId" when calling postKnowledgeSourceSynchronizationUploads';
47012
+ }
47013
+ // verify the required parameter 'synchronizationId' is set
47014
+ if (synchronizationId === undefined || synchronizationId === null || synchronizationId === '') {
47015
+ throw 'Missing the required parameter "synchronizationId" when calling postKnowledgeSourceSynchronizationUploads';
47016
+ }
47017
+ // verify the required parameter 'body' is set
47018
+ if (body === undefined || body === null) {
47019
+ throw 'Missing the required parameter "body" when calling postKnowledgeSourceSynchronizationUploads';
47020
+ }
47021
+
47022
+ return this.apiClient.callApi(
47023
+ '/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads',
47024
+ 'POST',
47025
+ { 'sourceId': sourceId,'synchronizationId': synchronizationId },
47026
+ { },
47027
+ { },
47028
+ { },
47029
+ body,
47030
+ ['PureCloud OAuth'],
47031
+ ['application/json'],
47032
+ ['application/json']
47033
+ );
47034
+ }
47035
+
47036
+ /**
47037
+ * Start a manual synchronization from a source.
47038
+ *
47039
+ * @param {String} sourceId Source ID
47040
+ * @param {Object} opts Optional parameters
47041
+ * @param {Object} opts.body
47042
+ */
47043
+ postKnowledgeSourceSynchronizations(sourceId, opts) {
47044
+ opts = opts || {};
47045
+
47046
+ // verify the required parameter 'sourceId' is set
47047
+ if (sourceId === undefined || sourceId === null || sourceId === '') {
47048
+ throw 'Missing the required parameter "sourceId" when calling postKnowledgeSourceSynchronizations';
47049
+ }
47050
+
47051
+ return this.apiClient.callApi(
47052
+ '/api/v2/knowledge/sources/{sourceId}/synchronizations',
47053
+ 'POST',
47054
+ { 'sourceId': sourceId },
47055
+ { },
47056
+ { },
47057
+ { },
47058
+ opts['body'],
47059
+ ['PureCloud OAuth'],
47060
+ ['application/json'],
47061
+ ['application/json']
47062
+ );
47063
+ }
47064
+
47065
+ /**
47066
+ * Create a new source
47067
+ *
47068
+ * @param {Object} body
47069
+ */
47070
+ postKnowledgeSources(body) {
47071
+ // verify the required parameter 'body' is set
47072
+ if (body === undefined || body === null) {
47073
+ throw 'Missing the required parameter "body" when calling postKnowledgeSources';
47074
+ }
47075
+
47076
+ return this.apiClient.callApi(
47077
+ '/api/v2/knowledge/sources',
47078
+ 'POST',
47079
+ { },
47080
+ { },
47081
+ { },
47082
+ { },
47083
+ body,
47084
+ ['PureCloud OAuth'],
47085
+ ['application/json'],
47086
+ ['application/json']
47087
+ );
47088
+ }
47089
+
45515
47090
  /**
45516
47091
  * Update Salesforce Knowledge integration source
45517
47092
  *
@@ -45582,13 +47157,43 @@ class KnowledgeApi {
45582
47157
  );
45583
47158
  }
45584
47159
 
47160
+ /**
47161
+ * Update the source
47162
+ *
47163
+ * @param {String} sourceId Source ID
47164
+ * @param {Object} body
47165
+ */
47166
+ putKnowledgeSource(sourceId, body) {
47167
+ // verify the required parameter 'sourceId' is set
47168
+ if (sourceId === undefined || sourceId === null || sourceId === '') {
47169
+ throw 'Missing the required parameter "sourceId" when calling putKnowledgeSource';
47170
+ }
47171
+ // verify the required parameter 'body' is set
47172
+ if (body === undefined || body === null) {
47173
+ throw 'Missing the required parameter "body" when calling putKnowledgeSource';
47174
+ }
47175
+
47176
+ return this.apiClient.callApi(
47177
+ '/api/v2/knowledge/sources/{sourceId}',
47178
+ 'PUT',
47179
+ { 'sourceId': sourceId },
47180
+ { },
47181
+ { },
47182
+ { },
47183
+ body,
47184
+ ['PureCloud OAuth'],
47185
+ ['application/json'],
47186
+ ['application/json']
47187
+ );
47188
+ }
47189
+
45585
47190
  }
45586
47191
 
45587
47192
  class LanguageUnderstandingApi {
45588
47193
  /**
45589
47194
  * LanguageUnderstanding service.
45590
47195
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
45591
- * @version 248.0.0
47196
+ * @version 249.0.0
45592
47197
  */
45593
47198
 
45594
47199
  /**
@@ -46807,7 +48412,7 @@ class LanguagesApi {
46807
48412
  /**
46808
48413
  * Languages service.
46809
48414
  * @module purecloud-platform-client-v2/api/LanguagesApi
46810
- * @version 248.0.0
48415
+ * @version 249.0.0
46811
48416
  */
46812
48417
 
46813
48418
  /**
@@ -47029,7 +48634,7 @@ class LearningApi {
47029
48634
  /**
47030
48635
  * Learning service.
47031
48636
  * @module purecloud-platform-client-v2/api/LearningApi
47032
- * @version 248.0.0
48637
+ * @version 249.0.0
47033
48638
  */
47034
48639
 
47035
48640
  /**
@@ -48138,7 +49743,7 @@ class LicenseApi {
48138
49743
  /**
48139
49744
  * License service.
48140
49745
  * @module purecloud-platform-client-v2/api/LicenseApi
48141
- * @version 248.0.0
49746
+ * @version 249.0.0
48142
49747
  */
48143
49748
 
48144
49749
  /**
@@ -48297,6 +49902,31 @@ class LicenseApi {
48297
49902
  );
48298
49903
  }
48299
49904
 
49905
+ /**
49906
+ * Get a list of licenses inferred based on a list of permissions
49907
+ *
49908
+ * @param {Object} opts Optional parameters
49909
+ * @param {Array.<String>} opts.body The permissions to use while inferring licenses
49910
+ * postLicenseInferPermissions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49911
+ */
49912
+ postLicenseInferPermissions(opts) {
49913
+ opts = opts || {};
49914
+
49915
+
49916
+ return this.apiClient.callApi(
49917
+ '/api/v2/license/infer/permissions',
49918
+ 'POST',
49919
+ { },
49920
+ { },
49921
+ { },
49922
+ { },
49923
+ opts['body'],
49924
+ ['PureCloud OAuth'],
49925
+ ['application/json'],
49926
+ ['application/json']
49927
+ );
49928
+ }
49929
+
48300
49930
  /**
48301
49931
  * Update the organization's license assignments in a batch.
48302
49932
  *
@@ -48376,7 +50006,7 @@ class LocationsApi {
48376
50006
  /**
48377
50007
  * Locations service.
48378
50008
  * @module purecloud-platform-client-v2/api/LocationsApi
48379
- * @version 248.0.0
50009
+ * @version 249.0.0
48380
50010
  */
48381
50011
 
48382
50012
  /**
@@ -48612,7 +50242,7 @@ class LogCaptureApi {
48612
50242
  /**
48613
50243
  * LogCapture service.
48614
50244
  * @module purecloud-platform-client-v2/api/LogCaptureApi
48615
- * @version 248.0.0
50245
+ * @version 249.0.0
48616
50246
  */
48617
50247
 
48618
50248
  /**
@@ -48811,7 +50441,7 @@ class MessagingApi {
48811
50441
  /**
48812
50442
  * Messaging service.
48813
50443
  * @module purecloud-platform-client-v2/api/MessagingApi
48814
- * @version 248.0.0
50444
+ * @version 249.0.0
48815
50445
  */
48816
50446
 
48817
50447
  /**
@@ -49170,7 +50800,7 @@ class MobileDevicesApi {
49170
50800
  /**
49171
50801
  * MobileDevices service.
49172
50802
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
49173
- * @version 248.0.0
50803
+ * @version 249.0.0
49174
50804
  */
49175
50805
 
49176
50806
  /**
@@ -49321,7 +50951,7 @@ class NotificationsApi {
49321
50951
  /**
49322
50952
  * Notifications service.
49323
50953
  * @module purecloud-platform-client-v2/api/NotificationsApi
49324
- * @version 248.0.0
50954
+ * @version 249.0.0
49325
50955
  */
49326
50956
 
49327
50957
  /**
@@ -49554,7 +51184,7 @@ class OAuthApi {
49554
51184
  /**
49555
51185
  * OAuth service.
49556
51186
  * @module purecloud-platform-client-v2/api/OAuthApi
49557
- * @version 248.0.0
51187
+ * @version 249.0.0
49558
51188
  */
49559
51189
 
49560
51190
  /**
@@ -49920,7 +51550,7 @@ class ObjectsApi {
49920
51550
  /**
49921
51551
  * Objects service.
49922
51552
  * @module purecloud-platform-client-v2/api/ObjectsApi
49923
- * @version 248.0.0
51553
+ * @version 249.0.0
49924
51554
  */
49925
51555
 
49926
51556
  /**
@@ -50244,7 +51874,7 @@ class OperationalEventsApi {
50244
51874
  /**
50245
51875
  * OperationalEvents service.
50246
51876
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
50247
- * @version 248.0.0
51877
+ * @version 249.0.0
50248
51878
  */
50249
51879
 
50250
51880
  /**
@@ -50361,7 +51991,7 @@ class OrganizationApi {
50361
51991
  /**
50362
51992
  * Organization service.
50363
51993
  * @module purecloud-platform-client-v2/api/OrganizationApi
50364
- * @version 248.0.0
51994
+ * @version 249.0.0
50365
51995
  */
50366
51996
 
50367
51997
  /**
@@ -50836,7 +52466,7 @@ class OrganizationAuthorizationApi {
50836
52466
  /**
50837
52467
  * OrganizationAuthorization service.
50838
52468
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
50839
- * @version 248.0.0
52469
+ * @version 249.0.0
50840
52470
  */
50841
52471
 
50842
52472
  /**
@@ -52230,7 +53860,7 @@ class OutboundApi {
52230
53860
  /**
52231
53861
  * Outbound service.
52232
53862
  * @module purecloud-platform-client-v2/api/OutboundApi
52233
- * @version 248.0.0
53863
+ * @version 249.0.0
52234
53864
  */
52235
53865
 
52236
53866
  /**
@@ -52451,7 +54081,7 @@ class OutboundApi {
52451
54081
  }
52452
54082
 
52453
54083
  /**
52454
- * Delete contacts from a contact list.
54084
+ * Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted
52455
54085
  *
52456
54086
  * @param {String} contactListId Contact List ID
52457
54087
  * @param {Array.<String>} contactIds ContactIds to delete.
@@ -54057,6 +55687,41 @@ class OutboundApi {
54057
55687
  );
54058
55688
  }
54059
55689
 
55690
+ /**
55691
+ * Get diagnostic summary for a single campaign
55692
+ *
55693
+ * @param {String} campaignId Campaign ID
55694
+ * @param {String} start Start datetime (ISO 8601 or Unix epoch)
55695
+ * @param {String} end End datetime (ISO 8601 or Unix epoch)
55696
+ */
55697
+ getOutboundDiagnosticsCampaignSummary(campaignId, start, end) {
55698
+ // verify the required parameter 'campaignId' is set
55699
+ if (campaignId === undefined || campaignId === null || campaignId === '') {
55700
+ throw 'Missing the required parameter "campaignId" when calling getOutboundDiagnosticsCampaignSummary';
55701
+ }
55702
+ // verify the required parameter 'start' is set
55703
+ if (start === undefined || start === null) {
55704
+ throw 'Missing the required parameter "start" when calling getOutboundDiagnosticsCampaignSummary';
55705
+ }
55706
+ // verify the required parameter 'end' is set
55707
+ if (end === undefined || end === null) {
55708
+ throw 'Missing the required parameter "end" when calling getOutboundDiagnosticsCampaignSummary';
55709
+ }
55710
+
55711
+ return this.apiClient.callApi(
55712
+ '/api/v2/outbound/diagnostics/campaigns/{campaignId}/summary',
55713
+ 'GET',
55714
+ { 'campaignId': campaignId },
55715
+ { 'start': start,'end': end },
55716
+ { },
55717
+ { },
55718
+ null,
55719
+ ['PureCloud OAuth'],
55720
+ ['application/json'],
55721
+ ['application/json']
55722
+ );
55723
+ }
55724
+
54060
55725
  /**
54061
55726
  * Get an Outbound Digital Rule Set
54062
55727
  *
@@ -57028,7 +58693,7 @@ class PresenceApi {
57028
58693
  /**
57029
58694
  * Presence service.
57030
58695
  * @module purecloud-platform-client-v2/api/PresenceApi
57031
- * @version 248.0.0
58696
+ * @version 249.0.0
57032
58697
  */
57033
58698
 
57034
58699
  /**
@@ -57772,7 +59437,7 @@ class ProcessAutomationApi {
57772
59437
  /**
57773
59438
  * ProcessAutomation service.
57774
59439
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
57775
- * @version 248.0.0
59440
+ * @version 249.0.0
57776
59441
  */
57777
59442
 
57778
59443
  /**
@@ -58011,7 +59676,7 @@ class QualityApi {
58011
59676
  /**
58012
59677
  * Quality service.
58013
59678
  * @module purecloud-platform-client-v2/api/QualityApi
58014
- * @version 248.0.0
59679
+ * @version 249.0.0
58015
59680
  */
58016
59681
 
58017
59682
  /**
@@ -60081,7 +61746,7 @@ class RecordingApi {
60081
61746
  /**
60082
61747
  * Recording service.
60083
61748
  * @module purecloud-platform-client-v2/api/RecordingApi
60084
- * @version 248.0.0
61749
+ * @version 249.0.0
60085
61750
  */
60086
61751
 
60087
61752
  /**
@@ -61686,7 +63351,7 @@ class ResponseManagementApi {
61686
63351
  /**
61687
63352
  * ResponseManagement service.
61688
63353
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
61689
- * @version 248.0.0
63354
+ * @version 249.0.0
61690
63355
  */
61691
63356
 
61692
63357
  /**
@@ -61988,6 +63653,62 @@ class ResponseManagementApi {
61988
63653
  );
61989
63654
  }
61990
63655
 
63656
+ /**
63657
+ * Query libraries using criteria. Users can set DivisionId parameter as '*' to fetch libraries that aren't associated with any divisions.
63658
+ *
63659
+ * @param {Object} body Query criteria
63660
+ * @param {Object} opts Optional parameters
63661
+ * @param {Number} opts.pageNumber Page number (default to 1)
63662
+ * @param {Number} opts.pageSize Page size (default to 25)
63663
+ * postResponsemanagementLibrariesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
63664
+ */
63665
+ postResponsemanagementLibrariesQuery(body, opts) {
63666
+ opts = opts || {};
63667
+
63668
+ // verify the required parameter 'body' is set
63669
+ if (body === undefined || body === null) {
63670
+ throw 'Missing the required parameter "body" when calling postResponsemanagementLibrariesQuery';
63671
+ }
63672
+
63673
+ return this.apiClient.callApi(
63674
+ '/api/v2/responsemanagement/libraries/query',
63675
+ 'POST',
63676
+ { },
63677
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
63678
+ { },
63679
+ { },
63680
+ body,
63681
+ ['PureCloud OAuth'],
63682
+ ['application/json'],
63683
+ ['application/json']
63684
+ );
63685
+ }
63686
+
63687
+ /**
63688
+ * Get response assets.
63689
+ *
63690
+ * @param {Object} body Asset IDs (max allowed 50)
63691
+ */
63692
+ postResponsemanagementResponseassetsBulk(body) {
63693
+ // verify the required parameter 'body' is set
63694
+ if (body === undefined || body === null) {
63695
+ throw 'Missing the required parameter "body" when calling postResponsemanagementResponseassetsBulk';
63696
+ }
63697
+
63698
+ return this.apiClient.callApi(
63699
+ '/api/v2/responsemanagement/responseassets/bulk',
63700
+ 'POST',
63701
+ { },
63702
+ { },
63703
+ { },
63704
+ { },
63705
+ body,
63706
+ ['PureCloud OAuth'],
63707
+ ['application/json'],
63708
+ ['application/json']
63709
+ );
63710
+ }
63711
+
61991
63712
  /**
61992
63713
  * Search response assets
61993
63714
  *
@@ -62196,7 +63917,7 @@ class RoutingApi {
62196
63917
  /**
62197
63918
  * Routing service.
62198
63919
  * @module purecloud-platform-client-v2/api/RoutingApi
62199
- * @version 248.0.0
63920
+ * @version 249.0.0
62200
63921
  */
62201
63922
 
62202
63923
  /**
@@ -64398,7 +66119,7 @@ class RoutingApi {
64398
66119
 
64399
66120
  /**
64400
66121
  * Get a phone number provisioned for SMS.
64401
- *
66122
+ * When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the "SMS Default" profile. This default profile allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The "SMS Default" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile using the PATCH endpoint.
64402
66123
  * @param {String} phoneNumberId phone number
64403
66124
  * @param {Object} opts Optional parameters
64404
66125
  * @param {Object} opts.expand Expand response with additional information
@@ -64427,7 +66148,7 @@ class RoutingApi {
64427
66148
 
64428
66149
  /**
64429
66150
  * Get a list of provisioned phone numbers.
64430
- *
66151
+ * When no supported content profile is explicitly set, the system uses the "SMS Default" profile. This default profile allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. The "SMS Default" profile does not have an ID and cannot be modified. To customize media filtering, create and assign a custom supported content profile.
64431
66152
  * @param {Object} opts Optional parameters
64432
66153
  * @param {String} opts.phoneNumber Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.
64433
66154
  * @param {Array.<String>} opts.phoneNumberType Filter on phone number type
@@ -65344,7 +67065,7 @@ class RoutingApi {
65344
67065
 
65345
67066
  /**
65346
67067
  * Update a phone number provisioned for SMS.
65347
- *
67068
+ * Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the "SMS Default" profile, which allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To customize media filtering, provide a supported content profile ID in the request body.
65348
67069
  * @param {String} phoneNumberId phone number
65349
67070
  * @param {Object} body SmsPhoneNumberPatchRequest
65350
67071
  */
@@ -66187,7 +67908,7 @@ class RoutingApi {
66187
67908
 
66188
67909
  /**
66189
67910
  * Provision a phone number for SMS
66190
- *
67911
+ * When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the "SMS Default" profile. This default profile allows all media types (\*\/\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. To use custom media filtering, specify a supported content profile ID in the request body.
66191
67912
  * @param {Object} body SmsPhoneNumber
66192
67913
  */
66193
67914
  postRoutingSmsPhonenumbers(body) {
@@ -66903,7 +68624,7 @@ class SCIMApi {
66903
68624
  /**
66904
68625
  * SCIM service.
66905
68626
  * @module purecloud-platform-client-v2/api/SCIMApi
66906
- * @version 248.0.0
68627
+ * @version 249.0.0
66907
68628
  */
66908
68629
 
66909
68630
  /**
@@ -67780,7 +69501,7 @@ class ScriptsApi {
67780
69501
  /**
67781
69502
  * Scripts service.
67782
69503
  * @module purecloud-platform-client-v2/api/ScriptsApi
67783
- * @version 248.0.0
69504
+ * @version 249.0.0
67784
69505
  */
67785
69506
 
67786
69507
  /**
@@ -68256,7 +69977,7 @@ class SearchApi {
68256
69977
  /**
68257
69978
  * Search service.
68258
69979
  * @module purecloud-platform-client-v2/api/SearchApi
68259
- * @version 248.0.0
69980
+ * @version 249.0.0
68260
69981
  */
68261
69982
 
68262
69983
  /**
@@ -68969,7 +70690,7 @@ class SettingsApi {
68969
70690
  /**
68970
70691
  * Settings service.
68971
70692
  * @module purecloud-platform-client-v2/api/SettingsApi
68972
- * @version 248.0.0
70693
+ * @version 249.0.0
68973
70694
  */
68974
70695
 
68975
70696
  /**
@@ -69317,7 +71038,7 @@ class SocialMediaApi {
69317
71038
  /**
69318
71039
  * SocialMedia service.
69319
71040
  * @module purecloud-platform-client-v2/api/SocialMediaApi
69320
- * @version 248.0.0
71041
+ * @version 249.0.0
69321
71042
  */
69322
71043
 
69323
71044
  /**
@@ -71161,7 +72882,7 @@ class SpeechTextAnalyticsApi {
71161
72882
  /**
71162
72883
  * SpeechTextAnalytics service.
71163
72884
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
71164
- * @version 248.0.0
72885
+ * @version 249.0.0
71165
72886
  */
71166
72887
 
71167
72888
  /**
@@ -72837,7 +74558,7 @@ class StationsApi {
72837
74558
  /**
72838
74559
  * Stations service.
72839
74560
  * @module purecloud-platform-client-v2/api/StationsApi
72840
- * @version 248.0.0
74561
+ * @version 249.0.0
72841
74562
  */
72842
74563
 
72843
74564
  /**
@@ -72939,7 +74660,7 @@ class SuggestApi {
72939
74660
  /**
72940
74661
  * Suggest service.
72941
74662
  * @module purecloud-platform-client-v2/api/SuggestApi
72942
- * @version 248.0.0
74663
+ * @version 249.0.0
72943
74664
  */
72944
74665
 
72945
74666
  /**
@@ -73078,7 +74799,7 @@ class TaskManagementApi {
73078
74799
  /**
73079
74800
  * TaskManagement service.
73080
74801
  * @module purecloud-platform-client-v2/api/TaskManagementApi
73081
- * @version 248.0.0
74802
+ * @version 249.0.0
73082
74803
  */
73083
74804
 
73084
74805
  /**
@@ -75239,7 +76960,7 @@ class TeamsApi {
75239
76960
  /**
75240
76961
  * Teams service.
75241
76962
  * @module purecloud-platform-client-v2/api/TeamsApi
75242
- * @version 248.0.0
76963
+ * @version 249.0.0
75243
76964
  */
75244
76965
 
75245
76966
  /**
@@ -75544,7 +77265,7 @@ class TelephonyApi {
75544
77265
  /**
75545
77266
  * Telephony service.
75546
77267
  * @module purecloud-platform-client-v2/api/TelephonyApi
75547
- * @version 248.0.0
77268
+ * @version 249.0.0
75548
77269
  */
75549
77270
 
75550
77271
  /**
@@ -75648,6 +77369,26 @@ class TelephonyApi {
75648
77369
  );
75649
77370
  }
75650
77371
 
77372
+ /**
77373
+ * Get the global telephony configuration.
77374
+ *
77375
+ */
77376
+ getTelephonySettings() {
77377
+
77378
+ return this.apiClient.callApi(
77379
+ '/api/v2/telephony/settings',
77380
+ 'GET',
77381
+ { },
77382
+ { },
77383
+ { },
77384
+ { },
77385
+ null,
77386
+ ['PureCloud OAuth'],
77387
+ ['application/json'],
77388
+ ['application/json']
77389
+ );
77390
+ }
77391
+
75651
77392
  /**
75652
77393
  * Get a SIP message.
75653
77394
  * Get the raw form of the SIP message
@@ -75844,13 +77585,38 @@ class TelephonyApi {
75844
77585
  );
75845
77586
  }
75846
77587
 
77588
+ /**
77589
+ * Update the global telephony configuration.
77590
+ *
77591
+ * @param {Object} body Telephony
77592
+ */
77593
+ putTelephonySettings(body) {
77594
+ // verify the required parameter 'body' is set
77595
+ if (body === undefined || body === null) {
77596
+ throw 'Missing the required parameter "body" when calling putTelephonySettings';
77597
+ }
77598
+
77599
+ return this.apiClient.callApi(
77600
+ '/api/v2/telephony/settings',
77601
+ 'PUT',
77602
+ { },
77603
+ { },
77604
+ { },
77605
+ { },
77606
+ body,
77607
+ ['PureCloud OAuth'],
77608
+ ['application/json'],
77609
+ ['application/json']
77610
+ );
77611
+ }
77612
+
75847
77613
  }
75848
77614
 
75849
77615
  class TelephonyProvidersEdgeApi {
75850
77616
  /**
75851
77617
  * TelephonyProvidersEdge service.
75852
77618
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
75853
- * @version 248.0.0
77619
+ * @version 249.0.0
75854
77620
  */
75855
77621
 
75856
77622
  /**
@@ -79343,7 +81109,7 @@ class TextbotsApi {
79343
81109
  /**
79344
81110
  * Textbots service.
79345
81111
  * @module purecloud-platform-client-v2/api/TextbotsApi
79346
- * @version 248.0.0
81112
+ * @version 249.0.0
79347
81113
  */
79348
81114
 
79349
81115
  /**
@@ -79472,7 +81238,7 @@ class TokensApi {
79472
81238
  /**
79473
81239
  * Tokens service.
79474
81240
  * @module purecloud-platform-client-v2/api/TokensApi
79475
- * @version 248.0.0
81241
+ * @version 249.0.0
79476
81242
  */
79477
81243
 
79478
81244
  /**
@@ -79626,7 +81392,7 @@ class UploadsApi {
79626
81392
  /**
79627
81393
  * Uploads service.
79628
81394
  * @module purecloud-platform-client-v2/api/UploadsApi
79629
- * @version 248.0.0
81395
+ * @version 249.0.0
79630
81396
  */
79631
81397
 
79632
81398
  /**
@@ -79942,7 +81708,7 @@ class UsageApi {
79942
81708
  /**
79943
81709
  * Usage service.
79944
81710
  * @module purecloud-platform-client-v2/api/UsageApi
79945
- * @version 248.0.0
81711
+ * @version 249.0.0
79946
81712
  */
79947
81713
 
79948
81714
  /**
@@ -80277,7 +82043,7 @@ class UserRecordingsApi {
80277
82043
  /**
80278
82044
  * UserRecordings service.
80279
82045
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
80280
- * @version 248.0.0
82046
+ * @version 249.0.0
80281
82047
  */
80282
82048
 
80283
82049
  /**
@@ -80461,7 +82227,7 @@ class UsersApi {
80461
82227
  /**
80462
82228
  * Users service.
80463
82229
  * @module purecloud-platform-client-v2/api/UsersApi
80464
- * @version 248.0.0
82230
+ * @version 249.0.0
80465
82231
  */
80466
82232
 
80467
82233
  /**
@@ -83911,7 +85677,7 @@ class UsersRulesApi {
83911
85677
  /**
83912
85678
  * UsersRules service.
83913
85679
  * @module purecloud-platform-client-v2/api/UsersRulesApi
83914
- * @version 248.0.0
85680
+ * @version 249.0.0
83915
85681
  */
83916
85682
 
83917
85683
  /**
@@ -84192,7 +85958,7 @@ class UtilitiesApi {
84192
85958
  /**
84193
85959
  * Utilities service.
84194
85960
  * @module purecloud-platform-client-v2/api/UtilitiesApi
84195
- * @version 248.0.0
85961
+ * @version 249.0.0
84196
85962
  */
84197
85963
 
84198
85964
  /**
@@ -84303,7 +86069,7 @@ class VoicemailApi {
84303
86069
  /**
84304
86070
  * Voicemail service.
84305
86071
  * @module purecloud-platform-client-v2/api/VoicemailApi
84306
- * @version 248.0.0
86072
+ * @version 249.0.0
84307
86073
  */
84308
86074
 
84309
86075
  /**
@@ -85025,7 +86791,7 @@ class WebChatApi {
85025
86791
  /**
85026
86792
  * WebChat service.
85027
86793
  * @module purecloud-platform-client-v2/api/WebChatApi
85028
- * @version 248.0.0
86794
+ * @version 249.0.0
85029
86795
  */
85030
86796
 
85031
86797
  /**
@@ -85588,7 +87354,7 @@ class WebDeploymentsApi {
85588
87354
  /**
85589
87355
  * WebDeployments service.
85590
87356
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
85591
- * @version 248.0.0
87357
+ * @version 249.0.0
85592
87358
  */
85593
87359
 
85594
87360
  /**
@@ -86182,7 +87948,7 @@ class WebMessagingApi {
86182
87948
  /**
86183
87949
  * WebMessaging service.
86184
87950
  * @module purecloud-platform-client-v2/api/WebMessagingApi
86185
- * @version 248.0.0
87951
+ * @version 249.0.0
86186
87952
  */
86187
87953
 
86188
87954
  /**
@@ -86328,7 +88094,7 @@ class WidgetsApi {
86328
88094
  /**
86329
88095
  * Widgets service.
86330
88096
  * @module purecloud-platform-client-v2/api/WidgetsApi
86331
- * @version 248.0.0
88097
+ * @version 249.0.0
86332
88098
  */
86333
88099
 
86334
88100
  /**
@@ -86479,7 +88245,7 @@ class WorkforceManagementApi {
86479
88245
  /**
86480
88246
  * WorkforceManagement service.
86481
88247
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
86482
- * @version 248.0.0
88248
+ * @version 249.0.0
86483
88249
  */
86484
88250
 
86485
88251
  /**
@@ -88061,6 +89827,31 @@ class WorkforceManagementApi {
88061
89827
  );
88062
89828
  }
88063
89829
 
89830
+ /**
89831
+ * Get minimum staffing settings for a business unit
89832
+ *
89833
+ * @param {String} businessUnitId The ID of the business unit
89834
+ */
89835
+ getWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId) {
89836
+ // verify the required parameter 'businessUnitId' is set
89837
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
89838
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMinimumstaffingSettings';
89839
+ }
89840
+
89841
+ return this.apiClient.callApi(
89842
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings',
89843
+ 'GET',
89844
+ { 'businessUnitId': businessUnitId },
89845
+ { },
89846
+ { },
89847
+ { },
89848
+ null,
89849
+ ['PureCloud OAuth'],
89850
+ ['application/json'],
89851
+ ['application/json']
89852
+ );
89853
+ }
89854
+
88064
89855
  /**
88065
89856
  * Get a planning group
88066
89857
  *
@@ -88116,6 +89907,31 @@ class WorkforceManagementApi {
88116
89907
  );
88117
89908
  }
88118
89909
 
89910
+ /**
89911
+ * Get scheduler settings for a business unit
89912
+ *
89913
+ * @param {String} businessUnitId The ID of the business unit
89914
+ */
89915
+ getWorkforcemanagementBusinessunitSchedulerSettings(businessUnitId) {
89916
+ // verify the required parameter 'businessUnitId' is set
89917
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
89918
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulerSettings';
89919
+ }
89920
+
89921
+ return this.apiClient.callApi(
89922
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings',
89923
+ 'GET',
89924
+ { 'businessUnitId': businessUnitId },
89925
+ { },
89926
+ { },
89927
+ { },
89928
+ null,
89929
+ ['PureCloud OAuth'],
89930
+ ['application/json'],
89931
+ ['application/json']
89932
+ );
89933
+ }
89934
+
88119
89935
  /**
88120
89936
  * Get a scheduling run
88121
89937
  *
@@ -88453,6 +90269,35 @@ class WorkforceManagementApi {
88453
90269
  );
88454
90270
  }
88455
90271
 
90272
+ /**
90273
+ * Get users in the business unit
90274
+ *
90275
+ * @param {String} businessUnitId The ID of the business unit
90276
+ * @param {Object} opts Optional parameters
90277
+ * @param {Array.<String>} opts.managementUnitIds The IDs of the management units for which to retrieve users
90278
+ */
90279
+ getWorkforcemanagementBusinessunitUsers(businessUnitId, opts) {
90280
+ opts = opts || {};
90281
+
90282
+ // verify the required parameter 'businessUnitId' is set
90283
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
90284
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitUsers';
90285
+ }
90286
+
90287
+ return this.apiClient.callApi(
90288
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/users',
90289
+ 'GET',
90290
+ { 'businessUnitId': businessUnitId },
90291
+ { 'managementUnitIds': this.apiClient.buildCollectionParam(opts['managementUnitIds'], 'multi') },
90292
+ { },
90293
+ { },
90294
+ null,
90295
+ ['PureCloud OAuth'],
90296
+ ['application/json'],
90297
+ ['application/json']
90298
+ );
90299
+ }
90300
+
88456
90301
  /**
88457
90302
  * Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
88458
90303
  *
@@ -90690,6 +92535,36 @@ class WorkforceManagementApi {
90690
92535
  );
90691
92536
  }
90692
92537
 
92538
+ /**
92539
+ * Update minimum staffing settings for a business unit
92540
+ *
92541
+ * @param {String} businessUnitId The ID of the business unit
92542
+ * @param {Object} body body
92543
+ */
92544
+ patchWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId, body) {
92545
+ // verify the required parameter 'businessUnitId' is set
92546
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
92547
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';
92548
+ }
92549
+ // verify the required parameter 'body' is set
92550
+ if (body === undefined || body === null) {
92551
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';
92552
+ }
92553
+
92554
+ return this.apiClient.callApi(
92555
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings',
92556
+ 'PATCH',
92557
+ { 'businessUnitId': businessUnitId },
92558
+ { },
92559
+ { },
92560
+ { },
92561
+ body,
92562
+ ['PureCloud OAuth'],
92563
+ ['application/json'],
92564
+ ['application/json']
92565
+ );
92566
+ }
92567
+
90693
92568
  /**
90694
92569
  * Updates the planning group
90695
92570
  *
@@ -90725,6 +92600,36 @@ class WorkforceManagementApi {
90725
92600
  );
90726
92601
  }
90727
92602
 
92603
+ /**
92604
+ * Update scheduler settings for a business unit
92605
+ *
92606
+ * @param {String} businessUnitId The ID of the business unit
92607
+ * @param {Object} body body
92608
+ */
92609
+ patchWorkforcemanagementBusinessunitSchedulerSettings(businessUnitId, body) {
92610
+ // verify the required parameter 'businessUnitId' is set
92611
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
92612
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulerSettings';
92613
+ }
92614
+ // verify the required parameter 'body' is set
92615
+ if (body === undefined || body === null) {
92616
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulerSettings';
92617
+ }
92618
+
92619
+ return this.apiClient.callApi(
92620
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings',
92621
+ 'PATCH',
92622
+ { 'businessUnitId': businessUnitId },
92623
+ { },
92624
+ { },
92625
+ { },
92626
+ body,
92627
+ ['PureCloud OAuth'],
92628
+ ['application/json'],
92629
+ ['application/json']
92630
+ );
92631
+ }
92632
+
90728
92633
  /**
90729
92634
  * Mark a schedule run as applied
90730
92635
  *
@@ -94778,7 +96683,7 @@ class WorkforceManagementApi {
94778
96683
  * </pre>
94779
96684
  * </p>
94780
96685
  * @module purecloud-platform-client-v2/index
94781
- * @version 248.0.0
96686
+ * @version 249.0.0
94782
96687
  */
94783
96688
  class platformClient {
94784
96689
  constructor() {
@@ -94862,6 +96767,11 @@ class platformClient {
94862
96767
  * @property {module:purecloud-platform-client-v2/api/CarrierServicesApi}
94863
96768
  */
94864
96769
  this.CarrierServicesApi = CarrierServicesApi;
96770
+ /**
96771
+ * The CaseManagementApi service constructor.
96772
+ * @property {module:purecloud-platform-client-v2/api/CaseManagementApi}
96773
+ */
96774
+ this.CaseManagementApi = CaseManagementApi;
94865
96775
  /**
94866
96776
  * The ChatApi service constructor.
94867
96777
  * @property {module:purecloud-platform-client-v2/api/ChatApi}