@work-shape/catalyst-api-contract 0.8.0-rc.8 → 0.8.0-rc.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/index.d.ts +1421 -55
  2. package/dist/index.js +2256 -2023
  3. package/openapi.json +991 -16
  4. package/package.json +2 -2
package/openapi.json CHANGED
@@ -2,8 +2,8 @@
2
2
  "openapi": "3.1.0",
3
3
  "info": {
4
4
  "title": "Workshape Catalyst API",
5
- "version": "0.8.0-rc.8",
6
- "description": "Every operation under `/api/v1` of release 0.8.0-rc.8, and the unversioned readiness probe `/ready`. Every error answers with the envelope `ApiErrorResponse`; its `code` is the stable part, its `correlationId` names the request in the instance's log."
5
+ "version": "0.8.0-rc.9",
6
+ "description": "Every operation under `/api/v1` of release 0.8.0-rc.9, and the unversioned readiness probe `/ready`. Every error answers with the envelope `ApiErrorResponse`; its `code` is the stable part, its `correlationId` names the request in the instance's log."
7
7
  },
8
8
  "servers": [
9
9
  {
@@ -4888,6 +4888,10 @@
4888
4888
  "connectorType": {
4889
4889
  "type": "string"
4890
4890
  },
4891
+ "personal": {
4892
+ "type": "boolean",
4893
+ "const": true
4894
+ },
4891
4895
  "tools": {
4892
4896
  "type": "array",
4893
4897
  "items": {
@@ -5385,7 +5389,7 @@
5385
5389
  "/api/v1/connections/{name}/disconnect": {
5386
5390
  "post": {
5387
5391
  "operationId": "connections.disconnect",
5388
- "summary": "End the shared OAuth sign-in of one Connection. Its tokens are deleted, then the provider is asked to revoke the grant",
5392
+ "summary": "End the OAuth sign-in of one Connection. Its tokens are deleted, then the provider is asked to revoke the grant",
5389
5393
  "tags": [
5390
5394
  "Connections"
5391
5395
  ],
@@ -5790,7 +5794,7 @@
5790
5794
  "/api/v1/connections/{name}/oauth/sign-ins/{signInId}": {
5791
5795
  "get": {
5792
5796
  "operationId": "connections.oauth_sign_in",
5793
- "summary": "Read whether a shared OAuth sign-in the caller started still waits for the browser to come back",
5797
+ "summary": "Read whether an OAuth sign-in the caller started still waits for the browser to come back",
5794
5798
  "tags": [
5795
5799
  "Connections"
5796
5800
  ],
@@ -5881,7 +5885,7 @@
5881
5885
  "/api/v1/connections/{name}/oauth/start": {
5882
5886
  "post": {
5883
5887
  "operationId": "connections.oauth_start",
5884
- "summary": "Start the shared OAuth sign-in of one Connection. The answer is the address to open in the person's browser",
5888
+ "summary": "Start the OAuth sign-in of one Connection. The answer is the address to open in the person's browser",
5885
5889
  "tags": [
5886
5890
  "Connections"
5887
5891
  ],
@@ -5994,6 +5998,261 @@
5994
5998
  "x-catalyst-rate-class": "write"
5995
5999
  }
5996
6000
  },
6001
+ "/api/v1/connections/{name}/people": {
6002
+ "get": {
6003
+ "operationId": "connections.people",
6004
+ "summary": "List personal sign-ins; requires Connection write access",
6005
+ "tags": [
6006
+ "Connections"
6007
+ ],
6008
+ "security": [
6009
+ {
6010
+ "sessionCookie": [
6011
+ "config_assets:write"
6012
+ ]
6013
+ },
6014
+ {
6015
+ "sessionToken": [
6016
+ "config_assets:write"
6017
+ ]
6018
+ }
6019
+ ],
6020
+ "parameters": [
6021
+ {
6022
+ "name": "name",
6023
+ "in": "path",
6024
+ "required": true,
6025
+ "schema": {
6026
+ "type": "string"
6027
+ }
6028
+ }
6029
+ ],
6030
+ "responses": {
6031
+ "200": {
6032
+ "description": "The result",
6033
+ "content": {
6034
+ "application/json": {
6035
+ "schema": {
6036
+ "type": "object",
6037
+ "properties": {
6038
+ "people": {
6039
+ "type": "array",
6040
+ "items": {
6041
+ "type": "object",
6042
+ "properties": {
6043
+ "state": {
6044
+ "type": "string",
6045
+ "enum": [
6046
+ "not_connected",
6047
+ "connected",
6048
+ "needs_reconnect",
6049
+ "revoked"
6050
+ ]
6051
+ },
6052
+ "account": {
6053
+ "type": "string"
6054
+ },
6055
+ "connectedAt": {
6056
+ "$ref": "#/components/schemas/Timestamp"
6057
+ },
6058
+ "lastUsedOn": {
6059
+ "type": "string"
6060
+ },
6061
+ "reason": {
6062
+ "type": "string"
6063
+ },
6064
+ "userId": {
6065
+ "type": "string"
6066
+ },
6067
+ "displayLabel": {
6068
+ "type": "string"
6069
+ }
6070
+ },
6071
+ "required": [
6072
+ "state",
6073
+ "userId"
6074
+ ]
6075
+ }
6076
+ }
6077
+ },
6078
+ "required": [
6079
+ "people"
6080
+ ]
6081
+ }
6082
+ }
6083
+ },
6084
+ "headers": {
6085
+ "Operation-Run-Id": {
6086
+ "$ref": "#/components/headers/OperationRunId"
6087
+ }
6088
+ }
6089
+ },
6090
+ "400": {
6091
+ "$ref": "#/components/responses/BadRequest"
6092
+ },
6093
+ "401": {
6094
+ "$ref": "#/components/responses/Unauthenticated"
6095
+ },
6096
+ "403": {
6097
+ "$ref": "#/components/responses/ForbiddenOrPolicyDeniedOrGuardrailBlocked"
6098
+ },
6099
+ "404": {
6100
+ "$ref": "#/components/responses/NotFound"
6101
+ },
6102
+ "409": {
6103
+ "$ref": "#/components/responses/Conflict"
6104
+ },
6105
+ "422": {
6106
+ "$ref": "#/components/responses/ValidationFailed"
6107
+ },
6108
+ "429": {
6109
+ "$ref": "#/components/responses/RateLimited"
6110
+ },
6111
+ "500": {
6112
+ "$ref": "#/components/responses/Internal"
6113
+ }
6114
+ },
6115
+ "x-catalyst-effect": "reading",
6116
+ "x-catalyst-rate-class": "read"
6117
+ }
6118
+ },
6119
+ "/api/v1/connections/{name}/people/{userId}": {
6120
+ "delete": {
6121
+ "operationId": "connections.revoke_person",
6122
+ "summary": "Revoke a personal sign-in locally without contacting the provider",
6123
+ "tags": [
6124
+ "Connections"
6125
+ ],
6126
+ "security": [
6127
+ {
6128
+ "sessionCookie": [
6129
+ "config_assets:write"
6130
+ ]
6131
+ },
6132
+ {
6133
+ "sessionToken": [
6134
+ "config_assets:write"
6135
+ ]
6136
+ }
6137
+ ],
6138
+ "parameters": [
6139
+ {
6140
+ "name": "name",
6141
+ "in": "path",
6142
+ "required": true,
6143
+ "schema": {
6144
+ "type": "string"
6145
+ }
6146
+ },
6147
+ {
6148
+ "name": "userId",
6149
+ "in": "path",
6150
+ "required": true,
6151
+ "schema": {
6152
+ "type": "string"
6153
+ }
6154
+ },
6155
+ {
6156
+ "name": "Idempotency-Key",
6157
+ "in": "header",
6158
+ "description": "A key the caller chooses for one changing call, up to 255 characters. The same key with the same input answers what the first call answered instead of acting twice. A key belongs to its caller: another caller's same key is another call.",
6159
+ "required": false,
6160
+ "schema": {
6161
+ "type": "string",
6162
+ "minLength": 1,
6163
+ "maxLength": 255
6164
+ }
6165
+ },
6166
+ {
6167
+ "name": "Catalyst-Unattended",
6168
+ "in": "header",
6169
+ "description": "`1` on a call of an API credential when nobody watches its terminal, such as `catalyst <kind> publish --yes`. The call is then not its caller's own confirmation: a call that needs one waits in the caller's Inbox and answers `202` with its run, status `pending_confirmation`. It only ever makes a call stricter; a browser session's call ignores it.",
6170
+ "required": false,
6171
+ "schema": {
6172
+ "type": "string",
6173
+ "minLength": 1,
6174
+ "maxLength": 255
6175
+ }
6176
+ }
6177
+ ],
6178
+ "responses": {
6179
+ "200": {
6180
+ "description": "The result",
6181
+ "content": {
6182
+ "application/json": {
6183
+ "schema": {
6184
+ "type": "object",
6185
+ "properties": {
6186
+ "state": {
6187
+ "type": "string",
6188
+ "const": "revoked"
6189
+ }
6190
+ },
6191
+ "required": [
6192
+ "state"
6193
+ ]
6194
+ }
6195
+ }
6196
+ },
6197
+ "headers": {
6198
+ "Operation-Run-Id": {
6199
+ "$ref": "#/components/headers/OperationRunId"
6200
+ },
6201
+ "Idempotent-Replayed": {
6202
+ "$ref": "#/components/headers/IdempotentReplayed"
6203
+ }
6204
+ }
6205
+ },
6206
+ "202": {
6207
+ "description": "The call waits for somebody else to approve it. This is its Operation Run; read it again at `Location`.",
6208
+ "content": {
6209
+ "application/json": {
6210
+ "schema": {
6211
+ "$ref": "#/components/schemas/OperationRun"
6212
+ }
6213
+ }
6214
+ },
6215
+ "headers": {
6216
+ "Operation-Run-Id": {
6217
+ "$ref": "#/components/headers/OperationRunId"
6218
+ },
6219
+ "Location": {
6220
+ "$ref": "#/components/headers/Location"
6221
+ },
6222
+ "Idempotent-Replayed": {
6223
+ "$ref": "#/components/headers/IdempotentReplayed"
6224
+ }
6225
+ }
6226
+ },
6227
+ "400": {
6228
+ "$ref": "#/components/responses/BadRequest"
6229
+ },
6230
+ "401": {
6231
+ "$ref": "#/components/responses/Unauthenticated"
6232
+ },
6233
+ "403": {
6234
+ "$ref": "#/components/responses/ForbiddenOrPolicyDeniedOrGuardrailBlockedOrDeclined"
6235
+ },
6236
+ "404": {
6237
+ "$ref": "#/components/responses/NotFound"
6238
+ },
6239
+ "409": {
6240
+ "$ref": "#/components/responses/ConflictOrIdempotencyKeyReusedOrOperationInProgressOrOperationExpiredOrOutputNotRetained"
6241
+ },
6242
+ "422": {
6243
+ "$ref": "#/components/responses/ValidationFailed"
6244
+ },
6245
+ "429": {
6246
+ "$ref": "#/components/responses/RateLimited"
6247
+ },
6248
+ "500": {
6249
+ "$ref": "#/components/responses/Internal"
6250
+ }
6251
+ },
6252
+ "x-catalyst-effect": "changing",
6253
+ "x-catalyst-rate-class": "write"
6254
+ }
6255
+ },
5997
6256
  "/api/v1/connections/{name}/person-context": {
5998
6257
  "get": {
5999
6258
  "operationId": "connections.person_context",
@@ -6921,6 +7180,63 @@
6921
7180
  "authScheme": {
6922
7181
  "type": "string"
6923
7182
  },
7183
+ "credentialModes": {
7184
+ "type": "array",
7185
+ "items": {
7186
+ "type": "string",
7187
+ "enum": [
7188
+ "shared",
7189
+ "user"
7190
+ ]
7191
+ }
7192
+ },
7193
+ "defaultCredentialMode": {
7194
+ "type": "string",
7195
+ "enum": [
7196
+ "shared",
7197
+ "user"
7198
+ ]
7199
+ },
7200
+ "groups": {
7201
+ "type": "array",
7202
+ "items": {
7203
+ "type": "object",
7204
+ "properties": {
7205
+ "id": {
7206
+ "type": "string"
7207
+ },
7208
+ "title": {
7209
+ "anyOf": [
7210
+ {
7211
+ "type": "string"
7212
+ },
7213
+ {
7214
+ "type": "object",
7215
+ "properties": {
7216
+ "en": {
7217
+ "type": "string"
7218
+ },
7219
+ "de": {
7220
+ "type": "string"
7221
+ }
7222
+ }
7223
+ }
7224
+ ]
7225
+ },
7226
+ "scopes": {
7227
+ "type": "array",
7228
+ "items": {
7229
+ "type": "string"
7230
+ }
7231
+ }
7232
+ },
7233
+ "required": [
7234
+ "id",
7235
+ "title",
7236
+ "scopes"
7237
+ ]
7238
+ }
7239
+ },
6924
7240
  "settings": {
6925
7241
  "type": "object",
6926
7242
  "propertyNames": {
@@ -7027,6 +7343,9 @@
7027
7343
  "type": "string"
7028
7344
  }
7029
7345
  },
7346
+ "redirectUri": {
7347
+ "type": "string"
7348
+ },
7030
7349
  "operations": {
7031
7350
  "type": "array",
7032
7351
  "items": {
@@ -7035,6 +7354,9 @@
7035
7354
  "name": {
7036
7355
  "type": "string"
7037
7356
  },
7357
+ "group": {
7358
+ "type": "string"
7359
+ },
7038
7360
  "title": {
7039
7361
  "type": "string"
7040
7362
  },
@@ -24078,6 +24400,138 @@
24078
24400
  "x-catalyst-rate-class": "auth"
24079
24401
  }
24080
24402
  },
24403
+ "/api/v1/me/connections": {
24404
+ "get": {
24405
+ "operationId": "connections.mine",
24406
+ "summary": "List usable personal Connections with only the caller's binding",
24407
+ "tags": [
24408
+ "Connections"
24409
+ ],
24410
+ "security": [
24411
+ {
24412
+ "sessionCookie": [
24413
+ "me:read"
24414
+ ]
24415
+ },
24416
+ {
24417
+ "sessionToken": [
24418
+ "me:read"
24419
+ ]
24420
+ }
24421
+ ],
24422
+ "parameters": [],
24423
+ "responses": {
24424
+ "200": {
24425
+ "description": "The result",
24426
+ "content": {
24427
+ "application/json": {
24428
+ "schema": {
24429
+ "type": "object",
24430
+ "properties": {
24431
+ "connections": {
24432
+ "type": "array",
24433
+ "items": {
24434
+ "type": "object",
24435
+ "properties": {
24436
+ "state": {
24437
+ "type": "string",
24438
+ "enum": [
24439
+ "not_connected",
24440
+ "connected",
24441
+ "needs_reconnect",
24442
+ "revoked"
24443
+ ]
24444
+ },
24445
+ "account": {
24446
+ "type": "string"
24447
+ },
24448
+ "connectedAt": {
24449
+ "$ref": "#/components/schemas/Timestamp"
24450
+ },
24451
+ "lastUsedOn": {
24452
+ "type": "string"
24453
+ },
24454
+ "reason": {
24455
+ "type": "string"
24456
+ },
24457
+ "name": {
24458
+ "type": "string"
24459
+ },
24460
+ "title": {
24461
+ "type": "string"
24462
+ },
24463
+ "service": {
24464
+ "type": "string"
24465
+ },
24466
+ "catalogue": {
24467
+ "type": "object",
24468
+ "properties": {
24469
+ "entry": {
24470
+ "type": "string"
24471
+ },
24472
+ "part": {
24473
+ "type": "string",
24474
+ "enum": [
24475
+ "tools",
24476
+ "source"
24477
+ ]
24478
+ },
24479
+ "version": {
24480
+ "type": "integer",
24481
+ "minimum": -9007199254740991,
24482
+ "maximum": 9007199254740991
24483
+ }
24484
+ },
24485
+ "required": [
24486
+ "entry",
24487
+ "part",
24488
+ "version"
24489
+ ]
24490
+ }
24491
+ },
24492
+ "required": [
24493
+ "state",
24494
+ "name",
24495
+ "title"
24496
+ ]
24497
+ }
24498
+ }
24499
+ },
24500
+ "required": [
24501
+ "connections"
24502
+ ]
24503
+ }
24504
+ }
24505
+ },
24506
+ "headers": {
24507
+ "Operation-Run-Id": {
24508
+ "$ref": "#/components/headers/OperationRunId"
24509
+ }
24510
+ }
24511
+ },
24512
+ "400": {
24513
+ "$ref": "#/components/responses/BadRequest"
24514
+ },
24515
+ "401": {
24516
+ "$ref": "#/components/responses/Unauthenticated"
24517
+ },
24518
+ "403": {
24519
+ "$ref": "#/components/responses/ForbiddenOrPolicyDeniedOrGuardrailBlocked"
24520
+ },
24521
+ "422": {
24522
+ "$ref": "#/components/responses/ValidationFailed"
24523
+ },
24524
+ "429": {
24525
+ "$ref": "#/components/responses/RateLimited"
24526
+ },
24527
+ "500": {
24528
+ "$ref": "#/components/responses/Internal"
24529
+ }
24530
+ },
24531
+ "x-catalyst-effect": "reading",
24532
+ "x-catalyst-rate-class": "read"
24533
+ }
24534
+ },
24081
24535
  "/api/v1/me/model-preference": {
24082
24536
  "get": {
24083
24537
  "operationId": "me.model_preference.get",
@@ -24194,6 +24648,177 @@
24194
24648
  "x-catalyst-rate-class": "write"
24195
24649
  }
24196
24650
  },
24651
+ "/api/v1/me/operation-settings": {
24652
+ "get": {
24653
+ "operationId": "me.operation_settings.list",
24654
+ "summary": "List the signed-in user's own confirmation settings and the operations their agents called lately",
24655
+ "tags": [
24656
+ "Account"
24657
+ ],
24658
+ "security": [
24659
+ {
24660
+ "sessionCookie": [
24661
+ "me:read"
24662
+ ]
24663
+ },
24664
+ {
24665
+ "sessionToken": [
24666
+ "me:read"
24667
+ ]
24668
+ }
24669
+ ],
24670
+ "parameters": [],
24671
+ "responses": {
24672
+ "200": {
24673
+ "description": "The result",
24674
+ "content": {
24675
+ "application/json": {
24676
+ "schema": {
24677
+ "$ref": "#/components/schemas/OperationSettings"
24678
+ }
24679
+ }
24680
+ }
24681
+ },
24682
+ "400": {
24683
+ "$ref": "#/components/responses/BadRequest"
24684
+ },
24685
+ "401": {
24686
+ "$ref": "#/components/responses/Unauthenticated"
24687
+ },
24688
+ "403": {
24689
+ "$ref": "#/components/responses/Forbidden"
24690
+ },
24691
+ "422": {
24692
+ "$ref": "#/components/responses/ValidationFailed"
24693
+ },
24694
+ "429": {
24695
+ "$ref": "#/components/responses/RateLimited"
24696
+ },
24697
+ "500": {
24698
+ "$ref": "#/components/responses/Internal"
24699
+ }
24700
+ },
24701
+ "x-catalyst-effect": "reading",
24702
+ "x-catalyst-rate-class": "read"
24703
+ },
24704
+ "put": {
24705
+ "operationId": "me.operation_settings.set",
24706
+ "summary": "Set the signed-in user's own value for an operation: Always allow, Ask me or Never, or none",
24707
+ "tags": [
24708
+ "Account"
24709
+ ],
24710
+ "security": [
24711
+ {
24712
+ "sessionCookie": [
24713
+ "me:write"
24714
+ ]
24715
+ },
24716
+ {
24717
+ "sessionToken": [
24718
+ "me:write"
24719
+ ]
24720
+ }
24721
+ ],
24722
+ "parameters": [
24723
+ {
24724
+ "name": "Idempotency-Key",
24725
+ "in": "header",
24726
+ "description": "A key the caller chooses for one changing call, up to 255 characters. The same key with the same input answers what the first call answered instead of acting twice. A key belongs to its caller: another caller's same key is another call.",
24727
+ "required": false,
24728
+ "schema": {
24729
+ "type": "string",
24730
+ "minLength": 1,
24731
+ "maxLength": 255
24732
+ }
24733
+ },
24734
+ {
24735
+ "name": "Catalyst-Unattended",
24736
+ "in": "header",
24737
+ "description": "`1` on a call of an API credential when nobody watches its terminal, such as `catalyst <kind> publish --yes`. The call is then not its caller's own confirmation: a call that needs one waits in the caller's Inbox and answers `202` with its run, status `pending_confirmation`. It only ever makes a call stricter; a browser session's call ignores it.",
24738
+ "required": false,
24739
+ "schema": {
24740
+ "type": "string",
24741
+ "minLength": 1,
24742
+ "maxLength": 255
24743
+ }
24744
+ }
24745
+ ],
24746
+ "requestBody": {
24747
+ "required": true,
24748
+ "content": {
24749
+ "application/json": {
24750
+ "schema": {
24751
+ "$ref": "#/components/schemas/SetOperationSettingRequest"
24752
+ }
24753
+ }
24754
+ }
24755
+ },
24756
+ "responses": {
24757
+ "200": {
24758
+ "description": "The result",
24759
+ "content": {
24760
+ "application/json": {
24761
+ "schema": {
24762
+ "$ref": "#/components/schemas/OperationSetting"
24763
+ }
24764
+ }
24765
+ },
24766
+ "headers": {
24767
+ "Operation-Run-Id": {
24768
+ "$ref": "#/components/headers/OperationRunId"
24769
+ },
24770
+ "Idempotent-Replayed": {
24771
+ "$ref": "#/components/headers/IdempotentReplayed"
24772
+ }
24773
+ }
24774
+ },
24775
+ "202": {
24776
+ "description": "The call waits for somebody else to approve it. This is its Operation Run; read it again at `Location`.",
24777
+ "content": {
24778
+ "application/json": {
24779
+ "schema": {
24780
+ "$ref": "#/components/schemas/OperationRun"
24781
+ }
24782
+ }
24783
+ },
24784
+ "headers": {
24785
+ "Operation-Run-Id": {
24786
+ "$ref": "#/components/headers/OperationRunId"
24787
+ },
24788
+ "Location": {
24789
+ "$ref": "#/components/headers/Location"
24790
+ },
24791
+ "Idempotent-Replayed": {
24792
+ "$ref": "#/components/headers/IdempotentReplayed"
24793
+ }
24794
+ }
24795
+ },
24796
+ "400": {
24797
+ "$ref": "#/components/responses/BadRequest"
24798
+ },
24799
+ "401": {
24800
+ "$ref": "#/components/responses/Unauthenticated"
24801
+ },
24802
+ "403": {
24803
+ "$ref": "#/components/responses/ForbiddenOrPolicyDeniedOrGuardrailBlockedOrDeclined"
24804
+ },
24805
+ "409": {
24806
+ "$ref": "#/components/responses/IdempotencyKeyReusedOrOperationInProgressOrOperationExpiredOrOutputNotRetained"
24807
+ },
24808
+ "422": {
24809
+ "$ref": "#/components/responses/ValidationFailed"
24810
+ },
24811
+ "429": {
24812
+ "$ref": "#/components/responses/RateLimited"
24813
+ },
24814
+ "500": {
24815
+ "$ref": "#/components/responses/Internal"
24816
+ }
24817
+ },
24818
+ "x-catalyst-effect": "changing",
24819
+ "x-catalyst-rate-class": "write"
24820
+ }
24821
+ },
24197
24822
  "/api/v1/me/password": {
24198
24823
  "post": {
24199
24824
  "operationId": "me.password.change",
@@ -24816,6 +25441,10 @@
24816
25441
  "type": "string",
24817
25442
  "minLength": 1,
24818
25443
  "maxLength": 500
25444
+ },
25445
+ "alwaysAllow": {
25446
+ "type": "boolean",
25447
+ "const": true
24819
25448
  }
24820
25449
  },
24821
25450
  "required": [
@@ -32375,7 +33004,7 @@
32375
33004
  }
32376
33005
  },
32377
33006
  "ForbiddenOrPolicyDeniedOrGuardrailBlocked": {
32378
- "description": "`FORBIDDEN`: The caller lacks the scope or the right this operation requires. `POLICY_DENIED`: The instance's policy does not allow this operation from here. `details.operation` names it. `details.reason` is `approval_unavailable` where the policy asks for another person's approval and the call cannot wait for one; `details.guardrailId` then names the guardrail that asked for it, where one did. It is `workflow_deleted` where a step of a run of a published Workflow needs the confirmation its publish gave, and the Workflow was deleted since. It is `approval_stale` where a call that waited can no longer be approved because what it is about changed or a newer call replaced it. It is `confirmation_required` where a subagent made a call that needs a person's confirmation or approval: a subagent never waits for one, and the agent that started it makes the call instead. `GUARDRAIL_BLOCKED`: A guardrail refused the call. `details.guardrailId` names it.",
33007
+ "description": "`FORBIDDEN`: The caller lacks the scope or the right this operation requires. `POLICY_DENIED`: The instance's policy does not allow this operation from here. `details.operation` names it. `details.reason` is `approval_unavailable` where the policy asks for another person's approval and the call cannot wait for one; `details.guardrailId` then names the guardrail that asked for it, where one did. It is `workflow_deleted` where a step of a run of a published Workflow needs the confirmation its publish gave, and the Workflow was deleted since. It is `approval_stale` where a call that waited can no longer be approved because what it is about changed or a newer call replaced it. It is `confirmation_required` where a subagent made a call that needs a person's confirmation or approval: a subagent never waits for one, and the agent that started it makes the call instead. `GUARDRAIL_BLOCKED`: A guardrail refused the call. `details.guardrailId` names it. `details.reason` is `check_unavailable` where a check could not answer, by an error or a timeout; `details.guardrailId` then names the event that was checked.",
32379
33008
  "content": {
32380
33009
  "application/json": {
32381
33010
  "schema": {
@@ -32395,7 +33024,7 @@
32395
33024
  }
32396
33025
  },
32397
33026
  "ForbiddenOrPolicyDeniedOrGuardrailBlockedOrDeclined": {
32398
- "description": "`FORBIDDEN`: The caller lacks the scope or the right this operation requires. `POLICY_DENIED`: The instance's policy does not allow this operation from here. `details.operation` names it. `details.reason` is `approval_unavailable` where the policy asks for another person's approval and the call cannot wait for one; `details.guardrailId` then names the guardrail that asked for it, where one did. It is `workflow_deleted` where a step of a run of a published Workflow needs the confirmation its publish gave, and the Workflow was deleted since. It is `approval_stale` where a call that waited can no longer be approved because what it is about changed or a newer call replaced it. It is `confirmation_required` where a subagent made a call that needs a person's confirmation or approval: a subagent never waits for one, and the agent that started it makes the call instead. `GUARDRAIL_BLOCKED`: A guardrail refused the call. `details.guardrailId` names it. `DECLINED`: The person asked to approve the call declined it. `details.by` names them, `details.comment` holds their reason where they gave one.",
33027
+ "description": "`FORBIDDEN`: The caller lacks the scope or the right this operation requires. `POLICY_DENIED`: The instance's policy does not allow this operation from here. `details.operation` names it. `details.reason` is `approval_unavailable` where the policy asks for another person's approval and the call cannot wait for one; `details.guardrailId` then names the guardrail that asked for it, where one did. It is `workflow_deleted` where a step of a run of a published Workflow needs the confirmation its publish gave, and the Workflow was deleted since. It is `approval_stale` where a call that waited can no longer be approved because what it is about changed or a newer call replaced it. It is `confirmation_required` where a subagent made a call that needs a person's confirmation or approval: a subagent never waits for one, and the agent that started it makes the call instead. `GUARDRAIL_BLOCKED`: A guardrail refused the call. `details.guardrailId` names it. `details.reason` is `check_unavailable` where a check could not answer, by an error or a timeout; `details.guardrailId` then names the event that was checked. `DECLINED`: The person asked to approve the call declined it. `details.by` names them, `details.comment` holds their reason where they gave one.",
32399
33028
  "content": {
32400
33029
  "application/json": {
32401
33030
  "schema": {
@@ -33158,6 +33787,58 @@
33158
33787
  "type": "string",
33159
33788
  "const": "subject_conversation_shared"
33160
33789
  },
33790
+ "connect": {
33791
+ "type": "object",
33792
+ "properties": {
33793
+ "connection": {
33794
+ "type": "object",
33795
+ "properties": {
33796
+ "name": {
33797
+ "type": "string"
33798
+ },
33799
+ "title": {
33800
+ "type": "string"
33801
+ },
33802
+ "service": {
33803
+ "type": "string"
33804
+ },
33805
+ "catalogue": {
33806
+ "type": "object",
33807
+ "properties": {
33808
+ "entry": {
33809
+ "type": "string"
33810
+ },
33811
+ "part": {
33812
+ "type": "string"
33813
+ }
33814
+ },
33815
+ "required": [
33816
+ "entry",
33817
+ "part"
33818
+ ]
33819
+ }
33820
+ },
33821
+ "required": [
33822
+ "name",
33823
+ "title"
33824
+ ]
33825
+ },
33826
+ "state": {
33827
+ "type": "string",
33828
+ "enum": [
33829
+ "not_connected",
33830
+ "needs_reconnect"
33831
+ ]
33832
+ },
33833
+ "agentName": {
33834
+ "type": "string"
33835
+ }
33836
+ },
33837
+ "required": [
33838
+ "connection",
33839
+ "state"
33840
+ ]
33841
+ },
33161
33842
  "decision": {
33162
33843
  "type": "object",
33163
33844
  "properties": {
@@ -33175,6 +33856,10 @@
33175
33856
  },
33176
33857
  "inputPreview": {},
33177
33858
  "simulation": {},
33859
+ "alwaysAllow": {
33860
+ "type": "boolean",
33861
+ "const": true
33862
+ },
33178
33863
  "expiresAt": {
33179
33864
  "$ref": "#/components/schemas/Timestamp"
33180
33865
  }
@@ -33329,6 +34014,58 @@
33329
34014
  "type": "string",
33330
34015
  "const": "subject_conversation_shared"
33331
34016
  },
34017
+ "connect": {
34018
+ "type": "object",
34019
+ "properties": {
34020
+ "connection": {
34021
+ "type": "object",
34022
+ "properties": {
34023
+ "name": {
34024
+ "type": "string"
34025
+ },
34026
+ "title": {
34027
+ "type": "string"
34028
+ },
34029
+ "service": {
34030
+ "type": "string"
34031
+ },
34032
+ "catalogue": {
34033
+ "type": "object",
34034
+ "properties": {
34035
+ "entry": {
34036
+ "type": "string"
34037
+ },
34038
+ "part": {
34039
+ "type": "string"
34040
+ }
34041
+ },
34042
+ "required": [
34043
+ "entry",
34044
+ "part"
34045
+ ]
34046
+ }
34047
+ },
34048
+ "required": [
34049
+ "name",
34050
+ "title"
34051
+ ]
34052
+ },
34053
+ "state": {
34054
+ "type": "string",
34055
+ "enum": [
34056
+ "not_connected",
34057
+ "needs_reconnect"
34058
+ ]
34059
+ },
34060
+ "agentName": {
34061
+ "type": "string"
34062
+ }
34063
+ },
34064
+ "required": [
34065
+ "connection",
34066
+ "state"
34067
+ ]
34068
+ },
33332
34069
  "decision": {
33333
34070
  "type": "object",
33334
34071
  "properties": {
@@ -33346,6 +34083,10 @@
33346
34083
  },
33347
34084
  "inputPreview": {},
33348
34085
  "simulation": {},
34086
+ "alwaysAllow": {
34087
+ "type": "boolean",
34088
+ "const": true
34089
+ },
33349
34090
  "expiresAt": {
33350
34091
  "$ref": "#/components/schemas/Timestamp"
33351
34092
  }
@@ -33738,6 +34479,10 @@
33738
34479
  },
33739
34480
  "inputPreview": {},
33740
34481
  "simulation": {},
34482
+ "alwaysAllow": {
34483
+ "type": "boolean",
34484
+ "const": true
34485
+ },
33741
34486
  "expiresAt": {
33742
34487
  "$ref": "#/components/schemas/Timestamp"
33743
34488
  }
@@ -35980,6 +36725,28 @@
35980
36725
  "$ref": "#/components/schemas/WorkflowStepFact"
35981
36726
  }
35982
36727
  },
36728
+ "workflowCallers": {
36729
+ "type": "array",
36730
+ "items": {
36731
+ "type": "object",
36732
+ "properties": {
36733
+ "name": {
36734
+ "type": "string"
36735
+ },
36736
+ "title": {
36737
+ "type": "string"
36738
+ },
36739
+ "scope": {
36740
+ "$ref": "#/components/schemas/AssetScope"
36741
+ }
36742
+ },
36743
+ "required": [
36744
+ "name",
36745
+ "title",
36746
+ "scope"
36747
+ ]
36748
+ }
36749
+ },
35983
36750
  "publishQuestion": {
35984
36751
  "type": "array",
35985
36752
  "items": {
@@ -37036,6 +37803,9 @@
37036
37803
  "type": "string"
37037
37804
  },
37038
37805
  "additionalProperties": {}
37806
+ },
37807
+ "about": {
37808
+ "$ref": "#/components/schemas/AuditSubject"
37039
37809
  }
37040
37810
  },
37041
37811
  "required": [
@@ -37047,6 +37817,23 @@
37047
37817
  "createdAt"
37048
37818
  ]
37049
37819
  },
37820
+ "AuditSubject": {
37821
+ "type": "object",
37822
+ "properties": {
37823
+ "kind": {
37824
+ "type": "string"
37825
+ },
37826
+ "title": {
37827
+ "type": "string"
37828
+ },
37829
+ "builtInRole": {
37830
+ "type": "string"
37831
+ }
37832
+ },
37833
+ "required": [
37834
+ "kind"
37835
+ ]
37836
+ },
37050
37837
  "AuthPrincipal": {
37051
37838
  "type": "object",
37052
37839
  "properties": {
@@ -38199,6 +38986,9 @@
38199
38986
  },
38200
38987
  "subject": {
38201
38988
  "$ref": "#/components/schemas/ConversationSubject"
38989
+ },
38990
+ "creationTarget": {
38991
+ "$ref": "#/components/schemas/ConversationCreationTarget"
38202
38992
  }
38203
38993
  },
38204
38994
  "required": [
@@ -38215,6 +39005,10 @@
38215
39005
  "retainedUntil"
38216
39006
  ]
38217
39007
  },
39008
+ "ConversationCreationTarget": {
39009
+ "type": "string",
39010
+ "const": "instance"
39011
+ },
38218
39012
  "ConversationFollowUp": {
38219
39013
  "type": "object",
38220
39014
  "properties": {
@@ -38335,6 +39129,9 @@
38335
39129
  "subject": {
38336
39130
  "$ref": "#/components/schemas/ConversationSubject"
38337
39131
  },
39132
+ "creationTarget": {
39133
+ "$ref": "#/components/schemas/ConversationCreationTarget"
39134
+ },
38338
39135
  "latestMessageAt": {
38339
39136
  "$ref": "#/components/schemas/Timestamp"
38340
39137
  },
@@ -38728,6 +39525,9 @@
38728
39525
  "ConversationThreadSnapshot": {
38729
39526
  "type": "object",
38730
39527
  "properties": {
39528
+ "personalData": {
39529
+ "type": "boolean"
39530
+ },
38731
39531
  "followUps": {
38732
39532
  "type": "array",
38733
39533
  "items": {
@@ -39052,6 +39852,9 @@
39052
39852
  },
39053
39853
  "subject": {
39054
39854
  "$ref": "#/components/schemas/ConversationSubject"
39855
+ },
39856
+ "creationTarget": {
39857
+ "$ref": "#/components/schemas/ConversationCreationTarget"
39055
39858
  }
39056
39859
  }
39057
39860
  },
@@ -39218,6 +40021,10 @@
39218
40021
  },
39219
40022
  "comment": {
39220
40023
  "type": "string"
40024
+ },
40025
+ "alwaysAllow": {
40026
+ "type": "boolean",
40027
+ "const": true
39221
40028
  }
39222
40029
  },
39223
40030
  "required": [
@@ -40115,11 +40922,7 @@
40115
40922
  "type": "boolean"
40116
40923
  },
40117
40924
  "region": {
40118
- "type": "string",
40119
- "enum": [
40120
- "eu",
40121
- "global"
40122
- ]
40925
+ "$ref": "#/components/schemas/ModelRegion"
40123
40926
  },
40124
40927
  "endpointHost": {
40125
40928
  "type": "string"
@@ -40637,10 +41440,8 @@
40637
41440
  },
40638
41441
  "ModelRegion": {
40639
41442
  "type": "string",
40640
- "enum": [
40641
- "eu",
40642
- "global"
40643
- ]
41443
+ "minLength": 1,
41444
+ "maxLength": 32
40644
41445
  },
40645
41446
  "ModelUsageAttributionGroup": {
40646
41447
  "type": "object",
@@ -42032,6 +42833,64 @@
42032
42833
  "expired"
42033
42834
  ]
42034
42835
  },
42836
+ "OperationSetting": {
42837
+ "type": "object",
42838
+ "properties": {
42839
+ "operation": {
42840
+ "type": "string"
42841
+ },
42842
+ "title": {
42843
+ "type": "string"
42844
+ },
42845
+ "effect": {
42846
+ "type": "string",
42847
+ "enum": [
42848
+ "reading",
42849
+ "changing"
42850
+ ]
42851
+ },
42852
+ "changeClass": {
42853
+ "type": "string",
42854
+ "enum": [
42855
+ "reversible",
42856
+ "irreversible",
42857
+ "outward"
42858
+ ]
42859
+ },
42860
+ "value": {
42861
+ "$ref": "#/components/schemas/PersonPolicySetting"
42862
+ },
42863
+ "mayAlwaysAllow": {
42864
+ "type": "boolean"
42865
+ },
42866
+ "alwaysAllowLocked": {
42867
+ "type": "boolean",
42868
+ "const": true
42869
+ },
42870
+ "updatedAt": {
42871
+ "$ref": "#/components/schemas/Timestamp"
42872
+ }
42873
+ },
42874
+ "required": [
42875
+ "operation",
42876
+ "effect",
42877
+ "mayAlwaysAllow"
42878
+ ]
42879
+ },
42880
+ "OperationSettings": {
42881
+ "type": "object",
42882
+ "properties": {
42883
+ "items": {
42884
+ "type": "array",
42885
+ "items": {
42886
+ "$ref": "#/components/schemas/OperationSetting"
42887
+ }
42888
+ }
42889
+ },
42890
+ "required": [
42891
+ "items"
42892
+ ]
42893
+ },
42035
42894
  "OperationTarget": {
42036
42895
  "type": "string",
42037
42896
  "enum": [
@@ -42395,6 +43254,14 @@
42395
43254
  "createdAt"
42396
43255
  ]
42397
43256
  },
43257
+ "PersonPolicySetting": {
43258
+ "type": "string",
43259
+ "enum": [
43260
+ "always_allow",
43261
+ "ask",
43262
+ "never"
43263
+ ]
43264
+ },
42398
43265
  "PersonalApiKey": {
42399
43266
  "type": "object",
42400
43267
  "properties": {
@@ -44342,6 +45209,30 @@
44342
45209
  "version"
44343
45210
  ]
44344
45211
  },
45212
+ "SetOperationSettingRequest": {
45213
+ "type": "object",
45214
+ "properties": {
45215
+ "operation": {
45216
+ "type": "string",
45217
+ "minLength": 1,
45218
+ "maxLength": 300
45219
+ },
45220
+ "value": {
45221
+ "anyOf": [
45222
+ {
45223
+ "$ref": "#/components/schemas/PersonPolicySetting"
45224
+ },
45225
+ {
45226
+ "type": "null"
45227
+ }
45228
+ ]
45229
+ }
45230
+ },
45231
+ "required": [
45232
+ "operation",
45233
+ "value"
45234
+ ]
45235
+ },
44345
45236
  "StartConnectCodeRequest": {
44346
45237
  "type": "object",
44347
45238
  "properties": {
@@ -45426,6 +46317,14 @@
45426
46317
  "ValidateAssetRequest": {
45427
46318
  "type": "object",
45428
46319
  "properties": {
46320
+ "files": {
46321
+ "minItems": 1,
46322
+ "maxItems": 500,
46323
+ "type": "array",
46324
+ "items": {
46325
+ "$ref": "#/components/schemas/AssetFileInput"
46326
+ }
46327
+ },
45429
46328
  "availability": {
45430
46329
  "$ref": "#/components/schemas/AgentAvailability"
45431
46330
  },
@@ -45526,6 +46425,7 @@
45526
46425
  "data_store",
45527
46426
  "knowledge_base",
45528
46427
  "workflow",
46428
+ "mail_sender",
45529
46429
  "other"
45530
46430
  ]
45531
46431
  },
@@ -45540,6 +46440,43 @@
45540
46440
  "kind"
45541
46441
  ]
45542
46442
  },
46443
+ "mailSender": {
46444
+ "type": "object",
46445
+ "properties": {
46446
+ "sender": {
46447
+ "type": "string",
46448
+ "minLength": 1
46449
+ },
46450
+ "title": {
46451
+ "type": "string",
46452
+ "minLength": 1
46453
+ },
46454
+ "icon": {
46455
+ "type": "string",
46456
+ "minLength": 1
46457
+ },
46458
+ "address": {
46459
+ "type": "string",
46460
+ "maxLength": 254,
46461
+ "format": "email",
46462
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
46463
+ },
46464
+ "recipientDomains": {
46465
+ "type": "array",
46466
+ "items": {
46467
+ "type": "string",
46468
+ "maxLength": 254
46469
+ }
46470
+ }
46471
+ },
46472
+ "required": [
46473
+ "sender",
46474
+ "title",
46475
+ "icon",
46476
+ "address",
46477
+ "recipientDomains"
46478
+ ]
46479
+ },
45543
46480
  "title": {
45544
46481
  "type": "string"
45545
46482
  },
@@ -45589,6 +46526,7 @@
45589
46526
  "data_store",
45590
46527
  "knowledge_base",
45591
46528
  "workflow",
46529
+ "mail_sender",
45592
46530
  "other"
45593
46531
  ]
45594
46532
  },
@@ -45603,6 +46541,43 @@
45603
46541
  "kind"
45604
46542
  ]
45605
46543
  },
46544
+ "mailSender": {
46545
+ "type": "object",
46546
+ "properties": {
46547
+ "sender": {
46548
+ "type": "string",
46549
+ "minLength": 1
46550
+ },
46551
+ "title": {
46552
+ "type": "string",
46553
+ "minLength": 1
46554
+ },
46555
+ "icon": {
46556
+ "type": "string",
46557
+ "minLength": 1
46558
+ },
46559
+ "address": {
46560
+ "type": "string",
46561
+ "maxLength": 254,
46562
+ "format": "email",
46563
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
46564
+ },
46565
+ "recipientDomains": {
46566
+ "type": "array",
46567
+ "items": {
46568
+ "type": "string",
46569
+ "maxLength": 254
46570
+ }
46571
+ }
46572
+ },
46573
+ "required": [
46574
+ "sender",
46575
+ "title",
46576
+ "icon",
46577
+ "address",
46578
+ "recipientDomains"
46579
+ ]
46580
+ },
45606
46581
  "title": {
45607
46582
  "type": "string"
45608
46583
  },