@shuffl/cli 0.5.5 → 0.5.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2361,6 +2361,10 @@ export const commands = [
2361
2361
  const: 'groups.allAutomations',
2362
2362
  type: 'string',
2363
2363
  },
2364
+ {
2365
+ const: 'groups.automationChoices',
2366
+ type: 'string',
2367
+ },
2364
2368
  {
2365
2369
  const: 'groups.automations',
2366
2370
  type: 'string',
@@ -2741,6 +2745,66 @@ export const commands = [
2741
2745
  const: 'mcp.knowledge',
2742
2746
  type: 'string',
2743
2747
  },
2748
+ {
2749
+ const: 'mentorship.checkIns.answer',
2750
+ type: 'string',
2751
+ },
2752
+ {
2753
+ const: 'mentorship.goals.remove',
2754
+ type: 'string',
2755
+ },
2756
+ {
2757
+ const: 'mentorship.goals.save',
2758
+ type: 'string',
2759
+ },
2760
+ {
2761
+ const: 'mentorship.join',
2762
+ type: 'string',
2763
+ },
2764
+ {
2765
+ const: 'mentorship.leave',
2766
+ type: 'string',
2767
+ },
2768
+ {
2769
+ const: 'mentorship.members.setStatus',
2770
+ type: 'string',
2771
+ },
2772
+ {
2773
+ const: 'mentorship.mine',
2774
+ type: 'string',
2775
+ },
2776
+ {
2777
+ const: 'mentorship.pairs.decide',
2778
+ type: 'string',
2779
+ },
2780
+ {
2781
+ const: 'mentorship.pairs.end',
2782
+ type: 'string',
2783
+ },
2784
+ {
2785
+ const: 'mentorship.pairs.setMine',
2786
+ type: 'string',
2787
+ },
2788
+ {
2789
+ const: 'mentorship.pairs.suggest',
2790
+ type: 'string',
2791
+ },
2792
+ {
2793
+ const: 'mentorship.programs.get',
2794
+ type: 'string',
2795
+ },
2796
+ {
2797
+ const: 'mentorship.programs.list',
2798
+ type: 'string',
2799
+ },
2800
+ {
2801
+ const: 'mentorship.programs.save',
2802
+ type: 'string',
2803
+ },
2804
+ {
2805
+ const: 'mentorship.programs.setStatus',
2806
+ type: 'string',
2807
+ },
2744
2808
  {
2745
2809
  const: 'network.claim',
2746
2810
  type: 'string',
@@ -4125,6 +4189,20 @@ export const commands = [
4125
4189
  scope: 'users:read',
4126
4190
  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',
4127
4191
  },
4192
+ {
4193
+ access: 'read',
4194
+ command: ['groups', 'automation-choices'],
4195
+ input: {
4196
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
4197
+ additionalProperties: false,
4198
+ properties: {},
4199
+ type: 'object',
4200
+ },
4201
+ path: ['groups', 'automationChoices'],
4202
+ permission: 'groups.automationChoices',
4203
+ scope: 'users:read',
4204
+ summary: 'The Pulse questions, badges and Shuffl lists a group automation can ask, give or add people to',
4205
+ },
4128
4206
  {
4129
4207
  access: 'read',
4130
4208
  command: ['groups', 'automations'],
@@ -4888,6 +4966,9 @@ export const commands = [
4888
4966
  },
4889
4967
  ],
4890
4968
  },
4969
+ badgeId: {
4970
+ type: 'string',
4971
+ },
4891
4972
  body: {
4892
4973
  items: {
4893
4974
  type: 'string',
@@ -4916,12 +4997,21 @@ export const commands = [
4916
4997
  note: {
4917
4998
  type: 'string',
4918
4999
  },
5000
+ personId: {
5001
+ type: 'string',
5002
+ },
4919
5003
  programId: {
4920
5004
  type: 'string',
4921
5005
  },
5006
+ questionId: {
5007
+ type: 'string',
5008
+ },
4922
5009
  subject: {
4923
5010
  type: 'string',
4924
5011
  },
5012
+ targetGroupId: {
5013
+ type: 'string',
5014
+ },
4925
5015
  },
4926
5016
  type: 'object',
4927
5017
  },
@@ -4931,6 +5021,9 @@ export const commands = [
4931
5021
  const: 'groups.setAutomation',
4932
5022
  type: 'string',
4933
5023
  },
5024
+ delayDays: {
5025
+ type: 'number',
5026
+ },
4934
5027
  groupId: {
4935
5028
  type: 'string',
4936
5029
  },
@@ -4939,14 +5032,30 @@ export const commands = [
4939
5032
  },
4940
5033
  kind: {
4941
5034
  anyOf: [
5035
+ {
5036
+ const: 'add_to_group',
5037
+ type: 'string',
5038
+ },
4942
5039
  {
4943
5040
  const: 'add_to_program',
4944
5041
  type: 'string',
4945
5042
  },
5043
+ {
5044
+ const: 'ask_pulse',
5045
+ type: 'string',
5046
+ },
5047
+ {
5048
+ const: 'give_badge',
5049
+ type: 'string',
5050
+ },
4946
5051
  {
4947
5052
  const: 'invite_community',
4948
5053
  type: 'string',
4949
5054
  },
5055
+ {
5056
+ const: 'remove_from_group',
5057
+ type: 'string',
5058
+ },
4950
5059
  {
4951
5060
  const: 'send_message',
4952
5061
  type: 'string',
@@ -4963,6 +5072,10 @@ export const commands = [
4963
5072
  const: 'tell_manager',
4964
5073
  type: 'string',
4965
5074
  },
5075
+ {
5076
+ const: 'tell_person',
5077
+ type: 'string',
5078
+ },
4966
5079
  ],
4967
5080
  },
4968
5081
  requestKey: {
@@ -4989,7 +5102,7 @@ export const commands = [
4989
5102
  path: ['groups', 'setAutomation'],
4990
5103
  permission: 'groups.setAutomation',
4991
5104
  scope: 'users:write',
4992
- summary: 'Add or change an automation on a group; a new one starts paused',
5105
+ summary: 'Add or change an automation on a group: send a message, ask a Pulse question, start a playbook, invite to a community, add to Connections, give a badge, add to or remove from another group, or tell HR, their manager or someone named, right away or days later; a new one starts paused',
4993
5106
  },
4994
5107
  {
4995
5108
  access: 'write',
@@ -7542,31 +7655,32 @@ export const commands = [
7542
7655
  },
7543
7656
  {
7544
7657
  access: 'write',
7545
- command: ['network', 'claim'],
7658
+ command: ['mentorship', 'check-ins', 'answer'],
7546
7659
  input: {
7547
7660
  $schema: 'https://json-schema.org/draft/2020-12/schema',
7548
7661
  additionalProperties: false,
7549
7662
  properties: {
7550
- confirm: {
7551
- const: 'network.claim',
7552
- type: 'string',
7553
- },
7554
- kind: {
7663
+ answer: {
7555
7664
  anyOf: [
7556
7665
  {
7557
- const: 'knows',
7666
+ const: 'helped',
7558
7667
  type: 'string',
7559
7668
  },
7560
7669
  {
7561
- const: 'wants_to_meet',
7670
+ const: 'met',
7671
+ type: 'string',
7672
+ },
7673
+ {
7674
+ const: 'not_yet',
7562
7675
  type: 'string',
7563
7676
  },
7564
7677
  ],
7565
7678
  },
7566
- on: {
7567
- type: 'boolean',
7679
+ checkInId: {
7680
+ type: 'string',
7568
7681
  },
7569
- personId: {
7682
+ confirm: {
7683
+ const: 'mentorship.checkIns.answer',
7570
7684
  type: 'string',
7571
7685
  },
7572
7686
  requestKey: {
@@ -7575,87 +7689,72 @@ export const commands = [
7575
7689
  type: 'string',
7576
7690
  },
7577
7691
  },
7578
- required: ['kind', 'on', 'personId', 'confirm', 'requestKey'],
7579
- type: 'object',
7580
- },
7581
- path: ['network', 'claim'],
7582
- permission: 'network.claim',
7583
- scope: 'profile:write',
7584
- summary: 'Say you know someone or would like to meet them',
7585
- },
7586
- {
7587
- access: 'read',
7588
- command: ['network', 'introductions'],
7589
- input: {
7590
- $schema: 'https://json-schema.org/draft/2020-12/schema',
7591
- additionalProperties: false,
7592
- properties: {},
7593
- type: 'object',
7594
- },
7595
- path: ['network', 'introductions'],
7596
- permission: 'network.introductions',
7597
- scope: 'users:read',
7598
- summary: 'Your Connections programs, when your next introduction goes out, and who you met',
7599
- },
7600
- {
7601
- access: 'read',
7602
- command: ['network', 'mine'],
7603
- input: {
7604
- $schema: 'https://json-schema.org/draft/2020-12/schema',
7605
- additionalProperties: false,
7606
- properties: {},
7692
+ required: ['answer', 'checkInId', 'confirm', 'requestKey'],
7607
7693
  type: 'object',
7608
7694
  },
7609
- path: ['network', 'mine'],
7610
- permission: 'network.mine',
7611
- scope: 'users:read',
7612
- summary: 'Who you know and who you should meet',
7695
+ path: ['mentorship', 'checkIns', 'answer'],
7696
+ permission: 'mentorship.checkIns.answer',
7697
+ scope: 'self:write',
7698
+ summary: 'Answer whether you met your mentor or mentee, and whether it helped',
7613
7699
  },
7614
7700
  {
7615
- access: 'read',
7616
- command: ['network', 'of-person'],
7701
+ access: 'write',
7702
+ command: ['mentorship', 'goals', 'remove'],
7617
7703
  input: {
7618
7704
  $schema: 'https://json-schema.org/draft/2020-12/schema',
7619
7705
  additionalProperties: false,
7620
7706
  properties: {
7621
- personId: {
7707
+ confirm: {
7708
+ const: 'mentorship.goals.remove',
7709
+ type: 'string',
7710
+ },
7711
+ goalId: {
7712
+ type: 'string',
7713
+ },
7714
+ pairId: {
7715
+ type: 'string',
7716
+ },
7717
+ requestKey: {
7718
+ maxLength: 128,
7719
+ minLength: 1,
7622
7720
  type: 'string',
7623
7721
  },
7624
7722
  },
7625
- required: ['personId'],
7626
- type: 'object',
7627
- },
7628
- path: ['network', 'ofPerson'],
7629
- permission: 'network.ofPerson',
7630
- scope: 'users:read',
7631
- summary: 'People you and this person both know',
7632
- },
7633
- {
7634
- access: 'read',
7635
- command: ['network', 'org-chart'],
7636
- input: {
7637
- $schema: 'https://json-schema.org/draft/2020-12/schema',
7638
- additionalProperties: false,
7639
- properties: {},
7723
+ required: ['goalId', 'pairId', 'confirm', 'requestKey'],
7640
7724
  type: 'object',
7641
7725
  },
7642
- path: ['network', 'orgChart'],
7643
- permission: 'network.orgChart',
7644
- scope: 'users:read',
7645
- summary: 'Everyone in the team with their manager, for the org chart',
7726
+ path: ['mentorship', 'goals', 'remove'],
7727
+ permission: 'mentorship.goals.remove',
7728
+ scope: 'self:write',
7729
+ summary: 'Remove a goal from your mentorship, as the mentee',
7646
7730
  },
7647
7731
  {
7648
7732
  access: 'write',
7649
- command: ['network', 'request-intro'],
7733
+ command: ['mentorship', 'goals', 'save'],
7650
7734
  input: {
7651
7735
  $schema: 'https://json-schema.org/draft/2020-12/schema',
7652
7736
  additionalProperties: false,
7653
7737
  properties: {
7654
7738
  confirm: {
7655
- const: 'network.requestIntro',
7739
+ const: 'mentorship.goals.save',
7656
7740
  type: 'string',
7657
7741
  },
7658
- personId: {
7742
+ done: {
7743
+ anyOf: [
7744
+ {
7745
+ const: false,
7746
+ type: 'boolean',
7747
+ },
7748
+ {
7749
+ const: true,
7750
+ type: 'boolean',
7751
+ },
7752
+ ],
7753
+ },
7754
+ goalId: {
7755
+ type: 'string',
7756
+ },
7757
+ pairId: {
7659
7758
  type: 'string',
7660
7759
  },
7661
7760
  requestKey: {
@@ -7663,60 +7762,617 @@ export const commands = [
7663
7762
  minLength: 1,
7664
7763
  type: 'string',
7665
7764
  },
7666
- viaId: {
7765
+ title: {
7667
7766
  type: 'string',
7668
7767
  },
7669
7768
  },
7670
- required: ['personId', 'viaId', 'confirm', 'requestKey'],
7769
+ required: ['pairId', 'confirm', 'requestKey'],
7671
7770
  type: 'object',
7672
7771
  },
7673
- path: ['network', 'requestIntro'],
7674
- permission: 'network.requestIntro',
7675
- scope: 'profile:write',
7676
- summary: 'Ask someone you both know to introduce you',
7772
+ path: ['mentorship', 'goals', 'save'],
7773
+ permission: 'mentorship.goals.save',
7774
+ scope: 'self:write',
7775
+ summary: 'Add, rename or check off a goal in your mentorship, as the mentee',
7677
7776
  },
7678
7777
  {
7679
- access: 'read',
7680
- command: ['notifications', 'preferences'],
7778
+ access: 'write',
7779
+ command: ['mentorship', 'join'],
7681
7780
  input: {
7682
7781
  $schema: 'https://json-schema.org/draft/2020-12/schema',
7683
7782
  additionalProperties: false,
7684
- properties: {},
7783
+ properties: {
7784
+ confirm: {
7785
+ const: 'mentorship.join',
7786
+ type: 'string',
7787
+ },
7788
+ programId: {
7789
+ type: 'string',
7790
+ },
7791
+ requestKey: {
7792
+ maxLength: 128,
7793
+ minLength: 1,
7794
+ type: 'string',
7795
+ },
7796
+ role: {
7797
+ anyOf: [
7798
+ {
7799
+ const: 'mentee',
7800
+ type: 'string',
7801
+ },
7802
+ {
7803
+ const: 'mentor',
7804
+ type: 'string',
7805
+ },
7806
+ ],
7807
+ },
7808
+ topics: {
7809
+ type: 'string',
7810
+ },
7811
+ },
7812
+ required: ['programId', 'role', 'topics', 'confirm', 'requestKey'],
7685
7813
  type: 'object',
7686
7814
  },
7687
- path: ['notifications', 'preferences'],
7688
- permission: 'notifications.preferences',
7689
- scope: 'self:read',
7690
- summary: 'Read your notification preferences',
7815
+ path: ['mentorship', 'join'],
7816
+ permission: 'mentorship.join',
7817
+ scope: 'self:write',
7818
+ summary: 'Join a mentorship program as a mentor or mentee, saying what you can help with or want to learn',
7691
7819
  },
7692
7820
  {
7693
7821
  access: 'write',
7694
- command: ['notifications', 'save'],
7822
+ command: ['mentorship', 'leave'],
7695
7823
  input: {
7696
7824
  $schema: 'https://json-schema.org/draft/2020-12/schema',
7697
7825
  additionalProperties: false,
7698
7826
  properties: {
7699
- channel: {
7827
+ confirm: {
7828
+ const: 'mentorship.leave',
7829
+ type: 'string',
7830
+ },
7831
+ programId: {
7832
+ type: 'string',
7833
+ },
7834
+ requestKey: {
7835
+ maxLength: 128,
7836
+ minLength: 1,
7837
+ type: 'string',
7838
+ },
7839
+ role: {
7700
7840
  anyOf: [
7701
7841
  {
7702
- const: 'email',
7703
- type: 'string',
7704
- },
7705
- {
7706
- const: 'slack',
7842
+ const: 'mentee',
7707
7843
  type: 'string',
7708
7844
  },
7709
7845
  {
7710
- const: 'teams',
7846
+ const: 'mentor',
7711
7847
  type: 'string',
7712
7848
  },
7713
7849
  ],
7714
7850
  },
7715
- enabled: {
7716
- type: 'boolean',
7717
- },
7718
- kind: {
7719
- anyOf: [
7851
+ },
7852
+ required: ['programId', 'role', 'confirm', 'requestKey'],
7853
+ type: 'object',
7854
+ },
7855
+ path: ['mentorship', 'leave'],
7856
+ permission: 'mentorship.leave',
7857
+ scope: 'self:write',
7858
+ summary: 'Leave a mentorship program as a mentor or mentee',
7859
+ },
7860
+ {
7861
+ access: 'write',
7862
+ command: ['mentorship', 'members', 'set-status'],
7863
+ input: {
7864
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
7865
+ additionalProperties: false,
7866
+ properties: {
7867
+ confirm: {
7868
+ const: 'mentorship.members.setStatus',
7869
+ type: 'string',
7870
+ },
7871
+ personId: {
7872
+ type: 'string',
7873
+ },
7874
+ programId: {
7875
+ type: 'string',
7876
+ },
7877
+ requestKey: {
7878
+ maxLength: 128,
7879
+ minLength: 1,
7880
+ type: 'string',
7881
+ },
7882
+ role: {
7883
+ anyOf: [
7884
+ {
7885
+ const: 'mentee',
7886
+ type: 'string',
7887
+ },
7888
+ {
7889
+ const: 'mentor',
7890
+ type: 'string',
7891
+ },
7892
+ ],
7893
+ },
7894
+ status: {
7895
+ anyOf: [
7896
+ {
7897
+ const: 'active',
7898
+ type: 'string',
7899
+ },
7900
+ {
7901
+ const: 'removed',
7902
+ type: 'string',
7903
+ },
7904
+ ],
7905
+ },
7906
+ },
7907
+ required: [
7908
+ 'personId',
7909
+ 'programId',
7910
+ 'role',
7911
+ 'status',
7912
+ 'confirm',
7913
+ 'requestKey',
7914
+ ],
7915
+ type: 'object',
7916
+ },
7917
+ path: ['mentorship', 'members', 'setStatus'],
7918
+ permission: 'mentorship.members.setStatus',
7919
+ scope: 'mentorship:write',
7920
+ summary: 'Take someone off a mentorship program, or put them back',
7921
+ },
7922
+ {
7923
+ access: 'read',
7924
+ command: ['mentorship', 'mine'],
7925
+ input: {
7926
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
7927
+ additionalProperties: false,
7928
+ properties: {},
7929
+ type: 'object',
7930
+ },
7931
+ path: ['mentorship', 'mine'],
7932
+ permission: 'mentorship.mine',
7933
+ scope: 'self:read',
7934
+ summary: 'Your mentorship programs and pairings, with goals and check-ins',
7935
+ },
7936
+ {
7937
+ access: 'write',
7938
+ command: ['mentorship', 'pairs', 'decide'],
7939
+ input: {
7940
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
7941
+ additionalProperties: false,
7942
+ properties: {
7943
+ confirm: {
7944
+ const: 'mentorship.pairs.decide',
7945
+ type: 'string',
7946
+ },
7947
+ decision: {
7948
+ anyOf: [
7949
+ {
7950
+ const: 'approve',
7951
+ type: 'string',
7952
+ },
7953
+ {
7954
+ const: 'skip',
7955
+ type: 'string',
7956
+ },
7957
+ ],
7958
+ },
7959
+ pairId: {
7960
+ type: 'string',
7961
+ },
7962
+ requestKey: {
7963
+ maxLength: 128,
7964
+ minLength: 1,
7965
+ type: 'string',
7966
+ },
7967
+ },
7968
+ required: ['decision', 'pairId', 'confirm', 'requestKey'],
7969
+ type: 'object',
7970
+ },
7971
+ path: ['mentorship', 'pairs', 'decide'],
7972
+ permission: 'mentorship.pairs.decide',
7973
+ scope: 'mentorship:write',
7974
+ summary: 'Approve a suggested mentorship pair, which introduces them, or skip it',
7975
+ },
7976
+ {
7977
+ access: 'write',
7978
+ command: ['mentorship', 'pairs', 'end'],
7979
+ input: {
7980
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
7981
+ additionalProperties: false,
7982
+ properties: {
7983
+ confirm: {
7984
+ const: 'mentorship.pairs.end',
7985
+ type: 'string',
7986
+ },
7987
+ pairId: {
7988
+ type: 'string',
7989
+ },
7990
+ requestKey: {
7991
+ maxLength: 128,
7992
+ minLength: 1,
7993
+ type: 'string',
7994
+ },
7995
+ },
7996
+ required: ['pairId', 'confirm', 'requestKey'],
7997
+ type: 'object',
7998
+ },
7999
+ path: ['mentorship', 'pairs', 'end'],
8000
+ permission: 'mentorship.pairs.end',
8001
+ scope: 'mentorship:write',
8002
+ summary: 'End a mentorship pairing early',
8003
+ },
8004
+ {
8005
+ access: 'write',
8006
+ command: ['mentorship', 'pairs', 'set-mine'],
8007
+ input: {
8008
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8009
+ additionalProperties: false,
8010
+ properties: {
8011
+ confirm: {
8012
+ const: 'mentorship.pairs.setMine',
8013
+ type: 'string',
8014
+ },
8015
+ pairId: {
8016
+ type: 'string',
8017
+ },
8018
+ requestKey: {
8019
+ maxLength: 128,
8020
+ minLength: 1,
8021
+ type: 'string',
8022
+ },
8023
+ status: {
8024
+ anyOf: [
8025
+ {
8026
+ const: 'active',
8027
+ type: 'string',
8028
+ },
8029
+ {
8030
+ const: 'ended',
8031
+ type: 'string',
8032
+ },
8033
+ {
8034
+ const: 'paused',
8035
+ type: 'string',
8036
+ },
8037
+ ],
8038
+ },
8039
+ },
8040
+ required: ['pairId', 'status', 'confirm', 'requestKey'],
8041
+ type: 'object',
8042
+ },
8043
+ path: ['mentorship', 'pairs', 'setMine'],
8044
+ permission: 'mentorship.pairs.setMine',
8045
+ scope: 'self:write',
8046
+ summary: 'Pause, resume or end your own mentorship pairing',
8047
+ },
8048
+ {
8049
+ access: 'write',
8050
+ command: ['mentorship', 'pairs', 'suggest'],
8051
+ input: {
8052
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8053
+ additionalProperties: false,
8054
+ properties: {
8055
+ confirm: {
8056
+ const: 'mentorship.pairs.suggest',
8057
+ type: 'string',
8058
+ },
8059
+ programId: {
8060
+ type: 'string',
8061
+ },
8062
+ requestKey: {
8063
+ maxLength: 128,
8064
+ minLength: 1,
8065
+ type: 'string',
8066
+ },
8067
+ },
8068
+ required: ['programId', 'confirm', 'requestKey'],
8069
+ type: 'object',
8070
+ },
8071
+ path: ['mentorship', 'pairs', 'suggest'],
8072
+ permission: 'mentorship.pairs.suggest',
8073
+ scope: 'mentorship:write',
8074
+ summary: 'Suggest a mentor outside their reporting line for every mentee still waiting',
8075
+ },
8076
+ {
8077
+ access: 'read',
8078
+ command: ['mentorship', 'programs', 'get'],
8079
+ input: {
8080
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8081
+ additionalProperties: false,
8082
+ properties: {
8083
+ programId: {
8084
+ type: 'string',
8085
+ },
8086
+ },
8087
+ required: ['programId'],
8088
+ type: 'object',
8089
+ },
8090
+ path: ['mentorship', 'programs', 'get'],
8091
+ permission: 'mentorship.programs.get',
8092
+ scope: 'mentorship:read',
8093
+ summary: 'One mentorship program: who joined, the suggested pairs and whether pairs are meeting',
8094
+ },
8095
+ {
8096
+ access: 'read',
8097
+ command: ['mentorship', 'programs', 'list'],
8098
+ input: {
8099
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8100
+ additionalProperties: false,
8101
+ properties: {},
8102
+ type: 'object',
8103
+ },
8104
+ path: ['mentorship', 'programs', 'list'],
8105
+ permission: 'mentorship.programs.list',
8106
+ scope: 'mentorship:read',
8107
+ summary: 'List mentorship programs, with how many mentors, mentees and pairs each has',
8108
+ },
8109
+ {
8110
+ access: 'write',
8111
+ command: ['mentorship', 'programs', 'save'],
8112
+ input: {
8113
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8114
+ additionalProperties: false,
8115
+ properties: {
8116
+ checkInWeeks: {
8117
+ type: 'number',
8118
+ },
8119
+ confirm: {
8120
+ const: 'mentorship.programs.save',
8121
+ type: 'string',
8122
+ },
8123
+ description: {
8124
+ type: 'string',
8125
+ },
8126
+ groupId: {
8127
+ type: ['null', 'string'],
8128
+ },
8129
+ id: {
8130
+ type: 'string',
8131
+ },
8132
+ mentorCapacity: {
8133
+ type: 'number',
8134
+ },
8135
+ name: {
8136
+ type: 'string',
8137
+ },
8138
+ pairingWeeks: {
8139
+ type: 'number',
8140
+ },
8141
+ requestKey: {
8142
+ maxLength: 128,
8143
+ minLength: 1,
8144
+ type: 'string',
8145
+ },
8146
+ },
8147
+ required: ['name', 'confirm', 'requestKey'],
8148
+ type: 'object',
8149
+ },
8150
+ path: ['mentorship', 'programs', 'save'],
8151
+ permission: 'mentorship.programs.save',
8152
+ scope: 'mentorship:write',
8153
+ summary: 'Create or change a mentorship program: who can join, how long pairings last and how often pairs check in',
8154
+ },
8155
+ {
8156
+ access: 'write',
8157
+ command: ['mentorship', 'programs', 'set-status'],
8158
+ input: {
8159
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8160
+ additionalProperties: false,
8161
+ properties: {
8162
+ confirm: {
8163
+ const: 'mentorship.programs.setStatus',
8164
+ type: 'string',
8165
+ },
8166
+ programId: {
8167
+ type: 'string',
8168
+ },
8169
+ requestKey: {
8170
+ maxLength: 128,
8171
+ minLength: 1,
8172
+ type: 'string',
8173
+ },
8174
+ status: {
8175
+ anyOf: [
8176
+ {
8177
+ const: 'active',
8178
+ type: 'string',
8179
+ },
8180
+ {
8181
+ const: 'archived',
8182
+ type: 'string',
8183
+ },
8184
+ {
8185
+ const: 'paused',
8186
+ type: 'string',
8187
+ },
8188
+ ],
8189
+ },
8190
+ },
8191
+ required: ['programId', 'status', 'confirm', 'requestKey'],
8192
+ type: 'object',
8193
+ },
8194
+ path: ['mentorship', 'programs', 'setStatus'],
8195
+ permission: 'mentorship.programs.setStatus',
8196
+ scope: 'mentorship:write',
8197
+ summary: 'Turn mentorship programs on, pause one, or archive one and end its pairs',
8198
+ },
8199
+ {
8200
+ access: 'write',
8201
+ command: ['network', 'claim'],
8202
+ input: {
8203
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8204
+ additionalProperties: false,
8205
+ properties: {
8206
+ confirm: {
8207
+ const: 'network.claim',
8208
+ type: 'string',
8209
+ },
8210
+ kind: {
8211
+ anyOf: [
8212
+ {
8213
+ const: 'knows',
8214
+ type: 'string',
8215
+ },
8216
+ {
8217
+ const: 'wants_to_meet',
8218
+ type: 'string',
8219
+ },
8220
+ ],
8221
+ },
8222
+ on: {
8223
+ type: 'boolean',
8224
+ },
8225
+ personId: {
8226
+ type: 'string',
8227
+ },
8228
+ requestKey: {
8229
+ maxLength: 128,
8230
+ minLength: 1,
8231
+ type: 'string',
8232
+ },
8233
+ },
8234
+ required: ['kind', 'on', 'personId', 'confirm', 'requestKey'],
8235
+ type: 'object',
8236
+ },
8237
+ path: ['network', 'claim'],
8238
+ permission: 'network.claim',
8239
+ scope: 'profile:write',
8240
+ summary: 'Say you know someone or would like to meet them',
8241
+ },
8242
+ {
8243
+ access: 'read',
8244
+ command: ['network', 'introductions'],
8245
+ input: {
8246
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8247
+ additionalProperties: false,
8248
+ properties: {},
8249
+ type: 'object',
8250
+ },
8251
+ path: ['network', 'introductions'],
8252
+ permission: 'network.introductions',
8253
+ scope: 'users:read',
8254
+ summary: 'Your Connections programs, when your next introduction goes out, and who you met',
8255
+ },
8256
+ {
8257
+ access: 'read',
8258
+ command: ['network', 'mine'],
8259
+ input: {
8260
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8261
+ additionalProperties: false,
8262
+ properties: {},
8263
+ type: 'object',
8264
+ },
8265
+ path: ['network', 'mine'],
8266
+ permission: 'network.mine',
8267
+ scope: 'users:read',
8268
+ summary: 'Who you know and who you should meet',
8269
+ },
8270
+ {
8271
+ access: 'read',
8272
+ command: ['network', 'of-person'],
8273
+ input: {
8274
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8275
+ additionalProperties: false,
8276
+ properties: {
8277
+ personId: {
8278
+ type: 'string',
8279
+ },
8280
+ },
8281
+ required: ['personId'],
8282
+ type: 'object',
8283
+ },
8284
+ path: ['network', 'ofPerson'],
8285
+ permission: 'network.ofPerson',
8286
+ scope: 'users:read',
8287
+ summary: 'People you and this person both know',
8288
+ },
8289
+ {
8290
+ access: 'read',
8291
+ command: ['network', 'org-chart'],
8292
+ input: {
8293
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8294
+ additionalProperties: false,
8295
+ properties: {},
8296
+ type: 'object',
8297
+ },
8298
+ path: ['network', 'orgChart'],
8299
+ permission: 'network.orgChart',
8300
+ scope: 'users:read',
8301
+ summary: 'Everyone in the team with their manager, for the org chart',
8302
+ },
8303
+ {
8304
+ access: 'write',
8305
+ command: ['network', 'request-intro'],
8306
+ input: {
8307
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8308
+ additionalProperties: false,
8309
+ properties: {
8310
+ confirm: {
8311
+ const: 'network.requestIntro',
8312
+ type: 'string',
8313
+ },
8314
+ personId: {
8315
+ type: 'string',
8316
+ },
8317
+ requestKey: {
8318
+ maxLength: 128,
8319
+ minLength: 1,
8320
+ type: 'string',
8321
+ },
8322
+ viaId: {
8323
+ type: 'string',
8324
+ },
8325
+ },
8326
+ required: ['personId', 'viaId', 'confirm', 'requestKey'],
8327
+ type: 'object',
8328
+ },
8329
+ path: ['network', 'requestIntro'],
8330
+ permission: 'network.requestIntro',
8331
+ scope: 'profile:write',
8332
+ summary: 'Ask someone you both know to introduce you',
8333
+ },
8334
+ {
8335
+ access: 'read',
8336
+ command: ['notifications', 'preferences'],
8337
+ input: {
8338
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8339
+ additionalProperties: false,
8340
+ properties: {},
8341
+ type: 'object',
8342
+ },
8343
+ path: ['notifications', 'preferences'],
8344
+ permission: 'notifications.preferences',
8345
+ scope: 'self:read',
8346
+ summary: 'Read your notification preferences',
8347
+ },
8348
+ {
8349
+ access: 'write',
8350
+ command: ['notifications', 'save'],
8351
+ input: {
8352
+ $schema: 'https://json-schema.org/draft/2020-12/schema',
8353
+ additionalProperties: false,
8354
+ properties: {
8355
+ channel: {
8356
+ anyOf: [
8357
+ {
8358
+ const: 'email',
8359
+ type: 'string',
8360
+ },
8361
+ {
8362
+ const: 'slack',
8363
+ type: 'string',
8364
+ },
8365
+ {
8366
+ const: 'teams',
8367
+ type: 'string',
8368
+ },
8369
+ ],
8370
+ },
8371
+ enabled: {
8372
+ type: 'boolean',
8373
+ },
8374
+ kind: {
8375
+ anyOf: [
7720
8376
  {
7721
8377
  const: 'billing_limit',
7722
8378
  type: 'string',
@@ -7757,6 +8413,10 @@ export const commands = [
7757
8413
  const: 'legacy_upgrade',
7758
8414
  type: 'string',
7759
8415
  },
8416
+ {
8417
+ const: 'mentorship',
8418
+ type: 'string',
8419
+ },
7760
8420
  {
7761
8421
  const: 'playbook',
7762
8422
  type: 'string',
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "dependencies": {
3
3
  "@orpc/client": "1.15.3",
4
- "@shuffl/api-contracts": "0.5.5",
5
- "@shuffl/sdk": "0.5.5"
4
+ "@shuffl/api-contracts": "0.5.7",
5
+ "@shuffl/sdk": "0.5.7"
6
6
  },
7
7
  "description": "Shuffl command line: every public API operation as a scriptable command with JSON output.",
8
8
  "engines": {
@@ -33,7 +33,7 @@
33
33
  "sideEffects": false,
34
34
  "type": "module",
35
35
  "types": "./dist/index.d.ts",
36
- "version": "0.5.5",
36
+ "version": "0.5.7",
37
37
  "bin": {
38
38
  "shuffl": "./dist/bin.js"
39
39
  }