@shuffl/api-contracts 0.5.3 → 0.5.4

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/openapi.json CHANGED
@@ -35737,6 +35737,9 @@
35737
35737
  {
35738
35738
  "const": "playbooks.plans"
35739
35739
  },
35740
+ {
35741
+ "const": "playbooks.previewAs"
35742
+ },
35740
35743
  {
35741
35744
  "const": "playbooks.previewEnrollment"
35742
35745
  },
@@ -37474,6 +37477,9 @@
37474
37477
  {
37475
37478
  "const": "playbooks.plans"
37476
37479
  },
37480
+ {
37481
+ "const": "playbooks.previewAs"
37482
+ },
37477
37483
  {
37478
37484
  "const": "playbooks.previewEnrollment"
37479
37485
  },
@@ -38786,6 +38792,9 @@
38786
38792
  {
38787
38793
  "const": "playbooks.plans"
38788
38794
  },
38795
+ {
38796
+ "const": "playbooks.previewAs"
38797
+ },
38789
38798
  {
38790
38799
  "const": "playbooks.previewEnrollment"
38791
38800
  },
@@ -48957,9 +48966,21 @@
48957
48966
  }
48958
48967
  ]
48959
48968
  },
48969
+ "notFor": {
48970
+ "type": "array",
48971
+ "items": {
48972
+ "type": "string"
48973
+ }
48974
+ },
48960
48975
  "offsetDays": {
48961
48976
  "type": "number"
48962
48977
  },
48978
+ "onlyFor": {
48979
+ "type": "array",
48980
+ "items": {
48981
+ "type": "string"
48982
+ }
48983
+ },
48963
48984
  "personId": {
48964
48985
  "anyOf": [
48965
48986
  {
@@ -130791,6 +130812,16 @@
130791
130812
  "items": {
130792
130813
  "type": "string"
130793
130814
  }
130815
+ },
130816
+ "track": {
130817
+ "anyOf": [
130818
+ {
130819
+ "type": "null"
130820
+ },
130821
+ {
130822
+ "type": "string"
130823
+ }
130824
+ ]
130794
130825
  }
130795
130826
  },
130796
130827
  "required": [
@@ -130805,7 +130836,8 @@
130805
130836
  "ref",
130806
130837
  "status",
130807
130838
  "title",
130808
- "todos"
130839
+ "todos",
130840
+ "track"
130809
130841
  ],
130810
130842
  "additionalProperties": false
130811
130843
  }
@@ -135296,6 +135328,619 @@
135296
135328
  "x-shuffl-permission": "playbooks.plans"
135297
135329
  }
135298
135330
  },
135331
+ "/manage/playbooks/previewAs": {
135332
+ "post": {
135333
+ "operationId": "playbooks.previewAs",
135334
+ "summary": "Which steps of a playbook one person would get, on which day, and why each skipped step is left out",
135335
+ "requestBody": {
135336
+ "required": true,
135337
+ "content": {
135338
+ "application/json": {
135339
+ "schema": {
135340
+ "type": "object",
135341
+ "properties": {
135342
+ "personId": {
135343
+ "type": "string"
135344
+ },
135345
+ "programId": {
135346
+ "type": "string"
135347
+ }
135348
+ },
135349
+ "required": [
135350
+ "personId",
135351
+ "programId"
135352
+ ],
135353
+ "additionalProperties": false
135354
+ }
135355
+ }
135356
+ }
135357
+ },
135358
+ "responses": {
135359
+ "200": {
135360
+ "description": "OK",
135361
+ "content": {
135362
+ "application/json": {
135363
+ "schema": {
135364
+ "type": "object",
135365
+ "properties": {
135366
+ "dayZero": {
135367
+ "type": "string"
135368
+ },
135369
+ "person": {
135370
+ "type": "object",
135371
+ "properties": {
135372
+ "id": {
135373
+ "type": "string"
135374
+ },
135375
+ "name": {
135376
+ "type": "string"
135377
+ }
135378
+ },
135379
+ "required": [
135380
+ "id",
135381
+ "name"
135382
+ ],
135383
+ "additionalProperties": false
135384
+ },
135385
+ "skipped": {
135386
+ "type": "number"
135387
+ },
135388
+ "steps": {
135389
+ "type": "array",
135390
+ "items": {
135391
+ "type": "object",
135392
+ "properties": {
135393
+ "dueAt": {
135394
+ "type": "string",
135395
+ "format": "date-time"
135396
+ },
135397
+ "kind": {
135398
+ "anyOf": [
135399
+ {
135400
+ "const": "acknowledge"
135401
+ },
135402
+ {
135403
+ "const": "buddy_invitation"
135404
+ },
135405
+ {
135406
+ "const": "catch_up"
135407
+ },
135408
+ {
135409
+ "const": "check_in"
135410
+ },
135411
+ {
135412
+ "const": "checkpoint"
135413
+ },
135414
+ {
135415
+ "const": "form"
135416
+ },
135417
+ {
135418
+ "const": "introduction"
135419
+ },
135420
+ {
135421
+ "const": "meet"
135422
+ },
135423
+ {
135424
+ "const": "message"
135425
+ },
135426
+ {
135427
+ "const": "task"
135428
+ }
135429
+ ]
135430
+ },
135431
+ "offsetDays": {
135432
+ "type": "number"
135433
+ },
135434
+ "recipient": {
135435
+ "anyOf": [
135436
+ {
135437
+ "type": "null"
135438
+ },
135439
+ {
135440
+ "const": "buddy"
135441
+ },
135442
+ {
135443
+ "const": "hire"
135444
+ },
135445
+ {
135446
+ "const": "hr"
135447
+ },
135448
+ {
135449
+ "const": "manager"
135450
+ },
135451
+ {
135452
+ "const": "person"
135453
+ }
135454
+ ]
135455
+ },
135456
+ "ref": {
135457
+ "type": "string"
135458
+ },
135459
+ "skipped": {
135460
+ "anyOf": [
135461
+ {
135462
+ "type": "null"
135463
+ },
135464
+ {
135465
+ "type": "string"
135466
+ }
135467
+ ]
135468
+ },
135469
+ "title": {
135470
+ "anyOf": [
135471
+ {
135472
+ "type": "null"
135473
+ },
135474
+ {
135475
+ "type": "string"
135476
+ }
135477
+ ]
135478
+ },
135479
+ "track": {
135480
+ "anyOf": [
135481
+ {
135482
+ "type": "null"
135483
+ },
135484
+ {
135485
+ "type": "string"
135486
+ }
135487
+ ]
135488
+ }
135489
+ },
135490
+ "required": [
135491
+ "dueAt",
135492
+ "kind",
135493
+ "offsetDays",
135494
+ "recipient",
135495
+ "ref",
135496
+ "skipped",
135497
+ "title",
135498
+ "track"
135499
+ ],
135500
+ "additionalProperties": false
135501
+ }
135502
+ },
135503
+ "tracked": {
135504
+ "type": "number"
135505
+ }
135506
+ },
135507
+ "required": [
135508
+ "dayZero",
135509
+ "person",
135510
+ "skipped",
135511
+ "steps",
135512
+ "tracked"
135513
+ ],
135514
+ "additionalProperties": false
135515
+ }
135516
+ }
135517
+ }
135518
+ },
135519
+ "400": {
135520
+ "description": "400",
135521
+ "content": {
135522
+ "application/json": {
135523
+ "schema": {
135524
+ "oneOf": [
135525
+ {
135526
+ "type": "object",
135527
+ "properties": {
135528
+ "defined": {
135529
+ "const": true
135530
+ },
135531
+ "code": {
135532
+ "const": "BAD_REQUEST"
135533
+ },
135534
+ "status": {
135535
+ "const": 400
135536
+ },
135537
+ "message": {
135538
+ "type": "string",
135539
+ "default": "Check the request input."
135540
+ },
135541
+ "data": {}
135542
+ },
135543
+ "required": [
135544
+ "defined",
135545
+ "code",
135546
+ "status",
135547
+ "message"
135548
+ ]
135549
+ },
135550
+ {
135551
+ "type": "object",
135552
+ "properties": {
135553
+ "defined": {
135554
+ "const": false
135555
+ },
135556
+ "code": {
135557
+ "type": "string"
135558
+ },
135559
+ "status": {
135560
+ "type": "number"
135561
+ },
135562
+ "message": {
135563
+ "type": "string"
135564
+ },
135565
+ "data": {}
135566
+ },
135567
+ "required": [
135568
+ "defined",
135569
+ "code",
135570
+ "status",
135571
+ "message"
135572
+ ]
135573
+ }
135574
+ ]
135575
+ }
135576
+ }
135577
+ }
135578
+ },
135579
+ "401": {
135580
+ "description": "401",
135581
+ "content": {
135582
+ "application/json": {
135583
+ "schema": {
135584
+ "oneOf": [
135585
+ {
135586
+ "type": "object",
135587
+ "properties": {
135588
+ "defined": {
135589
+ "const": true
135590
+ },
135591
+ "code": {
135592
+ "const": "UNAUTHORIZED"
135593
+ },
135594
+ "status": {
135595
+ "const": 401
135596
+ },
135597
+ "message": {
135598
+ "type": "string",
135599
+ "default": "A valid Shuffl API token is required."
135600
+ },
135601
+ "data": {}
135602
+ },
135603
+ "required": [
135604
+ "defined",
135605
+ "code",
135606
+ "status",
135607
+ "message"
135608
+ ]
135609
+ },
135610
+ {
135611
+ "type": "object",
135612
+ "properties": {
135613
+ "defined": {
135614
+ "const": false
135615
+ },
135616
+ "code": {
135617
+ "type": "string"
135618
+ },
135619
+ "status": {
135620
+ "type": "number"
135621
+ },
135622
+ "message": {
135623
+ "type": "string"
135624
+ },
135625
+ "data": {}
135626
+ },
135627
+ "required": [
135628
+ "defined",
135629
+ "code",
135630
+ "status",
135631
+ "message"
135632
+ ]
135633
+ }
135634
+ ]
135635
+ }
135636
+ }
135637
+ }
135638
+ },
135639
+ "403": {
135640
+ "description": "403",
135641
+ "content": {
135642
+ "application/json": {
135643
+ "schema": {
135644
+ "oneOf": [
135645
+ {
135646
+ "type": "object",
135647
+ "properties": {
135648
+ "defined": {
135649
+ "const": true
135650
+ },
135651
+ "code": {
135652
+ "const": "FORBIDDEN"
135653
+ },
135654
+ "status": {
135655
+ "const": 403
135656
+ },
135657
+ "message": {
135658
+ "type": "string",
135659
+ "default": "This token or team role does not permit the operation."
135660
+ },
135661
+ "data": {}
135662
+ },
135663
+ "required": [
135664
+ "defined",
135665
+ "code",
135666
+ "status",
135667
+ "message"
135668
+ ]
135669
+ },
135670
+ {
135671
+ "type": "object",
135672
+ "properties": {
135673
+ "defined": {
135674
+ "const": false
135675
+ },
135676
+ "code": {
135677
+ "type": "string"
135678
+ },
135679
+ "status": {
135680
+ "type": "number"
135681
+ },
135682
+ "message": {
135683
+ "type": "string"
135684
+ },
135685
+ "data": {}
135686
+ },
135687
+ "required": [
135688
+ "defined",
135689
+ "code",
135690
+ "status",
135691
+ "message"
135692
+ ]
135693
+ }
135694
+ ]
135695
+ }
135696
+ }
135697
+ }
135698
+ },
135699
+ "404": {
135700
+ "description": "404",
135701
+ "content": {
135702
+ "application/json": {
135703
+ "schema": {
135704
+ "oneOf": [
135705
+ {
135706
+ "type": "object",
135707
+ "properties": {
135708
+ "defined": {
135709
+ "const": true
135710
+ },
135711
+ "code": {
135712
+ "const": "NOT_FOUND"
135713
+ },
135714
+ "status": {
135715
+ "const": 404
135716
+ },
135717
+ "message": {
135718
+ "type": "string",
135719
+ "default": "The requested resource was not found."
135720
+ },
135721
+ "data": {}
135722
+ },
135723
+ "required": [
135724
+ "defined",
135725
+ "code",
135726
+ "status",
135727
+ "message"
135728
+ ]
135729
+ },
135730
+ {
135731
+ "type": "object",
135732
+ "properties": {
135733
+ "defined": {
135734
+ "const": false
135735
+ },
135736
+ "code": {
135737
+ "type": "string"
135738
+ },
135739
+ "status": {
135740
+ "type": "number"
135741
+ },
135742
+ "message": {
135743
+ "type": "string"
135744
+ },
135745
+ "data": {}
135746
+ },
135747
+ "required": [
135748
+ "defined",
135749
+ "code",
135750
+ "status",
135751
+ "message"
135752
+ ]
135753
+ }
135754
+ ]
135755
+ }
135756
+ }
135757
+ }
135758
+ },
135759
+ "409": {
135760
+ "description": "409",
135761
+ "content": {
135762
+ "application/json": {
135763
+ "schema": {
135764
+ "oneOf": [
135765
+ {
135766
+ "type": "object",
135767
+ "properties": {
135768
+ "defined": {
135769
+ "const": true
135770
+ },
135771
+ "code": {
135772
+ "const": "CONFLICT"
135773
+ },
135774
+ "status": {
135775
+ "const": 409
135776
+ },
135777
+ "message": {
135778
+ "type": "string",
135779
+ "default": "The resource changed or the request key was reused."
135780
+ },
135781
+ "data": {}
135782
+ },
135783
+ "required": [
135784
+ "defined",
135785
+ "code",
135786
+ "status",
135787
+ "message"
135788
+ ]
135789
+ },
135790
+ {
135791
+ "type": "object",
135792
+ "properties": {
135793
+ "defined": {
135794
+ "const": false
135795
+ },
135796
+ "code": {
135797
+ "type": "string"
135798
+ },
135799
+ "status": {
135800
+ "type": "number"
135801
+ },
135802
+ "message": {
135803
+ "type": "string"
135804
+ },
135805
+ "data": {}
135806
+ },
135807
+ "required": [
135808
+ "defined",
135809
+ "code",
135810
+ "status",
135811
+ "message"
135812
+ ]
135813
+ }
135814
+ ]
135815
+ }
135816
+ }
135817
+ }
135818
+ },
135819
+ "412": {
135820
+ "description": "412",
135821
+ "content": {
135822
+ "application/json": {
135823
+ "schema": {
135824
+ "oneOf": [
135825
+ {
135826
+ "type": "object",
135827
+ "properties": {
135828
+ "defined": {
135829
+ "const": true
135830
+ },
135831
+ "code": {
135832
+ "const": "PRECONDITION_FAILED"
135833
+ },
135834
+ "status": {
135835
+ "const": 412
135836
+ },
135837
+ "message": {
135838
+ "type": "string",
135839
+ "default": "The team is not ready for this operation."
135840
+ },
135841
+ "data": {}
135842
+ },
135843
+ "required": [
135844
+ "defined",
135845
+ "code",
135846
+ "status",
135847
+ "message"
135848
+ ]
135849
+ },
135850
+ {
135851
+ "type": "object",
135852
+ "properties": {
135853
+ "defined": {
135854
+ "const": false
135855
+ },
135856
+ "code": {
135857
+ "type": "string"
135858
+ },
135859
+ "status": {
135860
+ "type": "number"
135861
+ },
135862
+ "message": {
135863
+ "type": "string"
135864
+ },
135865
+ "data": {}
135866
+ },
135867
+ "required": [
135868
+ "defined",
135869
+ "code",
135870
+ "status",
135871
+ "message"
135872
+ ]
135873
+ }
135874
+ ]
135875
+ }
135876
+ }
135877
+ }
135878
+ },
135879
+ "429": {
135880
+ "description": "429",
135881
+ "content": {
135882
+ "application/json": {
135883
+ "schema": {
135884
+ "oneOf": [
135885
+ {
135886
+ "type": "object",
135887
+ "properties": {
135888
+ "defined": {
135889
+ "const": true
135890
+ },
135891
+ "code": {
135892
+ "const": "TOO_MANY_REQUESTS"
135893
+ },
135894
+ "status": {
135895
+ "const": 429
135896
+ },
135897
+ "message": {
135898
+ "type": "string",
135899
+ "default": "Too many requests. Try again shortly."
135900
+ },
135901
+ "data": {}
135902
+ },
135903
+ "required": [
135904
+ "defined",
135905
+ "code",
135906
+ "status",
135907
+ "message"
135908
+ ]
135909
+ },
135910
+ {
135911
+ "type": "object",
135912
+ "properties": {
135913
+ "defined": {
135914
+ "const": false
135915
+ },
135916
+ "code": {
135917
+ "type": "string"
135918
+ },
135919
+ "status": {
135920
+ "type": "number"
135921
+ },
135922
+ "message": {
135923
+ "type": "string"
135924
+ },
135925
+ "data": {}
135926
+ },
135927
+ "required": [
135928
+ "defined",
135929
+ "code",
135930
+ "status",
135931
+ "message"
135932
+ ]
135933
+ }
135934
+ ]
135935
+ }
135936
+ }
135937
+ }
135938
+ }
135939
+ },
135940
+ "x-shuffl-access": "read",
135941
+ "x-shuffl-permission": "playbooks.previewAs"
135942
+ }
135943
+ },
135299
135944
  "/manage/playbooks/previewEnrollment": {
135300
135945
  "post": {
135301
135946
  "operationId": "playbooks.previewEnrollment",
@@ -136540,9 +137185,21 @@
136540
137185
  }
136541
137186
  ]
136542
137187
  },
137188
+ "notFor": {
137189
+ "type": "array",
137190
+ "items": {
137191
+ "type": "string"
137192
+ }
137193
+ },
136543
137194
  "offsetDays": {
136544
137195
  "type": "number"
136545
137196
  },
137197
+ "onlyFor": {
137198
+ "type": "array",
137199
+ "items": {
137200
+ "type": "string"
137201
+ }
137202
+ },
136546
137203
  "personId": {
136547
137204
  "anyOf": [
136548
137205
  {
@@ -137534,6 +138191,63 @@
137534
138191
  "additionalProperties": {
137535
138192
  "type": "string"
137536
138193
  }
138194
+ },
138195
+ "tracks": {
138196
+ "type": "array",
138197
+ "items": {
138198
+ "type": "object",
138199
+ "properties": {
138200
+ "department": {
138201
+ "type": "boolean"
138202
+ },
138203
+ "hires": {
138204
+ "type": "number"
138205
+ },
138206
+ "id": {
138207
+ "type": "string"
138208
+ },
138209
+ "kind": {
138210
+ "anyOf": [
138211
+ {
138212
+ "const": "dynamic"
138213
+ },
138214
+ {
138215
+ "const": "list"
138216
+ }
138217
+ ]
138218
+ },
138219
+ "name": {
138220
+ "type": "string"
138221
+ },
138222
+ "not": {
138223
+ "type": "number"
138224
+ },
138225
+ "only": {
138226
+ "type": "number"
138227
+ },
138228
+ "rules": {
138229
+ "anyOf": [
138230
+ {
138231
+ "type": "null"
138232
+ },
138233
+ {
138234
+ "type": "string"
138235
+ }
138236
+ ]
138237
+ }
138238
+ },
138239
+ "required": [
138240
+ "department",
138241
+ "hires",
138242
+ "id",
138243
+ "kind",
138244
+ "name",
138245
+ "not",
138246
+ "only",
138247
+ "rules"
138248
+ ],
138249
+ "additionalProperties": false
138250
+ }
137537
138251
  }
137538
138252
  },
137539
138253
  "required": [
@@ -137543,7 +138257,8 @@
137543
138257
  "program",
137544
138258
  "responderName",
137545
138259
  "rows",
137546
- "stepPeople"
138260
+ "stepPeople",
138261
+ "tracks"
137547
138262
  ],
137548
138263
  "additionalProperties": false
137549
138264
  }
@@ -141680,9 +142395,21 @@
141680
142395
  }
141681
142396
  ]
141682
142397
  },
142398
+ "notFor": {
142399
+ "type": "array",
142400
+ "items": {
142401
+ "type": "string"
142402
+ }
142403
+ },
141683
142404
  "offsetDays": {
141684
142405
  "type": "number"
141685
142406
  },
142407
+ "onlyFor": {
142408
+ "type": "array",
142409
+ "items": {
142410
+ "type": "string"
142411
+ }
142412
+ },
141686
142413
  "personId": {
141687
142414
  "anyOf": [
141688
142415
  {
@@ -142387,9 +143114,21 @@
142387
143114
  }
142388
143115
  ]
142389
143116
  },
143117
+ "notFor": {
143118
+ "type": "array",
143119
+ "items": {
143120
+ "type": "string"
143121
+ }
143122
+ },
142390
143123
  "offsetDays": {
142391
143124
  "type": "number"
142392
143125
  },
143126
+ "onlyFor": {
143127
+ "type": "array",
143128
+ "items": {
143129
+ "type": "string"
143130
+ }
143131
+ },
142393
143132
  "personId": {
142394
143133
  "anyOf": [
142395
143134
  {
@@ -201694,9 +202433,21 @@
201694
202433
  }
201695
202434
  ]
201696
202435
  },
202436
+ "notFor": {
202437
+ "type": "array",
202438
+ "items": {
202439
+ "type": "string"
202440
+ }
202441
+ },
201697
202442
  "offsetDays": {
201698
202443
  "type": "number"
201699
202444
  },
202445
+ "onlyFor": {
202446
+ "type": "array",
202447
+ "items": {
202448
+ "type": "string"
202449
+ }
202450
+ },
201700
202451
  "personId": {
201701
202452
  "anyOf": [
201702
202453
  {
@@ -253998,6 +254749,7 @@
253998
254749
  "playbooks.mine",
253999
254750
  "playbooks.person",
254000
254751
  "playbooks.plans",
254752
+ "playbooks.previewAs",
254001
254753
  "playbooks.program",
254002
254754
  "playbooks.run",
254003
254755
  "playbooks.answerBuddyAsk",
@@ -254459,6 +255211,7 @@
254459
255211
  "playbooks.mine",
254460
255212
  "playbooks.person",
254461
255213
  "playbooks.plans",
255214
+ "playbooks.previewAs",
254462
255215
  "playbooks.program",
254463
255216
  "playbooks.run",
254464
255217
  "playbooks.answerBuddyAsk",