@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/dist/index.js CHANGED
@@ -427103,6 +427103,9 @@ var state = {
427103
427103
  schema: {
427104
427104
  type: "object",
427105
427105
  properties: {
427106
+ currentTaskId: {
427107
+ type: "string"
427108
+ },
427106
427109
  tags: {
427107
427110
  type: "object",
427108
427111
  additionalProperties: {
@@ -427111,7 +427114,6 @@ var state = {
427111
427114
  description: "Tags for the [Conversation](#schema_conversation)"
427112
427115
  }
427113
427116
  },
427114
- required: ["tags"],
427115
427117
  title: "updateConversationBody",
427116
427118
  additionalProperties: false
427117
427119
  }
@@ -428076,7 +428078,7 @@ var state = {
428076
428078
  in: "path",
428077
428079
  type: "string",
428078
428080
  description: "State type",
428079
- enum: ["conversation", "user", "bot", "integration"]
428081
+ enum: ["conversation", "user", "bot", "integration", "task"]
428080
428082
  },
428081
428083
  id: {
428082
428084
  in: "path",
@@ -428115,7 +428117,7 @@ var state = {
428115
428117
  in: "path",
428116
428118
  type: "string",
428117
428119
  description: "State type",
428118
- enum: ["conversation", "user", "bot", "integration"]
428120
+ enum: ["conversation", "user", "bot", "integration", "task"]
428119
428121
  },
428120
428122
  id: {
428121
428123
  in: "path",
@@ -428177,7 +428179,7 @@ var state = {
428177
428179
  in: "path",
428178
428180
  type: "string",
428179
428181
  description: "State type",
428180
- enum: ["conversation", "user", "bot", "integration"]
428182
+ enum: ["conversation", "user", "bot", "integration", "task"]
428181
428183
  },
428182
428184
  id: {
428183
428185
  in: "path",
@@ -429060,8 +429062,8 @@ var state = {
429060
429062
  properties: {
429061
429063
  type: {
429062
429064
  type: "string",
429063
- enum: ["conversation", "user", "bot"],
429064
- description: "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
429065
+ enum: ["conversation", "user", "bot", "task"],
429066
+ description: "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
429065
429067
  },
429066
429068
  schema: {
429067
429069
  type: "object",
@@ -429467,8 +429469,8 @@ var state = {
429467
429469
  properties: {
429468
429470
  type: {
429469
429471
  type: "string",
429470
- enum: ["conversation", "user", "bot"],
429471
- description: "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
429472
+ enum: ["conversation", "user", "bot", "task"],
429473
+ description: "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
429472
429474
  },
429473
429475
  schema: {
429474
429476
  type: "object",
@@ -431998,6 +432000,31 @@ var state = {
431998
432000
  additionalProperties: false
431999
432001
  }
432000
432002
  },
432003
+ entities: {
432004
+ type: "object",
432005
+ additionalProperties: {
432006
+ type: "object",
432007
+ properties: {
432008
+ title: {
432009
+ type: "string",
432010
+ maxLength: 64,
432011
+ description: "Title of the entity"
432012
+ },
432013
+ description: {
432014
+ type: "string",
432015
+ maxLength: 256,
432016
+ description: "Description of the entity"
432017
+ },
432018
+ schema: {
432019
+ type: "object",
432020
+ additionalProperties: true
432021
+ }
432022
+ },
432023
+ required: ["schema"],
432024
+ description: "Entity definition",
432025
+ additionalProperties: false
432026
+ }
432027
+ },
432001
432028
  identifier: {
432002
432029
  type: "object",
432003
432030
  properties: {
@@ -432534,6 +432561,32 @@ var state = {
432534
432561
  },
432535
432562
  additionalProperties: false
432536
432563
  },
432564
+ entities: {
432565
+ type: "object",
432566
+ additionalProperties: {
432567
+ type: "object",
432568
+ properties: {
432569
+ title: {
432570
+ type: "string",
432571
+ maxLength: 64,
432572
+ description: "Title of the entity"
432573
+ },
432574
+ description: {
432575
+ type: "string",
432576
+ maxLength: 256,
432577
+ description: "Description of the entity"
432578
+ },
432579
+ schema: {
432580
+ type: "object",
432581
+ additionalProperties: true
432582
+ }
432583
+ },
432584
+ required: ["schema"],
432585
+ description: "Entity definition",
432586
+ nullable: true,
432587
+ additionalProperties: false
432588
+ }
432589
+ },
432537
432590
  secrets: {
432538
432591
  type: "object",
432539
432592
  additionalProperties: {
@@ -433256,7 +433309,7 @@ var state = {
433256
433309
  title: "Botpress API",
433257
433310
  description: "API for Botpress Cloud",
433258
433311
  server: "https://api.botpress.cloud",
433259
- version: "0.16.3",
433312
+ version: "0.17.0",
433260
433313
  prefix: "v1"
433261
433314
  },
433262
433315
  errors: [
@@ -433749,8 +433802,8 @@ var state = {
433749
433802
  properties: {
433750
433803
  type: {
433751
433804
  type: "string",
433752
- enum: ["conversation", "user", "bot"],
433753
- description: "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
433805
+ enum: ["conversation", "user", "bot", "task"],
433806
+ description: "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
433754
433807
  },
433755
433808
  schema: {
433756
433809
  type: "object",
@@ -434271,6 +434324,31 @@ var state = {
434271
434324
  description: "User object configuration",
434272
434325
  additionalProperties: false
434273
434326
  },
434327
+ entities: {
434328
+ type: "object",
434329
+ additionalProperties: {
434330
+ type: "object",
434331
+ properties: {
434332
+ title: {
434333
+ type: "string",
434334
+ maxLength: 64,
434335
+ description: "Title of the entity"
434336
+ },
434337
+ description: {
434338
+ type: "string",
434339
+ maxLength: 256,
434340
+ description: "Description of the entity"
434341
+ },
434342
+ schema: {
434343
+ type: "object",
434344
+ additionalProperties: true
434345
+ }
434346
+ },
434347
+ required: ["schema"],
434348
+ description: "Entity definition",
434349
+ additionalProperties: false
434350
+ }
434351
+ },
434274
434352
  dev: {
434275
434353
  type: "boolean",
434276
434354
  description: "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -434315,6 +434393,7 @@ var state = {
434315
434393
  "events",
434316
434394
  "actions",
434317
434395
  "user",
434396
+ "entities",
434318
434397
  "dev",
434319
434398
  "title",
434320
434399
  "description",
@@ -434941,8 +435020,8 @@ var state = {
434941
435020
  },
434942
435021
  type: {
434943
435022
  type: "string",
434944
- enum: ["conversation", "user", "bot", "integration"],
434945
- description: "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot` or `integration`) that the state is related to"
435023
+ enum: ["conversation", "user", "bot", "task", "integration"],
435024
+ description: "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to"
434946
435025
  },
434947
435026
  payload: {
434948
435027
  type: "object",
@@ -435161,6 +435240,10 @@ var state = {
435161
435240
  index: {
435162
435241
  type: "integer"
435163
435242
  },
435243
+ id: {
435244
+ type: "string",
435245
+ description: "[deprecated] ID of the column."
435246
+ },
435164
435247
  searchable: {
435165
435248
  type: "boolean",
435166
435249
  description: "Indicates if the column is vectorized and searchable."
@@ -209,6 +209,9 @@ export declare const state: {
209
209
  schema: {
210
210
  type: "object";
211
211
  properties: {
212
+ currentTaskId: {
213
+ type: "string";
214
+ };
212
215
  tags: {
213
216
  type: "object";
214
217
  additionalProperties: {
@@ -217,7 +220,6 @@ export declare const state: {
217
220
  description: string;
218
221
  };
219
222
  };
220
- required: string[];
221
223
  title: string;
222
224
  additionalProperties: false;
223
225
  };
@@ -4827,6 +4829,31 @@ export declare const state: {
4827
4829
  additionalProperties: false;
4828
4830
  };
4829
4831
  };
4832
+ entities: {
4833
+ type: "object";
4834
+ additionalProperties: {
4835
+ type: "object";
4836
+ properties: {
4837
+ title: {
4838
+ type: "string";
4839
+ maxLength: number;
4840
+ description: string;
4841
+ };
4842
+ description: {
4843
+ type: "string";
4844
+ maxLength: number;
4845
+ description: string;
4846
+ };
4847
+ schema: {
4848
+ type: "object";
4849
+ additionalProperties: true;
4850
+ };
4851
+ };
4852
+ required: string[];
4853
+ description: string;
4854
+ additionalProperties: false;
4855
+ };
4856
+ };
4830
4857
  identifier: {
4831
4858
  type: "object";
4832
4859
  properties: {
@@ -5363,6 +5390,32 @@ export declare const state: {
5363
5390
  };
5364
5391
  additionalProperties: false;
5365
5392
  };
5393
+ entities: {
5394
+ type: "object";
5395
+ additionalProperties: {
5396
+ type: "object";
5397
+ properties: {
5398
+ title: {
5399
+ type: "string";
5400
+ maxLength: number;
5401
+ description: string;
5402
+ };
5403
+ description: {
5404
+ type: "string";
5405
+ maxLength: number;
5406
+ description: string;
5407
+ };
5408
+ schema: {
5409
+ type: "object";
5410
+ additionalProperties: true;
5411
+ };
5412
+ };
5413
+ required: string[];
5414
+ description: string;
5415
+ nullable: true;
5416
+ additionalProperties: false;
5417
+ };
5418
+ };
5366
5419
  secrets: {
5367
5420
  type: "object";
5368
5421
  additionalProperties: {
@@ -6954,6 +7007,31 @@ export declare const state: {
6954
7007
  description: string;
6955
7008
  additionalProperties: false;
6956
7009
  };
7010
+ entities: {
7011
+ type: "object";
7012
+ additionalProperties: {
7013
+ type: "object";
7014
+ properties: {
7015
+ title: {
7016
+ type: "string";
7017
+ maxLength: number;
7018
+ description: string;
7019
+ };
7020
+ description: {
7021
+ type: "string";
7022
+ maxLength: number;
7023
+ description: string;
7024
+ };
7025
+ schema: {
7026
+ type: "object";
7027
+ additionalProperties: true;
7028
+ };
7029
+ };
7030
+ required: string[];
7031
+ description: string;
7032
+ additionalProperties: false;
7033
+ };
7034
+ };
6957
7035
  dev: {
6958
7036
  type: "boolean";
6959
7037
  description: string;
@@ -7712,6 +7790,10 @@ export declare const state: {
7712
7790
  index: {
7713
7791
  type: "integer";
7714
7792
  };
7793
+ id: {
7794
+ type: "string";
7795
+ description: string;
7796
+ };
7715
7797
  searchable: {
7716
7798
  type: "boolean";
7717
7799
  description: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.16.3",
3
+ "version": "0.17.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {