@botpress/client 1.38.2 → 1.40.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
@@ -2053,6 +2053,14 @@ interface SetStateExpiryResponse$1 {
2053
2053
  payload: {
2054
2054
  [k: string]: any;
2055
2055
  };
2056
+ /**
2057
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
2058
+ */
2059
+ expiry?: number;
2060
+ /**
2061
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
2062
+ */
2063
+ expiresAt?: string;
2056
2064
  };
2057
2065
  }
2058
2066
 
@@ -2111,6 +2119,14 @@ interface GetStateResponse$1 {
2111
2119
  payload: {
2112
2120
  [k: string]: any;
2113
2121
  };
2122
+ /**
2123
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
2124
+ */
2125
+ expiry?: number;
2126
+ /**
2127
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
2128
+ */
2129
+ expiresAt?: string;
2114
2130
  };
2115
2131
  meta: {
2116
2132
  cached: boolean;
@@ -2182,6 +2198,14 @@ interface SetStateResponse$1 {
2182
2198
  payload: {
2183
2199
  [k: string]: any;
2184
2200
  };
2201
+ /**
2202
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
2203
+ */
2204
+ expiry?: number;
2205
+ /**
2206
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
2207
+ */
2208
+ expiresAt?: string;
2185
2209
  };
2186
2210
  }
2187
2211
 
@@ -2250,6 +2274,14 @@ interface GetOrSetStateResponse$1 {
2250
2274
  payload: {
2251
2275
  [k: string]: any;
2252
2276
  };
2277
+ /**
2278
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
2279
+ */
2280
+ expiry?: number;
2281
+ /**
2282
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
2283
+ */
2284
+ expiresAt?: string;
2253
2285
  };
2254
2286
  meta: {
2255
2287
  cached: boolean;
@@ -2272,6 +2304,10 @@ interface PatchStateRequestBody$1 {
2272
2304
  payload: {
2273
2305
  [k: string]: any;
2274
2306
  };
2307
+ /**
2308
+ * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
2309
+ */
2310
+ expiry?: number | null;
2275
2311
  }
2276
2312
  type PatchStateInput$1 = PatchStateRequestBody$1 & PatchStateRequestHeaders$1 & PatchStateRequestQuery$1 & PatchStateRequestParams$1;
2277
2313
  interface PatchStateResponse$1 {
@@ -2317,6 +2353,14 @@ interface PatchStateResponse$1 {
2317
2353
  payload: {
2318
2354
  [k: string]: any;
2319
2355
  };
2356
+ /**
2357
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
2358
+ */
2359
+ expiry?: number;
2360
+ /**
2361
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
2362
+ */
2363
+ expiresAt?: string;
2320
2364
  };
2321
2365
  }
2322
2366
 
@@ -8588,6 +8632,7 @@ interface CreateWorkspaceMemberRequestParams$1 {
8588
8632
  interface CreateWorkspaceMemberRequestBody$1 {
8589
8633
  email: string;
8590
8634
  role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
8635
+ sendEmail?: boolean;
8591
8636
  }
8592
8637
  type CreateWorkspaceMemberInput$1 = CreateWorkspaceMemberRequestBody$1 & CreateWorkspaceMemberRequestHeaders$1 & CreateWorkspaceMemberRequestQuery$1 & CreateWorkspaceMemberRequestParams$1;
8593
8638
  interface CreateWorkspaceMemberResponse$1 {
@@ -15838,6 +15883,41 @@ type RemoveTrialInput = RemoveTrialRequestBody & RemoveTrialRequestHeaders & Rem
15838
15883
  interface RemoveTrialResponse {
15839
15884
  }
15840
15885
 
15886
+ interface CreateCreditGrantRequestHeaders {
15887
+ }
15888
+ interface CreateCreditGrantRequestQuery {
15889
+ }
15890
+ interface CreateCreditGrantRequestParams {
15891
+ }
15892
+ interface CreateCreditGrantRequestBody {
15893
+ /**
15894
+ * Nanodollar value of the credit grant (e.g. 10_000_000_000 = $10.00 USD)
15895
+ */
15896
+ amount: number;
15897
+ feature: "integration_spend";
15898
+ }
15899
+ type CreateCreditGrantInput = CreateCreditGrantRequestBody & CreateCreditGrantRequestHeaders & CreateCreditGrantRequestQuery & CreateCreditGrantRequestParams;
15900
+ interface CreateCreditGrantResponse {
15901
+ id: string;
15902
+ workspace_id: string;
15903
+ invoice_id: string;
15904
+ /**
15905
+ * Dollar value of the credit grant (e.g. 10 = $10.00 USD)
15906
+ */
15907
+ amount: number;
15908
+ feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions";
15909
+ /**
15910
+ * Start of the period (inclusive)
15911
+ */
15912
+ period_start: string;
15913
+ /**
15914
+ * End of the period (exclusive)
15915
+ */
15916
+ period_end: string;
15917
+ updatedAt: string;
15918
+ createdAt: string;
15919
+ }
15920
+
15841
15921
  interface ListInvoicesRequestHeaders {
15842
15922
  }
15843
15923
  interface ListInvoicesRequestQuery {
@@ -15988,6 +16068,7 @@ declare class Client$7 {
15988
16068
  readonly getTrials: (input: GetTrialsInput) => Promise<GetTrialsResponse>;
15989
16069
  readonly createTrial: (input: CreateTrialInput) => Promise<CreateTrialResponse>;
15990
16070
  readonly removeTrial: (input: RemoveTrialInput) => Promise<RemoveTrialResponse>;
16071
+ readonly createCreditGrant: (input: CreateCreditGrantInput) => Promise<CreateCreditGrantResponse>;
15991
16072
  readonly listInvoices: (input: ListInvoicesInput) => Promise<ListInvoicesResponse>;
15992
16073
  readonly payInvoice: (input: PayInvoiceInput) => Promise<PayInvoiceResponse>;
15993
16074
  readonly getPaymentMethod: (input: GetPaymentMethodInput) => Promise<GetPaymentMethodResponse>;
@@ -20990,6 +21071,14 @@ interface SetStateExpiryResponse {
20990
21071
  payload: {
20991
21072
  [k: string]: any;
20992
21073
  };
21074
+ /**
21075
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
21076
+ */
21077
+ expiry?: number;
21078
+ /**
21079
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
21080
+ */
21081
+ expiresAt?: string;
20993
21082
  };
20994
21083
  }
20995
21084
 
@@ -21048,6 +21137,14 @@ interface GetStateResponse {
21048
21137
  payload: {
21049
21138
  [k: string]: any;
21050
21139
  };
21140
+ /**
21141
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
21142
+ */
21143
+ expiry?: number;
21144
+ /**
21145
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
21146
+ */
21147
+ expiresAt?: string;
21051
21148
  };
21052
21149
  meta: {
21053
21150
  cached: boolean;
@@ -21119,6 +21216,14 @@ interface SetStateResponse {
21119
21216
  payload: {
21120
21217
  [k: string]: any;
21121
21218
  };
21219
+ /**
21220
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
21221
+ */
21222
+ expiry?: number;
21223
+ /**
21224
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
21225
+ */
21226
+ expiresAt?: string;
21122
21227
  };
21123
21228
  }
21124
21229
 
@@ -21187,6 +21292,14 @@ interface GetOrSetStateResponse {
21187
21292
  payload: {
21188
21293
  [k: string]: any;
21189
21294
  };
21295
+ /**
21296
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
21297
+ */
21298
+ expiry?: number;
21299
+ /**
21300
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
21301
+ */
21302
+ expiresAt?: string;
21190
21303
  };
21191
21304
  meta: {
21192
21305
  cached: boolean;
@@ -21209,6 +21322,10 @@ interface PatchStateRequestBody {
21209
21322
  payload: {
21210
21323
  [k: string]: any;
21211
21324
  };
21325
+ /**
21326
+ * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
21327
+ */
21328
+ expiry?: number | null;
21212
21329
  }
21213
21330
  type PatchStateInput = PatchStateRequestBody & PatchStateRequestHeaders & PatchStateRequestQuery & PatchStateRequestParams;
21214
21331
  interface PatchStateResponse {
@@ -21254,6 +21371,14 @@ interface PatchStateResponse {
21254
21371
  payload: {
21255
21372
  [k: string]: any;
21256
21373
  };
21374
+ /**
21375
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
21376
+ */
21377
+ expiry?: number;
21378
+ /**
21379
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
21380
+ */
21381
+ expiresAt?: string;
21257
21382
  };
21258
21383
  }
21259
21384
 
@@ -27323,6 +27448,7 @@ interface CreateWorkspaceMemberRequestParams {
27323
27448
  interface CreateWorkspaceMemberRequestBody {
27324
27449
  email: string;
27325
27450
  role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
27451
+ sendEmail?: boolean;
27326
27452
  }
27327
27453
  type CreateWorkspaceMemberInput = CreateWorkspaceMemberRequestBody & CreateWorkspaceMemberRequestHeaders & CreateWorkspaceMemberRequestQuery & CreateWorkspaceMemberRequestParams;
27328
27454
  interface CreateWorkspaceMemberResponse {
@@ -37883,6 +38009,14 @@ interface State {
37883
38009
  payload: {
37884
38010
  [k: string]: any;
37885
38011
  };
38012
+ /**
38013
+ * Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set.
38014
+ */
38015
+ expiry?: number;
38016
+ /**
38017
+ * Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set.
38018
+ */
38019
+ expiresAt?: string;
37886
38020
  }
37887
38021
  /**
37888
38022
  * Workflow definition