@shuffl/api-contracts 0.5.7 → 0.5.9

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.
Files changed (8) hide show
  1. package/dist/index.d.ts +104 -12
  2. package/dist/management-operations.d.ts +1 -1
  3. package/dist/management-operations.js +8 -1
  4. package/dist/management.generated.d.ts +102 -12
  5. package/dist/management.generated.js +143 -1
  6. package/dist/permissions.d.ts +2 -0
  7. package/openapi.json +1077 -171
  8. package/package.json +1 -1
package/dist/management.generated.js CHANGED
@@ -267,6 +267,7 @@ const credentials_api_createInput = z
267
267
  z.literal('playbooks.answerBuddyFollowUp'),
268
268
  z.literal('playbooks.answerCheckIn'),
269
269
  z.literal('playbooks.answerFirstDaysCheckIn'),
270
+ z.literal('playbooks.answerForm'),
270
271
  z.literal('playbooks.approve'),
271
272
  z.literal('playbooks.askBuddy'),
272
273
  z.literal('playbooks.assignBuddy'),
@@ -853,6 +854,7 @@ const exports_teamOutput = z.strictObject({
853
854
  location: z.string().optional().optional(),
854
855
  offers: z.string().optional().optional(),
855
856
  phone: z.string().optional().optional(),
857
+ preferredName: z.string().optional().optional(),
856
858
  pronouns: z.string().optional().optional(),
857
859
  role: z.string().optional().optional(),
858
860
  workingOn: z.string().optional().optional(),
@@ -1116,6 +1118,16 @@ const exports_teamOutput = z.strictObject({
1116
1118
  ])
1117
1119
  .optional()
1118
1120
  .optional(),
1121
+ formFields: z
1122
+ .array(z.union([
1123
+ z.literal('bio'),
1124
+ z.literal('birthday'),
1125
+ z.literal('photo'),
1126
+ z.literal('preferredName'),
1127
+ z.literal('pronouns'),
1128
+ ]))
1129
+ .optional()
1130
+ .optional(),
1119
1131
  id: z.string(),
1120
1132
  kind: z.union([
1121
1133
  z.literal('acknowledge'),
@@ -2254,6 +2266,7 @@ const credentials_api_listOutput = z.strictObject({
2254
2266
  z.literal('playbooks.answerBuddyFollowUp'),
2255
2267
  z.literal('playbooks.answerCheckIn'),
2256
2268
  z.literal('playbooks.answerFirstDaysCheckIn'),
2269
+ z.literal('playbooks.answerForm'),
2257
2270
  z.literal('playbooks.approve'),
2258
2271
  z.literal('playbooks.askBuddy'),
2259
2272
  z.literal('playbooks.assignBuddy'),
@@ -2704,6 +2717,7 @@ const credentials_api_listOutput = z.strictObject({
2704
2717
  z.literal('playbooks.answerBuddyFollowUp'),
2705
2718
  z.literal('playbooks.answerCheckIn'),
2706
2719
  z.literal('playbooks.answerFirstDaysCheckIn'),
2720
+ z.literal('playbooks.answerForm'),
2707
2721
  z.literal('playbooks.approve'),
2708
2722
  z.literal('playbooks.askBuddy'),
2709
2723
  z.literal('playbooks.assignBuddy'),
@@ -3096,6 +3110,7 @@ const users_detailsOutput = z.strictObject({
3096
3110
  location: z.string().optional().optional(),
3097
3111
  offers: z.string().optional().optional(),
3098
3112
  phone: z.string().optional().optional(),
3113
+ preferredName: z.string().optional().optional(),
3099
3114
  pronouns: z.string().optional().optional(),
3100
3115
  role: z.string().optional().optional(),
3101
3116
  workingOn: z.string().optional().optional(),
@@ -3208,6 +3223,7 @@ const users_pageOutput = z.strictObject({
3208
3223
  location: z.string().optional().optional(),
3209
3224
  offers: z.string().optional().optional(),
3210
3225
  phone: z.string().optional().optional(),
3226
+ preferredName: z.string().optional().optional(),
3211
3227
  pronouns: z.string().optional().optional(),
3212
3228
  role: z.string().optional().optional(),
3213
3229
  workingOn: z.string().optional().optional(),
@@ -3309,6 +3325,7 @@ const users_participantsOutput = z.union([
3309
3325
  location: z.string().optional().optional(),
3310
3326
  offers: z.string().optional().optional(),
3311
3327
  phone: z.string().optional().optional(),
3328
+ preferredName: z.string().optional().optional(),
3312
3329
  pronouns: z.string().optional().optional(),
3313
3330
  role: z.string().optional().optional(),
3314
3331
  workingOn: z.string().optional().optional(),
@@ -3341,6 +3358,7 @@ const users_participantsOutput = z.union([
3341
3358
  location: z.string().optional().optional(),
3342
3359
  offers: z.string().optional().optional(),
3343
3360
  phone: z.string().optional().optional(),
3361
+ preferredName: z.string().optional().optional(),
3344
3362
  pronouns: z.string().optional().optional(),
3345
3363
  role: z.string().optional().optional(),
3346
3364
  workingOn: z.string().optional().optional(),
@@ -3484,6 +3502,7 @@ const users_saveOutput = z.object({
3484
3502
  location: z.string().optional().optional(),
3485
3503
  offers: z.string().optional().optional(),
3486
3504
  phone: z.string().optional().optional(),
3505
+ preferredName: z.string().optional().optional(),
3487
3506
  pronouns: z.string().optional().optional(),
3488
3507
  role: z.string().optional().optional(),
3489
3508
  workingOn: z.string().optional().optional(),
@@ -3694,6 +3713,7 @@ const profiles_getOutput = z.strictObject({
3694
3713
  location: z.union([z.null(), z.string()]),
3695
3714
  offers: z.union([z.null(), z.string()]),
3696
3715
  phone: z.union([z.null(), z.string()]),
3716
+ preferredName: z.string(),
3697
3717
  pronouns: z.union([z.null(), z.string()]),
3698
3718
  workingOn: z.union([z.null(), z.string()]),
3699
3719
  }),
@@ -3890,6 +3910,7 @@ const profiles_saveInput = z
3890
3910
  offers: z.string().optional().optional(),
3891
3911
  personId: z.string(),
3892
3912
  phone: z.string().optional().optional(),
3913
+ preferredName: z.string().optional().optional(),
3893
3914
  pronouns: z.string().optional().optional(),
3894
3915
  workingOn: z.string().optional().optional(),
3895
3916
  })
@@ -5164,6 +5185,8 @@ const groups_allAutomationsOutput = z.strictObject({
5164
5185
  ])
5165
5186
  .optional()
5166
5187
  .optional(),
5188
+ channelId: z.string().optional().optional(),
5189
+ channelName: z.string().optional().optional(),
5167
5190
  communityId: z.string().optional().optional(),
5168
5191
  note: z.string().optional().optional(),
5169
5192
  personId: z.string().optional().optional(),
@@ -5191,6 +5214,8 @@ const groups_allAutomationsOutput = z.strictObject({
5191
5214
  z.literal('invite_community'),
5192
5215
  z.literal('remove_from_group'),
5193
5216
  z.literal('send_message'),
5217
+ z.literal('slack_invite'),
5218
+ z.literal('slack_post'),
5194
5219
  z.literal('start_playbook'),
5195
5220
  z.literal('tell_hr'),
5196
5221
  z.literal('tell_manager'),
@@ -5262,6 +5287,8 @@ const groups_allAutomationsOutput = z.strictObject({
5262
5287
  z.literal('invite_community'),
5263
5288
  z.literal('remove_from_group'),
5264
5289
  z.literal('send_message'),
5290
+ z.literal('slack_invite'),
5291
+ z.literal('slack_post'),
5265
5292
  z.literal('start_playbook'),
5266
5293
  z.literal('tell_hr'),
5267
5294
  z.literal('tell_manager'),
@@ -5309,6 +5336,8 @@ const groups_automationsOutput = z.strictObject({
5309
5336
  ])
5310
5337
  .optional()
5311
5338
  .optional(),
5339
+ channelId: z.string().optional().optional(),
5340
+ channelName: z.string().optional().optional(),
5312
5341
  communityId: z.string().optional().optional(),
5313
5342
  note: z.string().optional().optional(),
5314
5343
  personId: z.string().optional().optional(),
@@ -5330,6 +5359,8 @@ const groups_automationsOutput = z.strictObject({
5330
5359
  z.literal('invite_community'),
5331
5360
  z.literal('remove_from_group'),
5332
5361
  z.literal('send_message'),
5362
+ z.literal('slack_invite'),
5363
+ z.literal('slack_post'),
5333
5364
  z.literal('start_playbook'),
5334
5365
  z.literal('tell_hr'),
5335
5366
  z.literal('tell_manager'),
@@ -5365,6 +5396,8 @@ const groups_automationsOutput = z.strictObject({
5365
5396
  z.literal('invite_community'),
5366
5397
  z.literal('remove_from_group'),
5367
5398
  z.literal('send_message'),
5399
+ z.literal('slack_invite'),
5400
+ z.literal('slack_post'),
5368
5401
  z.literal('start_playbook'),
5369
5402
  z.literal('tell_hr'),
5370
5403
  z.literal('tell_manager'),
@@ -5415,6 +5448,7 @@ const groups_setAutomationInput = z
5415
5448
  ])
5416
5449
  .optional()
5417
5450
  .optional(),
5451
+ channelId: z.string().optional().optional(),
5418
5452
  communityId: z.string().optional().optional(),
5419
5453
  note: z.string().optional().optional(),
5420
5454
  personId: z.string().optional().optional(),
@@ -5437,6 +5471,8 @@ const groups_setAutomationInput = z
5437
5471
  z.literal('invite_community'),
5438
5472
  z.literal('remove_from_group'),
5439
5473
  z.literal('send_message'),
5474
+ z.literal('slack_invite'),
5475
+ z.literal('slack_post'),
5440
5476
  z.literal('start_playbook'),
5441
5477
  z.literal('tell_hr'),
5442
5478
  z.literal('tell_manager'),
@@ -5471,6 +5507,8 @@ const groups_setAutomationOutput = z.object({
5471
5507
  ])
5472
5508
  .optional()
5473
5509
  .optional(),
5510
+ channelId: z.string().optional().optional(),
5511
+ channelName: z.string().optional().optional(),
5474
5512
  communityId: z.string().optional().optional(),
5475
5513
  note: z.string().optional().optional(),
5476
5514
  personId: z.string().optional().optional(),
@@ -5492,6 +5530,8 @@ const groups_setAutomationOutput = z.object({
5492
5530
  z.literal('invite_community'),
5493
5531
  z.literal('remove_from_group'),
5494
5532
  z.literal('send_message'),
5533
+ z.literal('slack_invite'),
5534
+ z.literal('slack_post'),
5495
5535
  z.literal('start_playbook'),
5496
5536
  z.literal('tell_hr'),
5497
5537
  z.literal('tell_manager'),
@@ -7086,6 +7126,7 @@ const runs_detailsOutput = z.strictObject({
7086
7126
  location: z.string().optional().optional(),
7087
7127
  offers: z.string().optional().optional(),
7088
7128
  phone: z.string().optional().optional(),
7129
+ preferredName: z.string().optional().optional(),
7089
7130
  pronouns: z.string().optional().optional(),
7090
7131
  role: z.string().optional().optional(),
7091
7132
  workingOn: z.string().optional().optional(),
@@ -9237,6 +9278,16 @@ const reports_overviewOutput = z.strictObject({
9237
9278
  ])
9238
9279
  .optional()
9239
9280
  .optional(),
9281
+ formFields: z
9282
+ .array(z.union([
9283
+ z.literal('bio'),
9284
+ z.literal('birthday'),
9285
+ z.literal('photo'),
9286
+ z.literal('preferredName'),
9287
+ z.literal('pronouns'),
9288
+ ]))
9289
+ .optional()
9290
+ .optional(),
9240
9291
  id: z.string(),
9241
9292
  kind: z.union([
9242
9293
  z.literal('acknowledge'),
@@ -9806,6 +9857,16 @@ const playbooks_programOutput = z.strictObject({
9806
9857
  ])
9807
9858
  .optional()
9808
9859
  .optional(),
9860
+ formFields: z
9861
+ .array(z.union([
9862
+ z.literal('bio'),
9863
+ z.literal('birthday'),
9864
+ z.literal('photo'),
9865
+ z.literal('preferredName'),
9866
+ z.literal('pronouns'),
9867
+ ]))
9868
+ .optional()
9869
+ .optional(),
9809
9870
  id: z.string(),
9810
9871
  kind: z.union([
9811
9872
  z.literal('acknowledge'),
@@ -10143,10 +10204,21 @@ const playbooks_saveProgramInput = z
10143
10204
  ])
10144
10205
  .optional()
10145
10206
  .optional(),
10207
+ formFields: z
10208
+ .array(z.union([
10209
+ z.literal('bio'),
10210
+ z.literal('birthday'),
10211
+ z.literal('photo'),
10212
+ z.literal('preferredName'),
10213
+ z.literal('pronouns'),
10214
+ ]))
10215
+ .optional()
10216
+ .optional(),
10146
10217
  id: z.string(),
10147
10218
  kind: z.union([
10148
10219
  z.literal('acknowledge'),
10149
10220
  z.literal('checkpoint'),
10221
+ z.literal('form'),
10150
10222
  z.literal('meet'),
10151
10223
  z.literal('message'),
10152
10224
  z.literal('task'),
@@ -10359,6 +10431,16 @@ const playbooks_saveProgramOutput = z.object({
10359
10431
  ])
10360
10432
  .optional()
10361
10433
  .optional(),
10434
+ formFields: z
10435
+ .array(z.union([
10436
+ z.literal('bio'),
10437
+ z.literal('birthday'),
10438
+ z.literal('photo'),
10439
+ z.literal('preferredName'),
10440
+ z.literal('pronouns'),
10441
+ ]))
10442
+ .optional()
10443
+ .optional(),
10362
10444
  id: z.string(),
10363
10445
  kind: z.union([
10364
10446
  z.literal('acknowledge'),
@@ -11145,6 +11227,19 @@ const playbooks_runOutput = z.union([
11145
11227
  ]),
11146
11228
  enrolled: z.boolean(),
11147
11229
  enrollmentId: z.union([z.null(), z.string()]),
11230
+ formValues: z.union([
11231
+ z.null(),
11232
+ z.strictObject({
11233
+ bio: z.string(),
11234
+ birthday: z.union([
11235
+ z.null(),
11236
+ z.strictObject({ day: z.number(), month: z.number() }),
11237
+ ]),
11238
+ photo: z.boolean(),
11239
+ preferredName: z.string(),
11240
+ pronouns: z.string(),
11241
+ }),
11242
+ ]),
11148
11243
  gettingReady: z.array(z.strictObject({
11149
11244
  done: z.boolean(),
11150
11245
  due: z.union([z.null(), z.string()]),
@@ -11176,6 +11271,7 @@ const playbooks_runOutput = z.union([
11176
11271
  title: z.union([z.null(), z.string()]),
11177
11272
  userId: z.union([z.null(), z.string()]),
11178
11273
  })),
11274
+ personId: z.string(),
11179
11275
  playbooks: z.array(z.strictObject({
11180
11276
  current: z.boolean(),
11181
11277
  dayZero: z.union([
@@ -11224,10 +11320,24 @@ const playbooks_runOutput = z.union([
11224
11320
  confirmedAt: z.union([z.null(), z.iso.datetime({ offset: true })]),
11225
11321
  date: z.string(),
11226
11322
  day: z.number(),
11323
+ form: z.union([
11324
+ z.null(),
11325
+ z.strictObject({
11326
+ answeredAt: z.union([z.null(), z.iso.datetime({ offset: true })]),
11327
+ fields: z.array(z.union([
11328
+ z.literal('bio'),
11329
+ z.literal('birthday'),
11330
+ z.literal('photo'),
11331
+ z.literal('preferredName'),
11332
+ z.literal('pronouns'),
11333
+ ])),
11334
+ }),
11335
+ ]),
11227
11336
  kind: z.union([
11228
11337
  z.literal('acknowledge'),
11229
11338
  z.literal('check_in'),
11230
11339
  z.literal('checkpoint'),
11340
+ z.literal('form'),
11231
11341
  z.literal('introduction'),
11232
11342
  z.literal('meet'),
11233
11343
  z.literal('message'),
@@ -11606,6 +11716,27 @@ const playbooks_respondBuddyOutput = z.object({
11606
11716
  receipt: commandReceiptSchema,
11607
11717
  result: z.strictObject({ status: z.string() }).nullable(),
11608
11718
  });
11719
+ const playbooks_answerFormInput = z
11720
+ .strictObject({
11721
+ bio: z.string().optional().optional(),
11722
+ birthday: z
11723
+ .union([z.null(), z.strictObject({ day: z.number(), month: z.number() })])
11724
+ .optional()
11725
+ .optional(),
11726
+ preferredName: z.string().optional().optional(),
11727
+ pronouns: z.string().optional().optional(),
11728
+ stepId: z.string(),
11729
+ })
11730
+ .extend({
11731
+ confirm: z.literal('playbooks.answerForm'),
11732
+ requestKey: z.string().min(1).max(128),
11733
+ });
11734
+ const playbooks_answerFormOutput = z.object({
11735
+ receipt: commandReceiptSchema,
11736
+ result: z
11737
+ .strictObject({ answered: z.literal(true), fields: z.number() })
11738
+ .nullable(),
11739
+ });
11609
11740
  const playbooks_buddySuggestionsInput = z.strictObject({});
11610
11741
  const playbooks_buddySuggestionsOutput = z.union([
11611
11742
  z.strictObject({
@@ -14528,6 +14659,8 @@ const users_activityOutput = z.strictObject({
14528
14659
  z.literal('invite_community'),
14529
14660
  z.literal('remove_from_group'),
14530
14661
  z.literal('send_message'),
14662
+ z.literal('slack_invite'),
14663
+ z.literal('slack_post'),
14531
14664
  z.literal('start_playbook'),
14532
14665
  z.literal('tell_hr'),
14533
14666
  z.literal('tell_manager'),
@@ -18276,7 +18409,7 @@ export const managementContract = {
18276
18409
  .route({
18277
18410
  method: 'POST',
18278
18411
  path: '/manage/groups/setAutomation',
18279
- 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',
18412
+ 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',
18280
18413
  })
18281
18414
  .input(groups_setAutomationInput)
18282
18415
  .output(groups_setAutomationOutput),
@@ -19223,6 +19356,15 @@ export const managementContract = {
19223
19356
  })
19224
19357
  .input(playbooks_answerFirstDaysCheckInInput)
19225
19358
  .output(playbooks_answerFirstDaysCheckInOutput),
19359
+ answerForm: base
19360
+ .meta({ scope: 'self:write' })
19361
+ .route({
19362
+ method: 'POST',
19363
+ path: '/manage/playbooks/answerForm',
19364
+ summary: 'Answer a playbook’s Tell us about you form; the answers fill in your profile',
19365
+ })
19366
+ .input(playbooks_answerFormInput)
19367
+ .output(playbooks_answerFormOutput),
19226
19368
  approve: base
19227
19369
  .meta({ scope: 'playbooks:write' })
19228
19370
  .route({
package/dist/permissions.d.ts CHANGED
@@ -226,6 +226,7 @@ export declare const permissionSchema: z.ZodEnum<{
226
226
  "playbooks.answerBuddyFollowUp": "playbooks.answerBuddyFollowUp";
227
227
  "playbooks.answerCheckIn": "playbooks.answerCheckIn";
228
228
  "playbooks.answerFirstDaysCheckIn": "playbooks.answerFirstDaysCheckIn";
229
+ "playbooks.answerForm": "playbooks.answerForm";
229
230
  "playbooks.approve": "playbooks.approve";
230
231
  "playbooks.askBuddy": "playbooks.askBuddy";
231
232
  "playbooks.assignBuddy": "playbooks.assignBuddy";
@@ -626,6 +627,7 @@ export declare const permissionDefinitionSchema: z.ZodObject<{
626
627
  "playbooks.answerBuddyFollowUp": "playbooks.answerBuddyFollowUp";
627
628
  "playbooks.answerCheckIn": "playbooks.answerCheckIn";
628
629
  "playbooks.answerFirstDaysCheckIn": "playbooks.answerFirstDaysCheckIn";
630
+ "playbooks.answerForm": "playbooks.answerForm";
629
631
  "playbooks.approve": "playbooks.approve";
630
632
  "playbooks.askBuddy": "playbooks.askBuddy";
631
633
  "playbooks.assignBuddy": "playbooks.assignBuddy";