purecloud-platform-client-v2 152.0.0 → 153.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 +444 -73
  3. package/dist/web-amd/purecloud-platform-client-v2.js +444 -73
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +444 -73
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +444 -73
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +212 -3
  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 +3 -3
  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 +46 -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 +3 -3
  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 +1 -1
  37. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  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 +1 -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 +4 -2
  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 +1 -1
  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 +1 -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 +325 -1
  77. package/src/purecloud-platform-client-v2/index.js +1 -1
package/index.d.ts CHANGED
@@ -642,11 +642,13 @@ declare class AuthorizationApi {
642
642
  getAuthorizationRoleSubjectgrants(roleId: string, opts?: AuthorizationApi.getAuthorizationRoleSubjectgrantsOptions): Promise<Models.SubjectDivisionGrantsEntityListing>;
643
643
  getAuthorizationRoleUsers(roleId: string, opts?: AuthorizationApi.getAuthorizationRoleUsersOptions): Promise<Models.UserEntityListing>;
644
644
  getAuthorizationRoles(opts?: AuthorizationApi.getAuthorizationRolesOptions): Promise<Models.OrganizationRoleEntityListing>;
645
+ getAuthorizationSettings(): Promise<Models.AuthorizationSettings>;
645
646
  getAuthorizationSubject(subjectId: string): Promise<Models.AuthzSubject>;
646
647
  getAuthorizationSubjectsMe(): Promise<Models.AuthzSubject>;
647
648
  getAuthorizationSubjectsRolecounts(opts?: AuthorizationApi.getAuthorizationSubjectsRolecountsOptions): Promise<{ [key: string]: object; }>;
648
649
  getUserRoles(subjectId: string): Promise<Models.UserAuthorization>;
649
650
  patchAuthorizationRole(roleId: string, body: Models.DomainOrganizationRole): Promise<Models.DomainOrganizationRole>;
651
+ patchAuthorizationSettings(body: Models.AuthorizationSettings): Promise<Models.AuthorizationSettings>;
650
652
  postAuthorizationDivisionObject(divisionId: string, objectType: string, body: Array<string>): Promise<void>;
651
653
  postAuthorizationDivisionRestore(divisionId: string, body: Models.AuthzDivision): Promise<Models.AuthzDivision>;
652
654
  postAuthorizationDivisions(body: Models.AuthzDivision): Promise<Models.AuthzDivision>;
@@ -3847,6 +3849,8 @@ declare namespace RoutingApi {
3847
3849
  "pattern"?: string;
3848
3850
  }
3849
3851
  export interface getRoutingEmailDomainsOptions {
3852
+ "pageSize"?: number;
3853
+ "pageNumber"?: number;
3850
3854
  "excludeStatus"?: boolean;
3851
3855
  }
3852
3856
  export interface getRoutingLanguagesOptions {
@@ -5264,8 +5268,11 @@ declare class WorkforceManagementApi {
5264
5268
  deleteWorkforcemanagementManagementunitWorkplan(managementUnitId: string, workPlanId: string): Promise<void>;
5265
5269
  deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId: string, workPlanRotationId: string): Promise<void>;
5266
5270
  getWorkforcemanagementAdherence(userId: Array<string>): Promise<Array<Models.UserScheduleAdherence>>;
5271
+ getWorkforcemanagementAdherenceExplanation(explanationId: string): Promise<Models.AdherenceExplanationResponse>;
5272
+ getWorkforcemanagementAdherenceExplanationsJob(jobId: string): Promise<Models.AdherenceExplanationJob>;
5267
5273
  getWorkforcemanagementAdherenceHistoricalJob(jobId: string): Promise<Models.WfmHistoricalAdherenceResponse>;
5268
5274
  getWorkforcemanagementAdhocmodelingjob(jobId: string): Promise<Models.ModelingStatusResponse>;
5275
+ getWorkforcemanagementAgentAdherenceExplanation(agentId: string, explanationId: string): Promise<Models.AdherenceExplanationResponse>;
5269
5276
  getWorkforcemanagementAgentManagementunit(agentId: string): Promise<Models.AgentManagementUnitReference>;
5270
5277
  getWorkforcemanagementAgentsMeManagementunit(): Promise<Models.AgentManagementUnitReference>;
5271
5278
  getWorkforcemanagementBusinessunit(businessUnitId: string, opts?: WorkforceManagementApi.getWorkforcemanagementBusinessunitOptions): Promise<Models.BusinessUnitResponse>;
@@ -5324,9 +5331,11 @@ declare class WorkforceManagementApi {
5324
5331
  getWorkforcemanagementNotifications(): Promise<Models.NotificationsResponse>;
5325
5332
  getWorkforcemanagementSchedulingjob(jobId: string): Promise<Models.SchedulingStatusResponse>;
5326
5333
  getWorkforcemanagementShifttrades(): Promise<Models.ShiftTradeListResponse>;
5334
+ getWorkforcemanagementShrinkageJob(jobId: string): Promise<Models.WfmHistoricalShrinkageResponse>;
5327
5335
  getWorkforcemanagementTimeoffrequest(timeOffRequestId: string): Promise<Models.TimeOffRequestResponse>;
5328
5336
  getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId: string): Promise<Models.WaitlistPositionListing>;
5329
5337
  getWorkforcemanagementTimeoffrequests(opts?: WorkforceManagementApi.getWorkforcemanagementTimeoffrequestsOptions): Promise<Models.TimeOffRequestList>;
5338
+ patchWorkforcemanagementAgentAdherenceExplanation(agentId: string, explanationId: string, body: Models.UpdateAdherenceExplanationStatusRequest): Promise<Models.AdherenceExplanationAsyncResponse>;
5330
5339
  patchWorkforcemanagementBusinessunit(businessUnitId: string, opts?: WorkforceManagementApi.patchWorkforcemanagementBusinessunitOptions): Promise<Models.BusinessUnitResponse>;
5331
5340
  patchWorkforcemanagementBusinessunitActivitycode(businessUnitId: string, activityCodeId: string, opts?: WorkforceManagementApi.patchWorkforcemanagementBusinessunitActivitycodeOptions): Promise<Models.BusinessUnitActivityCode>;
5332
5341
  patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId: string, planningGroupId: string, opts?: WorkforceManagementApi.patchWorkforcemanagementBusinessunitPlanninggroupOptions): Promise<Models.PlanningGroup>;
@@ -5340,9 +5349,14 @@ declare class WorkforceManagementApi {
5340
5349
  patchWorkforcemanagementManagementunitWorkplan(managementUnitId: string, workPlanId: string, opts?: WorkforceManagementApi.patchWorkforcemanagementManagementunitWorkplanOptions): Promise<Models.WorkPlan>;
5341
5350
  patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId: string, workPlanRotationId: string, opts?: WorkforceManagementApi.patchWorkforcemanagementManagementunitWorkplanrotationOptions): Promise<Models.WorkPlanRotationResponse>;
5342
5351
  patchWorkforcemanagementTimeoffrequest(timeOffRequestId: string, opts?: WorkforceManagementApi.patchWorkforcemanagementTimeoffrequestOptions): Promise<Models.TimeOffRequestResponse>;
5352
+ postWorkforcemanagementAdherenceExplanations(body: Models.AddAdherenceExplanationAgentRequest): Promise<Models.AdherenceExplanationAsyncResponse>;
5353
+ postWorkforcemanagementAdherenceExplanationsQuery(body: Models.AgentQueryAdherenceExplanationsRequest, opts?: WorkforceManagementApi.postWorkforcemanagementAdherenceExplanationsQueryOptions): Promise<Models.QueryAdherenceExplanationsResponse>;
5343
5354
  postWorkforcemanagementAdherenceHistorical(opts?: WorkforceManagementApi.postWorkforcemanagementAdherenceHistoricalOptions): Promise<Models.WfmHistoricalAdherenceResponse>;
5355
+ postWorkforcemanagementAgentAdherenceExplanations(agentId: string, body: Models.AddAdherenceExplanationAdminRequest): Promise<Models.AdherenceExplanationAsyncResponse>;
5356
+ postWorkforcemanagementAgentAdherenceExplanationsQuery(agentId: string, body: Models.AgentQueryAdherenceExplanationsRequest, opts?: WorkforceManagementApi.postWorkforcemanagementAgentAdherenceExplanationsQueryOptions): Promise<Models.AgentQueryAdherenceExplanationsResponse>;
5344
5357
  postWorkforcemanagementAgentschedulesMine(opts?: WorkforceManagementApi.postWorkforcemanagementAgentschedulesMineOptions): Promise<Models.BuCurrentAgentScheduleSearchResponse>;
5345
5358
  postWorkforcemanagementBusinessunitActivitycodes(businessUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementBusinessunitActivitycodesOptions): Promise<Models.BusinessUnitActivityCode>;
5359
+ postWorkforcemanagementBusinessunitAdherenceExplanationsQuery(businessUnitId: string, body: Models.BuQueryAdherenceExplanationsRequest, opts?: WorkforceManagementApi.postWorkforcemanagementBusinessunitAdherenceExplanationsQueryOptions): Promise<Models.BuQueryAdherenceExplanationsResponse>;
5346
5360
  postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementBusinessunitAgentschedulesSearchOptions): Promise<Models.BuAsyncAgentSchedulesSearchResponse>;
5347
5361
  postWorkforcemanagementBusinessunitIntraday(businessUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementBusinessunitIntradayOptions): Promise<Models.AsyncIntradayResponse>;
5348
5362
  postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementBusinessunitPlanninggroupsOptions): Promise<Models.PlanningGroup>;
@@ -5368,6 +5382,7 @@ declare class WorkforceManagementApi {
5368
5382
  postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementManagementunitHistoricaladherencequeryOptions): Promise<Models.WfmHistoricalAdherenceResponse>;
5369
5383
  postWorkforcemanagementManagementunitMove(managementUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementManagementunitMoveOptions): Promise<Models.MoveManagementUnitResponse>;
5370
5384
  postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementManagementunitSchedulesSearchOptions): Promise<Models.UserScheduleContainer>;
5385
+ postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementManagementunitShrinkageJobsOptions): Promise<Models.WfmHistoricalShrinkageResponse>;
5371
5386
  postWorkforcemanagementManagementunitTimeofflimits(managementUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementManagementunitTimeofflimitsOptions): Promise<Models.TimeOffLimit>;
5372
5387
  postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementManagementunitTimeofflimitsValuesQueryOptions): Promise<Models.QueryTimeOffLimitValuesResponse>;
5373
5388
  postWorkforcemanagementManagementunitTimeoffplans(managementUnitId: string, opts?: WorkforceManagementApi.postWorkforcemanagementManagementunitTimeoffplansOptions): Promise<Models.TimeOffPlan>;
@@ -5511,15 +5526,27 @@ declare namespace WorkforceManagementApi {
5511
5526
  export interface patchWorkforcemanagementTimeoffrequestOptions {
5512
5527
  "body"?: Models.AgentTimeOffRequestPatch;
5513
5528
  }
5529
+ export interface postWorkforcemanagementAdherenceExplanationsQueryOptions {
5530
+ "forceAsync"?: boolean;
5531
+ "forceDownloadService"?: boolean;
5532
+ }
5514
5533
  export interface postWorkforcemanagementAdherenceHistoricalOptions {
5515
5534
  "body"?: Models.WfmHistoricalAdherenceQueryForUsers;
5516
5535
  }
5536
+ export interface postWorkforcemanagementAgentAdherenceExplanationsQueryOptions {
5537
+ "forceAsync"?: boolean;
5538
+ "forceDownloadService"?: boolean;
5539
+ }
5517
5540
  export interface postWorkforcemanagementAgentschedulesMineOptions {
5518
5541
  "body"?: Models.BuGetCurrentAgentScheduleRequest;
5519
5542
  }
5520
5543
  export interface postWorkforcemanagementBusinessunitActivitycodesOptions {
5521
5544
  "body"?: Models.CreateActivityCodeRequest;
5522
5545
  }
5546
+ export interface postWorkforcemanagementBusinessunitAdherenceExplanationsQueryOptions {
5547
+ "forceAsync"?: boolean;
5548
+ "forceDownloadService"?: boolean;
5549
+ }
5523
5550
  export interface postWorkforcemanagementBusinessunitAgentschedulesSearchOptions {
5524
5551
  "forceAsync"?: boolean;
5525
5552
  "forceDownloadService"?: boolean;
@@ -5568,6 +5595,9 @@ declare namespace WorkforceManagementApi {
5568
5595
  export interface postWorkforcemanagementManagementunitSchedulesSearchOptions {
5569
5596
  "body"?: Models.UserListScheduleRequestBody;
5570
5597
  }
5598
+ export interface postWorkforcemanagementManagementunitShrinkageJobsOptions {
5599
+ "body"?: Models.WfmHistoricalShrinkageRequest;
5600
+ }
5571
5601
  export interface postWorkforcemanagementManagementunitTimeofflimitsOptions {
5572
5602
  "body"?: Models.CreateTimeOffLimitRequest;
5573
5603
  }
@@ -6016,6 +6046,21 @@ declare namespace Models {
6016
6046
  "timeoutMs"?: number;
6017
6047
  }
6018
6048
 
6049
+ export interface AddAdherenceExplanationAdminRequest {
6050
+ "type": string;
6051
+ "startDate": string;
6052
+ "lengthMinutes": number;
6053
+ "notes"?: string;
6054
+ "status"?: string;
6055
+ }
6056
+
6057
+ export interface AddAdherenceExplanationAgentRequest {
6058
+ "type": string;
6059
+ "startDate": string;
6060
+ "lengthMinutes": number;
6061
+ "notes"?: string;
6062
+ }
6063
+
6019
6064
  export interface AddConversationRequest {
6020
6065
  "conversationId": string;
6021
6066
  }
@@ -6071,6 +6116,41 @@ declare namespace Models {
6071
6116
  "selfUri"?: string;
6072
6117
  }
6073
6118
 
6119
+ export interface AdherenceExplanationAsyncResponse {
6120
+ "job"?: Models.AdherenceExplanationJobReference;
6121
+ }
6122
+
6123
+ export interface AdherenceExplanationJob {
6124
+ "id"?: string;
6125
+ "type"?: string;
6126
+ "status"?: string;
6127
+ "adherenceExplanation"?: Models.AdherenceExplanationResponse;
6128
+ "downloadUrl"?: string;
6129
+ "error"?: Models.ErrorBody;
6130
+ "agentQueryResponseTemplate"?: Models.AdherenceExplanationListingAgentQueryResponse;
6131
+ "buQueryResponseTemplate"?: Models.AdherenceExplanationListingBuQueryResponse;
6132
+ "selfUri"?: string;
6133
+ }
6134
+
6135
+ export interface AdherenceExplanationJobReference {
6136
+ "id"?: string;
6137
+ "type"?: string;
6138
+ "status"?: string;
6139
+ "selfUri"?: string;
6140
+ }
6141
+
6142
+ export interface AdherenceExplanationListing {
6143
+ "entities"?: Array<Models.AdherenceExplanationResponse>;
6144
+ }
6145
+
6146
+ export interface AdherenceExplanationListingAgentQueryResponse {
6147
+ "entities"?: Array<Models.AdherenceExplanationResponse>;
6148
+ }
6149
+
6150
+ export interface AdherenceExplanationListingBuQueryResponse {
6151
+ "entities"?: Array<Models.AdherenceExplanationResponse>;
6152
+ }
6153
+
6074
6154
  export interface AdherenceExplanationNotification {
6075
6155
  "id"?: string;
6076
6156
  "agent"?: Models.UserReference;
@@ -6084,6 +6164,21 @@ declare namespace Models {
6084
6164
  "selfUri"?: string;
6085
6165
  }
6086
6166
 
6167
+ export interface AdherenceExplanationResponse {
6168
+ "id"?: string;
6169
+ "agent": Models.UserReference;
6170
+ "managementUnit": Models.ManagementUnitReference;
6171
+ "businessUnit": Models.BusinessUnitReference;
6172
+ "type": string;
6173
+ "status": string;
6174
+ "startDate": string;
6175
+ "lengthMinutes": number;
6176
+ "notes"?: string;
6177
+ "reviewedBy"?: Models.UserReference;
6178
+ "reviewedDate"?: string;
6179
+ "selfUri"?: string;
6180
+ }
6181
+
6087
6182
  export interface AdherenceSettings {
6088
6183
  "severeAlertThresholdMinutes"?: number;
6089
6184
  "adherenceTargetPercent"?: number;
@@ -6259,6 +6354,17 @@ declare namespace Models {
6259
6354
  "maxOwnedCallbackDelayHours"?: number;
6260
6355
  }
6261
6356
 
6357
+ export interface AgentQueryAdherenceExplanationsRequest {
6358
+ "startDate": string;
6359
+ "endDate": string;
6360
+ }
6361
+
6362
+ export interface AgentQueryAdherenceExplanationsResponse {
6363
+ "job"?: Models.AdherenceExplanationJobReference;
6364
+ "result"?: Models.AdherenceExplanationListingAgentQueryResponse;
6365
+ "downloadUrl"?: string;
6366
+ }
6367
+
6262
6368
  export interface AgentTimeOffRequestPatch {
6263
6369
  "markedAsRead"?: boolean;
6264
6370
  "status"?: string;
@@ -7475,6 +7581,13 @@ declare namespace Models {
7475
7581
  "integrationId": string;
7476
7582
  }
7477
7583
 
7584
+ export interface AuthorizationSettings {
7585
+ "id"?: string;
7586
+ "analysisEnabled"?: boolean;
7587
+ "analysisDays"?: number;
7588
+ "selfUri"?: string;
7589
+ }
7590
+
7478
7591
  export interface AuthzDivision {
7479
7592
  "id"?: string;
7480
7593
  "name"?: string;
@@ -8177,6 +8290,19 @@ declare namespace Models {
8177
8290
  "requiredWithoutShrinkagePerInterval"?: Array<number>;
8178
8291
  }
8179
8292
 
8293
+ export interface BuQueryAdherenceExplanationsRequest {
8294
+ "startDate": string;
8295
+ "endDate": string;
8296
+ "managementUnitIds"?: Array<string>;
8297
+ "agentIds"?: Array<string>;
8298
+ }
8299
+
8300
+ export interface BuQueryAdherenceExplanationsResponse {
8301
+ "job"?: Models.AdherenceExplanationJobReference;
8302
+ "result"?: Models.AdherenceExplanationListingBuQueryResponse;
8303
+ "downloadUrl"?: string;
8304
+ }
8305
+
8180
8306
  export interface BuQueryAgentSchedulesRequest {
8181
8307
  "managementUnitId": string;
8182
8308
  "userIds"?: Array<string>;
@@ -13737,6 +13863,19 @@ declare namespace Models {
13737
13863
  "outputFieldMissingResolution": boolean;
13738
13864
  }
13739
13865
 
13866
+ export interface DataActionConditionSettings {
13867
+ "dataActionId": string;
13868
+ "contactIdField": string;
13869
+ "dataNotFoundResolution": boolean;
13870
+ "predicates"?: Array<Models.DigitalDataActionConditionPredicate>;
13871
+ "contactColumnToDataActionFieldMappings"?: Array<Models.DataActionContactColumnFieldMapping>;
13872
+ }
13873
+
13874
+ export interface DataActionContactColumnFieldMapping {
13875
+ "contactColumnName": string;
13876
+ "dataActionField": string;
13877
+ }
13878
+
13740
13879
  export interface DataAvailabilityResponse {
13741
13880
  "dataAvailabilityDate"?: string;
13742
13881
  }
@@ -14658,6 +14797,15 @@ declare namespace Models {
14658
14797
  "lastResultOverallConditionSettings"?: Models.LastResultOverallConditionSettings;
14659
14798
  }
14660
14799
 
14800
+ export interface DigitalDataActionConditionPredicate {
14801
+ "outputField": string;
14802
+ "outputOperator": string;
14803
+ "comparisonValue": string;
14804
+ "inverted": boolean;
14805
+ "outputFieldMissingResolution": boolean;
14806
+ "valueType": string;
14807
+ }
14808
+
14661
14809
  export interface DigitalRule {
14662
14810
  "id"?: string;
14663
14811
  "name": string;
@@ -18545,6 +18693,7 @@ declare namespace Models {
18545
18693
 
18546
18694
  export interface HistoricalAdherenceQueryResult {
18547
18695
  "userId"?: string;
18696
+ "managementUnitId"?: string;
18548
18697
  "startDate"?: string;
18549
18698
  "endDate"?: string;
18550
18699
  "adherencePercentage"?: number;
@@ -18579,6 +18728,41 @@ declare namespace Models {
18579
18728
  "entities"?: Array<Models.HistoricalImportStatus>;
18580
18729
  }
18581
18730
 
18731
+ export interface HistoricalShrinkageActivityCategoryResponse {
18732
+ "activityCategory"?: string;
18733
+ "shrinkageForActivityCategory"?: Models.HistoricalShrinkageAggregateResponse;
18734
+ "shrinkageForActivityCodes"?: Array<Models.HistoricalShrinkageActivityCodeResponse>;
18735
+ }
18736
+
18737
+ export interface HistoricalShrinkageActivityCodeResponse {
18738
+ "activityCodeId"?: string;
18739
+ "shrinkageForActivityCode"?: Models.HistoricalShrinkageAggregateResponse;
18740
+ }
18741
+
18742
+ export interface HistoricalShrinkageAggregateResponse {
18743
+ "scheduledShrinkageSeconds"?: number;
18744
+ "scheduledShrinkagePercent"?: number;
18745
+ "actualShrinkageSeconds"?: number;
18746
+ "actualShrinkagePercent"?: number;
18747
+ "paidShrinkageSeconds"?: number;
18748
+ "unpaidShrinkageSeconds"?: number;
18749
+ "plannedShrinkageSeconds"?: number;
18750
+ "unplannedShrinkageSeconds"?: number;
18751
+ }
18752
+
18753
+ export interface HistoricalShrinkageResult {
18754
+ "startDate"?: string;
18755
+ "endDate"?: string;
18756
+ "totalScheduledDurationSeconds"?: number;
18757
+ "totalLoggedInDurationSeconds"?: number;
18758
+ "aggregatedShrinkage"?: Models.HistoricalShrinkageAggregateResponse;
18759
+ "shrinkageForActivityCategories"?: Array<Models.HistoricalShrinkageActivityCategoryResponse>;
18760
+ }
18761
+
18762
+ export interface HistoricalShrinkageResultListing {
18763
+ "entities"?: Array<Models.HistoricalShrinkageResult>;
18764
+ }
18765
+
18582
18766
  export interface HistoryEntry {
18583
18767
  "action"?: string;
18584
18768
  "resource"?: string;
@@ -24745,6 +24929,12 @@ declare namespace Models {
24745
24929
  "value": string;
24746
24930
  }
24747
24931
 
24932
+ export interface QueryAdherenceExplanationsResponse {
24933
+ "job"?: Models.AdherenceExplanationJobReference;
24934
+ "result"?: Models.AdherenceExplanationListing;
24935
+ "downloadUrl"?: string;
24936
+ }
24937
+
24748
24938
  export interface QueryDivision {
24749
24939
  }
24750
24940
 
@@ -30279,7 +30469,7 @@ declare namespace Models {
30279
30469
  "language": string;
30280
30470
  "header"?: string;
30281
30471
  "footer"?: string;
30282
- "questionGroups": Array<Models.SurveyQuestionGroup>;
30472
+ "questionGroups"?: Array<Models.SurveyQuestionGroup>;
30283
30473
  "publishedVersions"?: Models.DomainEntityListingSurveyForm;
30284
30474
  "selfUri"?: string;
30285
30475
  }
@@ -31912,6 +32102,10 @@ declare namespace Models {
31912
32102
  "metadata": Models.WfmVersionedEntityMetadata;
31913
32103
  }
31914
32104
 
32105
+ export interface UpdateAdherenceExplanationStatusRequest {
32106
+ "status"?: string;
32107
+ }
32108
+
31915
32109
  export interface UpdateAnalyticsDataRetentionRequest {
31916
32110
  "retentionDays": number;
31917
32111
  }
@@ -32800,6 +32994,7 @@ declare namespace Models {
32800
32994
  "isOutOfOffice"?: boolean;
32801
32995
  "adherenceState"?: string;
32802
32996
  "impact"?: string;
32997
+ "adherenceExplanation"?: Models.RealTimeAdherenceExplanation;
32803
32998
  "timeOfAdherenceChange"?: string;
32804
32999
  "presenceUpdateTime"?: string;
32805
33000
  "activeQueues"?: Array<Models.QueueReference>;
@@ -34747,7 +34942,7 @@ declare namespace Models {
34747
34942
  export interface WfmHistoricalAdherenceQuery {
34748
34943
  "startDate": string;
34749
34944
  "endDate"?: string;
34750
- "timeZone"?: string;
34945
+ "timeZone": string;
34751
34946
  "userIds"?: Array<string>;
34752
34947
  "includeExceptions"?: boolean;
34753
34948
  "teamIds"?: Array<string>;
@@ -34756,7 +34951,7 @@ declare namespace Models {
34756
34951
  export interface WfmHistoricalAdherenceQueryForUsers {
34757
34952
  "startDate": string;
34758
34953
  "endDate"?: string;
34759
- "timeZone"?: string;
34954
+ "timeZone": string;
34760
34955
  "userIds": Array<string>;
34761
34956
  "includeExceptions"?: boolean;
34762
34957
  }
@@ -34791,6 +34986,20 @@ declare namespace Models {
34791
34986
  "type"?: string;
34792
34987
  }
34793
34988
 
34989
+ export interface WfmHistoricalShrinkageRequest {
34990
+ "startDate": string;
34991
+ "endDate"?: string;
34992
+ "timeZone"?: string;
34993
+ "granularity"?: string;
34994
+ }
34995
+
34996
+ export interface WfmHistoricalShrinkageResponse {
34997
+ "operationId"?: string;
34998
+ "downloadUrls"?: Array<string>;
34999
+ "downloadResult"?: Models.HistoricalShrinkageResultListing;
35000
+ "state"?: string;
35001
+ }
35002
+
34794
35003
  export interface WfmIntradayDataUpdateTopicIntradayDataGroup {
34795
35004
  "mediaType"?: string;
34796
35005
  "forecastDataPerInterval"?: Array<Models.WfmIntradayDataUpdateTopicIntradayForecastData>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "purecloud-platform-client-v2",
3
- "version": "152.0.0",
3
+ "version": "153.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 152.0.0
7
+ * @version 153.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 152.0.0
8
+ * @version 153.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 152.0.0
8
+ * @version 153.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -21,7 +21,7 @@ class AnalyticsApi {
21
21
 
22
22
 
23
23
  /**
24
- * Delete/cancel an async request
24
+ * Delete/cancel an async details job
25
25
  *
26
26
  * @param {String} jobId jobId
27
27
  */
@@ -203,7 +203,7 @@ class AnalyticsApi {
203
203
  }
204
204
 
205
205
  /**
206
- * Fetch a page of results for an async query
206
+ * Fetch a page of results for an async details job
207
207
  *
208
208
  * @param {String} jobId jobId
209
209
  * @param {Object} opts Optional parameters
@@ -5,7 +5,7 @@ class ArchitectApi {
5
5
  /**
6
6
  * Architect service.
7
7
  * @module purecloud-platform-client-v2/api/ArchitectApi
8
- * @version 152.0.0
8
+ * @version 153.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 152.0.0
8
+ * @version 153.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 152.0.0
8
+ * @version 153.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -538,6 +538,26 @@ class AuthorizationApi {
538
538
  );
539
539
  }
540
540
 
541
+ /**
542
+ * Get authorization settings
543
+ *
544
+ */
545
+ getAuthorizationSettings() {
546
+
547
+ return this.apiClient.callApi(
548
+ '/api/v2/authorization/settings',
549
+ 'GET',
550
+ { },
551
+ { },
552
+ { },
553
+ { },
554
+ null,
555
+ ['PureCloud OAuth'],
556
+ ['application/json'],
557
+ ['application/json']
558
+ );
559
+ }
560
+
541
561
  /**
542
562
  * Returns a listing of roles and permissions for a user.
543
563
  *
@@ -662,6 +682,31 @@ class AuthorizationApi {
662
682
  );
663
683
  }
664
684
 
685
+ /**
686
+ * Change authorization settings
687
+ * Change authorization settings
688
+ * @param {Object} body Authorization Settings
689
+ */
690
+ patchAuthorizationSettings(body) {
691
+ // verify the required parameter 'body' is set
692
+ if (body === undefined || body === null) {
693
+ throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
694
+ }
695
+
696
+ return this.apiClient.callApi(
697
+ '/api/v2/authorization/settings',
698
+ 'PATCH',
699
+ { },
700
+ { },
701
+ { },
702
+ { },
703
+ body,
704
+ ['PureCloud OAuth'],
705
+ ['application/json'],
706
+ ['application/json']
707
+ );
708
+ }
709
+
665
710
  /**
666
711
  * Assign a list of objects to a division
667
712
  * Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
@@ -5,7 +5,7 @@ class BillingApi {
5
5
  /**
6
6
  * Billing service.
7
7
  * @module purecloud-platform-client-v2/api/BillingApi
8
- * @version 152.0.0
8
+ * @version 153.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 152.0.0
8
+ * @version 153.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 152.0.0
8
+ * @version 153.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 152.0.0
8
+ * @version 153.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 152.0.0
8
+ * @version 153.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -21,7 +21,7 @@ class ConversationsApi {
21
21
 
22
22
 
23
23
  /**
24
- * Delete/cancel an async request
24
+ * Delete/cancel an async details job
25
25
  *
26
26
  * @param {String} jobId jobId
27
27
  */
@@ -395,7 +395,7 @@ class ConversationsApi {
395
395
  }
396
396
 
397
397
  /**
398
- * Fetch a page of results for an async query
398
+ * Fetch a page of results for an async details job
399
399
  *
400
400
  * @param {String} jobId jobId
401
401
  * @param {Object} opts Optional parameters
@@ -5,7 +5,7 @@ class DataExtensionsApi {
5
5
  /**
6
6
  * DataExtensions service.
7
7
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
8
- * @version 152.0.0
8
+ * @version 153.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class DownloadsApi {
5
5
  /**
6
6
  * Downloads service.
7
7
  * @module purecloud-platform-client-v2/api/DownloadsApi
8
- * @version 152.0.0
8
+ * @version 153.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class EventsApi {
5
5
  /**
6
6
  * Events service.
7
7
  * @module purecloud-platform-client-v2/api/EventsApi
8
- * @version 152.0.0
8
+ * @version 153.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ExternalContactsApi {
5
5
  /**
6
6
  * ExternalContacts service.
7
7
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
8
- * @version 152.0.0
8
+ * @version 153.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class FaxApi {
5
5
  /**
6
6
  * Fax service.
7
7
  * @module purecloud-platform-client-v2/api/FaxApi
8
- * @version 152.0.0
8
+ * @version 153.0.0
9
9
  */
10
10
 
11
11
  /**