@botpress/client 2.2.0 → 2.4.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.
Files changed (8) hide show
  1. package/dist/bundle.cjs +5 -5
  2. package/dist/bundle.cjs.map +4 -4
  3. package/dist/index.cjs +5 -5
  4. package/dist/index.cjs.map +4 -4
  5. package/dist/index.d.ts +65 -54
  6. package/dist/index.mjs +5 -5
  7. package/dist/index.mjs.map +4 -4
  8. package/package.json +1 -1
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
- pageSize?: number | undefined;
3330
+ channel?: string | undefined;
3331
3331
  tags?: {
3332
3332
  [x: string]: string;
3333
3333
  } | undefined;
3334
+ integrationName?: string | undefined;
3335
+ pageSize?: number | undefined;
3334
3336
  sortField?: "createdAt" | "updatedAt" | undefined;
3335
3337
  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
- type?: string | undefined;
3380
3379
  userId?: string | undefined;
3381
- workflowId?: string | undefined;
3380
+ type?: string | undefined;
3382
3381
  conversationId?: string | undefined;
3382
+ workflowId?: 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;
3400
3399
  tags?: {
3401
3400
  [x: string]: string;
3402
3401
  } | undefined;
3403
- conversationId?: string | undefined;
3402
+ pageSize?: number | undefined;
3404
3403
  afterDate?: string | undefined;
3405
3404
  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;
3424
3423
  tags?: {
3425
3424
  [x: string]: string;
3426
3425
  } | undefined;
3426
+ pageSize?: number | undefined;
3427
3427
  sortField?: "updatedAt" | "createdAt" | undefined;
3428
3428
  sortDirection?: "asc" | "desc" | undefined;
3429
- conversationId?: string | undefined;
3430
3429
  afterDate?: string | undefined;
3431
3430
  beforeDate?: string | undefined;
3431
+ conversationId?: string | undefined;
3432
3432
  rangeField?: "updatedAt" | "createdAt" | undefined;
3433
3433
  }) => AsyncCollection<{
3434
3434
  id: string;
@@ -8610,7 +8610,7 @@ interface CreateWorkspaceResponse$1 {
8610
8610
  createdAt: string;
8611
8611
  updatedAt: string;
8612
8612
  botCount: number;
8613
- billingVersion: "v1" | "v2" | "v3" | "v4";
8613
+ billingVersion: "v1" | "v2" | "v3" | "v4" | "v5";
8614
8614
  plan: "community" | "team" | "enterprise" | "plus" | "managed";
8615
8615
  blocked: boolean;
8616
8616
  spendingLimit: number;
@@ -8664,7 +8664,7 @@ interface GetWorkspaceResponse$1 {
8664
8664
  createdAt: string;
8665
8665
  updatedAt: string;
8666
8666
  botCount: number;
8667
- billingVersion: "v1" | "v2" | "v3" | "v4";
8667
+ billingVersion: "v1" | "v2" | "v3" | "v4" | "v5";
8668
8668
  plan: "community" | "team" | "enterprise" | "plus" | "managed";
8669
8669
  blocked: boolean;
8670
8670
  spendingLimit: number;
@@ -8836,7 +8836,7 @@ interface UpdateWorkspaceResponse$3 {
8836
8836
  createdAt: string;
8837
8837
  updatedAt: string;
8838
8838
  botCount: number;
8839
- billingVersion: "v1" | "v2" | "v3" | "v4";
8839
+ billingVersion: "v1" | "v2" | "v3" | "v4" | "v5";
8840
8840
  plan: "community" | "team" | "enterprise" | "plus" | "managed";
8841
8841
  blocked: boolean;
8842
8842
  spendingLimit: number;
@@ -8894,7 +8894,7 @@ interface UpdateWorkspaceResponse$2 {
8894
8894
  createdAt: string;
8895
8895
  updatedAt: string;
8896
8896
  botCount: number;
8897
- billingVersion: "v1" | "v2" | "v3" | "v4";
8897
+ billingVersion: "v1" | "v2" | "v3" | "v4" | "v5";
8898
8898
  plan: "community" | "team" | "enterprise" | "plus" | "managed";
8899
8899
  blocked: boolean;
8900
8900
  spendingLimit: number;
@@ -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
- limit?: number | undefined;
15510
15509
  name?: string | undefined;
15510
+ limit?: number | 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;
15554
15553
  tags?: {
15555
15554
  [x: string]: string;
15556
15555
  } | undefined;
15556
+ pageSize?: number | undefined;
15557
+ sortField?: "createdAt" | "updatedAt" | undefined;
15558
+ sortDirection?: "asc" | "desc" | undefined;
15557
15559
  dev?: boolean | undefined;
15558
15560
  integrationNames?: string[] | undefined;
15559
15561
  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
- limit?: number | undefined;
15616
15615
  name?: string | undefined;
15616
+ limit?: number | undefined;
15617
15617
  version?: string | undefined;
15618
15618
  interfaceId?: string | undefined;
15619
15619
  interfaceName?: string | undefined;
@@ -16408,7 +16408,8 @@ interface GetAutoRechargeSettingsResponse {
16408
16408
  [k: string]: {
16409
16409
  enabled: boolean;
16410
16410
  targetType?: "addon" | "credit_grant";
16411
- threshold?: number | null;
16411
+ thresholdType?: "percentage" | "remaining_amount";
16412
+ threshold: number;
16412
16413
  addonId?: string;
16413
16414
  chunkSize?: number | null;
16414
16415
  maxAmount?: number | null;
@@ -16426,9 +16427,10 @@ interface SetAutoRechargeSettingsRequestParams {
16426
16427
  interface SetAutoRechargeSettingsRequestBody {
16427
16428
  settings: {
16428
16429
  [k: string]: {
16429
- enabled: boolean;
16430
+ enabled?: boolean;
16430
16431
  targetType?: "addon" | "credit_grant";
16431
- threshold?: number | null;
16432
+ thresholdType?: "percentage" | "remaining_amount";
16433
+ threshold?: number;
16432
16434
  addonId?: string;
16433
16435
  chunkSize?: number | null;
16434
16436
  maxAmount?: number | null;
@@ -16441,7 +16443,8 @@ interface SetAutoRechargeSettingsResponse {
16441
16443
  [k: string]: {
16442
16444
  enabled: boolean;
16443
16445
  targetType?: "addon" | "credit_grant";
16444
- threshold?: number | null;
16446
+ thresholdType?: "percentage" | "remaining_amount";
16447
+ threshold: number;
16445
16448
  addonId?: string;
16446
16449
  chunkSize?: number | null;
16447
16450
  maxAmount?: number | null;
@@ -16508,7 +16511,7 @@ interface CreateCreditGrantRequestParams {
16508
16511
  }
16509
16512
  interface CreateCreditGrantRequestBody {
16510
16513
  /**
16511
- * Nanodollar value of the credit grant, must be a multiple of $5 (e.g. 10_000_000_000 = $10.00 USD)
16514
+ * Nanodollar value of the credit grant, must be at least $5 and a whole dollar amount
16512
16515
  */
16513
16516
  amount: number;
16514
16517
  feature: "ai_spend";
@@ -18005,8 +18008,8 @@ declare class Client$4 extends Client$5 implements IClient$2 {
18005
18008
  constructor(clientProps: ClientProps$4);
18006
18009
  get list(): {
18007
18010
  files: (props: {
18008
- pageSize?: number | undefined;
18009
18011
  tags?: any;
18012
+ pageSize?: number | undefined;
18010
18013
  sortField?: "key" | "size" | "createdAt" | "updatedAt" | "status" | undefined;
18011
18014
  sortDirection?: "asc" | "desc" | undefined;
18012
18015
  ids?: string[] | undefined;
@@ -18062,8 +18065,8 @@ declare class Client$4 extends Client$5 implements IClient$2 {
18062
18065
  tag: string;
18063
18066
  }) => AsyncCollection<string>;
18064
18067
  knowledgeBases: (props: {
18065
- pageSize?: number | undefined;
18066
18068
  tags?: any;
18069
+ pageSize?: number | undefined;
18067
18070
  }) => AsyncCollection<{
18068
18071
  id: string;
18069
18072
  name: string;
@@ -18975,7 +18978,7 @@ interface ExportTableResponse$1 {
18975
18978
  id: string;
18976
18979
  botId: string;
18977
18980
  tableId: string;
18978
- type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
18981
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table" | "key_column";
18979
18982
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
18980
18983
  progress?: number;
18981
18984
  inputFileId: string | null;
@@ -19000,7 +19003,7 @@ interface GetTableJobsResponse$1 {
19000
19003
  id: string;
19001
19004
  botId: string;
19002
19005
  tableId: string;
19003
- type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
19006
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table" | "key_column";
19004
19007
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
19005
19008
  progress?: number;
19006
19009
  inputFileId: string | null;
@@ -19029,7 +19032,7 @@ interface ImportTableResponse$1 {
19029
19032
  id: string;
19030
19033
  botId: string;
19031
19034
  tableId: string;
19032
- type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
19035
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table" | "key_column";
19033
19036
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
19034
19037
  progress?: number;
19035
19038
  inputFileId: string | null;
@@ -19222,6 +19225,10 @@ interface UpdateTableResponse$1 {
19222
19225
  * List of columns that have become stale following the modification.
19223
19226
  */
19224
19227
  staleColumns?: string[];
19228
+ job?: {
19229
+ id: string;
19230
+ status: string;
19231
+ };
19225
19232
  }
19226
19233
 
19227
19234
  interface RenameTableColumnRequestHeaders$1 {
@@ -28096,7 +28103,7 @@ interface CreateWorkspaceResponse {
28096
28103
  createdAt: string;
28097
28104
  updatedAt: string;
28098
28105
  botCount: number;
28099
- billingVersion: "v1" | "v2" | "v3" | "v4";
28106
+ billingVersion: "v1" | "v2" | "v3" | "v4" | "v5";
28100
28107
  plan: "community" | "team" | "enterprise" | "plus" | "managed";
28101
28108
  blocked: boolean;
28102
28109
  spendingLimit: number;
@@ -28150,7 +28157,7 @@ interface GetWorkspaceResponse {
28150
28157
  createdAt: string;
28151
28158
  updatedAt: string;
28152
28159
  botCount: number;
28153
- billingVersion: "v1" | "v2" | "v3" | "v4";
28160
+ billingVersion: "v1" | "v2" | "v3" | "v4" | "v5";
28154
28161
  plan: "community" | "team" | "enterprise" | "plus" | "managed";
28155
28162
  blocked: boolean;
28156
28163
  spendingLimit: number;
@@ -28322,7 +28329,7 @@ interface UpdateWorkspaceResponse$1 {
28322
28329
  createdAt: string;
28323
28330
  updatedAt: string;
28324
28331
  botCount: number;
28325
- billingVersion: "v1" | "v2" | "v3" | "v4";
28332
+ billingVersion: "v1" | "v2" | "v3" | "v4" | "v5";
28326
28333
  plan: "community" | "team" | "enterprise" | "plus" | "managed";
28327
28334
  blocked: boolean;
28328
28335
  spendingLimit: number;
@@ -28380,7 +28387,7 @@ interface UpdateWorkspaceResponse {
28380
28387
  createdAt: string;
28381
28388
  updatedAt: string;
28382
28389
  botCount: number;
28383
- billingVersion: "v1" | "v2" | "v3" | "v4";
28390
+ billingVersion: "v1" | "v2" | "v3" | "v4" | "v5";
28384
28391
  plan: "community" | "team" | "enterprise" | "plus" | "managed";
28385
28392
  blocked: boolean;
28386
28393
  spendingLimit: number;
@@ -36824,7 +36831,7 @@ interface ExportTableResponse {
36824
36831
  id: string;
36825
36832
  botId: string;
36826
36833
  tableId: string;
36827
- type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
36834
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table" | "key_column";
36828
36835
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
36829
36836
  progress?: number;
36830
36837
  inputFileId: string | null;
@@ -36849,7 +36856,7 @@ interface GetTableJobsResponse {
36849
36856
  id: string;
36850
36857
  botId: string;
36851
36858
  tableId: string;
36852
- type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
36859
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table" | "key_column";
36853
36860
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
36854
36861
  progress?: number;
36855
36862
  inputFileId: string | null;
@@ -36878,7 +36885,7 @@ interface ImportTableResponse {
36878
36885
  id: string;
36879
36886
  botId: string;
36880
36887
  tableId: string;
36881
- type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
36888
+ type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table" | "key_column";
36882
36889
  status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
36883
36890
  progress?: number;
36884
36891
  inputFileId: string | null;
@@ -37071,6 +37078,10 @@ interface UpdateTableResponse {
37071
37078
  * List of columns that have become stale following the modification.
37072
37079
  */
37073
37080
  staleColumns?: string[];
37081
+ job?: {
37082
+ id: string;
37083
+ status: string;
37084
+ };
37074
37085
  }
37075
37086
 
37076
37087
  interface RenameTableColumnRequestHeaders {
@@ -38875,7 +38886,7 @@ interface Workspace {
38875
38886
  createdAt: string;
38876
38887
  updatedAt: string;
38877
38888
  botCount: number;
38878
- billingVersion: "v1" | "v2" | "v3" | "v4";
38889
+ billingVersion: "v1" | "v2" | "v3" | "v4" | "v5";
38879
38890
  plan: "community" | "team" | "enterprise" | "plus" | "managed";
38880
38891
  blocked: boolean;
38881
38892
  spendingLimit: number;
@@ -39813,14 +39824,14 @@ declare class Client extends Client$1 implements IClient {
39813
39824
  constructor(clientProps?: ClientProps);
39814
39825
  get list(): {
39815
39826
  conversations: (props: {
39816
- pageSize?: number | undefined;
39827
+ channel?: string | undefined;
39817
39828
  tags?: {
39818
39829
  [x: string]: string;
39819
39830
  } | undefined;
39831
+ integrationName?: string | undefined;
39832
+ pageSize?: number | undefined;
39820
39833
  sortField?: "createdAt" | "updatedAt" | undefined;
39821
39834
  sortDirection?: "asc" | "desc" | undefined;
39822
- integrationName?: string | undefined;
39823
- channel?: string | undefined;
39824
39835
  participantIds?: string[] | undefined;
39825
39836
  afterDate?: string | undefined;
39826
39837
  beforeDate?: string | undefined;
@@ -39862,10 +39873,10 @@ declare class Client extends Client$1 implements IClient {
39862
39873
  }>;
39863
39874
  events: (props: {
39864
39875
  pageSize?: number | undefined;
39865
- type?: string | undefined;
39866
39876
  userId?: string | undefined;
39867
- workflowId?: string | undefined;
39877
+ type?: string | undefined;
39868
39878
  conversationId?: string | undefined;
39879
+ workflowId?: string | undefined;
39869
39880
  messageId?: string | undefined;
39870
39881
  status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
39871
39882
  }) => AsyncCollection<{
@@ -39882,13 +39893,13 @@ declare class Client extends Client$1 implements IClient {
39882
39893
  failureReason: string | null;
39883
39894
  }>;
39884
39895
  messages: (props: {
39885
- pageSize?: number | undefined;
39886
39896
  tags?: {
39887
39897
  [x: string]: string;
39888
39898
  } | undefined;
39889
- conversationId?: string | undefined;
39899
+ pageSize?: number | undefined;
39890
39900
  afterDate?: string | undefined;
39891
39901
  beforeDate?: string | undefined;
39902
+ conversationId?: string | undefined;
39892
39903
  }) => AsyncCollection<{
39893
39904
  id: string;
39894
39905
  createdAt: string;
@@ -39906,15 +39917,15 @@ declare class Client extends Client$1 implements IClient {
39906
39917
  origin?: "synthetic";
39907
39918
  }>;
39908
39919
  users: (props: {
39909
- pageSize?: number | undefined;
39910
39920
  tags?: {
39911
39921
  [x: string]: string;
39912
39922
  } | undefined;
39923
+ pageSize?: number | undefined;
39913
39924
  sortField?: "updatedAt" | "createdAt" | undefined;
39914
39925
  sortDirection?: "asc" | "desc" | undefined;
39915
- conversationId?: string | undefined;
39916
39926
  afterDate?: string | undefined;
39917
39927
  beforeDate?: string | undefined;
39928
+ conversationId?: string | undefined;
39918
39929
  rangeField?: "updatedAt" | "createdAt" | undefined;
39919
39930
  }) => AsyncCollection<{
39920
39931
  id: string;
@@ -39934,8 +39945,8 @@ declare class Client extends Client$1 implements IClient {
39934
39945
  }>;
39935
39946
  publicIntegrations: (props: {
39936
39947
  pageSize?: number | undefined;
39937
- limit?: number | undefined;
39938
39948
  name?: string | undefined;
39949
+ limit?: number | undefined;
39939
39950
  version?: string | undefined;
39940
39951
  interfaceId?: string | undefined;
39941
39952
  interfaceName?: string | undefined;
@@ -39978,15 +39989,15 @@ declare class Client extends Client$1 implements IClient {
39978
39989
  };
39979
39990
  }>;
39980
39991
  bots: (props: {
39981
- pageSize?: number | undefined;
39982
39992
  tags?: {
39983
39993
  [x: string]: string;
39984
39994
  } | undefined;
39995
+ pageSize?: number | undefined;
39996
+ sortField?: "createdAt" | "updatedAt" | undefined;
39997
+ sortDirection?: "asc" | "desc" | undefined;
39985
39998
  dev?: boolean | undefined;
39986
39999
  integrationNames?: string[] | undefined;
39987
40000
  pluginNames?: string[] | undefined;
39988
- sortField?: "createdAt" | "updatedAt" | undefined;
39989
- sortDirection?: "asc" | "desc" | undefined;
39990
40001
  }) => AsyncCollection<{
39991
40002
  id: string;
39992
40003
  createdAt: string;
@@ -40032,8 +40043,8 @@ declare class Client extends Client$1 implements IClient {
40032
40043
  }) => AsyncCollection<UpdateWorkspaceMemberResponse$1>;
40033
40044
  integrations: (props: {
40034
40045
  pageSize?: number | undefined;
40035
- limit?: number | undefined;
40036
40046
  name?: string | undefined;
40047
+ limit?: number | undefined;
40037
40048
  version?: string | undefined;
40038
40049
  interfaceId?: string | undefined;
40039
40050
  interfaceName?: string | undefined;
@@ -40154,8 +40165,8 @@ declare class Client extends Client$1 implements IClient {
40154
40165
  createdAt: string;
40155
40166
  }>;
40156
40167
  files: (props: {
40157
- pageSize?: number | undefined;
40158
40168
  tags?: any;
40169
+ pageSize?: number | undefined;
40159
40170
  sortField?: "key" | "size" | "createdAt" | "updatedAt" | "status" | undefined;
40160
40171
  sortDirection?: "asc" | "desc" | undefined;
40161
40172
  ids?: string[] | undefined;
@@ -40211,8 +40222,8 @@ declare class Client extends Client$1 implements IClient {
40211
40222
  tag: string;
40212
40223
  }) => AsyncCollection<string>;
40213
40224
  knowledgeBases: (props: {
40214
- pageSize?: number | undefined;
40215
40225
  tags?: any;
40226
+ pageSize?: number | undefined;
40216
40227
  }) => AsyncCollection<{
40217
40228
  id: string;
40218
40229
  name: string;
@@ -40254,13 +40265,13 @@ declare class Client extends Client$1 implements IClient {
40254
40265
  };
40255
40266
  }>;
40256
40267
  workflows: (props: {
40257
- pageSize?: number | undefined;
40258
- name?: string | undefined;
40259
40268
  tags?: {
40260
40269
  [x: string]: string;
40261
40270
  } | undefined;
40271
+ pageSize?: number | undefined;
40262
40272
  userId?: string | undefined;
40263
40273
  conversationId?: string | undefined;
40274
+ name?: string | undefined;
40264
40275
  parentWorkflowId?: string | undefined;
40265
40276
  statuses?: ("pending" | "failed" | "in_progress" | "completed" | "listening" | "paused" | "timedout" | "cancelled")[] | undefined;
40266
40277
  }) => AsyncCollection<{