@shuffl/api-contracts 0.5.1 → 0.5.3

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'),
@@ -234,6 +235,7 @@ const credentials_api_createInput = z
         z.literal('manager.current'),
         z.literal('mcp.knowledge'),
         z.literal('network.claim'),
+        z.literal('network.introductions'),
         z.literal('network.mine'),
         z.literal('network.ofPerson'),
         z.literal('network.orgChart'),
@@ -1046,6 +1048,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()
@@ -2113,6 +2119,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'),
@@ -2186,6 +2193,7 @@ const credentials_api_listOutput = z.strictObject({
             z.literal('manager.current'),
             z.literal('mcp.knowledge'),
             z.literal('network.claim'),
+            z.literal('network.introductions'),
             z.literal('network.mine'),
             z.literal('network.ofPerson'),
             z.literal('network.orgChart'),
@@ -2542,6 +2550,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'),
@@ -2615,6 +2624,7 @@ const credentials_api_listOutput = z.strictObject({
             z.literal('manager.current'),
             z.literal('mcp.knowledge'),
             z.literal('network.claim'),
+            z.literal('network.introductions'),
             z.literal('network.mine'),
             z.literal('network.ofPerson'),
             z.literal('network.orgChart'),
@@ -5123,6 +5133,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(),
@@ -5354,6 +5398,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),
@@ -5938,6 +6010,7 @@ const home_placesOutput = z.strictObject({
             z.literal('celebrations'),
             z.literal('chats'),
             z.literal('communities'),
+            z.literal('connections'),
             z.literal('knowledge'),
             z.literal('playbook'),
             z.literal('praise'),
@@ -6074,6 +6147,46 @@ const network_orgChartOutput = z.strictObject({
         userId: z.union([z.null(), z.string()]),
     })),
 });
+const network_introductionsInput = z.strictObject({});
+const network_introductionsOutput = z.union([
+    z.strictObject({
+        past: z.array(z.strictObject({
+            at: z.iso.datetime({ offset: true }),
+            id: z.string(),
+            program: z.string(),
+            with: z.array(z.strictObject({
+                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()]),
+            })),
+        })),
+        programs: z.array(z.strictObject({
+            breakUntil: z.union([z.null(), z.iso.datetime({ offset: true })]),
+            id: z.string(),
+            name: z.string(),
+            nextAt: z.union([z.null(), z.iso.datetime({ offset: true })]),
+        })),
+        total: z.number(),
+    }),
+    z.strictObject({
+        past: z.array(z.strictObject({
+            at: z.iso.datetime({ offset: true }),
+            id: z.string(),
+            program: z.string(),
+            with: z.array(z.strictObject({
+                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()]),
+            })),
+        })),
+        programs: z.array(z.never()),
+        total: z.number(),
+    }),
+]);
 const network_mineInput = z.strictObject({});
 const network_mineOutput = z.union([
     z.strictObject({
@@ -8937,6 +9050,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()
@@ -9490,6 +9607,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()
@@ -9801,6 +9922,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()
@@ -10000,6 +10125,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()
@@ -17255,7 +17384,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),
@@ -17457,6 +17586,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({
@@ -18094,6 +18232,15 @@ export const managementContract = {
         })
             .input(network_claimInput)
             .output(network_claimOutput),
+        introductions: base
+            .meta({ scope: 'users:read' })
+            .route({
+            method: 'POST',
+            path: '/manage/network/introductions',
+            summary: 'Your Connections programs, when your next introduction goes out, and who you met',
+        })
+            .input(network_introductionsInput)
+            .output(network_introductionsOutput),
         mine: base
             .meta({ scope: 'users: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";
@@ -193,6 +194,7 @@ export declare const permissionSchema: z.ZodEnum<{
     "manager.current": "manager.current";
     "mcp.knowledge": "mcp.knowledge";
     "network.claim": "network.claim";
+    "network.introductions": "network.introductions";
     "network.mine": "network.mine";
     "network.ofPerson": "network.ofPerson";
     "network.orgChart": "network.orgChart";
@@ -501,6 +503,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";
@@ -574,6 +577,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
         "manager.current": "manager.current";
         "mcp.knowledge": "mcp.knowledge";
         "network.claim": "network.claim";
+        "network.introductions": "network.introductions";
         "network.mine": "network.mine";
         "network.ofPerson": "network.ofPerson";
         "network.orgChart": "network.orgChart";