@botpress/api 0.69.0 → 0.70.1

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 +1195 -54
  2. package/dist/src/gen/state.d.ts +1111 -50
  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 +1195 -54
package/dist/index.js CHANGED
@@ -287305,6 +287305,17 @@ var state = {
287305
287305
  "type": "boolean",
287306
287306
  "required": false
287307
287307
  },
287308
+ "tags": {
287309
+ "in": "query",
287310
+ "type": "object",
287311
+ "schema": {
287312
+ "type": "object",
287313
+ "additionalProperties": {
287314
+ "type": "string"
287315
+ }
287316
+ },
287317
+ "description": "Filter by tags"
287318
+ },
287308
287319
  "nextToken": {
287309
287320
  "in": "query",
287310
287321
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
@@ -287362,13 +287373,21 @@ var state = {
287362
287373
  "deployedAt": {
287363
287374
  "type": "string",
287364
287375
  "format": "date-time"
287376
+ },
287377
+ "tags": {
287378
+ "type": "object",
287379
+ "additionalProperties": {
287380
+ "type": "string"
287381
+ },
287382
+ "description": "Tags of [Bot](#schema_bot)"
287365
287383
  }
287366
287384
  },
287367
287385
  "required": [
287368
287386
  "id",
287369
287387
  "createdAt",
287370
287388
  "updatedAt",
287371
- "name"
287389
+ "name",
287390
+ "tags"
287372
287391
  ]
287373
287392
  }
287374
287393
  },
@@ -290807,24 +290826,27 @@ var state = {
290807
290826
  },
290808
290827
  "parameters": {}
290809
290828
  },
290810
- "updateIntegration": {
290811
- "name": "updateIntegration",
290812
- "description": "Update integration",
290813
- "method": "put",
290814
- "path": "/v1/admin/integrations/{id}",
290829
+ "validateIntegrationCreation": {
290830
+ "name": "validateIntegrationCreation",
290831
+ "description": "Perform a validation of an integration creation request",
290832
+ "method": "post",
290815
290833
  "section": "integration",
290816
- "parameters": {
290817
- "id": {
290818
- "type": "string",
290819
- "description": "Integration ID",
290820
- "in": "path"
290821
- }
290822
- },
290834
+ "path": "/v1/admin/integrations/validate",
290823
290835
  "requestBody": {
290824
290836
  "description": "Integration",
290825
290837
  "schema": {
290826
290838
  "type": "object",
290827
290839
  "properties": {
290840
+ "name": {
290841
+ "type": "string",
290842
+ "maxLength": 200,
290843
+ "description": "Name of the [Integration](#schema_integration)"
290844
+ },
290845
+ "version": {
290846
+ "type": "string",
290847
+ "maxLength": 200,
290848
+ "description": "Version of the [Integration](#schema_integration)"
290849
+ },
290828
290850
  "configuration": {
290829
290851
  "type": "object",
290830
290852
  "properties": {
@@ -290846,13 +290868,12 @@ var state = {
290846
290868
  "identifier": {
290847
290869
  "type": "object",
290848
290870
  "properties": {
290849
- "linkTemplateScript": {
290850
- "type": "string",
290851
- "maxLength": 2e3,
290852
- "nullable": true
290853
- },
290854
290871
  "required": {
290855
290872
  "type": "boolean"
290873
+ },
290874
+ "linkTemplateScript": {
290875
+ "type": "string",
290876
+ "maxLength": 2e3
290856
290877
  }
290857
290878
  },
290858
290879
  "additionalProperties": false
@@ -290884,23 +290905,173 @@ var state = {
290884
290905
  "identifier": {
290885
290906
  "type": "object",
290886
290907
  "properties": {
290887
- "linkTemplateScript": {
290888
- "type": "string",
290889
- "maxLength": 2e3,
290890
- "nullable": true
290891
- },
290892
290908
  "required": {
290893
290909
  "type": "boolean"
290910
+ },
290911
+ "linkTemplateScript": {
290912
+ "type": "string",
290913
+ "maxLength": 2e3
290894
290914
  }
290895
290915
  },
290896
290916
  "additionalProperties": false
290897
290917
  }
290898
290918
  },
290899
- "nullable": true,
290900
290919
  "additionalProperties": false
290901
290920
  },
290902
290921
  "description": "Additional configuration definitions of the integration"
290903
290922
  },
290923
+ "states": {
290924
+ "type": "object",
290925
+ "additionalProperties": {
290926
+ "type": "object",
290927
+ "properties": {
290928
+ "type": {
290929
+ "type": "string",
290930
+ "enum": [
290931
+ "conversation",
290932
+ "user",
290933
+ "integration"
290934
+ ],
290935
+ "description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
290936
+ },
290937
+ "schema": {
290938
+ "type": "object",
290939
+ "additionalProperties": true,
290940
+ "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."
290941
+ }
290942
+ },
290943
+ "required": [
290944
+ "type",
290945
+ "schema"
290946
+ ],
290947
+ "description": "State definition",
290948
+ "additionalProperties": false
290949
+ }
290950
+ },
290951
+ "events": {
290952
+ "type": "object",
290953
+ "additionalProperties": {
290954
+ "type": "object",
290955
+ "properties": {
290956
+ "title": {
290957
+ "type": "string",
290958
+ "maxLength": 64,
290959
+ "description": "Title of the event"
290960
+ },
290961
+ "description": {
290962
+ "type": "string",
290963
+ "maxLength": 256,
290964
+ "description": "Description of the event"
290965
+ },
290966
+ "schema": {
290967
+ "type": "object",
290968
+ "additionalProperties": true
290969
+ }
290970
+ },
290971
+ "required": [
290972
+ "schema"
290973
+ ],
290974
+ "description": "Event Definition",
290975
+ "additionalProperties": false
290976
+ }
290977
+ },
290978
+ "actions": {
290979
+ "type": "object",
290980
+ "additionalProperties": {
290981
+ "type": "object",
290982
+ "properties": {
290983
+ "title": {
290984
+ "type": "string",
290985
+ "maxLength": 64,
290986
+ "description": "Title of the action"
290987
+ },
290988
+ "description": {
290989
+ "type": "string",
290990
+ "maxLength": 256,
290991
+ "description": "Description of the action"
290992
+ },
290993
+ "billable": {
290994
+ "type": "boolean"
290995
+ },
290996
+ "cacheable": {
290997
+ "type": "boolean"
290998
+ },
290999
+ "input": {
291000
+ "type": "object",
291001
+ "properties": {
291002
+ "schema": {
291003
+ "type": "object",
291004
+ "additionalProperties": true
291005
+ }
291006
+ },
291007
+ "required": [
291008
+ "schema"
291009
+ ],
291010
+ "additionalProperties": false
291011
+ },
291012
+ "output": {
291013
+ "type": "object",
291014
+ "properties": {
291015
+ "schema": {
291016
+ "type": "object",
291017
+ "additionalProperties": true
291018
+ }
291019
+ },
291020
+ "required": [
291021
+ "schema"
291022
+ ],
291023
+ "additionalProperties": false
291024
+ }
291025
+ },
291026
+ "required": [
291027
+ "input",
291028
+ "output"
291029
+ ],
291030
+ "description": "Action definition",
291031
+ "additionalProperties": false
291032
+ }
291033
+ },
291034
+ "entities": {
291035
+ "type": "object",
291036
+ "additionalProperties": {
291037
+ "type": "object",
291038
+ "properties": {
291039
+ "title": {
291040
+ "type": "string",
291041
+ "maxLength": 64,
291042
+ "description": "Title of the entity"
291043
+ },
291044
+ "description": {
291045
+ "type": "string",
291046
+ "maxLength": 256,
291047
+ "description": "Description of the entity"
291048
+ },
291049
+ "schema": {
291050
+ "type": "object",
291051
+ "additionalProperties": true
291052
+ }
291053
+ },
291054
+ "required": [
291055
+ "schema"
291056
+ ],
291057
+ "description": "Entity definition",
291058
+ "additionalProperties": false
291059
+ }
291060
+ },
291061
+ "identifier": {
291062
+ "type": "object",
291063
+ "properties": {
291064
+ "fallbackHandlerScript": {
291065
+ "type": "string",
291066
+ "maxLength": 2e3
291067
+ },
291068
+ "extractScript": {
291069
+ "type": "string",
291070
+ "maxLength": 2e3
291071
+ }
291072
+ },
291073
+ "additionalProperties": false
291074
+ },
290904
291075
  "channels": {
290905
291076
  "type": "object",
290906
291077
  "additionalProperties": {
@@ -290930,7 +291101,6 @@ var state = {
290930
291101
  "schema"
290931
291102
  ],
290932
291103
  "description": "Message definition",
290933
- "nullable": true,
290934
291104
  "additionalProperties": false
290935
291105
  }
290936
291106
  },
@@ -290976,7 +291146,6 @@ var state = {
290976
291146
  }
290977
291147
  },
290978
291148
  "description": "Definition of a tag that can be provided on the object",
290979
- "nullable": true,
290980
291149
  "additionalProperties": false
290981
291150
  }
290982
291151
  }
@@ -291003,7 +291172,6 @@ var state = {
291003
291172
  }
291004
291173
  },
291005
291174
  "description": "Definition of a tag that can be provided on the object",
291006
- "nullable": true,
291007
291175
  "additionalProperties": false
291008
291176
  }
291009
291177
  }
@@ -291011,27 +291179,1002 @@ var state = {
291011
291179
  "additionalProperties": false
291012
291180
  }
291013
291181
  },
291014
- "nullable": true,
291182
+ "required": [
291183
+ "messages"
291184
+ ],
291015
291185
  "additionalProperties": false
291016
291186
  }
291017
291187
  },
291018
- "identifier": {
291188
+ "user": {
291019
291189
  "type": "object",
291020
291190
  "properties": {
291021
- "extractScript": {
291022
- "type": "string",
291023
- "maxLength": 2e3,
291024
- "nullable": true
291191
+ "creation": {
291192
+ "type": "object",
291193
+ "properties": {
291194
+ "enabled": {
291195
+ "type": "boolean",
291196
+ "description": "Enable user creation"
291197
+ },
291198
+ "requiredTags": {
291199
+ "type": "array",
291200
+ "items": {
291201
+ "type": "string"
291202
+ },
291203
+ "description": "The list of tags that are required to be specified when calling the API directly to create a user."
291204
+ }
291205
+ },
291206
+ "required": [
291207
+ "enabled",
291208
+ "requiredTags"
291209
+ ],
291210
+ "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.",
291211
+ "additionalProperties": false
291025
291212
  },
291026
- "fallbackHandlerScript": {
291027
- "type": "string",
291028
- "maxLength": 2e3,
291029
- "nullable": true
291030
- }
291031
- },
291032
- "additionalProperties": false
291033
- },
291034
- "actions": {
291213
+ "tags": {
291214
+ "type": "object",
291215
+ "additionalProperties": {
291216
+ "type": "object",
291217
+ "properties": {
291218
+ "title": {
291219
+ "type": "string",
291220
+ "maxLength": 64,
291221
+ "description": "Title of the tag"
291222
+ },
291223
+ "description": {
291224
+ "type": "string",
291225
+ "maxLength": 256,
291226
+ "description": "Description of the tag"
291227
+ }
291228
+ },
291229
+ "description": "Definition of a tag that can be provided on the object",
291230
+ "additionalProperties": false
291231
+ }
291232
+ }
291233
+ },
291234
+ "additionalProperties": false
291235
+ },
291236
+ "interfaces": {
291237
+ "type": "object",
291238
+ "additionalProperties": {
291239
+ "type": "object",
291240
+ "properties": {
291241
+ "id": {
291242
+ "type": "string",
291243
+ "minLength": 28,
291244
+ "maxLength": 36,
291245
+ "description": "ID of the interface"
291246
+ },
291247
+ "entities": {
291248
+ "type": "object",
291249
+ "additionalProperties": {
291250
+ "type": "object",
291251
+ "properties": {
291252
+ "name": {
291253
+ "type": "string",
291254
+ "maxLength": 200
291255
+ }
291256
+ },
291257
+ "required": [
291258
+ "name"
291259
+ ],
291260
+ "additionalProperties": false
291261
+ }
291262
+ },
291263
+ "actions": {
291264
+ "type": "object",
291265
+ "additionalProperties": {
291266
+ "type": "object",
291267
+ "properties": {
291268
+ "name": {
291269
+ "type": "string",
291270
+ "maxLength": 200
291271
+ }
291272
+ },
291273
+ "required": [
291274
+ "name"
291275
+ ],
291276
+ "additionalProperties": false
291277
+ }
291278
+ },
291279
+ "events": {
291280
+ "type": "object",
291281
+ "additionalProperties": {
291282
+ "type": "object",
291283
+ "properties": {
291284
+ "name": {
291285
+ "type": "string",
291286
+ "maxLength": 200
291287
+ }
291288
+ },
291289
+ "required": [
291290
+ "name"
291291
+ ],
291292
+ "additionalProperties": false
291293
+ }
291294
+ },
291295
+ "channels": {
291296
+ "type": "object",
291297
+ "additionalProperties": {
291298
+ "type": "object",
291299
+ "properties": {
291300
+ "name": {
291301
+ "type": "string",
291302
+ "maxLength": 200
291303
+ }
291304
+ },
291305
+ "required": [
291306
+ "name"
291307
+ ],
291308
+ "additionalProperties": false
291309
+ }
291310
+ }
291311
+ },
291312
+ "required": [
291313
+ "id"
291314
+ ],
291315
+ "additionalProperties": false
291316
+ }
291317
+ },
291318
+ "secrets": {
291319
+ "type": "object",
291320
+ "additionalProperties": {
291321
+ "type": "string",
291322
+ "maxLength": 2e4
291323
+ },
291324
+ "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."
291325
+ },
291326
+ "code": {
291327
+ "type": "string",
291328
+ "description": "JavaScript code of the integration"
291329
+ },
291330
+ "url": {
291331
+ "type": "string",
291332
+ "description": "URL of the integration"
291333
+ },
291334
+ "dev": {
291335
+ "type": "boolean",
291336
+ "description": "Indicates if the integration is a development integration; Dev integrations run locally"
291337
+ },
291338
+ "icon": {
291339
+ "type": "string",
291340
+ "description": "Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes."
291341
+ },
291342
+ "readme": {
291343
+ "type": "string",
291344
+ "description": "Base64 encoded markdown of the integration readme. The readme is specific to each integration versions."
291345
+ },
291346
+ "title": {
291347
+ "type": "string",
291348
+ "minLength": 1,
291349
+ "maxLength": 64,
291350
+ "description": "Title of the integration. This is the name that will be displayed in the UI"
291351
+ },
291352
+ "description": {
291353
+ "type": "string",
291354
+ "maxLength": 256,
291355
+ "description": "Description of the integration. This is the description that will be displayed in the UI"
291356
+ },
291357
+ "public": {
291358
+ "type": "boolean",
291359
+ "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
291360
+ },
291361
+ "layers": {
291362
+ "type": "array",
291363
+ "items": {
291364
+ "type": "string"
291365
+ }
291366
+ }
291367
+ },
291368
+ "required": [
291369
+ "name",
291370
+ "version"
291371
+ ],
291372
+ "title": "validateIntegrationCreationBody",
291373
+ "additionalProperties": false
291374
+ }
291375
+ },
291376
+ "response": {
291377
+ "description": "Validation succeeded: the integration can be created using the same parameters",
291378
+ "schema": {
291379
+ "type": "object",
291380
+ "title": "validateIntegrationCreationResponse",
291381
+ "additionalProperties": false
291382
+ }
291383
+ },
291384
+ "parameters": {}
291385
+ },
291386
+ "updateIntegration": {
291387
+ "name": "updateIntegration",
291388
+ "description": "Update integration",
291389
+ "method": "put",
291390
+ "path": "/v1/admin/integrations/{id}",
291391
+ "section": "integration",
291392
+ "parameters": {
291393
+ "id": {
291394
+ "type": "string",
291395
+ "description": "Integration ID",
291396
+ "in": "path"
291397
+ }
291398
+ },
291399
+ "requestBody": {
291400
+ "description": "Integration",
291401
+ "schema": {
291402
+ "type": "object",
291403
+ "properties": {
291404
+ "configuration": {
291405
+ "type": "object",
291406
+ "properties": {
291407
+ "title": {
291408
+ "type": "string",
291409
+ "maxLength": 64,
291410
+ "description": "Title of the configuration"
291411
+ },
291412
+ "description": {
291413
+ "type": "string",
291414
+ "maxLength": 256,
291415
+ "description": "Description of the configuration"
291416
+ },
291417
+ "schema": {
291418
+ "type": "object",
291419
+ "additionalProperties": true,
291420
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
291421
+ },
291422
+ "identifier": {
291423
+ "type": "object",
291424
+ "properties": {
291425
+ "linkTemplateScript": {
291426
+ "type": "string",
291427
+ "maxLength": 2e3,
291428
+ "nullable": true
291429
+ },
291430
+ "required": {
291431
+ "type": "boolean"
291432
+ }
291433
+ },
291434
+ "additionalProperties": false
291435
+ }
291436
+ },
291437
+ "description": "Default configuration definition of the integration",
291438
+ "additionalProperties": false
291439
+ },
291440
+ "configurations": {
291441
+ "type": "object",
291442
+ "additionalProperties": {
291443
+ "type": "object",
291444
+ "properties": {
291445
+ "title": {
291446
+ "type": "string",
291447
+ "maxLength": 64,
291448
+ "description": "Title of the configuration"
291449
+ },
291450
+ "description": {
291451
+ "type": "string",
291452
+ "maxLength": 256,
291453
+ "description": "Description of the configuration"
291454
+ },
291455
+ "schema": {
291456
+ "type": "object",
291457
+ "additionalProperties": true,
291458
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
291459
+ },
291460
+ "identifier": {
291461
+ "type": "object",
291462
+ "properties": {
291463
+ "linkTemplateScript": {
291464
+ "type": "string",
291465
+ "maxLength": 2e3,
291466
+ "nullable": true
291467
+ },
291468
+ "required": {
291469
+ "type": "boolean"
291470
+ }
291471
+ },
291472
+ "additionalProperties": false
291473
+ }
291474
+ },
291475
+ "nullable": true,
291476
+ "additionalProperties": false
291477
+ },
291478
+ "description": "Additional configuration definitions of the integration"
291479
+ },
291480
+ "channels": {
291481
+ "type": "object",
291482
+ "additionalProperties": {
291483
+ "type": "object",
291484
+ "properties": {
291485
+ "title": {
291486
+ "type": "string",
291487
+ "maxLength": 64,
291488
+ "description": "Title of the channel"
291489
+ },
291490
+ "description": {
291491
+ "type": "string",
291492
+ "maxLength": 256,
291493
+ "description": "Description of the channel"
291494
+ },
291495
+ "messages": {
291496
+ "type": "object",
291497
+ "additionalProperties": {
291498
+ "type": "object",
291499
+ "properties": {
291500
+ "schema": {
291501
+ "type": "object",
291502
+ "additionalProperties": true
291503
+ }
291504
+ },
291505
+ "required": [
291506
+ "schema"
291507
+ ],
291508
+ "description": "Message definition",
291509
+ "nullable": true,
291510
+ "additionalProperties": false
291511
+ }
291512
+ },
291513
+ "conversation": {
291514
+ "type": "object",
291515
+ "properties": {
291516
+ "creation": {
291517
+ "type": "object",
291518
+ "properties": {
291519
+ "enabled": {
291520
+ "type": "boolean",
291521
+ "description": "Enable conversation creation"
291522
+ },
291523
+ "requiredTags": {
291524
+ "type": "array",
291525
+ "items": {
291526
+ "type": "string"
291527
+ },
291528
+ "description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
291529
+ }
291530
+ },
291531
+ "required": [
291532
+ "enabled",
291533
+ "requiredTags"
291534
+ ],
291535
+ "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.",
291536
+ "additionalProperties": false
291537
+ },
291538
+ "tags": {
291539
+ "type": "object",
291540
+ "additionalProperties": {
291541
+ "type": "object",
291542
+ "properties": {
291543
+ "title": {
291544
+ "type": "string",
291545
+ "maxLength": 64,
291546
+ "description": "Title of the tag"
291547
+ },
291548
+ "description": {
291549
+ "type": "string",
291550
+ "maxLength": 256,
291551
+ "description": "Description of the tag"
291552
+ }
291553
+ },
291554
+ "description": "Definition of a tag that can be provided on the object",
291555
+ "nullable": true,
291556
+ "additionalProperties": false
291557
+ }
291558
+ }
291559
+ },
291560
+ "additionalProperties": false
291561
+ },
291562
+ "message": {
291563
+ "type": "object",
291564
+ "properties": {
291565
+ "tags": {
291566
+ "type": "object",
291567
+ "additionalProperties": {
291568
+ "type": "object",
291569
+ "properties": {
291570
+ "title": {
291571
+ "type": "string",
291572
+ "maxLength": 64,
291573
+ "description": "Title of the tag"
291574
+ },
291575
+ "description": {
291576
+ "type": "string",
291577
+ "maxLength": 256,
291578
+ "description": "Description of the tag"
291579
+ }
291580
+ },
291581
+ "description": "Definition of a tag that can be provided on the object",
291582
+ "nullable": true,
291583
+ "additionalProperties": false
291584
+ }
291585
+ }
291586
+ },
291587
+ "additionalProperties": false
291588
+ }
291589
+ },
291590
+ "nullable": true,
291591
+ "additionalProperties": false
291592
+ }
291593
+ },
291594
+ "identifier": {
291595
+ "type": "object",
291596
+ "properties": {
291597
+ "extractScript": {
291598
+ "type": "string",
291599
+ "maxLength": 2e3,
291600
+ "nullable": true
291601
+ },
291602
+ "fallbackHandlerScript": {
291603
+ "type": "string",
291604
+ "maxLength": 2e3,
291605
+ "nullable": true
291606
+ }
291607
+ },
291608
+ "additionalProperties": false
291609
+ },
291610
+ "actions": {
291611
+ "type": "object",
291612
+ "additionalProperties": {
291613
+ "type": "object",
291614
+ "properties": {
291615
+ "title": {
291616
+ "type": "string",
291617
+ "maxLength": 64,
291618
+ "description": "Title of the action"
291619
+ },
291620
+ "description": {
291621
+ "type": "string",
291622
+ "maxLength": 256,
291623
+ "description": "Description of the action"
291624
+ },
291625
+ "billable": {
291626
+ "type": "boolean"
291627
+ },
291628
+ "cacheable": {
291629
+ "type": "boolean"
291630
+ },
291631
+ "input": {
291632
+ "type": "object",
291633
+ "properties": {
291634
+ "schema": {
291635
+ "type": "object",
291636
+ "additionalProperties": true
291637
+ }
291638
+ },
291639
+ "required": [
291640
+ "schema"
291641
+ ],
291642
+ "additionalProperties": false
291643
+ },
291644
+ "output": {
291645
+ "type": "object",
291646
+ "properties": {
291647
+ "schema": {
291648
+ "type": "object",
291649
+ "additionalProperties": true
291650
+ }
291651
+ },
291652
+ "required": [
291653
+ "schema"
291654
+ ],
291655
+ "additionalProperties": false
291656
+ }
291657
+ },
291658
+ "required": [
291659
+ "input",
291660
+ "output"
291661
+ ],
291662
+ "description": "Action definition",
291663
+ "nullable": true,
291664
+ "additionalProperties": false
291665
+ }
291666
+ },
291667
+ "events": {
291668
+ "type": "object",
291669
+ "additionalProperties": {
291670
+ "type": "object",
291671
+ "properties": {
291672
+ "title": {
291673
+ "type": "string",
291674
+ "maxLength": 64,
291675
+ "description": "Title of the event"
291676
+ },
291677
+ "description": {
291678
+ "type": "string",
291679
+ "maxLength": 256,
291680
+ "description": "Description of the event"
291681
+ },
291682
+ "schema": {
291683
+ "type": "object",
291684
+ "additionalProperties": true
291685
+ }
291686
+ },
291687
+ "required": [
291688
+ "schema"
291689
+ ],
291690
+ "description": "Event Definition",
291691
+ "nullable": true,
291692
+ "additionalProperties": false
291693
+ }
291694
+ },
291695
+ "states": {
291696
+ "type": "object",
291697
+ "additionalProperties": {
291698
+ "type": "object",
291699
+ "properties": {
291700
+ "type": {
291701
+ "type": "string",
291702
+ "enum": [
291703
+ "conversation",
291704
+ "user",
291705
+ "integration"
291706
+ ],
291707
+ "description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
291708
+ },
291709
+ "schema": {
291710
+ "type": "object",
291711
+ "additionalProperties": true,
291712
+ "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."
291713
+ }
291714
+ },
291715
+ "required": [
291716
+ "type",
291717
+ "schema"
291718
+ ],
291719
+ "description": "State definition",
291720
+ "nullable": true,
291721
+ "additionalProperties": false
291722
+ }
291723
+ },
291724
+ "user": {
291725
+ "type": "object",
291726
+ "properties": {
291727
+ "creation": {
291728
+ "type": "object",
291729
+ "properties": {
291730
+ "enabled": {
291731
+ "type": "boolean",
291732
+ "description": "Enable user creation"
291733
+ },
291734
+ "requiredTags": {
291735
+ "type": "array",
291736
+ "items": {
291737
+ "type": "string"
291738
+ },
291739
+ "description": "The list of tags that are required to be specified when calling the API directly to create a user."
291740
+ }
291741
+ },
291742
+ "required": [
291743
+ "enabled",
291744
+ "requiredTags"
291745
+ ],
291746
+ "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.",
291747
+ "additionalProperties": false
291748
+ },
291749
+ "tags": {
291750
+ "type": "object",
291751
+ "additionalProperties": {
291752
+ "type": "object",
291753
+ "properties": {
291754
+ "title": {
291755
+ "type": "string",
291756
+ "maxLength": 64,
291757
+ "description": "Title of the tag"
291758
+ },
291759
+ "description": {
291760
+ "type": "string",
291761
+ "maxLength": 256,
291762
+ "description": "Description of the tag"
291763
+ }
291764
+ },
291765
+ "description": "Definition of a tag that can be provided on the object",
291766
+ "nullable": true,
291767
+ "additionalProperties": false
291768
+ }
291769
+ }
291770
+ },
291771
+ "additionalProperties": false
291772
+ },
291773
+ "entities": {
291774
+ "type": "object",
291775
+ "additionalProperties": {
291776
+ "type": "object",
291777
+ "properties": {
291778
+ "title": {
291779
+ "type": "string",
291780
+ "maxLength": 64,
291781
+ "description": "Title of the entity"
291782
+ },
291783
+ "description": {
291784
+ "type": "string",
291785
+ "maxLength": 256,
291786
+ "description": "Description of the entity"
291787
+ },
291788
+ "schema": {
291789
+ "type": "object",
291790
+ "additionalProperties": true
291791
+ }
291792
+ },
291793
+ "required": [
291794
+ "schema"
291795
+ ],
291796
+ "description": "Entity definition",
291797
+ "nullable": true,
291798
+ "additionalProperties": false
291799
+ }
291800
+ },
291801
+ "interfaces": {
291802
+ "type": "object",
291803
+ "additionalProperties": {
291804
+ "type": "object",
291805
+ "properties": {
291806
+ "id": {
291807
+ "type": "string",
291808
+ "minLength": 28,
291809
+ "maxLength": 36,
291810
+ "description": "ID of the interface"
291811
+ },
291812
+ "entities": {
291813
+ "type": "object",
291814
+ "additionalProperties": {
291815
+ "type": "object",
291816
+ "properties": {
291817
+ "name": {
291818
+ "type": "string",
291819
+ "maxLength": 200
291820
+ }
291821
+ },
291822
+ "required": [
291823
+ "name"
291824
+ ],
291825
+ "additionalProperties": false
291826
+ }
291827
+ },
291828
+ "actions": {
291829
+ "type": "object",
291830
+ "additionalProperties": {
291831
+ "type": "object",
291832
+ "properties": {
291833
+ "name": {
291834
+ "type": "string",
291835
+ "maxLength": 200
291836
+ }
291837
+ },
291838
+ "required": [
291839
+ "name"
291840
+ ],
291841
+ "additionalProperties": false
291842
+ }
291843
+ },
291844
+ "events": {
291845
+ "type": "object",
291846
+ "additionalProperties": {
291847
+ "type": "object",
291848
+ "properties": {
291849
+ "name": {
291850
+ "type": "string",
291851
+ "maxLength": 200
291852
+ }
291853
+ },
291854
+ "required": [
291855
+ "name"
291856
+ ],
291857
+ "additionalProperties": false
291858
+ }
291859
+ },
291860
+ "channels": {
291861
+ "type": "object",
291862
+ "additionalProperties": {
291863
+ "type": "object",
291864
+ "properties": {
291865
+ "name": {
291866
+ "type": "string",
291867
+ "maxLength": 200
291868
+ }
291869
+ },
291870
+ "required": [
291871
+ "name"
291872
+ ],
291873
+ "additionalProperties": false
291874
+ }
291875
+ }
291876
+ },
291877
+ "required": [
291878
+ "id"
291879
+ ],
291880
+ "nullable": true,
291881
+ "additionalProperties": false
291882
+ }
291883
+ },
291884
+ "secrets": {
291885
+ "type": "object",
291886
+ "additionalProperties": {
291887
+ "type": "string",
291888
+ "maxLength": 2e4,
291889
+ "nullable": true
291890
+ },
291891
+ "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."
291892
+ },
291893
+ "code": {
291894
+ "type": "string",
291895
+ "description": "JavaScript code of the integration"
291896
+ },
291897
+ "icon": {
291898
+ "type": "string",
291899
+ "description": "Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes."
291900
+ },
291901
+ "readme": {
291902
+ "type": "string",
291903
+ "description": "Base64 encoded markdown of the integration readme. The readme is specific to each integration versions."
291904
+ },
291905
+ "title": {
291906
+ "type": "string",
291907
+ "minLength": 1,
291908
+ "maxLength": 64,
291909
+ "description": "Title of the integration. This is the name that will be displayed in the UI"
291910
+ },
291911
+ "description": {
291912
+ "type": "string",
291913
+ "maxLength": 256,
291914
+ "description": "Description of the integration. This is the description that will be displayed in the UI"
291915
+ },
291916
+ "url": {
291917
+ "type": "string",
291918
+ "description": "URL of the integration",
291919
+ "nullable": true
291920
+ },
291921
+ "public": {
291922
+ "type": "boolean",
291923
+ "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
291924
+ },
291925
+ "layers": {
291926
+ "type": "array",
291927
+ "items": {
291928
+ "type": "string"
291929
+ }
291930
+ }
291931
+ },
291932
+ "title": "updateIntegrationBody",
291933
+ "additionalProperties": false
291934
+ }
291935
+ },
291936
+ "response": {
291937
+ "description": "Success",
291938
+ "schema": {
291939
+ "type": "object",
291940
+ "properties": {
291941
+ "integration": {
291942
+ "$ref": "#/components/schemas/Integration"
291943
+ }
291944
+ },
291945
+ "required": [
291946
+ "integration"
291947
+ ],
291948
+ "title": "updateIntegrationResponse",
291949
+ "additionalProperties": false
291950
+ }
291951
+ }
291952
+ },
291953
+ "validateIntegrationUpdate": {
291954
+ "name": "validateIntegrationUpdate",
291955
+ "description": "Perform a validation of an integration update request",
291956
+ "method": "put",
291957
+ "path": "/v1/admin/integrations/{id}/validate",
291958
+ "section": "integration",
291959
+ "parameters": {
291960
+ "id": {
291961
+ "type": "string",
291962
+ "description": "Integration ID",
291963
+ "in": "path"
291964
+ }
291965
+ },
291966
+ "requestBody": {
291967
+ "description": "Integration",
291968
+ "schema": {
291969
+ "type": "object",
291970
+ "properties": {
291971
+ "configuration": {
291972
+ "type": "object",
291973
+ "properties": {
291974
+ "title": {
291975
+ "type": "string",
291976
+ "maxLength": 64,
291977
+ "description": "Title of the configuration"
291978
+ },
291979
+ "description": {
291980
+ "type": "string",
291981
+ "maxLength": 256,
291982
+ "description": "Description of the configuration"
291983
+ },
291984
+ "schema": {
291985
+ "type": "object",
291986
+ "additionalProperties": true,
291987
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
291988
+ },
291989
+ "identifier": {
291990
+ "type": "object",
291991
+ "properties": {
291992
+ "linkTemplateScript": {
291993
+ "type": "string",
291994
+ "maxLength": 2e3,
291995
+ "nullable": true
291996
+ },
291997
+ "required": {
291998
+ "type": "boolean"
291999
+ }
292000
+ },
292001
+ "additionalProperties": false
292002
+ }
292003
+ },
292004
+ "description": "Default configuration definition of the integration",
292005
+ "additionalProperties": false
292006
+ },
292007
+ "configurations": {
292008
+ "type": "object",
292009
+ "additionalProperties": {
292010
+ "type": "object",
292011
+ "properties": {
292012
+ "title": {
292013
+ "type": "string",
292014
+ "maxLength": 64,
292015
+ "description": "Title of the configuration"
292016
+ },
292017
+ "description": {
292018
+ "type": "string",
292019
+ "maxLength": 256,
292020
+ "description": "Description of the configuration"
292021
+ },
292022
+ "schema": {
292023
+ "type": "object",
292024
+ "additionalProperties": true,
292025
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
292026
+ },
292027
+ "identifier": {
292028
+ "type": "object",
292029
+ "properties": {
292030
+ "linkTemplateScript": {
292031
+ "type": "string",
292032
+ "maxLength": 2e3,
292033
+ "nullable": true
292034
+ },
292035
+ "required": {
292036
+ "type": "boolean"
292037
+ }
292038
+ },
292039
+ "additionalProperties": false
292040
+ }
292041
+ },
292042
+ "nullable": true,
292043
+ "additionalProperties": false
292044
+ },
292045
+ "description": "Additional configuration definitions of the integration"
292046
+ },
292047
+ "channels": {
292048
+ "type": "object",
292049
+ "additionalProperties": {
292050
+ "type": "object",
292051
+ "properties": {
292052
+ "title": {
292053
+ "type": "string",
292054
+ "maxLength": 64,
292055
+ "description": "Title of the channel"
292056
+ },
292057
+ "description": {
292058
+ "type": "string",
292059
+ "maxLength": 256,
292060
+ "description": "Description of the channel"
292061
+ },
292062
+ "messages": {
292063
+ "type": "object",
292064
+ "additionalProperties": {
292065
+ "type": "object",
292066
+ "properties": {
292067
+ "schema": {
292068
+ "type": "object",
292069
+ "additionalProperties": true
292070
+ }
292071
+ },
292072
+ "required": [
292073
+ "schema"
292074
+ ],
292075
+ "description": "Message definition",
292076
+ "nullable": true,
292077
+ "additionalProperties": false
292078
+ }
292079
+ },
292080
+ "conversation": {
292081
+ "type": "object",
292082
+ "properties": {
292083
+ "creation": {
292084
+ "type": "object",
292085
+ "properties": {
292086
+ "enabled": {
292087
+ "type": "boolean",
292088
+ "description": "Enable conversation creation"
292089
+ },
292090
+ "requiredTags": {
292091
+ "type": "array",
292092
+ "items": {
292093
+ "type": "string"
292094
+ },
292095
+ "description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
292096
+ }
292097
+ },
292098
+ "required": [
292099
+ "enabled",
292100
+ "requiredTags"
292101
+ ],
292102
+ "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.",
292103
+ "additionalProperties": false
292104
+ },
292105
+ "tags": {
292106
+ "type": "object",
292107
+ "additionalProperties": {
292108
+ "type": "object",
292109
+ "properties": {
292110
+ "title": {
292111
+ "type": "string",
292112
+ "maxLength": 64,
292113
+ "description": "Title of the tag"
292114
+ },
292115
+ "description": {
292116
+ "type": "string",
292117
+ "maxLength": 256,
292118
+ "description": "Description of the tag"
292119
+ }
292120
+ },
292121
+ "description": "Definition of a tag that can be provided on the object",
292122
+ "nullable": true,
292123
+ "additionalProperties": false
292124
+ }
292125
+ }
292126
+ },
292127
+ "additionalProperties": false
292128
+ },
292129
+ "message": {
292130
+ "type": "object",
292131
+ "properties": {
292132
+ "tags": {
292133
+ "type": "object",
292134
+ "additionalProperties": {
292135
+ "type": "object",
292136
+ "properties": {
292137
+ "title": {
292138
+ "type": "string",
292139
+ "maxLength": 64,
292140
+ "description": "Title of the tag"
292141
+ },
292142
+ "description": {
292143
+ "type": "string",
292144
+ "maxLength": 256,
292145
+ "description": "Description of the tag"
292146
+ }
292147
+ },
292148
+ "description": "Definition of a tag that can be provided on the object",
292149
+ "nullable": true,
292150
+ "additionalProperties": false
292151
+ }
292152
+ }
292153
+ },
292154
+ "additionalProperties": false
292155
+ }
292156
+ },
292157
+ "nullable": true,
292158
+ "additionalProperties": false
292159
+ }
292160
+ },
292161
+ "identifier": {
292162
+ "type": "object",
292163
+ "properties": {
292164
+ "extractScript": {
292165
+ "type": "string",
292166
+ "maxLength": 2e3,
292167
+ "nullable": true
292168
+ },
292169
+ "fallbackHandlerScript": {
292170
+ "type": "string",
292171
+ "maxLength": 2e3,
292172
+ "nullable": true
292173
+ }
292174
+ },
292175
+ "additionalProperties": false
292176
+ },
292177
+ "actions": {
291035
292178
  "type": "object",
291036
292179
  "additionalProperties": {
291037
292180
  "type": "object",
@@ -291353,23 +292496,15 @@ var state = {
291353
292496
  }
291354
292497
  }
291355
292498
  },
291356
- "title": "updateIntegrationBody",
292499
+ "title": "validateIntegrationUpdateBody",
291357
292500
  "additionalProperties": false
291358
292501
  }
291359
292502
  },
291360
292503
  "response": {
291361
- "description": "Success",
292504
+ "description": "Validation succeeded: the integration can be updated using the same parameters",
291362
292505
  "schema": {
291363
292506
  "type": "object",
291364
- "properties": {
291365
- "integration": {
291366
- "$ref": "#/components/schemas/Integration"
291367
- }
291368
- },
291369
- "required": [
291370
- "integration"
291371
- ],
291372
- "title": "updateIntegrationResponse",
292507
+ "title": "validateIntegrationUpdateResponse",
291373
292508
  "additionalProperties": false
291374
292509
  }
291375
292510
  }
@@ -296152,7 +297287,7 @@ var state = {
296152
297287
  "title": "Botpress API",
296153
297288
  "description": "API for Botpress Cloud",
296154
297289
  "server": "https://api.botpress.cloud",
296155
- "version": "0.69.0",
297290
+ "version": "0.70.1",
296156
297291
  "prefix": "v1"
296157
297292
  },
296158
297293
  "errors": [
@@ -296320,7 +297455,9 @@ var state = {
296320
297455
  "updateWorkspaceMemberBody": true,
296321
297456
  "createIntegrationApiKeyBody": true,
296322
297457
  "createIntegrationBody": true,
297458
+ "validateIntegrationCreationBody": true,
296323
297459
  "updateIntegrationBody": true,
297460
+ "validateIntegrationUpdateBody": true,
296324
297461
  "requestIntegrationVerificationBody": true,
296325
297462
  "createInterfaceBody": true,
296326
297463
  "updateInterfaceBody": true,
@@ -296443,7 +297580,9 @@ var state = {
296443
297580
  "createIntegrationApiKeyResponse": true,
296444
297581
  "deleteIntegrationApiKeyResponse": true,
296445
297582
  "createIntegrationResponse": true,
297583
+ "validateIntegrationCreationResponse": true,
296446
297584
  "updateIntegrationResponse": true,
297585
+ "validateIntegrationUpdateResponse": true,
296447
297586
  "listIntegrationsResponse": true,
296448
297587
  "getIntegrationResponse": true,
296449
297588
  "getIntegrationLogsResponse": true,
@@ -299856,7 +300995,9 @@ var state = {
299856
300995
  "createIntegrationApiKey",
299857
300996
  "deleteIntegrationApiKey",
299858
300997
  "createIntegration",
300998
+ "validateIntegrationCreation",
299859
300999
  "updateIntegration",
301000
+ "validateIntegrationUpdate",
299860
301001
  "listIntegrations",
299861
301002
  "getIntegration",
299862
301003
  "getIntegrationLogs",