@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/src/gen/admin/state.ts
CHANGED
|
@@ -3045,6 +3045,701 @@ export const state = {
|
|
|
3045
3045
|
}
|
|
3046
3046
|
}
|
|
3047
3047
|
},
|
|
3048
|
+
"listPublicInterfaces": {
|
|
3049
|
+
"name": "listPublicInterfaces",
|
|
3050
|
+
"description": "List public interfaces",
|
|
3051
|
+
"method": "get",
|
|
3052
|
+
"section": "hub",
|
|
3053
|
+
"path": "/v1/admin/hub/interfaces",
|
|
3054
|
+
"disableDefaultParameters": {
|
|
3055
|
+
"x-workspace-id": true
|
|
3056
|
+
},
|
|
3057
|
+
"parameters": {
|
|
3058
|
+
"nextToken": {
|
|
3059
|
+
"in": "query",
|
|
3060
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
3061
|
+
"type": "string"
|
|
3062
|
+
},
|
|
3063
|
+
"name": {
|
|
3064
|
+
"in": "query",
|
|
3065
|
+
"type": "string",
|
|
3066
|
+
"description": "Filter all versions of an interface by name"
|
|
3067
|
+
},
|
|
3068
|
+
"version": {
|
|
3069
|
+
"in": "query",
|
|
3070
|
+
"type": "string",
|
|
3071
|
+
"description": "Filter an interface by name and version"
|
|
3072
|
+
}
|
|
3073
|
+
},
|
|
3074
|
+
"response": {
|
|
3075
|
+
"description": "Success",
|
|
3076
|
+
"schema": {
|
|
3077
|
+
"type": "object",
|
|
3078
|
+
"properties": {
|
|
3079
|
+
"interfaces": {
|
|
3080
|
+
"type": "array",
|
|
3081
|
+
"items": {
|
|
3082
|
+
"type": "object",
|
|
3083
|
+
"properties": {
|
|
3084
|
+
"id": {
|
|
3085
|
+
"type": "string",
|
|
3086
|
+
"minLength": 28,
|
|
3087
|
+
"maxLength": 36,
|
|
3088
|
+
"description": "ID of the [Interface](#schema_interface)"
|
|
3089
|
+
},
|
|
3090
|
+
"createdAt": {
|
|
3091
|
+
"type": "string",
|
|
3092
|
+
"format": "date-time",
|
|
3093
|
+
"description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
3094
|
+
},
|
|
3095
|
+
"updatedAt": {
|
|
3096
|
+
"type": "string",
|
|
3097
|
+
"format": "date-time",
|
|
3098
|
+
"description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
3099
|
+
},
|
|
3100
|
+
"name": {
|
|
3101
|
+
"type": "string",
|
|
3102
|
+
"maxLength": 200,
|
|
3103
|
+
"description": "Name of the [Interface](#schema_interface)"
|
|
3104
|
+
},
|
|
3105
|
+
"version": {
|
|
3106
|
+
"type": "string",
|
|
3107
|
+
"maxLength": 200,
|
|
3108
|
+
"description": "Version of the [Interface](#schema_interface)"
|
|
3109
|
+
},
|
|
3110
|
+
"title": {
|
|
3111
|
+
"type": "string",
|
|
3112
|
+
"minLength": 1,
|
|
3113
|
+
"maxLength": 64,
|
|
3114
|
+
"description": "Title of the interface. This is the name that will be displayed in the UI"
|
|
3115
|
+
},
|
|
3116
|
+
"description": {
|
|
3117
|
+
"type": "string",
|
|
3118
|
+
"maxLength": 256,
|
|
3119
|
+
"description": "Description of the interface. This is the description that will be displayed in the UI"
|
|
3120
|
+
},
|
|
3121
|
+
"iconUrl": {
|
|
3122
|
+
"type": "string",
|
|
3123
|
+
"description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
|
|
3124
|
+
},
|
|
3125
|
+
"readmeUrl": {
|
|
3126
|
+
"type": "string",
|
|
3127
|
+
"description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
|
|
3128
|
+
},
|
|
3129
|
+
"public": {
|
|
3130
|
+
"type": "boolean",
|
|
3131
|
+
"description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
|
|
3132
|
+
}
|
|
3133
|
+
},
|
|
3134
|
+
"required": [
|
|
3135
|
+
"id",
|
|
3136
|
+
"createdAt",
|
|
3137
|
+
"updatedAt",
|
|
3138
|
+
"name",
|
|
3139
|
+
"version",
|
|
3140
|
+
"title",
|
|
3141
|
+
"description",
|
|
3142
|
+
"iconUrl",
|
|
3143
|
+
"readmeUrl",
|
|
3144
|
+
"public"
|
|
3145
|
+
]
|
|
3146
|
+
}
|
|
3147
|
+
},
|
|
3148
|
+
"meta": {
|
|
3149
|
+
"type": "object",
|
|
3150
|
+
"properties": {
|
|
3151
|
+
"nextToken": {
|
|
3152
|
+
"type": "string",
|
|
3153
|
+
"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."
|
|
3154
|
+
}
|
|
3155
|
+
},
|
|
3156
|
+
"additionalProperties": false
|
|
3157
|
+
}
|
|
3158
|
+
},
|
|
3159
|
+
"required": [
|
|
3160
|
+
"interfaces",
|
|
3161
|
+
"meta"
|
|
3162
|
+
],
|
|
3163
|
+
"title": "listPublicInterfacesResponse",
|
|
3164
|
+
"additionalProperties": false
|
|
3165
|
+
}
|
|
3166
|
+
}
|
|
3167
|
+
},
|
|
3168
|
+
"getPublicInterfaceById": {
|
|
3169
|
+
"name": "getPublicInterfaceById",
|
|
3170
|
+
"description": "Get public interface by Id",
|
|
3171
|
+
"method": "get",
|
|
3172
|
+
"section": "hub",
|
|
3173
|
+
"path": "/v1/admin/hub/interfaces/{id}",
|
|
3174
|
+
"disableDefaultParameters": {
|
|
3175
|
+
"x-workspace-id": true
|
|
3176
|
+
},
|
|
3177
|
+
"parameters": {
|
|
3178
|
+
"id": {
|
|
3179
|
+
"type": "string",
|
|
3180
|
+
"description": "Interface ID",
|
|
3181
|
+
"in": "path"
|
|
3182
|
+
}
|
|
3183
|
+
},
|
|
3184
|
+
"response": {
|
|
3185
|
+
"description": "Success",
|
|
3186
|
+
"schema": {
|
|
3187
|
+
"type": "object",
|
|
3188
|
+
"properties": {
|
|
3189
|
+
"interface": {
|
|
3190
|
+
"type": "object",
|
|
3191
|
+
"properties": {
|
|
3192
|
+
"id": {
|
|
3193
|
+
"type": "string",
|
|
3194
|
+
"minLength": 28,
|
|
3195
|
+
"maxLength": 36,
|
|
3196
|
+
"description": "ID of the [Interface](#schema_interface)"
|
|
3197
|
+
},
|
|
3198
|
+
"createdAt": {
|
|
3199
|
+
"type": "string",
|
|
3200
|
+
"format": "date-time",
|
|
3201
|
+
"description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
3202
|
+
},
|
|
3203
|
+
"updatedAt": {
|
|
3204
|
+
"type": "string",
|
|
3205
|
+
"format": "date-time",
|
|
3206
|
+
"description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
3207
|
+
},
|
|
3208
|
+
"name": {
|
|
3209
|
+
"type": "string",
|
|
3210
|
+
"maxLength": 200,
|
|
3211
|
+
"description": "Name of the [Interface](#schema_interface)"
|
|
3212
|
+
},
|
|
3213
|
+
"version": {
|
|
3214
|
+
"type": "string",
|
|
3215
|
+
"maxLength": 200,
|
|
3216
|
+
"description": "Version of the [Interface](#schema_interface)"
|
|
3217
|
+
},
|
|
3218
|
+
"entities": {
|
|
3219
|
+
"type": "object",
|
|
3220
|
+
"additionalProperties": {
|
|
3221
|
+
"type": "object",
|
|
3222
|
+
"properties": {
|
|
3223
|
+
"title": {
|
|
3224
|
+
"type": "string",
|
|
3225
|
+
"maxLength": 64,
|
|
3226
|
+
"description": "Title of the entity"
|
|
3227
|
+
},
|
|
3228
|
+
"description": {
|
|
3229
|
+
"type": "string",
|
|
3230
|
+
"maxLength": 256,
|
|
3231
|
+
"description": "Description of the entity"
|
|
3232
|
+
},
|
|
3233
|
+
"schema": {
|
|
3234
|
+
"type": "object",
|
|
3235
|
+
"additionalProperties": true
|
|
3236
|
+
}
|
|
3237
|
+
},
|
|
3238
|
+
"required": [
|
|
3239
|
+
"schema"
|
|
3240
|
+
],
|
|
3241
|
+
"description": "Entity definition",
|
|
3242
|
+
"additionalProperties": false
|
|
3243
|
+
}
|
|
3244
|
+
},
|
|
3245
|
+
"events": {
|
|
3246
|
+
"type": "object",
|
|
3247
|
+
"additionalProperties": {
|
|
3248
|
+
"type": "object",
|
|
3249
|
+
"properties": {
|
|
3250
|
+
"title": {
|
|
3251
|
+
"type": "string",
|
|
3252
|
+
"maxLength": 64,
|
|
3253
|
+
"description": "Title of the event"
|
|
3254
|
+
},
|
|
3255
|
+
"description": {
|
|
3256
|
+
"type": "string",
|
|
3257
|
+
"maxLength": 256,
|
|
3258
|
+
"description": "Description of the event"
|
|
3259
|
+
},
|
|
3260
|
+
"schema": {
|
|
3261
|
+
"type": "object",
|
|
3262
|
+
"additionalProperties": true
|
|
3263
|
+
},
|
|
3264
|
+
"attributes": {
|
|
3265
|
+
"type": "object",
|
|
3266
|
+
"additionalProperties": {
|
|
3267
|
+
"type": "string",
|
|
3268
|
+
"maxLength": 200
|
|
3269
|
+
},
|
|
3270
|
+
"description": "Optional attributes"
|
|
3271
|
+
}
|
|
3272
|
+
},
|
|
3273
|
+
"required": [
|
|
3274
|
+
"schema"
|
|
3275
|
+
],
|
|
3276
|
+
"description": "Event Definition",
|
|
3277
|
+
"additionalProperties": false
|
|
3278
|
+
}
|
|
3279
|
+
},
|
|
3280
|
+
"actions": {
|
|
3281
|
+
"type": "object",
|
|
3282
|
+
"additionalProperties": {
|
|
3283
|
+
"type": "object",
|
|
3284
|
+
"properties": {
|
|
3285
|
+
"title": {
|
|
3286
|
+
"type": "string",
|
|
3287
|
+
"maxLength": 64,
|
|
3288
|
+
"description": "Title of the action"
|
|
3289
|
+
},
|
|
3290
|
+
"description": {
|
|
3291
|
+
"type": "string",
|
|
3292
|
+
"maxLength": 256,
|
|
3293
|
+
"description": "Description of the action"
|
|
3294
|
+
},
|
|
3295
|
+
"billable": {
|
|
3296
|
+
"type": "boolean"
|
|
3297
|
+
},
|
|
3298
|
+
"cacheable": {
|
|
3299
|
+
"type": "boolean"
|
|
3300
|
+
},
|
|
3301
|
+
"input": {
|
|
3302
|
+
"type": "object",
|
|
3303
|
+
"properties": {
|
|
3304
|
+
"schema": {
|
|
3305
|
+
"type": "object",
|
|
3306
|
+
"additionalProperties": true
|
|
3307
|
+
}
|
|
3308
|
+
},
|
|
3309
|
+
"required": [
|
|
3310
|
+
"schema"
|
|
3311
|
+
],
|
|
3312
|
+
"additionalProperties": false
|
|
3313
|
+
},
|
|
3314
|
+
"output": {
|
|
3315
|
+
"type": "object",
|
|
3316
|
+
"properties": {
|
|
3317
|
+
"schema": {
|
|
3318
|
+
"type": "object",
|
|
3319
|
+
"additionalProperties": true
|
|
3320
|
+
}
|
|
3321
|
+
},
|
|
3322
|
+
"required": [
|
|
3323
|
+
"schema"
|
|
3324
|
+
],
|
|
3325
|
+
"additionalProperties": false
|
|
3326
|
+
},
|
|
3327
|
+
"attributes": {
|
|
3328
|
+
"type": "object",
|
|
3329
|
+
"additionalProperties": {
|
|
3330
|
+
"type": "string",
|
|
3331
|
+
"maxLength": 200
|
|
3332
|
+
},
|
|
3333
|
+
"description": "Optional attributes"
|
|
3334
|
+
}
|
|
3335
|
+
},
|
|
3336
|
+
"required": [
|
|
3337
|
+
"input",
|
|
3338
|
+
"output"
|
|
3339
|
+
],
|
|
3340
|
+
"description": "Action definition",
|
|
3341
|
+
"additionalProperties": false
|
|
3342
|
+
}
|
|
3343
|
+
},
|
|
3344
|
+
"channels": {
|
|
3345
|
+
"type": "object",
|
|
3346
|
+
"additionalProperties": {
|
|
3347
|
+
"type": "object",
|
|
3348
|
+
"properties": {
|
|
3349
|
+
"title": {
|
|
3350
|
+
"type": "string",
|
|
3351
|
+
"maxLength": 64,
|
|
3352
|
+
"description": "Title of the channel"
|
|
3353
|
+
},
|
|
3354
|
+
"description": {
|
|
3355
|
+
"type": "string",
|
|
3356
|
+
"maxLength": 256,
|
|
3357
|
+
"description": "Description of the channel"
|
|
3358
|
+
},
|
|
3359
|
+
"messages": {
|
|
3360
|
+
"type": "object",
|
|
3361
|
+
"additionalProperties": {
|
|
3362
|
+
"type": "object",
|
|
3363
|
+
"properties": {
|
|
3364
|
+
"schema": {
|
|
3365
|
+
"type": "object",
|
|
3366
|
+
"additionalProperties": true
|
|
3367
|
+
}
|
|
3368
|
+
},
|
|
3369
|
+
"required": [
|
|
3370
|
+
"schema"
|
|
3371
|
+
],
|
|
3372
|
+
"description": "Message definition",
|
|
3373
|
+
"additionalProperties": false
|
|
3374
|
+
}
|
|
3375
|
+
}
|
|
3376
|
+
},
|
|
3377
|
+
"required": [
|
|
3378
|
+
"messages"
|
|
3379
|
+
],
|
|
3380
|
+
"additionalProperties": false
|
|
3381
|
+
}
|
|
3382
|
+
},
|
|
3383
|
+
"nameTemplate": {
|
|
3384
|
+
"type": "object",
|
|
3385
|
+
"properties": {
|
|
3386
|
+
"script": {
|
|
3387
|
+
"type": "string",
|
|
3388
|
+
"maxLength": 2000
|
|
3389
|
+
},
|
|
3390
|
+
"language": {
|
|
3391
|
+
"type": "string",
|
|
3392
|
+
"maxLength": 200
|
|
3393
|
+
}
|
|
3394
|
+
},
|
|
3395
|
+
"required": [
|
|
3396
|
+
"script",
|
|
3397
|
+
"language"
|
|
3398
|
+
],
|
|
3399
|
+
"description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
|
|
3400
|
+
"additionalProperties": false
|
|
3401
|
+
},
|
|
3402
|
+
"title": {
|
|
3403
|
+
"type": "string",
|
|
3404
|
+
"minLength": 1,
|
|
3405
|
+
"maxLength": 64,
|
|
3406
|
+
"description": "Title of the interface. This is the name that will be displayed in the UI"
|
|
3407
|
+
},
|
|
3408
|
+
"description": {
|
|
3409
|
+
"type": "string",
|
|
3410
|
+
"maxLength": 256,
|
|
3411
|
+
"description": "Description of the interface. This is the description that will be displayed in the UI"
|
|
3412
|
+
},
|
|
3413
|
+
"iconUrl": {
|
|
3414
|
+
"type": "string",
|
|
3415
|
+
"description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
|
|
3416
|
+
},
|
|
3417
|
+
"readmeUrl": {
|
|
3418
|
+
"type": "string",
|
|
3419
|
+
"description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
|
|
3420
|
+
},
|
|
3421
|
+
"public": {
|
|
3422
|
+
"type": "boolean",
|
|
3423
|
+
"description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
|
|
3424
|
+
}
|
|
3425
|
+
},
|
|
3426
|
+
"required": [
|
|
3427
|
+
"id",
|
|
3428
|
+
"createdAt",
|
|
3429
|
+
"updatedAt",
|
|
3430
|
+
"name",
|
|
3431
|
+
"version",
|
|
3432
|
+
"entities",
|
|
3433
|
+
"events",
|
|
3434
|
+
"actions",
|
|
3435
|
+
"channels",
|
|
3436
|
+
"title",
|
|
3437
|
+
"description",
|
|
3438
|
+
"iconUrl",
|
|
3439
|
+
"readmeUrl",
|
|
3440
|
+
"public"
|
|
3441
|
+
],
|
|
3442
|
+
"additionalProperties": false
|
|
3443
|
+
}
|
|
3444
|
+
},
|
|
3445
|
+
"required": [
|
|
3446
|
+
"interface"
|
|
3447
|
+
],
|
|
3448
|
+
"title": "getPublicInterfaceByIdResponse",
|
|
3449
|
+
"additionalProperties": false
|
|
3450
|
+
}
|
|
3451
|
+
}
|
|
3452
|
+
},
|
|
3453
|
+
"getPublicInterface": {
|
|
3454
|
+
"name": "getPublicInterface",
|
|
3455
|
+
"description": "Get public interface by name and version",
|
|
3456
|
+
"method": "get",
|
|
3457
|
+
"section": "hub",
|
|
3458
|
+
"path": "/v1/admin/hub/interfaces/{name}/{version}",
|
|
3459
|
+
"disableDefaultParameters": {
|
|
3460
|
+
"x-workspace-id": true
|
|
3461
|
+
},
|
|
3462
|
+
"parameters": {
|
|
3463
|
+
"name": {
|
|
3464
|
+
"type": "string",
|
|
3465
|
+
"description": "Interface Name",
|
|
3466
|
+
"in": "path"
|
|
3467
|
+
},
|
|
3468
|
+
"version": {
|
|
3469
|
+
"type": "string",
|
|
3470
|
+
"description": "Interface version.",
|
|
3471
|
+
"in": "path"
|
|
3472
|
+
}
|
|
3473
|
+
},
|
|
3474
|
+
"response": {
|
|
3475
|
+
"description": "Success",
|
|
3476
|
+
"schema": {
|
|
3477
|
+
"type": "object",
|
|
3478
|
+
"properties": {
|
|
3479
|
+
"interface": {
|
|
3480
|
+
"type": "object",
|
|
3481
|
+
"properties": {
|
|
3482
|
+
"id": {
|
|
3483
|
+
"type": "string",
|
|
3484
|
+
"minLength": 28,
|
|
3485
|
+
"maxLength": 36,
|
|
3486
|
+
"description": "ID of the [Interface](#schema_interface)"
|
|
3487
|
+
},
|
|
3488
|
+
"createdAt": {
|
|
3489
|
+
"type": "string",
|
|
3490
|
+
"format": "date-time",
|
|
3491
|
+
"description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
3492
|
+
},
|
|
3493
|
+
"updatedAt": {
|
|
3494
|
+
"type": "string",
|
|
3495
|
+
"format": "date-time",
|
|
3496
|
+
"description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
3497
|
+
},
|
|
3498
|
+
"name": {
|
|
3499
|
+
"type": "string",
|
|
3500
|
+
"maxLength": 200,
|
|
3501
|
+
"description": "Name of the [Interface](#schema_interface)"
|
|
3502
|
+
},
|
|
3503
|
+
"version": {
|
|
3504
|
+
"type": "string",
|
|
3505
|
+
"maxLength": 200,
|
|
3506
|
+
"description": "Version of the [Interface](#schema_interface)"
|
|
3507
|
+
},
|
|
3508
|
+
"entities": {
|
|
3509
|
+
"type": "object",
|
|
3510
|
+
"additionalProperties": {
|
|
3511
|
+
"type": "object",
|
|
3512
|
+
"properties": {
|
|
3513
|
+
"title": {
|
|
3514
|
+
"type": "string",
|
|
3515
|
+
"maxLength": 64,
|
|
3516
|
+
"description": "Title of the entity"
|
|
3517
|
+
},
|
|
3518
|
+
"description": {
|
|
3519
|
+
"type": "string",
|
|
3520
|
+
"maxLength": 256,
|
|
3521
|
+
"description": "Description of the entity"
|
|
3522
|
+
},
|
|
3523
|
+
"schema": {
|
|
3524
|
+
"type": "object",
|
|
3525
|
+
"additionalProperties": true
|
|
3526
|
+
}
|
|
3527
|
+
},
|
|
3528
|
+
"required": [
|
|
3529
|
+
"schema"
|
|
3530
|
+
],
|
|
3531
|
+
"description": "Entity definition",
|
|
3532
|
+
"additionalProperties": false
|
|
3533
|
+
}
|
|
3534
|
+
},
|
|
3535
|
+
"events": {
|
|
3536
|
+
"type": "object",
|
|
3537
|
+
"additionalProperties": {
|
|
3538
|
+
"type": "object",
|
|
3539
|
+
"properties": {
|
|
3540
|
+
"title": {
|
|
3541
|
+
"type": "string",
|
|
3542
|
+
"maxLength": 64,
|
|
3543
|
+
"description": "Title of the event"
|
|
3544
|
+
},
|
|
3545
|
+
"description": {
|
|
3546
|
+
"type": "string",
|
|
3547
|
+
"maxLength": 256,
|
|
3548
|
+
"description": "Description of the event"
|
|
3549
|
+
},
|
|
3550
|
+
"schema": {
|
|
3551
|
+
"type": "object",
|
|
3552
|
+
"additionalProperties": true
|
|
3553
|
+
},
|
|
3554
|
+
"attributes": {
|
|
3555
|
+
"type": "object",
|
|
3556
|
+
"additionalProperties": {
|
|
3557
|
+
"type": "string",
|
|
3558
|
+
"maxLength": 200
|
|
3559
|
+
},
|
|
3560
|
+
"description": "Optional attributes"
|
|
3561
|
+
}
|
|
3562
|
+
},
|
|
3563
|
+
"required": [
|
|
3564
|
+
"schema"
|
|
3565
|
+
],
|
|
3566
|
+
"description": "Event Definition",
|
|
3567
|
+
"additionalProperties": false
|
|
3568
|
+
}
|
|
3569
|
+
},
|
|
3570
|
+
"actions": {
|
|
3571
|
+
"type": "object",
|
|
3572
|
+
"additionalProperties": {
|
|
3573
|
+
"type": "object",
|
|
3574
|
+
"properties": {
|
|
3575
|
+
"title": {
|
|
3576
|
+
"type": "string",
|
|
3577
|
+
"maxLength": 64,
|
|
3578
|
+
"description": "Title of the action"
|
|
3579
|
+
},
|
|
3580
|
+
"description": {
|
|
3581
|
+
"type": "string",
|
|
3582
|
+
"maxLength": 256,
|
|
3583
|
+
"description": "Description of the action"
|
|
3584
|
+
},
|
|
3585
|
+
"billable": {
|
|
3586
|
+
"type": "boolean"
|
|
3587
|
+
},
|
|
3588
|
+
"cacheable": {
|
|
3589
|
+
"type": "boolean"
|
|
3590
|
+
},
|
|
3591
|
+
"input": {
|
|
3592
|
+
"type": "object",
|
|
3593
|
+
"properties": {
|
|
3594
|
+
"schema": {
|
|
3595
|
+
"type": "object",
|
|
3596
|
+
"additionalProperties": true
|
|
3597
|
+
}
|
|
3598
|
+
},
|
|
3599
|
+
"required": [
|
|
3600
|
+
"schema"
|
|
3601
|
+
],
|
|
3602
|
+
"additionalProperties": false
|
|
3603
|
+
},
|
|
3604
|
+
"output": {
|
|
3605
|
+
"type": "object",
|
|
3606
|
+
"properties": {
|
|
3607
|
+
"schema": {
|
|
3608
|
+
"type": "object",
|
|
3609
|
+
"additionalProperties": true
|
|
3610
|
+
}
|
|
3611
|
+
},
|
|
3612
|
+
"required": [
|
|
3613
|
+
"schema"
|
|
3614
|
+
],
|
|
3615
|
+
"additionalProperties": false
|
|
3616
|
+
},
|
|
3617
|
+
"attributes": {
|
|
3618
|
+
"type": "object",
|
|
3619
|
+
"additionalProperties": {
|
|
3620
|
+
"type": "string",
|
|
3621
|
+
"maxLength": 200
|
|
3622
|
+
},
|
|
3623
|
+
"description": "Optional attributes"
|
|
3624
|
+
}
|
|
3625
|
+
},
|
|
3626
|
+
"required": [
|
|
3627
|
+
"input",
|
|
3628
|
+
"output"
|
|
3629
|
+
],
|
|
3630
|
+
"description": "Action definition",
|
|
3631
|
+
"additionalProperties": false
|
|
3632
|
+
}
|
|
3633
|
+
},
|
|
3634
|
+
"channels": {
|
|
3635
|
+
"type": "object",
|
|
3636
|
+
"additionalProperties": {
|
|
3637
|
+
"type": "object",
|
|
3638
|
+
"properties": {
|
|
3639
|
+
"title": {
|
|
3640
|
+
"type": "string",
|
|
3641
|
+
"maxLength": 64,
|
|
3642
|
+
"description": "Title of the channel"
|
|
3643
|
+
},
|
|
3644
|
+
"description": {
|
|
3645
|
+
"type": "string",
|
|
3646
|
+
"maxLength": 256,
|
|
3647
|
+
"description": "Description of the channel"
|
|
3648
|
+
},
|
|
3649
|
+
"messages": {
|
|
3650
|
+
"type": "object",
|
|
3651
|
+
"additionalProperties": {
|
|
3652
|
+
"type": "object",
|
|
3653
|
+
"properties": {
|
|
3654
|
+
"schema": {
|
|
3655
|
+
"type": "object",
|
|
3656
|
+
"additionalProperties": true
|
|
3657
|
+
}
|
|
3658
|
+
},
|
|
3659
|
+
"required": [
|
|
3660
|
+
"schema"
|
|
3661
|
+
],
|
|
3662
|
+
"description": "Message definition",
|
|
3663
|
+
"additionalProperties": false
|
|
3664
|
+
}
|
|
3665
|
+
}
|
|
3666
|
+
},
|
|
3667
|
+
"required": [
|
|
3668
|
+
"messages"
|
|
3669
|
+
],
|
|
3670
|
+
"additionalProperties": false
|
|
3671
|
+
}
|
|
3672
|
+
},
|
|
3673
|
+
"nameTemplate": {
|
|
3674
|
+
"type": "object",
|
|
3675
|
+
"properties": {
|
|
3676
|
+
"script": {
|
|
3677
|
+
"type": "string",
|
|
3678
|
+
"maxLength": 2000
|
|
3679
|
+
},
|
|
3680
|
+
"language": {
|
|
3681
|
+
"type": "string",
|
|
3682
|
+
"maxLength": 200
|
|
3683
|
+
}
|
|
3684
|
+
},
|
|
3685
|
+
"required": [
|
|
3686
|
+
"script",
|
|
3687
|
+
"language"
|
|
3688
|
+
],
|
|
3689
|
+
"description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
|
|
3690
|
+
"additionalProperties": false
|
|
3691
|
+
},
|
|
3692
|
+
"title": {
|
|
3693
|
+
"type": "string",
|
|
3694
|
+
"minLength": 1,
|
|
3695
|
+
"maxLength": 64,
|
|
3696
|
+
"description": "Title of the interface. This is the name that will be displayed in the UI"
|
|
3697
|
+
},
|
|
3698
|
+
"description": {
|
|
3699
|
+
"type": "string",
|
|
3700
|
+
"maxLength": 256,
|
|
3701
|
+
"description": "Description of the interface. This is the description that will be displayed in the UI"
|
|
3702
|
+
},
|
|
3703
|
+
"iconUrl": {
|
|
3704
|
+
"type": "string",
|
|
3705
|
+
"description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
|
|
3706
|
+
},
|
|
3707
|
+
"readmeUrl": {
|
|
3708
|
+
"type": "string",
|
|
3709
|
+
"description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
|
|
3710
|
+
},
|
|
3711
|
+
"public": {
|
|
3712
|
+
"type": "boolean",
|
|
3713
|
+
"description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
|
|
3714
|
+
}
|
|
3715
|
+
},
|
|
3716
|
+
"required": [
|
|
3717
|
+
"id",
|
|
3718
|
+
"createdAt",
|
|
3719
|
+
"updatedAt",
|
|
3720
|
+
"name",
|
|
3721
|
+
"version",
|
|
3722
|
+
"entities",
|
|
3723
|
+
"events",
|
|
3724
|
+
"actions",
|
|
3725
|
+
"channels",
|
|
3726
|
+
"title",
|
|
3727
|
+
"description",
|
|
3728
|
+
"iconUrl",
|
|
3729
|
+
"readmeUrl",
|
|
3730
|
+
"public"
|
|
3731
|
+
],
|
|
3732
|
+
"additionalProperties": false
|
|
3733
|
+
}
|
|
3734
|
+
},
|
|
3735
|
+
"required": [
|
|
3736
|
+
"interface"
|
|
3737
|
+
],
|
|
3738
|
+
"title": "getPublicInterfaceResponse",
|
|
3739
|
+
"additionalProperties": false
|
|
3740
|
+
}
|
|
3741
|
+
}
|
|
3742
|
+
},
|
|
3048
3743
|
"createBot": {
|
|
3049
3744
|
"name": "createBot",
|
|
3050
3745
|
"description": "Create bot",
|
|
@@ -10549,6 +11244,11 @@ export const state = {
|
|
|
10549
11244
|
"in": "query",
|
|
10550
11245
|
"type": "string",
|
|
10551
11246
|
"description": "Filter all versions of an interface by name"
|
|
11247
|
+
},
|
|
11248
|
+
"version": {
|
|
11249
|
+
"in": "query",
|
|
11250
|
+
"type": "string",
|
|
11251
|
+
"description": "Filter an interface by name and version"
|
|
10552
11252
|
}
|
|
10553
11253
|
},
|
|
10554
11254
|
"response": {
|
|
@@ -12094,7 +12794,7 @@ export const state = {
|
|
|
12094
12794
|
"title": "Botpress API",
|
|
12095
12795
|
"description": "API for Botpress Cloud",
|
|
12096
12796
|
"server": "https://api.botpress.cloud",
|
|
12097
|
-
"version": "1.
|
|
12797
|
+
"version": "1.13.0",
|
|
12098
12798
|
"prefix": "v1"
|
|
12099
12799
|
},
|
|
12100
12800
|
"errors": [
|
|
@@ -12268,6 +12968,9 @@ export const state = {
|
|
|
12268
12968
|
"getPublicPluginByIdResponse": true,
|
|
12269
12969
|
"getPublicPluginResponse": true,
|
|
12270
12970
|
"getPublicPluginCodeResponse": true,
|
|
12971
|
+
"listPublicInterfacesResponse": true,
|
|
12972
|
+
"getPublicInterfaceByIdResponse": true,
|
|
12973
|
+
"getPublicInterfaceResponse": true,
|
|
12271
12974
|
"createBotResponse": true,
|
|
12272
12975
|
"updateBotResponse": true,
|
|
12273
12976
|
"transferBotResponse": true,
|
|
@@ -15734,7 +16437,10 @@ export const state = {
|
|
|
15734
16437
|
"listPublicPlugins",
|
|
15735
16438
|
"getPublicPluginById",
|
|
15736
16439
|
"getPublicPlugin",
|
|
15737
|
-
"getPublicPluginCode"
|
|
16440
|
+
"getPublicPluginCode",
|
|
16441
|
+
"listPublicInterfaces",
|
|
16442
|
+
"getPublicInterfaceById",
|
|
16443
|
+
"getPublicInterface"
|
|
15738
16444
|
]
|
|
15739
16445
|
},
|
|
15740
16446
|
{
|