@botpress/client 0.36.0 → 0.36.2

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
@@ -5399,7 +5399,7 @@ interface CreateWorkspaceResponse {
5399
5399
  createdAt: string;
5400
5400
  updatedAt: string;
5401
5401
  botCount: number;
5402
- billingVersion: "v1" | "v2";
5402
+ billingVersion: "v1" | "v2" | "v3";
5403
5403
  plan: "community" | "team" | "enterprise";
5404
5404
  blocked: boolean;
5405
5405
  spendingLimit: number;
@@ -5452,7 +5452,7 @@ interface GetWorkspaceResponse {
5452
5452
  createdAt: string;
5453
5453
  updatedAt: string;
5454
5454
  botCount: number;
5455
- billingVersion: "v1" | "v2";
5455
+ billingVersion: "v1" | "v2" | "v3";
5456
5456
  plan: "community" | "team" | "enterprise";
5457
5457
  blocked: boolean;
5458
5458
  spendingLimit: number;
@@ -5623,7 +5623,7 @@ interface UpdateWorkspaceResponse$1 {
5623
5623
  createdAt: string;
5624
5624
  updatedAt: string;
5625
5625
  botCount: number;
5626
- billingVersion: "v1" | "v2";
5626
+ billingVersion: "v1" | "v2" | "v3";
5627
5627
  plan: "community" | "team" | "enterprise";
5628
5628
  blocked: boolean;
5629
5629
  spendingLimit: number;
@@ -5678,7 +5678,7 @@ interface UpdateWorkspaceResponse {
5678
5678
  createdAt: string;
5679
5679
  updatedAt: string;
5680
5680
  botCount: number;
5681
- billingVersion: "v1" | "v2";
5681
+ billingVersion: "v1" | "v2" | "v3";
5682
5682
  plan: "community" | "team" | "enterprise";
5683
5683
  blocked: boolean;
5684
5684
  spendingLimit: number;
@@ -8847,6 +8847,839 @@ interface ListInterfacesResponse {
8847
8847
  };
8848
8848
  }
8849
8849
 
8850
+ interface CreatePluginRequestHeaders {
8851
+ }
8852
+ interface CreatePluginRequestQuery {
8853
+ }
8854
+ interface CreatePluginRequestParams {
8855
+ }
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?: {
8869
+ /**
8870
+ * Title of the configuration
8871
+ */
8872
+ title?: string;
8873
+ /**
8874
+ * Description of the configuration
8875
+ */
8876
+ description?: string;
8877
+ /**
8878
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
8879
+ */
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?: {
8903
+ /**
8904
+ * Event Definition
8905
+ */
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?: {
8921
+ /**
8922
+ * Action definition
8923
+ */
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
+ };
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;
8968
+ }
8969
+ type CreatePluginInput = CreatePluginRequestBody & CreatePluginRequestHeaders & CreatePluginRequestQuery & CreatePluginRequestParams;
8970
+ interface CreatePluginResponse {
8971
+ /**
8972
+ * Plugin definition
8973
+ */
8974
+ plugin: {
8975
+ /**
8976
+ * ID of the [Plugin](#schema_plugin)
8977
+ */
8978
+ id: string;
8979
+ /**
8980
+ * Name of the [Plugin](#schema_plugin)
8981
+ */
8982
+ name: string;
8983
+ /**
8984
+ * Version of the [Plugin](#schema_plugin)
8985
+ */
8986
+ version: string;
8987
+ /**
8988
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
8989
+ */
8990
+ createdAt: string;
8991
+ /**
8992
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
8993
+ */
8994
+ updatedAt: string;
8995
+ /**
8996
+ * Configuration definition
8997
+ */
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
+ };
9013
+ };
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
+
8850
9683
  interface GetUsageRequestHeaders {
8851
9684
  }
8852
9685
  interface GetUsageRequestQuery {
@@ -11997,6 +12830,134 @@ interface Interface {
11997
12830
  language: string;
11998
12831
  };
11999
12832
  }
12833
+ /**
12834
+ * Plugin definition
12835
+ */
12836
+ interface Plugin {
12837
+ /**
12838
+ * ID of the [Plugin](#schema_plugin)
12839
+ */
12840
+ id: string;
12841
+ /**
12842
+ * Name of the [Plugin](#schema_plugin)
12843
+ */
12844
+ name: string;
12845
+ /**
12846
+ * Version of the [Plugin](#schema_plugin)
12847
+ */
12848
+ version: string;
12849
+ /**
12850
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
12851
+ */
12852
+ createdAt: string;
12853
+ /**
12854
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
12855
+ */
12856
+ updatedAt: string;
12857
+ /**
12858
+ * Configuration definition
12859
+ */
12860
+ configuration: {
12861
+ /**
12862
+ * Title of the configuration
12863
+ */
12864
+ title?: string;
12865
+ /**
12866
+ * Description of the configuration
12867
+ */
12868
+ description?: string;
12869
+ /**
12870
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
12871
+ */
12872
+ schema: {
12873
+ [k: string]: any;
12874
+ };
12875
+ };
12876
+ states: {
12877
+ [k: string]: {
12878
+ /**
12879
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
12880
+ */
12881
+ type: "conversation" | "user" | "bot" | "task";
12882
+ /**
12883
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
12884
+ */
12885
+ schema: {
12886
+ [k: string]: any;
12887
+ };
12888
+ /**
12889
+ * 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.
12890
+ */
12891
+ expiry?: number;
12892
+ };
12893
+ };
12894
+ events: {
12895
+ /**
12896
+ * Event Definition
12897
+ */
12898
+ [k: string]: {
12899
+ /**
12900
+ * Title of the event
12901
+ */
12902
+ title?: string;
12903
+ /**
12904
+ * Description of the event
12905
+ */
12906
+ description?: string;
12907
+ schema: {
12908
+ [k: string]: any;
12909
+ };
12910
+ };
12911
+ };
12912
+ actions: {
12913
+ /**
12914
+ * Action definition
12915
+ */
12916
+ [k: string]: {
12917
+ /**
12918
+ * Title of the action
12919
+ */
12920
+ title?: string;
12921
+ /**
12922
+ * Description of the action
12923
+ */
12924
+ description?: string;
12925
+ billable?: boolean;
12926
+ cacheable?: boolean;
12927
+ input: {
12928
+ schema: {
12929
+ [k: string]: any;
12930
+ };
12931
+ };
12932
+ output: {
12933
+ schema: {
12934
+ [k: string]: any;
12935
+ };
12936
+ };
12937
+ };
12938
+ };
12939
+ /**
12940
+ * User object configuration
12941
+ */
12942
+ user: {
12943
+ tags: {
12944
+ /**
12945
+ * Definition of a tag that can be provided on the object
12946
+ */
12947
+ [k: string]: {
12948
+ /**
12949
+ * Title of the tag
12950
+ */
12951
+ title?: string;
12952
+ /**
12953
+ * Description of the tag
12954
+ */
12955
+ description?: string;
12956
+ };
12957
+ };
12958
+ };
12959
+ code: string;
12960
+ }
12000
12961
  interface Workspace {
12001
12962
  id: string;
12002
12963
  name: string;
@@ -12004,7 +12965,7 @@ interface Workspace {
12004
12965
  createdAt: string;
12005
12966
  updatedAt: string;
12006
12967
  botCount: number;
12007
- billingVersion: "v1" | "v2";
12968
+ billingVersion: "v1" | "v2" | "v3";
12008
12969
  plan: "community" | "team" | "enterprise";
12009
12970
  blocked: boolean;
12010
12971
  spendingLimit: number;
@@ -12752,6 +13713,12 @@ declare class Client$1 {
12752
13713
  readonly updateInterface: (input: UpdateInterfaceInput) => Promise<UpdateInterfaceResponse>;
12753
13714
  readonly deleteInterface: (input: DeleteInterfaceInput) => Promise<DeleteInterfaceResponse>;
12754
13715
  readonly listInterfaces: (input: ListInterfacesInput) => Promise<ListInterfacesResponse>;
13716
+ readonly createPlugin: (input: CreatePluginInput) => Promise<CreatePluginResponse>;
13717
+ readonly getPlugin: (input: GetPluginInput) => Promise<GetPluginResponse>;
13718
+ readonly getPluginByName: (input: GetPluginByNameInput) => Promise<GetPluginByNameResponse>;
13719
+ readonly updatePlugin: (input: UpdatePluginInput) => Promise<UpdatePluginResponse>;
13720
+ readonly deletePlugin: (input: DeletePluginInput) => Promise<DeletePluginResponse>;
13721
+ readonly listPlugins: (input: ListPluginsInput) => Promise<ListPluginsResponse>;
12755
13722
  readonly getUsage: (input: GetUsageInput) => Promise<GetUsageResponse>;
12756
13723
  readonly getMultipleUsages: (input: GetMultipleUsagesInput) => Promise<GetMultipleUsagesResponse>;
12757
13724
  readonly listUsageHistory: (input: ListUsageHistoryInput) => Promise<ListUsageHistoryResponse>;
@@ -13042,9 +14009,51 @@ type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenErro
13042
14009
  declare const errorFrom: (err: unknown) => ApiError;
13043
14010
 
13044
14011
  declare class UploadFileError extends Error {
13045
- readonly innerError?: AxiosError | undefined;
13046
- readonly file?: UpsertFileResponse["file"] | undefined;
13047
- constructor(message: string, innerError?: AxiosError | undefined, file?: UpsertFileResponse["file"] | undefined);
14012
+ readonly innerError?: AxiosError<unknown, any> | undefined;
14013
+ readonly file?: {
14014
+ id: string;
14015
+ botId: string;
14016
+ key: string;
14017
+ url: string;
14018
+ size: number | null;
14019
+ contentType: string;
14020
+ tags: {
14021
+ [k: string]: string;
14022
+ };
14023
+ metadata: {
14024
+ [k: string]: any;
14025
+ };
14026
+ createdAt: string;
14027
+ updatedAt: string;
14028
+ accessPolicies: ("integrations" | "public_content")[];
14029
+ index: boolean;
14030
+ status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
14031
+ failedStatusReason?: string | undefined;
14032
+ expiresAt?: string | undefined;
14033
+ uploadUrl: string;
14034
+ } | undefined;
14035
+ constructor(message: string, innerError?: AxiosError<unknown, any> | undefined, file?: {
14036
+ id: string;
14037
+ botId: string;
14038
+ key: string;
14039
+ url: string;
14040
+ size: number | null;
14041
+ contentType: string;
14042
+ tags: {
14043
+ [k: string]: string;
14044
+ };
14045
+ metadata: {
14046
+ [k: string]: any;
14047
+ };
14048
+ createdAt: string;
14049
+ updatedAt: string;
14050
+ accessPolicies: ("integrations" | "public_content")[];
14051
+ index: boolean;
14052
+ status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
14053
+ failedStatusReason?: string | undefined;
14054
+ expiresAt?: string | undefined;
14055
+ uploadUrl: string;
14056
+ } | undefined);
13048
14057
  }
13049
14058
 
13050
14059
  type ListOperation = keyof {
@@ -13074,10 +14083,10 @@ declare class AsyncCollection<T> {
13074
14083
  declare class Lister {
13075
14084
  private _client;
13076
14085
  constructor(_client: Client$1);
13077
- readonly conversations: (props: ListInputs["listConversations"]) => AsyncCollection<{
14086
+ readonly conversations: (props: ListInputs['listConversations']) => AsyncCollection<{
13078
14087
  id: string;
13079
- currentTaskId?: string;
13080
- currentWorkflowId?: string;
14088
+ currentTaskId?: string | undefined;
14089
+ currentWorkflowId?: string | undefined;
13081
14090
  createdAt: string;
13082
14091
  updatedAt: string;
13083
14092
  channel: string;
@@ -13086,30 +14095,30 @@ declare class Lister {
13086
14095
  [k: string]: string;
13087
14096
  };
13088
14097
  }>;
13089
- readonly participants: (props: ListInputs["listParticipants"]) => AsyncCollection<{
14098
+ readonly participants: (props: ListInputs['listParticipants']) => AsyncCollection<{
13090
14099
  id: string;
13091
14100
  createdAt: string;
13092
14101
  updatedAt: string;
13093
14102
  tags: {
13094
14103
  [k: string]: string;
13095
14104
  };
13096
- name?: string;
13097
- pictureUrl?: string;
14105
+ name?: string | undefined;
14106
+ pictureUrl?: string | undefined;
13098
14107
  }>;
13099
- readonly events: (props: ListInputs["listEvents"]) => AsyncCollection<{
14108
+ readonly events: (props: ListInputs['listEvents']) => AsyncCollection<{
13100
14109
  id: string;
13101
14110
  createdAt: string;
13102
14111
  type: string;
13103
14112
  payload: {
13104
14113
  [k: string]: any;
13105
14114
  };
13106
- conversationId?: string;
13107
- userId?: string;
13108
- messageId?: string;
14115
+ conversationId?: string | undefined;
14116
+ userId?: string | undefined;
14117
+ messageId?: string | undefined;
13109
14118
  status: "pending" | "processed" | "ignored" | "failed" | "scheduled";
13110
14119
  failureReason: string | null;
13111
14120
  }>;
13112
- readonly messages: (props: ListInputs["listMessages"]) => AsyncCollection<{
14121
+ readonly messages: (props: ListInputs['listMessages']) => AsyncCollection<{
13113
14122
  id: string;
13114
14123
  createdAt: string;
13115
14124
  type: string;
@@ -13123,17 +14132,17 @@ declare class Lister {
13123
14132
  [k: string]: string;
13124
14133
  };
13125
14134
  }>;
13126
- readonly users: (props: ListInputs["listUsers"]) => AsyncCollection<{
14135
+ readonly users: (props: ListInputs['listUsers']) => AsyncCollection<{
13127
14136
  id: string;
13128
14137
  createdAt: string;
13129
14138
  updatedAt: string;
13130
14139
  tags: {
13131
14140
  [k: string]: string;
13132
14141
  };
13133
- name?: string;
13134
- pictureUrl?: string;
14142
+ name?: string | undefined;
14143
+ pictureUrl?: string | undefined;
13135
14144
  }>;
13136
- readonly tasks: (props: ListInputs["listTasks"]) => AsyncCollection<{
14145
+ readonly tasks: (props: ListInputs['listTasks']) => AsyncCollection<{
13137
14146
  id: string;
13138
14147
  title: string;
13139
14148
  description: string;
@@ -13141,19 +14150,19 @@ declare class Lister {
13141
14150
  data: {
13142
14151
  [k: string]: any;
13143
14152
  };
13144
- status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
13145
- parentTaskId?: string;
13146
- conversationId?: string;
13147
- userId?: string;
14153
+ status: "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
14154
+ parentTaskId?: string | undefined;
14155
+ conversationId?: string | undefined;
14156
+ userId?: string | undefined;
13148
14157
  timeoutAt: string;
13149
14158
  createdAt: string;
13150
14159
  updatedAt: string;
13151
- failureReason?: string;
14160
+ failureReason?: string | undefined;
13152
14161
  tags: {
13153
14162
  [k: string]: string;
13154
14163
  };
13155
14164
  }>;
13156
- readonly publicIntegrations: (props: ListInputs["listPublicIntegrations"]) => AsyncCollection<{
14165
+ readonly publicIntegrations: (props: ListInputs['listPublicIntegrations']) => AsyncCollection<{
13157
14166
  id: string;
13158
14167
  name: string;
13159
14168
  version: string;
@@ -13163,7 +14172,7 @@ declare class Lister {
13163
14172
  description: string;
13164
14173
  iconUrl: string;
13165
14174
  public: boolean;
13166
- verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
14175
+ verificationStatus: "pending" | "unapproved" | "approved" | "rejected";
13167
14176
  ownerWorkspace: {
13168
14177
  id: string;
13169
14178
  handle: string | null;
@@ -13174,14 +14183,14 @@ declare class Lister {
13174
14183
  views: number;
13175
14184
  };
13176
14185
  }>;
13177
- readonly bots: (props: ListInputs["listBots"]) => AsyncCollection<{
14186
+ readonly bots: (props: ListInputs['listBots']) => AsyncCollection<{
13178
14187
  id: string;
13179
14188
  createdAt: string;
13180
14189
  updatedAt: string;
13181
14190
  name: string;
13182
- deployedAt?: string;
14191
+ deployedAt?: string | undefined;
13183
14192
  }>;
13184
- readonly botIssues: (props: ListInputs["listBotIssues"]) => AsyncCollection<{
14193
+ readonly botIssues: (props: ListInputs['listBotIssues']) => AsyncCollection<{
13185
14194
  id: string;
13186
14195
  code: string;
13187
14196
  createdAt: string;
@@ -13191,25 +14200,25 @@ declare class Lister {
13191
14200
  groupedData: {
13192
14201
  [k: string]: {
13193
14202
  raw: string;
13194
- pretty?: string;
14203
+ pretty?: string | undefined;
13195
14204
  };
13196
14205
  };
13197
14206
  eventsCount: number;
13198
- category: "user_code" | "limits" | "configuration" | "other";
14207
+ category: "configuration" | "user_code" | "limits" | "other";
13199
14208
  resolutionLink: string | null;
13200
14209
  }>;
13201
- readonly workspaces: (props: ListInputs["listWorkspaces"]) => AsyncCollection<UpdateWorkspaceResponse>;
13202
- readonly publicWorkspaces: (props: ListInputs["listPublicWorkspaces"]) => AsyncCollection<GetPublicWorkspaceResponse>;
13203
- readonly workspaceMembers: (props: ListInputs["listWorkspaceMembers"]) => AsyncCollection<{
14210
+ readonly workspaces: (props: ListInputs['listWorkspaces']) => AsyncCollection<UpdateWorkspaceResponse>;
14211
+ readonly publicWorkspaces: (props: ListInputs['listPublicWorkspaces']) => AsyncCollection<GetPublicWorkspaceResponse>;
14212
+ readonly workspaceMembers: (props: ListInputs['listWorkspaceMembers']) => AsyncCollection<{
13204
14213
  id: string;
13205
- userId?: string;
14214
+ userId?: string | undefined;
13206
14215
  email: string;
13207
14216
  createdAt: string;
13208
14217
  role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
13209
- profilePicture?: string;
13210
- displayName?: string;
14218
+ profilePicture?: string | undefined;
14219
+ displayName?: string | undefined;
13211
14220
  }>;
13212
- readonly integrations: (props: ListInputs["listIntegrations"]) => AsyncCollection<{
14221
+ readonly integrations: (props: ListInputs['listIntegrations']) => AsyncCollection<{
13213
14222
  id: string;
13214
14223
  name: string;
13215
14224
  version: string;
@@ -13219,16 +14228,16 @@ declare class Lister {
13219
14228
  description: string;
13220
14229
  iconUrl: string;
13221
14230
  public: boolean;
13222
- verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
14231
+ verificationStatus: "pending" | "unapproved" | "approved" | "rejected";
13223
14232
  }>;
13224
- readonly interfaces: (props: ListInputs["listInterfaces"]) => AsyncCollection<{
14233
+ readonly interfaces: (props: ListInputs['listInterfaces']) => AsyncCollection<{
13225
14234
  id: string;
13226
14235
  createdAt: string;
13227
14236
  updatedAt: string;
13228
14237
  name: string;
13229
14238
  version: string;
13230
14239
  }>;
13231
- readonly activities: (props: ListInputs["listActivities"]) => AsyncCollection<{
14240
+ readonly activities: (props: ListInputs['listActivities']) => AsyncCollection<{
13232
14241
  id: string;
13233
14242
  description: string;
13234
14243
  taskId: string;
@@ -13238,7 +14247,7 @@ declare class Lister {
13238
14247
  };
13239
14248
  createdAt: string;
13240
14249
  }>;
13241
- readonly files: (props: ListInputs["listFiles"]) => AsyncCollection<{
14250
+ readonly files: (props: ListInputs['listFiles']) => AsyncCollection<{
13242
14251
  id: string;
13243
14252
  botId: string;
13244
14253
  key: string;
@@ -13249,24 +14258,24 @@ declare class Lister {
13249
14258
  [k: string]: string;
13250
14259
  };
13251
14260
  metadata: {
13252
- [k: string]: any | null;
14261
+ [k: string]: any;
13253
14262
  };
13254
14263
  createdAt: string;
13255
14264
  updatedAt: string;
13256
14265
  accessPolicies: ("integrations" | "public_content")[];
13257
14266
  index: boolean;
13258
14267
  status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
13259
- failedStatusReason?: string;
13260
- expiresAt?: string;
14268
+ failedStatusReason?: string | undefined;
14269
+ expiresAt?: string | undefined;
13261
14270
  }>;
13262
- readonly filePassages: (props: ListInputs["listFilePassages"]) => AsyncCollection<{
14271
+ readonly filePassages: (props: ListInputs['listFilePassages']) => AsyncCollection<{
13263
14272
  id: string;
13264
14273
  content: string;
13265
14274
  meta: {
13266
- type?: "chunk" | "summary" | "consolidated";
13267
- subtype?: "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | "code";
13268
- pageNumber?: number;
13269
- position?: number;
14275
+ type?: "chunk" | "summary" | "consolidated" | undefined;
14276
+ subtype?: "code" | "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | undefined;
14277
+ pageNumber?: number | undefined;
14278
+ position?: number | undefined;
13270
14279
  };
13271
14280
  }>;
13272
14281
  }
@@ -13278,7 +14287,7 @@ declare class Client extends Client$1 implements IClient {
13278
14287
  /**
13279
14288
  * Create/update and upload a file in a single step. Returns an object containing the file metadata and the URL to retrieve the file.
13280
14289
  */
13281
- readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs["uploadFile"]) => Promise<ClientOutputs["uploadFile"]>;
14290
+ readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, indexing, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs['uploadFile']) => Promise<ClientOutputs['uploadFile']>;
13282
14291
  }
13283
14292
 
13284
- 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 };
14293
+ 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, type Plugin, 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 };