purecloud-platform-client-v2 174.0.0 → 176.0.0

package/index.d.ts

@@ -383,6 +383,9 @@ declare class ArchitectApi {
   	getFlowLatestconfiguration(flowId: string, opts?: ArchitectApi.getFlowLatestconfigurationOptions): Promise<object>; 
   	getFlowVersion(flowId: string, versionId: string, opts?: ArchitectApi.getFlowVersionOptions): Promise<Models.FlowVersion>; 
   	getFlowVersionConfiguration(flowId: string, versionId: string, opts?: ArchitectApi.getFlowVersionConfigurationOptions): Promise<object>; 
+  	getFlowVersionHealth(flowId: string, versionId: string, opts?: ArchitectApi.getFlowVersionHealthOptions): Promise<Models.FlowHealth>; 
+  	getFlowVersionIntentHealth(flowId: string, versionId: string, intentId: string, language: string): Promise<Models.FlowHealthIntent>; 
+  	getFlowVersionIntentUtteranceHealth(flowId: string, versionId: string, intentId: string, utteranceId: string, language: string): Promise<Models.FlowHealthUtterance>; 
   	getFlowVersions(flowId: string, opts?: ArchitectApi.getFlowVersionsOptions): Promise<Models.FlowVersionEntityListing>; 
   	getFlows(opts?: ArchitectApi.getFlowsOptions): Promise<Models.FlowEntityListing>; 
   	getFlowsDatatable(datatableId: string, opts?: ArchitectApi.getFlowsDatatableOptions): Promise<Models.DataTable>; 
@@ -656,6 +659,9 @@ declare namespace ArchitectApi {
 	export interface getFlowVersionConfigurationOptions { 
 		"deleted"?: string;
 	}
+	export interface getFlowVersionHealthOptions { 
+		"language"?: string;
+	}
 	export interface getFlowVersionsOptions { 
 		"pageNumber"?: number;
 		"pageSize"?: number;
@@ -993,15 +999,70 @@ declare namespace CarrierServicesApi {
 }
 
 declare class ChatApi {  
+  	deleteChatsRoomMessage(roomJid: string, messageId: string): Promise<void>; 
+  	deleteChatsRoomParticipant(roomJid: string, userId: string): Promise<void>; 
+  	deleteChatsRoomPinnedmessage(roomJid: string, pinnedMessageId: string): Promise<void>; 
+  	deleteChatsUserMessage(userId: string, messageId: string): Promise<void>; 
   	getChatSettings(): Promise<Models.ChatSettings>; 
+  	getChatsMessage(messageId: string): Promise<Models.ChatMessageResponse>; 
+  	getChatsRoom(roomJid: string): Promise<Models.Room>; 
+  	getChatsRoomMessage(roomJid: string, messageIds: string): Promise<Models.ChatMessageEntityListing>; 
+  	getChatsRoomMessages(roomJid: string, opts?: ChatApi.getChatsRoomMessagesOptions): Promise<Models.ChatMessageEntityListing>; 
   	getChatsSettings(): Promise<Models.ChatSettings>; 
+  	getChatsThreadMessages(threadId: string, opts?: ChatApi.getChatsThreadMessagesOptions): Promise<Models.ChatMessageEntityListing>; 
+  	getChatsUserMessage(userId: string, messageIds: string): Promise<Models.ChatMessageEntityListing>; 
+  	getChatsUserMessages(userId: string, opts?: ChatApi.getChatsUserMessagesOptions): Promise<Models.ChatMessageResponse>; 
   	patchChatSettings(body: Models.ChatSettings): Promise<Models.ChatSettings>; 
+  	patchChatsRoom(roomJid: string, body: Models.RoomUpdateRequest): Promise<void>; 
+  	patchChatsRoomMessage(roomJid: string, messageId: string, body: Models.SendMessageBody): Promise<Models.ChatSendMessageResponse>; 
   	patchChatsSettings(body: Models.ChatSettings): Promise<Models.ChatSettings>; 
+  	patchChatsUserMessage(userId: string, messageId: string, body: Models.SendMessageBody): Promise<Models.ChatSendMessageResponse>; 
+  	postChatsRoomMessages(roomJid: string, body: Models.SendMessageBody): Promise<Models.ChatSendMessageResponse>; 
+  	postChatsRoomParticipant(roomJid: string, userId: string): Promise<void>; 
+  	postChatsRoomPinnedmessages(roomJid: string, body: Models.PinnedMessageRequest): Promise<void>; 
+  	postChatsRooms(opts?: ChatApi.postChatsRoomsOptions): Promise<Models.CreateRoomResponse>; 
+  	postChatsUserMessages(userId: string, body: Models.SendMessageBody): Promise<Models.ChatSendMessageResponse>; 
   	putChatSettings(body: Models.ChatSettings): Promise<Models.ChatSettings>; 
   	putChatsSettings(body: Models.ChatSettings): Promise<Models.ChatSettings>;
 }
 
 declare namespace ChatApi { 
+	export interface getChatsRoomMessagesOptions { 
+		"pageSize"?: number;
+		"pageNumber"?: number;
+		"sortBy"?: string;
+		"expand"?: Array<string>;
+		"nextPage"?: string;
+		"previousPage"?: string;
+		"limit"?: string;
+		"before"?: string;
+		"after"?: string;
+	}
+	export interface getChatsThreadMessagesOptions { 
+		"pageSize"?: number;
+		"pageNumber"?: number;
+		"sortBy"?: string;
+		"expand"?: Array<string>;
+		"nextPage"?: string;
+		"previousPage"?: string;
+		"limit"?: string;
+		"before"?: string;
+		"after"?: string;
+	}
+	export interface getChatsUserMessagesOptions { 
+		"pageSize"?: number;
+		"pageNumber"?: number;
+		"sortBy"?: string;
+		"expand"?: Array<string>;
+		"nextPage"?: string;
+		"previousPage"?: string;
+		"limit"?: string;
+		"before"?: string;
+		"after"?: string;
+	}
+	export interface postChatsRoomsOptions { 
+		"body"?: Models.CreateRoomRequest;
+	}
 }
 
 declare class CoachingApi {  
@@ -3071,7 +3132,7 @@ declare class LearningApi {
   	postLearningAssignmentsBulkadd(opts?: LearningApi.postLearningAssignmentsBulkaddOptions): Promise<Models.LearningAssignmentBulkAddResponse>; 
   	postLearningAssignmentsBulkremove(opts?: LearningApi.postLearningAssignmentsBulkremoveOptions): Promise<Models.LearningAssignmentBulkRemoveResponse>; 
   	postLearningModuleJobs(moduleId: string, body: Models.LearningModuleJobRequest): Promise<Models.LearningModuleJobResponse>; 
-  	postLearningModulePublish(moduleId: string): Promise<Models.LearningModulePublishResponse>; 
+  	postLearningModulePublish(moduleId: string, opts?: LearningApi.postLearningModulePublishOptions): Promise<Models.LearningModulePublishResponse>; 
   	postLearningModules(body: Models.LearningModuleRequest): Promise<Models.LearningModule>; 
   	postLearningRulesQuery(pageSize: number, pageNumber: number, body: Models.LearningAssignmentUserQuery): Promise<Models.LearningAssignmentUserListing>; 
   	postLearningScheduleslotsQuery(body: Models.LearningScheduleSlotsQueryRequest): Promise<Models.LearningScheduleSlotsQueryResponse>; 
@@ -3157,6 +3218,9 @@ declare namespace LearningApi {
 	export interface postLearningAssignmentsBulkremoveOptions { 
 		"body"?: Array<string>;
 	}
+	export interface postLearningModulePublishOptions { 
+		"body"?: Models.LearningModulePublishRequest;
+	}
 }
 
 declare class LicenseApi {  
@@ -4697,8 +4761,8 @@ declare namespace RoutingApi {
 		"pageNumber"?: number;
 		"sortBy"?: string;
 		"sortOrder"?: string;
-		"id"?: Array<string>;
 		"name"?: string;
+		"id"?: Array<string>;
 		"divisionId"?: Array<string>;
 	}
 	export interface getUserQueuesOptions { 
@@ -7563,6 +7627,22 @@ declare namespace Models {
 		"type": string;
 	}
 	
+	export interface AlertSummary { 
+		"entities": Array<Models.AlertSummaryEntity>;
+		"conversation"?: Models.AddressableEntityRef;
+		"metricType": string;
+		"entitiesAreTeamMembers": boolean;
+	}
+	
+	export interface AlertSummaryEntity { 
+		"entityType": string;
+		"user"?: Models.AddressableEntityRef;
+		"group"?: Models.AddressableEntityRef;
+		"queue"?: Models.AddressableEntityRef;
+		"team"?: Models.AddressableEntityRef;
+		"alerting": boolean;
+	}
+	
 	export interface AlertingUnreadStatus { 
 		"unread": boolean;
 	}
@@ -7780,6 +7860,7 @@ declare namespace Models {
 	export interface AnalyticsReportingSettings { 
 		"piiMaskingEnabled"?: boolean;
 		"queueAgentAccessObfuscation"?: boolean;
+		"myInteractionsPiiMaskingEnabled"?: boolean;
 	}
 	
 	export interface AnalyticsResolution { 
@@ -9766,11 +9847,21 @@ declare namespace Models {
 		"defaultHistoryWeeks"?: number;
 	}
 	
+	export interface BuUpdateAgentScheduleShift { 
+		"id"?: string;
+		"startDate"?: string;
+		"lengthMinutes"?: number;
+		"activities"?: Array<Models.BuAgentScheduleActivity>;
+		"manuallyEdited"?: boolean;
+		"schedule"?: Models.BuScheduleReference;
+		"delete"?: boolean;
+	}
+	
 	export interface BuUpdateAgentScheduleUploadSchema { 
 		"userId": string;
 		"workPlanId"?: Models.ValueWrapperString;
 		"workPlanIdsPerWeek"?: Models.ListWrapperString;
-		"shifts"?: Array<Models.BuAgentScheduleShift>;
+		"shifts"?: Array<Models.BuUpdateAgentScheduleShift>;
 		"fullDayTimeOffMarkers"?: Array<Models.BuFullDayTimeOffMarker>;
 		"metadata"?: Models.WfmVersionedEntityMetadata;
 		"delete"?: boolean;
@@ -10639,6 +10730,8 @@ declare namespace Models {
 		"enableAutoAnswer"?: boolean;
 		"alertingTimeoutSeconds"?: number;
 		"serviceLevel"?: Models.ServiceLevel;
+		"autoAnswerAlertToneSeconds"?: number;
+		"manualAnswerAlertToneSeconds"?: number;
 		"subTypeSettings"?: { [key: string]: Models.BaseMediaSettings; };
 	}
 	
@@ -10686,6 +10779,7 @@ declare namespace Models {
 		"outstandingInteractionsCount"?: number;
 		"scheduledInteractionsCount"?: number;
 		"timeZoneRescheduledCallsCount"?: number;
+		"campaignSkillStatistics"?: Models.CampaignSkillStatistics;
 	}
 	
 	export interface CampaignDivisionView { 
@@ -10861,6 +10955,11 @@ declare namespace Models {
 		"pageCount"?: number;
 	}
 	
+	export interface CampaignSkillStatistics { 
+		"skillCombinations"?: number;
+		"eligibleSkilledAgents"?: number;
+	}
+	
 	export interface CampaignStats { 
 		"contactRate"?: Models.ConnectRate;
 		"idleAgents"?: number;
@@ -11126,6 +11225,24 @@ declare namespace Models {
 		"user"?: Models.ChatMessageUser;
 	}
 	
+	export interface ChatMessageEntityListing { 
+		"entities"?: Array<Models.ChatMessageResponse>;
+	}
+	
+	export interface ChatMessageResponse { 
+		"id": string;
+		"dateCreated": string;
+		"dateModified"?: string;
+		"toJid": string;
+		"jid": string;
+		"body": string;
+		"mentions"?: { [key: string]: string; };
+		"edited"?: boolean;
+		"attachmentDeleted"?: boolean;
+		"fileUri"?: string;
+		"thread": Models.Entity;
+	}
+	
 	export interface ChatMessageUser { 
 		"id"?: string;
 		"name"?: string;
@@ -11134,6 +11251,10 @@ declare namespace Models {
 		"images"?: Array<Models.UserImage>;
 	}
 	
+	export interface ChatSendMessageResponse { 
+		"id": string;
+	}
+	
 	export interface ChatSettings { 
 		"messageRetentionPeriodDays"?: number;
 	}
@@ -11498,6 +11619,7 @@ declare namespace Models {
 		"dateSnoozedUntil": string;
 		"conditions": Models.CommonRuleConditions;
 		"conversationId"?: string;
+		"alertSummary"?: Models.AlertSummary;
 		"ruleUri"?: string;
 		"selfUri"?: string;
 	}
@@ -11710,6 +11832,34 @@ declare namespace Models {
 		"priority"?: boolean;
 	}
 	
+	export interface ConfusionDetails { 
+		"intents"?: Array<Models.ConfusionIntentDetails>;
+	}
+	
+	export interface ConfusionInfo { 
+		"intents"?: Array<Models.ConfusionIntentInfo>;
+	}
+	
+	export interface ConfusionIntentDetails { 
+		"id"?: string;
+		"name"?: string;
+		"utteranceCount"?: number;
+		"utterances"?: Array<Models.ConfusionUtterance>;
+		"selfUri"?: string;
+	}
+	
+	export interface ConfusionIntentInfo { 
+		"id"?: string;
+		"name"?: string;
+		"utteranceCount"?: number;
+	}
+	
+	export interface ConfusionUtterance { 
+		"id"?: string;
+		"text"?: string;
+		"similarity"?: number;
+	}
+	
 	export interface ConnectRate { 
 		"attempts"?: number;
 		"connects"?: number;
@@ -11920,6 +12070,7 @@ declare namespace Models {
 		"automaticTimeZoneMapping"?: boolean;
 		"zipCodeColumnName"?: string;
 		"columnDataTypeSpecifications"?: Array<Models.ColumnDataTypeSpecification>;
+		"trimWhitespace"?: boolean;
 		"selfUri"?: string;
 	}
 	
@@ -11967,7 +12118,7 @@ declare namespace Models {
 		"dateCreated"?: string;
 		"dateModified"?: string;
 		"version"?: number;
-		"contactList": Models.DomainEntityRef;
+		"contactList"?: Models.DomainEntityRef;
 		"clauses"?: Array<Models.ContactListFilterClause>;
 		"filterType"?: string;
 		"selfUri"?: string;
@@ -15027,6 +15178,14 @@ declare namespace Models {
 		"headers"?: { [key: string]: string; };
 	}
 	
+	export interface CreateRoomRequest { 
+		"description": string;
+	}
+	
+	export interface CreateRoomResponse { 
+		"jid": string;
+	}
+	
 	export interface CreateSecureSession { 
 		"sourceParticipantId"?: string;
 		"flowId": string;
@@ -15877,6 +16036,7 @@ declare namespace Models {
 	export interface DetectedNamedEntityValue { 
 		"raw"?: string;
 		"resolved"?: string;
+		"unit"?: string;
 	}
 	
 	export interface DevelopmentActivity { 
@@ -17562,8 +17722,8 @@ declare namespace Models {
 		"permissionPolicies"?: Array<Models.DomainPermissionPolicy>;
 		"userCount"?: number;
 		"roleNeedsUpdate"?: boolean;
-		"base"?: boolean;
 		"default"?: boolean;
+		"base"?: boolean;
 		"selfUri"?: string;
 	}
 	
@@ -17577,8 +17737,8 @@ declare namespace Models {
 		"permissionPolicies"?: Array<Models.DomainPermissionPolicy>;
 		"userCount"?: number;
 		"roleNeedsUpdate"?: boolean;
-		"base"?: boolean;
 		"default"?: boolean;
+		"base"?: boolean;
 		"selfUri"?: string;
 	}
 	
@@ -17592,8 +17752,8 @@ declare namespace Models {
 		"permissionPolicies"?: Array<Models.DomainPermissionPolicy>;
 		"userCount"?: number;
 		"roleNeedsUpdate"?: boolean;
-		"base"?: boolean;
 		"default"?: boolean;
+		"base"?: boolean;
 		"selfUri"?: string;
 	}
 	
@@ -20238,6 +20398,67 @@ declare namespace Models {
 		"selfUri"?: string;
 	}
 	
+	export interface FlowHealth { 
+		"flowVersionInfo"?: Models.FlowHealthVersionInfo;
+		"languageInfo"?: { [key: string]: Models.LocaleInfo; };
+		"intents"?: Array<Models.FlowHealthIntentInfo>;
+		"selfUri"?: string;
+	}
+	
+	export interface FlowHealthErrorInfo { 
+		"message"?: string;
+		"code"?: string;
+		"messageWithParams"?: string;
+		"messageParams"?: { [key: string]: object; };
+	}
+	
+	export interface FlowHealthIntent { 
+		"id"?: string;
+		"name"?: string;
+		"flowVersionInfo"?: Models.FlowHealthIntentVersionInfo;
+		"language"?: string;
+		"health"?: Models.HealthInfo;
+		"selfUri"?: string;
+	}
+	
+	export interface FlowHealthIntentInfo { 
+		"id"?: string;
+		"name"?: string;
+		"languageHealth"?: { [key: string]: Models.LocaleHealth; };
+		"selfUri"?: string;
+	}
+	
+	export interface FlowHealthIntentUtterance { 
+		"id"?: string;
+		"text"?: string;
+		"issueCount"?: number;
+		"staticValidationResults"?: Array<string>;
+		"outlierInfo"?: Models.OutlierInfo;
+		"confusionInfo"?: Models.ConfusionInfo;
+	}
+	
+	export interface FlowHealthIntentVersionInfo { 
+		"nluVersion"?: Models.AddressableEntityRef;
+		"flowVersion"?: Models.AddressableEntityRef;
+		"nluDomain"?: Models.AddressableEntityRef;
+	}
+	
+	export interface FlowHealthUtterance { 
+		"id"?: string;
+		"text"?: string;
+		"issueCount"?: number;
+		"language"?: string;
+		"staticValidationResults"?: Array<string>;
+		"outlierInfo"?: Models.OutlierInfo;
+		"confusionInfo"?: Models.ConfusionDetails;
+		"selfUri"?: string;
+	}
+	
+	export interface FlowHealthVersionInfo { 
+		"flowVersion"?: Models.AddressableEntityRef;
+		"nluDomain"?: Models.AddressableEntityRef;
+	}
+	
 	export interface FlowMetricsTopicFlowMetricRecord { 
 		"metric"?: string;
 		"metricDate"?: string;
@@ -21266,6 +21487,15 @@ declare namespace Models {
 		"value": number;
 	}
 	
+	export interface HealthInfo { 
+		"status"?: string;
+		"errorInfo"?: Models.FlowHealthErrorInfo;
+		"overallScore"?: number;
+		"issueCount"?: number;
+		"staticValidationResults"?: Array<string>;
+		"utterances"?: Array<Models.FlowHealthIntentUtterance>;
+	}
+	
 	export interface HelpLink { 
 		"uri"?: string;
 		"title"?: string;
@@ -21889,6 +22119,7 @@ declare namespace Models {
 		"user"?: Models.UserReference;
 		"metricData"?: Array<Models.InsightsSummaryMetricItem>;
 		"overallData"?: Models.InsightsSummaryOverallItem;
+		"ranking"?: number;
 	}
 	
 	export interface InsightsTrend { 
@@ -24595,6 +24826,10 @@ declare namespace Models {
 		"selfUri"?: string;
 	}
 	
+	export interface LearningModulePublishRequest { 
+		"termsAndConditionsAccepted"?: boolean;
+	}
+	
 	export interface LearningModulePublishResponse { 
 		"id"?: string;
 		"version"?: number;
@@ -25080,6 +25315,22 @@ declare namespace Models {
 		"nano"?: number;
 	}
 	
+	export interface LocaleFlowVersionInfo { 
+		"nluVersion"?: Models.AddressableEntityRef;
+	}
+	
+	export interface LocaleHealth { 
+		"overallScore"?: number;
+		"issueCount"?: number;
+		"staticValidationResults"?: Array<string>;
+	}
+	
+	export interface LocaleInfo { 
+		"status"?: string;
+		"errorInfo"?: Models.FlowHealthErrorInfo;
+		"flowVersionInfo"?: Models.LocaleFlowVersionInfo;
+	}
+	
 	export interface LocalizedLabels { 
 		"key"?: string;
 		"value"?: string;
@@ -25431,6 +25682,8 @@ declare namespace Models {
 		"enableAutoAnswer"?: boolean;
 		"alertingTimeoutSeconds"?: number;
 		"serviceLevel"?: Models.ServiceLevel;
+		"autoAnswerAlertToneSeconds"?: number;
+		"manualAnswerAlertToneSeconds"?: number;
 		"subTypeSettings"?: { [key: string]: Models.BaseMediaSettings; };
 	}
 	
@@ -25713,6 +25966,7 @@ declare namespace Models {
 		"recipientType"?: string;
 		"authenticated"?: boolean;
 		"monitoredParticipantId"?: string;
+		"monitoredParticipant"?: Models.AddressableEntityRef;
 	}
 	
 	export interface MessageMediaPolicy { 
@@ -27709,6 +27963,11 @@ declare namespace Models {
 		"modifiedDate"?: string;
 	}
 	
+	export interface OutlierInfo { 
+		"outlier"?: boolean;
+		"score"?: number;
+	}
+	
 	export interface OverallBestPoints { 
 		"division"?: Models.Division;
 		"bestPoints"?: Array<Models.OverallBestPointsItem>;
@@ -28414,6 +28673,10 @@ declare namespace Models {
 		"selfUri"?: string;
 	}
 	
+	export interface PinnedMessageRequest { 
+		"pinnedMessageIds": Array<string>;
+	}
+	
 	export interface PlanningGroup { 
 		"id"?: string;
 		"name"?: string;
@@ -32716,6 +32979,22 @@ declare namespace Models {
 		"divisionId": string;
 	}
 	
+	export interface Room { 
+		"id"?: string;
+		"name"?: string;
+		"dateCreated"?: string;
+		"roomType"?: string;
+		"description"?: string;
+		"participantLimit"?: number;
+		"owners"?: Array<Models.UserReference>;
+		"pinnedMessages"?: Array<Models.AddressableEntityRef>;
+		"selfUri"?: string;
+	}
+	
+	export interface RoomUpdateRequest { 
+		"description": string;
+	}
+	
 	export interface RoutePathRequest { 
 		"queueId": string;
 		"mediaType": string;
@@ -33810,6 +34089,12 @@ declare namespace Models {
 		"user"?: Models.AddressableEntityRef;
 	}
 	
+	export interface SendMessageBody { 
+		"message": string;
+		"mentions"?: Array<string>;
+		"threadId"?: string;
+	}
+	
 	export interface SentimentFeedback { 
 		"id"?: string;
 		"phrase": string;
@@ -38807,6 +39092,10 @@ declare namespace Models {
 		"participantInfo"?: Models.VideoConferenceUpdateTopicParticipantInfo;
 	}
 	
+	export interface VideoMetadata { 
+		"videoNotification"?: string;
+	}
+	
 	export interface ViewFilter { 
 		"mediaTypes"?: Array<string>;
 		"queueIds"?: Array<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "174.0.0",
+  "version": "176.0.0",
   "description": "A JavaScript library to interface with the PureCloud Platform API",
   "license": "MIT",
   "main": "dist/node/purecloud-platform-client-v2.js",

package/src/purecloud-platform-client-v2/ApiClient.js

@@ -4,7 +4,7 @@ import { default as qs } from 'qs';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 174.0.0
+ * @version 176.0.0
  */
 class ApiClient {
 	/**

package/src/purecloud-platform-client-v2/api/AlertingApi.js

@@ -5,7 +5,7 @@ class AlertingApi {
 	/**
 	 * Alerting service.
 	 * @module purecloud-platform-client-v2/api/AlertingApi
-	 * @version 174.0.0
+	 * @version 176.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AnalyticsApi.js

@@ -5,7 +5,7 @@ class AnalyticsApi {
 	/**
 	 * Analytics service.
 	 * @module purecloud-platform-client-v2/api/AnalyticsApi
-	 * @version 174.0.0
+	 * @version 176.0.0
 	 */
 
 	/**