@botpress/api 1.48.0 → 1.48.2

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