@shuffl/api-contracts 0.1.0

package/dist/index.js

@@ -0,0 +1,329 @@
+import { z } from 'zod';
+import { base } from './base.js';
+import { commandReceiptSchema, managementContract, } from './management.generated.js';
+import { permissionDefinitionSchema, permissionSchema } from './permissions.js';
+import { fineTuneSchema, keepApartSchema, profileSchema, programInput, programPatch, } from './schemas.js';
+export { adminScopes, scopeSchema, scopes } from './base.js';
+export { alwaysAllowedPermissions, grantedPermissions, permissionById, permissionCatalog, permissionDefinitionSchema, permissionIds, permissionSchema, permitsOperation, protocolPermissionIds, scopesForPermissions, } from './permissions.js';
+const id = z.string().min(1).max(128);
+const identifier = z.object({ id });
+export const citationSchema = z.object({
+    href: z.string(),
+    kind: z.enum(['knowledge', 'manager', 'directory']).optional(),
+    passageId: z.string(),
+    quote: z.string(),
+    sourceId: z.string(),
+    title: z.string(),
+    versionId: z.string(),
+});
+const pagination = z.object({
+    cursor: id.optional(),
+    limit: z.number().int().min(1).max(100).default(25),
+});
+export const userSchema = z.object({
+    active: z.boolean(),
+    bot: z.boolean(),
+    email: z.string().nullable(),
+    id,
+    name: z.string(),
+    profile: profileSchema,
+});
+export const programSchema = programInput.extend({
+    createdAt: z.iso.datetime(),
+    id,
+    matchingReviewRequired: z.boolean(),
+    nextRunAt: z.iso.datetime(),
+    revision: z.number().int().positive(),
+    status: z.enum(['active', 'paused', 'archived']),
+    summary: z
+        .string()
+        .optional()
+        .describe('What the program does, in the same sentence the editor shows.'),
+    workspaceId: id,
+});
+const choice = (value) => z.object({ description: z.string().optional(), label: z.string(), value });
+export const programOptionsSchema = z.object({
+    defaults: z.object({
+        fineTune: fineTuneSchema,
+        keepApart: keepApartSchema,
+        strategy: z.literal('new-connections'),
+    }),
+    fineTune: z.object({
+        commonGround: z.array(choice(z.number().int())),
+        meetRequests: z.string(),
+        mentionCommonGround: z.string(),
+        reach: z.array(choice(z.string())),
+    }),
+    keepApart: z.array(choice(z.string())),
+    purposes: z.array(choice(z.string())),
+    units: z.array(z.object({ id, kind: z.enum(['department', 'team']), name: z.string() })),
+});
+export const previewSchema = z.object({
+    algorithm: z.string(),
+    eligible: z.number(),
+    exclusions: z.array(z.object({
+        count: z.number().int().nonnegative(),
+        reason: z.enum([
+            'bot',
+            'inactive',
+            'absent',
+            'paused',
+            'slack_unavailable',
+            'access_unavailable',
+        ]),
+    })),
+    fingerprint: z.string(),
+    groups: z.array(z.array(id)),
+    members: z.array(z.object({ id, name: z.string() })),
+    newConnections: z.number(),
+    pairWeight: z.number(),
+    revision: z.number().int(),
+    selected: z.number(),
+    unmatched: z.array(id),
+});
+const page = (item) => z.object({ items: z.array(item), nextCursor: id.nullable() });
+export const contract = {
+    ...managementContract,
+    channels: {
+        list: base
+            .meta({ scope: 'programs:read' })
+            .route({
+            method: 'GET',
+            path: '/channels',
+            summary: 'List Slack channels available to Shuffl',
+        })
+            .output(z.array(z.object({
+            id,
+            isMember: z.boolean(),
+            isPrivate: z.boolean(),
+            name: z.string(),
+            readiness: z.enum(['ready', 'invite_required', 'missing_scope']),
+        }))),
+    },
+    commands: {
+        get: base
+            .route({
+            method: 'GET',
+            path: '/commands/{id}',
+            summary: 'Read your own management command receipt',
+        })
+            .input(z.strictObject({ id: z.string().uuid() }))
+            .output(commandReceiptSchema),
+    },
+    knowledge: {
+        ...managementContract.knowledge,
+        context: base
+            .meta({ scope: 'knowledge:read' })
+            .route({
+            method: 'POST',
+            path: '/knowledge/context',
+            summary: 'Read nearby passages from the same currently approved version',
+        })
+            .input(z.strictObject({
+            passageId: z.string().regex(/^passage-[1-9]\d{0,2}$/),
+            sourceId: z.string().uuid(),
+            versionId: z.string().uuid(),
+        }))
+            .output(z.array(citationSchema).max(3)),
+        search: base
+            .meta({ scope: 'knowledge:read' })
+            .route({
+            method: 'POST',
+            path: '/knowledge/search',
+            summary: 'Search currently approved knowledge and return immutable passage citations',
+        })
+            .input(z.strictObject({ query: z.string().trim().min(2).max(500) }))
+            .output(z.array(citationSchema).max(8)),
+    },
+    manager: {
+        current: base
+            .meta({ scope: 'manager:read' })
+            .route({
+            method: 'GET',
+            path: '/manager',
+            summary: 'Read the authenticated employee’s own manager context',
+        })
+            .output(citationSchema.nullable()),
+    },
+    permissions: {
+        list: base
+            .route({
+            method: 'GET',
+            path: '/permissions',
+            summary: 'Discover endpoint permissions available to this token',
+        })
+            .output(z.object({
+            catalog: z.array(permissionDefinitionSchema.extend({
+                grantable: z.boolean(),
+                granted: z.boolean(),
+            })),
+            permissions: z.array(permissionSchema),
+        })),
+    },
+    programs: {
+        ...managementContract.programs,
+        archive: base
+            .meta({ scope: 'programs:write' })
+            .route({
+            method: 'POST',
+            path: '/programs/{id}/archive',
+            summary: 'Archive a program',
+        })
+            .input(identifier)
+            .output(programSchema),
+        create: base
+            .meta({ scope: 'programs:write' })
+            .route({
+            method: 'POST',
+            path: '/programs',
+            summary: 'Create a program; reuse requestKey only for the same request',
+        })
+            .input(z.object({
+            draft: z.boolean().default(true),
+            program: programInput,
+            requestKey: z.string().min(8).max(120),
+        }))
+            .output(programSchema),
+        get: base
+            .meta({ scope: 'programs:read' })
+            .route({
+            method: 'GET',
+            path: '/programs/{id}',
+            summary: 'Get a program',
+        })
+            .input(identifier)
+            .output(programSchema),
+        list: base
+            .meta({ scope: 'programs:read' })
+            .route({ method: 'GET', path: '/programs', summary: 'List programs' })
+            .input(pagination)
+            .output(page(programSchema)),
+        options: base
+            .meta({ scope: 'programs:read' })
+            .route({
+            method: 'GET',
+            path: '/program-options',
+            summary: 'List the choices for a Connections program: who should meet whom, keep-apart rules, fine-tuning, defaults, teams and departments',
+        })
+            .input(z.object({}))
+            .output(programOptionsSchema),
+        pause: base
+            .meta({ scope: 'programs:write' })
+            .route({
+            method: 'POST',
+            path: '/programs/{id}/pause',
+            summary: 'Pause a program',
+        })
+            .input(identifier)
+            .output(programSchema),
+        preview: base
+            .meta({ scope: 'programs:read' })
+            .route({
+            method: 'POST',
+            path: '/programs/{id}/preview',
+            summary: 'Preview matches without sending introductions',
+        })
+            .input(z.object({ id, seed: z.string().min(1).max(128) }))
+            .output(previewSchema),
+        resume: base
+            .meta({ scope: 'programs:write' })
+            .route({
+            method: 'POST',
+            path: '/programs/{id}/resume',
+            summary: 'Activate a program and its schedule',
+        })
+            .input(identifier)
+            .output(programSchema),
+        syncRoster: base
+            .meta({ scope: 'programs:write' })
+            .route({
+            method: 'POST',
+            path: '/programs/{id}/sync-roster',
+            summary: 'Refresh program channel membership',
+        })
+            .input(identifier)
+            .output(z.object({ synced: z.boolean() })),
+        update: base
+            .meta({ scope: 'programs:write' })
+            .route({
+            method: 'PUT',
+            path: '/programs/{id}',
+            summary: 'Update a program at an expected revision',
+        })
+            .input(z.object({
+            expectedRevision: z
+                .number()
+                .int()
+                .positive()
+                .optional()
+                .describe('The revision you read. When given, the update is refused if the program changed since.'),
+            id,
+            program: programPatch.describe('Only the fields to change. match, match.fineTune and schedule merge field by field; keepApart or fineTune null removes it.'),
+            reviewMatching: z.boolean().optional(),
+        }))
+            .output(programSchema),
+    },
+    runs: {
+        ...managementContract.runs,
+        get: base
+            .meta({ scope: 'runs:read' })
+            .route({
+            method: 'GET',
+            path: '/runs/{id}',
+            summary: 'Get the durable status of a run',
+        })
+            .input(identifier)
+            .output(z.object({
+            createdAt: z.iso.datetime(),
+            id,
+            programId: id,
+            reason: z.string().nullable(),
+            status: z.string(),
+        })),
+        request: base
+            .meta({ scope: 'runs:write' })
+            .route({
+            method: 'POST',
+            path: '/runs',
+            summary: 'Queue introductions using a preview and idempotent request key',
+        })
+            .input(z.object({
+            preview: z.object({
+                fingerprint: z.string().length(64),
+                revision: z.number().int().positive(),
+                seed: z.string().min(1).max(128),
+            }),
+            programId: id,
+            requestKey: z.string().min(8).max(120),
+        }))
+            .output(z.object({ id, status: z.string() })),
+    },
+    users: {
+        ...managementContract.users,
+        get: base
+            .meta({ scope: 'users:read' })
+            .route({ method: 'GET', path: '/users/{id}', summary: 'Get a person' })
+            .input(identifier)
+            .output(userSchema),
+        list: base
+            .meta({ scope: 'users:read' })
+            .route({
+            method: 'GET',
+            path: '/users',
+            summary: 'List people in this workspace',
+        })
+            .input(pagination.extend({ search: z.string().trim().max(100).optional() }))
+            .output(page(userSchema)),
+    },
+    workspaces: {
+        ...managementContract.workspaces,
+        current: base
+            .meta({ scope: null })
+            .route({
+            method: 'GET',
+            path: '/workspace',
+            summary: 'Get the workspace bound to this token',
+        })
+            .output(z.object({ id, name: z.string(), role: z.string() })),
+    },
+};

package/dist/management-operations.d.ts

@@ -0,0 +1 @@
+export declare const managementOperations: readonly [readonly ['runs.dispatch', 'management.dispatchRun', 'runs:write', 'write', 'Dispatch this queued introduction run'], readonly ['operations.dispatchInbox', 'management.dispatchInbox', 'operations:write', 'write', 'Resume already-admitted workspace provider events and support delivery'], readonly ['hr.deliver', 'management.deliverHr', 'hr:write', 'write', 'Deliver your HR reply to the employee'], readonly ['assistant.send', 'management.sendAssistant', 'assistant:write', 'write'], readonly ['credentials.api.create', 'management.createApiToken', 'credentials:write', 'write', 'Delegate a subset of this credential with bounded expiry and inherited revocation'], readonly ['invitations.create', 'management.invite', 'access:write', 'write', 'Invite this person with the selected workspace role'], readonly ['invitations.list', 'management.invitations', 'access:read', 'read'], readonly ['invitations.cancel', 'management.cancelInvitation', 'access:write', 'write'], readonly ['exports.workspace', 'management.export', 'exports:read', 'read'], readonly ['knowledge.uploads.create', 'management.createPdfUpload', 'knowledge:write', 'write'], readonly ['knowledge.uploads.appendPart', 'management.uploadPdfPart', 'knowledge:write', 'write'], readonly ['knowledge.uploads.complete', 'management.completePdfUpload', 'knowledge:write', 'write'], readonly ['knowledge.uploads.retry', 'management.retryPdfUpload', 'knowledge:write', 'write'], readonly ['knowledge.uploads.get', 'management.pdfUpload', 'knowledge:write', 'read'], readonly ['knowledge.sources.importWebsite', 'management.importWebsite', 'knowledge:write', 'write'], readonly ['provisioning.current', 'management.provisioning', 'integrations:read', 'read'], readonly ['sync.current', 'directory.directorySync', 'integrations:read', 'read'], readonly ['sync.connect', 'directory.connectDirectoryProvider', 'integrations:write', 'write', 'Connect a directory sync provider with the credential given'], readonly ['sync.run', 'directory.syncDirectoryConnection', 'integrations:write', 'write'], readonly ['sync.disconnect', 'directory.disconnectDirectoryProvider', 'integrations:write', 'write', 'Disconnect this directory sync provider'], readonly ['sync.request', 'directory.requestDirectorySource', 'integrations:write', 'write'], readonly ['provisioning.configure', 'management.configureProvisioning', 'integrations:write', 'write', 'Change provisioning credentials or employee access policy'], readonly ['credentials.api.list', 'management.apiTokens', 'credentials:read', 'read'], readonly ['credentials.api.revoke', 'management.revokeApiToken', 'credentials:write', 'write'], readonly ['assistant.conversations', 'management.conversations', 'assistant:read', 'read'], readonly ['assistant.history', 'management.conversation', 'assistant:read', 'read'], readonly ['assistant.stop', 'management.stopAnswer', 'assistant:write', 'write'], readonly ['assistant.delete', 'management.deleteConversation', 'assistant:write', 'write'], readonly ['integrations.authorize', 'management.authorizeIntegration', 'integrations:write', 'read'], readonly ['users.details', 'directory.directoryPerson', 'users:read', 'read'], readonly ['users.page', 'people.peoplePage', 'users:read', 'read'], readonly ['users.filterOptions', 'people.peopleFilterOptions', 'users:read', 'read'], readonly ['users.participants', 'people.participants', 'users:read', 'read'], readonly ['users.managers', 'directory.directoryManagers', 'users:read', 'read'], readonly ['users.managerHistory', 'directory.managerHistory', 'users:read', 'read'], readonly ['users.save', 'directory.saveDirectoryPerson', 'users:write', 'write'], readonly ['users.participation', 'people.participation', 'participation:write', 'write'], readonly ['users.profile', 'people.profile', 'profile:write', 'write'], readonly ['timeOff.balances', 'people.timeOffBalances', 'self:read', 'read', 'Read your own time-off balances from the connected HR system'], readonly ['profiles.get', 'profiles.profile', 'users:read', 'read', 'Read a person’s profile as this workspace sees it'], readonly ['profiles.save', 'profiles.saveProfile', 'profile:write', 'write'], readonly ['profiles.settings', 'profiles.saveSettings', 'profile:write', 'write', 'Choose who sees the optional parts of your own profile'], readonly ['profiles.positions.save', 'profiles.savePosition', 'profile:write', 'write'], readonly ['profiles.positions.delete', 'profiles.deletePosition', 'profile:write', 'write'], readonly ['profiles.photo.delete', 'profiles.deletePhoto', 'profile:write', 'write'], readonly ['profiles.cover.delete', 'profiles.deleteCover', 'profile:write', 'write'], readonly ['profiles.draft', 'profiles.draft', 'profile:write', 'write', 'Draft the empty parts of your own profile with Mello; nothing is saved'], readonly ['profiles.employeeNumber', 'profiles.setEmployeeNumber', 'users:write', 'write', 'Set a person’s employee number to an unused number'], readonly ['badges.list', 'badges.list', 'users:read', 'read', 'List the workspace’s badges, who holds them and any open requests you decide'], readonly ['badges.ofPerson', 'badges.ofPerson', 'users:read', 'read'], readonly ['badges.save', 'badges.save', 'profile:write', 'write', 'Create or edit a badge you own'], readonly ['badges.award', 'badges.award', 'profile:write', 'write', 'Give a badge you own to a person'], readonly ['badges.revoke', 'badges.revoke', 'profile:write', 'write'], readonly ['badges.claim', 'badges.claim', 'profile:write', 'write', 'Claim a badge with its code'], readonly ['badges.request', 'badges.request', 'profile:write', 'write'], readonly ['badges.decideRequest', 'badges.decideRequest', 'profile:write', 'write'], readonly ['badges.hideOwn', 'badges.hideOwn', 'profile:write', 'write'], readonly ['badges.setHidden', 'badges.setHidden', 'users:write', 'write'], readonly ['communities.list', 'communities.list', 'users:read', 'read', 'List communities with the members you may see'], readonly ['communities.members', 'communities.members', 'users:read', 'read'], readonly ['communities.ofPerson', 'communities.ofPerson', 'users:read', 'read'], readonly ['communities.save', 'communities.save', 'profile:write', 'write', 'Create or edit a community, optionally tied to a Slack channel'], readonly ['communities.join', 'communities.join', 'profile:write', 'write'], readonly ['communities.leave', 'communities.leave', 'profile:write', 'write'], readonly ['communities.setVisibility', 'communities.setVisibility', 'profile:write', 'write'], readonly ['communities.archive', 'communities.archive', 'profile:write', 'write'], readonly ['communities.removeMember', 'communities.removeMember', 'profile:write', 'write', 'Remove someone from a community, as its owner or moderator'], readonly ['communities.sync', 'communities.sync', 'profile:write', 'write'], readonly ['home.feed', 'home.feed', 'self:read', 'read', 'What happened to people you know, and who Mello thinks you should meet'], readonly ['network.orgChart', 'network.orgChart', 'users:read', 'read', 'Everyone in the workspace with their manager, for the org chart'], readonly ['network.mine', 'network.mine', 'users:read', 'read', 'Who you know and who you should meet'], readonly ['network.ofPerson', 'network.ofPerson', 'users:read', 'read', 'People you and this person both know'], readonly ['network.claim', 'network.claim', 'profile:write', 'write', 'Say you know someone or would like to meet them'], readonly ['users.blockPair', 'people.blockPair', 'users:write', 'write'], readonly ['users.blockedPairs', 'people.blockedPairs', 'users:read', 'read'], readonly ['units.list', 'directory.directoryUnits', 'users:read', 'read'], readonly ['units.save', 'directory.saveDirectoryUnit', 'users:write', 'write'], readonly ['units.archive', 'directory.archiveDirectoryUnit', 'users:write', 'write'], readonly ['access.get', 'directory.employeeAccess', 'access:read', 'read'], readonly ['access.save', 'directory.saveEmployeeAccess', 'access:write', 'write', 'Change employee product access'], readonly ['access.saveRole', 'directory.saveWorkspaceRole', 'access:write', 'write', 'Change a member’s workspace role'], readonly ['identities.list', 'identities.personAccounts', 'identities:read', 'read'], readonly ['identities.slackAccounts', 'identities.slackAccounts', 'identities:read', 'read'], readonly ['identities.webAccounts', 'identities.webAccounts', 'identities:read', 'read'], readonly ['identities.linkSlack', 'identities.linkSlackAccount', 'identities:write', 'write', 'Link a verified Slack account'], readonly ['identities.linkWeb', 'identities.linkWebAccount', 'identities:write', 'write', 'Link a verified web account'], readonly ['identities.unlink', 'identities.unlinkPersonAccount', 'identities:write', 'write', 'Revoke an employee identity link'], readonly ['programs.schedulePreview', 'programs.schedulePreview', 'programs:read', 'read'], readonly ['programs.people', 'programs.people', 'programs:read', 'read'], readonly ['runs.list', 'runs.roundsPage', 'runs:read', 'read'], readonly ['runs.details', 'runs.run', 'runs:read', 'read'], readonly ['runs.retry', 'runs.retry', 'runs:write', 'write', 'Retry introduction delivery'], readonly ['knowledge.sources.list', 'knowledge.list', 'knowledge:manage', 'read'], readonly ['knowledge.sources.get', 'knowledge.read', 'knowledge:manage', 'read'], readonly ['knowledge.policies.coverage', 'knowledge.policyCoverage', 'knowledge:manage', 'read'], readonly ['knowledge.sources.history', 'knowledge.history', 'knowledge:manage', 'read'], readonly ['knowledge.sources.search', 'knowledge.search', 'knowledge:read', 'read'], readonly ['knowledge.sources.save', 'knowledge.save', 'knowledge:write', 'write'], readonly ['knowledge.sources.publish', 'knowledge.publish', 'knowledge:write', 'write', 'Publish this knowledge version to its audience'], readonly ['knowledge.sources.changeAudience', 'knowledge.changeAudience', 'knowledge:write', 'write', 'Change who can read this knowledge source'], readonly ['knowledge.sources.withdraw', 'knowledge.withdraw', 'knowledge:write', 'write'], readonly ['knowledge.sources.archive', 'knowledge.archive', 'knowledge:write', 'write', 'Archive an unpublished knowledge source'], readonly ['knowledge.sources.restore', 'knowledge.restore', 'knowledge:write', 'write', 'Restore an archived knowledge source'], readonly ['knowledge.connections.list', 'knowledge.connections', 'integrations:read', 'read'], readonly ['knowledge.connections.disconnect', 'knowledge.disconnect', 'integrations:write', 'write', 'Disconnect a knowledge provider'], readonly ['knowledge.sources.importConnected', 'knowledge.importConnected', 'knowledge:write', 'write', 'Import a document from a connected Knowledge source'], readonly ['knowledge.connections.browse', 'knowledge.browseConnected', 'integrations:read', 'read', 'List documents a connected Knowledge source can see'], readonly ['knowledge.connections.connect', 'knowledge.connectProvider', 'integrations:write', 'write', 'Connect a Knowledge provider with a token'], readonly ['knowledge.sources.refresh', 'knowledge.refreshSource', 'knowledge:write', 'write'], readonly ['hr.list', 'hrRequests.hrRequests', 'hr:read', 'read'], readonly ['hr.get', 'hrRequests.hrRequest', 'hr:read', 'read'], readonly ['hr.readiness', 'hrRequests.hrReadiness', 'hr:read', 'read'], readonly ['hr.settings', 'hrRequests.hrSettings', 'hr:read', 'read'], readonly ['hr.shareSources', 'hrRequests.hrShareSources', 'hr:read', 'read'], readonly ['hr.command', 'hrRequests.commandHrRequest', 'hr:write', 'write'], readonly ['hr.configure', 'hrRequests.configureHrDestination', 'hr:write', 'write', 'Change the HR request destination'], readonly ['hr.share', 'hrRequests.shareHrRequest', 'hr:write', 'write', 'Share this request with the selected HR responders'], readonly ['hr.retryDelivery', 'hrRequests.retryHrDelivery', 'hr:write', 'write', 'Retry HR request delivery'], readonly ['support.list', 'support.support', 'support:read', 'read'], readonly ['support.get', 'support.supportThread', 'support:read', 'read'], readonly ['support.create', 'support.createSupport', 'support:write', 'write'], readonly ['support.reply', 'support.reply', 'support:write', 'write'], readonly ['support.close', 'support.closeSupport', 'support:write', 'write'], readonly ['support.assign', 'support.assignSupport', 'support:write', 'write'], readonly ['billing.legacy', 'billing.billing', 'billing:read', 'read'], readonly ['billing.current', 'billing.companyBilling', 'billing:read', 'read'], readonly ['billing.initialize', 'billing.initializeCompanyBilling', 'billing:write', 'write'], readonly ['billing.refresh', 'billing.refreshCompanyBilling', 'billing:write', 'write'], readonly ['billing.activateTrial', 'billing.activateCompanyTrial', 'billing:write', 'write', 'Activate the company trial'], readonly ['billing.checkout', 'billing.companyCheckout', 'billing:write', 'write', 'Open checkout for the company subscription'], readonly ['billing.portal', 'billing.companyPortal', 'billing:write', 'write'], readonly ['billing.legacyPortal', 'billing.billingPortal', 'billing:write', 'write'], readonly ['billing.cancelSubscription', 'billing.cancelCompanySubscription', 'billing:write', 'write', 'Cancel the company subscription'], readonly ['operations.activity', 'operations.activity', 'operations:read', 'read'], readonly ['operations.status', 'operations.operations', 'operations:read', 'read'], readonly ['operations.reconcile', 'operations.reconcile', 'operator:write', 'write', 'Reconcile an externally verified delivery outcome'], readonly ['reports.overview', 'reporting.overview', 'reports:read', 'read'], readonly ['reports.connections', 'reporting.connectionsInsights', 'reports:read', 'read'], readonly ['reports.onboarding', 'reporting.onboardingInsights', 'reports:read', 'read'], readonly ['workspaces.status', 'workspaces.workspaceStatus', 'workspace:write', 'write'], readonly ['workspaces.setup', 'setup.setup', 'workspace:read', 'read'], readonly ['workspaces.initialize', 'workspaces.initialize', 'workspace:write', 'write'], readonly ['onboarding.program', 'onboarding.onboardingProgram', 'onboarding:read', 'read'], readonly ['onboarding.saveProgram', 'onboarding.saveOnboardingProgram', 'onboarding:write', 'write', 'Save the onboarding program and its messages'], readonly ['onboarding.candidates', 'onboarding.onboardingCandidates', 'onboarding:read', 'read'], readonly ['onboarding.person', 'onboarding.personOnboarding', 'onboarding:read', 'read'], readonly ['onboarding.enrollmentPreview', 'onboarding.onboardingEnrollmentPreview', 'onboarding:read', 'read'], readonly ['onboarding.previewEnrollment', 'onboarding.previewOnboardingEnrollment', 'onboarding:write', 'write'], readonly ['onboarding.enroll', 'onboarding.enrollOnboarding', 'onboarding:write', 'write', 'Enroll this person in onboarding'], readonly ['onboarding.approve', 'onboarding.approveOnboardingEnrollment', 'onboarding:write', 'write', 'Approve these exact onboarding messages for sending'], readonly ['onboarding.assignBuddy', 'onboarding.assignOnboardingBuddy', 'onboarding:write', 'write'], readonly ['onboarding.update', 'onboarding.updateOnboardingEnrollment', 'onboarding:write', 'write'], readonly ['onboarding.remove', 'onboarding.removeOnboardingEnrollment', 'onboarding:write', 'write'], readonly ['onboarding.retry', 'onboarding.retryOnboardingStep', 'onboarding:write', 'write'], readonly ['onboarding.mine', 'onboarding.myOnboarding', 'self:read', 'read'], readonly ['onboarding.answerCheckIn', 'onboarding.answerOnboardingCheckIn', 'self:write', 'write'], readonly ['onboarding.respondBuddy', 'onboarding.respondBuddyInvitation', 'self:write', 'write'], readonly ['onboarding.buddySuggestions', 'onboarding.buddySuggestions', 'self:read', 'read', 'Suggest coworkers who could be your onboarding buddy'], readonly ['onboarding.askBuddy', 'onboarding.askBuddy', 'self:write', 'write', 'Ask this coworker to be your onboarding buddy'], readonly ['celebrations.program', 'milestones.celebrationProgram', 'celebrations:read', 'read'], readonly ['celebrations.save', 'milestones.saveCelebrationProgram', 'celebrations:write', 'write', 'Save celebration settings; enabling them schedules messages'], readonly ['celebrations.preview', 'milestones.previewCelebration', 'celebrations:read', 'read'], readonly ['celebrations.review', 'milestones.milestoneReview', 'celebrations:read', 'read'], readonly ['celebrations.refresh', 'milestones.refreshMilestones', 'celebrations:write', 'write'], readonly ['celebrations.deliveries', 'milestones.celebrationDeliveries', 'celebrations:read', 'read'], readonly ['celebrations.mine', 'milestones.myCelebrations', 'self:read', 'read'], readonly ['celebrations.preferences', 'milestones.milestonePreferences', 'self:read', 'read'], readonly ['celebrations.savePreferences', 'milestones.saveMilestonePreferences', 'self:write', 'write'], readonly ['notifications.preferences', 'notifications.notificationPreferences', 'self:read', 'read'], readonly ['notifications.save', 'notifications.saveNotificationPreference', 'self:write', 'write'], readonly ['reports.answerFeedback', 'reporting.answerFeedback', 'reports:read', 'read'], readonly ['reports.knowledge', 'reporting.knowledgeActivity', 'reports:read', 'read'], readonly ['reports.knowledgeSource', 'reporting.knowledgeSourceActivity', 'reports:read', 'read'], readonly ['reports.needsYou', 'reporting.needsYouInsights', 'reports:read', 'read'], readonly ['reports.people', 'reporting.peopleInsights', 'reports:read', 'read'], readonly ['knowledge.connections.requests', 'knowledge.sourceRequests', 'integrations:read', 'read'], readonly ['knowledge.connections.request', 'knowledge.requestSource', 'integrations:write', 'write'], readonly ['access.slackWaiting', 'directory.slackAccessWaiting', 'access:read', 'read'], readonly ['access.enableSlack', 'directory.enableSlackAccess', 'access:write', 'write', 'Give these Slack people employee access'], readonly ['workspaces.slackJoinAccess', 'directory.slackJoinAccess', 'workspace:read', 'read'], readonly ['workspaces.saveSlackJoinAccess', 'directory.saveSlackJoinAccess', 'workspace:write', 'write'], readonly ['workspaces.slackProfileLink', 'directory.slackProfileLink', 'workspace:read', 'read'], readonly ['workspaces.saveSlackProfileLink', 'directory.saveSlackProfileLink', 'workspace:write', 'write'], readonly ['workspaces.syncSlackProfileLinks', 'directory.syncSlackProfileLinks', 'workspace:write', 'write', 'Write the Shuffl profile link to every Slack profile again'], readonly ['workspaces.saveAgentSetup', 'setup.saveAgentSetup', 'workspace:write', 'write'], readonly ['workspaces.resendSlackWelcome', 'setup.resendSlackWelcome', 'integrations:write', 'write', 'Send the Slack install welcome to your own Slack DM again'], readonly ['users.activity', 'personActivity.personActivity', 'users:read', 'read'], readonly ['programs.joinChannel', 'programs.joinChannel', 'programs:write', 'write', 'Add Shuffl to this public Slack channel'], readonly ['hr.renameTeam', 'personRoles.renameHrTeam', 'hr:write', 'write'], readonly ['pulse.program', 'pulse.program', 'pulse:read', 'read', 'Read the Pulse settings'], readonly ['pulse.saveProgram', 'pulse.saveProgram', 'pulse:write', 'write', 'Save Pulse settings; enabling Pulse schedules questions to everyone'], readonly ['pulse.questions', 'pulse.questions', 'pulse:read', 'read', 'List the Pulse question library'], readonly ['pulse.addQuestion', 'pulse.addQuestion', 'pulse:write', 'write', 'Add a Pulse question to the library'], readonly ['pulse.addTemplate', 'pulse.addTemplate', 'pulse:write', 'write', 'Add a Pulse question set from a template'], readonly ['pulse.setQuestionStatus', 'pulse.setQuestionStatus', 'pulse:write', 'write', 'Retire or restore a Pulse question'], readonly ['pulse.insights', 'pulse.insights', 'pulse:read', 'read', 'Read Pulse totals and trends (groups of seven or more)'], readonly ['pulse.asked', 'pulse.asked', 'self:read', 'read', 'List the Pulse questions asked so far'], readonly ['pulse.today', 'pulse.today', 'self:read', 'read', 'Read today’s Pulse question'], readonly ['praise.settings', 'praise.settings', 'praise:read', 'read', 'Read the Praise settings'], readonly ['praise.saveSettings', 'praise.saveSettings', 'praise:write', 'write', 'Save the Praise settings and company values'], readonly ['praise.addChannel', 'praise.addChannel', 'praise:write', 'write', 'Read praise from this Slack channel from now on'], readonly ['praise.removeChannel', 'praise.removeChannel', 'praise:write', 'write', 'Stop reading praise from a Slack channel'], readonly ['praise.insights', 'praise.insights', 'praise:read', 'read', 'Read Praise totals by value (groups of seven or more)'], readonly ['praise.feed', 'praise.feed', 'self:read', 'read', 'Read the Praise feed'], readonly ['praise.ofPerson', 'praise.ofPerson', 'self:read', 'read', 'Read the public praise one person received'], readonly ['praise.mine', 'praise.mine', 'self:read', 'read', 'Read praise you gave and received'], readonly ['praise.setDigest', 'praise.setDigest', 'self:write', 'write', 'Choose whether you get the daily Praise digest'], readonly ['praise.setHidden', 'praise.setHidden', 'self:write', 'write', 'Hide or show a praise you received']];