@botpress/api 1.47.0 → 1.48.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /* prettier-ignore */
4
4
  import * as opapi from '@bpinternal/opapi'
5
- export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag' | 'bot' | 'integration' | 'interface' | 'plugin' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>
5
+ export type State = opapi.State<'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag'>
6
6
  export const state = {
7
7
  "operations": {
8
8
  "createConversation": {
@@ -2640,10 +2640,10 @@ export const state = {
2640
2640
  }
2641
2641
  },
2642
2642
  "metadata": {
2643
- "title": "Botpress API",
2644
- "description": "API for Botpress Cloud",
2643
+ "title": "Botpress Runtime API",
2644
+ "description": "API for Botpress Runtime",
2645
2645
  "server": "https://api.botpress.cloud",
2646
- "version": "1.47.0",
2646
+ "version": "1.48.1",
2647
2647
  "prefix": "v1"
2648
2648
  },
2649
2649
  "errors": [
@@ -2722,6 +2722,11 @@ export const state = {
2722
2722
  "type": "ResourceLockedConflict",
2723
2723
  "description": "The resource is current locked and cannot be operated on until the lock is released."
2724
2724
  },
2725
+ {
2726
+ "status": 410,
2727
+ "type": "ResourceGone",
2728
+ "description": "The requested resource is no longer available."
2729
+ },
2725
2730
  {
2726
2731
  "status": 400,
2727
2732
  "type": "ReferenceNotFound",
@@ -2843,2471 +2848,16 @@ export const state = {
2843
2848
  "trackAnalyticsResponse": true
2844
2849
  },
2845
2850
  "schemas": {
2846
- "Bot": true,
2847
- "Integration": true,
2848
- "Interface": true,
2849
- "Plugin": true,
2850
- "Workspace": true,
2851
- "WorkspaceMember": true,
2852
- "Account": true,
2853
- "Usage": true,
2854
- "Issue": true,
2855
- "IssueEvent": true,
2856
- "Activity": true,
2857
- "Version": true,
2858
2851
  "User": true,
2859
2852
  "Conversation": true,
2860
2853
  "Event": true,
2861
2854
  "Message": true,
2862
- "State": true,
2863
- "Task": true,
2864
- "Workflow": true,
2865
- "Table": true,
2866
- "Column": true,
2867
- "Row": true,
2868
- "File": true
2869
- }
2870
- },
2871
- "schemas": {
2872
- "Bot": {
2873
- "section": "bot",
2874
- "schema": {
2875
- "type": "object",
2876
- "properties": {
2877
- "id": {
2878
- "type": "string",
2879
- "minLength": 28,
2880
- "maxLength": 36,
2881
- "description": "Id of the [Bot](#schema_bot)"
2882
- },
2883
- "createdAt": {
2884
- "type": "string",
2885
- "format": "date-time",
2886
- "description": "Creation date of the [Bot](#schema_bot) in ISO 8601 format"
2887
- },
2888
- "updatedAt": {
2889
- "type": "string",
2890
- "format": "date-time",
2891
- "description": "Updating date of the [Bot](#schema_bot) in ISO 8601 format"
2892
- },
2893
- "signingSecret": {
2894
- "type": "string",
2895
- "maxLength": 2000,
2896
- "description": "Signing secret of the [Bot](#schema_bot)"
2897
- },
2898
- "integrations": {
2899
- "type": "object",
2900
- "additionalProperties": {
2901
- "type": "object",
2902
- "properties": {
2903
- "enabled": {
2904
- "type": "boolean"
2905
- },
2906
- "name": {
2907
- "type": "string",
2908
- "maxLength": 200,
2909
- "description": "Name of the [Integration](#schema_integration)"
2910
- },
2911
- "version": {
2912
- "type": "string",
2913
- "maxLength": 200,
2914
- "description": "Version of the [Integration](#schema_integration)"
2915
- },
2916
- "webhookUrl": {
2917
- "type": "string",
2918
- "maxLength": 2000
2919
- },
2920
- "webhookId": {
2921
- "type": "string",
2922
- "maxLength": 200
2923
- },
2924
- "identifier": {
2925
- "type": "string",
2926
- "maxLength": 2000
2927
- },
2928
- "configurationType": {
2929
- "type": "string",
2930
- "maxLength": 200,
2931
- "nullable": true
2932
- },
2933
- "configuration": {
2934
- "type": "object",
2935
- "additionalProperties": true
2936
- },
2937
- "status": {
2938
- "type": "string",
2939
- "enum": [
2940
- "registration_pending",
2941
- "registered",
2942
- "registration_failed",
2943
- "unregistration_pending",
2944
- "unregistered",
2945
- "unregistration_failed"
2946
- ]
2947
- },
2948
- "statusReason": {
2949
- "type": "string",
2950
- "maxLength": 2000,
2951
- "nullable": true
2952
- },
2953
- "disabledChannels": {
2954
- "type": "array",
2955
- "items": {
2956
- "type": "string",
2957
- "description": "Channel name"
2958
- },
2959
- "description": "Disabled channels for this integration"
2960
- },
2961
- "id": {
2962
- "type": "string",
2963
- "minLength": 28,
2964
- "maxLength": 36,
2965
- "description": "ID of the [Integration](#schema_integration)"
2966
- },
2967
- "createdAt": {
2968
- "type": "string",
2969
- "format": "date-time",
2970
- "description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
2971
- },
2972
- "updatedAt": {
2973
- "type": "string",
2974
- "format": "date-time",
2975
- "description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
2976
- },
2977
- "title": {
2978
- "type": "string",
2979
- "minLength": 1,
2980
- "maxLength": 64,
2981
- "description": "Title of the integration. This is the name that will be displayed in the UI"
2982
- },
2983
- "description": {
2984
- "type": "string",
2985
- "maxLength": 256,
2986
- "description": "Description of the integration. This is the description that will be displayed in the UI"
2987
- },
2988
- "iconUrl": {
2989
- "type": "string",
2990
- "description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
2991
- },
2992
- "public": {
2993
- "type": "boolean",
2994
- "description": "[DEPRECATED] Indicates whether the integration is public. Please use the \"visibility\" parameter instead.",
2995
- "deprecated": true
2996
- },
2997
- "visibility": {
2998
- "type": "string",
2999
- "enum": [
3000
- "public",
3001
- "private",
3002
- "unlisted"
3003
- ],
3004
- "description": "The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them."
3005
- },
3006
- "verificationStatus": {
3007
- "type": "string",
3008
- "enum": [
3009
- "unapproved",
3010
- "pending",
3011
- "approved",
3012
- "rejected"
3013
- ],
3014
- "description": "Status of the integration version verification"
3015
- }
3016
- },
3017
- "required": [
3018
- "enabled",
3019
- "name",
3020
- "version",
3021
- "webhookUrl",
3022
- "webhookId",
3023
- "configurationType",
3024
- "configuration",
3025
- "status",
3026
- "statusReason",
3027
- "disabledChannels",
3028
- "id",
3029
- "createdAt",
3030
- "updatedAt",
3031
- "title",
3032
- "description",
3033
- "iconUrl",
3034
- "public",
3035
- "visibility",
3036
- "verificationStatus"
3037
- ],
3038
- "additionalProperties": false
3039
- },
3040
- "description": "A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids."
3041
- },
3042
- "plugins": {
3043
- "type": "object",
3044
- "additionalProperties": {
3045
- "type": "object",
3046
- "properties": {
3047
- "enabled": {
3048
- "type": "boolean"
3049
- },
3050
- "name": {
3051
- "type": "string",
3052
- "maxLength": 200,
3053
- "description": "Name of the [Plugin](#schema_plugin)"
3054
- },
3055
- "version": {
3056
- "type": "string",
3057
- "maxLength": 200,
3058
- "description": "Version of the [Plugin](#schema_plugin)"
3059
- },
3060
- "configuration": {
3061
- "type": "object",
3062
- "additionalProperties": true
3063
- },
3064
- "interfaces": {
3065
- "type": "object",
3066
- "additionalProperties": {
3067
- "type": "object",
3068
- "properties": {
3069
- "integrationId": {
3070
- "type": "string",
3071
- "minLength": 28,
3072
- "maxLength": 36
3073
- },
3074
- "integrationAlias": {
3075
- "type": "string",
3076
- "maxLength": 200
3077
- },
3078
- "integrationInterfaceAlias": {
3079
- "type": "string",
3080
- "maxLength": 200
3081
- },
3082
- "interfaceId": {
3083
- "type": "string",
3084
- "minLength": 28,
3085
- "maxLength": 36
3086
- }
3087
- },
3088
- "required": [
3089
- "integrationId",
3090
- "integrationAlias",
3091
- "interfaceId"
3092
- ],
3093
- "additionalProperties": false
3094
- },
3095
- "description": "A mapping of plugin interface aliases to their backing integrations"
3096
- },
3097
- "integrations": {
3098
- "type": "object",
3099
- "additionalProperties": {
3100
- "type": "object",
3101
- "properties": {
3102
- "integrationId": {
3103
- "type": "string",
3104
- "minLength": 28,
3105
- "maxLength": 36
3106
- },
3107
- "integrationAlias": {
3108
- "type": "string",
3109
- "maxLength": 200
3110
- }
3111
- },
3112
- "required": [
3113
- "integrationId",
3114
- "integrationAlias"
3115
- ],
3116
- "additionalProperties": false
3117
- },
3118
- "description": "A mapping of plugin integration aliases to their backing integrations"
3119
- },
3120
- "id": {
3121
- "type": "string",
3122
- "minLength": 28,
3123
- "maxLength": 36,
3124
- "description": "ID of the [Plugin](#schema_plugin)"
3125
- },
3126
- "createdAt": {
3127
- "type": "string",
3128
- "format": "date-time",
3129
- "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
3130
- },
3131
- "updatedAt": {
3132
- "type": "string",
3133
- "format": "date-time",
3134
- "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
3135
- },
3136
- "title": {
3137
- "type": "string",
3138
- "minLength": 1,
3139
- "maxLength": 64,
3140
- "description": "Title of the plugin. This is the name that will be displayed in the UI"
3141
- },
3142
- "description": {
3143
- "type": "string",
3144
- "maxLength": 256,
3145
- "description": "Description of the plugin. This is the description that will be displayed in the UI"
3146
- },
3147
- "iconUrl": {
3148
- "type": "string",
3149
- "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
3150
- },
3151
- "readmeUrl": {
3152
- "type": "string",
3153
- "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
3154
- },
3155
- "public": {
3156
- "type": "boolean",
3157
- "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
3158
- }
3159
- },
3160
- "required": [
3161
- "enabled",
3162
- "name",
3163
- "version",
3164
- "configuration",
3165
- "id",
3166
- "createdAt",
3167
- "updatedAt",
3168
- "title",
3169
- "description",
3170
- "iconUrl",
3171
- "readmeUrl",
3172
- "public"
3173
- ],
3174
- "additionalProperties": false
3175
- },
3176
- "description": "A mapping of plugin aliases to their configuration"
3177
- },
3178
- "maxExecutionTime": {
3179
- "type": "number",
3180
- "description": "Maximum execution time of the bot (in seconds)."
3181
- },
3182
- "user": {
3183
- "type": "object",
3184
- "properties": {
3185
- "tags": {
3186
- "type": "object",
3187
- "additionalProperties": {
3188
- "type": "object",
3189
- "properties": {
3190
- "title": {
3191
- "type": "string",
3192
- "maxLength": 64,
3193
- "description": "Title of the tag"
3194
- },
3195
- "description": {
3196
- "type": "string",
3197
- "maxLength": 256,
3198
- "description": "Description of the tag"
3199
- }
3200
- },
3201
- "description": "Definition of a tag that can be provided on the object",
3202
- "additionalProperties": false
3203
- }
3204
- }
3205
- },
3206
- "required": [
3207
- "tags"
3208
- ],
3209
- "description": "User object configuration",
3210
- "additionalProperties": false
3211
- },
3212
- "conversation": {
3213
- "type": "object",
3214
- "properties": {
3215
- "tags": {
3216
- "type": "object",
3217
- "additionalProperties": {
3218
- "type": "object",
3219
- "properties": {
3220
- "title": {
3221
- "type": "string",
3222
- "maxLength": 64,
3223
- "description": "Title of the tag"
3224
- },
3225
- "description": {
3226
- "type": "string",
3227
- "maxLength": 256,
3228
- "description": "Description of the tag"
3229
- }
3230
- },
3231
- "description": "Definition of a tag that can be provided on the object",
3232
- "additionalProperties": false
3233
- }
3234
- }
3235
- },
3236
- "required": [
3237
- "tags"
3238
- ],
3239
- "description": "Conversation object configuration",
3240
- "additionalProperties": false
3241
- },
3242
- "message": {
3243
- "type": "object",
3244
- "properties": {
3245
- "tags": {
3246
- "type": "object",
3247
- "additionalProperties": {
3248
- "type": "object",
3249
- "properties": {
3250
- "title": {
3251
- "type": "string",
3252
- "maxLength": 64,
3253
- "description": "Title of the tag"
3254
- },
3255
- "description": {
3256
- "type": "string",
3257
- "maxLength": 256,
3258
- "description": "Description of the tag"
3259
- }
3260
- },
3261
- "description": "Definition of a tag that can be provided on the object",
3262
- "additionalProperties": false
3263
- }
3264
- }
3265
- },
3266
- "required": [
3267
- "tags"
3268
- ],
3269
- "description": "Message object configuration",
3270
- "additionalProperties": false
3271
- },
3272
- "states": {
3273
- "type": "object",
3274
- "additionalProperties": {
3275
- "type": "object",
3276
- "properties": {
3277
- "type": {
3278
- "type": "string",
3279
- "enum": [
3280
- "conversation",
3281
- "user",
3282
- "bot",
3283
- "task"
3284
- ],
3285
- "description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
3286
- },
3287
- "schema": {
3288
- "type": "object",
3289
- "additionalProperties": true,
3290
- "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."
3291
- },
3292
- "expiry": {
3293
- "type": "number",
3294
- "minimum": 1,
3295
- "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."
3296
- }
3297
- },
3298
- "required": [
3299
- "type",
3300
- "schema"
3301
- ],
3302
- "additionalProperties": false
3303
- },
3304
- "description": "A mapping of states to their definition"
3305
- },
3306
- "configuration": {
3307
- "type": "object",
3308
- "properties": {
3309
- "data": {
3310
- "type": "object",
3311
- "additionalProperties": true,
3312
- "description": "Configuration data"
3313
- },
3314
- "schema": {
3315
- "type": "object",
3316
- "additionalProperties": true,
3317
- "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
3318
- }
3319
- },
3320
- "required": [
3321
- "data",
3322
- "schema"
3323
- ],
3324
- "description": "Configuration of the bot",
3325
- "additionalProperties": false
3326
- },
3327
- "events": {
3328
- "type": "object",
3329
- "additionalProperties": {
3330
- "type": "object",
3331
- "properties": {
3332
- "title": {
3333
- "type": "string",
3334
- "maxLength": 64,
3335
- "description": "Title of the event"
3336
- },
3337
- "description": {
3338
- "type": "string",
3339
- "maxLength": 256,
3340
- "description": "Description of the event"
3341
- },
3342
- "schema": {
3343
- "type": "object",
3344
- "additionalProperties": true
3345
- },
3346
- "attributes": {
3347
- "type": "object",
3348
- "additionalProperties": {
3349
- "type": "string",
3350
- "maxLength": 200
3351
- },
3352
- "description": "Optional attributes"
3353
- }
3354
- },
3355
- "required": [
3356
- "schema"
3357
- ],
3358
- "description": "Event Definition",
3359
- "additionalProperties": false
3360
- },
3361
- "description": "Events definition"
3362
- },
3363
- "recurringEvents": {
3364
- "type": "object",
3365
- "additionalProperties": {
3366
- "type": "object",
3367
- "properties": {
3368
- "schedule": {
3369
- "type": "object",
3370
- "properties": {
3371
- "cron": {
3372
- "type": "string",
3373
- "maxLength": 200
3374
- }
3375
- },
3376
- "required": [
3377
- "cron"
3378
- ],
3379
- "additionalProperties": false
3380
- },
3381
- "type": {
3382
- "type": "string",
3383
- "maxLength": 200
3384
- },
3385
- "payload": {
3386
- "type": "object",
3387
- "additionalProperties": true
3388
- },
3389
- "failedAttempts": {
3390
- "type": "number",
3391
- "description": "The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully."
3392
- },
3393
- "lastFailureReason": {
3394
- "type": "string",
3395
- "maxLength": 2000,
3396
- "description": "The reason why the recurring event failed to run in the last attempt.",
3397
- "nullable": true
3398
- }
3399
- },
3400
- "required": [
3401
- "schedule",
3402
- "type",
3403
- "payload",
3404
- "failedAttempts",
3405
- "lastFailureReason"
3406
- ],
3407
- "additionalProperties": false
3408
- },
3409
- "description": "Recurring events"
3410
- },
3411
- "subscriptions": {
3412
- "type": "object",
3413
- "properties": {
3414
- "events": {
3415
- "type": "object",
3416
- "additionalProperties": {
3417
- "type": "object",
3418
- "additionalProperties": false
3419
- },
3420
- "nullable": true,
3421
- "description": "Events that the bot is currently subscribed on (ex: \"slack:reactionAdded\"). If null, the bot is subscribed to all events."
3422
- }
3423
- },
3424
- "required": [
3425
- "events"
3426
- ],
3427
- "description": "Subscriptions of the bot",
3428
- "additionalProperties": false
3429
- },
3430
- "actions": {
3431
- "type": "object",
3432
- "additionalProperties": {
3433
- "type": "object",
3434
- "properties": {
3435
- "title": {
3436
- "type": "string",
3437
- "maxLength": 64,
3438
- "description": "Title of the action"
3439
- },
3440
- "description": {
3441
- "type": "string",
3442
- "maxLength": 256,
3443
- "description": "Description of the action"
3444
- },
3445
- "billable": {
3446
- "type": "boolean"
3447
- },
3448
- "cacheable": {
3449
- "type": "boolean"
3450
- },
3451
- "input": {
3452
- "type": "object",
3453
- "properties": {
3454
- "schema": {
3455
- "type": "object",
3456
- "additionalProperties": true
3457
- }
3458
- },
3459
- "required": [
3460
- "schema"
3461
- ],
3462
- "additionalProperties": false
3463
- },
3464
- "output": {
3465
- "type": "object",
3466
- "properties": {
3467
- "schema": {
3468
- "type": "object",
3469
- "additionalProperties": true
3470
- }
3471
- },
3472
- "required": [
3473
- "schema"
3474
- ],
3475
- "additionalProperties": false
3476
- },
3477
- "attributes": {
3478
- "type": "object",
3479
- "additionalProperties": {
3480
- "type": "string",
3481
- "maxLength": 200
3482
- },
3483
- "description": "Optional attributes"
3484
- }
3485
- },
3486
- "required": [
3487
- "input",
3488
- "output"
3489
- ],
3490
- "description": "Action definition",
3491
- "additionalProperties": false
3492
- },
3493
- "description": "Actions definition"
3494
- },
3495
- "tags": {
3496
- "type": "object",
3497
- "additionalProperties": {
3498
- "type": "string"
3499
- },
3500
- "description": "Tags of [Bot](#schema_bot)"
3501
- },
3502
- "name": {
3503
- "type": "string",
3504
- "description": "Name of the [Bot](#schema_bot)"
3505
- },
3506
- "deployedAt": {
3507
- "type": "string",
3508
- "format": "date-time",
3509
- "description": "Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format"
3510
- },
3511
- "dev": {
3512
- "type": "boolean",
3513
- "description": "Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations"
3514
- },
3515
- "createdBy": {
3516
- "type": "string",
3517
- "description": "Id of the user that created the bot"
3518
- },
3519
- "alwaysAlive": {
3520
- "type": "boolean",
3521
- "description": "Indicates if the [Bot](#schema_bot) should be in always alive mode"
3522
- },
3523
- "status": {
3524
- "type": "string",
3525
- "enum": [
3526
- "active",
3527
- "deploying"
3528
- ],
3529
- "description": "Status of the bot"
3530
- },
3531
- "medias": {
3532
- "type": "array",
3533
- "items": {
3534
- "type": "object",
3535
- "properties": {
3536
- "url": {
3537
- "type": "string",
3538
- "description": "URL of the media file"
3539
- },
3540
- "name": {
3541
- "type": "string",
3542
- "description": "Name of the media file"
3543
- }
3544
- },
3545
- "required": [
3546
- "url",
3547
- "name"
3548
- ]
3549
- },
3550
- "description": "Media files associated with the [Bot](#schema_bot)"
3551
- }
3552
- },
3553
- "required": [
3554
- "id",
3555
- "createdAt",
3556
- "updatedAt",
3557
- "signingSecret",
3558
- "integrations",
3559
- "plugins",
3560
- "user",
3561
- "conversation",
3562
- "message",
3563
- "states",
3564
- "configuration",
3565
- "events",
3566
- "recurringEvents",
3567
- "subscriptions",
3568
- "actions",
3569
- "tags",
3570
- "name",
3571
- "dev",
3572
- "alwaysAlive",
3573
- "status",
3574
- "medias"
3575
- ],
3576
- "additionalProperties": false
3577
- }
3578
- },
3579
- "Integration": {
3580
- "section": "integration",
3581
- "schema": {
3582
- "type": "object",
3583
- "properties": {
3584
- "id": {
3585
- "type": "string",
3586
- "minLength": 28,
3587
- "maxLength": 36,
3588
- "description": "ID of the [Integration](#schema_integration)"
3589
- },
3590
- "createdAt": {
3591
- "type": "string",
3592
- "format": "date-time",
3593
- "description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
3594
- },
3595
- "updatedAt": {
3596
- "type": "string",
3597
- "format": "date-time",
3598
- "description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
3599
- },
3600
- "identifier": {
3601
- "type": "object",
3602
- "properties": {
3603
- "fallbackHandlerScript": {
3604
- "type": "string",
3605
- "maxLength": 2000,
3606
- "description": "VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier"
3607
- },
3608
- "extractScript": {
3609
- "type": "string",
3610
- "maxLength": 2000,
3611
- "description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth"
3612
- }
3613
- },
3614
- "description": "Global identifier configuration of the [Integration](#schema_integration)",
3615
- "additionalProperties": false
3616
- },
3617
- "sandbox": {
3618
- "type": "object",
3619
- "properties": {
3620
- "identifierExtractScript": {
3621
- "type": "string",
3622
- "maxLength": 2000,
3623
- "description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox"
3624
- },
3625
- "messageExtractScript": {
3626
- "type": "string",
3627
- "maxLength": 2000,
3628
- "description": "VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox"
3629
- }
3630
- },
3631
- "additionalProperties": false
3632
- },
3633
- "maxExecutionTime": {
3634
- "type": "number",
3635
- "description": "Maximum execution time of the integration (in seconds)."
3636
- },
3637
- "url": {
3638
- "type": "string",
3639
- "maxLength": 2000,
3640
- "description": "URL of the [Integration](#schema_integration)"
3641
- },
3642
- "name": {
3643
- "type": "string",
3644
- "maxLength": 200,
3645
- "description": "Name of the [Integration](#schema_integration)"
3646
- },
3647
- "version": {
3648
- "type": "string",
3649
- "maxLength": 200,
3650
- "description": "Version of the [Integration](#schema_integration)"
3651
- },
3652
- "interfaces": {
3653
- "type": "object",
3654
- "additionalProperties": {
3655
- "type": "object",
3656
- "properties": {
3657
- "id": {
3658
- "type": "string",
3659
- "minLength": 28,
3660
- "maxLength": 36,
3661
- "description": "ID of the interface"
3662
- },
3663
- "name": {
3664
- "type": "string",
3665
- "maxLength": 200,
3666
- "description": "Name of the interface"
3667
- },
3668
- "version": {
3669
- "type": "string",
3670
- "maxLength": 200,
3671
- "description": "Version of the interface"
3672
- },
3673
- "entities": {
3674
- "type": "object",
3675
- "additionalProperties": {
3676
- "type": "object",
3677
- "properties": {
3678
- "name": {
3679
- "type": "string",
3680
- "maxLength": 200
3681
- }
3682
- },
3683
- "required": [
3684
- "name"
3685
- ],
3686
- "additionalProperties": false
3687
- }
3688
- },
3689
- "actions": {
3690
- "type": "object",
3691
- "additionalProperties": {
3692
- "type": "object",
3693
- "properties": {
3694
- "name": {
3695
- "type": "string",
3696
- "maxLength": 200
3697
- }
3698
- },
3699
- "required": [
3700
- "name"
3701
- ],
3702
- "additionalProperties": false
3703
- }
3704
- },
3705
- "events": {
3706
- "type": "object",
3707
- "additionalProperties": {
3708
- "type": "object",
3709
- "properties": {
3710
- "name": {
3711
- "type": "string",
3712
- "maxLength": 200
3713
- }
3714
- },
3715
- "required": [
3716
- "name"
3717
- ],
3718
- "additionalProperties": false
3719
- }
3720
- },
3721
- "channels": {
3722
- "type": "object",
3723
- "additionalProperties": {
3724
- "type": "object",
3725
- "properties": {
3726
- "name": {
3727
- "type": "string",
3728
- "maxLength": 200
3729
- }
3730
- },
3731
- "required": [
3732
- "name"
3733
- ],
3734
- "additionalProperties": false
3735
- }
3736
- }
3737
- },
3738
- "required": [
3739
- "id",
3740
- "name",
3741
- "version",
3742
- "entities",
3743
- "actions",
3744
- "events",
3745
- "channels"
3746
- ],
3747
- "additionalProperties": false
3748
- }
3749
- },
3750
- "configuration": {
3751
- "type": "object",
3752
- "properties": {
3753
- "title": {
3754
- "type": "string",
3755
- "maxLength": 64,
3756
- "description": "Title of the configuration"
3757
- },
3758
- "description": {
3759
- "type": "string",
3760
- "maxLength": 256,
3761
- "description": "Description of the configuration"
3762
- },
3763
- "identifier": {
3764
- "type": "object",
3765
- "properties": {
3766
- "linkTemplateScript": {
3767
- "type": "string",
3768
- "maxLength": 2000
3769
- },
3770
- "required": {
3771
- "type": "boolean"
3772
- }
3773
- },
3774
- "required": [
3775
- "required"
3776
- ],
3777
- "description": "Identifier configuration of the [Integration](#schema_integration)",
3778
- "additionalProperties": false
3779
- },
3780
- "schema": {
3781
- "type": "object",
3782
- "additionalProperties": true,
3783
- "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
3784
- }
3785
- },
3786
- "required": [
3787
- "identifier",
3788
- "schema"
3789
- ],
3790
- "description": "Configuration definition",
3791
- "additionalProperties": false
3792
- },
3793
- "configurations": {
3794
- "type": "object",
3795
- "additionalProperties": {
3796
- "type": "object",
3797
- "properties": {
3798
- "title": {
3799
- "type": "string",
3800
- "maxLength": 64,
3801
- "description": "Title of the configuration"
3802
- },
3803
- "description": {
3804
- "type": "string",
3805
- "maxLength": 256,
3806
- "description": "Description of the configuration"
3807
- },
3808
- "identifier": {
3809
- "type": "object",
3810
- "properties": {
3811
- "linkTemplateScript": {
3812
- "type": "string",
3813
- "maxLength": 2000
3814
- },
3815
- "required": {
3816
- "type": "boolean"
3817
- }
3818
- },
3819
- "required": [
3820
- "required"
3821
- ],
3822
- "description": "Identifier configuration of the [Integration](#schema_integration)",
3823
- "additionalProperties": false
3824
- },
3825
- "schema": {
3826
- "type": "object",
3827
- "additionalProperties": true,
3828
- "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
3829
- }
3830
- },
3831
- "required": [
3832
- "identifier",
3833
- "schema"
3834
- ],
3835
- "description": "Configuration definition",
3836
- "additionalProperties": false
3837
- }
3838
- },
3839
- "channels": {
3840
- "type": "object",
3841
- "additionalProperties": {
3842
- "type": "object",
3843
- "properties": {
3844
- "title": {
3845
- "type": "string",
3846
- "maxLength": 64,
3847
- "description": "Title of the channel"
3848
- },
3849
- "description": {
3850
- "type": "string",
3851
- "maxLength": 256,
3852
- "description": "Description of the channel"
3853
- },
3854
- "messages": {
3855
- "type": "object",
3856
- "additionalProperties": {
3857
- "type": "object",
3858
- "properties": {
3859
- "schema": {
3860
- "type": "object",
3861
- "additionalProperties": true
3862
- }
3863
- },
3864
- "required": [
3865
- "schema"
3866
- ],
3867
- "description": "Message definition",
3868
- "additionalProperties": false
3869
- }
3870
- },
3871
- "conversation": {
3872
- "type": "object",
3873
- "properties": {
3874
- "tags": {
3875
- "type": "object",
3876
- "additionalProperties": {
3877
- "type": "object",
3878
- "properties": {
3879
- "title": {
3880
- "type": "string",
3881
- "maxLength": 64,
3882
- "description": "Title of the tag"
3883
- },
3884
- "description": {
3885
- "type": "string",
3886
- "maxLength": 256,
3887
- "description": "Description of the tag"
3888
- }
3889
- },
3890
- "description": "Definition of a tag that can be provided on the object",
3891
- "additionalProperties": false
3892
- }
3893
- },
3894
- "creation": {
3895
- "type": "object",
3896
- "properties": {
3897
- "enabled": {
3898
- "type": "boolean",
3899
- "description": "Enable conversation creation"
3900
- },
3901
- "requiredTags": {
3902
- "type": "array",
3903
- "items": {
3904
- "type": "string"
3905
- },
3906
- "description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
3907
- }
3908
- },
3909
- "required": [
3910
- "enabled",
3911
- "requiredTags"
3912
- ],
3913
- "description": "The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.",
3914
- "additionalProperties": false
3915
- }
3916
- },
3917
- "required": [
3918
- "tags",
3919
- "creation"
3920
- ],
3921
- "description": "Conversation object configuration",
3922
- "additionalProperties": false
3923
- },
3924
- "message": {
3925
- "type": "object",
3926
- "properties": {
3927
- "tags": {
3928
- "type": "object",
3929
- "additionalProperties": {
3930
- "type": "object",
3931
- "properties": {
3932
- "title": {
3933
- "type": "string",
3934
- "maxLength": 64,
3935
- "description": "Title of the tag"
3936
- },
3937
- "description": {
3938
- "type": "string",
3939
- "maxLength": 256,
3940
- "description": "Description of the tag"
3941
- }
3942
- },
3943
- "description": "Definition of a tag that can be provided on the object",
3944
- "additionalProperties": false
3945
- }
3946
- }
3947
- },
3948
- "required": [
3949
- "tags"
3950
- ],
3951
- "description": "Message object configuration",
3952
- "additionalProperties": false
3953
- }
3954
- },
3955
- "required": [
3956
- "messages",
3957
- "conversation",
3958
- "message"
3959
- ],
3960
- "description": "Channel definition",
3961
- "additionalProperties": false
3962
- }
3963
- },
3964
- "states": {
3965
- "type": "object",
3966
- "additionalProperties": {
3967
- "type": "object",
3968
- "properties": {
3969
- "type": {
3970
- "type": "string",
3971
- "enum": [
3972
- "conversation",
3973
- "user",
3974
- "integration"
3975
- ],
3976
- "description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
3977
- },
3978
- "schema": {
3979
- "type": "object",
3980
- "additionalProperties": true,
3981
- "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."
3982
- }
3983
- },
3984
- "required": [
3985
- "type",
3986
- "schema"
3987
- ],
3988
- "description": "State definition",
3989
- "additionalProperties": false
3990
- }
3991
- },
3992
- "events": {
3993
- "type": "object",
3994
- "additionalProperties": {
3995
- "type": "object",
3996
- "properties": {
3997
- "title": {
3998
- "type": "string",
3999
- "maxLength": 64,
4000
- "description": "Title of the event"
4001
- },
4002
- "description": {
4003
- "type": "string",
4004
- "maxLength": 256,
4005
- "description": "Description of the event"
4006
- },
4007
- "schema": {
4008
- "type": "object",
4009
- "additionalProperties": true
4010
- },
4011
- "attributes": {
4012
- "type": "object",
4013
- "additionalProperties": {
4014
- "type": "string",
4015
- "maxLength": 200
4016
- },
4017
- "description": "Optional attributes"
4018
- }
4019
- },
4020
- "required": [
4021
- "schema"
4022
- ],
4023
- "description": "Event Definition",
4024
- "additionalProperties": false
4025
- }
4026
- },
4027
- "actions": {
4028
- "type": "object",
4029
- "additionalProperties": {
4030
- "type": "object",
4031
- "properties": {
4032
- "title": {
4033
- "type": "string",
4034
- "maxLength": 64,
4035
- "description": "Title of the action"
4036
- },
4037
- "description": {
4038
- "type": "string",
4039
- "maxLength": 256,
4040
- "description": "Description of the action"
4041
- },
4042
- "billable": {
4043
- "type": "boolean"
4044
- },
4045
- "cacheable": {
4046
- "type": "boolean"
4047
- },
4048
- "input": {
4049
- "type": "object",
4050
- "properties": {
4051
- "schema": {
4052
- "type": "object",
4053
- "additionalProperties": true
4054
- }
4055
- },
4056
- "required": [
4057
- "schema"
4058
- ],
4059
- "additionalProperties": false
4060
- },
4061
- "output": {
4062
- "type": "object",
4063
- "properties": {
4064
- "schema": {
4065
- "type": "object",
4066
- "additionalProperties": true
4067
- }
4068
- },
4069
- "required": [
4070
- "schema"
4071
- ],
4072
- "additionalProperties": false
4073
- },
4074
- "attributes": {
4075
- "type": "object",
4076
- "additionalProperties": {
4077
- "type": "string",
4078
- "maxLength": 200
4079
- },
4080
- "description": "Optional attributes"
4081
- }
4082
- },
4083
- "required": [
4084
- "input",
4085
- "output"
4086
- ],
4087
- "description": "Action definition",
4088
- "additionalProperties": false
4089
- }
4090
- },
4091
- "user": {
4092
- "type": "object",
4093
- "properties": {
4094
- "tags": {
4095
- "type": "object",
4096
- "additionalProperties": {
4097
- "type": "object",
4098
- "properties": {
4099
- "title": {
4100
- "type": "string",
4101
- "maxLength": 64,
4102
- "description": "Title of the tag"
4103
- },
4104
- "description": {
4105
- "type": "string",
4106
- "maxLength": 256,
4107
- "description": "Description of the tag"
4108
- }
4109
- },
4110
- "description": "Definition of a tag that can be provided on the object",
4111
- "additionalProperties": false
4112
- }
4113
- },
4114
- "creation": {
4115
- "type": "object",
4116
- "properties": {
4117
- "enabled": {
4118
- "type": "boolean",
4119
- "description": "Enable user creation"
4120
- },
4121
- "requiredTags": {
4122
- "type": "array",
4123
- "items": {
4124
- "type": "string"
4125
- },
4126
- "description": "The list of tags that are required to be specified when calling the API directly to create a user."
4127
- }
4128
- },
4129
- "required": [
4130
- "enabled",
4131
- "requiredTags"
4132
- ],
4133
- "description": "The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.",
4134
- "additionalProperties": false
4135
- }
4136
- },
4137
- "required": [
4138
- "tags",
4139
- "creation"
4140
- ],
4141
- "description": "User object configuration",
4142
- "additionalProperties": false
4143
- },
4144
- "entities": {
4145
- "type": "object",
4146
- "additionalProperties": {
4147
- "type": "object",
4148
- "properties": {
4149
- "title": {
4150
- "type": "string",
4151
- "maxLength": 64,
4152
- "description": "Title of the entity"
4153
- },
4154
- "description": {
4155
- "type": "string",
4156
- "maxLength": 256,
4157
- "description": "Description of the entity"
4158
- },
4159
- "schema": {
4160
- "type": "object",
4161
- "additionalProperties": true
4162
- }
4163
- },
4164
- "required": [
4165
- "schema"
4166
- ],
4167
- "description": "Entity definition",
4168
- "additionalProperties": false
4169
- }
4170
- },
4171
- "attributes": {
4172
- "type": "object",
4173
- "additionalProperties": {
4174
- "type": "string",
4175
- "maxLength": 200
4176
- },
4177
- "description": "Optional attributes"
4178
- },
4179
- "dev": {
4180
- "type": "boolean",
4181
- "description": "Indicates if the integration is a development integration; Dev integrations run locally"
4182
- },
4183
- "title": {
4184
- "type": "string",
4185
- "minLength": 1,
4186
- "maxLength": 64,
4187
- "description": "Title of the integration. This is the name that will be displayed in the UI"
4188
- },
4189
- "description": {
4190
- "type": "string",
4191
- "maxLength": 256,
4192
- "description": "Description of the integration. This is the description that will be displayed in the UI"
4193
- },
4194
- "iconUrl": {
4195
- "type": "string",
4196
- "description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
4197
- },
4198
- "readmeUrl": {
4199
- "type": "string",
4200
- "description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
4201
- },
4202
- "public": {
4203
- "type": "boolean",
4204
- "description": "[DEPRECATED] Indicates whether the integration is public. Please use the \"visibility\" parameter instead.",
4205
- "deprecated": true
4206
- },
4207
- "visibility": {
4208
- "type": "string",
4209
- "enum": [
4210
- "public",
4211
- "private",
4212
- "unlisted"
4213
- ],
4214
- "description": "The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them."
4215
- },
4216
- "verificationStatus": {
4217
- "type": "string",
4218
- "enum": [
4219
- "unapproved",
4220
- "pending",
4221
- "approved",
4222
- "rejected"
4223
- ],
4224
- "description": "Status of the integration version verification"
4225
- },
4226
- "secrets": {
4227
- "type": "array",
4228
- "items": {
4229
- "type": "string"
4230
- },
4231
- "description": "Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing."
4232
- }
4233
- },
4234
- "required": [
4235
- "id",
4236
- "createdAt",
4237
- "updatedAt",
4238
- "identifier",
4239
- "url",
4240
- "name",
4241
- "version",
4242
- "interfaces",
4243
- "configuration",
4244
- "configurations",
4245
- "channels",
4246
- "states",
4247
- "events",
4248
- "actions",
4249
- "user",
4250
- "entities",
4251
- "dev",
4252
- "title",
4253
- "description",
4254
- "iconUrl",
4255
- "readmeUrl",
4256
- "public",
4257
- "visibility",
4258
- "verificationStatus",
4259
- "secrets"
4260
- ],
4261
- "additionalProperties": false
4262
- }
4263
- },
4264
- "Interface": {
4265
- "section": "interface",
4266
- "schema": {
4267
- "type": "object",
4268
- "properties": {
4269
- "id": {
4270
- "type": "string",
4271
- "minLength": 28,
4272
- "maxLength": 36,
4273
- "description": "ID of the [Interface](#schema_interface)"
4274
- },
4275
- "createdAt": {
4276
- "type": "string",
4277
- "format": "date-time",
4278
- "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
4279
- },
4280
- "updatedAt": {
4281
- "type": "string",
4282
- "format": "date-time",
4283
- "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
4284
- },
4285
- "name": {
4286
- "type": "string",
4287
- "maxLength": 200,
4288
- "description": "Name of the [Interface](#schema_interface)"
4289
- },
4290
- "version": {
4291
- "type": "string",
4292
- "maxLength": 200,
4293
- "description": "Version of the [Interface](#schema_interface)"
4294
- },
4295
- "entities": {
4296
- "type": "object",
4297
- "additionalProperties": {
4298
- "type": "object",
4299
- "properties": {
4300
- "title": {
4301
- "type": "string",
4302
- "maxLength": 64,
4303
- "description": "Title of the entity"
4304
- },
4305
- "description": {
4306
- "type": "string",
4307
- "maxLength": 256,
4308
- "description": "Description of the entity"
4309
- },
4310
- "schema": {
4311
- "type": "object",
4312
- "additionalProperties": true
4313
- }
4314
- },
4315
- "required": [
4316
- "schema"
4317
- ],
4318
- "description": "Entity definition",
4319
- "additionalProperties": false
4320
- }
4321
- },
4322
- "events": {
4323
- "type": "object",
4324
- "additionalProperties": {
4325
- "type": "object",
4326
- "properties": {
4327
- "title": {
4328
- "type": "string",
4329
- "maxLength": 64,
4330
- "description": "Title of the event"
4331
- },
4332
- "description": {
4333
- "type": "string",
4334
- "maxLength": 256,
4335
- "description": "Description of the event"
4336
- },
4337
- "schema": {
4338
- "type": "object",
4339
- "additionalProperties": true
4340
- },
4341
- "attributes": {
4342
- "type": "object",
4343
- "additionalProperties": {
4344
- "type": "string",
4345
- "maxLength": 200
4346
- },
4347
- "description": "Optional attributes"
4348
- }
4349
- },
4350
- "required": [
4351
- "schema"
4352
- ],
4353
- "description": "Event Definition",
4354
- "additionalProperties": false
4355
- }
4356
- },
4357
- "actions": {
4358
- "type": "object",
4359
- "additionalProperties": {
4360
- "type": "object",
4361
- "properties": {
4362
- "title": {
4363
- "type": "string",
4364
- "maxLength": 64,
4365
- "description": "Title of the action"
4366
- },
4367
- "description": {
4368
- "type": "string",
4369
- "maxLength": 256,
4370
- "description": "Description of the action"
4371
- },
4372
- "billable": {
4373
- "type": "boolean"
4374
- },
4375
- "cacheable": {
4376
- "type": "boolean"
4377
- },
4378
- "input": {
4379
- "type": "object",
4380
- "properties": {
4381
- "schema": {
4382
- "type": "object",
4383
- "additionalProperties": true
4384
- }
4385
- },
4386
- "required": [
4387
- "schema"
4388
- ],
4389
- "additionalProperties": false
4390
- },
4391
- "output": {
4392
- "type": "object",
4393
- "properties": {
4394
- "schema": {
4395
- "type": "object",
4396
- "additionalProperties": true
4397
- }
4398
- },
4399
- "required": [
4400
- "schema"
4401
- ],
4402
- "additionalProperties": false
4403
- },
4404
- "attributes": {
4405
- "type": "object",
4406
- "additionalProperties": {
4407
- "type": "string",
4408
- "maxLength": 200
4409
- },
4410
- "description": "Optional attributes"
4411
- }
4412
- },
4413
- "required": [
4414
- "input",
4415
- "output"
4416
- ],
4417
- "description": "Action definition",
4418
- "additionalProperties": false
4419
- }
4420
- },
4421
- "channels": {
4422
- "type": "object",
4423
- "additionalProperties": {
4424
- "type": "object",
4425
- "properties": {
4426
- "title": {
4427
- "type": "string",
4428
- "maxLength": 64,
4429
- "description": "Title of the channel"
4430
- },
4431
- "description": {
4432
- "type": "string",
4433
- "maxLength": 256,
4434
- "description": "Description of the channel"
4435
- },
4436
- "messages": {
4437
- "type": "object",
4438
- "additionalProperties": {
4439
- "type": "object",
4440
- "properties": {
4441
- "schema": {
4442
- "type": "object",
4443
- "additionalProperties": true
4444
- }
4445
- },
4446
- "required": [
4447
- "schema"
4448
- ],
4449
- "description": "Message definition",
4450
- "additionalProperties": false
4451
- }
4452
- }
4453
- },
4454
- "required": [
4455
- "messages"
4456
- ],
4457
- "additionalProperties": false
4458
- }
4459
- },
4460
- "nameTemplate": {
4461
- "type": "object",
4462
- "properties": {
4463
- "script": {
4464
- "type": "string",
4465
- "maxLength": 2000
4466
- },
4467
- "language": {
4468
- "type": "string",
4469
- "maxLength": 200
4470
- }
4471
- },
4472
- "required": [
4473
- "script",
4474
- "language"
4475
- ],
4476
- "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
4477
- "additionalProperties": false
4478
- },
4479
- "attributes": {
4480
- "type": "object",
4481
- "additionalProperties": {
4482
- "type": "string",
4483
- "maxLength": 200
4484
- },
4485
- "description": "Optional attributes"
4486
- },
4487
- "title": {
4488
- "type": "string",
4489
- "minLength": 1,
4490
- "maxLength": 64,
4491
- "description": "Title of the interface. This is the name that will be displayed in the UI"
4492
- },
4493
- "description": {
4494
- "type": "string",
4495
- "maxLength": 256,
4496
- "description": "Description of the interface. This is the description that will be displayed in the UI"
4497
- },
4498
- "iconUrl": {
4499
- "type": "string",
4500
- "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
4501
- },
4502
- "readmeUrl": {
4503
- "type": "string",
4504
- "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
4505
- },
4506
- "public": {
4507
- "type": "boolean",
4508
- "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
4509
- }
4510
- },
4511
- "required": [
4512
- "id",
4513
- "createdAt",
4514
- "updatedAt",
4515
- "name",
4516
- "version",
4517
- "entities",
4518
- "events",
4519
- "actions",
4520
- "channels",
4521
- "title",
4522
- "description",
4523
- "iconUrl",
4524
- "readmeUrl",
4525
- "public"
4526
- ],
4527
- "additionalProperties": false
4528
- }
4529
- },
4530
- "Plugin": {
4531
- "section": "plugin",
4532
- "schema": {
4533
- "type": "object",
4534
- "properties": {
4535
- "id": {
4536
- "type": "string",
4537
- "minLength": 28,
4538
- "maxLength": 36,
4539
- "description": "ID of the [Plugin](#schema_plugin)"
4540
- },
4541
- "name": {
4542
- "type": "string",
4543
- "maxLength": 200,
4544
- "description": "Name of the [Plugin](#schema_plugin)"
4545
- },
4546
- "version": {
4547
- "type": "string",
4548
- "maxLength": 200,
4549
- "description": "Version of the [Plugin](#schema_plugin)"
4550
- },
4551
- "createdAt": {
4552
- "type": "string",
4553
- "format": "date-time",
4554
- "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
4555
- },
4556
- "updatedAt": {
4557
- "type": "string",
4558
- "format": "date-time",
4559
- "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
4560
- },
4561
- "configuration": {
4562
- "type": "object",
4563
- "properties": {
4564
- "title": {
4565
- "type": "string",
4566
- "maxLength": 64,
4567
- "description": "Title of the configuration"
4568
- },
4569
- "description": {
4570
- "type": "string",
4571
- "maxLength": 256,
4572
- "description": "Description of the configuration"
4573
- },
4574
- "schema": {
4575
- "type": "object",
4576
- "additionalProperties": true,
4577
- "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
4578
- }
4579
- },
4580
- "required": [
4581
- "schema"
4582
- ],
4583
- "description": "Configuration definition",
4584
- "additionalProperties": false
4585
- },
4586
- "states": {
4587
- "type": "object",
4588
- "additionalProperties": {
4589
- "type": "object",
4590
- "properties": {
4591
- "type": {
4592
- "type": "string",
4593
- "enum": [
4594
- "conversation",
4595
- "user",
4596
- "bot",
4597
- "task"
4598
- ],
4599
- "description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
4600
- },
4601
- "schema": {
4602
- "type": "object",
4603
- "additionalProperties": true,
4604
- "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."
4605
- },
4606
- "expiry": {
4607
- "type": "number",
4608
- "minimum": 1,
4609
- "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."
4610
- }
4611
- },
4612
- "required": [
4613
- "type",
4614
- "schema"
4615
- ],
4616
- "additionalProperties": false
4617
- }
4618
- },
4619
- "events": {
4620
- "type": "object",
4621
- "additionalProperties": {
4622
- "type": "object",
4623
- "properties": {
4624
- "title": {
4625
- "type": "string",
4626
- "maxLength": 64,
4627
- "description": "Title of the event"
4628
- },
4629
- "description": {
4630
- "type": "string",
4631
- "maxLength": 256,
4632
- "description": "Description of the event"
4633
- },
4634
- "schema": {
4635
- "type": "object",
4636
- "additionalProperties": true
4637
- },
4638
- "attributes": {
4639
- "type": "object",
4640
- "additionalProperties": {
4641
- "type": "string",
4642
- "maxLength": 200
4643
- },
4644
- "description": "Optional attributes"
4645
- }
4646
- },
4647
- "required": [
4648
- "schema"
4649
- ],
4650
- "description": "Event Definition",
4651
- "additionalProperties": false
4652
- }
4653
- },
4654
- "actions": {
4655
- "type": "object",
4656
- "additionalProperties": {
4657
- "type": "object",
4658
- "properties": {
4659
- "title": {
4660
- "type": "string",
4661
- "maxLength": 64,
4662
- "description": "Title of the action"
4663
- },
4664
- "description": {
4665
- "type": "string",
4666
- "maxLength": 256,
4667
- "description": "Description of the action"
4668
- },
4669
- "billable": {
4670
- "type": "boolean"
4671
- },
4672
- "cacheable": {
4673
- "type": "boolean"
4674
- },
4675
- "input": {
4676
- "type": "object",
4677
- "properties": {
4678
- "schema": {
4679
- "type": "object",
4680
- "additionalProperties": true
4681
- }
4682
- },
4683
- "required": [
4684
- "schema"
4685
- ],
4686
- "additionalProperties": false
4687
- },
4688
- "output": {
4689
- "type": "object",
4690
- "properties": {
4691
- "schema": {
4692
- "type": "object",
4693
- "additionalProperties": true
4694
- }
4695
- },
4696
- "required": [
4697
- "schema"
4698
- ],
4699
- "additionalProperties": false
4700
- },
4701
- "attributes": {
4702
- "type": "object",
4703
- "additionalProperties": {
4704
- "type": "string",
4705
- "maxLength": 200
4706
- },
4707
- "description": "Optional attributes"
4708
- }
4709
- },
4710
- "required": [
4711
- "input",
4712
- "output"
4713
- ],
4714
- "description": "Action definition",
4715
- "additionalProperties": false
4716
- }
4717
- },
4718
- "dependencies": {
4719
- "type": "object",
4720
- "properties": {
4721
- "interfaces": {
4722
- "type": "object",
4723
- "additionalProperties": {
4724
- "type": "object",
4725
- "properties": {
4726
- "id": {
4727
- "type": "string",
4728
- "minLength": 28,
4729
- "maxLength": 36
4730
- },
4731
- "name": {
4732
- "type": "string",
4733
- "maxLength": 200
4734
- },
4735
- "version": {
4736
- "type": "string",
4737
- "maxLength": 200
4738
- }
4739
- },
4740
- "required": [
4741
- "id",
4742
- "name",
4743
- "version"
4744
- ],
4745
- "additionalProperties": false
4746
- }
4747
- },
4748
- "integrations": {
4749
- "type": "object",
4750
- "additionalProperties": {
4751
- "type": "object",
4752
- "properties": {
4753
- "id": {
4754
- "type": "string",
4755
- "minLength": 28,
4756
- "maxLength": 36
4757
- },
4758
- "name": {
4759
- "type": "string",
4760
- "maxLength": 200
4761
- },
4762
- "version": {
4763
- "type": "string",
4764
- "maxLength": 200
4765
- }
4766
- },
4767
- "required": [
4768
- "id",
4769
- "name",
4770
- "version"
4771
- ],
4772
- "additionalProperties": false
4773
- }
4774
- }
4775
- },
4776
- "required": [
4777
- "interfaces",
4778
- "integrations"
4779
- ],
4780
- "additionalProperties": false
4781
- },
4782
- "user": {
4783
- "type": "object",
4784
- "properties": {
4785
- "tags": {
4786
- "type": "object",
4787
- "additionalProperties": {
4788
- "type": "object",
4789
- "properties": {
4790
- "title": {
4791
- "type": "string",
4792
- "maxLength": 64,
4793
- "description": "Title of the tag"
4794
- },
4795
- "description": {
4796
- "type": "string",
4797
- "maxLength": 256,
4798
- "description": "Description of the tag"
4799
- }
4800
- },
4801
- "description": "Definition of a tag that can be provided on the object",
4802
- "additionalProperties": false
4803
- }
4804
- }
4805
- },
4806
- "required": [
4807
- "tags"
4808
- ],
4809
- "description": "User object configuration",
4810
- "additionalProperties": false
4811
- },
4812
- "conversation": {
4813
- "type": "object",
4814
- "properties": {
4815
- "tags": {
4816
- "type": "object",
4817
- "additionalProperties": {
4818
- "type": "object",
4819
- "properties": {
4820
- "title": {
4821
- "type": "string",
4822
- "maxLength": 64,
4823
- "description": "Title of the tag"
4824
- },
4825
- "description": {
4826
- "type": "string",
4827
- "maxLength": 256,
4828
- "description": "Description of the tag"
4829
- }
4830
- },
4831
- "description": "Definition of a tag that can be provided on the object",
4832
- "additionalProperties": false
4833
- }
4834
- }
4835
- },
4836
- "required": [
4837
- "tags"
4838
- ],
4839
- "description": "Conversation object configuration",
4840
- "additionalProperties": false
4841
- },
4842
- "attributes": {
4843
- "type": "object",
4844
- "additionalProperties": {
4845
- "type": "string",
4846
- "maxLength": 200
4847
- },
4848
- "description": "Optional attributes"
4849
- },
4850
- "title": {
4851
- "type": "string",
4852
- "minLength": 1,
4853
- "maxLength": 64,
4854
- "description": "Title of the plugin. This is the name that will be displayed in the UI"
4855
- },
4856
- "description": {
4857
- "type": "string",
4858
- "maxLength": 256,
4859
- "description": "Description of the plugin. This is the description that will be displayed in the UI"
4860
- },
4861
- "iconUrl": {
4862
- "type": "string",
4863
- "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
4864
- },
4865
- "readmeUrl": {
4866
- "type": "string",
4867
- "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
4868
- },
4869
- "public": {
4870
- "type": "boolean",
4871
- "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
4872
- }
4873
- },
4874
- "required": [
4875
- "id",
4876
- "name",
4877
- "version",
4878
- "createdAt",
4879
- "updatedAt",
4880
- "configuration",
4881
- "states",
4882
- "events",
4883
- "actions",
4884
- "dependencies",
4885
- "user",
4886
- "conversation",
4887
- "title",
4888
- "description",
4889
- "iconUrl",
4890
- "readmeUrl",
4891
- "public"
4892
- ],
4893
- "additionalProperties": false
4894
- }
4895
- },
4896
- "Workspace": {
4897
- "section": "workspace",
4898
- "schema": {
4899
- "type": "object",
4900
- "properties": {
4901
- "id": {
4902
- "type": "string"
4903
- },
4904
- "name": {
4905
- "type": "string"
4906
- },
4907
- "ownerId": {
4908
- "type": "string"
4909
- },
4910
- "createdAt": {
4911
- "type": "string"
4912
- },
4913
- "updatedAt": {
4914
- "type": "string"
4915
- },
4916
- "botCount": {
4917
- "type": "number"
4918
- },
4919
- "billingVersion": {
4920
- "type": "string",
4921
- "enum": [
4922
- "v1",
4923
- "v2",
4924
- "v3"
4925
- ]
4926
- },
4927
- "plan": {
4928
- "type": "string",
4929
- "enum": [
4930
- "community",
4931
- "team",
4932
- "enterprise",
4933
- "plus"
4934
- ]
4935
- },
4936
- "blocked": {
4937
- "type": "boolean"
4938
- },
4939
- "spendingLimit": {
4940
- "type": "number"
4941
- },
4942
- "about": {
4943
- "default": "",
4944
- "type": "string"
4945
- },
4946
- "profilePicture": {
4947
- "default": "",
4948
- "type": "string"
4949
- },
4950
- "contactEmail": {
4951
- "default": "",
4952
- "type": "string"
4953
- },
4954
- "website": {
4955
- "default": "",
4956
- "type": "string"
4957
- },
4958
- "socialAccounts": {
4959
- "default": [],
4960
- "type": "array",
4961
- "items": {
4962
- "type": "string"
4963
- }
4964
- },
4965
- "isPublic": {
4966
- "type": "boolean"
4967
- },
4968
- "handle": {
4969
- "type": "string"
4970
- },
4971
- "activeTrialId": {
4972
- "type": "string",
4973
- "nullable": true
4974
- }
4975
- },
4976
- "required": [
4977
- "id",
4978
- "name",
4979
- "ownerId",
4980
- "createdAt",
4981
- "updatedAt",
4982
- "botCount",
4983
- "billingVersion",
4984
- "plan",
4985
- "blocked",
4986
- "spendingLimit",
4987
- "activeTrialId"
4988
- ],
4989
- "additionalProperties": false
4990
- }
4991
- },
4992
- "WorkspaceMember": {
4993
- "section": "workspaceMember",
4994
- "schema": {
4995
- "type": "object",
4996
- "properties": {
4997
- "id": {
4998
- "type": "string"
4999
- },
5000
- "userId": {
5001
- "type": "string",
5002
- "format": "uuid"
5003
- },
5004
- "email": {
5005
- "type": "string"
5006
- },
5007
- "createdAt": {
5008
- "type": "string"
5009
- },
5010
- "role": {
5011
- "type": "string",
5012
- "enum": [
5013
- "viewer",
5014
- "billing",
5015
- "developer",
5016
- "manager",
5017
- "administrator",
5018
- "owner"
5019
- ]
5020
- },
5021
- "profilePicture": {
5022
- "type": "string"
5023
- },
5024
- "displayName": {
5025
- "type": "string",
5026
- "maxLength": 100
5027
- }
5028
- },
5029
- "required": [
5030
- "id",
5031
- "email",
5032
- "createdAt",
5033
- "role"
5034
- ],
5035
- "additionalProperties": false
5036
- }
5037
- },
5038
- "Account": {
5039
- "section": "account",
5040
- "schema": {
5041
- "type": "object",
5042
- "properties": {
5043
- "id": {
5044
- "type": "string"
5045
- },
5046
- "email": {
5047
- "type": "string"
5048
- },
5049
- "displayName": {
5050
- "type": "string",
5051
- "maxLength": 100
5052
- },
5053
- "emailVerified": {
5054
- "type": "boolean"
5055
- },
5056
- "profilePicture": {
5057
- "type": "string"
5058
- },
5059
- "createdAt": {
5060
- "type": "string",
5061
- "format": "date-time",
5062
- "description": "Creation date of the [Account](#schema_account) in ISO 8601 format"
5063
- }
5064
- },
5065
- "required": [
5066
- "id",
5067
- "email",
5068
- "emailVerified",
5069
- "createdAt"
5070
- ],
5071
- "additionalProperties": false
5072
- }
5073
- },
5074
- "Usage": {
5075
- "section": "usage",
5076
- "schema": {
5077
- "type": "object",
5078
- "properties": {
5079
- "id": {
5080
- "type": "string",
5081
- "description": "Id of the usage that it is linked to. It can either be a workspace id or a bot id"
5082
- },
5083
- "period": {
5084
- "type": "string",
5085
- "description": "Period of the quota that it is applied to"
5086
- },
5087
- "value": {
5088
- "type": "number",
5089
- "description": "Value of the current usage"
5090
- },
5091
- "quota": {
5092
- "type": "number",
5093
- "description": "Quota of the current usage"
5094
- },
5095
- "type": {
5096
- "type": "string",
5097
- "enum": [
5098
- "invocation_timeout",
5099
- "invocation_calls",
5100
- "storage_count",
5101
- "bot_count",
5102
- "knowledgebase_vector_storage",
5103
- "workspace_ratelimit",
5104
- "table_row_count",
5105
- "workspace_member_count",
5106
- "integrations_owned_count",
5107
- "ai_spend",
5108
- "openai_spend",
5109
- "bing_search_spend",
5110
- "always_alive"
5111
- ],
5112
- "description": "Usage type that can be used"
5113
- }
5114
- },
5115
- "required": [
5116
- "id",
5117
- "period",
5118
- "value",
5119
- "quota",
5120
- "type"
5121
- ],
5122
- "additionalProperties": false
5123
- }
5124
- },
5125
- "Issue": {
5126
- "section": "bot",
5127
- "schema": {
5128
- "type": "object",
5129
- "properties": {
5130
- "id": {
5131
- "type": "string"
5132
- },
5133
- "code": {
5134
- "type": "string"
5135
- },
5136
- "createdAt": {
5137
- "type": "string",
5138
- "format": "date-time"
5139
- },
5140
- "lastSeenAt": {
5141
- "type": "string",
5142
- "format": "date-time"
5143
- },
5144
- "title": {
5145
- "type": "string"
5146
- },
5147
- "description": {
5148
- "type": "string"
5149
- },
5150
- "groupedData": {
5151
- "type": "object",
5152
- "additionalProperties": {
5153
- "type": "object",
5154
- "properties": {
5155
- "raw": {
5156
- "type": "string"
5157
- },
5158
- "pretty": {
5159
- "type": "string"
5160
- }
5161
- },
5162
- "required": [
5163
- "raw"
5164
- ],
5165
- "additionalProperties": false
5166
- }
5167
- },
5168
- "eventsCount": {
5169
- "type": "number"
5170
- },
5171
- "category": {
5172
- "type": "string",
5173
- "enum": [
5174
- "user_code",
5175
- "limits",
5176
- "configuration",
5177
- "other"
5178
- ]
5179
- },
5180
- "resolutionLink": {
5181
- "type": "string",
5182
- "nullable": true
5183
- }
5184
- },
5185
- "required": [
5186
- "id",
5187
- "code",
5188
- "createdAt",
5189
- "lastSeenAt",
5190
- "title",
5191
- "description",
5192
- "groupedData",
5193
- "eventsCount",
5194
- "category",
5195
- "resolutionLink"
5196
- ],
5197
- "additionalProperties": false
5198
- }
5199
- },
5200
- "IssueEvent": {
5201
- "section": "bot",
5202
- "schema": {
5203
- "type": "object",
5204
- "properties": {
5205
- "id": {
5206
- "type": "string"
5207
- },
5208
- "createdAt": {
5209
- "type": "string",
5210
- "format": "date-time"
5211
- },
5212
- "data": {
5213
- "type": "object",
5214
- "additionalProperties": {
5215
- "type": "object",
5216
- "properties": {
5217
- "raw": {
5218
- "type": "string"
5219
- },
5220
- "pretty": {
5221
- "type": "string"
5222
- }
5223
- },
5224
- "required": [
5225
- "raw"
5226
- ],
5227
- "additionalProperties": false
5228
- }
5229
- }
5230
- },
5231
- "required": [
5232
- "id",
5233
- "createdAt",
5234
- "data"
5235
- ],
5236
- "additionalProperties": false
5237
- }
5238
- },
5239
- "Activity": {
5240
- "section": "activity",
5241
- "schema": {
5242
- "type": "object",
5243
- "properties": {
5244
- "id": {
5245
- "type": "string"
5246
- },
5247
- "description": {
5248
- "type": "string"
5249
- },
5250
- "taskId": {
5251
- "type": "string"
5252
- },
5253
- "category": {
5254
- "type": "string",
5255
- "enum": [
5256
- "unknown",
5257
- "capture",
5258
- "bot_message",
5259
- "user_message",
5260
- "agent_message",
5261
- "event",
5262
- "action",
5263
- "task_status",
5264
- "subtask_status",
5265
- "exception"
5266
- ]
5267
- },
5268
- "data": {
5269
- "type": "object",
5270
- "additionalProperties": true
5271
- },
5272
- "createdAt": {
5273
- "type": "string",
5274
- "format": "date-time",
5275
- "description": "Creation date of the activity in ISO 8601 format"
5276
- }
5277
- },
5278
- "required": [
5279
- "id",
5280
- "description",
5281
- "taskId",
5282
- "category",
5283
- "data",
5284
- "createdAt"
5285
- ],
5286
- "additionalProperties": false
5287
- }
5288
- },
5289
- "Version": {
5290
- "section": "bot",
5291
- "schema": {
5292
- "type": "object",
5293
- "properties": {
5294
- "id": {
5295
- "type": "string"
5296
- },
5297
- "name": {
5298
- "type": "string"
5299
- },
5300
- "description": {
5301
- "type": "string"
5302
- }
5303
- },
5304
- "required": [
5305
- "id",
5306
- "name"
5307
- ],
5308
- "additionalProperties": false
5309
- }
5310
- },
2855
+ "State": true,
2856
+ "Task": true,
2857
+ "Workflow": true
2858
+ }
2859
+ },
2860
+ "schemas": {
5311
2861
  "User": {
5312
2862
  "section": "user",
5313
2863
  "schema": {
@@ -5858,573 +3408,6 @@ export const state = {
5858
3408
  "description": "Workflow definition",
5859
3409
  "additionalProperties": false
5860
3410
  }
5861
- },
5862
- "Table": {
5863
- "section": "tables",
5864
- "schema": {
5865
- "type": "object",
5866
- "properties": {
5867
- "id": {
5868
- "type": "string",
5869
- "description": "Unique identifier for the table"
5870
- },
5871
- "name": {
5872
- "description": "Required. This name is used to identify your table.",
5873
- "type": "string",
5874
- "minLength": 1
5875
- },
5876
- "factor": {
5877
- "default": 1,
5878
- "type": "number",
5879
- "minimum": 1,
5880
- "maximum": 30,
5881
- "description": "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1."
5882
- },
5883
- "frozen": {
5884
- "type": "boolean",
5885
- "description": "A table designated as \"frozen\" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations."
5886
- },
5887
- "schema": {
5888
- "type": "object",
5889
- "properties": {
5890
- "$schema": {
5891
- "type": "string"
5892
- },
5893
- "properties": {
5894
- "type": "object",
5895
- "additionalProperties": {
5896
- "type": "object",
5897
- "properties": {
5898
- "type": {
5899
- "type": "string",
5900
- "enum": [
5901
- "string",
5902
- "number",
5903
- "boolean",
5904
- "object",
5905
- "array",
5906
- "null"
5907
- ]
5908
- },
5909
- "format": {
5910
- "type": "string",
5911
- "enum": [
5912
- "date-time"
5913
- ]
5914
- },
5915
- "description": {
5916
- "type": "string"
5917
- },
5918
- "pattern": {
5919
- "type": "string",
5920
- "description": "String properties must match this pattern"
5921
- },
5922
- "enum": {
5923
- "type": "array",
5924
- "items": {
5925
- "type": "string"
5926
- },
5927
- "description": "String properties must be one of these values"
5928
- },
5929
- "items": {
5930
- "type": "object",
5931
- "properties": {
5932
- "type": {
5933
- "type": "string",
5934
- "enum": [
5935
- "string",
5936
- "number",
5937
- "boolean",
5938
- "object",
5939
- "array",
5940
- "null"
5941
- ]
5942
- }
5943
- },
5944
- "required": [
5945
- "type"
5946
- ],
5947
- "additionalProperties": true,
5948
- "description": "Defines the shape of items in an array"
5949
- },
5950
- "nullable": {
5951
- "default": true,
5952
- "type": "boolean"
5953
- },
5954
- "properties": {
5955
- "type": "object",
5956
- "additionalProperties": {
5957
- "type": "object",
5958
- "properties": {
5959
- "type": {
5960
- "type": "string",
5961
- "enum": [
5962
- "string",
5963
- "number",
5964
- "boolean",
5965
- "object",
5966
- "array",
5967
- "null"
5968
- ]
5969
- }
5970
- },
5971
- "required": [
5972
- "type"
5973
- ],
5974
- "additionalProperties": true
5975
- }
5976
- },
5977
- "x-zui": {
5978
- "type": "object",
5979
- "properties": {
5980
- "index": {
5981
- "type": "integer"
5982
- },
5983
- "id": {
5984
- "type": "string",
5985
- "description": "[deprecated] ID of the column."
5986
- },
5987
- "searchable": {
5988
- "type": "boolean",
5989
- "description": "Indicates if the column is vectorized and searchable."
5990
- },
5991
- "hidden": {
5992
- "type": "boolean",
5993
- "description": "Indicates if the field is hidden in the UI"
5994
- },
5995
- "order": {
5996
- "type": "number",
5997
- "description": "Order of the column in the UI"
5998
- },
5999
- "width": {
6000
- "type": "number",
6001
- "description": "Width of the column in the UI"
6002
- },
6003
- "schemaId": {
6004
- "type": "string",
6005
- "description": "ID of the schema"
6006
- },
6007
- "computed": {
6008
- "type": "object",
6009
- "properties": {
6010
- "action": {
6011
- "type": "string",
6012
- "enum": [
6013
- "ai",
6014
- "code",
6015
- "workflow"
6016
- ]
6017
- },
6018
- "dependencies": {
6019
- "default": [],
6020
- "type": "array",
6021
- "items": {
6022
- "type": "string"
6023
- }
6024
- },
6025
- "prompt": {
6026
- "type": "string",
6027
- "description": "Prompt when action is \"ai\""
6028
- },
6029
- "code": {
6030
- "type": "string",
6031
- "description": "Code to execute when action is \"code\""
6032
- },
6033
- "model": {
6034
- "default": "gpt-4o",
6035
- "type": "string",
6036
- "maxLength": 80,
6037
- "description": "Model to use when action is \"ai\""
6038
- },
6039
- "workflowId": {
6040
- "type": "string",
6041
- "maxLength": 20,
6042
- "description": "ID of Workflow to execute when action is \"workflow\""
6043
- },
6044
- "enabled": {
6045
- "type": "boolean"
6046
- }
6047
- },
6048
- "required": [
6049
- "action"
6050
- ],
6051
- "additionalProperties": false
6052
- },
6053
- "typings": {
6054
- "type": "string",
6055
- "description": "TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\""
6056
- }
6057
- },
6058
- "required": [
6059
- "index"
6060
- ],
6061
- "additionalProperties": false
6062
- }
6063
- },
6064
- "required": [
6065
- "type",
6066
- "x-zui"
6067
- ],
6068
- "additionalProperties": false
6069
- },
6070
- "description": "List of keys/columns in the table."
6071
- },
6072
- "additionalProperties": {
6073
- "type": "boolean",
6074
- "enum": [
6075
- true
6076
- ],
6077
- "description": "Additional properties can be provided, but they will be ignored if no column matches."
6078
- },
6079
- "required": {
6080
- "type": "array",
6081
- "items": {
6082
- "type": "string"
6083
- },
6084
- "description": "Array of required properties."
6085
- },
6086
- "type": {
6087
- "type": "string",
6088
- "enum": [
6089
- "object"
6090
- ]
6091
- }
6092
- },
6093
- "required": [
6094
- "properties",
6095
- "additionalProperties",
6096
- "type"
6097
- ],
6098
- "additionalProperties": false
6099
- },
6100
- "tags": {
6101
- "type": "object",
6102
- "additionalProperties": {
6103
- "type": "string"
6104
- },
6105
- "description": "Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs."
6106
- },
6107
- "isComputeEnabled": {
6108
- "type": "boolean",
6109
- "description": "Indicates if the table is enabled for computation."
6110
- },
6111
- "createdAt": {
6112
- "type": "string",
6113
- "format": "date-time",
6114
- "description": "Timestamp of table creation."
6115
- },
6116
- "updatedAt": {
6117
- "type": "string",
6118
- "format": "date-time",
6119
- "description": "Timestamp of the last table update."
6120
- }
6121
- },
6122
- "required": [
6123
- "id",
6124
- "name",
6125
- "schema"
6126
- ],
6127
- "additionalProperties": false
6128
- }
6129
- },
6130
- "Column": {
6131
- "section": "tables",
6132
- "schema": {
6133
- "type": "object",
6134
- "properties": {
6135
- "id": {
6136
- "type": "string",
6137
- "description": "Unique identifier for the column."
6138
- },
6139
- "name": {
6140
- "type": "string",
6141
- "minLength": 1,
6142
- "maxLength": 30,
6143
- "description": "Name of the column, must be within length limits."
6144
- },
6145
- "description": {
6146
- "type": "string",
6147
- "description": "Optional descriptive text about the column."
6148
- },
6149
- "searchable": {
6150
- "type": "boolean",
6151
- "description": "Indicates if the column is vectorized and searchable."
6152
- },
6153
- "type": {
6154
- "type": "string",
6155
- "enum": [
6156
- "string",
6157
- "number",
6158
- "boolean",
6159
- "date",
6160
- "object"
6161
- ],
6162
- "description": "Specifies the data type of the column. Use \"object\" for complex data structures."
6163
- },
6164
- "typings": {
6165
- "type": "string",
6166
- "description": "TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\""
6167
- },
6168
- "computed": {
6169
- "type": "object",
6170
- "properties": {
6171
- "action": {
6172
- "type": "string",
6173
- "enum": [
6174
- "ai",
6175
- "code",
6176
- "workflow"
6177
- ]
6178
- },
6179
- "dependencies": {
6180
- "default": [],
6181
- "type": "array",
6182
- "items": {
6183
- "type": "string"
6184
- }
6185
- },
6186
- "prompt": {
6187
- "type": "string",
6188
- "description": "Prompt when action is \"ai\""
6189
- },
6190
- "code": {
6191
- "type": "string",
6192
- "description": "Code to execute when action is \"code\""
6193
- },
6194
- "model": {
6195
- "default": "gpt-4o",
6196
- "type": "string",
6197
- "maxLength": 80,
6198
- "description": "Model to use when action is \"ai\""
6199
- },
6200
- "workflowId": {
6201
- "type": "string",
6202
- "maxLength": 20,
6203
- "description": "ID of Workflow to execute when action is \"workflow\""
6204
- },
6205
- "enabled": {
6206
- "type": "boolean"
6207
- }
6208
- },
6209
- "required": [
6210
- "action"
6211
- ],
6212
- "additionalProperties": false
6213
- },
6214
- "schema": {
6215
- "type": "object",
6216
- "additionalProperties": true
6217
- }
6218
- },
6219
- "required": [
6220
- "name",
6221
- "type"
6222
- ],
6223
- "additionalProperties": false
6224
- }
6225
- },
6226
- "Row": {
6227
- "section": "tables",
6228
- "schema": {
6229
- "type": "object",
6230
- "properties": {
6231
- "id": {
6232
- "type": "number",
6233
- "description": "Unique identifier for the row."
6234
- },
6235
- "createdAt": {
6236
- "type": "string",
6237
- "format": "date-time",
6238
- "description": "Timestamp of row creation."
6239
- },
6240
- "updatedAt": {
6241
- "type": "string",
6242
- "format": "date-time",
6243
- "description": "Timestamp of the last row update."
6244
- },
6245
- "computed": {
6246
- "type": "object",
6247
- "additionalProperties": {
6248
- "type": "object",
6249
- "properties": {
6250
- "status": {
6251
- "type": "string"
6252
- },
6253
- "error": {
6254
- "type": "string"
6255
- },
6256
- "updatedBy": {
6257
- "type": "string"
6258
- },
6259
- "updatedAt": {
6260
- "type": "string"
6261
- }
6262
- },
6263
- "required": [
6264
- "status"
6265
- ],
6266
- "additionalProperties": false
6267
- }
6268
- },
6269
- "stale": {
6270
- "type": "array",
6271
- "items": {
6272
- "type": "string"
6273
- },
6274
- "description": "[Read-only] List of stale values that are waiting to be recomputed."
6275
- },
6276
- "similarity": {
6277
- "type": "number",
6278
- "description": "Optional numeric value indicating similarity, when using findTableRows."
6279
- }
6280
- },
6281
- "required": [
6282
- "id",
6283
- "computed"
6284
- ],
6285
- "additionalProperties": true
6286
- }
6287
- },
6288
- "File": {
6289
- "section": "files",
6290
- "schema": {
6291
- "type": "object",
6292
- "properties": {
6293
- "id": {
6294
- "type": "string",
6295
- "description": "File ID"
6296
- },
6297
- "botId": {
6298
- "type": "string",
6299
- "description": "The ID of the bot the file belongs to"
6300
- },
6301
- "key": {
6302
- "type": "string",
6303
- "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
6304
- },
6305
- "url": {
6306
- "type": "string",
6307
- "description": "URL to retrieve the file content. This URL will be ready to use once the file is uploaded.\n\nIf the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe."
6308
- },
6309
- "size": {
6310
- "type": "number",
6311
- "description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
6312
- "nullable": true
6313
- },
6314
- "contentType": {
6315
- "type": "string",
6316
- "description": "MIME type of the file's content"
6317
- },
6318
- "tags": {
6319
- "type": "object",
6320
- "additionalProperties": {
6321
- "type": "string",
6322
- "maxLength": 1000
6323
- },
6324
- "description": "The tags of the file as an object of key/value pairs"
6325
- },
6326
- "metadata": {
6327
- "type": "object",
6328
- "additionalProperties": {
6329
- "nullable": true
6330
- },
6331
- "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
6332
- },
6333
- "createdAt": {
6334
- "type": "string",
6335
- "description": "File creation timestamp in ISO 8601 format"
6336
- },
6337
- "updatedAt": {
6338
- "type": "string",
6339
- "description": "File last update timestamp in ISO 8601 format"
6340
- },
6341
- "accessPolicies": {
6342
- "type": "array",
6343
- "items": {
6344
- "type": "string",
6345
- "enum": [
6346
- "integrations",
6347
- "public_content"
6348
- ]
6349
- },
6350
- "description": "Access policies configured for the file."
6351
- },
6352
- "index": {
6353
- "type": "boolean",
6354
- "description": "Whether the file was requested to be indexed for search or not."
6355
- },
6356
- "status": {
6357
- "type": "string",
6358
- "enum": [
6359
- "upload_pending",
6360
- "upload_failed",
6361
- "upload_completed",
6362
- "indexing_pending",
6363
- "indexing_failed",
6364
- "indexing_completed"
6365
- ],
6366
- "description": "Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field."
6367
- },
6368
- "failedStatusReason": {
6369
- "type": "string",
6370
- "description": "If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure."
6371
- },
6372
- "expiresAt": {
6373
- "type": "string",
6374
- "description": "File expiry timestamp in ISO 8601 format"
6375
- },
6376
- "owner": {
6377
- "type": "object",
6378
- "properties": {
6379
- "type": {
6380
- "type": "string",
6381
- "enum": [
6382
- "bot",
6383
- "integration",
6384
- "user"
6385
- ]
6386
- },
6387
- "id": {
6388
- "type": "string",
6389
- "description": "This field is present if `type` is \"user\" or \"bot\". If `type` is \"user\", this is the user ID. If `type` is \"bot\", this is the bot ID."
6390
- },
6391
- "name": {
6392
- "type": "string",
6393
- "description": "This field is present if the `type` is \"integration\". If `type` is \"integration\", this is the integration name."
6394
- }
6395
- },
6396
- "required": [
6397
- "type"
6398
- ],
6399
- "additionalProperties": false
6400
- },
6401
- "indexingStack": {
6402
- "type": "string",
6403
- "enum": [
6404
- "v1",
6405
- "v2"
6406
- ],
6407
- "description": "Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of \"v2\" denotes the latest stack, \"v1\" denotes the legacy stack."
6408
- }
6409
- },
6410
- "required": [
6411
- "id",
6412
- "botId",
6413
- "key",
6414
- "url",
6415
- "size",
6416
- "contentType",
6417
- "tags",
6418
- "metadata",
6419
- "createdAt",
6420
- "updatedAt",
6421
- "accessPolicies",
6422
- "index",
6423
- "status",
6424
- "owner"
6425
- ],
6426
- "additionalProperties": false
6427
- }
6428
3411
  }
6429
3412
  },
6430
3413
  "sections": [
@@ -6499,8 +3482,8 @@ export const state = {
6499
3482
  "schema": "State"
6500
3483
  },
6501
3484
  {
6502
- "title": "Hub",
6503
3485
  "description": "",
3486
+ "title": "Hub",
6504
3487
  "name": "hub",
6505
3488
  "operations": []
6506
3489
  },
@@ -6546,95 +3529,6 @@ export const state = {
6546
3529
  "operations": [
6547
3530
  "listTagValues"
6548
3531
  ]
6549
- },
6550
- {
6551
- "title": "Bot",
6552
- "description": "",
6553
- "name": "bot",
6554
- "operations": [],
6555
- "schema": "Bot"
6556
- },
6557
- {
6558
- "title": "Integration",
6559
- "description": "",
6560
- "name": "integration",
6561
- "operations": [],
6562
- "schema": "Integration"
6563
- },
6564
- {
6565
- "title": "Interface",
6566
- "description": "",
6567
- "name": "interface",
6568
- "operations": [],
6569
- "schema": "Interface"
6570
- },
6571
- {
6572
- "title": "Plugin",
6573
- "description": "",
6574
- "name": "plugin",
6575
- "operations": [],
6576
- "schema": "Plugin"
6577
- },
6578
- {
6579
- "title": "Workspace",
6580
- "description": "",
6581
- "name": "workspace",
6582
- "operations": [],
6583
- "schema": "Workspace"
6584
- },
6585
- {
6586
- "title": "Workspace Member",
6587
- "description": "",
6588
- "name": "workspaceMember",
6589
- "operations": [],
6590
- "schema": "WorkspaceMember"
6591
- },
6592
- {
6593
- "title": "Account",
6594
- "description": "",
6595
- "name": "account",
6596
- "operations": [],
6597
- "schema": "Account"
6598
- },
6599
- {
6600
- "title": "Usage",
6601
- "description": "",
6602
- "name": "usage",
6603
- "operations": [],
6604
- "schema": "Usage"
6605
- },
6606
- {
6607
- "title": "Quotas",
6608
- "description": "",
6609
- "name": "quotas",
6610
- "operations": []
6611
- },
6612
- {
6613
- "title": "Helper",
6614
- "description": "",
6615
- "name": "helper",
6616
- "operations": []
6617
- },
6618
- {
6619
- "title": "Activity",
6620
- "description": "",
6621
- "name": "activity",
6622
- "operations": [],
6623
- "schema": "Activity"
6624
- },
6625
- {
6626
- "title": "Tables",
6627
- "description": "Manage and interact with table structures, including creation, updates, and querying of tables and their rows.",
6628
- "name": "tables",
6629
- "operations": [],
6630
- "schema": "Table"
6631
- },
6632
- {
6633
- "title": "Files",
6634
- "description": "The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Word, HTML, Markdown, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.",
6635
- "name": "files",
6636
- "operations": [],
6637
- "schema": "File"
6638
3532
  }
6639
3533
  ],
6640
3534
  "options": {