@shuffl/api-contracts 0.5.9 → 0.5.11

package/dist/management.generated.js

@@ -345,6 +345,7 @@ const credentials_api_createInput = z
         z.literal('pulse.createAction'),
         z.literal('pulse.decideProposal'),
         z.literal('pulse.editProposal'),
+        z.literal('pulse.groupTrends'),
         z.literal('pulse.insights'),
         z.literal('pulse.latestRead'),
         z.literal('pulse.mine'),
@@ -2344,6 +2345,7 @@ const credentials_api_listOutput = z.strictObject({
             z.literal('pulse.createAction'),
             z.literal('pulse.decideProposal'),
             z.literal('pulse.editProposal'),
+            z.literal('pulse.groupTrends'),
             z.literal('pulse.insights'),
             z.literal('pulse.latestRead'),
             z.literal('pulse.mine'),
@@ -2795,6 +2797,7 @@ const credentials_api_listOutput = z.strictObject({
             z.literal('pulse.createAction'),
             z.literal('pulse.decideProposal'),
             z.literal('pulse.editProposal'),
+            z.literal('pulse.groupTrends'),
             z.literal('pulse.insights'),
             z.literal('pulse.latestRead'),
             z.literal('pulse.mine'),
@@ -5237,6 +5240,7 @@ const groups_allAutomationsOutput = z.strictObject({
         when: z.string(),
     })),
     playbookStarts: z.array(z.strictObject({
+        dayZero: z.union([z.literal('last_day'), z.literal('start_date')]),
         group: z.union([
             z.null(),
             z.strictObject({
@@ -15712,6 +15716,167 @@ const pulse_insightsOutput = z.strictObject({
     windowStart: z.iso.datetime({ offset: true }),
     withheld: z.number(),
 });
+const pulse_groupTrendsInput = z.strictObject({
+    days: z
+        .union([z.literal(30), z.literal(90), z.literal(180)])
+        .optional()
+        .optional(),
+});
+const pulse_groupTrendsOutput = z.strictObject({
+    days: z.union([z.literal(30), z.literal(90), z.literal(180)]),
+    dimensions: z.strictObject({
+        department: z.array(z.strictObject({
+            label: z.string(),
+            segment: z.string(),
+            series: z.array(z.strictObject({
+                change: z.union([z.null(), z.number()]),
+                latest: z.union([z.null(), z.number()]),
+                metric: z.union([
+                    z.literal('ai_adoption'),
+                    z.literal('belonging'),
+                    z.literal('clarity'),
+                    z.literal('engagement'),
+                    z.literal('enps'),
+                    z.literal('favourable'),
+                    z.literal('growth'),
+                    z.literal('manager'),
+                    z.literal('recognition'),
+                    z.literal('safety'),
+                    z.literal('tools'),
+                    z.literal('workload'),
+                ]),
+                points: z.array(z.strictObject({
+                    seen: z.boolean(),
+                    value: z.union([z.null(), z.number()]),
+                })),
+            })),
+        })),
+        group: z.array(z.strictObject({
+            label: z.string(),
+            segment: z.string(),
+            series: z.array(z.strictObject({
+                change: z.union([z.null(), z.number()]),
+                latest: z.union([z.null(), z.number()]),
+                metric: z.union([
+                    z.literal('ai_adoption'),
+                    z.literal('belonging'),
+                    z.literal('clarity'),
+                    z.literal('engagement'),
+                    z.literal('enps'),
+                    z.literal('favourable'),
+                    z.literal('growth'),
+                    z.literal('manager'),
+                    z.literal('recognition'),
+                    z.literal('safety'),
+                    z.literal('tools'),
+                    z.literal('workload'),
+                ]),
+                points: z.array(z.strictObject({
+                    seen: z.boolean(),
+                    value: z.union([z.null(), z.number()]),
+                })),
+            })),
+        })),
+        role: z.array(z.strictObject({
+            label: z.string(),
+            segment: z.string(),
+            series: z.array(z.strictObject({
+                change: z.union([z.null(), z.number()]),
+                latest: z.union([z.null(), z.number()]),
+                metric: z.union([
+                    z.literal('ai_adoption'),
+                    z.literal('belonging'),
+                    z.literal('clarity'),
+                    z.literal('engagement'),
+                    z.literal('enps'),
+                    z.literal('favourable'),
+                    z.literal('growth'),
+                    z.literal('manager'),
+                    z.literal('recognition'),
+                    z.literal('safety'),
+                    z.literal('tools'),
+                    z.literal('workload'),
+                ]),
+                points: z.array(z.strictObject({
+                    seen: z.boolean(),
+                    value: z.union([z.null(), z.number()]),
+                })),
+            })),
+        })),
+        tenure: z.array(z.strictObject({
+            label: z.string(),
+            segment: z.string(),
+            series: z.array(z.strictObject({
+                change: z.union([z.null(), z.number()]),
+                latest: z.union([z.null(), z.number()]),
+                metric: z.union([
+                    z.literal('ai_adoption'),
+                    z.literal('belonging'),
+                    z.literal('clarity'),
+                    z.literal('engagement'),
+                    z.literal('enps'),
+                    z.literal('favourable'),
+                    z.literal('growth'),
+                    z.literal('manager'),
+                    z.literal('recognition'),
+                    z.literal('safety'),
+                    z.literal('tools'),
+                    z.literal('workload'),
+                ]),
+                points: z.array(z.strictObject({
+                    seen: z.boolean(),
+                    value: z.union([z.null(), z.number()]),
+                })),
+            })),
+        })),
+    }),
+    enpsPeriods: z.array(z.string()),
+    everyone: z.array(z.strictObject({
+        change: z.union([z.null(), z.number()]),
+        latest: z.union([z.null(), z.number()]),
+        metric: z.union([
+            z.literal('ai_adoption'),
+            z.literal('belonging'),
+            z.literal('clarity'),
+            z.literal('engagement'),
+            z.literal('enps'),
+            z.literal('favourable'),
+            z.literal('growth'),
+            z.literal('manager'),
+            z.literal('recognition'),
+            z.literal('safety'),
+            z.literal('tools'),
+            z.literal('workload'),
+        ]),
+        points: z.array(z.strictObject({
+            seen: z.boolean(),
+            value: z.union([z.null(), z.number()]),
+        })),
+    })),
+    metrics: z.array(z.strictObject({
+        label: z.string(),
+        metric: z.union([
+            z.literal('ai_adoption'),
+            z.literal('belonging'),
+            z.literal('clarity'),
+            z.literal('engagement'),
+            z.literal('enps'),
+            z.literal('favourable'),
+            z.literal('growth'),
+            z.literal('manager'),
+            z.literal('recognition'),
+            z.literal('safety'),
+            z.literal('tools'),
+            z.literal('workload'),
+        ]),
+    })),
+    periods: z.array(z.string()),
+    unit: z.union([
+        z.literal('fortnight'),
+        z.literal('month'),
+        z.literal('week'),
+    ]),
+});
 const pulse_actionsInput = z.strictObject({
     driver: z
         .union([
@@ -18211,7 +18376,7 @@ export const managementContract = {
             .route({
             method: 'POST',
             path: '/manage/groups/allAutomations',
-            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',
+            summary: 'Every join and leave automation in the workspace: group automations with their group and last runs, playbooks that start on each start date or each last day (`dayZero`) and Connections programs whose people are a group; or only those that start one playbook, program or community',
         })
             .input(groups_allAutomationsInput)
             .output(groups_allAutomationsOutput),
@@ -18427,7 +18592,7 @@ export const managementContract = {
             .route({
             method: 'POST',
             path: '/manage/groups/setPlaybookAutoStart',
-            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',
+            summary: 'Turn on, pause or remove a playbook’s automation that starts it on each new hire’s start date, or a leaving playbook’s on each last day, for everyone or one group',
         })
             .input(groups_setPlaybookAutoStartInput)
             .output(groups_setPlaybookAutoStartOutput),
@@ -19982,6 +20147,15 @@ export const managementContract = {
         })
             .input(pulse_editProposalInput)
             .output(pulse_editProposalOutput),
+        groupTrends: base
+            .meta({ scope: 'pulse:read' })
+            .route({
+            method: 'POST',
+            path: '/manage/pulse/groupTrends',
+            summary: "Read each group's Pulse results over time, period by period, with the change since the start (published group totals only)",
+        })
+            .input(pulse_groupTrendsInput)
+            .output(pulse_groupTrendsOutput),
         insights: base
             .meta({ scope: 'pulse:read' })
             .route({

package/dist/permissions.d.ts

@@ -304,6 +304,7 @@ export declare const permissionSchema: z.ZodEnum<{
     "pulse.createAction": "pulse.createAction";
     "pulse.decideProposal": "pulse.decideProposal";
     "pulse.editProposal": "pulse.editProposal";
+    "pulse.groupTrends": "pulse.groupTrends";
     "pulse.insights": "pulse.insights";
     "pulse.latestRead": "pulse.latestRead";
     "pulse.mine": "pulse.mine";
@@ -705,6 +706,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
         "pulse.createAction": "pulse.createAction";
         "pulse.decideProposal": "pulse.decideProposal";
         "pulse.editProposal": "pulse.editProposal";
+        "pulse.groupTrends": "pulse.groupTrends";
         "pulse.insights": "pulse.insights";
         "pulse.latestRead": "pulse.latestRead";
         "pulse.mine": "pulse.mine";