@botpress/api 0.52.0 → 0.53.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/dist/index.js +860 -1
- package/dist/src/gen/state.d.ts +756 -1
- package/dist/src/index.d.ts +2 -2
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +861 -2
package/dist/index.js
CHANGED
|
@@ -291870,6 +291870,619 @@ var state = {
|
|
|
291870
291870
|
}
|
|
291871
291871
|
}
|
|
291872
291872
|
},
|
|
291873
|
+
"createPlugin": {
|
|
291874
|
+
"name": "createPlugin",
|
|
291875
|
+
"description": "Create Plugin",
|
|
291876
|
+
"method": "post",
|
|
291877
|
+
"path": "/v1/admin/plugins",
|
|
291878
|
+
"parameters": {},
|
|
291879
|
+
"requestBody": {
|
|
291880
|
+
"description": "Plugin to create",
|
|
291881
|
+
"schema": {
|
|
291882
|
+
"type": "object",
|
|
291883
|
+
"properties": {
|
|
291884
|
+
"name": {
|
|
291885
|
+
"type": "string",
|
|
291886
|
+
"maxLength": 200,
|
|
291887
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
291888
|
+
},
|
|
291889
|
+
"version": {
|
|
291890
|
+
"type": "string",
|
|
291891
|
+
"maxLength": 200,
|
|
291892
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
291893
|
+
},
|
|
291894
|
+
"configuration": {
|
|
291895
|
+
"type": "object",
|
|
291896
|
+
"properties": {
|
|
291897
|
+
"title": {
|
|
291898
|
+
"type": "string",
|
|
291899
|
+
"maxLength": 64,
|
|
291900
|
+
"description": "Title of the configuration"
|
|
291901
|
+
},
|
|
291902
|
+
"description": {
|
|
291903
|
+
"type": "string",
|
|
291904
|
+
"maxLength": 256,
|
|
291905
|
+
"description": "Description of the configuration"
|
|
291906
|
+
},
|
|
291907
|
+
"schema": {
|
|
291908
|
+
"type": "object",
|
|
291909
|
+
"additionalProperties": true,
|
|
291910
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
291911
|
+
}
|
|
291912
|
+
},
|
|
291913
|
+
"required": [
|
|
291914
|
+
"schema"
|
|
291915
|
+
],
|
|
291916
|
+
"description": "Configuration definition",
|
|
291917
|
+
"additionalProperties": false
|
|
291918
|
+
},
|
|
291919
|
+
"states": {
|
|
291920
|
+
"type": "object",
|
|
291921
|
+
"additionalProperties": {
|
|
291922
|
+
"type": "object",
|
|
291923
|
+
"properties": {
|
|
291924
|
+
"type": {
|
|
291925
|
+
"type": "string",
|
|
291926
|
+
"enum": [
|
|
291927
|
+
"conversation",
|
|
291928
|
+
"user",
|
|
291929
|
+
"bot",
|
|
291930
|
+
"task"
|
|
291931
|
+
],
|
|
291932
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
291933
|
+
},
|
|
291934
|
+
"schema": {
|
|
291935
|
+
"type": "object",
|
|
291936
|
+
"additionalProperties": true,
|
|
291937
|
+
"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."
|
|
291938
|
+
},
|
|
291939
|
+
"expiry": {
|
|
291940
|
+
"type": "number",
|
|
291941
|
+
"minimum": 1,
|
|
291942
|
+
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
291943
|
+
}
|
|
291944
|
+
},
|
|
291945
|
+
"required": [
|
|
291946
|
+
"type",
|
|
291947
|
+
"schema"
|
|
291948
|
+
],
|
|
291949
|
+
"additionalProperties": false
|
|
291950
|
+
}
|
|
291951
|
+
},
|
|
291952
|
+
"events": {
|
|
291953
|
+
"type": "object",
|
|
291954
|
+
"additionalProperties": {
|
|
291955
|
+
"type": "object",
|
|
291956
|
+
"properties": {
|
|
291957
|
+
"title": {
|
|
291958
|
+
"type": "string",
|
|
291959
|
+
"maxLength": 64,
|
|
291960
|
+
"description": "Title of the event"
|
|
291961
|
+
},
|
|
291962
|
+
"description": {
|
|
291963
|
+
"type": "string",
|
|
291964
|
+
"maxLength": 256,
|
|
291965
|
+
"description": "Description of the event"
|
|
291966
|
+
},
|
|
291967
|
+
"schema": {
|
|
291968
|
+
"type": "object",
|
|
291969
|
+
"additionalProperties": true
|
|
291970
|
+
}
|
|
291971
|
+
},
|
|
291972
|
+
"required": [
|
|
291973
|
+
"schema"
|
|
291974
|
+
],
|
|
291975
|
+
"description": "Event Definition",
|
|
291976
|
+
"additionalProperties": false
|
|
291977
|
+
}
|
|
291978
|
+
},
|
|
291979
|
+
"actions": {
|
|
291980
|
+
"type": "object",
|
|
291981
|
+
"additionalProperties": {
|
|
291982
|
+
"type": "object",
|
|
291983
|
+
"properties": {
|
|
291984
|
+
"title": {
|
|
291985
|
+
"type": "string",
|
|
291986
|
+
"maxLength": 64,
|
|
291987
|
+
"description": "Title of the action"
|
|
291988
|
+
},
|
|
291989
|
+
"description": {
|
|
291990
|
+
"type": "string",
|
|
291991
|
+
"maxLength": 256,
|
|
291992
|
+
"description": "Description of the action"
|
|
291993
|
+
},
|
|
291994
|
+
"billable": {
|
|
291995
|
+
"type": "boolean"
|
|
291996
|
+
},
|
|
291997
|
+
"cacheable": {
|
|
291998
|
+
"type": "boolean"
|
|
291999
|
+
},
|
|
292000
|
+
"input": {
|
|
292001
|
+
"type": "object",
|
|
292002
|
+
"properties": {
|
|
292003
|
+
"schema": {
|
|
292004
|
+
"type": "object",
|
|
292005
|
+
"additionalProperties": true
|
|
292006
|
+
}
|
|
292007
|
+
},
|
|
292008
|
+
"required": [
|
|
292009
|
+
"schema"
|
|
292010
|
+
],
|
|
292011
|
+
"additionalProperties": false
|
|
292012
|
+
},
|
|
292013
|
+
"output": {
|
|
292014
|
+
"type": "object",
|
|
292015
|
+
"properties": {
|
|
292016
|
+
"schema": {
|
|
292017
|
+
"type": "object",
|
|
292018
|
+
"additionalProperties": true
|
|
292019
|
+
}
|
|
292020
|
+
},
|
|
292021
|
+
"required": [
|
|
292022
|
+
"schema"
|
|
292023
|
+
],
|
|
292024
|
+
"additionalProperties": false
|
|
292025
|
+
}
|
|
292026
|
+
},
|
|
292027
|
+
"required": [
|
|
292028
|
+
"input",
|
|
292029
|
+
"output"
|
|
292030
|
+
],
|
|
292031
|
+
"description": "Action definition",
|
|
292032
|
+
"additionalProperties": false
|
|
292033
|
+
}
|
|
292034
|
+
},
|
|
292035
|
+
"user": {
|
|
292036
|
+
"type": "object",
|
|
292037
|
+
"properties": {
|
|
292038
|
+
"tags": {
|
|
292039
|
+
"type": "object",
|
|
292040
|
+
"additionalProperties": {
|
|
292041
|
+
"type": "object",
|
|
292042
|
+
"properties": {
|
|
292043
|
+
"title": {
|
|
292044
|
+
"type": "string",
|
|
292045
|
+
"maxLength": 64,
|
|
292046
|
+
"description": "Title of the tag"
|
|
292047
|
+
},
|
|
292048
|
+
"description": {
|
|
292049
|
+
"type": "string",
|
|
292050
|
+
"maxLength": 256,
|
|
292051
|
+
"description": "Description of the tag"
|
|
292052
|
+
}
|
|
292053
|
+
},
|
|
292054
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
292055
|
+
"additionalProperties": false
|
|
292056
|
+
}
|
|
292057
|
+
}
|
|
292058
|
+
},
|
|
292059
|
+
"required": [
|
|
292060
|
+
"tags"
|
|
292061
|
+
],
|
|
292062
|
+
"description": "User object configuration",
|
|
292063
|
+
"additionalProperties": false
|
|
292064
|
+
},
|
|
292065
|
+
"code": {
|
|
292066
|
+
"type": "string"
|
|
292067
|
+
}
|
|
292068
|
+
},
|
|
292069
|
+
"required": [
|
|
292070
|
+
"name",
|
|
292071
|
+
"version",
|
|
292072
|
+
"code"
|
|
292073
|
+
],
|
|
292074
|
+
"title": "createPluginBody",
|
|
292075
|
+
"additionalProperties": false
|
|
292076
|
+
}
|
|
292077
|
+
},
|
|
292078
|
+
"section": "plugin",
|
|
292079
|
+
"response": {
|
|
292080
|
+
"description": "Get an plugin",
|
|
292081
|
+
"schema": {
|
|
292082
|
+
"type": "object",
|
|
292083
|
+
"properties": {
|
|
292084
|
+
"plugin": {
|
|
292085
|
+
"$ref": "#/components/schemas/Plugin"
|
|
292086
|
+
}
|
|
292087
|
+
},
|
|
292088
|
+
"required": [
|
|
292089
|
+
"plugin"
|
|
292090
|
+
],
|
|
292091
|
+
"title": "createPluginResponse",
|
|
292092
|
+
"additionalProperties": false
|
|
292093
|
+
}
|
|
292094
|
+
}
|
|
292095
|
+
},
|
|
292096
|
+
"getPlugin": {
|
|
292097
|
+
"name": "getPlugin",
|
|
292098
|
+
"description": "Get Plugin",
|
|
292099
|
+
"method": "get",
|
|
292100
|
+
"path": "/v1/admin/plugins/{id}",
|
|
292101
|
+
"parameters": {
|
|
292102
|
+
"id": {
|
|
292103
|
+
"in": "path",
|
|
292104
|
+
"type": "string",
|
|
292105
|
+
"description": "Plugin id"
|
|
292106
|
+
}
|
|
292107
|
+
},
|
|
292108
|
+
"section": "plugin",
|
|
292109
|
+
"response": {
|
|
292110
|
+
"description": "Get an plugin",
|
|
292111
|
+
"schema": {
|
|
292112
|
+
"type": "object",
|
|
292113
|
+
"properties": {
|
|
292114
|
+
"plugin": {
|
|
292115
|
+
"$ref": "#/components/schemas/Plugin"
|
|
292116
|
+
}
|
|
292117
|
+
},
|
|
292118
|
+
"required": [
|
|
292119
|
+
"plugin"
|
|
292120
|
+
],
|
|
292121
|
+
"title": "getPluginResponse",
|
|
292122
|
+
"additionalProperties": false
|
|
292123
|
+
}
|
|
292124
|
+
}
|
|
292125
|
+
},
|
|
292126
|
+
"getPluginByName": {
|
|
292127
|
+
"name": "getPluginByName",
|
|
292128
|
+
"description": "Get Plugin by name and version",
|
|
292129
|
+
"method": "get",
|
|
292130
|
+
"path": "/v1/admin/plugins/{name}/{version}",
|
|
292131
|
+
"parameters": {
|
|
292132
|
+
"name": {
|
|
292133
|
+
"in": "path",
|
|
292134
|
+
"type": "string",
|
|
292135
|
+
"description": "Plugin name"
|
|
292136
|
+
},
|
|
292137
|
+
"version": {
|
|
292138
|
+
"in": "path",
|
|
292139
|
+
"type": "string",
|
|
292140
|
+
"description": "Plugin version"
|
|
292141
|
+
}
|
|
292142
|
+
},
|
|
292143
|
+
"section": "plugin",
|
|
292144
|
+
"response": {
|
|
292145
|
+
"description": "Get an plugin",
|
|
292146
|
+
"schema": {
|
|
292147
|
+
"type": "object",
|
|
292148
|
+
"properties": {
|
|
292149
|
+
"plugin": {
|
|
292150
|
+
"$ref": "#/components/schemas/Plugin"
|
|
292151
|
+
}
|
|
292152
|
+
},
|
|
292153
|
+
"required": [
|
|
292154
|
+
"plugin"
|
|
292155
|
+
],
|
|
292156
|
+
"title": "getPluginByNameResponse",
|
|
292157
|
+
"additionalProperties": false
|
|
292158
|
+
}
|
|
292159
|
+
}
|
|
292160
|
+
},
|
|
292161
|
+
"updatePlugin": {
|
|
292162
|
+
"name": "updatePlugin",
|
|
292163
|
+
"description": "Update Plugin",
|
|
292164
|
+
"method": "put",
|
|
292165
|
+
"path": "/v1/admin/plugins/{id}",
|
|
292166
|
+
"parameters": {
|
|
292167
|
+
"id": {
|
|
292168
|
+
"in": "path",
|
|
292169
|
+
"type": "string",
|
|
292170
|
+
"description": "Plugin id"
|
|
292171
|
+
}
|
|
292172
|
+
},
|
|
292173
|
+
"requestBody": {
|
|
292174
|
+
"description": "Plugin to update",
|
|
292175
|
+
"schema": {
|
|
292176
|
+
"type": "object",
|
|
292177
|
+
"properties": {
|
|
292178
|
+
"configuration": {
|
|
292179
|
+
"type": "object",
|
|
292180
|
+
"properties": {
|
|
292181
|
+
"title": {
|
|
292182
|
+
"type": "string",
|
|
292183
|
+
"maxLength": 64,
|
|
292184
|
+
"description": "Title of the configuration"
|
|
292185
|
+
},
|
|
292186
|
+
"description": {
|
|
292187
|
+
"type": "string",
|
|
292188
|
+
"maxLength": 256,
|
|
292189
|
+
"description": "Description of the configuration"
|
|
292190
|
+
},
|
|
292191
|
+
"schema": {
|
|
292192
|
+
"type": "object",
|
|
292193
|
+
"additionalProperties": true,
|
|
292194
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
292195
|
+
}
|
|
292196
|
+
},
|
|
292197
|
+
"required": [
|
|
292198
|
+
"schema"
|
|
292199
|
+
],
|
|
292200
|
+
"description": "Configuration definition",
|
|
292201
|
+
"nullable": true,
|
|
292202
|
+
"additionalProperties": false
|
|
292203
|
+
},
|
|
292204
|
+
"states": {
|
|
292205
|
+
"type": "object",
|
|
292206
|
+
"additionalProperties": {
|
|
292207
|
+
"type": "object",
|
|
292208
|
+
"properties": {
|
|
292209
|
+
"type": {
|
|
292210
|
+
"type": "string",
|
|
292211
|
+
"enum": [
|
|
292212
|
+
"conversation",
|
|
292213
|
+
"user",
|
|
292214
|
+
"bot",
|
|
292215
|
+
"task"
|
|
292216
|
+
],
|
|
292217
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
292218
|
+
},
|
|
292219
|
+
"schema": {
|
|
292220
|
+
"type": "object",
|
|
292221
|
+
"additionalProperties": true,
|
|
292222
|
+
"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."
|
|
292223
|
+
},
|
|
292224
|
+
"expiry": {
|
|
292225
|
+
"type": "number",
|
|
292226
|
+
"minimum": 1,
|
|
292227
|
+
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
292228
|
+
}
|
|
292229
|
+
},
|
|
292230
|
+
"required": [
|
|
292231
|
+
"type",
|
|
292232
|
+
"schema"
|
|
292233
|
+
],
|
|
292234
|
+
"nullable": true,
|
|
292235
|
+
"additionalProperties": false
|
|
292236
|
+
}
|
|
292237
|
+
},
|
|
292238
|
+
"events": {
|
|
292239
|
+
"type": "object",
|
|
292240
|
+
"additionalProperties": {
|
|
292241
|
+
"type": "object",
|
|
292242
|
+
"properties": {
|
|
292243
|
+
"title": {
|
|
292244
|
+
"type": "string",
|
|
292245
|
+
"maxLength": 64,
|
|
292246
|
+
"description": "Title of the event"
|
|
292247
|
+
},
|
|
292248
|
+
"description": {
|
|
292249
|
+
"type": "string",
|
|
292250
|
+
"maxLength": 256,
|
|
292251
|
+
"description": "Description of the event"
|
|
292252
|
+
},
|
|
292253
|
+
"schema": {
|
|
292254
|
+
"type": "object",
|
|
292255
|
+
"additionalProperties": true
|
|
292256
|
+
}
|
|
292257
|
+
},
|
|
292258
|
+
"required": [
|
|
292259
|
+
"schema"
|
|
292260
|
+
],
|
|
292261
|
+
"description": "Event Definition",
|
|
292262
|
+
"nullable": true,
|
|
292263
|
+
"additionalProperties": false
|
|
292264
|
+
}
|
|
292265
|
+
},
|
|
292266
|
+
"actions": {
|
|
292267
|
+
"type": "object",
|
|
292268
|
+
"additionalProperties": {
|
|
292269
|
+
"type": "object",
|
|
292270
|
+
"properties": {
|
|
292271
|
+
"title": {
|
|
292272
|
+
"type": "string",
|
|
292273
|
+
"maxLength": 64,
|
|
292274
|
+
"description": "Title of the action"
|
|
292275
|
+
},
|
|
292276
|
+
"description": {
|
|
292277
|
+
"type": "string",
|
|
292278
|
+
"maxLength": 256,
|
|
292279
|
+
"description": "Description of the action"
|
|
292280
|
+
},
|
|
292281
|
+
"billable": {
|
|
292282
|
+
"type": "boolean"
|
|
292283
|
+
},
|
|
292284
|
+
"cacheable": {
|
|
292285
|
+
"type": "boolean"
|
|
292286
|
+
},
|
|
292287
|
+
"input": {
|
|
292288
|
+
"type": "object",
|
|
292289
|
+
"properties": {
|
|
292290
|
+
"schema": {
|
|
292291
|
+
"type": "object",
|
|
292292
|
+
"additionalProperties": true
|
|
292293
|
+
}
|
|
292294
|
+
},
|
|
292295
|
+
"required": [
|
|
292296
|
+
"schema"
|
|
292297
|
+
],
|
|
292298
|
+
"additionalProperties": false
|
|
292299
|
+
},
|
|
292300
|
+
"output": {
|
|
292301
|
+
"type": "object",
|
|
292302
|
+
"properties": {
|
|
292303
|
+
"schema": {
|
|
292304
|
+
"type": "object",
|
|
292305
|
+
"additionalProperties": true
|
|
292306
|
+
}
|
|
292307
|
+
},
|
|
292308
|
+
"required": [
|
|
292309
|
+
"schema"
|
|
292310
|
+
],
|
|
292311
|
+
"additionalProperties": false
|
|
292312
|
+
}
|
|
292313
|
+
},
|
|
292314
|
+
"required": [
|
|
292315
|
+
"input",
|
|
292316
|
+
"output"
|
|
292317
|
+
],
|
|
292318
|
+
"description": "Action definition",
|
|
292319
|
+
"nullable": true,
|
|
292320
|
+
"additionalProperties": false
|
|
292321
|
+
}
|
|
292322
|
+
},
|
|
292323
|
+
"user": {
|
|
292324
|
+
"type": "object",
|
|
292325
|
+
"properties": {
|
|
292326
|
+
"tags": {
|
|
292327
|
+
"type": "object",
|
|
292328
|
+
"additionalProperties": {
|
|
292329
|
+
"type": "object",
|
|
292330
|
+
"properties": {
|
|
292331
|
+
"title": {
|
|
292332
|
+
"type": "string",
|
|
292333
|
+
"maxLength": 64,
|
|
292334
|
+
"description": "Title of the tag"
|
|
292335
|
+
},
|
|
292336
|
+
"description": {
|
|
292337
|
+
"type": "string",
|
|
292338
|
+
"maxLength": 256,
|
|
292339
|
+
"description": "Description of the tag"
|
|
292340
|
+
}
|
|
292341
|
+
},
|
|
292342
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
292343
|
+
"additionalProperties": false
|
|
292344
|
+
}
|
|
292345
|
+
}
|
|
292346
|
+
},
|
|
292347
|
+
"required": [
|
|
292348
|
+
"tags"
|
|
292349
|
+
],
|
|
292350
|
+
"description": "User object configuration",
|
|
292351
|
+
"nullable": true,
|
|
292352
|
+
"additionalProperties": false
|
|
292353
|
+
},
|
|
292354
|
+
"code": {
|
|
292355
|
+
"type": "string"
|
|
292356
|
+
}
|
|
292357
|
+
},
|
|
292358
|
+
"title": "updatePluginBody",
|
|
292359
|
+
"additionalProperties": false
|
|
292360
|
+
}
|
|
292361
|
+
},
|
|
292362
|
+
"section": "plugin",
|
|
292363
|
+
"response": {
|
|
292364
|
+
"description": "Update an plugin",
|
|
292365
|
+
"schema": {
|
|
292366
|
+
"type": "object",
|
|
292367
|
+
"properties": {
|
|
292368
|
+
"plugin": {
|
|
292369
|
+
"$ref": "#/components/schemas/Plugin"
|
|
292370
|
+
}
|
|
292371
|
+
},
|
|
292372
|
+
"required": [
|
|
292373
|
+
"plugin"
|
|
292374
|
+
],
|
|
292375
|
+
"title": "updatePluginResponse",
|
|
292376
|
+
"additionalProperties": false
|
|
292377
|
+
}
|
|
292378
|
+
}
|
|
292379
|
+
},
|
|
292380
|
+
"deletePlugin": {
|
|
292381
|
+
"name": "deletePlugin",
|
|
292382
|
+
"description": "Delete Plugin",
|
|
292383
|
+
"method": "delete",
|
|
292384
|
+
"path": "/v1/admin/plugins/{id}",
|
|
292385
|
+
"parameters": {
|
|
292386
|
+
"id": {
|
|
292387
|
+
"in": "path",
|
|
292388
|
+
"type": "string",
|
|
292389
|
+
"description": "Plugin id"
|
|
292390
|
+
}
|
|
292391
|
+
},
|
|
292392
|
+
"section": "plugin",
|
|
292393
|
+
"response": {
|
|
292394
|
+
"description": "Delete an plugin",
|
|
292395
|
+
"schema": {
|
|
292396
|
+
"type": "object",
|
|
292397
|
+
"title": "deletePluginResponse",
|
|
292398
|
+
"additionalProperties": false
|
|
292399
|
+
}
|
|
292400
|
+
}
|
|
292401
|
+
},
|
|
292402
|
+
"listPlugins": {
|
|
292403
|
+
"name": "listPlugins",
|
|
292404
|
+
"description": "List Plugins",
|
|
292405
|
+
"method": "get",
|
|
292406
|
+
"path": "/v1/admin/plugins",
|
|
292407
|
+
"section": "plugin",
|
|
292408
|
+
"parameters": {
|
|
292409
|
+
"nextToken": {
|
|
292410
|
+
"in": "query",
|
|
292411
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
292412
|
+
"type": "string"
|
|
292413
|
+
},
|
|
292414
|
+
"name": {
|
|
292415
|
+
"in": "query",
|
|
292416
|
+
"type": "string",
|
|
292417
|
+
"description": "Filter all versions of a plugin by name"
|
|
292418
|
+
}
|
|
292419
|
+
},
|
|
292420
|
+
"response": {
|
|
292421
|
+
"description": "List plugins",
|
|
292422
|
+
"schema": {
|
|
292423
|
+
"type": "object",
|
|
292424
|
+
"properties": {
|
|
292425
|
+
"plugins": {
|
|
292426
|
+
"type": "array",
|
|
292427
|
+
"items": {
|
|
292428
|
+
"type": "object",
|
|
292429
|
+
"properties": {
|
|
292430
|
+
"id": {
|
|
292431
|
+
"type": "string",
|
|
292432
|
+
"minLength": 28,
|
|
292433
|
+
"maxLength": 36,
|
|
292434
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
292435
|
+
},
|
|
292436
|
+
"createdAt": {
|
|
292437
|
+
"type": "string",
|
|
292438
|
+
"format": "date-time",
|
|
292439
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
292440
|
+
},
|
|
292441
|
+
"updatedAt": {
|
|
292442
|
+
"type": "string",
|
|
292443
|
+
"format": "date-time",
|
|
292444
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
292445
|
+
},
|
|
292446
|
+
"name": {
|
|
292447
|
+
"type": "string",
|
|
292448
|
+
"maxLength": 200,
|
|
292449
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
292450
|
+
},
|
|
292451
|
+
"version": {
|
|
292452
|
+
"type": "string",
|
|
292453
|
+
"maxLength": 200,
|
|
292454
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
292455
|
+
}
|
|
292456
|
+
},
|
|
292457
|
+
"required": [
|
|
292458
|
+
"id",
|
|
292459
|
+
"createdAt",
|
|
292460
|
+
"updatedAt",
|
|
292461
|
+
"name",
|
|
292462
|
+
"version"
|
|
292463
|
+
]
|
|
292464
|
+
}
|
|
292465
|
+
},
|
|
292466
|
+
"meta": {
|
|
292467
|
+
"type": "object",
|
|
292468
|
+
"properties": {
|
|
292469
|
+
"nextToken": {
|
|
292470
|
+
"type": "string",
|
|
292471
|
+
"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."
|
|
292472
|
+
}
|
|
292473
|
+
},
|
|
292474
|
+
"additionalProperties": false
|
|
292475
|
+
}
|
|
292476
|
+
},
|
|
292477
|
+
"required": [
|
|
292478
|
+
"plugins",
|
|
292479
|
+
"meta"
|
|
292480
|
+
],
|
|
292481
|
+
"title": "listPluginsResponse",
|
|
292482
|
+
"additionalProperties": false
|
|
292483
|
+
}
|
|
292484
|
+
}
|
|
292485
|
+
},
|
|
291873
292486
|
"getUsage": {
|
|
291874
292487
|
"name": "getUsage",
|
|
291875
292488
|
"path": "/v1/admin/usages/{id}",
|
|
@@ -294198,7 +294811,7 @@ var state = {
|
|
|
294198
294811
|
"title": "Botpress API",
|
|
294199
294812
|
"description": "API for Botpress Cloud",
|
|
294200
294813
|
"server": "https://api.botpress.cloud",
|
|
294201
|
-
"version": "0.
|
|
294814
|
+
"version": "0.53.0",
|
|
294202
294815
|
"prefix": "v1"
|
|
294203
294816
|
},
|
|
294204
294817
|
"errors": [
|
|
@@ -294370,6 +294983,8 @@ var state = {
|
|
|
294370
294983
|
"requestIntegrationVerificationBody": true,
|
|
294371
294984
|
"createInterfaceBody": true,
|
|
294372
294985
|
"updateInterfaceBody": true,
|
|
294986
|
+
"createPluginBody": true,
|
|
294987
|
+
"updatePluginBody": true,
|
|
294373
294988
|
"changeAISpendQuotaBody": true,
|
|
294374
294989
|
"introspectBody": true,
|
|
294375
294990
|
"upsertFileBody": true,
|
|
@@ -294497,6 +295112,12 @@ var state = {
|
|
|
294497
295112
|
"updateInterfaceResponse": true,
|
|
294498
295113
|
"deleteInterfaceResponse": true,
|
|
294499
295114
|
"listInterfacesResponse": true,
|
|
295115
|
+
"createPluginResponse": true,
|
|
295116
|
+
"getPluginResponse": true,
|
|
295117
|
+
"getPluginByNameResponse": true,
|
|
295118
|
+
"updatePluginResponse": true,
|
|
295119
|
+
"deletePluginResponse": true,
|
|
295120
|
+
"listPluginsResponse": true,
|
|
294500
295121
|
"getUsageResponse": true,
|
|
294501
295122
|
"getMultipleUsagesResponse": true,
|
|
294502
295123
|
"listUsageHistoryResponse": true,
|
|
@@ -294530,6 +295151,7 @@ var state = {
|
|
|
294530
295151
|
"Bot": true,
|
|
294531
295152
|
"Integration": true,
|
|
294532
295153
|
"Interface": true,
|
|
295154
|
+
"Plugin": true,
|
|
294533
295155
|
"Workspace": true,
|
|
294534
295156
|
"WorkspaceMember": true,
|
|
294535
295157
|
"Account": true,
|
|
@@ -295918,6 +296540,229 @@ var state = {
|
|
|
295918
296540
|
"additionalProperties": false
|
|
295919
296541
|
}
|
|
295920
296542
|
},
|
|
296543
|
+
"Plugin": {
|
|
296544
|
+
"section": "plugin",
|
|
296545
|
+
"schema": {
|
|
296546
|
+
"type": "object",
|
|
296547
|
+
"properties": {
|
|
296548
|
+
"id": {
|
|
296549
|
+
"type": "string",
|
|
296550
|
+
"minLength": 28,
|
|
296551
|
+
"maxLength": 36,
|
|
296552
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
296553
|
+
},
|
|
296554
|
+
"name": {
|
|
296555
|
+
"type": "string",
|
|
296556
|
+
"maxLength": 200,
|
|
296557
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
296558
|
+
},
|
|
296559
|
+
"version": {
|
|
296560
|
+
"type": "string",
|
|
296561
|
+
"maxLength": 200,
|
|
296562
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
296563
|
+
},
|
|
296564
|
+
"createdAt": {
|
|
296565
|
+
"type": "string",
|
|
296566
|
+
"format": "date-time",
|
|
296567
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
296568
|
+
},
|
|
296569
|
+
"updatedAt": {
|
|
296570
|
+
"type": "string",
|
|
296571
|
+
"format": "date-time",
|
|
296572
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
296573
|
+
},
|
|
296574
|
+
"configuration": {
|
|
296575
|
+
"type": "object",
|
|
296576
|
+
"properties": {
|
|
296577
|
+
"title": {
|
|
296578
|
+
"type": "string",
|
|
296579
|
+
"maxLength": 64,
|
|
296580
|
+
"description": "Title of the configuration"
|
|
296581
|
+
},
|
|
296582
|
+
"description": {
|
|
296583
|
+
"type": "string",
|
|
296584
|
+
"maxLength": 256,
|
|
296585
|
+
"description": "Description of the configuration"
|
|
296586
|
+
},
|
|
296587
|
+
"schema": {
|
|
296588
|
+
"type": "object",
|
|
296589
|
+
"additionalProperties": true,
|
|
296590
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
296591
|
+
}
|
|
296592
|
+
},
|
|
296593
|
+
"required": [
|
|
296594
|
+
"schema"
|
|
296595
|
+
],
|
|
296596
|
+
"description": "Configuration definition",
|
|
296597
|
+
"additionalProperties": false
|
|
296598
|
+
},
|
|
296599
|
+
"states": {
|
|
296600
|
+
"type": "object",
|
|
296601
|
+
"additionalProperties": {
|
|
296602
|
+
"type": "object",
|
|
296603
|
+
"properties": {
|
|
296604
|
+
"type": {
|
|
296605
|
+
"type": "string",
|
|
296606
|
+
"enum": [
|
|
296607
|
+
"conversation",
|
|
296608
|
+
"user",
|
|
296609
|
+
"bot",
|
|
296610
|
+
"task"
|
|
296611
|
+
],
|
|
296612
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
296613
|
+
},
|
|
296614
|
+
"schema": {
|
|
296615
|
+
"type": "object",
|
|
296616
|
+
"additionalProperties": true,
|
|
296617
|
+
"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."
|
|
296618
|
+
},
|
|
296619
|
+
"expiry": {
|
|
296620
|
+
"type": "number",
|
|
296621
|
+
"minimum": 1,
|
|
296622
|
+
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
296623
|
+
}
|
|
296624
|
+
},
|
|
296625
|
+
"required": [
|
|
296626
|
+
"type",
|
|
296627
|
+
"schema"
|
|
296628
|
+
],
|
|
296629
|
+
"additionalProperties": false
|
|
296630
|
+
}
|
|
296631
|
+
},
|
|
296632
|
+
"events": {
|
|
296633
|
+
"type": "object",
|
|
296634
|
+
"additionalProperties": {
|
|
296635
|
+
"type": "object",
|
|
296636
|
+
"properties": {
|
|
296637
|
+
"title": {
|
|
296638
|
+
"type": "string",
|
|
296639
|
+
"maxLength": 64,
|
|
296640
|
+
"description": "Title of the event"
|
|
296641
|
+
},
|
|
296642
|
+
"description": {
|
|
296643
|
+
"type": "string",
|
|
296644
|
+
"maxLength": 256,
|
|
296645
|
+
"description": "Description of the event"
|
|
296646
|
+
},
|
|
296647
|
+
"schema": {
|
|
296648
|
+
"type": "object",
|
|
296649
|
+
"additionalProperties": true
|
|
296650
|
+
}
|
|
296651
|
+
},
|
|
296652
|
+
"required": [
|
|
296653
|
+
"schema"
|
|
296654
|
+
],
|
|
296655
|
+
"description": "Event Definition",
|
|
296656
|
+
"additionalProperties": false
|
|
296657
|
+
}
|
|
296658
|
+
},
|
|
296659
|
+
"actions": {
|
|
296660
|
+
"type": "object",
|
|
296661
|
+
"additionalProperties": {
|
|
296662
|
+
"type": "object",
|
|
296663
|
+
"properties": {
|
|
296664
|
+
"title": {
|
|
296665
|
+
"type": "string",
|
|
296666
|
+
"maxLength": 64,
|
|
296667
|
+
"description": "Title of the action"
|
|
296668
|
+
},
|
|
296669
|
+
"description": {
|
|
296670
|
+
"type": "string",
|
|
296671
|
+
"maxLength": 256,
|
|
296672
|
+
"description": "Description of the action"
|
|
296673
|
+
},
|
|
296674
|
+
"billable": {
|
|
296675
|
+
"type": "boolean"
|
|
296676
|
+
},
|
|
296677
|
+
"cacheable": {
|
|
296678
|
+
"type": "boolean"
|
|
296679
|
+
},
|
|
296680
|
+
"input": {
|
|
296681
|
+
"type": "object",
|
|
296682
|
+
"properties": {
|
|
296683
|
+
"schema": {
|
|
296684
|
+
"type": "object",
|
|
296685
|
+
"additionalProperties": true
|
|
296686
|
+
}
|
|
296687
|
+
},
|
|
296688
|
+
"required": [
|
|
296689
|
+
"schema"
|
|
296690
|
+
],
|
|
296691
|
+
"additionalProperties": false
|
|
296692
|
+
},
|
|
296693
|
+
"output": {
|
|
296694
|
+
"type": "object",
|
|
296695
|
+
"properties": {
|
|
296696
|
+
"schema": {
|
|
296697
|
+
"type": "object",
|
|
296698
|
+
"additionalProperties": true
|
|
296699
|
+
}
|
|
296700
|
+
},
|
|
296701
|
+
"required": [
|
|
296702
|
+
"schema"
|
|
296703
|
+
],
|
|
296704
|
+
"additionalProperties": false
|
|
296705
|
+
}
|
|
296706
|
+
},
|
|
296707
|
+
"required": [
|
|
296708
|
+
"input",
|
|
296709
|
+
"output"
|
|
296710
|
+
],
|
|
296711
|
+
"description": "Action definition",
|
|
296712
|
+
"additionalProperties": false
|
|
296713
|
+
}
|
|
296714
|
+
},
|
|
296715
|
+
"user": {
|
|
296716
|
+
"type": "object",
|
|
296717
|
+
"properties": {
|
|
296718
|
+
"tags": {
|
|
296719
|
+
"type": "object",
|
|
296720
|
+
"additionalProperties": {
|
|
296721
|
+
"type": "object",
|
|
296722
|
+
"properties": {
|
|
296723
|
+
"title": {
|
|
296724
|
+
"type": "string",
|
|
296725
|
+
"maxLength": 64,
|
|
296726
|
+
"description": "Title of the tag"
|
|
296727
|
+
},
|
|
296728
|
+
"description": {
|
|
296729
|
+
"type": "string",
|
|
296730
|
+
"maxLength": 256,
|
|
296731
|
+
"description": "Description of the tag"
|
|
296732
|
+
}
|
|
296733
|
+
},
|
|
296734
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
296735
|
+
"additionalProperties": false
|
|
296736
|
+
}
|
|
296737
|
+
}
|
|
296738
|
+
},
|
|
296739
|
+
"required": [
|
|
296740
|
+
"tags"
|
|
296741
|
+
],
|
|
296742
|
+
"description": "User object configuration",
|
|
296743
|
+
"additionalProperties": false
|
|
296744
|
+
},
|
|
296745
|
+
"code": {
|
|
296746
|
+
"type": "string"
|
|
296747
|
+
}
|
|
296748
|
+
},
|
|
296749
|
+
"required": [
|
|
296750
|
+
"id",
|
|
296751
|
+
"name",
|
|
296752
|
+
"version",
|
|
296753
|
+
"createdAt",
|
|
296754
|
+
"updatedAt",
|
|
296755
|
+
"configuration",
|
|
296756
|
+
"states",
|
|
296757
|
+
"events",
|
|
296758
|
+
"actions",
|
|
296759
|
+
"user",
|
|
296760
|
+
"code"
|
|
296761
|
+
],
|
|
296762
|
+
"description": "Plugin definition",
|
|
296763
|
+
"additionalProperties": false
|
|
296764
|
+
}
|
|
296765
|
+
},
|
|
295921
296766
|
"Workspace": {
|
|
295922
296767
|
"section": "workspace",
|
|
295923
296768
|
"schema": {
|
|
@@ -297575,6 +298420,20 @@ var state = {
|
|
|
297575
298420
|
],
|
|
297576
298421
|
"schema": "Interface"
|
|
297577
298422
|
},
|
|
298423
|
+
{
|
|
298424
|
+
"title": "Plugin",
|
|
298425
|
+
"description": "",
|
|
298426
|
+
"name": "plugin",
|
|
298427
|
+
"operations": [
|
|
298428
|
+
"createPlugin",
|
|
298429
|
+
"getPlugin",
|
|
298430
|
+
"getPluginByName",
|
|
298431
|
+
"updatePlugin",
|
|
298432
|
+
"deletePlugin",
|
|
298433
|
+
"listPlugins"
|
|
298434
|
+
],
|
|
298435
|
+
"schema": "Plugin"
|
|
298436
|
+
},
|
|
297578
298437
|
{
|
|
297579
298438
|
"title": "Workspace",
|
|
297580
298439
|
"description": "",
|