@shuffl/api-contracts 0.5.0 → 0.5.2

package/dist/management.generated.js

@@ -161,6 +161,7 @@ const credentials_api_createInput = z
         z.literal('groups.sendMessage'),
         z.literal('groups.setAutomation'),
         z.literal('groups.setAutomationState'),
+        z.literal('groups.setPlaybookAutoStart'),
         z.literal('groups.suggestions'),
         z.literal('home.feed'),
         z.literal('home.places'),
@@ -264,6 +265,7 @@ const credentials_api_createInput = z
         z.literal('playbooks.firstDaysCheckIns'),
         z.literal('playbooks.firstDaysResults'),
         z.literal('playbooks.mine'),
+        z.literal('playbooks.nudge'),
         z.literal('playbooks.person'),
         z.literal('playbooks.plans'),
         z.literal('playbooks.previewEnrollment'),
@@ -1045,6 +1047,10 @@ const exports_teamOutput = z.strictObject({
                     .union([z.null(), z.string()])
                     .optional()
                     .optional(),
+                autoStartPaused: z
+                    .union([z.literal(false), z.literal(true)])
+                    .optional()
+                    .optional(),
                 buddy: z
                     .union([z.literal(false), z.literal(true)])
                     .optional()
@@ -2112,6 +2118,7 @@ const credentials_api_listOutput = z.strictObject({
             z.literal('groups.sendMessage'),
             z.literal('groups.setAutomation'),
             z.literal('groups.setAutomationState'),
+            z.literal('groups.setPlaybookAutoStart'),
             z.literal('groups.suggestions'),
             z.literal('home.feed'),
             z.literal('home.places'),
@@ -2215,6 +2222,7 @@ const credentials_api_listOutput = z.strictObject({
             z.literal('playbooks.firstDaysCheckIns'),
             z.literal('playbooks.firstDaysResults'),
             z.literal('playbooks.mine'),
+            z.literal('playbooks.nudge'),
             z.literal('playbooks.person'),
             z.literal('playbooks.plans'),
             z.literal('playbooks.previewEnrollment'),
@@ -2540,6 +2548,7 @@ const credentials_api_listOutput = z.strictObject({
             z.literal('groups.sendMessage'),
             z.literal('groups.setAutomation'),
             z.literal('groups.setAutomationState'),
+            z.literal('groups.setPlaybookAutoStart'),
             z.literal('groups.suggestions'),
             z.literal('home.feed'),
             z.literal('home.places'),
@@ -2643,6 +2652,7 @@ const credentials_api_listOutput = z.strictObject({
             z.literal('playbooks.firstDaysCheckIns'),
             z.literal('playbooks.firstDaysResults'),
             z.literal('playbooks.mine'),
+            z.literal('playbooks.nudge'),
             z.literal('playbooks.person'),
             z.literal('playbooks.plans'),
             z.literal('playbooks.previewEnrollment'),
@@ -5120,6 +5130,40 @@ const groups_allAutomationsOutput = z.strictObject({
         trigger: z.union([z.literal('entered'), z.literal('left')]),
         updatedAt: z.iso.datetime({ offset: true }),
     })),
+    playbookStarts: z.array(z.strictObject({
+        group: z.union([
+            z.null(),
+            z.strictObject({
+                id: z.string(),
+                kind: z.union([z.literal('dynamic'), z.literal('list')]),
+                members: z.number(),
+                name: z.string(),
+            }),
+        ]),
+        lastRunAt: z.union([z.null(), z.iso.datetime({ offset: true })]),
+        playbook: z.strictObject({
+            id: z.string(),
+            name: z.string(),
+            status: z.union([
+                z.literal('active'),
+                z.literal('archived'),
+                z.literal('paused'),
+            ]),
+        }),
+        runs: z.number(),
+        runs30: z.number(),
+        state: z.union([z.literal('active'), z.literal('paused')]),
+    })),
+    programRosters: z.array(z.strictObject({
+        group: z.strictObject({
+            id: z.string(),
+            kind: z.union([z.literal('dynamic'), z.literal('list')]),
+            members: z.number(),
+            name: z.string(),
+        }),
+        program: z.strictObject({ id: z.string(), name: z.string() }),
+        state: z.union([z.literal('active'), z.literal('paused')]),
+    })),
     runs: z.array(z.strictObject({
         at: z.iso.datetime({ offset: true }),
         automationId: z.string(),
@@ -5351,6 +5395,34 @@ const groups_setAutomationStateOutput = z.object({
     })
         .nullable(),
 });
+const groups_setPlaybookAutoStartInput = z
+    .strictObject({
+    groupId: z.union([z.null(), z.string()]).optional().optional(),
+    programId: z.string(),
+    state: z.union([
+        z.literal('active'),
+        z.literal('off'),
+        z.literal('paused'),
+    ]),
+})
+    .extend({
+    confirm: z.literal('groups.setPlaybookAutoStart'),
+    requestKey: z.string().min(1).max(128),
+});
+const groups_setPlaybookAutoStartOutput = z.object({
+    receipt: commandReceiptSchema,
+    result: z
+        .strictObject({
+        changed: z.boolean(),
+        id: z.string(),
+        state: z.union([
+            z.literal('active'),
+            z.literal('off'),
+            z.literal('paused'),
+        ]),
+    })
+        .nullable(),
+});
 const groups_removeAutomationInput = z.strictObject({ id: z.string() }).extend({
     confirm: z.literal('groups.removeAutomation'),
     requestKey: z.string().min(1).max(128),
@@ -8934,6 +9006,10 @@ const reports_overviewOutput = z.strictObject({
                     .union([z.null(), z.string()])
                     .optional()
                     .optional(),
+                autoStartPaused: z
+                    .union([z.literal(false), z.literal(true)])
+                    .optional()
+                    .optional(),
                 buddy: z
                     .union([z.literal(false), z.literal(true)])
                     .optional()
@@ -9487,6 +9563,10 @@ const playbooks_programOutput = z.strictObject({
             .optional()
             .optional(),
         autoStartGroupId: z.union([z.null(), z.string()]).optional().optional(),
+        autoStartPaused: z
+            .union([z.literal(false), z.literal(true)])
+            .optional()
+            .optional(),
         buddy: z
             .union([z.literal(false), z.literal(true)])
             .optional()
@@ -9596,6 +9676,12 @@ const playbooks_programOutput = z.strictObject({
             .optional(),
         timezone: z.string(),
     }),
+    hires: z.strictObject({
+        active: z.number(),
+        askedForHelp: z.number(),
+        onTime: z.union([z.null(), z.number()]),
+        overdue: z.number(),
+    }),
     intro: z.string(),
     program: z.strictObject({
         id: z.string(),
@@ -9655,6 +9741,36 @@ const playbooks_programOutput = z.strictObject({
                 total: z.number(),
             }),
         ]),
+        progress: z.union([
+            z.null(),
+            z.strictObject({
+                day: z.number(),
+                done: z.number(),
+                help: z.boolean(),
+                next: z.union([
+                    z.null(),
+                    z.strictObject({
+                        at: z.union([z.null(), z.iso.datetime({ offset: true })]),
+                        title: z.string(),
+                    }),
+                ]),
+                overdue: z.array(z.strictObject({
+                    count: z.number(),
+                    nudgedAt: z.union([z.null(), z.iso.datetime({ offset: true })]),
+                    ownerId: z.string(),
+                    ownerName: z.string(),
+                    role: z.union([
+                        z.literal('buddy'),
+                        z.literal('hire'),
+                        z.literal('manager'),
+                        z.literal('other'),
+                    ]),
+                    since: z.iso.datetime({ offset: true }),
+                })),
+                total: z.number(),
+                unconfirmed: z.number(),
+            }),
+        ]),
         removalReason: z.union([
             z.null(),
             z.literal('access_suspended'),
@@ -9762,6 +9878,10 @@ const playbooks_saveProgramInput = z
                 .optional()
                 .optional(),
             autoStartGroupId: z.union([z.null(), z.string()]).optional().optional(),
+            autoStartPaused: z
+                .union([z.literal(false), z.literal(true)])
+                .optional()
+                .optional(),
             buddy: z
                 .union([z.literal(false), z.literal(true)])
                 .optional()
@@ -9961,6 +10081,10 @@ const playbooks_saveProgramOutput = z.object({
                     .union([z.null(), z.string()])
                     .optional()
                     .optional(),
+                autoStartPaused: z
+                    .union([z.literal(false), z.literal(true)])
+                    .optional()
+                    .optional(),
                 buddy: z
                     .union([z.literal(false), z.literal(true)])
                     .optional()
@@ -10599,6 +10723,29 @@ const playbooks_retryOutput = z.object({
     receipt: commandReceiptSchema,
     result: z.strictObject({ status: z.literal('scheduled') }).nullable(),
 });
+const playbooks_nudgeInput = z
+    .strictObject({ enrollmentId: z.string(), ownerPersonId: z.string() })
+    .extend({
+    confirm: z.literal('playbooks.nudge'),
+    requestKey: z.string().min(1).max(128),
+});
+const playbooks_nudgeOutput = z.object({
+    receipt: commandReceiptSchema,
+    result: z
+        .strictObject({
+        nudgedAt: z.union([z.null(), z.iso.datetime({ offset: true })]),
+        status: z.union([
+            z.literal('failed'),
+            z.literal('no_slack'),
+            z.literal('nothing_overdue'),
+            z.literal('off'),
+            z.literal('recent'),
+            z.literal('sent'),
+        ]),
+        todos: z.number(),
+    })
+        .nullable(),
+});
 const playbooks_mineInput = z.strictObject({});
 const playbooks_mineOutput = z.union([
     z.strictObject({
@@ -17193,7 +17340,7 @@ export const managementContract = {
             .route({
             method: 'POST',
             path: '/manage/groups/allAutomations',
-            summary: 'Every group automation in the workspace with its group and last runs, or only those that start one playbook, program or community',
+            summary: 'Every join and leave rule in the workspace: group automations with their group and last runs, playbooks that start on each start date and Connections programs whose people are a group; or only those that start one playbook, program or community',
         })
             .input(groups_allAutomationsInput)
             .output(groups_allAutomationsOutput),
@@ -17395,6 +17542,15 @@ export const managementContract = {
         })
             .input(groups_setAutomationStateInput)
             .output(groups_setAutomationStateOutput),
+        setPlaybookAutoStart: base
+            .meta({ scope: 'users:write' })
+            .route({
+            method: 'POST',
+            path: '/manage/groups/setPlaybookAutoStart',
+            summary: 'Turn on, pause or remove a playbook’s rule that starts it on each new hire’s start date, for everyone or one group',
+        })
+            .input(groups_setPlaybookAutoStartInput)
+            .output(groups_setPlaybookAutoStartOutput),
         suggestions: base
             .meta({ scope: 'users:read' })
             .route({
@@ -18299,6 +18455,15 @@ export const managementContract = {
         })
             .input(playbooks_mineInput)
             .output(playbooks_mineOutput),
+        nudge: base
+            .meta({ scope: 'playbooks:write' })
+            .route({
+            method: 'POST',
+            path: '/manage/playbooks/nudge',
+            summary: 'Send someone one Slack nudge about a hire’s overdue playbook to-dos, at most once a day',
+        })
+            .input(playbooks_nudgeInput)
+            .output(playbooks_nudgeOutput),
         person: base
             .meta({ scope: 'playbooks:read' })
             .route({

package/dist/permissions.d.ts

@@ -120,6 +120,7 @@ export declare const permissionSchema: z.ZodEnum<{
     "groups.sendMessage": "groups.sendMessage";
     "groups.setAutomation": "groups.setAutomation";
     "groups.setAutomationState": "groups.setAutomationState";
+    "groups.setPlaybookAutoStart": "groups.setPlaybookAutoStart";
     "groups.suggestions": "groups.suggestions";
     "home.feed": "home.feed";
     "home.places": "home.places";
@@ -223,6 +224,7 @@ export declare const permissionSchema: z.ZodEnum<{
     "playbooks.firstDaysCheckIns": "playbooks.firstDaysCheckIns";
     "playbooks.firstDaysResults": "playbooks.firstDaysResults";
     "playbooks.mine": "playbooks.mine";
+    "playbooks.nudge": "playbooks.nudge";
     "playbooks.person": "playbooks.person";
     "playbooks.plans": "playbooks.plans";
     "playbooks.previewEnrollment": "playbooks.previewEnrollment";
@@ -500,6 +502,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
         "groups.sendMessage": "groups.sendMessage";
         "groups.setAutomation": "groups.setAutomation";
         "groups.setAutomationState": "groups.setAutomationState";
+        "groups.setPlaybookAutoStart": "groups.setPlaybookAutoStart";
         "groups.suggestions": "groups.suggestions";
         "home.feed": "home.feed";
         "home.places": "home.places";
@@ -603,6 +606,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
         "playbooks.firstDaysCheckIns": "playbooks.firstDaysCheckIns";
         "playbooks.firstDaysResults": "playbooks.firstDaysResults";
         "playbooks.mine": "playbooks.mine";
+        "playbooks.nudge": "playbooks.nudge";
         "playbooks.person": "playbooks.person";
         "playbooks.plans": "playbooks.plans";
         "playbooks.previewEnrollment": "playbooks.previewEnrollment";