@botpress/api 1.11.0 → 1.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/gen/state.ts CHANGED
@@ -5639,6 +5639,701 @@ export const state = {
5639
5639
  }
5640
5640
  }
5641
5641
  },
5642
+ "listPublicInterfaces": {
5643
+ "name": "listPublicInterfaces",
5644
+ "description": "List public interfaces",
5645
+ "method": "get",
5646
+ "section": "hub",
5647
+ "path": "/v1/admin/hub/interfaces",
5648
+ "disableDefaultParameters": {
5649
+ "x-workspace-id": true
5650
+ },
5651
+ "parameters": {
5652
+ "nextToken": {
5653
+ "in": "query",
5654
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
5655
+ "type": "string"
5656
+ },
5657
+ "name": {
5658
+ "in": "query",
5659
+ "type": "string",
5660
+ "description": "Filter all versions of an interface by name"
5661
+ },
5662
+ "version": {
5663
+ "in": "query",
5664
+ "type": "string",
5665
+ "description": "Filter an interface by name and version"
5666
+ }
5667
+ },
5668
+ "response": {
5669
+ "description": "Success",
5670
+ "schema": {
5671
+ "type": "object",
5672
+ "properties": {
5673
+ "interfaces": {
5674
+ "type": "array",
5675
+ "items": {
5676
+ "type": "object",
5677
+ "properties": {
5678
+ "id": {
5679
+ "type": "string",
5680
+ "minLength": 28,
5681
+ "maxLength": 36,
5682
+ "description": "ID of the [Interface](#schema_interface)"
5683
+ },
5684
+ "createdAt": {
5685
+ "type": "string",
5686
+ "format": "date-time",
5687
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
5688
+ },
5689
+ "updatedAt": {
5690
+ "type": "string",
5691
+ "format": "date-time",
5692
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
5693
+ },
5694
+ "name": {
5695
+ "type": "string",
5696
+ "maxLength": 200,
5697
+ "description": "Name of the [Interface](#schema_interface)"
5698
+ },
5699
+ "version": {
5700
+ "type": "string",
5701
+ "maxLength": 200,
5702
+ "description": "Version of the [Interface](#schema_interface)"
5703
+ },
5704
+ "title": {
5705
+ "type": "string",
5706
+ "minLength": 1,
5707
+ "maxLength": 64,
5708
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
5709
+ },
5710
+ "description": {
5711
+ "type": "string",
5712
+ "maxLength": 256,
5713
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
5714
+ },
5715
+ "iconUrl": {
5716
+ "type": "string",
5717
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
5718
+ },
5719
+ "readmeUrl": {
5720
+ "type": "string",
5721
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
5722
+ },
5723
+ "public": {
5724
+ "type": "boolean",
5725
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
5726
+ }
5727
+ },
5728
+ "required": [
5729
+ "id",
5730
+ "createdAt",
5731
+ "updatedAt",
5732
+ "name",
5733
+ "version",
5734
+ "title",
5735
+ "description",
5736
+ "iconUrl",
5737
+ "readmeUrl",
5738
+ "public"
5739
+ ]
5740
+ }
5741
+ },
5742
+ "meta": {
5743
+ "type": "object",
5744
+ "properties": {
5745
+ "nextToken": {
5746
+ "type": "string",
5747
+ "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."
5748
+ }
5749
+ },
5750
+ "additionalProperties": false
5751
+ }
5752
+ },
5753
+ "required": [
5754
+ "interfaces",
5755
+ "meta"
5756
+ ],
5757
+ "title": "listPublicInterfacesResponse",
5758
+ "additionalProperties": false
5759
+ }
5760
+ }
5761
+ },
5762
+ "getPublicInterfaceById": {
5763
+ "name": "getPublicInterfaceById",
5764
+ "description": "Get public interface by Id",
5765
+ "method": "get",
5766
+ "section": "hub",
5767
+ "path": "/v1/admin/hub/interfaces/{id}",
5768
+ "disableDefaultParameters": {
5769
+ "x-workspace-id": true
5770
+ },
5771
+ "parameters": {
5772
+ "id": {
5773
+ "type": "string",
5774
+ "description": "Interface ID",
5775
+ "in": "path"
5776
+ }
5777
+ },
5778
+ "response": {
5779
+ "description": "Success",
5780
+ "schema": {
5781
+ "type": "object",
5782
+ "properties": {
5783
+ "interface": {
5784
+ "type": "object",
5785
+ "properties": {
5786
+ "id": {
5787
+ "type": "string",
5788
+ "minLength": 28,
5789
+ "maxLength": 36,
5790
+ "description": "ID of the [Interface](#schema_interface)"
5791
+ },
5792
+ "createdAt": {
5793
+ "type": "string",
5794
+ "format": "date-time",
5795
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
5796
+ },
5797
+ "updatedAt": {
5798
+ "type": "string",
5799
+ "format": "date-time",
5800
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
5801
+ },
5802
+ "name": {
5803
+ "type": "string",
5804
+ "maxLength": 200,
5805
+ "description": "Name of the [Interface](#schema_interface)"
5806
+ },
5807
+ "version": {
5808
+ "type": "string",
5809
+ "maxLength": 200,
5810
+ "description": "Version of the [Interface](#schema_interface)"
5811
+ },
5812
+ "entities": {
5813
+ "type": "object",
5814
+ "additionalProperties": {
5815
+ "type": "object",
5816
+ "properties": {
5817
+ "title": {
5818
+ "type": "string",
5819
+ "maxLength": 64,
5820
+ "description": "Title of the entity"
5821
+ },
5822
+ "description": {
5823
+ "type": "string",
5824
+ "maxLength": 256,
5825
+ "description": "Description of the entity"
5826
+ },
5827
+ "schema": {
5828
+ "type": "object",
5829
+ "additionalProperties": true
5830
+ }
5831
+ },
5832
+ "required": [
5833
+ "schema"
5834
+ ],
5835
+ "description": "Entity definition",
5836
+ "additionalProperties": false
5837
+ }
5838
+ },
5839
+ "events": {
5840
+ "type": "object",
5841
+ "additionalProperties": {
5842
+ "type": "object",
5843
+ "properties": {
5844
+ "title": {
5845
+ "type": "string",
5846
+ "maxLength": 64,
5847
+ "description": "Title of the event"
5848
+ },
5849
+ "description": {
5850
+ "type": "string",
5851
+ "maxLength": 256,
5852
+ "description": "Description of the event"
5853
+ },
5854
+ "schema": {
5855
+ "type": "object",
5856
+ "additionalProperties": true
5857
+ },
5858
+ "attributes": {
5859
+ "type": "object",
5860
+ "additionalProperties": {
5861
+ "type": "string",
5862
+ "maxLength": 200
5863
+ },
5864
+ "description": "Optional attributes"
5865
+ }
5866
+ },
5867
+ "required": [
5868
+ "schema"
5869
+ ],
5870
+ "description": "Event Definition",
5871
+ "additionalProperties": false
5872
+ }
5873
+ },
5874
+ "actions": {
5875
+ "type": "object",
5876
+ "additionalProperties": {
5877
+ "type": "object",
5878
+ "properties": {
5879
+ "title": {
5880
+ "type": "string",
5881
+ "maxLength": 64,
5882
+ "description": "Title of the action"
5883
+ },
5884
+ "description": {
5885
+ "type": "string",
5886
+ "maxLength": 256,
5887
+ "description": "Description of the action"
5888
+ },
5889
+ "billable": {
5890
+ "type": "boolean"
5891
+ },
5892
+ "cacheable": {
5893
+ "type": "boolean"
5894
+ },
5895
+ "input": {
5896
+ "type": "object",
5897
+ "properties": {
5898
+ "schema": {
5899
+ "type": "object",
5900
+ "additionalProperties": true
5901
+ }
5902
+ },
5903
+ "required": [
5904
+ "schema"
5905
+ ],
5906
+ "additionalProperties": false
5907
+ },
5908
+ "output": {
5909
+ "type": "object",
5910
+ "properties": {
5911
+ "schema": {
5912
+ "type": "object",
5913
+ "additionalProperties": true
5914
+ }
5915
+ },
5916
+ "required": [
5917
+ "schema"
5918
+ ],
5919
+ "additionalProperties": false
5920
+ },
5921
+ "attributes": {
5922
+ "type": "object",
5923
+ "additionalProperties": {
5924
+ "type": "string",
5925
+ "maxLength": 200
5926
+ },
5927
+ "description": "Optional attributes"
5928
+ }
5929
+ },
5930
+ "required": [
5931
+ "input",
5932
+ "output"
5933
+ ],
5934
+ "description": "Action definition",
5935
+ "additionalProperties": false
5936
+ }
5937
+ },
5938
+ "channels": {
5939
+ "type": "object",
5940
+ "additionalProperties": {
5941
+ "type": "object",
5942
+ "properties": {
5943
+ "title": {
5944
+ "type": "string",
5945
+ "maxLength": 64,
5946
+ "description": "Title of the channel"
5947
+ },
5948
+ "description": {
5949
+ "type": "string",
5950
+ "maxLength": 256,
5951
+ "description": "Description of the channel"
5952
+ },
5953
+ "messages": {
5954
+ "type": "object",
5955
+ "additionalProperties": {
5956
+ "type": "object",
5957
+ "properties": {
5958
+ "schema": {
5959
+ "type": "object",
5960
+ "additionalProperties": true
5961
+ }
5962
+ },
5963
+ "required": [
5964
+ "schema"
5965
+ ],
5966
+ "description": "Message definition",
5967
+ "additionalProperties": false
5968
+ }
5969
+ }
5970
+ },
5971
+ "required": [
5972
+ "messages"
5973
+ ],
5974
+ "additionalProperties": false
5975
+ }
5976
+ },
5977
+ "nameTemplate": {
5978
+ "type": "object",
5979
+ "properties": {
5980
+ "script": {
5981
+ "type": "string",
5982
+ "maxLength": 2000
5983
+ },
5984
+ "language": {
5985
+ "type": "string",
5986
+ "maxLength": 200
5987
+ }
5988
+ },
5989
+ "required": [
5990
+ "script",
5991
+ "language"
5992
+ ],
5993
+ "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
5994
+ "additionalProperties": false
5995
+ },
5996
+ "title": {
5997
+ "type": "string",
5998
+ "minLength": 1,
5999
+ "maxLength": 64,
6000
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
6001
+ },
6002
+ "description": {
6003
+ "type": "string",
6004
+ "maxLength": 256,
6005
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
6006
+ },
6007
+ "iconUrl": {
6008
+ "type": "string",
6009
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
6010
+ },
6011
+ "readmeUrl": {
6012
+ "type": "string",
6013
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
6014
+ },
6015
+ "public": {
6016
+ "type": "boolean",
6017
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
6018
+ }
6019
+ },
6020
+ "required": [
6021
+ "id",
6022
+ "createdAt",
6023
+ "updatedAt",
6024
+ "name",
6025
+ "version",
6026
+ "entities",
6027
+ "events",
6028
+ "actions",
6029
+ "channels",
6030
+ "title",
6031
+ "description",
6032
+ "iconUrl",
6033
+ "readmeUrl",
6034
+ "public"
6035
+ ],
6036
+ "additionalProperties": false
6037
+ }
6038
+ },
6039
+ "required": [
6040
+ "interface"
6041
+ ],
6042
+ "title": "getPublicInterfaceByIdResponse",
6043
+ "additionalProperties": false
6044
+ }
6045
+ }
6046
+ },
6047
+ "getPublicInterface": {
6048
+ "name": "getPublicInterface",
6049
+ "description": "Get public interface by name and version",
6050
+ "method": "get",
6051
+ "section": "hub",
6052
+ "path": "/v1/admin/hub/interfaces/{name}/{version}",
6053
+ "disableDefaultParameters": {
6054
+ "x-workspace-id": true
6055
+ },
6056
+ "parameters": {
6057
+ "name": {
6058
+ "type": "string",
6059
+ "description": "Interface Name",
6060
+ "in": "path"
6061
+ },
6062
+ "version": {
6063
+ "type": "string",
6064
+ "description": "Interface version.",
6065
+ "in": "path"
6066
+ }
6067
+ },
6068
+ "response": {
6069
+ "description": "Success",
6070
+ "schema": {
6071
+ "type": "object",
6072
+ "properties": {
6073
+ "interface": {
6074
+ "type": "object",
6075
+ "properties": {
6076
+ "id": {
6077
+ "type": "string",
6078
+ "minLength": 28,
6079
+ "maxLength": 36,
6080
+ "description": "ID of the [Interface](#schema_interface)"
6081
+ },
6082
+ "createdAt": {
6083
+ "type": "string",
6084
+ "format": "date-time",
6085
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
6086
+ },
6087
+ "updatedAt": {
6088
+ "type": "string",
6089
+ "format": "date-time",
6090
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
6091
+ },
6092
+ "name": {
6093
+ "type": "string",
6094
+ "maxLength": 200,
6095
+ "description": "Name of the [Interface](#schema_interface)"
6096
+ },
6097
+ "version": {
6098
+ "type": "string",
6099
+ "maxLength": 200,
6100
+ "description": "Version of the [Interface](#schema_interface)"
6101
+ },
6102
+ "entities": {
6103
+ "type": "object",
6104
+ "additionalProperties": {
6105
+ "type": "object",
6106
+ "properties": {
6107
+ "title": {
6108
+ "type": "string",
6109
+ "maxLength": 64,
6110
+ "description": "Title of the entity"
6111
+ },
6112
+ "description": {
6113
+ "type": "string",
6114
+ "maxLength": 256,
6115
+ "description": "Description of the entity"
6116
+ },
6117
+ "schema": {
6118
+ "type": "object",
6119
+ "additionalProperties": true
6120
+ }
6121
+ },
6122
+ "required": [
6123
+ "schema"
6124
+ ],
6125
+ "description": "Entity definition",
6126
+ "additionalProperties": false
6127
+ }
6128
+ },
6129
+ "events": {
6130
+ "type": "object",
6131
+ "additionalProperties": {
6132
+ "type": "object",
6133
+ "properties": {
6134
+ "title": {
6135
+ "type": "string",
6136
+ "maxLength": 64,
6137
+ "description": "Title of the event"
6138
+ },
6139
+ "description": {
6140
+ "type": "string",
6141
+ "maxLength": 256,
6142
+ "description": "Description of the event"
6143
+ },
6144
+ "schema": {
6145
+ "type": "object",
6146
+ "additionalProperties": true
6147
+ },
6148
+ "attributes": {
6149
+ "type": "object",
6150
+ "additionalProperties": {
6151
+ "type": "string",
6152
+ "maxLength": 200
6153
+ },
6154
+ "description": "Optional attributes"
6155
+ }
6156
+ },
6157
+ "required": [
6158
+ "schema"
6159
+ ],
6160
+ "description": "Event Definition",
6161
+ "additionalProperties": false
6162
+ }
6163
+ },
6164
+ "actions": {
6165
+ "type": "object",
6166
+ "additionalProperties": {
6167
+ "type": "object",
6168
+ "properties": {
6169
+ "title": {
6170
+ "type": "string",
6171
+ "maxLength": 64,
6172
+ "description": "Title of the action"
6173
+ },
6174
+ "description": {
6175
+ "type": "string",
6176
+ "maxLength": 256,
6177
+ "description": "Description of the action"
6178
+ },
6179
+ "billable": {
6180
+ "type": "boolean"
6181
+ },
6182
+ "cacheable": {
6183
+ "type": "boolean"
6184
+ },
6185
+ "input": {
6186
+ "type": "object",
6187
+ "properties": {
6188
+ "schema": {
6189
+ "type": "object",
6190
+ "additionalProperties": true
6191
+ }
6192
+ },
6193
+ "required": [
6194
+ "schema"
6195
+ ],
6196
+ "additionalProperties": false
6197
+ },
6198
+ "output": {
6199
+ "type": "object",
6200
+ "properties": {
6201
+ "schema": {
6202
+ "type": "object",
6203
+ "additionalProperties": true
6204
+ }
6205
+ },
6206
+ "required": [
6207
+ "schema"
6208
+ ],
6209
+ "additionalProperties": false
6210
+ },
6211
+ "attributes": {
6212
+ "type": "object",
6213
+ "additionalProperties": {
6214
+ "type": "string",
6215
+ "maxLength": 200
6216
+ },
6217
+ "description": "Optional attributes"
6218
+ }
6219
+ },
6220
+ "required": [
6221
+ "input",
6222
+ "output"
6223
+ ],
6224
+ "description": "Action definition",
6225
+ "additionalProperties": false
6226
+ }
6227
+ },
6228
+ "channels": {
6229
+ "type": "object",
6230
+ "additionalProperties": {
6231
+ "type": "object",
6232
+ "properties": {
6233
+ "title": {
6234
+ "type": "string",
6235
+ "maxLength": 64,
6236
+ "description": "Title of the channel"
6237
+ },
6238
+ "description": {
6239
+ "type": "string",
6240
+ "maxLength": 256,
6241
+ "description": "Description of the channel"
6242
+ },
6243
+ "messages": {
6244
+ "type": "object",
6245
+ "additionalProperties": {
6246
+ "type": "object",
6247
+ "properties": {
6248
+ "schema": {
6249
+ "type": "object",
6250
+ "additionalProperties": true
6251
+ }
6252
+ },
6253
+ "required": [
6254
+ "schema"
6255
+ ],
6256
+ "description": "Message definition",
6257
+ "additionalProperties": false
6258
+ }
6259
+ }
6260
+ },
6261
+ "required": [
6262
+ "messages"
6263
+ ],
6264
+ "additionalProperties": false
6265
+ }
6266
+ },
6267
+ "nameTemplate": {
6268
+ "type": "object",
6269
+ "properties": {
6270
+ "script": {
6271
+ "type": "string",
6272
+ "maxLength": 2000
6273
+ },
6274
+ "language": {
6275
+ "type": "string",
6276
+ "maxLength": 200
6277
+ }
6278
+ },
6279
+ "required": [
6280
+ "script",
6281
+ "language"
6282
+ ],
6283
+ "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
6284
+ "additionalProperties": false
6285
+ },
6286
+ "title": {
6287
+ "type": "string",
6288
+ "minLength": 1,
6289
+ "maxLength": 64,
6290
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
6291
+ },
6292
+ "description": {
6293
+ "type": "string",
6294
+ "maxLength": 256,
6295
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
6296
+ },
6297
+ "iconUrl": {
6298
+ "type": "string",
6299
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
6300
+ },
6301
+ "readmeUrl": {
6302
+ "type": "string",
6303
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
6304
+ },
6305
+ "public": {
6306
+ "type": "boolean",
6307
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
6308
+ }
6309
+ },
6310
+ "required": [
6311
+ "id",
6312
+ "createdAt",
6313
+ "updatedAt",
6314
+ "name",
6315
+ "version",
6316
+ "entities",
6317
+ "events",
6318
+ "actions",
6319
+ "channels",
6320
+ "title",
6321
+ "description",
6322
+ "iconUrl",
6323
+ "readmeUrl",
6324
+ "public"
6325
+ ],
6326
+ "additionalProperties": false
6327
+ }
6328
+ },
6329
+ "required": [
6330
+ "interface"
6331
+ ],
6332
+ "title": "getPublicInterfaceResponse",
6333
+ "additionalProperties": false
6334
+ }
6335
+ }
6336
+ },
5642
6337
  "createBot": {
5643
6338
  "name": "createBot",
5644
6339
  "description": "Create bot",
@@ -13144,6 +13839,11 @@ export const state = {
13144
13839
  "in": "query",
13145
13840
  "type": "string",
13146
13841
  "description": "Filter all versions of an interface by name"
13842
+ },
13843
+ "version": {
13844
+ "in": "query",
13845
+ "type": "string",
13846
+ "description": "Filter an interface by name and version"
13147
13847
  }
13148
13848
  },
13149
13849
  "response": {
@@ -14481,14 +15181,44 @@ export const state = {
14481
15181
  "items": {
14482
15182
  "type": "object",
14483
15183
  "properties": {
15184
+ "key": {
15185
+ "type": "string"
15186
+ },
14484
15187
  "date": {
14485
15188
  "type": "string"
14486
15189
  },
14487
15190
  "value": {
14488
15191
  "type": "number"
15192
+ },
15193
+ "metadata": {
15194
+ "type": "object",
15195
+ "properties": {
15196
+ "botId": {
15197
+ "type": "string"
15198
+ },
15199
+ "type": {
15200
+ "type": "string",
15201
+ "enum": [
15202
+ "IntegrationAction",
15203
+ "FileIndexing"
15204
+ ]
15205
+ },
15206
+ "subtype": {
15207
+ "type": "string"
15208
+ },
15209
+ "source": {
15210
+ "type": "string"
15211
+ }
15212
+ },
15213
+ "required": [
15214
+ "botId",
15215
+ "type",
15216
+ "subtype"
15217
+ ]
14489
15218
  }
14490
15219
  },
14491
15220
  "required": [
15221
+ "key",
14492
15222
  "date",
14493
15223
  "value"
14494
15224
  ]
@@ -17434,7 +18164,7 @@ export const state = {
17434
18164
  "title": "Botpress API",
17435
18165
  "description": "API for Botpress Cloud",
17436
18166
  "server": "https://api.botpress.cloud",
17437
- "version": "1.11.0",
18167
+ "version": "1.13.0",
17438
18168
  "prefix": "v1"
17439
18169
  },
17440
18170
  "errors": [
@@ -17692,6 +18422,9 @@ export const state = {
17692
18422
  "getPublicPluginByIdResponse": true,
17693
18423
  "getPublicPluginResponse": true,
17694
18424
  "getPublicPluginCodeResponse": true,
18425
+ "listPublicInterfacesResponse": true,
18426
+ "getPublicInterfaceByIdResponse": true,
18427
+ "getPublicInterfaceResponse": true,
17695
18428
  "createBotResponse": true,
17696
18429
  "updateBotResponse": true,
17697
18430
  "transferBotResponse": true,
@@ -21226,7 +21959,10 @@ export const state = {
21226
21959
  "listPublicPlugins",
21227
21960
  "getPublicPluginById",
21228
21961
  "getPublicPlugin",
21229
- "getPublicPluginCode"
21962
+ "getPublicPluginCode",
21963
+ "listPublicInterfaces",
21964
+ "getPublicInterfaceById",
21965
+ "getPublicInterface"
21230
21966
  ]
21231
21967
  },
21232
21968
  {