@shuffl/api-contracts 0.3.0 → 0.4.0

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
@@ -5,11 +5,17 @@
5
5
  "bearerFormat": "Shuffl API token",
6
6
  "scheme": "bearer",
7
7
  "type": "http"
8
+ },
9
+ "companyKey": {
10
+ "bearerFormat": "Shuffl company key",
11
+ "description": "A company key (shuffl_company_) from Company settings. It reaches only the /company operations, and only those its grants name.",
12
+ "scheme": "bearer",
13
+ "type": "http"
8
14
  }
9
15
  }
10
16
  },
11
17
  "info": {
12
- "description": "Team-bound API tokens. SDK and CLI operations share the same contracts and authorization.",
18
+ "description": "Team-bound API tokens for workspace operations, and company keys for the /company operations. SDK and CLI operations share the same contracts and authorization.",
13
19
  "title": "Shuffl API",
14
20
  "version": "1.0.0"
15
21
  },
@@ -34944,6 +34950,9 @@
34944
34950
  {
34945
34951
  "const": "onboarding.candidates"
34946
34952
  },
34953
+ {
34954
+ "const": "onboarding.completeTodo"
34955
+ },
34947
34956
  {
34948
34957
  "const": "onboarding.enroll"
34949
34958
  },
@@ -36492,6 +36501,9 @@
36492
36501
  {
36493
36502
  "const": "onboarding.candidates"
36494
36503
  },
36504
+ {
36505
+ "const": "onboarding.completeTodo"
36506
+ },
36495
36507
  {
36496
36508
  "const": "onboarding.enroll"
36497
36509
  },
@@ -37609,6 +37621,9 @@
37609
37621
  {
37610
37622
  "const": "onboarding.candidates"
37611
37623
  },
37624
+ {
37625
+ "const": "onboarding.completeTodo"
37626
+ },
37612
37627
  {
37613
37628
  "const": "onboarding.enroll"
37614
37629
  },
@@ -45267,6 +45282,191 @@
45267
45282
  "sendTime": {
45268
45283
  "type": "string"
45269
45284
  },
45285
+ "steps": {
45286
+ "type": "array",
45287
+ "items": {
45288
+ "type": "object",
45289
+ "properties": {
45290
+ "body": {
45291
+ "type": "string"
45292
+ },
45293
+ "checkpoint": {
45294
+ "anyOf": [
45295
+ {
45296
+ "const": "day_30"
45297
+ },
45298
+ {
45299
+ "const": "day_365"
45300
+ },
45301
+ {
45302
+ "const": "day_60"
45303
+ },
45304
+ {
45305
+ "const": "day_90"
45306
+ }
45307
+ ]
45308
+ },
45309
+ "id": {
45310
+ "type": "string"
45311
+ },
45312
+ "kind": {
45313
+ "anyOf": [
45314
+ {
45315
+ "const": "acknowledge"
45316
+ },
45317
+ {
45318
+ "const": "checkpoint"
45319
+ },
45320
+ {
45321
+ "const": "form"
45322
+ },
45323
+ {
45324
+ "const": "meet"
45325
+ },
45326
+ {
45327
+ "const": "message"
45328
+ },
45329
+ {
45330
+ "const": "task"
45331
+ }
45332
+ ]
45333
+ },
45334
+ "offsetDays": {
45335
+ "type": "number"
45336
+ },
45337
+ "personId": {
45338
+ "anyOf": [
45339
+ {
45340
+ "type": "null"
45341
+ },
45342
+ {
45343
+ "type": "string"
45344
+ }
45345
+ ]
45346
+ },
45347
+ "recipient": {
45348
+ "anyOf": [
45349
+ {
45350
+ "const": "buddy"
45351
+ },
45352
+ {
45353
+ "const": "hire"
45354
+ },
45355
+ {
45356
+ "const": "hr"
45357
+ },
45358
+ {
45359
+ "const": "manager"
45360
+ },
45361
+ {
45362
+ "const": "person"
45363
+ }
45364
+ ]
45365
+ },
45366
+ "resources": {
45367
+ "type": "array",
45368
+ "items": {
45369
+ "anyOf": [
45370
+ {
45371
+ "type": "object",
45372
+ "properties": {
45373
+ "sourceId": {
45374
+ "type": "string"
45375
+ },
45376
+ "title": {
45377
+ "type": "string"
45378
+ },
45379
+ "type": {
45380
+ "const": "knowledge"
45381
+ }
45382
+ },
45383
+ "required": [
45384
+ "sourceId",
45385
+ "title",
45386
+ "type"
45387
+ ],
45388
+ "additionalProperties": false
45389
+ },
45390
+ {
45391
+ "type": "object",
45392
+ "properties": {
45393
+ "label": {
45394
+ "type": "string"
45395
+ },
45396
+ "type": {
45397
+ "const": "link"
45398
+ },
45399
+ "url": {
45400
+ "type": "string"
45401
+ }
45402
+ },
45403
+ "required": [
45404
+ "label",
45405
+ "type",
45406
+ "url"
45407
+ ],
45408
+ "additionalProperties": false
45409
+ },
45410
+ {
45411
+ "type": "object",
45412
+ "properties": {
45413
+ "communityId": {
45414
+ "type": "string"
45415
+ },
45416
+ "name": {
45417
+ "type": "string"
45418
+ },
45419
+ "type": {
45420
+ "const": "community"
45421
+ }
45422
+ },
45423
+ "required": [
45424
+ "communityId",
45425
+ "name",
45426
+ "type"
45427
+ ],
45428
+ "additionalProperties": false
45429
+ }
45430
+ ]
45431
+ }
45432
+ },
45433
+ "title": {
45434
+ "type": "string"
45435
+ },
45436
+ "todos": {
45437
+ "type": "array",
45438
+ "items": {
45439
+ "type": "object",
45440
+ "properties": {
45441
+ "id": {
45442
+ "type": "string"
45443
+ },
45444
+ "label": {
45445
+ "type": "string"
45446
+ }
45447
+ },
45448
+ "required": [
45449
+ "id",
45450
+ "label"
45451
+ ],
45452
+ "additionalProperties": false
45453
+ }
45454
+ }
45455
+ },
45456
+ "required": [
45457
+ "body",
45458
+ "id",
45459
+ "kind",
45460
+ "offsetDays",
45461
+ "personId",
45462
+ "recipient",
45463
+ "resources",
45464
+ "title",
45465
+ "todos"
45466
+ ],
45467
+ "additionalProperties": false
45468
+ }
45469
+ },
45270
45470
  "timezone": {
45271
45471
  "type": "string"
45272
45472
  }
@@ -97977,10 +98177,10 @@
97977
98177
  "x-shuffl-permission": "onboarding.candidates"
97978
98178
  }
97979
98179
  },
97980
- "/manage/onboarding/enroll": {
98180
+ "/manage/onboarding/completeTodo": {
97981
98181
  "post": {
97982
- "operationId": "onboarding.enroll",
97983
- "summary": "Enroll this person in onboarding",
98182
+ "operationId": "onboarding.completeTodo",
98183
+ "summary": "Check off (or reopen) one of your own onboarding to-dos",
97984
98184
  "requestBody": {
97985
98185
  "required": true,
97986
98186
  "content": {
@@ -97988,96 +98188,26 @@
97988
98188
  "schema": {
97989
98189
  "type": "object",
97990
98190
  "properties": {
97991
- "fingerprint": {
97992
- "type": "string"
98191
+ "done": {
98192
+ "type": "boolean"
97993
98193
  },
97994
- "programId": {
98194
+ "todoId": {
97995
98195
  "type": "string"
97996
98196
  },
98197
+ "confirm": {
98198
+ "const": "onboarding.completeTodo"
98199
+ },
97997
98200
  "requestKey": {
97998
98201
  "type": "string",
97999
98202
  "minLength": 1,
98000
98203
  "maxLength": 128
98001
- },
98002
- "rows": {
98003
- "type": "array",
98004
- "items": {
98005
- "type": "object",
98006
- "properties": {
98007
- "buddyEmail": {
98008
- "anyOf": [
98009
- {
98010
- "type": "null"
98011
- },
98012
- {
98013
- "type": "string"
98014
- }
98015
- ]
98016
- },
98017
- "buddyPersonId": {
98018
- "anyOf": [
98019
- {
98020
- "type": "null"
98021
- },
98022
- {
98023
- "type": "string"
98024
- }
98025
- ]
98026
- },
98027
- "email": {
98028
- "anyOf": [
98029
- {
98030
- "type": "null"
98031
- },
98032
- {
98033
- "type": "string"
98034
- }
98035
- ]
98036
- },
98037
- "personId": {
98038
- "anyOf": [
98039
- {
98040
- "type": "null"
98041
- },
98042
- {
98043
- "type": "string"
98044
- }
98045
- ]
98046
- },
98047
- "startDate": {
98048
- "anyOf": [
98049
- {
98050
- "type": "null"
98051
- },
98052
- {
98053
- "type": "string"
98054
- }
98055
- ]
98056
- },
98057
- "timezone": {
98058
- "anyOf": [
98059
- {
98060
- "type": "null"
98061
- },
98062
- {
98063
- "type": "string"
98064
- }
98065
- ]
98066
- }
98067
- },
98068
- "additionalProperties": false
98069
- }
98070
- },
98071
- "confirm": {
98072
- "const": "onboarding.enroll"
98073
98204
  }
98074
98205
  },
98075
98206
  "required": [
98076
- "fingerprint",
98077
- "programId",
98078
- "requestKey",
98079
- "rows",
98080
- "confirm"
98207
+ "done",
98208
+ "todoId",
98209
+ "confirm",
98210
+ "requestKey"
98081
98211
  ],
98082
98212
  "additionalProperties": false
98083
98213
  }
@@ -98144,43 +98274,16 @@
98144
98274
  {
98145
98275
  "type": "object",
98146
98276
  "properties": {
98147
- "enrolled": {
98148
- "type": "array",
98149
- "items": {
98150
- "type": "object",
98151
- "properties": {
98152
- "enrollmentId": {
98153
- "type": "string"
98154
- },
98155
- "episode": {
98156
- "type": "number"
98157
- },
98158
- "personId": {
98159
- "type": "string"
98160
- }
98161
- },
98162
- "required": [
98163
- "enrollmentId",
98164
- "episode",
98165
- "personId"
98166
- ],
98167
- "additionalProperties": false
98168
- }
98169
- },
98170
- "replayed": {
98277
+ "changed": {
98171
98278
  "type": "boolean"
98172
98279
  },
98173
- "skipped": {
98174
- "type": "array",
98175
- "items": {
98176
- "type": "number"
98177
- }
98280
+ "done": {
98281
+ "type": "boolean"
98178
98282
  }
98179
98283
  },
98180
98284
  "required": [
98181
- "enrolled",
98182
- "replayed",
98183
- "skipped"
98285
+ "changed",
98286
+ "done"
98184
98287
  ],
98185
98288
  "additionalProperties": false
98186
98289
  },
@@ -98620,13 +98723,13 @@
98620
98723
  }
98621
98724
  },
98622
98725
  "x-shuffl-access": "write",
98623
- "x-shuffl-permission": "onboarding.enroll"
98726
+ "x-shuffl-permission": "onboarding.completeTodo"
98624
98727
  }
98625
98728
  },
98626
- "/manage/onboarding/enrollmentPreview": {
98729
+ "/manage/onboarding/enroll": {
98627
98730
  "post": {
98628
- "operationId": "onboarding.enrollmentPreview",
98629
- "summary": "Preview enrolling a new hire in onboarding",
98731
+ "operationId": "onboarding.enroll",
98732
+ "summary": "Enroll this person in onboarding",
98630
98733
  "requestBody": {
98631
98734
  "required": true,
98632
98735
  "content": {
@@ -98634,12 +98737,96 @@
98634
98737
  "schema": {
98635
98738
  "type": "object",
98636
98739
  "properties": {
98637
- "enrollmentId": {
98740
+ "fingerprint": {
98638
98741
  "type": "string"
98742
+ },
98743
+ "programId": {
98744
+ "type": "string"
98745
+ },
98746
+ "requestKey": {
98747
+ "type": "string",
98748
+ "minLength": 1,
98749
+ "maxLength": 128
98750
+ },
98751
+ "rows": {
98752
+ "type": "array",
98753
+ "items": {
98754
+ "type": "object",
98755
+ "properties": {
98756
+ "buddyEmail": {
98757
+ "anyOf": [
98758
+ {
98759
+ "type": "null"
98760
+ },
98761
+ {
98762
+ "type": "string"
98763
+ }
98764
+ ]
98765
+ },
98766
+ "buddyPersonId": {
98767
+ "anyOf": [
98768
+ {
98769
+ "type": "null"
98770
+ },
98771
+ {
98772
+ "type": "string"
98773
+ }
98774
+ ]
98775
+ },
98776
+ "email": {
98777
+ "anyOf": [
98778
+ {
98779
+ "type": "null"
98780
+ },
98781
+ {
98782
+ "type": "string"
98783
+ }
98784
+ ]
98785
+ },
98786
+ "personId": {
98787
+ "anyOf": [
98788
+ {
98789
+ "type": "null"
98790
+ },
98791
+ {
98792
+ "type": "string"
98793
+ }
98794
+ ]
98795
+ },
98796
+ "startDate": {
98797
+ "anyOf": [
98798
+ {
98799
+ "type": "null"
98800
+ },
98801
+ {
98802
+ "type": "string"
98803
+ }
98804
+ ]
98805
+ },
98806
+ "timezone": {
98807
+ "anyOf": [
98808
+ {
98809
+ "type": "null"
98810
+ },
98811
+ {
98812
+ "type": "string"
98813
+ }
98814
+ ]
98815
+ }
98816
+ },
98817
+ "additionalProperties": false
98818
+ }
98819
+ },
98820
+ "confirm": {
98821
+ "const": "onboarding.enroll"
98639
98822
  }
98640
98823
  },
98641
98824
  "required": [
98642
- "enrollmentId"
98825
+ "fingerprint",
98826
+ "programId",
98827
+ "requestKey",
98828
+ "rows",
98829
+ "confirm"
98643
98830
  ],
98644
98831
  "additionalProperties": false
98645
98832
  }
@@ -98654,106 +98841,108 @@
98654
98841
  "schema": {
98655
98842
  "type": "object",
98656
98843
  "properties": {
98657
- "enrollmentId": {
98658
- "type": "string"
98659
- },
98660
- "hash": {
98661
- "type": "string"
98662
- },
98663
- "revision": {
98664
- "type": "number"
98844
+ "receipt": {
98845
+ "type": "object",
98846
+ "properties": {
98847
+ "completedAt": {
98848
+ "anyOf": [
98849
+ {
98850
+ "type": "string",
98851
+ "format": "date-time"
98852
+ },
98853
+ {
98854
+ "type": "null"
98855
+ }
98856
+ ]
98857
+ },
98858
+ "createdAt": {
98859
+ "type": "string",
98860
+ "format": "date-time"
98861
+ },
98862
+ "id": {
98863
+ "type": "string",
98864
+ "format": "uuid"
98865
+ },
98866
+ "operation": {
98867
+ "type": "string"
98868
+ },
98869
+ "requestKey": {
98870
+ "type": "string"
98871
+ },
98872
+ "status": {
98873
+ "enum": [
98874
+ "running",
98875
+ "succeeded",
98876
+ "failed",
98877
+ "unknown"
98878
+ ],
98879
+ "type": "string"
98880
+ }
98881
+ },
98882
+ "required": [
98883
+ "completedAt",
98884
+ "createdAt",
98885
+ "id",
98886
+ "operation",
98887
+ "requestKey",
98888
+ "status"
98889
+ ]
98665
98890
  },
98666
- "steps": {
98667
- "type": "array",
98668
- "items": {
98669
- "type": "object",
98670
- "properties": {
98671
- "dueAt": {
98672
- "type": "string",
98673
- "format": "date-time"
98674
- },
98675
- "kind": {
98676
- "anyOf": [
98677
- {
98678
- "const": "buddy_invitation"
98679
- },
98680
- {
98681
- "const": "check_in"
98682
- },
98683
- {
98684
- "const": "introduction"
98891
+ "result": {
98892
+ "anyOf": [
98893
+ {
98894
+ "type": "object",
98895
+ "properties": {
98896
+ "enrolled": {
98897
+ "type": "array",
98898
+ "items": {
98899
+ "type": "object",
98900
+ "properties": {
98901
+ "enrollmentId": {
98902
+ "type": "string"
98903
+ },
98904
+ "episode": {
98905
+ "type": "number"
98906
+ },
98907
+ "personId": {
98908
+ "type": "string"
98909
+ }
98910
+ },
98911
+ "required": [
98912
+ "enrollmentId",
98913
+ "episode",
98914
+ "personId"
98915
+ ],
98916
+ "additionalProperties": false
98685
98917
  }
98686
- ]
98687
- },
98688
- "offsetDays": {
98689
- "type": "number"
98690
- },
98691
- "pending": {
98692
- "type": "boolean"
98693
- },
98694
- "preview": {
98695
- "type": "string"
98696
- },
98697
- "status": {
98698
- "anyOf": [
98699
- {
98700
- "type": "null"
98701
- },
98702
- {
98703
- "const": "accepted"
98704
- },
98705
- {
98706
- "const": "answered"
98707
- },
98708
- {
98709
- "const": "canceled"
98710
- },
98711
- {
98712
- "const": "declined"
98713
- },
98714
- {
98715
- "const": "failed"
98716
- },
98717
- {
98718
- "const": "needs_review"
98719
- },
98720
- {
98721
- "const": "opened"
98722
- },
98723
- {
98724
- "const": "scheduled"
98725
- },
98726
- {
98727
- "const": "sent"
98728
- },
98729
- {
98730
- "const": "unknown"
98731
- },
98732
- {
98733
- "const": "waiting"
98918
+ },
98919
+ "replayed": {
98920
+ "type": "boolean"
98921
+ },
98922
+ "skipped": {
98923
+ "type": "array",
98924
+ "items": {
98925
+ "type": "number"
98734
98926
  }
98735
- ]
98736
- }
98927
+ }
98928
+ },
98929
+ "required": [
98930
+ "enrolled",
98931
+ "replayed",
98932
+ "skipped"
98933
+ ],
98934
+ "additionalProperties": false
98737
98935
  },
98738
- "required": [
98739
- "dueAt",
98740
- "kind",
98741
- "offsetDays",
98742
- "pending",
98743
- "preview",
98744
- "status"
98745
- ],
98746
- "additionalProperties": false
98747
- }
98936
+ {
98937
+ "type": "null"
98938
+ }
98939
+ ]
98748
98940
  }
98749
98941
  },
98750
98942
  "required": [
98751
- "enrollmentId",
98752
- "hash",
98753
- "revision",
98754
- "steps"
98755
- ],
98756
- "additionalProperties": false
98943
+ "receipt",
98944
+ "result"
98945
+ ]
98757
98946
  }
98758
98947
  }
98759
98948
  }
@@ -99179,20 +99368,28 @@
99179
99368
  }
99180
99369
  }
99181
99370
  },
99182
- "x-shuffl-access": "read",
99183
- "x-shuffl-permission": "onboarding.enrollmentPreview"
99371
+ "x-shuffl-access": "write",
99372
+ "x-shuffl-permission": "onboarding.enroll"
99184
99373
  }
99185
99374
  },
99186
- "/manage/onboarding/firstDaysCheckIns": {
99375
+ "/manage/onboarding/enrollmentPreview": {
99187
99376
  "post": {
99188
- "operationId": "onboarding.firstDaysCheckIns",
99189
- "summary": "Your open 30, 60 or 90-day or one-year new hire check-in",
99377
+ "operationId": "onboarding.enrollmentPreview",
99378
+ "summary": "Preview enrolling a new hire in onboarding",
99190
99379
  "requestBody": {
99191
99380
  "required": true,
99192
99381
  "content": {
99193
99382
  "application/json": {
99194
99383
  "schema": {
99195
99384
  "type": "object",
99385
+ "properties": {
99386
+ "enrollmentId": {
99387
+ "type": "string"
99388
+ }
99389
+ },
99390
+ "required": [
99391
+ "enrollmentId"
99392
+ ],
99196
99393
  "additionalProperties": false
99197
99394
  }
99198
99395
  }
@@ -99204,106 +99401,732 @@
99204
99401
  "content": {
99205
99402
  "application/json": {
99206
99403
  "schema": {
99207
- "type": "array",
99208
- "items": {
99209
- "type": "object",
99210
- "properties": {
99211
- "checkpoint": {
99212
- "anyOf": [
99213
- {
99214
- "const": "day_30"
99404
+ "type": "object",
99405
+ "properties": {
99406
+ "enrollmentId": {
99407
+ "type": "string"
99408
+ },
99409
+ "hash": {
99410
+ "type": "string"
99411
+ },
99412
+ "revision": {
99413
+ "type": "number"
99414
+ },
99415
+ "steps": {
99416
+ "type": "array",
99417
+ "items": {
99418
+ "type": "object",
99419
+ "properties": {
99420
+ "dueAt": {
99421
+ "type": "string",
99422
+ "format": "date-time"
99215
99423
  },
99216
- {
99217
- "const": "day_365"
99424
+ "kind": {
99425
+ "anyOf": [
99426
+ {
99427
+ "const": "acknowledge"
99428
+ },
99429
+ {
99430
+ "const": "buddy_invitation"
99431
+ },
99432
+ {
99433
+ "const": "check_in"
99434
+ },
99435
+ {
99436
+ "const": "checkpoint"
99437
+ },
99438
+ {
99439
+ "const": "form"
99440
+ },
99441
+ {
99442
+ "const": "introduction"
99443
+ },
99444
+ {
99445
+ "const": "meet"
99446
+ },
99447
+ {
99448
+ "const": "message"
99449
+ },
99450
+ {
99451
+ "const": "task"
99452
+ }
99453
+ ]
99218
99454
  },
99219
- {
99220
- "const": "day_60"
99455
+ "offsetDays": {
99456
+ "type": "number"
99221
99457
  },
99222
- {
99223
- "const": "day_90"
99224
- }
99225
- ]
99226
- },
99227
- "closesAt": {
99228
- "type": "string",
99229
- "format": "date-time"
99230
- },
99231
- "questions": {
99232
- "type": "array",
99233
- "items": {
99234
- "anyOf": [
99235
- {
99236
- "type": "object",
99237
- "properties": {
99238
- "id": {
99239
- "type": "string"
99240
- },
99241
- "kind": {
99242
- "const": "scale"
99243
- },
99244
- "scale": {
99245
- "anyOf": [
99246
- {
99247
- "const": "agree_5"
99248
- },
99249
- {
99250
- "const": "nps_11"
99251
- },
99252
- {
99253
- "const": "rating_5"
99254
- },
99255
- {
99256
- "const": "yes_no"
99257
- }
99258
- ]
99259
- },
99260
- "text": {
99261
- "type": "string"
99262
- }
99458
+ "pending": {
99459
+ "type": "boolean"
99460
+ },
99461
+ "preview": {
99462
+ "type": "string"
99463
+ },
99464
+ "recipient": {
99465
+ "anyOf": [
99466
+ {
99467
+ "type": "null"
99263
99468
  },
99264
- "required": [
99265
- "id",
99266
- "kind",
99267
- "scale",
99268
- "text"
99269
- ],
99270
- "additionalProperties": false
99271
- },
99272
- {
99273
- "type": "object",
99274
- "properties": {
99275
- "id": {
99276
- "type": "string"
99277
- },
99278
- "kind": {
99279
- "const": "open"
99280
- },
99281
- "text": {
99282
- "type": "string"
99283
- }
99469
+ {
99470
+ "const": "buddy"
99284
99471
  },
99285
- "required": [
99286
- "id",
99287
- "kind",
99288
- "text"
99289
- ],
99290
- "additionalProperties": false
99472
+ {
99473
+ "const": "hire"
99474
+ },
99475
+ {
99476
+ "const": "hr"
99477
+ },
99478
+ {
99479
+ "const": "manager"
99480
+ },
99481
+ {
99482
+ "const": "person"
99483
+ }
99484
+ ]
99485
+ },
99486
+ "recipientName": {
99487
+ "anyOf": [
99488
+ {
99489
+ "type": "null"
99490
+ },
99491
+ {
99492
+ "type": "string"
99493
+ }
99494
+ ]
99495
+ },
99496
+ "ref": {
99497
+ "type": "string"
99498
+ },
99499
+ "status": {
99500
+ "anyOf": [
99501
+ {
99502
+ "type": "null"
99503
+ },
99504
+ {
99505
+ "const": "accepted"
99506
+ },
99507
+ {
99508
+ "const": "answered"
99509
+ },
99510
+ {
99511
+ "const": "canceled"
99512
+ },
99513
+ {
99514
+ "const": "declined"
99515
+ },
99516
+ {
99517
+ "const": "failed"
99518
+ },
99519
+ {
99520
+ "const": "needs_review"
99521
+ },
99522
+ {
99523
+ "const": "opened"
99524
+ },
99525
+ {
99526
+ "const": "scheduled"
99527
+ },
99528
+ {
99529
+ "const": "sent"
99530
+ },
99531
+ {
99532
+ "const": "unknown"
99533
+ },
99534
+ {
99535
+ "const": "waiting"
99536
+ }
99537
+ ]
99538
+ },
99539
+ "title": {
99540
+ "anyOf": [
99541
+ {
99542
+ "type": "null"
99543
+ },
99544
+ {
99545
+ "type": "string"
99546
+ }
99547
+ ]
99548
+ },
99549
+ "todos": {
99550
+ "type": "array",
99551
+ "items": {
99552
+ "type": "string"
99291
99553
  }
99292
- ]
99293
- }
99294
- },
99295
- "title": {
99296
- "type": "string"
99554
+ }
99555
+ },
99556
+ "required": [
99557
+ "dueAt",
99558
+ "kind",
99559
+ "offsetDays",
99560
+ "pending",
99561
+ "preview",
99562
+ "recipient",
99563
+ "recipientName",
99564
+ "ref",
99565
+ "status",
99566
+ "title",
99567
+ "todos"
99568
+ ],
99569
+ "additionalProperties": false
99297
99570
  }
99298
- },
99299
- "required": [
99300
- "checkpoint",
99301
- "closesAt",
99302
- "questions",
99303
- "title"
99304
- ],
99305
- "additionalProperties": false
99306
- }
99571
+ }
99572
+ },
99573
+ "required": [
99574
+ "enrollmentId",
99575
+ "hash",
99576
+ "revision",
99577
+ "steps"
99578
+ ],
99579
+ "additionalProperties": false
99580
+ }
99581
+ }
99582
+ }
99583
+ },
99584
+ "400": {
99585
+ "description": "400",
99586
+ "content": {
99587
+ "application/json": {
99588
+ "schema": {
99589
+ "oneOf": [
99590
+ {
99591
+ "type": "object",
99592
+ "properties": {
99593
+ "defined": {
99594
+ "const": true
99595
+ },
99596
+ "code": {
99597
+ "const": "BAD_REQUEST"
99598
+ },
99599
+ "status": {
99600
+ "const": 400
99601
+ },
99602
+ "message": {
99603
+ "type": "string",
99604
+ "default": "Check the request input."
99605
+ },
99606
+ "data": {}
99607
+ },
99608
+ "required": [
99609
+ "defined",
99610
+ "code",
99611
+ "status",
99612
+ "message"
99613
+ ]
99614
+ },
99615
+ {
99616
+ "type": "object",
99617
+ "properties": {
99618
+ "defined": {
99619
+ "const": false
99620
+ },
99621
+ "code": {
99622
+ "type": "string"
99623
+ },
99624
+ "status": {
99625
+ "type": "number"
99626
+ },
99627
+ "message": {
99628
+ "type": "string"
99629
+ },
99630
+ "data": {}
99631
+ },
99632
+ "required": [
99633
+ "defined",
99634
+ "code",
99635
+ "status",
99636
+ "message"
99637
+ ]
99638
+ }
99639
+ ]
99640
+ }
99641
+ }
99642
+ }
99643
+ },
99644
+ "401": {
99645
+ "description": "401",
99646
+ "content": {
99647
+ "application/json": {
99648
+ "schema": {
99649
+ "oneOf": [
99650
+ {
99651
+ "type": "object",
99652
+ "properties": {
99653
+ "defined": {
99654
+ "const": true
99655
+ },
99656
+ "code": {
99657
+ "const": "UNAUTHORIZED"
99658
+ },
99659
+ "status": {
99660
+ "const": 401
99661
+ },
99662
+ "message": {
99663
+ "type": "string",
99664
+ "default": "A valid Shuffl API token is required."
99665
+ },
99666
+ "data": {}
99667
+ },
99668
+ "required": [
99669
+ "defined",
99670
+ "code",
99671
+ "status",
99672
+ "message"
99673
+ ]
99674
+ },
99675
+ {
99676
+ "type": "object",
99677
+ "properties": {
99678
+ "defined": {
99679
+ "const": false
99680
+ },
99681
+ "code": {
99682
+ "type": "string"
99683
+ },
99684
+ "status": {
99685
+ "type": "number"
99686
+ },
99687
+ "message": {
99688
+ "type": "string"
99689
+ },
99690
+ "data": {}
99691
+ },
99692
+ "required": [
99693
+ "defined",
99694
+ "code",
99695
+ "status",
99696
+ "message"
99697
+ ]
99698
+ }
99699
+ ]
99700
+ }
99701
+ }
99702
+ }
99703
+ },
99704
+ "403": {
99705
+ "description": "403",
99706
+ "content": {
99707
+ "application/json": {
99708
+ "schema": {
99709
+ "oneOf": [
99710
+ {
99711
+ "type": "object",
99712
+ "properties": {
99713
+ "defined": {
99714
+ "const": true
99715
+ },
99716
+ "code": {
99717
+ "const": "FORBIDDEN"
99718
+ },
99719
+ "status": {
99720
+ "const": 403
99721
+ },
99722
+ "message": {
99723
+ "type": "string",
99724
+ "default": "This token or team role does not permit the operation."
99725
+ },
99726
+ "data": {}
99727
+ },
99728
+ "required": [
99729
+ "defined",
99730
+ "code",
99731
+ "status",
99732
+ "message"
99733
+ ]
99734
+ },
99735
+ {
99736
+ "type": "object",
99737
+ "properties": {
99738
+ "defined": {
99739
+ "const": false
99740
+ },
99741
+ "code": {
99742
+ "type": "string"
99743
+ },
99744
+ "status": {
99745
+ "type": "number"
99746
+ },
99747
+ "message": {
99748
+ "type": "string"
99749
+ },
99750
+ "data": {}
99751
+ },
99752
+ "required": [
99753
+ "defined",
99754
+ "code",
99755
+ "status",
99756
+ "message"
99757
+ ]
99758
+ }
99759
+ ]
99760
+ }
99761
+ }
99762
+ }
99763
+ },
99764
+ "404": {
99765
+ "description": "404",
99766
+ "content": {
99767
+ "application/json": {
99768
+ "schema": {
99769
+ "oneOf": [
99770
+ {
99771
+ "type": "object",
99772
+ "properties": {
99773
+ "defined": {
99774
+ "const": true
99775
+ },
99776
+ "code": {
99777
+ "const": "NOT_FOUND"
99778
+ },
99779
+ "status": {
99780
+ "const": 404
99781
+ },
99782
+ "message": {
99783
+ "type": "string",
99784
+ "default": "The requested resource was not found."
99785
+ },
99786
+ "data": {}
99787
+ },
99788
+ "required": [
99789
+ "defined",
99790
+ "code",
99791
+ "status",
99792
+ "message"
99793
+ ]
99794
+ },
99795
+ {
99796
+ "type": "object",
99797
+ "properties": {
99798
+ "defined": {
99799
+ "const": false
99800
+ },
99801
+ "code": {
99802
+ "type": "string"
99803
+ },
99804
+ "status": {
99805
+ "type": "number"
99806
+ },
99807
+ "message": {
99808
+ "type": "string"
99809
+ },
99810
+ "data": {}
99811
+ },
99812
+ "required": [
99813
+ "defined",
99814
+ "code",
99815
+ "status",
99816
+ "message"
99817
+ ]
99818
+ }
99819
+ ]
99820
+ }
99821
+ }
99822
+ }
99823
+ },
99824
+ "409": {
99825
+ "description": "409",
99826
+ "content": {
99827
+ "application/json": {
99828
+ "schema": {
99829
+ "oneOf": [
99830
+ {
99831
+ "type": "object",
99832
+ "properties": {
99833
+ "defined": {
99834
+ "const": true
99835
+ },
99836
+ "code": {
99837
+ "const": "CONFLICT"
99838
+ },
99839
+ "status": {
99840
+ "const": 409
99841
+ },
99842
+ "message": {
99843
+ "type": "string",
99844
+ "default": "The resource changed or the request key was reused."
99845
+ },
99846
+ "data": {}
99847
+ },
99848
+ "required": [
99849
+ "defined",
99850
+ "code",
99851
+ "status",
99852
+ "message"
99853
+ ]
99854
+ },
99855
+ {
99856
+ "type": "object",
99857
+ "properties": {
99858
+ "defined": {
99859
+ "const": false
99860
+ },
99861
+ "code": {
99862
+ "type": "string"
99863
+ },
99864
+ "status": {
99865
+ "type": "number"
99866
+ },
99867
+ "message": {
99868
+ "type": "string"
99869
+ },
99870
+ "data": {}
99871
+ },
99872
+ "required": [
99873
+ "defined",
99874
+ "code",
99875
+ "status",
99876
+ "message"
99877
+ ]
99878
+ }
99879
+ ]
99880
+ }
99881
+ }
99882
+ }
99883
+ },
99884
+ "412": {
99885
+ "description": "412",
99886
+ "content": {
99887
+ "application/json": {
99888
+ "schema": {
99889
+ "oneOf": [
99890
+ {
99891
+ "type": "object",
99892
+ "properties": {
99893
+ "defined": {
99894
+ "const": true
99895
+ },
99896
+ "code": {
99897
+ "const": "PRECONDITION_FAILED"
99898
+ },
99899
+ "status": {
99900
+ "const": 412
99901
+ },
99902
+ "message": {
99903
+ "type": "string",
99904
+ "default": "The team is not ready for this operation."
99905
+ },
99906
+ "data": {}
99907
+ },
99908
+ "required": [
99909
+ "defined",
99910
+ "code",
99911
+ "status",
99912
+ "message"
99913
+ ]
99914
+ },
99915
+ {
99916
+ "type": "object",
99917
+ "properties": {
99918
+ "defined": {
99919
+ "const": false
99920
+ },
99921
+ "code": {
99922
+ "type": "string"
99923
+ },
99924
+ "status": {
99925
+ "type": "number"
99926
+ },
99927
+ "message": {
99928
+ "type": "string"
99929
+ },
99930
+ "data": {}
99931
+ },
99932
+ "required": [
99933
+ "defined",
99934
+ "code",
99935
+ "status",
99936
+ "message"
99937
+ ]
99938
+ }
99939
+ ]
99940
+ }
99941
+ }
99942
+ }
99943
+ },
99944
+ "429": {
99945
+ "description": "429",
99946
+ "content": {
99947
+ "application/json": {
99948
+ "schema": {
99949
+ "oneOf": [
99950
+ {
99951
+ "type": "object",
99952
+ "properties": {
99953
+ "defined": {
99954
+ "const": true
99955
+ },
99956
+ "code": {
99957
+ "const": "TOO_MANY_REQUESTS"
99958
+ },
99959
+ "status": {
99960
+ "const": 429
99961
+ },
99962
+ "message": {
99963
+ "type": "string",
99964
+ "default": "Too many requests. Try again shortly."
99965
+ },
99966
+ "data": {}
99967
+ },
99968
+ "required": [
99969
+ "defined",
99970
+ "code",
99971
+ "status",
99972
+ "message"
99973
+ ]
99974
+ },
99975
+ {
99976
+ "type": "object",
99977
+ "properties": {
99978
+ "defined": {
99979
+ "const": false
99980
+ },
99981
+ "code": {
99982
+ "type": "string"
99983
+ },
99984
+ "status": {
99985
+ "type": "number"
99986
+ },
99987
+ "message": {
99988
+ "type": "string"
99989
+ },
99990
+ "data": {}
99991
+ },
99992
+ "required": [
99993
+ "defined",
99994
+ "code",
99995
+ "status",
99996
+ "message"
99997
+ ]
99998
+ }
99999
+ ]
100000
+ }
100001
+ }
100002
+ }
100003
+ }
100004
+ },
100005
+ "x-shuffl-access": "read",
100006
+ "x-shuffl-permission": "onboarding.enrollmentPreview"
100007
+ }
100008
+ },
100009
+ "/manage/onboarding/firstDaysCheckIns": {
100010
+ "post": {
100011
+ "operationId": "onboarding.firstDaysCheckIns",
100012
+ "summary": "Your open 30, 60 or 90-day or one-year new hire check-in",
100013
+ "requestBody": {
100014
+ "required": true,
100015
+ "content": {
100016
+ "application/json": {
100017
+ "schema": {
100018
+ "type": "object",
100019
+ "additionalProperties": false
100020
+ }
100021
+ }
100022
+ }
100023
+ },
100024
+ "responses": {
100025
+ "200": {
100026
+ "description": "OK",
100027
+ "content": {
100028
+ "application/json": {
100029
+ "schema": {
100030
+ "type": "array",
100031
+ "items": {
100032
+ "type": "object",
100033
+ "properties": {
100034
+ "checkpoint": {
100035
+ "anyOf": [
100036
+ {
100037
+ "const": "day_30"
100038
+ },
100039
+ {
100040
+ "const": "day_365"
100041
+ },
100042
+ {
100043
+ "const": "day_60"
100044
+ },
100045
+ {
100046
+ "const": "day_90"
100047
+ }
100048
+ ]
100049
+ },
100050
+ "closesAt": {
100051
+ "type": "string",
100052
+ "format": "date-time"
100053
+ },
100054
+ "questions": {
100055
+ "type": "array",
100056
+ "items": {
100057
+ "anyOf": [
100058
+ {
100059
+ "type": "object",
100060
+ "properties": {
100061
+ "id": {
100062
+ "type": "string"
100063
+ },
100064
+ "kind": {
100065
+ "const": "scale"
100066
+ },
100067
+ "scale": {
100068
+ "anyOf": [
100069
+ {
100070
+ "const": "agree_5"
100071
+ },
100072
+ {
100073
+ "const": "nps_11"
100074
+ },
100075
+ {
100076
+ "const": "rating_5"
100077
+ },
100078
+ {
100079
+ "const": "yes_no"
100080
+ }
100081
+ ]
100082
+ },
100083
+ "text": {
100084
+ "type": "string"
100085
+ }
100086
+ },
100087
+ "required": [
100088
+ "id",
100089
+ "kind",
100090
+ "scale",
100091
+ "text"
100092
+ ],
100093
+ "additionalProperties": false
100094
+ },
100095
+ {
100096
+ "type": "object",
100097
+ "properties": {
100098
+ "id": {
100099
+ "type": "string"
100100
+ },
100101
+ "kind": {
100102
+ "const": "open"
100103
+ },
100104
+ "text": {
100105
+ "type": "string"
100106
+ }
100107
+ },
100108
+ "required": [
100109
+ "id",
100110
+ "kind",
100111
+ "text"
100112
+ ],
100113
+ "additionalProperties": false
100114
+ }
100115
+ ]
100116
+ }
100117
+ },
100118
+ "title": {
100119
+ "type": "string"
100120
+ }
100121
+ },
100122
+ "required": [
100123
+ "checkpoint",
100124
+ "closesAt",
100125
+ "questions",
100126
+ "title"
100127
+ ],
100128
+ "additionalProperties": false
100129
+ }
99307
100130
  }
99308
100131
  }
99309
100132
  }
@@ -99874,28 +100697,11 @@
99874
100697
  },
99875
100698
  "floor": {
99876
100699
  "type": "number"
99877
- },
99878
- "manager": {
99879
- "type": "object",
99880
- "properties": {
99881
- "booked": {
99882
- "type": "number"
99883
- },
99884
- "sent": {
99885
- "type": "number"
99886
- }
99887
- },
99888
- "required": [
99889
- "booked",
99890
- "sent"
99891
- ],
99892
- "additionalProperties": false
99893
100700
  }
99894
100701
  },
99895
100702
  "required": [
99896
100703
  "checkpoints",
99897
- "floor",
99898
- "manager"
100704
+ "floor"
99899
100705
  ],
99900
100706
  "additionalProperties": false
99901
100707
  }
@@ -100330,7 +101136,7 @@
100330
101136
  "/manage/onboarding/journey": {
100331
101137
  "post": {
100332
101138
  "operationId": "onboarding.journey",
100333
- "summary": "Your onboarding timeline: start date, buddy, manager and upcoming check-ins",
101139
+ "summary": "Your onboarding timeline: start date, buddy, manager, upcoming check-ins, your to-dos and resources",
100334
101140
  "requestBody": {
100335
101141
  "required": true,
100336
101142
  "content": {
@@ -100525,6 +101331,64 @@
100525
101331
  "enrolled": {
100526
101332
  "type": "boolean"
100527
101333
  },
101334
+ "gettingReady": {
101335
+ "type": "array",
101336
+ "items": {
101337
+ "type": "object",
101338
+ "properties": {
101339
+ "done": {
101340
+ "type": "boolean"
101341
+ },
101342
+ "due": {
101343
+ "anyOf": [
101344
+ {
101345
+ "type": "null"
101346
+ },
101347
+ {
101348
+ "type": "string"
101349
+ }
101350
+ ]
101351
+ },
101352
+ "id": {
101353
+ "type": "string"
101354
+ },
101355
+ "label": {
101356
+ "type": "string"
101357
+ },
101358
+ "owner": {
101359
+ "anyOf": [
101360
+ {
101361
+ "type": "null"
101362
+ },
101363
+ {
101364
+ "type": "object",
101365
+ "properties": {
101366
+ "id": {
101367
+ "type": "string"
101368
+ },
101369
+ "name": {
101370
+ "type": "string"
101371
+ }
101372
+ },
101373
+ "required": [
101374
+ "id",
101375
+ "name"
101376
+ ],
101377
+ "additionalProperties": false
101378
+ }
101379
+ ]
101380
+ }
101381
+ },
101382
+ "required": [
101383
+ "done",
101384
+ "due",
101385
+ "id",
101386
+ "label",
101387
+ "owner"
101388
+ ],
101389
+ "additionalProperties": false
101390
+ }
101391
+ },
100528
101392
  "manager": {
100529
101393
  "anyOf": [
100530
101394
  {
@@ -100603,47 +101467,6 @@
100603
101467
  }
100604
101468
  ]
100605
101469
  },
100606
- "managerCheckIns": {
100607
- "anyOf": [
100608
- {
100609
- "type": "null"
100610
- },
100611
- {
100612
- "type": "object",
100613
- "properties": {
100614
- "cadence": {
100615
- "anyOf": [
100616
- {
100617
- "const": "biweekly"
100618
- },
100619
- {
100620
- "const": "weekly"
100621
- }
100622
- ]
100623
- },
100624
- "week": {
100625
- "anyOf": [
100626
- {
100627
- "type": "null"
100628
- },
100629
- {
100630
- "type": "number"
100631
- }
100632
- ]
100633
- },
100634
- "weeks": {
100635
- "type": "number"
100636
- }
100637
- },
100638
- "required": [
100639
- "cadence",
100640
- "week",
100641
- "weeks"
100642
- ],
100643
- "additionalProperties": false
100644
- }
100645
- ]
100646
- },
100647
101470
  "programName": {
100648
101471
  "anyOf": [
100649
101472
  {
@@ -100654,6 +101477,85 @@
100654
101477
  }
100655
101478
  ]
100656
101479
  },
101480
+ "resources": {
101481
+ "type": "array",
101482
+ "items": {
101483
+ "anyOf": [
101484
+ {
101485
+ "type": "object",
101486
+ "properties": {
101487
+ "day": {
101488
+ "type": "number"
101489
+ },
101490
+ "sourceId": {
101491
+ "type": "string"
101492
+ },
101493
+ "title": {
101494
+ "type": "string"
101495
+ },
101496
+ "type": {
101497
+ "const": "knowledge"
101498
+ }
101499
+ },
101500
+ "required": [
101501
+ "day",
101502
+ "sourceId",
101503
+ "title",
101504
+ "type"
101505
+ ],
101506
+ "additionalProperties": false
101507
+ },
101508
+ {
101509
+ "type": "object",
101510
+ "properties": {
101511
+ "day": {
101512
+ "type": "number"
101513
+ },
101514
+ "label": {
101515
+ "type": "string"
101516
+ },
101517
+ "type": {
101518
+ "const": "link"
101519
+ },
101520
+ "url": {
101521
+ "type": "string"
101522
+ }
101523
+ },
101524
+ "required": [
101525
+ "day",
101526
+ "label",
101527
+ "type",
101528
+ "url"
101529
+ ],
101530
+ "additionalProperties": false
101531
+ },
101532
+ {
101533
+ "type": "object",
101534
+ "properties": {
101535
+ "communityId": {
101536
+ "type": "string"
101537
+ },
101538
+ "day": {
101539
+ "type": "number"
101540
+ },
101541
+ "name": {
101542
+ "type": "string"
101543
+ },
101544
+ "type": {
101545
+ "const": "community"
101546
+ }
101547
+ },
101548
+ "required": [
101549
+ "communityId",
101550
+ "day",
101551
+ "name",
101552
+ "type"
101553
+ ],
101554
+ "additionalProperties": false
101555
+ }
101556
+ ]
101557
+ }
101558
+ },
100657
101559
  "startDate": {
100658
101560
  "anyOf": [
100659
101561
  {
@@ -100693,8 +101595,17 @@
100693
101595
  {
100694
101596
  "const": "check_in"
100695
101597
  },
101598
+ {
101599
+ "const": "checkpoint"
101600
+ },
100696
101601
  {
100697
101602
  "const": "introduction"
101603
+ },
101604
+ {
101605
+ "const": "message"
101606
+ },
101607
+ {
101608
+ "const": "task"
100698
101609
  }
100699
101610
  ]
100700
101611
  },
@@ -100716,6 +101627,26 @@
100716
101627
  },
100717
101628
  "stepId": {
100718
101629
  "type": "string"
101630
+ },
101631
+ "stepKey": {
101632
+ "anyOf": [
101633
+ {
101634
+ "type": "null"
101635
+ },
101636
+ {
101637
+ "type": "string"
101638
+ }
101639
+ ]
101640
+ },
101641
+ "title": {
101642
+ "anyOf": [
101643
+ {
101644
+ "type": "null"
101645
+ },
101646
+ {
101647
+ "type": "string"
101648
+ }
101649
+ ]
100719
101650
  }
100720
101651
  },
100721
101652
  "required": [
@@ -100725,13 +101656,73 @@
100725
101656
  "kind",
100726
101657
  "state",
100727
101658
  "status",
100728
- "stepId"
101659
+ "stepId",
101660
+ "stepKey",
101661
+ "title"
100729
101662
  ],
100730
101663
  "additionalProperties": false
100731
101664
  }
100732
101665
  },
100733
101666
  "today": {
100734
101667
  "type": "string"
101668
+ },
101669
+ "todos": {
101670
+ "type": "array",
101671
+ "items": {
101672
+ "type": "object",
101673
+ "properties": {
101674
+ "done": {
101675
+ "type": "boolean"
101676
+ },
101677
+ "due": {
101678
+ "anyOf": [
101679
+ {
101680
+ "type": "null"
101681
+ },
101682
+ {
101683
+ "type": "string"
101684
+ }
101685
+ ]
101686
+ },
101687
+ "id": {
101688
+ "type": "string"
101689
+ },
101690
+ "label": {
101691
+ "type": "string"
101692
+ },
101693
+ "owner": {
101694
+ "anyOf": [
101695
+ {
101696
+ "type": "null"
101697
+ },
101698
+ {
101699
+ "type": "object",
101700
+ "properties": {
101701
+ "id": {
101702
+ "type": "string"
101703
+ },
101704
+ "name": {
101705
+ "type": "string"
101706
+ }
101707
+ },
101708
+ "required": [
101709
+ "id",
101710
+ "name"
101711
+ ],
101712
+ "additionalProperties": false
101713
+ }
101714
+ ]
101715
+ }
101716
+ },
101717
+ "required": [
101718
+ "done",
101719
+ "due",
101720
+ "id",
101721
+ "label",
101722
+ "owner"
101723
+ ],
101724
+ "additionalProperties": false
101725
+ }
100735
101726
  }
100736
101727
  },
100737
101728
  "required": [
@@ -100739,12 +101730,14 @@
100739
101730
  "checkpoints",
100740
101731
  "day",
100741
101732
  "enrolled",
101733
+ "gettingReady",
100742
101734
  "manager",
100743
- "managerCheckIns",
100744
101735
  "programName",
101736
+ "resources",
100745
101737
  "startDate",
100746
101738
  "steps",
100747
- "today"
101739
+ "today",
101740
+ "todos"
100748
101741
  ],
100749
101742
  "additionalProperties": false
100750
101743
  }
@@ -103352,6 +104345,191 @@
103352
104345
  "sendTime": {
103353
104346
  "type": "string"
103354
104347
  },
104348
+ "steps": {
104349
+ "type": "array",
104350
+ "items": {
104351
+ "type": "object",
104352
+ "properties": {
104353
+ "body": {
104354
+ "type": "string"
104355
+ },
104356
+ "checkpoint": {
104357
+ "anyOf": [
104358
+ {
104359
+ "const": "day_30"
104360
+ },
104361
+ {
104362
+ "const": "day_365"
104363
+ },
104364
+ {
104365
+ "const": "day_60"
104366
+ },
104367
+ {
104368
+ "const": "day_90"
104369
+ }
104370
+ ]
104371
+ },
104372
+ "id": {
104373
+ "type": "string"
104374
+ },
104375
+ "kind": {
104376
+ "anyOf": [
104377
+ {
104378
+ "const": "acknowledge"
104379
+ },
104380
+ {
104381
+ "const": "checkpoint"
104382
+ },
104383
+ {
104384
+ "const": "form"
104385
+ },
104386
+ {
104387
+ "const": "meet"
104388
+ },
104389
+ {
104390
+ "const": "message"
104391
+ },
104392
+ {
104393
+ "const": "task"
104394
+ }
104395
+ ]
104396
+ },
104397
+ "offsetDays": {
104398
+ "type": "number"
104399
+ },
104400
+ "personId": {
104401
+ "anyOf": [
104402
+ {
104403
+ "type": "null"
104404
+ },
104405
+ {
104406
+ "type": "string"
104407
+ }
104408
+ ]
104409
+ },
104410
+ "recipient": {
104411
+ "anyOf": [
104412
+ {
104413
+ "const": "buddy"
104414
+ },
104415
+ {
104416
+ "const": "hire"
104417
+ },
104418
+ {
104419
+ "const": "hr"
104420
+ },
104421
+ {
104422
+ "const": "manager"
104423
+ },
104424
+ {
104425
+ "const": "person"
104426
+ }
104427
+ ]
104428
+ },
104429
+ "resources": {
104430
+ "type": "array",
104431
+ "items": {
104432
+ "anyOf": [
104433
+ {
104434
+ "type": "object",
104435
+ "properties": {
104436
+ "sourceId": {
104437
+ "type": "string"
104438
+ },
104439
+ "title": {
104440
+ "type": "string"
104441
+ },
104442
+ "type": {
104443
+ "const": "knowledge"
104444
+ }
104445
+ },
104446
+ "required": [
104447
+ "sourceId",
104448
+ "title",
104449
+ "type"
104450
+ ],
104451
+ "additionalProperties": false
104452
+ },
104453
+ {
104454
+ "type": "object",
104455
+ "properties": {
104456
+ "label": {
104457
+ "type": "string"
104458
+ },
104459
+ "type": {
104460
+ "const": "link"
104461
+ },
104462
+ "url": {
104463
+ "type": "string"
104464
+ }
104465
+ },
104466
+ "required": [
104467
+ "label",
104468
+ "type",
104469
+ "url"
104470
+ ],
104471
+ "additionalProperties": false
104472
+ },
104473
+ {
104474
+ "type": "object",
104475
+ "properties": {
104476
+ "communityId": {
104477
+ "type": "string"
104478
+ },
104479
+ "name": {
104480
+ "type": "string"
104481
+ },
104482
+ "type": {
104483
+ "const": "community"
104484
+ }
104485
+ },
104486
+ "required": [
104487
+ "communityId",
104488
+ "name",
104489
+ "type"
104490
+ ],
104491
+ "additionalProperties": false
104492
+ }
104493
+ ]
104494
+ }
104495
+ },
104496
+ "title": {
104497
+ "type": "string"
104498
+ },
104499
+ "todos": {
104500
+ "type": "array",
104501
+ "items": {
104502
+ "type": "object",
104503
+ "properties": {
104504
+ "id": {
104505
+ "type": "string"
104506
+ },
104507
+ "label": {
104508
+ "type": "string"
104509
+ }
104510
+ },
104511
+ "required": [
104512
+ "id",
104513
+ "label"
104514
+ ],
104515
+ "additionalProperties": false
104516
+ }
104517
+ }
104518
+ },
104519
+ "required": [
104520
+ "body",
104521
+ "id",
104522
+ "kind",
104523
+ "offsetDays",
104524
+ "personId",
104525
+ "recipient",
104526
+ "resources",
104527
+ "title",
104528
+ "todos"
104529
+ ],
104530
+ "additionalProperties": false
104531
+ }
104532
+ },
103355
104533
  "timezone": {
103356
104534
  "type": "string"
103357
104535
  }
@@ -103726,17 +104904,35 @@
103726
104904
  },
103727
104905
  "kind": {
103728
104906
  "anyOf": [
104907
+ {
104908
+ "const": "acknowledge"
104909
+ },
103729
104910
  {
103730
104911
  "const": "buddy_invitation"
103731
104912
  },
103732
104913
  {
103733
104914
  "const": "check_in"
103734
104915
  },
104916
+ {
104917
+ "const": "checkpoint"
104918
+ },
103735
104919
  {
103736
104920
  "const": "follow_up"
103737
104921
  },
104922
+ {
104923
+ "const": "form"
104924
+ },
103738
104925
  {
103739
104926
  "const": "introduction"
104927
+ },
104928
+ {
104929
+ "const": "meet"
104930
+ },
104931
+ {
104932
+ "const": "message"
104933
+ },
104934
+ {
104935
+ "const": "task"
103740
104936
  }
103741
104937
  ]
103742
104938
  },
@@ -103790,6 +104986,26 @@
103790
104986
  "const": "waiting"
103791
104987
  }
103792
104988
  ]
104989
+ },
104990
+ "stepKey": {
104991
+ "anyOf": [
104992
+ {
104993
+ "type": "null"
104994
+ },
104995
+ {
104996
+ "type": "string"
104997
+ }
104998
+ ]
104999
+ },
105000
+ "title": {
105001
+ "anyOf": [
105002
+ {
105003
+ "type": "null"
105004
+ },
105005
+ {
105006
+ "type": "string"
105007
+ }
105008
+ ]
103793
105009
  }
103794
105010
  },
103795
105011
  "required": [
@@ -103803,7 +105019,9 @@
103803
105019
  "kind",
103804
105020
  "offsetDays",
103805
105021
  "sentAt",
103806
- "status"
105022
+ "status",
105023
+ "stepKey",
105024
+ "title"
103807
105025
  ],
103808
105026
  "additionalProperties": false
103809
105027
  }
@@ -103827,6 +105045,15 @@
103827
105045
  ],
103828
105046
  "additionalProperties": false
103829
105047
  }
105048
+ },
105049
+ "stepPeople": {
105050
+ "type": "object",
105051
+ "propertyNames": {
105052
+ "type": "string"
105053
+ },
105054
+ "additionalProperties": {
105055
+ "type": "string"
105056
+ }
103830
105057
  }
103831
105058
  },
103832
105059
  "required": [
@@ -103834,7 +105061,8 @@
103834
105061
  "intro",
103835
105062
  "program",
103836
105063
  "responderName",
103837
- "rows"
105064
+ "rows",
105065
+ "stepPeople"
103838
105066
  ],
103839
105067
  "additionalProperties": false
103840
105068
  }
@@ -105959,6 +107187,178 @@
105959
107187
  "sendTime": {
105960
107188
  "type": "string"
105961
107189
  },
107190
+ "steps": {
107191
+ "type": "array",
107192
+ "items": {
107193
+ "type": "object",
107194
+ "properties": {
107195
+ "body": {
107196
+ "type": "string"
107197
+ },
107198
+ "checkpoint": {
107199
+ "anyOf": [
107200
+ {
107201
+ "const": "day_30"
107202
+ },
107203
+ {
107204
+ "const": "day_365"
107205
+ },
107206
+ {
107207
+ "const": "day_60"
107208
+ },
107209
+ {
107210
+ "const": "day_90"
107211
+ }
107212
+ ]
107213
+ },
107214
+ "id": {
107215
+ "type": "string"
107216
+ },
107217
+ "kind": {
107218
+ "anyOf": [
107219
+ {
107220
+ "const": "checkpoint"
107221
+ },
107222
+ {
107223
+ "const": "message"
107224
+ },
107225
+ {
107226
+ "const": "task"
107227
+ }
107228
+ ]
107229
+ },
107230
+ "offsetDays": {
107231
+ "type": "number"
107232
+ },
107233
+ "personId": {
107234
+ "anyOf": [
107235
+ {
107236
+ "type": "null"
107237
+ },
107238
+ {
107239
+ "type": "string"
107240
+ }
107241
+ ]
107242
+ },
107243
+ "recipient": {
107244
+ "anyOf": [
107245
+ {
107246
+ "const": "buddy"
107247
+ },
107248
+ {
107249
+ "const": "hire"
107250
+ },
107251
+ {
107252
+ "const": "hr"
107253
+ },
107254
+ {
107255
+ "const": "manager"
107256
+ },
107257
+ {
107258
+ "const": "person"
107259
+ }
107260
+ ]
107261
+ },
107262
+ "resources": {
107263
+ "type": "array",
107264
+ "items": {
107265
+ "anyOf": [
107266
+ {
107267
+ "type": "object",
107268
+ "properties": {
107269
+ "sourceId": {
107270
+ "type": "string"
107271
+ },
107272
+ "title": {
107273
+ "type": "string"
107274
+ },
107275
+ "type": {
107276
+ "const": "knowledge"
107277
+ }
107278
+ },
107279
+ "required": [
107280
+ "sourceId",
107281
+ "title",
107282
+ "type"
107283
+ ],
107284
+ "additionalProperties": false
107285
+ },
107286
+ {
107287
+ "type": "object",
107288
+ "properties": {
107289
+ "label": {
107290
+ "type": "string"
107291
+ },
107292
+ "type": {
107293
+ "const": "link"
107294
+ },
107295
+ "url": {
107296
+ "type": "string"
107297
+ }
107298
+ },
107299
+ "required": [
107300
+ "label",
107301
+ "type",
107302
+ "url"
107303
+ ],
107304
+ "additionalProperties": false
107305
+ },
107306
+ {
107307
+ "type": "object",
107308
+ "properties": {
107309
+ "communityId": {
107310
+ "type": "string"
107311
+ },
107312
+ "name": {
107313
+ "type": "string"
107314
+ },
107315
+ "type": {
107316
+ "const": "community"
107317
+ }
107318
+ },
107319
+ "required": [
107320
+ "communityId",
107321
+ "name",
107322
+ "type"
107323
+ ],
107324
+ "additionalProperties": false
107325
+ }
107326
+ ]
107327
+ }
107328
+ },
107329
+ "title": {
107330
+ "type": "string"
107331
+ },
107332
+ "todos": {
107333
+ "type": "array",
107334
+ "items": {
107335
+ "type": "object",
107336
+ "properties": {
107337
+ "id": {
107338
+ "type": "string"
107339
+ },
107340
+ "label": {
107341
+ "type": "string"
107342
+ }
107343
+ },
107344
+ "required": [
107345
+ "id",
107346
+ "label"
107347
+ ],
107348
+ "additionalProperties": false
107349
+ }
107350
+ }
107351
+ },
107352
+ "required": [
107353
+ "id",
107354
+ "kind",
107355
+ "offsetDays",
107356
+ "recipient",
107357
+ "title"
107358
+ ],
107359
+ "additionalProperties": false
107360
+ }
107361
+ },
105962
107362
  "timezone": {
105963
107363
  "type": "string"
105964
107364
  }
@@ -106297,6 +107697,191 @@
106297
107697
  "sendTime": {
106298
107698
  "type": "string"
106299
107699
  },
107700
+ "steps": {
107701
+ "type": "array",
107702
+ "items": {
107703
+ "type": "object",
107704
+ "properties": {
107705
+ "body": {
107706
+ "type": "string"
107707
+ },
107708
+ "checkpoint": {
107709
+ "anyOf": [
107710
+ {
107711
+ "const": "day_30"
107712
+ },
107713
+ {
107714
+ "const": "day_365"
107715
+ },
107716
+ {
107717
+ "const": "day_60"
107718
+ },
107719
+ {
107720
+ "const": "day_90"
107721
+ }
107722
+ ]
107723
+ },
107724
+ "id": {
107725
+ "type": "string"
107726
+ },
107727
+ "kind": {
107728
+ "anyOf": [
107729
+ {
107730
+ "const": "acknowledge"
107731
+ },
107732
+ {
107733
+ "const": "checkpoint"
107734
+ },
107735
+ {
107736
+ "const": "form"
107737
+ },
107738
+ {
107739
+ "const": "meet"
107740
+ },
107741
+ {
107742
+ "const": "message"
107743
+ },
107744
+ {
107745
+ "const": "task"
107746
+ }
107747
+ ]
107748
+ },
107749
+ "offsetDays": {
107750
+ "type": "number"
107751
+ },
107752
+ "personId": {
107753
+ "anyOf": [
107754
+ {
107755
+ "type": "null"
107756
+ },
107757
+ {
107758
+ "type": "string"
107759
+ }
107760
+ ]
107761
+ },
107762
+ "recipient": {
107763
+ "anyOf": [
107764
+ {
107765
+ "const": "buddy"
107766
+ },
107767
+ {
107768
+ "const": "hire"
107769
+ },
107770
+ {
107771
+ "const": "hr"
107772
+ },
107773
+ {
107774
+ "const": "manager"
107775
+ },
107776
+ {
107777
+ "const": "person"
107778
+ }
107779
+ ]
107780
+ },
107781
+ "resources": {
107782
+ "type": "array",
107783
+ "items": {
107784
+ "anyOf": [
107785
+ {
107786
+ "type": "object",
107787
+ "properties": {
107788
+ "sourceId": {
107789
+ "type": "string"
107790
+ },
107791
+ "title": {
107792
+ "type": "string"
107793
+ },
107794
+ "type": {
107795
+ "const": "knowledge"
107796
+ }
107797
+ },
107798
+ "required": [
107799
+ "sourceId",
107800
+ "title",
107801
+ "type"
107802
+ ],
107803
+ "additionalProperties": false
107804
+ },
107805
+ {
107806
+ "type": "object",
107807
+ "properties": {
107808
+ "label": {
107809
+ "type": "string"
107810
+ },
107811
+ "type": {
107812
+ "const": "link"
107813
+ },
107814
+ "url": {
107815
+ "type": "string"
107816
+ }
107817
+ },
107818
+ "required": [
107819
+ "label",
107820
+ "type",
107821
+ "url"
107822
+ ],
107823
+ "additionalProperties": false
107824
+ },
107825
+ {
107826
+ "type": "object",
107827
+ "properties": {
107828
+ "communityId": {
107829
+ "type": "string"
107830
+ },
107831
+ "name": {
107832
+ "type": "string"
107833
+ },
107834
+ "type": {
107835
+ "const": "community"
107836
+ }
107837
+ },
107838
+ "required": [
107839
+ "communityId",
107840
+ "name",
107841
+ "type"
107842
+ ],
107843
+ "additionalProperties": false
107844
+ }
107845
+ ]
107846
+ }
107847
+ },
107848
+ "title": {
107849
+ "type": "string"
107850
+ },
107851
+ "todos": {
107852
+ "type": "array",
107853
+ "items": {
107854
+ "type": "object",
107855
+ "properties": {
107856
+ "id": {
107857
+ "type": "string"
107858
+ },
107859
+ "label": {
107860
+ "type": "string"
107861
+ }
107862
+ },
107863
+ "required": [
107864
+ "id",
107865
+ "label"
107866
+ ],
107867
+ "additionalProperties": false
107868
+ }
107869
+ }
107870
+ },
107871
+ "required": [
107872
+ "body",
107873
+ "id",
107874
+ "kind",
107875
+ "offsetDays",
107876
+ "personId",
107877
+ "recipient",
107878
+ "resources",
107879
+ "title",
107880
+ "todos"
107881
+ ],
107882
+ "additionalProperties": false
107883
+ }
107884
+ },
106300
107885
  "timezone": {
106301
107886
  "type": "string"
106302
107887
  }
@@ -111954,12 +113539,20 @@
111954
113539
  "count": {
111955
113540
  "type": "number"
111956
113541
  },
113542
+ "givers": {
113543
+ "type": "number"
113544
+ },
113545
+ "recognized": {
113546
+ "type": "number"
113547
+ },
111957
113548
  "week": {
111958
113549
  "type": "string"
111959
113550
  }
111960
113551
  },
111961
113552
  "required": [
111962
113553
  "count",
113554
+ "givers",
113555
+ "recognized",
111963
113556
  "week"
111964
113557
  ],
111965
113558
  "additionalProperties": false
@@ -153487,21 +155080,12 @@
153487
155080
  {
153488
155081
  "const": "before_close"
153489
155082
  },
153490
- {
153491
- "const": "biweekly"
153492
- },
153493
155083
  {
153494
155084
  "const": "default"
153495
155085
  },
153496
155086
  {
153497
155087
  "const": "every_2_weeks"
153498
155088
  },
153499
- {
153500
- "const": "first_90_days"
153501
- },
153502
- {
153503
- "const": "first_year"
153504
- },
153505
155089
  {
153506
155090
  "const": "monthly"
153507
155091
  },
@@ -153513,9 +155097,6 @@
153513
155097
  },
153514
155098
  {
153515
155099
  "const": "quarterly"
153516
- },
153517
- {
153518
- "const": "weekly"
153519
155100
  }
153520
155101
  ]
153521
155102
  },
@@ -153524,18 +155105,9 @@
153524
155105
  {
153525
155106
  "const": "before_close"
153526
155107
  },
153527
- {
153528
- "const": "biweekly"
153529
- },
153530
155108
  {
153531
155109
  "const": "every_2_weeks"
153532
155110
  },
153533
- {
153534
- "const": "first_90_days"
153535
- },
153536
- {
153537
- "const": "first_year"
153538
- },
153539
155111
  {
153540
155112
  "const": "monthly"
153541
155113
  },
@@ -153547,20 +155119,11 @@
153547
155119
  },
153548
155120
  {
153549
155121
  "const": "quarterly"
153550
- },
153551
- {
153552
- "const": "weekly"
153553
155122
  }
153554
155123
  ]
153555
155124
  },
153556
155125
  "kind": {
153557
155126
  "anyOf": [
153558
- {
153559
- "const": "manager_check_in"
153560
- },
153561
- {
153562
- "const": "new_hire_check_in"
153563
- },
153564
155127
  {
153565
155128
  "const": "praise"
153566
155129
  },
@@ -153576,18 +155139,9 @@
153576
155139
  {
153577
155140
  "const": "before_close"
153578
155141
  },
153579
- {
153580
- "const": "biweekly"
153581
- },
153582
155142
  {
153583
155143
  "const": "every_2_weeks"
153584
155144
  },
153585
- {
153586
- "const": "first_90_days"
153587
- },
153588
- {
153589
- "const": "first_year"
153590
- },
153591
155145
  {
153592
155146
  "const": "monthly"
153593
155147
  },
@@ -153596,9 +155150,6 @@
153596
155150
  },
153597
155151
  {
153598
155152
  "const": "quarterly"
153599
- },
153600
- {
153601
- "const": "weekly"
153602
155153
  }
153603
155154
  ]
153604
155155
  }
@@ -153608,18 +155159,9 @@
153608
155159
  {
153609
155160
  "const": "before_close"
153610
155161
  },
153611
- {
153612
- "const": "biweekly"
153613
- },
153614
155162
  {
153615
155163
  "const": "every_2_weeks"
153616
155164
  },
153617
- {
153618
- "const": "first_90_days"
153619
- },
153620
- {
153621
- "const": "first_year"
153622
- },
153623
155165
  {
153624
155166
  "const": "monthly"
153625
155167
  },
@@ -153631,9 +155173,6 @@
153631
155173
  },
153632
155174
  {
153633
155175
  "const": "quarterly"
153634
- },
153635
- {
153636
- "const": "weekly"
153637
155176
  }
153638
155177
  ]
153639
155178
  }
@@ -154102,12 +155641,6 @@
154102
155641
  },
154103
155642
  "kind": {
154104
155643
  "anyOf": [
154105
- {
154106
- "const": "manager_check_in"
154107
- },
154108
- {
154109
- "const": "new_hire_check_in"
154110
- },
154111
155644
  {
154112
155645
  "const": "praise"
154113
155646
  },
@@ -154209,21 +155742,12 @@
154209
155742
  {
154210
155743
  "const": "before_close"
154211
155744
  },
154212
- {
154213
- "const": "biweekly"
154214
- },
154215
155745
  {
154216
155746
  "const": "default"
154217
155747
  },
154218
155748
  {
154219
155749
  "const": "every_2_weeks"
154220
155750
  },
154221
- {
154222
- "const": "first_90_days"
154223
- },
154224
- {
154225
- "const": "first_year"
154226
- },
154227
155751
  {
154228
155752
  "const": "monthly"
154229
155753
  },
@@ -154235,9 +155759,6 @@
154235
155759
  },
154236
155760
  {
154237
155761
  "const": "quarterly"
154238
- },
154239
- {
154240
- "const": "weekly"
154241
155762
  }
154242
155763
  ]
154243
155764
  },
@@ -154246,18 +155767,9 @@
154246
155767
  {
154247
155768
  "const": "before_close"
154248
155769
  },
154249
- {
154250
- "const": "biweekly"
154251
- },
154252
155770
  {
154253
155771
  "const": "every_2_weeks"
154254
155772
  },
154255
- {
154256
- "const": "first_90_days"
154257
- },
154258
- {
154259
- "const": "first_year"
154260
- },
154261
155773
  {
154262
155774
  "const": "monthly"
154263
155775
  },
@@ -154269,20 +155781,11 @@
154269
155781
  },
154270
155782
  {
154271
155783
  "const": "quarterly"
154272
- },
154273
- {
154274
- "const": "weekly"
154275
155784
  }
154276
155785
  ]
154277
155786
  },
154278
155787
  "kind": {
154279
155788
  "anyOf": [
154280
- {
154281
- "const": "manager_check_in"
154282
- },
154283
- {
154284
- "const": "new_hire_check_in"
154285
- },
154286
155789
  {
154287
155790
  "const": "praise"
154288
155791
  },
@@ -154298,18 +155801,9 @@
154298
155801
  {
154299
155802
  "const": "before_close"
154300
155803
  },
154301
- {
154302
- "const": "biweekly"
154303
- },
154304
155804
  {
154305
155805
  "const": "every_2_weeks"
154306
155806
  },
154307
- {
154308
- "const": "first_90_days"
154309
- },
154310
- {
154311
- "const": "first_year"
154312
- },
154313
155807
  {
154314
155808
  "const": "monthly"
154315
155809
  },
@@ -154318,9 +155812,6 @@
154318
155812
  },
154319
155813
  {
154320
155814
  "const": "quarterly"
154321
- },
154322
- {
154323
- "const": "weekly"
154324
155815
  }
154325
155816
  ]
154326
155817
  }
@@ -154330,18 +155821,9 @@
154330
155821
  {
154331
155822
  "const": "before_close"
154332
155823
  },
154333
- {
154334
- "const": "biweekly"
154335
- },
154336
155824
  {
154337
155825
  "const": "every_2_weeks"
154338
155826
  },
154339
- {
154340
- "const": "first_90_days"
154341
- },
154342
- {
154343
- "const": "first_year"
154344
- },
154345
155827
  {
154346
155828
  "const": "monthly"
154347
155829
  },
@@ -154353,9 +155835,6 @@
154353
155835
  },
154354
155836
  {
154355
155837
  "const": "quarterly"
154356
- },
154357
- {
154358
- "const": "weekly"
154359
155838
  }
154360
155839
  ]
154361
155840
  }
@@ -154842,12 +156321,6 @@
154842
156321
  },
154843
156322
  "kind": {
154844
156323
  "anyOf": [
154845
- {
154846
- "const": "manager_check_in"
154847
- },
154848
- {
154849
- "const": "new_hire_check_in"
154850
- },
154851
156324
  {
154852
156325
  "const": "praise"
154853
156326
  },
@@ -154944,18 +156417,9 @@
154944
156417
  {
154945
156418
  "const": "before_close"
154946
156419
  },
154947
- {
154948
- "const": "biweekly"
154949
- },
154950
156420
  {
154951
156421
  "const": "every_2_weeks"
154952
156422
  },
154953
- {
154954
- "const": "first_90_days"
154955
- },
154956
- {
154957
- "const": "first_year"
154958
- },
154959
156423
  {
154960
156424
  "const": "monthly"
154961
156425
  },
@@ -154967,9 +156431,6 @@
154967
156431
  },
154968
156432
  {
154969
156433
  "const": "quarterly"
154970
- },
154971
- {
154972
- "const": "weekly"
154973
156434
  }
154974
156435
  ]
154975
156436
  },
@@ -154981,12 +156442,6 @@
154981
156442
  },
154982
156443
  "kind": {
154983
156444
  "anyOf": [
154984
- {
154985
- "const": "manager_check_in"
154986
- },
154987
- {
154988
- "const": "new_hire_check_in"
154989
- },
154990
156445
  {
154991
156446
  "const": "praise"
154992
156447
  },
@@ -155466,136 +156921,6 @@
155466
156921
  "schema": {
155467
156922
  "type": "object",
155468
156923
  "properties": {
155469
- "manager_check_in": {
155470
- "type": "object",
155471
- "properties": {
155472
- "available": {
155473
- "type": "boolean"
155474
- },
155475
- "choice": {
155476
- "anyOf": [
155477
- {
155478
- "const": "before_close"
155479
- },
155480
- {
155481
- "const": "biweekly"
155482
- },
155483
- {
155484
- "const": "every_2_weeks"
155485
- },
155486
- {
155487
- "const": "first_90_days"
155488
- },
155489
- {
155490
- "const": "first_year"
155491
- },
155492
- {
155493
- "const": "monthly"
155494
- },
155495
- {
155496
- "const": "next_day"
155497
- },
155498
- {
155499
- "const": "off"
155500
- },
155501
- {
155502
- "const": "quarterly"
155503
- },
155504
- {
155505
- "const": "weekly"
155506
- }
155507
- ]
155508
- },
155509
- "days": {
155510
- "type": "array",
155511
- "items": {
155512
- "type": "number"
155513
- }
155514
- },
155515
- "optedOut": {
155516
- "type": "number"
155517
- },
155518
- "options": {
155519
- "type": "array",
155520
- "items": {
155521
- "type": "string"
155522
- }
155523
- }
155524
- },
155525
- "required": [
155526
- "available",
155527
- "choice",
155528
- "days",
155529
- "optedOut",
155530
- "options"
155531
- ],
155532
- "additionalProperties": false
155533
- },
155534
- "new_hire_check_in": {
155535
- "type": "object",
155536
- "properties": {
155537
- "available": {
155538
- "type": "boolean"
155539
- },
155540
- "choice": {
155541
- "anyOf": [
155542
- {
155543
- "const": "before_close"
155544
- },
155545
- {
155546
- "const": "biweekly"
155547
- },
155548
- {
155549
- "const": "every_2_weeks"
155550
- },
155551
- {
155552
- "const": "first_90_days"
155553
- },
155554
- {
155555
- "const": "first_year"
155556
- },
155557
- {
155558
- "const": "monthly"
155559
- },
155560
- {
155561
- "const": "next_day"
155562
- },
155563
- {
155564
- "const": "off"
155565
- },
155566
- {
155567
- "const": "quarterly"
155568
- },
155569
- {
155570
- "const": "weekly"
155571
- }
155572
- ]
155573
- },
155574
- "days": {
155575
- "type": "array",
155576
- "items": {
155577
- "type": "number"
155578
- }
155579
- },
155580
- "optedOut": {
155581
- "type": "number"
155582
- },
155583
- "options": {
155584
- "type": "array",
155585
- "items": {
155586
- "type": "string"
155587
- }
155588
- }
155589
- },
155590
- "required": [
155591
- "available",
155592
- "choice",
155593
- "days",
155594
- "optedOut",
155595
- "options"
155596
- ],
155597
- "additionalProperties": false
155598
- },
155599
156924
  "praise": {
155600
156925
  "type": "object",
155601
156926
  "properties": {
@@ -155607,18 +156932,9 @@
155607
156932
  {
155608
156933
  "const": "before_close"
155609
156934
  },
155610
- {
155611
- "const": "biweekly"
155612
- },
155613
156935
  {
155614
156936
  "const": "every_2_weeks"
155615
156937
  },
155616
- {
155617
- "const": "first_90_days"
155618
- },
155619
- {
155620
- "const": "first_year"
155621
- },
155622
156938
  {
155623
156939
  "const": "monthly"
155624
156940
  },
@@ -155630,9 +156946,6 @@
155630
156946
  },
155631
156947
  {
155632
156948
  "const": "quarterly"
155633
- },
155634
- {
155635
- "const": "weekly"
155636
156949
  }
155637
156950
  ]
155638
156951
  },
@@ -155672,18 +156985,9 @@
155672
156985
  {
155673
156986
  "const": "before_close"
155674
156987
  },
155675
- {
155676
- "const": "biweekly"
155677
- },
155678
156988
  {
155679
156989
  "const": "every_2_weeks"
155680
156990
  },
155681
- {
155682
- "const": "first_90_days"
155683
- },
155684
- {
155685
- "const": "first_year"
155686
- },
155687
156991
  {
155688
156992
  "const": "monthly"
155689
156993
  },
@@ -155695,9 +156999,6 @@
155695
156999
  },
155696
157000
  {
155697
157001
  "const": "quarterly"
155698
- },
155699
- {
155700
- "const": "weekly"
155701
157002
  }
155702
157003
  ]
155703
157004
  },
@@ -155728,8 +157029,6 @@
155728
157029
  }
155729
157030
  },
155730
157031
  "required": [
155731
- "manager_check_in",
155732
- "new_hire_check_in",
155733
157032
  "praise",
155734
157033
  "pulse"
155735
157034
  ],
@@ -163542,13 +164841,37 @@
163542
164841
  },
163543
164842
  "sent": {
163544
164843
  "type": "number"
164844
+ },
164845
+ "weekly": {
164846
+ "type": "array",
164847
+ "items": {
164848
+ "type": "object",
164849
+ "properties": {
164850
+ "onTime": {
164851
+ "type": "number"
164852
+ },
164853
+ "sent": {
164854
+ "type": "number"
164855
+ },
164856
+ "week": {
164857
+ "type": "string"
164858
+ }
164859
+ },
164860
+ "required": [
164861
+ "onTime",
164862
+ "sent",
164863
+ "week"
164864
+ ],
164865
+ "additionalProperties": false
164866
+ }
163545
164867
  }
163546
164868
  },
163547
164869
  "required": [
163548
164870
  "byKind",
163549
164871
  "failed",
163550
164872
  "onTime",
163551
- "sent"
164873
+ "sent",
164874
+ "weekly"
163552
164875
  ],
163553
164876
  "additionalProperties": false
163554
164877
  },
@@ -164397,6 +165720,191 @@
164397
165720
  "sendTime": {
164398
165721
  "type": "string"
164399
165722
  },
165723
+ "steps": {
165724
+ "type": "array",
165725
+ "items": {
165726
+ "type": "object",
165727
+ "properties": {
165728
+ "body": {
165729
+ "type": "string"
165730
+ },
165731
+ "checkpoint": {
165732
+ "anyOf": [
165733
+ {
165734
+ "const": "day_30"
165735
+ },
165736
+ {
165737
+ "const": "day_365"
165738
+ },
165739
+ {
165740
+ "const": "day_60"
165741
+ },
165742
+ {
165743
+ "const": "day_90"
165744
+ }
165745
+ ]
165746
+ },
165747
+ "id": {
165748
+ "type": "string"
165749
+ },
165750
+ "kind": {
165751
+ "anyOf": [
165752
+ {
165753
+ "const": "acknowledge"
165754
+ },
165755
+ {
165756
+ "const": "checkpoint"
165757
+ },
165758
+ {
165759
+ "const": "form"
165760
+ },
165761
+ {
165762
+ "const": "meet"
165763
+ },
165764
+ {
165765
+ "const": "message"
165766
+ },
165767
+ {
165768
+ "const": "task"
165769
+ }
165770
+ ]
165771
+ },
165772
+ "offsetDays": {
165773
+ "type": "number"
165774
+ },
165775
+ "personId": {
165776
+ "anyOf": [
165777
+ {
165778
+ "type": "null"
165779
+ },
165780
+ {
165781
+ "type": "string"
165782
+ }
165783
+ ]
165784
+ },
165785
+ "recipient": {
165786
+ "anyOf": [
165787
+ {
165788
+ "const": "buddy"
165789
+ },
165790
+ {
165791
+ "const": "hire"
165792
+ },
165793
+ {
165794
+ "const": "hr"
165795
+ },
165796
+ {
165797
+ "const": "manager"
165798
+ },
165799
+ {
165800
+ "const": "person"
165801
+ }
165802
+ ]
165803
+ },
165804
+ "resources": {
165805
+ "type": "array",
165806
+ "items": {
165807
+ "anyOf": [
165808
+ {
165809
+ "type": "object",
165810
+ "properties": {
165811
+ "sourceId": {
165812
+ "type": "string"
165813
+ },
165814
+ "title": {
165815
+ "type": "string"
165816
+ },
165817
+ "type": {
165818
+ "const": "knowledge"
165819
+ }
165820
+ },
165821
+ "required": [
165822
+ "sourceId",
165823
+ "title",
165824
+ "type"
165825
+ ],
165826
+ "additionalProperties": false
165827
+ },
165828
+ {
165829
+ "type": "object",
165830
+ "properties": {
165831
+ "label": {
165832
+ "type": "string"
165833
+ },
165834
+ "type": {
165835
+ "const": "link"
165836
+ },
165837
+ "url": {
165838
+ "type": "string"
165839
+ }
165840
+ },
165841
+ "required": [
165842
+ "label",
165843
+ "type",
165844
+ "url"
165845
+ ],
165846
+ "additionalProperties": false
165847
+ },
165848
+ {
165849
+ "type": "object",
165850
+ "properties": {
165851
+ "communityId": {
165852
+ "type": "string"
165853
+ },
165854
+ "name": {
165855
+ "type": "string"
165856
+ },
165857
+ "type": {
165858
+ "const": "community"
165859
+ }
165860
+ },
165861
+ "required": [
165862
+ "communityId",
165863
+ "name",
165864
+ "type"
165865
+ ],
165866
+ "additionalProperties": false
165867
+ }
165868
+ ]
165869
+ }
165870
+ },
165871
+ "title": {
165872
+ "type": "string"
165873
+ },
165874
+ "todos": {
165875
+ "type": "array",
165876
+ "items": {
165877
+ "type": "object",
165878
+ "properties": {
165879
+ "id": {
165880
+ "type": "string"
165881
+ },
165882
+ "label": {
165883
+ "type": "string"
165884
+ }
165885
+ },
165886
+ "required": [
165887
+ "id",
165888
+ "label"
165889
+ ],
165890
+ "additionalProperties": false
165891
+ }
165892
+ }
165893
+ },
165894
+ "required": [
165895
+ "body",
165896
+ "id",
165897
+ "kind",
165898
+ "offsetDays",
165899
+ "personId",
165900
+ "recipient",
165901
+ "resources",
165902
+ "title",
165903
+ "todos"
165904
+ ],
165905
+ "additionalProperties": false
165906
+ }
165907
+ },
164400
165908
  "timezone": {
164401
165909
  "type": "string"
164402
165910
  }
@@ -165749,6 +167257,90 @@
165749
167257
  ],
165750
167258
  "additionalProperties": false
165751
167259
  },
167260
+ "history": {
167261
+ "type": "object",
167262
+ "properties": {
167263
+ "departments": {
167264
+ "type": "array",
167265
+ "items": {
167266
+ "type": "object",
167267
+ "properties": {
167268
+ "label": {
167269
+ "type": "string"
167270
+ },
167271
+ "value": {
167272
+ "type": "number"
167273
+ }
167274
+ },
167275
+ "required": [
167276
+ "label",
167277
+ "value"
167278
+ ],
167279
+ "additionalProperties": false
167280
+ }
167281
+ },
167282
+ "monthly": {
167283
+ "type": "array",
167284
+ "items": {
167285
+ "type": "object",
167286
+ "properties": {
167287
+ "headcount": {
167288
+ "type": "number"
167289
+ },
167290
+ "joined": {
167291
+ "type": "number"
167292
+ },
167293
+ "left": {
167294
+ "type": "number"
167295
+ },
167296
+ "month": {
167297
+ "type": "string"
167298
+ }
167299
+ },
167300
+ "required": [
167301
+ "headcount",
167302
+ "joined",
167303
+ "left",
167304
+ "month"
167305
+ ],
167306
+ "additionalProperties": false
167307
+ }
167308
+ },
167309
+ "noDepartment": {
167310
+ "type": "number"
167311
+ },
167312
+ "tenure": {
167313
+ "type": "array",
167314
+ "items": {
167315
+ "type": "object",
167316
+ "properties": {
167317
+ "label": {
167318
+ "type": "string"
167319
+ },
167320
+ "value": {
167321
+ "type": "number"
167322
+ }
167323
+ },
167324
+ "required": [
167325
+ "label",
167326
+ "value"
167327
+ ],
167328
+ "additionalProperties": false
167329
+ }
167330
+ },
167331
+ "undated": {
167332
+ "type": "number"
167333
+ }
167334
+ },
167335
+ "required": [
167336
+ "departments",
167337
+ "monthly",
167338
+ "noDepartment",
167339
+ "tenure",
167340
+ "undated"
167341
+ ],
167342
+ "additionalProperties": false
167343
+ },
165752
167344
  "joins": {
165753
167345
  "type": "object",
165754
167346
  "properties": {
@@ -165860,6 +167452,7 @@
165860
167452
  "departures",
165861
167453
  "end",
165862
167454
  "headcount",
167455
+ "history",
165863
167456
  "joins",
165864
167457
  "roles",
165865
167458
  "start",
@@ -208188,6 +209781,7 @@
208188
209781
  "onboarding.approve",
208189
209782
  "onboarding.askBuddy",
208190
209783
  "onboarding.assignBuddy",
209784
+ "onboarding.completeTodo",
208191
209785
  "onboarding.enroll",
208192
209786
  "onboarding.previewEnrollment",
208193
209787
  "onboarding.remove",
@@ -208584,6 +210178,7 @@
208584
210178
  "onboarding.approve",
208585
210179
  "onboarding.askBuddy",
208586
210180
  "onboarding.assignBuddy",
210181
+ "onboarding.completeTodo",
208587
210182
  "onboarding.enroll",
208588
210183
  "onboarding.previewEnrollment",
208589
210184
  "onboarding.remove",
@@ -209170,6 +210765,739 @@
209170
210765
  "x-shuffl-access": "read",
209171
210766
  "x-shuffl-permission": "permissions.list"
209172
210767
  }
210768
+ },
210769
+ "/company": {
210770
+ "get": {
210771
+ "operationId": "company.current",
210772
+ "summary": "Read the company this key belongs to and the permissions it was granted",
210773
+ "responses": {
210774
+ "200": {
210775
+ "description": "OK",
210776
+ "content": {
210777
+ "application/json": {
210778
+ "schema": {
210779
+ "type": "object",
210780
+ "properties": {
210781
+ "catalog": {
210782
+ "type": "array",
210783
+ "items": {
210784
+ "type": "object",
210785
+ "properties": {
210786
+ "access": {
210787
+ "enum": [
210788
+ "read",
210789
+ "write"
210790
+ ],
210791
+ "type": "string"
210792
+ },
210793
+ "description": {
210794
+ "type": "string"
210795
+ },
210796
+ "granted": {
210797
+ "type": "boolean"
210798
+ },
210799
+ "id": {
210800
+ "enum": [
210801
+ "company.details",
210802
+ "company.workspaces.list",
210803
+ "company.members.list",
210804
+ "company.emailDomains.list",
210805
+ "company.slack.list",
210806
+ "company.rename",
210807
+ "company.workspaces.setDefault",
210808
+ "company.members.remove"
210809
+ ],
210810
+ "type": "string"
210811
+ }
210812
+ },
210813
+ "required": [
210814
+ "access",
210815
+ "description",
210816
+ "granted",
210817
+ "id"
210818
+ ]
210819
+ }
210820
+ },
210821
+ "organizationId": {
210822
+ "type": "string",
210823
+ "minLength": 1,
210824
+ "maxLength": 128
210825
+ },
210826
+ "permissions": {
210827
+ "type": "array",
210828
+ "items": {
210829
+ "enum": [
210830
+ "company.details",
210831
+ "company.workspaces.list",
210832
+ "company.members.list",
210833
+ "company.emailDomains.list",
210834
+ "company.slack.list",
210835
+ "company.rename",
210836
+ "company.workspaces.setDefault",
210837
+ "company.members.remove"
210838
+ ],
210839
+ "type": "string"
210840
+ }
210841
+ }
210842
+ },
210843
+ "required": [
210844
+ "catalog",
210845
+ "organizationId",
210846
+ "permissions"
210847
+ ]
210848
+ }
210849
+ }
210850
+ }
210851
+ }
210852
+ },
210853
+ "security": [
210854
+ {
210855
+ "companyKey": []
210856
+ }
210857
+ ],
210858
+ "x-shuffl-access": "read",
210859
+ "x-shuffl-credential": "company",
210860
+ "x-shuffl-permission": "company.current"
210861
+ }
210862
+ },
210863
+ "/company/details": {
210864
+ "get": {
210865
+ "operationId": "company.details",
210866
+ "summary": "Read the company name, logo and default workspace",
210867
+ "responses": {
210868
+ "200": {
210869
+ "description": "OK",
210870
+ "content": {
210871
+ "application/json": {
210872
+ "schema": {
210873
+ "type": "object",
210874
+ "properties": {
210875
+ "defaultTeamId": {
210876
+ "anyOf": [
210877
+ {
210878
+ "type": "string",
210879
+ "minLength": 1,
210880
+ "maxLength": 128
210881
+ },
210882
+ {
210883
+ "type": "null"
210884
+ }
210885
+ ],
210886
+ "description": "The workspace new email domain and single sign-on members join."
210887
+ },
210888
+ "deleteAfter": {
210889
+ "anyOf": [
210890
+ {
210891
+ "type": "string",
210892
+ "format": "date-time"
210893
+ },
210894
+ {
210895
+ "type": "null"
210896
+ }
210897
+ ],
210898
+ "description": "When a deleted company is erased, or null."
210899
+ },
210900
+ "deletionRequestedAt": {
210901
+ "anyOf": [
210902
+ {
210903
+ "type": "string",
210904
+ "format": "date-time"
210905
+ },
210906
+ {
210907
+ "type": "null"
210908
+ }
210909
+ ],
210910
+ "description": "When someone deleted the company, or null."
210911
+ },
210912
+ "id": {
210913
+ "type": "string",
210914
+ "minLength": 1,
210915
+ "maxLength": 128
210916
+ },
210917
+ "logo": {
210918
+ "anyOf": [
210919
+ {
210920
+ "type": "string"
210921
+ },
210922
+ {
210923
+ "type": "null"
210924
+ }
210925
+ ]
210926
+ },
210927
+ "name": {
210928
+ "type": "string"
210929
+ },
210930
+ "role": {
210931
+ "enum": [
210932
+ "owner",
210933
+ "admin",
210934
+ "member"
210935
+ ],
210936
+ "type": "string",
210937
+ "description": "The company role of the person who made the key."
210938
+ }
210939
+ },
210940
+ "required": [
210941
+ "defaultTeamId",
210942
+ "deleteAfter",
210943
+ "deletionRequestedAt",
210944
+ "id",
210945
+ "logo",
210946
+ "name",
210947
+ "role"
210948
+ ]
210949
+ }
210950
+ }
210951
+ }
210952
+ }
210953
+ },
210954
+ "security": [
210955
+ {
210956
+ "companyKey": []
210957
+ }
210958
+ ],
210959
+ "x-shuffl-access": "read",
210960
+ "x-shuffl-credential": "company",
210961
+ "x-shuffl-permission": "company.details"
210962
+ }
210963
+ },
210964
+ "/company/emailDomains.list": {
210965
+ "get": {
210966
+ "operationId": "company.emailDomains.list",
210967
+ "summary": "List the company's email domains and their verification",
210968
+ "responses": {
210969
+ "200": {
210970
+ "description": "OK",
210971
+ "content": {
210972
+ "application/json": {
210973
+ "schema": {
210974
+ "type": "array",
210975
+ "items": {
210976
+ "type": "object",
210977
+ "properties": {
210978
+ "dnsRecord": {
210979
+ "anyOf": [
210980
+ {
210981
+ "type": "object",
210982
+ "properties": {
210983
+ "name": {
210984
+ "type": "string"
210985
+ },
210986
+ "value": {
210987
+ "type": "string"
210988
+ }
210989
+ },
210990
+ "required": [
210991
+ "name",
210992
+ "value"
210993
+ ]
210994
+ },
210995
+ {
210996
+ "type": "null"
210997
+ }
210998
+ ],
210999
+ "description": "The TXT record that proves the domain, until it is verified."
211000
+ },
211001
+ "domain": {
211002
+ "type": "string"
211003
+ },
211004
+ "id": {
211005
+ "type": "string",
211006
+ "minLength": 1,
211007
+ "maxLength": 128
211008
+ },
211009
+ "verifiedAt": {
211010
+ "anyOf": [
211011
+ {
211012
+ "type": "string",
211013
+ "format": "date-time"
211014
+ },
211015
+ {
211016
+ "type": "null"
211017
+ }
211018
+ ]
211019
+ }
211020
+ },
211021
+ "required": [
211022
+ "dnsRecord",
211023
+ "domain",
211024
+ "id",
211025
+ "verifiedAt"
211026
+ ]
211027
+ }
211028
+ }
211029
+ }
211030
+ }
211031
+ }
211032
+ },
211033
+ "security": [
211034
+ {
211035
+ "companyKey": []
211036
+ }
211037
+ ],
211038
+ "x-shuffl-access": "read",
211039
+ "x-shuffl-credential": "company",
211040
+ "x-shuffl-permission": "company.emailDomains.list"
211041
+ }
211042
+ },
211043
+ "/company/members.list": {
211044
+ "get": {
211045
+ "operationId": "company.members.list",
211046
+ "summary": "List company members and their company roles",
211047
+ "parameters": [
211048
+ {
211049
+ "name": "cursor",
211050
+ "in": "query",
211051
+ "schema": {
211052
+ "type": "string",
211053
+ "minLength": 1,
211054
+ "maxLength": 1024,
211055
+ "description": "nextCursor from the previous page."
211056
+ },
211057
+ "allowEmptyValue": true,
211058
+ "allowReserved": true
211059
+ },
211060
+ {
211061
+ "name": "limit",
211062
+ "in": "query",
211063
+ "schema": {
211064
+ "type": "integer",
211065
+ "minimum": 1,
211066
+ "maximum": 100,
211067
+ "default": 25
211068
+ },
211069
+ "allowEmptyValue": true,
211070
+ "allowReserved": true
211071
+ }
211072
+ ],
211073
+ "responses": {
211074
+ "200": {
211075
+ "description": "OK",
211076
+ "content": {
211077
+ "application/json": {
211078
+ "schema": {
211079
+ "type": "object",
211080
+ "properties": {
211081
+ "items": {
211082
+ "type": "array",
211083
+ "items": {
211084
+ "type": "object",
211085
+ "properties": {
211086
+ "email": {
211087
+ "type": "string"
211088
+ },
211089
+ "id": {
211090
+ "type": "string",
211091
+ "minLength": 1,
211092
+ "maxLength": 128,
211093
+ "description": "The company membership id."
211094
+ },
211095
+ "name": {
211096
+ "type": "string"
211097
+ },
211098
+ "role": {
211099
+ "enum": [
211100
+ "owner",
211101
+ "admin",
211102
+ "member"
211103
+ ],
211104
+ "type": "string"
211105
+ },
211106
+ "userId": {
211107
+ "type": "string",
211108
+ "minLength": 1,
211109
+ "maxLength": 128,
211110
+ "description": "The person’s user id. members.remove takes this."
211111
+ }
211112
+ },
211113
+ "required": [
211114
+ "email",
211115
+ "id",
211116
+ "name",
211117
+ "role",
211118
+ "userId"
211119
+ ]
211120
+ }
211121
+ },
211122
+ "nextCursor": {
211123
+ "anyOf": [
211124
+ {
211125
+ "type": "string",
211126
+ "minLength": 1,
211127
+ "maxLength": 1024
211128
+ },
211129
+ {
211130
+ "type": "null"
211131
+ }
211132
+ ]
211133
+ }
211134
+ },
211135
+ "required": [
211136
+ "items",
211137
+ "nextCursor"
211138
+ ]
211139
+ }
211140
+ }
211141
+ }
211142
+ }
211143
+ },
211144
+ "security": [
211145
+ {
211146
+ "companyKey": []
211147
+ }
211148
+ ],
211149
+ "x-shuffl-access": "read",
211150
+ "x-shuffl-credential": "company",
211151
+ "x-shuffl-permission": "company.members.list"
211152
+ }
211153
+ },
211154
+ "/company/members.remove": {
211155
+ "post": {
211156
+ "operationId": "company.members.remove",
211157
+ "summary": "Remove someone from the company (administrators only with an owner’s key)",
211158
+ "requestBody": {
211159
+ "required": true,
211160
+ "content": {
211161
+ "application/json": {
211162
+ "schema": {
211163
+ "type": "object",
211164
+ "properties": {
211165
+ "userId": {
211166
+ "type": "string",
211167
+ "minLength": 1,
211168
+ "maxLength": 128
211169
+ }
211170
+ },
211171
+ "required": [
211172
+ "userId"
211173
+ ]
211174
+ }
211175
+ }
211176
+ }
211177
+ },
211178
+ "responses": {
211179
+ "200": {
211180
+ "description": "OK",
211181
+ "content": {
211182
+ "application/json": {
211183
+ "schema": {
211184
+ "type": "object",
211185
+ "properties": {
211186
+ "removed": {
211187
+ "type": "boolean"
211188
+ }
211189
+ },
211190
+ "required": [
211191
+ "removed"
211192
+ ]
211193
+ }
211194
+ }
211195
+ }
211196
+ }
211197
+ },
211198
+ "security": [
211199
+ {
211200
+ "companyKey": []
211201
+ }
211202
+ ],
211203
+ "x-shuffl-access": "write",
211204
+ "x-shuffl-credential": "company",
211205
+ "x-shuffl-permission": "company.members.remove"
211206
+ }
211207
+ },
211208
+ "/company/rename": {
211209
+ "post": {
211210
+ "operationId": "company.rename",
211211
+ "summary": "Rename the company",
211212
+ "requestBody": {
211213
+ "required": true,
211214
+ "content": {
211215
+ "application/json": {
211216
+ "schema": {
211217
+ "type": "object",
211218
+ "properties": {
211219
+ "name": {
211220
+ "type": "string",
211221
+ "minLength": 1,
211222
+ "maxLength": 100
211223
+ }
211224
+ },
211225
+ "required": [
211226
+ "name"
211227
+ ]
211228
+ }
211229
+ }
211230
+ }
211231
+ },
211232
+ "responses": {
211233
+ "200": {
211234
+ "description": "OK",
211235
+ "content": {
211236
+ "application/json": {
211237
+ "schema": {
211238
+ "type": "object",
211239
+ "properties": {
211240
+ "name": {
211241
+ "type": "string"
211242
+ }
211243
+ },
211244
+ "required": [
211245
+ "name"
211246
+ ]
211247
+ }
211248
+ }
211249
+ }
211250
+ }
211251
+ },
211252
+ "security": [
211253
+ {
211254
+ "companyKey": []
211255
+ }
211256
+ ],
211257
+ "x-shuffl-access": "write",
211258
+ "x-shuffl-credential": "company",
211259
+ "x-shuffl-permission": "company.rename"
211260
+ }
211261
+ },
211262
+ "/company/slack.list": {
211263
+ "get": {
211264
+ "operationId": "company.slack.list",
211265
+ "summary": "List the Slack workspaces connected to the company",
211266
+ "responses": {
211267
+ "200": {
211268
+ "description": "OK",
211269
+ "content": {
211270
+ "application/json": {
211271
+ "schema": {
211272
+ "type": "array",
211273
+ "items": {
211274
+ "type": "object",
211275
+ "properties": {
211276
+ "installation": {
211277
+ "anyOf": [
211278
+ {
211279
+ "type": "object",
211280
+ "properties": {
211281
+ "enterpriseId": {
211282
+ "anyOf": [
211283
+ {
211284
+ "type": "string"
211285
+ },
211286
+ {
211287
+ "type": "null"
211288
+ }
211289
+ ]
211290
+ },
211291
+ "gridOrganizationId": {
211292
+ "anyOf": [
211293
+ {
211294
+ "type": "string"
211295
+ },
211296
+ {
211297
+ "type": "null"
211298
+ }
211299
+ ]
211300
+ },
211301
+ "revokedAt": {
211302
+ "anyOf": [
211303
+ {
211304
+ "type": "string",
211305
+ "format": "date-time"
211306
+ },
211307
+ {
211308
+ "type": "null"
211309
+ }
211310
+ ],
211311
+ "description": "When the connection stopped working, or null."
211312
+ },
211313
+ "slackTeamId": {
211314
+ "type": "string"
211315
+ }
211316
+ },
211317
+ "required": [
211318
+ "enterpriseId",
211319
+ "gridOrganizationId",
211320
+ "revokedAt",
211321
+ "slackTeamId"
211322
+ ]
211323
+ },
211324
+ {
211325
+ "type": "null"
211326
+ }
211327
+ ],
211328
+ "description": "The Slack connection, or null when the workspace has none."
211329
+ },
211330
+ "teamId": {
211331
+ "type": "string",
211332
+ "minLength": 1,
211333
+ "maxLength": 128
211334
+ },
211335
+ "teamName": {
211336
+ "type": "string"
211337
+ }
211338
+ },
211339
+ "required": [
211340
+ "installation",
211341
+ "teamId",
211342
+ "teamName"
211343
+ ]
211344
+ }
211345
+ }
211346
+ }
211347
+ }
211348
+ }
211349
+ },
211350
+ "security": [
211351
+ {
211352
+ "companyKey": []
211353
+ }
211354
+ ],
211355
+ "x-shuffl-access": "read",
211356
+ "x-shuffl-credential": "company",
211357
+ "x-shuffl-permission": "company.slack.list"
211358
+ }
211359
+ },
211360
+ "/company/workspaces.list": {
211361
+ "get": {
211362
+ "operationId": "company.workspaces.list",
211363
+ "summary": "List the company's workspaces",
211364
+ "responses": {
211365
+ "200": {
211366
+ "description": "OK",
211367
+ "content": {
211368
+ "application/json": {
211369
+ "schema": {
211370
+ "type": "array",
211371
+ "items": {
211372
+ "type": "object",
211373
+ "properties": {
211374
+ "accessible": {
211375
+ "type": "boolean",
211376
+ "description": "Whether the person who made the key can open the workspace."
211377
+ },
211378
+ "default": {
211379
+ "type": "boolean",
211380
+ "description": "Whether this is the default workspace."
211381
+ },
211382
+ "id": {
211383
+ "type": "string",
211384
+ "minLength": 1,
211385
+ "maxLength": 128
211386
+ },
211387
+ "logo": {
211388
+ "anyOf": [
211389
+ {
211390
+ "type": "string"
211391
+ },
211392
+ {
211393
+ "type": "null"
211394
+ }
211395
+ ]
211396
+ },
211397
+ "member": {
211398
+ "type": "boolean",
211399
+ "description": "Whether the person who made the key is a member of it."
211400
+ },
211401
+ "name": {
211402
+ "type": "string"
211403
+ },
211404
+ "status": {
211405
+ "anyOf": [
211406
+ {
211407
+ "enum": [
211408
+ "active",
211409
+ "paused",
211410
+ "uninstalled",
211411
+ "archived"
211412
+ ],
211413
+ "type": "string"
211414
+ },
211415
+ {
211416
+ "type": "null"
211417
+ }
211418
+ ]
211419
+ }
211420
+ },
211421
+ "required": [
211422
+ "accessible",
211423
+ "default",
211424
+ "id",
211425
+ "logo",
211426
+ "member",
211427
+ "name",
211428
+ "status"
211429
+ ]
211430
+ }
211431
+ }
211432
+ }
211433
+ }
211434
+ }
211435
+ },
211436
+ "security": [
211437
+ {
211438
+ "companyKey": []
211439
+ }
211440
+ ],
211441
+ "x-shuffl-access": "read",
211442
+ "x-shuffl-credential": "company",
211443
+ "x-shuffl-permission": "company.workspaces.list"
211444
+ }
211445
+ },
211446
+ "/company/workspaces.setDefault": {
211447
+ "post": {
211448
+ "operationId": "company.workspaces.setDefault",
211449
+ "summary": "Choose the workspace new email domain and single sign-on members join",
211450
+ "requestBody": {
211451
+ "required": true,
211452
+ "content": {
211453
+ "application/json": {
211454
+ "schema": {
211455
+ "type": "object",
211456
+ "properties": {
211457
+ "teamId": {
211458
+ "type": "string",
211459
+ "minLength": 1,
211460
+ "maxLength": 128
211461
+ }
211462
+ },
211463
+ "required": [
211464
+ "teamId"
211465
+ ]
211466
+ }
211467
+ }
211468
+ }
211469
+ },
211470
+ "responses": {
211471
+ "200": {
211472
+ "description": "OK",
211473
+ "content": {
211474
+ "application/json": {
211475
+ "schema": {
211476
+ "type": "object",
211477
+ "properties": {
211478
+ "teamId": {
211479
+ "type": "string",
211480
+ "minLength": 1,
211481
+ "maxLength": 128
211482
+ }
211483
+ },
211484
+ "required": [
211485
+ "teamId"
211486
+ ]
211487
+ }
211488
+ }
211489
+ }
211490
+ }
211491
+ },
211492
+ "security": [
211493
+ {
211494
+ "companyKey": []
211495
+ }
211496
+ ],
211497
+ "x-shuffl-access": "write",
211498
+ "x-shuffl-credential": "company",
211499
+ "x-shuffl-permission": "company.workspaces.setDefault"
211500
+ }
209173
211501
  }
209174
211502
  }
209175
211503
  }