@botpress/client 1.46.0 → 1.47.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
@@ -3161,10 +3161,10 @@ declare class Client$a extends Client$b {
3161
3161
  constructor(clientProps: ClientProps$a);
3162
3162
  get list(): {
3163
3163
  conversations: (props: {
3164
+ channel?: string | undefined;
3164
3165
  tags?: {
3165
3166
  [x: string]: string;
3166
3167
  } | undefined;
3167
- channel?: string | undefined;
3168
3168
  integrationName?: string | undefined;
3169
3169
  pageSize?: number | undefined;
3170
3170
  sortField?: "createdAt" | "updatedAt" | undefined;
@@ -3209,13 +3209,13 @@ declare class Client$a extends Client$b {
3209
3209
  };
3210
3210
  }>;
3211
3211
  events: (props: {
3212
- status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
3213
- type?: string | undefined;
3214
3212
  pageSize?: number | undefined;
3215
3213
  userId?: string | undefined;
3214
+ type?: string | undefined;
3216
3215
  conversationId?: string | undefined;
3217
3216
  workflowId?: string | undefined;
3218
3217
  messageId?: string | undefined;
3218
+ status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
3219
3219
  }) => AsyncCollection<{
3220
3220
  id: string;
3221
3221
  createdAt: string;
@@ -3284,7 +3284,8 @@ declare class Client$a extends Client$b {
3284
3284
  }
3285
3285
 
3286
3286
  declare namespace index$4 {
3287
- export { Client$a as Client, type ClientInputs$5 as ClientInputs, type ClientOutputs$5 as ClientOutputs, type ClientProps$a as ClientProps, type Operation$5 as Operation };
3287
+ export { Client$a as Client };
3288
+ export type { ClientInputs$5 as ClientInputs, ClientOutputs$5 as ClientOutputs, ClientProps$a as ClientProps, Operation$5 as Operation };
3288
3289
  }
3289
3290
 
3290
3291
  type Primitive$4 = string | number | boolean;
@@ -4474,10 +4475,6 @@ interface ListPublicPluginsResponse$1 {
4474
4475
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
4475
4476
  */
4476
4477
  iconUrl: string;
4477
- /**
4478
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
4479
- */
4480
- readmeUrl: string;
4481
4478
  /**
4482
4479
  * @deprecated
4483
4480
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -5706,17 +5703,6 @@ interface CreateBotRequestBody$1 {
5706
5703
  };
5707
5704
  };
5708
5705
  };
5709
- /**
5710
- * Subscriptions of the bot
5711
- */
5712
- subscriptions?: {
5713
- /**
5714
- * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
5715
- */
5716
- events: {
5717
- [k: string]: {};
5718
- } | null;
5719
- };
5720
5706
  /**
5721
5707
  * Actions definition
5722
5708
  */
@@ -5824,6 +5810,58 @@ interface CreateBotRequestBody$1 {
5824
5810
  tags?: {
5825
5811
  [k: string]: string;
5826
5812
  };
5813
+ /**
5814
+ * Maximum execution time (in seconds).
5815
+ */
5816
+ maxExecutionTime?: number;
5817
+ /**
5818
+ * Subscriptions of the bot
5819
+ */
5820
+ subscriptions?: {
5821
+ /**
5822
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
5823
+ */
5824
+ integrations?: {
5825
+ [k: string]: {
5826
+ /**
5827
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
5828
+ */
5829
+ events: {
5830
+ include?: string[];
5831
+ exclude?: string[];
5832
+ } | null;
5833
+ };
5834
+ };
5835
+ /**
5836
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
5837
+ */
5838
+ plugins?: {
5839
+ [k: string]: {
5840
+ /**
5841
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
5842
+ */
5843
+ events: {
5844
+ include?: string[];
5845
+ exclude?: string[];
5846
+ } | null;
5847
+ };
5848
+ };
5849
+ bot?: {
5850
+ /**
5851
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
5852
+ */
5853
+ events: {
5854
+ include?: string[];
5855
+ exclude?: string[];
5856
+ } | null;
5857
+ };
5858
+ /**
5859
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
5860
+ */
5861
+ events?: {
5862
+ [k: string]: {} | null;
5863
+ } | null;
5864
+ };
5827
5865
  /**
5828
5866
  * JavaScript code of the bot
5829
5867
  */
@@ -5857,14 +5895,7 @@ interface CreateBotRequestBody$1 {
5857
5895
  * Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
5858
5896
  */
5859
5897
  dev?: boolean;
5860
- /**
5861
- * Type of the [Bot](#schema_bot)
5862
- */
5863
- type?: "studio" | "adk" | "desk";
5864
- /**
5865
- * Maximum execution time (in seconds).
5866
- */
5867
- maxExecutionTime?: number;
5898
+ type?: "studio" | "adk";
5868
5899
  }
5869
5900
  type CreateBotInput$1 = CreateBotRequestBody$1 & CreateBotRequestHeaders$1 & CreateBotRequestQuery$1 & CreateBotRequestParams$1;
5870
5901
  interface CreateBotResponse$1 {
@@ -6016,10 +6047,6 @@ interface CreateBotResponse$1 {
6016
6047
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
6017
6048
  */
6018
6049
  iconUrl: string;
6019
- /**
6020
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
6021
- */
6022
- readmeUrl: string;
6023
6050
  /**
6024
6051
  * @deprecated
6025
6052
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -6191,11 +6218,48 @@ interface CreateBotResponse$1 {
6191
6218
  */
6192
6219
  subscriptions: {
6193
6220
  /**
6194
- * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
6221
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
6195
6222
  */
6196
6223
  events: {
6197
6224
  [k: string]: {};
6198
6225
  } | null;
6226
+ /**
6227
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
6228
+ */
6229
+ integrations?: {
6230
+ [k: string]: {
6231
+ /**
6232
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
6233
+ */
6234
+ events: {
6235
+ include?: string[];
6236
+ exclude?: string[];
6237
+ } | null;
6238
+ };
6239
+ };
6240
+ /**
6241
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
6242
+ */
6243
+ plugins?: {
6244
+ [k: string]: {
6245
+ /**
6246
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
6247
+ */
6248
+ events: {
6249
+ include?: string[];
6250
+ exclude?: string[];
6251
+ } | null;
6252
+ };
6253
+ };
6254
+ bot?: {
6255
+ /**
6256
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
6257
+ */
6258
+ events: {
6259
+ include?: string[];
6260
+ exclude?: string[];
6261
+ } | null;
6262
+ };
6199
6263
  };
6200
6264
  /**
6201
6265
  * Actions definition
@@ -6321,11 +6385,11 @@ interface UpdateBotRequestBody$1 {
6321
6385
  [k: string]: any;
6322
6386
  };
6323
6387
  };
6324
- blocked?: boolean;
6325
6388
  /**
6326
6389
  * Maximum execution time (in seconds).
6327
6390
  */
6328
6391
  maxExecutionTime?: number;
6392
+ blocked?: boolean;
6329
6393
  /**
6330
6394
  * Indicates if the [Bot](#schema_bot) should be in always alive mode
6331
6395
  */
@@ -6524,8 +6588,51 @@ interface UpdateBotRequestBody$1 {
6524
6588
  };
6525
6589
  } | null;
6526
6590
  };
6591
+ /**
6592
+ * Subscriptions of the bot
6593
+ */
6527
6594
  subscriptions?: {
6528
- events: {
6595
+ /**
6596
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
6597
+ */
6598
+ integrations?: {
6599
+ [k: string]: {
6600
+ /**
6601
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
6602
+ */
6603
+ events: {
6604
+ include?: string[];
6605
+ exclude?: string[];
6606
+ } | null;
6607
+ };
6608
+ };
6609
+ /**
6610
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
6611
+ */
6612
+ plugins?: {
6613
+ [k: string]: {
6614
+ /**
6615
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
6616
+ */
6617
+ events: {
6618
+ include?: string[];
6619
+ exclude?: string[];
6620
+ } | null;
6621
+ };
6622
+ };
6623
+ bot?: {
6624
+ /**
6625
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
6626
+ */
6627
+ events: {
6628
+ include?: string[];
6629
+ exclude?: string[];
6630
+ } | null;
6631
+ };
6632
+ /**
6633
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
6634
+ */
6635
+ events?: {
6529
6636
  [k: string]: {} | null;
6530
6637
  } | null;
6531
6638
  };
@@ -6555,10 +6662,7 @@ interface UpdateBotRequestBody$1 {
6555
6662
  [k: string]: string | null;
6556
6663
  };
6557
6664
  layers?: string[];
6558
- /**
6559
- * Type of the [Bot](#schema_bot)
6560
- */
6561
- type?: "studio" | "adk" | "desk";
6665
+ type?: "studio" | "adk";
6562
6666
  }
6563
6667
  type UpdateBotInput$1 = UpdateBotRequestBody$1 & UpdateBotRequestHeaders$1 & UpdateBotRequestQuery$1 & UpdateBotRequestParams$1;
6564
6668
  interface UpdateBotResponse$1 {
@@ -6710,10 +6814,6 @@ interface UpdateBotResponse$1 {
6710
6814
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
6711
6815
  */
6712
6816
  iconUrl: string;
6713
- /**
6714
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
6715
- */
6716
- readmeUrl: string;
6717
6817
  /**
6718
6818
  * @deprecated
6719
6819
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -6885,11 +6985,48 @@ interface UpdateBotResponse$1 {
6885
6985
  */
6886
6986
  subscriptions: {
6887
6987
  /**
6888
- * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
6988
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
6889
6989
  */
6890
6990
  events: {
6891
6991
  [k: string]: {};
6892
6992
  } | null;
6993
+ /**
6994
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
6995
+ */
6996
+ integrations?: {
6997
+ [k: string]: {
6998
+ /**
6999
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
7000
+ */
7001
+ events: {
7002
+ include?: string[];
7003
+ exclude?: string[];
7004
+ } | null;
7005
+ };
7006
+ };
7007
+ /**
7008
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
7009
+ */
7010
+ plugins?: {
7011
+ [k: string]: {
7012
+ /**
7013
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
7014
+ */
7015
+ events: {
7016
+ include?: string[];
7017
+ exclude?: string[];
7018
+ } | null;
7019
+ };
7020
+ };
7021
+ bot?: {
7022
+ /**
7023
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
7024
+ */
7025
+ events: {
7026
+ include?: string[];
7027
+ exclude?: string[];
7028
+ } | null;
7029
+ };
6893
7030
  };
6894
7031
  /**
6895
7032
  * Actions definition
@@ -7232,10 +7369,6 @@ interface GetBotResponse$1 {
7232
7369
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
7233
7370
  */
7234
7371
  iconUrl: string;
7235
- /**
7236
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
7237
- */
7238
- readmeUrl: string;
7239
7372
  /**
7240
7373
  * @deprecated
7241
7374
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -7407,11 +7540,48 @@ interface GetBotResponse$1 {
7407
7540
  */
7408
7541
  subscriptions: {
7409
7542
  /**
7410
- * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
7543
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
7411
7544
  */
7412
7545
  events: {
7413
7546
  [k: string]: {};
7414
7547
  } | null;
7548
+ /**
7549
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
7550
+ */
7551
+ integrations?: {
7552
+ [k: string]: {
7553
+ /**
7554
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
7555
+ */
7556
+ events: {
7557
+ include?: string[];
7558
+ exclude?: string[];
7559
+ } | null;
7560
+ };
7561
+ };
7562
+ /**
7563
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
7564
+ */
7565
+ plugins?: {
7566
+ [k: string]: {
7567
+ /**
7568
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
7569
+ */
7570
+ events: {
7571
+ include?: string[];
7572
+ exclude?: string[];
7573
+ } | null;
7574
+ };
7575
+ };
7576
+ bot?: {
7577
+ /**
7578
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
7579
+ */
7580
+ events: {
7581
+ include?: string[];
7582
+ exclude?: string[];
7583
+ } | null;
7584
+ };
7415
7585
  };
7416
7586
  /**
7417
7587
  * Actions definition
@@ -7584,7 +7754,7 @@ interface GetBotAnalyticsResponse$1 {
7584
7754
  */
7585
7755
  startDateTimeUtc: string;
7586
7756
  /**
7587
- * ISO 8601 date string of the end (inclusive) of the period
7757
+ * ISO 8601 date string of the end (exclusive) of the period
7588
7758
  */
7589
7759
  endDateTimeUtc: string;
7590
7760
  returningUsers: number;
@@ -7597,12 +7767,46 @@ interface GetBotAnalyticsResponse$1 {
7597
7767
  userMessages: number;
7598
7768
  botMessages: number;
7599
7769
  events: number;
7770
+ /**
7771
+ * Number of conversations created during the period
7772
+ */
7773
+ conversationsCreated: number;
7600
7774
  eventTypes: {
7601
7775
  [k: string]: number;
7602
7776
  };
7603
7777
  customEvents: {
7604
7778
  [k: string]: number;
7605
7779
  };
7780
+ workflows: {
7781
+ created: number;
7782
+ completed: number;
7783
+ failed: number;
7784
+ timedout: number;
7785
+ cancelled: number;
7786
+ duration: {
7787
+ count: number;
7788
+ sum: number;
7789
+ mean: number;
7790
+ min: number;
7791
+ max: number;
7792
+ };
7793
+ byName: {
7794
+ [k: string]: {
7795
+ created: number;
7796
+ completed: number;
7797
+ failed: number;
7798
+ timedout: number;
7799
+ cancelled: number;
7800
+ duration: {
7801
+ count: number;
7802
+ sum: number;
7803
+ mean: number;
7804
+ min: number;
7805
+ max: number;
7806
+ };
7807
+ };
7808
+ };
7809
+ };
7606
7810
  llm: {
7607
7811
  calls: number;
7608
7812
  errors: number;
@@ -14702,10 +14906,6 @@ interface ListPluginsResponse$1 {
14702
14906
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
14703
14907
  */
14704
14908
  iconUrl: string;
14705
- /**
14706
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
14707
- */
14708
- readmeUrl: string;
14709
14909
  /**
14710
14910
  * @deprecated
14711
14911
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -15113,7 +15313,6 @@ declare class Client$8 extends Client$9 {
15113
15313
  constructor(clientProps: ClientProps$8);
15114
15314
  get list(): {
15115
15315
  publicIntegrations: (props: {
15116
- search?: string | undefined;
15117
15316
  pageSize?: number | undefined;
15118
15317
  name?: string | undefined;
15119
15318
  limit?: number | undefined;
@@ -15122,6 +15321,7 @@ declare class Client$8 extends Client$9 {
15122
15321
  interfaceName?: string | undefined;
15123
15322
  installedByBotId?: string | undefined;
15124
15323
  verificationStatus?: "unapproved" | "pending" | "approved" | "rejected" | undefined;
15324
+ search?: string | undefined;
15125
15325
  sortBy?: "popularity" | "name" | "createdAt" | "updatedAt" | "installCount" | undefined;
15126
15326
  direction?: "asc" | "desc" | undefined;
15127
15327
  }) => AsyncCollection<{
@@ -15203,8 +15403,8 @@ declare class Client$8 extends Client$9 {
15203
15403
  handle?: string | undefined;
15204
15404
  }) => AsyncCollection<UpdateWorkspaceResponse$2>;
15205
15405
  publicWorkspaces: (props: {
15206
- search?: string | undefined;
15207
15406
  pageSize?: number | undefined;
15407
+ search?: string | undefined;
15208
15408
  workspaceIds?: string[] | undefined;
15209
15409
  }) => AsyncCollection<GetPublicWorkspaceResponse$2>;
15210
15410
  workspaceMembers: (props: {
@@ -15219,7 +15419,6 @@ declare class Client$8 extends Client$9 {
15219
15419
  displayName?: string;
15220
15420
  }>;
15221
15421
  integrations: (props: {
15222
- search?: string | undefined;
15223
15422
  pageSize?: number | undefined;
15224
15423
  name?: string | undefined;
15225
15424
  limit?: number | undefined;
@@ -15228,6 +15427,7 @@ declare class Client$8 extends Client$9 {
15228
15427
  interfaceName?: string | undefined;
15229
15428
  installedByBotId?: string | undefined;
15230
15429
  verificationStatus?: "unapproved" | "pending" | "approved" | "rejected" | undefined;
15430
+ search?: string | undefined;
15231
15431
  sortBy?: "popularity" | "name" | "createdAt" | "updatedAt" | "installCount" | undefined;
15232
15432
  direction?: "asc" | "desc" | undefined;
15233
15433
  dev?: boolean | undefined;
@@ -15278,8 +15478,8 @@ declare class Client$8 extends Client$9 {
15278
15478
  public: boolean;
15279
15479
  }>;
15280
15480
  activities: (props: {
15281
- botId: string;
15282
15481
  pageSize?: number | undefined;
15482
+ botId: string;
15283
15483
  taskId: string;
15284
15484
  }) => AsyncCollection<{
15285
15485
  id: string;
@@ -15292,9 +15492,9 @@ declare class Client$8 extends Client$9 {
15292
15492
  createdAt: string;
15293
15493
  }>;
15294
15494
  usageActivity: (props: {
15295
- type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
15296
15495
  id: string;
15297
15496
  pageSize?: number | undefined;
15497
+ type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
15298
15498
  timestampFrom?: string | undefined;
15299
15499
  timestampUntil?: string | undefined;
15300
15500
  }) => AsyncCollection<{
@@ -15306,9 +15506,9 @@ declare class Client$8 extends Client$9 {
15306
15506
  };
15307
15507
  }>;
15308
15508
  usageActivityDaily: (props: {
15309
- type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
15310
15509
  id: string;
15311
15510
  pageSize?: number | undefined;
15511
+ type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
15312
15512
  dateFrom?: string | undefined;
15313
15513
  dateUntil?: string | undefined;
15314
15514
  }) => AsyncCollection<{
@@ -15326,7 +15526,8 @@ declare class Client$8 extends Client$9 {
15326
15526
  }
15327
15527
 
15328
15528
  declare namespace index$3 {
15329
- export { Client$8 as Client, type ClientInputs$4 as ClientInputs, type ClientOutputs$4 as ClientOutputs, type ClientProps$8 as ClientProps, type Operation$4 as Operation };
15529
+ export { Client$8 as Client };
15530
+ export type { ClientInputs$4 as ClientInputs, ClientOutputs$4 as ClientOutputs, ClientProps$8 as ClientProps, Operation$4 as Operation };
15330
15531
  }
15331
15532
 
15332
15533
  type Primitive$3 = string | number | boolean;
@@ -15374,7 +15575,7 @@ interface GetBillingAddressResponse {
15374
15575
  lineTwo?: string;
15375
15576
  city: string;
15376
15577
  state?: string;
15377
- postalCode: string;
15578
+ postalCode?: string;
15378
15579
  country: string;
15379
15580
  } | null;
15380
15581
  }
@@ -15390,7 +15591,7 @@ interface SetBillingAddressRequestBody {
15390
15591
  lineTwo?: string;
15391
15592
  city: string;
15392
15593
  state?: string;
15393
- postalCode: string;
15594
+ postalCode?: string;
15394
15595
  country: string;
15395
15596
  }
15396
15597
  type SetBillingAddressInput = SetBillingAddressRequestBody & SetBillingAddressRequestHeaders & SetBillingAddressRequestQuery & SetBillingAddressRequestParams;
@@ -15412,7 +15613,7 @@ interface GetCustomerResponse {
15412
15613
  lineTwo?: string;
15413
15614
  city: string;
15414
15615
  state?: string;
15415
- postalCode: string;
15616
+ postalCode?: string;
15416
15617
  country: string;
15417
15618
  } | null;
15418
15619
  name: string | null;
@@ -15434,7 +15635,7 @@ interface SetCustomerRequestBody {
15434
15635
  lineTwo?: string;
15435
15636
  city: string;
15436
15637
  state?: string;
15437
- postalCode: string;
15638
+ postalCode?: string;
15438
15639
  country: string;
15439
15640
  };
15440
15641
  name?: string;
@@ -15450,7 +15651,7 @@ interface SetCustomerResponse {
15450
15651
  lineTwo?: string;
15451
15652
  city: string;
15452
15653
  state?: string;
15453
- postalCode: string;
15654
+ postalCode?: string;
15454
15655
  country: string;
15455
15656
  } | null;
15456
15657
  name: string | null;
@@ -16365,7 +16566,8 @@ declare class Client$6 extends Client$7 {
16365
16566
  }
16366
16567
 
16367
16568
  declare namespace index$2 {
16368
- export { Client$6 as Client, type ClientInputs$3 as ClientInputs, type ClientOutputs$3 as ClientOutputs, type ClientProps$6 as ClientProps, type Operation$3 as Operation };
16569
+ export { Client$6 as Client };
16570
+ export type { ClientInputs$3 as ClientInputs, ClientOutputs$3 as ClientOutputs, ClientProps$6 as ClientProps, Operation$3 as Operation };
16369
16571
  }
16370
16572
 
16371
16573
  type Primitive$2 = string | number | boolean;
@@ -17367,6 +17569,10 @@ interface CreateKnowledgeBaseRequestBody$1 {
17367
17569
  * Name of the knowledge base.
17368
17570
  */
17369
17571
  name: string;
17572
+ /**
17573
+ * Description of the knowledge base.
17574
+ */
17575
+ description?: string;
17370
17576
  tags?: {
17371
17577
  [k: string]: string;
17372
17578
  };
@@ -17382,6 +17588,10 @@ interface CreateKnowledgeBaseResponse$1 {
17382
17588
  * Name of the knowledge base.
17383
17589
  */
17384
17590
  name: string;
17591
+ /**
17592
+ * Description of the knowledge base.
17593
+ */
17594
+ description?: string;
17385
17595
  tags: {
17386
17596
  [k: string]: string;
17387
17597
  };
@@ -17413,6 +17623,10 @@ interface UpdateKnowledgeBaseRequestBody$1 {
17413
17623
  * New name of the knowledge base.
17414
17624
  */
17415
17625
  name: string;
17626
+ /**
17627
+ * Description of the knowledge base. Omit to keep the existing description; set to `null` to clear it.
17628
+ */
17629
+ description?: string | null;
17416
17630
  /**
17417
17631
  * The knowledge base tags to update as an object of key-value pairs with `string` (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`.
17418
17632
  */
@@ -17431,6 +17645,10 @@ interface UpdateKnowledgeBaseResponse$1 {
17431
17645
  * Name of the knowledge base.
17432
17646
  */
17433
17647
  name: string;
17648
+ /**
17649
+ * Description of the knowledge base.
17650
+ */
17651
+ description?: string;
17434
17652
  tags: {
17435
17653
  [k: string]: string;
17436
17654
  };
@@ -17459,6 +17677,10 @@ interface ListKnowledgeBasesResponse$1 {
17459
17677
  * Name of the knowledge base.
17460
17678
  */
17461
17679
  name: string;
17680
+ /**
17681
+ * Description of the knowledge base.
17682
+ */
17683
+ description?: string;
17462
17684
  /**
17463
17685
  * Knowledge base creation timestamp in ISO 8601 format
17464
17686
  */
@@ -17586,6 +17808,7 @@ declare class Client$4 extends Client$5 implements IClient$2 {
17586
17808
  }) => AsyncCollection<{
17587
17809
  id: string;
17588
17810
  name: string;
17811
+ description?: string;
17589
17812
  createdAt: string;
17590
17813
  tags: {
17591
17814
  [k: string]: string;
@@ -17599,7 +17822,8 @@ declare class Client$4 extends Client$5 implements IClient$2 {
17599
17822
  }
17600
17823
 
17601
17824
  declare namespace index$1 {
17602
- export { Client$4 as Client, type ClientInputs$2 as ClientInputs, type ClientOutputs$2 as ClientOutputs, type ClientProps$4 as ClientProps, type Operation$2 as Operation };
17825
+ export { Client$4 as Client };
17826
+ export type { ClientInputs$2 as ClientInputs, ClientOutputs$2 as ClientOutputs, ClientProps$4 as ClientProps, Operation$2 as Operation };
17603
17827
  }
17604
17828
 
17605
17829
  type Primitive$1 = string | number | boolean;
@@ -19344,7 +19568,8 @@ declare class Client$2 extends Client$3 {
19344
19568
  }
19345
19569
 
19346
19570
  declare namespace index {
19347
- export { Client$2 as Client, type ClientInputs$1 as ClientInputs, type ClientOutputs$1 as ClientOutputs, type ClientProps$2 as ClientProps, type Operation$1 as Operation };
19571
+ export { Client$2 as Client };
19572
+ export type { ClientInputs$1 as ClientInputs, ClientOutputs$1 as ClientOutputs, ClientProps$2 as ClientProps, Operation$1 as Operation };
19348
19573
  }
19349
19574
 
19350
19575
  type Primitive = string | number | boolean;
@@ -23551,10 +23776,6 @@ interface ListPublicPluginsResponse {
23551
23776
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
23552
23777
  */
23553
23778
  iconUrl: string;
23554
- /**
23555
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
23556
- */
23557
- readmeUrl: string;
23558
23779
  /**
23559
23780
  * @deprecated
23560
23781
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -24783,17 +25004,6 @@ interface CreateBotRequestBody {
24783
25004
  };
24784
25005
  };
24785
25006
  };
24786
- /**
24787
- * Subscriptions of the bot
24788
- */
24789
- subscriptions?: {
24790
- /**
24791
- * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
24792
- */
24793
- events: {
24794
- [k: string]: {};
24795
- } | null;
24796
- };
24797
25007
  /**
24798
25008
  * Actions definition
24799
25009
  */
@@ -24901,6 +25111,58 @@ interface CreateBotRequestBody {
24901
25111
  tags?: {
24902
25112
  [k: string]: string;
24903
25113
  };
25114
+ /**
25115
+ * Maximum execution time (in seconds).
25116
+ */
25117
+ maxExecutionTime?: number;
25118
+ /**
25119
+ * Subscriptions of the bot
25120
+ */
25121
+ subscriptions?: {
25122
+ /**
25123
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
25124
+ */
25125
+ integrations?: {
25126
+ [k: string]: {
25127
+ /**
25128
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
25129
+ */
25130
+ events: {
25131
+ include?: string[];
25132
+ exclude?: string[];
25133
+ } | null;
25134
+ };
25135
+ };
25136
+ /**
25137
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
25138
+ */
25139
+ plugins?: {
25140
+ [k: string]: {
25141
+ /**
25142
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
25143
+ */
25144
+ events: {
25145
+ include?: string[];
25146
+ exclude?: string[];
25147
+ } | null;
25148
+ };
25149
+ };
25150
+ bot?: {
25151
+ /**
25152
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
25153
+ */
25154
+ events: {
25155
+ include?: string[];
25156
+ exclude?: string[];
25157
+ } | null;
25158
+ };
25159
+ /**
25160
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
25161
+ */
25162
+ events?: {
25163
+ [k: string]: {} | null;
25164
+ } | null;
25165
+ };
24904
25166
  /**
24905
25167
  * JavaScript code of the bot
24906
25168
  */
@@ -24934,14 +25196,7 @@ interface CreateBotRequestBody {
24934
25196
  * Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
24935
25197
  */
24936
25198
  dev?: boolean;
24937
- /**
24938
- * Type of the [Bot](#schema_bot)
24939
- */
24940
- type?: "studio" | "adk" | "desk";
24941
- /**
24942
- * Maximum execution time (in seconds).
24943
- */
24944
- maxExecutionTime?: number;
25199
+ type?: "studio" | "adk";
24945
25200
  }
24946
25201
  type CreateBotInput = CreateBotRequestBody & CreateBotRequestHeaders & CreateBotRequestQuery & CreateBotRequestParams;
24947
25202
  interface CreateBotResponse {
@@ -25093,10 +25348,6 @@ interface CreateBotResponse {
25093
25348
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
25094
25349
  */
25095
25350
  iconUrl: string;
25096
- /**
25097
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
25098
- */
25099
- readmeUrl: string;
25100
25351
  /**
25101
25352
  * @deprecated
25102
25353
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -25268,11 +25519,48 @@ interface CreateBotResponse {
25268
25519
  */
25269
25520
  subscriptions: {
25270
25521
  /**
25271
- * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
25522
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
25272
25523
  */
25273
25524
  events: {
25274
25525
  [k: string]: {};
25275
25526
  } | null;
25527
+ /**
25528
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
25529
+ */
25530
+ integrations?: {
25531
+ [k: string]: {
25532
+ /**
25533
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
25534
+ */
25535
+ events: {
25536
+ include?: string[];
25537
+ exclude?: string[];
25538
+ } | null;
25539
+ };
25540
+ };
25541
+ /**
25542
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
25543
+ */
25544
+ plugins?: {
25545
+ [k: string]: {
25546
+ /**
25547
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
25548
+ */
25549
+ events: {
25550
+ include?: string[];
25551
+ exclude?: string[];
25552
+ } | null;
25553
+ };
25554
+ };
25555
+ bot?: {
25556
+ /**
25557
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
25558
+ */
25559
+ events: {
25560
+ include?: string[];
25561
+ exclude?: string[];
25562
+ } | null;
25563
+ };
25276
25564
  };
25277
25565
  /**
25278
25566
  * Actions definition
@@ -25398,11 +25686,11 @@ interface UpdateBotRequestBody {
25398
25686
  [k: string]: any;
25399
25687
  };
25400
25688
  };
25401
- blocked?: boolean;
25402
25689
  /**
25403
25690
  * Maximum execution time (in seconds).
25404
25691
  */
25405
25692
  maxExecutionTime?: number;
25693
+ blocked?: boolean;
25406
25694
  /**
25407
25695
  * Indicates if the [Bot](#schema_bot) should be in always alive mode
25408
25696
  */
@@ -25601,8 +25889,51 @@ interface UpdateBotRequestBody {
25601
25889
  };
25602
25890
  } | null;
25603
25891
  };
25892
+ /**
25893
+ * Subscriptions of the bot
25894
+ */
25604
25895
  subscriptions?: {
25605
- events: {
25896
+ /**
25897
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
25898
+ */
25899
+ integrations?: {
25900
+ [k: string]: {
25901
+ /**
25902
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
25903
+ */
25904
+ events: {
25905
+ include?: string[];
25906
+ exclude?: string[];
25907
+ } | null;
25908
+ };
25909
+ };
25910
+ /**
25911
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
25912
+ */
25913
+ plugins?: {
25914
+ [k: string]: {
25915
+ /**
25916
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
25917
+ */
25918
+ events: {
25919
+ include?: string[];
25920
+ exclude?: string[];
25921
+ } | null;
25922
+ };
25923
+ };
25924
+ bot?: {
25925
+ /**
25926
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
25927
+ */
25928
+ events: {
25929
+ include?: string[];
25930
+ exclude?: string[];
25931
+ } | null;
25932
+ };
25933
+ /**
25934
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
25935
+ */
25936
+ events?: {
25606
25937
  [k: string]: {} | null;
25607
25938
  } | null;
25608
25939
  };
@@ -25632,10 +25963,7 @@ interface UpdateBotRequestBody {
25632
25963
  [k: string]: string | null;
25633
25964
  };
25634
25965
  layers?: string[];
25635
- /**
25636
- * Type of the [Bot](#schema_bot)
25637
- */
25638
- type?: "studio" | "adk" | "desk";
25966
+ type?: "studio" | "adk";
25639
25967
  }
25640
25968
  type UpdateBotInput = UpdateBotRequestBody & UpdateBotRequestHeaders & UpdateBotRequestQuery & UpdateBotRequestParams;
25641
25969
  interface UpdateBotResponse {
@@ -25787,10 +26115,6 @@ interface UpdateBotResponse {
25787
26115
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
25788
26116
  */
25789
26117
  iconUrl: string;
25790
- /**
25791
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
25792
- */
25793
- readmeUrl: string;
25794
26118
  /**
25795
26119
  * @deprecated
25796
26120
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -25962,11 +26286,48 @@ interface UpdateBotResponse {
25962
26286
  */
25963
26287
  subscriptions: {
25964
26288
  /**
25965
- * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
26289
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
25966
26290
  */
25967
26291
  events: {
25968
26292
  [k: string]: {};
25969
26293
  } | null;
26294
+ /**
26295
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
26296
+ */
26297
+ integrations?: {
26298
+ [k: string]: {
26299
+ /**
26300
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
26301
+ */
26302
+ events: {
26303
+ include?: string[];
26304
+ exclude?: string[];
26305
+ } | null;
26306
+ };
26307
+ };
26308
+ /**
26309
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
26310
+ */
26311
+ plugins?: {
26312
+ [k: string]: {
26313
+ /**
26314
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
26315
+ */
26316
+ events: {
26317
+ include?: string[];
26318
+ exclude?: string[];
26319
+ } | null;
26320
+ };
26321
+ };
26322
+ bot?: {
26323
+ /**
26324
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
26325
+ */
26326
+ events: {
26327
+ include?: string[];
26328
+ exclude?: string[];
26329
+ } | null;
26330
+ };
25970
26331
  };
25971
26332
  /**
25972
26333
  * Actions definition
@@ -26309,10 +26670,6 @@ interface GetBotResponse {
26309
26670
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
26310
26671
  */
26311
26672
  iconUrl: string;
26312
- /**
26313
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
26314
- */
26315
- readmeUrl: string;
26316
26673
  /**
26317
26674
  * @deprecated
26318
26675
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -26484,11 +26841,48 @@ interface GetBotResponse {
26484
26841
  */
26485
26842
  subscriptions: {
26486
26843
  /**
26487
- * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
26844
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
26488
26845
  */
26489
26846
  events: {
26490
26847
  [k: string]: {};
26491
26848
  } | null;
26849
+ /**
26850
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
26851
+ */
26852
+ integrations?: {
26853
+ [k: string]: {
26854
+ /**
26855
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
26856
+ */
26857
+ events: {
26858
+ include?: string[];
26859
+ exclude?: string[];
26860
+ } | null;
26861
+ };
26862
+ };
26863
+ /**
26864
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
26865
+ */
26866
+ plugins?: {
26867
+ [k: string]: {
26868
+ /**
26869
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
26870
+ */
26871
+ events: {
26872
+ include?: string[];
26873
+ exclude?: string[];
26874
+ } | null;
26875
+ };
26876
+ };
26877
+ bot?: {
26878
+ /**
26879
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
26880
+ */
26881
+ events: {
26882
+ include?: string[];
26883
+ exclude?: string[];
26884
+ } | null;
26885
+ };
26492
26886
  };
26493
26887
  /**
26494
26888
  * Actions definition
@@ -26661,7 +27055,7 @@ interface GetBotAnalyticsResponse {
26661
27055
  */
26662
27056
  startDateTimeUtc: string;
26663
27057
  /**
26664
- * ISO 8601 date string of the end (inclusive) of the period
27058
+ * ISO 8601 date string of the end (exclusive) of the period
26665
27059
  */
26666
27060
  endDateTimeUtc: string;
26667
27061
  returningUsers: number;
@@ -26674,12 +27068,46 @@ interface GetBotAnalyticsResponse {
26674
27068
  userMessages: number;
26675
27069
  botMessages: number;
26676
27070
  events: number;
27071
+ /**
27072
+ * Number of conversations created during the period
27073
+ */
27074
+ conversationsCreated: number;
26677
27075
  eventTypes: {
26678
27076
  [k: string]: number;
26679
27077
  };
26680
27078
  customEvents: {
26681
27079
  [k: string]: number;
26682
27080
  };
27081
+ workflows: {
27082
+ created: number;
27083
+ completed: number;
27084
+ failed: number;
27085
+ timedout: number;
27086
+ cancelled: number;
27087
+ duration: {
27088
+ count: number;
27089
+ sum: number;
27090
+ mean: number;
27091
+ min: number;
27092
+ max: number;
27093
+ };
27094
+ byName: {
27095
+ [k: string]: {
27096
+ created: number;
27097
+ completed: number;
27098
+ failed: number;
27099
+ timedout: number;
27100
+ cancelled: number;
27101
+ duration: {
27102
+ count: number;
27103
+ sum: number;
27104
+ mean: number;
27105
+ min: number;
27106
+ max: number;
27107
+ };
27108
+ };
27109
+ };
27110
+ };
26683
27111
  llm: {
26684
27112
  calls: number;
26685
27113
  errors: number;
@@ -33780,10 +34208,6 @@ interface ListPluginsResponse {
33780
34208
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
33781
34209
  */
33782
34210
  iconUrl: string;
33783
- /**
33784
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
33785
- */
33786
- readmeUrl: string;
33787
34211
  /**
33788
34212
  * @deprecated
33789
34213
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -35039,6 +35463,10 @@ interface CreateKnowledgeBaseRequestBody {
35039
35463
  * Name of the knowledge base.
35040
35464
  */
35041
35465
  name: string;
35466
+ /**
35467
+ * Description of the knowledge base.
35468
+ */
35469
+ description?: string;
35042
35470
  tags?: {
35043
35471
  [k: string]: string;
35044
35472
  };
@@ -35054,6 +35482,10 @@ interface CreateKnowledgeBaseResponse {
35054
35482
  * Name of the knowledge base.
35055
35483
  */
35056
35484
  name: string;
35485
+ /**
35486
+ * Description of the knowledge base.
35487
+ */
35488
+ description?: string;
35057
35489
  tags: {
35058
35490
  [k: string]: string;
35059
35491
  };
@@ -35085,6 +35517,10 @@ interface UpdateKnowledgeBaseRequestBody {
35085
35517
  * New name of the knowledge base.
35086
35518
  */
35087
35519
  name: string;
35520
+ /**
35521
+ * Description of the knowledge base. Omit to keep the existing description; set to `null` to clear it.
35522
+ */
35523
+ description?: string | null;
35088
35524
  /**
35089
35525
  * The knowledge base tags to update as an object of key-value pairs with `string` (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`.
35090
35526
  */
@@ -35103,6 +35539,10 @@ interface UpdateKnowledgeBaseResponse {
35103
35539
  * Name of the knowledge base.
35104
35540
  */
35105
35541
  name: string;
35542
+ /**
35543
+ * Description of the knowledge base.
35544
+ */
35545
+ description?: string;
35106
35546
  tags: {
35107
35547
  [k: string]: string;
35108
35548
  };
@@ -35131,6 +35571,10 @@ interface ListKnowledgeBasesResponse {
35131
35571
  * Name of the knowledge base.
35132
35572
  */
35133
35573
  name: string;
35574
+ /**
35575
+ * Description of the knowledge base.
35576
+ */
35577
+ description?: string;
35134
35578
  /**
35135
35579
  * Knowledge base creation timestamp in ISO 8601 format
35136
35580
  */
@@ -36977,10 +37421,6 @@ interface Bot {
36977
37421
  * URL of the icon of the plugin. This is the icon that will be displayed in the UI
36978
37422
  */
36979
37423
  iconUrl: string;
36980
- /**
36981
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
36982
- */
36983
- readmeUrl: string;
36984
37424
  /**
36985
37425
  * @deprecated
36986
37426
  * [DEPRECATED] Indicates if the plugin is public. Please use the "visibility" parameter instead.
@@ -37152,11 +37592,48 @@ interface Bot {
37152
37592
  */
37153
37593
  subscriptions: {
37154
37594
  /**
37155
- * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
37595
+ * [DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events.
37156
37596
  */
37157
37597
  events: {
37158
37598
  [k: string]: {};
37159
37599
  } | null;
37600
+ /**
37601
+ * Subscriptions for events coming from specific integrations. Keyed by integration alias.
37602
+ */
37603
+ integrations?: {
37604
+ [k: string]: {
37605
+ /**
37606
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
37607
+ */
37608
+ events: {
37609
+ include?: string[];
37610
+ exclude?: string[];
37611
+ } | null;
37612
+ };
37613
+ };
37614
+ /**
37615
+ * Subscriptions for events coming from specific plugins. Keyed by plugin alias.
37616
+ */
37617
+ plugins?: {
37618
+ [k: string]: {
37619
+ /**
37620
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
37621
+ */
37622
+ events: {
37623
+ include?: string[];
37624
+ exclude?: string[];
37625
+ } | null;
37626
+ };
37627
+ };
37628
+ bot?: {
37629
+ /**
37630
+ * Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.
37631
+ */
37632
+ events: {
37633
+ include?: string[];
37634
+ exclude?: string[];
37635
+ } | null;
37636
+ };
37160
37637
  };
37161
37638
  /**
37162
37639
  * Actions definition
@@ -38956,10 +39433,10 @@ declare class Client extends Client$1 implements IClient {
38956
39433
  constructor(clientProps?: ClientProps);
38957
39434
  get list(): {
38958
39435
  conversations: (props: {
39436
+ channel?: string | undefined;
38959
39437
  tags?: {
38960
39438
  [x: string]: string;
38961
39439
  } | undefined;
38962
- channel?: string | undefined;
38963
39440
  integrationName?: string | undefined;
38964
39441
  pageSize?: number | undefined;
38965
39442
  sortField?: "createdAt" | "updatedAt" | undefined;
@@ -39004,13 +39481,13 @@ declare class Client extends Client$1 implements IClient {
39004
39481
  };
39005
39482
  }>;
39006
39483
  events: (props: {
39007
- status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
39008
- type?: string | undefined;
39009
39484
  pageSize?: number | undefined;
39010
39485
  userId?: string | undefined;
39486
+ type?: string | undefined;
39011
39487
  conversationId?: string | undefined;
39012
39488
  workflowId?: string | undefined;
39013
39489
  messageId?: string | undefined;
39490
+ status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
39014
39491
  }) => AsyncCollection<{
39015
39492
  id: string;
39016
39493
  createdAt: string;
@@ -39076,7 +39553,6 @@ declare class Client extends Client$1 implements IClient {
39076
39553
  };
39077
39554
  }>;
39078
39555
  publicIntegrations: (props: {
39079
- search?: string | undefined;
39080
39556
  pageSize?: number | undefined;
39081
39557
  name?: string | undefined;
39082
39558
  limit?: number | undefined;
@@ -39085,6 +39561,7 @@ declare class Client extends Client$1 implements IClient {
39085
39561
  interfaceName?: string | undefined;
39086
39562
  installedByBotId?: string | undefined;
39087
39563
  verificationStatus?: "unapproved" | "pending" | "approved" | "rejected" | undefined;
39564
+ search?: string | undefined;
39088
39565
  sortBy?: "popularity" | "name" | "createdAt" | "updatedAt" | "installCount" | undefined;
39089
39566
  direction?: "asc" | "desc" | undefined;
39090
39567
  }) => AsyncCollection<{
@@ -39166,15 +39643,14 @@ declare class Client extends Client$1 implements IClient {
39166
39643
  handle?: string | undefined;
39167
39644
  }) => AsyncCollection<UpdateWorkspaceResponse>;
39168
39645
  publicWorkspaces: (props: {
39169
- search?: string | undefined;
39170
39646
  pageSize?: number | undefined;
39647
+ search?: string | undefined;
39171
39648
  workspaceIds?: string[] | undefined;
39172
39649
  }) => AsyncCollection<GetPublicWorkspaceResponse>;
39173
39650
  workspaceMembers: (props: {
39174
39651
  pageSize?: number | undefined;
39175
39652
  }) => AsyncCollection<UpdateWorkspaceMemberResponse$1>;
39176
39653
  integrations: (props: {
39177
- search?: string | undefined;
39178
39654
  pageSize?: number | undefined;
39179
39655
  name?: string | undefined;
39180
39656
  limit?: number | undefined;
@@ -39183,6 +39659,7 @@ declare class Client extends Client$1 implements IClient {
39183
39659
  interfaceName?: string | undefined;
39184
39660
  installedByBotId?: string | undefined;
39185
39661
  verificationStatus?: "unapproved" | "pending" | "approved" | "rejected" | undefined;
39662
+ search?: string | undefined;
39186
39663
  sortBy?: "popularity" | "name" | "createdAt" | "updatedAt" | "installCount" | undefined;
39187
39664
  direction?: "asc" | "desc" | undefined;
39188
39665
  dev?: boolean | undefined;
@@ -39261,7 +39738,6 @@ declare class Client extends Client$1 implements IClient {
39261
39738
  title: string;
39262
39739
  description: string;
39263
39740
  iconUrl: string;
39264
- readmeUrl: string;
39265
39741
  public: boolean;
39266
39742
  visibility: "public" | "private" | "unlisted";
39267
39743
  lifecycleStatus: "published" | "deprecated";
@@ -39279,14 +39755,13 @@ declare class Client extends Client$1 implements IClient {
39279
39755
  title: string;
39280
39756
  description: string;
39281
39757
  iconUrl: string;
39282
- readmeUrl: string;
39283
39758
  public: boolean;
39284
39759
  visibility: "public" | "private" | "unlisted";
39285
39760
  lifecycleStatus: "published" | "deprecated";
39286
39761
  }>;
39287
39762
  activities: (props: {
39288
- botId: string;
39289
39763
  pageSize?: number | undefined;
39764
+ botId: string;
39290
39765
  taskId: string;
39291
39766
  }) => AsyncCollection<{
39292
39767
  id: string;
@@ -39361,15 +39836,16 @@ declare class Client extends Client$1 implements IClient {
39361
39836
  }) => AsyncCollection<{
39362
39837
  id: string;
39363
39838
  name: string;
39839
+ description?: string;
39364
39840
  createdAt: string;
39365
39841
  tags: {
39366
39842
  [k: string]: string;
39367
39843
  };
39368
39844
  }>;
39369
39845
  usageActivity: (props: {
39370
- type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
39371
39846
  id: string;
39372
39847
  pageSize?: number | undefined;
39848
+ type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
39373
39849
  timestampFrom?: string | undefined;
39374
39850
  timestampUntil?: string | undefined;
39375
39851
  }) => AsyncCollection<{
@@ -39381,9 +39857,9 @@ declare class Client extends Client$1 implements IClient {
39381
39857
  };
39382
39858
  }>;
39383
39859
  usageActivityDaily: (props: {
39384
- type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
39385
39860
  id: string;
39386
39861
  pageSize?: number | undefined;
39862
+ type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
39387
39863
  dateFrom?: string | undefined;
39388
39864
  dateUntil?: string | undefined;
39389
39865
  }) => AsyncCollection<{
@@ -39406,7 +39882,7 @@ declare class Client extends Client$1 implements IClient {
39406
39882
  conversationId?: string | undefined;
39407
39883
  name?: string | undefined;
39408
39884
  parentWorkflowId?: string | undefined;
39409
- statuses?: ("pending" | "failed" | "in_progress" | "listening" | "completed" | "paused" | "timedout" | "cancelled")[] | undefined;
39885
+ statuses?: ("pending" | "failed" | "in_progress" | "completed" | "listening" | "paused" | "timedout" | "cancelled")[] | undefined;
39410
39886
  }) => AsyncCollection<{
39411
39887
  id: string;
39412
39888
  name: string;
@@ -39671,4 +40147,5 @@ declare class UploadFileError extends Error {
39671
40147
  constructor(message: string, innerError?: AxiosError | undefined, file?: UpsertFileResponse["file"] | undefined);
39672
40148
  }
39673
40149
 
39674
- export { type Account, type Activity, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientProps, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type Headers, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, OperationTimeoutError, PayloadTooLargeError, PaymentRequiredError, type Plugin, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceGoneError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Version, type Workflow, type Workspace, type WorkspaceMember, index$3 as admin, index$2 as billing, errorFrom, index$1 as files, isApiError, index$4 as runtime, index as tables };
40150
+ export { AlreadyExistsError, BreakingChangesError, Client, ForbiddenError, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, LimitExceededError, MethodNotFoundError, OperationTimeoutError, PayloadTooLargeError, PaymentRequiredError, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceGoneError, ResourceLockedConflictError, ResourceNotFoundError, RuntimeError, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, index$3 as admin, index$2 as billing, errorFrom, index$1 as files, isApiError, index$4 as runtime, index as tables };
40151
+ export type { Account, Activity, ApiError, Bot, ClientConfig, ClientInputs, ClientOutputs, ClientProps, Column, Conversation, ErrorType, Event, File, Headers, Integration, Interface, Issue, IssueEvent, Message, Operation, Plugin, RetryConfig, Row, State, Table, Usage, User, Version, Workflow, Workspace, WorkspaceMember };