@botpress/api 0.12.2 → 0.12.5

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 (5) hide show
  1. package/dist/gen/state.d.ts +77 -0
  2. package/dist/index.js +79 -2
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +83 -1
package/src/gen/state.ts CHANGED
@@ -312,6 +312,21 @@ export const state = {
312
312
  "Schedule the Event to be sent at a specific time. Either dateTime or delay must be provided.",
313
313
  additionalProperties: false,
314
314
  },
315
+ conversationId: {
316
+ type: "string",
317
+ description:
318
+ "ID of the [Conversation](#schema_conversation) to link the event to.",
319
+ },
320
+ userId: {
321
+ type: "string",
322
+ description:
323
+ "ID of the [User](#schema_user) to link the event to.",
324
+ },
325
+ messageId: {
326
+ type: "string",
327
+ description:
328
+ "ID of the [Message](#schema_message) to link the event to.",
329
+ },
315
330
  },
316
331
  required: ["type", "payload"],
317
332
  title: "createEventBody",
@@ -385,6 +400,21 @@ export const state = {
385
400
  type: "string",
386
401
  description: "Filter by event type",
387
402
  },
403
+ conversationId: {
404
+ in: "query",
405
+ type: "string",
406
+ description: "Filter by conversation id",
407
+ },
408
+ userId: {
409
+ in: "query",
410
+ type: "string",
411
+ description: "Filter by user id",
412
+ },
413
+ messageId: {
414
+ in: "query",
415
+ type: "string",
416
+ description: "Filter by message id",
417
+ },
388
418
  },
389
419
  response: {
390
420
  description: "Returns a list of [Event](#schema_event) objects",
@@ -763,6 +793,14 @@ export const state = {
763
793
  description:
764
794
  "Name of the integration to which the user creation will be delegated",
765
795
  },
796
+ name: {
797
+ type: "string",
798
+ description: "Name of the user",
799
+ },
800
+ pictureUrl: {
801
+ type: "string",
802
+ description: "URL of the user picture",
803
+ },
766
804
  },
767
805
  required: ["tags"],
768
806
  title: "createUserBody",
@@ -903,6 +941,14 @@ export const state = {
903
941
  description:
904
942
  "Name of the integration to which the user creation will be delegated",
905
943
  },
944
+ name: {
945
+ type: "string",
946
+ description: "Name of the user",
947
+ },
948
+ pictureUrl: {
949
+ type: "string",
950
+ description: "URL of the user picture",
951
+ },
906
952
  },
907
953
  required: ["tags"],
908
954
  title: "getOrCreateUserBody",
@@ -949,9 +995,20 @@ export const state = {
949
995
  type: "object",
950
996
  additionalProperties: {
951
997
  type: "string",
998
+ maxLength: 500,
952
999
  },
953
1000
  description: "Tags for the [User](#schema_user)",
954
1001
  },
1002
+ name: {
1003
+ type: "string",
1004
+ nullable: true,
1005
+ description: "Name of the user",
1006
+ },
1007
+ pictureUrl: {
1008
+ type: "string",
1009
+ nullable: true,
1010
+ description: "URL of the user picture",
1011
+ },
955
1012
  },
956
1013
  required: ["tags"],
957
1014
  title: "updateUserBody",
@@ -5310,7 +5367,7 @@ export const state = {
5310
5367
  title: "Botpress API",
5311
5368
  description: "API for Botpress Cloud",
5312
5369
  server: "https://api.botpress.cloud",
5313
- version: "0.12.2",
5370
+ version: "0.12.5",
5314
5371
  prefix: "v1",
5315
5372
  },
5316
5373
  errors: [
@@ -5609,6 +5666,9 @@ export const state = {
5609
5666
  webhookId: {
5610
5667
  type: "string",
5611
5668
  },
5669
+ identifier: {
5670
+ type: "string",
5671
+ },
5612
5672
  configuration: {
5613
5673
  type: "object",
5614
5674
  additionalProperties: true,
@@ -6588,6 +6648,14 @@ export const state = {
6588
6648
  description:
6589
6649
  "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [User](#schema_user). The set of [Tags](/docs/developers/concepts/tags) available on a [User](#schema_user) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
6590
6650
  },
6651
+ name: {
6652
+ type: "string",
6653
+ description: "Name of the [User](#schema_user)",
6654
+ },
6655
+ pictureUrl: {
6656
+ type: "string",
6657
+ description: "Picture URL of the [User](#schema_user)",
6658
+ },
6591
6659
  },
6592
6660
  required: ["id", "createdAt", "updatedAt", "tags"],
6593
6661
  description:
@@ -6673,6 +6741,20 @@ export const state = {
6673
6741
  description:
6674
6742
  "Payload is the content of the event defined by the integration installed on your bot or one of the default events created by our api.",
6675
6743
  },
6744
+ conversationId: {
6745
+ type: "string",
6746
+ description:
6747
+ "ID of the [Conversation](#schema_conversation) to link the event to.",
6748
+ },
6749
+ userId: {
6750
+ type: "string",
6751
+ description: "ID of the [User](#schema_user) to link the event to.",
6752
+ },
6753
+ messageId: {
6754
+ type: "string",
6755
+ description:
6756
+ "ID of the [Message](#schema_message) to link the event to.",
6757
+ },
6676
6758
  },
6677
6759
  required: ["id", "createdAt", "type", "payload"],
6678
6760
  description: "The event object represents an action or an occurrence.",