@botpress/api 1.12.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/dist/index.js +1563 -151
- package/dist/src/gen/admin/state.d.ts +619 -0
- package/dist/src/gen/state.d.ts +619 -0
- package/package.json +1 -1
- package/src/gen/admin/metadata.json +1 -1
- package/src/gen/admin/openapi.json +1 -1
- package/src/gen/admin/state.ts +708 -2
- package/src/gen/files/openapi.json +1 -1
- package/src/gen/files/state.ts +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/runtime/openapi.json +1 -1
- package/src/gen/runtime/state.ts +1 -1
- package/src/gen/state.ts +708 -2
- package/src/gen/tables/openapi.json +1 -1
- 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.
|
|
284129
|
+
"version": "1.13.0",
|
|
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",
|
|
@@ -298430,6 +299125,11 @@ var state2 = {
|
|
|
298430
299125
|
"in": "query",
|
|
298431
299126
|
"type": "string",
|
|
298432
299127
|
"description": "Filter all versions of an interface by name"
|
|
299128
|
+
},
|
|
299129
|
+
"version": {
|
|
299130
|
+
"in": "query",
|
|
299131
|
+
"type": "string",
|
|
299132
|
+
"description": "Filter an interface by name and version"
|
|
298433
299133
|
}
|
|
298434
299134
|
},
|
|
298435
299135
|
"response": {
|
|
@@ -299975,7 +300675,7 @@ var state2 = {
|
|
|
299975
300675
|
"title": "Botpress API",
|
|
299976
300676
|
"description": "API for Botpress Cloud",
|
|
299977
300677
|
"server": "https://api.botpress.cloud",
|
|
299978
|
-
"version": "1.
|
|
300678
|
+
"version": "1.13.0",
|
|
299979
300679
|
"prefix": "v1"
|
|
299980
300680
|
},
|
|
299981
300681
|
"errors": [
|
|
@@ -300149,6 +300849,9 @@ var state2 = {
|
|
|
300149
300849
|
"getPublicPluginByIdResponse": true,
|
|
300150
300850
|
"getPublicPluginResponse": true,
|
|
300151
300851
|
"getPublicPluginCodeResponse": true,
|
|
300852
|
+
"listPublicInterfacesResponse": true,
|
|
300853
|
+
"getPublicInterfaceByIdResponse": true,
|
|
300854
|
+
"getPublicInterfaceResponse": true,
|
|
300152
300855
|
"createBotResponse": true,
|
|
300153
300856
|
"updateBotResponse": true,
|
|
300154
300857
|
"transferBotResponse": true,
|
|
@@ -303615,7 +304318,10 @@ var state2 = {
|
|
|
303615
304318
|
"listPublicPlugins",
|
|
303616
304319
|
"getPublicPluginById",
|
|
303617
304320
|
"getPublicPlugin",
|
|
303618
|
-
"getPublicPluginCode"
|
|
304321
|
+
"getPublicPluginCode",
|
|
304322
|
+
"listPublicInterfaces",
|
|
304323
|
+
"getPublicInterfaceById",
|
|
304324
|
+
"getPublicInterface"
|
|
303619
304325
|
]
|
|
303620
304326
|
},
|
|
303621
304327
|
{
|
|
@@ -305415,7 +306121,7 @@ var state3 = {
|
|
|
305415
306121
|
"title": "Botpress API",
|
|
305416
306122
|
"description": "API for Botpress Cloud",
|
|
305417
306123
|
"server": "https://api.botpress.cloud",
|
|
305418
|
-
"version": "1.
|
|
306124
|
+
"version": "1.13.0",
|
|
305419
306125
|
"prefix": "v1"
|
|
305420
306126
|
},
|
|
305421
306127
|
"errors": [
|
|
@@ -310302,7 +311008,7 @@ var state4 = {
|
|
|
310302
311008
|
"title": "Botpress API",
|
|
310303
311009
|
"description": "API for Botpress Cloud",
|
|
310304
311010
|
"server": "https://api.botpress.cloud",
|
|
310305
|
-
"version": "1.
|
|
311011
|
+
"version": "1.13.0",
|
|
310306
311012
|
"prefix": "v1"
|
|
310307
311013
|
},
|
|
310308
311014
|
"errors": [
|
|
@@ -319400,167 +320106,614 @@ var state5 = {
|
|
|
319400
320106
|
"additionalProperties": false
|
|
319401
320107
|
}
|
|
319402
320108
|
},
|
|
319403
|
-
"dependencies": {
|
|
320109
|
+
"dependencies": {
|
|
320110
|
+
"type": "object",
|
|
320111
|
+
"properties": {
|
|
320112
|
+
"interfaces": {
|
|
320113
|
+
"type": "object",
|
|
320114
|
+
"additionalProperties": {
|
|
320115
|
+
"type": "object",
|
|
320116
|
+
"properties": {
|
|
320117
|
+
"id": {
|
|
320118
|
+
"type": "string",
|
|
320119
|
+
"minLength": 28,
|
|
320120
|
+
"maxLength": 36
|
|
320121
|
+
},
|
|
320122
|
+
"name": {
|
|
320123
|
+
"type": "string",
|
|
320124
|
+
"maxLength": 200
|
|
320125
|
+
},
|
|
320126
|
+
"version": {
|
|
320127
|
+
"type": "string",
|
|
320128
|
+
"maxLength": 200
|
|
320129
|
+
}
|
|
320130
|
+
},
|
|
320131
|
+
"required": [
|
|
320132
|
+
"id",
|
|
320133
|
+
"name",
|
|
320134
|
+
"version"
|
|
320135
|
+
],
|
|
320136
|
+
"additionalProperties": false
|
|
320137
|
+
}
|
|
320138
|
+
},
|
|
320139
|
+
"integrations": {
|
|
320140
|
+
"type": "object",
|
|
320141
|
+
"additionalProperties": {
|
|
320142
|
+
"type": "object",
|
|
320143
|
+
"properties": {
|
|
320144
|
+
"id": {
|
|
320145
|
+
"type": "string",
|
|
320146
|
+
"minLength": 28,
|
|
320147
|
+
"maxLength": 36
|
|
320148
|
+
},
|
|
320149
|
+
"name": {
|
|
320150
|
+
"type": "string",
|
|
320151
|
+
"maxLength": 200
|
|
320152
|
+
},
|
|
320153
|
+
"version": {
|
|
320154
|
+
"type": "string",
|
|
320155
|
+
"maxLength": 200
|
|
320156
|
+
}
|
|
320157
|
+
},
|
|
320158
|
+
"required": [
|
|
320159
|
+
"id",
|
|
320160
|
+
"name",
|
|
320161
|
+
"version"
|
|
320162
|
+
],
|
|
320163
|
+
"additionalProperties": false
|
|
320164
|
+
}
|
|
320165
|
+
}
|
|
320166
|
+
},
|
|
320167
|
+
"required": [
|
|
320168
|
+
"interfaces",
|
|
320169
|
+
"integrations"
|
|
320170
|
+
],
|
|
320171
|
+
"additionalProperties": false
|
|
320172
|
+
},
|
|
320173
|
+
"user": {
|
|
320174
|
+
"type": "object",
|
|
320175
|
+
"properties": {
|
|
320176
|
+
"tags": {
|
|
320177
|
+
"type": "object",
|
|
320178
|
+
"additionalProperties": {
|
|
320179
|
+
"type": "object",
|
|
320180
|
+
"properties": {
|
|
320181
|
+
"title": {
|
|
320182
|
+
"type": "string",
|
|
320183
|
+
"maxLength": 64,
|
|
320184
|
+
"description": "Title of the tag"
|
|
320185
|
+
},
|
|
320186
|
+
"description": {
|
|
320187
|
+
"type": "string",
|
|
320188
|
+
"maxLength": 256,
|
|
320189
|
+
"description": "Description of the tag"
|
|
320190
|
+
}
|
|
320191
|
+
},
|
|
320192
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
320193
|
+
"additionalProperties": false
|
|
320194
|
+
}
|
|
320195
|
+
}
|
|
320196
|
+
},
|
|
320197
|
+
"required": [
|
|
320198
|
+
"tags"
|
|
320199
|
+
],
|
|
320200
|
+
"description": "User object configuration",
|
|
320201
|
+
"additionalProperties": false
|
|
320202
|
+
},
|
|
320203
|
+
"conversation": {
|
|
320204
|
+
"type": "object",
|
|
320205
|
+
"properties": {
|
|
320206
|
+
"tags": {
|
|
320207
|
+
"type": "object",
|
|
320208
|
+
"additionalProperties": {
|
|
320209
|
+
"type": "object",
|
|
320210
|
+
"properties": {
|
|
320211
|
+
"title": {
|
|
320212
|
+
"type": "string",
|
|
320213
|
+
"maxLength": 64,
|
|
320214
|
+
"description": "Title of the tag"
|
|
320215
|
+
},
|
|
320216
|
+
"description": {
|
|
320217
|
+
"type": "string",
|
|
320218
|
+
"maxLength": 256,
|
|
320219
|
+
"description": "Description of the tag"
|
|
320220
|
+
}
|
|
320221
|
+
},
|
|
320222
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
320223
|
+
"additionalProperties": false
|
|
320224
|
+
}
|
|
320225
|
+
}
|
|
320226
|
+
},
|
|
320227
|
+
"required": [
|
|
320228
|
+
"tags"
|
|
320229
|
+
],
|
|
320230
|
+
"description": "Conversation object configuration",
|
|
320231
|
+
"additionalProperties": false
|
|
320232
|
+
},
|
|
320233
|
+
"title": {
|
|
320234
|
+
"type": "string",
|
|
320235
|
+
"minLength": 1,
|
|
320236
|
+
"maxLength": 64,
|
|
320237
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
320238
|
+
},
|
|
320239
|
+
"description": {
|
|
320240
|
+
"type": "string",
|
|
320241
|
+
"maxLength": 256,
|
|
320242
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
320243
|
+
},
|
|
320244
|
+
"iconUrl": {
|
|
320245
|
+
"type": "string",
|
|
320246
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
320247
|
+
},
|
|
320248
|
+
"readmeUrl": {
|
|
320249
|
+
"type": "string",
|
|
320250
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
320251
|
+
},
|
|
320252
|
+
"public": {
|
|
320253
|
+
"type": "boolean",
|
|
320254
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
320255
|
+
}
|
|
320256
|
+
},
|
|
320257
|
+
"required": [
|
|
320258
|
+
"id",
|
|
320259
|
+
"name",
|
|
320260
|
+
"version",
|
|
320261
|
+
"createdAt",
|
|
320262
|
+
"updatedAt",
|
|
320263
|
+
"configuration",
|
|
320264
|
+
"states",
|
|
320265
|
+
"events",
|
|
320266
|
+
"actions",
|
|
320267
|
+
"dependencies",
|
|
320268
|
+
"user",
|
|
320269
|
+
"conversation",
|
|
320270
|
+
"title",
|
|
320271
|
+
"description",
|
|
320272
|
+
"iconUrl",
|
|
320273
|
+
"readmeUrl",
|
|
320274
|
+
"public"
|
|
320275
|
+
],
|
|
320276
|
+
"additionalProperties": false
|
|
320277
|
+
}
|
|
320278
|
+
},
|
|
320279
|
+
"required": [
|
|
320280
|
+
"plugin"
|
|
320281
|
+
],
|
|
320282
|
+
"title": "getPublicPluginResponse",
|
|
320283
|
+
"additionalProperties": false
|
|
320284
|
+
}
|
|
320285
|
+
}
|
|
320286
|
+
},
|
|
320287
|
+
"getPublicPluginCode": {
|
|
320288
|
+
"name": "getPublicPluginCode",
|
|
320289
|
+
"description": "Get public plugin code",
|
|
320290
|
+
"method": "get",
|
|
320291
|
+
"path": "/v1/admin/hub/plugins/{id}/code/{platform}",
|
|
320292
|
+
"disableDefaultParameters": {
|
|
320293
|
+
"x-workspace-id": true
|
|
320294
|
+
},
|
|
320295
|
+
"section": "hub",
|
|
320296
|
+
"parameters": {
|
|
320297
|
+
"id": {
|
|
320298
|
+
"in": "path",
|
|
320299
|
+
"type": "string",
|
|
320300
|
+
"description": "Plugin id"
|
|
320301
|
+
},
|
|
320302
|
+
"platform": {
|
|
320303
|
+
"in": "path",
|
|
320304
|
+
"type": "string",
|
|
320305
|
+
"enum": [
|
|
320306
|
+
"node",
|
|
320307
|
+
"browser"
|
|
320308
|
+
],
|
|
320309
|
+
"description": "Platform"
|
|
320310
|
+
}
|
|
320311
|
+
},
|
|
320312
|
+
"response": {
|
|
320313
|
+
"description": "Plugin code",
|
|
320314
|
+
"schema": {
|
|
320315
|
+
"type": "object",
|
|
320316
|
+
"properties": {
|
|
320317
|
+
"code": {
|
|
320318
|
+
"type": "string"
|
|
320319
|
+
}
|
|
320320
|
+
},
|
|
320321
|
+
"required": [
|
|
320322
|
+
"code"
|
|
320323
|
+
],
|
|
320324
|
+
"title": "getPublicPluginCodeResponse",
|
|
320325
|
+
"additionalProperties": false
|
|
320326
|
+
}
|
|
320327
|
+
}
|
|
320328
|
+
},
|
|
320329
|
+
"listPublicInterfaces": {
|
|
320330
|
+
"name": "listPublicInterfaces",
|
|
320331
|
+
"description": "List public interfaces",
|
|
320332
|
+
"method": "get",
|
|
320333
|
+
"section": "hub",
|
|
320334
|
+
"path": "/v1/admin/hub/interfaces",
|
|
320335
|
+
"disableDefaultParameters": {
|
|
320336
|
+
"x-workspace-id": true
|
|
320337
|
+
},
|
|
320338
|
+
"parameters": {
|
|
320339
|
+
"nextToken": {
|
|
320340
|
+
"in": "query",
|
|
320341
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
320342
|
+
"type": "string"
|
|
320343
|
+
},
|
|
320344
|
+
"name": {
|
|
320345
|
+
"in": "query",
|
|
320346
|
+
"type": "string",
|
|
320347
|
+
"description": "Filter all versions of an interface by name"
|
|
320348
|
+
},
|
|
320349
|
+
"version": {
|
|
320350
|
+
"in": "query",
|
|
320351
|
+
"type": "string",
|
|
320352
|
+
"description": "Filter an interface by name and version"
|
|
320353
|
+
}
|
|
320354
|
+
},
|
|
320355
|
+
"response": {
|
|
320356
|
+
"description": "Success",
|
|
320357
|
+
"schema": {
|
|
320358
|
+
"type": "object",
|
|
320359
|
+
"properties": {
|
|
320360
|
+
"interfaces": {
|
|
320361
|
+
"type": "array",
|
|
320362
|
+
"items": {
|
|
320363
|
+
"type": "object",
|
|
320364
|
+
"properties": {
|
|
320365
|
+
"id": {
|
|
320366
|
+
"type": "string",
|
|
320367
|
+
"minLength": 28,
|
|
320368
|
+
"maxLength": 36,
|
|
320369
|
+
"description": "ID of the [Interface](#schema_interface)"
|
|
320370
|
+
},
|
|
320371
|
+
"createdAt": {
|
|
320372
|
+
"type": "string",
|
|
320373
|
+
"format": "date-time",
|
|
320374
|
+
"description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
320375
|
+
},
|
|
320376
|
+
"updatedAt": {
|
|
320377
|
+
"type": "string",
|
|
320378
|
+
"format": "date-time",
|
|
320379
|
+
"description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
320380
|
+
},
|
|
320381
|
+
"name": {
|
|
320382
|
+
"type": "string",
|
|
320383
|
+
"maxLength": 200,
|
|
320384
|
+
"description": "Name of the [Interface](#schema_interface)"
|
|
320385
|
+
},
|
|
320386
|
+
"version": {
|
|
320387
|
+
"type": "string",
|
|
320388
|
+
"maxLength": 200,
|
|
320389
|
+
"description": "Version of the [Interface](#schema_interface)"
|
|
320390
|
+
},
|
|
320391
|
+
"title": {
|
|
320392
|
+
"type": "string",
|
|
320393
|
+
"minLength": 1,
|
|
320394
|
+
"maxLength": 64,
|
|
320395
|
+
"description": "Title of the interface. This is the name that will be displayed in the UI"
|
|
320396
|
+
},
|
|
320397
|
+
"description": {
|
|
320398
|
+
"type": "string",
|
|
320399
|
+
"maxLength": 256,
|
|
320400
|
+
"description": "Description of the interface. This is the description that will be displayed in the UI"
|
|
320401
|
+
},
|
|
320402
|
+
"iconUrl": {
|
|
320403
|
+
"type": "string",
|
|
320404
|
+
"description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
|
|
320405
|
+
},
|
|
320406
|
+
"readmeUrl": {
|
|
320407
|
+
"type": "string",
|
|
320408
|
+
"description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
|
|
320409
|
+
},
|
|
320410
|
+
"public": {
|
|
320411
|
+
"type": "boolean",
|
|
320412
|
+
"description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
|
|
320413
|
+
}
|
|
320414
|
+
},
|
|
320415
|
+
"required": [
|
|
320416
|
+
"id",
|
|
320417
|
+
"createdAt",
|
|
320418
|
+
"updatedAt",
|
|
320419
|
+
"name",
|
|
320420
|
+
"version",
|
|
320421
|
+
"title",
|
|
320422
|
+
"description",
|
|
320423
|
+
"iconUrl",
|
|
320424
|
+
"readmeUrl",
|
|
320425
|
+
"public"
|
|
320426
|
+
]
|
|
320427
|
+
}
|
|
320428
|
+
},
|
|
320429
|
+
"meta": {
|
|
320430
|
+
"type": "object",
|
|
320431
|
+
"properties": {
|
|
320432
|
+
"nextToken": {
|
|
320433
|
+
"type": "string",
|
|
320434
|
+
"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."
|
|
320435
|
+
}
|
|
320436
|
+
},
|
|
320437
|
+
"additionalProperties": false
|
|
320438
|
+
}
|
|
320439
|
+
},
|
|
320440
|
+
"required": [
|
|
320441
|
+
"interfaces",
|
|
320442
|
+
"meta"
|
|
320443
|
+
],
|
|
320444
|
+
"title": "listPublicInterfacesResponse",
|
|
320445
|
+
"additionalProperties": false
|
|
320446
|
+
}
|
|
320447
|
+
}
|
|
320448
|
+
},
|
|
320449
|
+
"getPublicInterfaceById": {
|
|
320450
|
+
"name": "getPublicInterfaceById",
|
|
320451
|
+
"description": "Get public interface by Id",
|
|
320452
|
+
"method": "get",
|
|
320453
|
+
"section": "hub",
|
|
320454
|
+
"path": "/v1/admin/hub/interfaces/{id}",
|
|
320455
|
+
"disableDefaultParameters": {
|
|
320456
|
+
"x-workspace-id": true
|
|
320457
|
+
},
|
|
320458
|
+
"parameters": {
|
|
320459
|
+
"id": {
|
|
320460
|
+
"type": "string",
|
|
320461
|
+
"description": "Interface ID",
|
|
320462
|
+
"in": "path"
|
|
320463
|
+
}
|
|
320464
|
+
},
|
|
320465
|
+
"response": {
|
|
320466
|
+
"description": "Success",
|
|
320467
|
+
"schema": {
|
|
320468
|
+
"type": "object",
|
|
320469
|
+
"properties": {
|
|
320470
|
+
"interface": {
|
|
320471
|
+
"type": "object",
|
|
320472
|
+
"properties": {
|
|
320473
|
+
"id": {
|
|
320474
|
+
"type": "string",
|
|
320475
|
+
"minLength": 28,
|
|
320476
|
+
"maxLength": 36,
|
|
320477
|
+
"description": "ID of the [Interface](#schema_interface)"
|
|
320478
|
+
},
|
|
320479
|
+
"createdAt": {
|
|
320480
|
+
"type": "string",
|
|
320481
|
+
"format": "date-time",
|
|
320482
|
+
"description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
320483
|
+
},
|
|
320484
|
+
"updatedAt": {
|
|
320485
|
+
"type": "string",
|
|
320486
|
+
"format": "date-time",
|
|
320487
|
+
"description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
320488
|
+
},
|
|
320489
|
+
"name": {
|
|
320490
|
+
"type": "string",
|
|
320491
|
+
"maxLength": 200,
|
|
320492
|
+
"description": "Name of the [Interface](#schema_interface)"
|
|
320493
|
+
},
|
|
320494
|
+
"version": {
|
|
320495
|
+
"type": "string",
|
|
320496
|
+
"maxLength": 200,
|
|
320497
|
+
"description": "Version of the [Interface](#schema_interface)"
|
|
320498
|
+
},
|
|
320499
|
+
"entities": {
|
|
320500
|
+
"type": "object",
|
|
320501
|
+
"additionalProperties": {
|
|
320502
|
+
"type": "object",
|
|
320503
|
+
"properties": {
|
|
320504
|
+
"title": {
|
|
320505
|
+
"type": "string",
|
|
320506
|
+
"maxLength": 64,
|
|
320507
|
+
"description": "Title of the entity"
|
|
320508
|
+
},
|
|
320509
|
+
"description": {
|
|
320510
|
+
"type": "string",
|
|
320511
|
+
"maxLength": 256,
|
|
320512
|
+
"description": "Description of the entity"
|
|
320513
|
+
},
|
|
320514
|
+
"schema": {
|
|
320515
|
+
"type": "object",
|
|
320516
|
+
"additionalProperties": true
|
|
320517
|
+
}
|
|
320518
|
+
},
|
|
320519
|
+
"required": [
|
|
320520
|
+
"schema"
|
|
320521
|
+
],
|
|
320522
|
+
"description": "Entity definition",
|
|
320523
|
+
"additionalProperties": false
|
|
320524
|
+
}
|
|
320525
|
+
},
|
|
320526
|
+
"events": {
|
|
320527
|
+
"type": "object",
|
|
320528
|
+
"additionalProperties": {
|
|
320529
|
+
"type": "object",
|
|
320530
|
+
"properties": {
|
|
320531
|
+
"title": {
|
|
320532
|
+
"type": "string",
|
|
320533
|
+
"maxLength": 64,
|
|
320534
|
+
"description": "Title of the event"
|
|
320535
|
+
},
|
|
320536
|
+
"description": {
|
|
320537
|
+
"type": "string",
|
|
320538
|
+
"maxLength": 256,
|
|
320539
|
+
"description": "Description of the event"
|
|
320540
|
+
},
|
|
320541
|
+
"schema": {
|
|
320542
|
+
"type": "object",
|
|
320543
|
+
"additionalProperties": true
|
|
320544
|
+
},
|
|
320545
|
+
"attributes": {
|
|
320546
|
+
"type": "object",
|
|
320547
|
+
"additionalProperties": {
|
|
320548
|
+
"type": "string",
|
|
320549
|
+
"maxLength": 200
|
|
320550
|
+
},
|
|
320551
|
+
"description": "Optional attributes"
|
|
320552
|
+
}
|
|
320553
|
+
},
|
|
320554
|
+
"required": [
|
|
320555
|
+
"schema"
|
|
320556
|
+
],
|
|
320557
|
+
"description": "Event Definition",
|
|
320558
|
+
"additionalProperties": false
|
|
320559
|
+
}
|
|
320560
|
+
},
|
|
320561
|
+
"actions": {
|
|
320562
|
+
"type": "object",
|
|
320563
|
+
"additionalProperties": {
|
|
320564
|
+
"type": "object",
|
|
320565
|
+
"properties": {
|
|
320566
|
+
"title": {
|
|
320567
|
+
"type": "string",
|
|
320568
|
+
"maxLength": 64,
|
|
320569
|
+
"description": "Title of the action"
|
|
320570
|
+
},
|
|
320571
|
+
"description": {
|
|
320572
|
+
"type": "string",
|
|
320573
|
+
"maxLength": 256,
|
|
320574
|
+
"description": "Description of the action"
|
|
320575
|
+
},
|
|
320576
|
+
"billable": {
|
|
320577
|
+
"type": "boolean"
|
|
320578
|
+
},
|
|
320579
|
+
"cacheable": {
|
|
320580
|
+
"type": "boolean"
|
|
320581
|
+
},
|
|
320582
|
+
"input": {
|
|
320583
|
+
"type": "object",
|
|
320584
|
+
"properties": {
|
|
320585
|
+
"schema": {
|
|
320586
|
+
"type": "object",
|
|
320587
|
+
"additionalProperties": true
|
|
320588
|
+
}
|
|
320589
|
+
},
|
|
320590
|
+
"required": [
|
|
320591
|
+
"schema"
|
|
320592
|
+
],
|
|
320593
|
+
"additionalProperties": false
|
|
320594
|
+
},
|
|
320595
|
+
"output": {
|
|
320596
|
+
"type": "object",
|
|
320597
|
+
"properties": {
|
|
320598
|
+
"schema": {
|
|
320599
|
+
"type": "object",
|
|
320600
|
+
"additionalProperties": true
|
|
320601
|
+
}
|
|
320602
|
+
},
|
|
320603
|
+
"required": [
|
|
320604
|
+
"schema"
|
|
320605
|
+
],
|
|
320606
|
+
"additionalProperties": false
|
|
320607
|
+
},
|
|
320608
|
+
"attributes": {
|
|
320609
|
+
"type": "object",
|
|
320610
|
+
"additionalProperties": {
|
|
320611
|
+
"type": "string",
|
|
320612
|
+
"maxLength": 200
|
|
320613
|
+
},
|
|
320614
|
+
"description": "Optional attributes"
|
|
320615
|
+
}
|
|
320616
|
+
},
|
|
320617
|
+
"required": [
|
|
320618
|
+
"input",
|
|
320619
|
+
"output"
|
|
320620
|
+
],
|
|
320621
|
+
"description": "Action definition",
|
|
320622
|
+
"additionalProperties": false
|
|
320623
|
+
}
|
|
320624
|
+
},
|
|
320625
|
+
"channels": {
|
|
319404
320626
|
"type": "object",
|
|
319405
|
-
"
|
|
319406
|
-
"
|
|
319407
|
-
|
|
319408
|
-
"
|
|
320627
|
+
"additionalProperties": {
|
|
320628
|
+
"type": "object",
|
|
320629
|
+
"properties": {
|
|
320630
|
+
"title": {
|
|
320631
|
+
"type": "string",
|
|
320632
|
+
"maxLength": 64,
|
|
320633
|
+
"description": "Title of the channel"
|
|
320634
|
+
},
|
|
320635
|
+
"description": {
|
|
320636
|
+
"type": "string",
|
|
320637
|
+
"maxLength": 256,
|
|
320638
|
+
"description": "Description of the channel"
|
|
320639
|
+
},
|
|
320640
|
+
"messages": {
|
|
319409
320641
|
"type": "object",
|
|
319410
|
-
"
|
|
319411
|
-
"
|
|
319412
|
-
|
|
319413
|
-
"
|
|
319414
|
-
|
|
319415
|
-
|
|
319416
|
-
|
|
319417
|
-
"type": "string",
|
|
319418
|
-
"maxLength": 200
|
|
320642
|
+
"additionalProperties": {
|
|
320643
|
+
"type": "object",
|
|
320644
|
+
"properties": {
|
|
320645
|
+
"schema": {
|
|
320646
|
+
"type": "object",
|
|
320647
|
+
"additionalProperties": true
|
|
320648
|
+
}
|
|
319419
320649
|
},
|
|
319420
|
-
"
|
|
319421
|
-
"
|
|
319422
|
-
|
|
319423
|
-
|
|
319424
|
-
|
|
319425
|
-
|
|
319426
|
-
"id",
|
|
319427
|
-
"name",
|
|
319428
|
-
"version"
|
|
319429
|
-
],
|
|
319430
|
-
"additionalProperties": false
|
|
320650
|
+
"required": [
|
|
320651
|
+
"schema"
|
|
320652
|
+
],
|
|
320653
|
+
"description": "Message definition",
|
|
320654
|
+
"additionalProperties": false
|
|
320655
|
+
}
|
|
319431
320656
|
}
|
|
319432
320657
|
},
|
|
319433
|
-
"
|
|
319434
|
-
"
|
|
319435
|
-
|
|
319436
|
-
|
|
319437
|
-
|
|
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
|
|
320658
|
+
"required": [
|
|
320659
|
+
"messages"
|
|
320660
|
+
],
|
|
320661
|
+
"additionalProperties": false
|
|
320662
|
+
}
|
|
319496
320663
|
},
|
|
319497
|
-
"
|
|
320664
|
+
"nameTemplate": {
|
|
319498
320665
|
"type": "object",
|
|
319499
320666
|
"properties": {
|
|
319500
|
-
"
|
|
319501
|
-
"type": "
|
|
319502
|
-
"
|
|
319503
|
-
|
|
319504
|
-
|
|
319505
|
-
|
|
319506
|
-
|
|
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
|
-
}
|
|
320667
|
+
"script": {
|
|
320668
|
+
"type": "string",
|
|
320669
|
+
"maxLength": 2e3
|
|
320670
|
+
},
|
|
320671
|
+
"language": {
|
|
320672
|
+
"type": "string",
|
|
320673
|
+
"maxLength": 200
|
|
319519
320674
|
}
|
|
319520
320675
|
},
|
|
319521
320676
|
"required": [
|
|
319522
|
-
"
|
|
320677
|
+
"script",
|
|
320678
|
+
"language"
|
|
319523
320679
|
],
|
|
319524
|
-
"description": "
|
|
320680
|
+
"description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
|
|
319525
320681
|
"additionalProperties": false
|
|
319526
320682
|
},
|
|
319527
320683
|
"title": {
|
|
319528
320684
|
"type": "string",
|
|
319529
320685
|
"minLength": 1,
|
|
319530
320686
|
"maxLength": 64,
|
|
319531
|
-
"description": "Title of the
|
|
320687
|
+
"description": "Title of the interface. This is the name that will be displayed in the UI"
|
|
319532
320688
|
},
|
|
319533
320689
|
"description": {
|
|
319534
320690
|
"type": "string",
|
|
319535
320691
|
"maxLength": 256,
|
|
319536
|
-
"description": "Description of the
|
|
320692
|
+
"description": "Description of the interface. This is the description that will be displayed in the UI"
|
|
319537
320693
|
},
|
|
319538
320694
|
"iconUrl": {
|
|
319539
320695
|
"type": "string",
|
|
319540
|
-
"description": "URL of the icon of the
|
|
320696
|
+
"description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
|
|
319541
320697
|
},
|
|
319542
320698
|
"readmeUrl": {
|
|
319543
320699
|
"type": "string",
|
|
319544
|
-
"description": "URL of the readme of the
|
|
320700
|
+
"description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
|
|
319545
320701
|
},
|
|
319546
320702
|
"public": {
|
|
319547
320703
|
"type": "boolean",
|
|
319548
|
-
"description": "Indicates if the
|
|
320704
|
+
"description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
|
|
319549
320705
|
}
|
|
319550
320706
|
},
|
|
319551
320707
|
"required": [
|
|
319552
320708
|
"id",
|
|
319553
|
-
"name",
|
|
319554
|
-
"version",
|
|
319555
320709
|
"createdAt",
|
|
319556
320710
|
"updatedAt",
|
|
319557
|
-
"
|
|
319558
|
-
"
|
|
320711
|
+
"name",
|
|
320712
|
+
"version",
|
|
320713
|
+
"entities",
|
|
319559
320714
|
"events",
|
|
319560
320715
|
"actions",
|
|
319561
|
-
"
|
|
319562
|
-
"user",
|
|
319563
|
-
"conversation",
|
|
320716
|
+
"channels",
|
|
319564
320717
|
"title",
|
|
319565
320718
|
"description",
|
|
319566
320719
|
"iconUrl",
|
|
@@ -319571,51 +320724,299 @@ var state5 = {
|
|
|
319571
320724
|
}
|
|
319572
320725
|
},
|
|
319573
320726
|
"required": [
|
|
319574
|
-
"
|
|
320727
|
+
"interface"
|
|
319575
320728
|
],
|
|
319576
|
-
"title": "
|
|
320729
|
+
"title": "getPublicInterfaceByIdResponse",
|
|
319577
320730
|
"additionalProperties": false
|
|
319578
320731
|
}
|
|
319579
320732
|
}
|
|
319580
320733
|
},
|
|
319581
|
-
"
|
|
319582
|
-
"name": "
|
|
319583
|
-
"description": "Get public
|
|
320734
|
+
"getPublicInterface": {
|
|
320735
|
+
"name": "getPublicInterface",
|
|
320736
|
+
"description": "Get public interface by name and version",
|
|
319584
320737
|
"method": "get",
|
|
319585
|
-
"
|
|
320738
|
+
"section": "hub",
|
|
320739
|
+
"path": "/v1/admin/hub/interfaces/{name}/{version}",
|
|
319586
320740
|
"disableDefaultParameters": {
|
|
319587
320741
|
"x-workspace-id": true
|
|
319588
320742
|
},
|
|
319589
|
-
"section": "hub",
|
|
319590
320743
|
"parameters": {
|
|
319591
|
-
"
|
|
319592
|
-
"in": "path",
|
|
320744
|
+
"name": {
|
|
319593
320745
|
"type": "string",
|
|
319594
|
-
"description": "
|
|
320746
|
+
"description": "Interface Name",
|
|
320747
|
+
"in": "path"
|
|
319595
320748
|
},
|
|
319596
|
-
"
|
|
319597
|
-
"in": "path",
|
|
320749
|
+
"version": {
|
|
319598
320750
|
"type": "string",
|
|
319599
|
-
"
|
|
319600
|
-
|
|
319601
|
-
"browser"
|
|
319602
|
-
],
|
|
319603
|
-
"description": "Platform"
|
|
320751
|
+
"description": "Interface version.",
|
|
320752
|
+
"in": "path"
|
|
319604
320753
|
}
|
|
319605
320754
|
},
|
|
319606
320755
|
"response": {
|
|
319607
|
-
"description": "
|
|
320756
|
+
"description": "Success",
|
|
319608
320757
|
"schema": {
|
|
319609
320758
|
"type": "object",
|
|
319610
320759
|
"properties": {
|
|
319611
|
-
"
|
|
319612
|
-
"type": "
|
|
320760
|
+
"interface": {
|
|
320761
|
+
"type": "object",
|
|
320762
|
+
"properties": {
|
|
320763
|
+
"id": {
|
|
320764
|
+
"type": "string",
|
|
320765
|
+
"minLength": 28,
|
|
320766
|
+
"maxLength": 36,
|
|
320767
|
+
"description": "ID of the [Interface](#schema_interface)"
|
|
320768
|
+
},
|
|
320769
|
+
"createdAt": {
|
|
320770
|
+
"type": "string",
|
|
320771
|
+
"format": "date-time",
|
|
320772
|
+
"description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
320773
|
+
},
|
|
320774
|
+
"updatedAt": {
|
|
320775
|
+
"type": "string",
|
|
320776
|
+
"format": "date-time",
|
|
320777
|
+
"description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
320778
|
+
},
|
|
320779
|
+
"name": {
|
|
320780
|
+
"type": "string",
|
|
320781
|
+
"maxLength": 200,
|
|
320782
|
+
"description": "Name of the [Interface](#schema_interface)"
|
|
320783
|
+
},
|
|
320784
|
+
"version": {
|
|
320785
|
+
"type": "string",
|
|
320786
|
+
"maxLength": 200,
|
|
320787
|
+
"description": "Version of the [Interface](#schema_interface)"
|
|
320788
|
+
},
|
|
320789
|
+
"entities": {
|
|
320790
|
+
"type": "object",
|
|
320791
|
+
"additionalProperties": {
|
|
320792
|
+
"type": "object",
|
|
320793
|
+
"properties": {
|
|
320794
|
+
"title": {
|
|
320795
|
+
"type": "string",
|
|
320796
|
+
"maxLength": 64,
|
|
320797
|
+
"description": "Title of the entity"
|
|
320798
|
+
},
|
|
320799
|
+
"description": {
|
|
320800
|
+
"type": "string",
|
|
320801
|
+
"maxLength": 256,
|
|
320802
|
+
"description": "Description of the entity"
|
|
320803
|
+
},
|
|
320804
|
+
"schema": {
|
|
320805
|
+
"type": "object",
|
|
320806
|
+
"additionalProperties": true
|
|
320807
|
+
}
|
|
320808
|
+
},
|
|
320809
|
+
"required": [
|
|
320810
|
+
"schema"
|
|
320811
|
+
],
|
|
320812
|
+
"description": "Entity definition",
|
|
320813
|
+
"additionalProperties": false
|
|
320814
|
+
}
|
|
320815
|
+
},
|
|
320816
|
+
"events": {
|
|
320817
|
+
"type": "object",
|
|
320818
|
+
"additionalProperties": {
|
|
320819
|
+
"type": "object",
|
|
320820
|
+
"properties": {
|
|
320821
|
+
"title": {
|
|
320822
|
+
"type": "string",
|
|
320823
|
+
"maxLength": 64,
|
|
320824
|
+
"description": "Title of the event"
|
|
320825
|
+
},
|
|
320826
|
+
"description": {
|
|
320827
|
+
"type": "string",
|
|
320828
|
+
"maxLength": 256,
|
|
320829
|
+
"description": "Description of the event"
|
|
320830
|
+
},
|
|
320831
|
+
"schema": {
|
|
320832
|
+
"type": "object",
|
|
320833
|
+
"additionalProperties": true
|
|
320834
|
+
},
|
|
320835
|
+
"attributes": {
|
|
320836
|
+
"type": "object",
|
|
320837
|
+
"additionalProperties": {
|
|
320838
|
+
"type": "string",
|
|
320839
|
+
"maxLength": 200
|
|
320840
|
+
},
|
|
320841
|
+
"description": "Optional attributes"
|
|
320842
|
+
}
|
|
320843
|
+
},
|
|
320844
|
+
"required": [
|
|
320845
|
+
"schema"
|
|
320846
|
+
],
|
|
320847
|
+
"description": "Event Definition",
|
|
320848
|
+
"additionalProperties": false
|
|
320849
|
+
}
|
|
320850
|
+
},
|
|
320851
|
+
"actions": {
|
|
320852
|
+
"type": "object",
|
|
320853
|
+
"additionalProperties": {
|
|
320854
|
+
"type": "object",
|
|
320855
|
+
"properties": {
|
|
320856
|
+
"title": {
|
|
320857
|
+
"type": "string",
|
|
320858
|
+
"maxLength": 64,
|
|
320859
|
+
"description": "Title of the action"
|
|
320860
|
+
},
|
|
320861
|
+
"description": {
|
|
320862
|
+
"type": "string",
|
|
320863
|
+
"maxLength": 256,
|
|
320864
|
+
"description": "Description of the action"
|
|
320865
|
+
},
|
|
320866
|
+
"billable": {
|
|
320867
|
+
"type": "boolean"
|
|
320868
|
+
},
|
|
320869
|
+
"cacheable": {
|
|
320870
|
+
"type": "boolean"
|
|
320871
|
+
},
|
|
320872
|
+
"input": {
|
|
320873
|
+
"type": "object",
|
|
320874
|
+
"properties": {
|
|
320875
|
+
"schema": {
|
|
320876
|
+
"type": "object",
|
|
320877
|
+
"additionalProperties": true
|
|
320878
|
+
}
|
|
320879
|
+
},
|
|
320880
|
+
"required": [
|
|
320881
|
+
"schema"
|
|
320882
|
+
],
|
|
320883
|
+
"additionalProperties": false
|
|
320884
|
+
},
|
|
320885
|
+
"output": {
|
|
320886
|
+
"type": "object",
|
|
320887
|
+
"properties": {
|
|
320888
|
+
"schema": {
|
|
320889
|
+
"type": "object",
|
|
320890
|
+
"additionalProperties": true
|
|
320891
|
+
}
|
|
320892
|
+
},
|
|
320893
|
+
"required": [
|
|
320894
|
+
"schema"
|
|
320895
|
+
],
|
|
320896
|
+
"additionalProperties": false
|
|
320897
|
+
},
|
|
320898
|
+
"attributes": {
|
|
320899
|
+
"type": "object",
|
|
320900
|
+
"additionalProperties": {
|
|
320901
|
+
"type": "string",
|
|
320902
|
+
"maxLength": 200
|
|
320903
|
+
},
|
|
320904
|
+
"description": "Optional attributes"
|
|
320905
|
+
}
|
|
320906
|
+
},
|
|
320907
|
+
"required": [
|
|
320908
|
+
"input",
|
|
320909
|
+
"output"
|
|
320910
|
+
],
|
|
320911
|
+
"description": "Action definition",
|
|
320912
|
+
"additionalProperties": false
|
|
320913
|
+
}
|
|
320914
|
+
},
|
|
320915
|
+
"channels": {
|
|
320916
|
+
"type": "object",
|
|
320917
|
+
"additionalProperties": {
|
|
320918
|
+
"type": "object",
|
|
320919
|
+
"properties": {
|
|
320920
|
+
"title": {
|
|
320921
|
+
"type": "string",
|
|
320922
|
+
"maxLength": 64,
|
|
320923
|
+
"description": "Title of the channel"
|
|
320924
|
+
},
|
|
320925
|
+
"description": {
|
|
320926
|
+
"type": "string",
|
|
320927
|
+
"maxLength": 256,
|
|
320928
|
+
"description": "Description of the channel"
|
|
320929
|
+
},
|
|
320930
|
+
"messages": {
|
|
320931
|
+
"type": "object",
|
|
320932
|
+
"additionalProperties": {
|
|
320933
|
+
"type": "object",
|
|
320934
|
+
"properties": {
|
|
320935
|
+
"schema": {
|
|
320936
|
+
"type": "object",
|
|
320937
|
+
"additionalProperties": true
|
|
320938
|
+
}
|
|
320939
|
+
},
|
|
320940
|
+
"required": [
|
|
320941
|
+
"schema"
|
|
320942
|
+
],
|
|
320943
|
+
"description": "Message definition",
|
|
320944
|
+
"additionalProperties": false
|
|
320945
|
+
}
|
|
320946
|
+
}
|
|
320947
|
+
},
|
|
320948
|
+
"required": [
|
|
320949
|
+
"messages"
|
|
320950
|
+
],
|
|
320951
|
+
"additionalProperties": false
|
|
320952
|
+
}
|
|
320953
|
+
},
|
|
320954
|
+
"nameTemplate": {
|
|
320955
|
+
"type": "object",
|
|
320956
|
+
"properties": {
|
|
320957
|
+
"script": {
|
|
320958
|
+
"type": "string",
|
|
320959
|
+
"maxLength": 2e3
|
|
320960
|
+
},
|
|
320961
|
+
"language": {
|
|
320962
|
+
"type": "string",
|
|
320963
|
+
"maxLength": 200
|
|
320964
|
+
}
|
|
320965
|
+
},
|
|
320966
|
+
"required": [
|
|
320967
|
+
"script",
|
|
320968
|
+
"language"
|
|
320969
|
+
],
|
|
320970
|
+
"description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
|
|
320971
|
+
"additionalProperties": false
|
|
320972
|
+
},
|
|
320973
|
+
"title": {
|
|
320974
|
+
"type": "string",
|
|
320975
|
+
"minLength": 1,
|
|
320976
|
+
"maxLength": 64,
|
|
320977
|
+
"description": "Title of the interface. This is the name that will be displayed in the UI"
|
|
320978
|
+
},
|
|
320979
|
+
"description": {
|
|
320980
|
+
"type": "string",
|
|
320981
|
+
"maxLength": 256,
|
|
320982
|
+
"description": "Description of the interface. This is the description that will be displayed in the UI"
|
|
320983
|
+
},
|
|
320984
|
+
"iconUrl": {
|
|
320985
|
+
"type": "string",
|
|
320986
|
+
"description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
|
|
320987
|
+
},
|
|
320988
|
+
"readmeUrl": {
|
|
320989
|
+
"type": "string",
|
|
320990
|
+
"description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
|
|
320991
|
+
},
|
|
320992
|
+
"public": {
|
|
320993
|
+
"type": "boolean",
|
|
320994
|
+
"description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
|
|
320995
|
+
}
|
|
320996
|
+
},
|
|
320997
|
+
"required": [
|
|
320998
|
+
"id",
|
|
320999
|
+
"createdAt",
|
|
321000
|
+
"updatedAt",
|
|
321001
|
+
"name",
|
|
321002
|
+
"version",
|
|
321003
|
+
"entities",
|
|
321004
|
+
"events",
|
|
321005
|
+
"actions",
|
|
321006
|
+
"channels",
|
|
321007
|
+
"title",
|
|
321008
|
+
"description",
|
|
321009
|
+
"iconUrl",
|
|
321010
|
+
"readmeUrl",
|
|
321011
|
+
"public"
|
|
321012
|
+
],
|
|
321013
|
+
"additionalProperties": false
|
|
319613
321014
|
}
|
|
319614
321015
|
},
|
|
319615
321016
|
"required": [
|
|
319616
|
-
"
|
|
321017
|
+
"interface"
|
|
319617
321018
|
],
|
|
319618
|
-
"title": "
|
|
321019
|
+
"title": "getPublicInterfaceResponse",
|
|
319619
321020
|
"additionalProperties": false
|
|
319620
321021
|
}
|
|
319621
321022
|
}
|
|
@@ -327125,6 +328526,11 @@ var state5 = {
|
|
|
327125
328526
|
"in": "query",
|
|
327126
328527
|
"type": "string",
|
|
327127
328528
|
"description": "Filter all versions of an interface by name"
|
|
328529
|
+
},
|
|
328530
|
+
"version": {
|
|
328531
|
+
"in": "query",
|
|
328532
|
+
"type": "string",
|
|
328533
|
+
"description": "Filter an interface by name and version"
|
|
327128
328534
|
}
|
|
327129
328535
|
},
|
|
327130
328536
|
"response": {
|
|
@@ -331445,7 +332851,7 @@ var state5 = {
|
|
|
331445
332851
|
"title": "Botpress API",
|
|
331446
332852
|
"description": "API for Botpress Cloud",
|
|
331447
332853
|
"server": "https://api.botpress.cloud",
|
|
331448
|
-
"version": "1.
|
|
332854
|
+
"version": "1.13.0",
|
|
331449
332855
|
"prefix": "v1"
|
|
331450
332856
|
},
|
|
331451
332857
|
"errors": [
|
|
@@ -331703,6 +333109,9 @@ var state5 = {
|
|
|
331703
333109
|
"getPublicPluginByIdResponse": true,
|
|
331704
333110
|
"getPublicPluginResponse": true,
|
|
331705
333111
|
"getPublicPluginCodeResponse": true,
|
|
333112
|
+
"listPublicInterfacesResponse": true,
|
|
333113
|
+
"getPublicInterfaceByIdResponse": true,
|
|
333114
|
+
"getPublicInterfaceResponse": true,
|
|
331706
333115
|
"createBotResponse": true,
|
|
331707
333116
|
"updateBotResponse": true,
|
|
331708
333117
|
"transferBotResponse": true,
|
|
@@ -335237,7 +336646,10 @@ var state5 = {
|
|
|
335237
336646
|
"listPublicPlugins",
|
|
335238
336647
|
"getPublicPluginById",
|
|
335239
336648
|
"getPublicPlugin",
|
|
335240
|
-
"getPublicPluginCode"
|
|
336649
|
+
"getPublicPluginCode",
|
|
336650
|
+
"listPublicInterfaces",
|
|
336651
|
+
"getPublicInterfaceById",
|
|
336652
|
+
"getPublicInterface"
|
|
335241
336653
|
]
|
|
335242
336654
|
},
|
|
335243
336655
|
{
|