@botpress/client 2.1.0 → 2.2.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
@@ -3327,14 +3327,14 @@ declare class Client$a extends Client$b {
3327
3327
  constructor(clientProps: ClientProps$a);
3328
3328
  get list(): {
3329
3329
  conversations: (props: {
3330
- channel?: string | undefined;
3330
+ pageSize?: number | undefined;
3331
3331
  tags?: {
3332
3332
  [x: string]: string;
3333
3333
  } | undefined;
3334
- integrationName?: string | undefined;
3335
- pageSize?: number | undefined;
3336
3334
  sortField?: "createdAt" | "updatedAt" | undefined;
3337
3335
  sortDirection?: "asc" | "desc" | undefined;
3336
+ integrationName?: string | undefined;
3337
+ channel?: string | undefined;
3338
3338
  participantIds?: string[] | undefined;
3339
3339
  afterDate?: string | undefined;
3340
3340
  beforeDate?: string | undefined;
@@ -3376,10 +3376,10 @@ declare class Client$a extends Client$b {
3376
3376
  }>;
3377
3377
  events: (props: {
3378
3378
  pageSize?: number | undefined;
3379
- userId?: string | undefined;
3380
3379
  type?: string | undefined;
3381
- conversationId?: string | undefined;
3380
+ userId?: string | undefined;
3382
3381
  workflowId?: string | undefined;
3382
+ conversationId?: string | undefined;
3383
3383
  messageId?: string | undefined;
3384
3384
  status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
3385
3385
  }) => AsyncCollection<{
@@ -3396,13 +3396,13 @@ declare class Client$a extends Client$b {
3396
3396
  failureReason: string | null;
3397
3397
  }>;
3398
3398
  messages: (props: {
3399
+ pageSize?: number | undefined;
3399
3400
  tags?: {
3400
3401
  [x: string]: string;
3401
3402
  } | undefined;
3402
- pageSize?: number | undefined;
3403
+ conversationId?: string | undefined;
3403
3404
  afterDate?: string | undefined;
3404
3405
  beforeDate?: string | undefined;
3405
- conversationId?: string | undefined;
3406
3406
  }) => AsyncCollection<{
3407
3407
  id: string;
3408
3408
  createdAt: string;
@@ -3420,15 +3420,15 @@ declare class Client$a extends Client$b {
3420
3420
  origin?: "synthetic";
3421
3421
  }>;
3422
3422
  users: (props: {
3423
+ pageSize?: number | undefined;
3423
3424
  tags?: {
3424
3425
  [x: string]: string;
3425
3426
  } | undefined;
3426
- pageSize?: number | undefined;
3427
3427
  sortField?: "updatedAt" | "createdAt" | undefined;
3428
3428
  sortDirection?: "asc" | "desc" | undefined;
3429
+ conversationId?: string | undefined;
3429
3430
  afterDate?: string | undefined;
3430
3431
  beforeDate?: string | undefined;
3431
- conversationId?: string | undefined;
3432
3432
  rangeField?: "updatedAt" | "createdAt" | undefined;
3433
3433
  }) => AsyncCollection<{
3434
3434
  id: string;
@@ -15506,8 +15506,8 @@ declare class Client$8 extends Client$9 {
15506
15506
  get list(): {
15507
15507
  publicIntegrations: (props: {
15508
15508
  pageSize?: number | undefined;
15509
- name?: string | undefined;
15510
15509
  limit?: number | undefined;
15510
+ name?: string | undefined;
15511
15511
  version?: string | undefined;
15512
15512
  interfaceId?: string | undefined;
15513
15513
  interfaceName?: string | undefined;
@@ -15550,15 +15550,15 @@ declare class Client$8 extends Client$9 {
15550
15550
  };
15551
15551
  }>;
15552
15552
  bots: (props: {
15553
+ pageSize?: number | undefined;
15553
15554
  tags?: {
15554
15555
  [x: string]: string;
15555
15556
  } | undefined;
15556
- pageSize?: number | undefined;
15557
- sortField?: "createdAt" | "updatedAt" | undefined;
15558
- sortDirection?: "asc" | "desc" | undefined;
15559
15557
  dev?: boolean | undefined;
15560
15558
  integrationNames?: string[] | undefined;
15561
15559
  pluginNames?: string[] | undefined;
15560
+ sortField?: "createdAt" | "updatedAt" | undefined;
15561
+ sortDirection?: "asc" | "desc" | undefined;
15562
15562
  }) => AsyncCollection<{
15563
15563
  id: string;
15564
15564
  createdAt: string;
@@ -15612,8 +15612,8 @@ declare class Client$8 extends Client$9 {
15612
15612
  }>;
15613
15613
  integrations: (props: {
15614
15614
  pageSize?: number | undefined;
15615
- name?: string | undefined;
15616
15615
  limit?: number | undefined;
15616
+ name?: string | undefined;
15617
15617
  version?: string | undefined;
15618
15618
  interfaceId?: string | undefined;
15619
15619
  interfaceName?: string | undefined;
@@ -16407,7 +16407,11 @@ interface GetAutoRechargeSettingsResponse {
16407
16407
  settings: {
16408
16408
  [k: string]: {
16409
16409
  enabled: boolean;
16410
- threshold?: number;
16410
+ targetType?: "addon" | "credit_grant";
16411
+ threshold?: number | null;
16412
+ addonId?: string;
16413
+ chunkSize?: number | null;
16414
+ maxAmount?: number | null;
16411
16415
  disabledReason?: string;
16412
16416
  };
16413
16417
  };
@@ -16423,7 +16427,11 @@ interface SetAutoRechargeSettingsRequestBody {
16423
16427
  settings: {
16424
16428
  [k: string]: {
16425
16429
  enabled: boolean;
16426
- threshold?: number;
16430
+ targetType?: "addon" | "credit_grant";
16431
+ threshold?: number | null;
16432
+ addonId?: string;
16433
+ chunkSize?: number | null;
16434
+ maxAmount?: number | null;
16427
16435
  };
16428
16436
  };
16429
16437
  }
@@ -16432,7 +16440,11 @@ interface SetAutoRechargeSettingsResponse {
16432
16440
  settings: {
16433
16441
  [k: string]: {
16434
16442
  enabled: boolean;
16435
- threshold?: number;
16443
+ targetType?: "addon" | "credit_grant";
16444
+ threshold?: number | null;
16445
+ addonId?: string;
16446
+ chunkSize?: number | null;
16447
+ maxAmount?: number | null;
16436
16448
  disabledReason?: string;
16437
16449
  };
16438
16450
  };
@@ -16496,7 +16508,7 @@ interface CreateCreditGrantRequestParams {
16496
16508
  }
16497
16509
  interface CreateCreditGrantRequestBody {
16498
16510
  /**
16499
- * Nanodollar value of the credit grant (e.g. 10_000_000_000 = $10.00 USD)
16511
+ * Nanodollar value of the credit grant, must be a multiple of $5 (e.g. 10_000_000_000 = $10.00 USD)
16500
16512
  */
16501
16513
  amount: number;
16502
16514
  feature: "ai_spend";
@@ -17993,8 +18005,8 @@ declare class Client$4 extends Client$5 implements IClient$2 {
17993
18005
  constructor(clientProps: ClientProps$4);
17994
18006
  get list(): {
17995
18007
  files: (props: {
17996
- tags?: any;
17997
18008
  pageSize?: number | undefined;
18009
+ tags?: any;
17998
18010
  sortField?: "key" | "size" | "createdAt" | "updatedAt" | "status" | undefined;
17999
18011
  sortDirection?: "asc" | "desc" | undefined;
18000
18012
  ids?: string[] | undefined;
@@ -18050,8 +18062,8 @@ declare class Client$4 extends Client$5 implements IClient$2 {
18050
18062
  tag: string;
18051
18063
  }) => AsyncCollection<string>;
18052
18064
  knowledgeBases: (props: {
18053
- tags?: any;
18054
18065
  pageSize?: number | undefined;
18066
+ tags?: any;
18055
18067
  }) => AsyncCollection<{
18056
18068
  id: string;
18057
18069
  name: string;
@@ -39801,14 +39813,14 @@ declare class Client extends Client$1 implements IClient {
39801
39813
  constructor(clientProps?: ClientProps);
39802
39814
  get list(): {
39803
39815
  conversations: (props: {
39804
- channel?: string | undefined;
39816
+ pageSize?: number | undefined;
39805
39817
  tags?: {
39806
39818
  [x: string]: string;
39807
39819
  } | undefined;
39808
- integrationName?: string | undefined;
39809
- pageSize?: number | undefined;
39810
39820
  sortField?: "createdAt" | "updatedAt" | undefined;
39811
39821
  sortDirection?: "asc" | "desc" | undefined;
39822
+ integrationName?: string | undefined;
39823
+ channel?: string | undefined;
39812
39824
  participantIds?: string[] | undefined;
39813
39825
  afterDate?: string | undefined;
39814
39826
  beforeDate?: string | undefined;
@@ -39850,10 +39862,10 @@ declare class Client extends Client$1 implements IClient {
39850
39862
  }>;
39851
39863
  events: (props: {
39852
39864
  pageSize?: number | undefined;
39853
- userId?: string | undefined;
39854
39865
  type?: string | undefined;
39855
- conversationId?: string | undefined;
39866
+ userId?: string | undefined;
39856
39867
  workflowId?: string | undefined;
39868
+ conversationId?: string | undefined;
39857
39869
  messageId?: string | undefined;
39858
39870
  status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
39859
39871
  }) => AsyncCollection<{
@@ -39870,13 +39882,13 @@ declare class Client extends Client$1 implements IClient {
39870
39882
  failureReason: string | null;
39871
39883
  }>;
39872
39884
  messages: (props: {
39885
+ pageSize?: number | undefined;
39873
39886
  tags?: {
39874
39887
  [x: string]: string;
39875
39888
  } | undefined;
39876
- pageSize?: number | undefined;
39889
+ conversationId?: string | undefined;
39877
39890
  afterDate?: string | undefined;
39878
39891
  beforeDate?: string | undefined;
39879
- conversationId?: string | undefined;
39880
39892
  }) => AsyncCollection<{
39881
39893
  id: string;
39882
39894
  createdAt: string;
@@ -39894,15 +39906,15 @@ declare class Client extends Client$1 implements IClient {
39894
39906
  origin?: "synthetic";
39895
39907
  }>;
39896
39908
  users: (props: {
39909
+ pageSize?: number | undefined;
39897
39910
  tags?: {
39898
39911
  [x: string]: string;
39899
39912
  } | undefined;
39900
- pageSize?: number | undefined;
39901
39913
  sortField?: "updatedAt" | "createdAt" | undefined;
39902
39914
  sortDirection?: "asc" | "desc" | undefined;
39915
+ conversationId?: string | undefined;
39903
39916
  afterDate?: string | undefined;
39904
39917
  beforeDate?: string | undefined;
39905
- conversationId?: string | undefined;
39906
39918
  rangeField?: "updatedAt" | "createdAt" | undefined;
39907
39919
  }) => AsyncCollection<{
39908
39920
  id: string;
@@ -39922,8 +39934,8 @@ declare class Client extends Client$1 implements IClient {
39922
39934
  }>;
39923
39935
  publicIntegrations: (props: {
39924
39936
  pageSize?: number | undefined;
39925
- name?: string | undefined;
39926
39937
  limit?: number | undefined;
39938
+ name?: string | undefined;
39927
39939
  version?: string | undefined;
39928
39940
  interfaceId?: string | undefined;
39929
39941
  interfaceName?: string | undefined;
@@ -39966,15 +39978,15 @@ declare class Client extends Client$1 implements IClient {
39966
39978
  };
39967
39979
  }>;
39968
39980
  bots: (props: {
39981
+ pageSize?: number | undefined;
39969
39982
  tags?: {
39970
39983
  [x: string]: string;
39971
39984
  } | undefined;
39972
- pageSize?: number | undefined;
39973
- sortField?: "createdAt" | "updatedAt" | undefined;
39974
- sortDirection?: "asc" | "desc" | undefined;
39975
39985
  dev?: boolean | undefined;
39976
39986
  integrationNames?: string[] | undefined;
39977
39987
  pluginNames?: string[] | undefined;
39988
+ sortField?: "createdAt" | "updatedAt" | undefined;
39989
+ sortDirection?: "asc" | "desc" | undefined;
39978
39990
  }) => AsyncCollection<{
39979
39991
  id: string;
39980
39992
  createdAt: string;
@@ -40020,8 +40032,8 @@ declare class Client extends Client$1 implements IClient {
40020
40032
  }) => AsyncCollection<UpdateWorkspaceMemberResponse$1>;
40021
40033
  integrations: (props: {
40022
40034
  pageSize?: number | undefined;
40023
- name?: string | undefined;
40024
40035
  limit?: number | undefined;
40036
+ name?: string | undefined;
40025
40037
  version?: string | undefined;
40026
40038
  interfaceId?: string | undefined;
40027
40039
  interfaceName?: string | undefined;
@@ -40142,8 +40154,8 @@ declare class Client extends Client$1 implements IClient {
40142
40154
  createdAt: string;
40143
40155
  }>;
40144
40156
  files: (props: {
40145
- tags?: any;
40146
40157
  pageSize?: number | undefined;
40158
+ tags?: any;
40147
40159
  sortField?: "key" | "size" | "createdAt" | "updatedAt" | "status" | undefined;
40148
40160
  sortDirection?: "asc" | "desc" | undefined;
40149
40161
  ids?: string[] | undefined;
@@ -40199,8 +40211,8 @@ declare class Client extends Client$1 implements IClient {
40199
40211
  tag: string;
40200
40212
  }) => AsyncCollection<string>;
40201
40213
  knowledgeBases: (props: {
40202
- tags?: any;
40203
40214
  pageSize?: number | undefined;
40215
+ tags?: any;
40204
40216
  }) => AsyncCollection<{
40205
40217
  id: string;
40206
40218
  name: string;
@@ -40242,13 +40254,13 @@ declare class Client extends Client$1 implements IClient {
40242
40254
  };
40243
40255
  }>;
40244
40256
  workflows: (props: {
40257
+ pageSize?: number | undefined;
40258
+ name?: string | undefined;
40245
40259
  tags?: {
40246
40260
  [x: string]: string;
40247
40261
  } | undefined;
40248
- pageSize?: number | undefined;
40249
40262
  userId?: string | undefined;
40250
40263
  conversationId?: string | undefined;
40251
- name?: string | undefined;
40252
40264
  parentWorkflowId?: string | undefined;
40253
40265
  statuses?: ("pending" | "failed" | "in_progress" | "completed" | "listening" | "paused" | "timedout" | "cancelled")[] | undefined;
40254
40266
  }) => AsyncCollection<{