@botpress/api 1.4.0 → 1.5.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.
@@ -4139,6 +4139,784 @@ export declare const state: {
4139
4139
  };
4140
4140
  };
4141
4141
  };
4142
+ listPublicPlugins: {
4143
+ name: string;
4144
+ description: string;
4145
+ method: "get";
4146
+ section: "hub";
4147
+ path: string;
4148
+ disableDefaultParameters: {
4149
+ "x-workspace-id": boolean;
4150
+ };
4151
+ parameters: {
4152
+ nextToken: {
4153
+ in: "query";
4154
+ description: string;
4155
+ type: "string";
4156
+ };
4157
+ name: {
4158
+ in: "query";
4159
+ type: "string";
4160
+ description: string;
4161
+ };
4162
+ version: {
4163
+ in: "query";
4164
+ type: "string";
4165
+ description: string;
4166
+ };
4167
+ };
4168
+ response: {
4169
+ description: string;
4170
+ schema: {
4171
+ type: "object";
4172
+ properties: {
4173
+ plugins: {
4174
+ type: "array";
4175
+ items: {
4176
+ type: "object";
4177
+ properties: {
4178
+ id: {
4179
+ type: "string";
4180
+ minLength: number;
4181
+ maxLength: number;
4182
+ description: string;
4183
+ };
4184
+ createdAt: {
4185
+ type: "string";
4186
+ format: string;
4187
+ description: string;
4188
+ };
4189
+ updatedAt: {
4190
+ type: "string";
4191
+ format: string;
4192
+ description: string;
4193
+ };
4194
+ name: {
4195
+ type: "string";
4196
+ maxLength: number;
4197
+ description: string;
4198
+ };
4199
+ version: {
4200
+ type: "string";
4201
+ maxLength: number;
4202
+ description: string;
4203
+ };
4204
+ title: {
4205
+ type: "string";
4206
+ minLength: number;
4207
+ maxLength: number;
4208
+ description: string;
4209
+ };
4210
+ description: {
4211
+ type: "string";
4212
+ maxLength: number;
4213
+ description: string;
4214
+ };
4215
+ iconUrl: {
4216
+ type: "string";
4217
+ description: string;
4218
+ };
4219
+ readmeUrl: {
4220
+ type: "string";
4221
+ description: string;
4222
+ };
4223
+ public: {
4224
+ type: "boolean";
4225
+ description: string;
4226
+ };
4227
+ };
4228
+ required: string[];
4229
+ };
4230
+ };
4231
+ meta: {
4232
+ type: "object";
4233
+ properties: {
4234
+ nextToken: {
4235
+ type: "string";
4236
+ description: string;
4237
+ };
4238
+ };
4239
+ additionalProperties: false;
4240
+ };
4241
+ };
4242
+ required: string[];
4243
+ title: string;
4244
+ additionalProperties: false;
4245
+ };
4246
+ };
4247
+ };
4248
+ getPublicPluginById: {
4249
+ name: string;
4250
+ description: string;
4251
+ method: "get";
4252
+ section: "hub";
4253
+ path: string;
4254
+ disableDefaultParameters: {
4255
+ "x-workspace-id": boolean;
4256
+ };
4257
+ parameters: {
4258
+ id: {
4259
+ type: "string";
4260
+ description: string;
4261
+ in: "path";
4262
+ };
4263
+ };
4264
+ response: {
4265
+ description: string;
4266
+ schema: {
4267
+ type: "object";
4268
+ properties: {
4269
+ plugin: {
4270
+ type: "object";
4271
+ properties: {
4272
+ id: {
4273
+ type: "string";
4274
+ minLength: number;
4275
+ maxLength: number;
4276
+ description: string;
4277
+ };
4278
+ name: {
4279
+ type: "string";
4280
+ maxLength: number;
4281
+ description: string;
4282
+ };
4283
+ version: {
4284
+ type: "string";
4285
+ maxLength: number;
4286
+ description: string;
4287
+ };
4288
+ createdAt: {
4289
+ type: "string";
4290
+ format: string;
4291
+ description: string;
4292
+ };
4293
+ updatedAt: {
4294
+ type: "string";
4295
+ format: string;
4296
+ description: string;
4297
+ };
4298
+ configuration: {
4299
+ type: "object";
4300
+ properties: {
4301
+ title: {
4302
+ type: "string";
4303
+ maxLength: number;
4304
+ description: string;
4305
+ };
4306
+ description: {
4307
+ type: "string";
4308
+ maxLength: number;
4309
+ description: string;
4310
+ };
4311
+ schema: {
4312
+ type: "object";
4313
+ additionalProperties: true;
4314
+ description: string;
4315
+ };
4316
+ };
4317
+ required: string[];
4318
+ description: string;
4319
+ additionalProperties: false;
4320
+ };
4321
+ states: {
4322
+ type: "object";
4323
+ additionalProperties: {
4324
+ type: "object";
4325
+ properties: {
4326
+ type: {
4327
+ type: "string";
4328
+ enum: string[];
4329
+ description: string;
4330
+ };
4331
+ schema: {
4332
+ type: "object";
4333
+ additionalProperties: true;
4334
+ description: string;
4335
+ };
4336
+ expiry: {
4337
+ type: "number";
4338
+ minimum: number;
4339
+ description: string;
4340
+ };
4341
+ };
4342
+ required: string[];
4343
+ additionalProperties: false;
4344
+ };
4345
+ };
4346
+ events: {
4347
+ type: "object";
4348
+ additionalProperties: {
4349
+ type: "object";
4350
+ properties: {
4351
+ title: {
4352
+ type: "string";
4353
+ maxLength: number;
4354
+ description: string;
4355
+ };
4356
+ description: {
4357
+ type: "string";
4358
+ maxLength: number;
4359
+ description: string;
4360
+ };
4361
+ schema: {
4362
+ type: "object";
4363
+ additionalProperties: true;
4364
+ };
4365
+ };
4366
+ required: string[];
4367
+ description: string;
4368
+ additionalProperties: false;
4369
+ };
4370
+ };
4371
+ actions: {
4372
+ type: "object";
4373
+ additionalProperties: {
4374
+ type: "object";
4375
+ properties: {
4376
+ title: {
4377
+ type: "string";
4378
+ maxLength: number;
4379
+ description: string;
4380
+ };
4381
+ description: {
4382
+ type: "string";
4383
+ maxLength: number;
4384
+ description: string;
4385
+ };
4386
+ billable: {
4387
+ type: "boolean";
4388
+ };
4389
+ cacheable: {
4390
+ type: "boolean";
4391
+ };
4392
+ input: {
4393
+ type: "object";
4394
+ properties: {
4395
+ schema: {
4396
+ type: "object";
4397
+ additionalProperties: true;
4398
+ };
4399
+ };
4400
+ required: string[];
4401
+ additionalProperties: false;
4402
+ };
4403
+ output: {
4404
+ type: "object";
4405
+ properties: {
4406
+ schema: {
4407
+ type: "object";
4408
+ additionalProperties: true;
4409
+ };
4410
+ };
4411
+ required: string[];
4412
+ additionalProperties: false;
4413
+ };
4414
+ };
4415
+ required: string[];
4416
+ description: string;
4417
+ additionalProperties: false;
4418
+ };
4419
+ };
4420
+ dependencies: {
4421
+ type: "object";
4422
+ properties: {
4423
+ interfaces: {
4424
+ type: "object";
4425
+ additionalProperties: {
4426
+ type: "object";
4427
+ properties: {
4428
+ id: {
4429
+ type: "string";
4430
+ minLength: number;
4431
+ maxLength: number;
4432
+ };
4433
+ name: {
4434
+ type: "string";
4435
+ maxLength: number;
4436
+ };
4437
+ version: {
4438
+ type: "string";
4439
+ maxLength: number;
4440
+ };
4441
+ };
4442
+ required: string[];
4443
+ additionalProperties: false;
4444
+ };
4445
+ };
4446
+ integrations: {
4447
+ type: "object";
4448
+ additionalProperties: {
4449
+ type: "object";
4450
+ properties: {
4451
+ id: {
4452
+ type: "string";
4453
+ minLength: number;
4454
+ maxLength: number;
4455
+ };
4456
+ name: {
4457
+ type: "string";
4458
+ maxLength: number;
4459
+ };
4460
+ version: {
4461
+ type: "string";
4462
+ maxLength: number;
4463
+ };
4464
+ };
4465
+ required: string[];
4466
+ additionalProperties: false;
4467
+ };
4468
+ };
4469
+ };
4470
+ required: string[];
4471
+ additionalProperties: false;
4472
+ };
4473
+ user: {
4474
+ type: "object";
4475
+ properties: {
4476
+ tags: {
4477
+ type: "object";
4478
+ additionalProperties: {
4479
+ type: "object";
4480
+ properties: {
4481
+ title: {
4482
+ type: "string";
4483
+ maxLength: number;
4484
+ description: string;
4485
+ };
4486
+ description: {
4487
+ type: "string";
4488
+ maxLength: number;
4489
+ description: string;
4490
+ };
4491
+ };
4492
+ description: string;
4493
+ additionalProperties: false;
4494
+ };
4495
+ };
4496
+ };
4497
+ required: string[];
4498
+ description: string;
4499
+ additionalProperties: false;
4500
+ };
4501
+ conversation: {
4502
+ type: "object";
4503
+ properties: {
4504
+ tags: {
4505
+ type: "object";
4506
+ additionalProperties: {
4507
+ type: "object";
4508
+ properties: {
4509
+ title: {
4510
+ type: "string";
4511
+ maxLength: number;
4512
+ description: string;
4513
+ };
4514
+ description: {
4515
+ type: "string";
4516
+ maxLength: number;
4517
+ description: string;
4518
+ };
4519
+ };
4520
+ description: string;
4521
+ additionalProperties: false;
4522
+ };
4523
+ };
4524
+ };
4525
+ required: string[];
4526
+ description: string;
4527
+ additionalProperties: false;
4528
+ };
4529
+ title: {
4530
+ type: "string";
4531
+ minLength: number;
4532
+ maxLength: number;
4533
+ description: string;
4534
+ };
4535
+ description: {
4536
+ type: "string";
4537
+ maxLength: number;
4538
+ description: string;
4539
+ };
4540
+ iconUrl: {
4541
+ type: "string";
4542
+ description: string;
4543
+ };
4544
+ readmeUrl: {
4545
+ type: "string";
4546
+ description: string;
4547
+ };
4548
+ public: {
4549
+ type: "boolean";
4550
+ description: string;
4551
+ };
4552
+ };
4553
+ required: string[];
4554
+ additionalProperties: false;
4555
+ };
4556
+ };
4557
+ required: string[];
4558
+ title: string;
4559
+ additionalProperties: false;
4560
+ };
4561
+ };
4562
+ };
4563
+ getPublicPlugin: {
4564
+ name: string;
4565
+ description: string;
4566
+ method: "get";
4567
+ section: "hub";
4568
+ path: string;
4569
+ disableDefaultParameters: {
4570
+ "x-workspace-id": boolean;
4571
+ };
4572
+ parameters: {
4573
+ name: {
4574
+ type: "string";
4575
+ description: string;
4576
+ in: "path";
4577
+ };
4578
+ version: {
4579
+ type: "string";
4580
+ description: string;
4581
+ in: "path";
4582
+ };
4583
+ };
4584
+ response: {
4585
+ description: string;
4586
+ schema: {
4587
+ type: "object";
4588
+ properties: {
4589
+ plugin: {
4590
+ type: "object";
4591
+ properties: {
4592
+ id: {
4593
+ type: "string";
4594
+ minLength: number;
4595
+ maxLength: number;
4596
+ description: string;
4597
+ };
4598
+ name: {
4599
+ type: "string";
4600
+ maxLength: number;
4601
+ description: string;
4602
+ };
4603
+ version: {
4604
+ type: "string";
4605
+ maxLength: number;
4606
+ description: string;
4607
+ };
4608
+ createdAt: {
4609
+ type: "string";
4610
+ format: string;
4611
+ description: string;
4612
+ };
4613
+ updatedAt: {
4614
+ type: "string";
4615
+ format: string;
4616
+ description: string;
4617
+ };
4618
+ configuration: {
4619
+ type: "object";
4620
+ properties: {
4621
+ title: {
4622
+ type: "string";
4623
+ maxLength: number;
4624
+ description: string;
4625
+ };
4626
+ description: {
4627
+ type: "string";
4628
+ maxLength: number;
4629
+ description: string;
4630
+ };
4631
+ schema: {
4632
+ type: "object";
4633
+ additionalProperties: true;
4634
+ description: string;
4635
+ };
4636
+ };
4637
+ required: string[];
4638
+ description: string;
4639
+ additionalProperties: false;
4640
+ };
4641
+ states: {
4642
+ type: "object";
4643
+ additionalProperties: {
4644
+ type: "object";
4645
+ properties: {
4646
+ type: {
4647
+ type: "string";
4648
+ enum: string[];
4649
+ description: string;
4650
+ };
4651
+ schema: {
4652
+ type: "object";
4653
+ additionalProperties: true;
4654
+ description: string;
4655
+ };
4656
+ expiry: {
4657
+ type: "number";
4658
+ minimum: number;
4659
+ description: string;
4660
+ };
4661
+ };
4662
+ required: string[];
4663
+ additionalProperties: false;
4664
+ };
4665
+ };
4666
+ events: {
4667
+ type: "object";
4668
+ additionalProperties: {
4669
+ type: "object";
4670
+ properties: {
4671
+ title: {
4672
+ type: "string";
4673
+ maxLength: number;
4674
+ description: string;
4675
+ };
4676
+ description: {
4677
+ type: "string";
4678
+ maxLength: number;
4679
+ description: string;
4680
+ };
4681
+ schema: {
4682
+ type: "object";
4683
+ additionalProperties: true;
4684
+ };
4685
+ };
4686
+ required: string[];
4687
+ description: string;
4688
+ additionalProperties: false;
4689
+ };
4690
+ };
4691
+ actions: {
4692
+ type: "object";
4693
+ additionalProperties: {
4694
+ type: "object";
4695
+ properties: {
4696
+ title: {
4697
+ type: "string";
4698
+ maxLength: number;
4699
+ description: string;
4700
+ };
4701
+ description: {
4702
+ type: "string";
4703
+ maxLength: number;
4704
+ description: string;
4705
+ };
4706
+ billable: {
4707
+ type: "boolean";
4708
+ };
4709
+ cacheable: {
4710
+ type: "boolean";
4711
+ };
4712
+ input: {
4713
+ type: "object";
4714
+ properties: {
4715
+ schema: {
4716
+ type: "object";
4717
+ additionalProperties: true;
4718
+ };
4719
+ };
4720
+ required: string[];
4721
+ additionalProperties: false;
4722
+ };
4723
+ output: {
4724
+ type: "object";
4725
+ properties: {
4726
+ schema: {
4727
+ type: "object";
4728
+ additionalProperties: true;
4729
+ };
4730
+ };
4731
+ required: string[];
4732
+ additionalProperties: false;
4733
+ };
4734
+ };
4735
+ required: string[];
4736
+ description: string;
4737
+ additionalProperties: false;
4738
+ };
4739
+ };
4740
+ dependencies: {
4741
+ type: "object";
4742
+ properties: {
4743
+ interfaces: {
4744
+ type: "object";
4745
+ additionalProperties: {
4746
+ type: "object";
4747
+ properties: {
4748
+ id: {
4749
+ type: "string";
4750
+ minLength: number;
4751
+ maxLength: number;
4752
+ };
4753
+ name: {
4754
+ type: "string";
4755
+ maxLength: number;
4756
+ };
4757
+ version: {
4758
+ type: "string";
4759
+ maxLength: number;
4760
+ };
4761
+ };
4762
+ required: string[];
4763
+ additionalProperties: false;
4764
+ };
4765
+ };
4766
+ integrations: {
4767
+ type: "object";
4768
+ additionalProperties: {
4769
+ type: "object";
4770
+ properties: {
4771
+ id: {
4772
+ type: "string";
4773
+ minLength: number;
4774
+ maxLength: number;
4775
+ };
4776
+ name: {
4777
+ type: "string";
4778
+ maxLength: number;
4779
+ };
4780
+ version: {
4781
+ type: "string";
4782
+ maxLength: number;
4783
+ };
4784
+ };
4785
+ required: string[];
4786
+ additionalProperties: false;
4787
+ };
4788
+ };
4789
+ };
4790
+ required: string[];
4791
+ additionalProperties: false;
4792
+ };
4793
+ user: {
4794
+ type: "object";
4795
+ properties: {
4796
+ tags: {
4797
+ type: "object";
4798
+ additionalProperties: {
4799
+ type: "object";
4800
+ properties: {
4801
+ title: {
4802
+ type: "string";
4803
+ maxLength: number;
4804
+ description: string;
4805
+ };
4806
+ description: {
4807
+ type: "string";
4808
+ maxLength: number;
4809
+ description: string;
4810
+ };
4811
+ };
4812
+ description: string;
4813
+ additionalProperties: false;
4814
+ };
4815
+ };
4816
+ };
4817
+ required: string[];
4818
+ description: string;
4819
+ additionalProperties: false;
4820
+ };
4821
+ conversation: {
4822
+ type: "object";
4823
+ properties: {
4824
+ tags: {
4825
+ type: "object";
4826
+ additionalProperties: {
4827
+ type: "object";
4828
+ properties: {
4829
+ title: {
4830
+ type: "string";
4831
+ maxLength: number;
4832
+ description: string;
4833
+ };
4834
+ description: {
4835
+ type: "string";
4836
+ maxLength: number;
4837
+ description: string;
4838
+ };
4839
+ };
4840
+ description: string;
4841
+ additionalProperties: false;
4842
+ };
4843
+ };
4844
+ };
4845
+ required: string[];
4846
+ description: string;
4847
+ additionalProperties: false;
4848
+ };
4849
+ title: {
4850
+ type: "string";
4851
+ minLength: number;
4852
+ maxLength: number;
4853
+ description: string;
4854
+ };
4855
+ description: {
4856
+ type: "string";
4857
+ maxLength: number;
4858
+ description: string;
4859
+ };
4860
+ iconUrl: {
4861
+ type: "string";
4862
+ description: string;
4863
+ };
4864
+ readmeUrl: {
4865
+ type: "string";
4866
+ description: string;
4867
+ };
4868
+ public: {
4869
+ type: "boolean";
4870
+ description: string;
4871
+ };
4872
+ };
4873
+ required: string[];
4874
+ additionalProperties: false;
4875
+ };
4876
+ };
4877
+ required: string[];
4878
+ title: string;
4879
+ additionalProperties: false;
4880
+ };
4881
+ };
4882
+ };
4883
+ getPublicPluginCode: {
4884
+ name: string;
4885
+ description: string;
4886
+ method: "get";
4887
+ path: string;
4888
+ disableDefaultParameters: {
4889
+ "x-workspace-id": boolean;
4890
+ };
4891
+ section: "hub";
4892
+ parameters: {
4893
+ id: {
4894
+ in: "path";
4895
+ type: "string";
4896
+ description: string;
4897
+ };
4898
+ platform: {
4899
+ in: "path";
4900
+ type: "string";
4901
+ enum: string[];
4902
+ description: string;
4903
+ };
4904
+ };
4905
+ response: {
4906
+ description: string;
4907
+ schema: {
4908
+ type: "object";
4909
+ properties: {
4910
+ code: {
4911
+ type: "string";
4912
+ };
4913
+ };
4914
+ required: string[];
4915
+ title: string;
4916
+ additionalProperties: false;
4917
+ };
4918
+ };
4919
+ };
4142
4920
  createBot: {
4143
4921
  name: string;
4144
4922
  description: string;
@@ -11256,6 +12034,11 @@ export declare const state: {
11256
12034
  type: "string";
11257
12035
  description: string;
11258
12036
  };
12037
+ version: {
12038
+ in: "query";
12039
+ type: "string";
12040
+ description: string;
12041
+ };
11259
12042
  };
11260
12043
  response: {
11261
12044
  description: string;
@@ -14363,6 +15146,10 @@ export declare const state: {
14363
15146
  listPublicIntegrationsResponse: true;
14364
15147
  getPublicIntegrationByIdResponse: true;
14365
15148
  getPublicIntegrationResponse: true;
15149
+ listPublicPluginsResponse: true;
15150
+ getPublicPluginByIdResponse: true;
15151
+ getPublicPluginResponse: true;
15152
+ getPublicPluginCodeResponse: true;
14366
15153
  createBotResponse: true;
14367
15154
  updateBotResponse: true;
14368
15155
  transferBotResponse: true;