purecloud-platform-client-v2 157.0.0 → 158.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 (77) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +529 -73
  3. package/dist/web-amd/purecloud-platform-client-v2.js +529 -73
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +529 -73
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +539 -73
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +141 -2
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +26 -1
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +3 -2
  37. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LearningApi.js +3 -3
  39. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +371 -1
  48. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/StationsApi.js +3 -3
  60. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +61 -1
  74. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/index.js +1 -1
package/index.d.ts CHANGED
@@ -1109,6 +1109,7 @@ declare class ConversationsApi {
1109
1109
  postAnalyticsConversationsDetailsJobs(body: Models.AsyncConversationQuery): Promise<Models.AsyncQueryResponse>;
1110
1110
  postAnalyticsConversationsDetailsQuery(body: Models.ConversationQuery): Promise<Models.AnalyticsConversationQueryResponse>;
1111
1111
  postConversationAssign(conversationId: string, body: Models.ConversationUser): Promise<string>;
1112
+ postConversationCobrowse(conversationId: string): Promise<Models.CobrowseWebMessagingSession>;
1112
1113
  postConversationDisconnect(conversationId: string): Promise<string>;
1113
1114
  postConversationParticipantCallbacks(conversationId: string, participantId: string, opts?: ConversationsApi.postConversationParticipantCallbacksOptions): Promise<void>;
1114
1115
  postConversationParticipantDigits(conversationId: string, participantId: string, opts?: ConversationsApi.postConversationParticipantDigitsOptions): Promise<void>;
@@ -1131,7 +1132,7 @@ declare class ConversationsApi {
1131
1132
  postConversationsChats(body: Models.CreateWebChatRequest): Promise<Models.ChatConversation>;
1132
1133
  postConversationsCobrowsesessionParticipantReplace(conversationId: string, participantId: string, opts?: ConversationsApi.postConversationsCobrowsesessionParticipantReplaceOptions): Promise<void>;
1133
1134
  postConversationsEmailInboundmessages(conversationId: string, body: Models.InboundMessageRequest): Promise<Models.EmailConversation>;
1134
- postConversationsEmailMessages(conversationId: string, body: Models.EmailMessage): Promise<Models.EmailMessage>;
1135
+ postConversationsEmailMessages(conversationId: string, body: Models.EmailMessage): Promise<Models.EmailMessageReply>;
1135
1136
  postConversationsEmailMessagesDraftAttachmentsCopy(conversationId: string, body: Models.CopyAttachmentsRequest): Promise<Models.EmailMessage>;
1136
1137
  postConversationsEmailParticipantReplace(conversationId: string, participantId: string, body: Models.TransferRequest): Promise<void>;
1137
1138
  postConversationsEmails(body: Models.CreateEmailRequest): Promise<Models.EmailConversation>;
@@ -2418,6 +2419,7 @@ declare namespace LanguageUnderstandingApi {
2418
2419
  "pageNumber"?: number;
2419
2420
  "pageSize"?: number;
2420
2421
  "enableCursorPagination"?: boolean;
2422
+ "includeTrainingUtterances"?: boolean;
2421
2423
  "after"?: string;
2422
2424
  "fields"?: Array<string>;
2423
2425
  }
@@ -2803,14 +2805,20 @@ declare namespace OrganizationApi {
2803
2805
  declare class OrganizationAuthorizationApi {
2804
2806
  deleteOrgauthorizationTrustee(trusteeOrgId: string): Promise<void>;
2805
2807
  deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId: string, trusteeUserId: string): Promise<void>;
2808
+ deleteOrgauthorizationTrusteeGroup(trusteeOrgId: string, trusteeGroupId: string): Promise<void>;
2809
+ deleteOrgauthorizationTrusteeGroupRoles(trusteeOrgId: string, trusteeGroupId: string): Promise<void>;
2806
2810
  deleteOrgauthorizationTrusteeUser(trusteeOrgId: string, trusteeUserId: string): Promise<void>;
2807
2811
  deleteOrgauthorizationTrusteeUserRoles(trusteeOrgId: string, trusteeUserId: string): Promise<void>;
2808
2812
  deleteOrgauthorizationTrustor(trustorOrgId: string): Promise<void>;
2809
2813
  deleteOrgauthorizationTrustorCloneduser(trustorOrgId: string, trusteeUserId: string): Promise<void>;
2814
+ deleteOrgauthorizationTrustorGroup(trustorOrgId: string, trustorGroupId: string): Promise<void>;
2810
2815
  deleteOrgauthorizationTrustorUser(trustorOrgId: string, trusteeUserId: string): Promise<void>;
2811
2816
  getOrgauthorizationPairing(pairingId: string): Promise<Models.TrustRequest>;
2812
2817
  getOrgauthorizationTrustee(trusteeOrgId: string): Promise<Models.Trustee>;
2813
2818
  getOrgauthorizationTrusteeClonedusers(trusteeOrgId: string): Promise<Models.ClonedUserEntityListing>;
2819
+ getOrgauthorizationTrusteeGroup(trusteeOrgId: string, trusteeGroupId: string): Promise<Models.TrustGroup>;
2820
+ getOrgauthorizationTrusteeGroupRoles(trusteeOrgId: string, trusteeGroupId: string): Promise<Models.UserAuthorization>;
2821
+ getOrgauthorizationTrusteeGroups(trusteeOrgId: string, opts?: OrganizationAuthorizationApi.getOrgauthorizationTrusteeGroupsOptions): Promise<Models.TrustGroupEntityListing>;
2814
2822
  getOrgauthorizationTrusteeUser(trusteeOrgId: string, trusteeUserId: string): Promise<Models.TrustUser>;
2815
2823
  getOrgauthorizationTrusteeUserRoles(trusteeOrgId: string, trusteeUserId: string): Promise<Models.UserAuthorization>;
2816
2824
  getOrgauthorizationTrusteeUsers(trusteeOrgId: string, opts?: OrganizationAuthorizationApi.getOrgauthorizationTrusteeUsersOptions): Promise<Models.TrustUserEntityListing>;
@@ -2819,23 +2827,33 @@ declare class OrganizationAuthorizationApi {
2819
2827
  getOrgauthorizationTrustor(trustorOrgId: string): Promise<Models.Trustor>;
2820
2828
  getOrgauthorizationTrustorCloneduser(trustorOrgId: string, trusteeUserId: string): Promise<Models.ClonedUser>;
2821
2829
  getOrgauthorizationTrustorClonedusers(trustorOrgId: string): Promise<Models.ClonedUserEntityListing>;
2830
+ getOrgauthorizationTrustorGroup(trustorOrgId: string, trustorGroupId: string): Promise<Models.TrustGroup>;
2831
+ getOrgauthorizationTrustorGroups(trustorOrgId: string, opts?: OrganizationAuthorizationApi.getOrgauthorizationTrustorGroupsOptions): Promise<Models.TrustGroupEntityListing>;
2822
2832
  getOrgauthorizationTrustorUser(trustorOrgId: string, trusteeUserId: string): Promise<Models.TrustUser>;
2823
2833
  getOrgauthorizationTrustorUsers(trustorOrgId: string, opts?: OrganizationAuthorizationApi.getOrgauthorizationTrustorUsersOptions): Promise<Models.TrustUserEntityListing>;
2824
2834
  getOrgauthorizationTrustors(opts?: OrganizationAuthorizationApi.getOrgauthorizationTrustorsOptions): Promise<Models.TrustorEntityListing>;
2825
2835
  postOrgauthorizationPairings(body: Models.TrustRequestCreate): Promise<Models.TrustRequest>;
2836
+ postOrgauthorizationTrusteeGroups(trusteeOrgId: string, body: Models.TrustMemberCreate): Promise<Models.TrustGroup>;
2826
2837
  postOrgauthorizationTrusteeUsers(trusteeOrgId: string, body: Models.TrustMemberCreate): Promise<Models.TrustUser>;
2827
2838
  postOrgauthorizationTrustees(body: Models.TrustCreate): Promise<Models.Trustee>;
2828
2839
  postOrgauthorizationTrusteesAudits(body: Models.TrusteeAuditQueryRequest, opts?: OrganizationAuthorizationApi.postOrgauthorizationTrusteesAuditsOptions): Promise<object>;
2829
2840
  postOrgauthorizationTrusteesDefault(opts?: OrganizationAuthorizationApi.postOrgauthorizationTrusteesDefaultOptions): Promise<Models.Trustee>;
2830
2841
  postOrgauthorizationTrustorAudits(body: Models.TrustorAuditQueryRequest, opts?: OrganizationAuthorizationApi.postOrgauthorizationTrustorAuditsOptions): Promise<object>;
2831
2842
  putOrgauthorizationTrustee(trusteeOrgId: string, body: Models.TrustUpdate): Promise<Models.Trustee>;
2843
+ putOrgauthorizationTrusteeGroupRoledivisions(trusteeOrgId: string, trusteeGroupId: string, body: Models.RoleDivisionGrants): Promise<Models.UserAuthorization>;
2844
+ putOrgauthorizationTrusteeGroupRoles(trusteeOrgId: string, trusteeGroupId: string, body: Array<string>): Promise<Models.UserAuthorization>;
2832
2845
  putOrgauthorizationTrusteeUserRoledivisions(trusteeOrgId: string, trusteeUserId: string, body: Models.RoleDivisionGrants): Promise<Models.UserAuthorization>;
2833
2846
  putOrgauthorizationTrusteeUserRoles(trusteeOrgId: string, trusteeUserId: string, body: Array<string>): Promise<Models.UserAuthorization>;
2834
2847
  putOrgauthorizationTrustorCloneduser(trustorOrgId: string, trusteeUserId: string): Promise<Models.ClonedUser>;
2848
+ putOrgauthorizationTrustorGroup(trustorOrgId: string, trustorGroupId: string): Promise<Models.TrustGroup>;
2835
2849
  putOrgauthorizationTrustorUser(trustorOrgId: string, trusteeUserId: string): Promise<Models.TrustUser>;
2836
2850
  }
2837
2851
 
2838
2852
  declare namespace OrganizationAuthorizationApi {
2853
+ export interface getOrgauthorizationTrusteeGroupsOptions {
2854
+ "pageSize"?: number;
2855
+ "pageNumber"?: number;
2856
+ }
2839
2857
  export interface getOrgauthorizationTrusteeUsersOptions {
2840
2858
  "pageSize"?: number;
2841
2859
  "pageNumber"?: number;
@@ -2844,6 +2862,10 @@ declare namespace OrganizationAuthorizationApi {
2844
2862
  "pageSize"?: number;
2845
2863
  "pageNumber"?: number;
2846
2864
  }
2865
+ export interface getOrgauthorizationTrustorGroupsOptions {
2866
+ "pageSize"?: number;
2867
+ "pageNumber"?: number;
2868
+ }
2847
2869
  export interface getOrgauthorizationTrustorUsersOptions {
2848
2870
  "pageSize"?: number;
2849
2871
  "pageNumber"?: number;
@@ -5240,12 +5262,14 @@ declare namespace WebChatApi {
5240
5262
  declare class WebDeploymentsApi {
5241
5263
  deleteWebdeploymentsConfiguration(configurationId: string): Promise<void>;
5242
5264
  deleteWebdeploymentsDeployment(deploymentId: string): Promise<void>;
5265
+ deleteWebdeploymentsDeploymentCobrowseSessionId(deploymentId: string, sessionId: string): Promise<object>;
5243
5266
  deleteWebdeploymentsTokenRevoke(opts?: WebDeploymentsApi.deleteWebdeploymentsTokenRevokeOptions): Promise<void>;
5244
5267
  getWebdeploymentsConfigurationVersion(configurationId: string, versionId: string): Promise<Models.WebDeploymentConfigurationVersion>;
5245
5268
  getWebdeploymentsConfigurationVersions(configurationId: string): Promise<Models.WebDeploymentConfigurationVersionEntityListing>;
5246
5269
  getWebdeploymentsConfigurationVersionsDraft(configurationId: string): Promise<Models.WebDeploymentConfigurationVersion>;
5247
5270
  getWebdeploymentsConfigurations(opts?: WebDeploymentsApi.getWebdeploymentsConfigurationsOptions): Promise<Models.WebDeploymentConfigurationVersionEntityListing>;
5248
5271
  getWebdeploymentsDeployment(deploymentId: string): Promise<Models.WebDeployment>;
5272
+ getWebdeploymentsDeploymentCobrowseSessionId(deploymentId: string, sessionId: string): Promise<Models.CobrowseWebMessagingSession>;
5249
5273
  getWebdeploymentsDeploymentConfigurations(deploymentId: string, opts?: WebDeploymentsApi.getWebdeploymentsDeploymentConfigurationsOptions): Promise<Models.WebDeploymentActiveConfigurationOnDeployment>;
5250
5274
  getWebdeploymentsDeployments(opts?: WebDeploymentsApi.getWebdeploymentsDeploymentsOptions): Promise<Models.ExpandableWebDeploymentEntityListing>;
5251
5275
  postWebdeploymentsConfigurationVersionsDraftPublish(configurationId: string): Promise<Models.WebDeploymentConfigurationVersion>;
@@ -6593,6 +6617,7 @@ declare namespace Models {
6593
6617
  "contextId"?: string;
6594
6618
  "deleted"?: boolean;
6595
6619
  "evaluationId"?: string;
6620
+ "evaluationStatus"?: string;
6596
6621
  "evaluatorId"?: string;
6597
6622
  "eventTime"?: string;
6598
6623
  "formId"?: string;
@@ -9114,6 +9139,7 @@ declare namespace Models {
9114
9139
  "held"?: boolean;
9115
9140
  "wrapupRequired"?: boolean;
9116
9141
  "wrapupPrompt"?: string;
9142
+ "mediaRoles"?: Array<string>;
9117
9143
  "user"?: Models.DomainEntityRef;
9118
9144
  "queue"?: Models.DomainEntityRef;
9119
9145
  "team"?: Models.DomainEntityRef;
@@ -9334,6 +9360,7 @@ declare namespace Models {
9334
9360
  "held"?: boolean;
9335
9361
  "wrapupRequired"?: boolean;
9336
9362
  "wrapupPrompt"?: string;
9363
+ "mediaRoles"?: Array<string>;
9337
9364
  "user"?: Models.DomainEntityRef;
9338
9365
  "queue"?: Models.DomainEntityRef;
9339
9366
  "team"?: Models.DomainEntityRef;
@@ -9780,6 +9807,7 @@ declare namespace Models {
9780
9807
  "held"?: boolean;
9781
9808
  "wrapupRequired"?: boolean;
9782
9809
  "wrapupPrompt"?: string;
9810
+ "mediaRoles"?: Array<string>;
9783
9811
  "user"?: Models.DomainEntityRef;
9784
9812
  "queue"?: Models.DomainEntityRef;
9785
9813
  "team"?: Models.DomainEntityRef;
@@ -10084,6 +10112,7 @@ declare namespace Models {
10084
10112
  "held"?: boolean;
10085
10113
  "wrapupRequired"?: boolean;
10086
10114
  "wrapupPrompt"?: string;
10115
+ "mediaRoles"?: Array<string>;
10087
10116
  "user"?: Models.DomainEntityRef;
10088
10117
  "queue"?: Models.DomainEntityRef;
10089
10118
  "team"?: Models.DomainEntityRef;
@@ -10116,6 +10145,16 @@ declare namespace Models {
10116
10145
  "maskSelectors"?: Array<string>;
10117
10146
  }
10118
10147
 
10148
+ export interface CobrowseWebMessagingSession {
10149
+ "id"?: string;
10150
+ "name"?: string;
10151
+ "joinCode"?: string;
10152
+ "websocketUrl"?: string;
10153
+ "dateOfferEnds"?: string;
10154
+ "communicationType"?: string;
10155
+ "selfUri"?: string;
10156
+ }
10157
+
10119
10158
  export interface Cobrowsesession {
10120
10159
  "state"?: string;
10121
10160
  "initialState"?: string;
@@ -10257,6 +10296,16 @@ declare namespace Models {
10257
10296
  "selfUri"?: string;
10258
10297
  }
10259
10298
 
10299
+ export interface Compliance {
10300
+ "stopSettings": Array<Models.StopSettings>;
10301
+ "optInSettings": Array<Models.OptInSettings>;
10302
+ "helpSettings": Array<Models.HelpSettings>;
10303
+ }
10304
+
10305
+ export interface ComplianceResponse {
10306
+ "message": string;
10307
+ }
10308
+
10260
10309
  export interface Condition {
10261
10310
  "type"?: string;
10262
10311
  "inverted"?: boolean;
@@ -11022,6 +11071,7 @@ declare namespace Models {
11022
11071
  "journeyContext"?: Models.ConversationCallEventTopicJourneyContext;
11023
11072
  "startAcwTime"?: string;
11024
11073
  "endAcwTime"?: string;
11074
+ "mediaRoles"?: Array<string>;
11025
11075
  "muted"?: boolean;
11026
11076
  "confined"?: boolean;
11027
11077
  "recording"?: boolean;
@@ -11168,6 +11218,7 @@ declare namespace Models {
11168
11218
  "journeyContext"?: Models.ConversationCallbackEventTopicJourneyContext;
11169
11219
  "startAcwTime"?: string;
11170
11220
  "endAcwTime"?: string;
11221
+ "mediaRoles"?: Array<string>;
11171
11222
  "outboundPreview"?: Models.ConversationCallbackEventTopicDialerPreview;
11172
11223
  "voicemail"?: Models.ConversationCallbackEventTopicVoicemail;
11173
11224
  "callbackNumbers"?: Array<string>;
@@ -11351,6 +11402,7 @@ declare namespace Models {
11351
11402
  "journeyContext"?: Models.ConversationChatEventTopicJourneyContext;
11352
11403
  "startAcwTime"?: string;
11353
11404
  "endAcwTime"?: string;
11405
+ "mediaRoles"?: Array<string>;
11354
11406
  "roomId"?: string;
11355
11407
  "avatarImageUrl"?: string;
11356
11408
  }
@@ -11474,6 +11526,7 @@ declare namespace Models {
11474
11526
  "journeyContext"?: Models.ConversationCobrowseEventTopicJourneyContext;
11475
11527
  "startAcwTime"?: string;
11476
11528
  "endAcwTime"?: string;
11529
+ "mediaRoles"?: Array<string>;
11477
11530
  "cobrowseSessionId"?: string;
11478
11531
  "cobrowseRole"?: string;
11479
11532
  "viewerUrl"?: string;
@@ -11738,6 +11791,7 @@ declare namespace Models {
11738
11791
  "journeyContext"?: Models.ConversationEmailEventTopicJourneyContext;
11739
11792
  "startAcwTime"?: string;
11740
11793
  "endAcwTime"?: string;
11794
+ "mediaRoles"?: Array<string>;
11741
11795
  "subject"?: string;
11742
11796
  "messagesSent"?: number;
11743
11797
  "autoGenerated"?: boolean;
@@ -12178,6 +12232,7 @@ declare namespace Models {
12178
12232
  "monitoredParticipantId"?: string;
12179
12233
  "coachedParticipantId"?: string;
12180
12234
  "bargedParticipantId"?: string;
12235
+ "mediaRoles"?: Array<string>;
12181
12236
  "screenRecordingState"?: string;
12182
12237
  "flaggedReason"?: string;
12183
12238
  "attributes"?: { [key: string]: string; };
@@ -12448,6 +12503,7 @@ declare namespace Models {
12448
12503
  "journeyContext"?: Models.ConversationMessageEventTopicJourneyContext;
12449
12504
  "startAcwTime"?: string;
12450
12505
  "endAcwTime"?: string;
12506
+ "mediaRoles"?: Array<string>;
12451
12507
  "messages"?: Array<Models.ConversationMessageEventTopicMessageDetails>;
12452
12508
  "type"?: string;
12453
12509
  "recipientCountry"?: string;
@@ -12838,6 +12894,7 @@ declare namespace Models {
12838
12894
  "journeyContext"?: Models.ConversationScreenShareEventTopicJourneyContext;
12839
12895
  "startAcwTime"?: string;
12840
12896
  "endAcwTime"?: string;
12897
+ "mediaRoles"?: Array<string>;
12841
12898
  "context"?: string;
12842
12899
  "peerCount"?: number;
12843
12900
  "sharing"?: boolean;
@@ -12967,6 +13024,7 @@ declare namespace Models {
12967
13024
  "journeyContext"?: Models.ConversationSocialExpressionEventTopicJourneyContext;
12968
13025
  "startAcwTime"?: string;
12969
13026
  "endAcwTime"?: string;
13027
+ "mediaRoles"?: Array<string>;
12970
13028
  "socialMediaId"?: string;
12971
13029
  "socialMediaHub"?: string;
12972
13030
  "socialUserName"?: string;
@@ -13122,6 +13180,7 @@ declare namespace Models {
13122
13180
  "journeyContext"?: Models.ConversationVideoEventTopicJourneyContext;
13123
13181
  "startAcwTime"?: string;
13124
13182
  "endAcwTime"?: string;
13183
+ "mediaRoles"?: Array<string>;
13125
13184
  "audioMuted"?: boolean;
13126
13185
  "videoMuted"?: boolean;
13127
13186
  "sharingScreen"?: boolean;
@@ -13363,6 +13422,8 @@ declare namespace Models {
13363
13422
  "objective"?: Models.CreateObjective;
13364
13423
  "performanceProfileId"?: string;
13365
13424
  "name": string;
13425
+ "precision"?: number;
13426
+ "timeDisplayUnit"?: string;
13366
13427
  }
13367
13428
 
13368
13429
  export interface CreateObjective {
@@ -16463,6 +16524,7 @@ declare namespace Models {
16463
16524
  "held"?: boolean;
16464
16525
  "wrapupRequired"?: boolean;
16465
16526
  "wrapupPrompt"?: string;
16527
+ "mediaRoles"?: Array<string>;
16466
16528
  "user"?: Models.DomainEntityRef;
16467
16529
  "queue"?: Models.DomainEntityRef;
16468
16530
  "team"?: Models.DomainEntityRef;
@@ -16519,6 +16581,7 @@ declare namespace Models {
16519
16581
  "htmlBody"?: string;
16520
16582
  "time"?: string;
16521
16583
  "historyIncluded"?: boolean;
16584
+ "state"?: string;
16522
16585
  "emailSizeBytes"?: number;
16523
16586
  "maxEmailSizeBytes"?: number;
16524
16587
  "selfUri"?: string;
@@ -16537,6 +16600,22 @@ declare namespace Models {
16537
16600
  "pageCount"?: number;
16538
16601
  }
16539
16602
 
16603
+ export interface EmailMessageReply {
16604
+ "to": Array<Models.EmailAddress>;
16605
+ "cc"?: Array<Models.EmailAddress>;
16606
+ "bcc"?: Array<Models.EmailAddress>;
16607
+ "from": Models.EmailAddress;
16608
+ "replyTo"?: Models.EmailAddress;
16609
+ "subject"?: string;
16610
+ "attachments"?: Array<Models.Attachment>;
16611
+ "textBody": string;
16612
+ "htmlBody"?: string;
16613
+ "time"?: string;
16614
+ "historyIncluded"?: boolean;
16615
+ "emailSizeBytes"?: number;
16616
+ "maxEmailSizeBytes"?: number;
16617
+ }
16618
+
16540
16619
  export interface EmailOutboundDomainResult {
16541
16620
  "dnsCnameBounceRecord"?: Models.DnsRecordEntry;
16542
16621
  "dnsTxtSendingRecord"?: Models.DnsRecordEntry;
@@ -18918,6 +18997,11 @@ declare namespace Models {
18918
18997
  "description"?: string;
18919
18998
  }
18920
18999
 
19000
+ export interface HelpSettings {
19001
+ "keyword": Array<string>;
19002
+ "response": Models.ComplianceResponse;
19003
+ }
19004
+
18921
19005
  export interface HistoricalAdherenceActuals {
18922
19006
  "actualActivityCategory"?: string;
18923
19007
  "actualSecondaryPresenceLookupId"?: string;
@@ -20348,6 +20432,15 @@ declare namespace Models {
20348
20432
  "medium"?: string;
20349
20433
  }
20350
20434
 
20435
+ export interface JourneyWebEventsNotificationSegment {
20436
+ "id"?: string;
20437
+ "selfUri"?: string;
20438
+ }
20439
+
20440
+ export interface JourneyWebEventsNotificationSegmentAssignmentMessage {
20441
+ "segment"?: Models.JourneyWebEventsNotificationSegment;
20442
+ }
20443
+
20351
20444
  export interface JourneyWebEventsNotificationSession {
20352
20445
  "id"?: string;
20353
20446
  "selfUri"?: string;
@@ -20382,6 +20475,7 @@ declare namespace Models {
20382
20475
  "webEvent"?: Models.JourneyWebEventsNotificationWebMessage;
20383
20476
  "webActionEvent"?: Models.JourneyWebEventsNotificationWebActionMessage;
20384
20477
  "outcomeAchievedEvent"?: Models.JourneyWebEventsNotificationOutcomeAchievedMessage;
20478
+ "segmentAssignmentEvent"?: Models.JourneyWebEventsNotificationSegmentAssignmentMessage;
20385
20479
  }
20386
20480
 
20387
20481
  export interface JourneyWebEventsNotificationWebMessage {
@@ -20450,6 +20544,7 @@ declare namespace Models {
20450
20544
  "kpiType"?: string;
20451
20545
  "source"?: string;
20452
20546
  "wrapUpCodeConfig"?: Models.WrapUpCodeConfig;
20547
+ "outcomeConfig"?: Models.OutcomeConfig;
20453
20548
  "status"?: string;
20454
20549
  "kpiGroup"?: string;
20455
20550
  "selfUri"?: string;
@@ -22462,6 +22557,7 @@ declare namespace Models {
22462
22557
  "held"?: boolean;
22463
22558
  "wrapupRequired"?: boolean;
22464
22559
  "wrapupPrompt"?: string;
22560
+ "mediaRoles"?: Array<string>;
22465
22561
  "user"?: Models.DomainEntityRef;
22466
22562
  "queue"?: Models.DomainEntityRef;
22467
22563
  "team"?: Models.DomainEntityRef;
@@ -22767,6 +22863,8 @@ declare namespace Models {
22767
22863
  "linkedMetric"?: Models.AddressableEntityRef;
22768
22864
  "dateCreated"?: string;
22769
22865
  "dateUnlinked"?: string;
22866
+ "precision"?: number;
22867
+ "timeDisplayUnit"?: string;
22770
22868
  "sourcePerformanceProfile"?: Models.PerformanceProfile;
22771
22869
  "selfUri"?: string;
22772
22870
  }
@@ -23562,6 +23660,11 @@ declare namespace Models {
23562
23660
  "actionStatus"?: string;
23563
23661
  }
23564
23662
 
23663
+ export interface OptInSettings {
23664
+ "keyword": Array<string>;
23665
+ "response": Models.ComplianceResponse;
23666
+ }
23667
+
23565
23668
  export interface OrgOAuthClient {
23566
23669
  "id"?: string;
23567
23670
  "name": string;
@@ -24006,6 +24109,10 @@ declare namespace Models {
24006
24109
  "achievedDate"?: string;
24007
24110
  }
24008
24111
 
24112
+ export interface OutcomeConfig {
24113
+ "values"?: Array<string>;
24114
+ }
24115
+
24009
24116
  export interface OutcomeEventScore {
24010
24117
  "outcome"?: Models.AddressableEntityRef;
24011
24118
  "sessionMaxProbability"?: number;
@@ -24115,6 +24222,7 @@ declare namespace Models {
24115
24222
  "wrapupTimeoutMs"?: number;
24116
24223
  "wrapupSkipped"?: boolean;
24117
24224
  "wrapup"?: Models.Wrapup;
24225
+ "mediaRoles"?: Array<string>;
24118
24226
  "conversationRoutingData"?: Models.ConversationRoutingData;
24119
24227
  "alertingTimeoutMs"?: number;
24120
24228
  "monitoredParticipantId"?: string;
@@ -24168,6 +24276,7 @@ declare namespace Models {
24168
24276
  "wrapupTimeoutMs"?: number;
24169
24277
  "wrapupSkipped"?: boolean;
24170
24278
  "wrapup"?: Models.Wrapup;
24279
+ "mediaRoles"?: Array<string>;
24171
24280
  "conversationRoutingData"?: Models.ConversationRoutingData;
24172
24281
  "alertingTimeoutMs"?: number;
24173
24282
  "monitoredParticipantId"?: string;
@@ -25458,6 +25567,7 @@ declare namespace Models {
25458
25567
  "journeyContext"?: Models.QueueConversationCallEventTopicJourneyContext;
25459
25568
  "startAcwTime"?: string;
25460
25569
  "endAcwTime"?: string;
25570
+ "mediaRoles"?: Array<string>;
25461
25571
  "muted"?: boolean;
25462
25572
  "confined"?: boolean;
25463
25573
  "recording"?: boolean;
@@ -25604,6 +25714,7 @@ declare namespace Models {
25604
25714
  "journeyContext"?: Models.QueueConversationCallbackEventTopicJourneyContext;
25605
25715
  "startAcwTime"?: string;
25606
25716
  "endAcwTime"?: string;
25717
+ "mediaRoles"?: Array<string>;
25607
25718
  "outboundPreview"?: Models.QueueConversationCallbackEventTopicDialerPreview;
25608
25719
  "voicemail"?: Models.QueueConversationCallbackEventTopicVoicemail;
25609
25720
  "callbackNumbers"?: Array<string>;
@@ -25754,6 +25865,7 @@ declare namespace Models {
25754
25865
  "journeyContext"?: Models.QueueConversationChatEventTopicJourneyContext;
25755
25866
  "startAcwTime"?: string;
25756
25867
  "endAcwTime"?: string;
25868
+ "mediaRoles"?: Array<string>;
25757
25869
  "roomId"?: string;
25758
25870
  "avatarImageUrl"?: string;
25759
25871
  }
@@ -25877,6 +25989,7 @@ declare namespace Models {
25877
25989
  "journeyContext"?: Models.QueueConversationCobrowseEventTopicJourneyContext;
25878
25990
  "startAcwTime"?: string;
25879
25991
  "endAcwTime"?: string;
25992
+ "mediaRoles"?: Array<string>;
25880
25993
  "cobrowseSessionId"?: string;
25881
25994
  "cobrowseRole"?: string;
25882
25995
  "viewerUrl"?: string;
@@ -26027,6 +26140,7 @@ declare namespace Models {
26027
26140
  "journeyContext"?: Models.QueueConversationEmailEventTopicJourneyContext;
26028
26141
  "startAcwTime"?: string;
26029
26142
  "endAcwTime"?: string;
26143
+ "mediaRoles"?: Array<string>;
26030
26144
  "subject"?: string;
26031
26145
  "messagesSent"?: number;
26032
26146
  "autoGenerated"?: boolean;
@@ -26430,6 +26544,7 @@ declare namespace Models {
26430
26544
  "monitoredParticipantId"?: string;
26431
26545
  "coachedParticipantId"?: string;
26432
26546
  "bargedParticipantId"?: string;
26547
+ "mediaRoles"?: Array<string>;
26433
26548
  "screenRecordingState"?: string;
26434
26549
  "flaggedReason"?: string;
26435
26550
  "attributes"?: { [key: string]: string; };
@@ -26674,6 +26789,7 @@ declare namespace Models {
26674
26789
  "journeyContext"?: Models.QueueConversationMessageEventTopicJourneyContext;
26675
26790
  "startAcwTime"?: string;
26676
26791
  "endAcwTime"?: string;
26792
+ "mediaRoles"?: Array<string>;
26677
26793
  "messages"?: Array<Models.QueueConversationMessageEventTopicMessageDetails>;
26678
26794
  "type"?: string;
26679
26795
  "recipientCountry"?: string;
@@ -26828,6 +26944,7 @@ declare namespace Models {
26828
26944
  "journeyContext"?: Models.QueueConversationScreenShareEventTopicJourneyContext;
26829
26945
  "startAcwTime"?: string;
26830
26946
  "endAcwTime"?: string;
26947
+ "mediaRoles"?: Array<string>;
26831
26948
  "context"?: string;
26832
26949
  "peerCount"?: number;
26833
26950
  "sharing"?: boolean;
@@ -27181,6 +27298,7 @@ declare namespace Models {
27181
27298
  "monitoredParticipantId"?: string;
27182
27299
  "coachedParticipantId"?: string;
27183
27300
  "bargedParticipantId"?: string;
27301
+ "mediaRoles"?: Array<string>;
27184
27302
  "screenRecordingState"?: string;
27185
27303
  "flaggedReason"?: string;
27186
27304
  "attributes"?: { [key: string]: string; };
@@ -27632,6 +27750,7 @@ declare namespace Models {
27632
27750
  "monitoredParticipantId"?: string;
27633
27751
  "coachedParticipantId"?: string;
27634
27752
  "bargedParticipantId"?: string;
27753
+ "mediaRoles"?: Array<string>;
27635
27754
  "screenRecordingState"?: string;
27636
27755
  "flaggedReason"?: string;
27637
27756
  "attributes"?: { [key: string]: string; };
@@ -30419,6 +30538,8 @@ declare namespace Models {
30419
30538
  "supportsSms"?: boolean;
30420
30539
  "supportsMms"?: boolean;
30421
30540
  "supportsVoice"?: boolean;
30541
+ "integration"?: Models.DomainEntityRef;
30542
+ "compliance"?: Models.Compliance;
30422
30543
  "selfUri"?: string;
30423
30544
  }
30424
30545
 
@@ -30437,10 +30558,10 @@ declare namespace Models {
30437
30558
 
30438
30559
  export interface SmsPhoneNumberProvision {
30439
30560
  "id"?: string;
30440
- "name"?: string;
30441
30561
  "phoneNumber": string;
30442
30562
  "phoneNumberType": string;
30443
30563
  "countryCode": string;
30564
+ "name"?: string;
30444
30565
  "addressId"?: string;
30445
30566
  "selfUri"?: string;
30446
30567
  }
@@ -30688,6 +30809,11 @@ declare namespace Models {
30688
30809
  "rejectReason"?: string;
30689
30810
  }
30690
30811
 
30812
+ export interface StopSettings {
30813
+ "keyword": Array<string>;
30814
+ "response": Models.ComplianceResponse;
30815
+ }
30816
+
30691
30817
  export interface StorySetting {
30692
30818
  "mention"?: Models.InboundOnlySetting;
30693
30819
  "reply"?: Models.InboundOnlySetting;
@@ -32209,6 +32335,19 @@ declare namespace Models {
32209
32335
  "createdBy"?: Models.OrgUser;
32210
32336
  }
32211
32337
 
32338
+ export interface TrustGroupEntityListing {
32339
+ "entities"?: Array<Models.TrustGroup>;
32340
+ "pageSize"?: number;
32341
+ "pageNumber"?: number;
32342
+ "total"?: number;
32343
+ "firstUri"?: string;
32344
+ "nextUri"?: string;
32345
+ "previousUri"?: string;
32346
+ "lastUri"?: string;
32347
+ "selfUri"?: string;
32348
+ "pageCount"?: number;
32349
+ }
32350
+
32212
32351
  export interface TrustMemberCreate {
32213
32352
  "id": string;
32214
32353
  "roleIds"?: Array<string>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "157.0.0",
3
+ "version": "158.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",
@@ -4,7 +4,7 @@ import { default as qs } from 'qs';
4
4
 
5
5
  /**
6
6
  * @module purecloud-platform-client-v2/ApiClient
7
- * @version 157.0.0
7
+ * @version 158.0.0
8
8
  */
9
9
  class ApiClient {
10
10
  /**
@@ -5,7 +5,7 @@ class AlertingApi {
5
5
  /**
6
6
  * Alerting service.
7
7
  * @module purecloud-platform-client-v2/api/AlertingApi
8
- * @version 157.0.0
8
+ * @version 158.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 157.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ArchitectApi {
5
5
  /**
6
6
  * Architect service.
7
7
  * @module purecloud-platform-client-v2/api/ArchitectApi
8
- * @version 157.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AuditApi {
5
5
  /**
6
6
  * Audit service.
7
7
  * @module purecloud-platform-client-v2/api/AuditApi
8
- * @version 157.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AuthorizationApi {
5
5
  /**
6
6
  * Authorization service.
7
7
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8
- * @version 157.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class BillingApi {
5
5
  /**
6
6
  * Billing service.
7
7
  * @module purecloud-platform-client-v2/api/BillingApi
8
- * @version 157.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ChatApi {
5
5
  /**
6
6
  * Chat service.
7
7
  * @module purecloud-platform-client-v2/api/ChatApi
8
- * @version 157.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class CoachingApi {
5
5
  /**
6
6
  * Coaching service.
7
7
  * @module purecloud-platform-client-v2/api/CoachingApi
8
- * @version 157.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ContentManagementApi {
5
5
  /**
6
6
  * ContentManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8
- * @version 157.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ConversationsApi {
5
5
  /**
6
6
  * Conversations service.
7
7
  * @module purecloud-platform-client-v2/api/ConversationsApi
8
- * @version 157.0.0
8
+ * @version 158.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -3392,6 +3392,31 @@ class ConversationsApi {
3392
3392
  );
3393
3393
  }
3394
3394
 
3395
+ /**
3396
+ * Creates a cobrowse session
3397
+ *
3398
+ * @param {String} conversationId Conversation ID
3399
+ */
3400
+ postConversationCobrowse(conversationId) {
3401
+ // verify the required parameter 'conversationId' is set
3402
+ if (conversationId === undefined || conversationId === null) {
3403
+ throw 'Missing the required parameter "conversationId" when calling postConversationCobrowse';
3404
+ }
3405
+
3406
+ return this.apiClient.callApi(
3407
+ '/api/v2/conversations/{conversationId}/cobrowse',
3408
+ 'POST',
3409
+ { 'conversationId': conversationId },
3410
+ { },
3411
+ { },
3412
+ { },
3413
+ null,
3414
+ ['PureCloud OAuth'],
3415
+ ['application/json'],
3416
+ ['application/json']
3417
+ );
3418
+ }
3419
+
3395
3420
  /**
3396
3421
  * Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
3397
3422
  *