@shuffl/api-contracts 0.5.3 → 0.5.5

package/dist/management.generated.js

@@ -269,6 +269,7 @@ const credentials_api_createInput = z
         z.literal('playbooks.nudge'),
         z.literal('playbooks.person'),
         z.literal('playbooks.plans'),
+        z.literal('playbooks.previewAs'),
         z.literal('playbooks.previewEnrollment'),
         z.literal('playbooks.program'),
         z.literal('playbooks.remove'),
@@ -1108,7 +1109,19 @@ const exports_teamOutput = z.strictObject({
                         z.literal('message'),
                         z.literal('task'),
                     ]),
+                    meet: z
+                        .union([
+                        z.literal('manager'),
+                        z.literal('person'),
+                        z.literal('skip_level'),
+                        z.literal('teammates'),
+                    ])
+                        .optional()
+                        .optional(),
+                    meetCount: z.number().optional().optional(),
+                    notFor: z.array(z.string()).optional().optional(),
                     offsetDays: z.number(),
+                    onlyFor: z.array(z.string()).optional().optional(),
                     personId: z.union([z.null(), z.string()]),
                     questions: z
                         .array(z.union([
@@ -2227,6 +2240,7 @@ const credentials_api_listOutput = z.strictObject({
             z.literal('playbooks.nudge'),
             z.literal('playbooks.person'),
             z.literal('playbooks.plans'),
+            z.literal('playbooks.previewAs'),
             z.literal('playbooks.previewEnrollment'),
             z.literal('playbooks.program'),
             z.literal('playbooks.remove'),
@@ -2658,6 +2672,7 @@ const credentials_api_listOutput = z.strictObject({
             z.literal('playbooks.nudge'),
             z.literal('playbooks.person'),
             z.literal('playbooks.plans'),
+            z.literal('playbooks.previewAs'),
             z.literal('playbooks.previewEnrollment'),
             z.literal('playbooks.program'),
             z.literal('playbooks.remove'),
@@ -9110,7 +9125,19 @@ const reports_overviewOutput = z.strictObject({
                         z.literal('message'),
                         z.literal('task'),
                     ]),
+                    meet: z
+                        .union([
+                        z.literal('manager'),
+                        z.literal('person'),
+                        z.literal('skip_level'),
+                        z.literal('teammates'),
+                    ])
+                        .optional()
+                        .optional(),
+                    meetCount: z.number().optional().optional(),
+                    notFor: z.array(z.string()).optional().optional(),
                     offsetDays: z.number(),
+                    onlyFor: z.array(z.string()).optional().optional(),
                     personId: z.union([z.null(), z.string()]),
                     questions: z
                         .array(z.union([
@@ -9667,7 +9694,19 @@ const playbooks_programOutput = z.strictObject({
                 z.literal('message'),
                 z.literal('task'),
             ]),
+            meet: z
+                .union([
+                z.literal('manager'),
+                z.literal('person'),
+                z.literal('skip_level'),
+                z.literal('teammates'),
+            ])
+                .optional()
+                .optional(),
+            meetCount: z.number().optional().optional(),
+            notFor: z.array(z.string()).optional().optional(),
             offsetDays: z.number(),
+            onlyFor: z.array(z.string()).optional().optional(),
             personId: z.union([z.null(), z.string()]),
             questions: z
                 .array(z.union([
@@ -9904,6 +9943,16 @@ const playbooks_programOutput = z.strictObject({
         timezone: z.string(),
     })),
     stepPeople: z.record(z.string(), z.string()),
+    tracks: z.array(z.strictObject({
+        department: z.boolean(),
+        hires: z.number(),
+        id: z.string(),
+        kind: z.union([z.literal('dynamic'), z.literal('list')]),
+        name: z.string(),
+        not: z.number(),
+        only: z.number(),
+        rules: z.union([z.null(), z.string()]),
+    })),
 });
 const playbooks_saveProgramInput = z
     .strictObject({
@@ -9977,10 +10026,23 @@ const playbooks_saveProgramInput = z
                 kind: z.union([
                     z.literal('acknowledge'),
                     z.literal('checkpoint'),
+                    z.literal('meet'),
                     z.literal('message'),
                     z.literal('task'),
                 ]),
+                meet: z
+                    .union([
+                    z.literal('manager'),
+                    z.literal('person'),
+                    z.literal('skip_level'),
+                    z.literal('teammates'),
+                ])
+                    .optional()
+                    .optional(),
+                meetCount: z.number().optional().optional(),
+                notFor: z.array(z.string()).optional().optional(),
                 offsetDays: z.number(),
+                onlyFor: z.array(z.string()).optional().optional(),
                 personId: z.union([z.null(), z.string()]).optional().optional(),
                 questions: z
                     .array(z.union([
@@ -10185,7 +10247,19 @@ const playbooks_saveProgramOutput = z.object({
                         z.literal('message'),
                         z.literal('task'),
                     ]),
+                    meet: z
+                        .union([
+                        z.literal('manager'),
+                        z.literal('person'),
+                        z.literal('skip_level'),
+                        z.literal('teammates'),
+                    ])
+                        .optional()
+                        .optional(),
+                    meetCount: z.number().optional().optional(),
+                    notFor: z.array(z.string()).optional().optional(),
                     offsetDays: z.number(),
+                    onlyFor: z.array(z.string()).optional().optional(),
                     personId: z.union([z.null(), z.string()]),
                     questions: z
                         .array(z.union([
@@ -10387,6 +10461,7 @@ const playbooks_enrollmentPreviewOutput = z.strictObject({
             z.literal('message'),
             z.literal('task'),
         ]),
+        meets: z.union([z.null(), z.array(z.string())]),
         offsetDays: z.number(),
         pending: z.boolean(),
         preview: z.string(),
@@ -10417,6 +10492,7 @@ const playbooks_enrollmentPreviewOutput = z.strictObject({
         ]),
         title: z.union([z.null(), z.string()]),
         todos: z.array(z.string()),
+        track: z.union([z.null(), z.string()]),
     })),
 });
 const playbooks_previewEnrollmentInput = z
@@ -10790,6 +10866,45 @@ const playbooks_nudgeOutput = z.object({
     })
         .nullable(),
 });
+const playbooks_previewAsInput = z.strictObject({
+    personId: z.string(),
+    programId: z.string(),
+});
+const playbooks_previewAsOutput = z.strictObject({
+    dayZero: z.string(),
+    person: z.strictObject({ id: z.string(), name: z.string() }),
+    skipped: z.number(),
+    steps: z.array(z.strictObject({
+        dueAt: z.iso.datetime({ offset: true }),
+        kind: z.union([
+            z.literal('acknowledge'),
+            z.literal('buddy_invitation'),
+            z.literal('catch_up'),
+            z.literal('check_in'),
+            z.literal('checkpoint'),
+            z.literal('form'),
+            z.literal('introduction'),
+            z.literal('meet'),
+            z.literal('message'),
+            z.literal('task'),
+        ]),
+        meets: z.array(z.string()),
+        offsetDays: z.number(),
+        recipient: z.union([
+            z.null(),
+            z.literal('buddy'),
+            z.literal('hire'),
+            z.literal('hr'),
+            z.literal('manager'),
+            z.literal('person'),
+        ]),
+        ref: z.string(),
+        skipped: z.union([z.null(), z.string()]),
+        title: z.union([z.null(), z.string()]),
+        track: z.union([z.null(), z.string()]),
+    })),
+    tracked: z.number(),
+});
 const playbooks_mineInput = z.strictObject({});
 const playbooks_mineOutput = z.union([
     z.strictObject({
@@ -10931,6 +11046,15 @@ const playbooks_runOutput = z.union([
                 userId: z.union([z.null(), z.string()]),
             }),
         ]),
+        met: z.array(z.strictObject({
+            email: z.union([z.null(), z.string()]),
+            id: z.string(),
+            name: z.string(),
+            photoUrl: z.union([z.null(), z.string()]),
+            slackUserId: z.union([z.null(), z.string()]),
+            title: z.union([z.null(), z.string()]),
+            userId: z.union([z.null(), z.string()]),
+        })),
         playbooks: z.array(z.strictObject({
             current: z.boolean(),
             dayZero: z.union([
@@ -10984,6 +11108,7 @@ const playbooks_runOutput = z.union([
                 z.literal('check_in'),
                 z.literal('checkpoint'),
                 z.literal('introduction'),
+                z.literal('meet'),
                 z.literal('message'),
                 z.literal('task'),
             ]),
@@ -17384,7 +17509,7 @@ export const managementContract = {
             .route({
             method: 'POST',
             path: '/manage/groups/allAutomations',
-            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',
+            summary: 'Every join and leave automation 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),
@@ -17591,7 +17716,7 @@ export const managementContract = {
             .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',
+            summary: 'Turn on, pause or remove a playbook’s automation that starts it on each new hire’s start date, for everyone or one group',
         })
             .input(groups_setPlaybookAutoStartInput)
             .output(groups_setPlaybookAutoStartOutput),
@@ -18535,6 +18660,15 @@ export const managementContract = {
         })
             .input(playbooks_plansInput)
             .output(playbooks_plansOutput),
+        previewAs: base
+            .meta({ scope: 'playbooks:read' })
+            .route({
+            method: 'POST',
+            path: '/manage/playbooks/previewAs',
+            summary: 'Which steps of a playbook one person would get, on which day, and why each skipped step is left out',
+        })
+            .input(playbooks_previewAsInput)
+            .output(playbooks_previewAsOutput),
         previewEnrollment: base
             .meta({ scope: 'playbooks:write' })
             .route({

package/dist/permissions.d.ts

@@ -228,6 +228,7 @@ export declare const permissionSchema: z.ZodEnum<{
     "playbooks.nudge": "playbooks.nudge";
     "playbooks.person": "playbooks.person";
     "playbooks.plans": "playbooks.plans";
+    "playbooks.previewAs": "playbooks.previewAs";
     "playbooks.previewEnrollment": "playbooks.previewEnrollment";
     "playbooks.program": "playbooks.program";
     "playbooks.remove": "playbooks.remove";
@@ -611,6 +612,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
         "playbooks.nudge": "playbooks.nudge";
         "playbooks.person": "playbooks.person";
         "playbooks.plans": "playbooks.plans";
+        "playbooks.previewAs": "playbooks.previewAs";
         "playbooks.previewEnrollment": "playbooks.previewEnrollment";
         "playbooks.program": "playbooks.program";
         "playbooks.remove": "playbooks.remove";