@botpress/cognitive 0.1.15 → 0.1.17

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
@@ -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
  /**
@@ -4902,20 +4912,510 @@ interface GetPublicIntegrationResponse {
4902
4912
  };
4903
4913
  };
4904
4914
  states: {
4905
- /**
4906
- * State definition
4907
- */
4915
+ /**
4916
+ * State definition
4917
+ */
4918
+ [k: string]: {
4919
+ /**
4920
+ * Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
4921
+ */
4922
+ type: "conversation" | "user" | "integration";
4923
+ /**
4924
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
4925
+ */
4926
+ schema: {
4927
+ [k: string]: any;
4928
+ };
4929
+ };
4930
+ };
4931
+ events: {
4932
+ /**
4933
+ * Event Definition
4934
+ */
4935
+ [k: string]: {
4936
+ /**
4937
+ * Title of the event
4938
+ */
4939
+ title?: string;
4940
+ /**
4941
+ * Description of the event
4942
+ */
4943
+ description?: string;
4944
+ schema: {
4945
+ [k: string]: any;
4946
+ };
4947
+ /**
4948
+ * Optional attributes
4949
+ */
4950
+ attributes?: {
4951
+ [k: string]: string;
4952
+ };
4953
+ };
4954
+ };
4955
+ actions: {
4956
+ /**
4957
+ * Action definition
4958
+ */
4959
+ [k: string]: {
4960
+ /**
4961
+ * Title of the action
4962
+ */
4963
+ title?: string;
4964
+ /**
4965
+ * Description of the action
4966
+ */
4967
+ description?: string;
4968
+ billable?: boolean;
4969
+ cacheable?: boolean;
4970
+ input: {
4971
+ schema: {
4972
+ [k: string]: any;
4973
+ };
4974
+ };
4975
+ output: {
4976
+ schema: {
4977
+ [k: string]: any;
4978
+ };
4979
+ };
4980
+ /**
4981
+ * Optional attributes
4982
+ */
4983
+ attributes?: {
4984
+ [k: string]: string;
4985
+ };
4986
+ };
4987
+ };
4988
+ /**
4989
+ * User object configuration
4990
+ */
4991
+ user: {
4992
+ tags: {
4993
+ /**
4994
+ * Definition of a tag that can be provided on the object
4995
+ */
4996
+ [k: string]: {
4997
+ /**
4998
+ * Title of the tag
4999
+ */
5000
+ title?: string;
5001
+ /**
5002
+ * Description of the tag
5003
+ */
5004
+ description?: string;
5005
+ };
5006
+ };
5007
+ /**
5008
+ * The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.
5009
+ */
5010
+ creation: {
5011
+ /**
5012
+ * Enable user creation
5013
+ */
5014
+ enabled: boolean;
5015
+ /**
5016
+ * The list of tags that are required to be specified when calling the API directly to create a user.
5017
+ */
5018
+ requiredTags: string[];
5019
+ };
5020
+ };
5021
+ entities: {
5022
+ /**
5023
+ * Entity definition
5024
+ */
5025
+ [k: string]: {
5026
+ /**
5027
+ * Title of the entity
5028
+ */
5029
+ title?: string;
5030
+ /**
5031
+ * Description of the entity
5032
+ */
5033
+ description?: string;
5034
+ schema: {
5035
+ [k: string]: any;
5036
+ };
5037
+ };
5038
+ };
5039
+ /**
5040
+ * Indicates if the integration is a development integration; Dev integrations run locally
5041
+ */
5042
+ dev: boolean;
5043
+ /**
5044
+ * Title of the integration. This is the name that will be displayed in the UI
5045
+ */
5046
+ title: string;
5047
+ /**
5048
+ * Description of the integration. This is the description that will be displayed in the UI
5049
+ */
5050
+ description: string;
5051
+ /**
5052
+ * URL of the icon of the integration. This is the icon that will be displayed in the UI
5053
+ */
5054
+ iconUrl: string;
5055
+ /**
5056
+ * URL of the readme of the integration. This is the readme that will be displayed in the UI
5057
+ */
5058
+ readmeUrl: string;
5059
+ /**
5060
+ * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
5061
+ */
5062
+ public: boolean;
5063
+ /**
5064
+ * Status of the integration version verification
5065
+ */
5066
+ verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
5067
+ /**
5068
+ * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
5069
+ */
5070
+ secrets: string[];
5071
+ ownerWorkspace: {
5072
+ id: string;
5073
+ handle: string | null;
5074
+ name: string;
5075
+ };
5076
+ meta: {
5077
+ installs: number;
5078
+ views: number;
5079
+ };
5080
+ };
5081
+ }
5082
+
5083
+ interface ListPublicPluginsRequestHeaders {
5084
+ }
5085
+ interface ListPublicPluginsRequestQuery {
5086
+ nextToken?: string;
5087
+ name?: string;
5088
+ version?: string;
5089
+ }
5090
+ interface ListPublicPluginsRequestParams {
5091
+ }
5092
+ interface ListPublicPluginsRequestBody {
5093
+ }
5094
+ type ListPublicPluginsInput = ListPublicPluginsRequestBody & ListPublicPluginsRequestHeaders & ListPublicPluginsRequestQuery & ListPublicPluginsRequestParams;
5095
+ interface ListPublicPluginsResponse {
5096
+ plugins: {
5097
+ /**
5098
+ * ID of the [Plugin](#schema_plugin)
5099
+ */
5100
+ id: string;
5101
+ /**
5102
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
5103
+ */
5104
+ createdAt: string;
5105
+ /**
5106
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
5107
+ */
5108
+ updatedAt: string;
5109
+ /**
5110
+ * Name of the [Plugin](#schema_plugin)
5111
+ */
5112
+ name: string;
5113
+ /**
5114
+ * Version of the [Plugin](#schema_plugin)
5115
+ */
5116
+ version: string;
5117
+ /**
5118
+ * Title of the plugin. This is the name that will be displayed in the UI
5119
+ */
5120
+ title: string;
5121
+ /**
5122
+ * Description of the plugin. This is the description that will be displayed in the UI
5123
+ */
5124
+ description: string;
5125
+ /**
5126
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
5127
+ */
5128
+ iconUrl: string;
5129
+ /**
5130
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
5131
+ */
5132
+ readmeUrl: string;
5133
+ /**
5134
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
5135
+ */
5136
+ public: boolean;
5137
+ }[];
5138
+ meta: {
5139
+ /**
5140
+ * 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.
5141
+ */
5142
+ nextToken?: string;
5143
+ };
5144
+ }
5145
+
5146
+ interface GetPublicPluginByIdRequestHeaders {
5147
+ }
5148
+ interface GetPublicPluginByIdRequestQuery {
5149
+ }
5150
+ interface GetPublicPluginByIdRequestParams {
5151
+ id: string;
5152
+ }
5153
+ interface GetPublicPluginByIdRequestBody {
5154
+ }
5155
+ type GetPublicPluginByIdInput = GetPublicPluginByIdRequestBody & GetPublicPluginByIdRequestHeaders & GetPublicPluginByIdRequestQuery & GetPublicPluginByIdRequestParams;
5156
+ interface GetPublicPluginByIdResponse {
5157
+ plugin: {
5158
+ /**
5159
+ * ID of the [Plugin](#schema_plugin)
5160
+ */
5161
+ id: string;
5162
+ /**
5163
+ * Name of the [Plugin](#schema_plugin)
5164
+ */
5165
+ name: string;
5166
+ /**
5167
+ * Version of the [Plugin](#schema_plugin)
5168
+ */
5169
+ version: string;
5170
+ /**
5171
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
5172
+ */
5173
+ createdAt: string;
5174
+ /**
5175
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
5176
+ */
5177
+ updatedAt: string;
5178
+ /**
5179
+ * Configuration definition
5180
+ */
5181
+ configuration: {
5182
+ /**
5183
+ * Title of the configuration
5184
+ */
5185
+ title?: string;
5186
+ /**
5187
+ * Description of the configuration
5188
+ */
5189
+ description?: string;
5190
+ /**
5191
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
5192
+ */
5193
+ schema: {
5194
+ [k: string]: any;
5195
+ };
5196
+ };
5197
+ states: {
5198
+ [k: string]: {
5199
+ /**
5200
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
5201
+ */
5202
+ type: "conversation" | "user" | "bot" | "task";
5203
+ /**
5204
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
5205
+ */
5206
+ schema: {
5207
+ [k: string]: any;
5208
+ };
5209
+ /**
5210
+ * 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.
5211
+ */
5212
+ expiry?: number;
5213
+ };
5214
+ };
5215
+ events: {
5216
+ /**
5217
+ * Event Definition
5218
+ */
5219
+ [k: string]: {
5220
+ /**
5221
+ * Title of the event
5222
+ */
5223
+ title?: string;
5224
+ /**
5225
+ * Description of the event
5226
+ */
5227
+ description?: string;
5228
+ schema: {
5229
+ [k: string]: any;
5230
+ };
5231
+ /**
5232
+ * Optional attributes
5233
+ */
5234
+ attributes?: {
5235
+ [k: string]: string;
5236
+ };
5237
+ };
5238
+ };
5239
+ actions: {
5240
+ /**
5241
+ * Action definition
5242
+ */
5243
+ [k: string]: {
5244
+ /**
5245
+ * Title of the action
5246
+ */
5247
+ title?: string;
5248
+ /**
5249
+ * Description of the action
5250
+ */
5251
+ description?: string;
5252
+ billable?: boolean;
5253
+ cacheable?: boolean;
5254
+ input: {
5255
+ schema: {
5256
+ [k: string]: any;
5257
+ };
5258
+ };
5259
+ output: {
5260
+ schema: {
5261
+ [k: string]: any;
5262
+ };
5263
+ };
5264
+ /**
5265
+ * Optional attributes
5266
+ */
5267
+ attributes?: {
5268
+ [k: string]: string;
5269
+ };
5270
+ };
5271
+ };
5272
+ dependencies: {
5273
+ interfaces: {
5274
+ [k: string]: {
5275
+ id: string;
5276
+ name: string;
5277
+ version: string;
5278
+ };
5279
+ };
5280
+ integrations: {
5281
+ [k: string]: {
5282
+ id: string;
5283
+ name: string;
5284
+ version: string;
5285
+ };
5286
+ };
5287
+ };
5288
+ /**
5289
+ * User object configuration
5290
+ */
5291
+ user: {
5292
+ tags: {
5293
+ /**
5294
+ * Definition of a tag that can be provided on the object
5295
+ */
5296
+ [k: string]: {
5297
+ /**
5298
+ * Title of the tag
5299
+ */
5300
+ title?: string;
5301
+ /**
5302
+ * Description of the tag
5303
+ */
5304
+ description?: string;
5305
+ };
5306
+ };
5307
+ };
5308
+ /**
5309
+ * Conversation object configuration
5310
+ */
5311
+ conversation: {
5312
+ tags: {
5313
+ /**
5314
+ * Definition of a tag that can be provided on the object
5315
+ */
5316
+ [k: string]: {
5317
+ /**
5318
+ * Title of the tag
5319
+ */
5320
+ title?: string;
5321
+ /**
5322
+ * Description of the tag
5323
+ */
5324
+ description?: string;
5325
+ };
5326
+ };
5327
+ };
5328
+ /**
5329
+ * Title of the plugin. This is the name that will be displayed in the UI
5330
+ */
5331
+ title: string;
5332
+ /**
5333
+ * Description of the plugin. This is the description that will be displayed in the UI
5334
+ */
5335
+ description: string;
5336
+ /**
5337
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
5338
+ */
5339
+ iconUrl: string;
5340
+ /**
5341
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
5342
+ */
5343
+ readmeUrl: string;
5344
+ /**
5345
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
5346
+ */
5347
+ public: boolean;
5348
+ };
5349
+ }
5350
+
5351
+ interface GetPublicPluginRequestHeaders {
5352
+ }
5353
+ interface GetPublicPluginRequestQuery {
5354
+ }
5355
+ interface GetPublicPluginRequestParams {
5356
+ name: string;
5357
+ version: string;
5358
+ }
5359
+ interface GetPublicPluginRequestBody {
5360
+ }
5361
+ type GetPublicPluginInput = GetPublicPluginRequestBody & GetPublicPluginRequestHeaders & GetPublicPluginRequestQuery & GetPublicPluginRequestParams;
5362
+ interface GetPublicPluginResponse {
5363
+ plugin: {
5364
+ /**
5365
+ * ID of the [Plugin](#schema_plugin)
5366
+ */
5367
+ id: string;
5368
+ /**
5369
+ * Name of the [Plugin](#schema_plugin)
5370
+ */
5371
+ name: string;
5372
+ /**
5373
+ * Version of the [Plugin](#schema_plugin)
5374
+ */
5375
+ version: string;
5376
+ /**
5377
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
5378
+ */
5379
+ createdAt: string;
5380
+ /**
5381
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
5382
+ */
5383
+ updatedAt: string;
5384
+ /**
5385
+ * Configuration definition
5386
+ */
5387
+ configuration: {
5388
+ /**
5389
+ * Title of the configuration
5390
+ */
5391
+ title?: string;
5392
+ /**
5393
+ * Description of the configuration
5394
+ */
5395
+ description?: string;
5396
+ /**
5397
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
5398
+ */
5399
+ schema: {
5400
+ [k: string]: any;
5401
+ };
5402
+ };
5403
+ states: {
4908
5404
  [k: string]: {
4909
5405
  /**
4910
- * Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
5406
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
4911
5407
  */
4912
- type: "conversation" | "user" | "integration";
5408
+ type: "conversation" | "user" | "bot" | "task";
4913
5409
  /**
4914
5410
  * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
4915
5411
  */
4916
5412
  schema: {
4917
5413
  [k: string]: any;
4918
5414
  };
5415
+ /**
5416
+ * 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.
5417
+ */
5418
+ expiry?: number;
4919
5419
  };
4920
5420
  };
4921
5421
  events: {
@@ -4934,6 +5434,12 @@ interface GetPublicIntegrationResponse {
4934
5434
  schema: {
4935
5435
  [k: string]: any;
4936
5436
  };
5437
+ /**
5438
+ * Optional attributes
5439
+ */
5440
+ attributes?: {
5441
+ [k: string]: string;
5442
+ };
4937
5443
  };
4938
5444
  };
4939
5445
  actions: {
@@ -4961,6 +5467,28 @@ interface GetPublicIntegrationResponse {
4961
5467
  [k: string]: any;
4962
5468
  };
4963
5469
  };
5470
+ /**
5471
+ * Optional attributes
5472
+ */
5473
+ attributes?: {
5474
+ [k: string]: string;
5475
+ };
5476
+ };
5477
+ };
5478
+ dependencies: {
5479
+ interfaces: {
5480
+ [k: string]: {
5481
+ id: string;
5482
+ name: string;
5483
+ version: string;
5484
+ };
5485
+ };
5486
+ integrations: {
5487
+ [k: string]: {
5488
+ id: string;
5489
+ name: string;
5490
+ version: string;
5491
+ };
4964
5492
  };
4965
5493
  };
4966
5494
  /**
@@ -4982,82 +5510,65 @@ interface GetPublicIntegrationResponse {
4982
5510
  description?: string;
4983
5511
  };
4984
5512
  };
4985
- /**
4986
- * The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.
4987
- */
4988
- creation: {
4989
- /**
4990
- * Enable user creation
4991
- */
4992
- enabled: boolean;
4993
- /**
4994
- * The list of tags that are required to be specified when calling the API directly to create a user.
4995
- */
4996
- requiredTags: string[];
4997
- };
4998
5513
  };
4999
- entities: {
5000
- /**
5001
- * Entity definition
5002
- */
5003
- [k: string]: {
5004
- /**
5005
- * Title of the entity
5006
- */
5007
- title?: string;
5514
+ /**
5515
+ * Conversation object configuration
5516
+ */
5517
+ conversation: {
5518
+ tags: {
5008
5519
  /**
5009
- * Description of the entity
5520
+ * Definition of a tag that can be provided on the object
5010
5521
  */
5011
- description?: string;
5012
- schema: {
5013
- [k: string]: any;
5522
+ [k: string]: {
5523
+ /**
5524
+ * Title of the tag
5525
+ */
5526
+ title?: string;
5527
+ /**
5528
+ * Description of the tag
5529
+ */
5530
+ description?: string;
5014
5531
  };
5015
5532
  };
5016
5533
  };
5017
5534
  /**
5018
- * Indicates if the integration is a development integration; Dev integrations run locally
5019
- */
5020
- dev: boolean;
5021
- /**
5022
- * Title of the integration. This is the name that will be displayed in the UI
5535
+ * Title of the plugin. This is the name that will be displayed in the UI
5023
5536
  */
5024
5537
  title: string;
5025
5538
  /**
5026
- * Description of the integration. This is the description that will be displayed in the UI
5539
+ * Description of the plugin. This is the description that will be displayed in the UI
5027
5540
  */
5028
5541
  description: string;
5029
5542
  /**
5030
- * URL of the icon of the integration. This is the icon that will be displayed in the UI
5543
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
5031
5544
  */
5032
5545
  iconUrl: string;
5033
5546
  /**
5034
- * URL of the readme of the integration. This is the readme that will be displayed in the UI
5547
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
5035
5548
  */
5036
5549
  readmeUrl: string;
5037
5550
  /**
5038
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
5551
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
5039
5552
  */
5040
5553
  public: boolean;
5041
- /**
5042
- * Status of the integration version verification
5043
- */
5044
- verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
5045
- /**
5046
- * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
5047
- */
5048
- secrets: string[];
5049
- ownerWorkspace: {
5050
- id: string;
5051
- handle: string | null;
5052
- name: string;
5053
- };
5054
- meta: {
5055
- installs: number;
5056
- views: number;
5057
- };
5058
5554
  };
5059
5555
  }
5060
5556
 
5557
+ interface GetPublicPluginCodeRequestHeaders {
5558
+ }
5559
+ interface GetPublicPluginCodeRequestQuery {
5560
+ }
5561
+ interface GetPublicPluginCodeRequestParams {
5562
+ id: string;
5563
+ platform: "node" | "browser";
5564
+ }
5565
+ interface GetPublicPluginCodeRequestBody {
5566
+ }
5567
+ type GetPublicPluginCodeInput = GetPublicPluginCodeRequestBody & GetPublicPluginCodeRequestHeaders & GetPublicPluginCodeRequestQuery & GetPublicPluginCodeRequestParams;
5568
+ interface GetPublicPluginCodeResponse {
5569
+ code: string;
5570
+ }
5571
+
5061
5572
  interface CreateBotRequestHeaders {
5062
5573
  }
5063
5574
  interface CreateBotRequestQuery {
@@ -5105,6 +5616,12 @@ interface CreateBotRequestBody {
5105
5616
  schema: {
5106
5617
  [k: string]: any;
5107
5618
  };
5619
+ /**
5620
+ * Optional attributes
5621
+ */
5622
+ attributes?: {
5623
+ [k: string]: string;
5624
+ };
5108
5625
  };
5109
5626
  };
5110
5627
  recurringEvents?: {
@@ -5157,6 +5674,12 @@ interface CreateBotRequestBody {
5157
5674
  [k: string]: any;
5158
5675
  };
5159
5676
  };
5677
+ /**
5678
+ * Optional attributes
5679
+ */
5680
+ attributes?: {
5681
+ [k: string]: string;
5682
+ };
5160
5683
  };
5161
5684
  };
5162
5685
  configuration?: {
@@ -5447,6 +5970,12 @@ interface CreateBotResponse {
5447
5970
  schema: {
5448
5971
  [k: string]: any;
5449
5972
  };
5973
+ /**
5974
+ * Optional attributes
5975
+ */
5976
+ attributes?: {
5977
+ [k: string]: string;
5978
+ };
5450
5979
  };
5451
5980
  };
5452
5981
  /**
@@ -5510,6 +6039,12 @@ interface CreateBotResponse {
5510
6039
  [k: string]: any;
5511
6040
  };
5512
6041
  };
6042
+ /**
6043
+ * Optional attributes
6044
+ */
6045
+ attributes?: {
6046
+ [k: string]: string;
6047
+ };
5513
6048
  };
5514
6049
  };
5515
6050
  /**
@@ -5651,9 +6186,6 @@ interface UpdateBotRequestBody {
5651
6186
  };
5652
6187
  };
5653
6188
  events?: {
5654
- /**
5655
- * Event Definition
5656
- */
5657
6189
  [k: string]: {
5658
6190
  /**
5659
6191
  * Title of the event
@@ -5666,12 +6198,15 @@ interface UpdateBotRequestBody {
5666
6198
  schema: {
5667
6199
  [k: string]: any;
5668
6200
  };
6201
+ /**
6202
+ * Optional attributes. Set attributes to null to remove them
6203
+ */
6204
+ attributes?: {
6205
+ [k: string]: string | null;
6206
+ };
5669
6207
  } | null;
5670
6208
  };
5671
6209
  actions?: {
5672
- /**
5673
- * Action definition
5674
- */
5675
6210
  [k: string]: {
5676
6211
  /**
5677
6212
  * Title of the action
@@ -5693,6 +6228,12 @@ interface UpdateBotRequestBody {
5693
6228
  [k: string]: any;
5694
6229
  };
5695
6230
  };
6231
+ /**
6232
+ * Optional attributes. Set attributes to null to remove them
6233
+ */
6234
+ attributes?: {
6235
+ [k: string]: string | null;
6236
+ };
5696
6237
  } | null;
5697
6238
  };
5698
6239
  states?: {
@@ -5951,6 +6492,12 @@ interface UpdateBotResponse {
5951
6492
  schema: {
5952
6493
  [k: string]: any;
5953
6494
  };
6495
+ /**
6496
+ * Optional attributes
6497
+ */
6498
+ attributes?: {
6499
+ [k: string]: string;
6500
+ };
5954
6501
  };
5955
6502
  };
5956
6503
  /**
@@ -6014,6 +6561,12 @@ interface UpdateBotResponse {
6014
6561
  [k: string]: any;
6015
6562
  };
6016
6563
  };
6564
+ /**
6565
+ * Optional attributes
6566
+ */
6567
+ attributes?: {
6568
+ [k: string]: string;
6569
+ };
6017
6570
  };
6018
6571
  };
6019
6572
  /**
@@ -6328,6 +6881,12 @@ interface GetBotResponse {
6328
6881
  schema: {
6329
6882
  [k: string]: any;
6330
6883
  };
6884
+ /**
6885
+ * Optional attributes
6886
+ */
6887
+ attributes?: {
6888
+ [k: string]: string;
6889
+ };
6331
6890
  };
6332
6891
  };
6333
6892
  /**
@@ -6391,6 +6950,12 @@ interface GetBotResponse {
6391
6950
  [k: string]: any;
6392
6951
  };
6393
6952
  };
6953
+ /**
6954
+ * Optional attributes
6955
+ */
6956
+ attributes?: {
6957
+ [k: string]: string;
6958
+ };
6394
6959
  };
6395
6960
  };
6396
6961
  /**
@@ -6789,6 +7354,58 @@ interface GetIntegrationShareableIdResponse {
6789
7354
  isExpired: boolean;
6790
7355
  }
6791
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
+
6792
7409
  interface ListWorkspaceInvoicesRequestHeaders {
6793
7410
  }
6794
7411
  interface ListWorkspaceInvoicesRequestQuery {
@@ -7563,6 +8180,12 @@ interface CreateIntegrationRequestBody {
7563
8180
  schema: {
7564
8181
  [k: string]: any;
7565
8182
  };
8183
+ /**
8184
+ * Optional attributes
8185
+ */
8186
+ attributes?: {
8187
+ [k: string]: string;
8188
+ };
7566
8189
  };
7567
8190
  };
7568
8191
  actions?: {
@@ -7590,6 +8213,12 @@ interface CreateIntegrationRequestBody {
7590
8213
  [k: string]: any;
7591
8214
  };
7592
8215
  };
8216
+ /**
8217
+ * Optional attributes
8218
+ */
8219
+ attributes?: {
8220
+ [k: string]: string;
8221
+ };
7593
8222
  };
7594
8223
  };
7595
8224
  entities?: {
@@ -8032,6 +8661,12 @@ interface CreateIntegrationResponse {
8032
8661
  schema: {
8033
8662
  [k: string]: any;
8034
8663
  };
8664
+ /**
8665
+ * Optional attributes
8666
+ */
8667
+ attributes?: {
8668
+ [k: string]: string;
8669
+ };
8035
8670
  };
8036
8671
  };
8037
8672
  actions: {
@@ -8059,6 +8694,12 @@ interface CreateIntegrationResponse {
8059
8694
  [k: string]: any;
8060
8695
  };
8061
8696
  };
8697
+ /**
8698
+ * Optional attributes
8699
+ */
8700
+ attributes?: {
8701
+ [k: string]: string;
8702
+ };
8062
8703
  };
8063
8704
  };
8064
8705
  /**
@@ -8243,6 +8884,12 @@ interface ValidateIntegrationCreationRequestBody {
8243
8884
  schema: {
8244
8885
  [k: string]: any;
8245
8886
  };
8887
+ /**
8888
+ * Optional attributes
8889
+ */
8890
+ attributes?: {
8891
+ [k: string]: string;
8892
+ };
8246
8893
  };
8247
8894
  };
8248
8895
  actions?: {
@@ -8270,6 +8917,12 @@ interface ValidateIntegrationCreationRequestBody {
8270
8917
  [k: string]: any;
8271
8918
  };
8272
8919
  };
8920
+ /**
8921
+ * Optional attributes
8922
+ */
8923
+ attributes?: {
8924
+ [k: string]: string;
8925
+ };
8273
8926
  };
8274
8927
  };
8275
8928
  entities?: {
@@ -8595,9 +9248,6 @@ interface UpdateIntegrationRequestBody {
8595
9248
  fallbackHandlerScript?: string | null;
8596
9249
  };
8597
9250
  actions?: {
8598
- /**
8599
- * Action definition
8600
- */
8601
9251
  [k: string]: {
8602
9252
  /**
8603
9253
  * Title of the action
@@ -8619,12 +9269,15 @@ interface UpdateIntegrationRequestBody {
8619
9269
  [k: string]: any;
8620
9270
  };
8621
9271
  };
9272
+ /**
9273
+ * Optional attributes. Set attributes to null to remove them
9274
+ */
9275
+ attributes?: {
9276
+ [k: string]: string | null;
9277
+ };
8622
9278
  } | null;
8623
9279
  };
8624
9280
  events?: {
8625
- /**
8626
- * Event Definition
8627
- */
8628
9281
  [k: string]: {
8629
9282
  /**
8630
9283
  * Title of the event
@@ -8637,6 +9290,12 @@ interface UpdateIntegrationRequestBody {
8637
9290
  schema: {
8638
9291
  [k: string]: any;
8639
9292
  };
9293
+ /**
9294
+ * Optional attributes. Set attributes to null to remove them
9295
+ */
9296
+ attributes?: {
9297
+ [k: string]: string | null;
9298
+ };
8640
9299
  } | null;
8641
9300
  };
8642
9301
  states?: {
@@ -9023,6 +9682,12 @@ interface UpdateIntegrationResponse {
9023
9682
  schema: {
9024
9683
  [k: string]: any;
9025
9684
  };
9685
+ /**
9686
+ * Optional attributes
9687
+ */
9688
+ attributes?: {
9689
+ [k: string]: string;
9690
+ };
9026
9691
  };
9027
9692
  };
9028
9693
  actions: {
@@ -9050,6 +9715,12 @@ interface UpdateIntegrationResponse {
9050
9715
  [k: string]: any;
9051
9716
  };
9052
9717
  };
9718
+ /**
9719
+ * Optional attributes
9720
+ */
9721
+ attributes?: {
9722
+ [k: string]: string;
9723
+ };
9053
9724
  };
9054
9725
  };
9055
9726
  /**
@@ -9268,9 +9939,6 @@ interface ValidateIntegrationUpdateRequestBody {
9268
9939
  fallbackHandlerScript?: string | null;
9269
9940
  };
9270
9941
  actions?: {
9271
- /**
9272
- * Action definition
9273
- */
9274
9942
  [k: string]: {
9275
9943
  /**
9276
9944
  * Title of the action
@@ -9292,12 +9960,15 @@ interface ValidateIntegrationUpdateRequestBody {
9292
9960
  [k: string]: any;
9293
9961
  };
9294
9962
  };
9963
+ /**
9964
+ * Optional attributes. Set attributes to null to remove them
9965
+ */
9966
+ attributes?: {
9967
+ [k: string]: string | null;
9968
+ };
9295
9969
  } | null;
9296
9970
  };
9297
9971
  events?: {
9298
- /**
9299
- * Event Definition
9300
- */
9301
9972
  [k: string]: {
9302
9973
  /**
9303
9974
  * Title of the event
@@ -9310,6 +9981,12 @@ interface ValidateIntegrationUpdateRequestBody {
9310
9981
  schema: {
9311
9982
  [k: string]: any;
9312
9983
  };
9984
+ /**
9985
+ * Optional attributes. Set attributes to null to remove them
9986
+ */
9987
+ attributes?: {
9988
+ [k: string]: string | null;
9989
+ };
9313
9990
  } | null;
9314
9991
  };
9315
9992
  states?: {
@@ -9812,6 +10489,12 @@ interface GetIntegrationResponse {
9812
10489
  schema: {
9813
10490
  [k: string]: any;
9814
10491
  };
10492
+ /**
10493
+ * Optional attributes
10494
+ */
10495
+ attributes?: {
10496
+ [k: string]: string;
10497
+ };
9815
10498
  };
9816
10499
  };
9817
10500
  actions: {
@@ -9839,6 +10522,12 @@ interface GetIntegrationResponse {
9839
10522
  [k: string]: any;
9840
10523
  };
9841
10524
  };
10525
+ /**
10526
+ * Optional attributes
10527
+ */
10528
+ attributes?: {
10529
+ [k: string]: string;
10530
+ };
9842
10531
  };
9843
10532
  };
9844
10533
  /**
@@ -10216,6 +10905,12 @@ interface GetIntegrationByNameResponse {
10216
10905
  schema: {
10217
10906
  [k: string]: any;
10218
10907
  };
10908
+ /**
10909
+ * Optional attributes
10910
+ */
10911
+ attributes?: {
10912
+ [k: string]: string;
10913
+ };
10219
10914
  };
10220
10915
  };
10221
10916
  actions: {
@@ -10243,6 +10938,12 @@ interface GetIntegrationByNameResponse {
10243
10938
  [k: string]: any;
10244
10939
  };
10245
10940
  };
10941
+ /**
10942
+ * Optional attributes
10943
+ */
10944
+ attributes?: {
10945
+ [k: string]: string;
10946
+ };
10246
10947
  };
10247
10948
  };
10248
10949
  /**
@@ -10406,6 +11107,12 @@ interface CreateInterfaceRequestBody {
10406
11107
  schema: {
10407
11108
  [k: string]: any;
10408
11109
  };
11110
+ /**
11111
+ * Optional attributes
11112
+ */
11113
+ attributes?: {
11114
+ [k: string]: string;
11115
+ };
10409
11116
  };
10410
11117
  };
10411
11118
  actions?: {
@@ -10433,6 +11140,12 @@ interface CreateInterfaceRequestBody {
10433
11140
  [k: string]: any;
10434
11141
  };
10435
11142
  };
11143
+ /**
11144
+ * Optional attributes
11145
+ */
11146
+ attributes?: {
11147
+ [k: string]: string;
11148
+ };
10436
11149
  };
10437
11150
  };
10438
11151
  channels?: {
@@ -10464,6 +11177,26 @@ interface CreateInterfaceRequestBody {
10464
11177
  script: string;
10465
11178
  language: string;
10466
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;
10467
11200
  }
10468
11201
  type CreateInterfaceInput = CreateInterfaceRequestBody & CreateInterfaceRequestHeaders & CreateInterfaceRequestQuery & CreateInterfaceRequestParams;
10469
11202
  interface CreateInterfaceResponse {
@@ -10522,6 +11255,12 @@ interface CreateInterfaceResponse {
10522
11255
  schema: {
10523
11256
  [k: string]: any;
10524
11257
  };
11258
+ /**
11259
+ * Optional attributes
11260
+ */
11261
+ attributes?: {
11262
+ [k: string]: string;
11263
+ };
10525
11264
  };
10526
11265
  };
10527
11266
  actions: {
@@ -10549,6 +11288,12 @@ interface CreateInterfaceResponse {
10549
11288
  [k: string]: any;
10550
11289
  };
10551
11290
  };
11291
+ /**
11292
+ * Optional attributes
11293
+ */
11294
+ attributes?: {
11295
+ [k: string]: string;
11296
+ };
10552
11297
  };
10553
11298
  };
10554
11299
  channels: {
@@ -10580,6 +11325,26 @@ interface CreateInterfaceResponse {
10580
11325
  script: string;
10581
11326
  language: string;
10582
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;
10583
11348
  };
10584
11349
  }
10585
11350
 
@@ -10649,6 +11414,12 @@ interface GetInterfaceResponse {
10649
11414
  schema: {
10650
11415
  [k: string]: any;
10651
11416
  };
11417
+ /**
11418
+ * Optional attributes
11419
+ */
11420
+ attributes?: {
11421
+ [k: string]: string;
11422
+ };
10652
11423
  };
10653
11424
  };
10654
11425
  actions: {
@@ -10676,6 +11447,12 @@ interface GetInterfaceResponse {
10676
11447
  [k: string]: any;
10677
11448
  };
10678
11449
  };
11450
+ /**
11451
+ * Optional attributes
11452
+ */
11453
+ attributes?: {
11454
+ [k: string]: string;
11455
+ };
10679
11456
  };
10680
11457
  };
10681
11458
  channels: {
@@ -10707,6 +11484,26 @@ interface GetInterfaceResponse {
10707
11484
  script: string;
10708
11485
  language: string;
10709
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;
10710
11507
  };
10711
11508
  }
10712
11509
 
@@ -10777,6 +11574,12 @@ interface GetInterfaceByNameResponse {
10777
11574
  schema: {
10778
11575
  [k: string]: any;
10779
11576
  };
11577
+ /**
11578
+ * Optional attributes
11579
+ */
11580
+ attributes?: {
11581
+ [k: string]: string;
11582
+ };
10780
11583
  };
10781
11584
  };
10782
11585
  actions: {
@@ -10804,6 +11607,12 @@ interface GetInterfaceByNameResponse {
10804
11607
  [k: string]: any;
10805
11608
  };
10806
11609
  };
11610
+ /**
11611
+ * Optional attributes
11612
+ */
11613
+ attributes?: {
11614
+ [k: string]: string;
11615
+ };
10807
11616
  };
10808
11617
  };
10809
11618
  channels: {
@@ -10835,6 +11644,26 @@ interface GetInterfaceByNameResponse {
10835
11644
  script: string;
10836
11645
  language: string;
10837
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;
10838
11667
  };
10839
11668
  }
10840
11669
 
@@ -10865,9 +11694,6 @@ interface UpdateInterfaceRequestBody {
10865
11694
  } | null;
10866
11695
  };
10867
11696
  events?: {
10868
- /**
10869
- * Event Definition
10870
- */
10871
11697
  [k: string]: {
10872
11698
  /**
10873
11699
  * Title of the event
@@ -10880,12 +11706,15 @@ interface UpdateInterfaceRequestBody {
10880
11706
  schema: {
10881
11707
  [k: string]: any;
10882
11708
  };
11709
+ /**
11710
+ * Optional attributes. Set attributes to null to remove them
11711
+ */
11712
+ attributes?: {
11713
+ [k: string]: string | null;
11714
+ };
10883
11715
  } | null;
10884
11716
  };
10885
11717
  actions?: {
10886
- /**
10887
- * Action definition
10888
- */
10889
11718
  [k: string]: {
10890
11719
  /**
10891
11720
  * Title of the action
@@ -10907,6 +11736,12 @@ interface UpdateInterfaceRequestBody {
10907
11736
  [k: string]: any;
10908
11737
  };
10909
11738
  };
11739
+ /**
11740
+ * Optional attributes. Set attributes to null to remove them
11741
+ */
11742
+ attributes?: {
11743
+ [k: string]: string | null;
11744
+ };
10910
11745
  } | null;
10911
11746
  };
10912
11747
  channels?: {
@@ -10938,6 +11773,26 @@ interface UpdateInterfaceRequestBody {
10938
11773
  script: string;
10939
11774
  language: string;
10940
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;
10941
11796
  }
10942
11797
  type UpdateInterfaceInput = UpdateInterfaceRequestBody & UpdateInterfaceRequestHeaders & UpdateInterfaceRequestQuery & UpdateInterfaceRequestParams;
10943
11798
  interface UpdateInterfaceResponse {
@@ -10996,6 +11851,12 @@ interface UpdateInterfaceResponse {
10996
11851
  schema: {
10997
11852
  [k: string]: any;
10998
11853
  };
11854
+ /**
11855
+ * Optional attributes
11856
+ */
11857
+ attributes?: {
11858
+ [k: string]: string;
11859
+ };
10999
11860
  };
11000
11861
  };
11001
11862
  actions: {
@@ -11023,6 +11884,12 @@ interface UpdateInterfaceResponse {
11023
11884
  [k: string]: any;
11024
11885
  };
11025
11886
  };
11887
+ /**
11888
+ * Optional attributes
11889
+ */
11890
+ attributes?: {
11891
+ [k: string]: string;
11892
+ };
11026
11893
  };
11027
11894
  };
11028
11895
  channels: {
@@ -11054,6 +11921,26 @@ interface UpdateInterfaceResponse {
11054
11921
  script: string;
11055
11922
  language: string;
11056
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;
11057
11944
  };
11058
11945
  }
11059
11946
 
@@ -11103,6 +11990,26 @@ interface ListInterfacesResponse {
11103
11990
  * Version of the [Interface](#schema_interface)
11104
11991
  */
11105
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;
11106
12013
  }[];
11107
12014
  meta: {
11108
12015
  /**
@@ -11180,6 +12087,12 @@ interface CreatePluginRequestBody {
11180
12087
  schema: {
11181
12088
  [k: string]: any;
11182
12089
  };
12090
+ /**
12091
+ * Optional attributes
12092
+ */
12093
+ attributes?: {
12094
+ [k: string]: string;
12095
+ };
11183
12096
  };
11184
12097
  };
11185
12098
  actions?: {
@@ -11207,6 +12120,12 @@ interface CreatePluginRequestBody {
11207
12120
  [k: string]: any;
11208
12121
  };
11209
12122
  };
12123
+ /**
12124
+ * Optional attributes
12125
+ */
12126
+ attributes?: {
12127
+ [k: string]: string;
12128
+ };
11210
12129
  };
11211
12130
  };
11212
12131
  /**
@@ -11368,6 +12287,12 @@ interface CreatePluginResponse {
11368
12287
  schema: {
11369
12288
  [k: string]: any;
11370
12289
  };
12290
+ /**
12291
+ * Optional attributes
12292
+ */
12293
+ attributes?: {
12294
+ [k: string]: string;
12295
+ };
11371
12296
  };
11372
12297
  };
11373
12298
  actions: {
@@ -11395,6 +12320,12 @@ interface CreatePluginResponse {
11395
12320
  [k: string]: any;
11396
12321
  };
11397
12322
  };
12323
+ /**
12324
+ * Optional attributes
12325
+ */
12326
+ attributes?: {
12327
+ [k: string]: string;
12328
+ };
11398
12329
  };
11399
12330
  };
11400
12331
  dependencies: {
@@ -11561,6 +12492,12 @@ interface GetPluginResponse {
11561
12492
  schema: {
11562
12493
  [k: string]: any;
11563
12494
  };
12495
+ /**
12496
+ * Optional attributes
12497
+ */
12498
+ attributes?: {
12499
+ [k: string]: string;
12500
+ };
11564
12501
  };
11565
12502
  };
11566
12503
  actions: {
@@ -11588,6 +12525,12 @@ interface GetPluginResponse {
11588
12525
  [k: string]: any;
11589
12526
  };
11590
12527
  };
12528
+ /**
12529
+ * Optional attributes
12530
+ */
12531
+ attributes?: {
12532
+ [k: string]: string;
12533
+ };
11591
12534
  };
11592
12535
  };
11593
12536
  dependencies: {
@@ -11755,6 +12698,12 @@ interface GetPluginByNameResponse {
11755
12698
  schema: {
11756
12699
  [k: string]: any;
11757
12700
  };
12701
+ /**
12702
+ * Optional attributes
12703
+ */
12704
+ attributes?: {
12705
+ [k: string]: string;
12706
+ };
11758
12707
  };
11759
12708
  };
11760
12709
  actions: {
@@ -11782,6 +12731,12 @@ interface GetPluginByNameResponse {
11782
12731
  [k: string]: any;
11783
12732
  };
11784
12733
  };
12734
+ /**
12735
+ * Optional attributes
12736
+ */
12737
+ attributes?: {
12738
+ [k: string]: string;
12739
+ };
11785
12740
  };
11786
12741
  };
11787
12742
  dependencies: {
@@ -11909,9 +12864,6 @@ interface UpdatePluginRequestBody {
11909
12864
  } | null;
11910
12865
  };
11911
12866
  events?: {
11912
- /**
11913
- * Event Definition
11914
- */
11915
12867
  [k: string]: {
11916
12868
  /**
11917
12869
  * Title of the event
@@ -11924,12 +12876,15 @@ interface UpdatePluginRequestBody {
11924
12876
  schema: {
11925
12877
  [k: string]: any;
11926
12878
  };
12879
+ /**
12880
+ * Optional attributes. Set attributes to null to remove them
12881
+ */
12882
+ attributes?: {
12883
+ [k: string]: string | null;
12884
+ };
11927
12885
  } | null;
11928
12886
  };
11929
12887
  actions?: {
11930
- /**
11931
- * Action definition
11932
- */
11933
12888
  [k: string]: {
11934
12889
  /**
11935
12890
  * Title of the action
@@ -11951,6 +12906,12 @@ interface UpdatePluginRequestBody {
11951
12906
  [k: string]: any;
11952
12907
  };
11953
12908
  };
12909
+ /**
12910
+ * Optional attributes. Set attributes to null to remove them
12911
+ */
12912
+ attributes?: {
12913
+ [k: string]: string | null;
12914
+ };
11954
12915
  } | null;
11955
12916
  };
11956
12917
  user?: {
@@ -12106,6 +13067,12 @@ interface UpdatePluginResponse {
12106
13067
  schema: {
12107
13068
  [k: string]: any;
12108
13069
  };
13070
+ /**
13071
+ * Optional attributes
13072
+ */
13073
+ attributes?: {
13074
+ [k: string]: string;
13075
+ };
12109
13076
  };
12110
13077
  };
12111
13078
  actions: {
@@ -12133,6 +13100,12 @@ interface UpdatePluginResponse {
12133
13100
  [k: string]: any;
12134
13101
  };
12135
13102
  };
13103
+ /**
13104
+ * Optional attributes
13105
+ */
13106
+ attributes?: {
13107
+ [k: string]: string;
13108
+ };
12136
13109
  };
12137
13110
  };
12138
13111
  dependencies: {
@@ -12232,6 +13205,7 @@ interface ListPluginsRequestHeaders {
12232
13205
  interface ListPluginsRequestQuery {
12233
13206
  nextToken?: string;
12234
13207
  name?: string;
13208
+ version?: string;
12235
13209
  }
12236
13210
  interface ListPluginsRequestParams {
12237
13211
  }
@@ -15146,6 +16120,10 @@ declare class Client$1 {
15146
16120
  readonly listPublicIntegrations: (input: ListPublicIntegrationsInput) => Promise<ListPublicIntegrationsResponse>;
15147
16121
  readonly getPublicIntegrationById: (input: GetPublicIntegrationByIdInput) => Promise<GetPublicIntegrationByIdResponse>;
15148
16122
  readonly getPublicIntegration: (input: GetPublicIntegrationInput) => Promise<GetPublicIntegrationResponse>;
16123
+ readonly listPublicPlugins: (input: ListPublicPluginsInput) => Promise<ListPublicPluginsResponse>;
16124
+ readonly getPublicPluginById: (input: GetPublicPluginByIdInput) => Promise<GetPublicPluginByIdResponse>;
16125
+ readonly getPublicPlugin: (input: GetPublicPluginInput) => Promise<GetPublicPluginResponse>;
16126
+ readonly getPublicPluginCode: (input: GetPublicPluginCodeInput) => Promise<GetPublicPluginCodeResponse>;
15149
16127
  readonly createBot: (input: CreateBotInput) => Promise<CreateBotResponse>;
15150
16128
  readonly updateBot: (input: UpdateBotInput) => Promise<UpdateBotResponse>;
15151
16129
  readonly transferBot: (input: TransferBotInput) => Promise<TransferBotResponse>;
@@ -15166,6 +16144,9 @@ declare class Client$1 {
15166
16144
  readonly createIntegrationShareableId: (input: CreateIntegrationShareableIdInput) => Promise<CreateIntegrationShareableIdResponse>;
15167
16145
  readonly deleteIntegrationShareableId: (input: DeleteIntegrationShareableIdInput) => Promise<DeleteIntegrationShareableIdResponse>;
15168
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>;
15169
16150
  readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput) => Promise<ListWorkspaceInvoicesResponse>;
15170
16151
  readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput) => Promise<GetUpcomingInvoiceResponse>;
15171
16152
  readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput) => Promise<ChargeWorkspaceUnpaidInvoicesResponse>;
@@ -15513,6 +16494,11 @@ declare class Client extends Client$1 implements IClient {
15513
16494
  updatedAt: string;
15514
16495
  name: string;
15515
16496
  version: string;
16497
+ title: string;
16498
+ description: string;
16499
+ iconUrl: string;
16500
+ readmeUrl: string;
16501
+ public: boolean;
15516
16502
  }>;
15517
16503
  activities: (props: {
15518
16504
  botId: string;