purecloud-platform-client-v2 169.1.0 → 170.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 (80) hide show
  1. package/README.md +6 -4
  2. package/dist/node/purecloud-platform-client-v2.js +774 -365
  3. package/dist/web-amd/purecloud-platform-client-v2.js +774 -365
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +774 -365
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +774 -365
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +211 -35
  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 +44 -44
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +6 -6
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +4 -4
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +362 -7
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +5 -5
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +9 -9
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +41 -11
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -45
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -29
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +6 -6
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +8 -8
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +3 -3
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +69 -16
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +16 -16
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +13 -13
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +5 -5
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +50 -46
  64. package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
  65. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +4 -4
  67. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TokensApi.js +3 -3
  69. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -13
  73. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebChatApi.js +6 -6
  76. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
  80. package/src/purecloud-platform-client-v2/index.js +1 -1
package/index.d.ts CHANGED
@@ -1131,6 +1131,7 @@ declare class ConversationsApi {
1131
1131
  deleteConversationsCallParticipantConsult(conversationId: string, participantId: string): Promise<void>;
1132
1132
  deleteConversationsEmailMessagesDraftAttachment(conversationId: string, attachmentId: string): Promise<void>;
1133
1133
  deleteConversationsMessagingIntegrationsFacebookIntegrationId(integrationId: string): Promise<void>;
1134
+ deleteConversationsMessagingIntegrationsInstagramIntegrationId(integrationId: string): Promise<void>;
1134
1135
  deleteConversationsMessagingIntegrationsLineIntegrationId(integrationId: string): Promise<void>;
1135
1136
  deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId: string): Promise<void>;
1136
1137
  deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId: string): Promise<void>;
@@ -1197,6 +1198,8 @@ declare class ConversationsApi {
1197
1198
  getConversationsMessagingIntegrations(opts?: ConversationsApi.getConversationsMessagingIntegrationsOptions): Promise<Models.MessagingIntegrationEntityListing>;
1198
1199
  getConversationsMessagingIntegrationsFacebook(opts?: ConversationsApi.getConversationsMessagingIntegrationsFacebookOptions): Promise<Models.FacebookIntegrationEntityListing>;
1199
1200
  getConversationsMessagingIntegrationsFacebookIntegrationId(integrationId: string, opts?: ConversationsApi.getConversationsMessagingIntegrationsFacebookIntegrationIdOptions): Promise<Models.FacebookIntegration>;
1201
+ getConversationsMessagingIntegrationsInstagram(opts?: ConversationsApi.getConversationsMessagingIntegrationsInstagramOptions): Promise<Models.InstagramIntegrationEntityListing>;
1202
+ getConversationsMessagingIntegrationsInstagramIntegrationId(integrationId: string, opts?: ConversationsApi.getConversationsMessagingIntegrationsInstagramIntegrationIdOptions): Promise<Models.InstagramIntegration>;
1200
1203
  getConversationsMessagingIntegrationsLine(opts?: ConversationsApi.getConversationsMessagingIntegrationsLineOptions): Promise<Models.LineIntegrationEntityListing>;
1201
1204
  getConversationsMessagingIntegrationsLineIntegrationId(integrationId: string, opts?: ConversationsApi.getConversationsMessagingIntegrationsLineIntegrationIdOptions): Promise<Models.LineIntegration>;
1202
1205
  getConversationsMessagingIntegrationsOpen(opts?: ConversationsApi.getConversationsMessagingIntegrationsOpenOptions): Promise<Models.OpenIntegrationEntityListing>;
@@ -1247,6 +1250,7 @@ declare class ConversationsApi {
1247
1250
  patchConversationsMessageParticipantAttributes(conversationId: string, participantId: string, opts?: ConversationsApi.patchConversationsMessageParticipantAttributesOptions): Promise<void>;
1248
1251
  patchConversationsMessageParticipantCommunication(conversationId: string, participantId: string, communicationId: string, body: Models.MediaParticipantRequest): Promise<object>;
1249
1252
  patchConversationsMessagingIntegrationsFacebookIntegrationId(integrationId: string, body: Models.FacebookIntegrationUpdateRequest): Promise<Models.FacebookIntegration>;
1253
+ patchConversationsMessagingIntegrationsInstagramIntegrationId(integrationId: string, body: Models.InstagramIntegrationUpdateRequest): Promise<Models.InstagramIntegration>;
1250
1254
  patchConversationsMessagingIntegrationsOpenIntegrationId(integrationId: string, body: Models.OpenIntegrationUpdateRequest): Promise<Models.OpenIntegration>;
1251
1255
  patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId: string, body: Models.TwitterIntegrationRequest): Promise<Models.TwitterIntegration>;
1252
1256
  patchConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId: string, body: Models.WhatsAppIntegrationUpdateRequest): Promise<Models.WhatsAppIntegration>;
@@ -1264,11 +1268,17 @@ declare class ConversationsApi {
1264
1268
  postConversationParticipantCallbacks(conversationId: string, participantId: string, opts?: ConversationsApi.postConversationParticipantCallbacksOptions): Promise<void>;
1265
1269
  postConversationParticipantDigits(conversationId: string, participantId: string, opts?: ConversationsApi.postConversationParticipantDigitsOptions): Promise<void>;
1266
1270
  postConversationParticipantReplace(conversationId: string, participantId: string, body: Models.TransferRequest): Promise<void>;
1271
+ postConversationParticipantReplaceAgent(conversationId: string, participantId: string, body: Models.TransferToAgentRequest): Promise<void>;
1272
+ postConversationParticipantReplaceExternal(conversationId: string, participantId: string, body: Models.TransferToExternalRequest): Promise<void>;
1273
+ postConversationParticipantReplaceQueue(conversationId: string, participantId: string, body: Models.TransferToQueueRequest): Promise<void>;
1267
1274
  postConversationParticipantSecureivrsessions(conversationId: string, participantId: string, opts?: ConversationsApi.postConversationParticipantSecureivrsessionsOptions): Promise<Models.SecureSession>;
1268
1275
  postConversationsCall(conversationId: string, body: Models.CallCommand): Promise<Models.Conversation>;
1269
1276
  postConversationsCallParticipantCoach(conversationId: string, participantId: string): Promise<void>;
1270
1277
  postConversationsCallParticipantCommunicationWrapup(conversationId: string, participantId: string, communicationId: string, opts?: ConversationsApi.postConversationsCallParticipantCommunicationWrapupOptions): Promise<void>;
1271
1278
  postConversationsCallParticipantConsult(conversationId: string, participantId: string, body: Models.ConsultTransfer): Promise<Models.ConsultTransferResponse>;
1279
+ postConversationsCallParticipantConsultAgent(conversationId: string, participantId: string, body: Models.ConsultTransferToAgent): Promise<Models.ConsultTransferResponse>;
1280
+ postConversationsCallParticipantConsultExternal(conversationId: string, participantId: string, body: Models.ConsultTransferToExternal): Promise<Models.ConsultTransferResponse>;
1281
+ postConversationsCallParticipantConsultQueue(conversationId: string, participantId: string, body: Models.ConsultTransferToQueue): Promise<Models.ConsultTransferResponse>;
1272
1282
  postConversationsCallParticipantMonitor(conversationId: string, participantId: string): Promise<void>;
1273
1283
  postConversationsCallParticipantReplace(conversationId: string, participantId: string, body: Models.TransferRequest): Promise<void>;
1274
1284
  postConversationsCallParticipants(conversationId: string, body: Models.Conversation): Promise<Models.Conversation>;
@@ -1306,6 +1316,7 @@ declare class ConversationsApi {
1306
1316
  postConversationsMessagesAgentless(body: Models.SendAgentlessOutboundMessageRequest): Promise<Models.SendAgentlessOutboundMessageResponse>;
1307
1317
  postConversationsMessagesInboundOpen(body: Models.OpenNormalizedMessage): Promise<Models.OpenNormalizedMessage>;
1308
1318
  postConversationsMessagingIntegrationsFacebook(body: Models.FacebookIntegrationRequest): Promise<Models.FacebookIntegration>;
1319
+ postConversationsMessagingIntegrationsInstagram(body: Models.InstagramIntegrationRequest): Promise<Models.InstagramIntegration>;
1309
1320
  postConversationsMessagingIntegrationsLine(body: Models.LineIntegrationRequest): Promise<Models.LineIntegration>;
1310
1321
  postConversationsMessagingIntegrationsOpen(body: Models.OpenIntegrationRequest): Promise<Models.OpenIntegration>;
1311
1322
  postConversationsMessagingIntegrationsTwitter(body: Models.TwitterIntegrationRequest): Promise<Models.TwitterIntegration>;
@@ -1423,6 +1434,16 @@ declare namespace ConversationsApi {
1423
1434
  export interface getConversationsMessagingIntegrationsFacebookIntegrationIdOptions {
1424
1435
  "expand"?: string;
1425
1436
  }
1437
+ export interface getConversationsMessagingIntegrationsInstagramOptions {
1438
+ "pageSize"?: number;
1439
+ "pageNumber"?: number;
1440
+ "expand"?: string;
1441
+ "supportedContentId"?: string;
1442
+ "messagingSettingId"?: string;
1443
+ }
1444
+ export interface getConversationsMessagingIntegrationsInstagramIntegrationIdOptions {
1445
+ "expand"?: string;
1446
+ }
1426
1447
  export interface getConversationsMessagingIntegrationsLineOptions {
1427
1448
  "pageSize"?: number;
1428
1449
  "pageNumber"?: number;
@@ -2195,7 +2216,8 @@ declare class IntegrationsApi {
2195
2216
  putIntegrationsBotconnectorIntegrationIdBots(integrationId: string, botList: Models.BotList): Promise<void>;
2196
2217
  putIntegrationsCredential(credentialId: string, opts?: IntegrationsApi.putIntegrationsCredentialOptions): Promise<Models.CredentialInfo>;
2197
2218
  putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(nuanceIntegrationId: string, settings: Models.NuanceBotLaunchSettings): Promise<void>;
2198
- putIntegrationsSpeechTtsSettings(body: Models.TtsSettings): Promise<Models.TtsSettings>;
2219
+ putIntegrationsSpeechTtsSettings(body: Models.TtsSettings): Promise<Models.TtsSettings>;
2220
+ putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId: string, body: Array<Models.UCThirdPartyPresence>): Promise<string>;
2199
2221
  }
2200
2222
 
2201
2223
  declare namespace IntegrationsApi {
@@ -2393,7 +2415,6 @@ declare class JourneyApi {
2393
2415
  getJourneyActiontargets(opts?: JourneyApi.getJourneyActiontargetsOptions): Promise<Models.ActionTargetListing>;
2394
2416
  getJourneyActiontemplate(actionTemplateId: string): Promise<Models.ActionTemplate>;
2395
2417
  getJourneyActiontemplates(opts?: JourneyApi.getJourneyActiontemplatesOptions): Promise<Models.ActionTemplateListing>;
2396
- getJourneyCustomerCustomerIdSessions(customerIdType: string, customerId: string, opts?: JourneyApi.getJourneyCustomerCustomerIdSessionsOptions): Promise<Models.SessionListing>;
2397
2418
  getJourneyOutcome(outcomeId: string): Promise<Models.Outcome>;
2398
2419
  getJourneyOutcomes(opts?: JourneyApi.getJourneyOutcomesOptions): Promise<Models.OutcomeListing>;
2399
2420
  getJourneyOutcomesAttributionsJob(jobId: string): Promise<Models.OutcomeAttributionJobStateResponse>;
@@ -2452,10 +2473,6 @@ declare namespace JourneyApi {
2452
2473
  "queryFields"?: Array<string>;
2453
2474
  "queryValue"?: string;
2454
2475
  }
2455
- export interface getJourneyCustomerCustomerIdSessionsOptions {
2456
- "pageSize"?: string;
2457
- "after"?: string;
2458
- }
2459
2476
  export interface getJourneyOutcomesOptions {
2460
2477
  "pageNumber"?: number;
2461
2478
  "pageSize"?: number;
@@ -2561,7 +2578,7 @@ declare class KnowledgeApi {
2561
2578
  getKnowledgeKnowledgebases(opts?: KnowledgeApi.getKnowledgeKnowledgebasesOptions): Promise<Models.KnowledgeBaseListing>;
2562
2579
  patchKnowledgeGuestSessionDocumentsSearchSearchId(sessionId: string, searchId: string, body: Models.SearchUpdateRequest): Promise<void>;
2563
2580
  patchKnowledgeKnowledgebase(knowledgeBaseId: string, body: Models.KnowledgeBase): Promise<Models.KnowledgeBase>;
2564
- patchKnowledgeKnowledgebaseCategory(knowledgeBaseId: string, categoryId: string, body: Models.CategoryRequest): Promise<Models.CategoryResponse>;
2581
+ patchKnowledgeKnowledgebaseCategory(knowledgeBaseId: string, categoryId: string, body: Models.CategoryUpdateRequest): Promise<Models.CategoryResponse>;
2565
2582
  patchKnowledgeKnowledgebaseDocument(knowledgeBaseId: string, documentId: string, body: Models.KnowledgeDocumentReq): Promise<Models.KnowledgeDocumentResponse>;
2566
2583
  patchKnowledgeKnowledgebaseDocumentVariation(documentVariationId: string, documentId: string, knowledgeBaseId: string, body: Models.DocumentVariation): Promise<Models.DocumentVariation>;
2567
2584
  patchKnowledgeKnowledgebaseDocumentsSearchSearchId(knowledgeBaseId: string, searchId: string, opts?: KnowledgeApi.patchKnowledgeKnowledgebaseDocumentsSearchSearchIdOptions): Promise<void>;
@@ -2576,7 +2593,7 @@ declare class KnowledgeApi {
2576
2593
  postKnowledgeGuestSessionDocumentsSearch(sessionId: string, opts?: KnowledgeApi.postKnowledgeGuestSessionDocumentsSearchOptions): Promise<Models.KnowledgeDocumentGuestSearch>;
2577
2594
  postKnowledgeGuestSessionDocumentsSearchSuggestions(sessionId: string, opts?: KnowledgeApi.postKnowledgeGuestSessionDocumentsSearchSuggestionsOptions): Promise<Models.KnowledgeGuestDocumentSuggestion>;
2578
2595
  postKnowledgeGuestSessions(body: Models.KnowledgeGuestSession): Promise<Models.KnowledgeGuestSession>;
2579
- postKnowledgeKnowledgebaseCategories(knowledgeBaseId: string, body: Models.CategoryRequest): Promise<Models.CategoryResponse>;
2596
+ postKnowledgeKnowledgebaseCategories(knowledgeBaseId: string, body: Models.CategoryCreateRequest): Promise<Models.CategoryResponse>;
2580
2597
  postKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId: string, documentId: string, body: Models.DocumentVariation): Promise<Models.DocumentVariation>;
2581
2598
  postKnowledgeKnowledgebaseDocumentVersions(knowledgeBaseId: string, documentId: string, body: Models.KnowledgeDocumentVersion): Promise<Models.KnowledgeDocumentVersion>;
2582
2599
  postKnowledgeKnowledgebaseDocuments(knowledgeBaseId: string, body: Models.KnowledgeDocumentReq): Promise<Models.KnowledgeDocumentResponse>;
@@ -2663,6 +2680,7 @@ declare namespace KnowledgeApi {
2663
2680
  "includeDrafts"?: boolean;
2664
2681
  "labelIds"?: Array<string>;
2665
2682
  "expand"?: Array<string>;
2683
+ "externalIds"?: Array<string>;
2666
2684
  }
2667
2685
  export interface getKnowledgeKnowledgebaseLabelsOptions {
2668
2686
  "before"?: string;
@@ -3665,6 +3683,8 @@ declare class PresenceApi {
3665
3683
  getSystempresences(): Promise<Array<Models.SystemPresence>>;
3666
3684
  getUserPresence(userId: string, sourceId: string): Promise<Models.UserPresence>;
3667
3685
  getUserPresencesPurecloud(userId: string): Promise<Models.UserPresence>;
3686
+ getUsersPresenceBulk(sourceId: string, opts?: PresenceApi.getUsersPresenceBulkOptions): Promise<Array<Models.UcUserPresence>>;
3687
+ getUsersPresencesPurecloudBulk(opts?: PresenceApi.getUsersPresencesPurecloudBulkOptions): Promise<Array<Models.UcUserPresence>>;
3668
3688
  patchUserPresence(userId: string, sourceId: string, body: Models.UserPresence): Promise<Models.UserPresence>;
3669
3689
  patchUserPresencesPurecloud(userId: string, body: Models.UserPresence): Promise<Models.UserPresence>;
3670
3690
  postPresenceDefinitions0(body: Models.OrganizationPresenceDefinition): Promise<Models.OrganizationPresenceDefinition>;
@@ -3695,6 +3715,12 @@ declare namespace PresenceApi {
3695
3715
  "deleted"?: string;
3696
3716
  "localeCode"?: string;
3697
3717
  }
3718
+ export interface getUsersPresenceBulkOptions {
3719
+ "id"?: Array<string>;
3720
+ }
3721
+ export interface getUsersPresencesPurecloudBulkOptions {
3722
+ "id"?: Array<string>;
3723
+ }
3698
3724
  }
3699
3725
 
3700
3726
  declare class ProcessAutomationApi {
@@ -4941,7 +4967,7 @@ declare class TaskManagementApi {
4941
4967
  getTaskmanagementWorkbinHistory(workbinId: string, opts?: TaskManagementApi.getTaskmanagementWorkbinHistoryOptions): Promise<Models.WorkbinChangeListing>;
4942
4968
  getTaskmanagementWorkbinVersion(workbinId: string, entityVersion: number): Promise<Models.WorkbinVersion>;
4943
4969
  getTaskmanagementWorkbinVersions(workbinId: string, opts?: TaskManagementApi.getTaskmanagementWorkbinVersionsOptions): Promise<Models.WorkbinVersionListing>;
4944
- getTaskmanagementWorkitem(workitemId: string): Promise<Models.Workitem>;
4970
+ getTaskmanagementWorkitem(workitemId: string, opts?: TaskManagementApi.getTaskmanagementWorkitemOptions): Promise<Models.Workitem>;
4945
4971
  getTaskmanagementWorkitemHistory(workitemId: string, opts?: TaskManagementApi.getTaskmanagementWorkitemHistoryOptions): Promise<Models.WorkitemChangeListing>;
4946
4972
  getTaskmanagementWorkitemUserWrapups(workitemId: string, userId: string, opts?: TaskManagementApi.getTaskmanagementWorkitemUserWrapupsOptions): Promise<Models.WorkitemWrapup>;
4947
4973
  getTaskmanagementWorkitemVersion(workitemId: string, entityVersion: number): Promise<Models.WorkitemVersion>;
@@ -4988,6 +5014,9 @@ declare namespace TaskManagementApi {
4988
5014
  "pageSize"?: number;
4989
5015
  "sortOrder"?: string;
4990
5016
  }
5017
+ export interface getTaskmanagementWorkitemOptions {
5018
+ "expands"?: string;
5019
+ }
4991
5020
  export interface getTaskmanagementWorkitemHistoryOptions {
4992
5021
  "after"?: string;
4993
5022
  "pageSize"?: number;
@@ -9039,18 +9068,18 @@ declare namespace Models {
9039
9068
  "planningGroupResults"?: Array<Models.BuForecastGenerationPlanningGroupResult>;
9040
9069
  }
9041
9070
 
9042
- export interface BuForecastModification {
9071
+ export interface BuForecastModificationResponse {
9043
9072
  "type": string;
9044
9073
  "startIntervalIndex"?: number;
9045
9074
  "endIntervalIndex"?: number;
9046
9075
  "metric": string;
9047
9076
  "legacyMetric"?: string;
9048
9077
  "value"?: number;
9049
- "values"?: Array<Models.WfmForecastModificationIntervalOffsetValue>;
9078
+ "values": Array<Models.WfmForecastModificationIntervalOffsetValue>;
9050
9079
  "displayGranularity": string;
9051
- "granularity"?: string;
9080
+ "granularity": string;
9052
9081
  "enabled": boolean;
9053
- "planningGroupIds"?: Array<string>;
9082
+ "planningGroupIds": Array<string>;
9054
9083
  }
9055
9084
 
9056
9085
  export interface BuForecastResult {
@@ -9305,7 +9334,7 @@ declare namespace Models {
9305
9334
  "canUseForScheduling"?: boolean;
9306
9335
  "referenceStartDate"?: string;
9307
9336
  "sourceDays"?: Array<Models.ForecastSourceDayPointer>;
9308
- "modifications"?: Array<Models.BuForecastModification>;
9337
+ "modifications"?: Array<Models.BuForecastModificationResponse>;
9309
9338
  "generationResults"?: Models.BuForecastGenerationResult;
9310
9339
  "timeZone"?: string;
9311
9340
  "planningGroupsVersion"?: number;
@@ -9966,6 +9995,7 @@ declare namespace Models {
9966
9995
  "uuiData"?: string;
9967
9996
  "bargedTime"?: string;
9968
9997
  "securePause"?: boolean;
9998
+ "disposition"?: Models.Disposition;
9969
9999
  }
9970
10000
 
9971
10001
  export interface CallMediaPolicy {
@@ -10445,6 +10475,15 @@ declare namespace Models {
10445
10475
  "name"?: string;
10446
10476
  }
10447
10477
 
10478
+ export interface CategoryCreateRequest {
10479
+ "id"?: string;
10480
+ "name": string;
10481
+ "parentCategoryId"?: string;
10482
+ "description"?: string;
10483
+ "externalId"?: string;
10484
+ "selfUri"?: string;
10485
+ }
10486
+
10448
10487
  export interface CategoryEntityListing {
10449
10488
  "entities"?: Array<Models.Category>;
10450
10489
  "pageSize"?: number;
@@ -10467,18 +10506,11 @@ declare namespace Models {
10467
10506
  "selfUri"?: string;
10468
10507
  }
10469
10508
 
10470
- export interface CategoryRequest {
10471
- "id"?: string;
10472
- "name": string;
10473
- "description"?: string;
10474
- "parentCategoryId"?: string;
10475
- "selfUri"?: string;
10476
- }
10477
-
10478
10509
  export interface CategoryResponse {
10479
10510
  "id"?: string;
10480
10511
  "name": string;
10481
10512
  "description"?: string;
10513
+ "externalId"?: string;
10482
10514
  "dateCreated"?: string;
10483
10515
  "dateModified"?: string;
10484
10516
  "parentCategory"?: Models.CategoryReference;
@@ -10494,6 +10526,15 @@ declare namespace Models {
10494
10526
  "previousUri"?: string;
10495
10527
  }
10496
10528
 
10529
+ export interface CategoryUpdateRequest {
10530
+ "id"?: string;
10531
+ "name"?: string;
10532
+ "parentCategoryId"?: string;
10533
+ "description"?: string;
10534
+ "externalId"?: string;
10535
+ "selfUri"?: string;
10536
+ }
10537
+
10497
10538
  export interface Certificate {
10498
10539
  "certificate": string;
10499
10540
  }
@@ -11184,7 +11225,8 @@ declare namespace Models {
11184
11225
  }
11185
11226
 
11186
11227
  export interface ConsultTransfer {
11187
- "speakTo"?: string;
11228
+ "speakTo": string;
11229
+ "consultingUserId"?: string;
11188
11230
  "destination": Models.Destination;
11189
11231
  }
11190
11232
 
@@ -11201,8 +11243,29 @@ declare namespace Models {
11201
11243
  "destinationParticipantId": string;
11202
11244
  }
11203
11245
 
11246
+ export interface ConsultTransferToAgent {
11247
+ "speakTo": string;
11248
+ "consultingUserId"?: string;
11249
+ "userId"?: string;
11250
+ "userDisplayName"?: string;
11251
+ }
11252
+
11253
+ export interface ConsultTransferToExternal {
11254
+ "speakTo": string;
11255
+ "consultingUserId"?: string;
11256
+ "address"?: string;
11257
+ }
11258
+
11259
+ export interface ConsultTransferToQueue {
11260
+ "speakTo": string;
11261
+ "consultingUserId"?: string;
11262
+ "queueId"?: string;
11263
+ "queueName"?: string;
11264
+ }
11265
+
11204
11266
  export interface ConsultTransferUpdate {
11205
11267
  "speakTo": string;
11268
+ "consultingUserId"?: string;
11206
11269
  }
11207
11270
 
11208
11271
  export interface ConsumedResourcesEntityListing {
@@ -14402,6 +14465,7 @@ declare namespace Models {
14402
14465
  "joinedMemberCount"?: number;
14403
14466
  "mediaSettings"?: Models.QueueMediaSettings;
14404
14467
  "routingRules"?: Array<Models.RoutingRule>;
14468
+ "conditionalGroupRouting"?: Models.ConditionalGroupRouting;
14405
14469
  "bullseye"?: Models.Bullseye;
14406
14470
  "acwSettings"?: Models.AcwSettings;
14407
14471
  "skillEvaluationMethod"?: string;
@@ -17844,6 +17908,7 @@ declare namespace Models {
17844
17908
  "contextId"?: string;
17845
17909
  "details"?: Array<Models.Detail>;
17846
17910
  "errors"?: Array<Models.ErrorBody>;
17911
+ "limit"?: Models.Limit;
17847
17912
  }
17848
17913
 
17849
17914
  export interface ErrorDetails {
@@ -20362,18 +20427,8 @@ declare namespace Models {
20362
20427
  "selfUri"?: string;
20363
20428
  }
20364
20429
 
20365
- export interface GuestCategoryResponse {
20366
- "id"?: string;
20367
- "name": string;
20368
- "description"?: string;
20369
- "dateCreated"?: string;
20370
- "dateModified"?: string;
20371
- "parentCategory"?: Models.GuestCategoryReference;
20372
- "selfUri"?: string;
20373
- }
20374
-
20375
20430
  export interface GuestCategoryResponseListing {
20376
- "entities"?: Array<Models.GuestCategoryResponse>;
20431
+ "entities"?: Array<Models.GuestResponseCategory>;
20377
20432
  "nextUri"?: string;
20378
20433
  "selfUri"?: string;
20379
20434
  "previousUri"?: string;
@@ -20390,6 +20445,17 @@ declare namespace Models {
20390
20445
  "customFields"?: { [key: string]: string; };
20391
20446
  }
20392
20447
 
20448
+ export interface GuestResponseCategory {
20449
+ "id"?: string;
20450
+ "name"?: string;
20451
+ "description"?: string;
20452
+ "externalId"?: string;
20453
+ "dateCreated"?: string;
20454
+ "dateModified"?: string;
20455
+ "parentCategory"?: Models.GuestCategoryReference;
20456
+ "selfUri"?: string;
20457
+ }
20458
+
20393
20459
  export interface HeadcountForecast {
20394
20460
  "required": Array<Models.HeadcountInterval>;
20395
20461
  "requiredWithoutShrinkage": Array<Models.HeadcountInterval>;
@@ -21012,6 +21078,65 @@ declare namespace Models {
21012
21078
  "displayName"?: string;
21013
21079
  }
21014
21080
 
21081
+ export interface InstagramIntegration {
21082
+ "id": string;
21083
+ "name": string;
21084
+ "supportedContent"?: Models.SupportedContentReference;
21085
+ "messagingSetting"?: Models.MessagingSettingReference;
21086
+ "appId": string;
21087
+ "pageId"?: string;
21088
+ "instagramId"?: string;
21089
+ "instagramUsername"?: string;
21090
+ "instagramName"?: string;
21091
+ "instagramProfileImageUrl"?: string;
21092
+ "status"?: string;
21093
+ "recipient"?: Models.DomainEntityRef;
21094
+ "dateCreated"?: string;
21095
+ "dateModified"?: string;
21096
+ "createdBy"?: Models.DomainEntityRef;
21097
+ "modifiedBy"?: Models.DomainEntityRef;
21098
+ "version": number;
21099
+ "createStatus"?: string;
21100
+ "createError"?: Models.ErrorBody;
21101
+ "selfUri"?: string;
21102
+ }
21103
+
21104
+ export interface InstagramIntegrationEntityListing {
21105
+ "entities"?: Array<Models.InstagramIntegration>;
21106
+ "pageSize"?: number;
21107
+ "pageNumber"?: number;
21108
+ "total"?: number;
21109
+ "firstUri"?: string;
21110
+ "nextUri"?: string;
21111
+ "previousUri"?: string;
21112
+ "lastUri"?: string;
21113
+ "selfUri"?: string;
21114
+ "pageCount"?: number;
21115
+ }
21116
+
21117
+ export interface InstagramIntegrationRequest {
21118
+ "id"?: string;
21119
+ "name": string;
21120
+ "supportedContent"?: Models.SupportedContentReference;
21121
+ "messagingSetting"?: Models.MessagingSettingRequestReference;
21122
+ "pageAccessToken"?: string;
21123
+ "userAccessToken"?: string;
21124
+ "pageId"?: string;
21125
+ "appId"?: string;
21126
+ "appSecret"?: string;
21127
+ "selfUri"?: string;
21128
+ }
21129
+
21130
+ export interface InstagramIntegrationUpdateRequest {
21131
+ "id"?: string;
21132
+ "name"?: string;
21133
+ "supportedContent"?: Models.SupportedContentReference;
21134
+ "messagingSetting"?: Models.MessagingSettingRequestReference;
21135
+ "pageAccessToken"?: string;
21136
+ "userAccessToken"?: string;
21137
+ "selfUri"?: string;
21138
+ }
21139
+
21015
21140
  export interface InstagramScopedId {
21016
21141
  "scopedId"?: string;
21017
21142
  }
@@ -22496,6 +22621,7 @@ declare namespace Models {
22496
22621
  "alternatives"?: Array<Models.KnowledgeDocumentAlternative>;
22497
22622
  "categoryId"?: string;
22498
22623
  "labelIds"?: Array<string>;
22624
+ "externalId"?: string;
22499
22625
  "selfUri"?: string;
22500
22626
  }
22501
22627
 
@@ -22525,6 +22651,7 @@ declare namespace Models {
22525
22651
  "labels"?: Array<Models.LabelResponse>;
22526
22652
  "knowledgeBase"?: Models.KnowledgeBaseReference;
22527
22653
  "variations"?: Array<Models.DocumentVariation>;
22654
+ "externalId"?: string;
22528
22655
  "selfUri"?: string;
22529
22656
  }
22530
22657
 
@@ -22782,6 +22909,7 @@ declare namespace Models {
22782
22909
  "contextId"?: string;
22783
22910
  "details"?: Array<Models.Detail>;
22784
22911
  "errors"?: Array<Models.ErrorBody>;
22912
+ "limit"?: Models.Limit;
22785
22913
  "documentIndex"?: number;
22786
22914
  }
22787
22915
 
@@ -22903,6 +23031,7 @@ declare namespace Models {
22903
23031
  "id"?: string;
22904
23032
  "name": string;
22905
23033
  "color": string;
23034
+ "externalId"?: string;
22906
23035
  "selfUri"?: string;
22907
23036
  }
22908
23037
 
@@ -22920,6 +23049,7 @@ declare namespace Models {
22920
23049
  "dateCreated"?: string;
22921
23050
  "dateModified"?: string;
22922
23051
  "documentCount"?: number;
23052
+ "externalId"?: string;
22923
23053
  "selfUri"?: string;
22924
23054
  }
22925
23055
 
@@ -22927,6 +23057,7 @@ declare namespace Models {
22927
23057
  "id"?: string;
22928
23058
  "name"?: string;
22929
23059
  "color"?: string;
23060
+ "externalId"?: string;
22930
23061
  "selfUri"?: string;
22931
23062
  }
22932
23063
 
@@ -23519,6 +23650,7 @@ declare namespace Models {
23519
23650
 
23520
23651
  export interface Limit {
23521
23652
  "key"?: string;
23653
+ "namespace"?: string;
23522
23654
  "value"?: number;
23523
23655
  }
23524
23656
 
@@ -27581,6 +27713,7 @@ declare namespace Models {
27581
27713
  "joinedMemberCount"?: number;
27582
27714
  "mediaSettings"?: Models.QueueMediaSettings;
27583
27715
  "routingRules"?: Array<Models.RoutingRule>;
27716
+ "conditionalGroupRouting"?: Models.ConditionalGroupRouting;
27584
27717
  "bullseye"?: Models.Bullseye;
27585
27718
  "acwSettings"?: Models.AcwSettings;
27586
27719
  "skillEvaluationMethod"?: string;
@@ -30018,6 +30151,7 @@ declare namespace Models {
30018
30151
  export interface QueueMessagingAddresses {
30019
30152
  "smsAddress"?: Models.DomainEntityRef;
30020
30153
  "openMessagingRecipient"?: Models.DomainEntityRef;
30154
+ "whatsAppRecipient"?: Models.DomainEntityRef;
30021
30155
  }
30022
30156
 
30023
30157
  export interface QueueObservationDataContainer {
@@ -30074,6 +30208,7 @@ declare namespace Models {
30074
30208
  "joinedMemberCount"?: number;
30075
30209
  "mediaSettings"?: Models.QueueMediaSettings;
30076
30210
  "routingRules"?: Array<Models.RoutingRule>;
30211
+ "conditionalGroupRouting"?: Models.ConditionalGroupRouting;
30077
30212
  "bullseye"?: Models.Bullseye;
30078
30213
  "acwSettings"?: Models.AcwSettings;
30079
30214
  "skillEvaluationMethod"?: string;
@@ -32176,6 +32311,7 @@ declare namespace Models {
32176
32311
  "textBody"?: string;
32177
32312
  "messagingTemplate"?: Models.MessagingTemplateRequest;
32178
32313
  "useExistingActiveConversation"?: boolean;
32314
+ "message"?: Models.MessageData;
32179
32315
  "timestamp"?: string;
32180
32316
  "selfUri"?: string;
32181
32317
  "user"?: Models.AddressableEntityRef;
@@ -34518,12 +34654,12 @@ declare namespace Models {
34518
34654
  }
34519
34655
 
34520
34656
  export interface TransferRequest {
34657
+ "transferType"?: string;
34521
34658
  "userId"?: string;
34522
34659
  "address"?: string;
34523
34660
  "userName"?: string;
34524
34661
  "queueId"?: string;
34525
34662
  "voicemail"?: boolean;
34526
- "transferType"?: string;
34527
34663
  }
34528
34664
 
34529
34665
  export interface TransferResponse {
@@ -34541,6 +34677,25 @@ declare namespace Models {
34541
34677
  "selfUri"?: string;
34542
34678
  }
34543
34679
 
34680
+ export interface TransferToAgentRequest {
34681
+ "transferType"?: string;
34682
+ "userId"?: string;
34683
+ "userName"?: string;
34684
+ "userDisplayName"?: string;
34685
+ "voicemail"?: boolean;
34686
+ }
34687
+
34688
+ export interface TransferToExternalRequest {
34689
+ "transferType"?: string;
34690
+ "address"?: string;
34691
+ }
34692
+
34693
+ export interface TransferToQueueRequest {
34694
+ "transferType"?: string;
34695
+ "queueId"?: string;
34696
+ "queueName"?: string;
34697
+ }
34698
+
34544
34699
  export interface TrendData {
34545
34700
  "dateStartWorkday"?: string;
34546
34701
  "dateEndWorkday"?: string;
@@ -35155,6 +35310,24 @@ declare namespace Models {
35155
35310
  "pageCount"?: number;
35156
35311
  }
35157
35312
 
35313
+ export interface UCThirdPartyPresence {
35314
+ "email": string;
35315
+ "presence": string;
35316
+ "message"?: string;
35317
+ "dateModified"?: string;
35318
+ }
35319
+
35320
+ export interface UcUserPresence {
35321
+ "id"?: string;
35322
+ "name"?: string;
35323
+ "userId"?: string;
35324
+ "source"?: string;
35325
+ "presenceDefinition"?: Models.PresenceDefinition;
35326
+ "message"?: string;
35327
+ "modifiedDate"?: string;
35328
+ "selfUri"?: string;
35329
+ }
35330
+
35158
35331
  export interface UnansweredGroup {
35159
35332
  "id"?: string;
35160
35333
  "label"?: string;
@@ -36068,6 +36241,7 @@ declare namespace Models {
36068
36241
  "joinedMemberCount"?: number;
36069
36242
  "mediaSettings"?: Models.QueueMediaSettings;
36070
36243
  "routingRules"?: Array<Models.RoutingRule>;
36244
+ "conditionalGroupRouting"?: Models.ConditionalGroupRouting;
36071
36245
  "bullseye"?: Models.Bullseye;
36072
36246
  "acwSettings"?: Models.AcwSettings;
36073
36247
  "skillEvaluationMethod"?: string;
@@ -37186,6 +37360,8 @@ declare namespace Models {
37186
37360
  "isClearedByCustomer"?: boolean;
37187
37361
  "evaluationAssigneeIds"?: Array<string>;
37188
37362
  "evaluationAssigned"?: boolean;
37363
+ "assistantIds"?: Array<string>;
37364
+ "knowledgeBaseIds"?: Array<string>;
37189
37365
  }
37190
37366
 
37191
37367
  export interface VisibilityCondition {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "169.1.0",
3
+ "version": "170.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 169.1.0
7
+ * @version 170.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 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**