@botpress/client 1.17.0 → 1.18.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.d.ts CHANGED
@@ -3317,6 +3317,10 @@ interface GetPublicIntegrationByIdResponse$1 {
3317
3317
  */
3318
3318
  messageExtractScript?: string;
3319
3319
  };
3320
+ /**
3321
+ * Maximum execution time of the integration (in seconds).
3322
+ */
3323
+ maxExecutionTime?: number;
3320
3324
  /**
3321
3325
  * URL of the [Integration](#schema_integration)
3322
3326
  */
@@ -3720,6 +3724,10 @@ interface GetPublicIntegrationResponse$1 {
3720
3724
  */
3721
3725
  messageExtractScript?: string;
3722
3726
  };
3727
+ /**
3728
+ * Maximum execution time of the integration (in seconds).
3729
+ */
3730
+ maxExecutionTime?: number;
3723
3731
  /**
3724
3732
  * URL of the [Integration](#schema_integration)
3725
3733
  */
@@ -5537,6 +5545,10 @@ interface CreateBotResponse$1 {
5537
5545
  public: boolean;
5538
5546
  };
5539
5547
  };
5548
+ /**
5549
+ * Maximum execution time of the bot (in seconds).
5550
+ */
5551
+ maxExecutionTime?: number;
5540
5552
  /**
5541
5553
  * User object configuration
5542
5554
  */
@@ -5814,6 +5826,10 @@ interface UpdateBotRequestBody$1 {
5814
5826
  [k: string]: string;
5815
5827
  };
5816
5828
  blocked?: boolean;
5829
+ /**
5830
+ * Maximum execution time (in seconds).
5831
+ */
5832
+ maxExecutionTime?: number;
5817
5833
  /**
5818
5834
  * Indicates if the [Bot](#schema_bot) should be in always alive mode
5819
5835
  */
@@ -6154,6 +6170,10 @@ interface UpdateBotResponse$1 {
6154
6170
  public: boolean;
6155
6171
  };
6156
6172
  };
6173
+ /**
6174
+ * Maximum execution time of the bot (in seconds).
6175
+ */
6176
+ maxExecutionTime?: number;
6157
6177
  /**
6158
6178
  * User object configuration
6159
6179
  */
@@ -6607,6 +6627,10 @@ interface GetBotResponse$1 {
6607
6627
  public: boolean;
6608
6628
  };
6609
6629
  };
6630
+ /**
6631
+ * Maximum execution time of the bot (in seconds).
6632
+ */
6633
+ maxExecutionTime?: number;
6610
6634
  /**
6611
6635
  * User object configuration
6612
6636
  */
@@ -7862,6 +7886,34 @@ interface GetAuditRecordsResponse$1 {
7862
7886
  };
7863
7887
  }
7864
7888
 
7889
+ interface SetWorkspacePreferenceRequestHeaders$1 {
7890
+ }
7891
+ interface SetWorkspacePreferenceRequestQuery$1 {
7892
+ }
7893
+ interface SetWorkspacePreferenceRequestParams$1 {
7894
+ key: string;
7895
+ }
7896
+ interface SetWorkspacePreferenceRequestBody$1 {
7897
+ value?: any;
7898
+ }
7899
+ type SetWorkspacePreferenceInput$1 = SetWorkspacePreferenceRequestBody$1 & SetWorkspacePreferenceRequestHeaders$1 & SetWorkspacePreferenceRequestQuery$1 & SetWorkspacePreferenceRequestParams$1;
7900
+ interface SetWorkspacePreferenceResponse$1 {
7901
+ }
7902
+
7903
+ interface GetWorkspacePreferenceRequestHeaders$1 {
7904
+ }
7905
+ interface GetWorkspacePreferenceRequestQuery$1 {
7906
+ }
7907
+ interface GetWorkspacePreferenceRequestParams$1 {
7908
+ key: string;
7909
+ }
7910
+ interface GetWorkspacePreferenceRequestBody$1 {
7911
+ }
7912
+ type GetWorkspacePreferenceInput$1 = GetWorkspacePreferenceRequestBody$1 & GetWorkspacePreferenceRequestHeaders$1 & GetWorkspacePreferenceRequestQuery$1 & GetWorkspacePreferenceRequestParams$1;
7913
+ interface GetWorkspacePreferenceResponse$1 {
7914
+ value?: any;
7915
+ }
7916
+
7865
7917
  interface ListWorkspaceMembersRequestHeaders$1 {
7866
7918
  }
7867
7919
  interface ListWorkspaceMembersRequestQuery$1 {
@@ -8309,9 +8361,13 @@ interface CreateIntegrationRequestBody$1 {
8309
8361
  };
8310
8362
  };
8311
8363
  /**
8312
- * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
8364
+ * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
8313
8365
  */
8314
- messageStatusChangeNotificationsEnabled?: boolean;
8366
+ extraOperations?: {
8367
+ [k: string]: {
8368
+ enabled: boolean;
8369
+ };
8370
+ };
8315
8371
  /**
8316
8372
  * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
8317
8373
  */
@@ -8390,6 +8446,10 @@ interface CreateIntegrationResponse$1 {
8390
8446
  */
8391
8447
  messageExtractScript?: string;
8392
8448
  };
8449
+ /**
8450
+ * Maximum execution time of the integration (in seconds).
8451
+ */
8452
+ maxExecutionTime?: number;
8393
8453
  /**
8394
8454
  * URL of the [Integration](#schema_integration)
8395
8455
  */
@@ -9029,9 +9089,13 @@ interface ValidateIntegrationCreationRequestBody$1 {
9029
9089
  };
9030
9090
  };
9031
9091
  /**
9032
- * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
9092
+ * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
9033
9093
  */
9034
- messageStatusChangeNotificationsEnabled?: boolean;
9094
+ extraOperations?: {
9095
+ [k: string]: {
9096
+ enabled: boolean;
9097
+ };
9098
+ };
9035
9099
  /**
9036
9100
  * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
9037
9101
  */
@@ -9133,9 +9197,13 @@ interface UpdateIntegrationRequestBody$1 {
9133
9197
  } | null;
9134
9198
  };
9135
9199
  /**
9136
- * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
9200
+ * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
9137
9201
  */
9138
- messageStatusChangeNotificationsEnabled?: boolean;
9202
+ extraOperations?: {
9203
+ [k: string]: {
9204
+ enabled: boolean;
9205
+ };
9206
+ };
9139
9207
  channels?: {
9140
9208
  [k: string]: {
9141
9209
  /**
@@ -9205,6 +9273,10 @@ interface UpdateIntegrationRequestBody$1 {
9205
9273
  };
9206
9274
  } | null;
9207
9275
  };
9276
+ /**
9277
+ * Maximum execution time of the integration (in seconds).
9278
+ */
9279
+ maxExecutionTime?: number;
9208
9280
  identifier?: {
9209
9281
  extractScript?: string | null;
9210
9282
  fallbackHandlerScript?: string | null;
@@ -9433,6 +9505,10 @@ interface UpdateIntegrationResponse$1 {
9433
9505
  */
9434
9506
  messageExtractScript?: string;
9435
9507
  };
9508
+ /**
9509
+ * Maximum execution time of the integration (in seconds).
9510
+ */
9511
+ maxExecutionTime?: number;
9436
9512
  /**
9437
9513
  * URL of the [Integration](#schema_integration)
9438
9514
  */
@@ -9836,9 +9912,13 @@ interface ValidateIntegrationUpdateRequestBody$1 {
9836
9912
  } | null;
9837
9913
  };
9838
9914
  /**
9839
- * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
9915
+ * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
9840
9916
  */
9841
- messageStatusChangeNotificationsEnabled?: boolean;
9917
+ extraOperations?: {
9918
+ [k: string]: {
9919
+ enabled: boolean;
9920
+ };
9921
+ };
9842
9922
  channels?: {
9843
9923
  [k: string]: {
9844
9924
  /**
@@ -9908,6 +9988,10 @@ interface ValidateIntegrationUpdateRequestBody$1 {
9908
9988
  };
9909
9989
  } | null;
9910
9990
  };
9991
+ /**
9992
+ * Maximum execution time of the integration (in seconds).
9993
+ */
9994
+ maxExecutionTime?: number;
9911
9995
  identifier?: {
9912
9996
  extractScript?: string | null;
9913
9997
  fallbackHandlerScript?: string | null;
@@ -10252,6 +10336,10 @@ interface GetIntegrationResponse$1 {
10252
10336
  */
10253
10337
  messageExtractScript?: string;
10254
10338
  };
10339
+ /**
10340
+ * Maximum execution time of the integration (in seconds).
10341
+ */
10342
+ maxExecutionTime?: number;
10255
10343
  /**
10256
10344
  * URL of the [Integration](#schema_integration)
10257
10345
  */
@@ -10675,6 +10763,10 @@ interface GetIntegrationByNameResponse$1 {
10675
10763
  */
10676
10764
  messageExtractScript?: string;
10677
10765
  };
10766
+ /**
10767
+ * Maximum execution time of the integration (in seconds).
10768
+ */
10769
+ maxExecutionTime?: number;
10678
10770
  /**
10679
10771
  * URL of the [Integration](#schema_integration)
10680
10772
  */
@@ -13864,6 +13956,8 @@ declare class Client$7 {
13864
13956
  readonly listPublicWorkspaces: (input: ListPublicWorkspacesInput$1) => Promise<ListPublicWorkspacesResponse$1>;
13865
13957
  readonly deleteWorkspace: (input: DeleteWorkspaceInput$1) => Promise<DeleteWorkspaceResponse$1>;
13866
13958
  readonly getAuditRecords: (input: GetAuditRecordsInput$1) => Promise<GetAuditRecordsResponse$1>;
13959
+ readonly setWorkspacePreference: (input: SetWorkspacePreferenceInput$1) => Promise<SetWorkspacePreferenceResponse$1>;
13960
+ readonly getWorkspacePreference: (input: GetWorkspacePreferenceInput$1) => Promise<GetWorkspacePreferenceResponse$1>;
13867
13961
  readonly listWorkspaceMembers: (input: ListWorkspaceMembersInput$1) => Promise<ListWorkspaceMembersResponse$1>;
13868
13962
  readonly getWorkspaceMember: (input: GetWorkspaceMemberInput$1) => Promise<GetWorkspaceMemberResponse$1>;
13869
13963
  readonly deleteWorkspaceMember: (input: DeleteWorkspaceMemberInput$1) => Promise<DeleteWorkspaceMemberResponse$1>;
@@ -19980,6 +20074,10 @@ interface GetPublicIntegrationByIdResponse {
19980
20074
  */
19981
20075
  messageExtractScript?: string;
19982
20076
  };
20077
+ /**
20078
+ * Maximum execution time of the integration (in seconds).
20079
+ */
20080
+ maxExecutionTime?: number;
19983
20081
  /**
19984
20082
  * URL of the [Integration](#schema_integration)
19985
20083
  */
@@ -20383,6 +20481,10 @@ interface GetPublicIntegrationResponse {
20383
20481
  */
20384
20482
  messageExtractScript?: string;
20385
20483
  };
20484
+ /**
20485
+ * Maximum execution time of the integration (in seconds).
20486
+ */
20487
+ maxExecutionTime?: number;
20386
20488
  /**
20387
20489
  * URL of the [Integration](#schema_integration)
20388
20490
  */
@@ -22200,6 +22302,10 @@ interface CreateBotResponse {
22200
22302
  public: boolean;
22201
22303
  };
22202
22304
  };
22305
+ /**
22306
+ * Maximum execution time of the bot (in seconds).
22307
+ */
22308
+ maxExecutionTime?: number;
22203
22309
  /**
22204
22310
  * User object configuration
22205
22311
  */
@@ -22477,6 +22583,10 @@ interface UpdateBotRequestBody {
22477
22583
  [k: string]: string;
22478
22584
  };
22479
22585
  blocked?: boolean;
22586
+ /**
22587
+ * Maximum execution time (in seconds).
22588
+ */
22589
+ maxExecutionTime?: number;
22480
22590
  /**
22481
22591
  * Indicates if the [Bot](#schema_bot) should be in always alive mode
22482
22592
  */
@@ -22817,6 +22927,10 @@ interface UpdateBotResponse {
22817
22927
  public: boolean;
22818
22928
  };
22819
22929
  };
22930
+ /**
22931
+ * Maximum execution time of the bot (in seconds).
22932
+ */
22933
+ maxExecutionTime?: number;
22820
22934
  /**
22821
22935
  * User object configuration
22822
22936
  */
@@ -23270,6 +23384,10 @@ interface GetBotResponse {
23270
23384
  public: boolean;
23271
23385
  };
23272
23386
  };
23387
+ /**
23388
+ * Maximum execution time of the bot (in seconds).
23389
+ */
23390
+ maxExecutionTime?: number;
23273
23391
  /**
23274
23392
  * User object configuration
23275
23393
  */
@@ -24525,6 +24643,34 @@ interface GetAuditRecordsResponse {
24525
24643
  };
24526
24644
  }
24527
24645
 
24646
+ interface SetWorkspacePreferenceRequestHeaders {
24647
+ }
24648
+ interface SetWorkspacePreferenceRequestQuery {
24649
+ }
24650
+ interface SetWorkspacePreferenceRequestParams {
24651
+ key: string;
24652
+ }
24653
+ interface SetWorkspacePreferenceRequestBody {
24654
+ value?: any;
24655
+ }
24656
+ type SetWorkspacePreferenceInput = SetWorkspacePreferenceRequestBody & SetWorkspacePreferenceRequestHeaders & SetWorkspacePreferenceRequestQuery & SetWorkspacePreferenceRequestParams;
24657
+ interface SetWorkspacePreferenceResponse {
24658
+ }
24659
+
24660
+ interface GetWorkspacePreferenceRequestHeaders {
24661
+ }
24662
+ interface GetWorkspacePreferenceRequestQuery {
24663
+ }
24664
+ interface GetWorkspacePreferenceRequestParams {
24665
+ key: string;
24666
+ }
24667
+ interface GetWorkspacePreferenceRequestBody {
24668
+ }
24669
+ type GetWorkspacePreferenceInput = GetWorkspacePreferenceRequestBody & GetWorkspacePreferenceRequestHeaders & GetWorkspacePreferenceRequestQuery & GetWorkspacePreferenceRequestParams;
24670
+ interface GetWorkspacePreferenceResponse {
24671
+ value?: any;
24672
+ }
24673
+
24528
24674
  interface ListWorkspaceMembersRequestHeaders {
24529
24675
  }
24530
24676
  interface ListWorkspaceMembersRequestQuery {
@@ -24973,9 +25119,13 @@ interface CreateIntegrationRequestBody {
24973
25119
  };
24974
25120
  };
24975
25121
  /**
24976
- * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
25122
+ * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
24977
25123
  */
24978
- messageStatusChangeNotificationsEnabled?: boolean;
25124
+ extraOperations?: {
25125
+ [k: string]: {
25126
+ enabled: boolean;
25127
+ };
25128
+ };
24979
25129
  /**
24980
25130
  * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
24981
25131
  */
@@ -25054,6 +25204,10 @@ interface CreateIntegrationResponse {
25054
25204
  */
25055
25205
  messageExtractScript?: string;
25056
25206
  };
25207
+ /**
25208
+ * Maximum execution time of the integration (in seconds).
25209
+ */
25210
+ maxExecutionTime?: number;
25057
25211
  /**
25058
25212
  * URL of the [Integration](#schema_integration)
25059
25213
  */
@@ -25693,9 +25847,13 @@ interface ValidateIntegrationCreationRequestBody {
25693
25847
  };
25694
25848
  };
25695
25849
  /**
25696
- * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
25850
+ * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
25697
25851
  */
25698
- messageStatusChangeNotificationsEnabled?: boolean;
25852
+ extraOperations?: {
25853
+ [k: string]: {
25854
+ enabled: boolean;
25855
+ };
25856
+ };
25699
25857
  /**
25700
25858
  * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
25701
25859
  */
@@ -25797,9 +25955,13 @@ interface UpdateIntegrationRequestBody {
25797
25955
  } | null;
25798
25956
  };
25799
25957
  /**
25800
- * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
25958
+ * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
25801
25959
  */
25802
- messageStatusChangeNotificationsEnabled?: boolean;
25960
+ extraOperations?: {
25961
+ [k: string]: {
25962
+ enabled: boolean;
25963
+ };
25964
+ };
25803
25965
  channels?: {
25804
25966
  [k: string]: {
25805
25967
  /**
@@ -25869,6 +26031,10 @@ interface UpdateIntegrationRequestBody {
25869
26031
  };
25870
26032
  } | null;
25871
26033
  };
26034
+ /**
26035
+ * Maximum execution time of the integration (in seconds).
26036
+ */
26037
+ maxExecutionTime?: number;
25872
26038
  identifier?: {
25873
26039
  extractScript?: string | null;
25874
26040
  fallbackHandlerScript?: string | null;
@@ -26097,6 +26263,10 @@ interface UpdateIntegrationResponse {
26097
26263
  */
26098
26264
  messageExtractScript?: string;
26099
26265
  };
26266
+ /**
26267
+ * Maximum execution time of the integration (in seconds).
26268
+ */
26269
+ maxExecutionTime?: number;
26100
26270
  /**
26101
26271
  * URL of the [Integration](#schema_integration)
26102
26272
  */
@@ -26500,9 +26670,13 @@ interface ValidateIntegrationUpdateRequestBody {
26500
26670
  } | null;
26501
26671
  };
26502
26672
  /**
26503
- * **EXPERIMENTAL** Whether the integration should be notified when the message status changes
26673
+ * **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
26504
26674
  */
26505
- messageStatusChangeNotificationsEnabled?: boolean;
26675
+ extraOperations?: {
26676
+ [k: string]: {
26677
+ enabled: boolean;
26678
+ };
26679
+ };
26506
26680
  channels?: {
26507
26681
  [k: string]: {
26508
26682
  /**
@@ -26572,6 +26746,10 @@ interface ValidateIntegrationUpdateRequestBody {
26572
26746
  };
26573
26747
  } | null;
26574
26748
  };
26749
+ /**
26750
+ * Maximum execution time of the integration (in seconds).
26751
+ */
26752
+ maxExecutionTime?: number;
26575
26753
  identifier?: {
26576
26754
  extractScript?: string | null;
26577
26755
  fallbackHandlerScript?: string | null;
@@ -26916,6 +27094,10 @@ interface GetIntegrationResponse {
26916
27094
  */
26917
27095
  messageExtractScript?: string;
26918
27096
  };
27097
+ /**
27098
+ * Maximum execution time of the integration (in seconds).
27099
+ */
27100
+ maxExecutionTime?: number;
26919
27101
  /**
26920
27102
  * URL of the [Integration](#schema_integration)
26921
27103
  */
@@ -27339,6 +27521,10 @@ interface GetIntegrationByNameResponse {
27339
27521
  */
27340
27522
  messageExtractScript?: string;
27341
27523
  };
27524
+ /**
27525
+ * Maximum execution time of the integration (in seconds).
27526
+ */
27527
+ maxExecutionTime?: number;
27342
27528
  /**
27343
27529
  * URL of the [Integration](#schema_integration)
27344
27530
  */
@@ -33228,6 +33414,10 @@ interface Bot {
33228
33414
  public: boolean;
33229
33415
  };
33230
33416
  };
33417
+ /**
33418
+ * Maximum execution time of the bot (in seconds).
33419
+ */
33420
+ maxExecutionTime?: number;
33231
33421
  /**
33232
33422
  * User object configuration
33233
33423
  */
@@ -33502,6 +33692,10 @@ interface Integration {
33502
33692
  */
33503
33693
  messageExtractScript?: string;
33504
33694
  };
33695
+ /**
33696
+ * Maximum execution time of the integration (in seconds).
33697
+ */
33698
+ maxExecutionTime?: number;
33505
33699
  /**
33506
33700
  * URL of the [Integration](#schema_integration)
33507
33701
  */
@@ -35048,6 +35242,8 @@ declare class Client$1 {
35048
35242
  readonly listPublicWorkspaces: (input: ListPublicWorkspacesInput) => Promise<ListPublicWorkspacesResponse>;
35049
35243
  readonly deleteWorkspace: (input: DeleteWorkspaceInput) => Promise<DeleteWorkspaceResponse>;
35050
35244
  readonly getAuditRecords: (input: GetAuditRecordsInput) => Promise<GetAuditRecordsResponse>;
35245
+ readonly setWorkspacePreference: (input: SetWorkspacePreferenceInput) => Promise<SetWorkspacePreferenceResponse>;
35246
+ readonly getWorkspacePreference: (input: GetWorkspacePreferenceInput) => Promise<GetWorkspacePreferenceResponse>;
35051
35247
  readonly listWorkspaceMembers: (input: ListWorkspaceMembersInput) => Promise<ListWorkspaceMembersResponse>;
35052
35248
  readonly getWorkspaceMember: (input: GetWorkspaceMemberInput) => Promise<GetWorkspaceMemberResponse>;
35053
35249
  readonly deleteWorkspaceMember: (input: DeleteWorkspaceMemberInput) => Promise<DeleteWorkspaceMemberResponse>;