@botpress/api 0.16.3 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/gen/state.ts CHANGED
@@ -267,6 +267,9 @@ export const state = {
267
267
  schema: {
268
268
  type: "object",
269
269
  properties: {
270
+ currentTaskId: {
271
+ type: "string",
272
+ },
270
273
  tags: {
271
274
  type: "object",
272
275
  additionalProperties: {
@@ -275,7 +278,6 @@ export const state = {
275
278
  description: "Tags for the [Conversation](#schema_conversation)",
276
279
  },
277
280
  },
278
- required: ["tags"],
279
281
  title: "updateConversationBody",
280
282
  additionalProperties: false,
281
283
  },
@@ -1305,7 +1307,7 @@ export const state = {
1305
1307
  in: "path",
1306
1308
  type: "string",
1307
1309
  description: "State type",
1308
- enum: ["conversation", "user", "bot", "integration"],
1310
+ enum: ["conversation", "user", "bot", "integration", "task"],
1309
1311
  },
1310
1312
  id: {
1311
1313
  in: "path",
@@ -1346,7 +1348,7 @@ export const state = {
1346
1348
  in: "path",
1347
1349
  type: "string",
1348
1350
  description: "State type",
1349
- enum: ["conversation", "user", "bot", "integration"],
1351
+ enum: ["conversation", "user", "bot", "integration", "task"],
1350
1352
  },
1351
1353
  id: {
1352
1354
  in: "path",
@@ -1412,7 +1414,7 @@ export const state = {
1412
1414
  in: "path",
1413
1415
  type: "string",
1414
1416
  description: "State type",
1415
- enum: ["conversation", "user", "bot", "integration"],
1417
+ enum: ["conversation", "user", "bot", "integration", "task"],
1416
1418
  },
1417
1419
  id: {
1418
1420
  in: "path",
@@ -2329,9 +2331,9 @@ export const state = {
2329
2331
  properties: {
2330
2332
  type: {
2331
2333
  type: "string",
2332
- enum: ["conversation", "user", "bot"],
2334
+ enum: ["conversation", "user", "bot", "task"],
2333
2335
  description:
2334
- "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)",
2336
+ "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)",
2335
2337
  },
2336
2338
  schema: {
2337
2339
  type: "object",
@@ -2756,9 +2758,9 @@ export const state = {
2756
2758
  properties: {
2757
2759
  type: {
2758
2760
  type: "string",
2759
- enum: ["conversation", "user", "bot"],
2761
+ enum: ["conversation", "user", "bot", "task"],
2760
2762
  description:
2761
- "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)",
2763
+ "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)",
2762
2764
  },
2763
2765
  schema: {
2764
2766
  type: "object",
@@ -5324,6 +5326,31 @@ export const state = {
5324
5326
  additionalProperties: false,
5325
5327
  },
5326
5328
  },
5329
+ entities: {
5330
+ type: "object",
5331
+ additionalProperties: {
5332
+ type: "object",
5333
+ properties: {
5334
+ title: {
5335
+ type: "string",
5336
+ maxLength: 64,
5337
+ description: "Title of the entity",
5338
+ },
5339
+ description: {
5340
+ type: "string",
5341
+ maxLength: 256,
5342
+ description: "Description of the entity",
5343
+ },
5344
+ schema: {
5345
+ type: "object",
5346
+ additionalProperties: true,
5347
+ },
5348
+ },
5349
+ required: ["schema"],
5350
+ description: "Entity definition",
5351
+ additionalProperties: false,
5352
+ },
5353
+ },
5327
5354
  identifier: {
5328
5355
  type: "object",
5329
5356
  properties: {
@@ -5884,6 +5911,32 @@ export const state = {
5884
5911
  },
5885
5912
  additionalProperties: false,
5886
5913
  },
5914
+ entities: {
5915
+ type: "object",
5916
+ additionalProperties: {
5917
+ type: "object",
5918
+ properties: {
5919
+ title: {
5920
+ type: "string",
5921
+ maxLength: 64,
5922
+ description: "Title of the entity",
5923
+ },
5924
+ description: {
5925
+ type: "string",
5926
+ maxLength: 256,
5927
+ description: "Description of the entity",
5928
+ },
5929
+ schema: {
5930
+ type: "object",
5931
+ additionalProperties: true,
5932
+ },
5933
+ },
5934
+ required: ["schema"],
5935
+ description: "Entity definition",
5936
+ nullable: true,
5937
+ additionalProperties: false,
5938
+ },
5939
+ },
5887
5940
  secrets: {
5888
5941
  type: "object",
5889
5942
  additionalProperties: {
@@ -6631,7 +6684,7 @@ export const state = {
6631
6684
  title: "Botpress API",
6632
6685
  description: "API for Botpress Cloud",
6633
6686
  server: "https://api.botpress.cloud",
6634
- version: "0.16.3",
6687
+ version: "0.17.0",
6635
6688
  prefix: "v1",
6636
6689
  },
6637
6690
  errors: [
@@ -7143,9 +7196,9 @@ export const state = {
7143
7196
  properties: {
7144
7197
  type: {
7145
7198
  type: "string",
7146
- enum: ["conversation", "user", "bot"],
7199
+ enum: ["conversation", "user", "bot", "task"],
7147
7200
  description:
7148
- "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)",
7201
+ "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)",
7149
7202
  },
7150
7203
  schema: {
7151
7204
  type: "object",
@@ -7691,6 +7744,31 @@ export const state = {
7691
7744
  description: "User object configuration",
7692
7745
  additionalProperties: false,
7693
7746
  },
7747
+ entities: {
7748
+ type: "object",
7749
+ additionalProperties: {
7750
+ type: "object",
7751
+ properties: {
7752
+ title: {
7753
+ type: "string",
7754
+ maxLength: 64,
7755
+ description: "Title of the entity",
7756
+ },
7757
+ description: {
7758
+ type: "string",
7759
+ maxLength: 256,
7760
+ description: "Description of the entity",
7761
+ },
7762
+ schema: {
7763
+ type: "object",
7764
+ additionalProperties: true,
7765
+ },
7766
+ },
7767
+ required: ["schema"],
7768
+ description: "Entity definition",
7769
+ additionalProperties: false,
7770
+ },
7771
+ },
7694
7772
  dev: {
7695
7773
  type: "boolean",
7696
7774
  description:
@@ -7741,6 +7819,7 @@ export const state = {
7741
7819
  "events",
7742
7820
  "actions",
7743
7821
  "user",
7822
+ "entities",
7744
7823
  "dev",
7745
7824
  "title",
7746
7825
  "description",
@@ -8389,9 +8468,9 @@ export const state = {
8389
8468
  },
8390
8469
  type: {
8391
8470
  type: "string",
8392
- enum: ["conversation", "user", "bot", "integration"],
8471
+ enum: ["conversation", "user", "bot", "task", "integration"],
8393
8472
  description:
8394
- "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot` or `integration`) that the state is related to",
8473
+ "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to",
8395
8474
  },
8396
8475
  payload: {
8397
8476
  type: "object",
@@ -8620,6 +8699,10 @@ export const state = {
8620
8699
  index: {
8621
8700
  type: "integer",
8622
8701
  },
8702
+ id: {
8703
+ type: "string",
8704
+ description: "[deprecated] ID of the column.",
8705
+ },
8623
8706
  searchable: {
8624
8707
  type: "boolean",
8625
8708
  description: