purecloud-platform-client-v2 211.0.0 → 212.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 (91) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +433 -88
  3. package/dist/web-amd/purecloud-platform-client-v2.js +433 -88
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +172 -88
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +173 -89
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +230 -10
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
  11. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +187 -1
  16. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +7 -3
  25. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +3 -2
  32. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -2
  45. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/RoutingApi.js +2 -2
  65. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +156 -1
  75. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/index.js +1 -1
package/index.d.ts CHANGED
@@ -276,6 +276,7 @@ declare class AnalyticsApi {
276
276
  deleteAnalyticsUsersDetailsJob(jobId: string): Promise<void>;
277
277
  getAnalyticsActionsAggregatesJob(jobId: string): Promise<Models.AsyncQueryStatus>;
278
278
  getAnalyticsActionsAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsActionsAggregatesJobResultsOptions): Promise<Models.ActionAsyncAggregateQueryResponse>;
279
+ getAnalyticsAgentStatus(userId: string): Promise<Models.AnalyticsAgentStateAgentResponse>;
279
280
  getAnalyticsAgentcopilotsAggregatesJob(jobId: string): Promise<Models.AsyncQueryStatus>;
280
281
  getAnalyticsAgentcopilotsAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsAgentcopilotsAggregatesJobResultsOptions): Promise<Models.AgentCopilotAsyncAggregateQueryResponse>;
281
282
  getAnalyticsBotflowDivisionsReportingturns(botFlowId: string, opts?: AnalyticsApi.getAnalyticsBotflowDivisionsReportingturnsOptions): Promise<Models.ReportingTurnsResponse>;
@@ -310,6 +311,8 @@ declare class AnalyticsApi {
310
311
  getAnalyticsReportingSettingsUserDashboards(userId: string, opts?: AnalyticsApi.getAnalyticsReportingSettingsUserDashboardsOptions): Promise<Models.DashboardConfigurationListing>;
311
312
  getAnalyticsResolutionsAggregatesJob(jobId: string): Promise<Models.AsyncQueryStatus>;
312
313
  getAnalyticsResolutionsAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsResolutionsAggregatesJobResultsOptions): Promise<Models.ResolutionAsyncAggregateQueryResponse>;
314
+ getAnalyticsSummariesAggregatesJob(jobId: string): Promise<Models.AsyncQueryStatus>;
315
+ getAnalyticsSummariesAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsSummariesAggregatesJobResultsOptions): Promise<Models.SummaryAsyncAggregateQueryResponse>;
313
316
  getAnalyticsSurveysAggregatesJob(jobId: string): Promise<Models.AsyncQueryStatus>;
314
317
  getAnalyticsSurveysAggregatesJobResults(jobId: string, opts?: AnalyticsApi.getAnalyticsSurveysAggregatesJobResultsOptions): Promise<Models.SurveyAsyncAggregateQueryResponse>;
315
318
  getAnalyticsTaskmanagementAggregatesJob(jobId: string): Promise<Models.AsyncQueryStatus>;
@@ -326,6 +329,8 @@ declare class AnalyticsApi {
326
329
  postAnalyticsActionsAggregatesQuery(body: Models.ActionAggregationQuery): Promise<Models.ActionAggregateQueryResponse>;
327
330
  postAnalyticsAgentcopilotsAggregatesJobs(body: Models.AgentCopilotAsyncAggregationQuery): Promise<Models.AsyncQueryResponse>;
328
331
  postAnalyticsAgentcopilotsAggregatesQuery(body: Models.AgentCopilotAggregationQuery): Promise<Models.AgentCopilotAggregateQueryResponse>;
332
+ postAnalyticsAgentsStatusCounts(body: Models.AgentStateCountsRequest): Promise<Models.AnalyticsAgentStateCountsResponse>;
333
+ postAnalyticsAgentsStatusQuery(body: Models.AgentStateQueryRequest): Promise<Models.AnalyticsAgentStateQueryResponse>;
329
334
  postAnalyticsBotsAggregatesJobs(body: Models.BotAsyncAggregationQuery): Promise<Models.AsyncQueryResponse>;
330
335
  postAnalyticsBotsAggregatesQuery(body: Models.BotAggregationQuery): Promise<Models.BotAggregateQueryResponse>;
331
336
  postAnalyticsConversationDetailsProperties(conversationId: string, body: Models.PropertyIndexRequest): Promise<Models.PropertyIndexRequest>;
@@ -355,6 +360,8 @@ declare class AnalyticsApi {
355
360
  postAnalyticsReportingSettingsDashboardsQuery(body: Models.DashboardConfigurationQueryRequest): Promise<Models.DashboardConfigurationListing>;
356
361
  postAnalyticsResolutionsAggregatesJobs(body: Models.ResolutionAsyncAggregationQuery): Promise<Models.AsyncQueryResponse>;
357
362
  postAnalyticsRoutingActivityQuery(body: Models.RoutingActivityQuery, opts?: AnalyticsApi.postAnalyticsRoutingActivityQueryOptions): Promise<Models.RoutingActivityResponse>;
363
+ postAnalyticsSummariesAggregatesJobs(body: Models.SummaryAsyncAggregationQuery): Promise<Models.AsyncQueryResponse>;
364
+ postAnalyticsSummariesAggregatesQuery(body: Models.SummaryAggregationQuery): Promise<Models.SummaryAggregateQueryResponse>;
358
365
  postAnalyticsSurveysAggregatesJobs(body: Models.SurveyAsyncAggregationQuery): Promise<Models.AsyncQueryResponse>;
359
366
  postAnalyticsSurveysAggregatesQuery(body: Models.SurveyAggregationQuery): Promise<Models.SurveyAggregateQueryResponse>;
360
367
  postAnalyticsTaskmanagementAggregatesJobs(body: Models.TaskManagementAsyncAggregationQuery): Promise<Models.AsyncQueryResponse>;
@@ -461,6 +468,9 @@ declare namespace AnalyticsApi {
461
468
  export interface getAnalyticsResolutionsAggregatesJobResultsOptions {
462
469
  "cursor"?: string;
463
470
  }
471
+ export interface getAnalyticsSummariesAggregatesJobResultsOptions {
472
+ "cursor"?: string;
473
+ }
464
474
  export interface getAnalyticsSurveysAggregatesJobResultsOptions {
465
475
  "cursor"?: string;
466
476
  }
@@ -1713,7 +1723,7 @@ declare class ConversationsApi {
1713
1723
  postConversationsMessageParticipantMonitor(conversationId: string, participantId: string): Promise<void>;
1714
1724
  postConversationsMessageParticipantReplace(conversationId: string, participantId: string, body: Models.TransferRequest): Promise<void>;
1715
1725
  postConversationsMessages(body: Models.CreateOutboundMessagingConversationRequest): Promise<Models.CreateOutboundMessagingConversationResponse>;
1716
- postConversationsMessagesAgentless(body: Models.SendAgentlessOutboundMessageRequest): Promise<Models.SendAgentlessOutboundMessageResponse>;
1726
+ postConversationsMessagesAgentless(body: Models.SendAgentlessOutboundMessageRequest, opts?: ConversationsApi.postConversationsMessagesAgentlessOptions): Promise<Models.SendAgentlessOutboundMessageResponse>;
1717
1727
  postConversationsMessagesInboundOpen(body: Models.OpenNormalizedMessage): Promise<Models.OpenNormalizedMessage>;
1718
1728
  postConversationsMessagingIntegrationsFacebook(body: Models.FacebookIntegrationRequest): Promise<Models.FacebookIntegration>;
1719
1729
  postConversationsMessagingIntegrationsInstagram(body: Models.InstagramIntegrationRequest): Promise<Models.InstagramIntegration>;
@@ -1958,6 +1968,9 @@ declare namespace ConversationsApi {
1958
1968
  export interface postConversationsMessageParticipantCommunicationWrapupOptions {
1959
1969
  "body"?: Models.WrapupInput;
1960
1970
  }
1971
+ export interface postConversationsMessagesAgentlessOptions {
1972
+ "useNormalizedMessage"?: boolean;
1973
+ }
1961
1974
  export interface postConversationsScreenshareParticipantCommunicationWrapupOptions {
1962
1975
  "body"?: Models.WrapupInput;
1963
1976
  }
@@ -6198,6 +6211,7 @@ declare class TaskManagementApi {
6198
6211
  deleteTaskmanagementWorkitem(workitemId: string): Promise<void>;
6199
6212
  deleteTaskmanagementWorkitemsSchema(schemaId: string): Promise<void>;
6200
6213
  deleteTaskmanagementWorktype(worktypeId: string): Promise<void>;
6214
+ deleteTaskmanagementWorktypeFlowsDatebasedRule(worktypeId: string, ruleId: string): Promise<void>;
6201
6215
  deleteTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId: string, ruleId: string): Promise<void>;
6202
6216
  deleteTaskmanagementWorktypeFlowsOncreateRule(worktypeId: string, ruleId: string): Promise<void>;
6203
6217
  deleteTaskmanagementWorktypeStatus(worktypeId: string, statusId: string): Promise<void>;
@@ -6218,6 +6232,8 @@ declare class TaskManagementApi {
6218
6232
  getTaskmanagementWorkitemsSchemaVersions(schemaId: string): Promise<Models.DataSchema>;
6219
6233
  getTaskmanagementWorkitemsSchemas(): Promise<Models.DataSchemaListing>;
6220
6234
  getTaskmanagementWorktype(worktypeId: string, opts?: TaskManagementApi.getTaskmanagementWorktypeOptions): Promise<Models.Worktype>;
6235
+ getTaskmanagementWorktypeFlowsDatebasedRule(worktypeId: string, ruleId: string): Promise<Models.WorkitemDateBasedRule>;
6236
+ getTaskmanagementWorktypeFlowsDatebasedRules(worktypeId: string, opts?: TaskManagementApi.getTaskmanagementWorktypeFlowsDatebasedRulesOptions): Promise<Models.WorkitemDateBasedRuleListing>;
6221
6237
  getTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId: string, ruleId: string): Promise<Models.WorkitemOnAttributeChangeRule>;
6222
6238
  getTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId: string, opts?: TaskManagementApi.getTaskmanagementWorktypeFlowsOnattributechangeRulesOptions): Promise<Models.WorkitemOnAttributeChangeRuleListing>;
6223
6239
  getTaskmanagementWorktypeFlowsOncreateRule(worktypeId: string, ruleId: string): Promise<Models.WorkitemOnCreateRule>;
@@ -6233,6 +6249,7 @@ declare class TaskManagementApi {
6233
6249
  patchTaskmanagementWorkitemUserWrapups(workitemId: string, userId: string, body: Models.WorkitemWrapupUpdate): Promise<Models.WorkitemWrapup>;
6234
6250
  patchTaskmanagementWorkitemUsersMeWrapups(workitemId: string, body: Models.WorkitemWrapupUpdate): Promise<Models.WorkitemWrapup>;
6235
6251
  patchTaskmanagementWorktype(worktypeId: string, body: Models.WorktypeUpdate): Promise<Models.Worktype>;
6252
+ patchTaskmanagementWorktypeFlowsDatebasedRule(worktypeId: string, ruleId: string, body: Models.WorkitemDateBasedRuleUpdate): Promise<Models.WorkitemDateBasedRule>;
6236
6253
  patchTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId: string, ruleId: string, body: Models.WorkitemOnAttributeChangeRuleUpdate): Promise<Models.WorkitemOnAttributeChangeRule>;
6237
6254
  patchTaskmanagementWorktypeFlowsOncreateRule(worktypeId: string, ruleId: string, body: Models.WorkitemOnCreateRuleUpdate): Promise<Models.WorkitemOnCreateRule>;
6238
6255
  patchTaskmanagementWorktypeStatus(worktypeId: string, statusId: string, body: Models.WorkitemStatusUpdate): Promise<Models.WorkitemStatus>;
@@ -6245,6 +6262,7 @@ declare class TaskManagementApi {
6245
6262
  postTaskmanagementWorkitemsQuery(body: Models.WorkitemQueryPostRequest): Promise<Models.WorkitemPostQueryEntityListing>;
6246
6263
  postTaskmanagementWorkitemsQueryJobs(body: Models.WorkitemQueryJobCreate): Promise<Models.WorkitemQueryJobResponse>;
6247
6264
  postTaskmanagementWorkitemsSchemas(body: Models.DataSchema): Promise<Models.DataSchema>;
6265
+ postTaskmanagementWorktypeFlowsDatebasedRules(worktypeId: string, body: Models.WorkitemDateBasedRuleCreate): Promise<Models.WorkitemDateBasedRule>;
6248
6266
  postTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId: string, body: Models.WorkitemOnAttributeChangeRuleCreate): Promise<Models.WorkitemOnAttributeChangeRule>;
6249
6267
  postTaskmanagementWorktypeFlowsOncreateRules(worktypeId: string, body: Models.WorkitemOnCreateRuleCreate): Promise<Models.WorkitemOnCreateRule>;
6250
6268
  postTaskmanagementWorktypeStatuses(worktypeId: string, body: Models.WorkitemStatusCreate): Promise<Models.WorkitemStatus>;
@@ -6292,6 +6310,10 @@ declare namespace TaskManagementApi {
6292
6310
  export interface getTaskmanagementWorktypeOptions {
6293
6311
  "expands"?: Array<string>;
6294
6312
  }
6313
+ export interface getTaskmanagementWorktypeFlowsDatebasedRulesOptions {
6314
+ "after"?: string;
6315
+ "pageSize"?: number;
6316
+ }
6295
6317
  export interface getTaskmanagementWorktypeFlowsOnattributechangeRulesOptions {
6296
6318
  "after"?: string;
6297
6319
  "pageSize"?: number;
@@ -9019,6 +9041,57 @@ declare namespace Models {
9019
9041
  "onQueueLengthMinutesPerInterval": Array<number>;
9020
9042
  }
9021
9043
 
9044
+ export interface AgentStateAgentQueryClause {
9045
+ "type": string;
9046
+ "predicates": Array<Models.AgentStateAgentQueryPredicate>;
9047
+ }
9048
+
9049
+ export interface AgentStateAgentQueryPredicate {
9050
+ "dimension": string;
9051
+ "value": string;
9052
+ }
9053
+
9054
+ export interface AgentStateCountsRequest {
9055
+ "userFilter"?: Models.AgentStateUserFilter;
9056
+ "sessionFilter"?: Models.AgentStateSessionFilter;
9057
+ }
9058
+
9059
+ export interface AgentStateQueryRequest {
9060
+ "userFilter"?: Models.AgentStateUserFilter;
9061
+ "sessionFilter"?: Models.AgentStateSessionFilter;
9062
+ "userOrderBy"?: string;
9063
+ "userOrder"?: string;
9064
+ "sessionOrderBy"?: string;
9065
+ "sessionOrder"?: string;
9066
+ }
9067
+
9068
+ export interface AgentStateSegmentTypeCount {
9069
+ "segmentType"?: string;
9070
+ "count"?: number;
9071
+ }
9072
+
9073
+ export interface AgentStateSessionFilter {
9074
+ "type": string;
9075
+ "clauses"?: Array<Models.AgentStateSessionQueryClause>;
9076
+ "predicates"?: Array<Models.AgentStateSessionQueryPredicate>;
9077
+ }
9078
+
9079
+ export interface AgentStateSessionQueryClause {
9080
+ "type": string;
9081
+ "predicates": Array<Models.AgentStateSessionQueryPredicate>;
9082
+ }
9083
+
9084
+ export interface AgentStateSessionQueryPredicate {
9085
+ "dimension": string;
9086
+ "value": string;
9087
+ }
9088
+
9089
+ export interface AgentStateUserFilter {
9090
+ "type": string;
9091
+ "clauses"?: Array<Models.AgentStateAgentQueryClause>;
9092
+ "predicates"?: Array<Models.AgentStateAgentQueryPredicate>;
9093
+ }
9094
+
9022
9095
  export interface AgentTimeOffRequestPatch {
9023
9096
  "markedAsRead"?: boolean;
9024
9097
  "status"?: string;
@@ -9403,6 +9476,36 @@ declare namespace Models {
9403
9476
  "agentGroupType"?: string;
9404
9477
  }
9405
9478
 
9479
+ export interface AnalyticsAgentStateAgentResponse {
9480
+ "userId"?: string;
9481
+ "divisionId"?: string;
9482
+ "userName"?: string;
9483
+ "managerId"?: string;
9484
+ "sessionCount"?: number;
9485
+ "sessions"?: Array<Models.AnalyticsAgentStateAgentSessionResult>;
9486
+ }
9487
+
9488
+ export interface AnalyticsAgentStateAgentSessionResult {
9489
+ "conversationId"?: string;
9490
+ "sessionId"?: string;
9491
+ "sessionStart"?: string;
9492
+ "segmentStart"?: string;
9493
+ "segmentType"?: string;
9494
+ "routedQueueId"?: string;
9495
+ "requestedRoutingSkillIds"?: Array<string>;
9496
+ "requestedLanguageId"?: string;
9497
+ "originatingDirection"?: string;
9498
+ "mediaType"?: string;
9499
+ }
9500
+
9501
+ export interface AnalyticsAgentStateCountsResponse {
9502
+ "counts"?: Array<Models.AgentStateSegmentTypeCount>;
9503
+ }
9504
+
9505
+ export interface AnalyticsAgentStateQueryResponse {
9506
+ "entities"?: Array<Models.AnalyticsAgentStateAgentResponse>;
9507
+ }
9508
+
9406
9509
  export interface AnalyticsConversation {
9407
9510
  "conferenceStart"?: string;
9408
9511
  "conversationEnd"?: string;
@@ -13044,7 +13147,7 @@ declare namespace Models {
13044
13147
  "dateModified"?: string;
13045
13148
  "version"?: number;
13046
13149
  "intervals": Array<Models.ScheduleInterval>;
13047
- "timeZone": string;
13150
+ "timeZone"?: string;
13048
13151
  "campaign": Models.DivisionedDomainEntityRef;
13049
13152
  "selfUri"?: string;
13050
13153
  }
@@ -18906,6 +19009,7 @@ declare namespace Models {
18906
19009
  "nameIdentifierFormat"?: string;
18907
19010
  "ssoBinding"?: string;
18908
19011
  "signAuthnRequests"?: boolean;
19012
+ "providerName"?: string;
18909
19013
  "selfUri"?: string;
18910
19014
  }
18911
19015
 
@@ -22096,13 +22200,6 @@ declare namespace Models {
22096
22200
  "disconnectType": string;
22097
22201
  }
22098
22202
 
22099
- export interface EmailCommunicationRepliedEvent {
22100
- "eventId": string;
22101
- "eventDateTime": string;
22102
- "conversationId": string;
22103
- "communicationId": string;
22104
- }
22105
-
22106
22203
  export interface EmailCommunicationSentMessageEvent {
22107
22204
  "eventId": string;
22108
22205
  "eventDateTime": string;
@@ -24084,6 +24181,14 @@ declare namespace Models {
24084
24181
  "selfUri"?: string;
24085
24182
  }
24086
24183
 
24184
+ export interface ExternalOrganizationIdentifier {
24185
+ "id"?: string;
24186
+ "type": string;
24187
+ "value": string;
24188
+ "dateCreated"?: string;
24189
+ "selfUri"?: string;
24190
+ }
24191
+
24087
24192
  export interface ExternalOrganizationListing {
24088
24193
  "entities"?: Array<Models.ExternalOrganization>;
24089
24194
  "pageSize"?: number;
@@ -25233,6 +25338,8 @@ declare namespace Models {
25233
25338
 
25234
25339
  export interface FlowPaths {
25235
25340
  "category": string;
25341
+ "dateStart"?: string;
25342
+ "dateEnd"?: string;
25236
25343
  "elements": { [key: string]: Models.FlowPathsElement; };
25237
25344
  }
25238
25345
 
@@ -41282,7 +41389,7 @@ declare namespace Models {
41282
41389
  "dateModified"?: string;
41283
41390
  "version"?: number;
41284
41391
  "intervals": Array<Models.ScheduleInterval>;
41285
- "timeZone": string;
41392
+ "timeZone"?: string;
41286
41393
  "sequence": Models.DomainEntityRef;
41287
41394
  "selfUri"?: string;
41288
41395
  }
@@ -42592,6 +42699,75 @@ declare namespace Models {
42592
42699
  "data"?: { [key: string]: string; };
42593
42700
  }
42594
42701
 
42702
+ export interface SummaryAggregateDataContainer {
42703
+ "group"?: { [key: string]: string; };
42704
+ "data"?: Array<Models.StatisticalResponse>;
42705
+ }
42706
+
42707
+ export interface SummaryAggregateQueryClause {
42708
+ "type": string;
42709
+ "predicates": Array<Models.SummaryAggregateQueryPredicate>;
42710
+ }
42711
+
42712
+ export interface SummaryAggregateQueryFilter {
42713
+ "type": string;
42714
+ "clauses"?: Array<Models.SummaryAggregateQueryClause>;
42715
+ "predicates"?: Array<Models.SummaryAggregateQueryPredicate>;
42716
+ }
42717
+
42718
+ export interface SummaryAggregateQueryPredicate {
42719
+ "type"?: string;
42720
+ "dimension"?: string;
42721
+ "operator"?: string;
42722
+ "value"?: string;
42723
+ "range"?: Models.NumericRange;
42724
+ }
42725
+
42726
+ export interface SummaryAggregateQueryResponse {
42727
+ "results"?: Array<Models.SummaryAggregateDataContainer>;
42728
+ }
42729
+
42730
+ export interface SummaryAggregationQuery {
42731
+ "interval": string;
42732
+ "granularity"?: string;
42733
+ "timeZone"?: string;
42734
+ "groupBy"?: Array<string>;
42735
+ "filter"?: Models.SummaryAggregateQueryFilter;
42736
+ "metrics": Array<string>;
42737
+ "flattenMultivaluedDimensions"?: boolean;
42738
+ "views"?: Array<Models.SummaryAggregationView>;
42739
+ "alternateTimeDimension"?: string;
42740
+ "queryType"?: string;
42741
+ "limit"?: number;
42742
+ }
42743
+
42744
+ export interface SummaryAggregationView {
42745
+ "target": string;
42746
+ "name": string;
42747
+ "function": string;
42748
+ "range"?: Models.AggregationRange;
42749
+ }
42750
+
42751
+ export interface SummaryAsyncAggregateQueryResponse {
42752
+ "results"?: Array<Models.SummaryAggregateDataContainer>;
42753
+ "cursor"?: string;
42754
+ }
42755
+
42756
+ export interface SummaryAsyncAggregationQuery {
42757
+ "interval": string;
42758
+ "granularity"?: string;
42759
+ "timeZone"?: string;
42760
+ "groupBy"?: Array<string>;
42761
+ "filter"?: Models.SummaryAggregateQueryFilter;
42762
+ "metrics": Array<string>;
42763
+ "flattenMultivaluedDimensions"?: boolean;
42764
+ "views"?: Array<Models.SummaryAggregationView>;
42765
+ "alternateTimeDimension"?: string;
42766
+ "queryType"?: string;
42767
+ "limit"?: number;
42768
+ "pageSize"?: number;
42769
+ }
42770
+
42595
42771
  export interface SummaryGenerationConfig {
42596
42772
  "enabled": boolean;
42597
42773
  }
@@ -49157,6 +49333,12 @@ declare namespace Models {
49157
49333
  "entities"?: Array<Models.WhatsAppAvailablePhoneNumberDetails>;
49158
49334
  }
49159
49335
 
49336
+ export interface WhatsAppConfig {
49337
+ "whatsAppColumns": Array<string>;
49338
+ "whatsAppIntegration": Models.AddressableEntityRef;
49339
+ "contentTemplate": Models.DomainEntityRef;
49340
+ }
49341
+
49160
49342
  export interface WhatsAppDefinition {
49161
49343
  "name": string;
49162
49344
  "namespace"?: string;
@@ -49859,6 +50041,44 @@ declare namespace Models {
49859
50041
  "preferredAgentIds"?: Array<string>;
49860
50042
  }
49861
50043
 
50044
+ export interface WorkitemDateBasedCondition {
50045
+ "attribute": string;
50046
+ "relativeMinutesToInvocation": number;
50047
+ }
50048
+
50049
+ export interface WorkitemDateBasedConditionUpdate {
50050
+ "attribute"?: string;
50051
+ "relativeMinutesToInvocation"?: number;
50052
+ }
50053
+
50054
+ export interface WorkitemDateBasedRule {
50055
+ "id"?: string;
50056
+ "name"?: string;
50057
+ "type"?: string;
50058
+ "action"?: Models.WorkitemRuleAction;
50059
+ "worktype"?: Models.WorktypeReference;
50060
+ "condition"?: Models.WorkitemDateBasedCondition;
50061
+ "selfUri"?: string;
50062
+ }
50063
+
50064
+ export interface WorkitemDateBasedRuleCreate {
50065
+ "name": string;
50066
+ "condition": Models.WorkitemDateBasedCondition;
50067
+ }
50068
+
50069
+ export interface WorkitemDateBasedRuleListing {
50070
+ "entities"?: Array<Models.WorkitemDateBasedRule>;
50071
+ "nextUri"?: string;
50072
+ "selfUri"?: string;
50073
+ "previousUri"?: string;
50074
+ "after"?: string;
50075
+ }
50076
+
50077
+ export interface WorkitemDateBasedRuleUpdate {
50078
+ "name"?: string;
50079
+ "condition"?: Models.WorkitemDateBasedConditionUpdate;
50080
+ }
50081
+
49862
50082
  export interface WorkitemDelta {
49863
50083
  "name"?: Models.WorkitemsAttributeChangeString;
49864
50084
  "description"?: Models.WorkitemsAttributeChangeString;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "211.0.0",
3
+ "version": "212.0.0",
4
4
  "description": "A JavaScript library to interface with the PureCloud Platform API",
5
5
  "license": "MIT",
6
6
  "main": "dist/node/purecloud-platform-client-v2.js",
@@ -7,7 +7,7 @@ import { default as qs } from 'qs';
7
7
 
8
8
  /**
9
9
  * @module purecloud-platform-client-v2/ApiClient
10
- * @version 211.0.0
10
+ * @version 212.0.0
11
11
  */
12
12
  class ApiClient {
13
13
  /**
@@ -980,7 +980,7 @@ class ApiClient {
980
980
  'Authorization': 'Basic ' + encodedData,
981
981
  'Content-Type': 'application/x-www-form-urlencoded'
982
982
  };
983
- var requestOptions = new HttpRequestOptions(loginBasePath, `POST`, headers, null, qs.stringify(data), this.timeout);
983
+ var requestOptions = new HttpRequestOptions(`${loginBasePath}/oauth/token`, `POST`, headers, null, qs.stringify(data), this.timeout);
984
984
  const httpClient = this.getHttpClient();
985
985
  return httpClient.request(requestOptions);
986
986
  }
@@ -5,7 +5,7 @@ class AgentAssistantsApi {
5
5
  /**
6
6
  * AgentAssistants service.
7
7
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
8
- * @version 211.0.0
8
+ * @version 212.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AgentCopilotApi {
5
5
  /**
6
6
  * AgentCopilot service.
7
7
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
8
- * @version 211.0.0
8
+ * @version 212.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AgentUIApi {
5
5
  /**
6
6
  * AgentUI service.
7
7
  * @module purecloud-platform-client-v2/api/AgentUIApi
8
- * @version 211.0.0
8
+ * @version 212.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AlertingApi {
5
5
  /**
6
6
  * Alerting service.
7
7
  * @module purecloud-platform-client-v2/api/AlertingApi
8
- * @version 211.0.0
8
+ * @version 212.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AnalyticsApi {
5
5
  /**
6
6
  * Analytics service.
7
7
  * @module purecloud-platform-client-v2/api/AnalyticsApi
8
- * @version 211.0.0
8
+ * @version 212.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -126,6 +126,32 @@ class AnalyticsApi {
126
126
  );
127
127
  }
128
128
 
129
+ /**
130
+ * Get an agent and their active sessions by user ID
131
+ *
132
+ * @param {String} userId userId
133
+ * getAnalyticsAgentStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
134
+ */
135
+ getAnalyticsAgentStatus(userId) {
136
+ // verify the required parameter 'userId' is set
137
+ if (userId === undefined || userId === null) {
138
+ throw 'Missing the required parameter "userId" when calling getAnalyticsAgentStatus';
139
+ }
140
+
141
+ return this.apiClient.callApi(
142
+ '/api/v2/analytics/agents/{userId}/status',
143
+ 'GET',
144
+ { 'userId': userId },
145
+ { },
146
+ { },
147
+ { },
148
+ null,
149
+ ['PureCloud OAuth'],
150
+ ['application/json'],
151
+ ['application/json']
152
+ );
153
+ }
154
+
129
155
  /**
130
156
  * Get status for async query for agent copilot aggregates
131
157
  *
@@ -1069,6 +1095,62 @@ class AnalyticsApi {
1069
1095
  );
1070
1096
  }
1071
1097
 
1098
+ /**
1099
+ * Get status for async query for summary aggregates
1100
+ *
1101
+ * @param {String} jobId jobId
1102
+ * getAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1103
+ */
1104
+ getAnalyticsSummariesAggregatesJob(jobId) {
1105
+ // verify the required parameter 'jobId' is set
1106
+ if (jobId === undefined || jobId === null) {
1107
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsSummariesAggregatesJob';
1108
+ }
1109
+
1110
+ return this.apiClient.callApi(
1111
+ '/api/v2/analytics/summaries/aggregates/jobs/{jobId}',
1112
+ 'GET',
1113
+ { 'jobId': jobId },
1114
+ { },
1115
+ { },
1116
+ { },
1117
+ null,
1118
+ ['PureCloud OAuth'],
1119
+ ['application/json'],
1120
+ ['application/json']
1121
+ );
1122
+ }
1123
+
1124
+ /**
1125
+ * Fetch a page of results for an async aggregates query
1126
+ *
1127
+ * @param {String} jobId jobId
1128
+ * @param {Object} opts Optional parameters
1129
+ * @param {String} opts.cursor Cursor token to retrieve next page
1130
+ * getAnalyticsSummariesAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1131
+ */
1132
+ getAnalyticsSummariesAggregatesJobResults(jobId, opts) {
1133
+ opts = opts || {};
1134
+
1135
+ // verify the required parameter 'jobId' is set
1136
+ if (jobId === undefined || jobId === null) {
1137
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsSummariesAggregatesJobResults';
1138
+ }
1139
+
1140
+ return this.apiClient.callApi(
1141
+ '/api/v2/analytics/summaries/aggregates/jobs/{jobId}/results',
1142
+ 'GET',
1143
+ { 'jobId': jobId },
1144
+ { 'cursor': opts['cursor'] },
1145
+ { },
1146
+ { },
1147
+ null,
1148
+ ['PureCloud OAuth'],
1149
+ ['application/json'],
1150
+ ['application/json']
1151
+ );
1152
+ }
1153
+
1072
1154
  /**
1073
1155
  * Get status for async query for survey aggregates
1074
1156
  *
@@ -1495,6 +1577,58 @@ class AnalyticsApi {
1495
1577
  );
1496
1578
  }
1497
1579
 
1580
+ /**
1581
+ * Count agents by segment type
1582
+ *
1583
+ * @param {Object} body query
1584
+ * postAnalyticsAgentsStatusCounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1585
+ */
1586
+ postAnalyticsAgentsStatusCounts(body) {
1587
+ // verify the required parameter 'body' is set
1588
+ if (body === undefined || body === null) {
1589
+ throw 'Missing the required parameter "body" when calling postAnalyticsAgentsStatusCounts';
1590
+ }
1591
+
1592
+ return this.apiClient.callApi(
1593
+ '/api/v2/analytics/agents/status/counts',
1594
+ 'POST',
1595
+ { },
1596
+ { },
1597
+ { },
1598
+ { },
1599
+ body,
1600
+ ['PureCloud OAuth'],
1601
+ ['application/json'],
1602
+ ['application/json']
1603
+ );
1604
+ }
1605
+
1606
+ /**
1607
+ * Retrieve the top 50 agents matching the query filters
1608
+ *
1609
+ * @param {Object} body query
1610
+ * postAnalyticsAgentsStatusQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1611
+ */
1612
+ postAnalyticsAgentsStatusQuery(body) {
1613
+ // verify the required parameter 'body' is set
1614
+ if (body === undefined || body === null) {
1615
+ throw 'Missing the required parameter "body" when calling postAnalyticsAgentsStatusQuery';
1616
+ }
1617
+
1618
+ return this.apiClient.callApi(
1619
+ '/api/v2/analytics/agents/status/query',
1620
+ 'POST',
1621
+ { },
1622
+ { },
1623
+ { },
1624
+ { },
1625
+ body,
1626
+ ['PureCloud OAuth'],
1627
+ ['application/json'],
1628
+ ['application/json']
1629
+ );
1630
+ }
1631
+
1498
1632
  /**
1499
1633
  * Query for bot aggregates asynchronously
1500
1634
  *
@@ -2248,6 +2382,58 @@ class AnalyticsApi {
2248
2382
  );
2249
2383
  }
2250
2384
 
2385
+ /**
2386
+ * Query for summary aggregates asynchronously
2387
+ *
2388
+ * @param {Object} body query
2389
+ * postAnalyticsSummariesAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2390
+ */
2391
+ postAnalyticsSummariesAggregatesJobs(body) {
2392
+ // verify the required parameter 'body' is set
2393
+ if (body === undefined || body === null) {
2394
+ throw 'Missing the required parameter "body" when calling postAnalyticsSummariesAggregatesJobs';
2395
+ }
2396
+
2397
+ return this.apiClient.callApi(
2398
+ '/api/v2/analytics/summaries/aggregates/jobs',
2399
+ 'POST',
2400
+ { },
2401
+ { },
2402
+ { },
2403
+ { },
2404
+ body,
2405
+ ['PureCloud OAuth'],
2406
+ ['application/json'],
2407
+ ['application/json']
2408
+ );
2409
+ }
2410
+
2411
+ /**
2412
+ * Query for summary aggregates
2413
+ *
2414
+ * @param {Object} body query
2415
+ * postAnalyticsSummariesAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2416
+ */
2417
+ postAnalyticsSummariesAggregatesQuery(body) {
2418
+ // verify the required parameter 'body' is set
2419
+ if (body === undefined || body === null) {
2420
+ throw 'Missing the required parameter "body" when calling postAnalyticsSummariesAggregatesQuery';
2421
+ }
2422
+
2423
+ return this.apiClient.callApi(
2424
+ '/api/v2/analytics/summaries/aggregates/query',
2425
+ 'POST',
2426
+ { },
2427
+ { },
2428
+ { },
2429
+ { },
2430
+ body,
2431
+ ['PureCloud OAuth'],
2432
+ ['application/json'],
2433
+ ['application/json']
2434
+ );
2435
+ }
2436
+
2251
2437
  /**
2252
2438
  * Query for survey aggregates asynchronously
2253
2439
  *