@botpress/client 1.24.1 → 1.24.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.
package/dist/index.d.ts CHANGED
@@ -588,6 +588,10 @@ interface CreateEventRequestBody$1 {
588
588
  * ID of the [User](#schema_user) to link the event to.
589
589
  */
590
590
  userId?: string;
591
+ /**
592
+ * ID of the [Workflow](#schema_workflow) to link the event to.
593
+ */
594
+ workflowId?: string;
591
595
  /**
592
596
  * ID of the [Message](#schema_message) to link the event to.
593
597
  */
@@ -698,6 +702,7 @@ interface ListEventsRequestQuery$1 {
698
702
  conversationId?: string;
699
703
  userId?: string;
700
704
  messageId?: string;
705
+ workflowId?: string;
701
706
  status?: "pending" | "ignored" | "processed" | "failed" | "scheduled";
702
707
  }
703
708
  interface ListEventsRequestParams$1 {
@@ -2903,6 +2908,7 @@ declare class Client$8 extends Client$9 {
2903
2908
  type?: string | undefined;
2904
2909
  userId?: string | undefined;
2905
2910
  conversationId?: string | undefined;
2911
+ workflowId?: string | undefined;
2906
2912
  messageId?: string | undefined;
2907
2913
  status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
2908
2914
  }) => AsyncCollection<{
@@ -5445,7 +5451,7 @@ interface CreateBotResponse$1 {
5445
5451
  */
5446
5452
  signingSecret: string;
5447
5453
  /**
5448
- * A mapping of integrations to their configuration
5454
+ * 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.
5449
5455
  */
5450
5456
  integrations: {
5451
5457
  [k: string]: {
@@ -6076,7 +6082,7 @@ interface UpdateBotResponse$1 {
6076
6082
  */
6077
6083
  signingSecret: string;
6078
6084
  /**
6079
- * A mapping of integrations to their configuration
6085
+ * 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.
6080
6086
  */
6081
6087
  integrations: {
6082
6088
  [k: string]: {
@@ -6539,7 +6545,7 @@ interface GetBotResponse$1 {
6539
6545
  */
6540
6546
  signingSecret: string;
6541
6547
  /**
6542
- * A mapping of integrations to their configuration
6548
+ * 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.
6543
6549
  */
6544
6550
  integrations: {
6545
6551
  [k: string]: {
@@ -14646,6 +14652,10 @@ interface UpsertFileResponse$1 {
14646
14652
  */
14647
14653
  name?: string;
14648
14654
  };
14655
+ /**
14656
+ * 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.
14657
+ */
14658
+ indexingStack?: "v1" | "v2";
14649
14659
  /**
14650
14660
  * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
14651
14661
  */
@@ -14768,6 +14778,10 @@ interface ListFilesResponse$1 {
14768
14778
  */
14769
14779
  name?: string;
14770
14780
  };
14781
+ /**
14782
+ * 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.
14783
+ */
14784
+ indexingStack?: "v1" | "v2";
14771
14785
  }[];
14772
14786
  meta: {
14773
14787
  /**
@@ -14872,6 +14886,10 @@ interface GetFileResponse$1 {
14872
14886
  */
14873
14887
  name?: string;
14874
14888
  };
14889
+ /**
14890
+ * 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.
14891
+ */
14892
+ indexingStack?: "v1" | "v2";
14875
14893
  };
14876
14894
  }
14877
14895
 
@@ -14990,6 +15008,10 @@ interface UpdateFileMetadataResponse$1 {
14990
15008
  */
14991
15009
  name?: string;
14992
15010
  };
15011
+ /**
15012
+ * 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.
15013
+ */
15014
+ indexingStack?: "v1" | "v2";
14993
15015
  };
14994
15016
  }
14995
15017
 
@@ -15096,6 +15118,10 @@ interface CopyFileResponse$1 {
15096
15118
  */
15097
15119
  name?: string;
15098
15120
  };
15121
+ /**
15122
+ * 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.
15123
+ */
15124
+ indexingStack?: "v1" | "v2";
15099
15125
  };
15100
15126
  }
15101
15127
 
@@ -15518,6 +15544,7 @@ declare class Client$4 extends Client$5 implements IClient$2 {
15518
15544
  id?: string;
15519
15545
  name?: string;
15520
15546
  };
15547
+ indexingStack?: "v1" | "v2";
15521
15548
  }>;
15522
15549
  filePassages: (props: {
15523
15550
  id: string;
@@ -17778,6 +17805,10 @@ interface CreateEventRequestBody {
17778
17805
  * ID of the [User](#schema_user) to link the event to.
17779
17806
  */
17780
17807
  userId?: string;
17808
+ /**
17809
+ * ID of the [Workflow](#schema_workflow) to link the event to.
17810
+ */
17811
+ workflowId?: string;
17781
17812
  /**
17782
17813
  * ID of the [Message](#schema_message) to link the event to.
17783
17814
  */
@@ -17888,6 +17919,7 @@ interface ListEventsRequestQuery {
17888
17919
  conversationId?: string;
17889
17920
  userId?: string;
17890
17921
  messageId?: string;
17922
+ workflowId?: string;
17891
17923
  status?: "pending" | "ignored" | "processed" | "failed" | "scheduled";
17892
17924
  }
17893
17925
  interface ListEventsRequestParams {
@@ -22427,7 +22459,7 @@ interface CreateBotResponse {
22427
22459
  */
22428
22460
  signingSecret: string;
22429
22461
  /**
22430
- * A mapping of integrations to their configuration
22462
+ * 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.
22431
22463
  */
22432
22464
  integrations: {
22433
22465
  [k: string]: {
@@ -23058,7 +23090,7 @@ interface UpdateBotResponse {
23058
23090
  */
23059
23091
  signingSecret: string;
23060
23092
  /**
23061
- * A mapping of integrations to their configuration
23093
+ * 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.
23062
23094
  */
23063
23095
  integrations: {
23064
23096
  [k: string]: {
@@ -23521,7 +23553,7 @@ interface GetBotResponse {
23521
23553
  */
23522
23554
  signingSecret: string;
23523
23555
  /**
23524
- * A mapping of integrations to their configuration
23556
+ * 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.
23525
23557
  */
23526
23558
  integrations: {
23527
23559
  [k: string]: {
@@ -31288,6 +31320,10 @@ interface UpsertFileResponse {
31288
31320
  */
31289
31321
  name?: string;
31290
31322
  };
31323
+ /**
31324
+ * 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.
31325
+ */
31326
+ indexingStack?: "v1" | "v2";
31291
31327
  /**
31292
31328
  * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
31293
31329
  */
@@ -31410,6 +31446,10 @@ interface ListFilesResponse {
31410
31446
  */
31411
31447
  name?: string;
31412
31448
  };
31449
+ /**
31450
+ * 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.
31451
+ */
31452
+ indexingStack?: "v1" | "v2";
31413
31453
  }[];
31414
31454
  meta: {
31415
31455
  /**
@@ -31514,6 +31554,10 @@ interface GetFileResponse {
31514
31554
  */
31515
31555
  name?: string;
31516
31556
  };
31557
+ /**
31558
+ * 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.
31559
+ */
31560
+ indexingStack?: "v1" | "v2";
31517
31561
  };
31518
31562
  }
31519
31563
 
@@ -31632,6 +31676,10 @@ interface UpdateFileMetadataResponse {
31632
31676
  */
31633
31677
  name?: string;
31634
31678
  };
31679
+ /**
31680
+ * 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.
31681
+ */
31682
+ indexingStack?: "v1" | "v2";
31635
31683
  };
31636
31684
  }
31637
31685
 
@@ -31738,6 +31786,10 @@ interface CopyFileResponse {
31738
31786
  */
31739
31787
  name?: string;
31740
31788
  };
31789
+ /**
31790
+ * 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.
31791
+ */
31792
+ indexingStack?: "v1" | "v2";
31741
31793
  };
31742
31794
  }
31743
31795
 
@@ -33727,7 +33779,7 @@ interface Bot {
33727
33779
  */
33728
33780
  signingSecret: string;
33729
33781
  /**
33730
- * A mapping of integrations to their configuration
33782
+ * 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.
33731
33783
  */
33732
33784
  integrations: {
33733
33785
  [k: string]: {
@@ -35566,6 +35618,10 @@ interface File {
35566
35618
  */
35567
35619
  name?: string;
35568
35620
  };
35621
+ /**
35622
+ * 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.
35623
+ */
35624
+ indexingStack?: "v1" | "v2";
35569
35625
  }
35570
35626
 
35571
35627
  type ClientProps$1 = {
@@ -35817,6 +35873,7 @@ declare class Client extends Client$1 implements IClient {
35817
35873
  type?: string | undefined;
35818
35874
  userId?: string | undefined;
35819
35875
  conversationId?: string | undefined;
35876
+ workflowId?: string | undefined;
35820
35877
  messageId?: string | undefined;
35821
35878
  status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
35822
35879
  }) => AsyncCollection<{
@@ -36121,6 +36178,7 @@ declare class Client extends Client$1 implements IClient {
36121
36178
  id?: string;
36122
36179
  name?: string;
36123
36180
  };
36181
+ indexingStack?: "v1" | "v2";
36124
36182
  }>;
36125
36183
  filePassages: (props: {
36126
36184
  id: string;