@botpress/api 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. package/dist/index.js +2425 -589
  2. package/dist/src/gen/admin/state.d.ts +787 -0
  3. package/dist/src/gen/state.d.ts +787 -0
  4. package/package.json +1 -1
  5. package/src/gen/admin/metadata.json +1 -1
  6. package/src/gen/admin/openapi.json +1 -1
  7. package/src/gen/admin/state.ts +920 -2
  8. package/src/gen/files/openapi.json +1 -1
  9. package/src/gen/files/state.ts +1 -1
  10. package/src/gen/metadata.json +1 -1
  11. package/src/gen/openapi.json +1 -1
  12. package/src/gen/runtime/openapi.json +1 -1
  13. package/src/gen/runtime/state.ts +1 -1
  14. package/src/gen/state.ts +920 -2
  15. package/src/gen/tables/openapi.json +1 -1
  16. package/src/gen/tables/state.ts +1 -1
package/src/gen/state.ts CHANGED
@@ -4673,6 +4673,911 @@ export const state = {
4673
4673
  }
4674
4674
  }
4675
4675
  },
4676
+ "listPublicPlugins": {
4677
+ "name": "listPublicPlugins",
4678
+ "description": "List public plugin",
4679
+ "method": "get",
4680
+ "section": "hub",
4681
+ "path": "/v1/admin/hub/plugins",
4682
+ "disableDefaultParameters": {
4683
+ "x-workspace-id": true
4684
+ },
4685
+ "parameters": {
4686
+ "nextToken": {
4687
+ "in": "query",
4688
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
4689
+ "type": "string"
4690
+ },
4691
+ "name": {
4692
+ "in": "query",
4693
+ "type": "string",
4694
+ "description": "Filter all versions of a plugin by name"
4695
+ },
4696
+ "version": {
4697
+ "in": "query",
4698
+ "type": "string",
4699
+ "description": "Filter a plugin by name and version"
4700
+ }
4701
+ },
4702
+ "response": {
4703
+ "description": "Success",
4704
+ "schema": {
4705
+ "type": "object",
4706
+ "properties": {
4707
+ "plugins": {
4708
+ "type": "array",
4709
+ "items": {
4710
+ "type": "object",
4711
+ "properties": {
4712
+ "id": {
4713
+ "type": "string",
4714
+ "minLength": 28,
4715
+ "maxLength": 36,
4716
+ "description": "ID of the [Plugin](#schema_plugin)"
4717
+ },
4718
+ "createdAt": {
4719
+ "type": "string",
4720
+ "format": "date-time",
4721
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
4722
+ },
4723
+ "updatedAt": {
4724
+ "type": "string",
4725
+ "format": "date-time",
4726
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
4727
+ },
4728
+ "name": {
4729
+ "type": "string",
4730
+ "maxLength": 200,
4731
+ "description": "Name of the [Plugin](#schema_plugin)"
4732
+ },
4733
+ "version": {
4734
+ "type": "string",
4735
+ "maxLength": 200,
4736
+ "description": "Version of the [Plugin](#schema_plugin)"
4737
+ },
4738
+ "title": {
4739
+ "type": "string",
4740
+ "minLength": 1,
4741
+ "maxLength": 64,
4742
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
4743
+ },
4744
+ "description": {
4745
+ "type": "string",
4746
+ "maxLength": 256,
4747
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
4748
+ },
4749
+ "iconUrl": {
4750
+ "type": "string",
4751
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
4752
+ },
4753
+ "readmeUrl": {
4754
+ "type": "string",
4755
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
4756
+ },
4757
+ "public": {
4758
+ "type": "boolean",
4759
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
4760
+ }
4761
+ },
4762
+ "required": [
4763
+ "id",
4764
+ "createdAt",
4765
+ "updatedAt",
4766
+ "name",
4767
+ "version",
4768
+ "title",
4769
+ "description",
4770
+ "iconUrl",
4771
+ "readmeUrl",
4772
+ "public"
4773
+ ]
4774
+ }
4775
+ },
4776
+ "meta": {
4777
+ "type": "object",
4778
+ "properties": {
4779
+ "nextToken": {
4780
+ "type": "string",
4781
+ "description": "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."
4782
+ }
4783
+ },
4784
+ "additionalProperties": false
4785
+ }
4786
+ },
4787
+ "required": [
4788
+ "plugins",
4789
+ "meta"
4790
+ ],
4791
+ "title": "listPublicPluginsResponse",
4792
+ "additionalProperties": false
4793
+ }
4794
+ }
4795
+ },
4796
+ "getPublicPluginById": {
4797
+ "name": "getPublicPluginById",
4798
+ "description": "Get public plugin by Id",
4799
+ "method": "get",
4800
+ "section": "hub",
4801
+ "path": "/v1/admin/hub/plugins/{id}",
4802
+ "disableDefaultParameters": {
4803
+ "x-workspace-id": true
4804
+ },
4805
+ "parameters": {
4806
+ "id": {
4807
+ "type": "string",
4808
+ "description": "Plugin ID",
4809
+ "in": "path"
4810
+ }
4811
+ },
4812
+ "response": {
4813
+ "description": "Success",
4814
+ "schema": {
4815
+ "type": "object",
4816
+ "properties": {
4817
+ "plugin": {
4818
+ "type": "object",
4819
+ "properties": {
4820
+ "id": {
4821
+ "type": "string",
4822
+ "minLength": 28,
4823
+ "maxLength": 36,
4824
+ "description": "ID of the [Plugin](#schema_plugin)"
4825
+ },
4826
+ "name": {
4827
+ "type": "string",
4828
+ "maxLength": 200,
4829
+ "description": "Name of the [Plugin](#schema_plugin)"
4830
+ },
4831
+ "version": {
4832
+ "type": "string",
4833
+ "maxLength": 200,
4834
+ "description": "Version of the [Plugin](#schema_plugin)"
4835
+ },
4836
+ "createdAt": {
4837
+ "type": "string",
4838
+ "format": "date-time",
4839
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
4840
+ },
4841
+ "updatedAt": {
4842
+ "type": "string",
4843
+ "format": "date-time",
4844
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
4845
+ },
4846
+ "configuration": {
4847
+ "type": "object",
4848
+ "properties": {
4849
+ "title": {
4850
+ "type": "string",
4851
+ "maxLength": 64,
4852
+ "description": "Title of the configuration"
4853
+ },
4854
+ "description": {
4855
+ "type": "string",
4856
+ "maxLength": 256,
4857
+ "description": "Description of the configuration"
4858
+ },
4859
+ "schema": {
4860
+ "type": "object",
4861
+ "additionalProperties": true,
4862
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
4863
+ }
4864
+ },
4865
+ "required": [
4866
+ "schema"
4867
+ ],
4868
+ "description": "Configuration definition",
4869
+ "additionalProperties": false
4870
+ },
4871
+ "states": {
4872
+ "type": "object",
4873
+ "additionalProperties": {
4874
+ "type": "object",
4875
+ "properties": {
4876
+ "type": {
4877
+ "type": "string",
4878
+ "enum": [
4879
+ "conversation",
4880
+ "user",
4881
+ "bot",
4882
+ "task"
4883
+ ],
4884
+ "description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
4885
+ },
4886
+ "schema": {
4887
+ "type": "object",
4888
+ "additionalProperties": true,
4889
+ "description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
4890
+ },
4891
+ "expiry": {
4892
+ "type": "number",
4893
+ "minimum": 1,
4894
+ "description": "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."
4895
+ }
4896
+ },
4897
+ "required": [
4898
+ "type",
4899
+ "schema"
4900
+ ],
4901
+ "additionalProperties": false
4902
+ }
4903
+ },
4904
+ "events": {
4905
+ "type": "object",
4906
+ "additionalProperties": {
4907
+ "type": "object",
4908
+ "properties": {
4909
+ "title": {
4910
+ "type": "string",
4911
+ "maxLength": 64,
4912
+ "description": "Title of the event"
4913
+ },
4914
+ "description": {
4915
+ "type": "string",
4916
+ "maxLength": 256,
4917
+ "description": "Description of the event"
4918
+ },
4919
+ "schema": {
4920
+ "type": "object",
4921
+ "additionalProperties": true
4922
+ }
4923
+ },
4924
+ "required": [
4925
+ "schema"
4926
+ ],
4927
+ "description": "Event Definition",
4928
+ "additionalProperties": false
4929
+ }
4930
+ },
4931
+ "actions": {
4932
+ "type": "object",
4933
+ "additionalProperties": {
4934
+ "type": "object",
4935
+ "properties": {
4936
+ "title": {
4937
+ "type": "string",
4938
+ "maxLength": 64,
4939
+ "description": "Title of the action"
4940
+ },
4941
+ "description": {
4942
+ "type": "string",
4943
+ "maxLength": 256,
4944
+ "description": "Description of the action"
4945
+ },
4946
+ "billable": {
4947
+ "type": "boolean"
4948
+ },
4949
+ "cacheable": {
4950
+ "type": "boolean"
4951
+ },
4952
+ "input": {
4953
+ "type": "object",
4954
+ "properties": {
4955
+ "schema": {
4956
+ "type": "object",
4957
+ "additionalProperties": true
4958
+ }
4959
+ },
4960
+ "required": [
4961
+ "schema"
4962
+ ],
4963
+ "additionalProperties": false
4964
+ },
4965
+ "output": {
4966
+ "type": "object",
4967
+ "properties": {
4968
+ "schema": {
4969
+ "type": "object",
4970
+ "additionalProperties": true
4971
+ }
4972
+ },
4973
+ "required": [
4974
+ "schema"
4975
+ ],
4976
+ "additionalProperties": false
4977
+ }
4978
+ },
4979
+ "required": [
4980
+ "input",
4981
+ "output"
4982
+ ],
4983
+ "description": "Action definition",
4984
+ "additionalProperties": false
4985
+ }
4986
+ },
4987
+ "dependencies": {
4988
+ "type": "object",
4989
+ "properties": {
4990
+ "interfaces": {
4991
+ "type": "object",
4992
+ "additionalProperties": {
4993
+ "type": "object",
4994
+ "properties": {
4995
+ "id": {
4996
+ "type": "string",
4997
+ "minLength": 28,
4998
+ "maxLength": 36
4999
+ },
5000
+ "name": {
5001
+ "type": "string",
5002
+ "maxLength": 200
5003
+ },
5004
+ "version": {
5005
+ "type": "string",
5006
+ "maxLength": 200
5007
+ }
5008
+ },
5009
+ "required": [
5010
+ "id",
5011
+ "name",
5012
+ "version"
5013
+ ],
5014
+ "additionalProperties": false
5015
+ }
5016
+ },
5017
+ "integrations": {
5018
+ "type": "object",
5019
+ "additionalProperties": {
5020
+ "type": "object",
5021
+ "properties": {
5022
+ "id": {
5023
+ "type": "string",
5024
+ "minLength": 28,
5025
+ "maxLength": 36
5026
+ },
5027
+ "name": {
5028
+ "type": "string",
5029
+ "maxLength": 200
5030
+ },
5031
+ "version": {
5032
+ "type": "string",
5033
+ "maxLength": 200
5034
+ }
5035
+ },
5036
+ "required": [
5037
+ "id",
5038
+ "name",
5039
+ "version"
5040
+ ],
5041
+ "additionalProperties": false
5042
+ }
5043
+ }
5044
+ },
5045
+ "required": [
5046
+ "interfaces",
5047
+ "integrations"
5048
+ ],
5049
+ "additionalProperties": false
5050
+ },
5051
+ "user": {
5052
+ "type": "object",
5053
+ "properties": {
5054
+ "tags": {
5055
+ "type": "object",
5056
+ "additionalProperties": {
5057
+ "type": "object",
5058
+ "properties": {
5059
+ "title": {
5060
+ "type": "string",
5061
+ "maxLength": 64,
5062
+ "description": "Title of the tag"
5063
+ },
5064
+ "description": {
5065
+ "type": "string",
5066
+ "maxLength": 256,
5067
+ "description": "Description of the tag"
5068
+ }
5069
+ },
5070
+ "description": "Definition of a tag that can be provided on the object",
5071
+ "additionalProperties": false
5072
+ }
5073
+ }
5074
+ },
5075
+ "required": [
5076
+ "tags"
5077
+ ],
5078
+ "description": "User object configuration",
5079
+ "additionalProperties": false
5080
+ },
5081
+ "conversation": {
5082
+ "type": "object",
5083
+ "properties": {
5084
+ "tags": {
5085
+ "type": "object",
5086
+ "additionalProperties": {
5087
+ "type": "object",
5088
+ "properties": {
5089
+ "title": {
5090
+ "type": "string",
5091
+ "maxLength": 64,
5092
+ "description": "Title of the tag"
5093
+ },
5094
+ "description": {
5095
+ "type": "string",
5096
+ "maxLength": 256,
5097
+ "description": "Description of the tag"
5098
+ }
5099
+ },
5100
+ "description": "Definition of a tag that can be provided on the object",
5101
+ "additionalProperties": false
5102
+ }
5103
+ }
5104
+ },
5105
+ "required": [
5106
+ "tags"
5107
+ ],
5108
+ "description": "Conversation object configuration",
5109
+ "additionalProperties": false
5110
+ },
5111
+ "title": {
5112
+ "type": "string",
5113
+ "minLength": 1,
5114
+ "maxLength": 64,
5115
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
5116
+ },
5117
+ "description": {
5118
+ "type": "string",
5119
+ "maxLength": 256,
5120
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
5121
+ },
5122
+ "iconUrl": {
5123
+ "type": "string",
5124
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
5125
+ },
5126
+ "readmeUrl": {
5127
+ "type": "string",
5128
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
5129
+ },
5130
+ "public": {
5131
+ "type": "boolean",
5132
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
5133
+ }
5134
+ },
5135
+ "required": [
5136
+ "id",
5137
+ "name",
5138
+ "version",
5139
+ "createdAt",
5140
+ "updatedAt",
5141
+ "configuration",
5142
+ "states",
5143
+ "events",
5144
+ "actions",
5145
+ "dependencies",
5146
+ "user",
5147
+ "conversation",
5148
+ "title",
5149
+ "description",
5150
+ "iconUrl",
5151
+ "readmeUrl",
5152
+ "public"
5153
+ ],
5154
+ "additionalProperties": false
5155
+ }
5156
+ },
5157
+ "required": [
5158
+ "plugin"
5159
+ ],
5160
+ "title": "getPublicPluginByIdResponse",
5161
+ "additionalProperties": false
5162
+ }
5163
+ }
5164
+ },
5165
+ "getPublicPlugin": {
5166
+ "name": "getPublicPlugin",
5167
+ "description": "Get public plugin by name and version",
5168
+ "method": "get",
5169
+ "section": "hub",
5170
+ "path": "/v1/admin/hub/plugins/{name}/{version}",
5171
+ "disableDefaultParameters": {
5172
+ "x-workspace-id": true
5173
+ },
5174
+ "parameters": {
5175
+ "name": {
5176
+ "type": "string",
5177
+ "description": "Plugin Name",
5178
+ "in": "path"
5179
+ },
5180
+ "version": {
5181
+ "type": "string",
5182
+ "description": "Plugin version.",
5183
+ "in": "path"
5184
+ }
5185
+ },
5186
+ "response": {
5187
+ "description": "Success",
5188
+ "schema": {
5189
+ "type": "object",
5190
+ "properties": {
5191
+ "plugin": {
5192
+ "type": "object",
5193
+ "properties": {
5194
+ "id": {
5195
+ "type": "string",
5196
+ "minLength": 28,
5197
+ "maxLength": 36,
5198
+ "description": "ID of the [Plugin](#schema_plugin)"
5199
+ },
5200
+ "name": {
5201
+ "type": "string",
5202
+ "maxLength": 200,
5203
+ "description": "Name of the [Plugin](#schema_plugin)"
5204
+ },
5205
+ "version": {
5206
+ "type": "string",
5207
+ "maxLength": 200,
5208
+ "description": "Version of the [Plugin](#schema_plugin)"
5209
+ },
5210
+ "createdAt": {
5211
+ "type": "string",
5212
+ "format": "date-time",
5213
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
5214
+ },
5215
+ "updatedAt": {
5216
+ "type": "string",
5217
+ "format": "date-time",
5218
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
5219
+ },
5220
+ "configuration": {
5221
+ "type": "object",
5222
+ "properties": {
5223
+ "title": {
5224
+ "type": "string",
5225
+ "maxLength": 64,
5226
+ "description": "Title of the configuration"
5227
+ },
5228
+ "description": {
5229
+ "type": "string",
5230
+ "maxLength": 256,
5231
+ "description": "Description of the configuration"
5232
+ },
5233
+ "schema": {
5234
+ "type": "object",
5235
+ "additionalProperties": true,
5236
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
5237
+ }
5238
+ },
5239
+ "required": [
5240
+ "schema"
5241
+ ],
5242
+ "description": "Configuration definition",
5243
+ "additionalProperties": false
5244
+ },
5245
+ "states": {
5246
+ "type": "object",
5247
+ "additionalProperties": {
5248
+ "type": "object",
5249
+ "properties": {
5250
+ "type": {
5251
+ "type": "string",
5252
+ "enum": [
5253
+ "conversation",
5254
+ "user",
5255
+ "bot",
5256
+ "task"
5257
+ ],
5258
+ "description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
5259
+ },
5260
+ "schema": {
5261
+ "type": "object",
5262
+ "additionalProperties": true,
5263
+ "description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
5264
+ },
5265
+ "expiry": {
5266
+ "type": "number",
5267
+ "minimum": 1,
5268
+ "description": "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."
5269
+ }
5270
+ },
5271
+ "required": [
5272
+ "type",
5273
+ "schema"
5274
+ ],
5275
+ "additionalProperties": false
5276
+ }
5277
+ },
5278
+ "events": {
5279
+ "type": "object",
5280
+ "additionalProperties": {
5281
+ "type": "object",
5282
+ "properties": {
5283
+ "title": {
5284
+ "type": "string",
5285
+ "maxLength": 64,
5286
+ "description": "Title of the event"
5287
+ },
5288
+ "description": {
5289
+ "type": "string",
5290
+ "maxLength": 256,
5291
+ "description": "Description of the event"
5292
+ },
5293
+ "schema": {
5294
+ "type": "object",
5295
+ "additionalProperties": true
5296
+ }
5297
+ },
5298
+ "required": [
5299
+ "schema"
5300
+ ],
5301
+ "description": "Event Definition",
5302
+ "additionalProperties": false
5303
+ }
5304
+ },
5305
+ "actions": {
5306
+ "type": "object",
5307
+ "additionalProperties": {
5308
+ "type": "object",
5309
+ "properties": {
5310
+ "title": {
5311
+ "type": "string",
5312
+ "maxLength": 64,
5313
+ "description": "Title of the action"
5314
+ },
5315
+ "description": {
5316
+ "type": "string",
5317
+ "maxLength": 256,
5318
+ "description": "Description of the action"
5319
+ },
5320
+ "billable": {
5321
+ "type": "boolean"
5322
+ },
5323
+ "cacheable": {
5324
+ "type": "boolean"
5325
+ },
5326
+ "input": {
5327
+ "type": "object",
5328
+ "properties": {
5329
+ "schema": {
5330
+ "type": "object",
5331
+ "additionalProperties": true
5332
+ }
5333
+ },
5334
+ "required": [
5335
+ "schema"
5336
+ ],
5337
+ "additionalProperties": false
5338
+ },
5339
+ "output": {
5340
+ "type": "object",
5341
+ "properties": {
5342
+ "schema": {
5343
+ "type": "object",
5344
+ "additionalProperties": true
5345
+ }
5346
+ },
5347
+ "required": [
5348
+ "schema"
5349
+ ],
5350
+ "additionalProperties": false
5351
+ }
5352
+ },
5353
+ "required": [
5354
+ "input",
5355
+ "output"
5356
+ ],
5357
+ "description": "Action definition",
5358
+ "additionalProperties": false
5359
+ }
5360
+ },
5361
+ "dependencies": {
5362
+ "type": "object",
5363
+ "properties": {
5364
+ "interfaces": {
5365
+ "type": "object",
5366
+ "additionalProperties": {
5367
+ "type": "object",
5368
+ "properties": {
5369
+ "id": {
5370
+ "type": "string",
5371
+ "minLength": 28,
5372
+ "maxLength": 36
5373
+ },
5374
+ "name": {
5375
+ "type": "string",
5376
+ "maxLength": 200
5377
+ },
5378
+ "version": {
5379
+ "type": "string",
5380
+ "maxLength": 200
5381
+ }
5382
+ },
5383
+ "required": [
5384
+ "id",
5385
+ "name",
5386
+ "version"
5387
+ ],
5388
+ "additionalProperties": false
5389
+ }
5390
+ },
5391
+ "integrations": {
5392
+ "type": "object",
5393
+ "additionalProperties": {
5394
+ "type": "object",
5395
+ "properties": {
5396
+ "id": {
5397
+ "type": "string",
5398
+ "minLength": 28,
5399
+ "maxLength": 36
5400
+ },
5401
+ "name": {
5402
+ "type": "string",
5403
+ "maxLength": 200
5404
+ },
5405
+ "version": {
5406
+ "type": "string",
5407
+ "maxLength": 200
5408
+ }
5409
+ },
5410
+ "required": [
5411
+ "id",
5412
+ "name",
5413
+ "version"
5414
+ ],
5415
+ "additionalProperties": false
5416
+ }
5417
+ }
5418
+ },
5419
+ "required": [
5420
+ "interfaces",
5421
+ "integrations"
5422
+ ],
5423
+ "additionalProperties": false
5424
+ },
5425
+ "user": {
5426
+ "type": "object",
5427
+ "properties": {
5428
+ "tags": {
5429
+ "type": "object",
5430
+ "additionalProperties": {
5431
+ "type": "object",
5432
+ "properties": {
5433
+ "title": {
5434
+ "type": "string",
5435
+ "maxLength": 64,
5436
+ "description": "Title of the tag"
5437
+ },
5438
+ "description": {
5439
+ "type": "string",
5440
+ "maxLength": 256,
5441
+ "description": "Description of the tag"
5442
+ }
5443
+ },
5444
+ "description": "Definition of a tag that can be provided on the object",
5445
+ "additionalProperties": false
5446
+ }
5447
+ }
5448
+ },
5449
+ "required": [
5450
+ "tags"
5451
+ ],
5452
+ "description": "User object configuration",
5453
+ "additionalProperties": false
5454
+ },
5455
+ "conversation": {
5456
+ "type": "object",
5457
+ "properties": {
5458
+ "tags": {
5459
+ "type": "object",
5460
+ "additionalProperties": {
5461
+ "type": "object",
5462
+ "properties": {
5463
+ "title": {
5464
+ "type": "string",
5465
+ "maxLength": 64,
5466
+ "description": "Title of the tag"
5467
+ },
5468
+ "description": {
5469
+ "type": "string",
5470
+ "maxLength": 256,
5471
+ "description": "Description of the tag"
5472
+ }
5473
+ },
5474
+ "description": "Definition of a tag that can be provided on the object",
5475
+ "additionalProperties": false
5476
+ }
5477
+ }
5478
+ },
5479
+ "required": [
5480
+ "tags"
5481
+ ],
5482
+ "description": "Conversation object configuration",
5483
+ "additionalProperties": false
5484
+ },
5485
+ "title": {
5486
+ "type": "string",
5487
+ "minLength": 1,
5488
+ "maxLength": 64,
5489
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
5490
+ },
5491
+ "description": {
5492
+ "type": "string",
5493
+ "maxLength": 256,
5494
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
5495
+ },
5496
+ "iconUrl": {
5497
+ "type": "string",
5498
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
5499
+ },
5500
+ "readmeUrl": {
5501
+ "type": "string",
5502
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
5503
+ },
5504
+ "public": {
5505
+ "type": "boolean",
5506
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
5507
+ }
5508
+ },
5509
+ "required": [
5510
+ "id",
5511
+ "name",
5512
+ "version",
5513
+ "createdAt",
5514
+ "updatedAt",
5515
+ "configuration",
5516
+ "states",
5517
+ "events",
5518
+ "actions",
5519
+ "dependencies",
5520
+ "user",
5521
+ "conversation",
5522
+ "title",
5523
+ "description",
5524
+ "iconUrl",
5525
+ "readmeUrl",
5526
+ "public"
5527
+ ],
5528
+ "additionalProperties": false
5529
+ }
5530
+ },
5531
+ "required": [
5532
+ "plugin"
5533
+ ],
5534
+ "title": "getPublicPluginResponse",
5535
+ "additionalProperties": false
5536
+ }
5537
+ }
5538
+ },
5539
+ "getPublicPluginCode": {
5540
+ "name": "getPublicPluginCode",
5541
+ "description": "Get public plugin code",
5542
+ "method": "get",
5543
+ "path": "/v1/admin/hub/{id}/code/{platform}",
5544
+ "disableDefaultParameters": {
5545
+ "x-workspace-id": true
5546
+ },
5547
+ "section": "hub",
5548
+ "parameters": {
5549
+ "id": {
5550
+ "in": "path",
5551
+ "type": "string",
5552
+ "description": "Plugin id"
5553
+ },
5554
+ "platform": {
5555
+ "in": "path",
5556
+ "type": "string",
5557
+ "enum": [
5558
+ "node",
5559
+ "browser"
5560
+ ],
5561
+ "description": "Platform"
5562
+ }
5563
+ },
5564
+ "response": {
5565
+ "description": "Plugin code",
5566
+ "schema": {
5567
+ "type": "object",
5568
+ "properties": {
5569
+ "code": {
5570
+ "type": "string"
5571
+ }
5572
+ },
5573
+ "required": [
5574
+ "code"
5575
+ ],
5576
+ "title": "getPublicPluginCodeResponse",
5577
+ "additionalProperties": false
5578
+ }
5579
+ }
5580
+ },
4676
5581
  "createBot": {
4677
5582
  "name": "createBot",
4678
5583
  "description": "Create bot",
@@ -12692,6 +13597,11 @@ export const state = {
12692
13597
  "in": "query",
12693
13598
  "type": "string",
12694
13599
  "description": "Filter all versions of a plugin by name"
13600
+ },
13601
+ "version": {
13602
+ "in": "query",
13603
+ "type": "string",
13604
+ "description": "Filter a plugin by name and version"
12695
13605
  }
12696
13606
  },
12697
13607
  "response": {
@@ -16099,7 +17009,7 @@ export const state = {
16099
17009
  "title": "Botpress API",
16100
17010
  "description": "API for Botpress Cloud",
16101
17011
  "server": "https://api.botpress.cloud",
16102
- "version": "1.4.0",
17012
+ "version": "1.5.0",
16103
17013
  "prefix": "v1"
16104
17014
  },
16105
17015
  "errors": [
@@ -16352,6 +17262,10 @@ export const state = {
16352
17262
  "listPublicIntegrationsResponse": true,
16353
17263
  "getPublicIntegrationByIdResponse": true,
16354
17264
  "getPublicIntegrationResponse": true,
17265
+ "listPublicPluginsResponse": true,
17266
+ "getPublicPluginByIdResponse": true,
17267
+ "getPublicPluginResponse": true,
17268
+ "getPublicPluginCodeResponse": true,
16355
17269
  "createBotResponse": true,
16356
17270
  "updateBotResponse": true,
16357
17271
  "transferBotResponse": true,
@@ -19787,7 +20701,11 @@ export const state = {
19787
20701
  "operations": [
19788
20702
  "listPublicIntegrations",
19789
20703
  "getPublicIntegrationById",
19790
- "getPublicIntegration"
20704
+ "getPublicIntegration",
20705
+ "listPublicPlugins",
20706
+ "getPublicPluginById",
20707
+ "getPublicPlugin",
20708
+ "getPublicPluginCode"
19791
20709
  ]
19792
20710
  },
19793
20711
  {