purecloud-platform-client-v2 196.0.0 → 197.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 (87) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +649 -116
  3. package/dist/web-amd/purecloud-platform-client-v2.js +649 -116
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +234 -98
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +235 -98
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +271 -92
  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/AgentUIApi.js +136 -0
  12. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +129 -1
  23. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +156 -0
  27. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +8 -4
  29. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/JourneyApi.js +3 -2
  40. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LearningApi.js +3 -2
  44. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OutboundApi.js +31 -35
  56. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -2
  62. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/SettingsApi.js +111 -1
  67. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/index.js +13 -1
package/index.d.ts CHANGED
@@ -78,6 +78,16 @@ declare class Logger {
78
78
  setLogger(): void;
79
79
  }
80
80
 
81
+ declare class AgentUIApi {
82
+ deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId: string): Promise<void>;
83
+ getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId: string): Promise<Models.AutoAnswerSettings>;
84
+ patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId: string, body: Models.AutoAnswerSettings): Promise<Models.AutoAnswerSettings>;
85
+ putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId: string, body: Models.AutoAnswerSettings): Promise<Models.AutoAnswerSettings>;
86
+ }
87
+
88
+ declare namespace AgentUIApi {
89
+ }
90
+
81
91
  declare class AlertingApi {
82
92
  deleteAlertingAlert(alertId: string): Promise<void>;
83
93
  deleteAlertingInteractionstatsAlert(alertId: string): Promise<void>;
@@ -1389,6 +1399,8 @@ declare class ConversationsApi {
1389
1399
  getConversationParticipantWrapup(conversationId: string, participantId: string, opts?: ConversationsApi.getConversationParticipantWrapupOptions): Promise<Models.AssignedWrapupCode>;
1390
1400
  getConversationParticipantWrapupcodes(conversationId: string, participantId: string): Promise<Array<Models.WrapupCode>>;
1391
1401
  getConversationSecureattributes(conversationId: string): Promise<Models.ConversationSecureAttributes>;
1402
+ getConversationSuggestion(conversationId: string, suggestionId: string): Promise<Models.Suggestion>;
1403
+ getConversationSuggestions(conversationId: string, opts?: ConversationsApi.getConversationSuggestionsOptions): Promise<Models.SuggestionListing>;
1392
1404
  getConversations(opts?: ConversationsApi.getConversationsOptions): Promise<Models.ConversationEntityListing>;
1393
1405
  getConversationsCall(conversationId: string): Promise<Models.CallConversation>;
1394
1406
  getConversationsCallParticipantCommunicationWrapup(conversationId: string, participantId: string, communicationId: string, opts?: ConversationsApi.getConversationsCallParticipantCommunicationWrapupOptions): Promise<Models.AssignedWrapupCode>;
@@ -1516,6 +1528,8 @@ declare class ConversationsApi {
1516
1528
  postConversationParticipantReplaceExternal(conversationId: string, participantId: string, body: Models.TransferToExternalRequest): Promise<void>;
1517
1529
  postConversationParticipantReplaceQueue(conversationId: string, participantId: string, body: Models.TransferToQueueRequest): Promise<void>;
1518
1530
  postConversationParticipantSecureivrsessions(conversationId: string, participantId: string, opts?: ConversationsApi.postConversationParticipantSecureivrsessionsOptions): Promise<Models.SecureSession>;
1531
+ postConversationSuggestionEngagement(conversationId: string, suggestionId: string, body: Models.SuggestionEngagement): Promise<Models.SuggestionEngagement>;
1532
+ postConversationSuggestionsFeedback(conversationId: string, body: Models.Feedback): Promise<void>;
1519
1533
  postConversationSummaryFeedback(conversationId: string, summaryId: string, opts?: ConversationsApi.postConversationSummaryFeedbackOptions): Promise<void>;
1520
1534
  postConversationsCall(conversationId: string, body: Models.CallCommand): Promise<Models.Conversation>;
1521
1535
  postConversationsCallParticipantBarge(conversationId: string, participantId: string): Promise<void>;
@@ -1611,6 +1625,13 @@ declare namespace ConversationsApi {
1611
1625
  export interface getConversationParticipantWrapupOptions {
1612
1626
  "provisional"?: boolean;
1613
1627
  }
1628
+ export interface getConversationSuggestionsOptions {
1629
+ "before"?: string;
1630
+ "after"?: string;
1631
+ "pageSize"?: string;
1632
+ "type"?: string;
1633
+ "state"?: string;
1634
+ }
1614
1635
  export interface getConversationsOptions {
1615
1636
  "communicationType"?: string;
1616
1637
  }
@@ -1841,6 +1862,21 @@ declare namespace EmailsApi {
1841
1862
  }
1842
1863
  }
1843
1864
 
1865
+ declare class EmployeeEngagementApi {
1866
+ deleteEmployeeengagementCelebration(celebrationId: string): Promise<void>;
1867
+ getEmployeeengagementCelebrations(opts?: EmployeeEngagementApi.getEmployeeengagementCelebrationsOptions): Promise<Models.GetCelebrationListing>;
1868
+ getEmployeeengagementRecognition(recognitionId: string): Promise<Models.Recognition>;
1869
+ patchEmployeeengagementCelebration(celebrationId: string, body: Models.CelebrationStateParam): Promise<void>;
1870
+ postEmployeeengagementRecognitions(body: Models.CreateRecognition): Promise<Models.RecognitionBase>;
1871
+ }
1872
+
1873
+ declare namespace EmployeeEngagementApi {
1874
+ export interface getEmployeeengagementCelebrationsOptions {
1875
+ "pageNumber"?: number;
1876
+ "pageSize"?: number;
1877
+ }
1878
+ }
1879
+
1844
1880
  declare class EventsApi {
1845
1881
  postEventsConversations(body: Models.BatchConversationEventRequest): Promise<Models.BatchEventResponse>;
1846
1882
  postEventsUsersPresence(body: Models.BatchUserPresenceEventRequest): Promise<Models.BatchEventResponse>;
@@ -1907,7 +1943,7 @@ declare class ExternalContactsApi {
1907
1943
  postExternalcontactsContactPromotion(contactId: string): Promise<Models.ExternalContact>;
1908
1944
  postExternalcontactsContacts(body: Models.ExternalContact): Promise<Models.ExternalContact>;
1909
1945
  postExternalcontactsContactsSchemas(body: Models.DataSchema): Promise<Models.DataSchema>;
1910
- postExternalcontactsIdentifierlookup(identifier: Models.ContactIdentifier): Promise<Models.ExternalContact>;
1946
+ postExternalcontactsIdentifierlookup(identifier: Models.ContactIdentifier, opts?: ExternalContactsApi.postExternalcontactsIdentifierlookupOptions): Promise<Models.ExternalContact>;
1911
1947
  postExternalcontactsMergeContacts(body: Models.MergeRequest): Promise<Models.ExternalContact>;
1912
1948
  postExternalcontactsOrganizationNotes(externalOrganizationId: string, body: Models.Note): Promise<Models.Note>;
1913
1949
  postExternalcontactsOrganizations(body: Models.ExternalOrganization): Promise<Models.ExternalOrganization>;
@@ -2009,6 +2045,9 @@ declare namespace ExternalContactsApi {
2009
2045
  "limit"?: number;
2010
2046
  "cursor"?: string;
2011
2047
  }
2048
+ export interface postExternalcontactsIdentifierlookupOptions {
2049
+ "expand"?: Array<string>;
2050
+ }
2012
2051
  }
2013
2052
 
2014
2053
  declare class FaxApi {
@@ -2830,6 +2869,7 @@ declare namespace JourneyApi {
2830
2869
  export interface getJourneySessionEventsOptions {
2831
2870
  "pageSize"?: string;
2832
2871
  "after"?: string;
2872
+ "eventType"?: string;
2833
2873
  }
2834
2874
  export interface getJourneyViewsJobsOptions {
2835
2875
  "pageNumber"?: number;
@@ -3337,6 +3377,7 @@ declare namespace LearningApi {
3337
3377
  }
3338
3378
  export interface getLearningAssignmentStepOptions {
3339
3379
  "shareableContentObjectId"?: string;
3380
+ "defaultShareableContentObject"?: string;
3340
3381
  "expand"?: Array<string>;
3341
3382
  }
3342
3383
  export interface getLearningAssignmentsOptions {
@@ -3886,12 +3927,12 @@ declare class OutboundApi {
3886
3927
  getOutboundSequences(opts?: OutboundApi.getOutboundSequencesOptions): Promise<Models.CampaignSequenceEntityListing>;
3887
3928
  getOutboundSettings(): Promise<Models.OutboundSettings>;
3888
3929
  getOutboundWrapupcodemappings(): Promise<Models.WrapUpCodeMapping>;
3930
+ patchOutboundCampaign(campaignId: string, body: Models.CampaignPatchRequest): Promise<void>;
3889
3931
  patchOutboundDnclistCustomexclusioncolumns(dncListId: string, body: Models.DncPatchCustomExclusionColumnsRequest): Promise<void>;
3890
3932
  patchOutboundDnclistEmailaddresses(dncListId: string, body: Models.DncPatchEmailsRequest): Promise<void>;
3891
3933
  patchOutboundDnclistPhonenumbers(dncListId: string, body: Models.DncPatchPhoneNumbersRequest): Promise<void>;
3892
3934
  patchOutboundSettings(body: Models.OutboundSettings): Promise<void>;
3893
3935
  postOutboundAttemptlimits(body: Models.AttemptLimits): Promise<Models.AttemptLimits>;
3894
- postOutboundAudits(body: Models.DialerAuditRequest, opts?: OutboundApi.postOutboundAuditsOptions): Promise<Models.AuditSearchResult>;
3895
3936
  postOutboundCallabletimesets(body: Models.CallableTimeSet): Promise<Models.CallableTimeSet>;
3896
3937
  postOutboundCallanalysisresponsesets(body: Models.ResponseSet): Promise<Models.ResponseSet>;
3897
3938
  postOutboundCampaignAgentownedmappingpreview(campaignId: string): Promise<object>;
@@ -4218,13 +4259,6 @@ declare namespace OutboundApi {
4218
4259
  "sortBy"?: string;
4219
4260
  "sortOrder"?: string;
4220
4261
  }
4221
- export interface postOutboundAuditsOptions {
4222
- "pageSize"?: number;
4223
- "pageNumber"?: number;
4224
- "sortBy"?: string;
4225
- "sortOrder"?: string;
4226
- "facetsOnly"?: boolean;
4227
- }
4228
4262
  export interface postOutboundContactlistContactsOptions {
4229
4263
  "priority"?: boolean;
4230
4264
  "clearSystemData"?: boolean;
@@ -5085,6 +5119,7 @@ declare namespace RoutingApi {
5085
5119
  "sortOrder"?: string;
5086
5120
  "language"?: string;
5087
5121
  "integrationId"?: string;
5122
+ "supportedContentId"?: string;
5088
5123
  }
5089
5124
  export interface getRoutingUtilizationLabelsOptions {
5090
5125
  "pageSize"?: number;
@@ -5461,10 +5496,14 @@ declare namespace SearchApi {
5461
5496
  }
5462
5497
 
5463
5498
  declare class SettingsApi {
5499
+ deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId: string): Promise<void>;
5464
5500
  getEmailsSettings(): Promise<Models.EmailSettings>;
5465
5501
  getSettingsExecutiondata(): Promise<Models.ExecutionDataGlobalSettingsResponse>;
5502
+ getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId: string): Promise<Models.AutoAnswerSettings>;
5466
5503
  patchEmailsSettings(opts?: SettingsApi.patchEmailsSettingsOptions): Promise<Models.EmailSettings>;
5467
- patchSettingsExecutiondata(body: Models.ExecutionDataSettingsRequest): Promise<Models.ExecutionDataGlobalSettingsResponse>;
5504
+ patchSettingsExecutiondata(body: Models.ExecutionDataSettingsRequest): Promise<Models.ExecutionDataGlobalSettingsResponse>;
5505
+ patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId: string, body: Models.AutoAnswerSettings): Promise<Models.AutoAnswerSettings>;
5506
+ putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId: string, body: Models.AutoAnswerSettings): Promise<Models.AutoAnswerSettings>;
5468
5507
  }
5469
5508
 
5470
5509
  declare namespace SettingsApi {
@@ -5476,7 +5515,7 @@ declare namespace SettingsApi {
5476
5515
  declare class SpeechTextAnalyticsApi {
5477
5516
  deleteSpeechandtextanalyticsCategory(categoryId: string): Promise<void>;
5478
5517
  deleteSpeechandtextanalyticsDictionaryfeedbackDictionaryFeedbackId(dictionaryFeedbackId: string): Promise<void>;
5479
- deleteSpeechandtextanalyticsProgram(programId: string, opts?: SpeechTextAnalyticsApi.deleteSpeechandtextanalyticsProgramOptions): Promise<void>;
5518
+ deleteSpeechandtextanalyticsProgram(programId: string, opts?: SpeechTextAnalyticsApi.deleteSpeechandtextanalyticsProgramOptions): Promise<Models.DeleteProgramResponse>;
5480
5519
  deleteSpeechandtextanalyticsSentimentfeedback(): Promise<void>;
5481
5520
  deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId: string): Promise<void>;
5482
5521
  deleteSpeechandtextanalyticsTopic(topicId: string): Promise<void>;
@@ -9031,6 +9070,16 @@ declare namespace Models {
9031
9070
  export interface ArrayNode {
9032
9071
  }
9033
9072
 
9073
+ export interface Article {
9074
+ "title"?: string;
9075
+ "uri"?: string;
9076
+ "snippets"?: Array<string>;
9077
+ "confidence"?: number;
9078
+ "metadata"?: { [key: string]: Models.MetadataAttribute; };
9079
+ "version"?: Models.AddressableEntityRef;
9080
+ "variations"?: Array<Models.AddressableEntityRef>;
9081
+ }
9082
+
9034
9083
  export interface ArticleContent {
9035
9084
  "body"?: Models.ArticleContentBody;
9036
9085
  }
@@ -9376,25 +9425,6 @@ declare namespace Models {
9376
9425
  "audioState": Models.AudioState;
9377
9426
  }
9378
9427
 
9379
- export interface AuditEntity {
9380
- "type": string;
9381
- "id"?: string;
9382
- "name"?: string;
9383
- "selfUri"?: string;
9384
- }
9385
-
9386
- export interface AuditFacet {
9387
- "name": string;
9388
- "type": string;
9389
- }
9390
-
9391
- export interface AuditFilter {
9392
- "name": string;
9393
- "type": string;
9394
- "operator": string;
9395
- "values": Array<string>;
9396
- }
9397
-
9398
9428
  export interface AuditLogMessage {
9399
9429
  "id"?: string;
9400
9430
  "userHomeOrgId"?: string;
@@ -9417,25 +9447,6 @@ declare namespace Models {
9417
9447
  "entityChanges"?: Array<Models.EntityChange>;
9418
9448
  }
9419
9449
 
9420
- export interface AuditMessage {
9421
- "id": string;
9422
- "user"?: Models.AuditUser;
9423
- "correlationId"?: string;
9424
- "transactionId"?: string;
9425
- "transactionInitiator"?: boolean;
9426
- "application"?: string;
9427
- "serviceName": string;
9428
- "level": string;
9429
- "timestamp"?: string;
9430
- "receivedTimestamp": string;
9431
- "status": string;
9432
- "actionContext"?: string;
9433
- "action"?: string;
9434
- "changes"?: Array<Models.Change>;
9435
- "entity"?: Models.AuditEntity;
9436
- "serviceContext"?: Models.ServiceContext;
9437
- }
9438
-
9439
9450
  export interface AuditQueryEntity {
9440
9451
  "name"?: string;
9441
9452
  "actions"?: Array<string>;
@@ -9514,15 +9525,6 @@ declare namespace Models {
9514
9525
  "entities"?: Array<Models.AuditLogMessage>;
9515
9526
  }
9516
9527
 
9517
- export interface AuditSearchResult {
9518
- "pageNumber"?: number;
9519
- "pageSize"?: number;
9520
- "total"?: number;
9521
- "pageCount"?: number;
9522
- "facetInfo"?: Array<Models.FacetInfo>;
9523
- "auditMessages"?: Array<Models.AuditMessage>;
9524
- }
9525
-
9526
9528
  export interface AuditTopicAddressableEntityRef {
9527
9529
  "id"?: string;
9528
9530
  "selfUri"?: string;
@@ -9566,12 +9568,6 @@ declare namespace Models {
9566
9568
  "newValues"?: Array<string>;
9567
9569
  }
9568
9570
 
9569
- export interface AuditUser {
9570
- "id": string;
9571
- "name"?: string;
9572
- "display"?: string;
9573
- }
9574
-
9575
9571
  export interface AuthenticationSettings {
9576
9572
  "enabled": boolean;
9577
9573
  "integrationId": string;
@@ -9648,6 +9644,14 @@ declare namespace Models {
9648
9644
  "selfUri"?: string;
9649
9645
  }
9650
9646
 
9647
+ export interface AutoAnswerSetting {
9648
+ "enabled": boolean;
9649
+ }
9650
+
9651
+ export interface AutoAnswerSettings {
9652
+ "settings": { [key: string]: Models.AutoAnswerSetting; };
9653
+ }
9654
+
9651
9655
  export interface AutoStart {
9652
9656
  "enabled"?: boolean;
9653
9657
  }
@@ -11703,6 +11707,14 @@ declare namespace Models {
11703
11707
  "linesReserved"?: number;
11704
11708
  }
11705
11709
 
11710
+ export interface CampaignPatchRequest {
11711
+ "outboundLineCount"?: number;
11712
+ "abandonRate"?: number;
11713
+ "maxCallsPerAgent"?: number;
11714
+ "dynamicLineBalancingSettings"?: Models.DynamicLineBalancingSettingsPatchRequest;
11715
+ "queue"?: Models.AddressableEntityRef;
11716
+ }
11717
+
11706
11718
  export interface CampaignProgress {
11707
11719
  "campaign": Models.DomainEntityRef;
11708
11720
  "contactList": Models.DomainEntityRef;
@@ -11769,6 +11781,11 @@ declare namespace Models {
11769
11781
  "value"?: string;
11770
11782
  "priority"?: string;
11771
11783
  "dialingMode"?: string;
11784
+ "abandonRate"?: number;
11785
+ "outboundLineCount"?: number;
11786
+ "relativeWeight"?: number;
11787
+ "maxCallsPerAgent"?: number;
11788
+ "queue"?: Models.DomainEntityRef;
11772
11789
  }
11773
11790
 
11774
11791
  export interface CampaignSchedule {
@@ -11937,6 +11954,22 @@ declare namespace Models {
11937
11954
  "selfUri"?: string;
11938
11955
  }
11939
11956
 
11957
+ export interface Celebration {
11958
+ "id"?: string;
11959
+ "recipient"?: Models.UserReference;
11960
+ "createdBy"?: Models.UserReference;
11961
+ "dateCreated"?: string;
11962
+ "type"?: string;
11963
+ "title"?: string;
11964
+ "note"?: string;
11965
+ "sourceEntity"?: Models.SourceEntity;
11966
+ "selfUri"?: string;
11967
+ }
11968
+
11969
+ export interface CelebrationStateParam {
11970
+ "state"?: string;
11971
+ }
11972
+
11940
11973
  export interface Certificate {
11941
11974
  "certificate": string;
11942
11975
  }
@@ -11964,13 +11997,6 @@ declare namespace Models {
11964
11997
  "valid"?: boolean;
11965
11998
  }
11966
11999
 
11967
- export interface Change {
11968
- "entity"?: Models.AuditEntity;
11969
- "property"?: string;
11970
- "oldValues"?: Array<string>;
11971
- "newValues"?: Array<string>;
11972
- }
11973
-
11974
12000
  export interface ChangeMyPasswordRequest {
11975
12001
  "newPassword": string;
11976
12002
  "oldPassword": string;
@@ -12911,6 +12937,7 @@ declare namespace Models {
12911
12937
  "criteria"?: Models.ContactBulkSearchCriteria;
12912
12938
  "contactIds"?: Array<string>;
12913
12939
  "contact"?: Models.DialerContact;
12940
+ "generateDownloadUri"?: boolean;
12914
12941
  }
12915
12942
 
12916
12943
  export interface ContactBulkSearchCriteria {
@@ -12921,6 +12948,7 @@ declare namespace Models {
12921
12948
  export interface ContactBulkSearchParameters {
12922
12949
  "contactListFilterId"?: string;
12923
12950
  "criteria"?: Models.ContactBulkSearchCriteria;
12951
+ "generateDownloadUri"?: boolean;
12924
12952
  }
12925
12953
 
12926
12954
  export interface ContactCallbackRequest {
@@ -13241,6 +13269,7 @@ declare namespace Models {
13241
13269
  "text"?: string;
13242
13270
  "sha256"?: string;
13243
13271
  "filename"?: string;
13272
+ "contentSizeBytes"?: number;
13244
13273
  }
13245
13274
 
13246
13275
  export interface ContentButtonResponse {
@@ -16328,6 +16357,15 @@ declare namespace Models {
16328
16357
  "selfUri"?: string;
16329
16358
  }
16330
16359
 
16360
+ export interface CreateRecognition {
16361
+ "recipientId": string;
16362
+ "type": string;
16363
+ "title"?: string;
16364
+ "note"?: string;
16365
+ "contextType"?: string;
16366
+ "contextId"?: string;
16367
+ }
16368
+
16331
16369
  export interface CreateResponseAssetRequest {
16332
16370
  "name": string;
16333
16371
  "divisionId"?: string;
@@ -17212,6 +17250,12 @@ declare namespace Models {
17212
17250
  "selfUri"?: string;
17213
17251
  }
17214
17252
 
17253
+ export interface DeleteProgramResponse {
17254
+ "id"?: string;
17255
+ "topicLinksJob"?: Models.AddressableEntityRef;
17256
+ "selfUri"?: string;
17257
+ }
17258
+
17215
17259
  export interface DeleteRetention {
17216
17260
  "days"?: number;
17217
17261
  }
@@ -17472,13 +17516,6 @@ declare namespace Models {
17472
17516
  "additionalProperties"?: { [key: string]: object; };
17473
17517
  }
17474
17518
 
17475
- export interface DialerAuditRequest {
17476
- "queryPhrase"?: string;
17477
- "queryFields"?: Array<string>;
17478
- "facets"?: Array<Models.AuditFacet>;
17479
- "filters"?: Array<Models.AuditFilter>;
17480
- }
17481
-
17482
17519
  export interface DialerCallabletimesetConfigChangeCallableTime {
17483
17520
  "timeSlots"?: Array<Models.DialerCallabletimesetConfigChangeTimeSlot>;
17484
17521
  "timeZoneId"?: string;
@@ -19375,6 +19412,11 @@ declare namespace Models {
19375
19412
  "relativeWeight"?: number;
19376
19413
  }
19377
19414
 
19415
+ export interface DynamicLineBalancingSettingsPatchRequest {
19416
+ "enabled"?: boolean;
19417
+ "relativeWeight"?: number;
19418
+ }
19419
+
19378
19420
  export interface Edge {
19379
19421
  "id"?: string;
19380
19422
  "name": string;
@@ -20341,11 +20383,6 @@ declare namespace Models {
20341
20383
  "entityType": string;
20342
20384
  }
20343
20385
 
20344
- export interface Entry {
20345
- "value"?: string;
20346
- "count"?: number;
20347
- }
20348
-
20349
20386
  export interface ErrorBody {
20350
20387
  "message"?: string;
20351
20388
  "code"?: string;
@@ -21675,11 +21712,6 @@ declare namespace Models {
21675
21712
  "terms"?: Array<Models.FacetTerm>;
21676
21713
  }
21677
21714
 
21678
- export interface FacetInfo {
21679
- "name"?: string;
21680
- "entries"?: Array<Models.Entry>;
21681
- }
21682
-
21683
21715
  export interface FacetKeyAttribute {
21684
21716
  "id"?: string;
21685
21717
  "name"?: string;
@@ -21725,6 +21757,15 @@ declare namespace Models {
21725
21757
  "pageCount"?: number;
21726
21758
  }
21727
21759
 
21760
+ export interface Faq {
21761
+ "question"?: string;
21762
+ "answer"?: string;
21763
+ "sourceUri"?: string;
21764
+ "documentUrl"?: string;
21765
+ "documentDisplayName"?: string;
21766
+ "confidence"?: number;
21767
+ }
21768
+
21728
21769
  export interface FaxConfig {
21729
21770
  "sendEmailNotifications": boolean;
21730
21771
  "disableEmailPii": boolean;
@@ -21841,6 +21882,12 @@ declare namespace Models {
21841
21882
  "enabled"?: boolean;
21842
21883
  }
21843
21884
 
21885
+ export interface Feedback {
21886
+ "suggestionId": string;
21887
+ "userProvided"?: boolean;
21888
+ "relevance": string;
21889
+ }
21890
+
21844
21891
  export interface FeedbackAddRequest {
21845
21892
  "summary": string;
21846
21893
  "rating"?: string;
@@ -23169,6 +23216,19 @@ declare namespace Models {
23169
23216
  "sortOrder"?: string;
23170
23217
  }
23171
23218
 
23219
+ export interface GetCelebrationListing {
23220
+ "entities"?: Array<Models.Celebration>;
23221
+ "pageSize"?: number;
23222
+ "pageNumber"?: number;
23223
+ "total"?: number;
23224
+ "lastUri"?: string;
23225
+ "firstUri"?: string;
23226
+ "selfUri"?: string;
23227
+ "nextUri"?: string;
23228
+ "previousUri"?: string;
23229
+ "pageCount"?: number;
23230
+ }
23231
+
23172
23232
  export interface GetFlowExecutionDataJobResult {
23173
23233
  "id"?: string;
23174
23234
  "name"?: string;
@@ -26306,6 +26366,7 @@ declare namespace Models {
26306
26366
  "labels"?: Array<Models.LabelResponse>;
26307
26367
  "knowledgeBase"?: Models.KnowledgeBaseReference;
26308
26368
  "externalId"?: string;
26369
+ "externalUrl"?: string;
26309
26370
  "source"?: Models.AddressableEntityRef;
26310
26371
  "readonly"?: boolean;
26311
26372
  "variations"?: Array<Models.DocumentVariation>;
@@ -26818,6 +26879,7 @@ declare namespace Models {
26818
26879
  "labels"?: Array<Models.LabelResponse>;
26819
26880
  "knowledgeBase"?: Models.KnowledgeBaseReference;
26820
26881
  "externalId"?: string;
26882
+ "externalUrl"?: string;
26821
26883
  "source"?: Models.AddressableEntityRef;
26822
26884
  "readonly"?: boolean;
26823
26885
  "variations"?: Array<Models.DocumentVariationAnswer>;
@@ -29095,6 +29157,10 @@ declare namespace Models {
29095
29157
  "selfUri"?: string;
29096
29158
  }
29097
29159
 
29160
+ export interface MetadataAttribute {
29161
+ "value"?: string;
29162
+ }
29163
+
29098
29164
  export interface MetadataDocumentation {
29099
29165
  "description"?: string;
29100
29166
  "location"?: string;
@@ -32162,6 +32228,7 @@ declare namespace Models {
32162
32228
  "dateModified"?: string;
32163
32229
  "publishedBy"?: Models.AddressableEntityRef;
32164
32230
  "datePublished"?: string;
32231
+ "topicLinksJob"?: Models.AddressableEntityRef;
32165
32232
  "selfUri"?: string;
32166
32233
  }
32167
32234
 
@@ -35386,6 +35453,34 @@ declare namespace Models {
35386
35453
  "flow"?: Models.RecipientFlow;
35387
35454
  }
35388
35455
 
35456
+ export interface Recognition {
35457
+ "id"?: string;
35458
+ "recipient"?: Models.UserReference;
35459
+ "createdBy"?: Models.UserReference;
35460
+ "dateCreated"?: string;
35461
+ "type"?: string;
35462
+ "title"?: string;
35463
+ "note"?: string;
35464
+ "contextType"?: string;
35465
+ "contextId"?: string;
35466
+ "dateDisplayed"?: string;
35467
+ "dateAcknowledged"?: string;
35468
+ "selfUri"?: string;
35469
+ }
35470
+
35471
+ export interface RecognitionBase {
35472
+ "id"?: string;
35473
+ "recipient"?: Models.UserReference;
35474
+ "createdBy"?: Models.UserReference;
35475
+ "dateCreated"?: string;
35476
+ "type"?: string;
35477
+ "title"?: string;
35478
+ "note"?: string;
35479
+ "contextType"?: string;
35480
+ "contextId"?: string;
35481
+ "selfUri"?: string;
35482
+ }
35483
+
35389
35484
  export interface Record {
35390
35485
  "name": string;
35391
35486
  "type": string;
@@ -37456,10 +37551,6 @@ declare namespace Models {
37456
37551
  "currentDate"?: string;
37457
37552
  }
37458
37553
 
37459
- export interface ServiceContext {
37460
- "name"?: string;
37461
- }
37462
-
37463
37554
  export interface ServiceGoalTemplate {
37464
37555
  "id"?: string;
37465
37556
  "name"?: string;
@@ -38188,6 +38279,12 @@ declare namespace Models {
38188
38279
  "tagId"?: string;
38189
38280
  }
38190
38281
 
38282
+ export interface SourceEntity {
38283
+ "id"?: string;
38284
+ "type"?: string;
38285
+ "selfUri"?: string;
38286
+ }
38287
+
38191
38288
  export interface SourceEntityListing {
38192
38289
  "total"?: number;
38193
38290
  "entities"?: Array<Models.Source>;
@@ -38530,6 +38627,88 @@ declare namespace Models {
38530
38627
  "query": Array<Models.SuggestSearchCriteria>;
38531
38628
  }
38532
38629
 
38630
+ export interface Suggestion {
38631
+ "id"?: string;
38632
+ "type"?: string;
38633
+ "faq"?: Models.Faq;
38634
+ "article"?: Models.Article;
38635
+ "dateCreated"?: string;
38636
+ "answerRecordId"?: string;
38637
+ "triggerType"?: string;
38638
+ "context"?: Models.SuggestionContext;
38639
+ "state"?: string;
38640
+ "knowledgeSearch"?: Models.SuggestionKnowledgeSearch;
38641
+ "knowledgeArticle"?: Models.SuggestionKnowledgeArticle;
38642
+ "cannedResponse"?: Models.SuggestionCannedResponse;
38643
+ "script"?: Models.SuggestionScript;
38644
+ "selfUri"?: string;
38645
+ "conversation"?: Models.AddressableEntityRef;
38646
+ "assistant"?: Models.AddressableEntityRef;
38647
+ }
38648
+
38649
+ export interface SuggestionCannedResponse {
38650
+ "response"?: Models.AddressableEntityRef;
38651
+ "library"?: Models.AddressableEntityRef;
38652
+ }
38653
+
38654
+ export interface SuggestionContext {
38655
+ "queue"?: Models.AddressableEntityRef;
38656
+ "mediaType"?: string;
38657
+ "user"?: Models.UserReference;
38658
+ "externalContact"?: Models.AddressableEntityRef;
38659
+ "utterance"?: Models.Entity;
38660
+ "message"?: Models.AddressableEntityRef;
38661
+ "queryStatement"?: string;
38662
+ }
38663
+
38664
+ export interface SuggestionEngagement {
38665
+ "engagementType": string;
38666
+ "feedback"?: Models.SuggestionFeedback;
38667
+ }
38668
+
38669
+ export interface SuggestionFeedback {
38670
+ "rating": string;
38671
+ }
38672
+
38673
+ export interface SuggestionKnowledgeAnswer {
38674
+ "answer"?: string;
38675
+ "startIndex"?: number;
38676
+ "endIndex"?: number;
38677
+ }
38678
+
38679
+ export interface SuggestionKnowledgeArticle {
38680
+ "title"?: string;
38681
+ "snippets"?: Array<string>;
38682
+ "document"?: Models.AddressableEntityRef;
38683
+ "version"?: Models.AddressableEntityRef;
38684
+ "knowledgeAnswer"?: Models.SuggestionKnowledgeAnswer;
38685
+ "variations"?: Array<Models.AddressableEntityRef>;
38686
+ }
38687
+
38688
+ export interface SuggestionKnowledgeSearch {
38689
+ "title"?: string;
38690
+ "snippets"?: Array<string>;
38691
+ "confidence"?: number;
38692
+ "searchId"?: string;
38693
+ "document"?: Models.AddressableEntityRef;
38694
+ "version"?: Models.AddressableEntityRef;
38695
+ "knowledgeAnswer"?: Models.SuggestionKnowledgeAnswer;
38696
+ "variations"?: Array<Models.AddressableEntityRef>;
38697
+ }
38698
+
38699
+ export interface SuggestionListing {
38700
+ "entities"?: Array<Models.Suggestion>;
38701
+ "nextUri"?: string;
38702
+ "selfUri"?: string;
38703
+ "previousUri"?: string;
38704
+ }
38705
+
38706
+ export interface SuggestionScript {
38707
+ "script"?: Models.AddressableEntityRef;
38708
+ "page"?: Models.AddressableEntityRef;
38709
+ "data"?: { [key: string]: string; };
38710
+ }
38711
+
38533
38712
  export interface SupportCenterCategory {
38534
38713
  "id"?: string;
38535
38714
  "selfUri"?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "196.0.0",
3
+ "version": "197.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 196.0.0
7
+ * @version 197.0.0
8
8
  */
9
9
  class ApiClient {
10
10
  /**