@botpress/api 0.16.0 → 0.16.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -428298,6 +428298,300 @@ var state = {
428298
428298
  },
428299
428299
  parameters: {}
428300
428300
  },
428301
+ getTask: {
428302
+ name: "getTask",
428303
+ description: "Retrieves the [Task](#schema_task) object for a valid identifier.",
428304
+ method: "get",
428305
+ path: "/v1/chat/tasks/{id}",
428306
+ parameters: {
428307
+ id: {
428308
+ in: "path",
428309
+ type: "string",
428310
+ description: "Task id"
428311
+ }
428312
+ },
428313
+ section: "task",
428314
+ response: {
428315
+ description: "Returns a [Task](#schema_task) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
428316
+ schema: {
428317
+ type: "object",
428318
+ properties: {
428319
+ task: {
428320
+ $ref: "#/components/schemas/Task"
428321
+ }
428322
+ },
428323
+ required: ["task"],
428324
+ title: "getTaskResponse",
428325
+ additionalProperties: false
428326
+ }
428327
+ }
428328
+ },
428329
+ createTask: {
428330
+ name: "createTask",
428331
+ description: "Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.",
428332
+ method: "post",
428333
+ path: "/v1/chat/tasks",
428334
+ requestBody: {
428335
+ description: "Task data",
428336
+ schema: {
428337
+ type: "object",
428338
+ properties: {
428339
+ title: {
428340
+ type: "string",
428341
+ maxLength: 2e3,
428342
+ description: "Title describing the task"
428343
+ },
428344
+ description: {
428345
+ type: "string",
428346
+ maxLength: 2e4,
428347
+ description: "All the notes related to the execution of the current task"
428348
+ },
428349
+ type: {
428350
+ type: "string",
428351
+ maxLength: 200,
428352
+ description: "Unique identifier of the integration that was installed on the bot"
428353
+ },
428354
+ data: {
428355
+ type: "object",
428356
+ additionalProperties: true,
428357
+ description: "Content related to the task"
428358
+ },
428359
+ parentTaskId: {
428360
+ type: "string",
428361
+ description: "Parent task id is the parent task that created this task"
428362
+ },
428363
+ conversationId: {
428364
+ type: "string",
428365
+ description: "Conversation id related to this task"
428366
+ },
428367
+ userId: {
428368
+ type: "string",
428369
+ description: "Specific user related to this task"
428370
+ },
428371
+ timeoutAt: {
428372
+ type: "string",
428373
+ format: "date-time",
428374
+ description: "The timeout date where the task should be failed in the ISO 8601 format"
428375
+ },
428376
+ tags: {
428377
+ type: "object",
428378
+ additionalProperties: {
428379
+ type: "string",
428380
+ maxLength: 500
428381
+ },
428382
+ description: "Tags for the [Task](#schema_task)"
428383
+ }
428384
+ },
428385
+ required: ["type", "conversationId"],
428386
+ title: "createTaskBody",
428387
+ additionalProperties: false
428388
+ }
428389
+ },
428390
+ section: "task",
428391
+ response: {
428392
+ description: "Returns a [Task](#schema_task) object if creation succeeds. Returns [an error](#errors) otherwise",
428393
+ status: 201,
428394
+ schema: {
428395
+ type: "object",
428396
+ properties: {
428397
+ task: {
428398
+ $ref: "#/components/schemas/Task"
428399
+ }
428400
+ },
428401
+ required: ["task"],
428402
+ title: "createTaskResponse",
428403
+ additionalProperties: false
428404
+ }
428405
+ },
428406
+ parameters: {}
428407
+ },
428408
+ updateTask: {
428409
+ name: "updateTask",
428410
+ description: "Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.",
428411
+ method: "put",
428412
+ path: "/v1/chat/tasks/{id}",
428413
+ parameters: {
428414
+ id: {
428415
+ in: "path",
428416
+ type: "string",
428417
+ description: "Task id"
428418
+ }
428419
+ },
428420
+ requestBody: {
428421
+ description: "Task data",
428422
+ schema: {
428423
+ type: "object",
428424
+ properties: {
428425
+ title: {
428426
+ type: "string",
428427
+ description: "Title describing the task"
428428
+ },
428429
+ description: {
428430
+ type: "string",
428431
+ description: "All the notes related to the execution of the current task"
428432
+ },
428433
+ data: {
428434
+ type: "object",
428435
+ additionalProperties: true,
428436
+ description: "Content related to the task"
428437
+ },
428438
+ timeoutAt: {
428439
+ type: "string",
428440
+ format: "date-time",
428441
+ description: "The timeout date where the task should be failed in the ISO 8601 format"
428442
+ },
428443
+ status: {
428444
+ type: "string",
428445
+ enum: [
428446
+ "pending",
428447
+ "in_progress",
428448
+ "failed",
428449
+ "completed",
428450
+ "blocked",
428451
+ "paused",
428452
+ "timeout",
428453
+ "cancelled"
428454
+ ],
428455
+ description: "Status of the task"
428456
+ },
428457
+ tags: {
428458
+ type: "object",
428459
+ additionalProperties: {
428460
+ type: "string",
428461
+ maxLength: 500
428462
+ },
428463
+ description: "Tags for the [Task](#schema_task)"
428464
+ }
428465
+ },
428466
+ title: "updateTaskBody",
428467
+ additionalProperties: false
428468
+ }
428469
+ },
428470
+ section: "task",
428471
+ response: {
428472
+ description: "Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
428473
+ schema: {
428474
+ type: "object",
428475
+ properties: {
428476
+ task: {
428477
+ $ref: "#/components/schemas/Task"
428478
+ }
428479
+ },
428480
+ required: ["task"],
428481
+ title: "updateTaskResponse",
428482
+ additionalProperties: false
428483
+ }
428484
+ }
428485
+ },
428486
+ deleteTask: {
428487
+ name: "deleteTask",
428488
+ description: "Permanently deletes a [Task](#schema_task). It cannot be undone.",
428489
+ method: "delete",
428490
+ path: "/v1/chat/tasks/{id}",
428491
+ parameters: {
428492
+ id: {
428493
+ in: "path",
428494
+ type: "string",
428495
+ description: "Task id"
428496
+ }
428497
+ },
428498
+ section: "task",
428499
+ response: {
428500
+ description: "Returns the [Task](#schema_task) object that was deleted",
428501
+ schema: {
428502
+ type: "object",
428503
+ title: "deleteTaskResponse",
428504
+ additionalProperties: false
428505
+ }
428506
+ }
428507
+ },
428508
+ listTasks: {
428509
+ name: "listTasks",
428510
+ description: "Retrieves a list of [Task](#schema_task) you've previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).",
428511
+ method: "get",
428512
+ path: "/v1/chat/tasks",
428513
+ parameters: {
428514
+ nextToken: {
428515
+ in: "query",
428516
+ description: "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
428517
+ type: "string"
428518
+ },
428519
+ tags: {
428520
+ in: "query",
428521
+ type: "object",
428522
+ schema: {
428523
+ type: "object",
428524
+ additionalProperties: {
428525
+ type: "string"
428526
+ }
428527
+ },
428528
+ description: "Filter by tags"
428529
+ },
428530
+ conversationId: {
428531
+ in: "query",
428532
+ type: "string",
428533
+ description: "Conversation id"
428534
+ },
428535
+ userId: {
428536
+ in: "query",
428537
+ type: "string",
428538
+ description: "User id"
428539
+ },
428540
+ parentTaskId: {
428541
+ in: "query",
428542
+ type: "string",
428543
+ description: "Parent task id"
428544
+ },
428545
+ status: {
428546
+ in: "query",
428547
+ type: "string[]",
428548
+ description: "Status",
428549
+ enum: [
428550
+ "pending",
428551
+ "in_progress",
428552
+ "failed",
428553
+ "completed",
428554
+ "blocked",
428555
+ "paused",
428556
+ "timeout",
428557
+ "cancelled"
428558
+ ]
428559
+ },
428560
+ type: {
428561
+ in: "query",
428562
+ type: "string",
428563
+ description: "Type"
428564
+ }
428565
+ },
428566
+ section: "task",
428567
+ response: {
428568
+ description: "Returns a list of [Task](#schema_task) objects",
428569
+ schema: {
428570
+ type: "object",
428571
+ properties: {
428572
+ tasks: {
428573
+ type: "array",
428574
+ items: {
428575
+ $ref: "#/components/schemas/Task"
428576
+ }
428577
+ },
428578
+ meta: {
428579
+ type: "object",
428580
+ properties: {
428581
+ nextToken: {
428582
+ type: "string",
428583
+ description: "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
428584
+ }
428585
+ },
428586
+ additionalProperties: false
428587
+ }
428588
+ },
428589
+ required: ["tasks", "meta"],
428590
+ title: "listTasksResponse",
428591
+ additionalProperties: false
428592
+ }
428593
+ }
428594
+ },
428301
428595
  runVrl: {
428302
428596
  name: "runVrl",
428303
428597
  description: "Run a VRL script",
@@ -430290,6 +430584,10 @@ var state = {
430290
430584
  },
430291
430585
  isPublic: {
430292
430586
  type: "boolean"
430587
+ },
430588
+ handle: {
430589
+ default: "",
430590
+ type: "string"
430293
430591
  }
430294
430592
  },
430295
430593
  required: [
@@ -430393,6 +430691,10 @@ var state = {
430393
430691
  },
430394
430692
  isPublic: {
430395
430693
  type: "boolean"
430694
+ },
430695
+ handle: {
430696
+ default: "",
430697
+ type: "string"
430396
430698
  }
430397
430699
  },
430398
430700
  required: [
@@ -430801,6 +431103,12 @@ var state = {
430801
431103
  },
430802
431104
  isPublic: {
430803
431105
  type: "boolean"
431106
+ },
431107
+ handle: {
431108
+ type: "string",
431109
+ minLength: 1,
431110
+ maxLength: 64,
431111
+ pattern: "^[0-9a-z][a-z0-9-]+[0-9a-z]$"
430804
431112
  }
430805
431113
  },
430806
431114
  additionalProperties: false,
@@ -430873,6 +431181,10 @@ var state = {
430873
431181
  },
430874
431182
  isPublic: {
430875
431183
  type: "boolean"
431184
+ },
431185
+ handle: {
431186
+ default: "",
431187
+ type: "string"
430876
431188
  }
430877
431189
  },
430878
431190
  required: [
@@ -430893,6 +431205,57 @@ var state = {
430893
431205
  }
430894
431206
  }
430895
431207
  },
431208
+ checkHandleAvailability: {
431209
+ name: "checkHandleAvailability",
431210
+ description: "Check if a workspace handle is available",
431211
+ section: "workspace",
431212
+ method: "put",
431213
+ disableDefaultParameters: {
431214
+ "x-workspace-id": true
431215
+ },
431216
+ path: "/v1/admin/workspaces/handle-availability",
431217
+ requestBody: {
431218
+ description: "Workspace handle availability",
431219
+ schema: {
431220
+ type: "object",
431221
+ properties: {
431222
+ handle: {
431223
+ type: "string",
431224
+ minLength: 1,
431225
+ maxLength: 50,
431226
+ pattern: "^[a-z0-9-_]+$"
431227
+ }
431228
+ },
431229
+ required: ["handle"],
431230
+ title: "checkHandleAvailabilityBody",
431231
+ additionalProperties: false
431232
+ }
431233
+ },
431234
+ response: {
431235
+ description: "Success",
431236
+ schema: {
431237
+ type: "object",
431238
+ properties: {
431239
+ available: {
431240
+ type: "boolean"
431241
+ },
431242
+ suggestions: {
431243
+ type: "array",
431244
+ items: {
431245
+ type: "string"
431246
+ }
431247
+ },
431248
+ usedBy: {
431249
+ type: "string"
431250
+ }
431251
+ },
431252
+ required: ["available", "suggestions"],
431253
+ title: "checkHandleAvailabilityResponse",
431254
+ additionalProperties: false
431255
+ }
431256
+ },
431257
+ parameters: {}
431258
+ },
430896
431259
  listWorkspaces: {
430897
431260
  name: "listWorkspaces",
430898
431261
  description: "List workspaces the user has access to",
@@ -430980,6 +431343,10 @@ var state = {
430980
431343
  },
430981
431344
  isPublic: {
430982
431345
  type: "boolean"
431346
+ },
431347
+ handle: {
431348
+ default: "",
431349
+ type: "string"
430983
431350
  }
430984
431351
  },
430985
431352
  required: [
@@ -431112,6 +431479,10 @@ var state = {
431112
431479
  },
431113
431480
  isPublic: {
431114
431481
  type: "boolean"
431482
+ },
431483
+ handle: {
431484
+ default: "",
431485
+ type: "string"
431115
431486
  }
431116
431487
  },
431117
431488
  required: [
@@ -431530,7 +431901,7 @@ var state = {
431530
431901
  linkTemplateScript: {
431531
431902
  type: "string",
431532
431903
  maxLength: 2e3,
431533
- description: "Signing secret of the [Bot](#schema_bot)"
431904
+ description: "Title describing the task"
431534
431905
  }
431535
431906
  },
431536
431907
  additionalProperties: false
@@ -431633,12 +432004,12 @@ var state = {
431633
432004
  fallbackHandlerScript: {
431634
432005
  type: "string",
431635
432006
  maxLength: 2e3,
431636
- description: "Signing secret of the [Bot](#schema_bot)"
432007
+ description: "Title describing the task"
431637
432008
  },
431638
432009
  extractScript: {
431639
432010
  type: "string",
431640
432011
  maxLength: 2e3,
431641
- description: "Signing secret of the [Bot](#schema_bot)"
432012
+ description: "Title describing the task"
431642
432013
  }
431643
432014
  },
431644
432015
  additionalProperties: false
@@ -431886,7 +432257,7 @@ var state = {
431886
432257
  linkTemplateScript: {
431887
432258
  type: "string",
431888
432259
  maxLength: 2e3,
431889
- description: "Signing secret of the [Bot](#schema_bot)",
432260
+ description: "Title describing the task",
431890
432261
  nullable: true
431891
432262
  },
431892
432263
  required: {
@@ -432013,13 +432384,13 @@ var state = {
432013
432384
  extractScript: {
432014
432385
  type: "string",
432015
432386
  maxLength: 2e3,
432016
- description: "Signing secret of the [Bot](#schema_bot)",
432387
+ description: "Title describing the task",
432017
432388
  nullable: true
432018
432389
  },
432019
432390
  fallbackHandlerScript: {
432020
432391
  type: "string",
432021
432392
  maxLength: 2e3,
432022
- description: "Signing secret of the [Bot](#schema_bot)",
432393
+ description: "Title describing the task",
432023
432394
  nullable: true
432024
432395
  }
432025
432396
  },
@@ -432611,6 +432982,62 @@ var state = {
432611
432982
  },
432612
432983
  parameters: {}
432613
432984
  },
432985
+ listActivities: {
432986
+ name: "listActivities",
432987
+ description: "List activities of a task",
432988
+ method: "get",
432989
+ section: "activity",
432990
+ path: "/v1/admin/activities",
432991
+ disableDefaultParameters: {
432992
+ "x-workspace-id": true
432993
+ },
432994
+ parameters: {
432995
+ nextToken: {
432996
+ in: "query",
432997
+ description: "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
432998
+ type: "string"
432999
+ },
433000
+ taskId: {
433001
+ in: "query",
433002
+ description: "ID of the task to list activities for",
433003
+ type: "string",
433004
+ required: true
433005
+ },
433006
+ botId: {
433007
+ in: "query",
433008
+ description: "ID of the bot to list activities for",
433009
+ type: "string",
433010
+ required: true
433011
+ }
433012
+ },
433013
+ response: {
433014
+ description: "Success",
433015
+ schema: {
433016
+ type: "object",
433017
+ properties: {
433018
+ activities: {
433019
+ type: "array",
433020
+ items: {
433021
+ $ref: "#/components/schemas/Activity"
433022
+ }
433023
+ },
433024
+ meta: {
433025
+ type: "object",
433026
+ properties: {
433027
+ nextToken: {
433028
+ type: "string",
433029
+ description: "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
433030
+ }
433031
+ },
433032
+ additionalProperties: false
433033
+ }
433034
+ },
433035
+ required: ["activities", "meta"],
433036
+ title: "listActivitiesResponse",
433037
+ additionalProperties: false
433038
+ }
433039
+ }
433040
+ },
432614
433041
  introspect: {
432615
433042
  name: "introspect",
432616
433043
  description: "Introspect the API",
@@ -432829,7 +433256,7 @@ var state = {
432829
433256
  title: "Botpress API",
432830
433257
  description: "API for Botpress Cloud",
432831
433258
  server: "https://api.botpress.cloud",
432832
- version: "0.16.0",
433259
+ version: "0.16.3",
432833
433260
  prefix: "v1"
432834
433261
  },
432835
433262
  errors: [
@@ -432957,6 +433384,8 @@ var state = {
432957
433384
  patchStateBody: true,
432958
433385
  callActionBody: true,
432959
433386
  configureIntegrationBody: true,
433387
+ createTaskBody: true,
433388
+ updateTaskBody: true,
432960
433389
  runVrlBody: true,
432961
433390
  createPersonalAccessTokenBody: true,
432962
433391
  setAccountPreferenceBody: true,
@@ -432967,6 +433396,7 @@ var state = {
432967
433396
  chargeWorkspaceUnpaidInvoicesBody: true,
432968
433397
  createWorkspaceBody: true,
432969
433398
  updateWorkspaceBody: true,
433399
+ checkHandleAvailabilityBody: true,
432970
433400
  changeWorkspacePlanBody: true,
432971
433401
  createWorkspaceMemberBody: true,
432972
433402
  updateWorkspaceMemberBody: true,
@@ -433007,6 +433437,11 @@ var state = {
433007
433437
  patchStateResponse: true,
433008
433438
  callActionResponse: true,
433009
433439
  configureIntegrationResponse: true,
433440
+ getTaskResponse: true,
433441
+ createTaskResponse: true,
433442
+ updateTaskResponse: true,
433443
+ deleteTaskResponse: true,
433444
+ listTasksResponse: true,
433010
433445
  runVrlResponse: true,
433011
433446
  getAccountResponse: true,
433012
433447
  listPersonalAccessTokensResponse: true,
@@ -433041,6 +433476,7 @@ var state = {
433041
433476
  getWorkspaceQuotaResponse: true,
433042
433477
  listWorkspaceQuotasResponse: true,
433043
433478
  updateWorkspaceResponse: true,
433479
+ checkHandleAvailabilityResponse: true,
433044
433480
  listWorkspacesResponse: true,
433045
433481
  changeWorkspacePlanResponse: true,
433046
433482
  deleteWorkspaceResponse: true,
@@ -433059,6 +433495,7 @@ var state = {
433059
433495
  getUsageResponse: true,
433060
433496
  listUsageHistoryResponse: true,
433061
433497
  changeAISpendQuotaResponse: true,
433498
+ listActivitiesResponse: true,
433062
433499
  introspectResponse: true,
433063
433500
  createFileResponse: true,
433064
433501
  getFileResponse: true,
@@ -433075,11 +433512,13 @@ var state = {
433075
433512
  Usage: true,
433076
433513
  Issue: true,
433077
433514
  IssueEvent: true,
433515
+ Activity: true,
433078
433516
  User: true,
433079
433517
  Conversation: true,
433080
433518
  Event: true,
433081
433519
  Message: true,
433082
433520
  State: true,
433521
+ Task: true,
433083
433522
  File: true,
433084
433523
  Table: true,
433085
433524
  Column: true,
@@ -433111,7 +433550,7 @@ var state = {
433111
433550
  signingSecret: {
433112
433551
  type: "string",
433113
433552
  maxLength: 2e3,
433114
- description: "Signing secret of the [Bot](#schema_bot)"
433553
+ description: "Title describing the task"
433115
433554
  },
433116
433555
  integrations: {
433117
433556
  type: "object",
@@ -433124,27 +433563,27 @@ var state = {
433124
433563
  name: {
433125
433564
  type: "string",
433126
433565
  maxLength: 200,
433127
- description: "Type of the [Message](#schema_message) represents the resource type that the message is related to"
433566
+ description: "Type of the task"
433128
433567
  },
433129
433568
  version: {
433130
433569
  type: "string",
433131
433570
  maxLength: 200,
433132
- description: "Type of the [Message](#schema_message) represents the resource type that the message is related to"
433571
+ description: "Type of the task"
433133
433572
  },
433134
433573
  webhookUrl: {
433135
433574
  type: "string",
433136
433575
  maxLength: 2e3,
433137
- description: "Signing secret of the [Bot](#schema_bot)"
433576
+ description: "Title describing the task"
433138
433577
  },
433139
433578
  webhookId: {
433140
433579
  type: "string",
433141
433580
  maxLength: 200,
433142
- description: "Type of the [Message](#schema_message) represents the resource type that the message is related to"
433581
+ description: "Type of the task"
433143
433582
  },
433144
433583
  identifier: {
433145
433584
  type: "string",
433146
433585
  maxLength: 2e3,
433147
- description: "Signing secret of the [Bot](#schema_bot)"
433586
+ description: "Title describing the task"
433148
433587
  },
433149
433588
  configuration: {
433150
433589
  type: "object",
@@ -433164,7 +433603,7 @@ var state = {
433164
433603
  statusReason: {
433165
433604
  type: "string",
433166
433605
  maxLength: 2e3,
433167
- description: "Signing secret of the [Bot](#schema_bot)",
433606
+ description: "Title describing the task",
433168
433607
  nullable: true
433169
433608
  },
433170
433609
  id: {
@@ -433384,7 +433823,7 @@ var state = {
433384
433823
  cron: {
433385
433824
  type: "string",
433386
433825
  maxLength: 200,
433387
- description: "Type of the [Message](#schema_message) represents the resource type that the message is related to"
433826
+ description: "Type of the task"
433388
433827
  }
433389
433828
  },
433390
433829
  required: ["cron"],
@@ -433393,7 +433832,7 @@ var state = {
433393
433832
  type: {
433394
433833
  type: "string",
433395
433834
  maxLength: 200,
433396
- description: "Type of the [Message](#schema_message) represents the resource type that the message is related to"
433835
+ description: "Type of the task"
433397
433836
  },
433398
433837
  payload: {
433399
433838
  type: "object",
@@ -433549,12 +433988,12 @@ var state = {
433549
433988
  name: {
433550
433989
  type: "string",
433551
433990
  maxLength: 200,
433552
- description: "Type of the [Message](#schema_message) represents the resource type that the message is related to"
433991
+ description: "Type of the task"
433553
433992
  },
433554
433993
  version: {
433555
433994
  type: "string",
433556
433995
  maxLength: 200,
433557
- description: "Type of the [Message](#schema_message) represents the resource type that the message is related to"
433996
+ description: "Type of the task"
433558
433997
  },
433559
433998
  configuration: {
433560
433999
  type: "object",
@@ -433565,7 +434004,7 @@ var state = {
433565
434004
  linkTemplateScript: {
433566
434005
  type: "string",
433567
434006
  maxLength: 2e3,
433568
- description: "Signing secret of the [Bot](#schema_bot)"
434007
+ description: "Title describing the task"
433569
434008
  },
433570
434009
  required: {
433571
434010
  type: "boolean"
@@ -433952,6 +434391,10 @@ var state = {
433952
434391
  },
433953
434392
  isPublic: {
433954
434393
  type: "boolean"
434394
+ },
434395
+ handle: {
434396
+ default: "",
434397
+ type: "string"
433955
434398
  }
433956
434399
  },
433957
434400
  required: [
@@ -434171,6 +434614,56 @@ var state = {
434171
434614
  additionalProperties: false
434172
434615
  }
434173
434616
  },
434617
+ Activity: {
434618
+ section: "activity",
434619
+ schema: {
434620
+ type: "object",
434621
+ properties: {
434622
+ id: {
434623
+ type: "string"
434624
+ },
434625
+ description: {
434626
+ type: "string"
434627
+ },
434628
+ taskId: {
434629
+ type: "string"
434630
+ },
434631
+ category: {
434632
+ type: "string",
434633
+ enum: [
434634
+ "unknown",
434635
+ "capture",
434636
+ "bot_message",
434637
+ "user_message",
434638
+ "agent_message",
434639
+ "event",
434640
+ "action",
434641
+ "task_status",
434642
+ "subtask_status",
434643
+ "exception"
434644
+ ]
434645
+ },
434646
+ data: {
434647
+ type: "object",
434648
+ additionalProperties: true
434649
+ },
434650
+ createdAt: {
434651
+ type: "string",
434652
+ format: "date-time",
434653
+ description: "Creation date of the activity in ISO 8601 format"
434654
+ }
434655
+ },
434656
+ required: [
434657
+ "id",
434658
+ "description",
434659
+ "taskId",
434660
+ "category",
434661
+ "data",
434662
+ "createdAt"
434663
+ ],
434664
+ additionalProperties: false
434665
+ }
434666
+ },
434174
434667
  User: {
434175
434668
  section: "user",
434176
434669
  schema: {
@@ -434226,6 +434719,12 @@ var state = {
434226
434719
  maxLength: 36,
434227
434720
  description: "ID of the [Conversation](#schema_conversation)"
434228
434721
  },
434722
+ currentTaskId: {
434723
+ type: "string",
434724
+ minLength: 28,
434725
+ maxLength: 36,
434726
+ description: "Id of the current [Task](#schema_task)"
434727
+ },
434229
434728
  createdAt: {
434230
434729
  type: "string",
434231
434730
  format: "date-time",
@@ -434283,7 +434782,7 @@ var state = {
434283
434782
  type: {
434284
434783
  type: "string",
434285
434784
  maxLength: 200,
434286
- description: "Type of the [Message](#schema_message) represents the resource type that the message is related to"
434785
+ description: "Type of the task"
434287
434786
  },
434288
434787
  payload: {
434289
434788
  type: "object",
@@ -434310,10 +434809,23 @@ var state = {
434310
434809
  },
434311
434810
  status: {
434312
434811
  type: "string",
434313
- description: "Status of the event (e.g. `ignored`, `processed`)"
434812
+ enum: ["pending", "processed", "ignored", "failed"]
434813
+ },
434814
+ failureReason: {
434815
+ type: "string",
434816
+ maxLength: 2e3,
434817
+ description: "Reason why the event failed to be processed",
434818
+ nullable: true
434314
434819
  }
434315
434820
  },
434316
- required: ["id", "createdAt", "type", "payload", "status"],
434821
+ required: [
434822
+ "id",
434823
+ "createdAt",
434824
+ "type",
434825
+ "payload",
434826
+ "status",
434827
+ "failureReason"
434828
+ ],
434317
434829
  description: "The event object represents an action or an occurrence.",
434318
434830
  additionalProperties: false
434319
434831
  }
@@ -434337,7 +434849,7 @@ var state = {
434337
434849
  type: {
434338
434850
  type: "string",
434339
434851
  maxLength: 200,
434340
- description: "Type of the [Message](#schema_message) represents the resource type that the message is related to"
434852
+ description: "Type of the task"
434341
434853
  },
434342
434854
  payload: {
434343
434855
  type: "object",
@@ -434425,7 +434937,7 @@ var state = {
434425
434937
  name: {
434426
434938
  type: "string",
434427
434939
  maxLength: 200,
434428
- description: "Type of the [Message](#schema_message) represents the resource type that the message is related to"
434940
+ description: "Type of the task"
434429
434941
  },
434430
434942
  type: {
434431
434943
  type: "string",
@@ -434451,6 +434963,112 @@ var state = {
434451
434963
  additionalProperties: false
434452
434964
  }
434453
434965
  },
434966
+ Task: {
434967
+ section: "task",
434968
+ schema: {
434969
+ type: "object",
434970
+ properties: {
434971
+ id: {
434972
+ type: "string",
434973
+ minLength: 28,
434974
+ maxLength: 36,
434975
+ description: "ID of the [Conversation](#schema_conversation)"
434976
+ },
434977
+ title: {
434978
+ type: "string",
434979
+ maxLength: 64,
434980
+ description: "Title describing the task"
434981
+ },
434982
+ description: {
434983
+ type: "string",
434984
+ maxLength: 256,
434985
+ description: "All the notes related to the execution of the current task"
434986
+ },
434987
+ type: {
434988
+ type: "string",
434989
+ description: "Type of the task"
434990
+ },
434991
+ data: {
434992
+ type: "object",
434993
+ additionalProperties: true,
434994
+ description: "Content related to the task"
434995
+ },
434996
+ status: {
434997
+ type: "string",
434998
+ enum: [
434999
+ "pending",
435000
+ "in_progress",
435001
+ "failed",
435002
+ "completed",
435003
+ "blocked",
435004
+ "paused",
435005
+ "timeout",
435006
+ "cancelled"
435007
+ ],
435008
+ description: "Status of the task"
435009
+ },
435010
+ parentTaskId: {
435011
+ type: "string",
435012
+ minLength: 28,
435013
+ maxLength: 36,
435014
+ description: "Parent task id is the parent task that created this task"
435015
+ },
435016
+ conversationId: {
435017
+ type: "string",
435018
+ minLength: 28,
435019
+ maxLength: 36,
435020
+ description: "Conversation id related to this task"
435021
+ },
435022
+ userId: {
435023
+ type: "string",
435024
+ minLength: 28,
435025
+ maxLength: 36,
435026
+ description: "Specific user related to this task"
435027
+ },
435028
+ timeoutAt: {
435029
+ type: "string",
435030
+ format: "date-time",
435031
+ description: "The timeout date where the task should be failed in the ISO 8601 format"
435032
+ },
435033
+ createdAt: {
435034
+ type: "string",
435035
+ format: "date-time",
435036
+ description: "Creation date of the task in ISO 8601 format"
435037
+ },
435038
+ updatedAt: {
435039
+ type: "string",
435040
+ format: "date-time",
435041
+ description: "Updating date of the task in ISO 8601 format"
435042
+ },
435043
+ failureReason: {
435044
+ type: "string",
435045
+ maxLength: 2e3,
435046
+ description: "If the task fails this is the reason behind it"
435047
+ },
435048
+ tags: {
435049
+ type: "object",
435050
+ additionalProperties: {
435051
+ type: "string"
435052
+ },
435053
+ description: "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them."
435054
+ }
435055
+ },
435056
+ required: [
435057
+ "id",
435058
+ "title",
435059
+ "description",
435060
+ "type",
435061
+ "data",
435062
+ "status",
435063
+ "timeoutAt",
435064
+ "createdAt",
435065
+ "updatedAt",
435066
+ "tags"
435067
+ ],
435068
+ description: "Task definition",
435069
+ additionalProperties: false
435070
+ }
435071
+ },
434454
435072
  File: {
434455
435073
  section: "file",
434456
435074
  schema: {
@@ -434511,53 +435129,75 @@ var state = {
434511
435129
  maximum: 30,
434512
435130
  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."
434513
435131
  },
434514
- columns: {
434515
- type: "array",
434516
- items: {
434517
- type: "object",
435132
+ schema: {
435133
+ type: "object",
435134
+ properties: {
435135
+ $schema: {
435136
+ type: "string"
435137
+ },
434518
435138
  properties: {
434519
- id: {
434520
- type: "string",
434521
- description: "Unique identifier for the column."
434522
- },
434523
- name: {
434524
- type: "string",
434525
- minLength: 1,
434526
- maxLength: 30,
434527
- description: "Name of the column, must be within length limits."
434528
- },
434529
- description: {
434530
- type: "string",
434531
- description: "Optional descriptive text about the column."
434532
- },
434533
- searchable: {
434534
- type: "boolean",
434535
- description: "Indicates if the column is vectorized and searchable."
434536
- },
434537
- type: {
434538
- type: "string",
434539
- enum: ["string", "number", "boolean", "date", "object"],
434540
- description: 'Specifies the data type of the column. Use "object" for complex data structures.'
435139
+ type: "object",
435140
+ additionalProperties: {
435141
+ type: "object",
435142
+ properties: {
435143
+ type: {
435144
+ type: "string",
435145
+ enum: ["string", "number", "boolean", "object", "null"]
435146
+ },
435147
+ format: {
435148
+ type: "string",
435149
+ enum: ["date-time"]
435150
+ },
435151
+ description: {
435152
+ type: "string"
435153
+ },
435154
+ nullable: {
435155
+ default: true,
435156
+ type: "boolean"
435157
+ },
435158
+ "x-zui": {
435159
+ type: "object",
435160
+ properties: {
435161
+ index: {
435162
+ type: "integer"
435163
+ },
435164
+ searchable: {
435165
+ type: "boolean",
435166
+ description: "Indicates if the column is vectorized and searchable."
435167
+ },
435168
+ typings: {
435169
+ type: "string",
435170
+ description: 'TypeScript typings for the column. Recommended if the type is "object", ex: "\\{ foo: string; bar: number \\}"'
435171
+ }
435172
+ },
435173
+ required: ["index"],
435174
+ additionalProperties: false
435175
+ }
435176
+ },
435177
+ required: ["type", "x-zui"],
435178
+ additionalProperties: false
434541
435179
  },
434542
- typings: {
434543
- type: "string",
434544
- description: 'TypeScript typings for the column. Recommended if the type is "object", ex: "\\{ foo: string; bar: number \\}"'
435180
+ description: "List of keys/columns in the table."
435181
+ },
435182
+ additionalProperties: {
435183
+ type: "boolean",
435184
+ enum: [true],
435185
+ description: "Additional properties can be provided, but they will be ignored if no column matches."
435186
+ },
435187
+ required: {
435188
+ type: "array",
435189
+ items: {
435190
+ type: "string"
434545
435191
  },
434546
- schema: {
434547
- type: "object",
434548
- properties: {},
434549
- additionalProperties: true
434550
- }
435192
+ description: "Array of required properties."
434551
435193
  },
434552
- required: ["name", "type"]
435194
+ type: {
435195
+ type: "string",
435196
+ enum: ["object"]
435197
+ }
434553
435198
  },
434554
- maxItems: 20,
434555
- description: "Array of columns in the table."
434556
- },
434557
- schema: {
434558
- type: "object",
434559
- additionalProperties: true,
434560
- description: "Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed."
435199
+ required: ["$schema", "properties", "additionalProperties", "type"],
435200
+ additionalProperties: false
434561
435201
  },
434562
435202
  tags: {
434563
435203
  type: "object",
@@ -434575,7 +435215,7 @@ var state = {
434575
435215
  description: "Timestamp of the last table update."
434576
435216
  }
434577
435217
  },
434578
- required: ["id", "name", "columns", "schema"],
435218
+ required: ["id", "name", "schema"],
434579
435219
  additionalProperties: false
434580
435220
  }
434581
435221
  },
@@ -434737,6 +435377,19 @@ var state = {
434737
435377
  name: "action",
434738
435378
  operations: ["callAction"]
434739
435379
  },
435380
+ {
435381
+ description: "",
435382
+ title: "Task",
435383
+ name: "task",
435384
+ operations: [
435385
+ "getTask",
435386
+ "createTask",
435387
+ "updateTask",
435388
+ "deleteTask",
435389
+ "listTasks"
435390
+ ],
435391
+ schema: "Task"
435392
+ },
434740
435393
  {
434741
435394
  title: "Bot",
434742
435395
  description: "",
@@ -434789,6 +435442,7 @@ var state = {
434789
435442
  "getWorkspaceQuota",
434790
435443
  "listWorkspaceQuotas",
434791
435444
  "updateWorkspace",
435445
+ "checkHandleAvailability",
434792
435446
  "listWorkspaces",
434793
435447
  "changeWorkspacePlan",
434794
435448
  "deleteWorkspace",
@@ -434841,6 +435495,13 @@ var state = {
434841
435495
  name: "helper",
434842
435496
  operations: ["runVrl"]
434843
435497
  },
435498
+ {
435499
+ title: "Activity",
435500
+ description: "",
435501
+ name: "activity",
435502
+ operations: ["listActivities"],
435503
+ schema: "Activity"
435504
+ },
434844
435505
  {
434845
435506
  title: "Tables",
434846
435507
  description: "Operations related to table management.",