@shuffl/api-contracts 0.4.0 → 0.5.0

package/dist/management-operations.js

@@ -112,6 +112,20 @@ export const managementOperations = [
         'integrations:write',
         'write',
     ],
+    [
+        'sync.groups',
+        'directory.providerGroups',
+        'integrations:read',
+        'read',
+        'List this source’s groups and which ones come into Shuffl',
+    ],
+    [
+        'sync.setGroup',
+        'directory.setProviderGroup',
+        'integrations:write',
+        'write',
+        'Change which of this source’s groups come into Shuffl',
+    ],
     [
         'sync.disconnect',
         'directory.disconnectDirectoryProvider',
@@ -387,6 +401,173 @@ export const managementOperations = [
         'write',
         'Turn badge offers from praise on or off, and choose the launch channel',
     ],
+    // #1917: the groups shown on profiles, for anyone in the workspace.
+    [
+        'groups.directory',
+        'groups.directory',
+        'users:read',
+        'read',
+        'List the groups shown on profiles, yours first, with a few faces each',
+    ],
+    [
+        'groups.directoryGroup',
+        'groups.directoryGroup',
+        'users:read',
+        'read',
+        'Read one group shown on profiles and everyone in it',
+    ],
+    [
+        'groups.glance',
+        'groups.glance',
+        'users:read',
+        'read',
+        'One group at a glance: size, joins, departments, tenure and time zones',
+    ],
+    // #1830: groups, a workspace's own live groups of people, for
+    // administrators.
+    [
+        'groups.list',
+        'groups.list',
+        'users:read',
+        'read',
+        'List the workspace’s groups with who is in each',
+    ],
+    [
+        'groups.get',
+        'groups.get',
+        'users:read',
+        'read',
+        'Read one group: its rules, members and recent entries and exits',
+    ],
+    [
+        'groups.members',
+        'groups.members',
+        'users:read',
+        'read',
+        'One page of a group’s members',
+    ],
+    [
+        'groups.options',
+        'groups.options',
+        'users:read',
+        'read',
+        'The departments, teams, communities, programs, titles, locations and time zones a rule may name',
+    ],
+    [
+        'groups.searchPeople',
+        'groups.searchPeople',
+        'users:read',
+        'read',
+        'Find people by name to pick for a group',
+    ],
+    [
+        'groups.suggestions',
+        'groups.suggestions',
+        'users:read',
+        'read',
+        'Starter groups not made yet, with how many people each would hold',
+    ],
+    [
+        'groups.preview',
+        'groups.preview',
+        'users:read',
+        'read',
+        'Count and sample who a set of rules would hold today',
+    ],
+    [
+        'groups.save',
+        'groups.save',
+        'users:write',
+        'write',
+        'Create or change a group or a department: a list of people or rules that keep it up to date',
+    ],
+    [
+        'groups.refresh',
+        'groups.refresh',
+        'users:write',
+        'write',
+        'Re-evaluate a dynamic group’s rules now',
+    ],
+    ['groups.remove', 'groups.remove', 'users:write', 'write', 'Remove a group'],
+    // #1833: messages from HR to a group, and the group's members as a file.
+    [
+        'groups.messages',
+        'groups.messages',
+        'users:read',
+        'read',
+        'The drafts and sends of messages to a group, newest first',
+    ],
+    [
+        'groups.message',
+        'groups.message',
+        'users:read',
+        'read',
+        'One message to a group: its words, who it would reach now and how it reads to one member',
+    ],
+    [
+        'groups.prepareMessage',
+        'groups.prepareMessage',
+        'users:write',
+        'write',
+        'Write a message to everyone in a group and see who it would reach; nothing is sent',
+    ],
+    [
+        'groups.sendMessage',
+        'groups.sendMessage',
+        'users:write',
+        'write',
+        'Send a drafted message to a group once per request key, on each person’s chosen channel',
+    ],
+    [
+        'groups.discardMessage',
+        'groups.discardMessage',
+        'users:write',
+        'write',
+        'Drop a drafted message to a group',
+    ],
+    [
+        'groups.export',
+        'groups.export',
+        'users:read',
+        'read',
+        'A group’s members as a CSV file: name, email, title, department, manager and when they joined',
+    ],
+    // #1834: automations on a group, run when someone enters or leaves it.
+    [
+        'groups.allAutomations',
+        'groups.allAutomations',
+        'users:read',
+        'read',
+        'Every group automation in the workspace with its group and last runs, or only those that start one playbook, program or community',
+    ],
+    [
+        'groups.automations',
+        'groups.automations',
+        'users:read',
+        'read',
+        'A group’s automations (what happens when someone joins or leaves) and their last runs',
+    ],
+    [
+        'groups.setAutomation',
+        'groups.setAutomation',
+        'users:write',
+        'write',
+        'Add or change an automation on a group; a new one starts paused',
+    ],
+    [
+        'groups.setAutomationState',
+        'groups.setAutomationState',
+        'users:write',
+        'write',
+        'Pause or resume an automation on a group',
+    ],
+    [
+        'groups.removeAutomation',
+        'groups.removeAutomation',
+        'users:write',
+        'write',
+        'Remove an automation from a group, with its runs',
+    ],
     [
         'communities.list',
         'communities.list',
@@ -541,11 +722,16 @@ export const managementOperations = [
         'write',
         'Say you know someone or would like to meet them',
     ],
+    [
+        'network.requestIntro',
+        'network.requestIntro',
+        'profile:write',
+        'write',
+        'Ask someone you both know to introduce you',
+    ],
     ['users.blockPair', 'people.blockPair', 'users:write', 'write'],
     ['users.blockedPairs', 'people.blockedPairs', 'users:read', 'read'],
     ['units.list', 'directory.directoryUnits', 'users:read', 'read'],
-    ['units.save', 'directory.saveDirectoryUnit', 'users:write', 'write'],
-    ['units.archive', 'directory.archiveDirectoryUnit', 'users:write', 'write'],
     ['access.get', 'directory.employeeAccess', 'access:read', 'read'],
     [
         'access.save',
@@ -602,6 +788,13 @@ export const managementOperations = [
         'read',
     ],
     ['programs.people', 'programs.people', 'programs:read', 'read'],
+    [
+        'programs.communities',
+        'programs.communities',
+        'programs:read',
+        'read',
+        'List communities a Connections program can take its people from, with how many members show each one on their profile',
+    ],
     ['runs.list', 'runs.roundsPage', 'runs:read', 'read'],
     ['runs.details', 'runs.run', 'runs:read', 'read'],
     [
@@ -655,6 +848,62 @@ export const managementOperations = [
         'write',
         'Change who can read this knowledge source',
     ],
+    // #1813: asking the people who can read a page to confirm they read it.
+    [
+        'knowledge.acknowledgements.status',
+        'knowledge.acknowledgements',
+        'knowledge:manage',
+        'read',
+    ],
+    [
+        'knowledge.acknowledgements.request',
+        'knowledge.requestAcknowledgement',
+        'knowledge:write',
+        'write',
+        'Ask the people who can read this page to confirm they read it, and message them',
+    ],
+    [
+        'knowledge.acknowledgements.remind',
+        'knowledge.remindAcknowledgement',
+        'knowledge:write',
+        'write',
+        'Message the people who have not confirmed this page yet',
+    ],
+    [
+        'knowledge.acknowledgements.close',
+        'knowledge.closeAcknowledgement',
+        'knowledge:write',
+        'write',
+        'Stop asking people to confirm this page',
+    ],
+    [
+        'knowledge.acknowledgements.mine',
+        'knowledge.myAcknowledgements',
+        'knowledge:read',
+        'read',
+    ],
+    // #1815: what Shuffl knows that policy templates ask for.
+    [
+        'knowledge.templates.facts',
+        'knowledge.templateFacts',
+        'knowledge:manage',
+        'read',
+    ],
+    // #1835: Mello researches a policy template and drafts the whole page.
+    [
+        'knowledge.templates.draft',
+        'knowledge.templateDraft',
+        'knowledge:write',
+        'write',
+        'Draft a policy template with Mello, researching each value; nothing is saved',
+    ],
+    // #1814: the pages published to everyone as one handbook.
+    [
+        'knowledge.handbook.export',
+        'knowledge.handbook',
+        'knowledge:manage',
+        'read',
+    ],
     [
         'knowledge.sources.withdraw',
         'knowledge.withdraw',
@@ -786,12 +1035,7 @@ export const managementOperations = [
         'reports:read',
         'read',
     ],
-    [
-        'reports.onboarding',
-        'reporting.onboardingInsights',
-        'reports:read',
-        'read',
-    ],
+    ['reports.playbooks', 'reporting.playbookInsights', 'reports:read', 'read'],
     ['teams.status', 'teams.teamStatus', 'team:write', 'write'],
     ['teams.rename', 'teams.teamRename', 'team:write', 'write'],
     ['teams.setup', 'setup.setup', 'team:read', 'read'],
@@ -809,146 +1053,213 @@ export const managementOperations = [
     ],
     ['teams.initialize', 'teams.initialize', 'team:write', 'write'],
     // #662: the rest of the app, so a person's own agent can do what they can.
+    ['playbooks.program', 'playbooks.playbookProgram', 'playbooks:read', 'read'],
+    [
+        'playbooks.saveProgram',
+        'playbooks.savePlaybookProgram',
+        'playbooks:write',
+        'write',
+        'Save a playbook: its day 0, steps and messages',
+    ],
+    [
+        'playbooks.candidates',
+        'playbooks.playbookCandidates',
+        'playbooks:read',
+        'read',
+    ],
+    ['playbooks.person', 'playbooks.personPlaybook', 'playbooks:read', 'read'],
     [
-        'onboarding.program',
-        'onboarding.onboardingProgram',
-        'onboarding:read',
+        'playbooks.enrollmentPreview',
+        'playbooks.playbookEnrollmentPreview',
+        'playbooks:read',
         'read',
     ],
     [
-        'onboarding.saveProgram',
-        'onboarding.saveOnboardingProgram',
-        'onboarding:write',
+        'playbooks.previewEnrollment',
+        'playbooks.previewPlaybookEnrollment',
+        'playbooks:write',
         'write',
-        'Save the onboarding program and its messages',
     ],
     [
-        'onboarding.candidates',
-        'onboarding.onboardingCandidates',
-        'onboarding:read',
-        'read',
+        'playbooks.enroll',
+        'playbooks.enrollPlaybook',
+        'playbooks:write',
+        'write',
+        'Put this person on a playbook',
     ],
     [
-        'onboarding.person',
-        'onboarding.personOnboarding',
-        'onboarding:read',
+        'playbooks.approve',
+        'playbooks.approvePlaybookEnrollment',
+        'playbooks:write',
+        'write',
+        'Approve these exact playbook messages for sending',
+    ],
+    [
+        'playbooks.assignBuddy',
+        'playbooks.assignPlaybookBuddy',
+        'playbooks:write',
+        'write',
+    ],
+    [
+        'playbooks.buddyCandidates',
+        'playbooks.buddyCandidates',
+        'playbooks:read',
         'read',
+        'Suggested buddies for a new hire: outside their reporting line, volunteers first, with how many hires each is buddying',
     ],
     [
-        'onboarding.enrollmentPreview',
-        'onboarding.onboardingEnrollmentPreview',
-        'onboarding:read',
+        'playbooks.buddyProgram',
+        'playbooks.buddyProgram',
+        'playbooks:read',
         'read',
+        'Buddy volunteers and recent buddies, with how many of their hires said they met and how many never did',
     ],
     [
-        'onboarding.previewEnrollment',
-        'onboarding.previewOnboardingEnrollment',
-        'onboarding:write',
+        'playbooks.setBuddyVolunteer',
+        'playbooks.setBuddyVolunteer',
+        'playbooks:write',
         'write',
+        'Put someone on the buddy volunteer list, take them off it, or clear it',
     ],
     [
-        'onboarding.enroll',
-        'onboarding.enrollOnboarding',
-        'onboarding:write',
+        'playbooks.volunteerAsBuddy',
+        'playbooks.setMyBuddyVolunteer',
+        'self:write',
         'write',
-        'Enroll this person in onboarding',
+        'Say you are happy to be an onboarding buddy, or stop',
     ],
     [
-        'onboarding.approve',
-        'onboarding.approveOnboardingEnrollment',
-        'onboarding:write',
+        'playbooks.buddyFollowUps',
+        'playbooks.myBuddyFeedback',
+        'self:read',
+        'read',
+        'Your "did you meet?" questions about a new hire or buddy you were paired with',
+    ],
+    [
+        'playbooks.answerBuddyFollowUp',
+        'playbooks.answerBuddyFeedback',
+        'self:write',
         'write',
-        'Approve these exact onboarding messages for sending',
+        'Answer whether you met your buddy or new hire, and whether it helped',
     ],
     [
-        'onboarding.assignBuddy',
-        'onboarding.assignOnboardingBuddy',
-        'onboarding:write',
+        'playbooks.update',
+        'playbooks.updatePlaybookEnrollment',
+        'playbooks:write',
         'write',
     ],
     [
-        'onboarding.update',
-        'onboarding.updateOnboardingEnrollment',
-        'onboarding:write',
+        'playbooks.remove',
+        'playbooks.removePlaybookEnrollment',
+        'playbooks:write',
         'write',
     ],
     [
-        'onboarding.remove',
-        'onboarding.removeOnboardingEnrollment',
-        'onboarding:write',
+        'playbooks.retry',
+        'playbooks.retryPlaybookStep',
+        'playbooks:write',
         'write',
     ],
+    ['playbooks.mine', 'playbooks.myPlaybook', 'self:read', 'read'],
+    [
+        'playbooks.run',
+        'playbooks.myPlaybookRun',
+        'self:read',
+        'read',
+        'One of your playbooks (onboarding or another): day 0, buddy, manager, upcoming check-ins, your to-dos and resources, and the other playbooks you are on',
+    ],
     [
-        'onboarding.retry',
-        'onboarding.retryOnboardingStep',
-        'onboarding:write',
+        'playbooks.completeTodo',
+        'playbooks.completeTodo',
+        'self:write',
         'write',
+        'Check off (or reopen) one of your own playbook to-dos',
     ],
-    ['onboarding.mine', 'onboarding.myOnboarding', 'self:read', 'read'],
     [
-        'onboarding.journey',
-        'onboarding.myJourney',
+        'playbooks.plans',
+        'playbooks.myNewHirePlans',
         'self:read',
         'read',
-        'Your onboarding timeline: start date, buddy, manager, upcoming check-ins, your to-dos and resources',
+        'The 30/60/90 plans for new hires you manage, and your own once your manager shares it',
+    ],
+    [
+        'playbooks.draftPlan',
+        'playbooks.draftNewHirePlan',
+        'self:write',
+        'write',
+        'Have Mello draft the 30/60/90 plan for a new hire you manage (not yet shared)',
+    ],
+    [
+        'playbooks.savePlan',
+        'playbooks.saveNewHirePlan',
+        'self:write',
+        'write',
+        'Write the goals of the 30/60/90 plan for a new hire you manage',
+    ],
+    [
+        'playbooks.sharePlan',
+        'playbooks.shareNewHirePlan',
+        'self:write',
+        'write',
+        'Share the 30/60/90 plan with the new hire you manage',
     ],
     [
-        'onboarding.completeTodo',
-        'onboarding.completeTodo',
+        'playbooks.setPlanGoal',
+        'playbooks.setNewHirePlanGoal',
         'self:write',
         'write',
-        'Check off (or reopen) one of your own onboarding to-dos',
+        'Tick a goal on a shared 30/60/90 plan done, or not done',
     ],
     [
-        'onboarding.firstDaysCheckIns',
-        'onboarding.myFirstDaysCheckIns',
+        'playbooks.firstDaysCheckIns',
+        'playbooks.myFirstDaysCheckIns',
         'self:read',
         'read',
         'Your open 30, 60 or 90-day or one-year new hire check-in',
     ],
     [
-        'onboarding.answerFirstDaysCheckIn',
-        'onboarding.answerFirstDaysCheckIn',
+        'playbooks.answerFirstDaysCheckIn',
+        'playbooks.answerFirstDaysCheckIn',
         'self:write',
         'write',
         'Answer your new-hire check-in',
     ],
     [
-        'onboarding.firstDaysResults',
-        'onboarding.firstDaysResults',
-        'onboarding:read',
+        'playbooks.firstDaysResults',
+        'playbooks.firstDaysResults',
+        'playbooks:read',
         'read',
         'What new hires said in their first 90 days check-ins, combined',
     ],
     [
-        'onboarding.answerCheckIn',
-        'onboarding.answerOnboardingCheckIn',
+        'playbooks.answerCheckIn',
+        'playbooks.answerPlaybookCheckIn',
         'self:write',
         'write',
     ],
     [
-        'onboarding.respondBuddy',
-        'onboarding.respondBuddyInvitation',
+        'playbooks.respondBuddy',
+        'playbooks.respondBuddyInvitation',
         'self:write',
         'write',
     ],
     [
-        'onboarding.buddySuggestions',
-        'onboarding.buddySuggestions',
+        'playbooks.buddySuggestions',
+        'playbooks.buddySuggestions',
         'self:read',
         'read',
         'Suggest coworkers who could be your onboarding buddy',
     ],
     [
-        'onboarding.answerBuddyAsk',
-        'onboarding.answerBuddyAsk',
+        'playbooks.answerBuddyAsk',
+        'playbooks.answerBuddyAsk',
         'self:write',
         'write',
         'Say yes or not now to being a new hire’s onboarding buddy',
     ],
     [
-        'onboarding.askBuddy',
-        'onboarding.askBuddy',
+        'playbooks.askBuddy',
+        'playbooks.askBuddy',
         'self:write',
         'write',
         'Ask this coworker to be your onboarding buddy',
@@ -1011,6 +1322,13 @@ export const managementOperations = [
         'read',
         'Open a celebration card you can sign or were given',
     ],
+    [
+        'celebrations.thisWeek',
+        'milestones.celebratedThisWeek',
+        'self:read',
+        'read',
+        'List who was celebrated in a channel in the last seven days',
+    ],
     [
         'celebrations.cards',
         'milestones.myCelebrationCards',
@@ -1090,6 +1408,13 @@ export const managementOperations = [
         'read',
         'List Mello’s culture nudges for the workspace',
     ],
+    [
+        'digest.culture',
+        'digest.culture',
+        'reports:read',
+        'read',
+        'List the Culture page’s recommendations in order and what happened after each one acted on',
+    ],
     [
         'digest.nudge',
         'digest.nudge',
@@ -1288,11 +1613,11 @@ export const managementOperations = [
         'Retire or restore a Pulse question',
     ],
     [
-        'pulse.setQuestionAudience',
-        'pulse.setQuestionAudience',
+        'pulse.setQuestionGroup',
+        'pulse.setQuestionGroup',
         'pulse:write',
         'write',
-        'Aim a Pulse question at departments, teams, managers or ICs',
+        'Aim a Pulse question at one of the workspace’s groups, or at everyone',
     ],
     // #707: Mello's suggested questions. Saving drafts adds suggestions for an
     // administrator to approve, never active questions; approving is the
@@ -1332,13 +1657,6 @@ export const managementOperations = [
         'write',
         'Approve a suggested Pulse question so it is asked next, or dismiss it',
     ],
-    [
-        'pulse.audienceOptions',
-        'pulse.audienceOptions',
-        'pulse:read',
-        'read',
-        'List the departments and teams a Pulse question can be aimed at',
-    ],
     [
         'pulse.insights',
         'pulse.insights',
@@ -1486,6 +1804,13 @@ export const managementOperations = [
         'write',
         'Hide or show a praise you received',
     ],
+    [
+        'praise.setRecognition',
+        'praise.setRecognition',
+        'self:write',
+        'write',
+        'Choose whether praise for you is posted publicly or sent to you privately',
+    ],
     [
         'reminders.settings',
         'reminders.settings',
@@ -1528,4 +1853,90 @@ export const managementOperations = [
         'write',
         'Praise coworkers in a praise channel',
     ],
+    // #643: outgoing webhooks. Signing secrets are returned when an endpoint
+    // is created or its secret rolled; revealing one is session-only.
+    [
+        'webhooks.list',
+        'webhooks.list',
+        'webhooks:read',
+        'read',
+        'List webhook endpoints, their status and delivery success over 24 hours',
+    ],
+    [
+        'webhooks.catalog',
+        'webhooks.catalog',
+        'webhooks:read',
+        'read',
+        'List the webhook event types and which ones this key can subscribe to',
+    ],
+    [
+        'webhooks.get',
+        'webhooks.get',
+        'webhooks:read',
+        'read',
+        'Read one webhook endpoint',
+    ],
+    [
+        'webhooks.create',
+        'webhooks.create',
+        'webhooks:write',
+        'write',
+        'Add a webhook endpoint that receives the chosen events, and get its signing secret',
+    ],
+    [
+        'webhooks.update',
+        'webhooks.update',
+        'webhooks:write',
+        'write',
+        'Change a webhook endpoint’s URL, description or events, or turn it on or off',
+    ],
+    [
+        'webhooks.delete',
+        'webhooks.delete',
+        'webhooks:write',
+        'write',
+        'Delete a webhook endpoint and its delivery log',
+    ],
+    [
+        'webhooks.rotateSecret',
+        'webhooks.rotateSecret',
+        'webhooks:write',
+        'write',
+        'Roll a webhook endpoint’s signing secret, keeping the old one valid for a while',
+    ],
+    [
+        'webhooks.sendTest',
+        'webhooks.sendTest',
+        'webhooks:write',
+        'write',
+        'Send a webhook.test event to an endpoint now',
+    ],
+    [
+        'webhooks.deliveries.list',
+        'webhooks.deliveries',
+        'webhooks:read',
+        'read',
+        'List an endpoint’s webhook deliveries, newest first',
+    ],
+    [
+        'webhooks.deliveries.get',
+        'webhooks.delivery',
+        'webhooks:read',
+        'read',
+        'Read one webhook delivery: the request body and every attempt’s answer',
+    ],
+    [
+        'webhooks.deliveries.replay',
+        'webhooks.replay',
+        'webhooks:write',
+        'write',
+        'Resend one webhook delivery with the same event id',
+    ],
+    [
+        'webhooks.deliveries.replayFailed',
+        'webhooks.replayFailed',
+        'webhooks:write',
+        'write',
+        'Resend every failed webhook delivery of an endpoint since a time',
+    ],
 ];