@botpress/client 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.
- package/dist/bundle.cjs +11 -11
- package/dist/bundle.cjs.map +4 -4
- package/dist/index.cjs +3 -3
- package/dist/index.cjs.map +4 -4
- package/dist/index.d.ts +2101 -1161
- package/dist/index.mjs +3 -3
- package/dist/index.mjs.map +4 -4
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -4029,276 +4029,197 @@ interface GetPublicIntegrationResponse$1 {
|
|
|
4029
4029
|
};
|
|
4030
4030
|
}
|
|
4031
4031
|
|
|
4032
|
-
interface
|
|
4032
|
+
interface ListPublicPluginsRequestHeaders$1 {
|
|
4033
4033
|
}
|
|
4034
|
-
interface
|
|
4034
|
+
interface ListPublicPluginsRequestQuery$1 {
|
|
4035
|
+
nextToken?: string;
|
|
4036
|
+
name?: string;
|
|
4037
|
+
version?: string;
|
|
4035
4038
|
}
|
|
4036
|
-
interface
|
|
4039
|
+
interface ListPublicPluginsRequestParams$1 {
|
|
4037
4040
|
}
|
|
4038
|
-
interface
|
|
4039
|
-
|
|
4040
|
-
|
|
4041
|
-
|
|
4042
|
-
|
|
4043
|
-
[k: string]: {
|
|
4044
|
-
/**
|
|
4045
|
-
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
4046
|
-
*/
|
|
4047
|
-
type: "conversation" | "user" | "bot" | "task";
|
|
4048
|
-
/**
|
|
4049
|
-
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
4050
|
-
*/
|
|
4051
|
-
schema: {
|
|
4052
|
-
[k: string]: any;
|
|
4053
|
-
};
|
|
4054
|
-
/**
|
|
4055
|
-
* 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.
|
|
4056
|
-
*/
|
|
4057
|
-
expiry?: number;
|
|
4058
|
-
};
|
|
4059
|
-
};
|
|
4060
|
-
/**
|
|
4061
|
-
* Events definition
|
|
4062
|
-
*/
|
|
4063
|
-
events?: {
|
|
4041
|
+
interface ListPublicPluginsRequestBody$1 {
|
|
4042
|
+
}
|
|
4043
|
+
type ListPublicPluginsInput$1 = ListPublicPluginsRequestBody$1 & ListPublicPluginsRequestHeaders$1 & ListPublicPluginsRequestQuery$1 & ListPublicPluginsRequestParams$1;
|
|
4044
|
+
interface ListPublicPluginsResponse$1 {
|
|
4045
|
+
plugins: {
|
|
4064
4046
|
/**
|
|
4065
|
-
*
|
|
4047
|
+
* ID of the [Plugin](#schema_plugin)
|
|
4066
4048
|
*/
|
|
4067
|
-
|
|
4068
|
-
/**
|
|
4069
|
-
* Title of the event
|
|
4070
|
-
*/
|
|
4071
|
-
title?: string;
|
|
4072
|
-
/**
|
|
4073
|
-
* Description of the event
|
|
4074
|
-
*/
|
|
4075
|
-
description?: string;
|
|
4076
|
-
schema: {
|
|
4077
|
-
[k: string]: any;
|
|
4078
|
-
};
|
|
4079
|
-
};
|
|
4080
|
-
};
|
|
4081
|
-
recurringEvents?: {
|
|
4082
|
-
[k: string]: {
|
|
4083
|
-
schedule: {
|
|
4084
|
-
cron: string;
|
|
4085
|
-
};
|
|
4086
|
-
type: string;
|
|
4087
|
-
payload: {
|
|
4088
|
-
[k: string]: any;
|
|
4089
|
-
};
|
|
4090
|
-
};
|
|
4091
|
-
};
|
|
4092
|
-
/**
|
|
4093
|
-
* Subscriptions of the bot
|
|
4094
|
-
*/
|
|
4095
|
-
subscriptions?: {
|
|
4049
|
+
id: string;
|
|
4096
4050
|
/**
|
|
4097
|
-
*
|
|
4051
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
4098
4052
|
*/
|
|
4099
|
-
|
|
4100
|
-
|
|
4101
|
-
|
|
4053
|
+
createdAt: string;
|
|
4054
|
+
/**
|
|
4055
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
4056
|
+
*/
|
|
4057
|
+
updatedAt: string;
|
|
4058
|
+
/**
|
|
4059
|
+
* Name of the [Plugin](#schema_plugin)
|
|
4060
|
+
*/
|
|
4061
|
+
name: string;
|
|
4062
|
+
/**
|
|
4063
|
+
* Version of the [Plugin](#schema_plugin)
|
|
4064
|
+
*/
|
|
4065
|
+
version: string;
|
|
4066
|
+
/**
|
|
4067
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
4068
|
+
*/
|
|
4069
|
+
title: string;
|
|
4070
|
+
/**
|
|
4071
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
4072
|
+
*/
|
|
4073
|
+
description: string;
|
|
4074
|
+
/**
|
|
4075
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
4076
|
+
*/
|
|
4077
|
+
iconUrl: string;
|
|
4078
|
+
/**
|
|
4079
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
4080
|
+
*/
|
|
4081
|
+
readmeUrl: string;
|
|
4082
|
+
/**
|
|
4083
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
4084
|
+
*/
|
|
4085
|
+
public: boolean;
|
|
4086
|
+
}[];
|
|
4087
|
+
meta: {
|
|
4088
|
+
/**
|
|
4089
|
+
* 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.
|
|
4090
|
+
*/
|
|
4091
|
+
nextToken?: string;
|
|
4102
4092
|
};
|
|
4103
|
-
|
|
4104
|
-
|
|
4105
|
-
|
|
4106
|
-
|
|
4093
|
+
}
|
|
4094
|
+
|
|
4095
|
+
interface GetPublicPluginByIdRequestHeaders$1 {
|
|
4096
|
+
}
|
|
4097
|
+
interface GetPublicPluginByIdRequestQuery$1 {
|
|
4098
|
+
}
|
|
4099
|
+
interface GetPublicPluginByIdRequestParams$1 {
|
|
4100
|
+
id: string;
|
|
4101
|
+
}
|
|
4102
|
+
interface GetPublicPluginByIdRequestBody$1 {
|
|
4103
|
+
}
|
|
4104
|
+
type GetPublicPluginByIdInput$1 = GetPublicPluginByIdRequestBody$1 & GetPublicPluginByIdRequestHeaders$1 & GetPublicPluginByIdRequestQuery$1 & GetPublicPluginByIdRequestParams$1;
|
|
4105
|
+
interface GetPublicPluginByIdResponse$1 {
|
|
4106
|
+
plugin: {
|
|
4107
4107
|
/**
|
|
4108
|
-
*
|
|
4108
|
+
* ID of the [Plugin](#schema_plugin)
|
|
4109
4109
|
*/
|
|
4110
|
-
|
|
4110
|
+
id: string;
|
|
4111
|
+
/**
|
|
4112
|
+
* Name of the [Plugin](#schema_plugin)
|
|
4113
|
+
*/
|
|
4114
|
+
name: string;
|
|
4115
|
+
/**
|
|
4116
|
+
* Version of the [Plugin](#schema_plugin)
|
|
4117
|
+
*/
|
|
4118
|
+
version: string;
|
|
4119
|
+
/**
|
|
4120
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
4121
|
+
*/
|
|
4122
|
+
createdAt: string;
|
|
4123
|
+
/**
|
|
4124
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
4125
|
+
*/
|
|
4126
|
+
updatedAt: string;
|
|
4127
|
+
/**
|
|
4128
|
+
* Configuration definition
|
|
4129
|
+
*/
|
|
4130
|
+
configuration: {
|
|
4111
4131
|
/**
|
|
4112
|
-
* Title of the
|
|
4132
|
+
* Title of the configuration
|
|
4113
4133
|
*/
|
|
4114
4134
|
title?: string;
|
|
4115
4135
|
/**
|
|
4116
|
-
* Description of the
|
|
4136
|
+
* Description of the configuration
|
|
4117
4137
|
*/
|
|
4118
4138
|
description?: string;
|
|
4119
|
-
billable?: boolean;
|
|
4120
|
-
cacheable?: boolean;
|
|
4121
|
-
input: {
|
|
4122
|
-
schema: {
|
|
4123
|
-
[k: string]: any;
|
|
4124
|
-
};
|
|
4125
|
-
};
|
|
4126
|
-
output: {
|
|
4127
|
-
schema: {
|
|
4128
|
-
[k: string]: any;
|
|
4129
|
-
};
|
|
4130
|
-
};
|
|
4131
|
-
};
|
|
4132
|
-
};
|
|
4133
|
-
configuration?: {
|
|
4134
|
-
/**
|
|
4135
|
-
* Configuration data
|
|
4136
|
-
*/
|
|
4137
|
-
data?: {
|
|
4138
|
-
[k: string]: any;
|
|
4139
|
-
};
|
|
4140
|
-
/**
|
|
4141
|
-
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
4142
|
-
*/
|
|
4143
|
-
schema?: {
|
|
4144
|
-
[k: string]: any;
|
|
4145
|
-
};
|
|
4146
|
-
};
|
|
4147
|
-
user?: {
|
|
4148
|
-
tags?: {
|
|
4149
4139
|
/**
|
|
4150
|
-
*
|
|
4140
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
4151
4141
|
*/
|
|
4142
|
+
schema: {
|
|
4143
|
+
[k: string]: any;
|
|
4144
|
+
};
|
|
4145
|
+
};
|
|
4146
|
+
states: {
|
|
4152
4147
|
[k: string]: {
|
|
4153
4148
|
/**
|
|
4154
|
-
*
|
|
4149
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
4155
4150
|
*/
|
|
4156
|
-
|
|
4151
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
4157
4152
|
/**
|
|
4158
|
-
*
|
|
4153
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
4159
4154
|
*/
|
|
4160
|
-
|
|
4155
|
+
schema: {
|
|
4156
|
+
[k: string]: any;
|
|
4157
|
+
};
|
|
4158
|
+
/**
|
|
4159
|
+
* 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.
|
|
4160
|
+
*/
|
|
4161
|
+
expiry?: number;
|
|
4161
4162
|
};
|
|
4162
4163
|
};
|
|
4163
|
-
|
|
4164
|
-
conversation?: {
|
|
4165
|
-
tags?: {
|
|
4164
|
+
events: {
|
|
4166
4165
|
/**
|
|
4167
|
-
* Definition
|
|
4166
|
+
* Event Definition
|
|
4168
4167
|
*/
|
|
4169
4168
|
[k: string]: {
|
|
4170
4169
|
/**
|
|
4171
|
-
* Title of the
|
|
4170
|
+
* Title of the event
|
|
4172
4171
|
*/
|
|
4173
4172
|
title?: string;
|
|
4174
4173
|
/**
|
|
4175
|
-
* Description of the
|
|
4174
|
+
* Description of the event
|
|
4176
4175
|
*/
|
|
4177
4176
|
description?: string;
|
|
4177
|
+
schema: {
|
|
4178
|
+
[k: string]: any;
|
|
4179
|
+
};
|
|
4178
4180
|
};
|
|
4179
4181
|
};
|
|
4180
|
-
|
|
4181
|
-
message?: {
|
|
4182
|
-
tags?: {
|
|
4182
|
+
actions: {
|
|
4183
4183
|
/**
|
|
4184
|
-
*
|
|
4184
|
+
* Action definition
|
|
4185
4185
|
*/
|
|
4186
4186
|
[k: string]: {
|
|
4187
4187
|
/**
|
|
4188
|
-
* Title of the
|
|
4188
|
+
* Title of the action
|
|
4189
4189
|
*/
|
|
4190
4190
|
title?: string;
|
|
4191
4191
|
/**
|
|
4192
|
-
* Description of the
|
|
4192
|
+
* Description of the action
|
|
4193
4193
|
*/
|
|
4194
4194
|
description?: string;
|
|
4195
|
+
billable?: boolean;
|
|
4196
|
+
cacheable?: boolean;
|
|
4197
|
+
input: {
|
|
4198
|
+
schema: {
|
|
4199
|
+
[k: string]: any;
|
|
4200
|
+
};
|
|
4201
|
+
};
|
|
4202
|
+
output: {
|
|
4203
|
+
schema: {
|
|
4204
|
+
[k: string]: any;
|
|
4205
|
+
};
|
|
4206
|
+
};
|
|
4195
4207
|
};
|
|
4196
4208
|
};
|
|
4197
|
-
|
|
4198
|
-
|
|
4199
|
-
|
|
4200
|
-
|
|
4201
|
-
|
|
4202
|
-
|
|
4203
|
-
|
|
4204
|
-
|
|
4205
|
-
|
|
4206
|
-
|
|
4207
|
-
|
|
4208
|
-
|
|
4209
|
-
|
|
4210
|
-
*/
|
|
4211
|
-
name?: string;
|
|
4212
|
-
/**
|
|
4213
|
-
* Media files associated with the [Bot](#schema_bot)
|
|
4214
|
-
*/
|
|
4215
|
-
medias?: {
|
|
4216
|
-
url: string;
|
|
4217
|
-
name: string;
|
|
4218
|
-
}[];
|
|
4219
|
-
/**
|
|
4220
|
-
* URL of the [Bot](#schema_bot); Only available for dev bots
|
|
4221
|
-
*/
|
|
4222
|
-
url?: string;
|
|
4223
|
-
/**
|
|
4224
|
-
* Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
|
|
4225
|
-
*/
|
|
4226
|
-
dev?: boolean;
|
|
4227
|
-
}
|
|
4228
|
-
type CreateBotInput$1 = CreateBotRequestBody$1 & CreateBotRequestHeaders$1 & CreateBotRequestQuery$1 & CreateBotRequestParams$1;
|
|
4229
|
-
interface CreateBotResponse$1 {
|
|
4230
|
-
bot: {
|
|
4231
|
-
/**
|
|
4232
|
-
* Id of the [Bot](#schema_bot)
|
|
4233
|
-
*/
|
|
4234
|
-
id: string;
|
|
4235
|
-
/**
|
|
4236
|
-
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
4237
|
-
*/
|
|
4238
|
-
createdAt: string;
|
|
4239
|
-
/**
|
|
4240
|
-
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
4241
|
-
*/
|
|
4242
|
-
updatedAt: string;
|
|
4243
|
-
/**
|
|
4244
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
4245
|
-
*/
|
|
4246
|
-
signingSecret: string;
|
|
4247
|
-
/**
|
|
4248
|
-
* A mapping of integrations to their configuration
|
|
4249
|
-
*/
|
|
4250
|
-
integrations: {
|
|
4251
|
-
[k: string]: {
|
|
4252
|
-
enabled: boolean;
|
|
4253
|
-
/**
|
|
4254
|
-
* Name of the [Integration](#schema_integration)
|
|
4255
|
-
*/
|
|
4256
|
-
name: string;
|
|
4257
|
-
/**
|
|
4258
|
-
* Version of the [Integration](#schema_integration)
|
|
4259
|
-
*/
|
|
4260
|
-
version: string;
|
|
4261
|
-
webhookUrl: string;
|
|
4262
|
-
webhookId: string;
|
|
4263
|
-
identifier?: string;
|
|
4264
|
-
configurationType: string | null;
|
|
4265
|
-
configuration: {
|
|
4266
|
-
[k: string]: any;
|
|
4209
|
+
dependencies: {
|
|
4210
|
+
interfaces: {
|
|
4211
|
+
[k: string]: {
|
|
4212
|
+
id: string;
|
|
4213
|
+
name: string;
|
|
4214
|
+
version: string;
|
|
4215
|
+
};
|
|
4216
|
+
};
|
|
4217
|
+
integrations: {
|
|
4218
|
+
[k: string]: {
|
|
4219
|
+
id: string;
|
|
4220
|
+
name: string;
|
|
4221
|
+
version: string;
|
|
4267
4222
|
};
|
|
4268
|
-
status: "registration_pending" | "registered" | "registration_failed" | "unregistration_pending" | "unregistered" | "unregistration_failed";
|
|
4269
|
-
statusReason: string | null;
|
|
4270
|
-
/**
|
|
4271
|
-
* ID of the [Integration](#schema_integration)
|
|
4272
|
-
*/
|
|
4273
|
-
id: string;
|
|
4274
|
-
/**
|
|
4275
|
-
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
4276
|
-
*/
|
|
4277
|
-
createdAt: string;
|
|
4278
|
-
/**
|
|
4279
|
-
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
4280
|
-
*/
|
|
4281
|
-
updatedAt: string;
|
|
4282
|
-
/**
|
|
4283
|
-
* Title of the integration. This is the name that will be displayed in the UI
|
|
4284
|
-
*/
|
|
4285
|
-
title: string;
|
|
4286
|
-
/**
|
|
4287
|
-
* Description of the integration. This is the description that will be displayed in the UI
|
|
4288
|
-
*/
|
|
4289
|
-
description: string;
|
|
4290
|
-
/**
|
|
4291
|
-
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
4292
|
-
*/
|
|
4293
|
-
iconUrl: string;
|
|
4294
|
-
/**
|
|
4295
|
-
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
4296
|
-
*/
|
|
4297
|
-
public: boolean;
|
|
4298
|
-
/**
|
|
4299
|
-
* Status of the integration version verification
|
|
4300
|
-
*/
|
|
4301
|
-
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
4302
4223
|
};
|
|
4303
4224
|
};
|
|
4304
4225
|
/**
|
|
@@ -4342,28 +4263,80 @@ interface CreateBotResponse$1 {
|
|
|
4342
4263
|
};
|
|
4343
4264
|
};
|
|
4344
4265
|
/**
|
|
4345
|
-
*
|
|
4266
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
4346
4267
|
*/
|
|
4347
|
-
|
|
4348
|
-
tags: {
|
|
4349
|
-
/**
|
|
4350
|
-
* Definition of a tag that can be provided on the object
|
|
4351
|
-
*/
|
|
4352
|
-
[k: string]: {
|
|
4353
|
-
/**
|
|
4354
|
-
* Title of the tag
|
|
4355
|
-
*/
|
|
4356
|
-
title?: string;
|
|
4357
|
-
/**
|
|
4358
|
-
* Description of the tag
|
|
4359
|
-
*/
|
|
4360
|
-
description?: string;
|
|
4361
|
-
};
|
|
4362
|
-
};
|
|
4363
|
-
};
|
|
4268
|
+
title: string;
|
|
4364
4269
|
/**
|
|
4365
|
-
*
|
|
4270
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
4271
|
+
*/
|
|
4272
|
+
description: string;
|
|
4273
|
+
/**
|
|
4274
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
4275
|
+
*/
|
|
4276
|
+
iconUrl: string;
|
|
4277
|
+
/**
|
|
4278
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
4279
|
+
*/
|
|
4280
|
+
readmeUrl: string;
|
|
4281
|
+
/**
|
|
4282
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
4283
|
+
*/
|
|
4284
|
+
public: boolean;
|
|
4285
|
+
};
|
|
4286
|
+
}
|
|
4287
|
+
|
|
4288
|
+
interface GetPublicPluginRequestHeaders$1 {
|
|
4289
|
+
}
|
|
4290
|
+
interface GetPublicPluginRequestQuery$1 {
|
|
4291
|
+
}
|
|
4292
|
+
interface GetPublicPluginRequestParams$1 {
|
|
4293
|
+
name: string;
|
|
4294
|
+
version: string;
|
|
4295
|
+
}
|
|
4296
|
+
interface GetPublicPluginRequestBody$1 {
|
|
4297
|
+
}
|
|
4298
|
+
type GetPublicPluginInput$1 = GetPublicPluginRequestBody$1 & GetPublicPluginRequestHeaders$1 & GetPublicPluginRequestQuery$1 & GetPublicPluginRequestParams$1;
|
|
4299
|
+
interface GetPublicPluginResponse$1 {
|
|
4300
|
+
plugin: {
|
|
4301
|
+
/**
|
|
4302
|
+
* ID of the [Plugin](#schema_plugin)
|
|
4303
|
+
*/
|
|
4304
|
+
id: string;
|
|
4305
|
+
/**
|
|
4306
|
+
* Name of the [Plugin](#schema_plugin)
|
|
4307
|
+
*/
|
|
4308
|
+
name: string;
|
|
4309
|
+
/**
|
|
4310
|
+
* Version of the [Plugin](#schema_plugin)
|
|
4311
|
+
*/
|
|
4312
|
+
version: string;
|
|
4313
|
+
/**
|
|
4314
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
4315
|
+
*/
|
|
4316
|
+
createdAt: string;
|
|
4317
|
+
/**
|
|
4318
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
4319
|
+
*/
|
|
4320
|
+
updatedAt: string;
|
|
4321
|
+
/**
|
|
4322
|
+
* Configuration definition
|
|
4366
4323
|
*/
|
|
4324
|
+
configuration: {
|
|
4325
|
+
/**
|
|
4326
|
+
* Title of the configuration
|
|
4327
|
+
*/
|
|
4328
|
+
title?: string;
|
|
4329
|
+
/**
|
|
4330
|
+
* Description of the configuration
|
|
4331
|
+
*/
|
|
4332
|
+
description?: string;
|
|
4333
|
+
/**
|
|
4334
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
4335
|
+
*/
|
|
4336
|
+
schema: {
|
|
4337
|
+
[k: string]: any;
|
|
4338
|
+
};
|
|
4339
|
+
};
|
|
4367
4340
|
states: {
|
|
4368
4341
|
[k: string]: {
|
|
4369
4342
|
/**
|
|
@@ -4382,26 +4355,6 @@ interface CreateBotResponse$1 {
|
|
|
4382
4355
|
expiry?: number;
|
|
4383
4356
|
};
|
|
4384
4357
|
};
|
|
4385
|
-
/**
|
|
4386
|
-
* Configuration of the bot
|
|
4387
|
-
*/
|
|
4388
|
-
configuration: {
|
|
4389
|
-
/**
|
|
4390
|
-
* Configuration data
|
|
4391
|
-
*/
|
|
4392
|
-
data: {
|
|
4393
|
-
[k: string]: any;
|
|
4394
|
-
};
|
|
4395
|
-
/**
|
|
4396
|
-
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
4397
|
-
*/
|
|
4398
|
-
schema: {
|
|
4399
|
-
[k: string]: any;
|
|
4400
|
-
};
|
|
4401
|
-
};
|
|
4402
|
-
/**
|
|
4403
|
-
* Events definition
|
|
4404
|
-
*/
|
|
4405
4358
|
events: {
|
|
4406
4359
|
/**
|
|
4407
4360
|
* Event Definition
|
|
@@ -4420,42 +4373,6 @@ interface CreateBotResponse$1 {
|
|
|
4420
4373
|
};
|
|
4421
4374
|
};
|
|
4422
4375
|
};
|
|
4423
|
-
/**
|
|
4424
|
-
* Recurring events
|
|
4425
|
-
*/
|
|
4426
|
-
recurringEvents: {
|
|
4427
|
-
[k: string]: {
|
|
4428
|
-
schedule: {
|
|
4429
|
-
cron: string;
|
|
4430
|
-
};
|
|
4431
|
-
type: string;
|
|
4432
|
-
payload: {
|
|
4433
|
-
[k: string]: any;
|
|
4434
|
-
};
|
|
4435
|
-
/**
|
|
4436
|
-
* The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully.
|
|
4437
|
-
*/
|
|
4438
|
-
failedAttempts: number;
|
|
4439
|
-
/**
|
|
4440
|
-
* The reason why the recurring event failed to run in the last attempt.
|
|
4441
|
-
*/
|
|
4442
|
-
lastFailureReason: string | null;
|
|
4443
|
-
};
|
|
4444
|
-
};
|
|
4445
|
-
/**
|
|
4446
|
-
* Subscriptions of the bot
|
|
4447
|
-
*/
|
|
4448
|
-
subscriptions: {
|
|
4449
|
-
/**
|
|
4450
|
-
* Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
|
|
4451
|
-
*/
|
|
4452
|
-
events: {
|
|
4453
|
-
[k: string]: {};
|
|
4454
|
-
} | null;
|
|
4455
|
-
};
|
|
4456
|
-
/**
|
|
4457
|
-
* Actions definition
|
|
4458
|
-
*/
|
|
4459
4376
|
actions: {
|
|
4460
4377
|
/**
|
|
4461
4378
|
* Action definition
|
|
@@ -4483,68 +4400,201 @@ interface CreateBotResponse$1 {
|
|
|
4483
4400
|
};
|
|
4484
4401
|
};
|
|
4485
4402
|
};
|
|
4403
|
+
dependencies: {
|
|
4404
|
+
interfaces: {
|
|
4405
|
+
[k: string]: {
|
|
4406
|
+
id: string;
|
|
4407
|
+
name: string;
|
|
4408
|
+
version: string;
|
|
4409
|
+
};
|
|
4410
|
+
};
|
|
4411
|
+
integrations: {
|
|
4412
|
+
[k: string]: {
|
|
4413
|
+
id: string;
|
|
4414
|
+
name: string;
|
|
4415
|
+
version: string;
|
|
4416
|
+
};
|
|
4417
|
+
};
|
|
4418
|
+
};
|
|
4486
4419
|
/**
|
|
4487
|
-
*
|
|
4420
|
+
* User object configuration
|
|
4488
4421
|
*/
|
|
4489
|
-
|
|
4490
|
-
|
|
4422
|
+
user: {
|
|
4423
|
+
tags: {
|
|
4424
|
+
/**
|
|
4425
|
+
* Definition of a tag that can be provided on the object
|
|
4426
|
+
*/
|
|
4427
|
+
[k: string]: {
|
|
4428
|
+
/**
|
|
4429
|
+
* Title of the tag
|
|
4430
|
+
*/
|
|
4431
|
+
title?: string;
|
|
4432
|
+
/**
|
|
4433
|
+
* Description of the tag
|
|
4434
|
+
*/
|
|
4435
|
+
description?: string;
|
|
4436
|
+
};
|
|
4437
|
+
};
|
|
4491
4438
|
};
|
|
4492
4439
|
/**
|
|
4493
|
-
*
|
|
4494
|
-
*/
|
|
4495
|
-
name: string;
|
|
4496
|
-
/**
|
|
4497
|
-
* Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
|
|
4440
|
+
* Conversation object configuration
|
|
4498
4441
|
*/
|
|
4499
|
-
|
|
4442
|
+
conversation: {
|
|
4443
|
+
tags: {
|
|
4444
|
+
/**
|
|
4445
|
+
* Definition of a tag that can be provided on the object
|
|
4446
|
+
*/
|
|
4447
|
+
[k: string]: {
|
|
4448
|
+
/**
|
|
4449
|
+
* Title of the tag
|
|
4450
|
+
*/
|
|
4451
|
+
title?: string;
|
|
4452
|
+
/**
|
|
4453
|
+
* Description of the tag
|
|
4454
|
+
*/
|
|
4455
|
+
description?: string;
|
|
4456
|
+
};
|
|
4457
|
+
};
|
|
4458
|
+
};
|
|
4500
4459
|
/**
|
|
4501
|
-
*
|
|
4460
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
4502
4461
|
*/
|
|
4503
|
-
|
|
4462
|
+
title: string;
|
|
4504
4463
|
/**
|
|
4505
|
-
*
|
|
4464
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
4506
4465
|
*/
|
|
4507
|
-
|
|
4466
|
+
description: string;
|
|
4508
4467
|
/**
|
|
4509
|
-
*
|
|
4468
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
4510
4469
|
*/
|
|
4511
|
-
|
|
4470
|
+
iconUrl: string;
|
|
4512
4471
|
/**
|
|
4513
|
-
*
|
|
4472
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
4514
4473
|
*/
|
|
4515
|
-
|
|
4474
|
+
readmeUrl: string;
|
|
4516
4475
|
/**
|
|
4517
|
-
*
|
|
4476
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
4518
4477
|
*/
|
|
4519
|
-
|
|
4520
|
-
/**
|
|
4521
|
-
* URL of the media file
|
|
4522
|
-
*/
|
|
4523
|
-
url: string;
|
|
4524
|
-
/**
|
|
4525
|
-
* Name of the media file
|
|
4526
|
-
*/
|
|
4527
|
-
name: string;
|
|
4528
|
-
}[];
|
|
4478
|
+
public: boolean;
|
|
4529
4479
|
};
|
|
4530
4480
|
}
|
|
4531
4481
|
|
|
4532
|
-
interface
|
|
4482
|
+
interface GetPublicPluginCodeRequestHeaders$1 {
|
|
4533
4483
|
}
|
|
4534
|
-
interface
|
|
4484
|
+
interface GetPublicPluginCodeRequestQuery$1 {
|
|
4535
4485
|
}
|
|
4536
|
-
interface
|
|
4486
|
+
interface GetPublicPluginCodeRequestParams$1 {
|
|
4537
4487
|
id: string;
|
|
4488
|
+
platform: "node" | "browser";
|
|
4538
4489
|
}
|
|
4539
|
-
interface
|
|
4490
|
+
interface GetPublicPluginCodeRequestBody$1 {
|
|
4491
|
+
}
|
|
4492
|
+
type GetPublicPluginCodeInput$1 = GetPublicPluginCodeRequestBody$1 & GetPublicPluginCodeRequestHeaders$1 & GetPublicPluginCodeRequestQuery$1 & GetPublicPluginCodeRequestParams$1;
|
|
4493
|
+
interface GetPublicPluginCodeResponse$1 {
|
|
4494
|
+
code: string;
|
|
4495
|
+
}
|
|
4496
|
+
|
|
4497
|
+
interface CreateBotRequestHeaders$1 {
|
|
4498
|
+
}
|
|
4499
|
+
interface CreateBotRequestQuery$1 {
|
|
4500
|
+
}
|
|
4501
|
+
interface CreateBotRequestParams$1 {
|
|
4502
|
+
}
|
|
4503
|
+
interface CreateBotRequestBody$1 {
|
|
4540
4504
|
/**
|
|
4541
|
-
*
|
|
4505
|
+
* A mapping of states to their definition
|
|
4542
4506
|
*/
|
|
4543
|
-
|
|
4507
|
+
states?: {
|
|
4508
|
+
[k: string]: {
|
|
4509
|
+
/**
|
|
4510
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
4511
|
+
*/
|
|
4512
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
4513
|
+
/**
|
|
4514
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
4515
|
+
*/
|
|
4516
|
+
schema: {
|
|
4517
|
+
[k: string]: any;
|
|
4518
|
+
};
|
|
4519
|
+
/**
|
|
4520
|
+
* 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.
|
|
4521
|
+
*/
|
|
4522
|
+
expiry?: number;
|
|
4523
|
+
};
|
|
4524
|
+
};
|
|
4544
4525
|
/**
|
|
4545
|
-
*
|
|
4526
|
+
* Events definition
|
|
4546
4527
|
*/
|
|
4547
|
-
|
|
4528
|
+
events?: {
|
|
4529
|
+
/**
|
|
4530
|
+
* Event Definition
|
|
4531
|
+
*/
|
|
4532
|
+
[k: string]: {
|
|
4533
|
+
/**
|
|
4534
|
+
* Title of the event
|
|
4535
|
+
*/
|
|
4536
|
+
title?: string;
|
|
4537
|
+
/**
|
|
4538
|
+
* Description of the event
|
|
4539
|
+
*/
|
|
4540
|
+
description?: string;
|
|
4541
|
+
schema: {
|
|
4542
|
+
[k: string]: any;
|
|
4543
|
+
};
|
|
4544
|
+
};
|
|
4545
|
+
};
|
|
4546
|
+
recurringEvents?: {
|
|
4547
|
+
[k: string]: {
|
|
4548
|
+
schedule: {
|
|
4549
|
+
cron: string;
|
|
4550
|
+
};
|
|
4551
|
+
type: string;
|
|
4552
|
+
payload: {
|
|
4553
|
+
[k: string]: any;
|
|
4554
|
+
};
|
|
4555
|
+
};
|
|
4556
|
+
};
|
|
4557
|
+
/**
|
|
4558
|
+
* Subscriptions of the bot
|
|
4559
|
+
*/
|
|
4560
|
+
subscriptions?: {
|
|
4561
|
+
/**
|
|
4562
|
+
* Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
|
|
4563
|
+
*/
|
|
4564
|
+
events: {
|
|
4565
|
+
[k: string]: {};
|
|
4566
|
+
} | null;
|
|
4567
|
+
};
|
|
4568
|
+
/**
|
|
4569
|
+
* Actions definition
|
|
4570
|
+
*/
|
|
4571
|
+
actions?: {
|
|
4572
|
+
/**
|
|
4573
|
+
* Action definition
|
|
4574
|
+
*/
|
|
4575
|
+
[k: string]: {
|
|
4576
|
+
/**
|
|
4577
|
+
* Title of the action
|
|
4578
|
+
*/
|
|
4579
|
+
title?: string;
|
|
4580
|
+
/**
|
|
4581
|
+
* Description of the action
|
|
4582
|
+
*/
|
|
4583
|
+
description?: string;
|
|
4584
|
+
billable?: boolean;
|
|
4585
|
+
cacheable?: boolean;
|
|
4586
|
+
input: {
|
|
4587
|
+
schema: {
|
|
4588
|
+
[k: string]: any;
|
|
4589
|
+
};
|
|
4590
|
+
};
|
|
4591
|
+
output: {
|
|
4592
|
+
schema: {
|
|
4593
|
+
[k: string]: any;
|
|
4594
|
+
};
|
|
4595
|
+
};
|
|
4596
|
+
};
|
|
4597
|
+
};
|
|
4548
4598
|
configuration?: {
|
|
4549
4599
|
/**
|
|
4550
4600
|
* Configuration data
|
|
@@ -4559,17 +4609,6 @@ interface UpdateBotRequestBody$1 {
|
|
|
4559
4609
|
[k: string]: any;
|
|
4560
4610
|
};
|
|
4561
4611
|
};
|
|
4562
|
-
/**
|
|
4563
|
-
* Tags of the [Bot](#schema_bot)
|
|
4564
|
-
*/
|
|
4565
|
-
tags?: {
|
|
4566
|
-
[k: string]: string;
|
|
4567
|
-
};
|
|
4568
|
-
blocked?: boolean;
|
|
4569
|
-
/**
|
|
4570
|
-
* Indicates if the [Bot](#schema_bot) should be in always alive mode
|
|
4571
|
-
*/
|
|
4572
|
-
alwaysAlive?: boolean;
|
|
4573
4612
|
user?: {
|
|
4574
4613
|
tags?: {
|
|
4575
4614
|
/**
|
|
@@ -4584,10 +4623,10 @@ interface UpdateBotRequestBody$1 {
|
|
|
4584
4623
|
* Description of the tag
|
|
4585
4624
|
*/
|
|
4586
4625
|
description?: string;
|
|
4587
|
-
}
|
|
4626
|
+
};
|
|
4588
4627
|
};
|
|
4589
4628
|
};
|
|
4590
|
-
|
|
4629
|
+
conversation?: {
|
|
4591
4630
|
tags?: {
|
|
4592
4631
|
/**
|
|
4593
4632
|
* Definition of a tag that can be provided on the object
|
|
@@ -4601,10 +4640,10 @@ interface UpdateBotRequestBody$1 {
|
|
|
4601
4640
|
* Description of the tag
|
|
4602
4641
|
*/
|
|
4603
4642
|
description?: string;
|
|
4604
|
-
}
|
|
4643
|
+
};
|
|
4605
4644
|
};
|
|
4606
4645
|
};
|
|
4607
|
-
|
|
4646
|
+
message?: {
|
|
4608
4647
|
tags?: {
|
|
4609
4648
|
/**
|
|
4610
4649
|
* Definition of a tag that can be provided on the object
|
|
@@ -4618,126 +4657,48 @@ interface UpdateBotRequestBody$1 {
|
|
|
4618
4657
|
* Description of the tag
|
|
4619
4658
|
*/
|
|
4620
4659
|
description?: string;
|
|
4621
|
-
}
|
|
4660
|
+
};
|
|
4622
4661
|
};
|
|
4623
4662
|
};
|
|
4624
|
-
|
|
4663
|
+
/**
|
|
4664
|
+
* Tags of the [Bot](#schema_bot)
|
|
4665
|
+
*/
|
|
4666
|
+
tags?: {
|
|
4667
|
+
[k: string]: string;
|
|
4668
|
+
};
|
|
4669
|
+
/**
|
|
4670
|
+
* JavaScript code of the bot
|
|
4671
|
+
*/
|
|
4672
|
+
code?: string;
|
|
4673
|
+
/**
|
|
4674
|
+
* Optional name for the bot, if not provided will be auto-generated
|
|
4675
|
+
*/
|
|
4676
|
+
name?: string;
|
|
4677
|
+
/**
|
|
4678
|
+
* Media files associated with the [Bot](#schema_bot)
|
|
4679
|
+
*/
|
|
4680
|
+
medias?: {
|
|
4681
|
+
url: string;
|
|
4682
|
+
name: string;
|
|
4683
|
+
}[];
|
|
4684
|
+
/**
|
|
4685
|
+
* URL of the [Bot](#schema_bot); Only available for dev bots
|
|
4686
|
+
*/
|
|
4687
|
+
url?: string;
|
|
4688
|
+
/**
|
|
4689
|
+
* Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
|
|
4690
|
+
*/
|
|
4691
|
+
dev?: boolean;
|
|
4692
|
+
}
|
|
4693
|
+
type CreateBotInput$1 = CreateBotRequestBody$1 & CreateBotRequestHeaders$1 & CreateBotRequestQuery$1 & CreateBotRequestParams$1;
|
|
4694
|
+
interface CreateBotResponse$1 {
|
|
4695
|
+
bot: {
|
|
4625
4696
|
/**
|
|
4626
|
-
*
|
|
4697
|
+
* Id of the [Bot](#schema_bot)
|
|
4627
4698
|
*/
|
|
4628
|
-
|
|
4629
|
-
/**
|
|
4630
|
-
* Title of the event
|
|
4631
|
-
*/
|
|
4632
|
-
title?: string;
|
|
4633
|
-
/**
|
|
4634
|
-
* Description of the event
|
|
4635
|
-
*/
|
|
4636
|
-
description?: string;
|
|
4637
|
-
schema: {
|
|
4638
|
-
[k: string]: any;
|
|
4639
|
-
};
|
|
4640
|
-
} | null;
|
|
4641
|
-
};
|
|
4642
|
-
actions?: {
|
|
4699
|
+
id: string;
|
|
4643
4700
|
/**
|
|
4644
|
-
*
|
|
4645
|
-
*/
|
|
4646
|
-
[k: string]: {
|
|
4647
|
-
/**
|
|
4648
|
-
* Title of the action
|
|
4649
|
-
*/
|
|
4650
|
-
title?: string;
|
|
4651
|
-
/**
|
|
4652
|
-
* Description of the action
|
|
4653
|
-
*/
|
|
4654
|
-
description?: string;
|
|
4655
|
-
billable?: boolean;
|
|
4656
|
-
cacheable?: boolean;
|
|
4657
|
-
input: {
|
|
4658
|
-
schema: {
|
|
4659
|
-
[k: string]: any;
|
|
4660
|
-
};
|
|
4661
|
-
};
|
|
4662
|
-
output: {
|
|
4663
|
-
schema: {
|
|
4664
|
-
[k: string]: any;
|
|
4665
|
-
};
|
|
4666
|
-
};
|
|
4667
|
-
} | null;
|
|
4668
|
-
};
|
|
4669
|
-
states?: {
|
|
4670
|
-
[k: string]: {
|
|
4671
|
-
/**
|
|
4672
|
-
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
4673
|
-
*/
|
|
4674
|
-
type: "conversation" | "user" | "bot" | "task";
|
|
4675
|
-
/**
|
|
4676
|
-
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
4677
|
-
*/
|
|
4678
|
-
schema: {
|
|
4679
|
-
[k: string]: any;
|
|
4680
|
-
};
|
|
4681
|
-
/**
|
|
4682
|
-
* 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.
|
|
4683
|
-
*/
|
|
4684
|
-
expiry?: number;
|
|
4685
|
-
} | null;
|
|
4686
|
-
};
|
|
4687
|
-
recurringEvents?: {
|
|
4688
|
-
[k: string]: {
|
|
4689
|
-
schedule: {
|
|
4690
|
-
cron: string;
|
|
4691
|
-
};
|
|
4692
|
-
type: string;
|
|
4693
|
-
payload: {
|
|
4694
|
-
[k: string]: any;
|
|
4695
|
-
};
|
|
4696
|
-
} | null;
|
|
4697
|
-
};
|
|
4698
|
-
integrations?: {
|
|
4699
|
-
[k: string]: {
|
|
4700
|
-
enabled?: boolean;
|
|
4701
|
-
/**
|
|
4702
|
-
* Integration's configuration type. Set to default if null.
|
|
4703
|
-
*/
|
|
4704
|
-
configurationType?: string | null;
|
|
4705
|
-
configuration?: {
|
|
4706
|
-
[k: string]: any;
|
|
4707
|
-
};
|
|
4708
|
-
} | null;
|
|
4709
|
-
};
|
|
4710
|
-
subscriptions?: {
|
|
4711
|
-
events: {
|
|
4712
|
-
[k: string]: {} | null;
|
|
4713
|
-
} | null;
|
|
4714
|
-
};
|
|
4715
|
-
/**
|
|
4716
|
-
* JavaScript code of the bot
|
|
4717
|
-
*/
|
|
4718
|
-
code?: string;
|
|
4719
|
-
/**
|
|
4720
|
-
* Optional name for the bot, if not provided will be auto-generated
|
|
4721
|
-
*/
|
|
4722
|
-
name?: string;
|
|
4723
|
-
/**
|
|
4724
|
-
* Media files associated with the [Bot](#schema_bot)
|
|
4725
|
-
*/
|
|
4726
|
-
medias?: {
|
|
4727
|
-
url: string;
|
|
4728
|
-
name: string;
|
|
4729
|
-
}[];
|
|
4730
|
-
layers?: string[];
|
|
4731
|
-
}
|
|
4732
|
-
type UpdateBotInput$1 = UpdateBotRequestBody$1 & UpdateBotRequestHeaders$1 & UpdateBotRequestQuery$1 & UpdateBotRequestParams$1;
|
|
4733
|
-
interface UpdateBotResponse$1 {
|
|
4734
|
-
bot: {
|
|
4735
|
-
/**
|
|
4736
|
-
* Id of the [Bot](#schema_bot)
|
|
4737
|
-
*/
|
|
4738
|
-
id: string;
|
|
4739
|
-
/**
|
|
4740
|
-
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
4701
|
+
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
4741
4702
|
*/
|
|
4742
4703
|
createdAt: string;
|
|
4743
4704
|
/**
|
|
@@ -5033,138 +4994,265 @@ interface UpdateBotResponse$1 {
|
|
|
5033
4994
|
};
|
|
5034
4995
|
}
|
|
5035
4996
|
|
|
5036
|
-
interface
|
|
4997
|
+
interface UpdateBotRequestHeaders$1 {
|
|
5037
4998
|
}
|
|
5038
|
-
interface
|
|
4999
|
+
interface UpdateBotRequestQuery$1 {
|
|
5039
5000
|
}
|
|
5040
|
-
interface
|
|
5001
|
+
interface UpdateBotRequestParams$1 {
|
|
5041
5002
|
id: string;
|
|
5042
5003
|
}
|
|
5043
|
-
interface
|
|
5004
|
+
interface UpdateBotRequestBody$1 {
|
|
5044
5005
|
/**
|
|
5045
|
-
*
|
|
5006
|
+
* URL of the [Bot](#schema_bot); Only available for dev bots
|
|
5046
5007
|
*/
|
|
5047
|
-
|
|
5048
|
-
|
|
5049
|
-
|
|
5050
|
-
|
|
5051
|
-
|
|
5052
|
-
|
|
5053
|
-
interface ListBotsRequestHeaders$1 {
|
|
5054
|
-
}
|
|
5055
|
-
interface ListBotsRequestQuery$1 {
|
|
5056
|
-
dev?: boolean;
|
|
5057
|
-
tags?: {
|
|
5058
|
-
[k: string]: string;
|
|
5059
|
-
};
|
|
5060
|
-
nextToken?: string;
|
|
5061
|
-
sortField?: "createdAt" | "updatedAt";
|
|
5062
|
-
sortDirection?: "asc" | "desc";
|
|
5063
|
-
}
|
|
5064
|
-
interface ListBotsRequestParams$1 {
|
|
5065
|
-
}
|
|
5066
|
-
interface ListBotsRequestBody$1 {
|
|
5067
|
-
}
|
|
5068
|
-
type ListBotsInput$1 = ListBotsRequestBody$1 & ListBotsRequestHeaders$1 & ListBotsRequestQuery$1 & ListBotsRequestParams$1;
|
|
5069
|
-
interface ListBotsResponse$1 {
|
|
5070
|
-
bots: {
|
|
5071
|
-
/**
|
|
5072
|
-
* Id of the [Bot](#schema_bot)
|
|
5073
|
-
*/
|
|
5074
|
-
id: string;
|
|
5075
|
-
/**
|
|
5076
|
-
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5077
|
-
*/
|
|
5078
|
-
createdAt: string;
|
|
5079
|
-
/**
|
|
5080
|
-
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5081
|
-
*/
|
|
5082
|
-
updatedAt: string;
|
|
5083
|
-
name: string;
|
|
5084
|
-
deployedAt?: string;
|
|
5008
|
+
url?: string;
|
|
5009
|
+
/**
|
|
5010
|
+
* Type of the [Bot](#schema_bot) authentication (`iam`)
|
|
5011
|
+
*/
|
|
5012
|
+
authentication?: "iam";
|
|
5013
|
+
configuration?: {
|
|
5085
5014
|
/**
|
|
5086
|
-
*
|
|
5015
|
+
* Configuration data
|
|
5087
5016
|
*/
|
|
5088
|
-
|
|
5089
|
-
[k: string]:
|
|
5017
|
+
data?: {
|
|
5018
|
+
[k: string]: any;
|
|
5090
5019
|
};
|
|
5091
|
-
}[];
|
|
5092
|
-
meta: {
|
|
5093
5020
|
/**
|
|
5094
|
-
*
|
|
5021
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
5095
5022
|
*/
|
|
5096
|
-
|
|
5023
|
+
schema?: {
|
|
5024
|
+
[k: string]: any;
|
|
5025
|
+
};
|
|
5097
5026
|
};
|
|
5098
|
-
|
|
5099
|
-
|
|
5100
|
-
|
|
5101
|
-
|
|
5102
|
-
|
|
5103
|
-
}
|
|
5104
|
-
|
|
5105
|
-
|
|
5106
|
-
|
|
5107
|
-
|
|
5108
|
-
|
|
5109
|
-
|
|
5110
|
-
|
|
5111
|
-
|
|
5112
|
-
|
|
5113
|
-
|
|
5114
|
-
*/
|
|
5115
|
-
id: string;
|
|
5116
|
-
/**
|
|
5117
|
-
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5118
|
-
*/
|
|
5119
|
-
createdAt: string;
|
|
5120
|
-
/**
|
|
5121
|
-
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5122
|
-
*/
|
|
5123
|
-
updatedAt: string;
|
|
5124
|
-
/**
|
|
5125
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
5126
|
-
*/
|
|
5127
|
-
signingSecret: string;
|
|
5128
|
-
/**
|
|
5129
|
-
* A mapping of integrations to their configuration
|
|
5130
|
-
*/
|
|
5131
|
-
integrations: {
|
|
5027
|
+
/**
|
|
5028
|
+
* Tags of the [Bot](#schema_bot)
|
|
5029
|
+
*/
|
|
5030
|
+
tags?: {
|
|
5031
|
+
[k: string]: string;
|
|
5032
|
+
};
|
|
5033
|
+
blocked?: boolean;
|
|
5034
|
+
/**
|
|
5035
|
+
* Indicates if the [Bot](#schema_bot) should be in always alive mode
|
|
5036
|
+
*/
|
|
5037
|
+
alwaysAlive?: boolean;
|
|
5038
|
+
user?: {
|
|
5039
|
+
tags?: {
|
|
5040
|
+
/**
|
|
5041
|
+
* Definition of a tag that can be provided on the object
|
|
5042
|
+
*/
|
|
5132
5043
|
[k: string]: {
|
|
5133
|
-
enabled: boolean;
|
|
5134
|
-
/**
|
|
5135
|
-
* Name of the [Integration](#schema_integration)
|
|
5136
|
-
*/
|
|
5137
|
-
name: string;
|
|
5138
|
-
/**
|
|
5139
|
-
* Version of the [Integration](#schema_integration)
|
|
5140
|
-
*/
|
|
5141
|
-
version: string;
|
|
5142
|
-
webhookUrl: string;
|
|
5143
|
-
webhookId: string;
|
|
5144
|
-
identifier?: string;
|
|
5145
|
-
configurationType: string | null;
|
|
5146
|
-
configuration: {
|
|
5147
|
-
[k: string]: any;
|
|
5148
|
-
};
|
|
5149
|
-
status: "registration_pending" | "registered" | "registration_failed" | "unregistration_pending" | "unregistered" | "unregistration_failed";
|
|
5150
|
-
statusReason: string | null;
|
|
5151
5044
|
/**
|
|
5152
|
-
*
|
|
5045
|
+
* Title of the tag
|
|
5153
5046
|
*/
|
|
5154
|
-
|
|
5047
|
+
title?: string;
|
|
5155
5048
|
/**
|
|
5156
|
-
*
|
|
5049
|
+
* Description of the tag
|
|
5157
5050
|
*/
|
|
5158
|
-
|
|
5051
|
+
description?: string;
|
|
5052
|
+
} | null;
|
|
5053
|
+
};
|
|
5054
|
+
};
|
|
5055
|
+
message?: {
|
|
5056
|
+
tags?: {
|
|
5057
|
+
/**
|
|
5058
|
+
* Definition of a tag that can be provided on the object
|
|
5059
|
+
*/
|
|
5060
|
+
[k: string]: {
|
|
5159
5061
|
/**
|
|
5160
|
-
*
|
|
5062
|
+
* Title of the tag
|
|
5161
5063
|
*/
|
|
5162
|
-
|
|
5064
|
+
title?: string;
|
|
5163
5065
|
/**
|
|
5164
|
-
*
|
|
5066
|
+
* Description of the tag
|
|
5165
5067
|
*/
|
|
5166
|
-
|
|
5167
|
-
|
|
5068
|
+
description?: string;
|
|
5069
|
+
} | null;
|
|
5070
|
+
};
|
|
5071
|
+
};
|
|
5072
|
+
conversation?: {
|
|
5073
|
+
tags?: {
|
|
5074
|
+
/**
|
|
5075
|
+
* Definition of a tag that can be provided on the object
|
|
5076
|
+
*/
|
|
5077
|
+
[k: string]: {
|
|
5078
|
+
/**
|
|
5079
|
+
* Title of the tag
|
|
5080
|
+
*/
|
|
5081
|
+
title?: string;
|
|
5082
|
+
/**
|
|
5083
|
+
* Description of the tag
|
|
5084
|
+
*/
|
|
5085
|
+
description?: string;
|
|
5086
|
+
} | null;
|
|
5087
|
+
};
|
|
5088
|
+
};
|
|
5089
|
+
events?: {
|
|
5090
|
+
/**
|
|
5091
|
+
* Event Definition
|
|
5092
|
+
*/
|
|
5093
|
+
[k: string]: {
|
|
5094
|
+
/**
|
|
5095
|
+
* Title of the event
|
|
5096
|
+
*/
|
|
5097
|
+
title?: string;
|
|
5098
|
+
/**
|
|
5099
|
+
* Description of the event
|
|
5100
|
+
*/
|
|
5101
|
+
description?: string;
|
|
5102
|
+
schema: {
|
|
5103
|
+
[k: string]: any;
|
|
5104
|
+
};
|
|
5105
|
+
} | null;
|
|
5106
|
+
};
|
|
5107
|
+
actions?: {
|
|
5108
|
+
/**
|
|
5109
|
+
* Action definition
|
|
5110
|
+
*/
|
|
5111
|
+
[k: string]: {
|
|
5112
|
+
/**
|
|
5113
|
+
* Title of the action
|
|
5114
|
+
*/
|
|
5115
|
+
title?: string;
|
|
5116
|
+
/**
|
|
5117
|
+
* Description of the action
|
|
5118
|
+
*/
|
|
5119
|
+
description?: string;
|
|
5120
|
+
billable?: boolean;
|
|
5121
|
+
cacheable?: boolean;
|
|
5122
|
+
input: {
|
|
5123
|
+
schema: {
|
|
5124
|
+
[k: string]: any;
|
|
5125
|
+
};
|
|
5126
|
+
};
|
|
5127
|
+
output: {
|
|
5128
|
+
schema: {
|
|
5129
|
+
[k: string]: any;
|
|
5130
|
+
};
|
|
5131
|
+
};
|
|
5132
|
+
} | null;
|
|
5133
|
+
};
|
|
5134
|
+
states?: {
|
|
5135
|
+
[k: string]: {
|
|
5136
|
+
/**
|
|
5137
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
5138
|
+
*/
|
|
5139
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
5140
|
+
/**
|
|
5141
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
5142
|
+
*/
|
|
5143
|
+
schema: {
|
|
5144
|
+
[k: string]: any;
|
|
5145
|
+
};
|
|
5146
|
+
/**
|
|
5147
|
+
* 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.
|
|
5148
|
+
*/
|
|
5149
|
+
expiry?: number;
|
|
5150
|
+
} | null;
|
|
5151
|
+
};
|
|
5152
|
+
recurringEvents?: {
|
|
5153
|
+
[k: string]: {
|
|
5154
|
+
schedule: {
|
|
5155
|
+
cron: string;
|
|
5156
|
+
};
|
|
5157
|
+
type: string;
|
|
5158
|
+
payload: {
|
|
5159
|
+
[k: string]: any;
|
|
5160
|
+
};
|
|
5161
|
+
} | null;
|
|
5162
|
+
};
|
|
5163
|
+
integrations?: {
|
|
5164
|
+
[k: string]: {
|
|
5165
|
+
enabled?: boolean;
|
|
5166
|
+
/**
|
|
5167
|
+
* Integration's configuration type. Set to default if null.
|
|
5168
|
+
*/
|
|
5169
|
+
configurationType?: string | null;
|
|
5170
|
+
configuration?: {
|
|
5171
|
+
[k: string]: any;
|
|
5172
|
+
};
|
|
5173
|
+
} | null;
|
|
5174
|
+
};
|
|
5175
|
+
subscriptions?: {
|
|
5176
|
+
events: {
|
|
5177
|
+
[k: string]: {} | null;
|
|
5178
|
+
} | null;
|
|
5179
|
+
};
|
|
5180
|
+
/**
|
|
5181
|
+
* JavaScript code of the bot
|
|
5182
|
+
*/
|
|
5183
|
+
code?: string;
|
|
5184
|
+
/**
|
|
5185
|
+
* Optional name for the bot, if not provided will be auto-generated
|
|
5186
|
+
*/
|
|
5187
|
+
name?: string;
|
|
5188
|
+
/**
|
|
5189
|
+
* Media files associated with the [Bot](#schema_bot)
|
|
5190
|
+
*/
|
|
5191
|
+
medias?: {
|
|
5192
|
+
url: string;
|
|
5193
|
+
name: string;
|
|
5194
|
+
}[];
|
|
5195
|
+
layers?: string[];
|
|
5196
|
+
}
|
|
5197
|
+
type UpdateBotInput$1 = UpdateBotRequestBody$1 & UpdateBotRequestHeaders$1 & UpdateBotRequestQuery$1 & UpdateBotRequestParams$1;
|
|
5198
|
+
interface UpdateBotResponse$1 {
|
|
5199
|
+
bot: {
|
|
5200
|
+
/**
|
|
5201
|
+
* Id of the [Bot](#schema_bot)
|
|
5202
|
+
*/
|
|
5203
|
+
id: string;
|
|
5204
|
+
/**
|
|
5205
|
+
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5206
|
+
*/
|
|
5207
|
+
createdAt: string;
|
|
5208
|
+
/**
|
|
5209
|
+
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5210
|
+
*/
|
|
5211
|
+
updatedAt: string;
|
|
5212
|
+
/**
|
|
5213
|
+
* Signing secret of the [Bot](#schema_bot)
|
|
5214
|
+
*/
|
|
5215
|
+
signingSecret: string;
|
|
5216
|
+
/**
|
|
5217
|
+
* A mapping of integrations to their configuration
|
|
5218
|
+
*/
|
|
5219
|
+
integrations: {
|
|
5220
|
+
[k: string]: {
|
|
5221
|
+
enabled: boolean;
|
|
5222
|
+
/**
|
|
5223
|
+
* Name of the [Integration](#schema_integration)
|
|
5224
|
+
*/
|
|
5225
|
+
name: string;
|
|
5226
|
+
/**
|
|
5227
|
+
* Version of the [Integration](#schema_integration)
|
|
5228
|
+
*/
|
|
5229
|
+
version: string;
|
|
5230
|
+
webhookUrl: string;
|
|
5231
|
+
webhookId: string;
|
|
5232
|
+
identifier?: string;
|
|
5233
|
+
configurationType: string | null;
|
|
5234
|
+
configuration: {
|
|
5235
|
+
[k: string]: any;
|
|
5236
|
+
};
|
|
5237
|
+
status: "registration_pending" | "registered" | "registration_failed" | "unregistration_pending" | "unregistered" | "unregistration_failed";
|
|
5238
|
+
statusReason: string | null;
|
|
5239
|
+
/**
|
|
5240
|
+
* ID of the [Integration](#schema_integration)
|
|
5241
|
+
*/
|
|
5242
|
+
id: string;
|
|
5243
|
+
/**
|
|
5244
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
5245
|
+
*/
|
|
5246
|
+
createdAt: string;
|
|
5247
|
+
/**
|
|
5248
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
5249
|
+
*/
|
|
5250
|
+
updatedAt: string;
|
|
5251
|
+
/**
|
|
5252
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
5253
|
+
*/
|
|
5254
|
+
title: string;
|
|
5255
|
+
/**
|
|
5168
5256
|
* Description of the integration. This is the description that will be displayed in the UI
|
|
5169
5257
|
*/
|
|
5170
5258
|
description: string;
|
|
@@ -5410,197 +5498,61 @@ interface GetBotResponse$1 {
|
|
|
5410
5498
|
};
|
|
5411
5499
|
}
|
|
5412
5500
|
|
|
5413
|
-
interface
|
|
5501
|
+
interface TransferBotRequestHeaders$1 {
|
|
5414
5502
|
}
|
|
5415
|
-
interface
|
|
5503
|
+
interface TransferBotRequestQuery$1 {
|
|
5416
5504
|
}
|
|
5417
|
-
interface
|
|
5505
|
+
interface TransferBotRequestParams$1 {
|
|
5418
5506
|
id: string;
|
|
5419
5507
|
}
|
|
5420
|
-
interface
|
|
5508
|
+
interface TransferBotRequestBody$1 {
|
|
5509
|
+
/**
|
|
5510
|
+
* The ID of the workspace you want to transfer the bot to.
|
|
5511
|
+
*/
|
|
5512
|
+
targetWorkspaceId: string;
|
|
5421
5513
|
}
|
|
5422
|
-
type
|
|
5423
|
-
interface
|
|
5514
|
+
type TransferBotInput$1 = TransferBotRequestBody$1 & TransferBotRequestHeaders$1 & TransferBotRequestQuery$1 & TransferBotRequestParams$1;
|
|
5515
|
+
interface TransferBotResponse$1 {
|
|
5424
5516
|
}
|
|
5425
5517
|
|
|
5426
|
-
interface
|
|
5427
|
-
}
|
|
5428
|
-
interface GetBotLogsRequestQuery$1 {
|
|
5429
|
-
timeStart: string;
|
|
5430
|
-
timeEnd?: string;
|
|
5431
|
-
level?: string;
|
|
5432
|
-
userId?: string;
|
|
5433
|
-
workflowId?: string;
|
|
5434
|
-
conversationId?: string;
|
|
5435
|
-
nextToken?: string;
|
|
5436
|
-
}
|
|
5437
|
-
interface GetBotLogsRequestParams$1 {
|
|
5438
|
-
id: string;
|
|
5439
|
-
}
|
|
5440
|
-
interface GetBotLogsRequestBody$1 {
|
|
5518
|
+
interface ListBotsRequestHeaders$1 {
|
|
5441
5519
|
}
|
|
5442
|
-
|
|
5443
|
-
|
|
5444
|
-
|
|
5445
|
-
|
|
5446
|
-
|
|
5447
|
-
message: string;
|
|
5448
|
-
workflowId?: string;
|
|
5449
|
-
userId?: string;
|
|
5450
|
-
conversationId?: string;
|
|
5451
|
-
}[];
|
|
5520
|
+
interface ListBotsRequestQuery$1 {
|
|
5521
|
+
dev?: boolean;
|
|
5522
|
+
tags?: {
|
|
5523
|
+
[k: string]: string;
|
|
5524
|
+
};
|
|
5452
5525
|
nextToken?: string;
|
|
5526
|
+
sortField?: "createdAt" | "updatedAt";
|
|
5527
|
+
sortDirection?: "asc" | "desc";
|
|
5453
5528
|
}
|
|
5454
|
-
|
|
5455
|
-
interface GetBotWebchatRequestHeaders$1 {
|
|
5456
|
-
}
|
|
5457
|
-
interface GetBotWebchatRequestQuery$1 {
|
|
5458
|
-
type: "preconfigured" | "configurable" | "fullscreen" | "sharableUrl";
|
|
5459
|
-
}
|
|
5460
|
-
interface GetBotWebchatRequestParams$1 {
|
|
5461
|
-
id: string;
|
|
5462
|
-
}
|
|
5463
|
-
interface GetBotWebchatRequestBody$1 {
|
|
5464
|
-
}
|
|
5465
|
-
type GetBotWebchatInput$1 = GetBotWebchatRequestBody$1 & GetBotWebchatRequestHeaders$1 & GetBotWebchatRequestQuery$1 & GetBotWebchatRequestParams$1;
|
|
5466
|
-
interface GetBotWebchatResponse$1 {
|
|
5467
|
-
code: string;
|
|
5529
|
+
interface ListBotsRequestParams$1 {
|
|
5468
5530
|
}
|
|
5469
|
-
|
|
5470
|
-
interface GetBotAnalyticsRequestHeaders$1 {
|
|
5531
|
+
interface ListBotsRequestBody$1 {
|
|
5471
5532
|
}
|
|
5472
|
-
|
|
5473
|
-
|
|
5474
|
-
|
|
5475
|
-
}
|
|
5476
|
-
interface GetBotAnalyticsRequestParams$1 {
|
|
5477
|
-
id: string;
|
|
5478
|
-
}
|
|
5479
|
-
interface GetBotAnalyticsRequestBody$1 {
|
|
5480
|
-
}
|
|
5481
|
-
type GetBotAnalyticsInput$1 = GetBotAnalyticsRequestBody$1 & GetBotAnalyticsRequestHeaders$1 & GetBotAnalyticsRequestQuery$1 & GetBotAnalyticsRequestParams$1;
|
|
5482
|
-
interface GetBotAnalyticsResponse$1 {
|
|
5483
|
-
records: {
|
|
5533
|
+
type ListBotsInput$1 = ListBotsRequestBody$1 & ListBotsRequestHeaders$1 & ListBotsRequestQuery$1 & ListBotsRequestParams$1;
|
|
5534
|
+
interface ListBotsResponse$1 {
|
|
5535
|
+
bots: {
|
|
5484
5536
|
/**
|
|
5485
|
-
*
|
|
5537
|
+
* Id of the [Bot](#schema_bot)
|
|
5486
5538
|
*/
|
|
5487
|
-
|
|
5539
|
+
id: string;
|
|
5488
5540
|
/**
|
|
5489
|
-
*
|
|
5541
|
+
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5490
5542
|
*/
|
|
5491
|
-
|
|
5492
|
-
returningUsers: number;
|
|
5493
|
-
newUsers: number;
|
|
5494
|
-
sessions: number;
|
|
5543
|
+
createdAt: string;
|
|
5495
5544
|
/**
|
|
5496
|
-
*
|
|
5545
|
+
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5497
5546
|
*/
|
|
5498
|
-
|
|
5499
|
-
|
|
5500
|
-
|
|
5501
|
-
|
|
5502
|
-
|
|
5503
|
-
|
|
5504
|
-
|
|
5505
|
-
|
|
5506
|
-
[k: string]: number;
|
|
5507
|
-
};
|
|
5508
|
-
llm: {
|
|
5509
|
-
calls: number;
|
|
5510
|
-
errors: number;
|
|
5511
|
-
inputTokens: number;
|
|
5512
|
-
outputTokens: number;
|
|
5513
|
-
/**
|
|
5514
|
-
* The time it took for the LLM to complete its response. Values are expressed in milliseconds
|
|
5515
|
-
*/
|
|
5516
|
-
latency: {
|
|
5517
|
-
mean: number;
|
|
5518
|
-
sd: number;
|
|
5519
|
-
min: number;
|
|
5520
|
-
max: number;
|
|
5521
|
-
};
|
|
5522
|
-
/**
|
|
5523
|
-
* LLM response generation speed expressed in output tokens per second.
|
|
5524
|
-
*/
|
|
5525
|
-
tokensPerSecond: {
|
|
5526
|
-
mean: number;
|
|
5527
|
-
sd: number;
|
|
5528
|
-
min: number;
|
|
5529
|
-
max: number;
|
|
5530
|
-
};
|
|
5531
|
-
/**
|
|
5532
|
-
* Values are expressed in U.S. dollars
|
|
5533
|
-
*/
|
|
5534
|
-
cost: {
|
|
5535
|
-
sum: number;
|
|
5536
|
-
mean: number;
|
|
5537
|
-
sd: number;
|
|
5538
|
-
min: number;
|
|
5539
|
-
max: number;
|
|
5540
|
-
};
|
|
5541
|
-
};
|
|
5542
|
-
}[];
|
|
5543
|
-
}
|
|
5544
|
-
|
|
5545
|
-
interface GetBotIssueRequestHeaders$1 {
|
|
5546
|
-
}
|
|
5547
|
-
interface GetBotIssueRequestQuery$1 {
|
|
5548
|
-
}
|
|
5549
|
-
interface GetBotIssueRequestParams$1 {
|
|
5550
|
-
id: string;
|
|
5551
|
-
issueId: string;
|
|
5552
|
-
}
|
|
5553
|
-
interface GetBotIssueRequestBody$1 {
|
|
5554
|
-
}
|
|
5555
|
-
type GetBotIssueInput$1 = GetBotIssueRequestBody$1 & GetBotIssueRequestHeaders$1 & GetBotIssueRequestQuery$1 & GetBotIssueRequestParams$1;
|
|
5556
|
-
interface GetBotIssueResponse$1 {
|
|
5557
|
-
issue: {
|
|
5558
|
-
id: string;
|
|
5559
|
-
code: string;
|
|
5560
|
-
createdAt: string;
|
|
5561
|
-
lastSeenAt: string;
|
|
5562
|
-
title: string;
|
|
5563
|
-
description: string;
|
|
5564
|
-
groupedData: {
|
|
5565
|
-
[k: string]: {
|
|
5566
|
-
raw: string;
|
|
5567
|
-
pretty?: string;
|
|
5568
|
-
};
|
|
5569
|
-
};
|
|
5570
|
-
eventsCount: number;
|
|
5571
|
-
category: "user_code" | "limits" | "configuration" | "other";
|
|
5572
|
-
resolutionLink: string | null;
|
|
5573
|
-
};
|
|
5574
|
-
}
|
|
5575
|
-
|
|
5576
|
-
interface ListBotIssuesRequestHeaders$1 {
|
|
5577
|
-
}
|
|
5578
|
-
interface ListBotIssuesRequestQuery$1 {
|
|
5579
|
-
nextToken?: string;
|
|
5580
|
-
}
|
|
5581
|
-
interface ListBotIssuesRequestParams$1 {
|
|
5582
|
-
id: string;
|
|
5583
|
-
}
|
|
5584
|
-
interface ListBotIssuesRequestBody$1 {
|
|
5585
|
-
}
|
|
5586
|
-
type ListBotIssuesInput$1 = ListBotIssuesRequestBody$1 & ListBotIssuesRequestHeaders$1 & ListBotIssuesRequestQuery$1 & ListBotIssuesRequestParams$1;
|
|
5587
|
-
interface ListBotIssuesResponse$1 {
|
|
5588
|
-
issues: {
|
|
5589
|
-
id: string;
|
|
5590
|
-
code: string;
|
|
5591
|
-
createdAt: string;
|
|
5592
|
-
lastSeenAt: string;
|
|
5593
|
-
title: string;
|
|
5594
|
-
description: string;
|
|
5595
|
-
groupedData: {
|
|
5596
|
-
[k: string]: {
|
|
5597
|
-
raw: string;
|
|
5598
|
-
pretty?: string;
|
|
5599
|
-
};
|
|
5547
|
+
updatedAt: string;
|
|
5548
|
+
name: string;
|
|
5549
|
+
deployedAt?: string;
|
|
5550
|
+
/**
|
|
5551
|
+
* Tags of [Bot](#schema_bot)
|
|
5552
|
+
*/
|
|
5553
|
+
tags: {
|
|
5554
|
+
[k: string]: string;
|
|
5600
5555
|
};
|
|
5601
|
-
eventsCount: number;
|
|
5602
|
-
category: "user_code" | "limits" | "configuration" | "other";
|
|
5603
|
-
resolutionLink: string | null;
|
|
5604
5556
|
}[];
|
|
5605
5557
|
meta: {
|
|
5606
5558
|
/**
|
|
@@ -5610,57 +5562,570 @@ interface ListBotIssuesResponse$1 {
|
|
|
5610
5562
|
};
|
|
5611
5563
|
}
|
|
5612
5564
|
|
|
5613
|
-
interface
|
|
5614
|
-
}
|
|
5615
|
-
interface DeleteBotIssueRequestQuery$1 {
|
|
5616
|
-
}
|
|
5617
|
-
interface DeleteBotIssueRequestParams$1 {
|
|
5618
|
-
id: string;
|
|
5619
|
-
issueId: string;
|
|
5620
|
-
}
|
|
5621
|
-
interface DeleteBotIssueRequestBody$1 {
|
|
5622
|
-
}
|
|
5623
|
-
type DeleteBotIssueInput$1 = DeleteBotIssueRequestBody$1 & DeleteBotIssueRequestHeaders$1 & DeleteBotIssueRequestQuery$1 & DeleteBotIssueRequestParams$1;
|
|
5624
|
-
interface DeleteBotIssueResponse$1 {
|
|
5625
|
-
}
|
|
5626
|
-
|
|
5627
|
-
interface ListBotIssueEventsRequestHeaders$1 {
|
|
5565
|
+
interface GetBotRequestHeaders$1 {
|
|
5628
5566
|
}
|
|
5629
|
-
interface
|
|
5567
|
+
interface GetBotRequestQuery$1 {
|
|
5630
5568
|
}
|
|
5631
|
-
interface
|
|
5569
|
+
interface GetBotRequestParams$1 {
|
|
5632
5570
|
id: string;
|
|
5633
|
-
issueId: string;
|
|
5634
5571
|
}
|
|
5635
|
-
interface
|
|
5572
|
+
interface GetBotRequestBody$1 {
|
|
5636
5573
|
}
|
|
5637
|
-
type
|
|
5638
|
-
interface
|
|
5639
|
-
|
|
5574
|
+
type GetBotInput$1 = GetBotRequestBody$1 & GetBotRequestHeaders$1 & GetBotRequestQuery$1 & GetBotRequestParams$1;
|
|
5575
|
+
interface GetBotResponse$1 {
|
|
5576
|
+
bot: {
|
|
5577
|
+
/**
|
|
5578
|
+
* Id of the [Bot](#schema_bot)
|
|
5579
|
+
*/
|
|
5640
5580
|
id: string;
|
|
5581
|
+
/**
|
|
5582
|
+
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5583
|
+
*/
|
|
5641
5584
|
createdAt: string;
|
|
5642
|
-
|
|
5585
|
+
/**
|
|
5586
|
+
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5587
|
+
*/
|
|
5588
|
+
updatedAt: string;
|
|
5589
|
+
/**
|
|
5590
|
+
* Signing secret of the [Bot](#schema_bot)
|
|
5591
|
+
*/
|
|
5592
|
+
signingSecret: string;
|
|
5593
|
+
/**
|
|
5594
|
+
* A mapping of integrations to their configuration
|
|
5595
|
+
*/
|
|
5596
|
+
integrations: {
|
|
5643
5597
|
[k: string]: {
|
|
5644
|
-
|
|
5645
|
-
|
|
5598
|
+
enabled: boolean;
|
|
5599
|
+
/**
|
|
5600
|
+
* Name of the [Integration](#schema_integration)
|
|
5601
|
+
*/
|
|
5602
|
+
name: string;
|
|
5603
|
+
/**
|
|
5604
|
+
* Version of the [Integration](#schema_integration)
|
|
5605
|
+
*/
|
|
5606
|
+
version: string;
|
|
5607
|
+
webhookUrl: string;
|
|
5608
|
+
webhookId: string;
|
|
5609
|
+
identifier?: string;
|
|
5610
|
+
configurationType: string | null;
|
|
5611
|
+
configuration: {
|
|
5612
|
+
[k: string]: any;
|
|
5613
|
+
};
|
|
5614
|
+
status: "registration_pending" | "registered" | "registration_failed" | "unregistration_pending" | "unregistered" | "unregistration_failed";
|
|
5615
|
+
statusReason: string | null;
|
|
5616
|
+
/**
|
|
5617
|
+
* ID of the [Integration](#schema_integration)
|
|
5618
|
+
*/
|
|
5619
|
+
id: string;
|
|
5620
|
+
/**
|
|
5621
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
5622
|
+
*/
|
|
5623
|
+
createdAt: string;
|
|
5624
|
+
/**
|
|
5625
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
5626
|
+
*/
|
|
5627
|
+
updatedAt: string;
|
|
5628
|
+
/**
|
|
5629
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
5630
|
+
*/
|
|
5631
|
+
title: string;
|
|
5632
|
+
/**
|
|
5633
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
5634
|
+
*/
|
|
5635
|
+
description: string;
|
|
5636
|
+
/**
|
|
5637
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
5638
|
+
*/
|
|
5639
|
+
iconUrl: string;
|
|
5640
|
+
/**
|
|
5641
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
5642
|
+
*/
|
|
5643
|
+
public: boolean;
|
|
5644
|
+
/**
|
|
5645
|
+
* Status of the integration version verification
|
|
5646
|
+
*/
|
|
5647
|
+
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
5646
5648
|
};
|
|
5647
5649
|
};
|
|
5648
|
-
|
|
5649
|
-
|
|
5650
|
-
|
|
5651
|
-
|
|
5652
|
-
|
|
5653
|
-
|
|
5654
|
-
|
|
5655
|
-
|
|
5656
|
-
|
|
5657
|
-
|
|
5658
|
-
|
|
5659
|
-
|
|
5660
|
-
|
|
5661
|
-
|
|
5662
|
-
|
|
5663
|
-
|
|
5650
|
+
/**
|
|
5651
|
+
* User object configuration
|
|
5652
|
+
*/
|
|
5653
|
+
user: {
|
|
5654
|
+
tags: {
|
|
5655
|
+
/**
|
|
5656
|
+
* Definition of a tag that can be provided on the object
|
|
5657
|
+
*/
|
|
5658
|
+
[k: string]: {
|
|
5659
|
+
/**
|
|
5660
|
+
* Title of the tag
|
|
5661
|
+
*/
|
|
5662
|
+
title?: string;
|
|
5663
|
+
/**
|
|
5664
|
+
* Description of the tag
|
|
5665
|
+
*/
|
|
5666
|
+
description?: string;
|
|
5667
|
+
};
|
|
5668
|
+
};
|
|
5669
|
+
};
|
|
5670
|
+
/**
|
|
5671
|
+
* Conversation object configuration
|
|
5672
|
+
*/
|
|
5673
|
+
conversation: {
|
|
5674
|
+
tags: {
|
|
5675
|
+
/**
|
|
5676
|
+
* Definition of a tag that can be provided on the object
|
|
5677
|
+
*/
|
|
5678
|
+
[k: string]: {
|
|
5679
|
+
/**
|
|
5680
|
+
* Title of the tag
|
|
5681
|
+
*/
|
|
5682
|
+
title?: string;
|
|
5683
|
+
/**
|
|
5684
|
+
* Description of the tag
|
|
5685
|
+
*/
|
|
5686
|
+
description?: string;
|
|
5687
|
+
};
|
|
5688
|
+
};
|
|
5689
|
+
};
|
|
5690
|
+
/**
|
|
5691
|
+
* Message object configuration
|
|
5692
|
+
*/
|
|
5693
|
+
message: {
|
|
5694
|
+
tags: {
|
|
5695
|
+
/**
|
|
5696
|
+
* Definition of a tag that can be provided on the object
|
|
5697
|
+
*/
|
|
5698
|
+
[k: string]: {
|
|
5699
|
+
/**
|
|
5700
|
+
* Title of the tag
|
|
5701
|
+
*/
|
|
5702
|
+
title?: string;
|
|
5703
|
+
/**
|
|
5704
|
+
* Description of the tag
|
|
5705
|
+
*/
|
|
5706
|
+
description?: string;
|
|
5707
|
+
};
|
|
5708
|
+
};
|
|
5709
|
+
};
|
|
5710
|
+
/**
|
|
5711
|
+
* A mapping of states to their definition
|
|
5712
|
+
*/
|
|
5713
|
+
states: {
|
|
5714
|
+
[k: string]: {
|
|
5715
|
+
/**
|
|
5716
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
5717
|
+
*/
|
|
5718
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
5719
|
+
/**
|
|
5720
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
5721
|
+
*/
|
|
5722
|
+
schema: {
|
|
5723
|
+
[k: string]: any;
|
|
5724
|
+
};
|
|
5725
|
+
/**
|
|
5726
|
+
* 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.
|
|
5727
|
+
*/
|
|
5728
|
+
expiry?: number;
|
|
5729
|
+
};
|
|
5730
|
+
};
|
|
5731
|
+
/**
|
|
5732
|
+
* Configuration of the bot
|
|
5733
|
+
*/
|
|
5734
|
+
configuration: {
|
|
5735
|
+
/**
|
|
5736
|
+
* Configuration data
|
|
5737
|
+
*/
|
|
5738
|
+
data: {
|
|
5739
|
+
[k: string]: any;
|
|
5740
|
+
};
|
|
5741
|
+
/**
|
|
5742
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
5743
|
+
*/
|
|
5744
|
+
schema: {
|
|
5745
|
+
[k: string]: any;
|
|
5746
|
+
};
|
|
5747
|
+
};
|
|
5748
|
+
/**
|
|
5749
|
+
* Events definition
|
|
5750
|
+
*/
|
|
5751
|
+
events: {
|
|
5752
|
+
/**
|
|
5753
|
+
* Event Definition
|
|
5754
|
+
*/
|
|
5755
|
+
[k: string]: {
|
|
5756
|
+
/**
|
|
5757
|
+
* Title of the event
|
|
5758
|
+
*/
|
|
5759
|
+
title?: string;
|
|
5760
|
+
/**
|
|
5761
|
+
* Description of the event
|
|
5762
|
+
*/
|
|
5763
|
+
description?: string;
|
|
5764
|
+
schema: {
|
|
5765
|
+
[k: string]: any;
|
|
5766
|
+
};
|
|
5767
|
+
};
|
|
5768
|
+
};
|
|
5769
|
+
/**
|
|
5770
|
+
* Recurring events
|
|
5771
|
+
*/
|
|
5772
|
+
recurringEvents: {
|
|
5773
|
+
[k: string]: {
|
|
5774
|
+
schedule: {
|
|
5775
|
+
cron: string;
|
|
5776
|
+
};
|
|
5777
|
+
type: string;
|
|
5778
|
+
payload: {
|
|
5779
|
+
[k: string]: any;
|
|
5780
|
+
};
|
|
5781
|
+
/**
|
|
5782
|
+
* The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully.
|
|
5783
|
+
*/
|
|
5784
|
+
failedAttempts: number;
|
|
5785
|
+
/**
|
|
5786
|
+
* The reason why the recurring event failed to run in the last attempt.
|
|
5787
|
+
*/
|
|
5788
|
+
lastFailureReason: string | null;
|
|
5789
|
+
};
|
|
5790
|
+
};
|
|
5791
|
+
/**
|
|
5792
|
+
* Subscriptions of the bot
|
|
5793
|
+
*/
|
|
5794
|
+
subscriptions: {
|
|
5795
|
+
/**
|
|
5796
|
+
* Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
|
|
5797
|
+
*/
|
|
5798
|
+
events: {
|
|
5799
|
+
[k: string]: {};
|
|
5800
|
+
} | null;
|
|
5801
|
+
};
|
|
5802
|
+
/**
|
|
5803
|
+
* Actions definition
|
|
5804
|
+
*/
|
|
5805
|
+
actions: {
|
|
5806
|
+
/**
|
|
5807
|
+
* Action definition
|
|
5808
|
+
*/
|
|
5809
|
+
[k: string]: {
|
|
5810
|
+
/**
|
|
5811
|
+
* Title of the action
|
|
5812
|
+
*/
|
|
5813
|
+
title?: string;
|
|
5814
|
+
/**
|
|
5815
|
+
* Description of the action
|
|
5816
|
+
*/
|
|
5817
|
+
description?: string;
|
|
5818
|
+
billable?: boolean;
|
|
5819
|
+
cacheable?: boolean;
|
|
5820
|
+
input: {
|
|
5821
|
+
schema: {
|
|
5822
|
+
[k: string]: any;
|
|
5823
|
+
};
|
|
5824
|
+
};
|
|
5825
|
+
output: {
|
|
5826
|
+
schema: {
|
|
5827
|
+
[k: string]: any;
|
|
5828
|
+
};
|
|
5829
|
+
};
|
|
5830
|
+
};
|
|
5831
|
+
};
|
|
5832
|
+
/**
|
|
5833
|
+
* Tags of [Bot](#schema_bot)
|
|
5834
|
+
*/
|
|
5835
|
+
tags: {
|
|
5836
|
+
[k: string]: string;
|
|
5837
|
+
};
|
|
5838
|
+
/**
|
|
5839
|
+
* Name of the [Bot](#schema_bot)
|
|
5840
|
+
*/
|
|
5841
|
+
name: string;
|
|
5842
|
+
/**
|
|
5843
|
+
* Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
|
|
5844
|
+
*/
|
|
5845
|
+
deployedAt?: string;
|
|
5846
|
+
/**
|
|
5847
|
+
* Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
|
|
5848
|
+
*/
|
|
5849
|
+
dev: boolean;
|
|
5850
|
+
/**
|
|
5851
|
+
* Id of the user that created the bot
|
|
5852
|
+
*/
|
|
5853
|
+
createdBy?: string;
|
|
5854
|
+
/**
|
|
5855
|
+
* Indicates if the [Bot](#schema_bot) should be in always alive mode
|
|
5856
|
+
*/
|
|
5857
|
+
alwaysAlive: boolean;
|
|
5858
|
+
/**
|
|
5859
|
+
* Status of the bot
|
|
5860
|
+
*/
|
|
5861
|
+
status: "active" | "deploying";
|
|
5862
|
+
/**
|
|
5863
|
+
* Media files associated with the [Bot](#schema_bot)
|
|
5864
|
+
*/
|
|
5865
|
+
medias: {
|
|
5866
|
+
/**
|
|
5867
|
+
* URL of the media file
|
|
5868
|
+
*/
|
|
5869
|
+
url: string;
|
|
5870
|
+
/**
|
|
5871
|
+
* Name of the media file
|
|
5872
|
+
*/
|
|
5873
|
+
name: string;
|
|
5874
|
+
}[];
|
|
5875
|
+
};
|
|
5876
|
+
}
|
|
5877
|
+
|
|
5878
|
+
interface DeleteBotRequestHeaders$1 {
|
|
5879
|
+
}
|
|
5880
|
+
interface DeleteBotRequestQuery$1 {
|
|
5881
|
+
}
|
|
5882
|
+
interface DeleteBotRequestParams$1 {
|
|
5883
|
+
id: string;
|
|
5884
|
+
}
|
|
5885
|
+
interface DeleteBotRequestBody$1 {
|
|
5886
|
+
}
|
|
5887
|
+
type DeleteBotInput$1 = DeleteBotRequestBody$1 & DeleteBotRequestHeaders$1 & DeleteBotRequestQuery$1 & DeleteBotRequestParams$1;
|
|
5888
|
+
interface DeleteBotResponse$1 {
|
|
5889
|
+
}
|
|
5890
|
+
|
|
5891
|
+
interface GetBotLogsRequestHeaders$1 {
|
|
5892
|
+
}
|
|
5893
|
+
interface GetBotLogsRequestQuery$1 {
|
|
5894
|
+
timeStart: string;
|
|
5895
|
+
timeEnd?: string;
|
|
5896
|
+
level?: string;
|
|
5897
|
+
userId?: string;
|
|
5898
|
+
workflowId?: string;
|
|
5899
|
+
conversationId?: string;
|
|
5900
|
+
nextToken?: string;
|
|
5901
|
+
}
|
|
5902
|
+
interface GetBotLogsRequestParams$1 {
|
|
5903
|
+
id: string;
|
|
5904
|
+
}
|
|
5905
|
+
interface GetBotLogsRequestBody$1 {
|
|
5906
|
+
}
|
|
5907
|
+
type GetBotLogsInput$1 = GetBotLogsRequestBody$1 & GetBotLogsRequestHeaders$1 & GetBotLogsRequestQuery$1 & GetBotLogsRequestParams$1;
|
|
5908
|
+
interface GetBotLogsResponse$1 {
|
|
5909
|
+
logs: {
|
|
5910
|
+
timestamp: string;
|
|
5911
|
+
level: string;
|
|
5912
|
+
message: string;
|
|
5913
|
+
workflowId?: string;
|
|
5914
|
+
userId?: string;
|
|
5915
|
+
conversationId?: string;
|
|
5916
|
+
}[];
|
|
5917
|
+
nextToken?: string;
|
|
5918
|
+
}
|
|
5919
|
+
|
|
5920
|
+
interface GetBotWebchatRequestHeaders$1 {
|
|
5921
|
+
}
|
|
5922
|
+
interface GetBotWebchatRequestQuery$1 {
|
|
5923
|
+
type: "preconfigured" | "configurable" | "fullscreen" | "sharableUrl";
|
|
5924
|
+
}
|
|
5925
|
+
interface GetBotWebchatRequestParams$1 {
|
|
5926
|
+
id: string;
|
|
5927
|
+
}
|
|
5928
|
+
interface GetBotWebchatRequestBody$1 {
|
|
5929
|
+
}
|
|
5930
|
+
type GetBotWebchatInput$1 = GetBotWebchatRequestBody$1 & GetBotWebchatRequestHeaders$1 & GetBotWebchatRequestQuery$1 & GetBotWebchatRequestParams$1;
|
|
5931
|
+
interface GetBotWebchatResponse$1 {
|
|
5932
|
+
code: string;
|
|
5933
|
+
}
|
|
5934
|
+
|
|
5935
|
+
interface GetBotAnalyticsRequestHeaders$1 {
|
|
5936
|
+
}
|
|
5937
|
+
interface GetBotAnalyticsRequestQuery$1 {
|
|
5938
|
+
startDate: string;
|
|
5939
|
+
endDate: string;
|
|
5940
|
+
}
|
|
5941
|
+
interface GetBotAnalyticsRequestParams$1 {
|
|
5942
|
+
id: string;
|
|
5943
|
+
}
|
|
5944
|
+
interface GetBotAnalyticsRequestBody$1 {
|
|
5945
|
+
}
|
|
5946
|
+
type GetBotAnalyticsInput$1 = GetBotAnalyticsRequestBody$1 & GetBotAnalyticsRequestHeaders$1 & GetBotAnalyticsRequestQuery$1 & GetBotAnalyticsRequestParams$1;
|
|
5947
|
+
interface GetBotAnalyticsResponse$1 {
|
|
5948
|
+
records: {
|
|
5949
|
+
/**
|
|
5950
|
+
* ISO 8601 date string of the beginning (inclusive) of the period
|
|
5951
|
+
*/
|
|
5952
|
+
startDateTimeUtc: string;
|
|
5953
|
+
/**
|
|
5954
|
+
* ISO 8601 date string of the end (exclusive) of the period
|
|
5955
|
+
*/
|
|
5956
|
+
endDateTimeUtc: string;
|
|
5957
|
+
returningUsers: number;
|
|
5958
|
+
newUsers: number;
|
|
5959
|
+
sessions: number;
|
|
5960
|
+
/**
|
|
5961
|
+
* Deprecated. Use `userMessages` instead.
|
|
5962
|
+
*/
|
|
5963
|
+
messages: number;
|
|
5964
|
+
userMessages: number;
|
|
5965
|
+
botMessages: number;
|
|
5966
|
+
events: number;
|
|
5967
|
+
eventTypes: {
|
|
5968
|
+
[k: string]: number;
|
|
5969
|
+
};
|
|
5970
|
+
customEvents: {
|
|
5971
|
+
[k: string]: number;
|
|
5972
|
+
};
|
|
5973
|
+
llm: {
|
|
5974
|
+
calls: number;
|
|
5975
|
+
errors: number;
|
|
5976
|
+
inputTokens: number;
|
|
5977
|
+
outputTokens: number;
|
|
5978
|
+
/**
|
|
5979
|
+
* The time it took for the LLM to complete its response. Values are expressed in milliseconds
|
|
5980
|
+
*/
|
|
5981
|
+
latency: {
|
|
5982
|
+
mean: number;
|
|
5983
|
+
sd: number;
|
|
5984
|
+
min: number;
|
|
5985
|
+
max: number;
|
|
5986
|
+
};
|
|
5987
|
+
/**
|
|
5988
|
+
* LLM response generation speed expressed in output tokens per second.
|
|
5989
|
+
*/
|
|
5990
|
+
tokensPerSecond: {
|
|
5991
|
+
mean: number;
|
|
5992
|
+
sd: number;
|
|
5993
|
+
min: number;
|
|
5994
|
+
max: number;
|
|
5995
|
+
};
|
|
5996
|
+
/**
|
|
5997
|
+
* Values are expressed in U.S. dollars
|
|
5998
|
+
*/
|
|
5999
|
+
cost: {
|
|
6000
|
+
sum: number;
|
|
6001
|
+
mean: number;
|
|
6002
|
+
sd: number;
|
|
6003
|
+
min: number;
|
|
6004
|
+
max: number;
|
|
6005
|
+
};
|
|
6006
|
+
};
|
|
6007
|
+
}[];
|
|
6008
|
+
}
|
|
6009
|
+
|
|
6010
|
+
interface GetBotIssueRequestHeaders$1 {
|
|
6011
|
+
}
|
|
6012
|
+
interface GetBotIssueRequestQuery$1 {
|
|
6013
|
+
}
|
|
6014
|
+
interface GetBotIssueRequestParams$1 {
|
|
6015
|
+
id: string;
|
|
6016
|
+
issueId: string;
|
|
6017
|
+
}
|
|
6018
|
+
interface GetBotIssueRequestBody$1 {
|
|
6019
|
+
}
|
|
6020
|
+
type GetBotIssueInput$1 = GetBotIssueRequestBody$1 & GetBotIssueRequestHeaders$1 & GetBotIssueRequestQuery$1 & GetBotIssueRequestParams$1;
|
|
6021
|
+
interface GetBotIssueResponse$1 {
|
|
6022
|
+
issue: {
|
|
6023
|
+
id: string;
|
|
6024
|
+
code: string;
|
|
6025
|
+
createdAt: string;
|
|
6026
|
+
lastSeenAt: string;
|
|
6027
|
+
title: string;
|
|
6028
|
+
description: string;
|
|
6029
|
+
groupedData: {
|
|
6030
|
+
[k: string]: {
|
|
6031
|
+
raw: string;
|
|
6032
|
+
pretty?: string;
|
|
6033
|
+
};
|
|
6034
|
+
};
|
|
6035
|
+
eventsCount: number;
|
|
6036
|
+
category: "user_code" | "limits" | "configuration" | "other";
|
|
6037
|
+
resolutionLink: string | null;
|
|
6038
|
+
};
|
|
6039
|
+
}
|
|
6040
|
+
|
|
6041
|
+
interface ListBotIssuesRequestHeaders$1 {
|
|
6042
|
+
}
|
|
6043
|
+
interface ListBotIssuesRequestQuery$1 {
|
|
6044
|
+
nextToken?: string;
|
|
6045
|
+
}
|
|
6046
|
+
interface ListBotIssuesRequestParams$1 {
|
|
6047
|
+
id: string;
|
|
6048
|
+
}
|
|
6049
|
+
interface ListBotIssuesRequestBody$1 {
|
|
6050
|
+
}
|
|
6051
|
+
type ListBotIssuesInput$1 = ListBotIssuesRequestBody$1 & ListBotIssuesRequestHeaders$1 & ListBotIssuesRequestQuery$1 & ListBotIssuesRequestParams$1;
|
|
6052
|
+
interface ListBotIssuesResponse$1 {
|
|
6053
|
+
issues: {
|
|
6054
|
+
id: string;
|
|
6055
|
+
code: string;
|
|
6056
|
+
createdAt: string;
|
|
6057
|
+
lastSeenAt: string;
|
|
6058
|
+
title: string;
|
|
6059
|
+
description: string;
|
|
6060
|
+
groupedData: {
|
|
6061
|
+
[k: string]: {
|
|
6062
|
+
raw: string;
|
|
6063
|
+
pretty?: string;
|
|
6064
|
+
};
|
|
6065
|
+
};
|
|
6066
|
+
eventsCount: number;
|
|
6067
|
+
category: "user_code" | "limits" | "configuration" | "other";
|
|
6068
|
+
resolutionLink: string | null;
|
|
6069
|
+
}[];
|
|
6070
|
+
meta: {
|
|
6071
|
+
/**
|
|
6072
|
+
* 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.
|
|
6073
|
+
*/
|
|
6074
|
+
nextToken?: string;
|
|
6075
|
+
};
|
|
6076
|
+
}
|
|
6077
|
+
|
|
6078
|
+
interface DeleteBotIssueRequestHeaders$1 {
|
|
6079
|
+
}
|
|
6080
|
+
interface DeleteBotIssueRequestQuery$1 {
|
|
6081
|
+
}
|
|
6082
|
+
interface DeleteBotIssueRequestParams$1 {
|
|
6083
|
+
id: string;
|
|
6084
|
+
issueId: string;
|
|
6085
|
+
}
|
|
6086
|
+
interface DeleteBotIssueRequestBody$1 {
|
|
6087
|
+
}
|
|
6088
|
+
type DeleteBotIssueInput$1 = DeleteBotIssueRequestBody$1 & DeleteBotIssueRequestHeaders$1 & DeleteBotIssueRequestQuery$1 & DeleteBotIssueRequestParams$1;
|
|
6089
|
+
interface DeleteBotIssueResponse$1 {
|
|
6090
|
+
}
|
|
6091
|
+
|
|
6092
|
+
interface ListBotIssueEventsRequestHeaders$1 {
|
|
6093
|
+
}
|
|
6094
|
+
interface ListBotIssueEventsRequestQuery$1 {
|
|
6095
|
+
}
|
|
6096
|
+
interface ListBotIssueEventsRequestParams$1 {
|
|
6097
|
+
id: string;
|
|
6098
|
+
issueId: string;
|
|
6099
|
+
}
|
|
6100
|
+
interface ListBotIssueEventsRequestBody$1 {
|
|
6101
|
+
}
|
|
6102
|
+
type ListBotIssueEventsInput$1 = ListBotIssueEventsRequestBody$1 & ListBotIssueEventsRequestHeaders$1 & ListBotIssueEventsRequestQuery$1 & ListBotIssueEventsRequestParams$1;
|
|
6103
|
+
interface ListBotIssueEventsResponse$1 {
|
|
6104
|
+
issueEvents: {
|
|
6105
|
+
id: string;
|
|
6106
|
+
createdAt: string;
|
|
6107
|
+
data: {
|
|
6108
|
+
[k: string]: {
|
|
6109
|
+
raw: string;
|
|
6110
|
+
pretty?: string;
|
|
6111
|
+
};
|
|
6112
|
+
};
|
|
6113
|
+
}[];
|
|
6114
|
+
}
|
|
6115
|
+
|
|
6116
|
+
interface ListBotVersionsRequestHeaders$1 {
|
|
6117
|
+
}
|
|
6118
|
+
interface ListBotVersionsRequestQuery$1 {
|
|
6119
|
+
}
|
|
6120
|
+
interface ListBotVersionsRequestParams$1 {
|
|
6121
|
+
id: string;
|
|
6122
|
+
}
|
|
6123
|
+
interface ListBotVersionsRequestBody$1 {
|
|
6124
|
+
}
|
|
6125
|
+
type ListBotVersionsInput$1 = ListBotVersionsRequestBody$1 & ListBotVersionsRequestHeaders$1 & ListBotVersionsRequestQuery$1 & ListBotVersionsRequestParams$1;
|
|
6126
|
+
interface ListBotVersionsResponse$1 {
|
|
6127
|
+
versions: {
|
|
6128
|
+
id: string;
|
|
5664
6129
|
name: string;
|
|
5665
6130
|
description?: string;
|
|
5666
6131
|
}[];
|
|
@@ -11202,6 +11667,7 @@ interface ListPluginsRequestHeaders$1 {
|
|
|
11202
11667
|
interface ListPluginsRequestQuery$1 {
|
|
11203
11668
|
nextToken?: string;
|
|
11204
11669
|
name?: string;
|
|
11670
|
+
version?: string;
|
|
11205
11671
|
}
|
|
11206
11672
|
interface ListPluginsRequestParams$1 {
|
|
11207
11673
|
}
|
|
@@ -11518,6 +11984,10 @@ declare class Client$7 {
|
|
|
11518
11984
|
readonly listPublicIntegrations: (input: ListPublicIntegrationsInput$1) => Promise<ListPublicIntegrationsResponse$1>;
|
|
11519
11985
|
readonly getPublicIntegrationById: (input: GetPublicIntegrationByIdInput$1) => Promise<GetPublicIntegrationByIdResponse$1>;
|
|
11520
11986
|
readonly getPublicIntegration: (input: GetPublicIntegrationInput$1) => Promise<GetPublicIntegrationResponse$1>;
|
|
11987
|
+
readonly listPublicPlugins: (input: ListPublicPluginsInput$1) => Promise<ListPublicPluginsResponse$1>;
|
|
11988
|
+
readonly getPublicPluginById: (input: GetPublicPluginByIdInput$1) => Promise<GetPublicPluginByIdResponse$1>;
|
|
11989
|
+
readonly getPublicPlugin: (input: GetPublicPluginInput$1) => Promise<GetPublicPluginResponse$1>;
|
|
11990
|
+
readonly getPublicPluginCode: (input: GetPublicPluginCodeInput$1) => Promise<GetPublicPluginCodeResponse$1>;
|
|
11521
11991
|
readonly createBot: (input: CreateBotInput$1) => Promise<CreateBotResponse$1>;
|
|
11522
11992
|
readonly updateBot: (input: UpdateBotInput$1) => Promise<UpdateBotResponse$1>;
|
|
11523
11993
|
readonly transferBot: (input: TransferBotInput$1) => Promise<TransferBotResponse$1>;
|
|
@@ -17438,17 +17908,424 @@ interface ListPublicIntegrationsResponse {
|
|
|
17438
17908
|
*/
|
|
17439
17909
|
name: string;
|
|
17440
17910
|
/**
|
|
17441
|
-
* Version of the [Integration](#schema_integration)
|
|
17911
|
+
* Version of the [Integration](#schema_integration)
|
|
17912
|
+
*/
|
|
17913
|
+
version: string;
|
|
17914
|
+
/**
|
|
17915
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
17916
|
+
*/
|
|
17917
|
+
createdAt: string;
|
|
17918
|
+
/**
|
|
17919
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
17920
|
+
*/
|
|
17921
|
+
updatedAt: string;
|
|
17922
|
+
/**
|
|
17923
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
17924
|
+
*/
|
|
17925
|
+
title: string;
|
|
17926
|
+
/**
|
|
17927
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
17928
|
+
*/
|
|
17929
|
+
description: string;
|
|
17930
|
+
/**
|
|
17931
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
17932
|
+
*/
|
|
17933
|
+
iconUrl: string;
|
|
17934
|
+
/**
|
|
17935
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
17936
|
+
*/
|
|
17937
|
+
public: boolean;
|
|
17938
|
+
/**
|
|
17939
|
+
* Status of the integration version verification
|
|
17940
|
+
*/
|
|
17941
|
+
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
17942
|
+
ownerWorkspace: {
|
|
17943
|
+
id: string;
|
|
17944
|
+
handle: string | null;
|
|
17945
|
+
name: string;
|
|
17946
|
+
};
|
|
17947
|
+
meta: {
|
|
17948
|
+
installs: number;
|
|
17949
|
+
views: number;
|
|
17950
|
+
};
|
|
17951
|
+
/**
|
|
17952
|
+
* Metadata about which fields matched the search criteria
|
|
17953
|
+
*/
|
|
17954
|
+
matchedOn?: {
|
|
17955
|
+
/**
|
|
17956
|
+
* Whether the integration name matched the search term
|
|
17957
|
+
*/
|
|
17958
|
+
name?: boolean;
|
|
17959
|
+
/**
|
|
17960
|
+
* Whether the integration title matched the search term
|
|
17961
|
+
*/
|
|
17962
|
+
title?: boolean;
|
|
17963
|
+
/**
|
|
17964
|
+
* Whether the integration description matched the search term
|
|
17965
|
+
*/
|
|
17966
|
+
description?: boolean;
|
|
17967
|
+
/**
|
|
17968
|
+
* Action names that matched the search term
|
|
17969
|
+
*/
|
|
17970
|
+
actions?: string[];
|
|
17971
|
+
/**
|
|
17972
|
+
* Interface names that matched the search term
|
|
17973
|
+
*/
|
|
17974
|
+
interfaces?: string[];
|
|
17975
|
+
};
|
|
17976
|
+
}[];
|
|
17977
|
+
meta: {
|
|
17978
|
+
/**
|
|
17979
|
+
* 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.
|
|
17980
|
+
*/
|
|
17981
|
+
nextToken?: string;
|
|
17982
|
+
};
|
|
17983
|
+
}
|
|
17984
|
+
|
|
17985
|
+
interface GetPublicIntegrationByIdRequestHeaders {
|
|
17986
|
+
}
|
|
17987
|
+
interface GetPublicIntegrationByIdRequestQuery {
|
|
17988
|
+
}
|
|
17989
|
+
interface GetPublicIntegrationByIdRequestParams {
|
|
17990
|
+
id: string;
|
|
17991
|
+
}
|
|
17992
|
+
interface GetPublicIntegrationByIdRequestBody {
|
|
17993
|
+
}
|
|
17994
|
+
type GetPublicIntegrationByIdInput = GetPublicIntegrationByIdRequestBody & GetPublicIntegrationByIdRequestHeaders & GetPublicIntegrationByIdRequestQuery & GetPublicIntegrationByIdRequestParams;
|
|
17995
|
+
interface GetPublicIntegrationByIdResponse {
|
|
17996
|
+
integration: {
|
|
17997
|
+
/**
|
|
17998
|
+
* ID of the [Integration](#schema_integration)
|
|
17999
|
+
*/
|
|
18000
|
+
id: string;
|
|
18001
|
+
/**
|
|
18002
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
18003
|
+
*/
|
|
18004
|
+
createdAt: string;
|
|
18005
|
+
/**
|
|
18006
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
18007
|
+
*/
|
|
18008
|
+
updatedAt: string;
|
|
18009
|
+
/**
|
|
18010
|
+
* Global identifier configuration of the [Integration](#schema_integration)
|
|
18011
|
+
*/
|
|
18012
|
+
identifier: {
|
|
18013
|
+
/**
|
|
18014
|
+
* VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier
|
|
18015
|
+
*/
|
|
18016
|
+
fallbackHandlerScript?: string;
|
|
18017
|
+
/**
|
|
18018
|
+
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
|
|
18019
|
+
*/
|
|
18020
|
+
extractScript?: string;
|
|
18021
|
+
};
|
|
18022
|
+
sandbox?: {
|
|
18023
|
+
/**
|
|
18024
|
+
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
|
|
18025
|
+
*/
|
|
18026
|
+
identifierExtractScript?: string;
|
|
18027
|
+
/**
|
|
18028
|
+
* VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
|
|
18029
|
+
*/
|
|
18030
|
+
messageExtractScript?: string;
|
|
18031
|
+
};
|
|
18032
|
+
/**
|
|
18033
|
+
* URL of the [Integration](#schema_integration)
|
|
18034
|
+
*/
|
|
18035
|
+
url: string;
|
|
18036
|
+
/**
|
|
18037
|
+
* Name of the [Integration](#schema_integration)
|
|
18038
|
+
*/
|
|
18039
|
+
name: string;
|
|
18040
|
+
/**
|
|
18041
|
+
* Version of the [Integration](#schema_integration)
|
|
18042
|
+
*/
|
|
18043
|
+
version: string;
|
|
18044
|
+
interfaces: {
|
|
18045
|
+
[k: string]: {
|
|
18046
|
+
/**
|
|
18047
|
+
* ID of the interface
|
|
18048
|
+
*/
|
|
18049
|
+
id: string;
|
|
18050
|
+
/**
|
|
18051
|
+
* Name of the interface
|
|
18052
|
+
*/
|
|
18053
|
+
name: string;
|
|
18054
|
+
/**
|
|
18055
|
+
* Version of the interface
|
|
18056
|
+
*/
|
|
18057
|
+
version: string;
|
|
18058
|
+
entities: {
|
|
18059
|
+
[k: string]: {
|
|
18060
|
+
name: string;
|
|
18061
|
+
};
|
|
18062
|
+
};
|
|
18063
|
+
actions: {
|
|
18064
|
+
[k: string]: {
|
|
18065
|
+
name: string;
|
|
18066
|
+
};
|
|
18067
|
+
};
|
|
18068
|
+
events: {
|
|
18069
|
+
[k: string]: {
|
|
18070
|
+
name: string;
|
|
18071
|
+
};
|
|
18072
|
+
};
|
|
18073
|
+
channels: {
|
|
18074
|
+
[k: string]: {
|
|
18075
|
+
name: string;
|
|
18076
|
+
};
|
|
18077
|
+
};
|
|
18078
|
+
};
|
|
18079
|
+
};
|
|
18080
|
+
/**
|
|
18081
|
+
* Configuration definition
|
|
17442
18082
|
*/
|
|
17443
|
-
|
|
18083
|
+
configuration: {
|
|
18084
|
+
/**
|
|
18085
|
+
* Title of the configuration
|
|
18086
|
+
*/
|
|
18087
|
+
title?: string;
|
|
18088
|
+
/**
|
|
18089
|
+
* Description of the configuration
|
|
18090
|
+
*/
|
|
18091
|
+
description?: string;
|
|
18092
|
+
/**
|
|
18093
|
+
* Identifier configuration of the [Integration](#schema_integration)
|
|
18094
|
+
*/
|
|
18095
|
+
identifier: {
|
|
18096
|
+
linkTemplateScript?: string;
|
|
18097
|
+
required: boolean;
|
|
18098
|
+
};
|
|
18099
|
+
/**
|
|
18100
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
18101
|
+
*/
|
|
18102
|
+
schema: {
|
|
18103
|
+
[k: string]: any;
|
|
18104
|
+
};
|
|
18105
|
+
};
|
|
18106
|
+
configurations: {
|
|
18107
|
+
/**
|
|
18108
|
+
* Configuration definition
|
|
18109
|
+
*/
|
|
18110
|
+
[k: string]: {
|
|
18111
|
+
/**
|
|
18112
|
+
* Title of the configuration
|
|
18113
|
+
*/
|
|
18114
|
+
title?: string;
|
|
18115
|
+
/**
|
|
18116
|
+
* Description of the configuration
|
|
18117
|
+
*/
|
|
18118
|
+
description?: string;
|
|
18119
|
+
/**
|
|
18120
|
+
* Identifier configuration of the [Integration](#schema_integration)
|
|
18121
|
+
*/
|
|
18122
|
+
identifier: {
|
|
18123
|
+
linkTemplateScript?: string;
|
|
18124
|
+
required: boolean;
|
|
18125
|
+
};
|
|
18126
|
+
/**
|
|
18127
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
18128
|
+
*/
|
|
18129
|
+
schema: {
|
|
18130
|
+
[k: string]: any;
|
|
18131
|
+
};
|
|
18132
|
+
};
|
|
18133
|
+
};
|
|
18134
|
+
channels: {
|
|
18135
|
+
/**
|
|
18136
|
+
* Channel definition
|
|
18137
|
+
*/
|
|
18138
|
+
[k: string]: {
|
|
18139
|
+
/**
|
|
18140
|
+
* Title of the channel
|
|
18141
|
+
*/
|
|
18142
|
+
title?: string;
|
|
18143
|
+
/**
|
|
18144
|
+
* Description of the channel
|
|
18145
|
+
*/
|
|
18146
|
+
description?: string;
|
|
18147
|
+
messages: {
|
|
18148
|
+
/**
|
|
18149
|
+
* Message definition
|
|
18150
|
+
*/
|
|
18151
|
+
[k: string]: {
|
|
18152
|
+
schema: {
|
|
18153
|
+
[k: string]: any;
|
|
18154
|
+
};
|
|
18155
|
+
};
|
|
18156
|
+
};
|
|
18157
|
+
/**
|
|
18158
|
+
* Conversation object configuration
|
|
18159
|
+
*/
|
|
18160
|
+
conversation: {
|
|
18161
|
+
tags: {
|
|
18162
|
+
/**
|
|
18163
|
+
* Definition of a tag that can be provided on the object
|
|
18164
|
+
*/
|
|
18165
|
+
[k: string]: {
|
|
18166
|
+
/**
|
|
18167
|
+
* Title of the tag
|
|
18168
|
+
*/
|
|
18169
|
+
title?: string;
|
|
18170
|
+
/**
|
|
18171
|
+
* Description of the tag
|
|
18172
|
+
*/
|
|
18173
|
+
description?: string;
|
|
18174
|
+
};
|
|
18175
|
+
};
|
|
18176
|
+
/**
|
|
18177
|
+
* The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.
|
|
18178
|
+
*/
|
|
18179
|
+
creation: {
|
|
18180
|
+
/**
|
|
18181
|
+
* Enable conversation creation
|
|
18182
|
+
*/
|
|
18183
|
+
enabled: boolean;
|
|
18184
|
+
/**
|
|
18185
|
+
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
18186
|
+
*/
|
|
18187
|
+
requiredTags: string[];
|
|
18188
|
+
};
|
|
18189
|
+
};
|
|
18190
|
+
/**
|
|
18191
|
+
* Message object configuration
|
|
18192
|
+
*/
|
|
18193
|
+
message: {
|
|
18194
|
+
tags: {
|
|
18195
|
+
/**
|
|
18196
|
+
* Definition of a tag that can be provided on the object
|
|
18197
|
+
*/
|
|
18198
|
+
[k: string]: {
|
|
18199
|
+
/**
|
|
18200
|
+
* Title of the tag
|
|
18201
|
+
*/
|
|
18202
|
+
title?: string;
|
|
18203
|
+
/**
|
|
18204
|
+
* Description of the tag
|
|
18205
|
+
*/
|
|
18206
|
+
description?: string;
|
|
18207
|
+
};
|
|
18208
|
+
};
|
|
18209
|
+
};
|
|
18210
|
+
};
|
|
18211
|
+
};
|
|
18212
|
+
states: {
|
|
18213
|
+
/**
|
|
18214
|
+
* State definition
|
|
18215
|
+
*/
|
|
18216
|
+
[k: string]: {
|
|
18217
|
+
/**
|
|
18218
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
18219
|
+
*/
|
|
18220
|
+
type: "conversation" | "user" | "integration";
|
|
18221
|
+
/**
|
|
18222
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
18223
|
+
*/
|
|
18224
|
+
schema: {
|
|
18225
|
+
[k: string]: any;
|
|
18226
|
+
};
|
|
18227
|
+
};
|
|
18228
|
+
};
|
|
18229
|
+
events: {
|
|
18230
|
+
/**
|
|
18231
|
+
* Event Definition
|
|
18232
|
+
*/
|
|
18233
|
+
[k: string]: {
|
|
18234
|
+
/**
|
|
18235
|
+
* Title of the event
|
|
18236
|
+
*/
|
|
18237
|
+
title?: string;
|
|
18238
|
+
/**
|
|
18239
|
+
* Description of the event
|
|
18240
|
+
*/
|
|
18241
|
+
description?: string;
|
|
18242
|
+
schema: {
|
|
18243
|
+
[k: string]: any;
|
|
18244
|
+
};
|
|
18245
|
+
};
|
|
18246
|
+
};
|
|
18247
|
+
actions: {
|
|
18248
|
+
/**
|
|
18249
|
+
* Action definition
|
|
18250
|
+
*/
|
|
18251
|
+
[k: string]: {
|
|
18252
|
+
/**
|
|
18253
|
+
* Title of the action
|
|
18254
|
+
*/
|
|
18255
|
+
title?: string;
|
|
18256
|
+
/**
|
|
18257
|
+
* Description of the action
|
|
18258
|
+
*/
|
|
18259
|
+
description?: string;
|
|
18260
|
+
billable?: boolean;
|
|
18261
|
+
cacheable?: boolean;
|
|
18262
|
+
input: {
|
|
18263
|
+
schema: {
|
|
18264
|
+
[k: string]: any;
|
|
18265
|
+
};
|
|
18266
|
+
};
|
|
18267
|
+
output: {
|
|
18268
|
+
schema: {
|
|
18269
|
+
[k: string]: any;
|
|
18270
|
+
};
|
|
18271
|
+
};
|
|
18272
|
+
};
|
|
18273
|
+
};
|
|
17444
18274
|
/**
|
|
17445
|
-
*
|
|
18275
|
+
* User object configuration
|
|
17446
18276
|
*/
|
|
17447
|
-
|
|
18277
|
+
user: {
|
|
18278
|
+
tags: {
|
|
18279
|
+
/**
|
|
18280
|
+
* Definition of a tag that can be provided on the object
|
|
18281
|
+
*/
|
|
18282
|
+
[k: string]: {
|
|
18283
|
+
/**
|
|
18284
|
+
* Title of the tag
|
|
18285
|
+
*/
|
|
18286
|
+
title?: string;
|
|
18287
|
+
/**
|
|
18288
|
+
* Description of the tag
|
|
18289
|
+
*/
|
|
18290
|
+
description?: string;
|
|
18291
|
+
};
|
|
18292
|
+
};
|
|
18293
|
+
/**
|
|
18294
|
+
* 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.
|
|
18295
|
+
*/
|
|
18296
|
+
creation: {
|
|
18297
|
+
/**
|
|
18298
|
+
* Enable user creation
|
|
18299
|
+
*/
|
|
18300
|
+
enabled: boolean;
|
|
18301
|
+
/**
|
|
18302
|
+
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
18303
|
+
*/
|
|
18304
|
+
requiredTags: string[];
|
|
18305
|
+
};
|
|
18306
|
+
};
|
|
18307
|
+
entities: {
|
|
18308
|
+
/**
|
|
18309
|
+
* Entity definition
|
|
18310
|
+
*/
|
|
18311
|
+
[k: string]: {
|
|
18312
|
+
/**
|
|
18313
|
+
* Title of the entity
|
|
18314
|
+
*/
|
|
18315
|
+
title?: string;
|
|
18316
|
+
/**
|
|
18317
|
+
* Description of the entity
|
|
18318
|
+
*/
|
|
18319
|
+
description?: string;
|
|
18320
|
+
schema: {
|
|
18321
|
+
[k: string]: any;
|
|
18322
|
+
};
|
|
18323
|
+
};
|
|
18324
|
+
};
|
|
17448
18325
|
/**
|
|
17449
|
-
*
|
|
18326
|
+
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
17450
18327
|
*/
|
|
17451
|
-
|
|
18328
|
+
dev: boolean;
|
|
17452
18329
|
/**
|
|
17453
18330
|
* Title of the integration. This is the name that will be displayed in the UI
|
|
17454
18331
|
*/
|
|
@@ -17460,7 +18337,11 @@ interface ListPublicIntegrationsResponse {
|
|
|
17460
18337
|
/**
|
|
17461
18338
|
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
17462
18339
|
*/
|
|
17463
|
-
iconUrl: string;
|
|
18340
|
+
iconUrl: string;
|
|
18341
|
+
/**
|
|
18342
|
+
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
18343
|
+
*/
|
|
18344
|
+
readmeUrl: string;
|
|
17464
18345
|
/**
|
|
17465
18346
|
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
17466
18347
|
*/
|
|
@@ -17469,6 +18350,10 @@ interface ListPublicIntegrationsResponse {
|
|
|
17469
18350
|
* Status of the integration version verification
|
|
17470
18351
|
*/
|
|
17471
18352
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
18353
|
+
/**
|
|
18354
|
+
* 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.
|
|
18355
|
+
*/
|
|
18356
|
+
secrets: string[];
|
|
17472
18357
|
ownerWorkspace: {
|
|
17473
18358
|
id: string;
|
|
17474
18359
|
handle: string | null;
|
|
@@ -17478,51 +18363,21 @@ interface ListPublicIntegrationsResponse {
|
|
|
17478
18363
|
installs: number;
|
|
17479
18364
|
views: number;
|
|
17480
18365
|
};
|
|
17481
|
-
/**
|
|
17482
|
-
* Metadata about which fields matched the search criteria
|
|
17483
|
-
*/
|
|
17484
|
-
matchedOn?: {
|
|
17485
|
-
/**
|
|
17486
|
-
* Whether the integration name matched the search term
|
|
17487
|
-
*/
|
|
17488
|
-
name?: boolean;
|
|
17489
|
-
/**
|
|
17490
|
-
* Whether the integration title matched the search term
|
|
17491
|
-
*/
|
|
17492
|
-
title?: boolean;
|
|
17493
|
-
/**
|
|
17494
|
-
* Whether the integration description matched the search term
|
|
17495
|
-
*/
|
|
17496
|
-
description?: boolean;
|
|
17497
|
-
/**
|
|
17498
|
-
* Action names that matched the search term
|
|
17499
|
-
*/
|
|
17500
|
-
actions?: string[];
|
|
17501
|
-
/**
|
|
17502
|
-
* Interface names that matched the search term
|
|
17503
|
-
*/
|
|
17504
|
-
interfaces?: string[];
|
|
17505
|
-
};
|
|
17506
|
-
}[];
|
|
17507
|
-
meta: {
|
|
17508
|
-
/**
|
|
17509
|
-
* 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.
|
|
17510
|
-
*/
|
|
17511
|
-
nextToken?: string;
|
|
17512
18366
|
};
|
|
17513
18367
|
}
|
|
17514
18368
|
|
|
17515
|
-
interface
|
|
18369
|
+
interface GetPublicIntegrationRequestHeaders {
|
|
17516
18370
|
}
|
|
17517
|
-
interface
|
|
18371
|
+
interface GetPublicIntegrationRequestQuery {
|
|
17518
18372
|
}
|
|
17519
|
-
interface
|
|
17520
|
-
|
|
18373
|
+
interface GetPublicIntegrationRequestParams {
|
|
18374
|
+
name: string;
|
|
18375
|
+
version: string;
|
|
17521
18376
|
}
|
|
17522
|
-
interface
|
|
18377
|
+
interface GetPublicIntegrationRequestBody {
|
|
17523
18378
|
}
|
|
17524
|
-
type
|
|
17525
|
-
interface
|
|
18379
|
+
type GetPublicIntegrationInput = GetPublicIntegrationRequestBody & GetPublicIntegrationRequestHeaders & GetPublicIntegrationRequestQuery & GetPublicIntegrationRequestParams;
|
|
18380
|
+
interface GetPublicIntegrationResponse {
|
|
17526
18381
|
integration: {
|
|
17527
18382
|
/**
|
|
17528
18383
|
* ID of the [Integration](#schema_integration)
|
|
@@ -17740,20 +18595,292 @@ interface GetPublicIntegrationByIdResponse {
|
|
|
17740
18595
|
};
|
|
17741
18596
|
};
|
|
17742
18597
|
states: {
|
|
17743
|
-
/**
|
|
17744
|
-
* State definition
|
|
17745
|
-
*/
|
|
18598
|
+
/**
|
|
18599
|
+
* State definition
|
|
18600
|
+
*/
|
|
18601
|
+
[k: string]: {
|
|
18602
|
+
/**
|
|
18603
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
18604
|
+
*/
|
|
18605
|
+
type: "conversation" | "user" | "integration";
|
|
18606
|
+
/**
|
|
18607
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
18608
|
+
*/
|
|
18609
|
+
schema: {
|
|
18610
|
+
[k: string]: any;
|
|
18611
|
+
};
|
|
18612
|
+
};
|
|
18613
|
+
};
|
|
18614
|
+
events: {
|
|
18615
|
+
/**
|
|
18616
|
+
* Event Definition
|
|
18617
|
+
*/
|
|
18618
|
+
[k: string]: {
|
|
18619
|
+
/**
|
|
18620
|
+
* Title of the event
|
|
18621
|
+
*/
|
|
18622
|
+
title?: string;
|
|
18623
|
+
/**
|
|
18624
|
+
* Description of the event
|
|
18625
|
+
*/
|
|
18626
|
+
description?: string;
|
|
18627
|
+
schema: {
|
|
18628
|
+
[k: string]: any;
|
|
18629
|
+
};
|
|
18630
|
+
};
|
|
18631
|
+
};
|
|
18632
|
+
actions: {
|
|
18633
|
+
/**
|
|
18634
|
+
* Action definition
|
|
18635
|
+
*/
|
|
18636
|
+
[k: string]: {
|
|
18637
|
+
/**
|
|
18638
|
+
* Title of the action
|
|
18639
|
+
*/
|
|
18640
|
+
title?: string;
|
|
18641
|
+
/**
|
|
18642
|
+
* Description of the action
|
|
18643
|
+
*/
|
|
18644
|
+
description?: string;
|
|
18645
|
+
billable?: boolean;
|
|
18646
|
+
cacheable?: boolean;
|
|
18647
|
+
input: {
|
|
18648
|
+
schema: {
|
|
18649
|
+
[k: string]: any;
|
|
18650
|
+
};
|
|
18651
|
+
};
|
|
18652
|
+
output: {
|
|
18653
|
+
schema: {
|
|
18654
|
+
[k: string]: any;
|
|
18655
|
+
};
|
|
18656
|
+
};
|
|
18657
|
+
};
|
|
18658
|
+
};
|
|
18659
|
+
/**
|
|
18660
|
+
* User object configuration
|
|
18661
|
+
*/
|
|
18662
|
+
user: {
|
|
18663
|
+
tags: {
|
|
18664
|
+
/**
|
|
18665
|
+
* Definition of a tag that can be provided on the object
|
|
18666
|
+
*/
|
|
18667
|
+
[k: string]: {
|
|
18668
|
+
/**
|
|
18669
|
+
* Title of the tag
|
|
18670
|
+
*/
|
|
18671
|
+
title?: string;
|
|
18672
|
+
/**
|
|
18673
|
+
* Description of the tag
|
|
18674
|
+
*/
|
|
18675
|
+
description?: string;
|
|
18676
|
+
};
|
|
18677
|
+
};
|
|
18678
|
+
/**
|
|
18679
|
+
* 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.
|
|
18680
|
+
*/
|
|
18681
|
+
creation: {
|
|
18682
|
+
/**
|
|
18683
|
+
* Enable user creation
|
|
18684
|
+
*/
|
|
18685
|
+
enabled: boolean;
|
|
18686
|
+
/**
|
|
18687
|
+
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
18688
|
+
*/
|
|
18689
|
+
requiredTags: string[];
|
|
18690
|
+
};
|
|
18691
|
+
};
|
|
18692
|
+
entities: {
|
|
18693
|
+
/**
|
|
18694
|
+
* Entity definition
|
|
18695
|
+
*/
|
|
18696
|
+
[k: string]: {
|
|
18697
|
+
/**
|
|
18698
|
+
* Title of the entity
|
|
18699
|
+
*/
|
|
18700
|
+
title?: string;
|
|
18701
|
+
/**
|
|
18702
|
+
* Description of the entity
|
|
18703
|
+
*/
|
|
18704
|
+
description?: string;
|
|
18705
|
+
schema: {
|
|
18706
|
+
[k: string]: any;
|
|
18707
|
+
};
|
|
18708
|
+
};
|
|
18709
|
+
};
|
|
18710
|
+
/**
|
|
18711
|
+
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
18712
|
+
*/
|
|
18713
|
+
dev: boolean;
|
|
18714
|
+
/**
|
|
18715
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
18716
|
+
*/
|
|
18717
|
+
title: string;
|
|
18718
|
+
/**
|
|
18719
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
18720
|
+
*/
|
|
18721
|
+
description: string;
|
|
18722
|
+
/**
|
|
18723
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
18724
|
+
*/
|
|
18725
|
+
iconUrl: string;
|
|
18726
|
+
/**
|
|
18727
|
+
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
18728
|
+
*/
|
|
18729
|
+
readmeUrl: string;
|
|
18730
|
+
/**
|
|
18731
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
18732
|
+
*/
|
|
18733
|
+
public: boolean;
|
|
18734
|
+
/**
|
|
18735
|
+
* Status of the integration version verification
|
|
18736
|
+
*/
|
|
18737
|
+
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
18738
|
+
/**
|
|
18739
|
+
* 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.
|
|
18740
|
+
*/
|
|
18741
|
+
secrets: string[];
|
|
18742
|
+
ownerWorkspace: {
|
|
18743
|
+
id: string;
|
|
18744
|
+
handle: string | null;
|
|
18745
|
+
name: string;
|
|
18746
|
+
};
|
|
18747
|
+
meta: {
|
|
18748
|
+
installs: number;
|
|
18749
|
+
views: number;
|
|
18750
|
+
};
|
|
18751
|
+
};
|
|
18752
|
+
}
|
|
18753
|
+
|
|
18754
|
+
interface ListPublicPluginsRequestHeaders {
|
|
18755
|
+
}
|
|
18756
|
+
interface ListPublicPluginsRequestQuery {
|
|
18757
|
+
nextToken?: string;
|
|
18758
|
+
name?: string;
|
|
18759
|
+
version?: string;
|
|
18760
|
+
}
|
|
18761
|
+
interface ListPublicPluginsRequestParams {
|
|
18762
|
+
}
|
|
18763
|
+
interface ListPublicPluginsRequestBody {
|
|
18764
|
+
}
|
|
18765
|
+
type ListPublicPluginsInput = ListPublicPluginsRequestBody & ListPublicPluginsRequestHeaders & ListPublicPluginsRequestQuery & ListPublicPluginsRequestParams;
|
|
18766
|
+
interface ListPublicPluginsResponse {
|
|
18767
|
+
plugins: {
|
|
18768
|
+
/**
|
|
18769
|
+
* ID of the [Plugin](#schema_plugin)
|
|
18770
|
+
*/
|
|
18771
|
+
id: string;
|
|
18772
|
+
/**
|
|
18773
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
18774
|
+
*/
|
|
18775
|
+
createdAt: string;
|
|
18776
|
+
/**
|
|
18777
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
18778
|
+
*/
|
|
18779
|
+
updatedAt: string;
|
|
18780
|
+
/**
|
|
18781
|
+
* Name of the [Plugin](#schema_plugin)
|
|
18782
|
+
*/
|
|
18783
|
+
name: string;
|
|
18784
|
+
/**
|
|
18785
|
+
* Version of the [Plugin](#schema_plugin)
|
|
18786
|
+
*/
|
|
18787
|
+
version: string;
|
|
18788
|
+
/**
|
|
18789
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
18790
|
+
*/
|
|
18791
|
+
title: string;
|
|
18792
|
+
/**
|
|
18793
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
18794
|
+
*/
|
|
18795
|
+
description: string;
|
|
18796
|
+
/**
|
|
18797
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
18798
|
+
*/
|
|
18799
|
+
iconUrl: string;
|
|
18800
|
+
/**
|
|
18801
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
18802
|
+
*/
|
|
18803
|
+
readmeUrl: string;
|
|
18804
|
+
/**
|
|
18805
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
18806
|
+
*/
|
|
18807
|
+
public: boolean;
|
|
18808
|
+
}[];
|
|
18809
|
+
meta: {
|
|
18810
|
+
/**
|
|
18811
|
+
* 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.
|
|
18812
|
+
*/
|
|
18813
|
+
nextToken?: string;
|
|
18814
|
+
};
|
|
18815
|
+
}
|
|
18816
|
+
|
|
18817
|
+
interface GetPublicPluginByIdRequestHeaders {
|
|
18818
|
+
}
|
|
18819
|
+
interface GetPublicPluginByIdRequestQuery {
|
|
18820
|
+
}
|
|
18821
|
+
interface GetPublicPluginByIdRequestParams {
|
|
18822
|
+
id: string;
|
|
18823
|
+
}
|
|
18824
|
+
interface GetPublicPluginByIdRequestBody {
|
|
18825
|
+
}
|
|
18826
|
+
type GetPublicPluginByIdInput = GetPublicPluginByIdRequestBody & GetPublicPluginByIdRequestHeaders & GetPublicPluginByIdRequestQuery & GetPublicPluginByIdRequestParams;
|
|
18827
|
+
interface GetPublicPluginByIdResponse {
|
|
18828
|
+
plugin: {
|
|
18829
|
+
/**
|
|
18830
|
+
* ID of the [Plugin](#schema_plugin)
|
|
18831
|
+
*/
|
|
18832
|
+
id: string;
|
|
18833
|
+
/**
|
|
18834
|
+
* Name of the [Plugin](#schema_plugin)
|
|
18835
|
+
*/
|
|
18836
|
+
name: string;
|
|
18837
|
+
/**
|
|
18838
|
+
* Version of the [Plugin](#schema_plugin)
|
|
18839
|
+
*/
|
|
18840
|
+
version: string;
|
|
18841
|
+
/**
|
|
18842
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
18843
|
+
*/
|
|
18844
|
+
createdAt: string;
|
|
18845
|
+
/**
|
|
18846
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
18847
|
+
*/
|
|
18848
|
+
updatedAt: string;
|
|
18849
|
+
/**
|
|
18850
|
+
* Configuration definition
|
|
18851
|
+
*/
|
|
18852
|
+
configuration: {
|
|
18853
|
+
/**
|
|
18854
|
+
* Title of the configuration
|
|
18855
|
+
*/
|
|
18856
|
+
title?: string;
|
|
18857
|
+
/**
|
|
18858
|
+
* Description of the configuration
|
|
18859
|
+
*/
|
|
18860
|
+
description?: string;
|
|
18861
|
+
/**
|
|
18862
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
18863
|
+
*/
|
|
18864
|
+
schema: {
|
|
18865
|
+
[k: string]: any;
|
|
18866
|
+
};
|
|
18867
|
+
};
|
|
18868
|
+
states: {
|
|
17746
18869
|
[k: string]: {
|
|
17747
18870
|
/**
|
|
17748
|
-
* Type of the [State](#schema_state) (`conversation`, `user` or `
|
|
18871
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
17749
18872
|
*/
|
|
17750
|
-
type: "conversation" | "user" | "
|
|
18873
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
17751
18874
|
/**
|
|
17752
18875
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
17753
18876
|
*/
|
|
17754
18877
|
schema: {
|
|
17755
18878
|
[k: string]: any;
|
|
17756
18879
|
};
|
|
18880
|
+
/**
|
|
18881
|
+
* 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.
|
|
18882
|
+
*/
|
|
18883
|
+
expiry?: number;
|
|
17757
18884
|
};
|
|
17758
18885
|
};
|
|
17759
18886
|
events: {
|
|
@@ -17801,6 +18928,22 @@ interface GetPublicIntegrationByIdResponse {
|
|
|
17801
18928
|
};
|
|
17802
18929
|
};
|
|
17803
18930
|
};
|
|
18931
|
+
dependencies: {
|
|
18932
|
+
interfaces: {
|
|
18933
|
+
[k: string]: {
|
|
18934
|
+
id: string;
|
|
18935
|
+
name: string;
|
|
18936
|
+
version: string;
|
|
18937
|
+
};
|
|
18938
|
+
};
|
|
18939
|
+
integrations: {
|
|
18940
|
+
[k: string]: {
|
|
18941
|
+
id: string;
|
|
18942
|
+
name: string;
|
|
18943
|
+
version: string;
|
|
18944
|
+
};
|
|
18945
|
+
};
|
|
18946
|
+
};
|
|
17804
18947
|
/**
|
|
17805
18948
|
* User object configuration
|
|
17806
18949
|
*/
|
|
@@ -17820,179 +18963,84 @@ interface GetPublicIntegrationByIdResponse {
|
|
|
17820
18963
|
description?: string;
|
|
17821
18964
|
};
|
|
17822
18965
|
};
|
|
17823
|
-
/**
|
|
17824
|
-
* 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.
|
|
17825
|
-
*/
|
|
17826
|
-
creation: {
|
|
17827
|
-
/**
|
|
17828
|
-
* Enable user creation
|
|
17829
|
-
*/
|
|
17830
|
-
enabled: boolean;
|
|
17831
|
-
/**
|
|
17832
|
-
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
17833
|
-
*/
|
|
17834
|
-
requiredTags: string[];
|
|
17835
|
-
};
|
|
17836
18966
|
};
|
|
17837
|
-
|
|
17838
|
-
|
|
17839
|
-
|
|
17840
|
-
|
|
17841
|
-
|
|
17842
|
-
/**
|
|
17843
|
-
* Title of the entity
|
|
17844
|
-
*/
|
|
17845
|
-
title?: string;
|
|
18967
|
+
/**
|
|
18968
|
+
* Conversation object configuration
|
|
18969
|
+
*/
|
|
18970
|
+
conversation: {
|
|
18971
|
+
tags: {
|
|
17846
18972
|
/**
|
|
17847
|
-
*
|
|
18973
|
+
* Definition of a tag that can be provided on the object
|
|
17848
18974
|
*/
|
|
17849
|
-
|
|
17850
|
-
|
|
17851
|
-
|
|
18975
|
+
[k: string]: {
|
|
18976
|
+
/**
|
|
18977
|
+
* Title of the tag
|
|
18978
|
+
*/
|
|
18979
|
+
title?: string;
|
|
18980
|
+
/**
|
|
18981
|
+
* Description of the tag
|
|
18982
|
+
*/
|
|
18983
|
+
description?: string;
|
|
17852
18984
|
};
|
|
17853
18985
|
};
|
|
17854
18986
|
};
|
|
17855
18987
|
/**
|
|
17856
|
-
*
|
|
17857
|
-
*/
|
|
17858
|
-
dev: boolean;
|
|
17859
|
-
/**
|
|
17860
|
-
* Title of the integration. This is the name that will be displayed in the UI
|
|
18988
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
17861
18989
|
*/
|
|
17862
18990
|
title: string;
|
|
17863
18991
|
/**
|
|
17864
|
-
* Description of the
|
|
18992
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
17865
18993
|
*/
|
|
17866
18994
|
description: string;
|
|
17867
18995
|
/**
|
|
17868
|
-
* URL of the icon of the
|
|
18996
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
17869
18997
|
*/
|
|
17870
18998
|
iconUrl: string;
|
|
17871
18999
|
/**
|
|
17872
|
-
* URL of the readme of the
|
|
19000
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
17873
19001
|
*/
|
|
17874
19002
|
readmeUrl: string;
|
|
17875
19003
|
/**
|
|
17876
|
-
* Indicates if the
|
|
17877
|
-
*/
|
|
17878
|
-
public: boolean;
|
|
17879
|
-
|
|
17880
|
-
|
|
17881
|
-
|
|
17882
|
-
|
|
17883
|
-
|
|
17884
|
-
|
|
17885
|
-
|
|
17886
|
-
|
|
17887
|
-
|
|
17888
|
-
|
|
17889
|
-
|
|
17890
|
-
|
|
17891
|
-
|
|
17892
|
-
|
|
17893
|
-
|
|
17894
|
-
|
|
17895
|
-
|
|
17896
|
-
|
|
17897
|
-
|
|
17898
|
-
|
|
17899
|
-
|
|
17900
|
-
|
|
17901
|
-
|
|
17902
|
-
|
|
17903
|
-
|
|
17904
|
-
|
|
17905
|
-
|
|
17906
|
-
|
|
17907
|
-
|
|
17908
|
-
|
|
17909
|
-
|
|
17910
|
-
|
|
17911
|
-
|
|
17912
|
-
|
|
17913
|
-
|
|
17914
|
-
|
|
17915
|
-
|
|
17916
|
-
/**
|
|
17917
|
-
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
17918
|
-
*/
|
|
17919
|
-
createdAt: string;
|
|
17920
|
-
/**
|
|
17921
|
-
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
17922
|
-
*/
|
|
17923
|
-
updatedAt: string;
|
|
17924
|
-
/**
|
|
17925
|
-
* Global identifier configuration of the [Integration](#schema_integration)
|
|
17926
|
-
*/
|
|
17927
|
-
identifier: {
|
|
17928
|
-
/**
|
|
17929
|
-
* VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier
|
|
17930
|
-
*/
|
|
17931
|
-
fallbackHandlerScript?: string;
|
|
17932
|
-
/**
|
|
17933
|
-
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
|
|
17934
|
-
*/
|
|
17935
|
-
extractScript?: string;
|
|
17936
|
-
};
|
|
17937
|
-
sandbox?: {
|
|
17938
|
-
/**
|
|
17939
|
-
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
|
|
17940
|
-
*/
|
|
17941
|
-
identifierExtractScript?: string;
|
|
17942
|
-
/**
|
|
17943
|
-
* VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
|
|
17944
|
-
*/
|
|
17945
|
-
messageExtractScript?: string;
|
|
17946
|
-
};
|
|
17947
|
-
/**
|
|
17948
|
-
* URL of the [Integration](#schema_integration)
|
|
17949
|
-
*/
|
|
17950
|
-
url: string;
|
|
17951
|
-
/**
|
|
17952
|
-
* Name of the [Integration](#schema_integration)
|
|
17953
|
-
*/
|
|
17954
|
-
name: string;
|
|
17955
|
-
/**
|
|
17956
|
-
* Version of the [Integration](#schema_integration)
|
|
17957
|
-
*/
|
|
17958
|
-
version: string;
|
|
17959
|
-
interfaces: {
|
|
17960
|
-
[k: string]: {
|
|
17961
|
-
/**
|
|
17962
|
-
* ID of the interface
|
|
17963
|
-
*/
|
|
17964
|
-
id: string;
|
|
17965
|
-
/**
|
|
17966
|
-
* Name of the interface
|
|
17967
|
-
*/
|
|
17968
|
-
name: string;
|
|
17969
|
-
/**
|
|
17970
|
-
* Version of the interface
|
|
17971
|
-
*/
|
|
17972
|
-
version: string;
|
|
17973
|
-
entities: {
|
|
17974
|
-
[k: string]: {
|
|
17975
|
-
name: string;
|
|
17976
|
-
};
|
|
17977
|
-
};
|
|
17978
|
-
actions: {
|
|
17979
|
-
[k: string]: {
|
|
17980
|
-
name: string;
|
|
17981
|
-
};
|
|
17982
|
-
};
|
|
17983
|
-
events: {
|
|
17984
|
-
[k: string]: {
|
|
17985
|
-
name: string;
|
|
17986
|
-
};
|
|
17987
|
-
};
|
|
17988
|
-
channels: {
|
|
17989
|
-
[k: string]: {
|
|
17990
|
-
name: string;
|
|
17991
|
-
};
|
|
17992
|
-
};
|
|
17993
|
-
};
|
|
17994
|
-
};
|
|
17995
|
-
/**
|
|
19004
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
19005
|
+
*/
|
|
19006
|
+
public: boolean;
|
|
19007
|
+
};
|
|
19008
|
+
}
|
|
19009
|
+
|
|
19010
|
+
interface GetPublicPluginRequestHeaders {
|
|
19011
|
+
}
|
|
19012
|
+
interface GetPublicPluginRequestQuery {
|
|
19013
|
+
}
|
|
19014
|
+
interface GetPublicPluginRequestParams {
|
|
19015
|
+
name: string;
|
|
19016
|
+
version: string;
|
|
19017
|
+
}
|
|
19018
|
+
interface GetPublicPluginRequestBody {
|
|
19019
|
+
}
|
|
19020
|
+
type GetPublicPluginInput = GetPublicPluginRequestBody & GetPublicPluginRequestHeaders & GetPublicPluginRequestQuery & GetPublicPluginRequestParams;
|
|
19021
|
+
interface GetPublicPluginResponse {
|
|
19022
|
+
plugin: {
|
|
19023
|
+
/**
|
|
19024
|
+
* ID of the [Plugin](#schema_plugin)
|
|
19025
|
+
*/
|
|
19026
|
+
id: string;
|
|
19027
|
+
/**
|
|
19028
|
+
* Name of the [Plugin](#schema_plugin)
|
|
19029
|
+
*/
|
|
19030
|
+
name: string;
|
|
19031
|
+
/**
|
|
19032
|
+
* Version of the [Plugin](#schema_plugin)
|
|
19033
|
+
*/
|
|
19034
|
+
version: string;
|
|
19035
|
+
/**
|
|
19036
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
19037
|
+
*/
|
|
19038
|
+
createdAt: string;
|
|
19039
|
+
/**
|
|
19040
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
19041
|
+
*/
|
|
19042
|
+
updatedAt: string;
|
|
19043
|
+
/**
|
|
17996
19044
|
* Configuration definition
|
|
17997
19045
|
*/
|
|
17998
19046
|
configuration: {
|
|
@@ -18004,13 +19052,6 @@ interface GetPublicIntegrationResponse {
|
|
|
18004
19052
|
* Description of the configuration
|
|
18005
19053
|
*/
|
|
18006
19054
|
description?: string;
|
|
18007
|
-
/**
|
|
18008
|
-
* Identifier configuration of the [Integration](#schema_integration)
|
|
18009
|
-
*/
|
|
18010
|
-
identifier: {
|
|
18011
|
-
linkTemplateScript?: string;
|
|
18012
|
-
required: boolean;
|
|
18013
|
-
};
|
|
18014
19055
|
/**
|
|
18015
19056
|
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
18016
19057
|
*/
|
|
@@ -18018,127 +19059,22 @@ interface GetPublicIntegrationResponse {
|
|
|
18018
19059
|
[k: string]: any;
|
|
18019
19060
|
};
|
|
18020
19061
|
};
|
|
18021
|
-
configurations: {
|
|
18022
|
-
/**
|
|
18023
|
-
* Configuration definition
|
|
18024
|
-
*/
|
|
18025
|
-
[k: string]: {
|
|
18026
|
-
/**
|
|
18027
|
-
* Title of the configuration
|
|
18028
|
-
*/
|
|
18029
|
-
title?: string;
|
|
18030
|
-
/**
|
|
18031
|
-
* Description of the configuration
|
|
18032
|
-
*/
|
|
18033
|
-
description?: string;
|
|
18034
|
-
/**
|
|
18035
|
-
* Identifier configuration of the [Integration](#schema_integration)
|
|
18036
|
-
*/
|
|
18037
|
-
identifier: {
|
|
18038
|
-
linkTemplateScript?: string;
|
|
18039
|
-
required: boolean;
|
|
18040
|
-
};
|
|
18041
|
-
/**
|
|
18042
|
-
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
18043
|
-
*/
|
|
18044
|
-
schema: {
|
|
18045
|
-
[k: string]: any;
|
|
18046
|
-
};
|
|
18047
|
-
};
|
|
18048
|
-
};
|
|
18049
|
-
channels: {
|
|
18050
|
-
/**
|
|
18051
|
-
* Channel definition
|
|
18052
|
-
*/
|
|
18053
|
-
[k: string]: {
|
|
18054
|
-
/**
|
|
18055
|
-
* Title of the channel
|
|
18056
|
-
*/
|
|
18057
|
-
title?: string;
|
|
18058
|
-
/**
|
|
18059
|
-
* Description of the channel
|
|
18060
|
-
*/
|
|
18061
|
-
description?: string;
|
|
18062
|
-
messages: {
|
|
18063
|
-
/**
|
|
18064
|
-
* Message definition
|
|
18065
|
-
*/
|
|
18066
|
-
[k: string]: {
|
|
18067
|
-
schema: {
|
|
18068
|
-
[k: string]: any;
|
|
18069
|
-
};
|
|
18070
|
-
};
|
|
18071
|
-
};
|
|
18072
|
-
/**
|
|
18073
|
-
* Conversation object configuration
|
|
18074
|
-
*/
|
|
18075
|
-
conversation: {
|
|
18076
|
-
tags: {
|
|
18077
|
-
/**
|
|
18078
|
-
* Definition of a tag that can be provided on the object
|
|
18079
|
-
*/
|
|
18080
|
-
[k: string]: {
|
|
18081
|
-
/**
|
|
18082
|
-
* Title of the tag
|
|
18083
|
-
*/
|
|
18084
|
-
title?: string;
|
|
18085
|
-
/**
|
|
18086
|
-
* Description of the tag
|
|
18087
|
-
*/
|
|
18088
|
-
description?: string;
|
|
18089
|
-
};
|
|
18090
|
-
};
|
|
18091
|
-
/**
|
|
18092
|
-
* The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.
|
|
18093
|
-
*/
|
|
18094
|
-
creation: {
|
|
18095
|
-
/**
|
|
18096
|
-
* Enable conversation creation
|
|
18097
|
-
*/
|
|
18098
|
-
enabled: boolean;
|
|
18099
|
-
/**
|
|
18100
|
-
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
18101
|
-
*/
|
|
18102
|
-
requiredTags: string[];
|
|
18103
|
-
};
|
|
18104
|
-
};
|
|
18105
|
-
/**
|
|
18106
|
-
* Message object configuration
|
|
18107
|
-
*/
|
|
18108
|
-
message: {
|
|
18109
|
-
tags: {
|
|
18110
|
-
/**
|
|
18111
|
-
* Definition of a tag that can be provided on the object
|
|
18112
|
-
*/
|
|
18113
|
-
[k: string]: {
|
|
18114
|
-
/**
|
|
18115
|
-
* Title of the tag
|
|
18116
|
-
*/
|
|
18117
|
-
title?: string;
|
|
18118
|
-
/**
|
|
18119
|
-
* Description of the tag
|
|
18120
|
-
*/
|
|
18121
|
-
description?: string;
|
|
18122
|
-
};
|
|
18123
|
-
};
|
|
18124
|
-
};
|
|
18125
|
-
};
|
|
18126
|
-
};
|
|
18127
19062
|
states: {
|
|
18128
|
-
/**
|
|
18129
|
-
* State definition
|
|
18130
|
-
*/
|
|
18131
19063
|
[k: string]: {
|
|
18132
19064
|
/**
|
|
18133
|
-
* Type of the [State](#schema_state) (`conversation`, `user` or `
|
|
19065
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
18134
19066
|
*/
|
|
18135
|
-
type: "conversation" | "user" | "
|
|
19067
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
18136
19068
|
/**
|
|
18137
19069
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
18138
19070
|
*/
|
|
18139
19071
|
schema: {
|
|
18140
19072
|
[k: string]: any;
|
|
18141
19073
|
};
|
|
19074
|
+
/**
|
|
19075
|
+
* 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.
|
|
19076
|
+
*/
|
|
19077
|
+
expiry?: number;
|
|
18142
19078
|
};
|
|
18143
19079
|
};
|
|
18144
19080
|
events: {
|
|
@@ -18186,6 +19122,22 @@ interface GetPublicIntegrationResponse {
|
|
|
18186
19122
|
};
|
|
18187
19123
|
};
|
|
18188
19124
|
};
|
|
19125
|
+
dependencies: {
|
|
19126
|
+
interfaces: {
|
|
19127
|
+
[k: string]: {
|
|
19128
|
+
id: string;
|
|
19129
|
+
name: string;
|
|
19130
|
+
version: string;
|
|
19131
|
+
};
|
|
19132
|
+
};
|
|
19133
|
+
integrations: {
|
|
19134
|
+
[k: string]: {
|
|
19135
|
+
id: string;
|
|
19136
|
+
name: string;
|
|
19137
|
+
version: string;
|
|
19138
|
+
};
|
|
19139
|
+
};
|
|
19140
|
+
};
|
|
18189
19141
|
/**
|
|
18190
19142
|
* User object configuration
|
|
18191
19143
|
*/
|
|
@@ -18205,82 +19157,65 @@ interface GetPublicIntegrationResponse {
|
|
|
18205
19157
|
description?: string;
|
|
18206
19158
|
};
|
|
18207
19159
|
};
|
|
18208
|
-
/**
|
|
18209
|
-
* 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.
|
|
18210
|
-
*/
|
|
18211
|
-
creation: {
|
|
18212
|
-
/**
|
|
18213
|
-
* Enable user creation
|
|
18214
|
-
*/
|
|
18215
|
-
enabled: boolean;
|
|
18216
|
-
/**
|
|
18217
|
-
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
18218
|
-
*/
|
|
18219
|
-
requiredTags: string[];
|
|
18220
|
-
};
|
|
18221
19160
|
};
|
|
18222
|
-
|
|
18223
|
-
|
|
18224
|
-
|
|
18225
|
-
|
|
18226
|
-
|
|
18227
|
-
/**
|
|
18228
|
-
* Title of the entity
|
|
18229
|
-
*/
|
|
18230
|
-
title?: string;
|
|
19161
|
+
/**
|
|
19162
|
+
* Conversation object configuration
|
|
19163
|
+
*/
|
|
19164
|
+
conversation: {
|
|
19165
|
+
tags: {
|
|
18231
19166
|
/**
|
|
18232
|
-
*
|
|
19167
|
+
* Definition of a tag that can be provided on the object
|
|
18233
19168
|
*/
|
|
18234
|
-
|
|
18235
|
-
|
|
18236
|
-
|
|
19169
|
+
[k: string]: {
|
|
19170
|
+
/**
|
|
19171
|
+
* Title of the tag
|
|
19172
|
+
*/
|
|
19173
|
+
title?: string;
|
|
19174
|
+
/**
|
|
19175
|
+
* Description of the tag
|
|
19176
|
+
*/
|
|
19177
|
+
description?: string;
|
|
18237
19178
|
};
|
|
18238
19179
|
};
|
|
18239
19180
|
};
|
|
18240
19181
|
/**
|
|
18241
|
-
*
|
|
18242
|
-
*/
|
|
18243
|
-
dev: boolean;
|
|
18244
|
-
/**
|
|
18245
|
-
* Title of the integration. This is the name that will be displayed in the UI
|
|
19182
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
18246
19183
|
*/
|
|
18247
19184
|
title: string;
|
|
18248
19185
|
/**
|
|
18249
|
-
* Description of the
|
|
19186
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
18250
19187
|
*/
|
|
18251
19188
|
description: string;
|
|
18252
19189
|
/**
|
|
18253
|
-
* URL of the icon of the
|
|
19190
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
18254
19191
|
*/
|
|
18255
19192
|
iconUrl: string;
|
|
18256
19193
|
/**
|
|
18257
|
-
* URL of the readme of the
|
|
19194
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
18258
19195
|
*/
|
|
18259
19196
|
readmeUrl: string;
|
|
18260
19197
|
/**
|
|
18261
|
-
* Indicates if the
|
|
19198
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
18262
19199
|
*/
|
|
18263
19200
|
public: boolean;
|
|
18264
|
-
/**
|
|
18265
|
-
* Status of the integration version verification
|
|
18266
|
-
*/
|
|
18267
|
-
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
18268
|
-
/**
|
|
18269
|
-
* 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.
|
|
18270
|
-
*/
|
|
18271
|
-
secrets: string[];
|
|
18272
|
-
ownerWorkspace: {
|
|
18273
|
-
id: string;
|
|
18274
|
-
handle: string | null;
|
|
18275
|
-
name: string;
|
|
18276
|
-
};
|
|
18277
|
-
meta: {
|
|
18278
|
-
installs: number;
|
|
18279
|
-
views: number;
|
|
18280
|
-
};
|
|
18281
19201
|
};
|
|
18282
19202
|
}
|
|
18283
19203
|
|
|
19204
|
+
interface GetPublicPluginCodeRequestHeaders {
|
|
19205
|
+
}
|
|
19206
|
+
interface GetPublicPluginCodeRequestQuery {
|
|
19207
|
+
}
|
|
19208
|
+
interface GetPublicPluginCodeRequestParams {
|
|
19209
|
+
id: string;
|
|
19210
|
+
platform: "node" | "browser";
|
|
19211
|
+
}
|
|
19212
|
+
interface GetPublicPluginCodeRequestBody {
|
|
19213
|
+
}
|
|
19214
|
+
type GetPublicPluginCodeInput = GetPublicPluginCodeRequestBody & GetPublicPluginCodeRequestHeaders & GetPublicPluginCodeRequestQuery & GetPublicPluginCodeRequestParams;
|
|
19215
|
+
interface GetPublicPluginCodeResponse {
|
|
19216
|
+
code: string;
|
|
19217
|
+
}
|
|
19218
|
+
|
|
18284
19219
|
interface CreateBotRequestHeaders {
|
|
18285
19220
|
}
|
|
18286
19221
|
interface CreateBotRequestQuery {
|
|
@@ -25455,6 +26390,7 @@ interface ListPluginsRequestHeaders {
|
|
|
25455
26390
|
interface ListPluginsRequestQuery {
|
|
25456
26391
|
nextToken?: string;
|
|
25457
26392
|
name?: string;
|
|
26393
|
+
version?: string;
|
|
25458
26394
|
}
|
|
25459
26395
|
interface ListPluginsRequestParams {
|
|
25460
26396
|
}
|
|
@@ -30049,6 +30985,10 @@ declare class Client$1 {
|
|
|
30049
30985
|
readonly listPublicIntegrations: (input: ListPublicIntegrationsInput) => Promise<ListPublicIntegrationsResponse>;
|
|
30050
30986
|
readonly getPublicIntegrationById: (input: GetPublicIntegrationByIdInput) => Promise<GetPublicIntegrationByIdResponse>;
|
|
30051
30987
|
readonly getPublicIntegration: (input: GetPublicIntegrationInput) => Promise<GetPublicIntegrationResponse>;
|
|
30988
|
+
readonly listPublicPlugins: (input: ListPublicPluginsInput) => Promise<ListPublicPluginsResponse>;
|
|
30989
|
+
readonly getPublicPluginById: (input: GetPublicPluginByIdInput) => Promise<GetPublicPluginByIdResponse>;
|
|
30990
|
+
readonly getPublicPlugin: (input: GetPublicPluginInput) => Promise<GetPublicPluginResponse>;
|
|
30991
|
+
readonly getPublicPluginCode: (input: GetPublicPluginCodeInput) => Promise<GetPublicPluginCodeResponse>;
|
|
30052
30992
|
readonly createBot: (input: CreateBotInput) => Promise<CreateBotResponse>;
|
|
30053
30993
|
readonly updateBot: (input: UpdateBotInput) => Promise<UpdateBotResponse>;
|
|
30054
30994
|
readonly transferBot: (input: TransferBotInput) => Promise<TransferBotResponse>;
|