@shuffl/api-contracts 0.3.0 → 0.5.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 (18) hide show
  1. package/dist/base.d.ts +5 -3
  2. package/dist/base.js +8 -4
  3. package/dist/company.d.ts +235 -0
  4. package/dist/company.js +177 -0
  5. package/dist/index.d.ts +7527 -3354
  6. package/dist/index.js +23 -3
  7. package/dist/management-operations.d.ts +1 -1
  8. package/dist/management-operations.js +497 -79
  9. package/dist/management.generated.d.ts +6071 -2091
  10. package/dist/management.generated.js +4808 -753
  11. package/dist/permissions.d.ts +179 -57
  12. package/dist/permissions.js +23 -18
  13. package/dist/schemas.d.ts +7 -0
  14. package/dist/schemas.js +20 -3
  15. package/dist/webhooks.d.ts +373 -0
  16. package/dist/webhooks.js +429 -0
  17. package/openapi.json +99305 -54947
  18. package/package.json +13 -1
package/dist/permissions.d.ts CHANGED
@@ -57,6 +57,7 @@ export declare const permissionSchema: z.ZodEnum<{
57
57
  "celebrations.savePreferences": "celebrations.savePreferences";
58
58
  "celebrations.signCard": "celebrations.signCard";
59
59
  "celebrations.startDates": "celebrations.startDates";
60
+ "celebrations.thisWeek": "celebrations.thisWeek";
60
61
  "channels.list": "channels.list";
61
62
  "commands.get": "commands.get";
62
63
  "communities.archive": "communities.archive";
@@ -81,6 +82,7 @@ export declare const permissionSchema: z.ZodEnum<{
81
82
  "credentials.api.list": "credentials.api.list";
82
83
  "credentials.api.revoke": "credentials.api.revoke";
83
84
  "digest.actOnNudge": "digest.actOnNudge";
85
+ "digest.culture": "digest.culture";
84
86
  "digest.dismissNudge": "digest.dismissNudge";
85
87
  "digest.nudge": "digest.nudge";
86
88
  "digest.nudges": "digest.nudges";
@@ -95,6 +97,30 @@ export declare const permissionSchema: z.ZodEnum<{
95
97
  "getStarted.get": "getStarted.get";
96
98
  "getStarted.intro": "getStarted.intro";
97
99
  "getStarted.wizard": "getStarted.wizard";
100
+ "groups.allAutomations": "groups.allAutomations";
101
+ "groups.automations": "groups.automations";
102
+ "groups.directory": "groups.directory";
103
+ "groups.directoryGroup": "groups.directoryGroup";
104
+ "groups.discardMessage": "groups.discardMessage";
105
+ "groups.export": "groups.export";
106
+ "groups.get": "groups.get";
107
+ "groups.glance": "groups.glance";
108
+ "groups.list": "groups.list";
109
+ "groups.members": "groups.members";
110
+ "groups.message": "groups.message";
111
+ "groups.messages": "groups.messages";
112
+ "groups.options": "groups.options";
113
+ "groups.prepareMessage": "groups.prepareMessage";
114
+ "groups.preview": "groups.preview";
115
+ "groups.refresh": "groups.refresh";
116
+ "groups.remove": "groups.remove";
117
+ "groups.removeAutomation": "groups.removeAutomation";
118
+ "groups.save": "groups.save";
119
+ "groups.searchPeople": "groups.searchPeople";
120
+ "groups.sendMessage": "groups.sendMessage";
121
+ "groups.setAutomation": "groups.setAutomation";
122
+ "groups.setAutomationState": "groups.setAutomationState";
123
+ "groups.suggestions": "groups.suggestions";
98
124
  "home.feed": "home.feed";
99
125
  "home.places": "home.places";
100
126
  "home.preferences": "home.preferences";
@@ -128,6 +154,11 @@ export declare const permissionSchema: z.ZodEnum<{
128
154
  "invitations.createMany": "invitations.createMany";
129
155
  "invitations.inviteDirectory": "invitations.inviteDirectory";
130
156
  "invitations.list": "invitations.list";
157
+ "knowledge.acknowledgements.close": "knowledge.acknowledgements.close";
158
+ "knowledge.acknowledgements.mine": "knowledge.acknowledgements.mine";
159
+ "knowledge.acknowledgements.remind": "knowledge.acknowledgements.remind";
160
+ "knowledge.acknowledgements.request": "knowledge.acknowledgements.request";
161
+ "knowledge.acknowledgements.status": "knowledge.acknowledgements.status";
131
162
  "knowledge.connections.browse": "knowledge.connections.browse";
132
163
  "knowledge.connections.connect": "knowledge.connections.connect";
133
164
  "knowledge.connections.disconnect": "knowledge.connections.disconnect";
@@ -135,6 +166,7 @@ export declare const permissionSchema: z.ZodEnum<{
135
166
  "knowledge.connections.request": "knowledge.connections.request";
136
167
  "knowledge.connections.requests": "knowledge.connections.requests";
137
168
  "knowledge.context": "knowledge.context";
169
+ "knowledge.handbook.export": "knowledge.handbook.export";
138
170
  "knowledge.policies.coverage": "knowledge.policies.coverage";
139
171
  "knowledge.search": "knowledge.search";
140
172
  "knowledge.sources.archive": "knowledge.sources.archive";
@@ -151,6 +183,8 @@ export declare const permissionSchema: z.ZodEnum<{
151
183
  "knowledge.sources.search": "knowledge.sources.search";
152
184
  "knowledge.sources.withdraw": "knowledge.sources.withdraw";
153
185
  "knowledge.sources.write": "knowledge.sources.write";
186
+ "knowledge.templates.draft": "knowledge.templates.draft";
187
+ "knowledge.templates.facts": "knowledge.templates.facts";
154
188
  "knowledge.uploads.appendPart": "knowledge.uploads.appendPart";
155
189
  "knowledge.uploads.complete": "knowledge.uploads.complete";
156
190
  "knowledge.uploads.create": "knowledge.uploads.create";
@@ -162,35 +196,48 @@ export declare const permissionSchema: z.ZodEnum<{
162
196
  "network.mine": "network.mine";
163
197
  "network.ofPerson": "network.ofPerson";
164
198
  "network.orgChart": "network.orgChart";
199
+ "network.requestIntro": "network.requestIntro";
165
200
  "notifications.preferences": "notifications.preferences";
166
201
  "notifications.save": "notifications.save";
167
- "onboarding.answerBuddyAsk": "onboarding.answerBuddyAsk";
168
- "onboarding.answerCheckIn": "onboarding.answerCheckIn";
169
- "onboarding.answerFirstDaysCheckIn": "onboarding.answerFirstDaysCheckIn";
170
- "onboarding.approve": "onboarding.approve";
171
- "onboarding.askBuddy": "onboarding.askBuddy";
172
- "onboarding.assignBuddy": "onboarding.assignBuddy";
173
- "onboarding.buddySuggestions": "onboarding.buddySuggestions";
174
- "onboarding.candidates": "onboarding.candidates";
175
- "onboarding.enroll": "onboarding.enroll";
176
- "onboarding.enrollmentPreview": "onboarding.enrollmentPreview";
177
- "onboarding.firstDaysCheckIns": "onboarding.firstDaysCheckIns";
178
- "onboarding.firstDaysResults": "onboarding.firstDaysResults";
179
- "onboarding.journey": "onboarding.journey";
180
- "onboarding.mine": "onboarding.mine";
181
- "onboarding.person": "onboarding.person";
182
- "onboarding.previewEnrollment": "onboarding.previewEnrollment";
183
- "onboarding.program": "onboarding.program";
184
- "onboarding.remove": "onboarding.remove";
185
- "onboarding.respondBuddy": "onboarding.respondBuddy";
186
- "onboarding.retry": "onboarding.retry";
187
- "onboarding.saveProgram": "onboarding.saveProgram";
188
- "onboarding.update": "onboarding.update";
189
202
  "operations.activity": "operations.activity";
190
203
  "operations.dispatchInbox": "operations.dispatchInbox";
191
204
  "operations.reconcile": "operations.reconcile";
192
205
  "operations.status": "operations.status";
193
206
  "permissions.list": "permissions.list";
207
+ "playbooks.answerBuddyAsk": "playbooks.answerBuddyAsk";
208
+ "playbooks.answerBuddyFollowUp": "playbooks.answerBuddyFollowUp";
209
+ "playbooks.answerCheckIn": "playbooks.answerCheckIn";
210
+ "playbooks.answerFirstDaysCheckIn": "playbooks.answerFirstDaysCheckIn";
211
+ "playbooks.approve": "playbooks.approve";
212
+ "playbooks.askBuddy": "playbooks.askBuddy";
213
+ "playbooks.assignBuddy": "playbooks.assignBuddy";
214
+ "playbooks.buddyCandidates": "playbooks.buddyCandidates";
215
+ "playbooks.buddyFollowUps": "playbooks.buddyFollowUps";
216
+ "playbooks.buddyProgram": "playbooks.buddyProgram";
217
+ "playbooks.buddySuggestions": "playbooks.buddySuggestions";
218
+ "playbooks.candidates": "playbooks.candidates";
219
+ "playbooks.completeTodo": "playbooks.completeTodo";
220
+ "playbooks.draftPlan": "playbooks.draftPlan";
221
+ "playbooks.enroll": "playbooks.enroll";
222
+ "playbooks.enrollmentPreview": "playbooks.enrollmentPreview";
223
+ "playbooks.firstDaysCheckIns": "playbooks.firstDaysCheckIns";
224
+ "playbooks.firstDaysResults": "playbooks.firstDaysResults";
225
+ "playbooks.mine": "playbooks.mine";
226
+ "playbooks.person": "playbooks.person";
227
+ "playbooks.plans": "playbooks.plans";
228
+ "playbooks.previewEnrollment": "playbooks.previewEnrollment";
229
+ "playbooks.program": "playbooks.program";
230
+ "playbooks.remove": "playbooks.remove";
231
+ "playbooks.respondBuddy": "playbooks.respondBuddy";
232
+ "playbooks.retry": "playbooks.retry";
233
+ "playbooks.run": "playbooks.run";
234
+ "playbooks.savePlan": "playbooks.savePlan";
235
+ "playbooks.saveProgram": "playbooks.saveProgram";
236
+ "playbooks.setBuddyVolunteer": "playbooks.setBuddyVolunteer";
237
+ "playbooks.setPlanGoal": "playbooks.setPlanGoal";
238
+ "playbooks.sharePlan": "playbooks.sharePlan";
239
+ "playbooks.update": "playbooks.update";
240
+ "playbooks.volunteerAsBuddy": "playbooks.volunteerAsBuddy";
194
241
  "praise.addChannel": "praise.addChannel";
195
242
  "praise.composer": "praise.composer";
196
243
  "praise.feed": "praise.feed";
@@ -202,6 +249,7 @@ export declare const permissionSchema: z.ZodEnum<{
202
249
  "praise.send": "praise.send";
203
250
  "praise.setDigest": "praise.setDigest";
204
251
  "praise.setHidden": "praise.setHidden";
252
+ "praise.setRecognition": "praise.setRecognition";
205
253
  "praise.settings": "praise.settings";
206
254
  "profiles.cover.delete": "profiles.cover.delete";
207
255
  "profiles.draft": "profiles.draft";
@@ -214,6 +262,7 @@ export declare const permissionSchema: z.ZodEnum<{
214
262
  "profiles.settings": "profiles.settings";
215
263
  "profiles.whoKnows": "profiles.whoKnows";
216
264
  "programs.archive": "programs.archive";
265
+ "programs.communities": "programs.communities";
217
266
  "programs.create": "programs.create";
218
267
  "programs.get": "programs.get";
219
268
  "programs.joinChannel": "programs.joinChannel";
@@ -231,7 +280,6 @@ export declare const permissionSchema: z.ZodEnum<{
231
280
  "pulse.addTemplate": "pulse.addTemplate";
232
281
  "pulse.answer": "pulse.answer";
233
282
  "pulse.asked": "pulse.asked";
234
- "pulse.audienceOptions": "pulse.audienceOptions";
235
283
  "pulse.createAction": "pulse.createAction";
236
284
  "pulse.decideProposal": "pulse.decideProposal";
237
285
  "pulse.editProposal": "pulse.editProposal";
@@ -245,7 +293,7 @@ export declare const permissionSchema: z.ZodEnum<{
245
293
  "pulse.questions": "pulse.questions";
246
294
  "pulse.requestProposals": "pulse.requestProposals";
247
295
  "pulse.saveProgram": "pulse.saveProgram";
248
- "pulse.setQuestionAudience": "pulse.setQuestionAudience";
296
+ "pulse.setQuestionGroup": "pulse.setQuestionGroup";
249
297
  "pulse.setQuestionStatus": "pulse.setQuestionStatus";
250
298
  "pulse.skip": "pulse.skip";
251
299
  "pulse.today": "pulse.today";
@@ -261,9 +309,9 @@ export declare const permissionSchema: z.ZodEnum<{
261
309
  "reports.melloTrial": "reports.melloTrial";
262
310
  "reports.melloValue": "reports.melloValue";
263
311
  "reports.needsYou": "reports.needsYou";
264
- "reports.onboarding": "reports.onboarding";
265
312
  "reports.overview": "reports.overview";
266
313
  "reports.people": "reports.people";
314
+ "reports.playbooks": "reports.playbooks";
267
315
  "runs.details": "runs.details";
268
316
  "runs.dispatch": "runs.dispatch";
269
317
  "runs.get": "runs.get";
@@ -282,8 +330,10 @@ export declare const permissionSchema: z.ZodEnum<{
282
330
  "sync.connect": "sync.connect";
283
331
  "sync.current": "sync.current";
284
332
  "sync.disconnect": "sync.disconnect";
333
+ "sync.groups": "sync.groups";
285
334
  "sync.request": "sync.request";
286
335
  "sync.run": "sync.run";
336
+ "sync.setGroup": "sync.setGroup";
287
337
  "team.answerMinutes": "team.answerMinutes";
288
338
  "team.dismissLaunchPost": "team.dismissLaunchPost";
289
339
  "team.launchPost": "team.launchPost";
@@ -306,9 +356,7 @@ export declare const permissionSchema: z.ZodEnum<{
306
356
  "teams.syncSlackProfileLinks": "teams.syncSlackProfileLinks";
307
357
  "teams.uploadPairHistory": "teams.uploadPairHistory";
308
358
  "timeOff.balances": "timeOff.balances";
309
- "units.archive": "units.archive";
310
359
  "units.list": "units.list";
311
- "units.save": "units.save";
312
360
  "users.activity": "users.activity";
313
361
  "users.assignManagers": "users.assignManagers";
314
362
  "users.blockPair": "users.blockPair";
@@ -328,6 +376,18 @@ export declare const permissionSchema: z.ZodEnum<{
328
376
  "users.reportingLineProposal": "users.reportingLineProposal";
329
377
  "users.reviewReportingLines": "users.reviewReportingLines";
330
378
  "users.save": "users.save";
379
+ "webhooks.catalog": "webhooks.catalog";
380
+ "webhooks.create": "webhooks.create";
381
+ "webhooks.delete": "webhooks.delete";
382
+ "webhooks.deliveries.get": "webhooks.deliveries.get";
383
+ "webhooks.deliveries.list": "webhooks.deliveries.list";
384
+ "webhooks.deliveries.replay": "webhooks.deliveries.replay";
385
+ "webhooks.deliveries.replayFailed": "webhooks.deliveries.replayFailed";
386
+ "webhooks.get": "webhooks.get";
387
+ "webhooks.list": "webhooks.list";
388
+ "webhooks.rotateSecret": "webhooks.rotateSecret";
389
+ "webhooks.sendTest": "webhooks.sendTest";
390
+ "webhooks.update": "webhooks.update";
331
391
  }>;
332
392
  export declare const permissionDefinitionSchema: z.ZodObject<{
333
393
  access: z.ZodEnum<{
@@ -377,6 +437,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
377
437
  "celebrations.savePreferences": "celebrations.savePreferences";
378
438
  "celebrations.signCard": "celebrations.signCard";
379
439
  "celebrations.startDates": "celebrations.startDates";
440
+ "celebrations.thisWeek": "celebrations.thisWeek";
380
441
  "channels.list": "channels.list";
381
442
  "commands.get": "commands.get";
382
443
  "communities.archive": "communities.archive";
@@ -401,6 +462,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
401
462
  "credentials.api.list": "credentials.api.list";
402
463
  "credentials.api.revoke": "credentials.api.revoke";
403
464
  "digest.actOnNudge": "digest.actOnNudge";
465
+ "digest.culture": "digest.culture";
404
466
  "digest.dismissNudge": "digest.dismissNudge";
405
467
  "digest.nudge": "digest.nudge";
406
468
  "digest.nudges": "digest.nudges";
@@ -415,6 +477,30 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
415
477
  "getStarted.get": "getStarted.get";
416
478
  "getStarted.intro": "getStarted.intro";
417
479
  "getStarted.wizard": "getStarted.wizard";
480
+ "groups.allAutomations": "groups.allAutomations";
481
+ "groups.automations": "groups.automations";
482
+ "groups.directory": "groups.directory";
483
+ "groups.directoryGroup": "groups.directoryGroup";
484
+ "groups.discardMessage": "groups.discardMessage";
485
+ "groups.export": "groups.export";
486
+ "groups.get": "groups.get";
487
+ "groups.glance": "groups.glance";
488
+ "groups.list": "groups.list";
489
+ "groups.members": "groups.members";
490
+ "groups.message": "groups.message";
491
+ "groups.messages": "groups.messages";
492
+ "groups.options": "groups.options";
493
+ "groups.prepareMessage": "groups.prepareMessage";
494
+ "groups.preview": "groups.preview";
495
+ "groups.refresh": "groups.refresh";
496
+ "groups.remove": "groups.remove";
497
+ "groups.removeAutomation": "groups.removeAutomation";
498
+ "groups.save": "groups.save";
499
+ "groups.searchPeople": "groups.searchPeople";
500
+ "groups.sendMessage": "groups.sendMessage";
501
+ "groups.setAutomation": "groups.setAutomation";
502
+ "groups.setAutomationState": "groups.setAutomationState";
503
+ "groups.suggestions": "groups.suggestions";
418
504
  "home.feed": "home.feed";
419
505
  "home.places": "home.places";
420
506
  "home.preferences": "home.preferences";
@@ -448,6 +534,11 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
448
534
  "invitations.createMany": "invitations.createMany";
449
535
  "invitations.inviteDirectory": "invitations.inviteDirectory";
450
536
  "invitations.list": "invitations.list";
537
+ "knowledge.acknowledgements.close": "knowledge.acknowledgements.close";
538
+ "knowledge.acknowledgements.mine": "knowledge.acknowledgements.mine";
539
+ "knowledge.acknowledgements.remind": "knowledge.acknowledgements.remind";
540
+ "knowledge.acknowledgements.request": "knowledge.acknowledgements.request";
541
+ "knowledge.acknowledgements.status": "knowledge.acknowledgements.status";
451
542
  "knowledge.connections.browse": "knowledge.connections.browse";
452
543
  "knowledge.connections.connect": "knowledge.connections.connect";
453
544
  "knowledge.connections.disconnect": "knowledge.connections.disconnect";
@@ -455,6 +546,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
455
546
  "knowledge.connections.request": "knowledge.connections.request";
456
547
  "knowledge.connections.requests": "knowledge.connections.requests";
457
548
  "knowledge.context": "knowledge.context";
549
+ "knowledge.handbook.export": "knowledge.handbook.export";
458
550
  "knowledge.policies.coverage": "knowledge.policies.coverage";
459
551
  "knowledge.search": "knowledge.search";
460
552
  "knowledge.sources.archive": "knowledge.sources.archive";
@@ -471,6 +563,8 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
471
563
  "knowledge.sources.search": "knowledge.sources.search";
472
564
  "knowledge.sources.withdraw": "knowledge.sources.withdraw";
473
565
  "knowledge.sources.write": "knowledge.sources.write";
566
+ "knowledge.templates.draft": "knowledge.templates.draft";
567
+ "knowledge.templates.facts": "knowledge.templates.facts";
474
568
  "knowledge.uploads.appendPart": "knowledge.uploads.appendPart";
475
569
  "knowledge.uploads.complete": "knowledge.uploads.complete";
476
570
  "knowledge.uploads.create": "knowledge.uploads.create";
@@ -482,35 +576,48 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
482
576
  "network.mine": "network.mine";
483
577
  "network.ofPerson": "network.ofPerson";
484
578
  "network.orgChart": "network.orgChart";
579
+ "network.requestIntro": "network.requestIntro";
485
580
  "notifications.preferences": "notifications.preferences";
486
581
  "notifications.save": "notifications.save";
487
- "onboarding.answerBuddyAsk": "onboarding.answerBuddyAsk";
488
- "onboarding.answerCheckIn": "onboarding.answerCheckIn";
489
- "onboarding.answerFirstDaysCheckIn": "onboarding.answerFirstDaysCheckIn";
490
- "onboarding.approve": "onboarding.approve";
491
- "onboarding.askBuddy": "onboarding.askBuddy";
492
- "onboarding.assignBuddy": "onboarding.assignBuddy";
493
- "onboarding.buddySuggestions": "onboarding.buddySuggestions";
494
- "onboarding.candidates": "onboarding.candidates";
495
- "onboarding.enroll": "onboarding.enroll";
496
- "onboarding.enrollmentPreview": "onboarding.enrollmentPreview";
497
- "onboarding.firstDaysCheckIns": "onboarding.firstDaysCheckIns";
498
- "onboarding.firstDaysResults": "onboarding.firstDaysResults";
499
- "onboarding.journey": "onboarding.journey";
500
- "onboarding.mine": "onboarding.mine";
501
- "onboarding.person": "onboarding.person";
502
- "onboarding.previewEnrollment": "onboarding.previewEnrollment";
503
- "onboarding.program": "onboarding.program";
504
- "onboarding.remove": "onboarding.remove";
505
- "onboarding.respondBuddy": "onboarding.respondBuddy";
506
- "onboarding.retry": "onboarding.retry";
507
- "onboarding.saveProgram": "onboarding.saveProgram";
508
- "onboarding.update": "onboarding.update";
509
582
  "operations.activity": "operations.activity";
510
583
  "operations.dispatchInbox": "operations.dispatchInbox";
511
584
  "operations.reconcile": "operations.reconcile";
512
585
  "operations.status": "operations.status";
513
586
  "permissions.list": "permissions.list";
587
+ "playbooks.answerBuddyAsk": "playbooks.answerBuddyAsk";
588
+ "playbooks.answerBuddyFollowUp": "playbooks.answerBuddyFollowUp";
589
+ "playbooks.answerCheckIn": "playbooks.answerCheckIn";
590
+ "playbooks.answerFirstDaysCheckIn": "playbooks.answerFirstDaysCheckIn";
591
+ "playbooks.approve": "playbooks.approve";
592
+ "playbooks.askBuddy": "playbooks.askBuddy";
593
+ "playbooks.assignBuddy": "playbooks.assignBuddy";
594
+ "playbooks.buddyCandidates": "playbooks.buddyCandidates";
595
+ "playbooks.buddyFollowUps": "playbooks.buddyFollowUps";
596
+ "playbooks.buddyProgram": "playbooks.buddyProgram";
597
+ "playbooks.buddySuggestions": "playbooks.buddySuggestions";
598
+ "playbooks.candidates": "playbooks.candidates";
599
+ "playbooks.completeTodo": "playbooks.completeTodo";
600
+ "playbooks.draftPlan": "playbooks.draftPlan";
601
+ "playbooks.enroll": "playbooks.enroll";
602
+ "playbooks.enrollmentPreview": "playbooks.enrollmentPreview";
603
+ "playbooks.firstDaysCheckIns": "playbooks.firstDaysCheckIns";
604
+ "playbooks.firstDaysResults": "playbooks.firstDaysResults";
605
+ "playbooks.mine": "playbooks.mine";
606
+ "playbooks.person": "playbooks.person";
607
+ "playbooks.plans": "playbooks.plans";
608
+ "playbooks.previewEnrollment": "playbooks.previewEnrollment";
609
+ "playbooks.program": "playbooks.program";
610
+ "playbooks.remove": "playbooks.remove";
611
+ "playbooks.respondBuddy": "playbooks.respondBuddy";
612
+ "playbooks.retry": "playbooks.retry";
613
+ "playbooks.run": "playbooks.run";
614
+ "playbooks.savePlan": "playbooks.savePlan";
615
+ "playbooks.saveProgram": "playbooks.saveProgram";
616
+ "playbooks.setBuddyVolunteer": "playbooks.setBuddyVolunteer";
617
+ "playbooks.setPlanGoal": "playbooks.setPlanGoal";
618
+ "playbooks.sharePlan": "playbooks.sharePlan";
619
+ "playbooks.update": "playbooks.update";
620
+ "playbooks.volunteerAsBuddy": "playbooks.volunteerAsBuddy";
514
621
  "praise.addChannel": "praise.addChannel";
515
622
  "praise.composer": "praise.composer";
516
623
  "praise.feed": "praise.feed";
@@ -522,6 +629,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
522
629
  "praise.send": "praise.send";
523
630
  "praise.setDigest": "praise.setDigest";
524
631
  "praise.setHidden": "praise.setHidden";
632
+ "praise.setRecognition": "praise.setRecognition";
525
633
  "praise.settings": "praise.settings";
526
634
  "profiles.cover.delete": "profiles.cover.delete";
527
635
  "profiles.draft": "profiles.draft";
@@ -534,6 +642,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
534
642
  "profiles.settings": "profiles.settings";
535
643
  "profiles.whoKnows": "profiles.whoKnows";
536
644
  "programs.archive": "programs.archive";
645
+ "programs.communities": "programs.communities";
537
646
  "programs.create": "programs.create";
538
647
  "programs.get": "programs.get";
539
648
  "programs.joinChannel": "programs.joinChannel";
@@ -551,7 +660,6 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
551
660
  "pulse.addTemplate": "pulse.addTemplate";
552
661
  "pulse.answer": "pulse.answer";
553
662
  "pulse.asked": "pulse.asked";
554
- "pulse.audienceOptions": "pulse.audienceOptions";
555
663
  "pulse.createAction": "pulse.createAction";
556
664
  "pulse.decideProposal": "pulse.decideProposal";
557
665
  "pulse.editProposal": "pulse.editProposal";
@@ -565,7 +673,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
565
673
  "pulse.questions": "pulse.questions";
566
674
  "pulse.requestProposals": "pulse.requestProposals";
567
675
  "pulse.saveProgram": "pulse.saveProgram";
568
- "pulse.setQuestionAudience": "pulse.setQuestionAudience";
676
+ "pulse.setQuestionGroup": "pulse.setQuestionGroup";
569
677
  "pulse.setQuestionStatus": "pulse.setQuestionStatus";
570
678
  "pulse.skip": "pulse.skip";
571
679
  "pulse.today": "pulse.today";
@@ -581,9 +689,9 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
581
689
  "reports.melloTrial": "reports.melloTrial";
582
690
  "reports.melloValue": "reports.melloValue";
583
691
  "reports.needsYou": "reports.needsYou";
584
- "reports.onboarding": "reports.onboarding";
585
692
  "reports.overview": "reports.overview";
586
693
  "reports.people": "reports.people";
694
+ "reports.playbooks": "reports.playbooks";
587
695
  "runs.details": "runs.details";
588
696
  "runs.dispatch": "runs.dispatch";
589
697
  "runs.get": "runs.get";
@@ -602,8 +710,10 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
602
710
  "sync.connect": "sync.connect";
603
711
  "sync.current": "sync.current";
604
712
  "sync.disconnect": "sync.disconnect";
713
+ "sync.groups": "sync.groups";
605
714
  "sync.request": "sync.request";
606
715
  "sync.run": "sync.run";
716
+ "sync.setGroup": "sync.setGroup";
607
717
  "team.answerMinutes": "team.answerMinutes";
608
718
  "team.dismissLaunchPost": "team.dismissLaunchPost";
609
719
  "team.launchPost": "team.launchPost";
@@ -626,9 +736,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
626
736
  "teams.syncSlackProfileLinks": "teams.syncSlackProfileLinks";
627
737
  "teams.uploadPairHistory": "teams.uploadPairHistory";
628
738
  "timeOff.balances": "timeOff.balances";
629
- "units.archive": "units.archive";
630
739
  "units.list": "units.list";
631
- "units.save": "units.save";
632
740
  "users.activity": "users.activity";
633
741
  "users.assignManagers": "users.assignManagers";
634
742
  "users.blockPair": "users.blockPair";
@@ -648,6 +756,18 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
648
756
  "users.reportingLineProposal": "users.reportingLineProposal";
649
757
  "users.reviewReportingLines": "users.reviewReportingLines";
650
758
  "users.save": "users.save";
759
+ "webhooks.catalog": "webhooks.catalog";
760
+ "webhooks.create": "webhooks.create";
761
+ "webhooks.delete": "webhooks.delete";
762
+ "webhooks.deliveries.get": "webhooks.deliveries.get";
763
+ "webhooks.deliveries.list": "webhooks.deliveries.list";
764
+ "webhooks.deliveries.replay": "webhooks.deliveries.replay";
765
+ "webhooks.deliveries.replayFailed": "webhooks.deliveries.replayFailed";
766
+ "webhooks.get": "webhooks.get";
767
+ "webhooks.list": "webhooks.list";
768
+ "webhooks.rotateSecret": "webhooks.rotateSecret";
769
+ "webhooks.sendTest": "webhooks.sendTest";
770
+ "webhooks.update": "webhooks.update";
651
771
  }>;
652
772
  resource: z.ZodString;
653
773
  scope: z.ZodNullable<z.ZodEnum<{
@@ -670,13 +790,13 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
670
790
  "knowledge:read": "knowledge:read";
671
791
  "knowledge:write": "knowledge:write";
672
792
  "manager:read": "manager:read";
673
- "onboarding:read": "onboarding:read";
674
- "onboarding:write": "onboarding:write";
675
793
  "operations:read": "operations:read";
676
794
  "operations:write": "operations:write";
677
795
  "operator:read": "operator:read";
678
796
  "operator:write": "operator:write";
679
797
  "participation:write": "participation:write";
798
+ "playbooks:read": "playbooks:read";
799
+ "playbooks:write": "playbooks:write";
680
800
  "praise:read": "praise:read";
681
801
  "praise:write": "praise:write";
682
802
  "profile:write": "profile:write";
@@ -695,10 +815,12 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
695
815
  "team:write": "team:write";
696
816
  "users:read": "users:read";
697
817
  "users:write": "users:write";
818
+ "webhooks:read": "webhooks:read";
819
+ "webhooks:write": "webhooks:write";
698
820
  }>>;
699
821
  }, z.core.$strip>;
700
822
  export declare const permissionById: Map<Permission, PermissionDefinition>;
701
- export declare const teamSetupPermissions: readonly ["teams.setup", "teams.saveAgentSetup", "teams.slackChannels", "teams.moveSlackChannels", "knowledge.uploads.create", "knowledge.uploads.appendPart", "knowledge.uploads.complete", "knowledge.uploads.get", "knowledge.sources.importWebsite", "knowledge.sources.list", "knowledge.sources.get", "knowledge.sources.write", "knowledge.sources.publish", "assistant.send", "invitations.create", "invitations.list", "pulse.program", "pulse.saveProgram", "channels.list", "programs.options", "programs.create", "onboarding.program", "onboarding.saveProgram", "celebrations.program", "celebrations.preview", "celebrations.save"];
823
+ export declare const teamSetupPermissions: readonly ["teams.setup", "teams.saveAgentSetup", "teams.slackChannels", "teams.moveSlackChannels", "knowledge.uploads.create", "knowledge.uploads.appendPart", "knowledge.uploads.complete", "knowledge.uploads.get", "knowledge.sources.importWebsite", "knowledge.sources.list", "knowledge.sources.get", "knowledge.sources.write", "knowledge.sources.publish", "assistant.send", "invitations.create", "invitations.list", "pulse.program", "pulse.saveProgram", "channels.list", "programs.options", "programs.create", "playbooks.program", "playbooks.saveProgram", "celebrations.program", "celebrations.preview", "celebrations.save"];
702
824
  export declare const destructiveOperation: RegExp;
703
825
  export declare function scopesForPermissions(permissions: readonly Permission[]): Scope[];
704
826
  export declare function grantedPermissions(grant: {
package/dist/permissions.js CHANGED
@@ -120,9 +120,15 @@ const operationDescriptions = {
120
120
  'invitations.cancel': 'Cancel a pending workspace invitation',
121
121
  'invitations.candidates': 'List people in the directory who can be invited to the workspace',
122
122
  'invitations.list': 'List pending workspace invitations',
123
+ 'knowledge.acknowledgements.close': 'Stop asking people to confirm a Knowledge page',
124
+ 'knowledge.acknowledgements.mine': 'List the Knowledge pages you are asked to read and confirm',
125
+ 'knowledge.acknowledgements.remind': 'Remind the people who have not confirmed a Knowledge page yet',
126
+ 'knowledge.acknowledgements.request': 'Ask the people a Knowledge page reaches to confirm they read it',
127
+ 'knowledge.acknowledgements.status': 'See who has confirmed a Knowledge page and who has not',
123
128
  'knowledge.connections.list': 'List connected Knowledge providers',
124
129
  'knowledge.connections.request': 'Ask an administrator to connect a Knowledge source',
125
130
  'knowledge.connections.requests': 'List requests to connect a Knowledge source',
131
+ 'knowledge.handbook.export': 'Download the pages published to everyone as one handbook, in Markdown',
126
132
  'knowledge.policies.coverage': 'Check which common HR policies Knowledge covers',
127
133
  'knowledge.sources.get': 'Read a Knowledge source',
128
134
  'knowledge.sources.history': "List a Knowledge source's versions",
@@ -132,6 +138,7 @@ const operationDescriptions = {
132
138
  'knowledge.sources.save': 'Save a Knowledge source draft',
133
139
  'knowledge.sources.search': 'Search Knowledge sources by title',
134
140
  'knowledge.sources.withdraw': 'Withdraw a published Knowledge source',
141
+ 'knowledge.templates.facts': 'Read what Shuffl knows that policy templates ask for',
135
142
  'knowledge.uploads.appendPart': 'Upload the next part of a Knowledge file',
136
143
  'knowledge.uploads.complete': 'Finish a Knowledge file upload and start reading it',
137
144
  'knowledge.uploads.create': 'Start uploading a file to Knowledge',
@@ -139,20 +146,20 @@ const operationDescriptions = {
139
146
  'knowledge.uploads.retry': 'Retry reading a Knowledge file that failed',
140
147
  'notifications.preferences': 'Read your notification preferences',
141
148
  'notifications.save': 'Save a notification preference',
142
- 'onboarding.answerCheckIn': 'Answer your onboarding program’s help check-in: all good, or ask HR for help',
143
- 'onboarding.assignBuddy': 'Assign an onboarding buddy to a new hire',
144
- 'onboarding.candidates': 'List people who could be enrolled in onboarding',
145
- 'onboarding.enrollmentPreview': 'Preview enrolling a new hire in onboarding',
146
- 'onboarding.mine': 'Read your own onboarding plan and buddy asks',
147
- 'onboarding.person': "Read a new hire's onboarding plan",
148
- 'onboarding.previewEnrollment': 'Preview the onboarding steps for a new hire',
149
- 'onboarding.program': 'Read the Onboarding program settings',
150
- 'onboarding.remove': 'Remove a new hire from onboarding',
151
- 'onboarding.respondBuddy': 'Accept or decline being an onboarding buddy',
152
- 'onboarding.retry': 'Retry a failed onboarding step',
153
- 'onboarding.update': "Change a new hire's onboarding start date or time zone",
154
149
  'operations.activity': "Read the workspace's recent audit activity",
155
150
  'operations.status': 'Read the workspace delivery and provider health summary',
151
+ 'playbooks.answerCheckIn': 'Answer your onboarding program’s help check-in: all good, or ask HR for help',
152
+ 'playbooks.assignBuddy': 'Assign an onboarding buddy to a new hire',
153
+ 'playbooks.candidates': 'List people who could be enrolled in onboarding',
154
+ 'playbooks.enrollmentPreview': 'Preview enrolling a new hire in onboarding',
155
+ 'playbooks.mine': 'Read your own onboarding plan and buddy asks',
156
+ 'playbooks.person': "Read a new hire's onboarding plan",
157
+ 'playbooks.previewEnrollment': 'Preview the onboarding steps for a new hire',
158
+ 'playbooks.program': 'Read the Onboarding program settings',
159
+ 'playbooks.remove': 'Remove a new hire from onboarding',
160
+ 'playbooks.respondBuddy': 'Accept or decline being an onboarding buddy',
161
+ 'playbooks.retry': 'Retry a failed onboarding step',
162
+ 'playbooks.update': "Change a new hire's onboarding start date or time zone",
156
163
  'profiles.cover.delete': 'Remove your profile cover picture',
157
164
  'profiles.photo.delete': 'Remove your profile photo',
158
165
  'profiles.positions.delete': 'Remove a past position from your profile',
@@ -165,9 +172,9 @@ const operationDescriptions = {
165
172
  'reports.knowledge': 'Read Knowledge activity',
166
173
  'reports.knowledgeSource': 'Read activity for one Knowledge source',
167
174
  'reports.needsYou': 'Read HR request and Knowledge draft insights',
168
- 'reports.onboarding': 'Read Onboarding insights',
169
175
  'reports.overview': 'Read the workspace overview figures',
170
176
  'reports.people': 'Read People insights: headcount, teams and growth',
177
+ 'reports.playbooks': 'Read Onboarding insights',
171
178
  'runs.details': 'Read one introduction round and its pairs',
172
179
  'runs.history.get': 'Read one introduction round imported from the previous Shuffl',
173
180
  'runs.history.list': 'List introduction rounds imported from the previous Shuffl',
@@ -194,9 +201,7 @@ const operationDescriptions = {
194
201
  'teams.slackJoinAccess': 'Read whether Slack members can join Shuffl on their own',
195
202
  'teams.slackProfileLink': 'Read the Shuffl profile link setting for Slack profiles',
196
203
  'teams.status': 'Pause or resume the whole workspace',
197
- 'units.archive': 'Archive a team or department in the People directory',
198
- 'units.list': 'List the teams and departments in the People directory',
199
- 'units.save': 'Create or rename a team or department in the People directory',
204
+ 'units.list': 'List the departments in the People directory',
200
205
  'users.activity': "Read a person's recent activity in Shuffl",
201
206
  'users.blockedPairs': 'List pairs of people who are never introduced',
202
207
  'users.blockPair': 'Stop two people from being introduced to each other',
@@ -268,8 +273,8 @@ export const teamSetupPermissions = [
268
273
  'channels.list',
269
274
  'programs.options',
270
275
  'programs.create',
271
- 'onboarding.program',
272
- 'onboarding.saveProgram',
276
+ 'playbooks.program',
277
+ 'playbooks.saveProgram',
273
278
  'celebrations.program',
274
279
  'celebrations.preview',
275
280
  'celebrations.save',
package/dist/schemas.d.ts CHANGED
@@ -207,6 +207,7 @@ export declare const matchSchema: z.ZodObject<{
207
207
  }>;
208
208
  unitIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
209
209
  unitKind: z.ZodOptional<z.ZodEnum<{
210
+ community: "community";
210
211
  department: "department";
211
212
  team: "team";
212
213
  }>>;
@@ -214,6 +215,8 @@ export declare const matchSchema: z.ZodObject<{
214
215
  export declare const programInput: z.ZodObject<{
215
216
  channelId: z.ZodString;
216
217
  channelName: z.ZodString;
218
+ communityIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
219
+ groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
217
220
  includeBios: z.ZodBoolean;
218
221
  includeSchedulingLink: z.ZodOptional<z.ZodBoolean>;
219
222
  intro: z.ZodString;
@@ -255,6 +258,7 @@ export declare const programInput: z.ZodObject<{
255
258
  }>;
256
259
  unitIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
257
260
  unitKind: z.ZodOptional<z.ZodEnum<{
261
+ community: "community";
258
262
  department: "department";
259
263
  team: "team";
260
264
  }>>;
@@ -333,6 +337,8 @@ export declare const profileSchema: z.ZodObject<{
333
337
  export declare const programPatch: z.ZodObject<{
334
338
  channelId: z.ZodOptional<z.ZodString>;
335
339
  channelName: z.ZodOptional<z.ZodString>;
340
+ communityIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
341
+ groupId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
336
342
  includeBios: z.ZodOptional<z.ZodBoolean>;
337
343
  includeSchedulingLink: z.ZodOptional<z.ZodBoolean>;
338
344
  intro: z.ZodOptional<z.ZodString>;
@@ -374,6 +380,7 @@ export declare const programPatch: z.ZodObject<{
374
380
  }>>;
375
381
  unitIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
376
382
  unitKind: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
383
+ community: "community";
377
384
  department: "department";
378
385
  team: "team";
379
386
  }>>>;