purecloud-platform-client-v2 238.0.0 → 241.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 (94) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +855 -116
  3. package/dist/web-amd/purecloud-platform-client-v2.js +855 -116
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +298 -119
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +298 -119
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +563 -8
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +5 -1
  11. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +36 -1
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +156 -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 +135 -1
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -14
  20. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +273 -13
  27. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +30 -1
  32. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/JourneyApi.js +5 -5
  45. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/OutboundApi.js +3 -2
  61. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/RoutingApi.js +134 -1
  67. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +3 -2
  73. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  93. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  94. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -748,7 +748,7 @@ class Configuration {
748
748
 
749
749
  /**
750
750
  * @module purecloud-platform-client-v2/ApiClient
751
- * @version 238.0.0
751
+ * @version 241.0.0
752
752
  */
753
753
  class ApiClient {
754
754
  /**
@@ -1123,6 +1123,7 @@ class ApiClient {
1123
1123
  * @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
1124
1124
  * @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
1125
1125
  * @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
1126
+ * @param {string} opts.prompt - (optional) Use the prompt=login parameter to require that the user be prompted to enter credentials at the Gensys Cloud login screen and ignore any remembered sessions (auth cookies).
1126
1127
  */
1127
1128
  loginImplicitGrant(clientId, redirectUri, opts) {
1128
1129
  // Check for auth token in hash
@@ -1164,6 +1165,7 @@ class ApiClient {
1164
1165
  if (opts.state) query.state = encodeURIComponent(opts.state);
1165
1166
  if (opts.org) query.org = encodeURIComponent(opts.org);
1166
1167
  if (opts.provider) query.provider = encodeURIComponent(opts.provider);
1168
+ if (opts.prompt && opts.prompt == 'login') query.prompt = encodeURIComponent(opts.prompt);
1167
1169
 
1168
1170
  var url = this._buildAuthUrl('oauth/authorize', query);
1169
1171
  window.location.replace(url);
@@ -1490,6 +1492,7 @@ class ApiClient {
1490
1492
  * @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
1491
1493
  * @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
1492
1494
  * @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
1495
+ * @param {string} opts.prompt - (optional) Use the prompt=login parameter to require that the user be prompted to enter credentials at the Gensys Cloud login screen and ignore any remembered sessions (auth cookies).
1493
1496
  * @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
1494
1497
  */
1495
1498
  loginPKCEGrant(clientId, redirectUri, opts, codeVerifier) {
@@ -1594,6 +1597,7 @@ class ApiClient {
1594
1597
  if (opts.state) tokenQuery.state = encodeURIComponent(opts.state);
1595
1598
  if (opts.org) tokenQuery.org = encodeURIComponent(opts.org);
1596
1599
  if (opts.provider) tokenQuery.provider = encodeURIComponent(opts.provider);
1600
+ if (opts.prompt && opts.prompt == 'login') tokenQuery.prompt = encodeURIComponent(opts.prompt);
1597
1601
 
1598
1602
  var url = this._buildAuthUrl('oauth/authorize', tokenQuery);
1599
1603
  window.location.replace(url);
@@ -2361,7 +2365,7 @@ class AIStudioApi {
2361
2365
  /**
2362
2366
  * AIStudio service.
2363
2367
  * @module purecloud-platform-client-v2/api/AIStudioApi
2364
- * @version 238.0.0
2368
+ * @version 241.0.0
2365
2369
  */
2366
2370
 
2367
2371
  /**
@@ -2779,6 +2783,41 @@ class AIStudioApi {
2779
2783
  );
2780
2784
  }
2781
2785
 
2786
+ /**
2787
+ * Add a turn to a guide session.
2788
+ * Creates a new turn in the specified guide session with the provided request data. If the session ID doesnt exist, a new session will be created automatically.
2789
+ * @param {String} guideId Guide ID
2790
+ * @param {String} guideSessionId Guide Session ID
2791
+ * @param {Object} body
2792
+ */
2793
+ postGuideSessionTurns(guideId, guideSessionId, body) {
2794
+ // verify the required parameter 'guideId' is set
2795
+ if (guideId === undefined || guideId === null || guideId === '') {
2796
+ throw 'Missing the required parameter "guideId" when calling postGuideSessionTurns';
2797
+ }
2798
+ // verify the required parameter 'guideSessionId' is set
2799
+ if (guideSessionId === undefined || guideSessionId === null || guideSessionId === '') {
2800
+ throw 'Missing the required parameter "guideSessionId" when calling postGuideSessionTurns';
2801
+ }
2802
+ // verify the required parameter 'body' is set
2803
+ if (body === undefined || body === null) {
2804
+ throw 'Missing the required parameter "body" when calling postGuideSessionTurns';
2805
+ }
2806
+
2807
+ return this.apiClient.callApi(
2808
+ '/api/v2/guides/{guideId}/sessions/{guideSessionId}/turns',
2809
+ 'POST',
2810
+ { 'guideId': guideId,'guideSessionId': guideSessionId },
2811
+ { },
2812
+ { },
2813
+ { },
2814
+ body,
2815
+ ['PureCloud OAuth'],
2816
+ ['application/json'],
2817
+ ['application/json']
2818
+ );
2819
+ }
2820
+
2782
2821
  /**
2783
2822
  * Start the publishing of a guide version.
2784
2823
  *
@@ -2933,7 +2972,7 @@ class AgentAssistantsApi {
2933
2972
  /**
2934
2973
  * AgentAssistants service.
2935
2974
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
2936
- * @version 238.0.0
2975
+ * @version 241.0.0
2937
2976
  */
2938
2977
 
2939
2978
  /**
@@ -3032,6 +3071,31 @@ class AgentAssistantsApi {
3032
3071
  );
3033
3072
  }
3034
3073
 
3074
+ /**
3075
+ * Delete an agent checklist
3076
+ *
3077
+ * @param {String} agentChecklistId Agent Checklist ID
3078
+ */
3079
+ deleteAssistantsAgentchecklist(agentChecklistId) {
3080
+ // verify the required parameter 'agentChecklistId' is set
3081
+ if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
3082
+ throw 'Missing the required parameter "agentChecklistId" when calling deleteAssistantsAgentchecklist';
3083
+ }
3084
+
3085
+ return this.apiClient.callApi(
3086
+ '/api/v2/assistants/agentchecklists/{agentChecklistId}',
3087
+ 'DELETE',
3088
+ { 'agentChecklistId': agentChecklistId },
3089
+ { },
3090
+ { },
3091
+ { },
3092
+ null,
3093
+ ['PureCloud OAuth'],
3094
+ ['application/json'],
3095
+ ['application/json']
3096
+ );
3097
+ }
3098
+
3035
3099
  /**
3036
3100
  * Get an assistant.
3037
3101
  *
@@ -3156,6 +3220,81 @@ class AgentAssistantsApi {
3156
3220
  );
3157
3221
  }
3158
3222
 
3223
+ /**
3224
+ * Get an agent checklist
3225
+ *
3226
+ * @param {String} agentChecklistId Agent Checklist ID
3227
+ */
3228
+ getAssistantsAgentchecklist(agentChecklistId) {
3229
+ // verify the required parameter 'agentChecklistId' is set
3230
+ if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
3231
+ throw 'Missing the required parameter "agentChecklistId" when calling getAssistantsAgentchecklist';
3232
+ }
3233
+
3234
+ return this.apiClient.callApi(
3235
+ '/api/v2/assistants/agentchecklists/{agentChecklistId}',
3236
+ 'GET',
3237
+ { 'agentChecklistId': agentChecklistId },
3238
+ { },
3239
+ { },
3240
+ { },
3241
+ null,
3242
+ ['PureCloud OAuth'],
3243
+ ['application/json'],
3244
+ ['application/json']
3245
+ );
3246
+ }
3247
+
3248
+ /**
3249
+ * Get the list of agent checklists
3250
+ *
3251
+ * @param {Object} opts Optional parameters
3252
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
3253
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
3254
+ * @param {String} opts.pageSize The page size for the listing. The max that will be returned is 100. (default to 25)
3255
+ * @param {String} opts.namePrefix The agent checklist name prefix filter applied to the listing.
3256
+ * @param {String} opts.language The agent checklist language filter applied to the listing.
3257
+ * @param {Object} opts.sortOrder The sort order for the listing
3258
+ * @param {Object} opts.sortBy The field to sort by for the listing.
3259
+ */
3260
+ getAssistantsAgentchecklists(opts) {
3261
+ opts = opts || {};
3262
+
3263
+
3264
+ return this.apiClient.callApi(
3265
+ '/api/v2/assistants/agentchecklists',
3266
+ 'GET',
3267
+ { },
3268
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
3269
+ { },
3270
+ { },
3271
+ null,
3272
+ ['PureCloud OAuth'],
3273
+ ['application/json'],
3274
+ ['application/json']
3275
+ );
3276
+ }
3277
+
3278
+ /**
3279
+ * Get the list of supported languages
3280
+ *
3281
+ */
3282
+ getAssistantsAgentchecklistsLanguages() {
3283
+
3284
+ return this.apiClient.callApi(
3285
+ '/api/v2/assistants/agentchecklists/languages',
3286
+ 'GET',
3287
+ { },
3288
+ { },
3289
+ { },
3290
+ { },
3291
+ null,
3292
+ ['PureCloud OAuth'],
3293
+ ['application/json'],
3294
+ ['application/json']
3295
+ );
3296
+ }
3297
+
3159
3298
  /**
3160
3299
  * Get all queues assigned to any assistant.
3161
3300
  *
@@ -3378,6 +3517,31 @@ class AgentAssistantsApi {
3378
3517
  );
3379
3518
  }
3380
3519
 
3520
+ /**
3521
+ * Create an agent checklist
3522
+ *
3523
+ * @param {Object} body Request body containing details of checklist to be added
3524
+ */
3525
+ postAssistantsAgentchecklists(body) {
3526
+ // verify the required parameter 'body' is set
3527
+ if (body === undefined || body === null) {
3528
+ throw 'Missing the required parameter "body" when calling postAssistantsAgentchecklists';
3529
+ }
3530
+
3531
+ return this.apiClient.callApi(
3532
+ '/api/v2/assistants/agentchecklists',
3533
+ 'POST',
3534
+ { },
3535
+ { },
3536
+ { },
3537
+ { },
3538
+ body,
3539
+ ['PureCloud OAuth'],
3540
+ ['application/json'],
3541
+ ['application/json']
3542
+ );
3543
+ }
3544
+
3381
3545
  /**
3382
3546
  * Create a queue assistant association.
3383
3547
  *
@@ -3413,13 +3577,43 @@ class AgentAssistantsApi {
3413
3577
  );
3414
3578
  }
3415
3579
 
3580
+ /**
3581
+ * Update an agent checklist
3582
+ *
3583
+ * @param {String} agentChecklistId Agent Checklist ID
3584
+ * @param {Object} body Request body containing details of checklist to be updated
3585
+ */
3586
+ putAssistantsAgentchecklist(agentChecklistId, body) {
3587
+ // verify the required parameter 'agentChecklistId' is set
3588
+ if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
3589
+ throw 'Missing the required parameter "agentChecklistId" when calling putAssistantsAgentchecklist';
3590
+ }
3591
+ // verify the required parameter 'body' is set
3592
+ if (body === undefined || body === null) {
3593
+ throw 'Missing the required parameter "body" when calling putAssistantsAgentchecklist';
3594
+ }
3595
+
3596
+ return this.apiClient.callApi(
3597
+ '/api/v2/assistants/agentchecklists/{agentChecklistId}',
3598
+ 'PUT',
3599
+ { 'agentChecklistId': agentChecklistId },
3600
+ { },
3601
+ { },
3602
+ { },
3603
+ body,
3604
+ ['PureCloud OAuth'],
3605
+ ['application/json'],
3606
+ ['application/json']
3607
+ );
3608
+ }
3609
+
3416
3610
  }
3417
3611
 
3418
3612
  class AgentCopilotApi {
3419
3613
  /**
3420
3614
  * AgentCopilot service.
3421
3615
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
3422
- * @version 238.0.0
3616
+ * @version 241.0.0
3423
3617
  */
3424
3618
 
3425
3619
  /**
@@ -3519,7 +3713,7 @@ class AgentUIApi {
3519
3713
  /**
3520
3714
  * AgentUI service.
3521
3715
  * @module purecloud-platform-client-v2/api/AgentUIApi
3522
- * @version 238.0.0
3716
+ * @version 241.0.0
3523
3717
  */
3524
3718
 
3525
3719
  /**
@@ -3650,7 +3844,7 @@ class AlertingApi {
3650
3844
  /**
3651
3845
  * Alerting service.
3652
3846
  * @module purecloud-platform-client-v2/api/AlertingApi
3653
- * @version 238.0.0
3847
+ * @version 241.0.0
3654
3848
  */
3655
3849
 
3656
3850
  /**
@@ -4051,7 +4245,7 @@ class AnalyticsApi {
4051
4245
  /**
4052
4246
  * Analytics service.
4053
4247
  * @module purecloud-platform-client-v2/api/AnalyticsApi
4054
- * @version 238.0.0
4248
+ * @version 241.0.0
4055
4249
  */
4056
4250
 
4057
4251
  /**
@@ -4144,6 +4338,32 @@ class AnalyticsApi {
4144
4338
  );
4145
4339
  }
4146
4340
 
4341
+ /**
4342
+ * Delete/cancel an async request for case management aggregates
4343
+ *
4344
+ * @param {String} jobId jobId
4345
+ * deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4346
+ */
4347
+ deleteAnalyticsCasemanagementAggregatesJob(jobId) {
4348
+ // verify the required parameter 'jobId' is set
4349
+ if (jobId === undefined || jobId === null || jobId === '') {
4350
+ throw 'Missing the required parameter "jobId" when calling deleteAnalyticsCasemanagementAggregatesJob';
4351
+ }
4352
+
4353
+ return this.apiClient.callApi(
4354
+ '/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}',
4355
+ 'DELETE',
4356
+ { 'jobId': jobId },
4357
+ { },
4358
+ { },
4359
+ { },
4360
+ null,
4361
+ ['PureCloud OAuth'],
4362
+ ['application/json'],
4363
+ ['application/json']
4364
+ );
4365
+ }
4366
+
4147
4367
  /**
4148
4368
  * Delete/cancel an async request for conversation aggregates
4149
4369
  *
@@ -4803,6 +5023,62 @@ class AnalyticsApi {
4803
5023
  );
4804
5024
  }
4805
5025
 
5026
+ /**
5027
+ * Get status for async query for case management aggregates
5028
+ *
5029
+ * @param {String} jobId jobId
5030
+ * getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5031
+ */
5032
+ getAnalyticsCasemanagementAggregatesJob(jobId) {
5033
+ // verify the required parameter 'jobId' is set
5034
+ if (jobId === undefined || jobId === null || jobId === '') {
5035
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJob';
5036
+ }
5037
+
5038
+ return this.apiClient.callApi(
5039
+ '/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}',
5040
+ 'GET',
5041
+ { 'jobId': jobId },
5042
+ { },
5043
+ { },
5044
+ { },
5045
+ null,
5046
+ ['PureCloud OAuth'],
5047
+ ['application/json'],
5048
+ ['application/json']
5049
+ );
5050
+ }
5051
+
5052
+ /**
5053
+ * Fetch a page of results for an async case management query
5054
+ *
5055
+ * @param {String} jobId jobId
5056
+ * @param {Object} opts Optional parameters
5057
+ * @param {String} opts.cursor Cursor token to retrieve next page
5058
+ * getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5059
+ */
5060
+ getAnalyticsCasemanagementAggregatesJobResults(jobId, opts) {
5061
+ opts = opts || {};
5062
+
5063
+ // verify the required parameter 'jobId' is set
5064
+ if (jobId === undefined || jobId === null || jobId === '') {
5065
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJobResults';
5066
+ }
5067
+
5068
+ return this.apiClient.callApi(
5069
+ '/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results',
5070
+ 'GET',
5071
+ { 'jobId': jobId },
5072
+ { 'cursor': opts['cursor'] },
5073
+ { },
5074
+ { },
5075
+ null,
5076
+ ['PureCloud OAuth'],
5077
+ ['application/json'],
5078
+ ['application/json']
5079
+ );
5080
+ }
5081
+
4806
5082
  /**
4807
5083
  * Get a conversation by id
4808
5084
  *
@@ -6170,6 +6446,58 @@ class AnalyticsApi {
6170
6446
  );
6171
6447
  }
6172
6448
 
6449
+ /**
6450
+ * Query for case management aggregates asynchronously
6451
+ *
6452
+ * @param {Object} body query
6453
+ * postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6454
+ */
6455
+ postAnalyticsCasemanagementAggregatesJobs(body) {
6456
+ // verify the required parameter 'body' is set
6457
+ if (body === undefined || body === null) {
6458
+ throw 'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesJobs';
6459
+ }
6460
+
6461
+ return this.apiClient.callApi(
6462
+ '/api/v2/analytics/casemanagement/aggregates/jobs',
6463
+ 'POST',
6464
+ { },
6465
+ { },
6466
+ { },
6467
+ { },
6468
+ body,
6469
+ ['PureCloud OAuth'],
6470
+ ['application/json'],
6471
+ ['application/json']
6472
+ );
6473
+ }
6474
+
6475
+ /**
6476
+ * Query for case management aggregates
6477
+ *
6478
+ * @param {Object} body query
6479
+ * postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6480
+ */
6481
+ postAnalyticsCasemanagementAggregatesQuery(body) {
6482
+ // verify the required parameter 'body' is set
6483
+ if (body === undefined || body === null) {
6484
+ throw 'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesQuery';
6485
+ }
6486
+
6487
+ return this.apiClient.callApi(
6488
+ '/api/v2/analytics/casemanagement/aggregates/query',
6489
+ 'POST',
6490
+ { },
6491
+ { },
6492
+ { },
6493
+ { },
6494
+ body,
6495
+ ['PureCloud OAuth'],
6496
+ ['application/json'],
6497
+ ['application/json']
6498
+ );
6499
+ }
6500
+
6173
6501
  /**
6174
6502
  * Index conversation properties
6175
6503
  *
@@ -7319,7 +7647,7 @@ class ArchitectApi {
7319
7647
  /**
7320
7648
  * Architect service.
7321
7649
  * @module purecloud-platform-client-v2/api/ArchitectApi
7322
- * @version 238.0.0
7650
+ * @version 241.0.0
7323
7651
  */
7324
7652
 
7325
7653
  /**
@@ -11614,7 +11942,7 @@ class AuditApi {
11614
11942
  /**
11615
11943
  * Audit service.
11616
11944
  * @module purecloud-platform-client-v2/api/AuditApi
11617
- * @version 238.0.0
11945
+ * @version 241.0.0
11618
11946
  */
11619
11947
 
11620
11948
  /**
@@ -11815,7 +12143,7 @@ class AuthorizationApi {
11815
12143
  /**
11816
12144
  * Authorization service.
11817
12145
  * @module purecloud-platform-client-v2/api/AuthorizationApi
11818
- * @version 238.0.0
12146
+ * @version 241.0.0
11819
12147
  */
11820
12148
 
11821
12149
  /**
@@ -11864,7 +12192,6 @@ class AuthorizationApi {
11864
12192
  *
11865
12193
  * @param {String} targetName The domain:entity:action target to which the policy is applied
11866
12194
  * @param {String} subjectId The ID of the subject to which the policy is applied
11867
- * deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11868
12195
  */
11869
12196
  deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
11870
12197
  // verify the required parameter 'targetName' is set
@@ -12263,7 +12590,6 @@ class AuthorizationApi {
12263
12590
  * @param {Object} opts Optional parameters
12264
12591
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
12265
12592
  * @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
12266
- * getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12267
12593
  */
12268
12594
  getAuthorizationPolicies(opts) {
12269
12595
  opts = opts || {};
@@ -12290,7 +12616,6 @@ class AuthorizationApi {
12290
12616
  * @param {Object} opts Optional parameters
12291
12617
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
12292
12618
  * @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
12293
- * getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12294
12619
  */
12295
12620
  getAuthorizationPoliciesSubjectSubjectId(subjectId, opts) {
12296
12621
  opts = opts || {};
@@ -12321,7 +12646,6 @@ class AuthorizationApi {
12321
12646
  * @param {Object} opts Optional parameters
12322
12647
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
12323
12648
  * @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
12324
- * getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12325
12649
  */
12326
12650
  getAuthorizationPoliciesTarget(targetName, opts) {
12327
12651
  opts = opts || {};
@@ -12350,7 +12674,6 @@ class AuthorizationApi {
12350
12674
  *
12351
12675
  * @param {String} targetName The domain:entity:action resource target to which the policy is applied
12352
12676
  * @param {String} subjectId The ID of the subject to which the policy is applied
12353
- * getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12354
12677
  */
12355
12678
  getAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
12356
12679
  // verify the required parameter 'targetName' is set
@@ -12379,7 +12702,6 @@ class AuthorizationApi {
12379
12702
  /**
12380
12703
  * Get a map of policy targets to valid attributes for those targets
12381
12704
  *
12382
- * getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12383
12705
  */
12384
12706
  getAuthorizationPoliciesTargets() {
12385
12707
 
@@ -12401,7 +12723,6 @@ class AuthorizationApi {
12401
12723
  * Get an access control policy with the specified policy ID
12402
12724
  *
12403
12725
  * @param {String} policyId The ID of the policy to retrieve
12404
- * getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12405
12726
  */
12406
12727
  getAuthorizationPolicy(policyId) {
12407
12728
  // verify the required parameter 'policyId' is set
@@ -12427,7 +12748,6 @@ class AuthorizationApi {
12427
12748
  * Get the list of attributes used to evaluate an access control policy with the specified policy ID
12428
12749
  *
12429
12750
  * @param {String} policyId The ID of the policy to retrieve attributes
12430
- * getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12431
12751
  */
12432
12752
  getAuthorizationPolicyAttributes(policyId) {
12433
12753
  // verify the required parameter 'policyId' is set
@@ -12919,7 +13239,6 @@ class AuthorizationApi {
12919
13239
  *
12920
13240
  * @param {String} targetName The domain:entity:action target to which the policy will be applied
12921
13241
  * @param {Object} body Access control policy
12922
- * postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12923
13242
  */
12924
13243
  postAuthorizationPoliciesTarget(targetName, body) {
12925
13244
  // verify the required parameter 'targetName' is set
@@ -12950,7 +13269,6 @@ class AuthorizationApi {
12950
13269
  *
12951
13270
  * @param {String} targetName The domain:entity:action target to which the policy will be applied
12952
13271
  * @param {Object} body Access control policy
12953
- * postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12954
13272
  */
12955
13273
  postAuthorizationPoliciesTargetValidate(targetName, body) {
12956
13274
  // verify the required parameter 'targetName' is set
@@ -12981,7 +13299,6 @@ class AuthorizationApi {
12981
13299
  *
12982
13300
  * @param {String} policyId The ID of the policy to test the simulated data against
12983
13301
  * @param {Object} body A map of attribute names to type and simulated data value
12984
- * postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
12985
13302
  */
12986
13303
  postAuthorizationPolicySimulate(policyId, body) {
12987
13304
  // verify the required parameter 'policyId' is set
@@ -13297,7 +13614,6 @@ class AuthorizationApi {
13297
13614
  *
13298
13615
  * @param {String} targetName The domain:entity:action target to which the policy will be applied
13299
13616
  * @param {Object} body Access control policy
13300
- * putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13301
13617
  */
13302
13618
  putAuthorizationPoliciesTarget(targetName, body) {
13303
13619
  // verify the required parameter 'targetName' is set
@@ -13328,7 +13644,6 @@ class AuthorizationApi {
13328
13644
  *
13329
13645
  * @param {String} policyId The ID of the policy to update
13330
13646
  * @param {Object} body Access control policy
13331
- * putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13332
13647
  */
13333
13648
  putAuthorizationPolicy(policyId, body) {
13334
13649
  // verify the required parameter 'policyId' is set
@@ -13530,7 +13845,7 @@ class BillingApi {
13530
13845
  /**
13531
13846
  * Billing service.
13532
13847
  * @module purecloud-platform-client-v2/api/BillingApi
13533
- * @version 238.0.0
13848
+ * @version 241.0.0
13534
13849
  */
13535
13850
 
13536
13851
  /**
@@ -13786,7 +14101,7 @@ class BusinessRulesApi {
13786
14101
  /**
13787
14102
  * BusinessRules service.
13788
14103
  * @module purecloud-platform-client-v2/api/BusinessRulesApi
13789
- * @version 238.0.0
14104
+ * @version 241.0.0
13790
14105
  */
13791
14106
 
13792
14107
  /**
@@ -14673,7 +14988,7 @@ class CarrierServicesApi {
14673
14988
  /**
14674
14989
  * CarrierServices service.
14675
14990
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
14676
- * @version 238.0.0
14991
+ * @version 241.0.0
14677
14992
  */
14678
14993
 
14679
14994
  /**
@@ -14743,7 +15058,7 @@ class ChatApi {
14743
15058
  /**
14744
15059
  * Chat service.
14745
15060
  * @module purecloud-platform-client-v2/api/ChatApi
14746
- * @version 238.0.0
15061
+ * @version 241.0.0
14747
15062
  */
14748
15063
 
14749
15064
  /**
@@ -15724,7 +16039,7 @@ class CoachingApi {
15724
16039
  /**
15725
16040
  * Coaching service.
15726
16041
  * @module purecloud-platform-client-v2/api/CoachingApi
15727
- * @version 238.0.0
16042
+ * @version 241.0.0
15728
16043
  */
15729
16044
 
15730
16045
  /**
@@ -16351,7 +16666,7 @@ class ContentManagementApi {
16351
16666
  /**
16352
16667
  * ContentManagement service.
16353
16668
  * @module purecloud-platform-client-v2/api/ContentManagementApi
16354
- * @version 238.0.0
16669
+ * @version 241.0.0
16355
16670
  */
16356
16671
 
16357
16672
  /**
@@ -17432,7 +17747,7 @@ class ConversationsApi {
17432
17747
  /**
17433
17748
  * Conversations service.
17434
17749
  * @module purecloud-platform-client-v2/api/ConversationsApi
17435
- * @version 238.0.0
17750
+ * @version 241.0.0
17436
17751
  */
17437
17752
 
17438
17753
  /**
@@ -18098,6 +18413,111 @@ class ConversationsApi {
18098
18413
  );
18099
18414
  }
18100
18415
 
18416
+ /**
18417
+ * Get checklist info for a single checklist.
18418
+ *
18419
+ * @param {String} conversationId Conversation ID
18420
+ * @param {String} communicationId Communication ID
18421
+ * @param {String} agentChecklistId Agent Checklist ID
18422
+ */
18423
+ getConversationCommunicationAgentchecklist(conversationId, communicationId, agentChecklistId) {
18424
+ // verify the required parameter 'conversationId' is set
18425
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
18426
+ throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklist';
18427
+ }
18428
+ // verify the required parameter 'communicationId' is set
18429
+ if (communicationId === undefined || communicationId === null || communicationId === '') {
18430
+ throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklist';
18431
+ }
18432
+ // verify the required parameter 'agentChecklistId' is set
18433
+ if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
18434
+ throw 'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklist';
18435
+ }
18436
+
18437
+ return this.apiClient.callApi(
18438
+ '/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}',
18439
+ 'GET',
18440
+ { 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
18441
+ { },
18442
+ { },
18443
+ { },
18444
+ null,
18445
+ ['PureCloud OAuth'],
18446
+ ['application/json'],
18447
+ ['application/json']
18448
+ );
18449
+ }
18450
+
18451
+ /**
18452
+ * Get inference job status
18453
+ *
18454
+ * @param {String} conversationId Conversation ID
18455
+ * @param {String} communicationId Communication ID
18456
+ * @param {String} agentChecklistId Agent Checklist ID
18457
+ * @param {String} jobId Inference Job ID
18458
+ */
18459
+ getConversationCommunicationAgentchecklistJob(conversationId, communicationId, agentChecklistId, jobId) {
18460
+ // verify the required parameter 'conversationId' is set
18461
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
18462
+ throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklistJob';
18463
+ }
18464
+ // verify the required parameter 'communicationId' is set
18465
+ if (communicationId === undefined || communicationId === null || communicationId === '') {
18466
+ throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklistJob';
18467
+ }
18468
+ // verify the required parameter 'agentChecklistId' is set
18469
+ if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
18470
+ throw 'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklistJob';
18471
+ }
18472
+ // verify the required parameter 'jobId' is set
18473
+ if (jobId === undefined || jobId === null || jobId === '') {
18474
+ throw 'Missing the required parameter "jobId" when calling getConversationCommunicationAgentchecklistJob';
18475
+ }
18476
+
18477
+ return this.apiClient.callApi(
18478
+ '/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs/{jobId}',
18479
+ 'GET',
18480
+ { 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId,'jobId': jobId },
18481
+ { },
18482
+ { },
18483
+ { },
18484
+ null,
18485
+ ['PureCloud OAuth'],
18486
+ ['application/json'],
18487
+ ['application/json']
18488
+ );
18489
+ }
18490
+
18491
+ /**
18492
+ * Get information of all checklists associated with a conversation.
18493
+ *
18494
+ * @param {String} conversationId Conversation ID
18495
+ * @param {String} communicationId Communication ID
18496
+ */
18497
+ getConversationCommunicationAgentchecklists(conversationId, communicationId) {
18498
+ // verify the required parameter 'conversationId' is set
18499
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
18500
+ throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklists';
18501
+ }
18502
+ // verify the required parameter 'communicationId' is set
18503
+ if (communicationId === undefined || communicationId === null || communicationId === '') {
18504
+ throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklists';
18505
+ }
18506
+
18507
+ return this.apiClient.callApi(
18508
+ '/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists',
18509
+ 'GET',
18510
+ { 'conversationId': conversationId,'communicationId': communicationId },
18511
+ { },
18512
+ { },
18513
+ { },
18514
+ null,
18515
+ ['PureCloud OAuth'],
18516
+ ['application/json'],
18517
+ ['application/json']
18518
+ );
18519
+ }
18520
+
18101
18521
  /**
18102
18522
  * Get message
18103
18523
  *
@@ -22653,6 +23073,161 @@ class ConversationsApi {
22653
23073
  );
22654
23074
  }
22655
23075
 
23076
+ /**
23077
+ * Agent Checklist activation API
23078
+ *
23079
+ * @param {String} conversationId Conversation ID
23080
+ * @param {String} communicationId Communication ID
23081
+ * @param {String} agentChecklistId Agent Checklist ID
23082
+ * @param {Object} body Agent checklist activation payload
23083
+ */
23084
+ postConversationCommunicationAgentchecklist(conversationId, communicationId, agentChecklistId, body) {
23085
+ // verify the required parameter 'conversationId' is set
23086
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
23087
+ throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklist';
23088
+ }
23089
+ // verify the required parameter 'communicationId' is set
23090
+ if (communicationId === undefined || communicationId === null || communicationId === '') {
23091
+ throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklist';
23092
+ }
23093
+ // verify the required parameter 'agentChecklistId' is set
23094
+ if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
23095
+ throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklist';
23096
+ }
23097
+ // verify the required parameter 'body' is set
23098
+ if (body === undefined || body === null) {
23099
+ throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklist';
23100
+ }
23101
+
23102
+ return this.apiClient.callApi(
23103
+ '/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}',
23104
+ 'POST',
23105
+ { 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
23106
+ { },
23107
+ { },
23108
+ { },
23109
+ body,
23110
+ ['PureCloud OAuth'],
23111
+ ['application/json'],
23112
+ ['application/json']
23113
+ );
23114
+ }
23115
+
23116
+ /**
23117
+ * API invoked to capture an agent action.
23118
+ *
23119
+ * @param {String} conversationId Conversation ID
23120
+ * @param {String} communicationId Communication ID
23121
+ * @param {String} agentChecklistId Agent Checklist ID
23122
+ * @param {Object} body Agent action payload
23123
+ */
23124
+ postConversationCommunicationAgentchecklistAgentaction(conversationId, communicationId, agentChecklistId, body) {
23125
+ // verify the required parameter 'conversationId' is set
23126
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
23127
+ throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistAgentaction';
23128
+ }
23129
+ // verify the required parameter 'communicationId' is set
23130
+ if (communicationId === undefined || communicationId === null || communicationId === '') {
23131
+ throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistAgentaction';
23132
+ }
23133
+ // verify the required parameter 'agentChecklistId' is set
23134
+ if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
23135
+ throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistAgentaction';
23136
+ }
23137
+ // verify the required parameter 'body' is set
23138
+ if (body === undefined || body === null) {
23139
+ throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistAgentaction';
23140
+ }
23141
+
23142
+ return this.apiClient.callApi(
23143
+ '/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/agentaction',
23144
+ 'POST',
23145
+ { 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
23146
+ { },
23147
+ { },
23148
+ { },
23149
+ body,
23150
+ ['PureCloud OAuth'],
23151
+ ['application/json'],
23152
+ ['application/json']
23153
+ );
23154
+ }
23155
+
23156
+ /**
23157
+ * Create inference job
23158
+ *
23159
+ * @param {String} conversationId Conversation ID
23160
+ * @param {String} communicationId Communication ID
23161
+ * @param {String} agentChecklistId Agent Checklist ID
23162
+ * @param {Object} body Agent checklist inference job payload
23163
+ */
23164
+ postConversationCommunicationAgentchecklistJobs(conversationId, communicationId, agentChecklistId, body) {
23165
+ // verify the required parameter 'conversationId' is set
23166
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
23167
+ throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistJobs';
23168
+ }
23169
+ // verify the required parameter 'communicationId' is set
23170
+ if (communicationId === undefined || communicationId === null || communicationId === '') {
23171
+ throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistJobs';
23172
+ }
23173
+ // verify the required parameter 'agentChecklistId' is set
23174
+ if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
23175
+ throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistJobs';
23176
+ }
23177
+ // verify the required parameter 'body' is set
23178
+ if (body === undefined || body === null) {
23179
+ throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistJobs';
23180
+ }
23181
+
23182
+ return this.apiClient.callApi(
23183
+ '/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs',
23184
+ 'POST',
23185
+ { 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
23186
+ { },
23187
+ { },
23188
+ { },
23189
+ body,
23190
+ ['PureCloud OAuth'],
23191
+ ['application/json'],
23192
+ ['application/json']
23193
+ );
23194
+ }
23195
+
23196
+ /**
23197
+ * API invoked to finalize agent checklist evaluation.
23198
+ *
23199
+ * @param {String} conversationId Conversation ID
23200
+ * @param {String} communicationId Communication ID
23201
+ * @param {Object} body Agent checklist finalize payload
23202
+ */
23203
+ postConversationCommunicationAgentchecklistsFinalize(conversationId, communicationId, body) {
23204
+ // verify the required parameter 'conversationId' is set
23205
+ if (conversationId === undefined || conversationId === null || conversationId === '') {
23206
+ throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistsFinalize';
23207
+ }
23208
+ // verify the required parameter 'communicationId' is set
23209
+ if (communicationId === undefined || communicationId === null || communicationId === '') {
23210
+ throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistsFinalize';
23211
+ }
23212
+ // verify the required parameter 'body' is set
23213
+ if (body === undefined || body === null) {
23214
+ throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistsFinalize';
23215
+ }
23216
+
23217
+ return this.apiClient.callApi(
23218
+ '/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/finalize',
23219
+ 'POST',
23220
+ { 'conversationId': conversationId,'communicationId': communicationId },
23221
+ { },
23222
+ { },
23223
+ { },
23224
+ body,
23225
+ ['PureCloud OAuth'],
23226
+ ['application/json'],
23227
+ ['application/json']
23228
+ );
23229
+ }
23230
+
22656
23231
  /**
22657
23232
  * Send internal message
22658
23233
  * Send a new internal message for an existing communication.
@@ -22817,11 +23392,12 @@ class ConversationsApi {
22817
23392
  }
22818
23393
 
22819
23394
  /**
22820
- * Replace this participant with the specified user and/or address
22821
- *
23395
+ * Replace this participant (Deprecated)
23396
+ * This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
22822
23397
  * @param {String} conversationId conversation ID
22823
23398
  * @param {String} participantId participant ID
22824
23399
  * @param {Object} body Transfer request
23400
+ * @deprecated
22825
23401
  */
22826
23402
  postConversationParticipantReplace(conversationId, participantId, body) {
22827
23403
  // verify the required parameter 'conversationId' is set
@@ -22892,7 +23468,6 @@ class ConversationsApi {
22892
23468
  * @param {String} conversationId conversation ID
22893
23469
  * @param {String} participantId participant ID
22894
23470
  * @param {Object} body Transfer request
22895
- * postConversationParticipantReplaceContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22896
23471
  */
22897
23472
  postConversationParticipantReplaceContactExternal(conversationId, participantId, body) {
22898
23473
  // verify the required parameter 'conversationId' is set
@@ -22923,11 +23498,12 @@ class ConversationsApi {
22923
23498
  }
22924
23499
 
22925
23500
  /**
22926
- * Replace this participant with the an external contact
22927
- *
23501
+ * Replace this participant with the an external contact (Deprecated)
23502
+ * This endpoint is deprecated. Use /replace/contact/external endpoint instead.
22928
23503
  * @param {String} conversationId conversation ID
22929
23504
  * @param {String} participantId participant ID
22930
23505
  * @param {Object} body Transfer request
23506
+ * @deprecated
22931
23507
  */
22932
23508
  postConversationParticipantReplaceExternal(conversationId, participantId, body) {
22933
23509
  // verify the required parameter 'conversationId' is set
@@ -23032,7 +23608,6 @@ class ConversationsApi {
23032
23608
  * @param {String} conversationId conversation ID
23033
23609
  * @param {String} participantId participant ID
23034
23610
  * @param {Object} body Transfer request
23035
- * postConversationParticipantTransfer is a preview method and is subject to both breaking and non-breaking changes at any time without notice
23036
23611
  */
23037
23612
  postConversationParticipantTransfer(conversationId, participantId, body) {
23038
23613
  // verify the required parameter 'conversationId' is set
@@ -23292,11 +23867,12 @@ class ConversationsApi {
23292
23867
  }
23293
23868
 
23294
23869
  /**
23295
- * Initiate and update consult transfer
23296
- *
23870
+ * Initiate and update consult transfer (Deprecated)
23871
+ * This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
23297
23872
  * @param {String} conversationId conversationId
23298
23873
  * @param {String} participantId participantId
23299
23874
  * @param {Object} body Destination address and initial speak to
23875
+ * @deprecated
23300
23876
  */
23301
23877
  postConversationsCallParticipantConsult(conversationId, participantId, body) {
23302
23878
  // verify the required parameter 'conversationId' is set
@@ -23367,7 +23943,6 @@ class ConversationsApi {
23367
23943
  * @param {String} conversationId conversationId
23368
23944
  * @param {String} participantId participantId
23369
23945
  * @param {Object} body Destination address and initial speak to
23370
- * postConversationsCallParticipantConsultContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
23371
23946
  */
23372
23947
  postConversationsCallParticipantConsultContactExternal(conversationId, participantId, body) {
23373
23948
  // verify the required parameter 'conversationId' is set
@@ -23398,11 +23973,12 @@ class ConversationsApi {
23398
23973
  }
23399
23974
 
23400
23975
  /**
23401
- * Initiate a consult transfer to an external contact
23402
- *
23976
+ * Initiate a consult transfer to an external contact (Deprecated)
23977
+ * This endpoint is deprecated. Use /consult/contact/external endpoints instead.
23403
23978
  * @param {String} conversationId conversationId
23404
23979
  * @param {String} participantId participantId
23405
23980
  * @param {Object} body Destination address and initial speak to
23981
+ * @deprecated
23406
23982
  */
23407
23983
  postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
23408
23984
  // verify the required parameter 'conversationId' is set
@@ -23538,7 +24114,6 @@ class ConversationsApi {
23538
24114
  * @param {String} conversationId conversationId
23539
24115
  * @param {String} participantId participantId
23540
24116
  * @param {Object} body Destination address and initial speak to
23541
- * postConversationsCallParticipantVoiceConsult is a preview method and is subject to both breaking and non-breaking changes at any time without notice
23542
24117
  */
23543
24118
  postConversationsCallParticipantVoiceConsult(conversationId, participantId, body) {
23544
24119
  // verify the required parameter 'conversationId' is set
@@ -26057,7 +26632,7 @@ class DataExtensionsApi {
26057
26632
  /**
26058
26633
  * DataExtensions service.
26059
26634
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
26060
- * @version 238.0.0
26635
+ * @version 241.0.0
26061
26636
  */
26062
26637
 
26063
26638
  /**
@@ -26143,7 +26718,7 @@ class DataPrivacyApi {
26143
26718
  /**
26144
26719
  * DataPrivacy service.
26145
26720
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
26146
- * @version 238.0.0
26721
+ * @version 241.0.0
26147
26722
  */
26148
26723
 
26149
26724
  /**
@@ -26313,7 +26888,7 @@ class DownloadsApi {
26313
26888
  /**
26314
26889
  * Downloads service.
26315
26890
  * @module purecloud-platform-client-v2/api/DownloadsApi
26316
- * @version 238.0.0
26891
+ * @version 241.0.0
26317
26892
  */
26318
26893
 
26319
26894
  /**
@@ -26365,7 +26940,7 @@ class EmailsApi {
26365
26940
  /**
26366
26941
  * Emails service.
26367
26942
  * @module purecloud-platform-client-v2/api/EmailsApi
26368
- * @version 238.0.0
26943
+ * @version 241.0.0
26369
26944
  */
26370
26945
 
26371
26946
  /**
@@ -26494,7 +27069,7 @@ class EmployeeEngagementApi {
26494
27069
  /**
26495
27070
  * EmployeeEngagement service.
26496
27071
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
26497
- * @version 238.0.0
27072
+ * @version 241.0.0
26498
27073
  */
26499
27074
 
26500
27075
  /**
@@ -26584,6 +27159,35 @@ class EmployeeEngagementApi {
26584
27159
  );
26585
27160
  }
26586
27161
 
27162
+ /**
27163
+ * Gets sent recognitions
27164
+ *
27165
+ * @param {Object} opts Optional parameters
27166
+ * @param {Object} opts.direction The direction of the recognitions. (default to received)
27167
+ * @param {String} opts.recipient The ID of the recipient (when direction is sent).
27168
+ * @param {Date} opts.dateStart The start date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
27169
+ * @param {Date} opts.dateEnd The end date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
27170
+ * @param {Number} opts.pageSize Page size (default to 100)
27171
+ * @param {Number} opts.pageNumber Page number (default to 1)
27172
+ */
27173
+ getEmployeeengagementRecognitions(opts) {
27174
+ opts = opts || {};
27175
+
27176
+
27177
+ return this.apiClient.callApi(
27178
+ '/api/v2/employeeengagement/recognitions',
27179
+ 'GET',
27180
+ { },
27181
+ { 'direction': opts['direction'],'recipient': opts['recipient'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
27182
+ { },
27183
+ { },
27184
+ null,
27185
+ ['PureCloud OAuth'],
27186
+ ['application/json'],
27187
+ ['application/json']
27188
+ );
27189
+ }
27190
+
26587
27191
  /**
26588
27192
  * Set a state for a celebration
26589
27193
  *
@@ -26645,7 +27249,7 @@ class EventsApi {
26645
27249
  /**
26646
27250
  * Events service.
26647
27251
  * @module purecloud-platform-client-v2/api/EventsApi
26648
- * @version 238.0.0
27252
+ * @version 241.0.0
26649
27253
  */
26650
27254
 
26651
27255
  /**
@@ -26741,7 +27345,7 @@ class ExternalContactsApi {
26741
27345
  /**
26742
27346
  * ExternalContacts service.
26743
27347
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
26744
- * @version 238.0.0
27348
+ * @version 241.0.0
26745
27349
  */
26746
27350
 
26747
27351
  /**
@@ -29988,7 +30592,7 @@ class FaxApi {
29988
30592
  /**
29989
30593
  * Fax service.
29990
30594
  * @module purecloud-platform-client-v2/api/FaxApi
29991
- * @version 238.0.0
30595
+ * @version 241.0.0
29992
30596
  */
29993
30597
 
29994
30598
  /**
@@ -30203,7 +30807,7 @@ class FlowsApi {
30203
30807
  /**
30204
30808
  * Flows service.
30205
30809
  * @module purecloud-platform-client-v2/api/FlowsApi
30206
- * @version 238.0.0
30810
+ * @version 241.0.0
30207
30811
  */
30208
30812
 
30209
30813
  /**
@@ -30412,7 +31016,7 @@ class GamificationApi {
30412
31016
  /**
30413
31017
  * Gamification service.
30414
31018
  * @module purecloud-platform-client-v2/api/GamificationApi
30415
- * @version 238.0.0
31019
+ * @version 241.0.0
30416
31020
  */
30417
31021
 
30418
31022
  /**
@@ -32970,7 +33574,7 @@ class GeneralDataProtectionRegulationApi {
32970
33574
  /**
32971
33575
  * GeneralDataProtectionRegulation service.
32972
33576
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
32973
- * @version 238.0.0
33577
+ * @version 241.0.0
32974
33578
  */
32975
33579
 
32976
33580
  /**
@@ -33100,7 +33704,7 @@ class GeolocationApi {
33100
33704
  /**
33101
33705
  * Geolocation service.
33102
33706
  * @module purecloud-platform-client-v2/api/GeolocationApi
33103
- * @version 238.0.0
33707
+ * @version 241.0.0
33104
33708
  */
33105
33709
 
33106
33710
  /**
@@ -33231,7 +33835,7 @@ class GreetingsApi {
33231
33835
  /**
33232
33836
  * Greetings service.
33233
33837
  * @module purecloud-platform-client-v2/api/GreetingsApi
33234
- * @version 238.0.0
33838
+ * @version 241.0.0
33235
33839
  */
33236
33840
 
33237
33841
  /**
@@ -33773,7 +34377,7 @@ class GroupsApi {
33773
34377
  /**
33774
34378
  * Groups service.
33775
34379
  * @module purecloud-platform-client-v2/api/GroupsApi
33776
- * @version 238.0.0
34380
+ * @version 241.0.0
33777
34381
  */
33778
34382
 
33779
34383
  /**
@@ -34292,7 +34896,7 @@ class IdentityProviderApi {
34292
34896
  /**
34293
34897
  * IdentityProvider service.
34294
34898
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
34295
- * @version 238.0.0
34899
+ * @version 241.0.0
34296
34900
  */
34297
34901
 
34298
34902
  /**
@@ -35153,7 +35757,7 @@ class InfrastructureAsCodeApi {
35153
35757
  /**
35154
35758
  * InfrastructureAsCode service.
35155
35759
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
35156
- * @version 238.0.0
35760
+ * @version 241.0.0
35157
35761
  */
35158
35762
 
35159
35763
  /**
@@ -35320,7 +35924,7 @@ class IntegrationsApi {
35320
35924
  /**
35321
35925
  * Integrations service.
35322
35926
  * @module purecloud-platform-client-v2/api/IntegrationsApi
35323
- * @version 238.0.0
35927
+ * @version 241.0.0
35324
35928
  */
35325
35929
 
35326
35930
  /**
@@ -37968,7 +38572,7 @@ class JourneyApi {
37968
38572
  /**
37969
38573
  * Journey service.
37970
38574
  * @module purecloud-platform-client-v2/api/JourneyApi
37971
- * @version 238.0.0
38575
+ * @version 241.0.0
37972
38576
  */
37973
38577
 
37974
38578
  /**
@@ -38341,7 +38945,7 @@ class JourneyApi {
38341
38945
  * @param {String} opts.filterValue Value to filter by. Requires 'filterValue' to also be set.
38342
38946
  * @param {Array.<String>} opts.actionMapIds IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.
38343
38947
  * @param {Array.<String>} opts.queryFields Action Map field(s) to query on. Requires 'queryValue' to also be set.
38344
- * @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
38948
+ * @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
38345
38949
  */
38346
38950
  getJourneyActionmaps(opts) {
38347
38951
  opts = opts || {};
@@ -38496,7 +39100,7 @@ class JourneyApi {
38496
39100
  * @param {Object} opts.mediaType Media type
38497
39101
  * @param {Object} opts.state Action template state.
38498
39102
  * @param {Array.<String>} opts.queryFields ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.
38499
- * @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
39103
+ * @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
38500
39104
  */
38501
39105
  getJourneyActiontemplates(opts) {
38502
39106
  opts = opts || {};
@@ -38588,7 +39192,7 @@ class JourneyApi {
38588
39192
  * @param {String} opts.sortBy Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
38589
39193
  * @param {Array.<String>} opts.outcomeIds IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.
38590
39194
  * @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
38591
- * @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
39195
+ * @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
38592
39196
  */
38593
39197
  getJourneyOutcomes(opts) {
38594
39198
  opts = opts || {};
@@ -38740,7 +39344,7 @@ class JourneyApi {
38740
39344
  * @param {Boolean} opts.isActive Determines whether or not to show only active segments.
38741
39345
  * @param {Array.<String>} opts.segmentIds IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.
38742
39346
  * @param {Array.<String>} opts.queryFields Segment field(s) to query on. Requires 'queryValue' to also be set.
38743
- * @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
39347
+ * @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
38744
39348
  */
38745
39349
  getJourneySegments(opts) {
38746
39350
  opts = opts || {};
@@ -40065,7 +40669,7 @@ class KnowledgeApi {
40065
40669
  /**
40066
40670
  * Knowledge service.
40067
40671
  * @module purecloud-platform-client-v2/api/KnowledgeApi
40068
- * @version 238.0.0
40672
+ * @version 241.0.0
40069
40673
  */
40070
40674
 
40071
40675
  /**
@@ -43148,7 +43752,7 @@ class LanguageUnderstandingApi {
43148
43752
  /**
43149
43753
  * LanguageUnderstanding service.
43150
43754
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
43151
- * @version 238.0.0
43755
+ * @version 241.0.0
43152
43756
  */
43153
43757
 
43154
43758
  /**
@@ -44367,7 +44971,7 @@ class LanguagesApi {
44367
44971
  /**
44368
44972
  * Languages service.
44369
44973
  * @module purecloud-platform-client-v2/api/LanguagesApi
44370
- * @version 238.0.0
44974
+ * @version 241.0.0
44371
44975
  */
44372
44976
 
44373
44977
  /**
@@ -44589,7 +45193,7 @@ class LearningApi {
44589
45193
  /**
44590
45194
  * Learning service.
44591
45195
  * @module purecloud-platform-client-v2/api/LearningApi
44592
- * @version 238.0.0
45196
+ * @version 241.0.0
44593
45197
  */
44594
45198
 
44595
45199
  /**
@@ -45698,7 +46302,7 @@ class LicenseApi {
45698
46302
  /**
45699
46303
  * License service.
45700
46304
  * @module purecloud-platform-client-v2/api/LicenseApi
45701
- * @version 238.0.0
46305
+ * @version 241.0.0
45702
46306
  */
45703
46307
 
45704
46308
  /**
@@ -45936,7 +46540,7 @@ class LocationsApi {
45936
46540
  /**
45937
46541
  * Locations service.
45938
46542
  * @module purecloud-platform-client-v2/api/LocationsApi
45939
- * @version 238.0.0
46543
+ * @version 241.0.0
45940
46544
  */
45941
46545
 
45942
46546
  /**
@@ -46172,7 +46776,7 @@ class LogCaptureApi {
46172
46776
  /**
46173
46777
  * LogCapture service.
46174
46778
  * @module purecloud-platform-client-v2/api/LogCaptureApi
46175
- * @version 238.0.0
46779
+ * @version 241.0.0
46176
46780
  */
46177
46781
 
46178
46782
  /**
@@ -46371,7 +46975,7 @@ class MessagingApi {
46371
46975
  /**
46372
46976
  * Messaging service.
46373
46977
  * @module purecloud-platform-client-v2/api/MessagingApi
46374
- * @version 238.0.0
46978
+ * @version 241.0.0
46375
46979
  */
46376
46980
 
46377
46981
  /**
@@ -46730,7 +47334,7 @@ class MobileDevicesApi {
46730
47334
  /**
46731
47335
  * MobileDevices service.
46732
47336
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
46733
- * @version 238.0.0
47337
+ * @version 241.0.0
46734
47338
  */
46735
47339
 
46736
47340
  /**
@@ -46881,7 +47485,7 @@ class NotificationsApi {
46881
47485
  /**
46882
47486
  * Notifications service.
46883
47487
  * @module purecloud-platform-client-v2/api/NotificationsApi
46884
- * @version 238.0.0
47488
+ * @version 241.0.0
46885
47489
  */
46886
47490
 
46887
47491
  /**
@@ -47114,7 +47718,7 @@ class OAuthApi {
47114
47718
  /**
47115
47719
  * OAuth service.
47116
47720
  * @module purecloud-platform-client-v2/api/OAuthApi
47117
- * @version 238.0.0
47721
+ * @version 241.0.0
47118
47722
  */
47119
47723
 
47120
47724
  /**
@@ -47480,7 +48084,7 @@ class ObjectsApi {
47480
48084
  /**
47481
48085
  * Objects service.
47482
48086
  * @module purecloud-platform-client-v2/api/ObjectsApi
47483
- * @version 238.0.0
48087
+ * @version 241.0.0
47484
48088
  */
47485
48089
 
47486
48090
  /**
@@ -47804,7 +48408,7 @@ class OperationalEventsApi {
47804
48408
  /**
47805
48409
  * OperationalEvents service.
47806
48410
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
47807
- * @version 238.0.0
48411
+ * @version 241.0.0
47808
48412
  */
47809
48413
 
47810
48414
  /**
@@ -47921,7 +48525,7 @@ class OrganizationApi {
47921
48525
  /**
47922
48526
  * Organization service.
47923
48527
  * @module purecloud-platform-client-v2/api/OrganizationApi
47924
- * @version 238.0.0
48528
+ * @version 241.0.0
47925
48529
  */
47926
48530
 
47927
48531
  /**
@@ -48396,7 +49000,7 @@ class OrganizationAuthorizationApi {
48396
49000
  /**
48397
49001
  * OrganizationAuthorization service.
48398
49002
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
48399
- * @version 238.0.0
49003
+ * @version 241.0.0
48400
49004
  */
48401
49005
 
48402
49006
  /**
@@ -49790,7 +50394,7 @@ class OutboundApi {
49790
50394
  /**
49791
50395
  * Outbound service.
49792
50396
  * @module purecloud-platform-client-v2/api/OutboundApi
49793
- * @version 238.0.0
50397
+ * @version 241.0.0
49794
50398
  */
49795
50399
 
49796
50400
  /**
@@ -52143,6 +52747,7 @@ class OutboundApi {
52143
52747
  * @param {Array.<String>} opts.id A list of messaging campaign ids to bulk fetch
52144
52748
  * @param {String} opts.contentTemplateId Content template ID
52145
52749
  * @param {Object} opts.campaignStatus Campaign Status
52750
+ * @param {Array.<String>} opts.ruleSetIds Ruleset ID(s)
52146
52751
  */
52147
52752
  getOutboundMessagingcampaigns(opts) {
52148
52753
  opts = opts || {};
@@ -52152,7 +52757,7 @@ class OutboundApi {
52152
52757
  '/api/v2/outbound/messagingcampaigns',
52153
52758
  'GET',
52154
52759
  { },
52155
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'contactListId': opts['contactListId'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'type': opts['type'],'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'contentTemplateId': opts['contentTemplateId'],'campaignStatus': opts['campaignStatus'] },
52760
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'contactListId': opts['contactListId'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'type': opts['type'],'senderSmsPhoneNumber': opts['senderSmsPhoneNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'contentTemplateId': opts['contentTemplateId'],'campaignStatus': opts['campaignStatus'],'ruleSetIds': this.apiClient.buildCollectionParam(opts['ruleSetIds'], 'multi') },
52156
52761
  { },
52157
52762
  { },
52158
52763
  null,
@@ -54537,7 +55142,7 @@ class PresenceApi {
54537
55142
  /**
54538
55143
  * Presence service.
54539
55144
  * @module purecloud-platform-client-v2/api/PresenceApi
54540
- * @version 238.0.0
55145
+ * @version 241.0.0
54541
55146
  */
54542
55147
 
54543
55148
  /**
@@ -55281,7 +55886,7 @@ class ProcessAutomationApi {
55281
55886
  /**
55282
55887
  * ProcessAutomation service.
55283
55888
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
55284
- * @version 238.0.0
55889
+ * @version 241.0.0
55285
55890
  */
55286
55891
 
55287
55892
  /**
@@ -55520,7 +56125,7 @@ class QualityApi {
55520
56125
  /**
55521
56126
  * Quality service.
55522
56127
  * @module purecloud-platform-client-v2/api/QualityApi
55523
- * @version 238.0.0
56128
+ * @version 241.0.0
55524
56129
  */
55525
56130
 
55526
56131
  /**
@@ -57359,7 +57964,7 @@ class RecordingApi {
57359
57964
  /**
57360
57965
  * Recording service.
57361
57966
  * @module purecloud-platform-client-v2/api/RecordingApi
57362
- * @version 238.0.0
57967
+ * @version 241.0.0
57363
57968
  */
57364
57969
 
57365
57970
  /**
@@ -58964,7 +59569,7 @@ class ResponseManagementApi {
58964
59569
  /**
58965
59570
  * ResponseManagement service.
58966
59571
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
58967
- * @version 238.0.0
59572
+ * @version 241.0.0
58968
59573
  */
58969
59574
 
58970
59575
  /**
@@ -59474,7 +60079,7 @@ class RoutingApi {
59474
60079
  /**
59475
60080
  * Routing service.
59476
60081
  * @module purecloud-platform-client-v2/api/RoutingApi
59477
- * @version 238.0.0
60082
+ * @version 241.0.0
59478
60083
  */
59479
60084
 
59480
60085
  /**
@@ -59664,6 +60269,32 @@ class RoutingApi {
59664
60269
  );
59665
60270
  }
59666
60271
 
60272
+ /**
60273
+ * Delete a custom Key Performance Indicator.
60274
+ *
60275
+ * @param {String} kpiId Key Performance Indicator ID
60276
+ * deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
60277
+ */
60278
+ deleteRoutingPredictorsKeyperformanceindicator(kpiId) {
60279
+ // verify the required parameter 'kpiId' is set
60280
+ if (kpiId === undefined || kpiId === null || kpiId === '') {
60281
+ throw 'Missing the required parameter "kpiId" when calling deleteRoutingPredictorsKeyperformanceindicator';
60282
+ }
60283
+
60284
+ return this.apiClient.callApi(
60285
+ '/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
60286
+ 'DELETE',
60287
+ { 'kpiId': kpiId },
60288
+ { },
60289
+ { },
60290
+ { },
60291
+ null,
60292
+ ['PureCloud OAuth'],
60293
+ ['application/json'],
60294
+ ['application/json']
60295
+ );
60296
+ }
60297
+
59667
60298
  /**
59668
60299
  * Delete a queue
59669
60300
  *
@@ -60804,6 +61435,36 @@ class RoutingApi {
60804
61435
  );
60805
61436
  }
60806
61437
 
61438
+ /**
61439
+ * Retrieve a single Key Performance Indicator.
61440
+ *
61441
+ * @param {String} kpiId Key Performance Indicator ID
61442
+ * @param {Object} opts Optional parameters
61443
+ * @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
61444
+ * getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61445
+ */
61446
+ getRoutingPredictorsKeyperformanceindicator(kpiId, opts) {
61447
+ opts = opts || {};
61448
+
61449
+ // verify the required parameter 'kpiId' is set
61450
+ if (kpiId === undefined || kpiId === null || kpiId === '') {
61451
+ throw 'Missing the required parameter "kpiId" when calling getRoutingPredictorsKeyperformanceindicator';
61452
+ }
61453
+
61454
+ return this.apiClient.callApi(
61455
+ '/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
61456
+ 'GET',
61457
+ { 'kpiId': kpiId },
61458
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
61459
+ { },
61460
+ { },
61461
+ null,
61462
+ ['PureCloud OAuth'],
61463
+ ['application/json'],
61464
+ ['application/json']
61465
+ );
61466
+ }
61467
+
60807
61468
  /**
60808
61469
  * Get a list of Key Performance Indicators
60809
61470
  *
@@ -60829,6 +61490,27 @@ class RoutingApi {
60829
61490
  );
60830
61491
  }
60831
61492
 
61493
+ /**
61494
+ * Get a list of Key Performance Indicators Types available.
61495
+ *
61496
+ * getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
61497
+ */
61498
+ getRoutingPredictorsKeyperformanceindicatortypes() {
61499
+
61500
+ return this.apiClient.callApi(
61501
+ '/api/v2/routing/predictors/keyperformanceindicatortypes',
61502
+ 'GET',
61503
+ { },
61504
+ { },
61505
+ { },
61506
+ { },
61507
+ null,
61508
+ ['PureCloud OAuth'],
61509
+ ['application/json'],
61510
+ ['application/json']
61511
+ );
61512
+ }
61513
+
60832
61514
  /**
60833
61515
  * Get details about this queue.
60834
61516
  *
@@ -62239,6 +62921,36 @@ class RoutingApi {
62239
62921
  );
62240
62922
  }
62241
62923
 
62924
+ /**
62925
+ * Update a custom Key Performance Indicator.
62926
+ *
62927
+ * @param {String} kpiId Key Performance Indicator ID
62928
+ * @param {Object} opts Optional parameters
62929
+ * @param {Object} opts.body
62930
+ * patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
62931
+ */
62932
+ patchRoutingPredictorsKeyperformanceindicator(kpiId, opts) {
62933
+ opts = opts || {};
62934
+
62935
+ // verify the required parameter 'kpiId' is set
62936
+ if (kpiId === undefined || kpiId === null || kpiId === '') {
62937
+ throw 'Missing the required parameter "kpiId" when calling patchRoutingPredictorsKeyperformanceindicator';
62938
+ }
62939
+
62940
+ return this.apiClient.callApi(
62941
+ '/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
62942
+ 'PATCH',
62943
+ { 'kpiId': kpiId },
62944
+ { },
62945
+ { },
62946
+ { },
62947
+ opts['body'],
62948
+ ['PureCloud OAuth'],
62949
+ ['application/json'],
62950
+ ['application/json']
62951
+ );
62952
+ }
62953
+
62242
62954
  /**
62243
62955
  * Update the ring number OR joined status for a queue member.
62244
62956
  *
@@ -63011,6 +63723,32 @@ class RoutingApi {
63011
63723
  );
63012
63724
  }
63013
63725
 
63726
+ /**
63727
+ * Create a custom Key Performance Indicator.
63728
+ *
63729
+ * @param {Object} body request
63730
+ * postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice
63731
+ */
63732
+ postRoutingPredictorsKeyperformanceindicators(body) {
63733
+ // verify the required parameter 'body' is set
63734
+ if (body === undefined || body === null) {
63735
+ throw 'Missing the required parameter "body" when calling postRoutingPredictorsKeyperformanceindicators';
63736
+ }
63737
+
63738
+ return this.apiClient.callApi(
63739
+ '/api/v2/routing/predictors/keyperformanceindicators',
63740
+ 'POST',
63741
+ { },
63742
+ { },
63743
+ { },
63744
+ { },
63745
+ body,
63746
+ ['PureCloud OAuth'],
63747
+ ['application/json'],
63748
+ ['application/json']
63749
+ );
63750
+ }
63751
+
63014
63752
  /**
63015
63753
  * Bulk add or delete up to 100 queue members
63016
63754
  *
@@ -63957,7 +64695,7 @@ class SCIMApi {
63957
64695
  /**
63958
64696
  * SCIM service.
63959
64697
  * @module purecloud-platform-client-v2/api/SCIMApi
63960
- * @version 238.0.0
64698
+ * @version 241.0.0
63961
64699
  */
63962
64700
 
63963
64701
  /**
@@ -64834,7 +65572,7 @@ class ScreenRecordingApi {
64834
65572
  /**
64835
65573
  * ScreenRecording service.
64836
65574
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
64837
- * @version 238.0.0
65575
+ * @version 241.0.0
64838
65576
  */
64839
65577
 
64840
65578
  /**
@@ -64879,7 +65617,7 @@ class ScriptsApi {
64879
65617
  /**
64880
65618
  * Scripts service.
64881
65619
  * @module purecloud-platform-client-v2/api/ScriptsApi
64882
- * @version 238.0.0
65620
+ * @version 241.0.0
64883
65621
  */
64884
65622
 
64885
65623
  /**
@@ -65355,7 +66093,7 @@ class SearchApi {
65355
66093
  /**
65356
66094
  * Search service.
65357
66095
  * @module purecloud-platform-client-v2/api/SearchApi
65358
- * @version 238.0.0
66096
+ * @version 241.0.0
65359
66097
  */
65360
66098
 
65361
66099
  /**
@@ -66043,7 +66781,7 @@ class SettingsApi {
66043
66781
  /**
66044
66782
  * Settings service.
66045
66783
  * @module purecloud-platform-client-v2/api/SettingsApi
66046
- * @version 238.0.0
66784
+ * @version 241.0.0
66047
66785
  */
66048
66786
 
66049
66787
  /**
@@ -66391,7 +67129,7 @@ class SocialMediaApi {
66391
67129
  /**
66392
67130
  * SocialMedia service.
66393
67131
  * @module purecloud-platform-client-v2/api/SocialMediaApi
66394
- * @version 238.0.0
67132
+ * @version 241.0.0
66395
67133
  */
66396
67134
 
66397
67135
  /**
@@ -67293,6 +68031,7 @@ class SocialMediaApi {
67293
68031
  * @param {Number} opts.pageSize Page size (default to 25)
67294
68032
  * @param {Array.<String>} opts.divisionIds One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
67295
68033
  * @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
68034
+ * @param {String} opts.name Search for topic by name that contains the given search string, search is case insensitive
67296
68035
  */
67297
68036
  getSocialmediaTopics(opts) {
67298
68037
  opts = opts || {};
@@ -67302,7 +68041,7 @@ class SocialMediaApi {
67302
68041
  '/api/v2/socialmedia/topics',
67303
68042
  'GET',
67304
68043
  { },
67305
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'] },
68044
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'],'name': opts['name'] },
67306
68045
  { },
67307
68046
  { },
67308
68047
  null,
@@ -67986,7 +68725,7 @@ class SpeechTextAnalyticsApi {
67986
68725
  /**
67987
68726
  * SpeechTextAnalytics service.
67988
68727
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
67989
- * @version 238.0.0
68728
+ * @version 241.0.0
67990
68729
  */
67991
68730
 
67992
68731
  /**
@@ -69633,7 +70372,7 @@ class StationsApi {
69633
70372
  /**
69634
70373
  * Stations service.
69635
70374
  * @module purecloud-platform-client-v2/api/StationsApi
69636
- * @version 238.0.0
70375
+ * @version 241.0.0
69637
70376
  */
69638
70377
 
69639
70378
  /**
@@ -69735,7 +70474,7 @@ class SuggestApi {
69735
70474
  /**
69736
70475
  * Suggest service.
69737
70476
  * @module purecloud-platform-client-v2/api/SuggestApi
69738
- * @version 238.0.0
70477
+ * @version 241.0.0
69739
70478
  */
69740
70479
 
69741
70480
  /**
@@ -69874,7 +70613,7 @@ class TaskManagementApi {
69874
70613
  /**
69875
70614
  * TaskManagement service.
69876
70615
  * @module purecloud-platform-client-v2/api/TaskManagementApi
69877
- * @version 238.0.0
70616
+ * @version 241.0.0
69878
70617
  */
69879
70618
 
69880
70619
  /**
@@ -72036,7 +72775,7 @@ class TeamsApi {
72036
72775
  /**
72037
72776
  * Teams service.
72038
72777
  * @module purecloud-platform-client-v2/api/TeamsApi
72039
- * @version 238.0.0
72778
+ * @version 241.0.0
72040
72779
  */
72041
72780
 
72042
72781
  /**
@@ -72341,7 +73080,7 @@ class TelephonyApi {
72341
73080
  /**
72342
73081
  * Telephony service.
72343
73082
  * @module purecloud-platform-client-v2/api/TelephonyApi
72344
- * @version 238.0.0
73083
+ * @version 241.0.0
72345
73084
  */
72346
73085
 
72347
73086
  /**
@@ -72627,7 +73366,7 @@ class TelephonyProvidersEdgeApi {
72627
73366
  /**
72628
73367
  * TelephonyProvidersEdge service.
72629
73368
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
72630
- * @version 238.0.0
73369
+ * @version 241.0.0
72631
73370
  */
72632
73371
 
72633
73372
  /**
@@ -76120,7 +76859,7 @@ class TextbotsApi {
76120
76859
  /**
76121
76860
  * Textbots service.
76122
76861
  * @module purecloud-platform-client-v2/api/TextbotsApi
76123
- * @version 238.0.0
76862
+ * @version 241.0.0
76124
76863
  */
76125
76864
 
76126
76865
  /**
@@ -76249,7 +76988,7 @@ class TokensApi {
76249
76988
  /**
76250
76989
  * Tokens service.
76251
76990
  * @module purecloud-platform-client-v2/api/TokensApi
76252
- * @version 238.0.0
76991
+ * @version 241.0.0
76253
76992
  */
76254
76993
 
76255
76994
  /**
@@ -76403,7 +77142,7 @@ class UploadsApi {
76403
77142
  /**
76404
77143
  * Uploads service.
76405
77144
  * @module purecloud-platform-client-v2/api/UploadsApi
76406
- * @version 238.0.0
77145
+ * @version 241.0.0
76407
77146
  */
76408
77147
 
76409
77148
  /**
@@ -76694,7 +77433,7 @@ class UsageApi {
76694
77433
  /**
76695
77434
  * Usage service.
76696
77435
  * @module purecloud-platform-client-v2/api/UsageApi
76697
- * @version 238.0.0
77436
+ * @version 241.0.0
76698
77437
  */
76699
77438
 
76700
77439
  /**
@@ -77029,7 +77768,7 @@ class UserRecordingsApi {
77029
77768
  /**
77030
77769
  * UserRecordings service.
77031
77770
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
77032
- * @version 238.0.0
77771
+ * @version 241.0.0
77033
77772
  */
77034
77773
 
77035
77774
  /**
@@ -77213,7 +77952,7 @@ class UsersApi {
77213
77952
  /**
77214
77953
  * Users service.
77215
77954
  * @module purecloud-platform-client-v2/api/UsersApi
77216
- * @version 238.0.0
77955
+ * @version 241.0.0
77217
77956
  */
77218
77957
 
77219
77958
  /**
@@ -80222,7 +80961,7 @@ class UsersRulesApi {
80222
80961
  /**
80223
80962
  * UsersRules service.
80224
80963
  * @module purecloud-platform-client-v2/api/UsersRulesApi
80225
- * @version 238.0.0
80964
+ * @version 241.0.0
80226
80965
  */
80227
80966
 
80228
80967
  /**
@@ -80511,7 +81250,7 @@ class UtilitiesApi {
80511
81250
  /**
80512
81251
  * Utilities service.
80513
81252
  * @module purecloud-platform-client-v2/api/UtilitiesApi
80514
- * @version 238.0.0
81253
+ * @version 241.0.0
80515
81254
  */
80516
81255
 
80517
81256
  /**
@@ -80622,7 +81361,7 @@ class VoicemailApi {
80622
81361
  /**
80623
81362
  * Voicemail service.
80624
81363
  * @module purecloud-platform-client-v2/api/VoicemailApi
80625
- * @version 238.0.0
81364
+ * @version 241.0.0
80626
81365
  */
80627
81366
 
80628
81367
  /**
@@ -81344,7 +82083,7 @@ class WebChatApi {
81344
82083
  /**
81345
82084
  * WebChat service.
81346
82085
  * @module purecloud-platform-client-v2/api/WebChatApi
81347
- * @version 238.0.0
82086
+ * @version 241.0.0
81348
82087
  */
81349
82088
 
81350
82089
  /**
@@ -81907,7 +82646,7 @@ class WebDeploymentsApi {
81907
82646
  /**
81908
82647
  * WebDeployments service.
81909
82648
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
81910
- * @version 238.0.0
82649
+ * @version 241.0.0
81911
82650
  */
81912
82651
 
81913
82652
  /**
@@ -82489,7 +83228,7 @@ class WebMessagingApi {
82489
83228
  /**
82490
83229
  * WebMessaging service.
82491
83230
  * @module purecloud-platform-client-v2/api/WebMessagingApi
82492
- * @version 238.0.0
83231
+ * @version 241.0.0
82493
83232
  */
82494
83233
 
82495
83234
  /**
@@ -82635,7 +83374,7 @@ class WidgetsApi {
82635
83374
  /**
82636
83375
  * Widgets service.
82637
83376
  * @module purecloud-platform-client-v2/api/WidgetsApi
82638
- * @version 238.0.0
83377
+ * @version 241.0.0
82639
83378
  */
82640
83379
 
82641
83380
  /**
@@ -82786,7 +83525,7 @@ class WorkforceManagementApi {
82786
83525
  /**
82787
83526
  * WorkforceManagement service.
82788
83527
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
82789
- * @version 238.0.0
83528
+ * @version 241.0.0
82790
83529
  */
82791
83530
 
82792
83531
  /**
@@ -90837,7 +91576,7 @@ class WorkforceManagementApi {
90837
91576
  * </pre>
90838
91577
  * </p>
90839
91578
  * @module purecloud-platform-client-v2/index
90840
- * @version 238.0.0
91579
+ * @version 241.0.0
90841
91580
  */
90842
91581
  class platformClient {
90843
91582
  constructor() {