@shuffl/api-contracts 0.5.6 → 0.5.8
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.
- package/dist/base.d.ts +3 -1
- package/dist/base.js +5 -0
- package/dist/index.d.ts +872 -18
- package/dist/management-operations.d.ts +1 -1
- package/dist/management-operations.js +106 -1
- package/dist/management.generated.d.ts +840 -18
- package/dist/management.generated.js +661 -1
- package/dist/permissions.d.ts +33 -1
- package/dist/permissions.js +6 -1
- package/openapi.json +9457 -109
- package/package.json +1 -1
|
@@ -235,6 +235,21 @@ const credentials_api_createInput = z
|
|
|
235
235
|
z.literal('knowledge.uploads.retry'),
|
|
236
236
|
z.literal('manager.current'),
|
|
237
237
|
z.literal('mcp.knowledge'),
|
|
238
|
+
z.literal('mentorship.checkIns.answer'),
|
|
239
|
+
z.literal('mentorship.goals.remove'),
|
|
240
|
+
z.literal('mentorship.goals.save'),
|
|
241
|
+
z.literal('mentorship.join'),
|
|
242
|
+
z.literal('mentorship.leave'),
|
|
243
|
+
z.literal('mentorship.members.setStatus'),
|
|
244
|
+
z.literal('mentorship.mine'),
|
|
245
|
+
z.literal('mentorship.pairs.decide'),
|
|
246
|
+
z.literal('mentorship.pairs.end'),
|
|
247
|
+
z.literal('mentorship.pairs.setMine'),
|
|
248
|
+
z.literal('mentorship.pairs.suggest'),
|
|
249
|
+
z.literal('mentorship.programs.get'),
|
|
250
|
+
z.literal('mentorship.programs.list'),
|
|
251
|
+
z.literal('mentorship.programs.save'),
|
|
252
|
+
z.literal('mentorship.programs.setStatus'),
|
|
238
253
|
z.literal('network.claim'),
|
|
239
254
|
z.literal('network.introductions'),
|
|
240
255
|
z.literal('network.mine'),
|
|
@@ -2207,6 +2222,21 @@ const credentials_api_listOutput = z.strictObject({
|
|
|
2207
2222
|
z.literal('knowledge.uploads.retry'),
|
|
2208
2223
|
z.literal('manager.current'),
|
|
2209
2224
|
z.literal('mcp.knowledge'),
|
|
2225
|
+
z.literal('mentorship.checkIns.answer'),
|
|
2226
|
+
z.literal('mentorship.goals.remove'),
|
|
2227
|
+
z.literal('mentorship.goals.save'),
|
|
2228
|
+
z.literal('mentorship.join'),
|
|
2229
|
+
z.literal('mentorship.leave'),
|
|
2230
|
+
z.literal('mentorship.members.setStatus'),
|
|
2231
|
+
z.literal('mentorship.mine'),
|
|
2232
|
+
z.literal('mentorship.pairs.decide'),
|
|
2233
|
+
z.literal('mentorship.pairs.end'),
|
|
2234
|
+
z.literal('mentorship.pairs.setMine'),
|
|
2235
|
+
z.literal('mentorship.pairs.suggest'),
|
|
2236
|
+
z.literal('mentorship.programs.get'),
|
|
2237
|
+
z.literal('mentorship.programs.list'),
|
|
2238
|
+
z.literal('mentorship.programs.save'),
|
|
2239
|
+
z.literal('mentorship.programs.setStatus'),
|
|
2210
2240
|
z.literal('network.claim'),
|
|
2211
2241
|
z.literal('network.introductions'),
|
|
2212
2242
|
z.literal('network.mine'),
|
|
@@ -2427,6 +2457,8 @@ const credentials_api_listOutput = z.strictObject({
|
|
|
2427
2457
|
z.literal('knowledge:read'),
|
|
2428
2458
|
z.literal('knowledge:write'),
|
|
2429
2459
|
z.literal('manager:read'),
|
|
2460
|
+
z.literal('mentorship:read'),
|
|
2461
|
+
z.literal('mentorship:write'),
|
|
2430
2462
|
z.literal('operations:read'),
|
|
2431
2463
|
z.literal('operations:write'),
|
|
2432
2464
|
z.literal('operator:read'),
|
|
@@ -2640,6 +2672,21 @@ const credentials_api_listOutput = z.strictObject({
|
|
|
2640
2672
|
z.literal('knowledge.uploads.retry'),
|
|
2641
2673
|
z.literal('manager.current'),
|
|
2642
2674
|
z.literal('mcp.knowledge'),
|
|
2675
|
+
z.literal('mentorship.checkIns.answer'),
|
|
2676
|
+
z.literal('mentorship.goals.remove'),
|
|
2677
|
+
z.literal('mentorship.goals.save'),
|
|
2678
|
+
z.literal('mentorship.join'),
|
|
2679
|
+
z.literal('mentorship.leave'),
|
|
2680
|
+
z.literal('mentorship.members.setStatus'),
|
|
2681
|
+
z.literal('mentorship.mine'),
|
|
2682
|
+
z.literal('mentorship.pairs.decide'),
|
|
2683
|
+
z.literal('mentorship.pairs.end'),
|
|
2684
|
+
z.literal('mentorship.pairs.setMine'),
|
|
2685
|
+
z.literal('mentorship.pairs.suggest'),
|
|
2686
|
+
z.literal('mentorship.programs.get'),
|
|
2687
|
+
z.literal('mentorship.programs.list'),
|
|
2688
|
+
z.literal('mentorship.programs.save'),
|
|
2689
|
+
z.literal('mentorship.programs.setStatus'),
|
|
2643
2690
|
z.literal('network.claim'),
|
|
2644
2691
|
z.literal('network.introductions'),
|
|
2645
2692
|
z.literal('network.mine'),
|
|
@@ -2862,6 +2909,8 @@ const credentials_api_listOutput = z.strictObject({
|
|
|
2862
2909
|
z.literal('knowledge:read'),
|
|
2863
2910
|
z.literal('knowledge:write'),
|
|
2864
2911
|
z.literal('manager:read'),
|
|
2912
|
+
z.literal('mentorship:read'),
|
|
2913
|
+
z.literal('mentorship:write'),
|
|
2865
2914
|
z.literal('operations:read'),
|
|
2866
2915
|
z.literal('operations:write'),
|
|
2867
2916
|
z.literal('operator:read'),
|
|
@@ -5115,6 +5164,8 @@ const groups_allAutomationsOutput = z.strictObject({
|
|
|
5115
5164
|
])
|
|
5116
5165
|
.optional()
|
|
5117
5166
|
.optional(),
|
|
5167
|
+
channelId: z.string().optional().optional(),
|
|
5168
|
+
channelName: z.string().optional().optional(),
|
|
5118
5169
|
communityId: z.string().optional().optional(),
|
|
5119
5170
|
note: z.string().optional().optional(),
|
|
5120
5171
|
personId: z.string().optional().optional(),
|
|
@@ -5142,6 +5193,8 @@ const groups_allAutomationsOutput = z.strictObject({
|
|
|
5142
5193
|
z.literal('invite_community'),
|
|
5143
5194
|
z.literal('remove_from_group'),
|
|
5144
5195
|
z.literal('send_message'),
|
|
5196
|
+
z.literal('slack_invite'),
|
|
5197
|
+
z.literal('slack_post'),
|
|
5145
5198
|
z.literal('start_playbook'),
|
|
5146
5199
|
z.literal('tell_hr'),
|
|
5147
5200
|
z.literal('tell_manager'),
|
|
@@ -5213,6 +5266,8 @@ const groups_allAutomationsOutput = z.strictObject({
|
|
|
5213
5266
|
z.literal('invite_community'),
|
|
5214
5267
|
z.literal('remove_from_group'),
|
|
5215
5268
|
z.literal('send_message'),
|
|
5269
|
+
z.literal('slack_invite'),
|
|
5270
|
+
z.literal('slack_post'),
|
|
5216
5271
|
z.literal('start_playbook'),
|
|
5217
5272
|
z.literal('tell_hr'),
|
|
5218
5273
|
z.literal('tell_manager'),
|
|
@@ -5260,6 +5315,8 @@ const groups_automationsOutput = z.strictObject({
|
|
|
5260
5315
|
])
|
|
5261
5316
|
.optional()
|
|
5262
5317
|
.optional(),
|
|
5318
|
+
channelId: z.string().optional().optional(),
|
|
5319
|
+
channelName: z.string().optional().optional(),
|
|
5263
5320
|
communityId: z.string().optional().optional(),
|
|
5264
5321
|
note: z.string().optional().optional(),
|
|
5265
5322
|
personId: z.string().optional().optional(),
|
|
@@ -5281,6 +5338,8 @@ const groups_automationsOutput = z.strictObject({
|
|
|
5281
5338
|
z.literal('invite_community'),
|
|
5282
5339
|
z.literal('remove_from_group'),
|
|
5283
5340
|
z.literal('send_message'),
|
|
5341
|
+
z.literal('slack_invite'),
|
|
5342
|
+
z.literal('slack_post'),
|
|
5284
5343
|
z.literal('start_playbook'),
|
|
5285
5344
|
z.literal('tell_hr'),
|
|
5286
5345
|
z.literal('tell_manager'),
|
|
@@ -5316,6 +5375,8 @@ const groups_automationsOutput = z.strictObject({
|
|
|
5316
5375
|
z.literal('invite_community'),
|
|
5317
5376
|
z.literal('remove_from_group'),
|
|
5318
5377
|
z.literal('send_message'),
|
|
5378
|
+
z.literal('slack_invite'),
|
|
5379
|
+
z.literal('slack_post'),
|
|
5319
5380
|
z.literal('start_playbook'),
|
|
5320
5381
|
z.literal('tell_hr'),
|
|
5321
5382
|
z.literal('tell_manager'),
|
|
@@ -5366,6 +5427,7 @@ const groups_setAutomationInput = z
|
|
|
5366
5427
|
])
|
|
5367
5428
|
.optional()
|
|
5368
5429
|
.optional(),
|
|
5430
|
+
channelId: z.string().optional().optional(),
|
|
5369
5431
|
communityId: z.string().optional().optional(),
|
|
5370
5432
|
note: z.string().optional().optional(),
|
|
5371
5433
|
personId: z.string().optional().optional(),
|
|
@@ -5388,6 +5450,8 @@ const groups_setAutomationInput = z
|
|
|
5388
5450
|
z.literal('invite_community'),
|
|
5389
5451
|
z.literal('remove_from_group'),
|
|
5390
5452
|
z.literal('send_message'),
|
|
5453
|
+
z.literal('slack_invite'),
|
|
5454
|
+
z.literal('slack_post'),
|
|
5391
5455
|
z.literal('start_playbook'),
|
|
5392
5456
|
z.literal('tell_hr'),
|
|
5393
5457
|
z.literal('tell_manager'),
|
|
@@ -5422,6 +5486,8 @@ const groups_setAutomationOutput = z.object({
|
|
|
5422
5486
|
])
|
|
5423
5487
|
.optional()
|
|
5424
5488
|
.optional(),
|
|
5489
|
+
channelId: z.string().optional().optional(),
|
|
5490
|
+
channelName: z.string().optional().optional(),
|
|
5425
5491
|
communityId: z.string().optional().optional(),
|
|
5426
5492
|
note: z.string().optional().optional(),
|
|
5427
5493
|
personId: z.string().optional().optional(),
|
|
@@ -5443,6 +5509,8 @@ const groups_setAutomationOutput = z.object({
|
|
|
5443
5509
|
z.literal('invite_community'),
|
|
5444
5510
|
z.literal('remove_from_group'),
|
|
5445
5511
|
z.literal('send_message'),
|
|
5512
|
+
z.literal('slack_invite'),
|
|
5513
|
+
z.literal('slack_post'),
|
|
5446
5514
|
z.literal('start_playbook'),
|
|
5447
5515
|
z.literal('tell_hr'),
|
|
5448
5516
|
z.literal('tell_manager'),
|
|
@@ -6098,6 +6166,7 @@ const home_placesOutput = z.strictObject({
|
|
|
6098
6166
|
z.literal('communities'),
|
|
6099
6167
|
z.literal('connections'),
|
|
6100
6168
|
z.literal('knowledge'),
|
|
6169
|
+
z.literal('mentorship'),
|
|
6101
6170
|
z.literal('playbook'),
|
|
6102
6171
|
z.literal('praise'),
|
|
6103
6172
|
z.literal('pulse'),
|
|
@@ -11640,6 +11709,443 @@ const playbooks_askBuddyOutput = z.object({
|
|
|
11640
11709
|
])
|
|
11641
11710
|
.nullable(),
|
|
11642
11711
|
});
|
|
11712
|
+
const mentorship_programs_listInput = z.strictObject({});
|
|
11713
|
+
const mentorship_programs_listOutput = z.strictObject({
|
|
11714
|
+
programs: z.array(z.strictObject({
|
|
11715
|
+
activePairs: z.number(),
|
|
11716
|
+
audience: z.union([z.null(), z.string()]),
|
|
11717
|
+
checkInWeeks: z.number(),
|
|
11718
|
+
createdAt: z.string(),
|
|
11719
|
+
description: z.string(),
|
|
11720
|
+
groupId: z.union([z.null(), z.string()]),
|
|
11721
|
+
id: z.string(),
|
|
11722
|
+
mentees: z.number(),
|
|
11723
|
+
mentorCapacity: z.number(),
|
|
11724
|
+
mentors: z.number(),
|
|
11725
|
+
name: z.string(),
|
|
11726
|
+
pairingWeeks: z.number(),
|
|
11727
|
+
status: z.union([
|
|
11728
|
+
z.literal('active'),
|
|
11729
|
+
z.literal('archived'),
|
|
11730
|
+
z.literal('paused'),
|
|
11731
|
+
]),
|
|
11732
|
+
suggested: z.number(),
|
|
11733
|
+
waiting: z.number(),
|
|
11734
|
+
})),
|
|
11735
|
+
});
|
|
11736
|
+
const mentorship_programs_getInput = z.strictObject({ programId: z.string() });
|
|
11737
|
+
const mentorship_programs_getOutput = z.strictObject({
|
|
11738
|
+
members: z.array(z.strictObject({
|
|
11739
|
+
id: z.string(),
|
|
11740
|
+
joinedAt: z.string(),
|
|
11741
|
+
name: z.string(),
|
|
11742
|
+
pairs: z.number(),
|
|
11743
|
+
photoUrl: z.union([z.null(), z.string()]),
|
|
11744
|
+
role: z.union([z.literal('mentee'), z.literal('mentor')]),
|
|
11745
|
+
slackUserId: z.union([z.null(), z.string()]),
|
|
11746
|
+
status: z.union([
|
|
11747
|
+
z.literal('active'),
|
|
11748
|
+
z.literal('left'),
|
|
11749
|
+
z.literal('removed'),
|
|
11750
|
+
]),
|
|
11751
|
+
title: z.union([z.null(), z.string()]),
|
|
11752
|
+
topics: z.string(),
|
|
11753
|
+
userId: z.union([z.null(), z.string()]),
|
|
11754
|
+
})),
|
|
11755
|
+
pairs: z.array(z.strictObject({
|
|
11756
|
+
checkIns: z.strictObject({
|
|
11757
|
+
answered: z.number(),
|
|
11758
|
+
asked: z.number(),
|
|
11759
|
+
met: z.number(),
|
|
11760
|
+
}),
|
|
11761
|
+
endedAt: z.union([z.null(), z.string()]),
|
|
11762
|
+
endReason: z.union([
|
|
11763
|
+
z.null(),
|
|
11764
|
+
z.literal('completed'),
|
|
11765
|
+
z.literal('hr'),
|
|
11766
|
+
z.literal('mentee'),
|
|
11767
|
+
z.literal('mentor'),
|
|
11768
|
+
]),
|
|
11769
|
+
endsOn: z.union([z.null(), z.string()]),
|
|
11770
|
+
final: z.strictObject({
|
|
11771
|
+
mentee: z.union([
|
|
11772
|
+
z.null(),
|
|
11773
|
+
z.literal('helped'),
|
|
11774
|
+
z.literal('met'),
|
|
11775
|
+
z.literal('not_yet'),
|
|
11776
|
+
]),
|
|
11777
|
+
mentor: z.union([
|
|
11778
|
+
z.null(),
|
|
11779
|
+
z.literal('helped'),
|
|
11780
|
+
z.literal('met'),
|
|
11781
|
+
z.literal('not_yet'),
|
|
11782
|
+
]),
|
|
11783
|
+
}),
|
|
11784
|
+
id: z.string(),
|
|
11785
|
+
mentee: z.strictObject({
|
|
11786
|
+
id: z.string(),
|
|
11787
|
+
name: z.string(),
|
|
11788
|
+
photoUrl: z.union([z.null(), z.string()]),
|
|
11789
|
+
slackUserId: z.union([z.null(), z.string()]),
|
|
11790
|
+
title: z.union([z.null(), z.string()]),
|
|
11791
|
+
userId: z.union([z.null(), z.string()]),
|
|
11792
|
+
}),
|
|
11793
|
+
mentor: z.strictObject({
|
|
11794
|
+
id: z.string(),
|
|
11795
|
+
name: z.string(),
|
|
11796
|
+
photoUrl: z.union([z.null(), z.string()]),
|
|
11797
|
+
slackUserId: z.union([z.null(), z.string()]),
|
|
11798
|
+
title: z.union([z.null(), z.string()]),
|
|
11799
|
+
userId: z.union([z.null(), z.string()]),
|
|
11800
|
+
}),
|
|
11801
|
+
nextCheckInOn: z.union([z.null(), z.string()]),
|
|
11802
|
+
reasons: z.array(z.string()),
|
|
11803
|
+
startedAt: z.union([z.null(), z.string()]),
|
|
11804
|
+
status: z.union([
|
|
11805
|
+
z.literal('active'),
|
|
11806
|
+
z.literal('ended'),
|
|
11807
|
+
z.literal('paused'),
|
|
11808
|
+
z.literal('skipped'),
|
|
11809
|
+
z.literal('suggested'),
|
|
11810
|
+
]),
|
|
11811
|
+
suggestedAt: z.string(),
|
|
11812
|
+
})),
|
|
11813
|
+
program: z.strictObject({
|
|
11814
|
+
activePairs: z.number(),
|
|
11815
|
+
audience: z.union([z.null(), z.string()]),
|
|
11816
|
+
checkInWeeks: z.number(),
|
|
11817
|
+
createdAt: z.string(),
|
|
11818
|
+
description: z.string(),
|
|
11819
|
+
groupId: z.union([z.null(), z.string()]),
|
|
11820
|
+
id: z.string(),
|
|
11821
|
+
mentees: z.number(),
|
|
11822
|
+
mentorCapacity: z.number(),
|
|
11823
|
+
mentors: z.number(),
|
|
11824
|
+
name: z.string(),
|
|
11825
|
+
pairingWeeks: z.number(),
|
|
11826
|
+
status: z.union([
|
|
11827
|
+
z.literal('active'),
|
|
11828
|
+
z.literal('archived'),
|
|
11829
|
+
z.literal('paused'),
|
|
11830
|
+
]),
|
|
11831
|
+
suggested: z.number(),
|
|
11832
|
+
waiting: z.number(),
|
|
11833
|
+
}),
|
|
11834
|
+
});
|
|
11835
|
+
const mentorship_programs_saveInput = z
|
|
11836
|
+
.strictObject({
|
|
11837
|
+
checkInWeeks: z.number().optional().optional(),
|
|
11838
|
+
description: z.string().optional().optional(),
|
|
11839
|
+
groupId: z.union([z.null(), z.string()]).optional().optional(),
|
|
11840
|
+
id: z.string().optional().optional(),
|
|
11841
|
+
mentorCapacity: z.number().optional().optional(),
|
|
11842
|
+
name: z.string(),
|
|
11843
|
+
pairingWeeks: z.number().optional().optional(),
|
|
11844
|
+
})
|
|
11845
|
+
.extend({
|
|
11846
|
+
confirm: z.literal('mentorship.programs.save'),
|
|
11847
|
+
requestKey: z.string().min(1).max(128),
|
|
11848
|
+
});
|
|
11849
|
+
const mentorship_programs_saveOutput = z.object({
|
|
11850
|
+
receipt: commandReceiptSchema,
|
|
11851
|
+
result: z
|
|
11852
|
+
.strictObject({
|
|
11853
|
+
created: z.boolean(),
|
|
11854
|
+
grouped: z.boolean(),
|
|
11855
|
+
id: z.string(),
|
|
11856
|
+
})
|
|
11857
|
+
.nullable(),
|
|
11858
|
+
});
|
|
11859
|
+
const mentorship_programs_setStatusInput = z
|
|
11860
|
+
.strictObject({
|
|
11861
|
+
programId: z.string(),
|
|
11862
|
+
status: z.union([
|
|
11863
|
+
z.literal('active'),
|
|
11864
|
+
z.literal('archived'),
|
|
11865
|
+
z.literal('paused'),
|
|
11866
|
+
]),
|
|
11867
|
+
})
|
|
11868
|
+
.extend({
|
|
11869
|
+
confirm: z.literal('mentorship.programs.setStatus'),
|
|
11870
|
+
requestKey: z.string().min(1).max(128),
|
|
11871
|
+
});
|
|
11872
|
+
const mentorship_programs_setStatusOutput = z.object({
|
|
11873
|
+
receipt: commandReceiptSchema,
|
|
11874
|
+
result: z
|
|
11875
|
+
.strictObject({
|
|
11876
|
+
changed: z.boolean(),
|
|
11877
|
+
status: z.union([
|
|
11878
|
+
z.literal('active'),
|
|
11879
|
+
z.literal('archived'),
|
|
11880
|
+
z.literal('paused'),
|
|
11881
|
+
]),
|
|
11882
|
+
})
|
|
11883
|
+
.nullable(),
|
|
11884
|
+
});
|
|
11885
|
+
const mentorship_pairs_suggestInput = z
|
|
11886
|
+
.strictObject({ programId: z.string() })
|
|
11887
|
+
.extend({
|
|
11888
|
+
confirm: z.literal('mentorship.pairs.suggest'),
|
|
11889
|
+
requestKey: z.string().min(1).max(128),
|
|
11890
|
+
});
|
|
11891
|
+
const mentorship_pairs_suggestOutput = z.object({
|
|
11892
|
+
receipt: commandReceiptSchema,
|
|
11893
|
+
result: z
|
|
11894
|
+
.strictObject({ suggested: z.number(), waiting: z.number() })
|
|
11895
|
+
.nullable(),
|
|
11896
|
+
});
|
|
11897
|
+
const mentorship_pairs_decideInput = z
|
|
11898
|
+
.strictObject({
|
|
11899
|
+
decision: z.union([z.literal('approve'), z.literal('skip')]),
|
|
11900
|
+
pairId: z.string(),
|
|
11901
|
+
})
|
|
11902
|
+
.extend({
|
|
11903
|
+
confirm: z.literal('mentorship.pairs.decide'),
|
|
11904
|
+
requestKey: z.string().min(1).max(128),
|
|
11905
|
+
});
|
|
11906
|
+
const mentorship_pairs_decideOutput = z.object({
|
|
11907
|
+
receipt: commandReceiptSchema,
|
|
11908
|
+
result: z
|
|
11909
|
+
.union([
|
|
11910
|
+
z.strictObject({
|
|
11911
|
+
decision: z.literal('skip'),
|
|
11912
|
+
endsOn: z.undefined().optional(),
|
|
11913
|
+
reached: z.number(),
|
|
11914
|
+
status: z.literal('skipped'),
|
|
11915
|
+
}),
|
|
11916
|
+
z.strictObject({
|
|
11917
|
+
decision: z.literal('approve'),
|
|
11918
|
+
endsOn: z.string(),
|
|
11919
|
+
reached: z.number(),
|
|
11920
|
+
status: z.literal('active'),
|
|
11921
|
+
}),
|
|
11922
|
+
])
|
|
11923
|
+
.nullable(),
|
|
11924
|
+
});
|
|
11925
|
+
const mentorship_pairs_endInput = z
|
|
11926
|
+
.strictObject({ pairId: z.string() })
|
|
11927
|
+
.extend({
|
|
11928
|
+
confirm: z.literal('mentorship.pairs.end'),
|
|
11929
|
+
requestKey: z.string().min(1).max(128),
|
|
11930
|
+
});
|
|
11931
|
+
const mentorship_pairs_endOutput = z.object({
|
|
11932
|
+
receipt: commandReceiptSchema,
|
|
11933
|
+
result: z.strictObject({ changed: z.boolean() }).nullable(),
|
|
11934
|
+
});
|
|
11935
|
+
const mentorship_members_setStatusInput = z
|
|
11936
|
+
.strictObject({
|
|
11937
|
+
personId: z.string(),
|
|
11938
|
+
programId: z.string(),
|
|
11939
|
+
role: z.union([z.literal('mentee'), z.literal('mentor')]),
|
|
11940
|
+
status: z.union([z.literal('active'), z.literal('removed')]),
|
|
11941
|
+
})
|
|
11942
|
+
.extend({
|
|
11943
|
+
confirm: z.literal('mentorship.members.setStatus'),
|
|
11944
|
+
requestKey: z.string().min(1).max(128),
|
|
11945
|
+
});
|
|
11946
|
+
const mentorship_members_setStatusOutput = z.object({
|
|
11947
|
+
receipt: commandReceiptSchema,
|
|
11948
|
+
result: z.strictObject({ changed: z.boolean() }).nullable(),
|
|
11949
|
+
});
|
|
11950
|
+
const mentorship_mineInput = z.strictObject({});
|
|
11951
|
+
const mentorship_mineOutput = z.strictObject({
|
|
11952
|
+
pairs: z.array(z.strictObject({
|
|
11953
|
+
checkIns: z.array(z.strictObject({
|
|
11954
|
+
answer: z.union([
|
|
11955
|
+
z.null(),
|
|
11956
|
+
z.literal('helped'),
|
|
11957
|
+
z.literal('met'),
|
|
11958
|
+
z.literal('not_yet'),
|
|
11959
|
+
]),
|
|
11960
|
+
dueOn: z.string(),
|
|
11961
|
+
id: z.string(),
|
|
11962
|
+
kind: z.union([z.literal('check_in'), z.literal('final')]),
|
|
11963
|
+
})),
|
|
11964
|
+
endedAt: z.union([z.null(), z.string()]),
|
|
11965
|
+
endsOn: z.string(),
|
|
11966
|
+
goals: z.array(z.strictObject({
|
|
11967
|
+
done: z.boolean(),
|
|
11968
|
+
id: z.string(),
|
|
11969
|
+
title: z.string(),
|
|
11970
|
+
})),
|
|
11971
|
+
id: z.string(),
|
|
11972
|
+
nextCheckInOn: z.union([z.null(), z.string()]),
|
|
11973
|
+
other: z.strictObject({
|
|
11974
|
+
id: z.string(),
|
|
11975
|
+
name: z.string(),
|
|
11976
|
+
photoUrl: z.union([z.null(), z.string()]),
|
|
11977
|
+
slackUserId: z.union([z.null(), z.string()]),
|
|
11978
|
+
title: z.union([z.null(), z.string()]),
|
|
11979
|
+
userId: z.union([z.null(), z.string()]),
|
|
11980
|
+
}),
|
|
11981
|
+
otherTopics: z.string(),
|
|
11982
|
+
program: z.string(),
|
|
11983
|
+
role: z.union([z.literal('mentee'), z.literal('mentor')]),
|
|
11984
|
+
startedAt: z.string(),
|
|
11985
|
+
status: z.union([
|
|
11986
|
+
z.literal('active'),
|
|
11987
|
+
z.literal('ended'),
|
|
11988
|
+
z.literal('paused'),
|
|
11989
|
+
]),
|
|
11990
|
+
})),
|
|
11991
|
+
programs: z.array(z.strictObject({
|
|
11992
|
+
audience: z.union([z.null(), z.string()]),
|
|
11993
|
+
description: z.string(),
|
|
11994
|
+
id: z.string(),
|
|
11995
|
+
mentee: z.union([
|
|
11996
|
+
z.null(),
|
|
11997
|
+
z.strictObject({
|
|
11998
|
+
status: z.union([
|
|
11999
|
+
z.literal('active'),
|
|
12000
|
+
z.literal('left'),
|
|
12001
|
+
z.literal('removed'),
|
|
12002
|
+
]),
|
|
12003
|
+
topics: z.string(),
|
|
12004
|
+
}),
|
|
12005
|
+
]),
|
|
12006
|
+
mentor: z.union([
|
|
12007
|
+
z.null(),
|
|
12008
|
+
z.strictObject({
|
|
12009
|
+
status: z.union([
|
|
12010
|
+
z.literal('active'),
|
|
12011
|
+
z.literal('left'),
|
|
12012
|
+
z.literal('removed'),
|
|
12013
|
+
]),
|
|
12014
|
+
topics: z.string(),
|
|
12015
|
+
}),
|
|
12016
|
+
]),
|
|
12017
|
+
name: z.string(),
|
|
12018
|
+
terms: z.string(),
|
|
12019
|
+
waiting: z.boolean(),
|
|
12020
|
+
})),
|
|
12021
|
+
});
|
|
12022
|
+
const mentorship_joinInput = z
|
|
12023
|
+
.strictObject({
|
|
12024
|
+
programId: z.string(),
|
|
12025
|
+
role: z.union([z.literal('mentee'), z.literal('mentor')]),
|
|
12026
|
+
topics: z.string(),
|
|
12027
|
+
})
|
|
12028
|
+
.extend({
|
|
12029
|
+
confirm: z.literal('mentorship.join'),
|
|
12030
|
+
requestKey: z.string().min(1).max(128),
|
|
12031
|
+
});
|
|
12032
|
+
const mentorship_joinOutput = z.object({
|
|
12033
|
+
receipt: commandReceiptSchema,
|
|
12034
|
+
result: z
|
|
12035
|
+
.strictObject({
|
|
12036
|
+
joined: z.boolean(),
|
|
12037
|
+
role: z.union([z.literal('mentee'), z.literal('mentor')]),
|
|
12038
|
+
topics: z.boolean(),
|
|
12039
|
+
})
|
|
12040
|
+
.nullable(),
|
|
12041
|
+
});
|
|
12042
|
+
const mentorship_leaveInput = z
|
|
12043
|
+
.strictObject({
|
|
12044
|
+
programId: z.string(),
|
|
12045
|
+
role: z.union([z.literal('mentee'), z.literal('mentor')]),
|
|
12046
|
+
})
|
|
12047
|
+
.extend({
|
|
12048
|
+
confirm: z.literal('mentorship.leave'),
|
|
12049
|
+
requestKey: z.string().min(1).max(128),
|
|
12050
|
+
});
|
|
12051
|
+
const mentorship_leaveOutput = z.object({
|
|
12052
|
+
receipt: commandReceiptSchema,
|
|
12053
|
+
result: z
|
|
12054
|
+
.strictObject({
|
|
12055
|
+
changed: z.boolean(),
|
|
12056
|
+
role: z.union([z.literal('mentee'), z.literal('mentor')]),
|
|
12057
|
+
})
|
|
12058
|
+
.nullable(),
|
|
12059
|
+
});
|
|
12060
|
+
const mentorship_pairs_setMineInput = z
|
|
12061
|
+
.strictObject({
|
|
12062
|
+
pairId: z.string(),
|
|
12063
|
+
status: z.union([
|
|
12064
|
+
z.literal('active'),
|
|
12065
|
+
z.literal('ended'),
|
|
12066
|
+
z.literal('paused'),
|
|
12067
|
+
]),
|
|
12068
|
+
})
|
|
12069
|
+
.extend({
|
|
12070
|
+
confirm: z.literal('mentorship.pairs.setMine'),
|
|
12071
|
+
requestKey: z.string().min(1).max(128),
|
|
12072
|
+
});
|
|
12073
|
+
const mentorship_pairs_setMineOutput = z.object({
|
|
12074
|
+
receipt: commandReceiptSchema,
|
|
12075
|
+
result: z
|
|
12076
|
+
.strictObject({
|
|
12077
|
+
changed: z.boolean(),
|
|
12078
|
+
role: z.string(),
|
|
12079
|
+
status: z.union([
|
|
12080
|
+
z.literal('active'),
|
|
12081
|
+
z.literal('ended'),
|
|
12082
|
+
z.literal('paused'),
|
|
12083
|
+
]),
|
|
12084
|
+
})
|
|
12085
|
+
.nullable(),
|
|
12086
|
+
});
|
|
12087
|
+
const mentorship_goals_saveInput = z
|
|
12088
|
+
.strictObject({
|
|
12089
|
+
done: z
|
|
12090
|
+
.union([z.literal(false), z.literal(true)])
|
|
12091
|
+
.optional()
|
|
12092
|
+
.optional(),
|
|
12093
|
+
goalId: z.string().optional().optional(),
|
|
12094
|
+
pairId: z.string(),
|
|
12095
|
+
title: z.string().optional().optional(),
|
|
12096
|
+
})
|
|
12097
|
+
.extend({
|
|
12098
|
+
confirm: z.literal('mentorship.goals.save'),
|
|
12099
|
+
requestKey: z.string().min(1).max(128),
|
|
12100
|
+
});
|
|
12101
|
+
const mentorship_goals_saveOutput = z.object({
|
|
12102
|
+
receipt: commandReceiptSchema,
|
|
12103
|
+
result: z
|
|
12104
|
+
.strictObject({
|
|
12105
|
+
added: z.boolean(),
|
|
12106
|
+
done: z.boolean(),
|
|
12107
|
+
goalId: z.union([z.null(), z.string()]),
|
|
12108
|
+
})
|
|
12109
|
+
.nullable(),
|
|
12110
|
+
});
|
|
12111
|
+
const mentorship_goals_removeInput = z
|
|
12112
|
+
.strictObject({ goalId: z.string(), pairId: z.string() })
|
|
12113
|
+
.extend({
|
|
12114
|
+
confirm: z.literal('mentorship.goals.remove'),
|
|
12115
|
+
requestKey: z.string().min(1).max(128),
|
|
12116
|
+
});
|
|
12117
|
+
const mentorship_goals_removeOutput = z.object({
|
|
12118
|
+
receipt: commandReceiptSchema,
|
|
12119
|
+
result: z.strictObject({ removed: z.boolean() }).nullable(),
|
|
12120
|
+
});
|
|
12121
|
+
const mentorship_checkIns_answerInput = z
|
|
12122
|
+
.strictObject({
|
|
12123
|
+
answer: z.union([
|
|
12124
|
+
z.literal('helped'),
|
|
12125
|
+
z.literal('met'),
|
|
12126
|
+
z.literal('not_yet'),
|
|
12127
|
+
]),
|
|
12128
|
+
checkInId: z.string(),
|
|
12129
|
+
})
|
|
12130
|
+
.extend({
|
|
12131
|
+
confirm: z.literal('mentorship.checkIns.answer'),
|
|
12132
|
+
requestKey: z.string().min(1).max(128),
|
|
12133
|
+
});
|
|
12134
|
+
const mentorship_checkIns_answerOutput = z.object({
|
|
12135
|
+
receipt: commandReceiptSchema,
|
|
12136
|
+
result: z
|
|
12137
|
+
.strictObject({
|
|
12138
|
+
answer: z.union([
|
|
12139
|
+
z.literal('helped'),
|
|
12140
|
+
z.literal('met'),
|
|
12141
|
+
z.literal('not_yet'),
|
|
12142
|
+
]),
|
|
12143
|
+
changed: z.boolean(),
|
|
12144
|
+
kind: z.union([z.literal('check_in'), z.literal('final')]),
|
|
12145
|
+
role: z.union([z.literal('mentee'), z.literal('mentor')]),
|
|
12146
|
+
})
|
|
12147
|
+
.nullable(),
|
|
12148
|
+
});
|
|
11643
12149
|
const celebrations_programInput = z.strictObject({});
|
|
11644
12150
|
const celebrations_programOutput = z.strictObject({
|
|
11645
12151
|
programs: z.array(z.strictObject({
|
|
@@ -12242,6 +12748,7 @@ const notifications_preferencesOutput = z.strictObject({
|
|
|
12242
12748
|
z.literal('hr_reply'),
|
|
12243
12749
|
z.literal('hr_request'),
|
|
12244
12750
|
z.literal('legacy_upgrade'),
|
|
12751
|
+
z.literal('mentorship'),
|
|
12245
12752
|
z.literal('playbook'),
|
|
12246
12753
|
z.literal('policy_acknowledgement'),
|
|
12247
12754
|
z.literal('praise'),
|
|
@@ -12271,6 +12778,7 @@ const notifications_preferencesOutput = z.strictObject({
|
|
|
12271
12778
|
z.literal('hr_reply'),
|
|
12272
12779
|
z.literal('hr_request'),
|
|
12273
12780
|
z.literal('legacy_upgrade'),
|
|
12781
|
+
z.literal('mentorship'),
|
|
12274
12782
|
z.literal('playbook'),
|
|
12275
12783
|
z.literal('policy_acknowledgement'),
|
|
12276
12784
|
z.literal('praise'),
|
|
@@ -12304,6 +12812,7 @@ const notifications_saveInput = z
|
|
|
12304
12812
|
z.literal('hr_reply'),
|
|
12305
12813
|
z.literal('hr_request'),
|
|
12306
12814
|
z.literal('legacy_upgrade'),
|
|
12815
|
+
z.literal('mentorship'),
|
|
12307
12816
|
z.literal('playbook'),
|
|
12308
12817
|
z.literal('policy_acknowledgement'),
|
|
12309
12818
|
z.literal('praise'),
|
|
@@ -12336,6 +12845,7 @@ const notifications_saveOutput = z.object({
|
|
|
12336
12845
|
z.literal('hr_reply'),
|
|
12337
12846
|
z.literal('hr_request'),
|
|
12338
12847
|
z.literal('legacy_upgrade'),
|
|
12848
|
+
z.literal('mentorship'),
|
|
12339
12849
|
z.literal('playbook'),
|
|
12340
12850
|
z.literal('policy_acknowledgement'),
|
|
12341
12851
|
z.literal('praise'),
|
|
@@ -12369,6 +12879,7 @@ const notifications_saveOutput = z.object({
|
|
|
12369
12879
|
z.literal('hr_reply'),
|
|
12370
12880
|
z.literal('hr_request'),
|
|
12371
12881
|
z.literal('legacy_upgrade'),
|
|
12882
|
+
z.literal('mentorship'),
|
|
12372
12883
|
z.literal('playbook'),
|
|
12373
12884
|
z.literal('policy_acknowledgement'),
|
|
12374
12885
|
z.literal('praise'),
|
|
@@ -14036,6 +14547,8 @@ const users_activityOutput = z.strictObject({
|
|
|
14036
14547
|
z.literal('invite_community'),
|
|
14037
14548
|
z.literal('remove_from_group'),
|
|
14038
14549
|
z.literal('send_message'),
|
|
14550
|
+
z.literal('slack_invite'),
|
|
14551
|
+
z.literal('slack_post'),
|
|
14039
14552
|
z.literal('start_playbook'),
|
|
14040
14553
|
z.literal('tell_hr'),
|
|
14041
14554
|
z.literal('tell_manager'),
|
|
@@ -17784,7 +18297,7 @@ export const managementContract = {
|
|
|
17784
18297
|
.route({
|
|
17785
18298
|
method: 'POST',
|
|
17786
18299
|
path: '/manage/groups/setAutomation',
|
|
17787
|
-
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',
|
|
18300
|
+
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, add to or post in a Slack channel (`config.channelId`, read back from Slack), or tell HR, their manager or someone named, right away or days later; a new one starts paused',
|
|
17788
18301
|
})
|
|
17789
18302
|
.input(groups_setAutomationInput)
|
|
17790
18303
|
.output(groups_setAutomationOutput),
|
|
@@ -18433,6 +18946,153 @@ export const managementContract = {
|
|
|
18433
18946
|
.output(knowledge_uploads_retryOutput),
|
|
18434
18947
|
},
|
|
18435
18948
|
},
|
|
18949
|
+
mentorship: {
|
|
18950
|
+
checkIns: {
|
|
18951
|
+
answer: base
|
|
18952
|
+
.meta({ scope: 'self:write' })
|
|
18953
|
+
.route({
|
|
18954
|
+
method: 'POST',
|
|
18955
|
+
path: '/manage/mentorship/checkIns/answer',
|
|
18956
|
+
summary: 'Answer whether you met your mentor or mentee, and whether it helped',
|
|
18957
|
+
})
|
|
18958
|
+
.input(mentorship_checkIns_answerInput)
|
|
18959
|
+
.output(mentorship_checkIns_answerOutput),
|
|
18960
|
+
},
|
|
18961
|
+
goals: {
|
|
18962
|
+
remove: base
|
|
18963
|
+
.meta({ scope: 'self:write' })
|
|
18964
|
+
.route({
|
|
18965
|
+
method: 'POST',
|
|
18966
|
+
path: '/manage/mentorship/goals/remove',
|
|
18967
|
+
summary: 'Remove a goal from your mentorship, as the mentee',
|
|
18968
|
+
})
|
|
18969
|
+
.input(mentorship_goals_removeInput)
|
|
18970
|
+
.output(mentorship_goals_removeOutput),
|
|
18971
|
+
save: base
|
|
18972
|
+
.meta({ scope: 'self:write' })
|
|
18973
|
+
.route({
|
|
18974
|
+
method: 'POST',
|
|
18975
|
+
path: '/manage/mentorship/goals/save',
|
|
18976
|
+
summary: 'Add, rename or check off a goal in your mentorship, as the mentee',
|
|
18977
|
+
})
|
|
18978
|
+
.input(mentorship_goals_saveInput)
|
|
18979
|
+
.output(mentorship_goals_saveOutput),
|
|
18980
|
+
},
|
|
18981
|
+
join: base
|
|
18982
|
+
.meta({ scope: 'self:write' })
|
|
18983
|
+
.route({
|
|
18984
|
+
method: 'POST',
|
|
18985
|
+
path: '/manage/mentorship/join',
|
|
18986
|
+
summary: 'Join a mentorship program as a mentor or mentee, saying what you can help with or want to learn',
|
|
18987
|
+
})
|
|
18988
|
+
.input(mentorship_joinInput)
|
|
18989
|
+
.output(mentorship_joinOutput),
|
|
18990
|
+
leave: base
|
|
18991
|
+
.meta({ scope: 'self:write' })
|
|
18992
|
+
.route({
|
|
18993
|
+
method: 'POST',
|
|
18994
|
+
path: '/manage/mentorship/leave',
|
|
18995
|
+
summary: 'Leave a mentorship program as a mentor or mentee',
|
|
18996
|
+
})
|
|
18997
|
+
.input(mentorship_leaveInput)
|
|
18998
|
+
.output(mentorship_leaveOutput),
|
|
18999
|
+
members: {
|
|
19000
|
+
setStatus: base
|
|
19001
|
+
.meta({ scope: 'mentorship:write' })
|
|
19002
|
+
.route({
|
|
19003
|
+
method: 'POST',
|
|
19004
|
+
path: '/manage/mentorship/members/setStatus',
|
|
19005
|
+
summary: 'Take someone off a mentorship program, or put them back',
|
|
19006
|
+
})
|
|
19007
|
+
.input(mentorship_members_setStatusInput)
|
|
19008
|
+
.output(mentorship_members_setStatusOutput),
|
|
19009
|
+
},
|
|
19010
|
+
mine: base
|
|
19011
|
+
.meta({ scope: 'self:read' })
|
|
19012
|
+
.route({
|
|
19013
|
+
method: 'POST',
|
|
19014
|
+
path: '/manage/mentorship/mine',
|
|
19015
|
+
summary: 'Your mentorship programs and pairings, with goals and check-ins',
|
|
19016
|
+
})
|
|
19017
|
+
.input(mentorship_mineInput)
|
|
19018
|
+
.output(mentorship_mineOutput),
|
|
19019
|
+
pairs: {
|
|
19020
|
+
decide: base
|
|
19021
|
+
.meta({ scope: 'mentorship:write' })
|
|
19022
|
+
.route({
|
|
19023
|
+
method: 'POST',
|
|
19024
|
+
path: '/manage/mentorship/pairs/decide',
|
|
19025
|
+
summary: 'Approve a suggested mentorship pair, which introduces them, or skip it',
|
|
19026
|
+
})
|
|
19027
|
+
.input(mentorship_pairs_decideInput)
|
|
19028
|
+
.output(mentorship_pairs_decideOutput),
|
|
19029
|
+
end: base
|
|
19030
|
+
.meta({ scope: 'mentorship:write' })
|
|
19031
|
+
.route({
|
|
19032
|
+
method: 'POST',
|
|
19033
|
+
path: '/manage/mentorship/pairs/end',
|
|
19034
|
+
summary: 'End a mentorship pairing early',
|
|
19035
|
+
})
|
|
19036
|
+
.input(mentorship_pairs_endInput)
|
|
19037
|
+
.output(mentorship_pairs_endOutput),
|
|
19038
|
+
setMine: base
|
|
19039
|
+
.meta({ scope: 'self:write' })
|
|
19040
|
+
.route({
|
|
19041
|
+
method: 'POST',
|
|
19042
|
+
path: '/manage/mentorship/pairs/setMine',
|
|
19043
|
+
summary: 'Pause, resume or end your own mentorship pairing',
|
|
19044
|
+
})
|
|
19045
|
+
.input(mentorship_pairs_setMineInput)
|
|
19046
|
+
.output(mentorship_pairs_setMineOutput),
|
|
19047
|
+
suggest: base
|
|
19048
|
+
.meta({ scope: 'mentorship:write' })
|
|
19049
|
+
.route({
|
|
19050
|
+
method: 'POST',
|
|
19051
|
+
path: '/manage/mentorship/pairs/suggest',
|
|
19052
|
+
summary: 'Suggest a mentor outside their reporting line for every mentee still waiting',
|
|
19053
|
+
})
|
|
19054
|
+
.input(mentorship_pairs_suggestInput)
|
|
19055
|
+
.output(mentorship_pairs_suggestOutput),
|
|
19056
|
+
},
|
|
19057
|
+
programs: {
|
|
19058
|
+
get: base
|
|
19059
|
+
.meta({ scope: 'mentorship:read' })
|
|
19060
|
+
.route({
|
|
19061
|
+
method: 'POST',
|
|
19062
|
+
path: '/manage/mentorship/programs/get',
|
|
19063
|
+
summary: 'One mentorship program: who joined, the suggested pairs and whether pairs are meeting',
|
|
19064
|
+
})
|
|
19065
|
+
.input(mentorship_programs_getInput)
|
|
19066
|
+
.output(mentorship_programs_getOutput),
|
|
19067
|
+
list: base
|
|
19068
|
+
.meta({ scope: 'mentorship:read' })
|
|
19069
|
+
.route({
|
|
19070
|
+
method: 'POST',
|
|
19071
|
+
path: '/manage/mentorship/programs/list',
|
|
19072
|
+
summary: 'List mentorship programs, with how many mentors, mentees and pairs each has',
|
|
19073
|
+
})
|
|
19074
|
+
.input(mentorship_programs_listInput)
|
|
19075
|
+
.output(mentorship_programs_listOutput),
|
|
19076
|
+
save: base
|
|
19077
|
+
.meta({ scope: 'mentorship:write' })
|
|
19078
|
+
.route({
|
|
19079
|
+
method: 'POST',
|
|
19080
|
+
path: '/manage/mentorship/programs/save',
|
|
19081
|
+
summary: 'Create or change a mentorship program: who can join, how long pairings last and how often pairs check in',
|
|
19082
|
+
})
|
|
19083
|
+
.input(mentorship_programs_saveInput)
|
|
19084
|
+
.output(mentorship_programs_saveOutput),
|
|
19085
|
+
setStatus: base
|
|
19086
|
+
.meta({ scope: 'mentorship:write' })
|
|
19087
|
+
.route({
|
|
19088
|
+
method: 'POST',
|
|
19089
|
+
path: '/manage/mentorship/programs/setStatus',
|
|
19090
|
+
summary: 'Turn mentorship programs on, pause one, or archive one and end its pairs',
|
|
19091
|
+
})
|
|
19092
|
+
.input(mentorship_programs_setStatusInput)
|
|
19093
|
+
.output(mentorship_programs_setStatusOutput),
|
|
19094
|
+
},
|
|
19095
|
+
},
|
|
18436
19096
|
network: {
|
|
18437
19097
|
claim: base
|
|
18438
19098
|
.meta({ scope: 'profile:write' })
|