@shuffl/api-contracts 0.5.8 → 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 +90 -5
  2. package/dist/management-operations.d.ts +1 -1
  3. package/dist/management-operations.js +7 -0
  4. package/dist/management.generated.d.ts +88 -5
  5. package/dist/management.generated.js +121 -0
  6. package/dist/permissions.d.ts +2 -0
  7. package/openapi.json +1013 -170
  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
  })
@@ -7105,6 +7126,7 @@ const runs_detailsOutput = z.strictObject({
7105
7126
  location: z.string().optional().optional(),
7106
7127
  offers: z.string().optional().optional(),
7107
7128
  phone: z.string().optional().optional(),
7129
+ preferredName: z.string().optional().optional(),
7108
7130
  pronouns: z.string().optional().optional(),
7109
7131
  role: z.string().optional().optional(),
7110
7132
  workingOn: z.string().optional().optional(),
@@ -9256,6 +9278,16 @@ const reports_overviewOutput = z.strictObject({
9256
9278
  ])
9257
9279
  .optional()
9258
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(),
9259
9291
  id: z.string(),
9260
9292
  kind: z.union([
9261
9293
  z.literal('acknowledge'),
@@ -9825,6 +9857,16 @@ const playbooks_programOutput = z.strictObject({
9825
9857
  ])
9826
9858
  .optional()
9827
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(),
9828
9870
  id: z.string(),
9829
9871
  kind: z.union([
9830
9872
  z.literal('acknowledge'),
@@ -10162,10 +10204,21 @@ const playbooks_saveProgramInput = z
10162
10204
  ])
10163
10205
  .optional()
10164
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(),
10165
10217
  id: z.string(),
10166
10218
  kind: z.union([
10167
10219
  z.literal('acknowledge'),
10168
10220
  z.literal('checkpoint'),
10221
+ z.literal('form'),
10169
10222
  z.literal('meet'),
10170
10223
  z.literal('message'),
10171
10224
  z.literal('task'),
@@ -10378,6 +10431,16 @@ const playbooks_saveProgramOutput = z.object({
10378
10431
  ])
10379
10432
  .optional()
10380
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(),
10381
10444
  id: z.string(),
10382
10445
  kind: z.union([
10383
10446
  z.literal('acknowledge'),
@@ -11164,6 +11227,19 @@ const playbooks_runOutput = z.union([
11164
11227
  ]),
11165
11228
  enrolled: z.boolean(),
11166
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
+ ]),
11167
11243
  gettingReady: z.array(z.strictObject({
11168
11244
  done: z.boolean(),
11169
11245
  due: z.union([z.null(), z.string()]),
@@ -11195,6 +11271,7 @@ const playbooks_runOutput = z.union([
11195
11271
  title: z.union([z.null(), z.string()]),
11196
11272
  userId: z.union([z.null(), z.string()]),
11197
11273
  })),
11274
+ personId: z.string(),
11198
11275
  playbooks: z.array(z.strictObject({
11199
11276
  current: z.boolean(),
11200
11277
  dayZero: z.union([
@@ -11243,10 +11320,24 @@ const playbooks_runOutput = z.union([
11243
11320
  confirmedAt: z.union([z.null(), z.iso.datetime({ offset: true })]),
11244
11321
  date: z.string(),
11245
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
+ ]),
11246
11336
  kind: z.union([
11247
11337
  z.literal('acknowledge'),
11248
11338
  z.literal('check_in'),
11249
11339
  z.literal('checkpoint'),
11340
+ z.literal('form'),
11250
11341
  z.literal('introduction'),
11251
11342
  z.literal('meet'),
11252
11343
  z.literal('message'),
@@ -11625,6 +11716,27 @@ const playbooks_respondBuddyOutput = z.object({
11625
11716
  receipt: commandReceiptSchema,
11626
11717
  result: z.strictObject({ status: z.string() }).nullable(),
11627
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
+ });
11628
11740
  const playbooks_buddySuggestionsInput = z.strictObject({});
11629
11741
  const playbooks_buddySuggestionsOutput = z.union([
11630
11742
  z.strictObject({
@@ -19244,6 +19356,15 @@ export const managementContract = {
19244
19356
  })
19245
19357
  .input(playbooks_answerFirstDaysCheckInInput)
19246
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),
19247
19368
  approve: base
19248
19369
  .meta({ scope: 'playbooks:write' })
19249
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";