@shuffl/cli 0.7.14 → 0.7.16

package/dist/commands.generated.js

@@ -1358,6 +1358,10 @@ export const commands = [
                             const: 'communities',
                             type: 'string',
                         },
+                        {
+                            const: 'compliance_evidence',
+                            type: 'string',
+                        },
                         {
                             const: 'connected_docs',
                             type: 'string',
@@ -1539,6 +1543,10 @@ export const commands = [
                             const: 'communities',
                             type: 'string',
                         },
+                        {
+                            const: 'compliance_evidence',
+                            type: 'string',
+                        },
                         {
                             const: 'connected_docs',
                             type: 'string',
@@ -2932,6 +2940,146 @@ export const commands = [
         scope: 'profile:write',
         summary: 'Set a community cover from a PNG, JPEG or WebP picture sent as base64, as its owner, moderator or an administrator',
     },
+    {
+        access: 'read',
+        command: ['compliance', 'current'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {},
+            type: 'object',
+        },
+        path: ['compliance', 'current'],
+        permission: 'compliance.current',
+        scope: 'integrations:read',
+        summary: 'List the connected compliance platforms, what each receives and its recent pushes',
+    },
+    {
+        access: 'write',
+        command: ['compliance', 'disconnect'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                confirm: {
+                    const: 'compliance.disconnect',
+                    type: 'string',
+                },
+                connectionId: {
+                    type: 'string',
+                },
+                requestKey: {
+                    maxLength: 128,
+                    minLength: 1,
+                    type: 'string',
+                },
+            },
+            required: ['connectionId', 'confirm', 'requestKey'],
+            type: 'object',
+        },
+        path: ['compliance', 'disconnect'],
+        permission: 'compliance.disconnect',
+        scope: 'integrations:write',
+        summary: 'Disconnect a compliance platform; pushes stop at once',
+    },
+    {
+        access: 'write',
+        command: ['compliance', 'push-now'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                confirm: {
+                    const: 'compliance.pushNow',
+                    type: 'string',
+                },
+                connectionId: {
+                    type: 'string',
+                },
+                requestKey: {
+                    maxLength: 128,
+                    minLength: 1,
+                    type: 'string',
+                },
+            },
+            required: ['connectionId', 'requestKey', 'confirm'],
+            type: 'object',
+        },
+        path: ['compliance', 'pushNow'],
+        permission: 'compliance.pushNow',
+        scope: 'integrations:write',
+        summary: 'Send the evidence a compliance platform is set to receive now',
+    },
+    {
+        access: 'write',
+        command: ['compliance', 'set-evidence'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                confirm: {
+                    const: 'compliance.setEvidence',
+                    type: 'string',
+                },
+                connectionId: {
+                    type: 'string',
+                },
+                enabled: {
+                    anyOf: [
+                        {
+                            const: false,
+                            type: 'boolean',
+                        },
+                        {
+                            const: true,
+                            type: 'boolean',
+                        },
+                    ],
+                },
+                evidence: {
+                    additionalProperties: false,
+                    properties: {
+                        people: {
+                            anyOf: [
+                                {
+                                    const: false,
+                                    type: 'boolean',
+                                },
+                                {
+                                    const: true,
+                                    type: 'boolean',
+                                },
+                            ],
+                        },
+                        policy_acknowledgements: {
+                            anyOf: [
+                                {
+                                    const: false,
+                                    type: 'boolean',
+                                },
+                                {
+                                    const: true,
+                                    type: 'boolean',
+                                },
+                            ],
+                        },
+                    },
+                    type: 'object',
+                },
+                requestKey: {
+                    maxLength: 128,
+                    minLength: 1,
+                    type: 'string',
+                },
+            },
+            required: ['connectionId', 'confirm', 'requestKey'],
+            type: 'object',
+        },
+        path: ['compliance', 'setEvidence'],
+        permission: 'compliance.setEvidence',
+        scope: 'integrations:write',
+        summary: 'Choose which evidence a compliance platform receives, or pause sending',
+    },
     {
         access: 'write',
         command: ['credentials', 'api', 'create'],
@@ -3281,6 +3429,22 @@ export const commands = [
                                 const: 'communities.uploadCover',
                                 type: 'string',
                             },
+                            {
+                                const: 'compliance.current',
+                                type: 'string',
+                            },
+                            {
+                                const: 'compliance.disconnect',
+                                type: 'string',
+                            },
+                            {
+                                const: 'compliance.pushNow',
+                                type: 'string',
+                            },
+                            {
+                                const: 'compliance.setEvidence',
+                                type: 'string',
+                            },
                             {
                                 const: 'credentials.api.create',
                                 type: 'string',
@@ -3789,6 +3953,10 @@ export const commands = [
                                 const: 'mentorship.circles.save',
                                 type: 'string',
                             },
+                            {
+                                const: 'mentorship.cohorts.sponsor',
+                                type: 'string',
+                            },
                             {
                                 const: 'mentorship.feedback.save',
                                 type: 'string',
@@ -3801,10 +3969,22 @@ export const commands = [
                                 const: 'mentorship.goals.save',
                                 type: 'string',
                             },
+                            {
+                                const: 'mentorship.invitations.answer',
+                                type: 'string',
+                            },
+                            {
+                                const: 'mentorship.invitations.send',
+                                type: 'string',
+                            },
                             {
                                 const: 'mentorship.join',
                                 type: 'string',
                             },
+                            {
+                                const: 'mentorship.leaders.get',
+                                type: 'string',
+                            },
                             {
                                 const: 'mentorship.leave',
                                 type: 'string',
@@ -3813,6 +3993,10 @@ export const commands = [
                                 const: 'mentorship.members.setStatus',
                                 type: 'string',
                             },
+                            {
+                                const: 'mentorship.mentors.candidates',
+                                type: 'string',
+                            },
                             {
                                 const: 'mentorship.mentors.choose',
                                 type: 'string',
@@ -3821,6 +4005,10 @@ export const commands = [
                                 const: 'mentorship.mine',
                                 type: 'string',
                             },
+                            {
+                                const: 'mentorship.pairs.approveAll',
+                                type: 'string',
+                            },
                             {
                                 const: 'mentorship.pairs.decide',
                                 type: 'string',
@@ -3829,6 +4017,10 @@ export const commands = [
                                 const: 'mentorship.pairs.end',
                                 type: 'string',
                             },
+                            {
+                                const: 'mentorship.pairs.nudge',
+                                type: 'string',
+                            },
                             {
                                 const: 'mentorship.pairs.setMine',
                                 type: 'string',
@@ -3837,6 +4029,14 @@ export const commands = [
                                 const: 'mentorship.pairs.suggest',
                                 type: 'string',
                             },
+                            {
+                                const: 'mentorship.profiles.get',
+                                type: 'string',
+                            },
+                            {
+                                const: 'mentorship.profiles.setHidden',
+                                type: 'string',
+                            },
                             {
                                 const: 'mentorship.programs.get',
                                 type: 'string',
@@ -3873,6 +4073,10 @@ export const commands = [
                                 const: 'mentorship.settings.save',
                                 type: 'string',
                             },
+                            {
+                                const: 'mentorship.thanks.save',
+                                type: 'string',
+                            },
                             {
                                 const: 'network.claim',
                                 type: 'string',
@@ -9152,6 +9356,37 @@ export const commands = [
         scope: 'mentorship:write',
         summary: 'Set or move a mentorship program’s next mentor circle, a short meeting where its mentors swap what works',
     },
+    {
+        access: 'write',
+        command: ['mentorship', 'cohorts', 'sponsor'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                confirm: {
+                    const: 'mentorship.cohorts.sponsor',
+                    type: 'string',
+                },
+                note: {
+                    type: ['null', 'string'],
+                },
+                programId: {
+                    type: 'string',
+                },
+                requestKey: {
+                    maxLength: 128,
+                    minLength: 1,
+                    type: 'string',
+                },
+            },
+            required: ['note', 'programId', 'confirm', 'requestKey'],
+            type: 'object',
+        },
+        path: ['mentorship', 'cohorts', 'sponsor'],
+        permission: 'mentorship.cohorts.sponsor',
+        scope: 'self:write',
+        summary: 'Sponsor an upcoming mentorship cohort with a short note shown on its invite and kickoff, or take it back',
+    },
     {
         access: 'write',
         command: ['mentorship', 'feedback', 'save'],
@@ -9263,6 +9498,102 @@ export const commands = [
         scope: 'self:write',
         summary: 'Add, rename or check off a goal in your mentorship, as the mentee',
     },
+    {
+        access: 'write',
+        command: ['mentorship', 'invitations', 'answer'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                answer: {
+                    anyOf: [
+                        {
+                            const: 'later',
+                            type: 'string',
+                        },
+                        {
+                            const: 'not_now',
+                            type: 'string',
+                        },
+                        {
+                            const: 'yes',
+                            type: 'string',
+                        },
+                    ],
+                },
+                confirm: {
+                    const: 'mentorship.invitations.answer',
+                    type: 'string',
+                },
+                invitationId: {
+                    type: 'string',
+                },
+                requestKey: {
+                    maxLength: 128,
+                    minLength: 1,
+                    type: 'string',
+                },
+            },
+            required: ['answer', 'invitationId', 'confirm', 'requestKey'],
+            type: 'object',
+        },
+        path: ['mentorship', 'invitations', 'answer'],
+        permission: 'mentorship.invitations.answer',
+        scope: 'self:write',
+        summary: 'Answer an invite to mentor: yes, not now, or ask me later',
+    },
+    {
+        access: 'write',
+        command: ['mentorship', 'invitations', 'send'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                confirm: {
+                    const: 'mentorship.invitations.send',
+                    type: 'string',
+                },
+                message: {
+                    type: 'string',
+                },
+                personIds: {
+                    items: {
+                        type: 'string',
+                    },
+                    type: 'array',
+                },
+                programId: {
+                    type: 'string',
+                },
+                requestKey: {
+                    maxLength: 128,
+                    minLength: 1,
+                    type: 'string',
+                },
+                tellManagers: {
+                    anyOf: [
+                        {
+                            const: false,
+                            type: 'boolean',
+                        },
+                        {
+                            const: true,
+                            type: 'boolean',
+                        },
+                    ],
+                },
+                topic: {
+                    type: 'string',
+                },
+            },
+            required: ['message', 'personIds', 'programId', 'confirm', 'requestKey'],
+            type: 'object',
+        },
+        path: ['mentorship', 'invitations', 'send'],
+        permission: 'mentorship.invitations.send',
+        scope: 'mentorship:write',
+        summary: 'Invite up to 20 people to mentor in a program, optionally telling their managers. Nobody becomes a mentor until they say yes',
+    },
     {
         access: 'write',
         command: ['mentorship', 'join'],
@@ -9312,6 +9643,20 @@ export const commands = [
         scope: 'self:write',
         summary: 'Join a mentorship program as a mentor or mentee, saying what you can help with or want to learn, and as a mentor how many mentees and hours you can give',
     },
+    {
+        access: 'read',
+        command: ['mentorship', 'leaders', 'get'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {},
+            type: 'object',
+        },
+        path: ['mentorship', 'leaders', 'get'],
+        permission: 'mentorship.leaders.get',
+        scope: 'self:read',
+        summary: 'Mentorship across the people you lead: how many take part against the company, topics short of mentors and cohorts you can sponsor. Totals only',
+    },
     {
         access: 'write',
         command: ['mentorship', 'leave'],
@@ -9414,6 +9759,28 @@ export const commands = [
         scope: 'mentorship:write',
         summary: 'Take someone off a mentorship program, or put them back',
     },
+    {
+        access: 'read',
+        command: ['mentorship', 'mentors', 'candidates'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                programId: {
+                    type: 'string',
+                },
+                topic: {
+                    type: 'string',
+                },
+            },
+            required: ['programId'],
+            type: 'object',
+        },
+        path: ['mentorship', 'mentors', 'candidates'],
+        permission: 'mentorship.mentors.candidates',
+        scope: 'mentorship:read',
+        summary: 'People who could mentor a topic, from their titles, tenure, who they manage and praise that mentions it, with a drafted invite',
+    },
     {
         access: 'write',
         command: ['mentorship', 'mentors', 'choose'],
@@ -9459,6 +9826,34 @@ export const commands = [
         scope: 'self:read',
         summary: 'Your mentorship programs and pairings, with goals and check-ins',
     },
+    {
+        access: 'write',
+        command: ['mentorship', 'pairs', 'approve-all'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                confirm: {
+                    const: 'mentorship.pairs.approveAll',
+                    type: 'string',
+                },
+                programId: {
+                    type: 'string',
+                },
+                requestKey: {
+                    maxLength: 128,
+                    minLength: 1,
+                    type: 'string',
+                },
+            },
+            required: ['programId', 'confirm', 'requestKey'],
+            type: 'object',
+        },
+        path: ['mentorship', 'pairs', 'approveAll'],
+        permission: 'mentorship.pairs.approveAll',
+        scope: 'mentorship:write',
+        summary: 'Approve every suggested pair in a mentorship program at once. In a cohort before its start day they wait for it; otherwise each starts now',
+    },
     {
         access: 'write',
         command: ['mentorship', 'pairs', 'decide'],
@@ -9527,6 +9922,34 @@ export const commands = [
         scope: 'mentorship:write',
         summary: 'End a mentorship pairing early',
     },
+    {
+        access: 'write',
+        command: ['mentorship', 'pairs', 'nudge'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                confirm: {
+                    const: 'mentorship.pairs.nudge',
+                    type: 'string',
+                },
+                programId: {
+                    type: 'string',
+                },
+                requestKey: {
+                    maxLength: 128,
+                    minLength: 1,
+                    type: 'string',
+                },
+            },
+            required: ['programId', 'confirm', 'requestKey'],
+            type: 'object',
+        },
+        path: ['mentorship', 'pairs', 'nudge'],
+        permission: 'mentorship.pairs.nudge',
+        scope: 'mentorship:write',
+        summary: 'Nudge every pair in a mentorship program that hasn’t met in three weeks to pick a time. Each pair hears it once a week at most',
+    },
     {
         access: 'write',
         command: ['mentorship', 'pairs', 'set-mine'],
@@ -9599,6 +10022,53 @@ export const commands = [
         scope: 'mentorship:write',
         summary: 'Suggest a mentor outside their reporting line for every mentee still waiting',
     },
+    {
+        access: 'read',
+        command: ['mentorship', 'profiles', 'get'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                personId: {
+                    type: 'string',
+                },
+            },
+            required: ['personId'],
+            type: 'object',
+        },
+        path: ['mentorship', 'profiles', 'get'],
+        permission: 'mentorship.profiles.get',
+        scope: 'users:read',
+        summary: 'A person’s Mentoring section: how many people they mentored, what they offer and the thank-yous shared there',
+    },
+    {
+        access: 'write',
+        command: ['mentorship', 'profiles', 'set-hidden'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                confirm: {
+                    const: 'mentorship.profiles.setHidden',
+                    type: 'string',
+                },
+                hidden: {
+                    type: 'boolean',
+                },
+                requestKey: {
+                    maxLength: 128,
+                    minLength: 1,
+                    type: 'string',
+                },
+            },
+            required: ['hidden', 'confirm', 'requestKey'],
+            type: 'object',
+        },
+        path: ['mentorship', 'profiles', 'setHidden'],
+        permission: 'mentorship.profiles.setHidden',
+        scope: 'profile:write',
+        summary: 'Hide or show the Mentoring section of your own profile',
+    },
     {
         access: 'read',
         command: ['mentorship', 'programs', 'get'],
@@ -9642,6 +10112,26 @@ export const commands = [
                 checkInWeeks: {
                     type: 'number',
                 },
+                cohort: {
+                    anyOf: [
+                        {
+                            type: 'null',
+                        },
+                        {
+                            additionalProperties: false,
+                            properties: {
+                                signupClosesOn: {
+                                    type: 'string',
+                                },
+                                startsOn: {
+                                    type: 'string',
+                                },
+                            },
+                            required: ['signupClosesOn', 'startsOn'],
+                            type: 'object',
+                        },
+                    ],
+                },
                 confirm: {
                     const: 'mentorship.programs.save',
                     type: 'string',
@@ -9649,6 +10139,26 @@ export const commands = [
                 description: {
                     type: 'string',
                 },
+                format: {
+                    anyOf: [
+                        {
+                            const: 'ask_once',
+                            type: 'string',
+                        },
+                        {
+                            const: 'circle',
+                            type: 'string',
+                        },
+                        {
+                            const: 'one_to_one',
+                            type: 'string',
+                        },
+                        {
+                            const: 'reverse',
+                            type: 'string',
+                        },
+                    ],
+                },
                 groupId: {
                     type: ['null', 'string'],
                 },
@@ -9688,7 +10198,7 @@ export const commands = [
         path: ['mentorship', 'programs', 'save'],
         permission: 'mentorship.programs.save',
         scope: 'mentorship:write',
-        summary: 'Create or change a mentorship program: who can join, how long pairings last and how often pairs check in',
+        summary: 'Create or change a mentorship program: who can join, its format (one to one, ask once, circles or reverse mentoring), whether it runs as a cohort, how long pairings last and how often pairs check in',
     },
     {
         access: 'write',
@@ -9899,6 +10409,64 @@ export const commands = [
         scope: 'mentorship:write',
         summary: 'Change what a new mentorship program starts with; existing programs keep their own terms',
     },
+    {
+        access: 'write',
+        command: ['mentorship', 'thanks', 'save'],
+        input: {
+            $schema: 'https://json-schema.org/draft/2020-12/schema',
+            additionalProperties: false,
+            properties: {
+                confirm: {
+                    const: 'mentorship.thanks.save',
+                    type: 'string',
+                },
+                message: {
+                    type: 'string',
+                },
+                onProfile: {
+                    anyOf: [
+                        {
+                            const: false,
+                            type: 'boolean',
+                        },
+                        {
+                            const: true,
+                            type: 'boolean',
+                        },
+                    ],
+                },
+                pairId: {
+                    type: 'string',
+                },
+                praiseChannelId: {
+                    type: ['null', 'string'],
+                },
+                requestKey: {
+                    maxLength: 128,
+                    minLength: 1,
+                    type: 'string',
+                },
+                tellManager: {
+                    anyOf: [
+                        {
+                            const: false,
+                            type: 'boolean',
+                        },
+                        {
+                            const: true,
+                            type: 'boolean',
+                        },
+                    ],
+                },
+            },
+            required: ['message', 'pairId', 'confirm', 'requestKey'],
+            type: 'object',
+        },
+        path: ['mentorship', 'thanks', 'save'],
+        permission: 'mentorship.thanks.save',
+        scope: 'self:write',
+        summary: 'Thank your mentor when your pairing ends: optionally on their profile, to their manager, and as praise in a channel',
+    },
     {
         access: 'write',
         command: ['network', 'claim'],
@@ -12229,6 +12797,10 @@ export const commands = [
                             const: 'feed',
                             type: 'string',
                         },
+                        {
+                            const: 'mentorship',
+                            type: 'string',
+                        },
                         {
                             const: 'nudge',
                             type: 'string',
@@ -15789,7 +16361,7 @@ export const commands = [
         path: ['reports', 'mentorship'],
         permission: 'reports.mentorship',
         scope: 'reports:read',
-        summary: 'Mentorship over 30, 90 or 180 days against the period before: pairs started, ended early and completed, check-ins answered and met, pairs meeting and mentees waiting now; `programId` narrows it. Never goals',
+        summary: 'Mentorship over 30, 90 or 180 days against the period before: pairs started, ended early and completed, check-ins answered and met, pairs meeting and mentees waiting now; `programId` narrows it. `outcomes` compares people who were in a pairing with peers at similar tenure, hidden under five people. Never anyone’s goals',
     },
     {
         access: 'read',

package/package.json

@@ -1,8 +1,8 @@
 {
   "dependencies": {
     "@orpc/client": "1.15.3",
-    "@shuffl/api-contracts": "0.7.14",
-    "@shuffl/sdk": "0.7.14"
+    "@shuffl/api-contracts": "0.7.16",
+    "@shuffl/sdk": "0.7.16"
   },
   "description": "Shuffl command line: every public API operation as a scriptable command with JSON output.",
   "engines": {
@@ -33,7 +33,7 @@
   "sideEffects": false,
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "0.7.14",
+  "version": "0.7.16",
   "bin": {
     "shuffl": "./dist/bin.js"
   }