@botpress/client 0.35.0 → 0.36.1

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
@@ -2955,6 +2955,10 @@ interface GetPublicIntegrationByIdResponse {
2955
2955
  * Name of the interface
2956
2956
  */
2957
2957
  name: string;
2958
+ /**
2959
+ * Version of the interface
2960
+ */
2961
+ version: string;
2958
2962
  entities: {
2959
2963
  [k: string]: {
2960
2964
  name: string;
@@ -3326,6 +3330,10 @@ interface GetPublicIntegrationResponse {
3326
3330
  * Name of the interface
3327
3331
  */
3328
3332
  name: string;
3333
+ /**
3334
+ * Version of the interface
3335
+ */
3336
+ version: string;
3329
3337
  entities: {
3330
3338
  [k: string]: {
3331
3339
  name: string;
@@ -5391,7 +5399,7 @@ interface CreateWorkspaceResponse {
5391
5399
  createdAt: string;
5392
5400
  updatedAt: string;
5393
5401
  botCount: number;
5394
- billingVersion: "v1" | "v2";
5402
+ billingVersion: "v1" | "v2" | "v3";
5395
5403
  plan: "community" | "team" | "enterprise";
5396
5404
  blocked: boolean;
5397
5405
  spendingLimit: number;
@@ -5444,7 +5452,7 @@ interface GetWorkspaceResponse {
5444
5452
  createdAt: string;
5445
5453
  updatedAt: string;
5446
5454
  botCount: number;
5447
- billingVersion: "v1" | "v2";
5455
+ billingVersion: "v1" | "v2" | "v3";
5448
5456
  plan: "community" | "team" | "enterprise";
5449
5457
  blocked: boolean;
5450
5458
  spendingLimit: number;
@@ -5615,7 +5623,7 @@ interface UpdateWorkspaceResponse$1 {
5615
5623
  createdAt: string;
5616
5624
  updatedAt: string;
5617
5625
  botCount: number;
5618
- billingVersion: "v1" | "v2";
5626
+ billingVersion: "v1" | "v2" | "v3";
5619
5627
  plan: "community" | "team" | "enterprise";
5620
5628
  blocked: boolean;
5621
5629
  spendingLimit: number;
@@ -5670,7 +5678,7 @@ interface UpdateWorkspaceResponse {
5670
5678
  createdAt: string;
5671
5679
  updatedAt: string;
5672
5680
  botCount: number;
5673
- billingVersion: "v1" | "v2";
5681
+ billingVersion: "v1" | "v2" | "v3";
5674
5682
  plan: "community" | "team" | "enterprise";
5675
5683
  blocked: boolean;
5676
5684
  spendingLimit: number;
@@ -6277,6 +6285,10 @@ interface CreateIntegrationResponse {
6277
6285
  * Name of the interface
6278
6286
  */
6279
6287
  name: string;
6288
+ /**
6289
+ * Version of the interface
6290
+ */
6291
+ version: string;
6280
6292
  entities: {
6281
6293
  [k: string]: {
6282
6294
  name: string;
@@ -6931,6 +6943,10 @@ interface UpdateIntegrationResponse {
6931
6943
  * Name of the interface
6932
6944
  */
6933
6945
  name: string;
6946
+ /**
6947
+ * Version of the interface
6948
+ */
6949
+ version: string;
6934
6950
  entities: {
6935
6951
  [k: string]: {
6936
6952
  name: string;
@@ -7356,6 +7372,10 @@ interface GetIntegrationResponse {
7356
7372
  * Name of the interface
7357
7373
  */
7358
7374
  name: string;
7375
+ /**
7376
+ * Version of the interface
7377
+ */
7378
+ version: string;
7359
7379
  entities: {
7360
7380
  [k: string]: {
7361
7381
  name: string;
@@ -7740,6 +7760,10 @@ interface GetIntegrationByNameResponse {
7740
7760
  * Name of the interface
7741
7761
  */
7742
7762
  name: string;
7763
+ /**
7764
+ * Version of the interface
7765
+ */
7766
+ version: string;
7743
7767
  entities: {
7744
7768
  [k: string]: {
7745
7769
  name: string;
@@ -8785,6 +8809,7 @@ interface ListInterfacesRequestHeaders {
8785
8809
  }
8786
8810
  interface ListInterfacesRequestQuery {
8787
8811
  nextToken?: string;
8812
+ name?: string;
8788
8813
  }
8789
8814
  interface ListInterfacesRequestParams {
8790
8815
  }
@@ -8822,152 +8847,985 @@ interface ListInterfacesResponse {
8822
8847
  };
8823
8848
  }
8824
8849
 
8825
- interface GetUsageRequestHeaders {
8826
- }
8827
- interface GetUsageRequestQuery {
8828
- 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";
8829
- period?: string;
8850
+ interface CreatePluginRequestHeaders {
8830
8851
  }
8831
- interface GetUsageRequestParams {
8832
- id: string;
8852
+ interface CreatePluginRequestQuery {
8833
8853
  }
8834
- interface GetUsageRequestBody {
8854
+ interface CreatePluginRequestParams {
8835
8855
  }
8836
- type GetUsageInput = GetUsageRequestBody & GetUsageRequestHeaders & GetUsageRequestQuery & GetUsageRequestParams;
8837
- interface GetUsageResponse {
8838
- usage: {
8856
+ interface CreatePluginRequestBody {
8857
+ /**
8858
+ * Name of the [Plugin](#schema_plugin)
8859
+ */
8860
+ name: string;
8861
+ /**
8862
+ * Version of the [Plugin](#schema_plugin)
8863
+ */
8864
+ version: string;
8865
+ /**
8866
+ * Configuration definition
8867
+ */
8868
+ configuration?: {
8839
8869
  /**
8840
- * Id of the usage that it is linked to. It can either be a workspace id or a bot id
8870
+ * Title of the configuration
8841
8871
  */
8842
- id: string;
8872
+ title?: string;
8843
8873
  /**
8844
- * Period of the quota that it is applied to
8874
+ * Description of the configuration
8845
8875
  */
8846
- period: string;
8876
+ description?: string;
8847
8877
  /**
8848
- * Value of the current usage
8878
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
8849
8879
  */
8850
- value: number;
8880
+ schema: {
8881
+ [k: string]: any;
8882
+ };
8883
+ };
8884
+ states?: {
8885
+ [k: string]: {
8886
+ /**
8887
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
8888
+ */
8889
+ type: "conversation" | "user" | "bot" | "task";
8890
+ /**
8891
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
8892
+ */
8893
+ schema: {
8894
+ [k: string]: any;
8895
+ };
8896
+ /**
8897
+ * 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.
8898
+ */
8899
+ expiry?: number;
8900
+ };
8901
+ };
8902
+ events?: {
8851
8903
  /**
8852
- * Quota of the current usage
8904
+ * Event Definition
8853
8905
  */
8854
- quota: number;
8906
+ [k: string]: {
8907
+ /**
8908
+ * Title of the event
8909
+ */
8910
+ title?: string;
8911
+ /**
8912
+ * Description of the event
8913
+ */
8914
+ description?: string;
8915
+ schema: {
8916
+ [k: string]: any;
8917
+ };
8918
+ };
8919
+ };
8920
+ actions?: {
8855
8921
  /**
8856
- * Usage type that can be used
8922
+ * Action definition
8857
8923
  */
8858
- 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";
8924
+ [k: string]: {
8925
+ /**
8926
+ * Title of the action
8927
+ */
8928
+ title?: string;
8929
+ /**
8930
+ * Description of the action
8931
+ */
8932
+ description?: string;
8933
+ billable?: boolean;
8934
+ cacheable?: boolean;
8935
+ input: {
8936
+ schema: {
8937
+ [k: string]: any;
8938
+ };
8939
+ };
8940
+ output: {
8941
+ schema: {
8942
+ [k: string]: any;
8943
+ };
8944
+ };
8945
+ };
8859
8946
  };
8947
+ /**
8948
+ * User object configuration
8949
+ */
8950
+ user?: {
8951
+ tags: {
8952
+ /**
8953
+ * Definition of a tag that can be provided on the object
8954
+ */
8955
+ [k: string]: {
8956
+ /**
8957
+ * Title of the tag
8958
+ */
8959
+ title?: string;
8960
+ /**
8961
+ * Description of the tag
8962
+ */
8963
+ description?: string;
8964
+ };
8965
+ };
8966
+ };
8967
+ code: string;
8860
8968
  }
8861
-
8862
- interface GetMultipleUsagesRequestHeaders {
8863
- }
8864
- interface GetMultipleUsagesRequestQuery {
8865
- types: string[];
8866
- ids: string[];
8867
- period?: string;
8868
- }
8869
- interface GetMultipleUsagesRequestParams {
8870
- }
8871
- interface GetMultipleUsagesRequestBody {
8872
- }
8873
- type GetMultipleUsagesInput = GetMultipleUsagesRequestBody & GetMultipleUsagesRequestHeaders & GetMultipleUsagesRequestQuery & GetMultipleUsagesRequestParams;
8874
- interface GetMultipleUsagesResponse {
8875
- usages: {
8969
+ type CreatePluginInput = CreatePluginRequestBody & CreatePluginRequestHeaders & CreatePluginRequestQuery & CreatePluginRequestParams;
8970
+ interface CreatePluginResponse {
8971
+ /**
8972
+ * Plugin definition
8973
+ */
8974
+ plugin: {
8876
8975
  /**
8877
- * Id of the usage that it is linked to. It can either be a workspace id or a bot id
8976
+ * ID of the [Plugin](#schema_plugin)
8878
8977
  */
8879
8978
  id: string;
8880
8979
  /**
8881
- * Period of the quota that it is applied to
8882
- */
8883
- period: string;
8884
- /**
8885
- * Value of the current usage
8886
- */
8887
- value: number;
8888
- /**
8889
- * Quota of the current usage
8890
- */
8891
- quota: number;
8892
- /**
8893
- * Usage type that can be used
8894
- */
8895
- 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";
8896
- }[];
8897
- }
8898
-
8899
- interface ListUsageHistoryRequestHeaders {
8900
- }
8901
- interface ListUsageHistoryRequestQuery {
8902
- 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";
8903
- }
8904
- interface ListUsageHistoryRequestParams {
8905
- id: string;
8906
- }
8907
- interface ListUsageHistoryRequestBody {
8908
- }
8909
- type ListUsageHistoryInput = ListUsageHistoryRequestBody & ListUsageHistoryRequestHeaders & ListUsageHistoryRequestQuery & ListUsageHistoryRequestParams;
8910
- interface ListUsageHistoryResponse {
8911
- usages: {
8912
- /**
8913
- * Id of the usage that it is linked to. It can either be a workspace id or a bot id
8980
+ * Name of the [Plugin](#schema_plugin)
8914
8981
  */
8915
- id: string;
8982
+ name: string;
8916
8983
  /**
8917
- * Period of the quota that it is applied to
8984
+ * Version of the [Plugin](#schema_plugin)
8918
8985
  */
8919
- period: string;
8986
+ version: string;
8920
8987
  /**
8921
- * Value of the current usage
8988
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
8922
8989
  */
8923
- value: number;
8990
+ createdAt: string;
8924
8991
  /**
8925
- * Quota of the current usage
8992
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
8926
8993
  */
8927
- quota: number;
8994
+ updatedAt: string;
8928
8995
  /**
8929
- * Usage type that can be used
8996
+ * Configuration definition
8930
8997
  */
8931
- 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";
8932
- }[];
8933
- }
8934
-
8935
- interface ListUsageActivityRequestHeaders {
8936
- }
8937
- interface ListUsageActivityRequestQuery {
8938
- 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";
8939
- nextToken?: string;
8940
- }
8941
- interface ListUsageActivityRequestParams {
8942
- id: string;
8943
- }
8944
- interface ListUsageActivityRequestBody {
8945
- }
8946
- type ListUsageActivityInput = ListUsageActivityRequestBody & ListUsageActivityRequestHeaders & ListUsageActivityRequestQuery & ListUsageActivityRequestParams;
8947
- interface ListUsageActivityResponse {
8948
- data: {
8949
- timestamp: string;
8950
- value: number;
8951
- period: string;
8952
- metadata: {
8953
- [k: string]: any | null;
8998
+ configuration: {
8999
+ /**
9000
+ * Title of the configuration
9001
+ */
9002
+ title?: string;
9003
+ /**
9004
+ * Description of the configuration
9005
+ */
9006
+ description?: string;
9007
+ /**
9008
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
9009
+ */
9010
+ schema: {
9011
+ [k: string]: any;
9012
+ };
8954
9013
  };
8955
- }[];
8956
- meta: {
8957
- nextToken?: string;
8958
- };
8959
- }
8960
-
8961
- interface ChangeAispendQuotaRequestHeaders {
8962
- }
8963
- interface ChangeAispendQuotaRequestQuery {
8964
- }
8965
- interface ChangeAispendQuotaRequestParams {
8966
- }
8967
- interface ChangeAispendQuotaRequestBody {
8968
- monthlySpendingLimit: number;
8969
- }
8970
- type ChangeAispendQuotaInput = ChangeAispendQuotaRequestBody & ChangeAispendQuotaRequestHeaders & ChangeAispendQuotaRequestQuery & ChangeAispendQuotaRequestParams;
9014
+ states: {
9015
+ [k: string]: {
9016
+ /**
9017
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
9018
+ */
9019
+ type: "conversation" | "user" | "bot" | "task";
9020
+ /**
9021
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
9022
+ */
9023
+ schema: {
9024
+ [k: string]: any;
9025
+ };
9026
+ /**
9027
+ * 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.
9028
+ */
9029
+ expiry?: number;
9030
+ };
9031
+ };
9032
+ events: {
9033
+ /**
9034
+ * Event Definition
9035
+ */
9036
+ [k: string]: {
9037
+ /**
9038
+ * Title of the event
9039
+ */
9040
+ title?: string;
9041
+ /**
9042
+ * Description of the event
9043
+ */
9044
+ description?: string;
9045
+ schema: {
9046
+ [k: string]: any;
9047
+ };
9048
+ };
9049
+ };
9050
+ actions: {
9051
+ /**
9052
+ * Action definition
9053
+ */
9054
+ [k: string]: {
9055
+ /**
9056
+ * Title of the action
9057
+ */
9058
+ title?: string;
9059
+ /**
9060
+ * Description of the action
9061
+ */
9062
+ description?: string;
9063
+ billable?: boolean;
9064
+ cacheable?: boolean;
9065
+ input: {
9066
+ schema: {
9067
+ [k: string]: any;
9068
+ };
9069
+ };
9070
+ output: {
9071
+ schema: {
9072
+ [k: string]: any;
9073
+ };
9074
+ };
9075
+ };
9076
+ };
9077
+ /**
9078
+ * User object configuration
9079
+ */
9080
+ user: {
9081
+ tags: {
9082
+ /**
9083
+ * Definition of a tag that can be provided on the object
9084
+ */
9085
+ [k: string]: {
9086
+ /**
9087
+ * Title of the tag
9088
+ */
9089
+ title?: string;
9090
+ /**
9091
+ * Description of the tag
9092
+ */
9093
+ description?: string;
9094
+ };
9095
+ };
9096
+ };
9097
+ code: string;
9098
+ };
9099
+ }
9100
+
9101
+ interface GetPluginRequestHeaders {
9102
+ }
9103
+ interface GetPluginRequestQuery {
9104
+ }
9105
+ interface GetPluginRequestParams {
9106
+ id: string;
9107
+ }
9108
+ interface GetPluginRequestBody {
9109
+ }
9110
+ type GetPluginInput = GetPluginRequestBody & GetPluginRequestHeaders & GetPluginRequestQuery & GetPluginRequestParams;
9111
+ interface GetPluginResponse {
9112
+ /**
9113
+ * Plugin definition
9114
+ */
9115
+ plugin: {
9116
+ /**
9117
+ * ID of the [Plugin](#schema_plugin)
9118
+ */
9119
+ id: string;
9120
+ /**
9121
+ * Name of the [Plugin](#schema_plugin)
9122
+ */
9123
+ name: string;
9124
+ /**
9125
+ * Version of the [Plugin](#schema_plugin)
9126
+ */
9127
+ version: string;
9128
+ /**
9129
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
9130
+ */
9131
+ createdAt: string;
9132
+ /**
9133
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
9134
+ */
9135
+ updatedAt: string;
9136
+ /**
9137
+ * Configuration definition
9138
+ */
9139
+ configuration: {
9140
+ /**
9141
+ * Title of the configuration
9142
+ */
9143
+ title?: string;
9144
+ /**
9145
+ * Description of the configuration
9146
+ */
9147
+ description?: string;
9148
+ /**
9149
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
9150
+ */
9151
+ schema: {
9152
+ [k: string]: any;
9153
+ };
9154
+ };
9155
+ states: {
9156
+ [k: string]: {
9157
+ /**
9158
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
9159
+ */
9160
+ type: "conversation" | "user" | "bot" | "task";
9161
+ /**
9162
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
9163
+ */
9164
+ schema: {
9165
+ [k: string]: any;
9166
+ };
9167
+ /**
9168
+ * 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.
9169
+ */
9170
+ expiry?: number;
9171
+ };
9172
+ };
9173
+ events: {
9174
+ /**
9175
+ * Event Definition
9176
+ */
9177
+ [k: string]: {
9178
+ /**
9179
+ * Title of the event
9180
+ */
9181
+ title?: string;
9182
+ /**
9183
+ * Description of the event
9184
+ */
9185
+ description?: string;
9186
+ schema: {
9187
+ [k: string]: any;
9188
+ };
9189
+ };
9190
+ };
9191
+ actions: {
9192
+ /**
9193
+ * Action definition
9194
+ */
9195
+ [k: string]: {
9196
+ /**
9197
+ * Title of the action
9198
+ */
9199
+ title?: string;
9200
+ /**
9201
+ * Description of the action
9202
+ */
9203
+ description?: string;
9204
+ billable?: boolean;
9205
+ cacheable?: boolean;
9206
+ input: {
9207
+ schema: {
9208
+ [k: string]: any;
9209
+ };
9210
+ };
9211
+ output: {
9212
+ schema: {
9213
+ [k: string]: any;
9214
+ };
9215
+ };
9216
+ };
9217
+ };
9218
+ /**
9219
+ * User object configuration
9220
+ */
9221
+ user: {
9222
+ tags: {
9223
+ /**
9224
+ * Definition of a tag that can be provided on the object
9225
+ */
9226
+ [k: string]: {
9227
+ /**
9228
+ * Title of the tag
9229
+ */
9230
+ title?: string;
9231
+ /**
9232
+ * Description of the tag
9233
+ */
9234
+ description?: string;
9235
+ };
9236
+ };
9237
+ };
9238
+ code: string;
9239
+ };
9240
+ }
9241
+
9242
+ interface GetPluginByNameRequestHeaders {
9243
+ }
9244
+ interface GetPluginByNameRequestQuery {
9245
+ }
9246
+ interface GetPluginByNameRequestParams {
9247
+ name: string;
9248
+ version: string;
9249
+ }
9250
+ interface GetPluginByNameRequestBody {
9251
+ }
9252
+ type GetPluginByNameInput = GetPluginByNameRequestBody & GetPluginByNameRequestHeaders & GetPluginByNameRequestQuery & GetPluginByNameRequestParams;
9253
+ interface GetPluginByNameResponse {
9254
+ /**
9255
+ * Plugin definition
9256
+ */
9257
+ plugin: {
9258
+ /**
9259
+ * ID of the [Plugin](#schema_plugin)
9260
+ */
9261
+ id: string;
9262
+ /**
9263
+ * Name of the [Plugin](#schema_plugin)
9264
+ */
9265
+ name: string;
9266
+ /**
9267
+ * Version of the [Plugin](#schema_plugin)
9268
+ */
9269
+ version: string;
9270
+ /**
9271
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
9272
+ */
9273
+ createdAt: string;
9274
+ /**
9275
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
9276
+ */
9277
+ updatedAt: string;
9278
+ /**
9279
+ * Configuration definition
9280
+ */
9281
+ configuration: {
9282
+ /**
9283
+ * Title of the configuration
9284
+ */
9285
+ title?: string;
9286
+ /**
9287
+ * Description of the configuration
9288
+ */
9289
+ description?: string;
9290
+ /**
9291
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
9292
+ */
9293
+ schema: {
9294
+ [k: string]: any;
9295
+ };
9296
+ };
9297
+ states: {
9298
+ [k: string]: {
9299
+ /**
9300
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
9301
+ */
9302
+ type: "conversation" | "user" | "bot" | "task";
9303
+ /**
9304
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
9305
+ */
9306
+ schema: {
9307
+ [k: string]: any;
9308
+ };
9309
+ /**
9310
+ * 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.
9311
+ */
9312
+ expiry?: number;
9313
+ };
9314
+ };
9315
+ events: {
9316
+ /**
9317
+ * Event Definition
9318
+ */
9319
+ [k: string]: {
9320
+ /**
9321
+ * Title of the event
9322
+ */
9323
+ title?: string;
9324
+ /**
9325
+ * Description of the event
9326
+ */
9327
+ description?: string;
9328
+ schema: {
9329
+ [k: string]: any;
9330
+ };
9331
+ };
9332
+ };
9333
+ actions: {
9334
+ /**
9335
+ * Action definition
9336
+ */
9337
+ [k: string]: {
9338
+ /**
9339
+ * Title of the action
9340
+ */
9341
+ title?: string;
9342
+ /**
9343
+ * Description of the action
9344
+ */
9345
+ description?: string;
9346
+ billable?: boolean;
9347
+ cacheable?: boolean;
9348
+ input: {
9349
+ schema: {
9350
+ [k: string]: any;
9351
+ };
9352
+ };
9353
+ output: {
9354
+ schema: {
9355
+ [k: string]: any;
9356
+ };
9357
+ };
9358
+ };
9359
+ };
9360
+ /**
9361
+ * User object configuration
9362
+ */
9363
+ user: {
9364
+ tags: {
9365
+ /**
9366
+ * Definition of a tag that can be provided on the object
9367
+ */
9368
+ [k: string]: {
9369
+ /**
9370
+ * Title of the tag
9371
+ */
9372
+ title?: string;
9373
+ /**
9374
+ * Description of the tag
9375
+ */
9376
+ description?: string;
9377
+ };
9378
+ };
9379
+ };
9380
+ code: string;
9381
+ };
9382
+ }
9383
+
9384
+ interface UpdatePluginRequestHeaders {
9385
+ }
9386
+ interface UpdatePluginRequestQuery {
9387
+ }
9388
+ interface UpdatePluginRequestParams {
9389
+ id: string;
9390
+ }
9391
+ interface UpdatePluginRequestBody {
9392
+ /**
9393
+ * Configuration definition
9394
+ */
9395
+ configuration?: {
9396
+ /**
9397
+ * Title of the configuration
9398
+ */
9399
+ title?: string;
9400
+ /**
9401
+ * Description of the configuration
9402
+ */
9403
+ description?: string;
9404
+ /**
9405
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
9406
+ */
9407
+ schema: {
9408
+ [k: string]: any;
9409
+ };
9410
+ } | null;
9411
+ states?: {
9412
+ [k: string]: {
9413
+ /**
9414
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
9415
+ */
9416
+ type: "conversation" | "user" | "bot" | "task";
9417
+ /**
9418
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
9419
+ */
9420
+ schema: {
9421
+ [k: string]: any;
9422
+ };
9423
+ /**
9424
+ * 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.
9425
+ */
9426
+ expiry?: number;
9427
+ } | null;
9428
+ };
9429
+ events?: {
9430
+ /**
9431
+ * Event Definition
9432
+ */
9433
+ [k: string]: {
9434
+ /**
9435
+ * Title of the event
9436
+ */
9437
+ title?: string;
9438
+ /**
9439
+ * Description of the event
9440
+ */
9441
+ description?: string;
9442
+ schema: {
9443
+ [k: string]: any;
9444
+ };
9445
+ } | null;
9446
+ };
9447
+ actions?: {
9448
+ /**
9449
+ * Action definition
9450
+ */
9451
+ [k: string]: {
9452
+ /**
9453
+ * Title of the action
9454
+ */
9455
+ title?: string;
9456
+ /**
9457
+ * Description of the action
9458
+ */
9459
+ description?: string;
9460
+ billable?: boolean;
9461
+ cacheable?: boolean;
9462
+ input: {
9463
+ schema: {
9464
+ [k: string]: any;
9465
+ };
9466
+ };
9467
+ output: {
9468
+ schema: {
9469
+ [k: string]: any;
9470
+ };
9471
+ };
9472
+ } | null;
9473
+ };
9474
+ /**
9475
+ * User object configuration
9476
+ */
9477
+ user?: {
9478
+ tags: {
9479
+ /**
9480
+ * Definition of a tag that can be provided on the object
9481
+ */
9482
+ [k: string]: {
9483
+ /**
9484
+ * Title of the tag
9485
+ */
9486
+ title?: string;
9487
+ /**
9488
+ * Description of the tag
9489
+ */
9490
+ description?: string;
9491
+ };
9492
+ };
9493
+ } | null;
9494
+ code?: string;
9495
+ }
9496
+ type UpdatePluginInput = UpdatePluginRequestBody & UpdatePluginRequestHeaders & UpdatePluginRequestQuery & UpdatePluginRequestParams;
9497
+ interface UpdatePluginResponse {
9498
+ /**
9499
+ * Plugin definition
9500
+ */
9501
+ plugin: {
9502
+ /**
9503
+ * ID of the [Plugin](#schema_plugin)
9504
+ */
9505
+ id: string;
9506
+ /**
9507
+ * Name of the [Plugin](#schema_plugin)
9508
+ */
9509
+ name: string;
9510
+ /**
9511
+ * Version of the [Plugin](#schema_plugin)
9512
+ */
9513
+ version: string;
9514
+ /**
9515
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
9516
+ */
9517
+ createdAt: string;
9518
+ /**
9519
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
9520
+ */
9521
+ updatedAt: string;
9522
+ /**
9523
+ * Configuration definition
9524
+ */
9525
+ configuration: {
9526
+ /**
9527
+ * Title of the configuration
9528
+ */
9529
+ title?: string;
9530
+ /**
9531
+ * Description of the configuration
9532
+ */
9533
+ description?: string;
9534
+ /**
9535
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
9536
+ */
9537
+ schema: {
9538
+ [k: string]: any;
9539
+ };
9540
+ };
9541
+ states: {
9542
+ [k: string]: {
9543
+ /**
9544
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
9545
+ */
9546
+ type: "conversation" | "user" | "bot" | "task";
9547
+ /**
9548
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
9549
+ */
9550
+ schema: {
9551
+ [k: string]: any;
9552
+ };
9553
+ /**
9554
+ * 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.
9555
+ */
9556
+ expiry?: number;
9557
+ };
9558
+ };
9559
+ events: {
9560
+ /**
9561
+ * Event Definition
9562
+ */
9563
+ [k: string]: {
9564
+ /**
9565
+ * Title of the event
9566
+ */
9567
+ title?: string;
9568
+ /**
9569
+ * Description of the event
9570
+ */
9571
+ description?: string;
9572
+ schema: {
9573
+ [k: string]: any;
9574
+ };
9575
+ };
9576
+ };
9577
+ actions: {
9578
+ /**
9579
+ * Action definition
9580
+ */
9581
+ [k: string]: {
9582
+ /**
9583
+ * Title of the action
9584
+ */
9585
+ title?: string;
9586
+ /**
9587
+ * Description of the action
9588
+ */
9589
+ description?: string;
9590
+ billable?: boolean;
9591
+ cacheable?: boolean;
9592
+ input: {
9593
+ schema: {
9594
+ [k: string]: any;
9595
+ };
9596
+ };
9597
+ output: {
9598
+ schema: {
9599
+ [k: string]: any;
9600
+ };
9601
+ };
9602
+ };
9603
+ };
9604
+ /**
9605
+ * User object configuration
9606
+ */
9607
+ user: {
9608
+ tags: {
9609
+ /**
9610
+ * Definition of a tag that can be provided on the object
9611
+ */
9612
+ [k: string]: {
9613
+ /**
9614
+ * Title of the tag
9615
+ */
9616
+ title?: string;
9617
+ /**
9618
+ * Description of the tag
9619
+ */
9620
+ description?: string;
9621
+ };
9622
+ };
9623
+ };
9624
+ code: string;
9625
+ };
9626
+ }
9627
+
9628
+ interface DeletePluginRequestHeaders {
9629
+ }
9630
+ interface DeletePluginRequestQuery {
9631
+ }
9632
+ interface DeletePluginRequestParams {
9633
+ id: string;
9634
+ }
9635
+ interface DeletePluginRequestBody {
9636
+ }
9637
+ type DeletePluginInput = DeletePluginRequestBody & DeletePluginRequestHeaders & DeletePluginRequestQuery & DeletePluginRequestParams;
9638
+ interface DeletePluginResponse {
9639
+ }
9640
+
9641
+ interface ListPluginsRequestHeaders {
9642
+ }
9643
+ interface ListPluginsRequestQuery {
9644
+ nextToken?: string;
9645
+ name?: string;
9646
+ }
9647
+ interface ListPluginsRequestParams {
9648
+ }
9649
+ interface ListPluginsRequestBody {
9650
+ }
9651
+ type ListPluginsInput = ListPluginsRequestBody & ListPluginsRequestHeaders & ListPluginsRequestQuery & ListPluginsRequestParams;
9652
+ interface ListPluginsResponse {
9653
+ plugins: {
9654
+ /**
9655
+ * ID of the [Plugin](#schema_plugin)
9656
+ */
9657
+ id: string;
9658
+ /**
9659
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
9660
+ */
9661
+ createdAt: string;
9662
+ /**
9663
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
9664
+ */
9665
+ updatedAt: string;
9666
+ /**
9667
+ * Name of the [Plugin](#schema_plugin)
9668
+ */
9669
+ name: string;
9670
+ /**
9671
+ * Version of the [Plugin](#schema_plugin)
9672
+ */
9673
+ version: string;
9674
+ }[];
9675
+ meta: {
9676
+ /**
9677
+ * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
9678
+ */
9679
+ nextToken?: string;
9680
+ };
9681
+ }
9682
+
9683
+ interface GetUsageRequestHeaders {
9684
+ }
9685
+ interface GetUsageRequestQuery {
9686
+ 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";
9687
+ period?: string;
9688
+ }
9689
+ interface GetUsageRequestParams {
9690
+ id: string;
9691
+ }
9692
+ interface GetUsageRequestBody {
9693
+ }
9694
+ type GetUsageInput = GetUsageRequestBody & GetUsageRequestHeaders & GetUsageRequestQuery & GetUsageRequestParams;
9695
+ interface GetUsageResponse {
9696
+ usage: {
9697
+ /**
9698
+ * Id of the usage that it is linked to. It can either be a workspace id or a bot id
9699
+ */
9700
+ id: string;
9701
+ /**
9702
+ * Period of the quota that it is applied to
9703
+ */
9704
+ period: string;
9705
+ /**
9706
+ * Value of the current usage
9707
+ */
9708
+ value: number;
9709
+ /**
9710
+ * Quota of the current usage
9711
+ */
9712
+ quota: number;
9713
+ /**
9714
+ * Usage type that can be used
9715
+ */
9716
+ 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";
9717
+ };
9718
+ }
9719
+
9720
+ interface GetMultipleUsagesRequestHeaders {
9721
+ }
9722
+ interface GetMultipleUsagesRequestQuery {
9723
+ types: string[];
9724
+ ids: string[];
9725
+ period?: string;
9726
+ }
9727
+ interface GetMultipleUsagesRequestParams {
9728
+ }
9729
+ interface GetMultipleUsagesRequestBody {
9730
+ }
9731
+ type GetMultipleUsagesInput = GetMultipleUsagesRequestBody & GetMultipleUsagesRequestHeaders & GetMultipleUsagesRequestQuery & GetMultipleUsagesRequestParams;
9732
+ interface GetMultipleUsagesResponse {
9733
+ usages: {
9734
+ /**
9735
+ * Id of the usage that it is linked to. It can either be a workspace id or a bot id
9736
+ */
9737
+ id: string;
9738
+ /**
9739
+ * Period of the quota that it is applied to
9740
+ */
9741
+ period: string;
9742
+ /**
9743
+ * Value of the current usage
9744
+ */
9745
+ value: number;
9746
+ /**
9747
+ * Quota of the current usage
9748
+ */
9749
+ quota: number;
9750
+ /**
9751
+ * Usage type that can be used
9752
+ */
9753
+ 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";
9754
+ }[];
9755
+ }
9756
+
9757
+ interface ListUsageHistoryRequestHeaders {
9758
+ }
9759
+ interface ListUsageHistoryRequestQuery {
9760
+ 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";
9761
+ }
9762
+ interface ListUsageHistoryRequestParams {
9763
+ id: string;
9764
+ }
9765
+ interface ListUsageHistoryRequestBody {
9766
+ }
9767
+ type ListUsageHistoryInput = ListUsageHistoryRequestBody & ListUsageHistoryRequestHeaders & ListUsageHistoryRequestQuery & ListUsageHistoryRequestParams;
9768
+ interface ListUsageHistoryResponse {
9769
+ usages: {
9770
+ /**
9771
+ * Id of the usage that it is linked to. It can either be a workspace id or a bot id
9772
+ */
9773
+ id: string;
9774
+ /**
9775
+ * Period of the quota that it is applied to
9776
+ */
9777
+ period: string;
9778
+ /**
9779
+ * Value of the current usage
9780
+ */
9781
+ value: number;
9782
+ /**
9783
+ * Quota of the current usage
9784
+ */
9785
+ quota: number;
9786
+ /**
9787
+ * Usage type that can be used
9788
+ */
9789
+ 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";
9790
+ }[];
9791
+ }
9792
+
9793
+ interface ListUsageActivityRequestHeaders {
9794
+ }
9795
+ interface ListUsageActivityRequestQuery {
9796
+ 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";
9797
+ nextToken?: string;
9798
+ }
9799
+ interface ListUsageActivityRequestParams {
9800
+ id: string;
9801
+ }
9802
+ interface ListUsageActivityRequestBody {
9803
+ }
9804
+ type ListUsageActivityInput = ListUsageActivityRequestBody & ListUsageActivityRequestHeaders & ListUsageActivityRequestQuery & ListUsageActivityRequestParams;
9805
+ interface ListUsageActivityResponse {
9806
+ data: {
9807
+ timestamp: string;
9808
+ value: number;
9809
+ period: string;
9810
+ metadata: {
9811
+ [k: string]: any | null;
9812
+ };
9813
+ }[];
9814
+ meta: {
9815
+ nextToken?: string;
9816
+ };
9817
+ }
9818
+
9819
+ interface ChangeAispendQuotaRequestHeaders {
9820
+ }
9821
+ interface ChangeAispendQuotaRequestQuery {
9822
+ }
9823
+ interface ChangeAispendQuotaRequestParams {
9824
+ }
9825
+ interface ChangeAispendQuotaRequestBody {
9826
+ monthlySpendingLimit: number;
9827
+ }
9828
+ type ChangeAispendQuotaInput = ChangeAispendQuotaRequestBody & ChangeAispendQuotaRequestHeaders & ChangeAispendQuotaRequestQuery & ChangeAispendQuotaRequestParams;
8971
9829
  interface ChangeAispendQuotaResponse {
8972
9830
  }
8973
9831
 
@@ -9056,6 +9914,18 @@ interface UpsertFileRequestBody {
9056
9914
  * The minimum length a standalone paragraph should have. If a paragraph is shorter than this, it will be merged with the next immediate paragraph.
9057
9915
  */
9058
9916
  minimumParagraphLength?: number;
9917
+ /**
9918
+ * (Team/Enterprise plan only, charged as AI Spend) Enabling this will use a lightweight/inexpensive LLM to clean up the extracted content of PDF files before indexing them to increase the quality of the stored vectors, as PDFs often store raw text in unusual ways which when extracted may result in formatting issues (e.g. broken sentences/paragraphs, unexpected headings, garbled characters, etc.) that can affect retrieval performance for certain user queries if left untouched.
9919
+ *
9920
+ * Notes:
9921
+ * - This feature is only available in Team and Enterprise plans.
9922
+ * - This feature is only available for PDF files. If the file isn't a PDF, this setting will be ignored and no AI Spend will be incurred.
9923
+ * - We recommend using this feature for PDFs that have custom layouts or design. For simple text-based PDFs like documents and books, this feature is usually not necessary.
9924
+ * - The smart cleanup takes some time to perform due to the LLM calls involved, so enabling it will increase the total time it takes to index the file.
9925
+ * - We take steps to prevent the original text from being fundamentally changed but due to the nature of LLMs this could theoretically still happen so it's recommended to review the passages generated for the file after indexing to ensure the content is still accurate.
9926
+ * - This feature is limited to the first 30 pages or 20 KB of text in the PDF file (whichever comes first). If the file has more content than these limits then the rest of the file will be indexed as-is without any cleanup. If you need to clean up the content of the entire file, consider splitting it into smaller files.
9927
+ */
9928
+ smartCleanup?: boolean;
9059
9929
  };
9060
9930
  chunking?: {
9061
9931
  /**
@@ -9073,7 +9943,9 @@ interface UpsertFileRequestBody {
9073
9943
  };
9074
9944
  summarization?: {
9075
9945
  /**
9076
- * Create summaries for this file and index them as standalone vectors. Enabling this option will incur in AI Spend cost (charged to the workspace of the bot) to generate the summaries based on the amount of content in the file and the summarization model used. Please note that this feature is only available in Team/Enterprise plans.
9946
+ * (Team/Enterprise plan only, charged as AI Spend) Create summaries for this file and index them as standalone vectors. Enabling this option will incur in AI Spend cost (charged to the workspace of the bot) to generate the summaries based on the amount of content in the file and the summarization model used.
9947
+ *
9948
+ * Please note that this feature is only available in Team and Enterprise plans.
9077
9949
  */
9078
9950
  enable?: boolean;
9079
9951
  /**
@@ -9093,6 +9965,23 @@ interface UpsertFileRequestBody {
9093
9965
  */
9094
9966
  generateMasterSummary?: boolean;
9095
9967
  };
9968
+ vision?: {
9969
+ /**
9970
+ * (Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.
9971
+ *
9972
+ * This feature is useful when a PDF file contains custom designs or layouts, or when your document has many infographics, which require visual processing in order to index the file effectively, as the default text-based indexing may not be enough to allow your bot to correctly understand the content in your PDFs.
9973
+ *
9974
+ * Notes:
9975
+ * - This feature is only available in Team and Enterprise plans.
9976
+ * - Enabling this feature will incurr in AI Spend cost to use a vision-enabled LLM to index the PDF pages.
9977
+ * - This is limited to a maximum of 30 pages of the PDF. If the file has more pages then the rest of the pages will NOT be transcribed using this vision feature, and will be processed using the default text-based indexing instead. If you need to transcribe the entire file using vision, please split it into smaller files.
9978
+ * - Pages that are vision-transcribed will not be processed by the default text-based indexing to avoid duplicate content in the index.
9979
+ * - This feature is only available for PDF files. If the file isn't a PDF, this setting will be ignored and no AI Spend will be incurred.
9980
+ */
9981
+ transcribePages?: {
9982
+ [k: string]: any;
9983
+ };
9984
+ };
9096
9985
  };
9097
9986
  };
9098
9987
  /**
@@ -11523,6 +12412,10 @@ interface Integration {
11523
12412
  * Name of the interface
11524
12413
  */
11525
12414
  name: string;
12415
+ /**
12416
+ * Version of the interface
12417
+ */
12418
+ version: string;
11526
12419
  entities: {
11527
12420
  [k: string]: {
11528
12421
  name: string;
@@ -11944,7 +12837,7 @@ interface Workspace {
11944
12837
  createdAt: string;
11945
12838
  updatedAt: string;
11946
12839
  botCount: number;
11947
- billingVersion: "v1" | "v2";
12840
+ billingVersion: "v1" | "v2" | "v3";
11948
12841
  plan: "community" | "team" | "enterprise";
11949
12842
  blocked: boolean;
11950
12843
  spendingLimit: number;
@@ -12692,6 +13585,12 @@ declare class Client$1 {
12692
13585
  readonly updateInterface: (input: UpdateInterfaceInput) => Promise<UpdateInterfaceResponse>;
12693
13586
  readonly deleteInterface: (input: DeleteInterfaceInput) => Promise<DeleteInterfaceResponse>;
12694
13587
  readonly listInterfaces: (input: ListInterfacesInput) => Promise<ListInterfacesResponse>;
13588
+ readonly createPlugin: (input: CreatePluginInput) => Promise<CreatePluginResponse>;
13589
+ readonly getPlugin: (input: GetPluginInput) => Promise<GetPluginResponse>;
13590
+ readonly getPluginByName: (input: GetPluginByNameInput) => Promise<GetPluginByNameResponse>;
13591
+ readonly updatePlugin: (input: UpdatePluginInput) => Promise<UpdatePluginResponse>;
13592
+ readonly deletePlugin: (input: DeletePluginInput) => Promise<DeletePluginResponse>;
13593
+ readonly listPlugins: (input: ListPluginsInput) => Promise<ListPluginsResponse>;
12695
13594
  readonly getUsage: (input: GetUsageInput) => Promise<GetUsageResponse>;
12696
13595
  readonly getMultipleUsages: (input: GetMultipleUsagesInput) => Promise<GetMultipleUsagesResponse>;
12697
13596
  readonly listUsageHistory: (input: ListUsageHistoryInput) => Promise<ListUsageHistoryResponse>;
@@ -12982,9 +13881,51 @@ type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenErro
12982
13881
  declare const errorFrom: (err: unknown) => ApiError;
12983
13882
 
12984
13883
  declare class UploadFileError extends Error {
12985
- readonly innerError?: AxiosError | undefined;
12986
- readonly file?: UpsertFileResponse["file"] | undefined;
12987
- constructor(message: string, innerError?: AxiosError | undefined, file?: UpsertFileResponse["file"] | undefined);
13884
+ readonly innerError?: AxiosError<unknown, any> | undefined;
13885
+ readonly file?: {
13886
+ id: string;
13887
+ botId: string;
13888
+ key: string;
13889
+ url: string;
13890
+ size: number | null;
13891
+ contentType: string;
13892
+ tags: {
13893
+ [k: string]: string;
13894
+ };
13895
+ metadata: {
13896
+ [k: string]: any;
13897
+ };
13898
+ createdAt: string;
13899
+ updatedAt: string;
13900
+ accessPolicies: ("integrations" | "public_content")[];
13901
+ index: boolean;
13902
+ status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
13903
+ failedStatusReason?: string | undefined;
13904
+ expiresAt?: string | undefined;
13905
+ uploadUrl: string;
13906
+ } | undefined;
13907
+ constructor(message: string, innerError?: AxiosError<unknown, any> | undefined, file?: {
13908
+ id: string;
13909
+ botId: string;
13910
+ key: string;
13911
+ url: string;
13912
+ size: number | null;
13913
+ contentType: string;
13914
+ tags: {
13915
+ [k: string]: string;
13916
+ };
13917
+ metadata: {
13918
+ [k: string]: any;
13919
+ };
13920
+ createdAt: string;
13921
+ updatedAt: string;
13922
+ accessPolicies: ("integrations" | "public_content")[];
13923
+ index: boolean;
13924
+ status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
13925
+ failedStatusReason?: string | undefined;
13926
+ expiresAt?: string | undefined;
13927
+ uploadUrl: string;
13928
+ } | undefined);
12988
13929
  }
12989
13930
 
12990
13931
  type ListOperation = keyof {
@@ -13014,10 +13955,10 @@ declare class AsyncCollection<T> {
13014
13955
  declare class Lister {
13015
13956
  private _client;
13016
13957
  constructor(_client: Client$1);
13017
- readonly conversations: (props: ListInputs["listConversations"]) => AsyncCollection<{
13958
+ readonly conversations: (props: ListInputs['listConversations']) => AsyncCollection<{
13018
13959
  id: string;
13019
- currentTaskId?: string;
13020
- currentWorkflowId?: string;
13960
+ currentTaskId?: string | undefined;
13961
+ currentWorkflowId?: string | undefined;
13021
13962
  createdAt: string;
13022
13963
  updatedAt: string;
13023
13964
  channel: string;
@@ -13026,30 +13967,30 @@ declare class Lister {
13026
13967
  [k: string]: string;
13027
13968
  };
13028
13969
  }>;
13029
- readonly participants: (props: ListInputs["listParticipants"]) => AsyncCollection<{
13970
+ readonly participants: (props: ListInputs['listParticipants']) => AsyncCollection<{
13030
13971
  id: string;
13031
13972
  createdAt: string;
13032
13973
  updatedAt: string;
13033
13974
  tags: {
13034
13975
  [k: string]: string;
13035
13976
  };
13036
- name?: string;
13037
- pictureUrl?: string;
13977
+ name?: string | undefined;
13978
+ pictureUrl?: string | undefined;
13038
13979
  }>;
13039
- readonly events: (props: ListInputs["listEvents"]) => AsyncCollection<{
13980
+ readonly events: (props: ListInputs['listEvents']) => AsyncCollection<{
13040
13981
  id: string;
13041
13982
  createdAt: string;
13042
13983
  type: string;
13043
13984
  payload: {
13044
13985
  [k: string]: any;
13045
13986
  };
13046
- conversationId?: string;
13047
- userId?: string;
13048
- messageId?: string;
13987
+ conversationId?: string | undefined;
13988
+ userId?: string | undefined;
13989
+ messageId?: string | undefined;
13049
13990
  status: "pending" | "processed" | "ignored" | "failed" | "scheduled";
13050
13991
  failureReason: string | null;
13051
13992
  }>;
13052
- readonly messages: (props: ListInputs["listMessages"]) => AsyncCollection<{
13993
+ readonly messages: (props: ListInputs['listMessages']) => AsyncCollection<{
13053
13994
  id: string;
13054
13995
  createdAt: string;
13055
13996
  type: string;
@@ -13063,17 +14004,17 @@ declare class Lister {
13063
14004
  [k: string]: string;
13064
14005
  };
13065
14006
  }>;
13066
- readonly users: (props: ListInputs["listUsers"]) => AsyncCollection<{
14007
+ readonly users: (props: ListInputs['listUsers']) => AsyncCollection<{
13067
14008
  id: string;
13068
14009
  createdAt: string;
13069
14010
  updatedAt: string;
13070
14011
  tags: {
13071
14012
  [k: string]: string;
13072
14013
  };
13073
- name?: string;
13074
- pictureUrl?: string;
14014
+ name?: string | undefined;
14015
+ pictureUrl?: string | undefined;
13075
14016
  }>;
13076
- readonly tasks: (props: ListInputs["listTasks"]) => AsyncCollection<{
14017
+ readonly tasks: (props: ListInputs['listTasks']) => AsyncCollection<{
13077
14018
  id: string;
13078
14019
  title: string;
13079
14020
  description: string;
@@ -13081,19 +14022,19 @@ declare class Lister {
13081
14022
  data: {
13082
14023
  [k: string]: any;
13083
14024
  };
13084
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
13085
- parentTaskId?: string;
13086
- conversationId?: string;
13087
- userId?: string;
14025
+ status: "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
14026
+ parentTaskId?: string | undefined;
14027
+ conversationId?: string | undefined;
14028
+ userId?: string | undefined;
13088
14029
  timeoutAt: string;
13089
14030
  createdAt: string;
13090
14031
  updatedAt: string;
13091
- failureReason?: string;
14032
+ failureReason?: string | undefined;
13092
14033
  tags: {
13093
14034
  [k: string]: string;
13094
14035
  };
13095
14036
  }>;
13096
- readonly publicIntegrations: (props: ListInputs["listPublicIntegrations"]) => AsyncCollection<{
14037
+ readonly publicIntegrations: (props: ListInputs['listPublicIntegrations']) => AsyncCollection<{
13097
14038
  id: string;
13098
14039
  name: string;
13099
14040
  version: string;
@@ -13103,7 +14044,7 @@ declare class Lister {
13103
14044
  description: string;
13104
14045
  iconUrl: string;
13105
14046
  public: boolean;
13106
- verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
14047
+ verificationStatus: "pending" | "unapproved" | "approved" | "rejected";
13107
14048
  ownerWorkspace: {
13108
14049
  id: string;
13109
14050
  handle: string | null;
@@ -13114,14 +14055,14 @@ declare class Lister {
13114
14055
  views: number;
13115
14056
  };
13116
14057
  }>;
13117
- readonly bots: (props: ListInputs["listBots"]) => AsyncCollection<{
14058
+ readonly bots: (props: ListInputs['listBots']) => AsyncCollection<{
13118
14059
  id: string;
13119
14060
  createdAt: string;
13120
14061
  updatedAt: string;
13121
14062
  name: string;
13122
- deployedAt?: string;
14063
+ deployedAt?: string | undefined;
13123
14064
  }>;
13124
- readonly botIssues: (props: ListInputs["listBotIssues"]) => AsyncCollection<{
14065
+ readonly botIssues: (props: ListInputs['listBotIssues']) => AsyncCollection<{
13125
14066
  id: string;
13126
14067
  code: string;
13127
14068
  createdAt: string;
@@ -13131,25 +14072,25 @@ declare class Lister {
13131
14072
  groupedData: {
13132
14073
  [k: string]: {
13133
14074
  raw: string;
13134
- pretty?: string;
14075
+ pretty?: string | undefined;
13135
14076
  };
13136
14077
  };
13137
14078
  eventsCount: number;
13138
- category: "user_code" | "limits" | "configuration" | "other";
14079
+ category: "configuration" | "user_code" | "limits" | "other";
13139
14080
  resolutionLink: string | null;
13140
14081
  }>;
13141
- readonly workspaces: (props: ListInputs["listWorkspaces"]) => AsyncCollection<UpdateWorkspaceResponse>;
13142
- readonly publicWorkspaces: (props: ListInputs["listPublicWorkspaces"]) => AsyncCollection<GetPublicWorkspaceResponse>;
13143
- readonly workspaceMembers: (props: ListInputs["listWorkspaceMembers"]) => AsyncCollection<{
14082
+ readonly workspaces: (props: ListInputs['listWorkspaces']) => AsyncCollection<UpdateWorkspaceResponse>;
14083
+ readonly publicWorkspaces: (props: ListInputs['listPublicWorkspaces']) => AsyncCollection<GetPublicWorkspaceResponse>;
14084
+ readonly workspaceMembers: (props: ListInputs['listWorkspaceMembers']) => AsyncCollection<{
13144
14085
  id: string;
13145
- userId?: string;
14086
+ userId?: string | undefined;
13146
14087
  email: string;
13147
14088
  createdAt: string;
13148
14089
  role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
13149
- profilePicture?: string;
13150
- displayName?: string;
14090
+ profilePicture?: string | undefined;
14091
+ displayName?: string | undefined;
13151
14092
  }>;
13152
- readonly integrations: (props: ListInputs["listIntegrations"]) => AsyncCollection<{
14093
+ readonly integrations: (props: ListInputs['listIntegrations']) => AsyncCollection<{
13153
14094
  id: string;
13154
14095
  name: string;
13155
14096
  version: string;
@@ -13159,16 +14100,16 @@ declare class Lister {
13159
14100
  description: string;
13160
14101
  iconUrl: string;
13161
14102
  public: boolean;
13162
- verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
14103
+ verificationStatus: "pending" | "unapproved" | "approved" | "rejected";
13163
14104
  }>;
13164
- readonly interfaces: (props: ListInputs["listInterfaces"]) => AsyncCollection<{
14105
+ readonly interfaces: (props: ListInputs['listInterfaces']) => AsyncCollection<{
13165
14106
  id: string;
13166
14107
  createdAt: string;
13167
14108
  updatedAt: string;
13168
14109
  name: string;
13169
14110
  version: string;
13170
14111
  }>;
13171
- readonly activities: (props: ListInputs["listActivities"]) => AsyncCollection<{
14112
+ readonly activities: (props: ListInputs['listActivities']) => AsyncCollection<{
13172
14113
  id: string;
13173
14114
  description: string;
13174
14115
  taskId: string;
@@ -13178,7 +14119,7 @@ declare class Lister {
13178
14119
  };
13179
14120
  createdAt: string;
13180
14121
  }>;
13181
- readonly files: (props: ListInputs["listFiles"]) => AsyncCollection<{
14122
+ readonly files: (props: ListInputs['listFiles']) => AsyncCollection<{
13182
14123
  id: string;
13183
14124
  botId: string;
13184
14125
  key: string;
@@ -13189,24 +14130,24 @@ declare class Lister {
13189
14130
  [k: string]: string;
13190
14131
  };
13191
14132
  metadata: {
13192
- [k: string]: any | null;
14133
+ [k: string]: any;
13193
14134
  };
13194
14135
  createdAt: string;
13195
14136
  updatedAt: string;
13196
14137
  accessPolicies: ("integrations" | "public_content")[];
13197
14138
  index: boolean;
13198
14139
  status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
13199
- failedStatusReason?: string;
13200
- expiresAt?: string;
14140
+ failedStatusReason?: string | undefined;
14141
+ expiresAt?: string | undefined;
13201
14142
  }>;
13202
- readonly filePassages: (props: ListInputs["listFilePassages"]) => AsyncCollection<{
14143
+ readonly filePassages: (props: ListInputs['listFilePassages']) => AsyncCollection<{
13203
14144
  id: string;
13204
14145
  content: string;
13205
14146
  meta: {
13206
- type?: "chunk" | "summary" | "consolidated";
13207
- subtype?: "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | "code";
13208
- pageNumber?: number;
13209
- position?: number;
14147
+ type?: "chunk" | "summary" | "consolidated" | undefined;
14148
+ subtype?: "code" | "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | undefined;
14149
+ pageNumber?: number | undefined;
14150
+ position?: number | undefined;
13210
14151
  };
13211
14152
  }>;
13212
14153
  }
@@ -13218,7 +14159,7 @@ declare class Client extends Client$1 implements IClient {
13218
14159
  /**
13219
14160
  * Create/update and upload a file in a single step. Returns an object containing the file metadata and the URL to retrieve the file.
13220
14161
  */
13221
- readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs["uploadFile"]) => Promise<ClientOutputs["uploadFile"]>;
14162
+ readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs['uploadFile']) => Promise<ClientOutputs['uploadFile']>;
13222
14163
  }
13223
14164
 
13224
14165
  export { type Account, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientParams, type ClientProps, type ClientReturn, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type IClient, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, PayloadTooLargeError, PaymentRequiredError, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workflow, type Workspace, type WorkspaceMember, errorFrom, isApiError };