@botpress/api 1.12.0 → 1.13.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 (16) hide show
  1. package/dist/index.js +1587 -151
  2. package/dist/src/gen/admin/state.d.ts +631 -0
  3. package/dist/src/gen/state.d.ts +631 -0
  4. package/package.json +1 -1
  5. package/src/gen/admin/metadata.json +1 -1
  6. package/src/gen/admin/openapi.json +1 -1
  7. package/src/gen/admin/state.ts +720 -2
  8. package/src/gen/files/openapi.json +1 -1
  9. package/src/gen/files/state.ts +1 -1
  10. package/src/gen/metadata.json +1 -1
  11. package/src/gen/openapi.json +1 -1
  12. package/src/gen/runtime/openapi.json +1 -1
  13. package/src/gen/runtime/state.ts +1 -1
  14. package/src/gen/state.ts +720 -2
  15. package/src/gen/tables/openapi.json +1 -1
  16. package/src/gen/tables/state.ts +1 -1
package/dist/index.js CHANGED
@@ -284126,7 +284126,7 @@ var state = {
284126
284126
  "title": "Botpress API",
284127
284127
  "description": "API for Botpress Cloud",
284128
284128
  "server": "https://api.botpress.cloud",
284129
- "version": "1.12.0",
284129
+ "version": "1.13.1",
284130
284130
  "prefix": "v1"
284131
284131
  },
284132
284132
  "errors": [
@@ -290926,6 +290926,701 @@ var state2 = {
290926
290926
  }
290927
290927
  }
290928
290928
  },
290929
+ "listPublicInterfaces": {
290930
+ "name": "listPublicInterfaces",
290931
+ "description": "List public interfaces",
290932
+ "method": "get",
290933
+ "section": "hub",
290934
+ "path": "/v1/admin/hub/interfaces",
290935
+ "disableDefaultParameters": {
290936
+ "x-workspace-id": true
290937
+ },
290938
+ "parameters": {
290939
+ "nextToken": {
290940
+ "in": "query",
290941
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
290942
+ "type": "string"
290943
+ },
290944
+ "name": {
290945
+ "in": "query",
290946
+ "type": "string",
290947
+ "description": "Filter all versions of an interface by name"
290948
+ },
290949
+ "version": {
290950
+ "in": "query",
290951
+ "type": "string",
290952
+ "description": "Filter an interface by name and version"
290953
+ }
290954
+ },
290955
+ "response": {
290956
+ "description": "Success",
290957
+ "schema": {
290958
+ "type": "object",
290959
+ "properties": {
290960
+ "interfaces": {
290961
+ "type": "array",
290962
+ "items": {
290963
+ "type": "object",
290964
+ "properties": {
290965
+ "id": {
290966
+ "type": "string",
290967
+ "minLength": 28,
290968
+ "maxLength": 36,
290969
+ "description": "ID of the [Interface](#schema_interface)"
290970
+ },
290971
+ "createdAt": {
290972
+ "type": "string",
290973
+ "format": "date-time",
290974
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
290975
+ },
290976
+ "updatedAt": {
290977
+ "type": "string",
290978
+ "format": "date-time",
290979
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
290980
+ },
290981
+ "name": {
290982
+ "type": "string",
290983
+ "maxLength": 200,
290984
+ "description": "Name of the [Interface](#schema_interface)"
290985
+ },
290986
+ "version": {
290987
+ "type": "string",
290988
+ "maxLength": 200,
290989
+ "description": "Version of the [Interface](#schema_interface)"
290990
+ },
290991
+ "title": {
290992
+ "type": "string",
290993
+ "minLength": 1,
290994
+ "maxLength": 64,
290995
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
290996
+ },
290997
+ "description": {
290998
+ "type": "string",
290999
+ "maxLength": 256,
291000
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
291001
+ },
291002
+ "iconUrl": {
291003
+ "type": "string",
291004
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
291005
+ },
291006
+ "readmeUrl": {
291007
+ "type": "string",
291008
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
291009
+ },
291010
+ "public": {
291011
+ "type": "boolean",
291012
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
291013
+ }
291014
+ },
291015
+ "required": [
291016
+ "id",
291017
+ "createdAt",
291018
+ "updatedAt",
291019
+ "name",
291020
+ "version",
291021
+ "title",
291022
+ "description",
291023
+ "iconUrl",
291024
+ "readmeUrl",
291025
+ "public"
291026
+ ]
291027
+ }
291028
+ },
291029
+ "meta": {
291030
+ "type": "object",
291031
+ "properties": {
291032
+ "nextToken": {
291033
+ "type": "string",
291034
+ "description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
291035
+ }
291036
+ },
291037
+ "additionalProperties": false
291038
+ }
291039
+ },
291040
+ "required": [
291041
+ "interfaces",
291042
+ "meta"
291043
+ ],
291044
+ "title": "listPublicInterfacesResponse",
291045
+ "additionalProperties": false
291046
+ }
291047
+ }
291048
+ },
291049
+ "getPublicInterfaceById": {
291050
+ "name": "getPublicInterfaceById",
291051
+ "description": "Get public interface by Id",
291052
+ "method": "get",
291053
+ "section": "hub",
291054
+ "path": "/v1/admin/hub/interfaces/{id}",
291055
+ "disableDefaultParameters": {
291056
+ "x-workspace-id": true
291057
+ },
291058
+ "parameters": {
291059
+ "id": {
291060
+ "type": "string",
291061
+ "description": "Interface ID",
291062
+ "in": "path"
291063
+ }
291064
+ },
291065
+ "response": {
291066
+ "description": "Success",
291067
+ "schema": {
291068
+ "type": "object",
291069
+ "properties": {
291070
+ "interface": {
291071
+ "type": "object",
291072
+ "properties": {
291073
+ "id": {
291074
+ "type": "string",
291075
+ "minLength": 28,
291076
+ "maxLength": 36,
291077
+ "description": "ID of the [Interface](#schema_interface)"
291078
+ },
291079
+ "createdAt": {
291080
+ "type": "string",
291081
+ "format": "date-time",
291082
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
291083
+ },
291084
+ "updatedAt": {
291085
+ "type": "string",
291086
+ "format": "date-time",
291087
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
291088
+ },
291089
+ "name": {
291090
+ "type": "string",
291091
+ "maxLength": 200,
291092
+ "description": "Name of the [Interface](#schema_interface)"
291093
+ },
291094
+ "version": {
291095
+ "type": "string",
291096
+ "maxLength": 200,
291097
+ "description": "Version of the [Interface](#schema_interface)"
291098
+ },
291099
+ "entities": {
291100
+ "type": "object",
291101
+ "additionalProperties": {
291102
+ "type": "object",
291103
+ "properties": {
291104
+ "title": {
291105
+ "type": "string",
291106
+ "maxLength": 64,
291107
+ "description": "Title of the entity"
291108
+ },
291109
+ "description": {
291110
+ "type": "string",
291111
+ "maxLength": 256,
291112
+ "description": "Description of the entity"
291113
+ },
291114
+ "schema": {
291115
+ "type": "object",
291116
+ "additionalProperties": true
291117
+ }
291118
+ },
291119
+ "required": [
291120
+ "schema"
291121
+ ],
291122
+ "description": "Entity definition",
291123
+ "additionalProperties": false
291124
+ }
291125
+ },
291126
+ "events": {
291127
+ "type": "object",
291128
+ "additionalProperties": {
291129
+ "type": "object",
291130
+ "properties": {
291131
+ "title": {
291132
+ "type": "string",
291133
+ "maxLength": 64,
291134
+ "description": "Title of the event"
291135
+ },
291136
+ "description": {
291137
+ "type": "string",
291138
+ "maxLength": 256,
291139
+ "description": "Description of the event"
291140
+ },
291141
+ "schema": {
291142
+ "type": "object",
291143
+ "additionalProperties": true
291144
+ },
291145
+ "attributes": {
291146
+ "type": "object",
291147
+ "additionalProperties": {
291148
+ "type": "string",
291149
+ "maxLength": 200
291150
+ },
291151
+ "description": "Optional attributes"
291152
+ }
291153
+ },
291154
+ "required": [
291155
+ "schema"
291156
+ ],
291157
+ "description": "Event Definition",
291158
+ "additionalProperties": false
291159
+ }
291160
+ },
291161
+ "actions": {
291162
+ "type": "object",
291163
+ "additionalProperties": {
291164
+ "type": "object",
291165
+ "properties": {
291166
+ "title": {
291167
+ "type": "string",
291168
+ "maxLength": 64,
291169
+ "description": "Title of the action"
291170
+ },
291171
+ "description": {
291172
+ "type": "string",
291173
+ "maxLength": 256,
291174
+ "description": "Description of the action"
291175
+ },
291176
+ "billable": {
291177
+ "type": "boolean"
291178
+ },
291179
+ "cacheable": {
291180
+ "type": "boolean"
291181
+ },
291182
+ "input": {
291183
+ "type": "object",
291184
+ "properties": {
291185
+ "schema": {
291186
+ "type": "object",
291187
+ "additionalProperties": true
291188
+ }
291189
+ },
291190
+ "required": [
291191
+ "schema"
291192
+ ],
291193
+ "additionalProperties": false
291194
+ },
291195
+ "output": {
291196
+ "type": "object",
291197
+ "properties": {
291198
+ "schema": {
291199
+ "type": "object",
291200
+ "additionalProperties": true
291201
+ }
291202
+ },
291203
+ "required": [
291204
+ "schema"
291205
+ ],
291206
+ "additionalProperties": false
291207
+ },
291208
+ "attributes": {
291209
+ "type": "object",
291210
+ "additionalProperties": {
291211
+ "type": "string",
291212
+ "maxLength": 200
291213
+ },
291214
+ "description": "Optional attributes"
291215
+ }
291216
+ },
291217
+ "required": [
291218
+ "input",
291219
+ "output"
291220
+ ],
291221
+ "description": "Action definition",
291222
+ "additionalProperties": false
291223
+ }
291224
+ },
291225
+ "channels": {
291226
+ "type": "object",
291227
+ "additionalProperties": {
291228
+ "type": "object",
291229
+ "properties": {
291230
+ "title": {
291231
+ "type": "string",
291232
+ "maxLength": 64,
291233
+ "description": "Title of the channel"
291234
+ },
291235
+ "description": {
291236
+ "type": "string",
291237
+ "maxLength": 256,
291238
+ "description": "Description of the channel"
291239
+ },
291240
+ "messages": {
291241
+ "type": "object",
291242
+ "additionalProperties": {
291243
+ "type": "object",
291244
+ "properties": {
291245
+ "schema": {
291246
+ "type": "object",
291247
+ "additionalProperties": true
291248
+ }
291249
+ },
291250
+ "required": [
291251
+ "schema"
291252
+ ],
291253
+ "description": "Message definition",
291254
+ "additionalProperties": false
291255
+ }
291256
+ }
291257
+ },
291258
+ "required": [
291259
+ "messages"
291260
+ ],
291261
+ "additionalProperties": false
291262
+ }
291263
+ },
291264
+ "nameTemplate": {
291265
+ "type": "object",
291266
+ "properties": {
291267
+ "script": {
291268
+ "type": "string",
291269
+ "maxLength": 2e3
291270
+ },
291271
+ "language": {
291272
+ "type": "string",
291273
+ "maxLength": 200
291274
+ }
291275
+ },
291276
+ "required": [
291277
+ "script",
291278
+ "language"
291279
+ ],
291280
+ "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
291281
+ "additionalProperties": false
291282
+ },
291283
+ "title": {
291284
+ "type": "string",
291285
+ "minLength": 1,
291286
+ "maxLength": 64,
291287
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
291288
+ },
291289
+ "description": {
291290
+ "type": "string",
291291
+ "maxLength": 256,
291292
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
291293
+ },
291294
+ "iconUrl": {
291295
+ "type": "string",
291296
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
291297
+ },
291298
+ "readmeUrl": {
291299
+ "type": "string",
291300
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
291301
+ },
291302
+ "public": {
291303
+ "type": "boolean",
291304
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
291305
+ }
291306
+ },
291307
+ "required": [
291308
+ "id",
291309
+ "createdAt",
291310
+ "updatedAt",
291311
+ "name",
291312
+ "version",
291313
+ "entities",
291314
+ "events",
291315
+ "actions",
291316
+ "channels",
291317
+ "title",
291318
+ "description",
291319
+ "iconUrl",
291320
+ "readmeUrl",
291321
+ "public"
291322
+ ],
291323
+ "additionalProperties": false
291324
+ }
291325
+ },
291326
+ "required": [
291327
+ "interface"
291328
+ ],
291329
+ "title": "getPublicInterfaceByIdResponse",
291330
+ "additionalProperties": false
291331
+ }
291332
+ }
291333
+ },
291334
+ "getPublicInterface": {
291335
+ "name": "getPublicInterface",
291336
+ "description": "Get public interface by name and version",
291337
+ "method": "get",
291338
+ "section": "hub",
291339
+ "path": "/v1/admin/hub/interfaces/{name}/{version}",
291340
+ "disableDefaultParameters": {
291341
+ "x-workspace-id": true
291342
+ },
291343
+ "parameters": {
291344
+ "name": {
291345
+ "type": "string",
291346
+ "description": "Interface Name",
291347
+ "in": "path"
291348
+ },
291349
+ "version": {
291350
+ "type": "string",
291351
+ "description": "Interface version.",
291352
+ "in": "path"
291353
+ }
291354
+ },
291355
+ "response": {
291356
+ "description": "Success",
291357
+ "schema": {
291358
+ "type": "object",
291359
+ "properties": {
291360
+ "interface": {
291361
+ "type": "object",
291362
+ "properties": {
291363
+ "id": {
291364
+ "type": "string",
291365
+ "minLength": 28,
291366
+ "maxLength": 36,
291367
+ "description": "ID of the [Interface](#schema_interface)"
291368
+ },
291369
+ "createdAt": {
291370
+ "type": "string",
291371
+ "format": "date-time",
291372
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
291373
+ },
291374
+ "updatedAt": {
291375
+ "type": "string",
291376
+ "format": "date-time",
291377
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
291378
+ },
291379
+ "name": {
291380
+ "type": "string",
291381
+ "maxLength": 200,
291382
+ "description": "Name of the [Interface](#schema_interface)"
291383
+ },
291384
+ "version": {
291385
+ "type": "string",
291386
+ "maxLength": 200,
291387
+ "description": "Version of the [Interface](#schema_interface)"
291388
+ },
291389
+ "entities": {
291390
+ "type": "object",
291391
+ "additionalProperties": {
291392
+ "type": "object",
291393
+ "properties": {
291394
+ "title": {
291395
+ "type": "string",
291396
+ "maxLength": 64,
291397
+ "description": "Title of the entity"
291398
+ },
291399
+ "description": {
291400
+ "type": "string",
291401
+ "maxLength": 256,
291402
+ "description": "Description of the entity"
291403
+ },
291404
+ "schema": {
291405
+ "type": "object",
291406
+ "additionalProperties": true
291407
+ }
291408
+ },
291409
+ "required": [
291410
+ "schema"
291411
+ ],
291412
+ "description": "Entity definition",
291413
+ "additionalProperties": false
291414
+ }
291415
+ },
291416
+ "events": {
291417
+ "type": "object",
291418
+ "additionalProperties": {
291419
+ "type": "object",
291420
+ "properties": {
291421
+ "title": {
291422
+ "type": "string",
291423
+ "maxLength": 64,
291424
+ "description": "Title of the event"
291425
+ },
291426
+ "description": {
291427
+ "type": "string",
291428
+ "maxLength": 256,
291429
+ "description": "Description of the event"
291430
+ },
291431
+ "schema": {
291432
+ "type": "object",
291433
+ "additionalProperties": true
291434
+ },
291435
+ "attributes": {
291436
+ "type": "object",
291437
+ "additionalProperties": {
291438
+ "type": "string",
291439
+ "maxLength": 200
291440
+ },
291441
+ "description": "Optional attributes"
291442
+ }
291443
+ },
291444
+ "required": [
291445
+ "schema"
291446
+ ],
291447
+ "description": "Event Definition",
291448
+ "additionalProperties": false
291449
+ }
291450
+ },
291451
+ "actions": {
291452
+ "type": "object",
291453
+ "additionalProperties": {
291454
+ "type": "object",
291455
+ "properties": {
291456
+ "title": {
291457
+ "type": "string",
291458
+ "maxLength": 64,
291459
+ "description": "Title of the action"
291460
+ },
291461
+ "description": {
291462
+ "type": "string",
291463
+ "maxLength": 256,
291464
+ "description": "Description of the action"
291465
+ },
291466
+ "billable": {
291467
+ "type": "boolean"
291468
+ },
291469
+ "cacheable": {
291470
+ "type": "boolean"
291471
+ },
291472
+ "input": {
291473
+ "type": "object",
291474
+ "properties": {
291475
+ "schema": {
291476
+ "type": "object",
291477
+ "additionalProperties": true
291478
+ }
291479
+ },
291480
+ "required": [
291481
+ "schema"
291482
+ ],
291483
+ "additionalProperties": false
291484
+ },
291485
+ "output": {
291486
+ "type": "object",
291487
+ "properties": {
291488
+ "schema": {
291489
+ "type": "object",
291490
+ "additionalProperties": true
291491
+ }
291492
+ },
291493
+ "required": [
291494
+ "schema"
291495
+ ],
291496
+ "additionalProperties": false
291497
+ },
291498
+ "attributes": {
291499
+ "type": "object",
291500
+ "additionalProperties": {
291501
+ "type": "string",
291502
+ "maxLength": 200
291503
+ },
291504
+ "description": "Optional attributes"
291505
+ }
291506
+ },
291507
+ "required": [
291508
+ "input",
291509
+ "output"
291510
+ ],
291511
+ "description": "Action definition",
291512
+ "additionalProperties": false
291513
+ }
291514
+ },
291515
+ "channels": {
291516
+ "type": "object",
291517
+ "additionalProperties": {
291518
+ "type": "object",
291519
+ "properties": {
291520
+ "title": {
291521
+ "type": "string",
291522
+ "maxLength": 64,
291523
+ "description": "Title of the channel"
291524
+ },
291525
+ "description": {
291526
+ "type": "string",
291527
+ "maxLength": 256,
291528
+ "description": "Description of the channel"
291529
+ },
291530
+ "messages": {
291531
+ "type": "object",
291532
+ "additionalProperties": {
291533
+ "type": "object",
291534
+ "properties": {
291535
+ "schema": {
291536
+ "type": "object",
291537
+ "additionalProperties": true
291538
+ }
291539
+ },
291540
+ "required": [
291541
+ "schema"
291542
+ ],
291543
+ "description": "Message definition",
291544
+ "additionalProperties": false
291545
+ }
291546
+ }
291547
+ },
291548
+ "required": [
291549
+ "messages"
291550
+ ],
291551
+ "additionalProperties": false
291552
+ }
291553
+ },
291554
+ "nameTemplate": {
291555
+ "type": "object",
291556
+ "properties": {
291557
+ "script": {
291558
+ "type": "string",
291559
+ "maxLength": 2e3
291560
+ },
291561
+ "language": {
291562
+ "type": "string",
291563
+ "maxLength": 200
291564
+ }
291565
+ },
291566
+ "required": [
291567
+ "script",
291568
+ "language"
291569
+ ],
291570
+ "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
291571
+ "additionalProperties": false
291572
+ },
291573
+ "title": {
291574
+ "type": "string",
291575
+ "minLength": 1,
291576
+ "maxLength": 64,
291577
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
291578
+ },
291579
+ "description": {
291580
+ "type": "string",
291581
+ "maxLength": 256,
291582
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
291583
+ },
291584
+ "iconUrl": {
291585
+ "type": "string",
291586
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
291587
+ },
291588
+ "readmeUrl": {
291589
+ "type": "string",
291590
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
291591
+ },
291592
+ "public": {
291593
+ "type": "boolean",
291594
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
291595
+ }
291596
+ },
291597
+ "required": [
291598
+ "id",
291599
+ "createdAt",
291600
+ "updatedAt",
291601
+ "name",
291602
+ "version",
291603
+ "entities",
291604
+ "events",
291605
+ "actions",
291606
+ "channels",
291607
+ "title",
291608
+ "description",
291609
+ "iconUrl",
291610
+ "readmeUrl",
291611
+ "public"
291612
+ ],
291613
+ "additionalProperties": false
291614
+ }
291615
+ },
291616
+ "required": [
291617
+ "interface"
291618
+ ],
291619
+ "title": "getPublicInterfaceResponse",
291620
+ "additionalProperties": false
291621
+ }
291622
+ }
291623
+ },
290929
291624
  "createBot": {
290930
291625
  "name": "createBot",
290931
291626
  "description": "Create bot",
@@ -291953,6 +292648,12 @@ var state2 = {
291953
292648
  "type": "string",
291954
292649
  "required": false
291955
292650
  },
292651
+ "messageContains": {
292652
+ "in": "query",
292653
+ "description": "Filter logs where the message contains this substring",
292654
+ "type": "string",
292655
+ "required": false
292656
+ },
291956
292657
  "nextToken": {
291957
292658
  "in": "query",
291958
292659
  "description": "Token to get the next page of logs",
@@ -297678,6 +298379,12 @@ var state2 = {
297678
298379
  "type": "string",
297679
298380
  "required": false
297680
298381
  },
298382
+ "messageContains": {
298383
+ "in": "query",
298384
+ "description": "Filter logs where the message contains this substring",
298385
+ "type": "string",
298386
+ "required": false
298387
+ },
297681
298388
  "nextToken": {
297682
298389
  "in": "query",
297683
298390
  "description": "Token to get the next page of logs",
@@ -298430,6 +299137,11 @@ var state2 = {
298430
299137
  "in": "query",
298431
299138
  "type": "string",
298432
299139
  "description": "Filter all versions of an interface by name"
299140
+ },
299141
+ "version": {
299142
+ "in": "query",
299143
+ "type": "string",
299144
+ "description": "Filter an interface by name and version"
298433
299145
  }
298434
299146
  },
298435
299147
  "response": {
@@ -299975,7 +300687,7 @@ var state2 = {
299975
300687
  "title": "Botpress API",
299976
300688
  "description": "API for Botpress Cloud",
299977
300689
  "server": "https://api.botpress.cloud",
299978
- "version": "1.12.0",
300690
+ "version": "1.13.1",
299979
300691
  "prefix": "v1"
299980
300692
  },
299981
300693
  "errors": [
@@ -300149,6 +300861,9 @@ var state2 = {
300149
300861
  "getPublicPluginByIdResponse": true,
300150
300862
  "getPublicPluginResponse": true,
300151
300863
  "getPublicPluginCodeResponse": true,
300864
+ "listPublicInterfacesResponse": true,
300865
+ "getPublicInterfaceByIdResponse": true,
300866
+ "getPublicInterfaceResponse": true,
300152
300867
  "createBotResponse": true,
300153
300868
  "updateBotResponse": true,
300154
300869
  "transferBotResponse": true,
@@ -303615,7 +304330,10 @@ var state2 = {
303615
304330
  "listPublicPlugins",
303616
304331
  "getPublicPluginById",
303617
304332
  "getPublicPlugin",
303618
- "getPublicPluginCode"
304333
+ "getPublicPluginCode",
304334
+ "listPublicInterfaces",
304335
+ "getPublicInterfaceById",
304336
+ "getPublicInterface"
303619
304337
  ]
303620
304338
  },
303621
304339
  {
@@ -305415,7 +306133,7 @@ var state3 = {
305415
306133
  "title": "Botpress API",
305416
306134
  "description": "API for Botpress Cloud",
305417
306135
  "server": "https://api.botpress.cloud",
305418
- "version": "1.12.0",
306136
+ "version": "1.13.1",
305419
306137
  "prefix": "v1"
305420
306138
  },
305421
306139
  "errors": [
@@ -310302,7 +311020,7 @@ var state4 = {
310302
311020
  "title": "Botpress API",
310303
311021
  "description": "API for Botpress Cloud",
310304
311022
  "server": "https://api.botpress.cloud",
310305
- "version": "1.12.0",
311023
+ "version": "1.13.1",
310306
311024
  "prefix": "v1"
310307
311025
  },
310308
311026
  "errors": [
@@ -319400,167 +320118,614 @@ var state5 = {
319400
320118
  "additionalProperties": false
319401
320119
  }
319402
320120
  },
319403
- "dependencies": {
320121
+ "dependencies": {
320122
+ "type": "object",
320123
+ "properties": {
320124
+ "interfaces": {
320125
+ "type": "object",
320126
+ "additionalProperties": {
320127
+ "type": "object",
320128
+ "properties": {
320129
+ "id": {
320130
+ "type": "string",
320131
+ "minLength": 28,
320132
+ "maxLength": 36
320133
+ },
320134
+ "name": {
320135
+ "type": "string",
320136
+ "maxLength": 200
320137
+ },
320138
+ "version": {
320139
+ "type": "string",
320140
+ "maxLength": 200
320141
+ }
320142
+ },
320143
+ "required": [
320144
+ "id",
320145
+ "name",
320146
+ "version"
320147
+ ],
320148
+ "additionalProperties": false
320149
+ }
320150
+ },
320151
+ "integrations": {
320152
+ "type": "object",
320153
+ "additionalProperties": {
320154
+ "type": "object",
320155
+ "properties": {
320156
+ "id": {
320157
+ "type": "string",
320158
+ "minLength": 28,
320159
+ "maxLength": 36
320160
+ },
320161
+ "name": {
320162
+ "type": "string",
320163
+ "maxLength": 200
320164
+ },
320165
+ "version": {
320166
+ "type": "string",
320167
+ "maxLength": 200
320168
+ }
320169
+ },
320170
+ "required": [
320171
+ "id",
320172
+ "name",
320173
+ "version"
320174
+ ],
320175
+ "additionalProperties": false
320176
+ }
320177
+ }
320178
+ },
320179
+ "required": [
320180
+ "interfaces",
320181
+ "integrations"
320182
+ ],
320183
+ "additionalProperties": false
320184
+ },
320185
+ "user": {
320186
+ "type": "object",
320187
+ "properties": {
320188
+ "tags": {
320189
+ "type": "object",
320190
+ "additionalProperties": {
320191
+ "type": "object",
320192
+ "properties": {
320193
+ "title": {
320194
+ "type": "string",
320195
+ "maxLength": 64,
320196
+ "description": "Title of the tag"
320197
+ },
320198
+ "description": {
320199
+ "type": "string",
320200
+ "maxLength": 256,
320201
+ "description": "Description of the tag"
320202
+ }
320203
+ },
320204
+ "description": "Definition of a tag that can be provided on the object",
320205
+ "additionalProperties": false
320206
+ }
320207
+ }
320208
+ },
320209
+ "required": [
320210
+ "tags"
320211
+ ],
320212
+ "description": "User object configuration",
320213
+ "additionalProperties": false
320214
+ },
320215
+ "conversation": {
320216
+ "type": "object",
320217
+ "properties": {
320218
+ "tags": {
320219
+ "type": "object",
320220
+ "additionalProperties": {
320221
+ "type": "object",
320222
+ "properties": {
320223
+ "title": {
320224
+ "type": "string",
320225
+ "maxLength": 64,
320226
+ "description": "Title of the tag"
320227
+ },
320228
+ "description": {
320229
+ "type": "string",
320230
+ "maxLength": 256,
320231
+ "description": "Description of the tag"
320232
+ }
320233
+ },
320234
+ "description": "Definition of a tag that can be provided on the object",
320235
+ "additionalProperties": false
320236
+ }
320237
+ }
320238
+ },
320239
+ "required": [
320240
+ "tags"
320241
+ ],
320242
+ "description": "Conversation object configuration",
320243
+ "additionalProperties": false
320244
+ },
320245
+ "title": {
320246
+ "type": "string",
320247
+ "minLength": 1,
320248
+ "maxLength": 64,
320249
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
320250
+ },
320251
+ "description": {
320252
+ "type": "string",
320253
+ "maxLength": 256,
320254
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
320255
+ },
320256
+ "iconUrl": {
320257
+ "type": "string",
320258
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
320259
+ },
320260
+ "readmeUrl": {
320261
+ "type": "string",
320262
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
320263
+ },
320264
+ "public": {
320265
+ "type": "boolean",
320266
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
320267
+ }
320268
+ },
320269
+ "required": [
320270
+ "id",
320271
+ "name",
320272
+ "version",
320273
+ "createdAt",
320274
+ "updatedAt",
320275
+ "configuration",
320276
+ "states",
320277
+ "events",
320278
+ "actions",
320279
+ "dependencies",
320280
+ "user",
320281
+ "conversation",
320282
+ "title",
320283
+ "description",
320284
+ "iconUrl",
320285
+ "readmeUrl",
320286
+ "public"
320287
+ ],
320288
+ "additionalProperties": false
320289
+ }
320290
+ },
320291
+ "required": [
320292
+ "plugin"
320293
+ ],
320294
+ "title": "getPublicPluginResponse",
320295
+ "additionalProperties": false
320296
+ }
320297
+ }
320298
+ },
320299
+ "getPublicPluginCode": {
320300
+ "name": "getPublicPluginCode",
320301
+ "description": "Get public plugin code",
320302
+ "method": "get",
320303
+ "path": "/v1/admin/hub/plugins/{id}/code/{platform}",
320304
+ "disableDefaultParameters": {
320305
+ "x-workspace-id": true
320306
+ },
320307
+ "section": "hub",
320308
+ "parameters": {
320309
+ "id": {
320310
+ "in": "path",
320311
+ "type": "string",
320312
+ "description": "Plugin id"
320313
+ },
320314
+ "platform": {
320315
+ "in": "path",
320316
+ "type": "string",
320317
+ "enum": [
320318
+ "node",
320319
+ "browser"
320320
+ ],
320321
+ "description": "Platform"
320322
+ }
320323
+ },
320324
+ "response": {
320325
+ "description": "Plugin code",
320326
+ "schema": {
320327
+ "type": "object",
320328
+ "properties": {
320329
+ "code": {
320330
+ "type": "string"
320331
+ }
320332
+ },
320333
+ "required": [
320334
+ "code"
320335
+ ],
320336
+ "title": "getPublicPluginCodeResponse",
320337
+ "additionalProperties": false
320338
+ }
320339
+ }
320340
+ },
320341
+ "listPublicInterfaces": {
320342
+ "name": "listPublicInterfaces",
320343
+ "description": "List public interfaces",
320344
+ "method": "get",
320345
+ "section": "hub",
320346
+ "path": "/v1/admin/hub/interfaces",
320347
+ "disableDefaultParameters": {
320348
+ "x-workspace-id": true
320349
+ },
320350
+ "parameters": {
320351
+ "nextToken": {
320352
+ "in": "query",
320353
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
320354
+ "type": "string"
320355
+ },
320356
+ "name": {
320357
+ "in": "query",
320358
+ "type": "string",
320359
+ "description": "Filter all versions of an interface by name"
320360
+ },
320361
+ "version": {
320362
+ "in": "query",
320363
+ "type": "string",
320364
+ "description": "Filter an interface by name and version"
320365
+ }
320366
+ },
320367
+ "response": {
320368
+ "description": "Success",
320369
+ "schema": {
320370
+ "type": "object",
320371
+ "properties": {
320372
+ "interfaces": {
320373
+ "type": "array",
320374
+ "items": {
320375
+ "type": "object",
320376
+ "properties": {
320377
+ "id": {
320378
+ "type": "string",
320379
+ "minLength": 28,
320380
+ "maxLength": 36,
320381
+ "description": "ID of the [Interface](#schema_interface)"
320382
+ },
320383
+ "createdAt": {
320384
+ "type": "string",
320385
+ "format": "date-time",
320386
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
320387
+ },
320388
+ "updatedAt": {
320389
+ "type": "string",
320390
+ "format": "date-time",
320391
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
320392
+ },
320393
+ "name": {
320394
+ "type": "string",
320395
+ "maxLength": 200,
320396
+ "description": "Name of the [Interface](#schema_interface)"
320397
+ },
320398
+ "version": {
320399
+ "type": "string",
320400
+ "maxLength": 200,
320401
+ "description": "Version of the [Interface](#schema_interface)"
320402
+ },
320403
+ "title": {
320404
+ "type": "string",
320405
+ "minLength": 1,
320406
+ "maxLength": 64,
320407
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
320408
+ },
320409
+ "description": {
320410
+ "type": "string",
320411
+ "maxLength": 256,
320412
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
320413
+ },
320414
+ "iconUrl": {
320415
+ "type": "string",
320416
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
320417
+ },
320418
+ "readmeUrl": {
320419
+ "type": "string",
320420
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
320421
+ },
320422
+ "public": {
320423
+ "type": "boolean",
320424
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
320425
+ }
320426
+ },
320427
+ "required": [
320428
+ "id",
320429
+ "createdAt",
320430
+ "updatedAt",
320431
+ "name",
320432
+ "version",
320433
+ "title",
320434
+ "description",
320435
+ "iconUrl",
320436
+ "readmeUrl",
320437
+ "public"
320438
+ ]
320439
+ }
320440
+ },
320441
+ "meta": {
320442
+ "type": "object",
320443
+ "properties": {
320444
+ "nextToken": {
320445
+ "type": "string",
320446
+ "description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
320447
+ }
320448
+ },
320449
+ "additionalProperties": false
320450
+ }
320451
+ },
320452
+ "required": [
320453
+ "interfaces",
320454
+ "meta"
320455
+ ],
320456
+ "title": "listPublicInterfacesResponse",
320457
+ "additionalProperties": false
320458
+ }
320459
+ }
320460
+ },
320461
+ "getPublicInterfaceById": {
320462
+ "name": "getPublicInterfaceById",
320463
+ "description": "Get public interface by Id",
320464
+ "method": "get",
320465
+ "section": "hub",
320466
+ "path": "/v1/admin/hub/interfaces/{id}",
320467
+ "disableDefaultParameters": {
320468
+ "x-workspace-id": true
320469
+ },
320470
+ "parameters": {
320471
+ "id": {
320472
+ "type": "string",
320473
+ "description": "Interface ID",
320474
+ "in": "path"
320475
+ }
320476
+ },
320477
+ "response": {
320478
+ "description": "Success",
320479
+ "schema": {
320480
+ "type": "object",
320481
+ "properties": {
320482
+ "interface": {
320483
+ "type": "object",
320484
+ "properties": {
320485
+ "id": {
320486
+ "type": "string",
320487
+ "minLength": 28,
320488
+ "maxLength": 36,
320489
+ "description": "ID of the [Interface](#schema_interface)"
320490
+ },
320491
+ "createdAt": {
320492
+ "type": "string",
320493
+ "format": "date-time",
320494
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
320495
+ },
320496
+ "updatedAt": {
320497
+ "type": "string",
320498
+ "format": "date-time",
320499
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
320500
+ },
320501
+ "name": {
320502
+ "type": "string",
320503
+ "maxLength": 200,
320504
+ "description": "Name of the [Interface](#schema_interface)"
320505
+ },
320506
+ "version": {
320507
+ "type": "string",
320508
+ "maxLength": 200,
320509
+ "description": "Version of the [Interface](#schema_interface)"
320510
+ },
320511
+ "entities": {
320512
+ "type": "object",
320513
+ "additionalProperties": {
320514
+ "type": "object",
320515
+ "properties": {
320516
+ "title": {
320517
+ "type": "string",
320518
+ "maxLength": 64,
320519
+ "description": "Title of the entity"
320520
+ },
320521
+ "description": {
320522
+ "type": "string",
320523
+ "maxLength": 256,
320524
+ "description": "Description of the entity"
320525
+ },
320526
+ "schema": {
320527
+ "type": "object",
320528
+ "additionalProperties": true
320529
+ }
320530
+ },
320531
+ "required": [
320532
+ "schema"
320533
+ ],
320534
+ "description": "Entity definition",
320535
+ "additionalProperties": false
320536
+ }
320537
+ },
320538
+ "events": {
320539
+ "type": "object",
320540
+ "additionalProperties": {
320541
+ "type": "object",
320542
+ "properties": {
320543
+ "title": {
320544
+ "type": "string",
320545
+ "maxLength": 64,
320546
+ "description": "Title of the event"
320547
+ },
320548
+ "description": {
320549
+ "type": "string",
320550
+ "maxLength": 256,
320551
+ "description": "Description of the event"
320552
+ },
320553
+ "schema": {
320554
+ "type": "object",
320555
+ "additionalProperties": true
320556
+ },
320557
+ "attributes": {
320558
+ "type": "object",
320559
+ "additionalProperties": {
320560
+ "type": "string",
320561
+ "maxLength": 200
320562
+ },
320563
+ "description": "Optional attributes"
320564
+ }
320565
+ },
320566
+ "required": [
320567
+ "schema"
320568
+ ],
320569
+ "description": "Event Definition",
320570
+ "additionalProperties": false
320571
+ }
320572
+ },
320573
+ "actions": {
320574
+ "type": "object",
320575
+ "additionalProperties": {
320576
+ "type": "object",
320577
+ "properties": {
320578
+ "title": {
320579
+ "type": "string",
320580
+ "maxLength": 64,
320581
+ "description": "Title of the action"
320582
+ },
320583
+ "description": {
320584
+ "type": "string",
320585
+ "maxLength": 256,
320586
+ "description": "Description of the action"
320587
+ },
320588
+ "billable": {
320589
+ "type": "boolean"
320590
+ },
320591
+ "cacheable": {
320592
+ "type": "boolean"
320593
+ },
320594
+ "input": {
320595
+ "type": "object",
320596
+ "properties": {
320597
+ "schema": {
320598
+ "type": "object",
320599
+ "additionalProperties": true
320600
+ }
320601
+ },
320602
+ "required": [
320603
+ "schema"
320604
+ ],
320605
+ "additionalProperties": false
320606
+ },
320607
+ "output": {
320608
+ "type": "object",
320609
+ "properties": {
320610
+ "schema": {
320611
+ "type": "object",
320612
+ "additionalProperties": true
320613
+ }
320614
+ },
320615
+ "required": [
320616
+ "schema"
320617
+ ],
320618
+ "additionalProperties": false
320619
+ },
320620
+ "attributes": {
320621
+ "type": "object",
320622
+ "additionalProperties": {
320623
+ "type": "string",
320624
+ "maxLength": 200
320625
+ },
320626
+ "description": "Optional attributes"
320627
+ }
320628
+ },
320629
+ "required": [
320630
+ "input",
320631
+ "output"
320632
+ ],
320633
+ "description": "Action definition",
320634
+ "additionalProperties": false
320635
+ }
320636
+ },
320637
+ "channels": {
319404
320638
  "type": "object",
319405
- "properties": {
319406
- "interfaces": {
319407
- "type": "object",
319408
- "additionalProperties": {
320639
+ "additionalProperties": {
320640
+ "type": "object",
320641
+ "properties": {
320642
+ "title": {
320643
+ "type": "string",
320644
+ "maxLength": 64,
320645
+ "description": "Title of the channel"
320646
+ },
320647
+ "description": {
320648
+ "type": "string",
320649
+ "maxLength": 256,
320650
+ "description": "Description of the channel"
320651
+ },
320652
+ "messages": {
319409
320653
  "type": "object",
319410
- "properties": {
319411
- "id": {
319412
- "type": "string",
319413
- "minLength": 28,
319414
- "maxLength": 36
319415
- },
319416
- "name": {
319417
- "type": "string",
319418
- "maxLength": 200
320654
+ "additionalProperties": {
320655
+ "type": "object",
320656
+ "properties": {
320657
+ "schema": {
320658
+ "type": "object",
320659
+ "additionalProperties": true
320660
+ }
319419
320661
  },
319420
- "version": {
319421
- "type": "string",
319422
- "maxLength": 200
319423
- }
319424
- },
319425
- "required": [
319426
- "id",
319427
- "name",
319428
- "version"
319429
- ],
319430
- "additionalProperties": false
320662
+ "required": [
320663
+ "schema"
320664
+ ],
320665
+ "description": "Message definition",
320666
+ "additionalProperties": false
320667
+ }
319431
320668
  }
319432
320669
  },
319433
- "integrations": {
319434
- "type": "object",
319435
- "additionalProperties": {
319436
- "type": "object",
319437
- "properties": {
319438
- "id": {
319439
- "type": "string",
319440
- "minLength": 28,
319441
- "maxLength": 36
319442
- },
319443
- "name": {
319444
- "type": "string",
319445
- "maxLength": 200
319446
- },
319447
- "version": {
319448
- "type": "string",
319449
- "maxLength": 200
319450
- }
319451
- },
319452
- "required": [
319453
- "id",
319454
- "name",
319455
- "version"
319456
- ],
319457
- "additionalProperties": false
319458
- }
319459
- }
319460
- },
319461
- "required": [
319462
- "interfaces",
319463
- "integrations"
319464
- ],
319465
- "additionalProperties": false
319466
- },
319467
- "user": {
319468
- "type": "object",
319469
- "properties": {
319470
- "tags": {
319471
- "type": "object",
319472
- "additionalProperties": {
319473
- "type": "object",
319474
- "properties": {
319475
- "title": {
319476
- "type": "string",
319477
- "maxLength": 64,
319478
- "description": "Title of the tag"
319479
- },
319480
- "description": {
319481
- "type": "string",
319482
- "maxLength": 256,
319483
- "description": "Description of the tag"
319484
- }
319485
- },
319486
- "description": "Definition of a tag that can be provided on the object",
319487
- "additionalProperties": false
319488
- }
319489
- }
319490
- },
319491
- "required": [
319492
- "tags"
319493
- ],
319494
- "description": "User object configuration",
319495
- "additionalProperties": false
320670
+ "required": [
320671
+ "messages"
320672
+ ],
320673
+ "additionalProperties": false
320674
+ }
319496
320675
  },
319497
- "conversation": {
320676
+ "nameTemplate": {
319498
320677
  "type": "object",
319499
320678
  "properties": {
319500
- "tags": {
319501
- "type": "object",
319502
- "additionalProperties": {
319503
- "type": "object",
319504
- "properties": {
319505
- "title": {
319506
- "type": "string",
319507
- "maxLength": 64,
319508
- "description": "Title of the tag"
319509
- },
319510
- "description": {
319511
- "type": "string",
319512
- "maxLength": 256,
319513
- "description": "Description of the tag"
319514
- }
319515
- },
319516
- "description": "Definition of a tag that can be provided on the object",
319517
- "additionalProperties": false
319518
- }
320679
+ "script": {
320680
+ "type": "string",
320681
+ "maxLength": 2e3
320682
+ },
320683
+ "language": {
320684
+ "type": "string",
320685
+ "maxLength": 200
319519
320686
  }
319520
320687
  },
319521
320688
  "required": [
319522
- "tags"
320689
+ "script",
320690
+ "language"
319523
320691
  ],
319524
- "description": "Conversation object configuration",
320692
+ "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
319525
320693
  "additionalProperties": false
319526
320694
  },
319527
320695
  "title": {
319528
320696
  "type": "string",
319529
320697
  "minLength": 1,
319530
320698
  "maxLength": 64,
319531
- "description": "Title of the plugin. This is the name that will be displayed in the UI"
320699
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
319532
320700
  },
319533
320701
  "description": {
319534
320702
  "type": "string",
319535
320703
  "maxLength": 256,
319536
- "description": "Description of the plugin. This is the description that will be displayed in the UI"
320704
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
319537
320705
  },
319538
320706
  "iconUrl": {
319539
320707
  "type": "string",
319540
- "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
320708
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
319541
320709
  },
319542
320710
  "readmeUrl": {
319543
320711
  "type": "string",
319544
- "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
320712
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
319545
320713
  },
319546
320714
  "public": {
319547
320715
  "type": "boolean",
319548
- "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
320716
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
319549
320717
  }
319550
320718
  },
319551
320719
  "required": [
319552
320720
  "id",
319553
- "name",
319554
- "version",
319555
320721
  "createdAt",
319556
320722
  "updatedAt",
319557
- "configuration",
319558
- "states",
320723
+ "name",
320724
+ "version",
320725
+ "entities",
319559
320726
  "events",
319560
320727
  "actions",
319561
- "dependencies",
319562
- "user",
319563
- "conversation",
320728
+ "channels",
319564
320729
  "title",
319565
320730
  "description",
319566
320731
  "iconUrl",
@@ -319571,51 +320736,299 @@ var state5 = {
319571
320736
  }
319572
320737
  },
319573
320738
  "required": [
319574
- "plugin"
320739
+ "interface"
319575
320740
  ],
319576
- "title": "getPublicPluginResponse",
320741
+ "title": "getPublicInterfaceByIdResponse",
319577
320742
  "additionalProperties": false
319578
320743
  }
319579
320744
  }
319580
320745
  },
319581
- "getPublicPluginCode": {
319582
- "name": "getPublicPluginCode",
319583
- "description": "Get public plugin code",
320746
+ "getPublicInterface": {
320747
+ "name": "getPublicInterface",
320748
+ "description": "Get public interface by name and version",
319584
320749
  "method": "get",
319585
- "path": "/v1/admin/hub/plugins/{id}/code/{platform}",
320750
+ "section": "hub",
320751
+ "path": "/v1/admin/hub/interfaces/{name}/{version}",
319586
320752
  "disableDefaultParameters": {
319587
320753
  "x-workspace-id": true
319588
320754
  },
319589
- "section": "hub",
319590
320755
  "parameters": {
319591
- "id": {
319592
- "in": "path",
320756
+ "name": {
319593
320757
  "type": "string",
319594
- "description": "Plugin id"
320758
+ "description": "Interface Name",
320759
+ "in": "path"
319595
320760
  },
319596
- "platform": {
319597
- "in": "path",
320761
+ "version": {
319598
320762
  "type": "string",
319599
- "enum": [
319600
- "node",
319601
- "browser"
319602
- ],
319603
- "description": "Platform"
320763
+ "description": "Interface version.",
320764
+ "in": "path"
319604
320765
  }
319605
320766
  },
319606
320767
  "response": {
319607
- "description": "Plugin code",
320768
+ "description": "Success",
319608
320769
  "schema": {
319609
320770
  "type": "object",
319610
320771
  "properties": {
319611
- "code": {
319612
- "type": "string"
320772
+ "interface": {
320773
+ "type": "object",
320774
+ "properties": {
320775
+ "id": {
320776
+ "type": "string",
320777
+ "minLength": 28,
320778
+ "maxLength": 36,
320779
+ "description": "ID of the [Interface](#schema_interface)"
320780
+ },
320781
+ "createdAt": {
320782
+ "type": "string",
320783
+ "format": "date-time",
320784
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
320785
+ },
320786
+ "updatedAt": {
320787
+ "type": "string",
320788
+ "format": "date-time",
320789
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
320790
+ },
320791
+ "name": {
320792
+ "type": "string",
320793
+ "maxLength": 200,
320794
+ "description": "Name of the [Interface](#schema_interface)"
320795
+ },
320796
+ "version": {
320797
+ "type": "string",
320798
+ "maxLength": 200,
320799
+ "description": "Version of the [Interface](#schema_interface)"
320800
+ },
320801
+ "entities": {
320802
+ "type": "object",
320803
+ "additionalProperties": {
320804
+ "type": "object",
320805
+ "properties": {
320806
+ "title": {
320807
+ "type": "string",
320808
+ "maxLength": 64,
320809
+ "description": "Title of the entity"
320810
+ },
320811
+ "description": {
320812
+ "type": "string",
320813
+ "maxLength": 256,
320814
+ "description": "Description of the entity"
320815
+ },
320816
+ "schema": {
320817
+ "type": "object",
320818
+ "additionalProperties": true
320819
+ }
320820
+ },
320821
+ "required": [
320822
+ "schema"
320823
+ ],
320824
+ "description": "Entity definition",
320825
+ "additionalProperties": false
320826
+ }
320827
+ },
320828
+ "events": {
320829
+ "type": "object",
320830
+ "additionalProperties": {
320831
+ "type": "object",
320832
+ "properties": {
320833
+ "title": {
320834
+ "type": "string",
320835
+ "maxLength": 64,
320836
+ "description": "Title of the event"
320837
+ },
320838
+ "description": {
320839
+ "type": "string",
320840
+ "maxLength": 256,
320841
+ "description": "Description of the event"
320842
+ },
320843
+ "schema": {
320844
+ "type": "object",
320845
+ "additionalProperties": true
320846
+ },
320847
+ "attributes": {
320848
+ "type": "object",
320849
+ "additionalProperties": {
320850
+ "type": "string",
320851
+ "maxLength": 200
320852
+ },
320853
+ "description": "Optional attributes"
320854
+ }
320855
+ },
320856
+ "required": [
320857
+ "schema"
320858
+ ],
320859
+ "description": "Event Definition",
320860
+ "additionalProperties": false
320861
+ }
320862
+ },
320863
+ "actions": {
320864
+ "type": "object",
320865
+ "additionalProperties": {
320866
+ "type": "object",
320867
+ "properties": {
320868
+ "title": {
320869
+ "type": "string",
320870
+ "maxLength": 64,
320871
+ "description": "Title of the action"
320872
+ },
320873
+ "description": {
320874
+ "type": "string",
320875
+ "maxLength": 256,
320876
+ "description": "Description of the action"
320877
+ },
320878
+ "billable": {
320879
+ "type": "boolean"
320880
+ },
320881
+ "cacheable": {
320882
+ "type": "boolean"
320883
+ },
320884
+ "input": {
320885
+ "type": "object",
320886
+ "properties": {
320887
+ "schema": {
320888
+ "type": "object",
320889
+ "additionalProperties": true
320890
+ }
320891
+ },
320892
+ "required": [
320893
+ "schema"
320894
+ ],
320895
+ "additionalProperties": false
320896
+ },
320897
+ "output": {
320898
+ "type": "object",
320899
+ "properties": {
320900
+ "schema": {
320901
+ "type": "object",
320902
+ "additionalProperties": true
320903
+ }
320904
+ },
320905
+ "required": [
320906
+ "schema"
320907
+ ],
320908
+ "additionalProperties": false
320909
+ },
320910
+ "attributes": {
320911
+ "type": "object",
320912
+ "additionalProperties": {
320913
+ "type": "string",
320914
+ "maxLength": 200
320915
+ },
320916
+ "description": "Optional attributes"
320917
+ }
320918
+ },
320919
+ "required": [
320920
+ "input",
320921
+ "output"
320922
+ ],
320923
+ "description": "Action definition",
320924
+ "additionalProperties": false
320925
+ }
320926
+ },
320927
+ "channels": {
320928
+ "type": "object",
320929
+ "additionalProperties": {
320930
+ "type": "object",
320931
+ "properties": {
320932
+ "title": {
320933
+ "type": "string",
320934
+ "maxLength": 64,
320935
+ "description": "Title of the channel"
320936
+ },
320937
+ "description": {
320938
+ "type": "string",
320939
+ "maxLength": 256,
320940
+ "description": "Description of the channel"
320941
+ },
320942
+ "messages": {
320943
+ "type": "object",
320944
+ "additionalProperties": {
320945
+ "type": "object",
320946
+ "properties": {
320947
+ "schema": {
320948
+ "type": "object",
320949
+ "additionalProperties": true
320950
+ }
320951
+ },
320952
+ "required": [
320953
+ "schema"
320954
+ ],
320955
+ "description": "Message definition",
320956
+ "additionalProperties": false
320957
+ }
320958
+ }
320959
+ },
320960
+ "required": [
320961
+ "messages"
320962
+ ],
320963
+ "additionalProperties": false
320964
+ }
320965
+ },
320966
+ "nameTemplate": {
320967
+ "type": "object",
320968
+ "properties": {
320969
+ "script": {
320970
+ "type": "string",
320971
+ "maxLength": 2e3
320972
+ },
320973
+ "language": {
320974
+ "type": "string",
320975
+ "maxLength": 200
320976
+ }
320977
+ },
320978
+ "required": [
320979
+ "script",
320980
+ "language"
320981
+ ],
320982
+ "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
320983
+ "additionalProperties": false
320984
+ },
320985
+ "title": {
320986
+ "type": "string",
320987
+ "minLength": 1,
320988
+ "maxLength": 64,
320989
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
320990
+ },
320991
+ "description": {
320992
+ "type": "string",
320993
+ "maxLength": 256,
320994
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
320995
+ },
320996
+ "iconUrl": {
320997
+ "type": "string",
320998
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
320999
+ },
321000
+ "readmeUrl": {
321001
+ "type": "string",
321002
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
321003
+ },
321004
+ "public": {
321005
+ "type": "boolean",
321006
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
321007
+ }
321008
+ },
321009
+ "required": [
321010
+ "id",
321011
+ "createdAt",
321012
+ "updatedAt",
321013
+ "name",
321014
+ "version",
321015
+ "entities",
321016
+ "events",
321017
+ "actions",
321018
+ "channels",
321019
+ "title",
321020
+ "description",
321021
+ "iconUrl",
321022
+ "readmeUrl",
321023
+ "public"
321024
+ ],
321025
+ "additionalProperties": false
319613
321026
  }
319614
321027
  },
319615
321028
  "required": [
319616
- "code"
321029
+ "interface"
319617
321030
  ],
319618
- "title": "getPublicPluginCodeResponse",
321031
+ "title": "getPublicInterfaceResponse",
319619
321032
  "additionalProperties": false
319620
321033
  }
319621
321034
  }
@@ -320647,6 +322060,12 @@ var state5 = {
320647
322060
  "type": "string",
320648
322061
  "required": false
320649
322062
  },
322063
+ "messageContains": {
322064
+ "in": "query",
322065
+ "description": "Filter logs where the message contains this substring",
322066
+ "type": "string",
322067
+ "required": false
322068
+ },
320650
322069
  "nextToken": {
320651
322070
  "in": "query",
320652
322071
  "description": "Token to get the next page of logs",
@@ -326373,6 +327792,12 @@ var state5 = {
326373
327792
  "type": "string",
326374
327793
  "required": false
326375
327794
  },
327795
+ "messageContains": {
327796
+ "in": "query",
327797
+ "description": "Filter logs where the message contains this substring",
327798
+ "type": "string",
327799
+ "required": false
327800
+ },
326376
327801
  "nextToken": {
326377
327802
  "in": "query",
326378
327803
  "description": "Token to get the next page of logs",
@@ -327125,6 +328550,11 @@ var state5 = {
327125
328550
  "in": "query",
327126
328551
  "type": "string",
327127
328552
  "description": "Filter all versions of an interface by name"
328553
+ },
328554
+ "version": {
328555
+ "in": "query",
328556
+ "type": "string",
328557
+ "description": "Filter an interface by name and version"
327128
328558
  }
327129
328559
  },
327130
328560
  "response": {
@@ -331445,7 +332875,7 @@ var state5 = {
331445
332875
  "title": "Botpress API",
331446
332876
  "description": "API for Botpress Cloud",
331447
332877
  "server": "https://api.botpress.cloud",
331448
- "version": "1.12.0",
332878
+ "version": "1.13.1",
331449
332879
  "prefix": "v1"
331450
332880
  },
331451
332881
  "errors": [
@@ -331703,6 +333133,9 @@ var state5 = {
331703
333133
  "getPublicPluginByIdResponse": true,
331704
333134
  "getPublicPluginResponse": true,
331705
333135
  "getPublicPluginCodeResponse": true,
333136
+ "listPublicInterfacesResponse": true,
333137
+ "getPublicInterfaceByIdResponse": true,
333138
+ "getPublicInterfaceResponse": true,
331706
333139
  "createBotResponse": true,
331707
333140
  "updateBotResponse": true,
331708
333141
  "transferBotResponse": true,
@@ -335237,7 +336670,10 @@ var state5 = {
335237
336670
  "listPublicPlugins",
335238
336671
  "getPublicPluginById",
335239
336672
  "getPublicPlugin",
335240
- "getPublicPluginCode"
336673
+ "getPublicPluginCode",
336674
+ "listPublicInterfaces",
336675
+ "getPublicInterfaceById",
336676
+ "getPublicInterface"
335241
336677
  ]
335242
336678
  },
335243
336679
  {