@botpress/client 1.3.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 +2213 -1179
- package/dist/index.mjs +3 -3
- package/dist/index.mjs.map +4 -4
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -3210,7 +3210,7 @@ interface ListPublicIntegrationsResponse$1 {
|
|
|
3210
3210
|
*/
|
|
3211
3211
|
iconUrl: string;
|
|
3212
3212
|
/**
|
|
3213
|
-
*
|
|
3213
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
3214
3214
|
*/
|
|
3215
3215
|
public: boolean;
|
|
3216
3216
|
/**
|
|
@@ -3621,7 +3621,7 @@ interface GetPublicIntegrationByIdResponse$1 {
|
|
|
3621
3621
|
*/
|
|
3622
3622
|
readmeUrl: string;
|
|
3623
3623
|
/**
|
|
3624
|
-
*
|
|
3624
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
3625
3625
|
*/
|
|
3626
3626
|
public: boolean;
|
|
3627
3627
|
/**
|
|
@@ -4006,7 +4006,7 @@ interface GetPublicIntegrationResponse$1 {
|
|
|
4006
4006
|
*/
|
|
4007
4007
|
readmeUrl: string;
|
|
4008
4008
|
/**
|
|
4009
|
-
*
|
|
4009
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
4010
4010
|
*/
|
|
4011
4011
|
public: boolean;
|
|
4012
4012
|
/**
|
|
@@ -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
|
-
* Idicates 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.
|
|
4366
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
|
|
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
|
};
|
|
4486
|
-
|
|
4487
|
-
|
|
4488
|
-
|
|
4489
|
-
|
|
4490
|
-
|
|
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
|
+
};
|
|
4491
4418
|
};
|
|
4492
4419
|
/**
|
|
4493
|
-
*
|
|
4420
|
+
* User object configuration
|
|
4494
4421
|
*/
|
|
4495
|
-
|
|
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
|
+
};
|
|
4438
|
+
};
|
|
4496
4439
|
/**
|
|
4497
|
-
*
|
|
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,125 +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
|
-
}
|
|
4731
|
-
type UpdateBotInput$1 = UpdateBotRequestBody$1 & UpdateBotRequestHeaders$1 & UpdateBotRequestQuery$1 & UpdateBotRequestParams$1;
|
|
4732
|
-
interface UpdateBotResponse$1 {
|
|
4733
|
-
bot: {
|
|
4734
|
-
/**
|
|
4735
|
-
* Id of the [Bot](#schema_bot)
|
|
4736
|
-
*/
|
|
4737
|
-
id: string;
|
|
4738
|
-
/**
|
|
4739
|
-
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
4701
|
+
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
4740
4702
|
*/
|
|
4741
4703
|
createdAt: string;
|
|
4742
4704
|
/**
|
|
@@ -4795,7 +4757,7 @@ interface UpdateBotResponse$1 {
|
|
|
4795
4757
|
*/
|
|
4796
4758
|
iconUrl: string;
|
|
4797
4759
|
/**
|
|
4798
|
-
*
|
|
4760
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
4799
4761
|
*/
|
|
4800
4762
|
public: boolean;
|
|
4801
4763
|
/**
|
|
@@ -5032,133 +4994,260 @@ interface UpdateBotResponse$1 {
|
|
|
5032
4994
|
};
|
|
5033
4995
|
}
|
|
5034
4996
|
|
|
5035
|
-
interface
|
|
4997
|
+
interface UpdateBotRequestHeaders$1 {
|
|
5036
4998
|
}
|
|
5037
|
-
interface
|
|
4999
|
+
interface UpdateBotRequestQuery$1 {
|
|
5038
5000
|
}
|
|
5039
|
-
interface
|
|
5001
|
+
interface UpdateBotRequestParams$1 {
|
|
5040
5002
|
id: string;
|
|
5041
5003
|
}
|
|
5042
|
-
interface
|
|
5004
|
+
interface UpdateBotRequestBody$1 {
|
|
5043
5005
|
/**
|
|
5044
|
-
*
|
|
5006
|
+
* URL of the [Bot](#schema_bot); Only available for dev bots
|
|
5045
5007
|
*/
|
|
5046
|
-
|
|
5047
|
-
|
|
5048
|
-
|
|
5049
|
-
|
|
5050
|
-
|
|
5051
|
-
|
|
5052
|
-
interface ListBotsRequestHeaders$1 {
|
|
5053
|
-
}
|
|
5054
|
-
interface ListBotsRequestQuery$1 {
|
|
5055
|
-
dev?: boolean;
|
|
5056
|
-
tags?: {
|
|
5057
|
-
[k: string]: string;
|
|
5058
|
-
};
|
|
5059
|
-
nextToken?: string;
|
|
5060
|
-
sortField?: "createdAt" | "updatedAt";
|
|
5061
|
-
sortDirection?: "asc" | "desc";
|
|
5062
|
-
}
|
|
5063
|
-
interface ListBotsRequestParams$1 {
|
|
5064
|
-
}
|
|
5065
|
-
interface ListBotsRequestBody$1 {
|
|
5066
|
-
}
|
|
5067
|
-
type ListBotsInput$1 = ListBotsRequestBody$1 & ListBotsRequestHeaders$1 & ListBotsRequestQuery$1 & ListBotsRequestParams$1;
|
|
5068
|
-
interface ListBotsResponse$1 {
|
|
5069
|
-
bots: {
|
|
5070
|
-
/**
|
|
5071
|
-
* Id of the [Bot](#schema_bot)
|
|
5072
|
-
*/
|
|
5073
|
-
id: string;
|
|
5074
|
-
/**
|
|
5075
|
-
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5076
|
-
*/
|
|
5077
|
-
createdAt: string;
|
|
5078
|
-
/**
|
|
5079
|
-
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5080
|
-
*/
|
|
5081
|
-
updatedAt: string;
|
|
5082
|
-
name: string;
|
|
5083
|
-
deployedAt?: string;
|
|
5008
|
+
url?: string;
|
|
5009
|
+
/**
|
|
5010
|
+
* Type of the [Bot](#schema_bot) authentication (`iam`)
|
|
5011
|
+
*/
|
|
5012
|
+
authentication?: "iam";
|
|
5013
|
+
configuration?: {
|
|
5084
5014
|
/**
|
|
5085
|
-
*
|
|
5015
|
+
* Configuration data
|
|
5086
5016
|
*/
|
|
5087
|
-
|
|
5088
|
-
[k: string]:
|
|
5017
|
+
data?: {
|
|
5018
|
+
[k: string]: any;
|
|
5089
5019
|
};
|
|
5090
|
-
}[];
|
|
5091
|
-
meta: {
|
|
5092
5020
|
/**
|
|
5093
|
-
*
|
|
5021
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
5094
5022
|
*/
|
|
5095
|
-
|
|
5023
|
+
schema?: {
|
|
5024
|
+
[k: string]: any;
|
|
5025
|
+
};
|
|
5096
5026
|
};
|
|
5097
|
-
|
|
5098
|
-
|
|
5099
|
-
|
|
5100
|
-
|
|
5101
|
-
|
|
5102
|
-
}
|
|
5103
|
-
|
|
5104
|
-
|
|
5105
|
-
|
|
5106
|
-
|
|
5107
|
-
|
|
5108
|
-
|
|
5109
|
-
|
|
5110
|
-
|
|
5111
|
-
|
|
5112
|
-
|
|
5113
|
-
*/
|
|
5114
|
-
id: string;
|
|
5115
|
-
/**
|
|
5116
|
-
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5117
|
-
*/
|
|
5118
|
-
createdAt: string;
|
|
5119
|
-
/**
|
|
5120
|
-
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5121
|
-
*/
|
|
5122
|
-
updatedAt: string;
|
|
5123
|
-
/**
|
|
5124
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
5125
|
-
*/
|
|
5126
|
-
signingSecret: string;
|
|
5127
|
-
/**
|
|
5128
|
-
* A mapping of integrations to their configuration
|
|
5129
|
-
*/
|
|
5130
|
-
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
|
+
*/
|
|
5131
5043
|
[k: string]: {
|
|
5132
|
-
enabled: boolean;
|
|
5133
5044
|
/**
|
|
5134
|
-
*
|
|
5045
|
+
* Title of the tag
|
|
5135
5046
|
*/
|
|
5136
|
-
|
|
5047
|
+
title?: string;
|
|
5137
5048
|
/**
|
|
5138
|
-
*
|
|
5049
|
+
* Description of the tag
|
|
5139
5050
|
*/
|
|
5140
|
-
|
|
5141
|
-
|
|
5142
|
-
|
|
5143
|
-
|
|
5144
|
-
|
|
5145
|
-
|
|
5146
|
-
|
|
5147
|
-
|
|
5148
|
-
|
|
5149
|
-
|
|
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]: {
|
|
5150
5061
|
/**
|
|
5151
|
-
*
|
|
5062
|
+
* Title of the tag
|
|
5152
5063
|
*/
|
|
5153
|
-
|
|
5064
|
+
title?: string;
|
|
5154
5065
|
/**
|
|
5155
|
-
*
|
|
5066
|
+
* Description of the tag
|
|
5156
5067
|
*/
|
|
5157
|
-
|
|
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]: {
|
|
5158
5078
|
/**
|
|
5159
|
-
*
|
|
5079
|
+
* Title of the tag
|
|
5160
5080
|
*/
|
|
5161
|
-
|
|
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;
|
|
5162
5251
|
/**
|
|
5163
5252
|
* Title of the integration. This is the name that will be displayed in the UI
|
|
5164
5253
|
*/
|
|
@@ -5172,7 +5261,7 @@ interface GetBotResponse$1 {
|
|
|
5172
5261
|
*/
|
|
5173
5262
|
iconUrl: string;
|
|
5174
5263
|
/**
|
|
5175
|
-
*
|
|
5264
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
5176
5265
|
*/
|
|
5177
5266
|
public: boolean;
|
|
5178
5267
|
/**
|
|
@@ -5409,312 +5498,689 @@ interface GetBotResponse$1 {
|
|
|
5409
5498
|
};
|
|
5410
5499
|
}
|
|
5411
5500
|
|
|
5412
|
-
interface
|
|
5501
|
+
interface TransferBotRequestHeaders$1 {
|
|
5413
5502
|
}
|
|
5414
|
-
interface
|
|
5503
|
+
interface TransferBotRequestQuery$1 {
|
|
5415
5504
|
}
|
|
5416
|
-
interface
|
|
5505
|
+
interface TransferBotRequestParams$1 {
|
|
5417
5506
|
id: string;
|
|
5418
5507
|
}
|
|
5419
|
-
interface
|
|
5508
|
+
interface TransferBotRequestBody$1 {
|
|
5509
|
+
/**
|
|
5510
|
+
* The ID of the workspace you want to transfer the bot to.
|
|
5511
|
+
*/
|
|
5512
|
+
targetWorkspaceId: string;
|
|
5420
5513
|
}
|
|
5421
|
-
type
|
|
5422
|
-
interface
|
|
5514
|
+
type TransferBotInput$1 = TransferBotRequestBody$1 & TransferBotRequestHeaders$1 & TransferBotRequestQuery$1 & TransferBotRequestParams$1;
|
|
5515
|
+
interface TransferBotResponse$1 {
|
|
5423
5516
|
}
|
|
5424
5517
|
|
|
5425
|
-
interface
|
|
5518
|
+
interface ListBotsRequestHeaders$1 {
|
|
5426
5519
|
}
|
|
5427
|
-
interface
|
|
5428
|
-
|
|
5429
|
-
|
|
5430
|
-
|
|
5431
|
-
|
|
5432
|
-
workflowId?: string;
|
|
5433
|
-
conversationId?: string;
|
|
5520
|
+
interface ListBotsRequestQuery$1 {
|
|
5521
|
+
dev?: boolean;
|
|
5522
|
+
tags?: {
|
|
5523
|
+
[k: string]: string;
|
|
5524
|
+
};
|
|
5434
5525
|
nextToken?: string;
|
|
5526
|
+
sortField?: "createdAt" | "updatedAt";
|
|
5527
|
+
sortDirection?: "asc" | "desc";
|
|
5435
5528
|
}
|
|
5436
|
-
interface
|
|
5437
|
-
id: string;
|
|
5529
|
+
interface ListBotsRequestParams$1 {
|
|
5438
5530
|
}
|
|
5439
|
-
interface
|
|
5531
|
+
interface ListBotsRequestBody$1 {
|
|
5440
5532
|
}
|
|
5441
|
-
type
|
|
5442
|
-
interface
|
|
5443
|
-
|
|
5444
|
-
|
|
5445
|
-
|
|
5446
|
-
|
|
5447
|
-
|
|
5448
|
-
|
|
5449
|
-
|
|
5533
|
+
type ListBotsInput$1 = ListBotsRequestBody$1 & ListBotsRequestHeaders$1 & ListBotsRequestQuery$1 & ListBotsRequestParams$1;
|
|
5534
|
+
interface ListBotsResponse$1 {
|
|
5535
|
+
bots: {
|
|
5536
|
+
/**
|
|
5537
|
+
* Id of the [Bot](#schema_bot)
|
|
5538
|
+
*/
|
|
5539
|
+
id: string;
|
|
5540
|
+
/**
|
|
5541
|
+
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5542
|
+
*/
|
|
5543
|
+
createdAt: string;
|
|
5544
|
+
/**
|
|
5545
|
+
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5546
|
+
*/
|
|
5547
|
+
updatedAt: string;
|
|
5548
|
+
name: string;
|
|
5549
|
+
deployedAt?: string;
|
|
5550
|
+
/**
|
|
5551
|
+
* Tags of [Bot](#schema_bot)
|
|
5552
|
+
*/
|
|
5553
|
+
tags: {
|
|
5554
|
+
[k: string]: string;
|
|
5555
|
+
};
|
|
5450
5556
|
}[];
|
|
5451
|
-
|
|
5557
|
+
meta: {
|
|
5558
|
+
/**
|
|
5559
|
+
* 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.
|
|
5560
|
+
*/
|
|
5561
|
+
nextToken?: string;
|
|
5562
|
+
};
|
|
5452
5563
|
}
|
|
5453
5564
|
|
|
5454
|
-
interface
|
|
5565
|
+
interface GetBotRequestHeaders$1 {
|
|
5455
5566
|
}
|
|
5456
|
-
interface
|
|
5457
|
-
type: "preconfigured" | "configurable" | "fullscreen" | "sharableUrl";
|
|
5567
|
+
interface GetBotRequestQuery$1 {
|
|
5458
5568
|
}
|
|
5459
|
-
interface
|
|
5569
|
+
interface GetBotRequestParams$1 {
|
|
5460
5570
|
id: string;
|
|
5461
5571
|
}
|
|
5462
|
-
interface
|
|
5572
|
+
interface GetBotRequestBody$1 {
|
|
5463
5573
|
}
|
|
5464
|
-
type
|
|
5465
|
-
interface
|
|
5466
|
-
|
|
5467
|
-
}
|
|
5468
|
-
|
|
5469
|
-
interface GetBotAnalyticsRequestHeaders$1 {
|
|
5470
|
-
}
|
|
5471
|
-
interface GetBotAnalyticsRequestQuery$1 {
|
|
5472
|
-
startDate: string;
|
|
5473
|
-
endDate: string;
|
|
5474
|
-
}
|
|
5475
|
-
interface GetBotAnalyticsRequestParams$1 {
|
|
5476
|
-
id: string;
|
|
5477
|
-
}
|
|
5478
|
-
interface GetBotAnalyticsRequestBody$1 {
|
|
5479
|
-
}
|
|
5480
|
-
type GetBotAnalyticsInput$1 = GetBotAnalyticsRequestBody$1 & GetBotAnalyticsRequestHeaders$1 & GetBotAnalyticsRequestQuery$1 & GetBotAnalyticsRequestParams$1;
|
|
5481
|
-
interface GetBotAnalyticsResponse$1 {
|
|
5482
|
-
records: {
|
|
5574
|
+
type GetBotInput$1 = GetBotRequestBody$1 & GetBotRequestHeaders$1 & GetBotRequestQuery$1 & GetBotRequestParams$1;
|
|
5575
|
+
interface GetBotResponse$1 {
|
|
5576
|
+
bot: {
|
|
5483
5577
|
/**
|
|
5484
|
-
*
|
|
5578
|
+
* Id of the [Bot](#schema_bot)
|
|
5485
5579
|
*/
|
|
5486
|
-
|
|
5580
|
+
id: string;
|
|
5487
5581
|
/**
|
|
5488
|
-
*
|
|
5582
|
+
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5489
5583
|
*/
|
|
5490
|
-
|
|
5491
|
-
returningUsers: number;
|
|
5492
|
-
newUsers: number;
|
|
5493
|
-
sessions: number;
|
|
5584
|
+
createdAt: string;
|
|
5494
5585
|
/**
|
|
5495
|
-
*
|
|
5586
|
+
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5496
5587
|
*/
|
|
5497
|
-
|
|
5498
|
-
|
|
5499
|
-
|
|
5500
|
-
|
|
5501
|
-
|
|
5502
|
-
|
|
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: {
|
|
5597
|
+
[k: string]: {
|
|
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";
|
|
5648
|
+
};
|
|
5503
5649
|
};
|
|
5504
|
-
|
|
5505
|
-
|
|
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
|
+
};
|
|
5506
5669
|
};
|
|
5507
|
-
|
|
5508
|
-
|
|
5509
|
-
|
|
5510
|
-
|
|
5511
|
-
|
|
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: {
|
|
5512
5735
|
/**
|
|
5513
|
-
*
|
|
5736
|
+
* Configuration data
|
|
5514
5737
|
*/
|
|
5515
|
-
|
|
5516
|
-
|
|
5517
|
-
sd: number;
|
|
5518
|
-
min: number;
|
|
5519
|
-
max: number;
|
|
5738
|
+
data: {
|
|
5739
|
+
[k: string]: any;
|
|
5520
5740
|
};
|
|
5521
5741
|
/**
|
|
5522
|
-
*
|
|
5742
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
5523
5743
|
*/
|
|
5524
|
-
|
|
5525
|
-
|
|
5526
|
-
sd: number;
|
|
5527
|
-
min: number;
|
|
5528
|
-
max: number;
|
|
5744
|
+
schema: {
|
|
5745
|
+
[k: string]: any;
|
|
5529
5746
|
};
|
|
5747
|
+
};
|
|
5748
|
+
/**
|
|
5749
|
+
* Events definition
|
|
5750
|
+
*/
|
|
5751
|
+
events: {
|
|
5530
5752
|
/**
|
|
5531
|
-
*
|
|
5753
|
+
* Event Definition
|
|
5532
5754
|
*/
|
|
5533
|
-
|
|
5534
|
-
|
|
5535
|
-
|
|
5536
|
-
|
|
5537
|
-
|
|
5538
|
-
|
|
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
|
+
};
|
|
5539
5767
|
};
|
|
5540
5768
|
};
|
|
5541
|
-
|
|
5542
|
-
|
|
5543
|
-
|
|
5544
|
-
|
|
5545
|
-
|
|
5546
|
-
|
|
5547
|
-
|
|
5548
|
-
|
|
5549
|
-
|
|
5550
|
-
|
|
5551
|
-
|
|
5552
|
-
|
|
5553
|
-
|
|
5554
|
-
|
|
5555
|
-
|
|
5556
|
-
|
|
5557
|
-
|
|
5558
|
-
|
|
5559
|
-
|
|
5560
|
-
|
|
5561
|
-
title: string;
|
|
5562
|
-
description: string;
|
|
5563
|
-
groupedData: {
|
|
5564
|
-
[k: string]: {
|
|
5565
|
-
raw: string;
|
|
5566
|
-
pretty?: string;
|
|
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;
|
|
5567
5789
|
};
|
|
5568
5790
|
};
|
|
5569
|
-
|
|
5570
|
-
|
|
5571
|
-
|
|
5572
|
-
|
|
5573
|
-
|
|
5574
|
-
|
|
5575
|
-
|
|
5576
|
-
|
|
5577
|
-
|
|
5578
|
-
|
|
5579
|
-
}
|
|
5580
|
-
|
|
5581
|
-
|
|
5582
|
-
|
|
5583
|
-
|
|
5584
|
-
|
|
5585
|
-
|
|
5586
|
-
|
|
5587
|
-
issues: {
|
|
5588
|
-
id: string;
|
|
5589
|
-
code: string;
|
|
5590
|
-
createdAt: string;
|
|
5591
|
-
lastSeenAt: string;
|
|
5592
|
-
title: string;
|
|
5593
|
-
description: string;
|
|
5594
|
-
groupedData: {
|
|
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
|
+
*/
|
|
5595
5809
|
[k: string]: {
|
|
5596
|
-
|
|
5597
|
-
|
|
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
|
+
};
|
|
5598
5830
|
};
|
|
5599
5831
|
};
|
|
5600
|
-
eventsCount: number;
|
|
5601
|
-
category: "user_code" | "limits" | "configuration" | "other";
|
|
5602
|
-
resolutionLink: string | null;
|
|
5603
|
-
}[];
|
|
5604
|
-
meta: {
|
|
5605
5832
|
/**
|
|
5606
|
-
*
|
|
5833
|
+
* Tags of [Bot](#schema_bot)
|
|
5607
5834
|
*/
|
|
5608
|
-
|
|
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
|
+
}[];
|
|
5609
5875
|
};
|
|
5610
5876
|
}
|
|
5611
5877
|
|
|
5612
|
-
interface
|
|
5613
|
-
}
|
|
5614
|
-
interface DeleteBotIssueRequestQuery$1 {
|
|
5615
|
-
}
|
|
5616
|
-
interface DeleteBotIssueRequestParams$1 {
|
|
5617
|
-
id: string;
|
|
5618
|
-
issueId: string;
|
|
5619
|
-
}
|
|
5620
|
-
interface DeleteBotIssueRequestBody$1 {
|
|
5621
|
-
}
|
|
5622
|
-
type DeleteBotIssueInput$1 = DeleteBotIssueRequestBody$1 & DeleteBotIssueRequestHeaders$1 & DeleteBotIssueRequestQuery$1 & DeleteBotIssueRequestParams$1;
|
|
5623
|
-
interface DeleteBotIssueResponse$1 {
|
|
5624
|
-
}
|
|
5625
|
-
|
|
5626
|
-
interface ListBotIssueEventsRequestHeaders$1 {
|
|
5878
|
+
interface DeleteBotRequestHeaders$1 {
|
|
5627
5879
|
}
|
|
5628
|
-
interface
|
|
5880
|
+
interface DeleteBotRequestQuery$1 {
|
|
5629
5881
|
}
|
|
5630
|
-
interface
|
|
5882
|
+
interface DeleteBotRequestParams$1 {
|
|
5631
5883
|
id: string;
|
|
5632
|
-
issueId: string;
|
|
5633
5884
|
}
|
|
5634
|
-
interface
|
|
5885
|
+
interface DeleteBotRequestBody$1 {
|
|
5635
5886
|
}
|
|
5636
|
-
type
|
|
5637
|
-
interface
|
|
5638
|
-
issueEvents: {
|
|
5639
|
-
id: string;
|
|
5640
|
-
createdAt: string;
|
|
5641
|
-
data: {
|
|
5642
|
-
[k: string]: {
|
|
5643
|
-
raw: string;
|
|
5644
|
-
pretty?: string;
|
|
5645
|
-
};
|
|
5646
|
-
};
|
|
5647
|
-
}[];
|
|
5887
|
+
type DeleteBotInput$1 = DeleteBotRequestBody$1 & DeleteBotRequestHeaders$1 & DeleteBotRequestQuery$1 & DeleteBotRequestParams$1;
|
|
5888
|
+
interface DeleteBotResponse$1 {
|
|
5648
5889
|
}
|
|
5649
5890
|
|
|
5650
|
-
interface
|
|
5891
|
+
interface GetBotLogsRequestHeaders$1 {
|
|
5651
5892
|
}
|
|
5652
|
-
interface
|
|
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;
|
|
5653
5901
|
}
|
|
5654
|
-
interface
|
|
5902
|
+
interface GetBotLogsRequestParams$1 {
|
|
5655
5903
|
id: string;
|
|
5656
5904
|
}
|
|
5657
|
-
interface
|
|
5905
|
+
interface GetBotLogsRequestBody$1 {
|
|
5658
5906
|
}
|
|
5659
|
-
type
|
|
5660
|
-
interface
|
|
5661
|
-
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
|
|
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;
|
|
5665
5916
|
}[];
|
|
5917
|
+
nextToken?: string;
|
|
5666
5918
|
}
|
|
5667
5919
|
|
|
5668
|
-
interface
|
|
5669
|
-
}
|
|
5670
|
-
interface GetBotVersionRequestQuery$1 {
|
|
5671
|
-
}
|
|
5672
|
-
interface GetBotVersionRequestParams$1 {
|
|
5673
|
-
id: string;
|
|
5674
|
-
versionId: string;
|
|
5675
|
-
}
|
|
5676
|
-
interface GetBotVersionRequestBody$1 {
|
|
5677
|
-
}
|
|
5678
|
-
type GetBotVersionInput$1 = GetBotVersionRequestBody$1 & GetBotVersionRequestHeaders$1 & GetBotVersionRequestQuery$1 & GetBotVersionRequestParams$1;
|
|
5679
|
-
interface GetBotVersionResponse$1 {
|
|
5680
|
-
url: string;
|
|
5681
|
-
}
|
|
5682
|
-
|
|
5683
|
-
interface CreateBotVersionRequestHeaders$1 {
|
|
5920
|
+
interface GetBotWebchatRequestHeaders$1 {
|
|
5684
5921
|
}
|
|
5685
|
-
interface
|
|
5922
|
+
interface GetBotWebchatRequestQuery$1 {
|
|
5923
|
+
type: "preconfigured" | "configurable" | "fullscreen" | "sharableUrl";
|
|
5686
5924
|
}
|
|
5687
|
-
interface
|
|
5925
|
+
interface GetBotWebchatRequestParams$1 {
|
|
5688
5926
|
id: string;
|
|
5689
5927
|
}
|
|
5690
|
-
interface
|
|
5691
|
-
name: string;
|
|
5692
|
-
description?: string;
|
|
5928
|
+
interface GetBotWebchatRequestBody$1 {
|
|
5693
5929
|
}
|
|
5694
|
-
type
|
|
5695
|
-
interface
|
|
5696
|
-
|
|
5697
|
-
id: string;
|
|
5698
|
-
name: string;
|
|
5699
|
-
description?: string;
|
|
5700
|
-
};
|
|
5930
|
+
type GetBotWebchatInput$1 = GetBotWebchatRequestBody$1 & GetBotWebchatRequestHeaders$1 & GetBotWebchatRequestQuery$1 & GetBotWebchatRequestParams$1;
|
|
5931
|
+
interface GetBotWebchatResponse$1 {
|
|
5932
|
+
code: string;
|
|
5701
5933
|
}
|
|
5702
5934
|
|
|
5703
|
-
interface
|
|
5935
|
+
interface GetBotAnalyticsRequestHeaders$1 {
|
|
5704
5936
|
}
|
|
5705
|
-
interface
|
|
5937
|
+
interface GetBotAnalyticsRequestQuery$1 {
|
|
5938
|
+
startDate: string;
|
|
5939
|
+
endDate: string;
|
|
5706
5940
|
}
|
|
5707
|
-
interface
|
|
5941
|
+
interface GetBotAnalyticsRequestParams$1 {
|
|
5708
5942
|
id: string;
|
|
5709
5943
|
}
|
|
5710
|
-
interface
|
|
5711
|
-
|
|
5712
|
-
|
|
5713
|
-
|
|
5714
|
-
|
|
5715
|
-
|
|
5716
|
-
|
|
5717
|
-
|
|
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;
|
|
6129
|
+
name: string;
|
|
6130
|
+
description?: string;
|
|
6131
|
+
}[];
|
|
6132
|
+
}
|
|
6133
|
+
|
|
6134
|
+
interface GetBotVersionRequestHeaders$1 {
|
|
6135
|
+
}
|
|
6136
|
+
interface GetBotVersionRequestQuery$1 {
|
|
6137
|
+
}
|
|
6138
|
+
interface GetBotVersionRequestParams$1 {
|
|
6139
|
+
id: string;
|
|
6140
|
+
versionId: string;
|
|
6141
|
+
}
|
|
6142
|
+
interface GetBotVersionRequestBody$1 {
|
|
6143
|
+
}
|
|
6144
|
+
type GetBotVersionInput$1 = GetBotVersionRequestBody$1 & GetBotVersionRequestHeaders$1 & GetBotVersionRequestQuery$1 & GetBotVersionRequestParams$1;
|
|
6145
|
+
interface GetBotVersionResponse$1 {
|
|
6146
|
+
url: string;
|
|
6147
|
+
}
|
|
6148
|
+
|
|
6149
|
+
interface CreateBotVersionRequestHeaders$1 {
|
|
6150
|
+
}
|
|
6151
|
+
interface CreateBotVersionRequestQuery$1 {
|
|
6152
|
+
}
|
|
6153
|
+
interface CreateBotVersionRequestParams$1 {
|
|
6154
|
+
id: string;
|
|
6155
|
+
}
|
|
6156
|
+
interface CreateBotVersionRequestBody$1 {
|
|
6157
|
+
name: string;
|
|
6158
|
+
description?: string;
|
|
6159
|
+
}
|
|
6160
|
+
type CreateBotVersionInput$1 = CreateBotVersionRequestBody$1 & CreateBotVersionRequestHeaders$1 & CreateBotVersionRequestQuery$1 & CreateBotVersionRequestParams$1;
|
|
6161
|
+
interface CreateBotVersionResponse$1 {
|
|
6162
|
+
version: {
|
|
6163
|
+
id: string;
|
|
6164
|
+
name: string;
|
|
6165
|
+
description?: string;
|
|
6166
|
+
};
|
|
6167
|
+
}
|
|
6168
|
+
|
|
6169
|
+
interface DeployBotVersionRequestHeaders$1 {
|
|
6170
|
+
}
|
|
6171
|
+
interface DeployBotVersionRequestQuery$1 {
|
|
6172
|
+
}
|
|
6173
|
+
interface DeployBotVersionRequestParams$1 {
|
|
6174
|
+
id: string;
|
|
6175
|
+
}
|
|
6176
|
+
interface DeployBotVersionRequestBody$1 {
|
|
6177
|
+
versionId: string;
|
|
6178
|
+
}
|
|
6179
|
+
type DeployBotVersionInput$1 = DeployBotVersionRequestBody$1 & DeployBotVersionRequestHeaders$1 & DeployBotVersionRequestQuery$1 & DeployBotVersionRequestParams$1;
|
|
6180
|
+
interface DeployBotVersionResponse$1 {
|
|
6181
|
+
}
|
|
6182
|
+
|
|
6183
|
+
interface CreateIntegrationShareableIdRequestHeaders$1 {
|
|
5718
6184
|
}
|
|
5719
6185
|
interface CreateIntegrationShareableIdRequestQuery$1 {
|
|
5720
6186
|
}
|
|
@@ -6745,7 +7211,7 @@ interface CreateIntegrationRequestBody$1 {
|
|
|
6745
7211
|
*/
|
|
6746
7212
|
description?: string;
|
|
6747
7213
|
/**
|
|
6748
|
-
*
|
|
7214
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
6749
7215
|
*/
|
|
6750
7216
|
public?: boolean;
|
|
6751
7217
|
layers?: string[];
|
|
@@ -7102,7 +7568,7 @@ interface CreateIntegrationResponse$1 {
|
|
|
7102
7568
|
*/
|
|
7103
7569
|
readmeUrl: string;
|
|
7104
7570
|
/**
|
|
7105
|
-
*
|
|
7571
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
7106
7572
|
*/
|
|
7107
7573
|
public: boolean;
|
|
7108
7574
|
/**
|
|
@@ -7425,7 +7891,7 @@ interface ValidateIntegrationCreationRequestBody$1 {
|
|
|
7425
7891
|
*/
|
|
7426
7892
|
description?: string;
|
|
7427
7893
|
/**
|
|
7428
|
-
*
|
|
7894
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
7429
7895
|
*/
|
|
7430
7896
|
public?: boolean;
|
|
7431
7897
|
layers?: string[];
|
|
@@ -7736,7 +8202,7 @@ interface UpdateIntegrationRequestBody$1 {
|
|
|
7736
8202
|
*/
|
|
7737
8203
|
url?: string | null;
|
|
7738
8204
|
/**
|
|
7739
|
-
*
|
|
8205
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
7740
8206
|
*/
|
|
7741
8207
|
public?: boolean;
|
|
7742
8208
|
layers?: string[];
|
|
@@ -8093,7 +8559,7 @@ interface UpdateIntegrationResponse$1 {
|
|
|
8093
8559
|
*/
|
|
8094
8560
|
readmeUrl: string;
|
|
8095
8561
|
/**
|
|
8096
|
-
*
|
|
8562
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
8097
8563
|
*/
|
|
8098
8564
|
public: boolean;
|
|
8099
8565
|
/**
|
|
@@ -8409,7 +8875,7 @@ interface ValidateIntegrationUpdateRequestBody$1 {
|
|
|
8409
8875
|
*/
|
|
8410
8876
|
url?: string | null;
|
|
8411
8877
|
/**
|
|
8412
|
-
*
|
|
8878
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
8413
8879
|
*/
|
|
8414
8880
|
public?: boolean;
|
|
8415
8881
|
layers?: string[];
|
|
@@ -8475,7 +8941,7 @@ interface ListIntegrationsResponse$1 {
|
|
|
8475
8941
|
*/
|
|
8476
8942
|
iconUrl: string;
|
|
8477
8943
|
/**
|
|
8478
|
-
*
|
|
8944
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
8479
8945
|
*/
|
|
8480
8946
|
public: boolean;
|
|
8481
8947
|
/**
|
|
@@ -8882,7 +9348,7 @@ interface GetIntegrationResponse$1 {
|
|
|
8882
9348
|
*/
|
|
8883
9349
|
readmeUrl: string;
|
|
8884
9350
|
/**
|
|
8885
|
-
*
|
|
9351
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
8886
9352
|
*/
|
|
8887
9353
|
public: boolean;
|
|
8888
9354
|
/**
|
|
@@ -8900,7 +9366,7 @@ interface GetIntegrationLogsRequestHeaders$1 {
|
|
|
8900
9366
|
}
|
|
8901
9367
|
interface GetIntegrationLogsRequestQuery$1 {
|
|
8902
9368
|
timeStart: string;
|
|
8903
|
-
timeEnd
|
|
9369
|
+
timeEnd?: string;
|
|
8904
9370
|
level?: string;
|
|
8905
9371
|
userId?: string;
|
|
8906
9372
|
conversationId?: string;
|
|
@@ -9286,7 +9752,7 @@ interface GetIntegrationByNameResponse$1 {
|
|
|
9286
9752
|
*/
|
|
9287
9753
|
readmeUrl: string;
|
|
9288
9754
|
/**
|
|
9289
|
-
*
|
|
9755
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
9290
9756
|
*/
|
|
9291
9757
|
public: boolean;
|
|
9292
9758
|
/**
|
|
@@ -10256,6 +10722,10 @@ interface CreatePluginRequestBody$1 {
|
|
|
10256
10722
|
* Description of the plugin. This is the description that will be displayed in the UI
|
|
10257
10723
|
*/
|
|
10258
10724
|
description?: string;
|
|
10725
|
+
/**
|
|
10726
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
10727
|
+
*/
|
|
10728
|
+
public?: boolean;
|
|
10259
10729
|
}
|
|
10260
10730
|
type CreatePluginInput$1 = CreatePluginRequestBody$1 & CreatePluginRequestHeaders$1 & CreatePluginRequestQuery$1 & CreatePluginRequestParams$1;
|
|
10261
10731
|
interface CreatePluginResponse$1 {
|
|
@@ -10434,6 +10904,10 @@ interface CreatePluginResponse$1 {
|
|
|
10434
10904
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
10435
10905
|
*/
|
|
10436
10906
|
readmeUrl: string;
|
|
10907
|
+
/**
|
|
10908
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
10909
|
+
*/
|
|
10910
|
+
public: boolean;
|
|
10437
10911
|
};
|
|
10438
10912
|
}
|
|
10439
10913
|
|
|
@@ -10623,6 +11097,10 @@ interface GetPluginResponse$1 {
|
|
|
10623
11097
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
10624
11098
|
*/
|
|
10625
11099
|
readmeUrl: string;
|
|
11100
|
+
/**
|
|
11101
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
11102
|
+
*/
|
|
11103
|
+
public: boolean;
|
|
10626
11104
|
};
|
|
10627
11105
|
}
|
|
10628
11106
|
|
|
@@ -10813,6 +11291,10 @@ interface GetPluginByNameResponse$1 {
|
|
|
10813
11291
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
10814
11292
|
*/
|
|
10815
11293
|
readmeUrl: string;
|
|
11294
|
+
/**
|
|
11295
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
11296
|
+
*/
|
|
11297
|
+
public: boolean;
|
|
10816
11298
|
};
|
|
10817
11299
|
}
|
|
10818
11300
|
|
|
@@ -10978,6 +11460,10 @@ interface UpdatePluginRequestBody$1 {
|
|
|
10978
11460
|
* Description of the plugin. This is the description that will be displayed in the UI
|
|
10979
11461
|
*/
|
|
10980
11462
|
description?: string;
|
|
11463
|
+
/**
|
|
11464
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
11465
|
+
*/
|
|
11466
|
+
public?: boolean;
|
|
10981
11467
|
}
|
|
10982
11468
|
type UpdatePluginInput$1 = UpdatePluginRequestBody$1 & UpdatePluginRequestHeaders$1 & UpdatePluginRequestQuery$1 & UpdatePluginRequestParams$1;
|
|
10983
11469
|
interface UpdatePluginResponse$1 {
|
|
@@ -11156,8 +11642,12 @@ interface UpdatePluginResponse$1 {
|
|
|
11156
11642
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
11157
11643
|
*/
|
|
11158
11644
|
readmeUrl: string;
|
|
11159
|
-
|
|
11160
|
-
|
|
11645
|
+
/**
|
|
11646
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
11647
|
+
*/
|
|
11648
|
+
public: boolean;
|
|
11649
|
+
};
|
|
11650
|
+
}
|
|
11161
11651
|
|
|
11162
11652
|
interface DeletePluginRequestHeaders$1 {
|
|
11163
11653
|
}
|
|
@@ -11177,6 +11667,7 @@ interface ListPluginsRequestHeaders$1 {
|
|
|
11177
11667
|
interface ListPluginsRequestQuery$1 {
|
|
11178
11668
|
nextToken?: string;
|
|
11179
11669
|
name?: string;
|
|
11670
|
+
version?: string;
|
|
11180
11671
|
}
|
|
11181
11672
|
interface ListPluginsRequestParams$1 {
|
|
11182
11673
|
}
|
|
@@ -11221,6 +11712,10 @@ interface ListPluginsResponse$1 {
|
|
|
11221
11712
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
11222
11713
|
*/
|
|
11223
11714
|
readmeUrl: string;
|
|
11715
|
+
/**
|
|
11716
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
11717
|
+
*/
|
|
11718
|
+
public: boolean;
|
|
11224
11719
|
}[];
|
|
11225
11720
|
meta: {
|
|
11226
11721
|
/**
|
|
@@ -11489,6 +11984,10 @@ declare class Client$7 {
|
|
|
11489
11984
|
readonly listPublicIntegrations: (input: ListPublicIntegrationsInput$1) => Promise<ListPublicIntegrationsResponse$1>;
|
|
11490
11985
|
readonly getPublicIntegrationById: (input: GetPublicIntegrationByIdInput$1) => Promise<GetPublicIntegrationByIdResponse$1>;
|
|
11491
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>;
|
|
11492
11991
|
readonly createBot: (input: CreateBotInput$1) => Promise<CreateBotResponse$1>;
|
|
11493
11992
|
readonly updateBot: (input: UpdateBotInput$1) => Promise<UpdateBotResponse$1>;
|
|
11494
11993
|
readonly transferBot: (input: TransferBotInput$1) => Promise<TransferBotResponse$1>;
|
|
@@ -11861,6 +12360,10 @@ interface UpsertFileRequestBody$1 {
|
|
|
11861
12360
|
*/
|
|
11862
12361
|
generateMasterSummary?: boolean;
|
|
11863
12362
|
};
|
|
12363
|
+
/**
|
|
12364
|
+
* Internal setting, cannot be set manually.
|
|
12365
|
+
*/
|
|
12366
|
+
stack?: "realtime-v1";
|
|
11864
12367
|
vision?: {
|
|
11865
12368
|
/**
|
|
11866
12369
|
* (Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.
|
|
@@ -12487,6 +12990,18 @@ interface SearchFilesResponse$1 {
|
|
|
12487
12990
|
*/
|
|
12488
12991
|
updatedAt: string;
|
|
12489
12992
|
};
|
|
12993
|
+
context?: {
|
|
12994
|
+
id: string;
|
|
12995
|
+
text: string;
|
|
12996
|
+
/**
|
|
12997
|
+
* Position of the context passage relative to the current passage. Negative for preceding passages, positive for subsequent, ommited for breadcrumbs.
|
|
12998
|
+
*/
|
|
12999
|
+
offset?: number;
|
|
13000
|
+
/**
|
|
13001
|
+
* The type of context passage
|
|
13002
|
+
*/
|
|
13003
|
+
type: "preceding" | "subsequent" | "breadcrumb";
|
|
13004
|
+
}[];
|
|
12490
13005
|
}[];
|
|
12491
13006
|
}
|
|
12492
13007
|
|
|
@@ -17401,9 +17916,416 @@ interface ListPublicIntegrationsResponse {
|
|
|
17401
17916
|
*/
|
|
17402
17917
|
createdAt: string;
|
|
17403
17918
|
/**
|
|
17404
|
-
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
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
|
|
18082
|
+
*/
|
|
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
|
+
};
|
|
18274
|
+
/**
|
|
18275
|
+
* User object configuration
|
|
18276
|
+
*/
|
|
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
|
+
};
|
|
18325
|
+
/**
|
|
18326
|
+
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
17405
18327
|
*/
|
|
17406
|
-
|
|
18328
|
+
dev: boolean;
|
|
17407
18329
|
/**
|
|
17408
18330
|
* Title of the integration. This is the name that will be displayed in the UI
|
|
17409
18331
|
*/
|
|
@@ -17417,13 +18339,21 @@ interface ListPublicIntegrationsResponse {
|
|
|
17417
18339
|
*/
|
|
17418
18340
|
iconUrl: string;
|
|
17419
18341
|
/**
|
|
17420
|
-
*
|
|
18342
|
+
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
18343
|
+
*/
|
|
18344
|
+
readmeUrl: string;
|
|
18345
|
+
/**
|
|
18346
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
17421
18347
|
*/
|
|
17422
18348
|
public: boolean;
|
|
17423
18349
|
/**
|
|
17424
18350
|
* Status of the integration version verification
|
|
17425
18351
|
*/
|
|
17426
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[];
|
|
17427
18357
|
ownerWorkspace: {
|
|
17428
18358
|
id: string;
|
|
17429
18359
|
handle: string | null;
|
|
@@ -17433,51 +18363,21 @@ interface ListPublicIntegrationsResponse {
|
|
|
17433
18363
|
installs: number;
|
|
17434
18364
|
views: number;
|
|
17435
18365
|
};
|
|
17436
|
-
/**
|
|
17437
|
-
* Metadata about which fields matched the search criteria
|
|
17438
|
-
*/
|
|
17439
|
-
matchedOn?: {
|
|
17440
|
-
/**
|
|
17441
|
-
* Whether the integration name matched the search term
|
|
17442
|
-
*/
|
|
17443
|
-
name?: boolean;
|
|
17444
|
-
/**
|
|
17445
|
-
* Whether the integration title matched the search term
|
|
17446
|
-
*/
|
|
17447
|
-
title?: boolean;
|
|
17448
|
-
/**
|
|
17449
|
-
* Whether the integration description matched the search term
|
|
17450
|
-
*/
|
|
17451
|
-
description?: boolean;
|
|
17452
|
-
/**
|
|
17453
|
-
* Action names that matched the search term
|
|
17454
|
-
*/
|
|
17455
|
-
actions?: string[];
|
|
17456
|
-
/**
|
|
17457
|
-
* Interface names that matched the search term
|
|
17458
|
-
*/
|
|
17459
|
-
interfaces?: string[];
|
|
17460
|
-
};
|
|
17461
|
-
}[];
|
|
17462
|
-
meta: {
|
|
17463
|
-
/**
|
|
17464
|
-
* 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.
|
|
17465
|
-
*/
|
|
17466
|
-
nextToken?: string;
|
|
17467
18366
|
};
|
|
17468
18367
|
}
|
|
17469
18368
|
|
|
17470
|
-
interface
|
|
18369
|
+
interface GetPublicIntegrationRequestHeaders {
|
|
17471
18370
|
}
|
|
17472
|
-
interface
|
|
18371
|
+
interface GetPublicIntegrationRequestQuery {
|
|
17473
18372
|
}
|
|
17474
|
-
interface
|
|
17475
|
-
|
|
18373
|
+
interface GetPublicIntegrationRequestParams {
|
|
18374
|
+
name: string;
|
|
18375
|
+
version: string;
|
|
17476
18376
|
}
|
|
17477
|
-
interface
|
|
18377
|
+
interface GetPublicIntegrationRequestBody {
|
|
17478
18378
|
}
|
|
17479
|
-
type
|
|
17480
|
-
interface
|
|
18379
|
+
type GetPublicIntegrationInput = GetPublicIntegrationRequestBody & GetPublicIntegrationRequestHeaders & GetPublicIntegrationRequestQuery & GetPublicIntegrationRequestParams;
|
|
18380
|
+
interface GetPublicIntegrationResponse {
|
|
17481
18381
|
integration: {
|
|
17482
18382
|
/**
|
|
17483
18383
|
* ID of the [Integration](#schema_integration)
|
|
@@ -17695,20 +18595,292 @@ interface GetPublicIntegrationByIdResponse {
|
|
|
17695
18595
|
};
|
|
17696
18596
|
};
|
|
17697
18597
|
states: {
|
|
17698
|
-
/**
|
|
17699
|
-
* State definition
|
|
17700
|
-
*/
|
|
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: {
|
|
17701
18869
|
[k: string]: {
|
|
17702
18870
|
/**
|
|
17703
|
-
* Type of the [State](#schema_state) (`conversation`, `user` or `
|
|
18871
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
17704
18872
|
*/
|
|
17705
|
-
type: "conversation" | "user" | "
|
|
18873
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
17706
18874
|
/**
|
|
17707
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.
|
|
17708
18876
|
*/
|
|
17709
18877
|
schema: {
|
|
17710
18878
|
[k: string]: any;
|
|
17711
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;
|
|
17712
18884
|
};
|
|
17713
18885
|
};
|
|
17714
18886
|
events: {
|
|
@@ -17756,6 +18928,22 @@ interface GetPublicIntegrationByIdResponse {
|
|
|
17756
18928
|
};
|
|
17757
18929
|
};
|
|
17758
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
|
+
};
|
|
17759
18947
|
/**
|
|
17760
18948
|
* User object configuration
|
|
17761
18949
|
*/
|
|
@@ -17775,178 +18963,83 @@ interface GetPublicIntegrationByIdResponse {
|
|
|
17775
18963
|
description?: string;
|
|
17776
18964
|
};
|
|
17777
18965
|
};
|
|
17778
|
-
/**
|
|
17779
|
-
* 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.
|
|
17780
|
-
*/
|
|
17781
|
-
creation: {
|
|
17782
|
-
/**
|
|
17783
|
-
* Enable user creation
|
|
17784
|
-
*/
|
|
17785
|
-
enabled: boolean;
|
|
17786
|
-
/**
|
|
17787
|
-
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
17788
|
-
*/
|
|
17789
|
-
requiredTags: string[];
|
|
17790
|
-
};
|
|
17791
18966
|
};
|
|
17792
|
-
|
|
17793
|
-
|
|
17794
|
-
|
|
17795
|
-
|
|
17796
|
-
|
|
17797
|
-
/**
|
|
17798
|
-
* Title of the entity
|
|
17799
|
-
*/
|
|
17800
|
-
title?: string;
|
|
18967
|
+
/**
|
|
18968
|
+
* Conversation object configuration
|
|
18969
|
+
*/
|
|
18970
|
+
conversation: {
|
|
18971
|
+
tags: {
|
|
17801
18972
|
/**
|
|
17802
|
-
*
|
|
18973
|
+
* Definition of a tag that can be provided on the object
|
|
17803
18974
|
*/
|
|
17804
|
-
|
|
17805
|
-
|
|
17806
|
-
|
|
18975
|
+
[k: string]: {
|
|
18976
|
+
/**
|
|
18977
|
+
* Title of the tag
|
|
18978
|
+
*/
|
|
18979
|
+
title?: string;
|
|
18980
|
+
/**
|
|
18981
|
+
* Description of the tag
|
|
18982
|
+
*/
|
|
18983
|
+
description?: string;
|
|
17807
18984
|
};
|
|
17808
18985
|
};
|
|
17809
18986
|
};
|
|
17810
18987
|
/**
|
|
17811
|
-
*
|
|
17812
|
-
*/
|
|
17813
|
-
dev: boolean;
|
|
17814
|
-
/**
|
|
17815
|
-
* 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
|
|
17816
18989
|
*/
|
|
17817
18990
|
title: string;
|
|
17818
18991
|
/**
|
|
17819
|
-
* Description of the
|
|
18992
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
17820
18993
|
*/
|
|
17821
18994
|
description: string;
|
|
17822
18995
|
/**
|
|
17823
|
-
* 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
|
|
17824
18997
|
*/
|
|
17825
18998
|
iconUrl: string;
|
|
17826
18999
|
/**
|
|
17827
|
-
* 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
|
|
17828
19001
|
*/
|
|
17829
19002
|
readmeUrl: string;
|
|
17830
19003
|
/**
|
|
17831
|
-
*
|
|
19004
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
17832
19005
|
*/
|
|
17833
19006
|
public: boolean;
|
|
17834
|
-
/**
|
|
17835
|
-
* Status of the integration version verification
|
|
17836
|
-
*/
|
|
17837
|
-
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
17838
|
-
/**
|
|
17839
|
-
* 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.
|
|
17840
|
-
*/
|
|
17841
|
-
secrets: string[];
|
|
17842
|
-
ownerWorkspace: {
|
|
17843
|
-
id: string;
|
|
17844
|
-
handle: string | null;
|
|
17845
|
-
name: string;
|
|
17846
|
-
};
|
|
17847
|
-
meta: {
|
|
17848
|
-
installs: number;
|
|
17849
|
-
views: number;
|
|
17850
|
-
};
|
|
17851
19007
|
};
|
|
17852
19008
|
}
|
|
17853
19009
|
|
|
17854
|
-
interface
|
|
19010
|
+
interface GetPublicPluginRequestHeaders {
|
|
17855
19011
|
}
|
|
17856
|
-
interface
|
|
19012
|
+
interface GetPublicPluginRequestQuery {
|
|
17857
19013
|
}
|
|
17858
|
-
interface
|
|
19014
|
+
interface GetPublicPluginRequestParams {
|
|
17859
19015
|
name: string;
|
|
17860
19016
|
version: string;
|
|
17861
19017
|
}
|
|
17862
|
-
interface
|
|
19018
|
+
interface GetPublicPluginRequestBody {
|
|
17863
19019
|
}
|
|
17864
|
-
type
|
|
17865
|
-
interface
|
|
17866
|
-
|
|
19020
|
+
type GetPublicPluginInput = GetPublicPluginRequestBody & GetPublicPluginRequestHeaders & GetPublicPluginRequestQuery & GetPublicPluginRequestParams;
|
|
19021
|
+
interface GetPublicPluginResponse {
|
|
19022
|
+
plugin: {
|
|
17867
19023
|
/**
|
|
17868
|
-
* ID of the [
|
|
19024
|
+
* ID of the [Plugin](#schema_plugin)
|
|
17869
19025
|
*/
|
|
17870
19026
|
id: string;
|
|
17871
19027
|
/**
|
|
17872
|
-
*
|
|
17873
|
-
*/
|
|
17874
|
-
createdAt: string;
|
|
17875
|
-
/**
|
|
17876
|
-
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
17877
|
-
*/
|
|
17878
|
-
updatedAt: string;
|
|
17879
|
-
/**
|
|
17880
|
-
* Global identifier configuration of the [Integration](#schema_integration)
|
|
19028
|
+
* Name of the [Plugin](#schema_plugin)
|
|
17881
19029
|
*/
|
|
17882
|
-
|
|
17883
|
-
/**
|
|
17884
|
-
* VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier
|
|
17885
|
-
*/
|
|
17886
|
-
fallbackHandlerScript?: string;
|
|
17887
|
-
/**
|
|
17888
|
-
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
|
|
17889
|
-
*/
|
|
17890
|
-
extractScript?: string;
|
|
17891
|
-
};
|
|
17892
|
-
sandbox?: {
|
|
17893
|
-
/**
|
|
17894
|
-
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
|
|
17895
|
-
*/
|
|
17896
|
-
identifierExtractScript?: string;
|
|
17897
|
-
/**
|
|
17898
|
-
* VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
|
|
17899
|
-
*/
|
|
17900
|
-
messageExtractScript?: string;
|
|
17901
|
-
};
|
|
19030
|
+
name: string;
|
|
17902
19031
|
/**
|
|
17903
|
-
*
|
|
19032
|
+
* Version of the [Plugin](#schema_plugin)
|
|
17904
19033
|
*/
|
|
17905
|
-
|
|
19034
|
+
version: string;
|
|
17906
19035
|
/**
|
|
17907
|
-
*
|
|
19036
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
17908
19037
|
*/
|
|
17909
|
-
|
|
19038
|
+
createdAt: string;
|
|
17910
19039
|
/**
|
|
17911
|
-
*
|
|
17912
|
-
*/
|
|
17913
|
-
|
|
17914
|
-
interfaces: {
|
|
17915
|
-
[k: string]: {
|
|
17916
|
-
/**
|
|
17917
|
-
* ID of the interface
|
|
17918
|
-
*/
|
|
17919
|
-
id: string;
|
|
17920
|
-
/**
|
|
17921
|
-
* Name of the interface
|
|
17922
|
-
*/
|
|
17923
|
-
name: string;
|
|
17924
|
-
/**
|
|
17925
|
-
* Version of the interface
|
|
17926
|
-
*/
|
|
17927
|
-
version: string;
|
|
17928
|
-
entities: {
|
|
17929
|
-
[k: string]: {
|
|
17930
|
-
name: string;
|
|
17931
|
-
};
|
|
17932
|
-
};
|
|
17933
|
-
actions: {
|
|
17934
|
-
[k: string]: {
|
|
17935
|
-
name: string;
|
|
17936
|
-
};
|
|
17937
|
-
};
|
|
17938
|
-
events: {
|
|
17939
|
-
[k: string]: {
|
|
17940
|
-
name: string;
|
|
17941
|
-
};
|
|
17942
|
-
};
|
|
17943
|
-
channels: {
|
|
17944
|
-
[k: string]: {
|
|
17945
|
-
name: string;
|
|
17946
|
-
};
|
|
17947
|
-
};
|
|
17948
|
-
};
|
|
17949
|
-
};
|
|
19040
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
19041
|
+
*/
|
|
19042
|
+
updatedAt: string;
|
|
17950
19043
|
/**
|
|
17951
19044
|
* Configuration definition
|
|
17952
19045
|
*/
|
|
@@ -17959,13 +19052,6 @@ interface GetPublicIntegrationResponse {
|
|
|
17959
19052
|
* Description of the configuration
|
|
17960
19053
|
*/
|
|
17961
19054
|
description?: string;
|
|
17962
|
-
/**
|
|
17963
|
-
* Identifier configuration of the [Integration](#schema_integration)
|
|
17964
|
-
*/
|
|
17965
|
-
identifier: {
|
|
17966
|
-
linkTemplateScript?: string;
|
|
17967
|
-
required: boolean;
|
|
17968
|
-
};
|
|
17969
19055
|
/**
|
|
17970
19056
|
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
17971
19057
|
*/
|
|
@@ -17973,127 +19059,22 @@ interface GetPublicIntegrationResponse {
|
|
|
17973
19059
|
[k: string]: any;
|
|
17974
19060
|
};
|
|
17975
19061
|
};
|
|
17976
|
-
configurations: {
|
|
17977
|
-
/**
|
|
17978
|
-
* Configuration definition
|
|
17979
|
-
*/
|
|
17980
|
-
[k: string]: {
|
|
17981
|
-
/**
|
|
17982
|
-
* Title of the configuration
|
|
17983
|
-
*/
|
|
17984
|
-
title?: string;
|
|
17985
|
-
/**
|
|
17986
|
-
* Description of the configuration
|
|
17987
|
-
*/
|
|
17988
|
-
description?: string;
|
|
17989
|
-
/**
|
|
17990
|
-
* Identifier configuration of the [Integration](#schema_integration)
|
|
17991
|
-
*/
|
|
17992
|
-
identifier: {
|
|
17993
|
-
linkTemplateScript?: string;
|
|
17994
|
-
required: boolean;
|
|
17995
|
-
};
|
|
17996
|
-
/**
|
|
17997
|
-
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
17998
|
-
*/
|
|
17999
|
-
schema: {
|
|
18000
|
-
[k: string]: any;
|
|
18001
|
-
};
|
|
18002
|
-
};
|
|
18003
|
-
};
|
|
18004
|
-
channels: {
|
|
18005
|
-
/**
|
|
18006
|
-
* Channel definition
|
|
18007
|
-
*/
|
|
18008
|
-
[k: string]: {
|
|
18009
|
-
/**
|
|
18010
|
-
* Title of the channel
|
|
18011
|
-
*/
|
|
18012
|
-
title?: string;
|
|
18013
|
-
/**
|
|
18014
|
-
* Description of the channel
|
|
18015
|
-
*/
|
|
18016
|
-
description?: string;
|
|
18017
|
-
messages: {
|
|
18018
|
-
/**
|
|
18019
|
-
* Message definition
|
|
18020
|
-
*/
|
|
18021
|
-
[k: string]: {
|
|
18022
|
-
schema: {
|
|
18023
|
-
[k: string]: any;
|
|
18024
|
-
};
|
|
18025
|
-
};
|
|
18026
|
-
};
|
|
18027
|
-
/**
|
|
18028
|
-
* Conversation object configuration
|
|
18029
|
-
*/
|
|
18030
|
-
conversation: {
|
|
18031
|
-
tags: {
|
|
18032
|
-
/**
|
|
18033
|
-
* Definition of a tag that can be provided on the object
|
|
18034
|
-
*/
|
|
18035
|
-
[k: string]: {
|
|
18036
|
-
/**
|
|
18037
|
-
* Title of the tag
|
|
18038
|
-
*/
|
|
18039
|
-
title?: string;
|
|
18040
|
-
/**
|
|
18041
|
-
* Description of the tag
|
|
18042
|
-
*/
|
|
18043
|
-
description?: string;
|
|
18044
|
-
};
|
|
18045
|
-
};
|
|
18046
|
-
/**
|
|
18047
|
-
* 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.
|
|
18048
|
-
*/
|
|
18049
|
-
creation: {
|
|
18050
|
-
/**
|
|
18051
|
-
* Enable conversation creation
|
|
18052
|
-
*/
|
|
18053
|
-
enabled: boolean;
|
|
18054
|
-
/**
|
|
18055
|
-
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
18056
|
-
*/
|
|
18057
|
-
requiredTags: string[];
|
|
18058
|
-
};
|
|
18059
|
-
};
|
|
18060
|
-
/**
|
|
18061
|
-
* Message object configuration
|
|
18062
|
-
*/
|
|
18063
|
-
message: {
|
|
18064
|
-
tags: {
|
|
18065
|
-
/**
|
|
18066
|
-
* Definition of a tag that can be provided on the object
|
|
18067
|
-
*/
|
|
18068
|
-
[k: string]: {
|
|
18069
|
-
/**
|
|
18070
|
-
* Title of the tag
|
|
18071
|
-
*/
|
|
18072
|
-
title?: string;
|
|
18073
|
-
/**
|
|
18074
|
-
* Description of the tag
|
|
18075
|
-
*/
|
|
18076
|
-
description?: string;
|
|
18077
|
-
};
|
|
18078
|
-
};
|
|
18079
|
-
};
|
|
18080
|
-
};
|
|
18081
|
-
};
|
|
18082
19062
|
states: {
|
|
18083
|
-
/**
|
|
18084
|
-
* State definition
|
|
18085
|
-
*/
|
|
18086
19063
|
[k: string]: {
|
|
18087
19064
|
/**
|
|
18088
|
-
* Type of the [State](#schema_state) (`conversation`, `user` or `
|
|
19065
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
18089
19066
|
*/
|
|
18090
|
-
type: "conversation" | "user" | "
|
|
19067
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
18091
19068
|
/**
|
|
18092
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.
|
|
18093
19070
|
*/
|
|
18094
19071
|
schema: {
|
|
18095
19072
|
[k: string]: any;
|
|
18096
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;
|
|
18097
19078
|
};
|
|
18098
19079
|
};
|
|
18099
19080
|
events: {
|
|
@@ -18141,6 +19122,22 @@ interface GetPublicIntegrationResponse {
|
|
|
18141
19122
|
};
|
|
18142
19123
|
};
|
|
18143
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
|
+
};
|
|
18144
19141
|
/**
|
|
18145
19142
|
* User object configuration
|
|
18146
19143
|
*/
|
|
@@ -18160,82 +19157,65 @@ interface GetPublicIntegrationResponse {
|
|
|
18160
19157
|
description?: string;
|
|
18161
19158
|
};
|
|
18162
19159
|
};
|
|
18163
|
-
/**
|
|
18164
|
-
* 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.
|
|
18165
|
-
*/
|
|
18166
|
-
creation: {
|
|
18167
|
-
/**
|
|
18168
|
-
* Enable user creation
|
|
18169
|
-
*/
|
|
18170
|
-
enabled: boolean;
|
|
18171
|
-
/**
|
|
18172
|
-
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
18173
|
-
*/
|
|
18174
|
-
requiredTags: string[];
|
|
18175
|
-
};
|
|
18176
19160
|
};
|
|
18177
|
-
|
|
18178
|
-
|
|
18179
|
-
|
|
18180
|
-
|
|
18181
|
-
|
|
18182
|
-
/**
|
|
18183
|
-
* Title of the entity
|
|
18184
|
-
*/
|
|
18185
|
-
title?: string;
|
|
19161
|
+
/**
|
|
19162
|
+
* Conversation object configuration
|
|
19163
|
+
*/
|
|
19164
|
+
conversation: {
|
|
19165
|
+
tags: {
|
|
18186
19166
|
/**
|
|
18187
|
-
*
|
|
19167
|
+
* Definition of a tag that can be provided on the object
|
|
18188
19168
|
*/
|
|
18189
|
-
|
|
18190
|
-
|
|
18191
|
-
|
|
19169
|
+
[k: string]: {
|
|
19170
|
+
/**
|
|
19171
|
+
* Title of the tag
|
|
19172
|
+
*/
|
|
19173
|
+
title?: string;
|
|
19174
|
+
/**
|
|
19175
|
+
* Description of the tag
|
|
19176
|
+
*/
|
|
19177
|
+
description?: string;
|
|
18192
19178
|
};
|
|
18193
19179
|
};
|
|
18194
19180
|
};
|
|
18195
19181
|
/**
|
|
18196
|
-
*
|
|
18197
|
-
*/
|
|
18198
|
-
dev: boolean;
|
|
18199
|
-
/**
|
|
18200
|
-
* 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
|
|
18201
19183
|
*/
|
|
18202
19184
|
title: string;
|
|
18203
19185
|
/**
|
|
18204
|
-
* Description of the
|
|
19186
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
18205
19187
|
*/
|
|
18206
19188
|
description: string;
|
|
18207
19189
|
/**
|
|
18208
|
-
* 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
|
|
18209
19191
|
*/
|
|
18210
19192
|
iconUrl: string;
|
|
18211
19193
|
/**
|
|
18212
|
-
* 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
|
|
18213
19195
|
*/
|
|
18214
19196
|
readmeUrl: string;
|
|
18215
19197
|
/**
|
|
18216
|
-
*
|
|
19198
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
18217
19199
|
*/
|
|
18218
19200
|
public: boolean;
|
|
18219
|
-
/**
|
|
18220
|
-
* Status of the integration version verification
|
|
18221
|
-
*/
|
|
18222
|
-
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
18223
|
-
/**
|
|
18224
|
-
* 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.
|
|
18225
|
-
*/
|
|
18226
|
-
secrets: string[];
|
|
18227
|
-
ownerWorkspace: {
|
|
18228
|
-
id: string;
|
|
18229
|
-
handle: string | null;
|
|
18230
|
-
name: string;
|
|
18231
|
-
};
|
|
18232
|
-
meta: {
|
|
18233
|
-
installs: number;
|
|
18234
|
-
views: number;
|
|
18235
|
-
};
|
|
18236
19201
|
};
|
|
18237
19202
|
}
|
|
18238
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
|
+
|
|
18239
19219
|
interface CreateBotRequestHeaders {
|
|
18240
19220
|
}
|
|
18241
19221
|
interface CreateBotRequestQuery {
|
|
@@ -18499,7 +19479,7 @@ interface CreateBotResponse {
|
|
|
18499
19479
|
*/
|
|
18500
19480
|
iconUrl: string;
|
|
18501
19481
|
/**
|
|
18502
|
-
*
|
|
19482
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
18503
19483
|
*/
|
|
18504
19484
|
public: boolean;
|
|
18505
19485
|
/**
|
|
@@ -18934,6 +19914,7 @@ interface UpdateBotRequestBody {
|
|
|
18934
19914
|
url: string;
|
|
18935
19915
|
name: string;
|
|
18936
19916
|
}[];
|
|
19917
|
+
layers?: string[];
|
|
18937
19918
|
}
|
|
18938
19919
|
type UpdateBotInput = UpdateBotRequestBody & UpdateBotRequestHeaders & UpdateBotRequestQuery & UpdateBotRequestParams;
|
|
18939
19920
|
interface UpdateBotResponse {
|
|
@@ -19002,7 +19983,7 @@ interface UpdateBotResponse {
|
|
|
19002
19983
|
*/
|
|
19003
19984
|
iconUrl: string;
|
|
19004
19985
|
/**
|
|
19005
|
-
*
|
|
19986
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
19006
19987
|
*/
|
|
19007
19988
|
public: boolean;
|
|
19008
19989
|
/**
|
|
@@ -19379,7 +20360,7 @@ interface GetBotResponse {
|
|
|
19379
20360
|
*/
|
|
19380
20361
|
iconUrl: string;
|
|
19381
20362
|
/**
|
|
19382
|
-
*
|
|
20363
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
19383
20364
|
*/
|
|
19384
20365
|
public: boolean;
|
|
19385
20366
|
/**
|
|
@@ -19633,7 +20614,7 @@ interface GetBotLogsRequestHeaders {
|
|
|
19633
20614
|
}
|
|
19634
20615
|
interface GetBotLogsRequestQuery {
|
|
19635
20616
|
timeStart: string;
|
|
19636
|
-
timeEnd
|
|
20617
|
+
timeEnd?: string;
|
|
19637
20618
|
level?: string;
|
|
19638
20619
|
userId?: string;
|
|
19639
20620
|
workflowId?: string;
|
|
@@ -20953,7 +21934,7 @@ interface CreateIntegrationRequestBody {
|
|
|
20953
21934
|
*/
|
|
20954
21935
|
description?: string;
|
|
20955
21936
|
/**
|
|
20956
|
-
*
|
|
21937
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
20957
21938
|
*/
|
|
20958
21939
|
public?: boolean;
|
|
20959
21940
|
layers?: string[];
|
|
@@ -21310,7 +22291,7 @@ interface CreateIntegrationResponse {
|
|
|
21310
22291
|
*/
|
|
21311
22292
|
readmeUrl: string;
|
|
21312
22293
|
/**
|
|
21313
|
-
*
|
|
22294
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
21314
22295
|
*/
|
|
21315
22296
|
public: boolean;
|
|
21316
22297
|
/**
|
|
@@ -21633,7 +22614,7 @@ interface ValidateIntegrationCreationRequestBody {
|
|
|
21633
22614
|
*/
|
|
21634
22615
|
description?: string;
|
|
21635
22616
|
/**
|
|
21636
|
-
*
|
|
22617
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
21637
22618
|
*/
|
|
21638
22619
|
public?: boolean;
|
|
21639
22620
|
layers?: string[];
|
|
@@ -21944,7 +22925,7 @@ interface UpdateIntegrationRequestBody {
|
|
|
21944
22925
|
*/
|
|
21945
22926
|
url?: string | null;
|
|
21946
22927
|
/**
|
|
21947
|
-
*
|
|
22928
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
21948
22929
|
*/
|
|
21949
22930
|
public?: boolean;
|
|
21950
22931
|
layers?: string[];
|
|
@@ -22301,7 +23282,7 @@ interface UpdateIntegrationResponse {
|
|
|
22301
23282
|
*/
|
|
22302
23283
|
readmeUrl: string;
|
|
22303
23284
|
/**
|
|
22304
|
-
*
|
|
23285
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
22305
23286
|
*/
|
|
22306
23287
|
public: boolean;
|
|
22307
23288
|
/**
|
|
@@ -22617,7 +23598,7 @@ interface ValidateIntegrationUpdateRequestBody {
|
|
|
22617
23598
|
*/
|
|
22618
23599
|
url?: string | null;
|
|
22619
23600
|
/**
|
|
22620
|
-
*
|
|
23601
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
22621
23602
|
*/
|
|
22622
23603
|
public?: boolean;
|
|
22623
23604
|
layers?: string[];
|
|
@@ -22683,7 +23664,7 @@ interface ListIntegrationsResponse {
|
|
|
22683
23664
|
*/
|
|
22684
23665
|
iconUrl: string;
|
|
22685
23666
|
/**
|
|
22686
|
-
*
|
|
23667
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
22687
23668
|
*/
|
|
22688
23669
|
public: boolean;
|
|
22689
23670
|
/**
|
|
@@ -23090,7 +24071,7 @@ interface GetIntegrationResponse {
|
|
|
23090
24071
|
*/
|
|
23091
24072
|
readmeUrl: string;
|
|
23092
24073
|
/**
|
|
23093
|
-
*
|
|
24074
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
23094
24075
|
*/
|
|
23095
24076
|
public: boolean;
|
|
23096
24077
|
/**
|
|
@@ -23108,7 +24089,7 @@ interface GetIntegrationLogsRequestHeaders {
|
|
|
23108
24089
|
}
|
|
23109
24090
|
interface GetIntegrationLogsRequestQuery {
|
|
23110
24091
|
timeStart: string;
|
|
23111
|
-
timeEnd
|
|
24092
|
+
timeEnd?: string;
|
|
23112
24093
|
level?: string;
|
|
23113
24094
|
userId?: string;
|
|
23114
24095
|
conversationId?: string;
|
|
@@ -23494,7 +24475,7 @@ interface GetIntegrationByNameResponse {
|
|
|
23494
24475
|
*/
|
|
23495
24476
|
readmeUrl: string;
|
|
23496
24477
|
/**
|
|
23497
|
-
*
|
|
24478
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
23498
24479
|
*/
|
|
23499
24480
|
public: boolean;
|
|
23500
24481
|
/**
|
|
@@ -24464,6 +25445,10 @@ interface CreatePluginRequestBody {
|
|
|
24464
25445
|
* Description of the plugin. This is the description that will be displayed in the UI
|
|
24465
25446
|
*/
|
|
24466
25447
|
description?: string;
|
|
25448
|
+
/**
|
|
25449
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
25450
|
+
*/
|
|
25451
|
+
public?: boolean;
|
|
24467
25452
|
}
|
|
24468
25453
|
type CreatePluginInput = CreatePluginRequestBody & CreatePluginRequestHeaders & CreatePluginRequestQuery & CreatePluginRequestParams;
|
|
24469
25454
|
interface CreatePluginResponse {
|
|
@@ -24642,6 +25627,10 @@ interface CreatePluginResponse {
|
|
|
24642
25627
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
24643
25628
|
*/
|
|
24644
25629
|
readmeUrl: string;
|
|
25630
|
+
/**
|
|
25631
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
25632
|
+
*/
|
|
25633
|
+
public: boolean;
|
|
24645
25634
|
};
|
|
24646
25635
|
}
|
|
24647
25636
|
|
|
@@ -24831,6 +25820,10 @@ interface GetPluginResponse {
|
|
|
24831
25820
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
24832
25821
|
*/
|
|
24833
25822
|
readmeUrl: string;
|
|
25823
|
+
/**
|
|
25824
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
25825
|
+
*/
|
|
25826
|
+
public: boolean;
|
|
24834
25827
|
};
|
|
24835
25828
|
}
|
|
24836
25829
|
|
|
@@ -25021,6 +26014,10 @@ interface GetPluginByNameResponse {
|
|
|
25021
26014
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
25022
26015
|
*/
|
|
25023
26016
|
readmeUrl: string;
|
|
26017
|
+
/**
|
|
26018
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
26019
|
+
*/
|
|
26020
|
+
public: boolean;
|
|
25024
26021
|
};
|
|
25025
26022
|
}
|
|
25026
26023
|
|
|
@@ -25186,6 +26183,10 @@ interface UpdatePluginRequestBody {
|
|
|
25186
26183
|
* Description of the plugin. This is the description that will be displayed in the UI
|
|
25187
26184
|
*/
|
|
25188
26185
|
description?: string;
|
|
26186
|
+
/**
|
|
26187
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
26188
|
+
*/
|
|
26189
|
+
public?: boolean;
|
|
25189
26190
|
}
|
|
25190
26191
|
type UpdatePluginInput = UpdatePluginRequestBody & UpdatePluginRequestHeaders & UpdatePluginRequestQuery & UpdatePluginRequestParams;
|
|
25191
26192
|
interface UpdatePluginResponse {
|
|
@@ -25364,6 +26365,10 @@ interface UpdatePluginResponse {
|
|
|
25364
26365
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
25365
26366
|
*/
|
|
25366
26367
|
readmeUrl: string;
|
|
26368
|
+
/**
|
|
26369
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
26370
|
+
*/
|
|
26371
|
+
public: boolean;
|
|
25367
26372
|
};
|
|
25368
26373
|
}
|
|
25369
26374
|
|
|
@@ -25385,6 +26390,7 @@ interface ListPluginsRequestHeaders {
|
|
|
25385
26390
|
interface ListPluginsRequestQuery {
|
|
25386
26391
|
nextToken?: string;
|
|
25387
26392
|
name?: string;
|
|
26393
|
+
version?: string;
|
|
25388
26394
|
}
|
|
25389
26395
|
interface ListPluginsRequestParams {
|
|
25390
26396
|
}
|
|
@@ -25429,6 +26435,10 @@ interface ListPluginsResponse {
|
|
|
25429
26435
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
25430
26436
|
*/
|
|
25431
26437
|
readmeUrl: string;
|
|
26438
|
+
/**
|
|
26439
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
26440
|
+
*/
|
|
26441
|
+
public: boolean;
|
|
25432
26442
|
}[];
|
|
25433
26443
|
meta: {
|
|
25434
26444
|
/**
|
|
@@ -25764,6 +26774,10 @@ interface UpsertFileRequestBody {
|
|
|
25764
26774
|
*/
|
|
25765
26775
|
generateMasterSummary?: boolean;
|
|
25766
26776
|
};
|
|
26777
|
+
/**
|
|
26778
|
+
* Internal setting, cannot be set manually.
|
|
26779
|
+
*/
|
|
26780
|
+
stack?: "realtime-v1";
|
|
25767
26781
|
vision?: {
|
|
25768
26782
|
/**
|
|
25769
26783
|
* (Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.
|
|
@@ -26390,6 +27404,18 @@ interface SearchFilesResponse {
|
|
|
26390
27404
|
*/
|
|
26391
27405
|
updatedAt: string;
|
|
26392
27406
|
};
|
|
27407
|
+
context?: {
|
|
27408
|
+
id: string;
|
|
27409
|
+
text: string;
|
|
27410
|
+
/**
|
|
27411
|
+
* Position of the context passage relative to the current passage. Negative for preceding passages, positive for subsequent, ommited for breadcrumbs.
|
|
27412
|
+
*/
|
|
27413
|
+
offset?: number;
|
|
27414
|
+
/**
|
|
27415
|
+
* The type of context passage
|
|
27416
|
+
*/
|
|
27417
|
+
type: "preceding" | "subsequent" | "breadcrumb";
|
|
27418
|
+
}[];
|
|
26393
27419
|
}[];
|
|
26394
27420
|
}
|
|
26395
27421
|
|
|
@@ -28280,7 +29306,7 @@ interface Bot {
|
|
|
28280
29306
|
*/
|
|
28281
29307
|
iconUrl: string;
|
|
28282
29308
|
/**
|
|
28283
|
-
*
|
|
29309
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
28284
29310
|
*/
|
|
28285
29311
|
public: boolean;
|
|
28286
29312
|
/**
|
|
@@ -28865,7 +29891,7 @@ interface Integration {
|
|
|
28865
29891
|
*/
|
|
28866
29892
|
readmeUrl: string;
|
|
28867
29893
|
/**
|
|
28868
|
-
*
|
|
29894
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
28869
29895
|
*/
|
|
28870
29896
|
public: boolean;
|
|
28871
29897
|
/**
|
|
@@ -29166,6 +30192,10 @@ interface Plugin {
|
|
|
29166
30192
|
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
29167
30193
|
*/
|
|
29168
30194
|
readmeUrl: string;
|
|
30195
|
+
/**
|
|
30196
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
30197
|
+
*/
|
|
30198
|
+
public: boolean;
|
|
29169
30199
|
}
|
|
29170
30200
|
interface Workspace {
|
|
29171
30201
|
id: string;
|
|
@@ -29955,6 +30985,10 @@ declare class Client$1 {
|
|
|
29955
30985
|
readonly listPublicIntegrations: (input: ListPublicIntegrationsInput) => Promise<ListPublicIntegrationsResponse>;
|
|
29956
30986
|
readonly getPublicIntegrationById: (input: GetPublicIntegrationByIdInput) => Promise<GetPublicIntegrationByIdResponse>;
|
|
29957
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>;
|
|
29958
30992
|
readonly createBot: (input: CreateBotInput) => Promise<CreateBotResponse>;
|
|
29959
30993
|
readonly updateBot: (input: UpdateBotInput) => Promise<UpdateBotResponse>;
|
|
29960
30994
|
readonly transferBot: (input: TransferBotInput) => Promise<TransferBotResponse>;
|