@botpress/api 0.69.0 → 0.70.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/index.js +1135 -13
  2. package/dist/src/gen/state.d.ts +1049 -6
  3. package/package.json +1 -1
  4. package/src/gen/metadata.json +1 -1
  5. package/src/gen/openapi.json +1 -1
  6. package/src/gen/state.ts +1135 -13
package/dist/index.js CHANGED
@@ -290807,11 +290807,1135 @@ var state = {
290807
290807
  },
290808
290808
  "parameters": {}
290809
290809
  },
290810
+ "validateIntegrationCreation": {
290811
+ "name": "validateIntegrationCreation",
290812
+ "description": "Perform a validation of an integration creation request",
290813
+ "method": "post",
290814
+ "section": "integration",
290815
+ "path": "/v1/admin/integrations/validate",
290816
+ "requestBody": {
290817
+ "description": "Integration",
290818
+ "schema": {
290819
+ "type": "object",
290820
+ "properties": {
290821
+ "name": {
290822
+ "type": "string",
290823
+ "maxLength": 200,
290824
+ "description": "Name of the [Integration](#schema_integration)"
290825
+ },
290826
+ "version": {
290827
+ "type": "string",
290828
+ "maxLength": 200,
290829
+ "description": "Version of the [Integration](#schema_integration)"
290830
+ },
290831
+ "configuration": {
290832
+ "type": "object",
290833
+ "properties": {
290834
+ "title": {
290835
+ "type": "string",
290836
+ "maxLength": 64,
290837
+ "description": "Title of the configuration"
290838
+ },
290839
+ "description": {
290840
+ "type": "string",
290841
+ "maxLength": 256,
290842
+ "description": "Description of the configuration"
290843
+ },
290844
+ "schema": {
290845
+ "type": "object",
290846
+ "additionalProperties": true,
290847
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
290848
+ },
290849
+ "identifier": {
290850
+ "type": "object",
290851
+ "properties": {
290852
+ "required": {
290853
+ "type": "boolean"
290854
+ },
290855
+ "linkTemplateScript": {
290856
+ "type": "string",
290857
+ "maxLength": 2e3
290858
+ }
290859
+ },
290860
+ "additionalProperties": false
290861
+ }
290862
+ },
290863
+ "description": "Default configuration definition of the integration",
290864
+ "additionalProperties": false
290865
+ },
290866
+ "configurations": {
290867
+ "type": "object",
290868
+ "additionalProperties": {
290869
+ "type": "object",
290870
+ "properties": {
290871
+ "title": {
290872
+ "type": "string",
290873
+ "maxLength": 64,
290874
+ "description": "Title of the configuration"
290875
+ },
290876
+ "description": {
290877
+ "type": "string",
290878
+ "maxLength": 256,
290879
+ "description": "Description of the configuration"
290880
+ },
290881
+ "schema": {
290882
+ "type": "object",
290883
+ "additionalProperties": true,
290884
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
290885
+ },
290886
+ "identifier": {
290887
+ "type": "object",
290888
+ "properties": {
290889
+ "required": {
290890
+ "type": "boolean"
290891
+ },
290892
+ "linkTemplateScript": {
290893
+ "type": "string",
290894
+ "maxLength": 2e3
290895
+ }
290896
+ },
290897
+ "additionalProperties": false
290898
+ }
290899
+ },
290900
+ "additionalProperties": false
290901
+ },
290902
+ "description": "Additional configuration definitions of the integration"
290903
+ },
290904
+ "states": {
290905
+ "type": "object",
290906
+ "additionalProperties": {
290907
+ "type": "object",
290908
+ "properties": {
290909
+ "type": {
290910
+ "type": "string",
290911
+ "enum": [
290912
+ "conversation",
290913
+ "user",
290914
+ "integration"
290915
+ ],
290916
+ "description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
290917
+ },
290918
+ "schema": {
290919
+ "type": "object",
290920
+ "additionalProperties": true,
290921
+ "description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
290922
+ }
290923
+ },
290924
+ "required": [
290925
+ "type",
290926
+ "schema"
290927
+ ],
290928
+ "description": "State definition",
290929
+ "additionalProperties": false
290930
+ }
290931
+ },
290932
+ "events": {
290933
+ "type": "object",
290934
+ "additionalProperties": {
290935
+ "type": "object",
290936
+ "properties": {
290937
+ "title": {
290938
+ "type": "string",
290939
+ "maxLength": 64,
290940
+ "description": "Title of the event"
290941
+ },
290942
+ "description": {
290943
+ "type": "string",
290944
+ "maxLength": 256,
290945
+ "description": "Description of the event"
290946
+ },
290947
+ "schema": {
290948
+ "type": "object",
290949
+ "additionalProperties": true
290950
+ }
290951
+ },
290952
+ "required": [
290953
+ "schema"
290954
+ ],
290955
+ "description": "Event Definition",
290956
+ "additionalProperties": false
290957
+ }
290958
+ },
290959
+ "actions": {
290960
+ "type": "object",
290961
+ "additionalProperties": {
290962
+ "type": "object",
290963
+ "properties": {
290964
+ "title": {
290965
+ "type": "string",
290966
+ "maxLength": 64,
290967
+ "description": "Title of the action"
290968
+ },
290969
+ "description": {
290970
+ "type": "string",
290971
+ "maxLength": 256,
290972
+ "description": "Description of the action"
290973
+ },
290974
+ "billable": {
290975
+ "type": "boolean"
290976
+ },
290977
+ "cacheable": {
290978
+ "type": "boolean"
290979
+ },
290980
+ "input": {
290981
+ "type": "object",
290982
+ "properties": {
290983
+ "schema": {
290984
+ "type": "object",
290985
+ "additionalProperties": true
290986
+ }
290987
+ },
290988
+ "required": [
290989
+ "schema"
290990
+ ],
290991
+ "additionalProperties": false
290992
+ },
290993
+ "output": {
290994
+ "type": "object",
290995
+ "properties": {
290996
+ "schema": {
290997
+ "type": "object",
290998
+ "additionalProperties": true
290999
+ }
291000
+ },
291001
+ "required": [
291002
+ "schema"
291003
+ ],
291004
+ "additionalProperties": false
291005
+ }
291006
+ },
291007
+ "required": [
291008
+ "input",
291009
+ "output"
291010
+ ],
291011
+ "description": "Action definition",
291012
+ "additionalProperties": false
291013
+ }
291014
+ },
291015
+ "entities": {
291016
+ "type": "object",
291017
+ "additionalProperties": {
291018
+ "type": "object",
291019
+ "properties": {
291020
+ "title": {
291021
+ "type": "string",
291022
+ "maxLength": 64,
291023
+ "description": "Title of the entity"
291024
+ },
291025
+ "description": {
291026
+ "type": "string",
291027
+ "maxLength": 256,
291028
+ "description": "Description of the entity"
291029
+ },
291030
+ "schema": {
291031
+ "type": "object",
291032
+ "additionalProperties": true
291033
+ }
291034
+ },
291035
+ "required": [
291036
+ "schema"
291037
+ ],
291038
+ "description": "Entity definition",
291039
+ "additionalProperties": false
291040
+ }
291041
+ },
291042
+ "identifier": {
291043
+ "type": "object",
291044
+ "properties": {
291045
+ "fallbackHandlerScript": {
291046
+ "type": "string",
291047
+ "maxLength": 2e3
291048
+ },
291049
+ "extractScript": {
291050
+ "type": "string",
291051
+ "maxLength": 2e3
291052
+ }
291053
+ },
291054
+ "additionalProperties": false
291055
+ },
291056
+ "channels": {
291057
+ "type": "object",
291058
+ "additionalProperties": {
291059
+ "type": "object",
291060
+ "properties": {
291061
+ "title": {
291062
+ "type": "string",
291063
+ "maxLength": 64,
291064
+ "description": "Title of the channel"
291065
+ },
291066
+ "description": {
291067
+ "type": "string",
291068
+ "maxLength": 256,
291069
+ "description": "Description of the channel"
291070
+ },
291071
+ "messages": {
291072
+ "type": "object",
291073
+ "additionalProperties": {
291074
+ "type": "object",
291075
+ "properties": {
291076
+ "schema": {
291077
+ "type": "object",
291078
+ "additionalProperties": true
291079
+ }
291080
+ },
291081
+ "required": [
291082
+ "schema"
291083
+ ],
291084
+ "description": "Message definition",
291085
+ "additionalProperties": false
291086
+ }
291087
+ },
291088
+ "conversation": {
291089
+ "type": "object",
291090
+ "properties": {
291091
+ "creation": {
291092
+ "type": "object",
291093
+ "properties": {
291094
+ "enabled": {
291095
+ "type": "boolean",
291096
+ "description": "Enable conversation creation"
291097
+ },
291098
+ "requiredTags": {
291099
+ "type": "array",
291100
+ "items": {
291101
+ "type": "string"
291102
+ },
291103
+ "description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
291104
+ }
291105
+ },
291106
+ "required": [
291107
+ "enabled",
291108
+ "requiredTags"
291109
+ ],
291110
+ "description": "The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.",
291111
+ "additionalProperties": false
291112
+ },
291113
+ "tags": {
291114
+ "type": "object",
291115
+ "additionalProperties": {
291116
+ "type": "object",
291117
+ "properties": {
291118
+ "title": {
291119
+ "type": "string",
291120
+ "maxLength": 64,
291121
+ "description": "Title of the tag"
291122
+ },
291123
+ "description": {
291124
+ "type": "string",
291125
+ "maxLength": 256,
291126
+ "description": "Description of the tag"
291127
+ }
291128
+ },
291129
+ "description": "Definition of a tag that can be provided on the object",
291130
+ "additionalProperties": false
291131
+ }
291132
+ }
291133
+ },
291134
+ "additionalProperties": false
291135
+ },
291136
+ "message": {
291137
+ "type": "object",
291138
+ "properties": {
291139
+ "tags": {
291140
+ "type": "object",
291141
+ "additionalProperties": {
291142
+ "type": "object",
291143
+ "properties": {
291144
+ "title": {
291145
+ "type": "string",
291146
+ "maxLength": 64,
291147
+ "description": "Title of the tag"
291148
+ },
291149
+ "description": {
291150
+ "type": "string",
291151
+ "maxLength": 256,
291152
+ "description": "Description of the tag"
291153
+ }
291154
+ },
291155
+ "description": "Definition of a tag that can be provided on the object",
291156
+ "additionalProperties": false
291157
+ }
291158
+ }
291159
+ },
291160
+ "additionalProperties": false
291161
+ }
291162
+ },
291163
+ "required": [
291164
+ "messages"
291165
+ ],
291166
+ "additionalProperties": false
291167
+ }
291168
+ },
291169
+ "user": {
291170
+ "type": "object",
291171
+ "properties": {
291172
+ "creation": {
291173
+ "type": "object",
291174
+ "properties": {
291175
+ "enabled": {
291176
+ "type": "boolean",
291177
+ "description": "Enable user creation"
291178
+ },
291179
+ "requiredTags": {
291180
+ "type": "array",
291181
+ "items": {
291182
+ "type": "string"
291183
+ },
291184
+ "description": "The list of tags that are required to be specified when calling the API directly to create a user."
291185
+ }
291186
+ },
291187
+ "required": [
291188
+ "enabled",
291189
+ "requiredTags"
291190
+ ],
291191
+ "description": "The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.",
291192
+ "additionalProperties": false
291193
+ },
291194
+ "tags": {
291195
+ "type": "object",
291196
+ "additionalProperties": {
291197
+ "type": "object",
291198
+ "properties": {
291199
+ "title": {
291200
+ "type": "string",
291201
+ "maxLength": 64,
291202
+ "description": "Title of the tag"
291203
+ },
291204
+ "description": {
291205
+ "type": "string",
291206
+ "maxLength": 256,
291207
+ "description": "Description of the tag"
291208
+ }
291209
+ },
291210
+ "description": "Definition of a tag that can be provided on the object",
291211
+ "additionalProperties": false
291212
+ }
291213
+ }
291214
+ },
291215
+ "additionalProperties": false
291216
+ },
291217
+ "interfaces": {
291218
+ "type": "object",
291219
+ "additionalProperties": {
291220
+ "type": "object",
291221
+ "properties": {
291222
+ "id": {
291223
+ "type": "string",
291224
+ "minLength": 28,
291225
+ "maxLength": 36,
291226
+ "description": "ID of the interface"
291227
+ },
291228
+ "entities": {
291229
+ "type": "object",
291230
+ "additionalProperties": {
291231
+ "type": "object",
291232
+ "properties": {
291233
+ "name": {
291234
+ "type": "string",
291235
+ "maxLength": 200
291236
+ }
291237
+ },
291238
+ "required": [
291239
+ "name"
291240
+ ],
291241
+ "additionalProperties": false
291242
+ }
291243
+ },
291244
+ "actions": {
291245
+ "type": "object",
291246
+ "additionalProperties": {
291247
+ "type": "object",
291248
+ "properties": {
291249
+ "name": {
291250
+ "type": "string",
291251
+ "maxLength": 200
291252
+ }
291253
+ },
291254
+ "required": [
291255
+ "name"
291256
+ ],
291257
+ "additionalProperties": false
291258
+ }
291259
+ },
291260
+ "events": {
291261
+ "type": "object",
291262
+ "additionalProperties": {
291263
+ "type": "object",
291264
+ "properties": {
291265
+ "name": {
291266
+ "type": "string",
291267
+ "maxLength": 200
291268
+ }
291269
+ },
291270
+ "required": [
291271
+ "name"
291272
+ ],
291273
+ "additionalProperties": false
291274
+ }
291275
+ },
291276
+ "channels": {
291277
+ "type": "object",
291278
+ "additionalProperties": {
291279
+ "type": "object",
291280
+ "properties": {
291281
+ "name": {
291282
+ "type": "string",
291283
+ "maxLength": 200
291284
+ }
291285
+ },
291286
+ "required": [
291287
+ "name"
291288
+ ],
291289
+ "additionalProperties": false
291290
+ }
291291
+ }
291292
+ },
291293
+ "required": [
291294
+ "id"
291295
+ ],
291296
+ "additionalProperties": false
291297
+ }
291298
+ },
291299
+ "secrets": {
291300
+ "type": "object",
291301
+ "additionalProperties": {
291302
+ "type": "string",
291303
+ "maxLength": 2e4
291304
+ },
291305
+ "description": "Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing."
291306
+ },
291307
+ "code": {
291308
+ "type": "string",
291309
+ "description": "JavaScript code of the integration"
291310
+ },
291311
+ "url": {
291312
+ "type": "string",
291313
+ "description": "URL of the integration"
291314
+ },
291315
+ "dev": {
291316
+ "type": "boolean",
291317
+ "description": "Indicates if the integration is a development integration; Dev integrations run locally"
291318
+ },
291319
+ "icon": {
291320
+ "type": "string",
291321
+ "description": "Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes."
291322
+ },
291323
+ "readme": {
291324
+ "type": "string",
291325
+ "description": "Base64 encoded markdown of the integration readme. The readme is specific to each integration versions."
291326
+ },
291327
+ "title": {
291328
+ "type": "string",
291329
+ "minLength": 1,
291330
+ "maxLength": 64,
291331
+ "description": "Title of the integration. This is the name that will be displayed in the UI"
291332
+ },
291333
+ "description": {
291334
+ "type": "string",
291335
+ "maxLength": 256,
291336
+ "description": "Description of the integration. This is the description that will be displayed in the UI"
291337
+ },
291338
+ "public": {
291339
+ "type": "boolean",
291340
+ "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
291341
+ },
291342
+ "layers": {
291343
+ "type": "array",
291344
+ "items": {
291345
+ "type": "string"
291346
+ }
291347
+ }
291348
+ },
291349
+ "required": [
291350
+ "name",
291351
+ "version"
291352
+ ],
291353
+ "title": "validateIntegrationCreationBody",
291354
+ "additionalProperties": false
291355
+ }
291356
+ },
291357
+ "response": {
291358
+ "description": "Validation succeeded: the integration can be created using the same parameters",
291359
+ "schema": {
291360
+ "type": "object",
291361
+ "title": "validateIntegrationCreationResponse",
291362
+ "additionalProperties": false
291363
+ }
291364
+ },
291365
+ "parameters": {}
291366
+ },
290810
291367
  "updateIntegration": {
290811
291368
  "name": "updateIntegration",
290812
291369
  "description": "Update integration",
290813
291370
  "method": "put",
290814
- "path": "/v1/admin/integrations/{id}",
291371
+ "path": "/v1/admin/integrations/{id}",
291372
+ "section": "integration",
291373
+ "parameters": {
291374
+ "id": {
291375
+ "type": "string",
291376
+ "description": "Integration ID",
291377
+ "in": "path"
291378
+ }
291379
+ },
291380
+ "requestBody": {
291381
+ "description": "Integration",
291382
+ "schema": {
291383
+ "type": "object",
291384
+ "properties": {
291385
+ "configuration": {
291386
+ "type": "object",
291387
+ "properties": {
291388
+ "title": {
291389
+ "type": "string",
291390
+ "maxLength": 64,
291391
+ "description": "Title of the configuration"
291392
+ },
291393
+ "description": {
291394
+ "type": "string",
291395
+ "maxLength": 256,
291396
+ "description": "Description of the configuration"
291397
+ },
291398
+ "schema": {
291399
+ "type": "object",
291400
+ "additionalProperties": true,
291401
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
291402
+ },
291403
+ "identifier": {
291404
+ "type": "object",
291405
+ "properties": {
291406
+ "linkTemplateScript": {
291407
+ "type": "string",
291408
+ "maxLength": 2e3,
291409
+ "nullable": true
291410
+ },
291411
+ "required": {
291412
+ "type": "boolean"
291413
+ }
291414
+ },
291415
+ "additionalProperties": false
291416
+ }
291417
+ },
291418
+ "description": "Default configuration definition of the integration",
291419
+ "additionalProperties": false
291420
+ },
291421
+ "configurations": {
291422
+ "type": "object",
291423
+ "additionalProperties": {
291424
+ "type": "object",
291425
+ "properties": {
291426
+ "title": {
291427
+ "type": "string",
291428
+ "maxLength": 64,
291429
+ "description": "Title of the configuration"
291430
+ },
291431
+ "description": {
291432
+ "type": "string",
291433
+ "maxLength": 256,
291434
+ "description": "Description of the configuration"
291435
+ },
291436
+ "schema": {
291437
+ "type": "object",
291438
+ "additionalProperties": true,
291439
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
291440
+ },
291441
+ "identifier": {
291442
+ "type": "object",
291443
+ "properties": {
291444
+ "linkTemplateScript": {
291445
+ "type": "string",
291446
+ "maxLength": 2e3,
291447
+ "nullable": true
291448
+ },
291449
+ "required": {
291450
+ "type": "boolean"
291451
+ }
291452
+ },
291453
+ "additionalProperties": false
291454
+ }
291455
+ },
291456
+ "nullable": true,
291457
+ "additionalProperties": false
291458
+ },
291459
+ "description": "Additional configuration definitions of the integration"
291460
+ },
291461
+ "channels": {
291462
+ "type": "object",
291463
+ "additionalProperties": {
291464
+ "type": "object",
291465
+ "properties": {
291466
+ "title": {
291467
+ "type": "string",
291468
+ "maxLength": 64,
291469
+ "description": "Title of the channel"
291470
+ },
291471
+ "description": {
291472
+ "type": "string",
291473
+ "maxLength": 256,
291474
+ "description": "Description of the channel"
291475
+ },
291476
+ "messages": {
291477
+ "type": "object",
291478
+ "additionalProperties": {
291479
+ "type": "object",
291480
+ "properties": {
291481
+ "schema": {
291482
+ "type": "object",
291483
+ "additionalProperties": true
291484
+ }
291485
+ },
291486
+ "required": [
291487
+ "schema"
291488
+ ],
291489
+ "description": "Message definition",
291490
+ "nullable": true,
291491
+ "additionalProperties": false
291492
+ }
291493
+ },
291494
+ "conversation": {
291495
+ "type": "object",
291496
+ "properties": {
291497
+ "creation": {
291498
+ "type": "object",
291499
+ "properties": {
291500
+ "enabled": {
291501
+ "type": "boolean",
291502
+ "description": "Enable conversation creation"
291503
+ },
291504
+ "requiredTags": {
291505
+ "type": "array",
291506
+ "items": {
291507
+ "type": "string"
291508
+ },
291509
+ "description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
291510
+ }
291511
+ },
291512
+ "required": [
291513
+ "enabled",
291514
+ "requiredTags"
291515
+ ],
291516
+ "description": "The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.",
291517
+ "additionalProperties": false
291518
+ },
291519
+ "tags": {
291520
+ "type": "object",
291521
+ "additionalProperties": {
291522
+ "type": "object",
291523
+ "properties": {
291524
+ "title": {
291525
+ "type": "string",
291526
+ "maxLength": 64,
291527
+ "description": "Title of the tag"
291528
+ },
291529
+ "description": {
291530
+ "type": "string",
291531
+ "maxLength": 256,
291532
+ "description": "Description of the tag"
291533
+ }
291534
+ },
291535
+ "description": "Definition of a tag that can be provided on the object",
291536
+ "nullable": true,
291537
+ "additionalProperties": false
291538
+ }
291539
+ }
291540
+ },
291541
+ "additionalProperties": false
291542
+ },
291543
+ "message": {
291544
+ "type": "object",
291545
+ "properties": {
291546
+ "tags": {
291547
+ "type": "object",
291548
+ "additionalProperties": {
291549
+ "type": "object",
291550
+ "properties": {
291551
+ "title": {
291552
+ "type": "string",
291553
+ "maxLength": 64,
291554
+ "description": "Title of the tag"
291555
+ },
291556
+ "description": {
291557
+ "type": "string",
291558
+ "maxLength": 256,
291559
+ "description": "Description of the tag"
291560
+ }
291561
+ },
291562
+ "description": "Definition of a tag that can be provided on the object",
291563
+ "nullable": true,
291564
+ "additionalProperties": false
291565
+ }
291566
+ }
291567
+ },
291568
+ "additionalProperties": false
291569
+ }
291570
+ },
291571
+ "nullable": true,
291572
+ "additionalProperties": false
291573
+ }
291574
+ },
291575
+ "identifier": {
291576
+ "type": "object",
291577
+ "properties": {
291578
+ "extractScript": {
291579
+ "type": "string",
291580
+ "maxLength": 2e3,
291581
+ "nullable": true
291582
+ },
291583
+ "fallbackHandlerScript": {
291584
+ "type": "string",
291585
+ "maxLength": 2e3,
291586
+ "nullable": true
291587
+ }
291588
+ },
291589
+ "additionalProperties": false
291590
+ },
291591
+ "actions": {
291592
+ "type": "object",
291593
+ "additionalProperties": {
291594
+ "type": "object",
291595
+ "properties": {
291596
+ "title": {
291597
+ "type": "string",
291598
+ "maxLength": 64,
291599
+ "description": "Title of the action"
291600
+ },
291601
+ "description": {
291602
+ "type": "string",
291603
+ "maxLength": 256,
291604
+ "description": "Description of the action"
291605
+ },
291606
+ "billable": {
291607
+ "type": "boolean"
291608
+ },
291609
+ "cacheable": {
291610
+ "type": "boolean"
291611
+ },
291612
+ "input": {
291613
+ "type": "object",
291614
+ "properties": {
291615
+ "schema": {
291616
+ "type": "object",
291617
+ "additionalProperties": true
291618
+ }
291619
+ },
291620
+ "required": [
291621
+ "schema"
291622
+ ],
291623
+ "additionalProperties": false
291624
+ },
291625
+ "output": {
291626
+ "type": "object",
291627
+ "properties": {
291628
+ "schema": {
291629
+ "type": "object",
291630
+ "additionalProperties": true
291631
+ }
291632
+ },
291633
+ "required": [
291634
+ "schema"
291635
+ ],
291636
+ "additionalProperties": false
291637
+ }
291638
+ },
291639
+ "required": [
291640
+ "input",
291641
+ "output"
291642
+ ],
291643
+ "description": "Action definition",
291644
+ "nullable": true,
291645
+ "additionalProperties": false
291646
+ }
291647
+ },
291648
+ "events": {
291649
+ "type": "object",
291650
+ "additionalProperties": {
291651
+ "type": "object",
291652
+ "properties": {
291653
+ "title": {
291654
+ "type": "string",
291655
+ "maxLength": 64,
291656
+ "description": "Title of the event"
291657
+ },
291658
+ "description": {
291659
+ "type": "string",
291660
+ "maxLength": 256,
291661
+ "description": "Description of the event"
291662
+ },
291663
+ "schema": {
291664
+ "type": "object",
291665
+ "additionalProperties": true
291666
+ }
291667
+ },
291668
+ "required": [
291669
+ "schema"
291670
+ ],
291671
+ "description": "Event Definition",
291672
+ "nullable": true,
291673
+ "additionalProperties": false
291674
+ }
291675
+ },
291676
+ "states": {
291677
+ "type": "object",
291678
+ "additionalProperties": {
291679
+ "type": "object",
291680
+ "properties": {
291681
+ "type": {
291682
+ "type": "string",
291683
+ "enum": [
291684
+ "conversation",
291685
+ "user",
291686
+ "integration"
291687
+ ],
291688
+ "description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
291689
+ },
291690
+ "schema": {
291691
+ "type": "object",
291692
+ "additionalProperties": true,
291693
+ "description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
291694
+ }
291695
+ },
291696
+ "required": [
291697
+ "type",
291698
+ "schema"
291699
+ ],
291700
+ "description": "State definition",
291701
+ "nullable": true,
291702
+ "additionalProperties": false
291703
+ }
291704
+ },
291705
+ "user": {
291706
+ "type": "object",
291707
+ "properties": {
291708
+ "creation": {
291709
+ "type": "object",
291710
+ "properties": {
291711
+ "enabled": {
291712
+ "type": "boolean",
291713
+ "description": "Enable user creation"
291714
+ },
291715
+ "requiredTags": {
291716
+ "type": "array",
291717
+ "items": {
291718
+ "type": "string"
291719
+ },
291720
+ "description": "The list of tags that are required to be specified when calling the API directly to create a user."
291721
+ }
291722
+ },
291723
+ "required": [
291724
+ "enabled",
291725
+ "requiredTags"
291726
+ ],
291727
+ "description": "The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.",
291728
+ "additionalProperties": false
291729
+ },
291730
+ "tags": {
291731
+ "type": "object",
291732
+ "additionalProperties": {
291733
+ "type": "object",
291734
+ "properties": {
291735
+ "title": {
291736
+ "type": "string",
291737
+ "maxLength": 64,
291738
+ "description": "Title of the tag"
291739
+ },
291740
+ "description": {
291741
+ "type": "string",
291742
+ "maxLength": 256,
291743
+ "description": "Description of the tag"
291744
+ }
291745
+ },
291746
+ "description": "Definition of a tag that can be provided on the object",
291747
+ "nullable": true,
291748
+ "additionalProperties": false
291749
+ }
291750
+ }
291751
+ },
291752
+ "additionalProperties": false
291753
+ },
291754
+ "entities": {
291755
+ "type": "object",
291756
+ "additionalProperties": {
291757
+ "type": "object",
291758
+ "properties": {
291759
+ "title": {
291760
+ "type": "string",
291761
+ "maxLength": 64,
291762
+ "description": "Title of the entity"
291763
+ },
291764
+ "description": {
291765
+ "type": "string",
291766
+ "maxLength": 256,
291767
+ "description": "Description of the entity"
291768
+ },
291769
+ "schema": {
291770
+ "type": "object",
291771
+ "additionalProperties": true
291772
+ }
291773
+ },
291774
+ "required": [
291775
+ "schema"
291776
+ ],
291777
+ "description": "Entity definition",
291778
+ "nullable": true,
291779
+ "additionalProperties": false
291780
+ }
291781
+ },
291782
+ "interfaces": {
291783
+ "type": "object",
291784
+ "additionalProperties": {
291785
+ "type": "object",
291786
+ "properties": {
291787
+ "id": {
291788
+ "type": "string",
291789
+ "minLength": 28,
291790
+ "maxLength": 36,
291791
+ "description": "ID of the interface"
291792
+ },
291793
+ "entities": {
291794
+ "type": "object",
291795
+ "additionalProperties": {
291796
+ "type": "object",
291797
+ "properties": {
291798
+ "name": {
291799
+ "type": "string",
291800
+ "maxLength": 200
291801
+ }
291802
+ },
291803
+ "required": [
291804
+ "name"
291805
+ ],
291806
+ "additionalProperties": false
291807
+ }
291808
+ },
291809
+ "actions": {
291810
+ "type": "object",
291811
+ "additionalProperties": {
291812
+ "type": "object",
291813
+ "properties": {
291814
+ "name": {
291815
+ "type": "string",
291816
+ "maxLength": 200
291817
+ }
291818
+ },
291819
+ "required": [
291820
+ "name"
291821
+ ],
291822
+ "additionalProperties": false
291823
+ }
291824
+ },
291825
+ "events": {
291826
+ "type": "object",
291827
+ "additionalProperties": {
291828
+ "type": "object",
291829
+ "properties": {
291830
+ "name": {
291831
+ "type": "string",
291832
+ "maxLength": 200
291833
+ }
291834
+ },
291835
+ "required": [
291836
+ "name"
291837
+ ],
291838
+ "additionalProperties": false
291839
+ }
291840
+ },
291841
+ "channels": {
291842
+ "type": "object",
291843
+ "additionalProperties": {
291844
+ "type": "object",
291845
+ "properties": {
291846
+ "name": {
291847
+ "type": "string",
291848
+ "maxLength": 200
291849
+ }
291850
+ },
291851
+ "required": [
291852
+ "name"
291853
+ ],
291854
+ "additionalProperties": false
291855
+ }
291856
+ }
291857
+ },
291858
+ "required": [
291859
+ "id"
291860
+ ],
291861
+ "nullable": true,
291862
+ "additionalProperties": false
291863
+ }
291864
+ },
291865
+ "secrets": {
291866
+ "type": "object",
291867
+ "additionalProperties": {
291868
+ "type": "string",
291869
+ "maxLength": 2e4,
291870
+ "nullable": true
291871
+ },
291872
+ "description": "Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing."
291873
+ },
291874
+ "code": {
291875
+ "type": "string",
291876
+ "description": "JavaScript code of the integration"
291877
+ },
291878
+ "icon": {
291879
+ "type": "string",
291880
+ "description": "Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes."
291881
+ },
291882
+ "readme": {
291883
+ "type": "string",
291884
+ "description": "Base64 encoded markdown of the integration readme. The readme is specific to each integration versions."
291885
+ },
291886
+ "title": {
291887
+ "type": "string",
291888
+ "minLength": 1,
291889
+ "maxLength": 64,
291890
+ "description": "Title of the integration. This is the name that will be displayed in the UI"
291891
+ },
291892
+ "description": {
291893
+ "type": "string",
291894
+ "maxLength": 256,
291895
+ "description": "Description of the integration. This is the description that will be displayed in the UI"
291896
+ },
291897
+ "url": {
291898
+ "type": "string",
291899
+ "description": "URL of the integration",
291900
+ "nullable": true
291901
+ },
291902
+ "public": {
291903
+ "type": "boolean",
291904
+ "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
291905
+ },
291906
+ "layers": {
291907
+ "type": "array",
291908
+ "items": {
291909
+ "type": "string"
291910
+ }
291911
+ }
291912
+ },
291913
+ "title": "updateIntegrationBody",
291914
+ "additionalProperties": false
291915
+ }
291916
+ },
291917
+ "response": {
291918
+ "description": "Success",
291919
+ "schema": {
291920
+ "type": "object",
291921
+ "properties": {
291922
+ "integration": {
291923
+ "$ref": "#/components/schemas/Integration"
291924
+ }
291925
+ },
291926
+ "required": [
291927
+ "integration"
291928
+ ],
291929
+ "title": "updateIntegrationResponse",
291930
+ "additionalProperties": false
291931
+ }
291932
+ }
291933
+ },
291934
+ "validateIntegrationUpdate": {
291935
+ "name": "validateIntegrationUpdate",
291936
+ "description": "Perform a validation of an integration update request",
291937
+ "method": "put",
291938
+ "path": "/v1/admin/integrations/{id}/validate",
290815
291939
  "section": "integration",
290816
291940
  "parameters": {
290817
291941
  "id": {
@@ -291353,23 +292477,15 @@ var state = {
291353
292477
  }
291354
292478
  }
291355
292479
  },
291356
- "title": "updateIntegrationBody",
292480
+ "title": "validateIntegrationUpdateBody",
291357
292481
  "additionalProperties": false
291358
292482
  }
291359
292483
  },
291360
292484
  "response": {
291361
- "description": "Success",
292485
+ "description": "Validation succeeded: the integration can be updated using the same parameters",
291362
292486
  "schema": {
291363
292487
  "type": "object",
291364
- "properties": {
291365
- "integration": {
291366
- "$ref": "#/components/schemas/Integration"
291367
- }
291368
- },
291369
- "required": [
291370
- "integration"
291371
- ],
291372
- "title": "updateIntegrationResponse",
292488
+ "title": "validateIntegrationUpdateResponse",
291373
292489
  "additionalProperties": false
291374
292490
  }
291375
292491
  }
@@ -296152,7 +297268,7 @@ var state = {
296152
297268
  "title": "Botpress API",
296153
297269
  "description": "API for Botpress Cloud",
296154
297270
  "server": "https://api.botpress.cloud",
296155
- "version": "0.69.0",
297271
+ "version": "0.70.0",
296156
297272
  "prefix": "v1"
296157
297273
  },
296158
297274
  "errors": [
@@ -296320,7 +297436,9 @@ var state = {
296320
297436
  "updateWorkspaceMemberBody": true,
296321
297437
  "createIntegrationApiKeyBody": true,
296322
297438
  "createIntegrationBody": true,
297439
+ "validateIntegrationCreationBody": true,
296323
297440
  "updateIntegrationBody": true,
297441
+ "validateIntegrationUpdateBody": true,
296324
297442
  "requestIntegrationVerificationBody": true,
296325
297443
  "createInterfaceBody": true,
296326
297444
  "updateInterfaceBody": true,
@@ -296443,7 +297561,9 @@ var state = {
296443
297561
  "createIntegrationApiKeyResponse": true,
296444
297562
  "deleteIntegrationApiKeyResponse": true,
296445
297563
  "createIntegrationResponse": true,
297564
+ "validateIntegrationCreationResponse": true,
296446
297565
  "updateIntegrationResponse": true,
297566
+ "validateIntegrationUpdateResponse": true,
296447
297567
  "listIntegrationsResponse": true,
296448
297568
  "getIntegrationResponse": true,
296449
297569
  "getIntegrationLogsResponse": true,
@@ -299856,7 +300976,9 @@ var state = {
299856
300976
  "createIntegrationApiKey",
299857
300977
  "deleteIntegrationApiKey",
299858
300978
  "createIntegration",
300979
+ "validateIntegrationCreation",
299859
300980
  "updateIntegration",
300981
+ "validateIntegrationUpdate",
299860
300982
  "listIntegrations",
299861
300983
  "getIntegration",
299862
300984
  "getIntegrationLogs",