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
package/index.d.ts CHANGED
@@ -44,12 +44,16 @@ declare class ApiClientClass {
44
44
 
45
45
  declare class LoginImplicitGrantOptions {
46
46
  state?: string;
47
+ org?: string;
48
+ provider?: string;
49
+ prompt?: string;
47
50
  }
48
51
 
49
52
  declare class LoginPKCEGrantOptions {
50
53
  state?: string;
51
54
  org?: string;
52
55
  provider?: string;
56
+ prompt?: string;
53
57
  }
54
58
 
55
59
  declare class AuthData {
@@ -168,6 +172,7 @@ declare class AIStudioApi {
168
172
  patchGuideVersion(guideId: string, versionId: string, body: Models.UpdateGuideVersion): Promise<Models.GuideVersion>;
169
173
  postConversationsSummariesPreview(body: Models.SummarySettingWithTranscript): Promise<void>;
170
174
  postConversationsSummariesSettings(body: Models.SummarySetting): Promise<Models.SummarySetting>;
175
+ postGuideSessionTurns(guideId: string, guideSessionId: string, body: Models.GuideSessionTurnRequest): Promise<Models.GuideSessionTurnResponse>;
171
176
  postGuideVersionJobs(guideId: string, versionId: string, body: Models.GuideVersionPublishJobRequest): Promise<Models.GuideVersionPublishJob>;
172
177
  postGuideVersions(guideId: string, opts?: AIStudioApi.postGuideVersionsOptions): Promise<Models.GuideVersion>;
173
178
  postGuides(body: Models.CreateGuide): Promise<Models.Guide>;
@@ -203,10 +208,14 @@ declare class AgentAssistantsApi {
203
208
  deleteAssistant(assistantId: string): Promise<void>;
204
209
  deleteAssistantQueue(assistantId: string, queueId: string): Promise<void>;
205
210
  deleteAssistantQueues(assistantId: string, opts?: AgentAssistantsApi.deleteAssistantQueuesOptions): Promise<void>;
211
+ deleteAssistantsAgentchecklist(agentChecklistId: string): Promise<void>;
206
212
  getAssistant(assistantId: string, opts?: AgentAssistantsApi.getAssistantOptions): Promise<Models.Assistant>;
207
213
  getAssistantQueue(assistantId: string, queueId: string, opts?: AgentAssistantsApi.getAssistantQueueOptions): Promise<Models.AssistantQueue>;
208
214
  getAssistantQueues(assistantId: string, opts?: AgentAssistantsApi.getAssistantQueuesOptions): Promise<Models.AssistantQueueListing>;
209
215
  getAssistants(opts?: AgentAssistantsApi.getAssistantsOptions): Promise<Models.AssistantListing>;
216
+ getAssistantsAgentchecklist(agentChecklistId: string): Promise<Models.AgentChecklist>;
217
+ getAssistantsAgentchecklists(opts?: AgentAssistantsApi.getAssistantsAgentchecklistsOptions): Promise<Models.AgentChecklistListing>;
218
+ getAssistantsAgentchecklistsLanguages(): Promise<Models.EntityListing>;
210
219
  getAssistantsQueues(opts?: AgentAssistantsApi.getAssistantsQueuesOptions): Promise<Models.AssistantQueueListing>;
211
220
  patchAssistant(assistantId: string, body: Models.Assistant): Promise<Models.Assistant>;
212
221
  patchAssistantQueues(assistantId: string, body: Array<Models.AssistantQueue>): Promise<Models.AssistantQueueListing>;
@@ -214,7 +223,9 @@ declare class AgentAssistantsApi {
214
223
  postAssistantQueueUsersBulkRemove(assistantId: string, queueId: string, body: Models.AssistantQueueUsersBulkRemoveRequest): Promise<Models.BulkResponse>;
215
224
  postAssistantQueueUsersQuery(assistantId: string, queueId: string, body: Models.AssistantQueueUsersQueryRequest, opts?: AgentAssistantsApi.postAssistantQueueUsersQueryOptions): Promise<Models.AssistantQueueUsersQueryResponse>;
216
225
  postAssistants(body: Models.Assistant): Promise<Models.Assistant>;
226
+ postAssistantsAgentchecklists(body: Models.AgentChecklist): Promise<Models.AgentChecklist>;
217
227
  putAssistantQueue(assistantId: string, queueId: string, body: Models.AssistantQueue): Promise<Models.AssistantQueue>;
228
+ putAssistantsAgentchecklist(agentChecklistId: string, body: Models.AgentChecklist): Promise<Models.AgentChecklist>;
218
229
  }
219
230
 
220
231
  declare namespace AgentAssistantsApi {
@@ -241,6 +252,15 @@ declare namespace AgentAssistantsApi {
241
252
  "name"?: string;
242
253
  "expand"?: string;
243
254
  }
255
+ export interface getAssistantsAgentchecklistsOptions {
256
+ "before"?: string;
257
+ "after"?: string;
258
+ "pageSize"?: string;
259
+ "namePrefix"?: string;
260
+ "language"?: string;
261
+ "sortOrder"?: string;
262
+ "sortBy"?: string;
263
+ }
244
264
  export interface getAssistantsQueuesOptions {
245
265
  "before"?: string;
246
266
  "after"?: string;
@@ -319,6 +339,7 @@ declare class AnalyticsApi {
319
339
  deleteAnalyticsActionsAggregatesJob(jobId: string): Promise<void>;
320
340
  deleteAnalyticsAgentcopilotsAggregatesJob(jobId: string): Promise<void>;
321
341
  deleteAnalyticsBotsAggregatesJob(jobId: string): Promise<void>;
342
+ deleteAnalyticsCasemanagementAggregatesJob(jobId: string): Promise<void>;
322
343
  deleteAnalyticsConversationsAggregatesJob(jobId: string): Promise<void>;
323
344
  deleteAnalyticsConversationsDetailsJob(jobId: string): Promise<void>;
324
345
  deleteAnalyticsEvaluationsAggregatesJob(jobId: string): Promise<void>;
@@ -343,6 +364,8 @@ declare class AnalyticsApi {
343
364
  getAnalyticsBotflowSessions(botFlowId: string, opts?: AnalyticsApi.getAnalyticsBotflowSessionsOptions): Promise<Models.SessionsResponse>;
344
365
  getAnalyticsBotsAggregatesJob(jobId: string): Promise<Models.AsyncQueryStatus>;
345
366
  getAnalyticsBotsAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsBotsAggregatesJobResultsOptions): Promise<Models.BotAsyncAggregateQueryResponse>;
367
+ getAnalyticsCasemanagementAggregatesJob(jobId: string): Promise<Models.AsyncQueryStatus>;
368
+ getAnalyticsCasemanagementAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsCasemanagementAggregatesJobResultsOptions): Promise<Models.CaseManagementAsyncAggregateQueryResponse>;
346
369
  getAnalyticsConversationDetails(conversationId: string): Promise<Models.AnalyticsConversationWithoutAttributes>;
347
370
  getAnalyticsConversationsAggregatesJob(jobId: string): Promise<Models.AsyncQueryStatus>;
348
371
  getAnalyticsConversationsAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsConversationsAggregatesJobResultsOptions): Promise<Models.ConversationAsyncAggregateQueryResponse>;
@@ -394,6 +417,8 @@ declare class AnalyticsApi {
394
417
  postAnalyticsAgentsStatusQuery(body: Models.AgentStateQueryRequest): Promise<Models.AnalyticsAgentStateQueryResponse>;
395
418
  postAnalyticsBotsAggregatesJobs(body: Models.BotAsyncAggregationQuery): Promise<Models.AsyncQueryResponse>;
396
419
  postAnalyticsBotsAggregatesQuery(body: Models.BotAggregationQuery): Promise<Models.BotAggregateQueryResponse>;
420
+ postAnalyticsCasemanagementAggregatesJobs(body: Models.CaseManagementAsyncAggregationQuery): Promise<Models.AsyncQueryResponse>;
421
+ postAnalyticsCasemanagementAggregatesQuery(body: Models.CaseManagementAggregationQuery): Promise<Models.CaseManagementAggregateQueryResponse>;
397
422
  postAnalyticsConversationDetailsProperties(conversationId: string, body: Models.PropertyIndexRequest): Promise<Models.PropertyIndexRequest>;
398
423
  postAnalyticsConversationsActivityQuery(body: Models.ConversationActivityQuery, opts?: AnalyticsApi.postAnalyticsConversationsActivityQueryOptions): Promise<Models.ConversationActivityResponse>;
399
424
  postAnalyticsConversationsAggregatesJobs(body: Models.ConversationAsyncAggregationQuery): Promise<Models.AsyncQueryResponse>;
@@ -475,6 +500,9 @@ declare namespace AnalyticsApi {
475
500
  export interface getAnalyticsBotsAggregatesJobResultsOptions {
476
501
  "cursor"?: string;
477
502
  }
503
+ export interface getAnalyticsCasemanagementAggregatesJobResultsOptions {
504
+ "cursor"?: string;
505
+ }
478
506
  export interface getAnalyticsConversationsAggregatesJobResultsOptions {
479
507
  "cursor"?: string;
480
508
  }
@@ -1763,6 +1791,9 @@ declare class ConversationsApi {
1763
1791
  getAnalyticsConversationsDetailsJobResults(jobId: string, opts?: ConversationsApi.getAnalyticsConversationsDetailsJobResultsOptions): Promise<Models.AnalyticsConversationAsyncQueryResponse>;
1764
1792
  getAnalyticsConversationsDetailsJobsAvailability(): Promise<Models.DataAvailabilityResponse>;
1765
1793
  getConversation(conversationId: string): Promise<Models.Conversation>;
1794
+ getConversationCommunicationAgentchecklist(conversationId: string, communicationId: string, agentChecklistId: string): Promise<Models.AgentChecklistResponse>;
1795
+ getConversationCommunicationAgentchecklistJob(conversationId: string, communicationId: string, agentChecklistId: string, jobId: string): Promise<Models.ChecklistInferenceJobResponse>;
1796
+ getConversationCommunicationAgentchecklists(conversationId: string, communicationId: string): Promise<Models.AgentChecklistResponseList>;
1766
1797
  getConversationCommunicationInternalmessage(conversationId: string, communicationId: string, messageId: string): Promise<Models.InternalMessageData>;
1767
1798
  getConversationCommunicationInternalmessages(conversationId: string, communicationId: string, opts?: ConversationsApi.getConversationCommunicationInternalmessagesOptions): Promise<Models.InternalMessageDataEntityListing>;
1768
1799
  getConversationParticipantSecureivrsession(conversationId: string, participantId: string, secureSessionId: string): Promise<Models.SecureSession>;
@@ -1916,6 +1947,10 @@ declare class ConversationsApi {
1916
1947
  postConversationAssign(conversationId: string, body: Models.ConversationUser): Promise<string>;
1917
1948
  postConversationBarge(conversationId: string): Promise<void>;
1918
1949
  postConversationCobrowse(conversationId: string): Promise<Models.CobrowseWebMessagingSession>;
1950
+ postConversationCommunicationAgentchecklist(conversationId: string, communicationId: string, agentChecklistId: string, body: Models.ChecklistActivationPayload): Promise<Models.AgentChecklistResponse>;
1951
+ postConversationCommunicationAgentchecklistAgentaction(conversationId: string, communicationId: string, agentChecklistId: string, body: Models.AgentActionPayload): Promise<Models.AgentChecklistResponse>;
1952
+ postConversationCommunicationAgentchecklistJobs(conversationId: string, communicationId: string, agentChecklistId: string, body: Models.ChecklistInferenceJobPayload): Promise<Models.ChecklistInferenceJobCreationResponse>;
1953
+ postConversationCommunicationAgentchecklistsFinalize(conversationId: string, communicationId: string, body: Models.ChecklistFinalizePayload): Promise<Models.AgentChecklistResponseList>;
1919
1954
  postConversationCommunicationInternalmessages(conversationId: string, communicationId: string, body: Models.InternalMessageRequest): Promise<Models.InternalMessageData>;
1920
1955
  postConversationDisconnect(conversationId: string): Promise<string>;
1921
1956
  postConversationParticipantCallbacks(conversationId: string, participantId: string, opts?: ConversationsApi.postConversationParticipantCallbacksOptions): Promise<void>;
@@ -2352,6 +2387,7 @@ declare class EmployeeEngagementApi {
2352
2387
  deleteEmployeeengagementCelebration(celebrationId: string): Promise<void>;
2353
2388
  getEmployeeengagementCelebrations(opts?: EmployeeEngagementApi.getEmployeeengagementCelebrationsOptions): Promise<Models.GetCelebrationListing>;
2354
2389
  getEmployeeengagementRecognition(recognitionId: string): Promise<Models.Recognition>;
2390
+ getEmployeeengagementRecognitions(opts?: EmployeeEngagementApi.getEmployeeengagementRecognitionsOptions): Promise<Models.Recognitions>;
2355
2391
  patchEmployeeengagementCelebration(celebrationId: string, body: Models.CelebrationStateParam): Promise<void>;
2356
2392
  postEmployeeengagementRecognitions(body: Models.CreateRecognition): Promise<Models.RecognitionBase>;
2357
2393
  }
@@ -2361,6 +2397,14 @@ declare namespace EmployeeEngagementApi {
2361
2397
  "pageNumber"?: number;
2362
2398
  "pageSize"?: number;
2363
2399
  }
2400
+ export interface getEmployeeengagementRecognitionsOptions {
2401
+ "direction"?: string;
2402
+ "recipient"?: string;
2403
+ "dateStart"?: string;
2404
+ "dateEnd"?: string;
2405
+ "pageSize"?: number;
2406
+ "pageNumber"?: number;
2407
+ }
2364
2408
  }
2365
2409
 
2366
2410
  declare class EventsApi {
@@ -5121,6 +5165,7 @@ declare namespace OutboundApi {
5121
5165
  "id"?: Array<string>;
5122
5166
  "contentTemplateId"?: string;
5123
5167
  "campaignStatus"?: string;
5168
+ "ruleSetIds"?: Array<string>;
5124
5169
  }
5125
5170
  export interface getOutboundMessagingcampaignsDivisionviewsOptions {
5126
5171
  "pageSize"?: number;
@@ -5717,6 +5762,7 @@ declare class RoutingApi {
5717
5762
  deleteRoutingEmailOutboundDomain(domainId: string): Promise<void>;
5718
5763
  deleteRoutingLanguage(languageId: string): Promise<void>;
5719
5764
  deleteRoutingPredictor(predictorId: string): Promise<void>;
5765
+ deleteRoutingPredictorsKeyperformanceindicator(kpiId: string): Promise<void>;
5720
5766
  deleteRoutingQueue(queueId: string, opts?: RoutingApi.deleteRoutingQueueOptions): Promise<void>;
5721
5767
  deleteRoutingQueueMember(queueId: string, memberId: string): Promise<void>;
5722
5768
  deleteRoutingQueueUser(queueId: string, memberId: string): Promise<void>;
@@ -5760,7 +5806,9 @@ declare class RoutingApi {
5760
5806
  getRoutingPredictorModelFeatures(predictorId: string, modelId: string): Promise<Models.PredictorModelFeatureListing>;
5761
5807
  getRoutingPredictorModels(predictorId: string): Promise<Models.PredictorModels>;
5762
5808
  getRoutingPredictors(opts?: RoutingApi.getRoutingPredictorsOptions): Promise<Models.PredictorListing>;
5809
+ getRoutingPredictorsKeyperformanceindicator(kpiId: string, opts?: RoutingApi.getRoutingPredictorsKeyperformanceindicatorOptions): Promise<Models.KeyPerformanceIndicator>;
5763
5810
  getRoutingPredictorsKeyperformanceindicators(opts?: RoutingApi.getRoutingPredictorsKeyperformanceindicatorsOptions): Promise<Array<Models.KeyPerformanceIndicator>>;
5811
+ getRoutingPredictorsKeyperformanceindicatortypes(): Promise<Array<Models.KeyPerformanceIndicatorType>>;
5764
5812
  getRoutingQueue(queueId: string, opts?: RoutingApi.getRoutingQueueOptions): Promise<Models.Queue>;
5765
5813
  getRoutingQueueAssistant(queueId: string, opts?: RoutingApi.getRoutingQueueAssistantOptions): Promise<Models.AssistantQueue>;
5766
5814
  getRoutingQueueComparisonperiod(queueId: string, comparisonPeriodId: string): Promise<Models.ComparisonPeriod>;
@@ -5811,6 +5859,7 @@ declare class RoutingApi {
5811
5859
  patchRoutingEmailDomain(domainId: string, body: Models.InboundDomainPatchRequest): Promise<Models.InboundDomain>;
5812
5860
  patchRoutingEmailDomainValidate(domainId: string, body: Models.InboundDomainPatchRequest): Promise<Models.InboundDomain>;
5813
5861
  patchRoutingPredictor(predictorId: string, opts?: RoutingApi.patchRoutingPredictorOptions): Promise<Models.Predictor>;
5862
+ patchRoutingPredictorsKeyperformanceindicator(kpiId: string, opts?: RoutingApi.patchRoutingPredictorsKeyperformanceindicatorOptions): Promise<Models.KeyPerformanceIndicator>;
5814
5863
  patchRoutingQueueMember(queueId: string, memberId: string, body: Models.QueueMember): Promise<void>;
5815
5864
  patchRoutingQueueMembers(queueId: string, body: Array<Models.QueueMember>): Promise<Models.QueueMemberEntityListing>;
5816
5865
  patchRoutingQueueUser(queueId: string, memberId: string, body: Models.QueueMember): Promise<void>;
@@ -5838,6 +5887,7 @@ declare class RoutingApi {
5838
5887
  postRoutingEmailOutboundDomainsSimulated(body: Models.OutboundDomainCreateRequest): Promise<Models.EmailOutboundDomainResult>;
5839
5888
  postRoutingLanguages(body: Models.Language): Promise<Models.Language>;
5840
5889
  postRoutingPredictors(opts?: RoutingApi.postRoutingPredictorsOptions): Promise<Models.Predictor>;
5890
+ postRoutingPredictorsKeyperformanceindicators(body: Models.CreateKpiRequest): Promise<Models.KeyPerformanceIndicator>;
5841
5891
  postRoutingQueueMembers(queueId: string, body: Array<Models.WritableEntity>, opts?: RoutingApi.postRoutingQueueMembersOptions): Promise<void>;
5842
5892
  postRoutingQueueUsers(queueId: string, body: Array<Models.WritableEntity>, opts?: RoutingApi.postRoutingQueueUsersOptions): Promise<void>;
5843
5893
  postRoutingQueueWrapupcodes(queueId: string, body: Array<Models.WrapUpCodeReference>): Promise<Array<Models.WrapupCode>>;
@@ -5943,6 +5993,9 @@ declare namespace RoutingApi {
5943
5993
  "kpiId"?: string;
5944
5994
  "state"?: string;
5945
5995
  }
5996
+ export interface getRoutingPredictorsKeyperformanceindicatorOptions {
5997
+ "expand"?: Array<string>;
5998
+ }
5946
5999
  export interface getRoutingPredictorsKeyperformanceindicatorsOptions {
5947
6000
  "kpiGroup"?: string;
5948
6001
  "expand"?: Array<string>;
@@ -6125,6 +6178,9 @@ declare namespace RoutingApi {
6125
6178
  export interface patchRoutingPredictorOptions {
6126
6179
  "body"?: Models.PatchPredictorRequest;
6127
6180
  }
6181
+ export interface patchRoutingPredictorsKeyperformanceindicatorOptions {
6182
+ "body"?: Models.UpdateKpiRequest;
6183
+ }
6128
6184
  export interface patchUserQueuesOptions {
6129
6185
  "divisionId"?: Array<string>;
6130
6186
  }
@@ -6502,7 +6558,7 @@ declare class SocialMediaApi {
6502
6558
  getSocialmediaAnalyticsMessagesJobResults(jobId: string, opts?: SocialMediaApi.getSocialmediaAnalyticsMessagesJobResultsOptions): Promise<Models.SocialMediaAsyncDetailQueryResponse>;
6503
6559
  getSocialmediaEscalationrule(escalationRuleId: string, opts?: SocialMediaApi.getSocialmediaEscalationruleOptions): Promise<Models.EscalationRuleResponse>;
6504
6560
  getSocialmediaEscalationrules(divisionId: string, opts?: SocialMediaApi.getSocialmediaEscalationrulesOptions): Promise<Models.SocialEscalationResponseEntityListing>;
6505
- getSocialmediaTopic(topicId: string, opts?: SocialMediaApi.getSocialmediaTopicOptions): Promise<Models.SocialTopicResponse>;
6561
+ getSocialmediaTopic(topicId: string, opts?: SocialMediaApi.getSocialmediaTopicOptions): Promise<Models.SocialTopicWithDataIngestionRuleMetadataResponse>;
6506
6562
  getSocialmediaTopicDataingestionrules(topicId: string, opts?: SocialMediaApi.getSocialmediaTopicDataingestionrulesOptions): Promise<Models.DataIngestionRuleResponseEntityListing>;
6507
6563
  getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleId(topicId: string, facebookIngestionRuleId: string, opts?: SocialMediaApi.getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdOptions): Promise<Models.FacebookDataIngestionRuleResponse>;
6508
6564
  getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersion(topicId: string, facebookIngestionRuleId: string, dataIngestionRuleVersion: string, opts?: SocialMediaApi.getSocialmediaTopicDataingestionrulesFacebookFacebookIngestionRuleIdVersionOptions): Promise<Models.FacebookDataIngestionRuleVersionResponse>;
@@ -6627,6 +6683,7 @@ declare namespace SocialMediaApi {
6627
6683
  "pageSize"?: number;
6628
6684
  "divisionIds"?: Array<string>;
6629
6685
  "includeDeleted"?: boolean;
6686
+ "name"?: string;
6630
6687
  }
6631
6688
  export interface patchSocialmediaTopicOptions {
6632
6689
  "body"?: Models.SocialTopicPatchRequest;
@@ -8961,6 +9018,13 @@ declare namespace Models {
8961
9018
  "delayInSeconds"?: number;
8962
9019
  }
8963
9020
 
9021
+ export interface ActivationTrigger {
9022
+ "triggerType"?: string;
9023
+ "triggerDate"?: string;
9024
+ "intentId"?: string;
9025
+ "intentName"?: string;
9026
+ }
9027
+
8964
9028
  export interface ActivityCode {
8965
9029
  "id"?: string;
8966
9030
  "selfUri"?: string;
@@ -9407,6 +9471,18 @@ declare namespace Models {
9407
9471
  "stage"?: string;
9408
9472
  }
9409
9473
 
9474
+ export interface AgentAction {
9475
+ "id": string;
9476
+ "name": string;
9477
+ "agentAction": string;
9478
+ "selfUri"?: string;
9479
+ }
9480
+
9481
+ export interface AgentActionPayload {
9482
+ "afterCallWork"?: boolean;
9483
+ "checklistItems": Array<Models.AgentAction>;
9484
+ }
9485
+
9410
9486
  export interface AgentActivity {
9411
9487
  "id"?: string;
9412
9488
  "name"?: string;
@@ -9493,6 +9569,69 @@ declare namespace Models {
9493
9569
  "overrideReason"?: string;
9494
9570
  }
9495
9571
 
9572
+ export interface AgentChecklist {
9573
+ "id"?: string;
9574
+ "name": string;
9575
+ "language": string;
9576
+ "checklistItems": Array<Models.AgentChecklistItem>;
9577
+ "createdBy"?: Models.UserReference;
9578
+ "modifiedBy"?: Models.UserReference;
9579
+ "dateCreated"?: string;
9580
+ "dateModified"?: string;
9581
+ "selfUri"?: string;
9582
+ }
9583
+
9584
+ export interface AgentChecklistInfo {
9585
+ "id": string;
9586
+ "name": string;
9587
+ "checklistItems": Array<Models.ChecklistItem>;
9588
+ "selfUri"?: string;
9589
+ }
9590
+
9591
+ export interface AgentChecklistItem {
9592
+ "id"?: string;
9593
+ "name": string;
9594
+ "description"?: string;
9595
+ "automatedCheckEnabled"?: boolean;
9596
+ "important"?: boolean;
9597
+ "selfUri"?: string;
9598
+ }
9599
+
9600
+ export interface AgentChecklistListing {
9601
+ "entities"?: Array<Models.AgentChecklist>;
9602
+ "nextUri"?: string;
9603
+ "selfUri"?: string;
9604
+ "previousUri"?: string;
9605
+ }
9606
+
9607
+ export interface AgentChecklistResponse {
9608
+ "id": string;
9609
+ "name": string;
9610
+ "checklistItems": Array<Models.ChecklistItem>;
9611
+ "activationTriggers"?: Array<Models.ActivationTrigger>;
9612
+ "status": string;
9613
+ "exitReason"?: string;
9614
+ "language": string;
9615
+ "agentId"?: string;
9616
+ "participantId"?: string;
9617
+ "queueId"?: string;
9618
+ "assistantId"?: string;
9619
+ "mediaType"?: string;
9620
+ "direction"?: string;
9621
+ "evaluationStartDate"?: string;
9622
+ "evaluationLastModifiedDate"?: string;
9623
+ "evaluationFinalizedDate"?: string;
9624
+ "evaluationFinalizedWithAcwDate"?: string;
9625
+ "selfUri"?: string;
9626
+ }
9627
+
9628
+ export interface AgentChecklistResponseList {
9629
+ "entities"?: Array<Models.AgentChecklistResponse>;
9630
+ "nextUri"?: string;
9631
+ "selfUri"?: string;
9632
+ "previousUri"?: string;
9633
+ }
9634
+
9496
9635
  export interface AgentCopilotAggregateDataContainer {
9497
9636
  "group"?: { [key: string]: string; };
9498
9637
  "data"?: Array<Models.StatisticalResponse>;
@@ -10519,6 +10658,7 @@ declare namespace Models {
10519
10658
  "routingRing"?: number;
10520
10659
  "routingRule"?: string;
10521
10660
  "routingRuleType"?: string;
10661
+ "screenMonitoredUserId"?: string;
10522
10662
  "screenShareAddressSelf"?: string;
10523
10663
  "screenShareRoomId"?: string;
10524
10664
  "scriptId"?: string;
@@ -13422,6 +13562,7 @@ declare namespace Models {
13422
13562
  "success"?: boolean;
13423
13563
  "entity"?: Models.ExternalContact;
13424
13564
  "error"?: Models.BulkEntityErrorContactEnrichRequest;
13565
+ "status"?: number;
13425
13566
  }
13426
13567
 
13427
13568
  export interface BulkResponseResultExternalContactEntityBulkEntityErrorEntity {
@@ -13429,6 +13570,7 @@ declare namespace Models {
13429
13570
  "success"?: boolean;
13430
13571
  "entity"?: Models.ExternalContact;
13431
13572
  "error"?: Models.BulkEntityErrorEntity;
13573
+ "status"?: number;
13432
13574
  }
13433
13575
 
13434
13576
  export interface BulkResponseResultExternalContactExternalContactBulkEntityErrorExternalContact {
@@ -13436,6 +13578,7 @@ declare namespace Models {
13436
13578
  "success"?: boolean;
13437
13579
  "entity"?: Models.ExternalContact;
13438
13580
  "error"?: Models.BulkEntityErrorExternalContact;
13581
+ "status"?: number;
13439
13582
  }
13440
13583
 
13441
13584
  export interface BulkResponseResultExternalOrganizationEntityBulkEntityErrorEntity {
@@ -13443,6 +13586,7 @@ declare namespace Models {
13443
13586
  "success"?: boolean;
13444
13587
  "entity"?: Models.ExternalOrganization;
13445
13588
  "error"?: Models.BulkEntityErrorEntity;
13589
+ "status"?: number;
13446
13590
  }
13447
13591
 
13448
13592
  export interface BulkResponseResultExternalOrganizationExternalOrganizationBulkEntityErrorExternalOrganization {
@@ -13450,6 +13594,7 @@ declare namespace Models {
13450
13594
  "success"?: boolean;
13451
13595
  "entity"?: Models.ExternalOrganization;
13452
13596
  "error"?: Models.BulkEntityErrorExternalOrganization;
13597
+ "status"?: number;
13453
13598
  }
13454
13599
 
13455
13600
  export interface BulkResponseResultExternalOrganizationExternalOrganizationEnrichRequestBulkEntityErrorExternalOrganizationEnrichRequest {
@@ -13457,6 +13602,7 @@ declare namespace Models {
13457
13602
  "success"?: boolean;
13458
13603
  "entity"?: Models.ExternalOrganization;
13459
13604
  "error"?: Models.BulkEntityErrorExternalOrganizationEnrichRequest;
13605
+ "status"?: number;
13460
13606
  }
13461
13607
 
13462
13608
  export interface BulkResponseResultNoteEntityBulkEntityErrorEntity {
@@ -13464,6 +13610,7 @@ declare namespace Models {
13464
13610
  "success"?: boolean;
13465
13611
  "entity"?: Models.Note;
13466
13612
  "error"?: Models.BulkEntityErrorEntity;
13613
+ "status"?: number;
13467
13614
  }
13468
13615
 
13469
13616
  export interface BulkResponseResultNoteNoteBulkEntityErrorNote {
@@ -13471,6 +13618,7 @@ declare namespace Models {
13471
13618
  "success"?: boolean;
13472
13619
  "entity"?: Models.Note;
13473
13620
  "error"?: Models.BulkEntityErrorNote;
13621
+ "status"?: number;
13474
13622
  }
13475
13623
 
13476
13624
  export interface BulkResponseResultRelationshipEntityBulkEntityErrorEntity {
@@ -13478,6 +13626,7 @@ declare namespace Models {
13478
13626
  "success"?: boolean;
13479
13627
  "entity"?: Models.Relationship;
13480
13628
  "error"?: Models.BulkEntityErrorEntity;
13629
+ "status"?: number;
13481
13630
  }
13482
13631
 
13483
13632
  export interface BulkResponseResultRelationshipRelationshipBulkEntityErrorRelationship {
@@ -13485,6 +13634,7 @@ declare namespace Models {
13485
13634
  "success"?: boolean;
13486
13635
  "entity"?: Models.Relationship;
13487
13636
  "error"?: Models.BulkEntityErrorRelationship;
13637
+ "status"?: number;
13488
13638
  }
13489
13639
 
13490
13640
  export interface BulkResponseResultVoidEntityBulkEntityErrorEntity {
@@ -13492,6 +13642,7 @@ declare namespace Models {
13492
13642
  "success"?: boolean;
13493
13643
  "entity"?: object;
13494
13644
  "error"?: Models.BulkEntityErrorEntity;
13645
+ "status"?: number;
13495
13646
  }
13496
13647
 
13497
13648
  export interface BulkResult {
@@ -14677,6 +14828,22 @@ declare namespace Models {
14677
14828
  "version": number;
14678
14829
  }
14679
14830
 
14831
+ export interface CapacityPlanMetricsSummary {
14832
+ "requiredStaffFullTimeEquivalentCount": Array<number>;
14833
+ "plannedFullTimeEquivalentCount": Array<number>;
14834
+ "staffingOverUnderFullTimeEquivalentCount": Array<number>;
14835
+ "startingFullTimeEquivalentCount": Array<number>;
14836
+ "attritionFullTimeEquivalentCount": Array<number>;
14837
+ "attritionPercentage": Array<number>;
14838
+ "newHireFullTimeEquivalentCount": Array<number>;
14839
+ "transfersFullTimeEquivalentCount": Array<number>;
14840
+ "extraTimeUnderTimeFullTimeEquivalentCount": Array<number>;
14841
+ "shrinkageFullTimeEquivalentCount": Array<number>;
14842
+ "shrinkagePercentage": Array<number>;
14843
+ "endOfMonthPlannedFullTimeEquivalentCount"?: Array<number>;
14844
+ "netFullTimeEquivalentCount": Array<number>;
14845
+ }
14846
+
14680
14847
  export interface CapacityPlanReference {
14681
14848
  "id"?: string;
14682
14849
  "name"?: string;
@@ -14739,6 +14906,14 @@ declare namespace Models {
14739
14906
  "downloadTemplate"?: Models.StaffingRequirementResultResponseTemplate;
14740
14907
  }
14741
14908
 
14909
+ export interface CapacityPlanningPlanningGroupAllocation {
14910
+ "planningGroupId": string;
14911
+ "requiredStaffFullTimeEquivalentCount": Array<number>;
14912
+ "staffingGroupFullTimeEquivalentContributions": Array<Models.StaffingGroupFullTimeEquivalentContribution>;
14913
+ "totalPlannedFullTimeEquivalentCount": Array<number>;
14914
+ "overUnderFullTimeEquivalentCount": Array<number>;
14915
+ }
14916
+
14742
14917
  export interface CapacityPlanningRequirementsResultTopicBusinessUnit {
14743
14918
  "id"?: string;
14744
14919
  }
@@ -14777,6 +14952,85 @@ declare namespace Models {
14777
14952
  "isSelected"?: boolean;
14778
14953
  }
14779
14954
 
14955
+ export interface CardParameters {
14956
+ "bodyParameters"?: Array<Models.TemplateParameter>;
14957
+ "buttonUrlParameters"?: Array<Models.TemplateParameter>;
14958
+ }
14959
+
14960
+ export interface CarouselParameters {
14961
+ "cardParameters"?: Array<Models.CardParameters>;
14962
+ }
14963
+
14964
+ export interface CaseManagementAggregateDataContainer {
14965
+ "group"?: { [key: string]: string; };
14966
+ "data"?: Array<Models.StatisticalResponse>;
14967
+ }
14968
+
14969
+ export interface CaseManagementAggregateQueryClause {
14970
+ "type": string;
14971
+ "predicates": Array<Models.CaseManagementAggregateQueryPredicate>;
14972
+ }
14973
+
14974
+ export interface CaseManagementAggregateQueryFilter {
14975
+ "type": string;
14976
+ "clauses"?: Array<Models.CaseManagementAggregateQueryClause>;
14977
+ "predicates"?: Array<Models.CaseManagementAggregateQueryPredicate>;
14978
+ }
14979
+
14980
+ export interface CaseManagementAggregateQueryPredicate {
14981
+ "type"?: string;
14982
+ "dimension"?: string;
14983
+ "operator"?: string;
14984
+ "value"?: string;
14985
+ "range"?: Models.NumericRange;
14986
+ }
14987
+
14988
+ export interface CaseManagementAggregateQueryResponse {
14989
+ "results"?: Array<Models.CaseManagementAggregateDataContainer>;
14990
+ }
14991
+
14992
+ export interface CaseManagementAggregationQuery {
14993
+ "interval": string;
14994
+ "granularity"?: string;
14995
+ "timeZone"?: string;
14996
+ "groupBy"?: Array<string>;
14997
+ "filter"?: Models.CaseManagementAggregateQueryFilter;
14998
+ "metrics": Array<string>;
14999
+ "flattenMultivaluedDimensions"?: boolean;
15000
+ "views"?: Array<Models.CaseManagementAggregationView>;
15001
+ "alternateTimeDimension"?: string;
15002
+ }
15003
+
15004
+ export interface CaseManagementAggregationSort {
15005
+ "name": string;
15006
+ "function": string;
15007
+ }
15008
+
15009
+ export interface CaseManagementAggregationView {
15010
+ "target": string;
15011
+ "name": string;
15012
+ "function": string;
15013
+ "range"?: Models.AggregationRange;
15014
+ }
15015
+
15016
+ export interface CaseManagementAsyncAggregateQueryResponse {
15017
+ "results"?: Array<Models.CaseManagementAggregateDataContainer>;
15018
+ "cursor"?: string;
15019
+ }
15020
+
15021
+ export interface CaseManagementAsyncAggregationQuery {
15022
+ "interval": string;
15023
+ "granularity"?: string;
15024
+ "timeZone"?: string;
15025
+ "groupBy"?: Array<string>;
15026
+ "filter"?: Models.CaseManagementAggregateQueryFilter;
15027
+ "metrics": Array<string>;
15028
+ "flattenMultivaluedDimensions"?: boolean;
15029
+ "views"?: Array<Models.CaseManagementAggregationView>;
15030
+ "alternateTimeDimension"?: string;
15031
+ "pageSize"?: number;
15032
+ }
15033
+
14780
15034
  export interface CategoriesEntityListing {
14781
15035
  "entities"?: Array<Models.StaCategory>;
14782
15036
  "pageSize"?: number;
@@ -15157,6 +15411,63 @@ declare namespace Models {
15157
15411
  "type"?: string;
15158
15412
  }
15159
15413
 
15414
+ export interface ChecklistActivationPayload {
15415
+ "activationTriggerType": string;
15416
+ "intentId"?: string;
15417
+ "intentName"?: string;
15418
+ "language": string;
15419
+ "agentId"?: string;
15420
+ "participantId"?: string;
15421
+ "queueId"?: string;
15422
+ "assistantId"?: string;
15423
+ "mediaType"?: string;
15424
+ "direction"?: string;
15425
+ }
15426
+
15427
+ export interface ChecklistFinalizePayload {
15428
+ "exitReason": string;
15429
+ }
15430
+
15431
+ export interface ChecklistInferenceJobCreationResponse {
15432
+ "jobId"?: string;
15433
+ "message"?: string;
15434
+ }
15435
+
15436
+ export interface ChecklistInferenceJobPayload {
15437
+ "conversationContext": Array<Models.ConversationContext>;
15438
+ }
15439
+
15440
+ export interface ChecklistInferenceJobResponse {
15441
+ "id": string;
15442
+ "status": string;
15443
+ "error"?: Models.ErrorInfo;
15444
+ "agentChecklistInfo"?: Models.AgentChecklistInfo;
15445
+ "jobStartTime"?: string;
15446
+ "jobEndTime"?: string;
15447
+ "language"?: string;
15448
+ "agentId"?: string;
15449
+ "participantId"?: string;
15450
+ "queueId"?: string;
15451
+ "assistantId"?: string;
15452
+ "mediaType"?: string;
15453
+ "direction"?: string;
15454
+ "selfUri"?: string;
15455
+ }
15456
+
15457
+ export interface ChecklistItem {
15458
+ "id": string;
15459
+ "name": string;
15460
+ "description"?: string;
15461
+ "automatedCheckEnabled"?: boolean;
15462
+ "important"?: boolean;
15463
+ "stateFromModel"?: string;
15464
+ "stateFromAgent"?: string;
15465
+ "dateLastModifiedByModel"?: string;
15466
+ "dateLastModifiedByAgent"?: string;
15467
+ "lastModifiedInAcw"?: boolean;
15468
+ "selfUri"?: string;
15469
+ }
15470
+
15160
15471
  export interface ClientApp {
15161
15472
  "id"?: string;
15162
15473
  "name"?: string;
@@ -18305,6 +18616,12 @@ declare namespace Models {
18305
18616
  "value"?: string;
18306
18617
  }
18307
18618
 
18619
+ export interface ConversationContext {
18620
+ "id": string;
18621
+ "participant": string;
18622
+ "text": string;
18623
+ }
18624
+
18308
18625
  export interface ConversationDeletionProtectionQuery {
18309
18626
  "conversationIds": Array<string>;
18310
18627
  }
@@ -19766,9 +20083,20 @@ declare namespace Models {
19766
20083
  "index": number;
19767
20084
  "phoneNumber"?: string;
19768
20085
  "url"?: string;
20086
+ "payload"?: string;
19769
20087
  "parameters"?: Array<Models.ConversationNotificationTemplateParameter>;
19770
20088
  }
19771
20089
 
20090
+ export interface ConversationNotificationTemplateCard {
20091
+ "header": Models.ConversationNotificationTemplateHeader;
20092
+ "body"?: Models.ConversationNotificationTemplateBody;
20093
+ "buttons": Array<Models.ConversationNotificationTemplateButton>;
20094
+ }
20095
+
20096
+ export interface ConversationNotificationTemplateCarousel {
20097
+ "cards": Array<Models.ConversationNotificationTemplateCard>;
20098
+ }
20099
+
19772
20100
  export interface ConversationNotificationTemplateFooter {
19773
20101
  "text"?: string;
19774
20102
  }
@@ -20815,6 +21143,21 @@ declare namespace Models {
20815
21143
  "conditionValues": Array<string>;
20816
21144
  }
20817
21145
 
21146
+ export interface CopilotContext {
21147
+ "values"?: Array<Models.CopilotContextValue>;
21148
+ }
21149
+
21150
+ export interface CopilotContextFilter {
21151
+ "operator"?: string;
21152
+ "values"?: Array<string>;
21153
+ }
21154
+
21155
+ export interface CopilotContextValue {
21156
+ "name": string;
21157
+ "type": string;
21158
+ "participantDataProperties"?: Models.ParticipantDataProperties;
21159
+ }
21160
+
20818
21161
  export interface CopilotFallbackAction {
20819
21162
  "actionType": string;
20820
21163
  "attributes"?: { [key: string]: string; };
@@ -21141,6 +21484,7 @@ declare namespace Models {
21141
21484
  "id"?: string;
21142
21485
  "state"?: string;
21143
21486
  "testTopicPhraseResults"?: Array<Models.CreateGeneralProgramTestTopicPhraseResults>;
21487
+ "genAIPhrasesResults"?: Array<string>;
21144
21488
  }
21145
21489
 
21146
21490
  export interface CreateGuide {
@@ -21161,6 +21505,14 @@ declare namespace Models {
21161
21505
  "selfUri"?: string;
21162
21506
  }
21163
21507
 
21508
+ export interface CreateKpiRequest {
21509
+ "name": string;
21510
+ "description"?: string;
21511
+ "kpiType": string;
21512
+ "wrapUpCodeConfig"?: Models.WrapUpCodeConfig;
21513
+ "source": string;
21514
+ }
21515
+
21164
21516
  export interface CreateManagementUnitApiRequest {
21165
21517
  "name": string;
21166
21518
  "timeZone"?: string;
@@ -24545,8 +24897,8 @@ declare namespace Models {
24545
24897
  "edgeVersion"?: string;
24546
24898
  "publishDate"?: string;
24547
24899
  "edgeUri"?: string;
24548
- "current"?: boolean;
24549
24900
  "latestRelease"?: boolean;
24901
+ "current"?: boolean;
24550
24902
  "selfUri"?: string;
24551
24903
  }
24552
24904
 
@@ -24719,8 +25071,8 @@ declare namespace Models {
24719
25071
  "baseLicense"?: string;
24720
25072
  "addonLicenses"?: Array<string>;
24721
25073
  "dateLicenseLastUpdated"?: string;
24722
- "default"?: boolean;
24723
25074
  "base"?: boolean;
25075
+ "default"?: boolean;
24724
25076
  "selfUri"?: string;
24725
25077
  }
24726
25078
 
@@ -24737,8 +25089,8 @@ declare namespace Models {
24737
25089
  "baseLicense"?: string;
24738
25090
  "addonLicenses"?: Array<string>;
24739
25091
  "dateLicenseLastUpdated"?: string;
24740
- "default"?: boolean;
24741
25092
  "base"?: boolean;
25093
+ "default"?: boolean;
24742
25094
  "selfUri"?: string;
24743
25095
  }
24744
25096
 
@@ -24755,8 +25107,8 @@ declare namespace Models {
24755
25107
  "baseLicense"?: string;
24756
25108
  "addonLicenses"?: Array<string>;
24757
25109
  "dateLicenseLastUpdated"?: string;
24758
- "default"?: boolean;
24759
25110
  "base"?: boolean;
25111
+ "default"?: boolean;
24760
25112
  "selfUri"?: string;
24761
25113
  }
24762
25114
 
@@ -28118,7 +28470,6 @@ declare namespace Models {
28118
28470
  "compatibleFlowTypes"?: Array<string>;
28119
28471
  "worktypeId"?: string;
28120
28472
  "virtualAgentEnabled"?: boolean;
28121
- "agenticVirtualAgentEnabled"?: boolean;
28122
28473
  "selfUri"?: string;
28123
28474
  }
28124
28475
 
@@ -28928,7 +29279,6 @@ declare namespace Models {
28928
29279
  "inputSchema"?: Models.JsonSchemaDocument;
28929
29280
  "outputSchema"?: Models.JsonSchemaDocument;
28930
29281
  "virtualAgentEnabled"?: boolean;
28931
- "agenticVirtualAgentEnabled"?: boolean;
28932
29282
  "datePublished"?: string;
28933
29283
  "datePublishedEnd"?: string;
28934
29284
  "nluInfo"?: Models.NluInfo;
@@ -29188,6 +29538,7 @@ declare namespace Models {
29188
29538
  "status": string;
29189
29539
  "subject": Models.GDPRSubject;
29190
29540
  "resultsUrl"?: string;
29541
+ "resultsUrls"?: Array<string>;
29191
29542
  "selfUri"?: string;
29192
29543
  }
29193
29544
 
@@ -29929,6 +30280,58 @@ declare namespace Models {
29929
30280
  "selfUri"?: string;
29930
30281
  }
29931
30282
 
30283
+ export interface GuideSessionInputEvent {
30284
+ "type": string;
30285
+ "text"?: string;
30286
+ "mode": string;
30287
+ "invocationId"?: string;
30288
+ "invocations"?: Array<Models.GuideSessionTurnInvocationData>;
30289
+ }
30290
+
30291
+ export interface GuideSessionTurnInvocationData {
30292
+ "group": string;
30293
+ "actionName": string;
30294
+ "output": string;
30295
+ }
30296
+
30297
+ export interface GuideSessionTurnInvocationParameters {
30298
+ "name"?: string;
30299
+ "type"?: string;
30300
+ "value"?: string;
30301
+ }
30302
+
30303
+ export interface GuideSessionTurnInvocationResponse {
30304
+ "id"?: string;
30305
+ "group": string;
30306
+ "actionName": string;
30307
+ "parameters"?: Array<Models.GuideSessionTurnInvocationParameters>;
30308
+ }
30309
+
30310
+ export interface GuideSessionTurnRequest {
30311
+ "inputEvent": Models.GuideSessionInputEvent;
30312
+ "languageCode": string;
30313
+ "version": string;
30314
+ "inputVariables"?: Array<Models.GuideSessionVariable>;
30315
+ }
30316
+
30317
+ export interface GuideSessionTurnResponse {
30318
+ "response"?: Models.GuideSessionTurnResponseData;
30319
+ "status"?: string;
30320
+ "result"?: string;
30321
+ "outputVariables"?: Array<Models.GuideSessionVariable>;
30322
+ "invocationId"?: string;
30323
+ "invocations"?: Array<Models.GuideSessionTurnInvocationResponse>;
30324
+ }
30325
+
30326
+ export interface GuideSessionTurnResponseData {
30327
+ "text"?: string;
30328
+ }
30329
+
30330
+ export interface GuideSessionVariable {
30331
+ "name"?: string;
30332
+ "value"?: string;
30333
+ }
30334
+
29932
30335
  export interface GuideVersion {
29933
30336
  "selfUri"?: string;
29934
30337
  "guide"?: Models.AddressableEntityRef;
@@ -30605,6 +31008,9 @@ declare namespace Models {
30605
31008
  }
30606
31009
 
30607
31010
  export interface InactivityTimeoutSettings {
31011
+ "timeoutSeconds"?: number;
31012
+ "actionType"?: string;
31013
+ "flowId"?: Models.DomainEntityRef;
30608
31014
  }
30609
31015
 
30610
31016
  export interface InboundDomain {
@@ -32371,6 +32777,7 @@ declare namespace Models {
32371
32777
 
32372
32778
  export interface JourneyViewResult {
32373
32779
  "elements"?: Array<Models.JourneyViewResultElement>;
32780
+ "charts"?: Array<Models.JourneyViewChartResult>;
32374
32781
  }
32375
32782
 
32376
32783
  export interface JourneyViewResultElement {
@@ -32844,6 +33251,11 @@ declare namespace Models {
32844
33251
  "checks"?: Array<Models.Check>;
32845
33252
  }
32846
33253
 
33254
+ export interface KeyPerformanceIndicatorType {
33255
+ "id"?: string;
33256
+ "sources"?: Array<string>;
33257
+ }
33258
+
32847
33259
  export interface KeyRotationSchedule {
32848
33260
  "id"?: string;
32849
33261
  "name"?: string;
@@ -36028,6 +36440,8 @@ declare namespace Models {
36028
36440
  "autoAnswerAlertToneSeconds"?: number;
36029
36441
  "manualAnswerAlertToneSeconds"?: number;
36030
36442
  "subTypeSettings"?: { [key: string]: Models.MessageSubtypeSettings; };
36443
+ "enableInactivityTimeout"?: boolean;
36444
+ "inactivityTimeoutSettings"?: Models.InactivityTimeoutSettings;
36031
36445
  }
36032
36446
 
36033
36447
  export interface MessageMediaUploadData {
@@ -36050,6 +36464,7 @@ declare namespace Models {
36050
36464
 
36051
36465
  export interface MessageSubtypeSettings {
36052
36466
  "enableAutoAnswer"?: boolean;
36467
+ "enableInactivityTimeout"?: boolean;
36053
36468
  }
36054
36469
 
36055
36470
  export interface MessageTypingEventRequest {
@@ -39260,6 +39675,10 @@ declare namespace Models {
39260
39675
  "bargedParticipantId"?: string;
39261
39676
  }
39262
39677
 
39678
+ export interface ParticipantDataProperties {
39679
+ "name": string;
39680
+ }
39681
+
39263
39682
  export interface ParticipantInfo {
39264
39683
  "activeParticipantCount"?: number;
39265
39684
  "version"?: number;
@@ -39938,6 +40357,7 @@ declare namespace Models {
39938
40357
  "text": string;
39939
40358
  "strictness"?: string;
39940
40359
  "sentiment"?: string;
40360
+ "isAIGenerated"?: boolean;
39941
40361
  }
39942
40362
 
39943
40363
  export interface PhraseAssociations {
@@ -40529,6 +40949,7 @@ declare namespace Models {
40529
40949
  "id"?: string;
40530
40950
  "state"?: string;
40531
40951
  "testTopicPhraseResults"?: Array<Models.ProgramTopicLinksTestTopicPhraseResults>;
40952
+ "genAIPhrasesResults"?: Array<string>;
40532
40953
  }
40533
40954
 
40534
40955
  export interface ProgramTranscriptionEngine {
@@ -40714,6 +41135,7 @@ declare namespace Models {
40714
41135
  "id"?: string;
40715
41136
  "state"?: string;
40716
41137
  "testTopicPhraseResults"?: Array<Models.PublishProgramTestTopicPhraseResults>;
41138
+ "genAIPhrasesResults"?: Array<string>;
40717
41139
  }
40718
41140
 
40719
41141
  export interface PublishScriptRequestData {
@@ -40746,6 +41168,7 @@ declare namespace Models {
40746
41168
  "id"?: string;
40747
41169
  "state"?: string;
40748
41170
  "testTopicPhraseResults"?: Array<Models.PublishTopicTestTopicPhraseResults>;
41171
+ "genAIPhrasesResults"?: Array<string>;
40749
41172
  }
40750
41173
 
40751
41174
  export interface PublishedSurveyFormReference {
@@ -44323,6 +44746,14 @@ declare namespace Models {
44323
44746
  "selfUri"?: string;
44324
44747
  }
44325
44748
 
44749
+ export interface Recognitions {
44750
+ "entities"?: Array<Models.Recognition>;
44751
+ "pageSize"?: number;
44752
+ "pageNumber"?: number;
44753
+ "total"?: number;
44754
+ "pageCount"?: number;
44755
+ }
44756
+
44326
44757
  export interface Record {
44327
44758
  "name": string;
44328
44759
  "type": string;
@@ -44573,6 +45004,18 @@ declare namespace Models {
44573
45004
  "longitude"?: number;
44574
45005
  }
44575
45006
 
45007
+ export interface RecordingMessageReceipt {
45008
+ "id"?: string;
45009
+ "receiptTime"?: string;
45010
+ "status"?: string;
45011
+ "reasons"?: Array<Models.RecordingMessageReceiptReason>;
45012
+ }
45013
+
45014
+ export interface RecordingMessageReceiptReason {
45015
+ "code"?: string;
45016
+ "message"?: string;
45017
+ }
45018
+
44576
45019
  export interface RecordingMessagingMessage {
44577
45020
  "from"?: string;
44578
45021
  "fromUser"?: Models.User;
@@ -46796,6 +47239,7 @@ declare namespace Models {
46796
47239
  "headerParameters"?: Array<Models.TemplateParameter>;
46797
47240
  "bodyParameters"?: Array<Models.TemplateParameter>;
46798
47241
  "buttonUrlParameters"?: Array<Models.TemplateParameter>;
47242
+ "carouselParameters"?: Models.CarouselParameters;
46799
47243
  }
46800
47244
 
46801
47245
  export interface SentimentData {
@@ -47882,7 +48326,6 @@ declare namespace Models {
47882
48326
  "dateModified"?: string;
47883
48327
  "divisionId"?: string;
47884
48328
  "status"?: string;
47885
- "dataIngestionRulesMetadata"?: Array<Models.DataIngestionRulesMetadata>;
47886
48329
  "selfUri"?: string;
47887
48330
  }
47888
48331
 
@@ -47899,6 +48342,18 @@ declare namespace Models {
47899
48342
  "pageCount"?: number;
47900
48343
  }
47901
48344
 
48345
+ export interface SocialTopicWithDataIngestionRuleMetadataResponse {
48346
+ "id"?: string;
48347
+ "name"?: string;
48348
+ "description"?: string;
48349
+ "dateCreated"?: string;
48350
+ "dateModified"?: string;
48351
+ "divisionId"?: string;
48352
+ "status"?: string;
48353
+ "dataIngestionRulesMetadata"?: Array<Models.DataIngestionRulesMetadata>;
48354
+ "selfUri"?: string;
48355
+ }
48356
+
47902
48357
  export interface SortItem {
47903
48358
  "name"?: string;
47904
48359
  "ascending"?: boolean;
@@ -48026,6 +48481,11 @@ declare namespace Models {
48026
48481
  "staffingGroupAllocations": Array<Models.StaffingGroupAllocation>;
48027
48482
  }
48028
48483
 
48484
+ export interface StaffingGroupFullTimeEquivalentContribution {
48485
+ "staffingGroupId": string;
48486
+ "plannedFullTimeEquivalentContribution": Array<number>;
48487
+ }
48488
+
48029
48489
  export interface StaffingGroupListing {
48030
48490
  "entities"?: Array<Models.StaffingGroupResponse>;
48031
48491
  "downloadUrl"?: string;
@@ -49420,6 +49880,7 @@ declare namespace Models {
49420
49880
  "id"?: string;
49421
49881
  "state"?: string;
49422
49882
  "testTopicPhraseResults"?: Array<Models.TestTopicPhraseTestTopicPhraseResults>;
49883
+ "genAIPhrasesResults"?: Array<string>;
49423
49884
  }
49424
49885
 
49425
49886
  export interface TextBotChannel {
@@ -51250,6 +51711,12 @@ declare namespace Models {
51250
51711
  "resources"?: Models.GuideVersionResources;
51251
51712
  }
51252
51713
 
51714
+ export interface UpdateKpiRequest {
51715
+ "name"?: string;
51716
+ "description"?: string;
51717
+ "status"?: string;
51718
+ }
51719
+
51253
51720
  export interface UpdateManagementUnitRequest {
51254
51721
  "name"?: string;
51255
51722
  "divisionId"?: string;
@@ -55272,6 +55739,83 @@ declare namespace Models {
55272
55739
  "value": number;
55273
55740
  }
55274
55741
 
55742
+ export interface WfmHistoricalAdherenceAgentCalculationsCompleteTopicSecondaryPresenceReference {
55743
+ "id"?: string;
55744
+ }
55745
+
55746
+ export interface WfmHistoricalAdherenceAgentCalculationsCompleteTopicUserReference {
55747
+ "id"?: string;
55748
+ }
55749
+
55750
+ export interface WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceActuals {
55751
+ "actualActivityCategory"?: string;
55752
+ "actualSecondaryPresenceId"?: string;
55753
+ "startOffsetSeconds"?: number;
55754
+ "endOffsetSeconds"?: number;
55755
+ }
55756
+
55757
+ export interface WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceAgentCalculationsCompleteNotification {
55758
+ "jobId"?: string;
55759
+ "queryState"?: string;
55760
+ "downloadUrls"?: Array<string>;
55761
+ "result"?: Models.WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceAgentResult;
55762
+ }
55763
+
55764
+ export interface WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceAgentDayMetrics {
55765
+ "dayStartOffsetSeconds"?: number;
55766
+ "adherenceScheduleSeconds"?: number;
55767
+ "conformanceScheduleSeconds"?: number;
55768
+ "conformanceActualSeconds"?: number;
55769
+ "exceptionCount"?: number;
55770
+ "exceptionDurationSeconds"?: number;
55771
+ "actualLengthSeconds"?: number;
55772
+ "scheduleLengthSeconds"?: number;
55773
+ "impactSeconds"?: number;
55774
+ "adherencePercentage"?: number;
55775
+ "conformancePercentage"?: number;
55776
+ }
55777
+
55778
+ export interface WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceAgentResult {
55779
+ "user"?: Models.WfmHistoricalAdherenceAgentCalculationsCompleteTopicUserReference;
55780
+ "startDate"?: string;
55781
+ "endDate"?: string;
55782
+ "calculationsCompletedDate"?: string;
55783
+ "targetAdherencePercentage"?: number;
55784
+ "adherencePercentage"?: number;
55785
+ "conformancePercentage"?: number;
55786
+ "impact"?: string;
55787
+ "exceptionInfo"?: Array<Models.WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceExceptionInfo>;
55788
+ "dayMetrics"?: Array<Models.WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceAgentDayMetrics>;
55789
+ "actuals"?: Array<Models.WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceActuals>;
55790
+ "scheduledActivities"?: Array<Models.WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceScheduledActivity>;
55791
+ "secondaryPresenceLookupItems"?: Array<Models.WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmSecondaryPresenceLookupItem>;
55792
+ }
55793
+
55794
+ export interface WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceExceptionInfo {
55795
+ "startOffsetSeconds"?: number;
55796
+ "endOffsetSeconds"?: number;
55797
+ "scheduledActivityCodeId"?: string;
55798
+ "scheduledActivityCategory"?: string;
55799
+ "scheduledSecondaryPresenceLookupIds"?: Array<string>;
55800
+ "actualActivityCodeId"?: string;
55801
+ "actualActivityCategory"?: string;
55802
+ "systemPresence"?: string;
55803
+ "routingStatus"?: string;
55804
+ "impact"?: string;
55805
+ "secondaryPresenceLookupId"?: string;
55806
+ }
55807
+
55808
+ export interface WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmHistoricalAdherenceScheduledActivity {
55809
+ "activityCodeId"?: string;
55810
+ "startOffsetSeconds"?: number;
55811
+ "endOffsetSeconds"?: number;
55812
+ }
55813
+
55814
+ export interface WfmHistoricalAdherenceAgentCalculationsCompleteTopicWfmSecondaryPresenceLookupItem {
55815
+ "lookupId"?: string;
55816
+ "secondaryPresence"?: Models.WfmHistoricalAdherenceAgentCalculationsCompleteTopicSecondaryPresenceReference;
55817
+ }
55818
+
55275
55819
  export interface WfmHistoricalAdherenceBulkCalculationsCompleteTopicWfmHistoricalAdherenceBulkCalculationsCompleteNotification {
55276
55820
  "id"?: string;
55277
55821
  "downloadUrls"?: Array<string>;
@@ -57614,6 +58158,7 @@ declare namespace Models {
57614
58158
  "ruleSettings"?: Models.WorkitemRuleSettings;
57615
58159
  "flow"?: Models.WorkitemFlowReference;
57616
58160
  "defaultScript"?: Models.WorkitemScriptReference;
58161
+ "unassignedDivisionContactsEnabled"?: boolean;
57617
58162
  "selfUri"?: string;
57618
58163
  }
57619
58164
 
@@ -57637,6 +58182,7 @@ declare namespace Models {
57637
58182
  "schemaId"?: string;
57638
58183
  "serviceLevelTarget"?: number;
57639
58184
  "ruleSettings"?: Models.WorkitemRuleSettings;
58185
+ "unassignedDivisionContactsEnabled"?: boolean;
57640
58186
  "description"?: string;
57641
58187
  "divisionId"?: string;
57642
58188
  "disableDefaultStatusCreation"?: boolean;
@@ -57714,6 +58260,7 @@ declare namespace Models {
57714
58260
  "schemaId"?: string;
57715
58261
  "serviceLevelTarget"?: number;
57716
58262
  "ruleSettings"?: Models.WorkitemRuleSettings;
58263
+ "unassignedDivisionContactsEnabled"?: boolean;
57717
58264
  "description"?: string;
57718
58265
  "defaultStatusId"?: string;
57719
58266
  "schemaVersion"?: number;
@@ -57748,6 +58295,7 @@ declare namespace Models {
57748
58295
  "ruleSettings"?: Models.WorkitemRuleSettings;
57749
58296
  "flow"?: Models.WorkitemFlowReference;
57750
58297
  "defaultScript"?: Models.WorkitemScriptReference;
58298
+ "unassignedDivisionContactsEnabled"?: boolean;
57751
58299
  "version"?: number;
57752
58300
  "selfUri"?: string;
57753
58301
  }
@@ -57907,4 +58455,11 @@ declare namespace Models {
57907
58455
  "selfUri"?: string;
57908
58456
  }
57909
58457
 
58458
+ export interface YearMonth {
58459
+ "year"?: number;
58460
+ "month"?: string;
58461
+ "monthValue"?: number;
58462
+ "leapYear"?: boolean;
58463
+ }
58464
+
57910
58465
  }