@botpress/cognitive 0.1.16 → 0.1.18

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.
@@ -1,19 +1,19 @@
1
1
 
2
- > @botpress/cognitive@0.1.16 build /home/runner/work/botpress/botpress/packages/cognitive
2
+ > @botpress/cognitive@0.1.18 build /home/runner/work/botpress/botpress/packages/cognitive
3
3
  > pnpm build:type && pnpm build:neutral && size-limit
4
4
 
5
5
 
6
- > @botpress/cognitive@0.1.16 build:type /home/runner/work/botpress/botpress/packages/cognitive
6
+ > @botpress/cognitive@0.1.18 build:type /home/runner/work/botpress/botpress/packages/cognitive
7
7
  > tsup --tsconfig tsconfig.build.json ./src/index.ts --dts-resolve --dts-only --clean
8
8
 
9
9
  CLI Building entry: ./src/index.ts
10
10
  CLI Using tsconfig: tsconfig.build.json
11
11
  CLI tsup v8.0.2
12
12
  DTS Build start
13
- DTS ⚡️ Build success in 9136ms
14
- DTS dist/index.d.ts 539.34 KB
13
+ DTS ⚡️ Build success in 10432ms
14
+ DTS dist/index.d.ts 555.36 KB
15
15
 
16
- > @botpress/cognitive@0.1.16 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
16
+ > @botpress/cognitive@0.1.18 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
17
17
  > ts-node -T ./build.ts --neutral
18
18
 
19
19
  Done
package/dist/index.d.ts CHANGED
@@ -3047,17 +3047,15 @@ interface ConfigureIntegrationRequestBody {
3047
3047
  /**
3048
3048
  * Unique identifier of the integration that was installed on the bot
3049
3049
  */
3050
- identifier?: string;
3050
+ identifier?: string | null;
3051
3051
  /**
3052
3052
  * Recurring schedule on which `register()` will be called on the integration
3053
3053
  */
3054
3054
  scheduleRegisterCall?: "hourly" | "daily" | "weekly" | "bi-weekly" | "monthly" | "bi-monthly" | "quarterly" | "yearly";
3055
3055
  /**
3056
- * Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. Setting an individual sandbox identifier to null will remove that sandbox identifier. This is an experimental feature meant to be used by specific integrations.
3056
+ * **EXPERIMENTAL** Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. This is an experimental feature meant to be used by specific integrations.
3057
3057
  */
3058
- sandboxIdentifiers?: {
3059
- [k: string]: {} | null;
3060
- } | null;
3058
+ sandboxIdentifiers?: {} | null;
3061
3059
  }
3062
3060
  type ConfigureIntegrationInput = ConfigureIntegrationRequestBody & ConfigureIntegrationRequestHeaders & ConfigureIntegrationRequestQuery & ConfigureIntegrationRequestParams;
3063
3061
  interface ConfigureIntegrationResponse {
@@ -4549,6 +4547,12 @@ interface GetPublicIntegrationByIdResponse {
4549
4547
  schema: {
4550
4548
  [k: string]: any;
4551
4549
  };
4550
+ /**
4551
+ * Optional attributes
4552
+ */
4553
+ attributes?: {
4554
+ [k: string]: string;
4555
+ };
4552
4556
  };
4553
4557
  };
4554
4558
  actions: {
@@ -4576,6 +4580,12 @@ interface GetPublicIntegrationByIdResponse {
4576
4580
  [k: string]: any;
4577
4581
  };
4578
4582
  };
4583
+ /**
4584
+ * Optional attributes
4585
+ */
4586
+ attributes?: {
4587
+ [k: string]: string;
4588
+ };
4579
4589
  };
4580
4590
  };
4581
4591
  /**
@@ -4934,6 +4944,12 @@ interface GetPublicIntegrationResponse {
4934
4944
  schema: {
4935
4945
  [k: string]: any;
4936
4946
  };
4947
+ /**
4948
+ * Optional attributes
4949
+ */
4950
+ attributes?: {
4951
+ [k: string]: string;
4952
+ };
4937
4953
  };
4938
4954
  };
4939
4955
  actions: {
@@ -4961,6 +4977,12 @@ interface GetPublicIntegrationResponse {
4961
4977
  [k: string]: any;
4962
4978
  };
4963
4979
  };
4980
+ /**
4981
+ * Optional attributes
4982
+ */
4983
+ attributes?: {
4984
+ [k: string]: string;
4985
+ };
4964
4986
  };
4965
4987
  };
4966
4988
  /**
@@ -5206,6 +5228,12 @@ interface GetPublicPluginByIdResponse {
5206
5228
  schema: {
5207
5229
  [k: string]: any;
5208
5230
  };
5231
+ /**
5232
+ * Optional attributes
5233
+ */
5234
+ attributes?: {
5235
+ [k: string]: string;
5236
+ };
5209
5237
  };
5210
5238
  };
5211
5239
  actions: {
@@ -5233,6 +5261,12 @@ interface GetPublicPluginByIdResponse {
5233
5261
  [k: string]: any;
5234
5262
  };
5235
5263
  };
5264
+ /**
5265
+ * Optional attributes
5266
+ */
5267
+ attributes?: {
5268
+ [k: string]: string;
5269
+ };
5236
5270
  };
5237
5271
  };
5238
5272
  dependencies: {
@@ -5400,6 +5434,12 @@ interface GetPublicPluginResponse {
5400
5434
  schema: {
5401
5435
  [k: string]: any;
5402
5436
  };
5437
+ /**
5438
+ * Optional attributes
5439
+ */
5440
+ attributes?: {
5441
+ [k: string]: string;
5442
+ };
5403
5443
  };
5404
5444
  };
5405
5445
  actions: {
@@ -5427,6 +5467,12 @@ interface GetPublicPluginResponse {
5427
5467
  [k: string]: any;
5428
5468
  };
5429
5469
  };
5470
+ /**
5471
+ * Optional attributes
5472
+ */
5473
+ attributes?: {
5474
+ [k: string]: string;
5475
+ };
5430
5476
  };
5431
5477
  };
5432
5478
  dependencies: {
@@ -5570,6 +5616,12 @@ interface CreateBotRequestBody {
5570
5616
  schema: {
5571
5617
  [k: string]: any;
5572
5618
  };
5619
+ /**
5620
+ * Optional attributes
5621
+ */
5622
+ attributes?: {
5623
+ [k: string]: string;
5624
+ };
5573
5625
  };
5574
5626
  };
5575
5627
  recurringEvents?: {
@@ -5622,6 +5674,12 @@ interface CreateBotRequestBody {
5622
5674
  [k: string]: any;
5623
5675
  };
5624
5676
  };
5677
+ /**
5678
+ * Optional attributes
5679
+ */
5680
+ attributes?: {
5681
+ [k: string]: string;
5682
+ };
5625
5683
  };
5626
5684
  };
5627
5685
  configuration?: {
@@ -5912,6 +5970,12 @@ interface CreateBotResponse {
5912
5970
  schema: {
5913
5971
  [k: string]: any;
5914
5972
  };
5973
+ /**
5974
+ * Optional attributes
5975
+ */
5976
+ attributes?: {
5977
+ [k: string]: string;
5978
+ };
5915
5979
  };
5916
5980
  };
5917
5981
  /**
@@ -5975,6 +6039,12 @@ interface CreateBotResponse {
5975
6039
  [k: string]: any;
5976
6040
  };
5977
6041
  };
6042
+ /**
6043
+ * Optional attributes
6044
+ */
6045
+ attributes?: {
6046
+ [k: string]: string;
6047
+ };
5978
6048
  };
5979
6049
  };
5980
6050
  /**
@@ -6116,9 +6186,6 @@ interface UpdateBotRequestBody {
6116
6186
  };
6117
6187
  };
6118
6188
  events?: {
6119
- /**
6120
- * Event Definition
6121
- */
6122
6189
  [k: string]: {
6123
6190
  /**
6124
6191
  * Title of the event
@@ -6131,12 +6198,15 @@ interface UpdateBotRequestBody {
6131
6198
  schema: {
6132
6199
  [k: string]: any;
6133
6200
  };
6201
+ /**
6202
+ * Optional attributes. Set attributes to null to remove them
6203
+ */
6204
+ attributes?: {
6205
+ [k: string]: string | null;
6206
+ };
6134
6207
  } | null;
6135
6208
  };
6136
6209
  actions?: {
6137
- /**
6138
- * Action definition
6139
- */
6140
6210
  [k: string]: {
6141
6211
  /**
6142
6212
  * Title of the action
@@ -6158,6 +6228,12 @@ interface UpdateBotRequestBody {
6158
6228
  [k: string]: any;
6159
6229
  };
6160
6230
  };
6231
+ /**
6232
+ * Optional attributes. Set attributes to null to remove them
6233
+ */
6234
+ attributes?: {
6235
+ [k: string]: string | null;
6236
+ };
6161
6237
  } | null;
6162
6238
  };
6163
6239
  states?: {
@@ -6416,6 +6492,12 @@ interface UpdateBotResponse {
6416
6492
  schema: {
6417
6493
  [k: string]: any;
6418
6494
  };
6495
+ /**
6496
+ * Optional attributes
6497
+ */
6498
+ attributes?: {
6499
+ [k: string]: string;
6500
+ };
6419
6501
  };
6420
6502
  };
6421
6503
  /**
@@ -6479,6 +6561,12 @@ interface UpdateBotResponse {
6479
6561
  [k: string]: any;
6480
6562
  };
6481
6563
  };
6564
+ /**
6565
+ * Optional attributes
6566
+ */
6567
+ attributes?: {
6568
+ [k: string]: string;
6569
+ };
6482
6570
  };
6483
6571
  };
6484
6572
  /**
@@ -6793,6 +6881,12 @@ interface GetBotResponse {
6793
6881
  schema: {
6794
6882
  [k: string]: any;
6795
6883
  };
6884
+ /**
6885
+ * Optional attributes
6886
+ */
6887
+ attributes?: {
6888
+ [k: string]: string;
6889
+ };
6796
6890
  };
6797
6891
  };
6798
6892
  /**
@@ -6856,6 +6950,12 @@ interface GetBotResponse {
6856
6950
  [k: string]: any;
6857
6951
  };
6858
6952
  };
6953
+ /**
6954
+ * Optional attributes
6955
+ */
6956
+ attributes?: {
6957
+ [k: string]: string;
6958
+ };
6859
6959
  };
6860
6960
  };
6861
6961
  /**
@@ -7254,6 +7354,58 @@ interface GetIntegrationShareableIdResponse {
7254
7354
  isExpired: boolean;
7255
7355
  }
7256
7356
 
7357
+ interface ListBotApiKeysRequestHeaders {
7358
+ }
7359
+ interface ListBotApiKeysRequestQuery {
7360
+ botId: string;
7361
+ }
7362
+ interface ListBotApiKeysRequestParams {
7363
+ }
7364
+ interface ListBotApiKeysRequestBody {
7365
+ }
7366
+ type ListBotApiKeysInput = ListBotApiKeysRequestBody & ListBotApiKeysRequestHeaders & ListBotApiKeysRequestQuery & ListBotApiKeysRequestParams;
7367
+ interface ListBotApiKeysResponse {
7368
+ baks: {
7369
+ id: string;
7370
+ createdAt: string;
7371
+ note: string;
7372
+ }[];
7373
+ }
7374
+
7375
+ interface CreateBotApiKeyRequestHeaders {
7376
+ }
7377
+ interface CreateBotApiKeyRequestQuery {
7378
+ }
7379
+ interface CreateBotApiKeyRequestParams {
7380
+ }
7381
+ interface CreateBotApiKeyRequestBody {
7382
+ botId: string;
7383
+ note?: string;
7384
+ }
7385
+ type CreateBotApiKeyInput = CreateBotApiKeyRequestBody & CreateBotApiKeyRequestHeaders & CreateBotApiKeyRequestQuery & CreateBotApiKeyRequestParams;
7386
+ interface CreateBotApiKeyResponse {
7387
+ id: string;
7388
+ createdAt: string;
7389
+ note: string;
7390
+ /**
7391
+ * The BAK value. This will only be returned here when created and cannot be retrieved later.
7392
+ */
7393
+ value: string;
7394
+ }
7395
+
7396
+ interface DeleteBotApiKeyRequestHeaders {
7397
+ }
7398
+ interface DeleteBotApiKeyRequestQuery {
7399
+ }
7400
+ interface DeleteBotApiKeyRequestParams {
7401
+ id: string;
7402
+ }
7403
+ interface DeleteBotApiKeyRequestBody {
7404
+ }
7405
+ type DeleteBotApiKeyInput = DeleteBotApiKeyRequestBody & DeleteBotApiKeyRequestHeaders & DeleteBotApiKeyRequestQuery & DeleteBotApiKeyRequestParams;
7406
+ interface DeleteBotApiKeyResponse {
7407
+ }
7408
+
7257
7409
  interface ListWorkspaceInvoicesRequestHeaders {
7258
7410
  }
7259
7411
  interface ListWorkspaceInvoicesRequestQuery {
@@ -8028,6 +8180,12 @@ interface CreateIntegrationRequestBody {
8028
8180
  schema: {
8029
8181
  [k: string]: any;
8030
8182
  };
8183
+ /**
8184
+ * Optional attributes
8185
+ */
8186
+ attributes?: {
8187
+ [k: string]: string;
8188
+ };
8031
8189
  };
8032
8190
  };
8033
8191
  actions?: {
@@ -8055,6 +8213,12 @@ interface CreateIntegrationRequestBody {
8055
8213
  [k: string]: any;
8056
8214
  };
8057
8215
  };
8216
+ /**
8217
+ * Optional attributes
8218
+ */
8219
+ attributes?: {
8220
+ [k: string]: string;
8221
+ };
8058
8222
  };
8059
8223
  };
8060
8224
  entities?: {
@@ -8497,6 +8661,12 @@ interface CreateIntegrationResponse {
8497
8661
  schema: {
8498
8662
  [k: string]: any;
8499
8663
  };
8664
+ /**
8665
+ * Optional attributes
8666
+ */
8667
+ attributes?: {
8668
+ [k: string]: string;
8669
+ };
8500
8670
  };
8501
8671
  };
8502
8672
  actions: {
@@ -8524,6 +8694,12 @@ interface CreateIntegrationResponse {
8524
8694
  [k: string]: any;
8525
8695
  };
8526
8696
  };
8697
+ /**
8698
+ * Optional attributes
8699
+ */
8700
+ attributes?: {
8701
+ [k: string]: string;
8702
+ };
8527
8703
  };
8528
8704
  };
8529
8705
  /**
@@ -8708,6 +8884,12 @@ interface ValidateIntegrationCreationRequestBody {
8708
8884
  schema: {
8709
8885
  [k: string]: any;
8710
8886
  };
8887
+ /**
8888
+ * Optional attributes
8889
+ */
8890
+ attributes?: {
8891
+ [k: string]: string;
8892
+ };
8711
8893
  };
8712
8894
  };
8713
8895
  actions?: {
@@ -8735,6 +8917,12 @@ interface ValidateIntegrationCreationRequestBody {
8735
8917
  [k: string]: any;
8736
8918
  };
8737
8919
  };
8920
+ /**
8921
+ * Optional attributes
8922
+ */
8923
+ attributes?: {
8924
+ [k: string]: string;
8925
+ };
8738
8926
  };
8739
8927
  };
8740
8928
  entities?: {
@@ -9060,9 +9248,6 @@ interface UpdateIntegrationRequestBody {
9060
9248
  fallbackHandlerScript?: string | null;
9061
9249
  };
9062
9250
  actions?: {
9063
- /**
9064
- * Action definition
9065
- */
9066
9251
  [k: string]: {
9067
9252
  /**
9068
9253
  * Title of the action
@@ -9084,12 +9269,15 @@ interface UpdateIntegrationRequestBody {
9084
9269
  [k: string]: any;
9085
9270
  };
9086
9271
  };
9272
+ /**
9273
+ * Optional attributes. Set attributes to null to remove them
9274
+ */
9275
+ attributes?: {
9276
+ [k: string]: string | null;
9277
+ };
9087
9278
  } | null;
9088
9279
  };
9089
9280
  events?: {
9090
- /**
9091
- * Event Definition
9092
- */
9093
9281
  [k: string]: {
9094
9282
  /**
9095
9283
  * Title of the event
@@ -9102,6 +9290,12 @@ interface UpdateIntegrationRequestBody {
9102
9290
  schema: {
9103
9291
  [k: string]: any;
9104
9292
  };
9293
+ /**
9294
+ * Optional attributes. Set attributes to null to remove them
9295
+ */
9296
+ attributes?: {
9297
+ [k: string]: string | null;
9298
+ };
9105
9299
  } | null;
9106
9300
  };
9107
9301
  states?: {
@@ -9488,6 +9682,12 @@ interface UpdateIntegrationResponse {
9488
9682
  schema: {
9489
9683
  [k: string]: any;
9490
9684
  };
9685
+ /**
9686
+ * Optional attributes
9687
+ */
9688
+ attributes?: {
9689
+ [k: string]: string;
9690
+ };
9491
9691
  };
9492
9692
  };
9493
9693
  actions: {
@@ -9515,6 +9715,12 @@ interface UpdateIntegrationResponse {
9515
9715
  [k: string]: any;
9516
9716
  };
9517
9717
  };
9718
+ /**
9719
+ * Optional attributes
9720
+ */
9721
+ attributes?: {
9722
+ [k: string]: string;
9723
+ };
9518
9724
  };
9519
9725
  };
9520
9726
  /**
@@ -9733,9 +9939,6 @@ interface ValidateIntegrationUpdateRequestBody {
9733
9939
  fallbackHandlerScript?: string | null;
9734
9940
  };
9735
9941
  actions?: {
9736
- /**
9737
- * Action definition
9738
- */
9739
9942
  [k: string]: {
9740
9943
  /**
9741
9944
  * Title of the action
@@ -9757,12 +9960,15 @@ interface ValidateIntegrationUpdateRequestBody {
9757
9960
  [k: string]: any;
9758
9961
  };
9759
9962
  };
9963
+ /**
9964
+ * Optional attributes. Set attributes to null to remove them
9965
+ */
9966
+ attributes?: {
9967
+ [k: string]: string | null;
9968
+ };
9760
9969
  } | null;
9761
9970
  };
9762
9971
  events?: {
9763
- /**
9764
- * Event Definition
9765
- */
9766
9972
  [k: string]: {
9767
9973
  /**
9768
9974
  * Title of the event
@@ -9775,6 +9981,12 @@ interface ValidateIntegrationUpdateRequestBody {
9775
9981
  schema: {
9776
9982
  [k: string]: any;
9777
9983
  };
9984
+ /**
9985
+ * Optional attributes. Set attributes to null to remove them
9986
+ */
9987
+ attributes?: {
9988
+ [k: string]: string | null;
9989
+ };
9778
9990
  } | null;
9779
9991
  };
9780
9992
  states?: {
@@ -10277,6 +10489,12 @@ interface GetIntegrationResponse {
10277
10489
  schema: {
10278
10490
  [k: string]: any;
10279
10491
  };
10492
+ /**
10493
+ * Optional attributes
10494
+ */
10495
+ attributes?: {
10496
+ [k: string]: string;
10497
+ };
10280
10498
  };
10281
10499
  };
10282
10500
  actions: {
@@ -10304,6 +10522,12 @@ interface GetIntegrationResponse {
10304
10522
  [k: string]: any;
10305
10523
  };
10306
10524
  };
10525
+ /**
10526
+ * Optional attributes
10527
+ */
10528
+ attributes?: {
10529
+ [k: string]: string;
10530
+ };
10307
10531
  };
10308
10532
  };
10309
10533
  /**
@@ -10681,6 +10905,12 @@ interface GetIntegrationByNameResponse {
10681
10905
  schema: {
10682
10906
  [k: string]: any;
10683
10907
  };
10908
+ /**
10909
+ * Optional attributes
10910
+ */
10911
+ attributes?: {
10912
+ [k: string]: string;
10913
+ };
10684
10914
  };
10685
10915
  };
10686
10916
  actions: {
@@ -10708,6 +10938,12 @@ interface GetIntegrationByNameResponse {
10708
10938
  [k: string]: any;
10709
10939
  };
10710
10940
  };
10941
+ /**
10942
+ * Optional attributes
10943
+ */
10944
+ attributes?: {
10945
+ [k: string]: string;
10946
+ };
10711
10947
  };
10712
10948
  };
10713
10949
  /**
@@ -10871,6 +11107,12 @@ interface CreateInterfaceRequestBody {
10871
11107
  schema: {
10872
11108
  [k: string]: any;
10873
11109
  };
11110
+ /**
11111
+ * Optional attributes
11112
+ */
11113
+ attributes?: {
11114
+ [k: string]: string;
11115
+ };
10874
11116
  };
10875
11117
  };
10876
11118
  actions?: {
@@ -10898,6 +11140,12 @@ interface CreateInterfaceRequestBody {
10898
11140
  [k: string]: any;
10899
11141
  };
10900
11142
  };
11143
+ /**
11144
+ * Optional attributes
11145
+ */
11146
+ attributes?: {
11147
+ [k: string]: string;
11148
+ };
10901
11149
  };
10902
11150
  };
10903
11151
  channels?: {
@@ -10929,6 +11177,26 @@ interface CreateInterfaceRequestBody {
10929
11177
  script: string;
10930
11178
  language: string;
10931
11179
  };
11180
+ /**
11181
+ * Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes.
11182
+ */
11183
+ icon?: string;
11184
+ /**
11185
+ * Base64 encoded markdown of the interface readme. The readme is specific to each interface versions.
11186
+ */
11187
+ readme?: string;
11188
+ /**
11189
+ * Title of the interface. This is the name that will be displayed in the UI
11190
+ */
11191
+ title?: string;
11192
+ /**
11193
+ * Description of the interface. This is the description that will be displayed in the UI
11194
+ */
11195
+ description?: string;
11196
+ /**
11197
+ * Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
11198
+ */
11199
+ public?: boolean;
10932
11200
  }
10933
11201
  type CreateInterfaceInput = CreateInterfaceRequestBody & CreateInterfaceRequestHeaders & CreateInterfaceRequestQuery & CreateInterfaceRequestParams;
10934
11202
  interface CreateInterfaceResponse {
@@ -10987,6 +11255,12 @@ interface CreateInterfaceResponse {
10987
11255
  schema: {
10988
11256
  [k: string]: any;
10989
11257
  };
11258
+ /**
11259
+ * Optional attributes
11260
+ */
11261
+ attributes?: {
11262
+ [k: string]: string;
11263
+ };
10990
11264
  };
10991
11265
  };
10992
11266
  actions: {
@@ -11014,6 +11288,12 @@ interface CreateInterfaceResponse {
11014
11288
  [k: string]: any;
11015
11289
  };
11016
11290
  };
11291
+ /**
11292
+ * Optional attributes
11293
+ */
11294
+ attributes?: {
11295
+ [k: string]: string;
11296
+ };
11017
11297
  };
11018
11298
  };
11019
11299
  channels: {
@@ -11045,6 +11325,26 @@ interface CreateInterfaceResponse {
11045
11325
  script: string;
11046
11326
  language: string;
11047
11327
  };
11328
+ /**
11329
+ * Title of the interface. This is the name that will be displayed in the UI
11330
+ */
11331
+ title: string;
11332
+ /**
11333
+ * Description of the interface. This is the description that will be displayed in the UI
11334
+ */
11335
+ description: string;
11336
+ /**
11337
+ * URL of the icon of the interface. This is the icon that will be displayed in the UI
11338
+ */
11339
+ iconUrl: string;
11340
+ /**
11341
+ * URL of the readme of the interface. This is the readme that will be displayed in the UI
11342
+ */
11343
+ readmeUrl: string;
11344
+ /**
11345
+ * Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
11346
+ */
11347
+ public: boolean;
11048
11348
  };
11049
11349
  }
11050
11350
 
@@ -11114,6 +11414,12 @@ interface GetInterfaceResponse {
11114
11414
  schema: {
11115
11415
  [k: string]: any;
11116
11416
  };
11417
+ /**
11418
+ * Optional attributes
11419
+ */
11420
+ attributes?: {
11421
+ [k: string]: string;
11422
+ };
11117
11423
  };
11118
11424
  };
11119
11425
  actions: {
@@ -11141,6 +11447,12 @@ interface GetInterfaceResponse {
11141
11447
  [k: string]: any;
11142
11448
  };
11143
11449
  };
11450
+ /**
11451
+ * Optional attributes
11452
+ */
11453
+ attributes?: {
11454
+ [k: string]: string;
11455
+ };
11144
11456
  };
11145
11457
  };
11146
11458
  channels: {
@@ -11172,6 +11484,26 @@ interface GetInterfaceResponse {
11172
11484
  script: string;
11173
11485
  language: string;
11174
11486
  };
11487
+ /**
11488
+ * Title of the interface. This is the name that will be displayed in the UI
11489
+ */
11490
+ title: string;
11491
+ /**
11492
+ * Description of the interface. This is the description that will be displayed in the UI
11493
+ */
11494
+ description: string;
11495
+ /**
11496
+ * URL of the icon of the interface. This is the icon that will be displayed in the UI
11497
+ */
11498
+ iconUrl: string;
11499
+ /**
11500
+ * URL of the readme of the interface. This is the readme that will be displayed in the UI
11501
+ */
11502
+ readmeUrl: string;
11503
+ /**
11504
+ * Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
11505
+ */
11506
+ public: boolean;
11175
11507
  };
11176
11508
  }
11177
11509
 
@@ -11242,6 +11574,12 @@ interface GetInterfaceByNameResponse {
11242
11574
  schema: {
11243
11575
  [k: string]: any;
11244
11576
  };
11577
+ /**
11578
+ * Optional attributes
11579
+ */
11580
+ attributes?: {
11581
+ [k: string]: string;
11582
+ };
11245
11583
  };
11246
11584
  };
11247
11585
  actions: {
@@ -11269,6 +11607,12 @@ interface GetInterfaceByNameResponse {
11269
11607
  [k: string]: any;
11270
11608
  };
11271
11609
  };
11610
+ /**
11611
+ * Optional attributes
11612
+ */
11613
+ attributes?: {
11614
+ [k: string]: string;
11615
+ };
11272
11616
  };
11273
11617
  };
11274
11618
  channels: {
@@ -11300,6 +11644,26 @@ interface GetInterfaceByNameResponse {
11300
11644
  script: string;
11301
11645
  language: string;
11302
11646
  };
11647
+ /**
11648
+ * Title of the interface. This is the name that will be displayed in the UI
11649
+ */
11650
+ title: string;
11651
+ /**
11652
+ * Description of the interface. This is the description that will be displayed in the UI
11653
+ */
11654
+ description: string;
11655
+ /**
11656
+ * URL of the icon of the interface. This is the icon that will be displayed in the UI
11657
+ */
11658
+ iconUrl: string;
11659
+ /**
11660
+ * URL of the readme of the interface. This is the readme that will be displayed in the UI
11661
+ */
11662
+ readmeUrl: string;
11663
+ /**
11664
+ * Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
11665
+ */
11666
+ public: boolean;
11303
11667
  };
11304
11668
  }
11305
11669
 
@@ -11330,9 +11694,6 @@ interface UpdateInterfaceRequestBody {
11330
11694
  } | null;
11331
11695
  };
11332
11696
  events?: {
11333
- /**
11334
- * Event Definition
11335
- */
11336
11697
  [k: string]: {
11337
11698
  /**
11338
11699
  * Title of the event
@@ -11345,12 +11706,15 @@ interface UpdateInterfaceRequestBody {
11345
11706
  schema: {
11346
11707
  [k: string]: any;
11347
11708
  };
11709
+ /**
11710
+ * Optional attributes. Set attributes to null to remove them
11711
+ */
11712
+ attributes?: {
11713
+ [k: string]: string | null;
11714
+ };
11348
11715
  } | null;
11349
11716
  };
11350
11717
  actions?: {
11351
- /**
11352
- * Action definition
11353
- */
11354
11718
  [k: string]: {
11355
11719
  /**
11356
11720
  * Title of the action
@@ -11372,6 +11736,12 @@ interface UpdateInterfaceRequestBody {
11372
11736
  [k: string]: any;
11373
11737
  };
11374
11738
  };
11739
+ /**
11740
+ * Optional attributes. Set attributes to null to remove them
11741
+ */
11742
+ attributes?: {
11743
+ [k: string]: string | null;
11744
+ };
11375
11745
  } | null;
11376
11746
  };
11377
11747
  channels?: {
@@ -11403,6 +11773,26 @@ interface UpdateInterfaceRequestBody {
11403
11773
  script: string;
11404
11774
  language: string;
11405
11775
  } | null;
11776
+ /**
11777
+ * Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes.
11778
+ */
11779
+ icon?: string;
11780
+ /**
11781
+ * Base64 encoded markdown of the interface readme. The readme is specific to each interface versions.
11782
+ */
11783
+ readme?: string;
11784
+ /**
11785
+ * Title of the interface. This is the name that will be displayed in the UI
11786
+ */
11787
+ title?: string;
11788
+ /**
11789
+ * Description of the interface. This is the description that will be displayed in the UI
11790
+ */
11791
+ description?: string;
11792
+ /**
11793
+ * Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
11794
+ */
11795
+ public?: boolean;
11406
11796
  }
11407
11797
  type UpdateInterfaceInput = UpdateInterfaceRequestBody & UpdateInterfaceRequestHeaders & UpdateInterfaceRequestQuery & UpdateInterfaceRequestParams;
11408
11798
  interface UpdateInterfaceResponse {
@@ -11461,6 +11851,12 @@ interface UpdateInterfaceResponse {
11461
11851
  schema: {
11462
11852
  [k: string]: any;
11463
11853
  };
11854
+ /**
11855
+ * Optional attributes
11856
+ */
11857
+ attributes?: {
11858
+ [k: string]: string;
11859
+ };
11464
11860
  };
11465
11861
  };
11466
11862
  actions: {
@@ -11488,6 +11884,12 @@ interface UpdateInterfaceResponse {
11488
11884
  [k: string]: any;
11489
11885
  };
11490
11886
  };
11887
+ /**
11888
+ * Optional attributes
11889
+ */
11890
+ attributes?: {
11891
+ [k: string]: string;
11892
+ };
11491
11893
  };
11492
11894
  };
11493
11895
  channels: {
@@ -11519,6 +11921,26 @@ interface UpdateInterfaceResponse {
11519
11921
  script: string;
11520
11922
  language: string;
11521
11923
  };
11924
+ /**
11925
+ * Title of the interface. This is the name that will be displayed in the UI
11926
+ */
11927
+ title: string;
11928
+ /**
11929
+ * Description of the interface. This is the description that will be displayed in the UI
11930
+ */
11931
+ description: string;
11932
+ /**
11933
+ * URL of the icon of the interface. This is the icon that will be displayed in the UI
11934
+ */
11935
+ iconUrl: string;
11936
+ /**
11937
+ * URL of the readme of the interface. This is the readme that will be displayed in the UI
11938
+ */
11939
+ readmeUrl: string;
11940
+ /**
11941
+ * Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
11942
+ */
11943
+ public: boolean;
11522
11944
  };
11523
11945
  }
11524
11946
 
@@ -11568,6 +11990,26 @@ interface ListInterfacesResponse {
11568
11990
  * Version of the [Interface](#schema_interface)
11569
11991
  */
11570
11992
  version: string;
11993
+ /**
11994
+ * Title of the interface. This is the name that will be displayed in the UI
11995
+ */
11996
+ title: string;
11997
+ /**
11998
+ * Description of the interface. This is the description that will be displayed in the UI
11999
+ */
12000
+ description: string;
12001
+ /**
12002
+ * URL of the icon of the interface. This is the icon that will be displayed in the UI
12003
+ */
12004
+ iconUrl: string;
12005
+ /**
12006
+ * URL of the readme of the interface. This is the readme that will be displayed in the UI
12007
+ */
12008
+ readmeUrl: string;
12009
+ /**
12010
+ * Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
12011
+ */
12012
+ public: boolean;
11571
12013
  }[];
11572
12014
  meta: {
11573
12015
  /**
@@ -11645,6 +12087,12 @@ interface CreatePluginRequestBody {
11645
12087
  schema: {
11646
12088
  [k: string]: any;
11647
12089
  };
12090
+ /**
12091
+ * Optional attributes
12092
+ */
12093
+ attributes?: {
12094
+ [k: string]: string;
12095
+ };
11648
12096
  };
11649
12097
  };
11650
12098
  actions?: {
@@ -11672,6 +12120,12 @@ interface CreatePluginRequestBody {
11672
12120
  [k: string]: any;
11673
12121
  };
11674
12122
  };
12123
+ /**
12124
+ * Optional attributes
12125
+ */
12126
+ attributes?: {
12127
+ [k: string]: string;
12128
+ };
11675
12129
  };
11676
12130
  };
11677
12131
  /**
@@ -11833,6 +12287,12 @@ interface CreatePluginResponse {
11833
12287
  schema: {
11834
12288
  [k: string]: any;
11835
12289
  };
12290
+ /**
12291
+ * Optional attributes
12292
+ */
12293
+ attributes?: {
12294
+ [k: string]: string;
12295
+ };
11836
12296
  };
11837
12297
  };
11838
12298
  actions: {
@@ -11860,6 +12320,12 @@ interface CreatePluginResponse {
11860
12320
  [k: string]: any;
11861
12321
  };
11862
12322
  };
12323
+ /**
12324
+ * Optional attributes
12325
+ */
12326
+ attributes?: {
12327
+ [k: string]: string;
12328
+ };
11863
12329
  };
11864
12330
  };
11865
12331
  dependencies: {
@@ -12026,6 +12492,12 @@ interface GetPluginResponse {
12026
12492
  schema: {
12027
12493
  [k: string]: any;
12028
12494
  };
12495
+ /**
12496
+ * Optional attributes
12497
+ */
12498
+ attributes?: {
12499
+ [k: string]: string;
12500
+ };
12029
12501
  };
12030
12502
  };
12031
12503
  actions: {
@@ -12053,6 +12525,12 @@ interface GetPluginResponse {
12053
12525
  [k: string]: any;
12054
12526
  };
12055
12527
  };
12528
+ /**
12529
+ * Optional attributes
12530
+ */
12531
+ attributes?: {
12532
+ [k: string]: string;
12533
+ };
12056
12534
  };
12057
12535
  };
12058
12536
  dependencies: {
@@ -12220,6 +12698,12 @@ interface GetPluginByNameResponse {
12220
12698
  schema: {
12221
12699
  [k: string]: any;
12222
12700
  };
12701
+ /**
12702
+ * Optional attributes
12703
+ */
12704
+ attributes?: {
12705
+ [k: string]: string;
12706
+ };
12223
12707
  };
12224
12708
  };
12225
12709
  actions: {
@@ -12247,6 +12731,12 @@ interface GetPluginByNameResponse {
12247
12731
  [k: string]: any;
12248
12732
  };
12249
12733
  };
12734
+ /**
12735
+ * Optional attributes
12736
+ */
12737
+ attributes?: {
12738
+ [k: string]: string;
12739
+ };
12250
12740
  };
12251
12741
  };
12252
12742
  dependencies: {
@@ -12374,9 +12864,6 @@ interface UpdatePluginRequestBody {
12374
12864
  } | null;
12375
12865
  };
12376
12866
  events?: {
12377
- /**
12378
- * Event Definition
12379
- */
12380
12867
  [k: string]: {
12381
12868
  /**
12382
12869
  * Title of the event
@@ -12389,12 +12876,15 @@ interface UpdatePluginRequestBody {
12389
12876
  schema: {
12390
12877
  [k: string]: any;
12391
12878
  };
12879
+ /**
12880
+ * Optional attributes. Set attributes to null to remove them
12881
+ */
12882
+ attributes?: {
12883
+ [k: string]: string | null;
12884
+ };
12392
12885
  } | null;
12393
12886
  };
12394
12887
  actions?: {
12395
- /**
12396
- * Action definition
12397
- */
12398
12888
  [k: string]: {
12399
12889
  /**
12400
12890
  * Title of the action
@@ -12416,6 +12906,12 @@ interface UpdatePluginRequestBody {
12416
12906
  [k: string]: any;
12417
12907
  };
12418
12908
  };
12909
+ /**
12910
+ * Optional attributes. Set attributes to null to remove them
12911
+ */
12912
+ attributes?: {
12913
+ [k: string]: string | null;
12914
+ };
12419
12915
  } | null;
12420
12916
  };
12421
12917
  user?: {
@@ -12571,6 +13067,12 @@ interface UpdatePluginResponse {
12571
13067
  schema: {
12572
13068
  [k: string]: any;
12573
13069
  };
13070
+ /**
13071
+ * Optional attributes
13072
+ */
13073
+ attributes?: {
13074
+ [k: string]: string;
13075
+ };
12574
13076
  };
12575
13077
  };
12576
13078
  actions: {
@@ -12598,6 +13100,12 @@ interface UpdatePluginResponse {
12598
13100
  [k: string]: any;
12599
13101
  };
12600
13102
  };
13103
+ /**
13104
+ * Optional attributes
13105
+ */
13106
+ attributes?: {
13107
+ [k: string]: string;
13108
+ };
12601
13109
  };
12602
13110
  };
12603
13111
  dependencies: {
@@ -15636,6 +16144,9 @@ declare class Client$1 {
15636
16144
  readonly createIntegrationShareableId: (input: CreateIntegrationShareableIdInput) => Promise<CreateIntegrationShareableIdResponse>;
15637
16145
  readonly deleteIntegrationShareableId: (input: DeleteIntegrationShareableIdInput) => Promise<DeleteIntegrationShareableIdResponse>;
15638
16146
  readonly getIntegrationShareableId: (input: GetIntegrationShareableIdInput) => Promise<GetIntegrationShareableIdResponse>;
16147
+ readonly listBotApiKeys: (input: ListBotApiKeysInput) => Promise<ListBotApiKeysResponse>;
16148
+ readonly createBotApiKey: (input: CreateBotApiKeyInput) => Promise<CreateBotApiKeyResponse>;
16149
+ readonly deleteBotApiKey: (input: DeleteBotApiKeyInput) => Promise<DeleteBotApiKeyResponse>;
15639
16150
  readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput) => Promise<ListWorkspaceInvoicesResponse>;
15640
16151
  readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput) => Promise<GetUpcomingInvoiceResponse>;
15641
16152
  readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput) => Promise<ChargeWorkspaceUnpaidInvoicesResponse>;
@@ -15983,6 +16494,11 @@ declare class Client extends Client$1 implements IClient {
15983
16494
  updatedAt: string;
15984
16495
  name: string;
15985
16496
  version: string;
16497
+ title: string;
16498
+ description: string;
16499
+ iconUrl: string;
16500
+ readmeUrl: string;
16501
+ public: boolean;
15986
16502
  }>;
15987
16503
  activities: (props: {
15988
16504
  botId: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/cognitive",
3
- "version": "0.1.16",
3
+ "version": "0.1.18",
4
4
  "description": "Wrapper around the Botpress Client to call LLMs",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.mjs",