@shuffl/api-contracts 0.5.1 → 0.5.3

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
@@ -35413,6 +35413,9 @@
35413
35413
  {
35414
35414
  "const": "groups.setAutomationState"
35415
35415
  },
35416
+ {
35417
+ "const": "groups.setPlaybookAutoStart"
35418
+ },
35416
35419
  {
35417
35420
  "const": "groups.suggestions"
35418
35421
  },
@@ -35632,6 +35635,9 @@
35632
35635
  {
35633
35636
  "const": "network.claim"
35634
35637
  },
35638
+ {
35639
+ "const": "network.introductions"
35640
+ },
35635
35641
  {
35636
35642
  "const": "network.mine"
35637
35643
  },
@@ -37144,6 +37150,9 @@
37144
37150
  {
37145
37151
  "const": "groups.setAutomationState"
37146
37152
  },
37153
+ {
37154
+ "const": "groups.setPlaybookAutoStart"
37155
+ },
37147
37156
  {
37148
37157
  "const": "groups.suggestions"
37149
37158
  },
@@ -37363,6 +37372,9 @@
37363
37372
  {
37364
37373
  "const": "network.claim"
37365
37374
  },
37375
+ {
37376
+ "const": "network.introductions"
37377
+ },
37366
37378
  {
37367
37379
  "const": "network.mine"
37368
37380
  },
@@ -38450,6 +38462,9 @@
38450
38462
  {
38451
38463
  "const": "groups.setAutomationState"
38452
38464
  },
38465
+ {
38466
+ "const": "groups.setPlaybookAutoStart"
38467
+ },
38453
38468
  {
38454
38469
  "const": "groups.suggestions"
38455
38470
  },
@@ -38669,6 +38684,9 @@
38669
38684
  {
38670
38685
  "const": "network.claim"
38671
38686
  },
38687
+ {
38688
+ "const": "network.introductions"
38689
+ },
38672
38690
  {
38673
38691
  "const": "network.mine"
38674
38692
  },
@@ -48774,6 +48792,16 @@
48774
48792
  }
48775
48793
  ]
48776
48794
  },
48795
+ "autoStartPaused": {
48796
+ "anyOf": [
48797
+ {
48798
+ "const": false
48799
+ },
48800
+ {
48801
+ "const": true
48802
+ }
48803
+ ]
48804
+ },
48777
48805
  "buddy": {
48778
48806
  "anyOf": [
48779
48807
  {
@@ -54202,7 +54230,7 @@
54202
54230
  "/manage/groups/allAutomations": {
54203
54231
  "post": {
54204
54232
  "operationId": "groups.allAutomations",
54205
- "summary": "Every group automation in the workspace with its group and last runs, or only those that start one playbook, program or community",
54233
+ "summary": "Every join and leave rule in the workspace: group automations with their group and last runs, playbooks that start on each start date and Connections programs whose people are a group; or only those that start one playbook, program or community",
54206
54234
  "requestBody": {
54207
54235
  "required": true,
54208
54236
  "content": {
@@ -54456,6 +54484,189 @@
54456
54484
  "additionalProperties": false
54457
54485
  }
54458
54486
  },
54487
+ "playbookStarts": {
54488
+ "type": "array",
54489
+ "items": {
54490
+ "type": "object",
54491
+ "properties": {
54492
+ "group": {
54493
+ "anyOf": [
54494
+ {
54495
+ "type": "null"
54496
+ },
54497
+ {
54498
+ "type": "object",
54499
+ "properties": {
54500
+ "id": {
54501
+ "type": "string"
54502
+ },
54503
+ "kind": {
54504
+ "anyOf": [
54505
+ {
54506
+ "const": "dynamic"
54507
+ },
54508
+ {
54509
+ "const": "list"
54510
+ }
54511
+ ]
54512
+ },
54513
+ "members": {
54514
+ "type": "number"
54515
+ },
54516
+ "name": {
54517
+ "type": "string"
54518
+ }
54519
+ },
54520
+ "required": [
54521
+ "id",
54522
+ "kind",
54523
+ "members",
54524
+ "name"
54525
+ ],
54526
+ "additionalProperties": false
54527
+ }
54528
+ ]
54529
+ },
54530
+ "lastRunAt": {
54531
+ "anyOf": [
54532
+ {
54533
+ "type": "null"
54534
+ },
54535
+ {
54536
+ "type": "string",
54537
+ "format": "date-time"
54538
+ }
54539
+ ]
54540
+ },
54541
+ "playbook": {
54542
+ "type": "object",
54543
+ "properties": {
54544
+ "id": {
54545
+ "type": "string"
54546
+ },
54547
+ "name": {
54548
+ "type": "string"
54549
+ },
54550
+ "status": {
54551
+ "anyOf": [
54552
+ {
54553
+ "const": "active"
54554
+ },
54555
+ {
54556
+ "const": "archived"
54557
+ },
54558
+ {
54559
+ "const": "paused"
54560
+ }
54561
+ ]
54562
+ }
54563
+ },
54564
+ "required": [
54565
+ "id",
54566
+ "name",
54567
+ "status"
54568
+ ],
54569
+ "additionalProperties": false
54570
+ },
54571
+ "runs": {
54572
+ "type": "number"
54573
+ },
54574
+ "runs30": {
54575
+ "type": "number"
54576
+ },
54577
+ "state": {
54578
+ "anyOf": [
54579
+ {
54580
+ "const": "active"
54581
+ },
54582
+ {
54583
+ "const": "paused"
54584
+ }
54585
+ ]
54586
+ }
54587
+ },
54588
+ "required": [
54589
+ "group",
54590
+ "lastRunAt",
54591
+ "playbook",
54592
+ "runs",
54593
+ "runs30",
54594
+ "state"
54595
+ ],
54596
+ "additionalProperties": false
54597
+ }
54598
+ },
54599
+ "programRosters": {
54600
+ "type": "array",
54601
+ "items": {
54602
+ "type": "object",
54603
+ "properties": {
54604
+ "group": {
54605
+ "type": "object",
54606
+ "properties": {
54607
+ "id": {
54608
+ "type": "string"
54609
+ },
54610
+ "kind": {
54611
+ "anyOf": [
54612
+ {
54613
+ "const": "dynamic"
54614
+ },
54615
+ {
54616
+ "const": "list"
54617
+ }
54618
+ ]
54619
+ },
54620
+ "members": {
54621
+ "type": "number"
54622
+ },
54623
+ "name": {
54624
+ "type": "string"
54625
+ }
54626
+ },
54627
+ "required": [
54628
+ "id",
54629
+ "kind",
54630
+ "members",
54631
+ "name"
54632
+ ],
54633
+ "additionalProperties": false
54634
+ },
54635
+ "program": {
54636
+ "type": "object",
54637
+ "properties": {
54638
+ "id": {
54639
+ "type": "string"
54640
+ },
54641
+ "name": {
54642
+ "type": "string"
54643
+ }
54644
+ },
54645
+ "required": [
54646
+ "id",
54647
+ "name"
54648
+ ],
54649
+ "additionalProperties": false
54650
+ },
54651
+ "state": {
54652
+ "anyOf": [
54653
+ {
54654
+ "const": "active"
54655
+ },
54656
+ {
54657
+ "const": "paused"
54658
+ }
54659
+ ]
54660
+ }
54661
+ },
54662
+ "required": [
54663
+ "group",
54664
+ "program",
54665
+ "state"
54666
+ ],
54667
+ "additionalProperties": false
54668
+ }
54669
+ },
54459
54670
  "runs": {
54460
54671
  "type": "array",
54461
54672
  "items": {
@@ -54618,6 +54829,8 @@
54618
54829
  },
54619
54830
  "required": [
54620
54831
  "automations",
54832
+ "playbookStarts",
54833
+ "programRosters",
54621
54834
  "runs",
54622
54835
  "totals"
54623
54836
  ],
@@ -69143,16 +69356,58 @@
69143
69356
  "x-shuffl-permission": "groups.setAutomationState"
69144
69357
  }
69145
69358
  },
69146
- "/manage/groups/suggestions": {
69359
+ "/manage/groups/setPlaybookAutoStart": {
69147
69360
  "post": {
69148
- "operationId": "groups.suggestions",
69149
- "summary": "Starter groups not made yet, with how many people each would hold",
69361
+ "operationId": "groups.setPlaybookAutoStart",
69362
+ "summary": "Turn on, pause or remove a playbook’s rule that starts it on each new hire’s start date, for everyone or one group",
69150
69363
  "requestBody": {
69151
69364
  "required": true,
69152
69365
  "content": {
69153
69366
  "application/json": {
69154
69367
  "schema": {
69155
69368
  "type": "object",
69369
+ "properties": {
69370
+ "groupId": {
69371
+ "anyOf": [
69372
+ {
69373
+ "type": "null"
69374
+ },
69375
+ {
69376
+ "type": "string"
69377
+ }
69378
+ ]
69379
+ },
69380
+ "programId": {
69381
+ "type": "string"
69382
+ },
69383
+ "state": {
69384
+ "anyOf": [
69385
+ {
69386
+ "const": "active"
69387
+ },
69388
+ {
69389
+ "const": "off"
69390
+ },
69391
+ {
69392
+ "const": "paused"
69393
+ }
69394
+ ]
69395
+ },
69396
+ "confirm": {
69397
+ "const": "groups.setPlaybookAutoStart"
69398
+ },
69399
+ "requestKey": {
69400
+ "type": "string",
69401
+ "minLength": 1,
69402
+ "maxLength": 128
69403
+ }
69404
+ },
69405
+ "required": [
69406
+ "programId",
69407
+ "state",
69408
+ "confirm",
69409
+ "requestKey"
69410
+ ],
69156
69411
  "additionalProperties": false
69157
69412
  }
69158
69413
  }
@@ -69164,136 +69419,677 @@
69164
69419
  "content": {
69165
69420
  "application/json": {
69166
69421
  "schema": {
69167
- "type": "array",
69168
- "items": {
69169
- "type": "object",
69170
- "properties": {
69171
- "count": {
69172
- "type": "number"
69422
+ "type": "object",
69423
+ "properties": {
69424
+ "receipt": {
69425
+ "type": "object",
69426
+ "properties": {
69427
+ "completedAt": {
69428
+ "anyOf": [
69429
+ {
69430
+ "type": "string",
69431
+ "format": "date-time"
69432
+ },
69433
+ {
69434
+ "type": "null"
69435
+ }
69436
+ ]
69437
+ },
69438
+ "createdAt": {
69439
+ "type": "string",
69440
+ "format": "date-time"
69441
+ },
69442
+ "id": {
69443
+ "type": "string",
69444
+ "format": "uuid"
69445
+ },
69446
+ "operation": {
69447
+ "type": "string"
69448
+ },
69449
+ "requestKey": {
69450
+ "type": "string"
69451
+ },
69452
+ "status": {
69453
+ "enum": [
69454
+ "running",
69455
+ "succeeded",
69456
+ "failed",
69457
+ "unknown"
69458
+ ],
69459
+ "type": "string"
69460
+ }
69173
69461
  },
69174
- "criteria": {
69175
- "type": "object",
69176
- "properties": {
69177
- "all": {
69178
- "type": "array",
69179
- "items": {
69462
+ "required": [
69463
+ "completedAt",
69464
+ "createdAt",
69465
+ "id",
69466
+ "operation",
69467
+ "requestKey",
69468
+ "status"
69469
+ ]
69470
+ },
69471
+ "result": {
69472
+ "anyOf": [
69473
+ {
69474
+ "type": "object",
69475
+ "properties": {
69476
+ "changed": {
69477
+ "type": "boolean"
69478
+ },
69479
+ "id": {
69480
+ "type": "string"
69481
+ },
69482
+ "state": {
69180
69483
  "anyOf": [
69181
69484
  {
69182
- "type": "object",
69183
- "properties": {
69184
- "attribute": {
69185
- "type": "string"
69186
- },
69187
- "operator": {
69188
- "type": "string"
69189
- },
69190
- "value": {
69191
- "anyOf": [
69192
- {
69193
- "type": "string"
69194
- },
69195
- {
69196
- "type": "number"
69197
- },
69198
- {
69199
- "const": false
69200
- },
69201
- {
69202
- "const": true
69203
- },
69204
- {
69205
- "type": "array",
69206
- "items": {
69207
- "type": "string"
69208
- }
69209
- }
69210
- ]
69211
- }
69212
- },
69213
- "required": [
69214
- "attribute",
69215
- "operator"
69216
- ],
69217
- "additionalProperties": false
69485
+ "const": "active"
69218
69486
  },
69219
69487
  {
69220
- "type": "object",
69221
- "properties": {
69222
- "any": {
69223
- "type": "array",
69224
- "items": {
69225
- "type": "object",
69226
- "properties": {
69227
- "attribute": {
69228
- "type": "string"
69229
- },
69230
- "operator": {
69231
- "type": "string"
69232
- },
69233
- "value": {
69234
- "anyOf": [
69235
- {
69236
- "type": "string"
69237
- },
69238
- {
69239
- "type": "number"
69240
- },
69241
- {
69242
- "const": false
69243
- },
69244
- {
69245
- "const": true
69246
- },
69247
- {
69248
- "type": "array",
69249
- "items": {
69250
- "type": "string"
69251
- }
69252
- }
69253
- ]
69254
- }
69255
- },
69256
- "required": [
69257
- "attribute",
69258
- "operator"
69259
- ],
69260
- "additionalProperties": false
69261
- }
69262
- }
69263
- },
69264
- "required": [
69265
- "any"
69266
- ],
69267
- "additionalProperties": false
69488
+ "const": "off"
69489
+ },
69490
+ {
69491
+ "const": "paused"
69268
69492
  }
69269
69493
  ]
69270
69494
  }
69271
- }
69495
+ },
69496
+ "required": [
69497
+ "changed",
69498
+ "id",
69499
+ "state"
69500
+ ],
69501
+ "additionalProperties": false
69272
69502
  },
69273
- "required": [
69274
- "all"
69275
- ],
69276
- "additionalProperties": false
69277
- },
69278
- "description": {
69279
- "type": "string"
69280
- },
69281
- "name": {
69282
- "type": "string"
69283
- },
69284
- "suggestion": {
69285
- "type": "string"
69286
- }
69287
- },
69288
- "required": [
69289
- "count",
69290
- "criteria",
69291
- "description",
69292
- "name",
69293
- "suggestion"
69294
- ],
69295
- "additionalProperties": false
69296
- }
69503
+ {
69504
+ "type": "null"
69505
+ }
69506
+ ]
69507
+ }
69508
+ },
69509
+ "required": [
69510
+ "receipt",
69511
+ "result"
69512
+ ]
69513
+ }
69514
+ }
69515
+ }
69516
+ },
69517
+ "400": {
69518
+ "description": "400",
69519
+ "content": {
69520
+ "application/json": {
69521
+ "schema": {
69522
+ "oneOf": [
69523
+ {
69524
+ "type": "object",
69525
+ "properties": {
69526
+ "defined": {
69527
+ "const": true
69528
+ },
69529
+ "code": {
69530
+ "const": "BAD_REQUEST"
69531
+ },
69532
+ "status": {
69533
+ "const": 400
69534
+ },
69535
+ "message": {
69536
+ "type": "string",
69537
+ "default": "Check the request input."
69538
+ },
69539
+ "data": {}
69540
+ },
69541
+ "required": [
69542
+ "defined",
69543
+ "code",
69544
+ "status",
69545
+ "message"
69546
+ ]
69547
+ },
69548
+ {
69549
+ "type": "object",
69550
+ "properties": {
69551
+ "defined": {
69552
+ "const": false
69553
+ },
69554
+ "code": {
69555
+ "type": "string"
69556
+ },
69557
+ "status": {
69558
+ "type": "number"
69559
+ },
69560
+ "message": {
69561
+ "type": "string"
69562
+ },
69563
+ "data": {}
69564
+ },
69565
+ "required": [
69566
+ "defined",
69567
+ "code",
69568
+ "status",
69569
+ "message"
69570
+ ]
69571
+ }
69572
+ ]
69573
+ }
69574
+ }
69575
+ }
69576
+ },
69577
+ "401": {
69578
+ "description": "401",
69579
+ "content": {
69580
+ "application/json": {
69581
+ "schema": {
69582
+ "oneOf": [
69583
+ {
69584
+ "type": "object",
69585
+ "properties": {
69586
+ "defined": {
69587
+ "const": true
69588
+ },
69589
+ "code": {
69590
+ "const": "UNAUTHORIZED"
69591
+ },
69592
+ "status": {
69593
+ "const": 401
69594
+ },
69595
+ "message": {
69596
+ "type": "string",
69597
+ "default": "A valid Shuffl API token is required."
69598
+ },
69599
+ "data": {}
69600
+ },
69601
+ "required": [
69602
+ "defined",
69603
+ "code",
69604
+ "status",
69605
+ "message"
69606
+ ]
69607
+ },
69608
+ {
69609
+ "type": "object",
69610
+ "properties": {
69611
+ "defined": {
69612
+ "const": false
69613
+ },
69614
+ "code": {
69615
+ "type": "string"
69616
+ },
69617
+ "status": {
69618
+ "type": "number"
69619
+ },
69620
+ "message": {
69621
+ "type": "string"
69622
+ },
69623
+ "data": {}
69624
+ },
69625
+ "required": [
69626
+ "defined",
69627
+ "code",
69628
+ "status",
69629
+ "message"
69630
+ ]
69631
+ }
69632
+ ]
69633
+ }
69634
+ }
69635
+ }
69636
+ },
69637
+ "403": {
69638
+ "description": "403",
69639
+ "content": {
69640
+ "application/json": {
69641
+ "schema": {
69642
+ "oneOf": [
69643
+ {
69644
+ "type": "object",
69645
+ "properties": {
69646
+ "defined": {
69647
+ "const": true
69648
+ },
69649
+ "code": {
69650
+ "const": "FORBIDDEN"
69651
+ },
69652
+ "status": {
69653
+ "const": 403
69654
+ },
69655
+ "message": {
69656
+ "type": "string",
69657
+ "default": "This token or team role does not permit the operation."
69658
+ },
69659
+ "data": {}
69660
+ },
69661
+ "required": [
69662
+ "defined",
69663
+ "code",
69664
+ "status",
69665
+ "message"
69666
+ ]
69667
+ },
69668
+ {
69669
+ "type": "object",
69670
+ "properties": {
69671
+ "defined": {
69672
+ "const": false
69673
+ },
69674
+ "code": {
69675
+ "type": "string"
69676
+ },
69677
+ "status": {
69678
+ "type": "number"
69679
+ },
69680
+ "message": {
69681
+ "type": "string"
69682
+ },
69683
+ "data": {}
69684
+ },
69685
+ "required": [
69686
+ "defined",
69687
+ "code",
69688
+ "status",
69689
+ "message"
69690
+ ]
69691
+ }
69692
+ ]
69693
+ }
69694
+ }
69695
+ }
69696
+ },
69697
+ "404": {
69698
+ "description": "404",
69699
+ "content": {
69700
+ "application/json": {
69701
+ "schema": {
69702
+ "oneOf": [
69703
+ {
69704
+ "type": "object",
69705
+ "properties": {
69706
+ "defined": {
69707
+ "const": true
69708
+ },
69709
+ "code": {
69710
+ "const": "NOT_FOUND"
69711
+ },
69712
+ "status": {
69713
+ "const": 404
69714
+ },
69715
+ "message": {
69716
+ "type": "string",
69717
+ "default": "The requested resource was not found."
69718
+ },
69719
+ "data": {}
69720
+ },
69721
+ "required": [
69722
+ "defined",
69723
+ "code",
69724
+ "status",
69725
+ "message"
69726
+ ]
69727
+ },
69728
+ {
69729
+ "type": "object",
69730
+ "properties": {
69731
+ "defined": {
69732
+ "const": false
69733
+ },
69734
+ "code": {
69735
+ "type": "string"
69736
+ },
69737
+ "status": {
69738
+ "type": "number"
69739
+ },
69740
+ "message": {
69741
+ "type": "string"
69742
+ },
69743
+ "data": {}
69744
+ },
69745
+ "required": [
69746
+ "defined",
69747
+ "code",
69748
+ "status",
69749
+ "message"
69750
+ ]
69751
+ }
69752
+ ]
69753
+ }
69754
+ }
69755
+ }
69756
+ },
69757
+ "409": {
69758
+ "description": "409",
69759
+ "content": {
69760
+ "application/json": {
69761
+ "schema": {
69762
+ "oneOf": [
69763
+ {
69764
+ "type": "object",
69765
+ "properties": {
69766
+ "defined": {
69767
+ "const": true
69768
+ },
69769
+ "code": {
69770
+ "const": "CONFLICT"
69771
+ },
69772
+ "status": {
69773
+ "const": 409
69774
+ },
69775
+ "message": {
69776
+ "type": "string",
69777
+ "default": "The resource changed or the request key was reused."
69778
+ },
69779
+ "data": {}
69780
+ },
69781
+ "required": [
69782
+ "defined",
69783
+ "code",
69784
+ "status",
69785
+ "message"
69786
+ ]
69787
+ },
69788
+ {
69789
+ "type": "object",
69790
+ "properties": {
69791
+ "defined": {
69792
+ "const": false
69793
+ },
69794
+ "code": {
69795
+ "type": "string"
69796
+ },
69797
+ "status": {
69798
+ "type": "number"
69799
+ },
69800
+ "message": {
69801
+ "type": "string"
69802
+ },
69803
+ "data": {}
69804
+ },
69805
+ "required": [
69806
+ "defined",
69807
+ "code",
69808
+ "status",
69809
+ "message"
69810
+ ]
69811
+ }
69812
+ ]
69813
+ }
69814
+ }
69815
+ }
69816
+ },
69817
+ "412": {
69818
+ "description": "412",
69819
+ "content": {
69820
+ "application/json": {
69821
+ "schema": {
69822
+ "oneOf": [
69823
+ {
69824
+ "type": "object",
69825
+ "properties": {
69826
+ "defined": {
69827
+ "const": true
69828
+ },
69829
+ "code": {
69830
+ "const": "PRECONDITION_FAILED"
69831
+ },
69832
+ "status": {
69833
+ "const": 412
69834
+ },
69835
+ "message": {
69836
+ "type": "string",
69837
+ "default": "The team is not ready for this operation."
69838
+ },
69839
+ "data": {}
69840
+ },
69841
+ "required": [
69842
+ "defined",
69843
+ "code",
69844
+ "status",
69845
+ "message"
69846
+ ]
69847
+ },
69848
+ {
69849
+ "type": "object",
69850
+ "properties": {
69851
+ "defined": {
69852
+ "const": false
69853
+ },
69854
+ "code": {
69855
+ "type": "string"
69856
+ },
69857
+ "status": {
69858
+ "type": "number"
69859
+ },
69860
+ "message": {
69861
+ "type": "string"
69862
+ },
69863
+ "data": {}
69864
+ },
69865
+ "required": [
69866
+ "defined",
69867
+ "code",
69868
+ "status",
69869
+ "message"
69870
+ ]
69871
+ }
69872
+ ]
69873
+ }
69874
+ }
69875
+ }
69876
+ },
69877
+ "429": {
69878
+ "description": "429",
69879
+ "content": {
69880
+ "application/json": {
69881
+ "schema": {
69882
+ "oneOf": [
69883
+ {
69884
+ "type": "object",
69885
+ "properties": {
69886
+ "defined": {
69887
+ "const": true
69888
+ },
69889
+ "code": {
69890
+ "const": "TOO_MANY_REQUESTS"
69891
+ },
69892
+ "status": {
69893
+ "const": 429
69894
+ },
69895
+ "message": {
69896
+ "type": "string",
69897
+ "default": "Too many requests. Try again shortly."
69898
+ },
69899
+ "data": {}
69900
+ },
69901
+ "required": [
69902
+ "defined",
69903
+ "code",
69904
+ "status",
69905
+ "message"
69906
+ ]
69907
+ },
69908
+ {
69909
+ "type": "object",
69910
+ "properties": {
69911
+ "defined": {
69912
+ "const": false
69913
+ },
69914
+ "code": {
69915
+ "type": "string"
69916
+ },
69917
+ "status": {
69918
+ "type": "number"
69919
+ },
69920
+ "message": {
69921
+ "type": "string"
69922
+ },
69923
+ "data": {}
69924
+ },
69925
+ "required": [
69926
+ "defined",
69927
+ "code",
69928
+ "status",
69929
+ "message"
69930
+ ]
69931
+ }
69932
+ ]
69933
+ }
69934
+ }
69935
+ }
69936
+ }
69937
+ },
69938
+ "x-shuffl-access": "write",
69939
+ "x-shuffl-permission": "groups.setPlaybookAutoStart"
69940
+ }
69941
+ },
69942
+ "/manage/groups/suggestions": {
69943
+ "post": {
69944
+ "operationId": "groups.suggestions",
69945
+ "summary": "Starter groups not made yet, with how many people each would hold",
69946
+ "requestBody": {
69947
+ "required": true,
69948
+ "content": {
69949
+ "application/json": {
69950
+ "schema": {
69951
+ "type": "object",
69952
+ "additionalProperties": false
69953
+ }
69954
+ }
69955
+ }
69956
+ },
69957
+ "responses": {
69958
+ "200": {
69959
+ "description": "OK",
69960
+ "content": {
69961
+ "application/json": {
69962
+ "schema": {
69963
+ "type": "array",
69964
+ "items": {
69965
+ "type": "object",
69966
+ "properties": {
69967
+ "count": {
69968
+ "type": "number"
69969
+ },
69970
+ "criteria": {
69971
+ "type": "object",
69972
+ "properties": {
69973
+ "all": {
69974
+ "type": "array",
69975
+ "items": {
69976
+ "anyOf": [
69977
+ {
69978
+ "type": "object",
69979
+ "properties": {
69980
+ "attribute": {
69981
+ "type": "string"
69982
+ },
69983
+ "operator": {
69984
+ "type": "string"
69985
+ },
69986
+ "value": {
69987
+ "anyOf": [
69988
+ {
69989
+ "type": "string"
69990
+ },
69991
+ {
69992
+ "type": "number"
69993
+ },
69994
+ {
69995
+ "const": false
69996
+ },
69997
+ {
69998
+ "const": true
69999
+ },
70000
+ {
70001
+ "type": "array",
70002
+ "items": {
70003
+ "type": "string"
70004
+ }
70005
+ }
70006
+ ]
70007
+ }
70008
+ },
70009
+ "required": [
70010
+ "attribute",
70011
+ "operator"
70012
+ ],
70013
+ "additionalProperties": false
70014
+ },
70015
+ {
70016
+ "type": "object",
70017
+ "properties": {
70018
+ "any": {
70019
+ "type": "array",
70020
+ "items": {
70021
+ "type": "object",
70022
+ "properties": {
70023
+ "attribute": {
70024
+ "type": "string"
70025
+ },
70026
+ "operator": {
70027
+ "type": "string"
70028
+ },
70029
+ "value": {
70030
+ "anyOf": [
70031
+ {
70032
+ "type": "string"
70033
+ },
70034
+ {
70035
+ "type": "number"
70036
+ },
70037
+ {
70038
+ "const": false
70039
+ },
70040
+ {
70041
+ "const": true
70042
+ },
70043
+ {
70044
+ "type": "array",
70045
+ "items": {
70046
+ "type": "string"
70047
+ }
70048
+ }
70049
+ ]
70050
+ }
70051
+ },
70052
+ "required": [
70053
+ "attribute",
70054
+ "operator"
70055
+ ],
70056
+ "additionalProperties": false
70057
+ }
70058
+ }
70059
+ },
70060
+ "required": [
70061
+ "any"
70062
+ ],
70063
+ "additionalProperties": false
70064
+ }
70065
+ ]
70066
+ }
70067
+ }
70068
+ },
70069
+ "required": [
70070
+ "all"
70071
+ ],
70072
+ "additionalProperties": false
70073
+ },
70074
+ "description": {
70075
+ "type": "string"
70076
+ },
70077
+ "name": {
70078
+ "type": "string"
70079
+ },
70080
+ "suggestion": {
70081
+ "type": "string"
70082
+ }
70083
+ },
70084
+ "required": [
70085
+ "count",
70086
+ "criteria",
70087
+ "description",
70088
+ "name",
70089
+ "suggestion"
70090
+ ],
70091
+ "additionalProperties": false
70092
+ }
69297
70093
  }
69298
70094
  }
69299
70095
  }
@@ -71443,6 +72239,9 @@
71443
72239
  {
71444
72240
  "const": "communities"
71445
72241
  },
72242
+ {
72243
+ "const": "connections"
72244
+ },
71446
72245
  {
71447
72246
  "const": "knowledge"
71448
72247
  },
@@ -111246,14 +112045,714 @@
111246
112045
  }
111247
112046
  }
111248
112047
  },
111249
- "x-shuffl-access": "read",
111250
- "x-shuffl-permission": "knowledge.uploads.get"
112048
+ "x-shuffl-access": "read",
112049
+ "x-shuffl-permission": "knowledge.uploads.get"
112050
+ }
112051
+ },
112052
+ "/manage/knowledge/uploads/retry": {
112053
+ "post": {
112054
+ "operationId": "knowledge.uploads.retry",
112055
+ "summary": "Retry reading a Knowledge file that failed",
112056
+ "requestBody": {
112057
+ "required": true,
112058
+ "content": {
112059
+ "application/json": {
112060
+ "schema": {
112061
+ "type": "object",
112062
+ "properties": {
112063
+ "uploadId": {
112064
+ "type": "string"
112065
+ },
112066
+ "requestKey": {
112067
+ "type": "string",
112068
+ "minLength": 1,
112069
+ "maxLength": 128
112070
+ }
112071
+ },
112072
+ "required": [
112073
+ "uploadId",
112074
+ "requestKey"
112075
+ ],
112076
+ "additionalProperties": false
112077
+ }
112078
+ }
112079
+ }
112080
+ },
112081
+ "responses": {
112082
+ "200": {
112083
+ "description": "OK",
112084
+ "content": {
112085
+ "application/json": {
112086
+ "schema": {
112087
+ "type": "object",
112088
+ "properties": {
112089
+ "receipt": {
112090
+ "type": "object",
112091
+ "properties": {
112092
+ "completedAt": {
112093
+ "anyOf": [
112094
+ {
112095
+ "type": "string",
112096
+ "format": "date-time"
112097
+ },
112098
+ {
112099
+ "type": "null"
112100
+ }
112101
+ ]
112102
+ },
112103
+ "createdAt": {
112104
+ "type": "string",
112105
+ "format": "date-time"
112106
+ },
112107
+ "id": {
112108
+ "type": "string",
112109
+ "format": "uuid"
112110
+ },
112111
+ "operation": {
112112
+ "type": "string"
112113
+ },
112114
+ "requestKey": {
112115
+ "type": "string"
112116
+ },
112117
+ "status": {
112118
+ "enum": [
112119
+ "running",
112120
+ "succeeded",
112121
+ "failed",
112122
+ "unknown"
112123
+ ],
112124
+ "type": "string"
112125
+ }
112126
+ },
112127
+ "required": [
112128
+ "completedAt",
112129
+ "createdAt",
112130
+ "id",
112131
+ "operation",
112132
+ "requestKey",
112133
+ "status"
112134
+ ]
112135
+ },
112136
+ "result": {
112137
+ "anyOf": [
112138
+ {
112139
+ "type": "object",
112140
+ "properties": {
112141
+ "byteSize": {
112142
+ "type": "number"
112143
+ },
112144
+ "canRetry": {
112145
+ "type": "boolean"
112146
+ },
112147
+ "chunkBytes": {
112148
+ "type": "number"
112149
+ },
112150
+ "chunkCount": {
112151
+ "type": "number"
112152
+ },
112153
+ "documentId": {
112154
+ "type": "string"
112155
+ },
112156
+ "error": {
112157
+ "anyOf": [
112158
+ {
112159
+ "type": "null"
112160
+ },
112161
+ {
112162
+ "type": "string"
112163
+ }
112164
+ ]
112165
+ },
112166
+ "errorCode": {
112167
+ "anyOf": [
112168
+ {
112169
+ "type": "null"
112170
+ },
112171
+ {
112172
+ "const": "access"
112173
+ },
112174
+ {
112175
+ "const": "encrypted"
112176
+ },
112177
+ {
112178
+ "const": "interrupted"
112179
+ },
112180
+ {
112181
+ "const": "no_text"
112182
+ },
112183
+ {
112184
+ "const": "ocr_failed"
112185
+ },
112186
+ {
112187
+ "const": "ocr_limit"
112188
+ },
112189
+ {
112190
+ "const": "ocr_unavailable"
112191
+ },
112192
+ {
112193
+ "const": "quota"
112194
+ },
112195
+ {
112196
+ "const": "too_many_pages"
112197
+ },
112198
+ {
112199
+ "const": "unreadable"
112200
+ },
112201
+ {
112202
+ "const": "unsupported"
112203
+ }
112204
+ ]
112205
+ },
112206
+ "format": {
112207
+ "anyOf": [
112208
+ {
112209
+ "type": "null"
112210
+ },
112211
+ {
112212
+ "const": "docx"
112213
+ },
112214
+ {
112215
+ "const": "html"
112216
+ },
112217
+ {
112218
+ "const": "markdown"
112219
+ },
112220
+ {
112221
+ "const": "pdf"
112222
+ },
112223
+ {
112224
+ "const": "pptx"
112225
+ },
112226
+ {
112227
+ "const": "text"
112228
+ }
112229
+ ]
112230
+ },
112231
+ "id": {
112232
+ "type": "string"
112233
+ },
112234
+ "name": {
112235
+ "type": "string"
112236
+ },
112237
+ "ocrPages": {
112238
+ "type": "number"
112239
+ },
112240
+ "ocrRead": {
112241
+ "type": "number"
112242
+ },
112243
+ "pageCount": {
112244
+ "anyOf": [
112245
+ {
112246
+ "type": "null"
112247
+ },
112248
+ {
112249
+ "type": "number"
112250
+ }
112251
+ ]
112252
+ },
112253
+ "pagesRead": {
112254
+ "type": "number"
112255
+ },
112256
+ "received": {
112257
+ "type": "array",
112258
+ "items": {
112259
+ "type": "number"
112260
+ }
112261
+ },
112262
+ "sourceIds": {
112263
+ "type": "array",
112264
+ "items": {
112265
+ "type": "string"
112266
+ }
112267
+ },
112268
+ "status": {
112269
+ "anyOf": [
112270
+ {
112271
+ "const": "completed"
112272
+ },
112273
+ {
112274
+ "const": "failed"
112275
+ },
112276
+ {
112277
+ "const": "parsing"
112278
+ },
112279
+ {
112280
+ "const": "queued"
112281
+ },
112282
+ {
112283
+ "const": "uploading"
112284
+ }
112285
+ ]
112286
+ },
112287
+ "updatedAt": {
112288
+ "type": "string"
112289
+ }
112290
+ },
112291
+ "required": [
112292
+ "byteSize",
112293
+ "canRetry",
112294
+ "chunkBytes",
112295
+ "chunkCount",
112296
+ "documentId",
112297
+ "error",
112298
+ "errorCode",
112299
+ "format",
112300
+ "id",
112301
+ "name",
112302
+ "ocrPages",
112303
+ "ocrRead",
112304
+ "pageCount",
112305
+ "pagesRead",
112306
+ "received",
112307
+ "sourceIds",
112308
+ "status",
112309
+ "updatedAt"
112310
+ ],
112311
+ "additionalProperties": false
112312
+ },
112313
+ {
112314
+ "type": "null"
112315
+ }
112316
+ ]
112317
+ }
112318
+ },
112319
+ "required": [
112320
+ "receipt",
112321
+ "result"
112322
+ ]
112323
+ }
112324
+ }
112325
+ }
112326
+ },
112327
+ "400": {
112328
+ "description": "400",
112329
+ "content": {
112330
+ "application/json": {
112331
+ "schema": {
112332
+ "oneOf": [
112333
+ {
112334
+ "type": "object",
112335
+ "properties": {
112336
+ "defined": {
112337
+ "const": true
112338
+ },
112339
+ "code": {
112340
+ "const": "BAD_REQUEST"
112341
+ },
112342
+ "status": {
112343
+ "const": 400
112344
+ },
112345
+ "message": {
112346
+ "type": "string",
112347
+ "default": "Check the request input."
112348
+ },
112349
+ "data": {}
112350
+ },
112351
+ "required": [
112352
+ "defined",
112353
+ "code",
112354
+ "status",
112355
+ "message"
112356
+ ]
112357
+ },
112358
+ {
112359
+ "type": "object",
112360
+ "properties": {
112361
+ "defined": {
112362
+ "const": false
112363
+ },
112364
+ "code": {
112365
+ "type": "string"
112366
+ },
112367
+ "status": {
112368
+ "type": "number"
112369
+ },
112370
+ "message": {
112371
+ "type": "string"
112372
+ },
112373
+ "data": {}
112374
+ },
112375
+ "required": [
112376
+ "defined",
112377
+ "code",
112378
+ "status",
112379
+ "message"
112380
+ ]
112381
+ }
112382
+ ]
112383
+ }
112384
+ }
112385
+ }
112386
+ },
112387
+ "401": {
112388
+ "description": "401",
112389
+ "content": {
112390
+ "application/json": {
112391
+ "schema": {
112392
+ "oneOf": [
112393
+ {
112394
+ "type": "object",
112395
+ "properties": {
112396
+ "defined": {
112397
+ "const": true
112398
+ },
112399
+ "code": {
112400
+ "const": "UNAUTHORIZED"
112401
+ },
112402
+ "status": {
112403
+ "const": 401
112404
+ },
112405
+ "message": {
112406
+ "type": "string",
112407
+ "default": "A valid Shuffl API token is required."
112408
+ },
112409
+ "data": {}
112410
+ },
112411
+ "required": [
112412
+ "defined",
112413
+ "code",
112414
+ "status",
112415
+ "message"
112416
+ ]
112417
+ },
112418
+ {
112419
+ "type": "object",
112420
+ "properties": {
112421
+ "defined": {
112422
+ "const": false
112423
+ },
112424
+ "code": {
112425
+ "type": "string"
112426
+ },
112427
+ "status": {
112428
+ "type": "number"
112429
+ },
112430
+ "message": {
112431
+ "type": "string"
112432
+ },
112433
+ "data": {}
112434
+ },
112435
+ "required": [
112436
+ "defined",
112437
+ "code",
112438
+ "status",
112439
+ "message"
112440
+ ]
112441
+ }
112442
+ ]
112443
+ }
112444
+ }
112445
+ }
112446
+ },
112447
+ "403": {
112448
+ "description": "403",
112449
+ "content": {
112450
+ "application/json": {
112451
+ "schema": {
112452
+ "oneOf": [
112453
+ {
112454
+ "type": "object",
112455
+ "properties": {
112456
+ "defined": {
112457
+ "const": true
112458
+ },
112459
+ "code": {
112460
+ "const": "FORBIDDEN"
112461
+ },
112462
+ "status": {
112463
+ "const": 403
112464
+ },
112465
+ "message": {
112466
+ "type": "string",
112467
+ "default": "This token or team role does not permit the operation."
112468
+ },
112469
+ "data": {}
112470
+ },
112471
+ "required": [
112472
+ "defined",
112473
+ "code",
112474
+ "status",
112475
+ "message"
112476
+ ]
112477
+ },
112478
+ {
112479
+ "type": "object",
112480
+ "properties": {
112481
+ "defined": {
112482
+ "const": false
112483
+ },
112484
+ "code": {
112485
+ "type": "string"
112486
+ },
112487
+ "status": {
112488
+ "type": "number"
112489
+ },
112490
+ "message": {
112491
+ "type": "string"
112492
+ },
112493
+ "data": {}
112494
+ },
112495
+ "required": [
112496
+ "defined",
112497
+ "code",
112498
+ "status",
112499
+ "message"
112500
+ ]
112501
+ }
112502
+ ]
112503
+ }
112504
+ }
112505
+ }
112506
+ },
112507
+ "404": {
112508
+ "description": "404",
112509
+ "content": {
112510
+ "application/json": {
112511
+ "schema": {
112512
+ "oneOf": [
112513
+ {
112514
+ "type": "object",
112515
+ "properties": {
112516
+ "defined": {
112517
+ "const": true
112518
+ },
112519
+ "code": {
112520
+ "const": "NOT_FOUND"
112521
+ },
112522
+ "status": {
112523
+ "const": 404
112524
+ },
112525
+ "message": {
112526
+ "type": "string",
112527
+ "default": "The requested resource was not found."
112528
+ },
112529
+ "data": {}
112530
+ },
112531
+ "required": [
112532
+ "defined",
112533
+ "code",
112534
+ "status",
112535
+ "message"
112536
+ ]
112537
+ },
112538
+ {
112539
+ "type": "object",
112540
+ "properties": {
112541
+ "defined": {
112542
+ "const": false
112543
+ },
112544
+ "code": {
112545
+ "type": "string"
112546
+ },
112547
+ "status": {
112548
+ "type": "number"
112549
+ },
112550
+ "message": {
112551
+ "type": "string"
112552
+ },
112553
+ "data": {}
112554
+ },
112555
+ "required": [
112556
+ "defined",
112557
+ "code",
112558
+ "status",
112559
+ "message"
112560
+ ]
112561
+ }
112562
+ ]
112563
+ }
112564
+ }
112565
+ }
112566
+ },
112567
+ "409": {
112568
+ "description": "409",
112569
+ "content": {
112570
+ "application/json": {
112571
+ "schema": {
112572
+ "oneOf": [
112573
+ {
112574
+ "type": "object",
112575
+ "properties": {
112576
+ "defined": {
112577
+ "const": true
112578
+ },
112579
+ "code": {
112580
+ "const": "CONFLICT"
112581
+ },
112582
+ "status": {
112583
+ "const": 409
112584
+ },
112585
+ "message": {
112586
+ "type": "string",
112587
+ "default": "The resource changed or the request key was reused."
112588
+ },
112589
+ "data": {}
112590
+ },
112591
+ "required": [
112592
+ "defined",
112593
+ "code",
112594
+ "status",
112595
+ "message"
112596
+ ]
112597
+ },
112598
+ {
112599
+ "type": "object",
112600
+ "properties": {
112601
+ "defined": {
112602
+ "const": false
112603
+ },
112604
+ "code": {
112605
+ "type": "string"
112606
+ },
112607
+ "status": {
112608
+ "type": "number"
112609
+ },
112610
+ "message": {
112611
+ "type": "string"
112612
+ },
112613
+ "data": {}
112614
+ },
112615
+ "required": [
112616
+ "defined",
112617
+ "code",
112618
+ "status",
112619
+ "message"
112620
+ ]
112621
+ }
112622
+ ]
112623
+ }
112624
+ }
112625
+ }
112626
+ },
112627
+ "412": {
112628
+ "description": "412",
112629
+ "content": {
112630
+ "application/json": {
112631
+ "schema": {
112632
+ "oneOf": [
112633
+ {
112634
+ "type": "object",
112635
+ "properties": {
112636
+ "defined": {
112637
+ "const": true
112638
+ },
112639
+ "code": {
112640
+ "const": "PRECONDITION_FAILED"
112641
+ },
112642
+ "status": {
112643
+ "const": 412
112644
+ },
112645
+ "message": {
112646
+ "type": "string",
112647
+ "default": "The team is not ready for this operation."
112648
+ },
112649
+ "data": {}
112650
+ },
112651
+ "required": [
112652
+ "defined",
112653
+ "code",
112654
+ "status",
112655
+ "message"
112656
+ ]
112657
+ },
112658
+ {
112659
+ "type": "object",
112660
+ "properties": {
112661
+ "defined": {
112662
+ "const": false
112663
+ },
112664
+ "code": {
112665
+ "type": "string"
112666
+ },
112667
+ "status": {
112668
+ "type": "number"
112669
+ },
112670
+ "message": {
112671
+ "type": "string"
112672
+ },
112673
+ "data": {}
112674
+ },
112675
+ "required": [
112676
+ "defined",
112677
+ "code",
112678
+ "status",
112679
+ "message"
112680
+ ]
112681
+ }
112682
+ ]
112683
+ }
112684
+ }
112685
+ }
112686
+ },
112687
+ "429": {
112688
+ "description": "429",
112689
+ "content": {
112690
+ "application/json": {
112691
+ "schema": {
112692
+ "oneOf": [
112693
+ {
112694
+ "type": "object",
112695
+ "properties": {
112696
+ "defined": {
112697
+ "const": true
112698
+ },
112699
+ "code": {
112700
+ "const": "TOO_MANY_REQUESTS"
112701
+ },
112702
+ "status": {
112703
+ "const": 429
112704
+ },
112705
+ "message": {
112706
+ "type": "string",
112707
+ "default": "Too many requests. Try again shortly."
112708
+ },
112709
+ "data": {}
112710
+ },
112711
+ "required": [
112712
+ "defined",
112713
+ "code",
112714
+ "status",
112715
+ "message"
112716
+ ]
112717
+ },
112718
+ {
112719
+ "type": "object",
112720
+ "properties": {
112721
+ "defined": {
112722
+ "const": false
112723
+ },
112724
+ "code": {
112725
+ "type": "string"
112726
+ },
112727
+ "status": {
112728
+ "type": "number"
112729
+ },
112730
+ "message": {
112731
+ "type": "string"
112732
+ },
112733
+ "data": {}
112734
+ },
112735
+ "required": [
112736
+ "defined",
112737
+ "code",
112738
+ "status",
112739
+ "message"
112740
+ ]
112741
+ }
112742
+ ]
112743
+ }
112744
+ }
112745
+ }
112746
+ }
112747
+ },
112748
+ "x-shuffl-access": "write",
112749
+ "x-shuffl-permission": "knowledge.uploads.retry"
111251
112750
  }
111252
112751
  },
111253
- "/manage/knowledge/uploads/retry": {
112752
+ "/knowledge/context": {
111254
112753
  "post": {
111255
- "operationId": "knowledge.uploads.retry",
111256
- "summary": "Retry reading a Knowledge file that failed",
112754
+ "operationId": "knowledge.context",
112755
+ "summary": "Read nearby passages from the same currently approved version",
111257
112756
  "requestBody": {
111258
112757
  "required": true,
111259
112758
  "content": {
@@ -111261,18 +112760,23 @@
111261
112760
  "schema": {
111262
112761
  "type": "object",
111263
112762
  "properties": {
111264
- "uploadId": {
111265
- "type": "string"
112763
+ "passageId": {
112764
+ "type": "string",
112765
+ "pattern": "^passage-[1-9]\\d{0,2}$"
111266
112766
  },
111267
- "requestKey": {
112767
+ "sourceId": {
111268
112768
  "type": "string",
111269
- "minLength": 1,
111270
- "maxLength": 128
112769
+ "format": "uuid"
112770
+ },
112771
+ "versionId": {
112772
+ "type": "string",
112773
+ "format": "uuid"
111271
112774
  }
111272
112775
  },
111273
112776
  "required": [
111274
- "uploadId",
111275
- "requestKey"
112777
+ "passageId",
112778
+ "sourceId",
112779
+ "versionId"
111276
112780
  ],
111277
112781
  "additionalProperties": false
111278
112782
  }
@@ -111285,242 +112789,48 @@
111285
112789
  "content": {
111286
112790
  "application/json": {
111287
112791
  "schema": {
111288
- "type": "object",
111289
- "properties": {
111290
- "receipt": {
111291
- "type": "object",
111292
- "properties": {
111293
- "completedAt": {
111294
- "anyOf": [
111295
- {
111296
- "type": "string",
111297
- "format": "date-time"
111298
- },
111299
- {
111300
- "type": "null"
111301
- }
111302
- ]
111303
- },
111304
- "createdAt": {
111305
- "type": "string",
111306
- "format": "date-time"
111307
- },
111308
- "id": {
111309
- "type": "string",
111310
- "format": "uuid"
111311
- },
111312
- "operation": {
111313
- "type": "string"
111314
- },
111315
- "requestKey": {
111316
- "type": "string"
111317
- },
111318
- "status": {
111319
- "enum": [
111320
- "running",
111321
- "succeeded",
111322
- "failed",
111323
- "unknown"
111324
- ],
111325
- "type": "string"
111326
- }
112792
+ "type": "array",
112793
+ "maxItems": 3,
112794
+ "items": {
112795
+ "type": "object",
112796
+ "properties": {
112797
+ "href": {
112798
+ "type": "string"
111327
112799
  },
111328
- "required": [
111329
- "completedAt",
111330
- "createdAt",
111331
- "id",
111332
- "operation",
111333
- "requestKey",
111334
- "status"
111335
- ]
112800
+ "kind": {
112801
+ "enum": [
112802
+ "knowledge",
112803
+ "manager",
112804
+ "directory",
112805
+ "playbook"
112806
+ ],
112807
+ "type": "string"
112808
+ },
112809
+ "passageId": {
112810
+ "type": "string"
112811
+ },
112812
+ "quote": {
112813
+ "type": "string"
112814
+ },
112815
+ "sourceId": {
112816
+ "type": "string"
112817
+ },
112818
+ "title": {
112819
+ "type": "string"
112820
+ },
112821
+ "versionId": {
112822
+ "type": "string"
112823
+ }
111336
112824
  },
111337
- "result": {
111338
- "anyOf": [
111339
- {
111340
- "type": "object",
111341
- "properties": {
111342
- "byteSize": {
111343
- "type": "number"
111344
- },
111345
- "canRetry": {
111346
- "type": "boolean"
111347
- },
111348
- "chunkBytes": {
111349
- "type": "number"
111350
- },
111351
- "chunkCount": {
111352
- "type": "number"
111353
- },
111354
- "documentId": {
111355
- "type": "string"
111356
- },
111357
- "error": {
111358
- "anyOf": [
111359
- {
111360
- "type": "null"
111361
- },
111362
- {
111363
- "type": "string"
111364
- }
111365
- ]
111366
- },
111367
- "errorCode": {
111368
- "anyOf": [
111369
- {
111370
- "type": "null"
111371
- },
111372
- {
111373
- "const": "access"
111374
- },
111375
- {
111376
- "const": "encrypted"
111377
- },
111378
- {
111379
- "const": "interrupted"
111380
- },
111381
- {
111382
- "const": "no_text"
111383
- },
111384
- {
111385
- "const": "ocr_failed"
111386
- },
111387
- {
111388
- "const": "ocr_limit"
111389
- },
111390
- {
111391
- "const": "ocr_unavailable"
111392
- },
111393
- {
111394
- "const": "quota"
111395
- },
111396
- {
111397
- "const": "too_many_pages"
111398
- },
111399
- {
111400
- "const": "unreadable"
111401
- },
111402
- {
111403
- "const": "unsupported"
111404
- }
111405
- ]
111406
- },
111407
- "format": {
111408
- "anyOf": [
111409
- {
111410
- "type": "null"
111411
- },
111412
- {
111413
- "const": "docx"
111414
- },
111415
- {
111416
- "const": "html"
111417
- },
111418
- {
111419
- "const": "markdown"
111420
- },
111421
- {
111422
- "const": "pdf"
111423
- },
111424
- {
111425
- "const": "pptx"
111426
- },
111427
- {
111428
- "const": "text"
111429
- }
111430
- ]
111431
- },
111432
- "id": {
111433
- "type": "string"
111434
- },
111435
- "name": {
111436
- "type": "string"
111437
- },
111438
- "ocrPages": {
111439
- "type": "number"
111440
- },
111441
- "ocrRead": {
111442
- "type": "number"
111443
- },
111444
- "pageCount": {
111445
- "anyOf": [
111446
- {
111447
- "type": "null"
111448
- },
111449
- {
111450
- "type": "number"
111451
- }
111452
- ]
111453
- },
111454
- "pagesRead": {
111455
- "type": "number"
111456
- },
111457
- "received": {
111458
- "type": "array",
111459
- "items": {
111460
- "type": "number"
111461
- }
111462
- },
111463
- "sourceIds": {
111464
- "type": "array",
111465
- "items": {
111466
- "type": "string"
111467
- }
111468
- },
111469
- "status": {
111470
- "anyOf": [
111471
- {
111472
- "const": "completed"
111473
- },
111474
- {
111475
- "const": "failed"
111476
- },
111477
- {
111478
- "const": "parsing"
111479
- },
111480
- {
111481
- "const": "queued"
111482
- },
111483
- {
111484
- "const": "uploading"
111485
- }
111486
- ]
111487
- },
111488
- "updatedAt": {
111489
- "type": "string"
111490
- }
111491
- },
111492
- "required": [
111493
- "byteSize",
111494
- "canRetry",
111495
- "chunkBytes",
111496
- "chunkCount",
111497
- "documentId",
111498
- "error",
111499
- "errorCode",
111500
- "format",
111501
- "id",
111502
- "name",
111503
- "ocrPages",
111504
- "ocrRead",
111505
- "pageCount",
111506
- "pagesRead",
111507
- "received",
111508
- "sourceIds",
111509
- "status",
111510
- "updatedAt"
111511
- ],
111512
- "additionalProperties": false
111513
- },
111514
- {
111515
- "type": "null"
111516
- }
111517
- ]
111518
- }
111519
- },
111520
- "required": [
111521
- "receipt",
111522
- "result"
111523
- ]
112825
+ "required": [
112826
+ "href",
112827
+ "passageId",
112828
+ "quote",
112829
+ "sourceId",
112830
+ "title",
112831
+ "versionId"
112832
+ ]
112833
+ }
111524
112834
  }
111525
112835
  }
111526
112836
  }
@@ -111946,14 +113256,14 @@
111946
113256
  }
111947
113257
  }
111948
113258
  },
111949
- "x-shuffl-access": "write",
111950
- "x-shuffl-permission": "knowledge.uploads.retry"
113259
+ "x-shuffl-access": "read",
113260
+ "x-shuffl-permission": "knowledge.context"
111951
113261
  }
111952
113262
  },
111953
- "/knowledge/context": {
113263
+ "/knowledge/search": {
111954
113264
  "post": {
111955
- "operationId": "knowledge.context",
111956
- "summary": "Read nearby passages from the same currently approved version",
113265
+ "operationId": "knowledge.search",
113266
+ "summary": "Search currently approved knowledge and return immutable passage citations",
111957
113267
  "requestBody": {
111958
113268
  "required": true,
111959
113269
  "content": {
@@ -111961,23 +113271,14 @@
111961
113271
  "schema": {
111962
113272
  "type": "object",
111963
113273
  "properties": {
111964
- "passageId": {
111965
- "type": "string",
111966
- "pattern": "^passage-[1-9]\\d{0,2}$"
111967
- },
111968
- "sourceId": {
111969
- "type": "string",
111970
- "format": "uuid"
111971
- },
111972
- "versionId": {
113274
+ "query": {
111973
113275
  "type": "string",
111974
- "format": "uuid"
113276
+ "minLength": 2,
113277
+ "maxLength": 500
111975
113278
  }
111976
113279
  },
111977
113280
  "required": [
111978
- "passageId",
111979
- "sourceId",
111980
- "versionId"
113281
+ "query"
111981
113282
  ],
111982
113283
  "additionalProperties": false
111983
113284
  }
@@ -111991,7 +113292,7 @@
111991
113292
  "application/json": {
111992
113293
  "schema": {
111993
113294
  "type": "array",
111994
- "maxItems": 3,
113295
+ "maxItems": 8,
111995
113296
  "items": {
111996
113297
  "type": "object",
111997
113298
  "properties": {
@@ -112458,13 +113759,13 @@
112458
113759
  }
112459
113760
  },
112460
113761
  "x-shuffl-access": "read",
112461
- "x-shuffl-permission": "knowledge.context"
113762
+ "x-shuffl-permission": "knowledge.search"
112462
113763
  }
112463
113764
  },
112464
- "/knowledge/search": {
113765
+ "/manage/network/claim": {
112465
113766
  "post": {
112466
- "operationId": "knowledge.search",
112467
- "summary": "Search currently approved knowledge and return immutable passage citations",
113767
+ "operationId": "network.claim",
113768
+ "summary": "Say you know someone or would like to meet them",
112468
113769
  "requestBody": {
112469
113770
  "required": true,
112470
113771
  "content": {
@@ -112472,14 +113773,37 @@
112472
113773
  "schema": {
112473
113774
  "type": "object",
112474
113775
  "properties": {
112475
- "query": {
113776
+ "kind": {
113777
+ "anyOf": [
113778
+ {
113779
+ "const": "knows"
113780
+ },
113781
+ {
113782
+ "const": "wants_to_meet"
113783
+ }
113784
+ ]
113785
+ },
113786
+ "on": {
113787
+ "type": "boolean"
113788
+ },
113789
+ "personId": {
113790
+ "type": "string"
113791
+ },
113792
+ "confirm": {
113793
+ "const": "network.claim"
113794
+ },
113795
+ "requestKey": {
112476
113796
  "type": "string",
112477
- "minLength": 2,
112478
- "maxLength": 500
113797
+ "minLength": 1,
113798
+ "maxLength": 128
112479
113799
  }
112480
113800
  },
112481
113801
  "required": [
112482
- "query"
113802
+ "kind",
113803
+ "on",
113804
+ "personId",
113805
+ "confirm",
113806
+ "requestKey"
112483
113807
  ],
112484
113808
  "additionalProperties": false
112485
113809
  }
@@ -112492,48 +113816,87 @@
112492
113816
  "content": {
112493
113817
  "application/json": {
112494
113818
  "schema": {
112495
- "type": "array",
112496
- "maxItems": 8,
112497
- "items": {
112498
- "type": "object",
112499
- "properties": {
112500
- "href": {
112501
- "type": "string"
112502
- },
112503
- "kind": {
112504
- "enum": [
112505
- "knowledge",
112506
- "manager",
112507
- "directory",
112508
- "playbook"
112509
- ],
112510
- "type": "string"
112511
- },
112512
- "passageId": {
112513
- "type": "string"
112514
- },
112515
- "quote": {
112516
- "type": "string"
112517
- },
112518
- "sourceId": {
112519
- "type": "string"
112520
- },
112521
- "title": {
112522
- "type": "string"
113819
+ "type": "object",
113820
+ "properties": {
113821
+ "receipt": {
113822
+ "type": "object",
113823
+ "properties": {
113824
+ "completedAt": {
113825
+ "anyOf": [
113826
+ {
113827
+ "type": "string",
113828
+ "format": "date-time"
113829
+ },
113830
+ {
113831
+ "type": "null"
113832
+ }
113833
+ ]
113834
+ },
113835
+ "createdAt": {
113836
+ "type": "string",
113837
+ "format": "date-time"
113838
+ },
113839
+ "id": {
113840
+ "type": "string",
113841
+ "format": "uuid"
113842
+ },
113843
+ "operation": {
113844
+ "type": "string"
113845
+ },
113846
+ "requestKey": {
113847
+ "type": "string"
113848
+ },
113849
+ "status": {
113850
+ "enum": [
113851
+ "running",
113852
+ "succeeded",
113853
+ "failed",
113854
+ "unknown"
113855
+ ],
113856
+ "type": "string"
113857
+ }
112523
113858
  },
112524
- "versionId": {
112525
- "type": "string"
112526
- }
113859
+ "required": [
113860
+ "completedAt",
113861
+ "createdAt",
113862
+ "id",
113863
+ "operation",
113864
+ "requestKey",
113865
+ "status"
113866
+ ]
112527
113867
  },
112528
- "required": [
112529
- "href",
112530
- "passageId",
112531
- "quote",
112532
- "sourceId",
112533
- "title",
112534
- "versionId"
112535
- ]
112536
- }
113868
+ "result": {
113869
+ "anyOf": [
113870
+ {
113871
+ "type": "object",
113872
+ "properties": {
113873
+ "confirmed": {
113874
+ "type": "boolean"
113875
+ },
113876
+ "knows": {
113877
+ "type": "boolean"
113878
+ },
113879
+ "wantsToMeet": {
113880
+ "type": "boolean"
113881
+ }
113882
+ },
113883
+ "required": [
113884
+ "confirmed",
113885
+ "knows",
113886
+ "wantsToMeet"
113887
+ ],
113888
+ "additionalProperties": false
113889
+ },
113890
+ {
113891
+ "type": "null"
113892
+ }
113893
+ ]
113894
+ }
113895
+ },
113896
+ "required": [
113897
+ "receipt",
113898
+ "result"
113899
+ ]
112537
113900
  }
112538
113901
  }
112539
113902
  }
@@ -112959,53 +114322,20 @@
112959
114322
  }
112960
114323
  }
112961
114324
  },
112962
- "x-shuffl-access": "read",
112963
- "x-shuffl-permission": "knowledge.search"
114325
+ "x-shuffl-access": "write",
114326
+ "x-shuffl-permission": "network.claim"
112964
114327
  }
112965
114328
  },
112966
- "/manage/network/claim": {
114329
+ "/manage/network/introductions": {
112967
114330
  "post": {
112968
- "operationId": "network.claim",
112969
- "summary": "Say you know someone or would like to meet them",
114331
+ "operationId": "network.introductions",
114332
+ "summary": "Your Connections programs, when your next introduction goes out, and who you met",
112970
114333
  "requestBody": {
112971
114334
  "required": true,
112972
114335
  "content": {
112973
114336
  "application/json": {
112974
114337
  "schema": {
112975
114338
  "type": "object",
112976
- "properties": {
112977
- "kind": {
112978
- "anyOf": [
112979
- {
112980
- "const": "knows"
112981
- },
112982
- {
112983
- "const": "wants_to_meet"
112984
- }
112985
- ]
112986
- },
112987
- "on": {
112988
- "type": "boolean"
112989
- },
112990
- "personId": {
112991
- "type": "string"
112992
- },
112993
- "confirm": {
112994
- "const": "network.claim"
112995
- },
112996
- "requestKey": {
112997
- "type": "string",
112998
- "minLength": 1,
112999
- "maxLength": 128
113000
- }
113001
- },
113002
- "required": [
113003
- "kind",
113004
- "on",
113005
- "personId",
113006
- "confirm",
113007
- "requestKey"
113008
- ],
113009
114339
  "additionalProperties": false
113010
114340
  }
113011
114341
  }
@@ -113017,86 +114347,238 @@
113017
114347
  "content": {
113018
114348
  "application/json": {
113019
114349
  "schema": {
113020
- "type": "object",
113021
- "properties": {
113022
- "receipt": {
114350
+ "anyOf": [
114351
+ {
113023
114352
  "type": "object",
113024
114353
  "properties": {
113025
- "completedAt": {
113026
- "anyOf": [
113027
- {
113028
- "type": "string",
113029
- "format": "date-time"
114354
+ "past": {
114355
+ "type": "array",
114356
+ "items": {
114357
+ "type": "object",
114358
+ "properties": {
114359
+ "at": {
114360
+ "type": "string",
114361
+ "format": "date-time"
114362
+ },
114363
+ "id": {
114364
+ "type": "string"
114365
+ },
114366
+ "program": {
114367
+ "type": "string"
114368
+ },
114369
+ "with": {
114370
+ "type": "array",
114371
+ "items": {
114372
+ "type": "object",
114373
+ "properties": {
114374
+ "id": {
114375
+ "type": "string"
114376
+ },
114377
+ "name": {
114378
+ "type": "string"
114379
+ },
114380
+ "photoUrl": {
114381
+ "anyOf": [
114382
+ {
114383
+ "type": "null"
114384
+ },
114385
+ {
114386
+ "type": "string"
114387
+ }
114388
+ ]
114389
+ },
114390
+ "slackUserId": {
114391
+ "anyOf": [
114392
+ {
114393
+ "type": "null"
114394
+ },
114395
+ {
114396
+ "type": "string"
114397
+ }
114398
+ ]
114399
+ },
114400
+ "title": {
114401
+ "anyOf": [
114402
+ {
114403
+ "type": "null"
114404
+ },
114405
+ {
114406
+ "type": "string"
114407
+ }
114408
+ ]
114409
+ }
114410
+ },
114411
+ "required": [
114412
+ "id",
114413
+ "name",
114414
+ "photoUrl",
114415
+ "slackUserId",
114416
+ "title"
114417
+ ],
114418
+ "additionalProperties": false
114419
+ }
114420
+ }
113030
114421
  },
113031
- {
113032
- "type": "null"
113033
- }
113034
- ]
113035
- },
113036
- "createdAt": {
113037
- "type": "string",
113038
- "format": "date-time"
113039
- },
113040
- "id": {
113041
- "type": "string",
113042
- "format": "uuid"
113043
- },
113044
- "operation": {
113045
- "type": "string"
114422
+ "required": [
114423
+ "at",
114424
+ "id",
114425
+ "program",
114426
+ "with"
114427
+ ],
114428
+ "additionalProperties": false
114429
+ }
113046
114430
  },
113047
- "requestKey": {
113048
- "type": "string"
114431
+ "programs": {
114432
+ "type": "array",
114433
+ "items": {
114434
+ "type": "object",
114435
+ "properties": {
114436
+ "breakUntil": {
114437
+ "anyOf": [
114438
+ {
114439
+ "type": "null"
114440
+ },
114441
+ {
114442
+ "type": "string",
114443
+ "format": "date-time"
114444
+ }
114445
+ ]
114446
+ },
114447
+ "id": {
114448
+ "type": "string"
114449
+ },
114450
+ "name": {
114451
+ "type": "string"
114452
+ },
114453
+ "nextAt": {
114454
+ "anyOf": [
114455
+ {
114456
+ "type": "null"
114457
+ },
114458
+ {
114459
+ "type": "string",
114460
+ "format": "date-time"
114461
+ }
114462
+ ]
114463
+ }
114464
+ },
114465
+ "required": [
114466
+ "breakUntil",
114467
+ "id",
114468
+ "name",
114469
+ "nextAt"
114470
+ ],
114471
+ "additionalProperties": false
114472
+ }
113049
114473
  },
113050
- "status": {
113051
- "enum": [
113052
- "running",
113053
- "succeeded",
113054
- "failed",
113055
- "unknown"
113056
- ],
113057
- "type": "string"
114474
+ "total": {
114475
+ "type": "number"
113058
114476
  }
113059
114477
  },
113060
114478
  "required": [
113061
- "completedAt",
113062
- "createdAt",
113063
- "id",
113064
- "operation",
113065
- "requestKey",
113066
- "status"
113067
- ]
114479
+ "past",
114480
+ "programs",
114481
+ "total"
114482
+ ],
114483
+ "additionalProperties": false
113068
114484
  },
113069
- "result": {
113070
- "anyOf": [
113071
- {
113072
- "type": "object",
113073
- "properties": {
113074
- "confirmed": {
113075
- "type": "boolean"
113076
- },
113077
- "knows": {
113078
- "type": "boolean"
114485
+ {
114486
+ "type": "object",
114487
+ "properties": {
114488
+ "past": {
114489
+ "type": "array",
114490
+ "items": {
114491
+ "type": "object",
114492
+ "properties": {
114493
+ "at": {
114494
+ "type": "string",
114495
+ "format": "date-time"
114496
+ },
114497
+ "id": {
114498
+ "type": "string"
114499
+ },
114500
+ "program": {
114501
+ "type": "string"
114502
+ },
114503
+ "with": {
114504
+ "type": "array",
114505
+ "items": {
114506
+ "type": "object",
114507
+ "properties": {
114508
+ "id": {
114509
+ "type": "string"
114510
+ },
114511
+ "name": {
114512
+ "type": "string"
114513
+ },
114514
+ "photoUrl": {
114515
+ "anyOf": [
114516
+ {
114517
+ "type": "null"
114518
+ },
114519
+ {
114520
+ "type": "string"
114521
+ }
114522
+ ]
114523
+ },
114524
+ "slackUserId": {
114525
+ "anyOf": [
114526
+ {
114527
+ "type": "null"
114528
+ },
114529
+ {
114530
+ "type": "string"
114531
+ }
114532
+ ]
114533
+ },
114534
+ "title": {
114535
+ "anyOf": [
114536
+ {
114537
+ "type": "null"
114538
+ },
114539
+ {
114540
+ "type": "string"
114541
+ }
114542
+ ]
114543
+ }
114544
+ },
114545
+ "required": [
114546
+ "id",
114547
+ "name",
114548
+ "photoUrl",
114549
+ "slackUserId",
114550
+ "title"
114551
+ ],
114552
+ "additionalProperties": false
114553
+ }
114554
+ }
113079
114555
  },
113080
- "wantsToMeet": {
113081
- "type": "boolean"
113082
- }
113083
- },
113084
- "required": [
113085
- "confirmed",
113086
- "knows",
113087
- "wantsToMeet"
113088
- ],
113089
- "additionalProperties": false
114556
+ "required": [
114557
+ "at",
114558
+ "id",
114559
+ "program",
114560
+ "with"
114561
+ ],
114562
+ "additionalProperties": false
114563
+ }
113090
114564
  },
113091
- {
113092
- "type": "null"
114565
+ "programs": {
114566
+ "type": "array",
114567
+ "items": {
114568
+ "not": {}
114569
+ }
114570
+ },
114571
+ "total": {
114572
+ "type": "number"
113093
114573
  }
113094
- ]
114574
+ },
114575
+ "required": [
114576
+ "past",
114577
+ "programs",
114578
+ "total"
114579
+ ],
114580
+ "additionalProperties": false
113095
114581
  }
113096
- },
113097
- "required": [
113098
- "receipt",
113099
- "result"
113100
114582
  ]
113101
114583
  }
113102
114584
  }
@@ -113523,8 +115005,8 @@
113523
115005
  }
113524
115006
  }
113525
115007
  },
113526
- "x-shuffl-access": "write",
113527
- "x-shuffl-permission": "network.claim"
115008
+ "x-shuffl-access": "read",
115009
+ "x-shuffl-permission": "network.introductions"
113528
115010
  }
113529
115011
  },
113530
115012
  "/manage/network/mine": {
@@ -134893,6 +136375,16 @@
134893
136375
  }
134894
136376
  ]
134895
136377
  },
136378
+ "autoStartPaused": {
136379
+ "anyOf": [
136380
+ {
136381
+ "const": false
136382
+ },
136383
+ {
136384
+ "const": true
136385
+ }
136386
+ ]
136387
+ },
134896
136388
  "buddy": {
134897
136389
  "anyOf": [
134898
136390
  {
@@ -140029,6 +141521,16 @@
140029
141521
  }
140030
141522
  ]
140031
141523
  },
141524
+ "autoStartPaused": {
141525
+ "anyOf": [
141526
+ {
141527
+ "const": false
141528
+ },
141529
+ {
141530
+ "const": true
141531
+ }
141532
+ ]
141533
+ },
140032
141534
  "buddy": {
140033
141535
  "anyOf": [
140034
141536
  {
@@ -140720,6 +142222,16 @@
140720
142222
  }
140721
142223
  ]
140722
142224
  },
142225
+ "autoStartPaused": {
142226
+ "anyOf": [
142227
+ {
142228
+ "const": false
142229
+ },
142230
+ {
142231
+ "const": true
142232
+ }
142233
+ ]
142234
+ },
140723
142235
  "buddy": {
140724
142236
  "anyOf": [
140725
142237
  {
@@ -200017,6 +201529,16 @@
200017
201529
  }
200018
201530
  ]
200019
201531
  },
201532
+ "autoStartPaused": {
201533
+ "anyOf": [
201534
+ {
201535
+ "const": false
201536
+ },
201537
+ {
201538
+ "const": true
201539
+ }
201540
+ ]
201541
+ },
200020
201542
  "buddy": {
200021
201543
  "anyOf": [
200022
201544
  {
@@ -252380,6 +253902,7 @@
252380
253902
  "groups.sendMessage",
252381
253903
  "groups.setAutomation",
252382
253904
  "groups.setAutomationState",
253905
+ "groups.setPlaybookAutoStart",
252383
253906
  "home.feed",
252384
253907
  "home.places",
252385
253908
  "home.preferences",
@@ -252451,6 +253974,7 @@
252451
253974
  "knowledge.uploads.retry",
252452
253975
  "manager.current",
252453
253976
  "mcp.knowledge",
253977
+ "network.introductions",
252454
253978
  "network.mine",
252455
253979
  "network.ofPerson",
252456
253980
  "network.orgChart",
@@ -252839,6 +254363,7 @@
252839
254363
  "groups.sendMessage",
252840
254364
  "groups.setAutomation",
252841
254365
  "groups.setAutomationState",
254366
+ "groups.setPlaybookAutoStart",
252842
254367
  "home.feed",
252843
254368
  "home.places",
252844
254369
  "home.preferences",
@@ -252910,6 +254435,7 @@
252910
254435
  "knowledge.uploads.retry",
252911
254436
  "manager.current",
252912
254437
  "mcp.knowledge",
254438
+ "network.introductions",
252913
254439
  "network.mine",
252914
254440
  "network.ofPerson",
252915
254441
  "network.orgChart",