@botpress/client 1.27.2 → 1.29.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 +14 -14
- package/dist/bundle.cjs.map +4 -4
- package/dist/index.cjs +6 -6
- package/dist/index.cjs.map +4 -4
- package/dist/index.d.ts +1203 -185
- package/dist/index.mjs +5 -5
- package/dist/index.mjs.map +4 -4
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1119,6 +1119,8 @@ interface ListMessagesRequestQuery$1 {
|
|
|
1119
1119
|
tags?: {
|
|
1120
1120
|
[k: string]: string;
|
|
1121
1121
|
};
|
|
1122
|
+
afterDate?: string;
|
|
1123
|
+
beforeDate?: string;
|
|
1122
1124
|
}
|
|
1123
1125
|
interface ListMessagesRequestParams$1 {
|
|
1124
1126
|
}
|
|
@@ -1193,6 +1195,303 @@ type DeleteMessageInput$1 = DeleteMessageRequestBody$1 & DeleteMessageRequestHea
|
|
|
1193
1195
|
interface DeleteMessageResponse$1 {
|
|
1194
1196
|
}
|
|
1195
1197
|
|
|
1198
|
+
interface InitializeIncomingMessageRequestHeaders$1 {
|
|
1199
|
+
}
|
|
1200
|
+
interface InitializeIncomingMessageRequestQuery$1 {
|
|
1201
|
+
}
|
|
1202
|
+
interface InitializeIncomingMessageRequestParams$1 {
|
|
1203
|
+
}
|
|
1204
|
+
interface InitializeIncomingMessageRequestBody$1 {
|
|
1205
|
+
userId?: string;
|
|
1206
|
+
user?: {
|
|
1207
|
+
/**
|
|
1208
|
+
* Tags for the [User](#schema_user)
|
|
1209
|
+
*/
|
|
1210
|
+
tags: {
|
|
1211
|
+
[k: string]: string;
|
|
1212
|
+
};
|
|
1213
|
+
/**
|
|
1214
|
+
* @deprecated
|
|
1215
|
+
* [DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.
|
|
1216
|
+
*/
|
|
1217
|
+
integrationName?: string;
|
|
1218
|
+
/**
|
|
1219
|
+
* Name of the user
|
|
1220
|
+
*/
|
|
1221
|
+
name?: string;
|
|
1222
|
+
/**
|
|
1223
|
+
* URI of the user picture
|
|
1224
|
+
*/
|
|
1225
|
+
pictureUrl?: string;
|
|
1226
|
+
/**
|
|
1227
|
+
* Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
1228
|
+
*/
|
|
1229
|
+
discriminateByTags: string[];
|
|
1230
|
+
};
|
|
1231
|
+
conversationId?: string;
|
|
1232
|
+
conversation?: {
|
|
1233
|
+
/**
|
|
1234
|
+
* Channel name
|
|
1235
|
+
*/
|
|
1236
|
+
channel: string;
|
|
1237
|
+
/**
|
|
1238
|
+
* Tags for the [Conversation](#schema_conversation)
|
|
1239
|
+
*/
|
|
1240
|
+
tags: {
|
|
1241
|
+
[k: string]: string;
|
|
1242
|
+
};
|
|
1243
|
+
/**
|
|
1244
|
+
* @deprecated
|
|
1245
|
+
* [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
|
|
1246
|
+
*/
|
|
1247
|
+
integrationName?: string;
|
|
1248
|
+
/**
|
|
1249
|
+
* Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
1250
|
+
*/
|
|
1251
|
+
discriminateByTags: string[];
|
|
1252
|
+
};
|
|
1253
|
+
message?: {
|
|
1254
|
+
/**
|
|
1255
|
+
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
1256
|
+
*/
|
|
1257
|
+
payload: {
|
|
1258
|
+
[k: string]: any;
|
|
1259
|
+
};
|
|
1260
|
+
/**
|
|
1261
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
1262
|
+
*/
|
|
1263
|
+
type: string;
|
|
1264
|
+
/**
|
|
1265
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
1266
|
+
*/
|
|
1267
|
+
tags: {
|
|
1268
|
+
[k: string]: string;
|
|
1269
|
+
};
|
|
1270
|
+
origin?: "synthetic";
|
|
1271
|
+
/**
|
|
1272
|
+
* Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
1273
|
+
*/
|
|
1274
|
+
discriminateByTags: string[];
|
|
1275
|
+
};
|
|
1276
|
+
}
|
|
1277
|
+
type InitializeIncomingMessageInput$1 = InitializeIncomingMessageRequestBody$1 & InitializeIncomingMessageRequestHeaders$1 & InitializeIncomingMessageRequestQuery$1 & InitializeIncomingMessageRequestParams$1;
|
|
1278
|
+
interface InitializeIncomingMessageResponse$1 {
|
|
1279
|
+
/**
|
|
1280
|
+
* The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
|
|
1281
|
+
*/
|
|
1282
|
+
user: {
|
|
1283
|
+
/**
|
|
1284
|
+
* Id of the [User](#schema_user)
|
|
1285
|
+
*/
|
|
1286
|
+
id: string;
|
|
1287
|
+
/**
|
|
1288
|
+
* Creation date of the [User](#schema_user) in ISO 8601 format
|
|
1289
|
+
*/
|
|
1290
|
+
createdAt: string;
|
|
1291
|
+
/**
|
|
1292
|
+
* Updating date of the [User](#schema_user) in ISO 8601 format
|
|
1293
|
+
*/
|
|
1294
|
+
updatedAt: string;
|
|
1295
|
+
/**
|
|
1296
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [User](#schema_user). The set of [Tags](/docs/developers/concepts/tags) available on a [User](#schema_user) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
1297
|
+
*/
|
|
1298
|
+
tags: {
|
|
1299
|
+
[k: string]: string;
|
|
1300
|
+
};
|
|
1301
|
+
/**
|
|
1302
|
+
* Name of the [User](#schema_user)
|
|
1303
|
+
*/
|
|
1304
|
+
name?: string;
|
|
1305
|
+
/**
|
|
1306
|
+
* Picture URL of the [User](#schema_user)
|
|
1307
|
+
*/
|
|
1308
|
+
pictureUrl?: string;
|
|
1309
|
+
};
|
|
1310
|
+
/**
|
|
1311
|
+
* The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
|
|
1312
|
+
*/
|
|
1313
|
+
conversation: {
|
|
1314
|
+
/**
|
|
1315
|
+
* Id of the [Conversation](#schema_conversation)
|
|
1316
|
+
*/
|
|
1317
|
+
id: string;
|
|
1318
|
+
/**
|
|
1319
|
+
* Id of the current [Task](#schema_task)
|
|
1320
|
+
*/
|
|
1321
|
+
currentTaskId?: string;
|
|
1322
|
+
/**
|
|
1323
|
+
* Id of the current [Workflow](#schema_workflow)
|
|
1324
|
+
*/
|
|
1325
|
+
currentWorkflowId?: string;
|
|
1326
|
+
/**
|
|
1327
|
+
* Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
|
|
1328
|
+
*/
|
|
1329
|
+
createdAt: string;
|
|
1330
|
+
/**
|
|
1331
|
+
* Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
|
|
1332
|
+
*/
|
|
1333
|
+
updatedAt: string;
|
|
1334
|
+
/**
|
|
1335
|
+
* Name of the channel where the [Conversation](#schema_conversation) is happening
|
|
1336
|
+
*/
|
|
1337
|
+
channel: string;
|
|
1338
|
+
/**
|
|
1339
|
+
* Name of the integration that created the [Conversation](#schema_conversation)
|
|
1340
|
+
*/
|
|
1341
|
+
integration: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
1344
|
+
*/
|
|
1345
|
+
tags: {
|
|
1346
|
+
[k: string]: string;
|
|
1347
|
+
};
|
|
1348
|
+
};
|
|
1349
|
+
/**
|
|
1350
|
+
* The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
|
|
1351
|
+
*/
|
|
1352
|
+
message?: {
|
|
1353
|
+
/**
|
|
1354
|
+
* Id of the [Message](#schema_message)
|
|
1355
|
+
*/
|
|
1356
|
+
id: string;
|
|
1357
|
+
/**
|
|
1358
|
+
* Creation date of the [Message](#schema_message) in ISO 8601 format
|
|
1359
|
+
*/
|
|
1360
|
+
createdAt: string;
|
|
1361
|
+
/**
|
|
1362
|
+
* Update date of the [Message](#schema_message) in ISO 8601 format
|
|
1363
|
+
*/
|
|
1364
|
+
updatedAt: string;
|
|
1365
|
+
/**
|
|
1366
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
1367
|
+
*/
|
|
1368
|
+
type: string;
|
|
1369
|
+
/**
|
|
1370
|
+
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
1371
|
+
*/
|
|
1372
|
+
payload: {
|
|
1373
|
+
[k: string]: any;
|
|
1374
|
+
};
|
|
1375
|
+
/**
|
|
1376
|
+
* Direction of the message (`incoming` or `outgoing`).
|
|
1377
|
+
*/
|
|
1378
|
+
direction: "incoming" | "outgoing";
|
|
1379
|
+
/**
|
|
1380
|
+
* ID of the [User](#schema_user)
|
|
1381
|
+
*/
|
|
1382
|
+
userId: string;
|
|
1383
|
+
/**
|
|
1384
|
+
* ID of the [Conversation](#schema_conversation)
|
|
1385
|
+
*/
|
|
1386
|
+
conversationId: string;
|
|
1387
|
+
/**
|
|
1388
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
1389
|
+
*/
|
|
1390
|
+
tags: {
|
|
1391
|
+
[k: string]: string;
|
|
1392
|
+
};
|
|
1393
|
+
/**
|
|
1394
|
+
* Origin of the message (`synthetic`).
|
|
1395
|
+
*/
|
|
1396
|
+
origin?: "synthetic";
|
|
1397
|
+
};
|
|
1398
|
+
}
|
|
1399
|
+
|
|
1400
|
+
interface ImportMessagesRequestHeaders$1 {
|
|
1401
|
+
}
|
|
1402
|
+
interface ImportMessagesRequestQuery$1 {
|
|
1403
|
+
}
|
|
1404
|
+
interface ImportMessagesRequestParams$1 {
|
|
1405
|
+
}
|
|
1406
|
+
interface ImportMessagesRequestBody$1 {
|
|
1407
|
+
/**
|
|
1408
|
+
* @maxItems 100
|
|
1409
|
+
*/
|
|
1410
|
+
messages: {
|
|
1411
|
+
/**
|
|
1412
|
+
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
1413
|
+
*/
|
|
1414
|
+
payload: {
|
|
1415
|
+
[k: string]: any;
|
|
1416
|
+
};
|
|
1417
|
+
/**
|
|
1418
|
+
* ID of the [User](#schema_user)
|
|
1419
|
+
*/
|
|
1420
|
+
userId: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* ID of the [Conversation](#schema_conversation)
|
|
1423
|
+
*/
|
|
1424
|
+
conversationId: string;
|
|
1425
|
+
/**
|
|
1426
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
1427
|
+
*/
|
|
1428
|
+
type: string;
|
|
1429
|
+
/**
|
|
1430
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
1431
|
+
*/
|
|
1432
|
+
tags: {
|
|
1433
|
+
[k: string]: string;
|
|
1434
|
+
};
|
|
1435
|
+
/**
|
|
1436
|
+
* Creation date of the [Message](#schema_message) in ISO 8601 format
|
|
1437
|
+
*/
|
|
1438
|
+
createdAt: string;
|
|
1439
|
+
/**
|
|
1440
|
+
* Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
1441
|
+
*/
|
|
1442
|
+
discriminateByTags: string[];
|
|
1443
|
+
}[];
|
|
1444
|
+
}
|
|
1445
|
+
type ImportMessagesInput$1 = ImportMessagesRequestBody$1 & ImportMessagesRequestHeaders$1 & ImportMessagesRequestQuery$1 & ImportMessagesRequestParams$1;
|
|
1446
|
+
interface ImportMessagesResponse$1 {
|
|
1447
|
+
messages: {
|
|
1448
|
+
/**
|
|
1449
|
+
* Id of the [Message](#schema_message)
|
|
1450
|
+
*/
|
|
1451
|
+
id: string;
|
|
1452
|
+
/**
|
|
1453
|
+
* Creation date of the [Message](#schema_message) in ISO 8601 format
|
|
1454
|
+
*/
|
|
1455
|
+
createdAt: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* Update date of the [Message](#schema_message) in ISO 8601 format
|
|
1458
|
+
*/
|
|
1459
|
+
updatedAt: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
1462
|
+
*/
|
|
1463
|
+
type: string;
|
|
1464
|
+
/**
|
|
1465
|
+
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
1466
|
+
*/
|
|
1467
|
+
payload: {
|
|
1468
|
+
[k: string]: any;
|
|
1469
|
+
};
|
|
1470
|
+
/**
|
|
1471
|
+
* Direction of the message (`incoming` or `outgoing`).
|
|
1472
|
+
*/
|
|
1473
|
+
direction: "incoming" | "outgoing";
|
|
1474
|
+
/**
|
|
1475
|
+
* ID of the [User](#schema_user)
|
|
1476
|
+
*/
|
|
1477
|
+
userId: string;
|
|
1478
|
+
/**
|
|
1479
|
+
* ID of the [Conversation](#schema_conversation)
|
|
1480
|
+
*/
|
|
1481
|
+
conversationId: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
1484
|
+
*/
|
|
1485
|
+
tags: {
|
|
1486
|
+
[k: string]: string;
|
|
1487
|
+
};
|
|
1488
|
+
/**
|
|
1489
|
+
* Origin of the message (`synthetic`).
|
|
1490
|
+
*/
|
|
1491
|
+
origin?: "synthetic";
|
|
1492
|
+
}[];
|
|
1493
|
+
}
|
|
1494
|
+
|
|
1196
1495
|
interface CreateUserRequestHeaders$1 {
|
|
1197
1496
|
}
|
|
1198
1497
|
interface CreateUserRequestQuery$1 {
|
|
@@ -1307,6 +1606,11 @@ interface ListUsersRequestQuery$1 {
|
|
|
1307
1606
|
tags?: {
|
|
1308
1607
|
[k: string]: string;
|
|
1309
1608
|
};
|
|
1609
|
+
afterDate?: string;
|
|
1610
|
+
beforeDate?: string;
|
|
1611
|
+
rangeField?: "updatedAt" | "createdAt";
|
|
1612
|
+
sortField?: "updatedAt" | "createdAt";
|
|
1613
|
+
sortDirection?: "asc" | "desc";
|
|
1310
1614
|
}
|
|
1311
1615
|
interface ListUsersRequestParams$1 {
|
|
1312
1616
|
}
|
|
@@ -2873,6 +3177,8 @@ declare class Client$9 {
|
|
|
2873
3177
|
readonly updateMessage: (input: UpdateMessageInput$1) => Promise<UpdateMessageResponse$1>;
|
|
2874
3178
|
readonly listMessages: (input: ListMessagesInput$1) => Promise<ListMessagesResponse$1>;
|
|
2875
3179
|
readonly deleteMessage: (input: DeleteMessageInput$1) => Promise<DeleteMessageResponse$1>;
|
|
3180
|
+
readonly initializeIncomingMessage: (input: InitializeIncomingMessageInput$1) => Promise<InitializeIncomingMessageResponse$1>;
|
|
3181
|
+
readonly importMessages: (input: ImportMessagesInput$1) => Promise<ImportMessagesResponse$1>;
|
|
2876
3182
|
readonly createUser: (input: CreateUserInput$1) => Promise<CreateUserResponse$1>;
|
|
2877
3183
|
readonly getUser: (input: GetUserInput$1) => Promise<GetUserResponse$1>;
|
|
2878
3184
|
readonly listUsers: (input: ListUsersInput$1) => Promise<ListUsersResponse$1>;
|
|
@@ -2975,6 +3281,8 @@ declare class Client$8 extends Client$9 {
|
|
|
2975
3281
|
tags?: {
|
|
2976
3282
|
[x: string]: string;
|
|
2977
3283
|
} | undefined;
|
|
3284
|
+
afterDate?: string | undefined;
|
|
3285
|
+
beforeDate?: string | undefined;
|
|
2978
3286
|
conversationId?: string | undefined;
|
|
2979
3287
|
}) => AsyncCollection<{
|
|
2980
3288
|
id: string;
|
|
@@ -2996,7 +3304,12 @@ declare class Client$8 extends Client$9 {
|
|
|
2996
3304
|
tags?: {
|
|
2997
3305
|
[x: string]: string;
|
|
2998
3306
|
} | undefined;
|
|
3307
|
+
sortField?: "updatedAt" | "createdAt" | undefined;
|
|
3308
|
+
sortDirection?: "asc" | "desc" | undefined;
|
|
3309
|
+
afterDate?: string | undefined;
|
|
3310
|
+
beforeDate?: string | undefined;
|
|
2999
3311
|
conversationId?: string | undefined;
|
|
3312
|
+
rangeField?: "updatedAt" | "createdAt" | undefined;
|
|
3000
3313
|
}) => AsyncCollection<{
|
|
3001
3314
|
id: string;
|
|
3002
3315
|
createdAt: string;
|
|
@@ -3290,6 +3603,10 @@ interface ListPublicIntegrationsResponse$1 {
|
|
|
3290
3603
|
* Status of the integration version verification
|
|
3291
3604
|
*/
|
|
3292
3605
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
3606
|
+
/**
|
|
3607
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
3608
|
+
*/
|
|
3609
|
+
lifecycleStatus: "published" | "deprecated";
|
|
3293
3610
|
ownerWorkspace: {
|
|
3294
3611
|
id: string;
|
|
3295
3612
|
handle: string | null;
|
|
@@ -3728,6 +4045,10 @@ interface GetPublicIntegrationByIdResponse$1 {
|
|
|
3728
4045
|
* Status of the integration version verification
|
|
3729
4046
|
*/
|
|
3730
4047
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
4048
|
+
/**
|
|
4049
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
4050
|
+
*/
|
|
4051
|
+
lifecycleStatus: "published" | "deprecated";
|
|
3731
4052
|
/**
|
|
3732
4053
|
* 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.
|
|
3733
4054
|
*/
|
|
@@ -4140,6 +4461,10 @@ interface GetPublicIntegrationResponse$1 {
|
|
|
4140
4461
|
* Status of the integration version verification
|
|
4141
4462
|
*/
|
|
4142
4463
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
4464
|
+
/**
|
|
4465
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
4466
|
+
*/
|
|
4467
|
+
lifecycleStatus: "published" | "deprecated";
|
|
4143
4468
|
/**
|
|
4144
4469
|
* 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.
|
|
4145
4470
|
*/
|
|
@@ -4215,6 +4540,10 @@ interface ListPublicPluginsResponse$1 {
|
|
|
4215
4540
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
4216
4541
|
*/
|
|
4217
4542
|
visibility: "public" | "private" | "unlisted";
|
|
4543
|
+
/**
|
|
4544
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
4545
|
+
*/
|
|
4546
|
+
lifecycleStatus: "published" | "deprecated";
|
|
4218
4547
|
}[];
|
|
4219
4548
|
meta: {
|
|
4220
4549
|
/**
|
|
@@ -4437,6 +4766,10 @@ interface GetPublicPluginByIdResponse$1 {
|
|
|
4437
4766
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
4438
4767
|
*/
|
|
4439
4768
|
visibility: "public" | "private" | "unlisted";
|
|
4769
|
+
/**
|
|
4770
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
4771
|
+
*/
|
|
4772
|
+
lifecycleStatus: "published" | "deprecated";
|
|
4440
4773
|
};
|
|
4441
4774
|
}
|
|
4442
4775
|
|
|
@@ -4662,6 +4995,10 @@ interface GetDereferencedPublicPluginByIdResponse$1 {
|
|
|
4662
4995
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
4663
4996
|
*/
|
|
4664
4997
|
visibility: "public" | "private" | "unlisted";
|
|
4998
|
+
/**
|
|
4999
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
5000
|
+
*/
|
|
5001
|
+
lifecycleStatus: "published" | "deprecated";
|
|
4665
5002
|
};
|
|
4666
5003
|
}
|
|
4667
5004
|
|
|
@@ -4879,6 +5216,10 @@ interface GetPublicPluginResponse$1 {
|
|
|
4879
5216
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
4880
5217
|
*/
|
|
4881
5218
|
visibility: "public" | "private" | "unlisted";
|
|
5219
|
+
/**
|
|
5220
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
5221
|
+
*/
|
|
5222
|
+
lifecycleStatus: "published" | "deprecated";
|
|
4882
5223
|
};
|
|
4883
5224
|
}
|
|
4884
5225
|
|
|
@@ -5483,6 +5824,10 @@ interface CreateBotRequestBody$1 {
|
|
|
5483
5824
|
* Optional name for the bot, if not provided will be auto-generated
|
|
5484
5825
|
*/
|
|
5485
5826
|
name?: string;
|
|
5827
|
+
/**
|
|
5828
|
+
* Optional description for the bot
|
|
5829
|
+
*/
|
|
5830
|
+
description?: string;
|
|
5486
5831
|
/**
|
|
5487
5832
|
* Media files associated with the [Bot](#schema_bot)
|
|
5488
5833
|
*/
|
|
@@ -5582,6 +5927,10 @@ interface CreateBotResponse$1 {
|
|
|
5582
5927
|
* Status of the integration version verification
|
|
5583
5928
|
*/
|
|
5584
5929
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
5930
|
+
/**
|
|
5931
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
5932
|
+
*/
|
|
5933
|
+
lifecycleStatus: "published" | "deprecated";
|
|
5585
5934
|
};
|
|
5586
5935
|
};
|
|
5587
5936
|
/**
|
|
@@ -5658,6 +6007,10 @@ interface CreateBotResponse$1 {
|
|
|
5658
6007
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
5659
6008
|
*/
|
|
5660
6009
|
visibility: "public" | "private" | "unlisted";
|
|
6010
|
+
/**
|
|
6011
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
6012
|
+
*/
|
|
6013
|
+
lifecycleStatus: "published" | "deprecated";
|
|
5661
6014
|
};
|
|
5662
6015
|
};
|
|
5663
6016
|
/**
|
|
@@ -5868,6 +6221,10 @@ interface CreateBotResponse$1 {
|
|
|
5868
6221
|
* Name of the [Bot](#schema_bot)
|
|
5869
6222
|
*/
|
|
5870
6223
|
name: string;
|
|
6224
|
+
/**
|
|
6225
|
+
* Description of the [Bot](#schema_bot)
|
|
6226
|
+
*/
|
|
6227
|
+
description?: string;
|
|
5871
6228
|
/**
|
|
5872
6229
|
* Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
|
|
5873
6230
|
*/
|
|
@@ -5887,7 +6244,7 @@ interface CreateBotResponse$1 {
|
|
|
5887
6244
|
/**
|
|
5888
6245
|
* Status of the bot
|
|
5889
6246
|
*/
|
|
5890
|
-
status: "active" | "deploying";
|
|
6247
|
+
status: "active" | "deploying" | "deleting";
|
|
5891
6248
|
/**
|
|
5892
6249
|
* Media files associated with the [Bot](#schema_bot)
|
|
5893
6250
|
*/
|
|
@@ -6150,6 +6507,10 @@ interface UpdateBotRequestBody$1 {
|
|
|
6150
6507
|
* Optional name for the bot, if not provided will be auto-generated
|
|
6151
6508
|
*/
|
|
6152
6509
|
name?: string;
|
|
6510
|
+
/**
|
|
6511
|
+
* Optional description for the bot
|
|
6512
|
+
*/
|
|
6513
|
+
description?: string;
|
|
6153
6514
|
/**
|
|
6154
6515
|
* Media files associated with the [Bot](#schema_bot)
|
|
6155
6516
|
*/
|
|
@@ -6246,6 +6607,10 @@ interface UpdateBotResponse$1 {
|
|
|
6246
6607
|
* Status of the integration version verification
|
|
6247
6608
|
*/
|
|
6248
6609
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
6610
|
+
/**
|
|
6611
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
6612
|
+
*/
|
|
6613
|
+
lifecycleStatus: "published" | "deprecated";
|
|
6249
6614
|
};
|
|
6250
6615
|
};
|
|
6251
6616
|
/**
|
|
@@ -6322,6 +6687,10 @@ interface UpdateBotResponse$1 {
|
|
|
6322
6687
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
6323
6688
|
*/
|
|
6324
6689
|
visibility: "public" | "private" | "unlisted";
|
|
6690
|
+
/**
|
|
6691
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
6692
|
+
*/
|
|
6693
|
+
lifecycleStatus: "published" | "deprecated";
|
|
6325
6694
|
};
|
|
6326
6695
|
};
|
|
6327
6696
|
/**
|
|
@@ -6532,6 +6901,10 @@ interface UpdateBotResponse$1 {
|
|
|
6532
6901
|
* Name of the [Bot](#schema_bot)
|
|
6533
6902
|
*/
|
|
6534
6903
|
name: string;
|
|
6904
|
+
/**
|
|
6905
|
+
* Description of the [Bot](#schema_bot)
|
|
6906
|
+
*/
|
|
6907
|
+
description?: string;
|
|
6535
6908
|
/**
|
|
6536
6909
|
* Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
|
|
6537
6910
|
*/
|
|
@@ -6551,7 +6924,7 @@ interface UpdateBotResponse$1 {
|
|
|
6551
6924
|
/**
|
|
6552
6925
|
* Status of the bot
|
|
6553
6926
|
*/
|
|
6554
|
-
status: "active" | "deploying";
|
|
6927
|
+
status: "active" | "deploying" | "deleting";
|
|
6555
6928
|
/**
|
|
6556
6929
|
* Media files associated with the [Bot](#schema_bot)
|
|
6557
6930
|
*/
|
|
@@ -6725,6 +7098,10 @@ interface GetBotResponse$1 {
|
|
|
6725
7098
|
* Status of the integration version verification
|
|
6726
7099
|
*/
|
|
6727
7100
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
7101
|
+
/**
|
|
7102
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
7103
|
+
*/
|
|
7104
|
+
lifecycleStatus: "published" | "deprecated";
|
|
6728
7105
|
};
|
|
6729
7106
|
};
|
|
6730
7107
|
/**
|
|
@@ -6801,6 +7178,10 @@ interface GetBotResponse$1 {
|
|
|
6801
7178
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
6802
7179
|
*/
|
|
6803
7180
|
visibility: "public" | "private" | "unlisted";
|
|
7181
|
+
/**
|
|
7182
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
7183
|
+
*/
|
|
7184
|
+
lifecycleStatus: "published" | "deprecated";
|
|
6804
7185
|
};
|
|
6805
7186
|
};
|
|
6806
7187
|
/**
|
|
@@ -7011,6 +7392,10 @@ interface GetBotResponse$1 {
|
|
|
7011
7392
|
* Name of the [Bot](#schema_bot)
|
|
7012
7393
|
*/
|
|
7013
7394
|
name: string;
|
|
7395
|
+
/**
|
|
7396
|
+
* Description of the [Bot](#schema_bot)
|
|
7397
|
+
*/
|
|
7398
|
+
description?: string;
|
|
7014
7399
|
/**
|
|
7015
7400
|
* Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
|
|
7016
7401
|
*/
|
|
@@ -7030,7 +7415,7 @@ interface GetBotResponse$1 {
|
|
|
7030
7415
|
/**
|
|
7031
7416
|
* Status of the bot
|
|
7032
7417
|
*/
|
|
7033
|
-
status: "active" | "deploying";
|
|
7418
|
+
status: "active" | "deploying" | "deleting";
|
|
7034
7419
|
/**
|
|
7035
7420
|
* Media files associated with the [Bot](#schema_bot)
|
|
7036
7421
|
*/
|
|
@@ -7810,7 +8195,7 @@ interface GetWorkspaceResponse$1 {
|
|
|
7810
8195
|
interface ListWorkspaceUsagesRequestHeaders$1 {
|
|
7811
8196
|
}
|
|
7812
8197
|
interface ListWorkspaceUsagesRequestQuery$1 {
|
|
7813
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
8198
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
7814
8199
|
period?: string;
|
|
7815
8200
|
}
|
|
7816
8201
|
interface ListWorkspaceUsagesRequestParams$1 {
|
|
@@ -7840,14 +8225,14 @@ interface ListWorkspaceUsagesResponse$1 {
|
|
|
7840
8225
|
/**
|
|
7841
8226
|
* Usage type that can be used
|
|
7842
8227
|
*/
|
|
7843
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
8228
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
7844
8229
|
}[];
|
|
7845
8230
|
}
|
|
7846
8231
|
|
|
7847
8232
|
interface BreakDownWorkspaceUsageByBotRequestHeaders$1 {
|
|
7848
8233
|
}
|
|
7849
8234
|
interface BreakDownWorkspaceUsageByBotRequestQuery$1 {
|
|
7850
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
8235
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
7851
8236
|
period?: string;
|
|
7852
8237
|
}
|
|
7853
8238
|
interface BreakDownWorkspaceUsageByBotRequestParams$1 {
|
|
@@ -7874,7 +8259,7 @@ interface GetAllWorkspaceQuotaCompletionRequestBody$1 {
|
|
|
7874
8259
|
type GetAllWorkspaceQuotaCompletionInput$1 = GetAllWorkspaceQuotaCompletionRequestBody$1 & GetAllWorkspaceQuotaCompletionRequestHeaders$1 & GetAllWorkspaceQuotaCompletionRequestQuery$1 & GetAllWorkspaceQuotaCompletionRequestParams$1;
|
|
7875
8260
|
interface GetAllWorkspaceQuotaCompletionResponse$1 {
|
|
7876
8261
|
[k: string]: {
|
|
7877
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
8262
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
7878
8263
|
completion: number;
|
|
7879
8264
|
};
|
|
7880
8265
|
}
|
|
@@ -7882,7 +8267,7 @@ interface GetAllWorkspaceQuotaCompletionResponse$1 {
|
|
|
7882
8267
|
interface GetWorkspaceQuotaRequestHeaders$1 {
|
|
7883
8268
|
}
|
|
7884
8269
|
interface GetWorkspaceQuotaRequestQuery$1 {
|
|
7885
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
8270
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
7886
8271
|
period?: string;
|
|
7887
8272
|
}
|
|
7888
8273
|
interface GetWorkspaceQuotaRequestParams$1 {
|
|
@@ -7904,7 +8289,7 @@ interface GetWorkspaceQuotaResponse$1 {
|
|
|
7904
8289
|
/**
|
|
7905
8290
|
* Usage type that can be used
|
|
7906
8291
|
*/
|
|
7907
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
8292
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
7908
8293
|
};
|
|
7909
8294
|
}
|
|
7910
8295
|
|
|
@@ -7932,7 +8317,7 @@ interface ListWorkspaceQuotasResponse$1 {
|
|
|
7932
8317
|
/**
|
|
7933
8318
|
* Usage type that can be used
|
|
7934
8319
|
*/
|
|
7935
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
8320
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
7936
8321
|
}[];
|
|
7937
8322
|
}
|
|
7938
8323
|
|
|
@@ -9027,6 +9412,10 @@ interface CreateIntegrationResponse$1 {
|
|
|
9027
9412
|
* Status of the integration version verification
|
|
9028
9413
|
*/
|
|
9029
9414
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
9415
|
+
/**
|
|
9416
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
9417
|
+
*/
|
|
9418
|
+
lifecycleStatus: "published" | "deprecated";
|
|
9030
9419
|
/**
|
|
9031
9420
|
* 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.
|
|
9032
9421
|
*/
|
|
@@ -10103,6 +10492,10 @@ interface UpdateIntegrationResponse$1 {
|
|
|
10103
10492
|
* Status of the integration version verification
|
|
10104
10493
|
*/
|
|
10105
10494
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
10495
|
+
/**
|
|
10496
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
10497
|
+
*/
|
|
10498
|
+
lifecycleStatus: "published" | "deprecated";
|
|
10106
10499
|
/**
|
|
10107
10500
|
* 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.
|
|
10108
10501
|
*/
|
|
@@ -10516,6 +10909,10 @@ interface ListIntegrationsResponse$1 {
|
|
|
10516
10909
|
* Status of the integration version verification
|
|
10517
10910
|
*/
|
|
10518
10911
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
10912
|
+
/**
|
|
10913
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
10914
|
+
*/
|
|
10915
|
+
lifecycleStatus: "published" | "deprecated";
|
|
10519
10916
|
/**
|
|
10520
10917
|
* Metadata about which fields matched the search criteria
|
|
10521
10918
|
*/
|
|
@@ -10950,6 +11347,10 @@ interface GetIntegrationResponse$1 {
|
|
|
10950
11347
|
* Status of the integration version verification
|
|
10951
11348
|
*/
|
|
10952
11349
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
11350
|
+
/**
|
|
11351
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
11352
|
+
*/
|
|
11353
|
+
lifecycleStatus: "published" | "deprecated";
|
|
10953
11354
|
/**
|
|
10954
11355
|
* 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.
|
|
10955
11356
|
*/
|
|
@@ -11382,6 +11783,10 @@ interface GetIntegrationByNameResponse$1 {
|
|
|
11382
11783
|
* Status of the integration version verification
|
|
11383
11784
|
*/
|
|
11384
11785
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
11786
|
+
/**
|
|
11787
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
11788
|
+
*/
|
|
11789
|
+
lifecycleStatus: "published" | "deprecated";
|
|
11385
11790
|
/**
|
|
11386
11791
|
* 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.
|
|
11387
11792
|
*/
|
|
@@ -12851,6 +13256,10 @@ interface CreatePluginResponse$1 {
|
|
|
12851
13256
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
12852
13257
|
*/
|
|
12853
13258
|
visibility: "public" | "private" | "unlisted";
|
|
13259
|
+
/**
|
|
13260
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
13261
|
+
*/
|
|
13262
|
+
lifecycleStatus: "published" | "deprecated";
|
|
12854
13263
|
};
|
|
12855
13264
|
}
|
|
12856
13265
|
|
|
@@ -13067,6 +13476,10 @@ interface GetPluginResponse$1 {
|
|
|
13067
13476
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
13068
13477
|
*/
|
|
13069
13478
|
visibility: "public" | "private" | "unlisted";
|
|
13479
|
+
/**
|
|
13480
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
13481
|
+
*/
|
|
13482
|
+
lifecycleStatus: "published" | "deprecated";
|
|
13070
13483
|
};
|
|
13071
13484
|
}
|
|
13072
13485
|
|
|
@@ -13292,6 +13705,10 @@ interface GetDereferencedPluginResponse$1 {
|
|
|
13292
13705
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
13293
13706
|
*/
|
|
13294
13707
|
visibility: "public" | "private" | "unlisted";
|
|
13708
|
+
/**
|
|
13709
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
13710
|
+
*/
|
|
13711
|
+
lifecycleStatus: "published" | "deprecated";
|
|
13295
13712
|
};
|
|
13296
13713
|
}
|
|
13297
13714
|
|
|
@@ -13509,6 +13926,10 @@ interface GetPluginByNameResponse$1 {
|
|
|
13509
13926
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
13510
13927
|
*/
|
|
13511
13928
|
visibility: "public" | "private" | "unlisted";
|
|
13929
|
+
/**
|
|
13930
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
13931
|
+
*/
|
|
13932
|
+
lifecycleStatus: "published" | "deprecated";
|
|
13512
13933
|
};
|
|
13513
13934
|
}
|
|
13514
13935
|
|
|
@@ -13929,6 +14350,10 @@ interface UpdatePluginResponse$1 {
|
|
|
13929
14350
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
13930
14351
|
*/
|
|
13931
14352
|
visibility: "public" | "private" | "unlisted";
|
|
14353
|
+
/**
|
|
14354
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
14355
|
+
*/
|
|
14356
|
+
lifecycleStatus: "published" | "deprecated";
|
|
13932
14357
|
};
|
|
13933
14358
|
}
|
|
13934
14359
|
|
|
@@ -14004,6 +14429,10 @@ interface ListPluginsResponse$1 {
|
|
|
14004
14429
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
14005
14430
|
*/
|
|
14006
14431
|
visibility: "public" | "private" | "unlisted";
|
|
14432
|
+
/**
|
|
14433
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
14434
|
+
*/
|
|
14435
|
+
lifecycleStatus: "published" | "deprecated";
|
|
14007
14436
|
}[];
|
|
14008
14437
|
meta: {
|
|
14009
14438
|
/**
|
|
@@ -14031,7 +14460,7 @@ interface GetPluginCodeResponse$1 {
|
|
|
14031
14460
|
interface GetUsageRequestHeaders$1 {
|
|
14032
14461
|
}
|
|
14033
14462
|
interface GetUsageRequestQuery$1 {
|
|
14034
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
14463
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
14035
14464
|
period?: string;
|
|
14036
14465
|
}
|
|
14037
14466
|
interface GetUsageRequestParams$1 {
|
|
@@ -14061,7 +14490,7 @@ interface GetUsageResponse$1 {
|
|
|
14061
14490
|
/**
|
|
14062
14491
|
* Usage type that can be used
|
|
14063
14492
|
*/
|
|
14064
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
14493
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
14065
14494
|
};
|
|
14066
14495
|
}
|
|
14067
14496
|
|
|
@@ -14098,14 +14527,14 @@ interface GetMultipleUsagesResponse$1 {
|
|
|
14098
14527
|
/**
|
|
14099
14528
|
* Usage type that can be used
|
|
14100
14529
|
*/
|
|
14101
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
14530
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
14102
14531
|
}[];
|
|
14103
14532
|
}
|
|
14104
14533
|
|
|
14105
14534
|
interface ListUsageHistoryRequestHeaders$1 {
|
|
14106
14535
|
}
|
|
14107
14536
|
interface ListUsageHistoryRequestQuery$1 {
|
|
14108
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
14537
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
14109
14538
|
}
|
|
14110
14539
|
interface ListUsageHistoryRequestParams$1 {
|
|
14111
14540
|
id: string;
|
|
@@ -14134,14 +14563,14 @@ interface ListUsageHistoryResponse$1 {
|
|
|
14134
14563
|
/**
|
|
14135
14564
|
* Usage type that can be used
|
|
14136
14565
|
*/
|
|
14137
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
14566
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
14138
14567
|
}[];
|
|
14139
14568
|
}
|
|
14140
14569
|
|
|
14141
14570
|
interface ListUsageActivityRequestHeaders$1 {
|
|
14142
14571
|
}
|
|
14143
14572
|
interface ListUsageActivityRequestQuery$1 {
|
|
14144
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
14573
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
14145
14574
|
timestampFrom?: string;
|
|
14146
14575
|
timestampUntil?: string;
|
|
14147
14576
|
nextToken?: string;
|
|
@@ -14169,7 +14598,7 @@ interface ListUsageActivityResponse$1 {
|
|
|
14169
14598
|
interface ListUsageActivityDailyRequestHeaders$1 {
|
|
14170
14599
|
}
|
|
14171
14600
|
interface ListUsageActivityDailyRequestQuery$1 {
|
|
14172
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
14601
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
14173
14602
|
dateFrom?: string;
|
|
14174
14603
|
dateUntil?: string;
|
|
14175
14604
|
nextToken?: string;
|
|
@@ -14414,6 +14843,7 @@ declare class Client$6 extends Client$7 {
|
|
|
14414
14843
|
public: boolean;
|
|
14415
14844
|
visibility: "public" | "private" | "unlisted";
|
|
14416
14845
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
14846
|
+
lifecycleStatus: "published" | "deprecated";
|
|
14417
14847
|
ownerWorkspace: {
|
|
14418
14848
|
id: string;
|
|
14419
14849
|
handle: string | null;
|
|
@@ -14508,6 +14938,7 @@ declare class Client$6 extends Client$7 {
|
|
|
14508
14938
|
public: boolean;
|
|
14509
14939
|
visibility: "public" | "private" | "unlisted";
|
|
14510
14940
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
14941
|
+
lifecycleStatus: "published" | "deprecated";
|
|
14511
14942
|
matchedOn?: {
|
|
14512
14943
|
name?: boolean;
|
|
14513
14944
|
title?: boolean;
|
|
@@ -14550,7 +14981,7 @@ declare class Client$6 extends Client$7 {
|
|
|
14550
14981
|
createdAt: string;
|
|
14551
14982
|
}>;
|
|
14552
14983
|
usageActivity: (props: {
|
|
14553
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
14984
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
14554
14985
|
id: string;
|
|
14555
14986
|
timestampFrom?: string | undefined;
|
|
14556
14987
|
timestampUntil?: string | undefined;
|
|
@@ -14563,7 +14994,7 @@ declare class Client$6 extends Client$7 {
|
|
|
14563
14994
|
};
|
|
14564
14995
|
}>;
|
|
14565
14996
|
usageActivityDaily: (props: {
|
|
14566
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
14997
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
14567
14998
|
id: string;
|
|
14568
14999
|
dateFrom?: string | undefined;
|
|
14569
15000
|
dateUntil?: string | undefined;
|
|
@@ -14844,6 +15275,10 @@ interface UpsertFileResponse$1 {
|
|
|
14844
15275
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
14845
15276
|
*/
|
|
14846
15277
|
name?: string;
|
|
15278
|
+
/**
|
|
15279
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
15280
|
+
*/
|
|
15281
|
+
alias?: string;
|
|
14847
15282
|
};
|
|
14848
15283
|
/**
|
|
14849
15284
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -14880,6 +15315,7 @@ interface ListFilesRequestQuery$1 {
|
|
|
14880
15315
|
* @maxItems 50
|
|
14881
15316
|
*/
|
|
14882
15317
|
ids?: string[];
|
|
15318
|
+
indexed?: boolean;
|
|
14883
15319
|
}
|
|
14884
15320
|
interface ListFilesRequestParams$1 {
|
|
14885
15321
|
}
|
|
@@ -14970,6 +15406,10 @@ interface ListFilesResponse$1 {
|
|
|
14970
15406
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
14971
15407
|
*/
|
|
14972
15408
|
name?: string;
|
|
15409
|
+
/**
|
|
15410
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
15411
|
+
*/
|
|
15412
|
+
alias?: string;
|
|
14973
15413
|
};
|
|
14974
15414
|
/**
|
|
14975
15415
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -15078,6 +15518,10 @@ interface GetFileResponse$1 {
|
|
|
15078
15518
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
15079
15519
|
*/
|
|
15080
15520
|
name?: string;
|
|
15521
|
+
/**
|
|
15522
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
15523
|
+
*/
|
|
15524
|
+
alias?: string;
|
|
15081
15525
|
};
|
|
15082
15526
|
/**
|
|
15083
15527
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -15200,6 +15644,10 @@ interface UpdateFileMetadataResponse$1 {
|
|
|
15200
15644
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
15201
15645
|
*/
|
|
15202
15646
|
name?: string;
|
|
15647
|
+
/**
|
|
15648
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
15649
|
+
*/
|
|
15650
|
+
alias?: string;
|
|
15203
15651
|
};
|
|
15204
15652
|
/**
|
|
15205
15653
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -15310,6 +15758,10 @@ interface CopyFileResponse$1 {
|
|
|
15310
15758
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
15311
15759
|
*/
|
|
15312
15760
|
name?: string;
|
|
15761
|
+
/**
|
|
15762
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
15763
|
+
*/
|
|
15764
|
+
alias?: string;
|
|
15313
15765
|
};
|
|
15314
15766
|
/**
|
|
15315
15767
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -15719,6 +16171,7 @@ declare class Client$4 extends Client$5 implements IClient$2 {
|
|
|
15719
16171
|
sortField?: "key" | "size" | "createdAt" | "updatedAt" | "status" | undefined;
|
|
15720
16172
|
sortDirection?: "asc" | "desc" | undefined;
|
|
15721
16173
|
ids?: string[] | undefined;
|
|
16174
|
+
indexed?: boolean | undefined;
|
|
15722
16175
|
}) => AsyncCollection<{
|
|
15723
16176
|
id: string;
|
|
15724
16177
|
botId: string;
|
|
@@ -15743,6 +16196,7 @@ declare class Client$4 extends Client$5 implements IClient$2 {
|
|
|
15743
16196
|
type: "bot" | "integration" | "user";
|
|
15744
16197
|
id?: string;
|
|
15745
16198
|
name?: string;
|
|
16199
|
+
alias?: string;
|
|
15746
16200
|
};
|
|
15747
16201
|
indexingStack?: "v1" | "v2";
|
|
15748
16202
|
}>;
|
|
@@ -15831,6 +16285,10 @@ interface ListTablesResponse$1 {
|
|
|
15831
16285
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
15832
16286
|
*/
|
|
15833
16287
|
frozen?: boolean;
|
|
16288
|
+
/**
|
|
16289
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
16290
|
+
*/
|
|
16291
|
+
keyColumn?: string | null;
|
|
15834
16292
|
schema: {
|
|
15835
16293
|
$schema?: string;
|
|
15836
16294
|
/**
|
|
@@ -15976,6 +16434,10 @@ interface GetTableResponse$1 {
|
|
|
15976
16434
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
15977
16435
|
*/
|
|
15978
16436
|
frozen?: boolean;
|
|
16437
|
+
/**
|
|
16438
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
16439
|
+
*/
|
|
16440
|
+
keyColumn?: string | null;
|
|
15979
16441
|
schema: {
|
|
15980
16442
|
$schema?: string;
|
|
15981
16443
|
/**
|
|
@@ -16121,6 +16583,10 @@ interface GetOrCreateTableRequestBody$1 {
|
|
|
16121
16583
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
16122
16584
|
*/
|
|
16123
16585
|
frozen?: boolean;
|
|
16586
|
+
/**
|
|
16587
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
16588
|
+
*/
|
|
16589
|
+
keyColumn?: string | null;
|
|
16124
16590
|
/**
|
|
16125
16591
|
* Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
|
|
16126
16592
|
*/
|
|
@@ -16157,6 +16623,10 @@ interface GetOrCreateTableResponse$1 {
|
|
|
16157
16623
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
16158
16624
|
*/
|
|
16159
16625
|
frozen?: boolean;
|
|
16626
|
+
/**
|
|
16627
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
16628
|
+
*/
|
|
16629
|
+
keyColumn?: string | null;
|
|
16160
16630
|
schema: {
|
|
16161
16631
|
$schema?: string;
|
|
16162
16632
|
/**
|
|
@@ -16309,6 +16779,10 @@ interface CreateTableRequestBody$1 {
|
|
|
16309
16779
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
16310
16780
|
*/
|
|
16311
16781
|
frozen?: boolean;
|
|
16782
|
+
/**
|
|
16783
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
16784
|
+
*/
|
|
16785
|
+
keyColumn?: string | null;
|
|
16312
16786
|
/**
|
|
16313
16787
|
* Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
|
|
16314
16788
|
*/
|
|
@@ -16345,6 +16819,10 @@ interface CreateTableResponse$1 {
|
|
|
16345
16819
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
16346
16820
|
*/
|
|
16347
16821
|
frozen?: boolean;
|
|
16822
|
+
/**
|
|
16823
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
16824
|
+
*/
|
|
16825
|
+
keyColumn?: string | null;
|
|
16348
16826
|
schema: {
|
|
16349
16827
|
$schema?: string;
|
|
16350
16828
|
/**
|
|
@@ -16499,6 +16977,10 @@ interface DuplicateTableResponse$1 {
|
|
|
16499
16977
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
16500
16978
|
*/
|
|
16501
16979
|
frozen?: boolean;
|
|
16980
|
+
/**
|
|
16981
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
16982
|
+
*/
|
|
16983
|
+
keyColumn?: string | null;
|
|
16502
16984
|
schema: {
|
|
16503
16985
|
$schema?: string;
|
|
16504
16986
|
/**
|
|
@@ -16637,7 +17119,7 @@ interface ExportTableResponse$1 {
|
|
|
16637
17119
|
id: string;
|
|
16638
17120
|
botId: string;
|
|
16639
17121
|
tableId: string;
|
|
16640
|
-
type: "export" | "import";
|
|
17122
|
+
type: "export" | "import" | "clear_column" | "clear_vectors";
|
|
16641
17123
|
status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
|
|
16642
17124
|
progress?: number;
|
|
16643
17125
|
inputFileId: string | null;
|
|
@@ -16662,7 +17144,7 @@ interface GetTableJobsResponse$1 {
|
|
|
16662
17144
|
id: string;
|
|
16663
17145
|
botId: string;
|
|
16664
17146
|
tableId: string;
|
|
16665
|
-
type: "export" | "import";
|
|
17147
|
+
type: "export" | "import" | "clear_column" | "clear_vectors";
|
|
16666
17148
|
status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
|
|
16667
17149
|
progress?: number;
|
|
16668
17150
|
inputFileId: string | null;
|
|
@@ -16691,7 +17173,7 @@ interface ImportTableResponse$1 {
|
|
|
16691
17173
|
id: string;
|
|
16692
17174
|
botId: string;
|
|
16693
17175
|
tableId: string;
|
|
16694
|
-
type: "export" | "import";
|
|
17176
|
+
type: "export" | "import" | "clear_column" | "clear_vectors";
|
|
16695
17177
|
status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
|
|
16696
17178
|
progress?: number;
|
|
16697
17179
|
inputFileId: string | null;
|
|
@@ -16717,6 +17199,10 @@ interface UpdateTableRequestBody$1 {
|
|
|
16717
17199
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
16718
17200
|
*/
|
|
16719
17201
|
frozen?: boolean;
|
|
17202
|
+
/**
|
|
17203
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
17204
|
+
*/
|
|
17205
|
+
keyColumn?: string | null;
|
|
16720
17206
|
/**
|
|
16721
17207
|
* Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
|
|
16722
17208
|
*/
|
|
@@ -16757,6 +17243,10 @@ interface UpdateTableResponse$1 {
|
|
|
16757
17243
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
16758
17244
|
*/
|
|
16759
17245
|
frozen?: boolean;
|
|
17246
|
+
/**
|
|
17247
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
17248
|
+
*/
|
|
17249
|
+
keyColumn?: string | null;
|
|
16760
17250
|
schema: {
|
|
16761
17251
|
$schema?: string;
|
|
16762
17252
|
/**
|
|
@@ -16914,6 +17404,10 @@ interface RenameTableColumnResponse$1 {
|
|
|
16914
17404
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
16915
17405
|
*/
|
|
16916
17406
|
frozen?: boolean;
|
|
17407
|
+
/**
|
|
17408
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
17409
|
+
*/
|
|
17410
|
+
keyColumn?: string | null;
|
|
16917
17411
|
schema: {
|
|
16918
17412
|
$schema?: string;
|
|
16919
17413
|
/**
|
|
@@ -18399,47 +18893,445 @@ interface GetOrCreateMessageResponse {
|
|
|
18399
18893
|
};
|
|
18400
18894
|
}
|
|
18401
18895
|
|
|
18402
|
-
interface GetMessageRequestHeaders {
|
|
18896
|
+
interface GetMessageRequestHeaders {
|
|
18897
|
+
}
|
|
18898
|
+
interface GetMessageRequestQuery {
|
|
18899
|
+
}
|
|
18900
|
+
interface GetMessageRequestParams {
|
|
18901
|
+
id: string;
|
|
18902
|
+
}
|
|
18903
|
+
interface GetMessageRequestBody {
|
|
18904
|
+
}
|
|
18905
|
+
type GetMessageInput = GetMessageRequestBody & GetMessageRequestHeaders & GetMessageRequestQuery & GetMessageRequestParams;
|
|
18906
|
+
interface GetMessageResponse {
|
|
18907
|
+
/**
|
|
18908
|
+
* The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
|
|
18909
|
+
*/
|
|
18910
|
+
message: {
|
|
18911
|
+
/**
|
|
18912
|
+
* Id of the [Message](#schema_message)
|
|
18913
|
+
*/
|
|
18914
|
+
id: string;
|
|
18915
|
+
/**
|
|
18916
|
+
* Creation date of the [Message](#schema_message) in ISO 8601 format
|
|
18917
|
+
*/
|
|
18918
|
+
createdAt: string;
|
|
18919
|
+
/**
|
|
18920
|
+
* Update date of the [Message](#schema_message) in ISO 8601 format
|
|
18921
|
+
*/
|
|
18922
|
+
updatedAt: string;
|
|
18923
|
+
/**
|
|
18924
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
18925
|
+
*/
|
|
18926
|
+
type: string;
|
|
18927
|
+
/**
|
|
18928
|
+
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
18929
|
+
*/
|
|
18930
|
+
payload: {
|
|
18931
|
+
[k: string]: any;
|
|
18932
|
+
};
|
|
18933
|
+
/**
|
|
18934
|
+
* Direction of the message (`incoming` or `outgoing`).
|
|
18935
|
+
*/
|
|
18936
|
+
direction: "incoming" | "outgoing";
|
|
18937
|
+
/**
|
|
18938
|
+
* ID of the [User](#schema_user)
|
|
18939
|
+
*/
|
|
18940
|
+
userId: string;
|
|
18941
|
+
/**
|
|
18942
|
+
* ID of the [Conversation](#schema_conversation)
|
|
18943
|
+
*/
|
|
18944
|
+
conversationId: string;
|
|
18945
|
+
/**
|
|
18946
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
18947
|
+
*/
|
|
18948
|
+
tags: {
|
|
18949
|
+
[k: string]: string;
|
|
18950
|
+
};
|
|
18951
|
+
/**
|
|
18952
|
+
* Origin of the message (`synthetic`).
|
|
18953
|
+
*/
|
|
18954
|
+
origin?: "synthetic";
|
|
18955
|
+
};
|
|
18956
|
+
}
|
|
18957
|
+
|
|
18958
|
+
interface UpdateMessageRequestHeaders {
|
|
18959
|
+
}
|
|
18960
|
+
interface UpdateMessageRequestQuery {
|
|
18961
|
+
}
|
|
18962
|
+
interface UpdateMessageRequestParams {
|
|
18963
|
+
id: string;
|
|
18964
|
+
}
|
|
18965
|
+
interface UpdateMessageRequestBody {
|
|
18966
|
+
/**
|
|
18967
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
18968
|
+
*/
|
|
18969
|
+
tags: {
|
|
18970
|
+
[k: string]: string;
|
|
18971
|
+
};
|
|
18972
|
+
/**
|
|
18973
|
+
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
18974
|
+
*/
|
|
18975
|
+
payload?: {
|
|
18976
|
+
[k: string]: any;
|
|
18977
|
+
};
|
|
18978
|
+
}
|
|
18979
|
+
type UpdateMessageInput = UpdateMessageRequestBody & UpdateMessageRequestHeaders & UpdateMessageRequestQuery & UpdateMessageRequestParams;
|
|
18980
|
+
interface UpdateMessageResponse {
|
|
18981
|
+
/**
|
|
18982
|
+
* The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
|
|
18983
|
+
*/
|
|
18984
|
+
message: {
|
|
18985
|
+
/**
|
|
18986
|
+
* Id of the [Message](#schema_message)
|
|
18987
|
+
*/
|
|
18988
|
+
id: string;
|
|
18989
|
+
/**
|
|
18990
|
+
* Creation date of the [Message](#schema_message) in ISO 8601 format
|
|
18991
|
+
*/
|
|
18992
|
+
createdAt: string;
|
|
18993
|
+
/**
|
|
18994
|
+
* Update date of the [Message](#schema_message) in ISO 8601 format
|
|
18995
|
+
*/
|
|
18996
|
+
updatedAt: string;
|
|
18997
|
+
/**
|
|
18998
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
18999
|
+
*/
|
|
19000
|
+
type: string;
|
|
19001
|
+
/**
|
|
19002
|
+
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
19003
|
+
*/
|
|
19004
|
+
payload: {
|
|
19005
|
+
[k: string]: any;
|
|
19006
|
+
};
|
|
19007
|
+
/**
|
|
19008
|
+
* Direction of the message (`incoming` or `outgoing`).
|
|
19009
|
+
*/
|
|
19010
|
+
direction: "incoming" | "outgoing";
|
|
19011
|
+
/**
|
|
19012
|
+
* ID of the [User](#schema_user)
|
|
19013
|
+
*/
|
|
19014
|
+
userId: string;
|
|
19015
|
+
/**
|
|
19016
|
+
* ID of the [Conversation](#schema_conversation)
|
|
19017
|
+
*/
|
|
19018
|
+
conversationId: string;
|
|
19019
|
+
/**
|
|
19020
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
19021
|
+
*/
|
|
19022
|
+
tags: {
|
|
19023
|
+
[k: string]: string;
|
|
19024
|
+
};
|
|
19025
|
+
/**
|
|
19026
|
+
* Origin of the message (`synthetic`).
|
|
19027
|
+
*/
|
|
19028
|
+
origin?: "synthetic";
|
|
19029
|
+
};
|
|
19030
|
+
}
|
|
19031
|
+
|
|
19032
|
+
interface ListMessagesRequestHeaders {
|
|
19033
|
+
}
|
|
19034
|
+
interface ListMessagesRequestQuery {
|
|
19035
|
+
nextToken?: string;
|
|
19036
|
+
conversationId?: string;
|
|
19037
|
+
tags?: {
|
|
19038
|
+
[k: string]: string;
|
|
19039
|
+
};
|
|
19040
|
+
afterDate?: string;
|
|
19041
|
+
beforeDate?: string;
|
|
19042
|
+
}
|
|
19043
|
+
interface ListMessagesRequestParams {
|
|
19044
|
+
}
|
|
19045
|
+
interface ListMessagesRequestBody {
|
|
19046
|
+
}
|
|
19047
|
+
type ListMessagesInput = ListMessagesRequestBody & ListMessagesRequestHeaders & ListMessagesRequestQuery & ListMessagesRequestParams;
|
|
19048
|
+
interface ListMessagesResponse {
|
|
19049
|
+
messages: {
|
|
19050
|
+
/**
|
|
19051
|
+
* Id of the [Message](#schema_message)
|
|
19052
|
+
*/
|
|
19053
|
+
id: string;
|
|
19054
|
+
/**
|
|
19055
|
+
* Creation date of the [Message](#schema_message) in ISO 8601 format
|
|
19056
|
+
*/
|
|
19057
|
+
createdAt: string;
|
|
19058
|
+
/**
|
|
19059
|
+
* Update date of the [Message](#schema_message) in ISO 8601 format
|
|
19060
|
+
*/
|
|
19061
|
+
updatedAt: string;
|
|
19062
|
+
/**
|
|
19063
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
19064
|
+
*/
|
|
19065
|
+
type: string;
|
|
19066
|
+
/**
|
|
19067
|
+
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
19068
|
+
*/
|
|
19069
|
+
payload: {
|
|
19070
|
+
[k: string]: any;
|
|
19071
|
+
};
|
|
19072
|
+
/**
|
|
19073
|
+
* Direction of the message (`incoming` or `outgoing`).
|
|
19074
|
+
*/
|
|
19075
|
+
direction: "incoming" | "outgoing";
|
|
19076
|
+
/**
|
|
19077
|
+
* ID of the [User](#schema_user)
|
|
19078
|
+
*/
|
|
19079
|
+
userId: string;
|
|
19080
|
+
/**
|
|
19081
|
+
* ID of the [Conversation](#schema_conversation)
|
|
19082
|
+
*/
|
|
19083
|
+
conversationId: string;
|
|
19084
|
+
/**
|
|
19085
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
19086
|
+
*/
|
|
19087
|
+
tags: {
|
|
19088
|
+
[k: string]: string;
|
|
19089
|
+
};
|
|
19090
|
+
/**
|
|
19091
|
+
* Origin of the message (`synthetic`).
|
|
19092
|
+
*/
|
|
19093
|
+
origin?: "synthetic";
|
|
19094
|
+
}[];
|
|
19095
|
+
meta: {
|
|
19096
|
+
/**
|
|
19097
|
+
* 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.
|
|
19098
|
+
*/
|
|
19099
|
+
nextToken?: string;
|
|
19100
|
+
};
|
|
19101
|
+
}
|
|
19102
|
+
|
|
19103
|
+
interface DeleteMessageRequestHeaders {
|
|
19104
|
+
}
|
|
19105
|
+
interface DeleteMessageRequestQuery {
|
|
19106
|
+
}
|
|
19107
|
+
interface DeleteMessageRequestParams {
|
|
19108
|
+
id: string;
|
|
19109
|
+
}
|
|
19110
|
+
interface DeleteMessageRequestBody {
|
|
19111
|
+
}
|
|
19112
|
+
type DeleteMessageInput = DeleteMessageRequestBody & DeleteMessageRequestHeaders & DeleteMessageRequestQuery & DeleteMessageRequestParams;
|
|
19113
|
+
interface DeleteMessageResponse {
|
|
19114
|
+
}
|
|
19115
|
+
|
|
19116
|
+
interface InitializeIncomingMessageRequestHeaders {
|
|
19117
|
+
}
|
|
19118
|
+
interface InitializeIncomingMessageRequestQuery {
|
|
19119
|
+
}
|
|
19120
|
+
interface InitializeIncomingMessageRequestParams {
|
|
19121
|
+
}
|
|
19122
|
+
interface InitializeIncomingMessageRequestBody {
|
|
19123
|
+
userId?: string;
|
|
19124
|
+
user?: {
|
|
19125
|
+
/**
|
|
19126
|
+
* Tags for the [User](#schema_user)
|
|
19127
|
+
*/
|
|
19128
|
+
tags: {
|
|
19129
|
+
[k: string]: string;
|
|
19130
|
+
};
|
|
19131
|
+
/**
|
|
19132
|
+
* @deprecated
|
|
19133
|
+
* [DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.
|
|
19134
|
+
*/
|
|
19135
|
+
integrationName?: string;
|
|
19136
|
+
/**
|
|
19137
|
+
* Name of the user
|
|
19138
|
+
*/
|
|
19139
|
+
name?: string;
|
|
19140
|
+
/**
|
|
19141
|
+
* URI of the user picture
|
|
19142
|
+
*/
|
|
19143
|
+
pictureUrl?: string;
|
|
19144
|
+
/**
|
|
19145
|
+
* Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
19146
|
+
*/
|
|
19147
|
+
discriminateByTags: string[];
|
|
19148
|
+
};
|
|
19149
|
+
conversationId?: string;
|
|
19150
|
+
conversation?: {
|
|
19151
|
+
/**
|
|
19152
|
+
* Channel name
|
|
19153
|
+
*/
|
|
19154
|
+
channel: string;
|
|
19155
|
+
/**
|
|
19156
|
+
* Tags for the [Conversation](#schema_conversation)
|
|
19157
|
+
*/
|
|
19158
|
+
tags: {
|
|
19159
|
+
[k: string]: string;
|
|
19160
|
+
};
|
|
19161
|
+
/**
|
|
19162
|
+
* @deprecated
|
|
19163
|
+
* [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
|
|
19164
|
+
*/
|
|
19165
|
+
integrationName?: string;
|
|
19166
|
+
/**
|
|
19167
|
+
* Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
19168
|
+
*/
|
|
19169
|
+
discriminateByTags: string[];
|
|
19170
|
+
};
|
|
19171
|
+
message?: {
|
|
19172
|
+
/**
|
|
19173
|
+
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
19174
|
+
*/
|
|
19175
|
+
payload: {
|
|
19176
|
+
[k: string]: any;
|
|
19177
|
+
};
|
|
19178
|
+
/**
|
|
19179
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
19180
|
+
*/
|
|
19181
|
+
type: string;
|
|
19182
|
+
/**
|
|
19183
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
19184
|
+
*/
|
|
19185
|
+
tags: {
|
|
19186
|
+
[k: string]: string;
|
|
19187
|
+
};
|
|
19188
|
+
origin?: "synthetic";
|
|
19189
|
+
/**
|
|
19190
|
+
* Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
19191
|
+
*/
|
|
19192
|
+
discriminateByTags: string[];
|
|
19193
|
+
};
|
|
19194
|
+
}
|
|
19195
|
+
type InitializeIncomingMessageInput = InitializeIncomingMessageRequestBody & InitializeIncomingMessageRequestHeaders & InitializeIncomingMessageRequestQuery & InitializeIncomingMessageRequestParams;
|
|
19196
|
+
interface InitializeIncomingMessageResponse {
|
|
19197
|
+
/**
|
|
19198
|
+
* The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
|
|
19199
|
+
*/
|
|
19200
|
+
user: {
|
|
19201
|
+
/**
|
|
19202
|
+
* Id of the [User](#schema_user)
|
|
19203
|
+
*/
|
|
19204
|
+
id: string;
|
|
19205
|
+
/**
|
|
19206
|
+
* Creation date of the [User](#schema_user) in ISO 8601 format
|
|
19207
|
+
*/
|
|
19208
|
+
createdAt: string;
|
|
19209
|
+
/**
|
|
19210
|
+
* Updating date of the [User](#schema_user) in ISO 8601 format
|
|
19211
|
+
*/
|
|
19212
|
+
updatedAt: string;
|
|
19213
|
+
/**
|
|
19214
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [User](#schema_user). The set of [Tags](/docs/developers/concepts/tags) available on a [User](#schema_user) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
19215
|
+
*/
|
|
19216
|
+
tags: {
|
|
19217
|
+
[k: string]: string;
|
|
19218
|
+
};
|
|
19219
|
+
/**
|
|
19220
|
+
* Name of the [User](#schema_user)
|
|
19221
|
+
*/
|
|
19222
|
+
name?: string;
|
|
19223
|
+
/**
|
|
19224
|
+
* Picture URL of the [User](#schema_user)
|
|
19225
|
+
*/
|
|
19226
|
+
pictureUrl?: string;
|
|
19227
|
+
};
|
|
19228
|
+
/**
|
|
19229
|
+
* The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
|
|
19230
|
+
*/
|
|
19231
|
+
conversation: {
|
|
19232
|
+
/**
|
|
19233
|
+
* Id of the [Conversation](#schema_conversation)
|
|
19234
|
+
*/
|
|
19235
|
+
id: string;
|
|
19236
|
+
/**
|
|
19237
|
+
* Id of the current [Task](#schema_task)
|
|
19238
|
+
*/
|
|
19239
|
+
currentTaskId?: string;
|
|
19240
|
+
/**
|
|
19241
|
+
* Id of the current [Workflow](#schema_workflow)
|
|
19242
|
+
*/
|
|
19243
|
+
currentWorkflowId?: string;
|
|
19244
|
+
/**
|
|
19245
|
+
* Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
|
|
19246
|
+
*/
|
|
19247
|
+
createdAt: string;
|
|
19248
|
+
/**
|
|
19249
|
+
* Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
|
|
19250
|
+
*/
|
|
19251
|
+
updatedAt: string;
|
|
19252
|
+
/**
|
|
19253
|
+
* Name of the channel where the [Conversation](#schema_conversation) is happening
|
|
19254
|
+
*/
|
|
19255
|
+
channel: string;
|
|
19256
|
+
/**
|
|
19257
|
+
* Name of the integration that created the [Conversation](#schema_conversation)
|
|
19258
|
+
*/
|
|
19259
|
+
integration: string;
|
|
19260
|
+
/**
|
|
19261
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
19262
|
+
*/
|
|
19263
|
+
tags: {
|
|
19264
|
+
[k: string]: string;
|
|
19265
|
+
};
|
|
19266
|
+
};
|
|
19267
|
+
/**
|
|
19268
|
+
* The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
|
|
19269
|
+
*/
|
|
19270
|
+
message?: {
|
|
19271
|
+
/**
|
|
19272
|
+
* Id of the [Message](#schema_message)
|
|
19273
|
+
*/
|
|
19274
|
+
id: string;
|
|
19275
|
+
/**
|
|
19276
|
+
* Creation date of the [Message](#schema_message) in ISO 8601 format
|
|
19277
|
+
*/
|
|
19278
|
+
createdAt: string;
|
|
19279
|
+
/**
|
|
19280
|
+
* Update date of the [Message](#schema_message) in ISO 8601 format
|
|
19281
|
+
*/
|
|
19282
|
+
updatedAt: string;
|
|
19283
|
+
/**
|
|
19284
|
+
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
19285
|
+
*/
|
|
19286
|
+
type: string;
|
|
19287
|
+
/**
|
|
19288
|
+
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
19289
|
+
*/
|
|
19290
|
+
payload: {
|
|
19291
|
+
[k: string]: any;
|
|
19292
|
+
};
|
|
19293
|
+
/**
|
|
19294
|
+
* Direction of the message (`incoming` or `outgoing`).
|
|
19295
|
+
*/
|
|
19296
|
+
direction: "incoming" | "outgoing";
|
|
19297
|
+
/**
|
|
19298
|
+
* ID of the [User](#schema_user)
|
|
19299
|
+
*/
|
|
19300
|
+
userId: string;
|
|
19301
|
+
/**
|
|
19302
|
+
* ID of the [Conversation](#schema_conversation)
|
|
19303
|
+
*/
|
|
19304
|
+
conversationId: string;
|
|
19305
|
+
/**
|
|
19306
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
19307
|
+
*/
|
|
19308
|
+
tags: {
|
|
19309
|
+
[k: string]: string;
|
|
19310
|
+
};
|
|
19311
|
+
/**
|
|
19312
|
+
* Origin of the message (`synthetic`).
|
|
19313
|
+
*/
|
|
19314
|
+
origin?: "synthetic";
|
|
19315
|
+
};
|
|
19316
|
+
}
|
|
19317
|
+
|
|
19318
|
+
interface ImportMessagesRequestHeaders {
|
|
18403
19319
|
}
|
|
18404
|
-
interface
|
|
19320
|
+
interface ImportMessagesRequestQuery {
|
|
18405
19321
|
}
|
|
18406
|
-
interface
|
|
18407
|
-
id: string;
|
|
19322
|
+
interface ImportMessagesRequestParams {
|
|
18408
19323
|
}
|
|
18409
|
-
interface
|
|
18410
|
-
}
|
|
18411
|
-
type GetMessageInput = GetMessageRequestBody & GetMessageRequestHeaders & GetMessageRequestQuery & GetMessageRequestParams;
|
|
18412
|
-
interface GetMessageResponse {
|
|
19324
|
+
interface ImportMessagesRequestBody {
|
|
18413
19325
|
/**
|
|
18414
|
-
*
|
|
19326
|
+
* @maxItems 100
|
|
18415
19327
|
*/
|
|
18416
|
-
|
|
18417
|
-
/**
|
|
18418
|
-
* Id of the [Message](#schema_message)
|
|
18419
|
-
*/
|
|
18420
|
-
id: string;
|
|
18421
|
-
/**
|
|
18422
|
-
* Creation date of the [Message](#schema_message) in ISO 8601 format
|
|
18423
|
-
*/
|
|
18424
|
-
createdAt: string;
|
|
18425
|
-
/**
|
|
18426
|
-
* Update date of the [Message](#schema_message) in ISO 8601 format
|
|
18427
|
-
*/
|
|
18428
|
-
updatedAt: string;
|
|
18429
|
-
/**
|
|
18430
|
-
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
18431
|
-
*/
|
|
18432
|
-
type: string;
|
|
19328
|
+
messages: {
|
|
18433
19329
|
/**
|
|
18434
19330
|
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
18435
19331
|
*/
|
|
18436
19332
|
payload: {
|
|
18437
19333
|
[k: string]: any;
|
|
18438
19334
|
};
|
|
18439
|
-
/**
|
|
18440
|
-
* Direction of the message (`incoming` or `outgoing`).
|
|
18441
|
-
*/
|
|
18442
|
-
direction: "incoming" | "outgoing";
|
|
18443
19335
|
/**
|
|
18444
19336
|
* ID of the [User](#schema_user)
|
|
18445
19337
|
*/
|
|
@@ -18448,108 +19340,28 @@ interface GetMessageResponse {
|
|
|
18448
19340
|
* ID of the [Conversation](#schema_conversation)
|
|
18449
19341
|
*/
|
|
18450
19342
|
conversationId: string;
|
|
18451
|
-
/**
|
|
18452
|
-
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
18453
|
-
*/
|
|
18454
|
-
tags: {
|
|
18455
|
-
[k: string]: string;
|
|
18456
|
-
};
|
|
18457
|
-
/**
|
|
18458
|
-
* Origin of the message (`synthetic`).
|
|
18459
|
-
*/
|
|
18460
|
-
origin?: "synthetic";
|
|
18461
|
-
};
|
|
18462
|
-
}
|
|
18463
|
-
|
|
18464
|
-
interface UpdateMessageRequestHeaders {
|
|
18465
|
-
}
|
|
18466
|
-
interface UpdateMessageRequestQuery {
|
|
18467
|
-
}
|
|
18468
|
-
interface UpdateMessageRequestParams {
|
|
18469
|
-
id: string;
|
|
18470
|
-
}
|
|
18471
|
-
interface UpdateMessageRequestBody {
|
|
18472
|
-
/**
|
|
18473
|
-
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
18474
|
-
*/
|
|
18475
|
-
tags: {
|
|
18476
|
-
[k: string]: string;
|
|
18477
|
-
};
|
|
18478
|
-
/**
|
|
18479
|
-
* Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
|
|
18480
|
-
*/
|
|
18481
|
-
payload?: {
|
|
18482
|
-
[k: string]: any;
|
|
18483
|
-
};
|
|
18484
|
-
}
|
|
18485
|
-
type UpdateMessageInput = UpdateMessageRequestBody & UpdateMessageRequestHeaders & UpdateMessageRequestQuery & UpdateMessageRequestParams;
|
|
18486
|
-
interface UpdateMessageResponse {
|
|
18487
|
-
/**
|
|
18488
|
-
* The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
|
|
18489
|
-
*/
|
|
18490
|
-
message: {
|
|
18491
|
-
/**
|
|
18492
|
-
* Id of the [Message](#schema_message)
|
|
18493
|
-
*/
|
|
18494
|
-
id: string;
|
|
18495
|
-
/**
|
|
18496
|
-
* Creation date of the [Message](#schema_message) in ISO 8601 format
|
|
18497
|
-
*/
|
|
18498
|
-
createdAt: string;
|
|
18499
|
-
/**
|
|
18500
|
-
* Update date of the [Message](#schema_message) in ISO 8601 format
|
|
18501
|
-
*/
|
|
18502
|
-
updatedAt: string;
|
|
18503
19343
|
/**
|
|
18504
19344
|
* Type of the [Message](#schema_message) represents the resource type that the message is related to
|
|
18505
19345
|
*/
|
|
18506
19346
|
type: string;
|
|
18507
19347
|
/**
|
|
18508
|
-
*
|
|
18509
|
-
*/
|
|
18510
|
-
payload: {
|
|
18511
|
-
[k: string]: any;
|
|
18512
|
-
};
|
|
18513
|
-
/**
|
|
18514
|
-
* Direction of the message (`incoming` or `outgoing`).
|
|
18515
|
-
*/
|
|
18516
|
-
direction: "incoming" | "outgoing";
|
|
18517
|
-
/**
|
|
18518
|
-
* ID of the [User](#schema_user)
|
|
18519
|
-
*/
|
|
18520
|
-
userId: string;
|
|
18521
|
-
/**
|
|
18522
|
-
* ID of the [Conversation](#schema_conversation)
|
|
18523
|
-
*/
|
|
18524
|
-
conversationId: string;
|
|
18525
|
-
/**
|
|
18526
|
-
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
19348
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
|
|
18527
19349
|
*/
|
|
18528
19350
|
tags: {
|
|
18529
19351
|
[k: string]: string;
|
|
18530
19352
|
};
|
|
18531
19353
|
/**
|
|
18532
|
-
*
|
|
19354
|
+
* Creation date of the [Message](#schema_message) in ISO 8601 format
|
|
18533
19355
|
*/
|
|
18534
|
-
|
|
18535
|
-
|
|
18536
|
-
}
|
|
18537
|
-
|
|
18538
|
-
|
|
18539
|
-
}
|
|
18540
|
-
interface ListMessagesRequestQuery {
|
|
18541
|
-
nextToken?: string;
|
|
18542
|
-
conversationId?: string;
|
|
18543
|
-
tags?: {
|
|
18544
|
-
[k: string]: string;
|
|
18545
|
-
};
|
|
18546
|
-
}
|
|
18547
|
-
interface ListMessagesRequestParams {
|
|
18548
|
-
}
|
|
18549
|
-
interface ListMessagesRequestBody {
|
|
19356
|
+
createdAt: string;
|
|
19357
|
+
/**
|
|
19358
|
+
* Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
|
|
19359
|
+
*/
|
|
19360
|
+
discriminateByTags: string[];
|
|
19361
|
+
}[];
|
|
18550
19362
|
}
|
|
18551
|
-
type
|
|
18552
|
-
interface
|
|
19363
|
+
type ImportMessagesInput = ImportMessagesRequestBody & ImportMessagesRequestHeaders & ImportMessagesRequestQuery & ImportMessagesRequestParams;
|
|
19364
|
+
interface ImportMessagesResponse {
|
|
18553
19365
|
messages: {
|
|
18554
19366
|
/**
|
|
18555
19367
|
* Id of the [Message](#schema_message)
|
|
@@ -18596,25 +19408,6 @@ interface ListMessagesResponse {
|
|
|
18596
19408
|
*/
|
|
18597
19409
|
origin?: "synthetic";
|
|
18598
19410
|
}[];
|
|
18599
|
-
meta: {
|
|
18600
|
-
/**
|
|
18601
|
-
* 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.
|
|
18602
|
-
*/
|
|
18603
|
-
nextToken?: string;
|
|
18604
|
-
};
|
|
18605
|
-
}
|
|
18606
|
-
|
|
18607
|
-
interface DeleteMessageRequestHeaders {
|
|
18608
|
-
}
|
|
18609
|
-
interface DeleteMessageRequestQuery {
|
|
18610
|
-
}
|
|
18611
|
-
interface DeleteMessageRequestParams {
|
|
18612
|
-
id: string;
|
|
18613
|
-
}
|
|
18614
|
-
interface DeleteMessageRequestBody {
|
|
18615
|
-
}
|
|
18616
|
-
type DeleteMessageInput = DeleteMessageRequestBody & DeleteMessageRequestHeaders & DeleteMessageRequestQuery & DeleteMessageRequestParams;
|
|
18617
|
-
interface DeleteMessageResponse {
|
|
18618
19411
|
}
|
|
18619
19412
|
|
|
18620
19413
|
interface CreateUserRequestHeaders {
|
|
@@ -18731,6 +19524,11 @@ interface ListUsersRequestQuery {
|
|
|
18731
19524
|
tags?: {
|
|
18732
19525
|
[k: string]: string;
|
|
18733
19526
|
};
|
|
19527
|
+
afterDate?: string;
|
|
19528
|
+
beforeDate?: string;
|
|
19529
|
+
rangeField?: "updatedAt" | "createdAt";
|
|
19530
|
+
sortField?: "updatedAt" | "createdAt";
|
|
19531
|
+
sortDirection?: "asc" | "desc";
|
|
18734
19532
|
}
|
|
18735
19533
|
interface ListUsersRequestParams {
|
|
18736
19534
|
}
|
|
@@ -20500,6 +21298,10 @@ interface ListPublicIntegrationsResponse {
|
|
|
20500
21298
|
* Status of the integration version verification
|
|
20501
21299
|
*/
|
|
20502
21300
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
21301
|
+
/**
|
|
21302
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
21303
|
+
*/
|
|
21304
|
+
lifecycleStatus: "published" | "deprecated";
|
|
20503
21305
|
ownerWorkspace: {
|
|
20504
21306
|
id: string;
|
|
20505
21307
|
handle: string | null;
|
|
@@ -20938,6 +21740,10 @@ interface GetPublicIntegrationByIdResponse {
|
|
|
20938
21740
|
* Status of the integration version verification
|
|
20939
21741
|
*/
|
|
20940
21742
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
21743
|
+
/**
|
|
21744
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
21745
|
+
*/
|
|
21746
|
+
lifecycleStatus: "published" | "deprecated";
|
|
20941
21747
|
/**
|
|
20942
21748
|
* 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.
|
|
20943
21749
|
*/
|
|
@@ -21350,6 +22156,10 @@ interface GetPublicIntegrationResponse {
|
|
|
21350
22156
|
* Status of the integration version verification
|
|
21351
22157
|
*/
|
|
21352
22158
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
22159
|
+
/**
|
|
22160
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
22161
|
+
*/
|
|
22162
|
+
lifecycleStatus: "published" | "deprecated";
|
|
21353
22163
|
/**
|
|
21354
22164
|
* 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.
|
|
21355
22165
|
*/
|
|
@@ -21425,6 +22235,10 @@ interface ListPublicPluginsResponse {
|
|
|
21425
22235
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
21426
22236
|
*/
|
|
21427
22237
|
visibility: "public" | "private" | "unlisted";
|
|
22238
|
+
/**
|
|
22239
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
22240
|
+
*/
|
|
22241
|
+
lifecycleStatus: "published" | "deprecated";
|
|
21428
22242
|
}[];
|
|
21429
22243
|
meta: {
|
|
21430
22244
|
/**
|
|
@@ -21647,6 +22461,10 @@ interface GetPublicPluginByIdResponse {
|
|
|
21647
22461
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
21648
22462
|
*/
|
|
21649
22463
|
visibility: "public" | "private" | "unlisted";
|
|
22464
|
+
/**
|
|
22465
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
22466
|
+
*/
|
|
22467
|
+
lifecycleStatus: "published" | "deprecated";
|
|
21650
22468
|
};
|
|
21651
22469
|
}
|
|
21652
22470
|
|
|
@@ -21872,6 +22690,10 @@ interface GetDereferencedPublicPluginByIdResponse {
|
|
|
21872
22690
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
21873
22691
|
*/
|
|
21874
22692
|
visibility: "public" | "private" | "unlisted";
|
|
22693
|
+
/**
|
|
22694
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
22695
|
+
*/
|
|
22696
|
+
lifecycleStatus: "published" | "deprecated";
|
|
21875
22697
|
};
|
|
21876
22698
|
}
|
|
21877
22699
|
|
|
@@ -22089,6 +22911,10 @@ interface GetPublicPluginResponse {
|
|
|
22089
22911
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
22090
22912
|
*/
|
|
22091
22913
|
visibility: "public" | "private" | "unlisted";
|
|
22914
|
+
/**
|
|
22915
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
22916
|
+
*/
|
|
22917
|
+
lifecycleStatus: "published" | "deprecated";
|
|
22092
22918
|
};
|
|
22093
22919
|
}
|
|
22094
22920
|
|
|
@@ -22693,6 +23519,10 @@ interface CreateBotRequestBody {
|
|
|
22693
23519
|
* Optional name for the bot, if not provided will be auto-generated
|
|
22694
23520
|
*/
|
|
22695
23521
|
name?: string;
|
|
23522
|
+
/**
|
|
23523
|
+
* Optional description for the bot
|
|
23524
|
+
*/
|
|
23525
|
+
description?: string;
|
|
22696
23526
|
/**
|
|
22697
23527
|
* Media files associated with the [Bot](#schema_bot)
|
|
22698
23528
|
*/
|
|
@@ -22792,6 +23622,10 @@ interface CreateBotResponse {
|
|
|
22792
23622
|
* Status of the integration version verification
|
|
22793
23623
|
*/
|
|
22794
23624
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
23625
|
+
/**
|
|
23626
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
23627
|
+
*/
|
|
23628
|
+
lifecycleStatus: "published" | "deprecated";
|
|
22795
23629
|
};
|
|
22796
23630
|
};
|
|
22797
23631
|
/**
|
|
@@ -22868,6 +23702,10 @@ interface CreateBotResponse {
|
|
|
22868
23702
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
22869
23703
|
*/
|
|
22870
23704
|
visibility: "public" | "private" | "unlisted";
|
|
23705
|
+
/**
|
|
23706
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
23707
|
+
*/
|
|
23708
|
+
lifecycleStatus: "published" | "deprecated";
|
|
22871
23709
|
};
|
|
22872
23710
|
};
|
|
22873
23711
|
/**
|
|
@@ -23078,6 +23916,10 @@ interface CreateBotResponse {
|
|
|
23078
23916
|
* Name of the [Bot](#schema_bot)
|
|
23079
23917
|
*/
|
|
23080
23918
|
name: string;
|
|
23919
|
+
/**
|
|
23920
|
+
* Description of the [Bot](#schema_bot)
|
|
23921
|
+
*/
|
|
23922
|
+
description?: string;
|
|
23081
23923
|
/**
|
|
23082
23924
|
* Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
|
|
23083
23925
|
*/
|
|
@@ -23097,7 +23939,7 @@ interface CreateBotResponse {
|
|
|
23097
23939
|
/**
|
|
23098
23940
|
* Status of the bot
|
|
23099
23941
|
*/
|
|
23100
|
-
status: "active" | "deploying";
|
|
23942
|
+
status: "active" | "deploying" | "deleting";
|
|
23101
23943
|
/**
|
|
23102
23944
|
* Media files associated with the [Bot](#schema_bot)
|
|
23103
23945
|
*/
|
|
@@ -23360,6 +24202,10 @@ interface UpdateBotRequestBody {
|
|
|
23360
24202
|
* Optional name for the bot, if not provided will be auto-generated
|
|
23361
24203
|
*/
|
|
23362
24204
|
name?: string;
|
|
24205
|
+
/**
|
|
24206
|
+
* Optional description for the bot
|
|
24207
|
+
*/
|
|
24208
|
+
description?: string;
|
|
23363
24209
|
/**
|
|
23364
24210
|
* Media files associated with the [Bot](#schema_bot)
|
|
23365
24211
|
*/
|
|
@@ -23456,6 +24302,10 @@ interface UpdateBotResponse {
|
|
|
23456
24302
|
* Status of the integration version verification
|
|
23457
24303
|
*/
|
|
23458
24304
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
24305
|
+
/**
|
|
24306
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
24307
|
+
*/
|
|
24308
|
+
lifecycleStatus: "published" | "deprecated";
|
|
23459
24309
|
};
|
|
23460
24310
|
};
|
|
23461
24311
|
/**
|
|
@@ -23532,6 +24382,10 @@ interface UpdateBotResponse {
|
|
|
23532
24382
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
23533
24383
|
*/
|
|
23534
24384
|
visibility: "public" | "private" | "unlisted";
|
|
24385
|
+
/**
|
|
24386
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
24387
|
+
*/
|
|
24388
|
+
lifecycleStatus: "published" | "deprecated";
|
|
23535
24389
|
};
|
|
23536
24390
|
};
|
|
23537
24391
|
/**
|
|
@@ -23742,6 +24596,10 @@ interface UpdateBotResponse {
|
|
|
23742
24596
|
* Name of the [Bot](#schema_bot)
|
|
23743
24597
|
*/
|
|
23744
24598
|
name: string;
|
|
24599
|
+
/**
|
|
24600
|
+
* Description of the [Bot](#schema_bot)
|
|
24601
|
+
*/
|
|
24602
|
+
description?: string;
|
|
23745
24603
|
/**
|
|
23746
24604
|
* Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
|
|
23747
24605
|
*/
|
|
@@ -23761,7 +24619,7 @@ interface UpdateBotResponse {
|
|
|
23761
24619
|
/**
|
|
23762
24620
|
* Status of the bot
|
|
23763
24621
|
*/
|
|
23764
|
-
status: "active" | "deploying";
|
|
24622
|
+
status: "active" | "deploying" | "deleting";
|
|
23765
24623
|
/**
|
|
23766
24624
|
* Media files associated with the [Bot](#schema_bot)
|
|
23767
24625
|
*/
|
|
@@ -23935,6 +24793,10 @@ interface GetBotResponse {
|
|
|
23935
24793
|
* Status of the integration version verification
|
|
23936
24794
|
*/
|
|
23937
24795
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
24796
|
+
/**
|
|
24797
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
24798
|
+
*/
|
|
24799
|
+
lifecycleStatus: "published" | "deprecated";
|
|
23938
24800
|
};
|
|
23939
24801
|
};
|
|
23940
24802
|
/**
|
|
@@ -24011,6 +24873,10 @@ interface GetBotResponse {
|
|
|
24011
24873
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
24012
24874
|
*/
|
|
24013
24875
|
visibility: "public" | "private" | "unlisted";
|
|
24876
|
+
/**
|
|
24877
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
24878
|
+
*/
|
|
24879
|
+
lifecycleStatus: "published" | "deprecated";
|
|
24014
24880
|
};
|
|
24015
24881
|
};
|
|
24016
24882
|
/**
|
|
@@ -24221,6 +25087,10 @@ interface GetBotResponse {
|
|
|
24221
25087
|
* Name of the [Bot](#schema_bot)
|
|
24222
25088
|
*/
|
|
24223
25089
|
name: string;
|
|
25090
|
+
/**
|
|
25091
|
+
* Description of the [Bot](#schema_bot)
|
|
25092
|
+
*/
|
|
25093
|
+
description?: string;
|
|
24224
25094
|
/**
|
|
24225
25095
|
* Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
|
|
24226
25096
|
*/
|
|
@@ -24240,7 +25110,7 @@ interface GetBotResponse {
|
|
|
24240
25110
|
/**
|
|
24241
25111
|
* Status of the bot
|
|
24242
25112
|
*/
|
|
24243
|
-
status: "active" | "deploying";
|
|
25113
|
+
status: "active" | "deploying" | "deleting";
|
|
24244
25114
|
/**
|
|
24245
25115
|
* Media files associated with the [Bot](#schema_bot)
|
|
24246
25116
|
*/
|
|
@@ -25020,7 +25890,7 @@ interface GetWorkspaceResponse {
|
|
|
25020
25890
|
interface ListWorkspaceUsagesRequestHeaders {
|
|
25021
25891
|
}
|
|
25022
25892
|
interface ListWorkspaceUsagesRequestQuery {
|
|
25023
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
25893
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
25024
25894
|
period?: string;
|
|
25025
25895
|
}
|
|
25026
25896
|
interface ListWorkspaceUsagesRequestParams {
|
|
@@ -25050,14 +25920,14 @@ interface ListWorkspaceUsagesResponse {
|
|
|
25050
25920
|
/**
|
|
25051
25921
|
* Usage type that can be used
|
|
25052
25922
|
*/
|
|
25053
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
25923
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
25054
25924
|
}[];
|
|
25055
25925
|
}
|
|
25056
25926
|
|
|
25057
25927
|
interface BreakDownWorkspaceUsageByBotRequestHeaders {
|
|
25058
25928
|
}
|
|
25059
25929
|
interface BreakDownWorkspaceUsageByBotRequestQuery {
|
|
25060
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
25930
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
25061
25931
|
period?: string;
|
|
25062
25932
|
}
|
|
25063
25933
|
interface BreakDownWorkspaceUsageByBotRequestParams {
|
|
@@ -25084,7 +25954,7 @@ interface GetAllWorkspaceQuotaCompletionRequestBody {
|
|
|
25084
25954
|
type GetAllWorkspaceQuotaCompletionInput = GetAllWorkspaceQuotaCompletionRequestBody & GetAllWorkspaceQuotaCompletionRequestHeaders & GetAllWorkspaceQuotaCompletionRequestQuery & GetAllWorkspaceQuotaCompletionRequestParams;
|
|
25085
25955
|
interface GetAllWorkspaceQuotaCompletionResponse {
|
|
25086
25956
|
[k: string]: {
|
|
25087
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
25957
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
25088
25958
|
completion: number;
|
|
25089
25959
|
};
|
|
25090
25960
|
}
|
|
@@ -25092,7 +25962,7 @@ interface GetAllWorkspaceQuotaCompletionResponse {
|
|
|
25092
25962
|
interface GetWorkspaceQuotaRequestHeaders {
|
|
25093
25963
|
}
|
|
25094
25964
|
interface GetWorkspaceQuotaRequestQuery {
|
|
25095
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
25965
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
25096
25966
|
period?: string;
|
|
25097
25967
|
}
|
|
25098
25968
|
interface GetWorkspaceQuotaRequestParams {
|
|
@@ -25114,7 +25984,7 @@ interface GetWorkspaceQuotaResponse {
|
|
|
25114
25984
|
/**
|
|
25115
25985
|
* Usage type that can be used
|
|
25116
25986
|
*/
|
|
25117
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
25987
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
25118
25988
|
};
|
|
25119
25989
|
}
|
|
25120
25990
|
|
|
@@ -25142,7 +26012,7 @@ interface ListWorkspaceQuotasResponse {
|
|
|
25142
26012
|
/**
|
|
25143
26013
|
* Usage type that can be used
|
|
25144
26014
|
*/
|
|
25145
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
26015
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
25146
26016
|
}[];
|
|
25147
26017
|
}
|
|
25148
26018
|
|
|
@@ -26238,6 +27108,10 @@ interface CreateIntegrationResponse {
|
|
|
26238
27108
|
* Status of the integration version verification
|
|
26239
27109
|
*/
|
|
26240
27110
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
27111
|
+
/**
|
|
27112
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
27113
|
+
*/
|
|
27114
|
+
lifecycleStatus: "published" | "deprecated";
|
|
26241
27115
|
/**
|
|
26242
27116
|
* 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.
|
|
26243
27117
|
*/
|
|
@@ -27314,6 +28188,10 @@ interface UpdateIntegrationResponse {
|
|
|
27314
28188
|
* Status of the integration version verification
|
|
27315
28189
|
*/
|
|
27316
28190
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
28191
|
+
/**
|
|
28192
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
28193
|
+
*/
|
|
28194
|
+
lifecycleStatus: "published" | "deprecated";
|
|
27317
28195
|
/**
|
|
27318
28196
|
* 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.
|
|
27319
28197
|
*/
|
|
@@ -27727,6 +28605,10 @@ interface ListIntegrationsResponse {
|
|
|
27727
28605
|
* Status of the integration version verification
|
|
27728
28606
|
*/
|
|
27729
28607
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
28608
|
+
/**
|
|
28609
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
28610
|
+
*/
|
|
28611
|
+
lifecycleStatus: "published" | "deprecated";
|
|
27730
28612
|
/**
|
|
27731
28613
|
* Metadata about which fields matched the search criteria
|
|
27732
28614
|
*/
|
|
@@ -28161,6 +29043,10 @@ interface GetIntegrationResponse {
|
|
|
28161
29043
|
* Status of the integration version verification
|
|
28162
29044
|
*/
|
|
28163
29045
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
29046
|
+
/**
|
|
29047
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
29048
|
+
*/
|
|
29049
|
+
lifecycleStatus: "published" | "deprecated";
|
|
28164
29050
|
/**
|
|
28165
29051
|
* 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.
|
|
28166
29052
|
*/
|
|
@@ -28593,6 +29479,10 @@ interface GetIntegrationByNameResponse {
|
|
|
28593
29479
|
* Status of the integration version verification
|
|
28594
29480
|
*/
|
|
28595
29481
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
29482
|
+
/**
|
|
29483
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
29484
|
+
*/
|
|
29485
|
+
lifecycleStatus: "published" | "deprecated";
|
|
28596
29486
|
/**
|
|
28597
29487
|
* 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.
|
|
28598
29488
|
*/
|
|
@@ -30062,6 +30952,10 @@ interface CreatePluginResponse {
|
|
|
30062
30952
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
30063
30953
|
*/
|
|
30064
30954
|
visibility: "public" | "private" | "unlisted";
|
|
30955
|
+
/**
|
|
30956
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
30957
|
+
*/
|
|
30958
|
+
lifecycleStatus: "published" | "deprecated";
|
|
30065
30959
|
};
|
|
30066
30960
|
}
|
|
30067
30961
|
|
|
@@ -30278,6 +31172,10 @@ interface GetPluginResponse {
|
|
|
30278
31172
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
30279
31173
|
*/
|
|
30280
31174
|
visibility: "public" | "private" | "unlisted";
|
|
31175
|
+
/**
|
|
31176
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
31177
|
+
*/
|
|
31178
|
+
lifecycleStatus: "published" | "deprecated";
|
|
30281
31179
|
};
|
|
30282
31180
|
}
|
|
30283
31181
|
|
|
@@ -30503,6 +31401,10 @@ interface GetDereferencedPluginResponse {
|
|
|
30503
31401
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
30504
31402
|
*/
|
|
30505
31403
|
visibility: "public" | "private" | "unlisted";
|
|
31404
|
+
/**
|
|
31405
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
31406
|
+
*/
|
|
31407
|
+
lifecycleStatus: "published" | "deprecated";
|
|
30506
31408
|
};
|
|
30507
31409
|
}
|
|
30508
31410
|
|
|
@@ -30720,6 +31622,10 @@ interface GetPluginByNameResponse {
|
|
|
30720
31622
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
30721
31623
|
*/
|
|
30722
31624
|
visibility: "public" | "private" | "unlisted";
|
|
31625
|
+
/**
|
|
31626
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
31627
|
+
*/
|
|
31628
|
+
lifecycleStatus: "published" | "deprecated";
|
|
30723
31629
|
};
|
|
30724
31630
|
}
|
|
30725
31631
|
|
|
@@ -31140,6 +32046,10 @@ interface UpdatePluginResponse {
|
|
|
31140
32046
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
31141
32047
|
*/
|
|
31142
32048
|
visibility: "public" | "private" | "unlisted";
|
|
32049
|
+
/**
|
|
32050
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
32051
|
+
*/
|
|
32052
|
+
lifecycleStatus: "published" | "deprecated";
|
|
31143
32053
|
};
|
|
31144
32054
|
}
|
|
31145
32055
|
|
|
@@ -31215,6 +32125,10 @@ interface ListPluginsResponse {
|
|
|
31215
32125
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
31216
32126
|
*/
|
|
31217
32127
|
visibility: "public" | "private" | "unlisted";
|
|
32128
|
+
/**
|
|
32129
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
32130
|
+
*/
|
|
32131
|
+
lifecycleStatus: "published" | "deprecated";
|
|
31218
32132
|
}[];
|
|
31219
32133
|
meta: {
|
|
31220
32134
|
/**
|
|
@@ -31242,7 +32156,7 @@ interface GetPluginCodeResponse {
|
|
|
31242
32156
|
interface GetUsageRequestHeaders {
|
|
31243
32157
|
}
|
|
31244
32158
|
interface GetUsageRequestQuery {
|
|
31245
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
32159
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
31246
32160
|
period?: string;
|
|
31247
32161
|
}
|
|
31248
32162
|
interface GetUsageRequestParams {
|
|
@@ -31272,7 +32186,7 @@ interface GetUsageResponse {
|
|
|
31272
32186
|
/**
|
|
31273
32187
|
* Usage type that can be used
|
|
31274
32188
|
*/
|
|
31275
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
32189
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
31276
32190
|
};
|
|
31277
32191
|
}
|
|
31278
32192
|
|
|
@@ -31309,14 +32223,14 @@ interface GetMultipleUsagesResponse {
|
|
|
31309
32223
|
/**
|
|
31310
32224
|
* Usage type that can be used
|
|
31311
32225
|
*/
|
|
31312
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
32226
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
31313
32227
|
}[];
|
|
31314
32228
|
}
|
|
31315
32229
|
|
|
31316
32230
|
interface ListUsageHistoryRequestHeaders {
|
|
31317
32231
|
}
|
|
31318
32232
|
interface ListUsageHistoryRequestQuery {
|
|
31319
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
32233
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
31320
32234
|
}
|
|
31321
32235
|
interface ListUsageHistoryRequestParams {
|
|
31322
32236
|
id: string;
|
|
@@ -31345,14 +32259,14 @@ interface ListUsageHistoryResponse {
|
|
|
31345
32259
|
/**
|
|
31346
32260
|
* Usage type that can be used
|
|
31347
32261
|
*/
|
|
31348
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
32262
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
31349
32263
|
}[];
|
|
31350
32264
|
}
|
|
31351
32265
|
|
|
31352
32266
|
interface ListUsageActivityRequestHeaders {
|
|
31353
32267
|
}
|
|
31354
32268
|
interface ListUsageActivityRequestQuery {
|
|
31355
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
32269
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
31356
32270
|
timestampFrom?: string;
|
|
31357
32271
|
timestampUntil?: string;
|
|
31358
32272
|
nextToken?: string;
|
|
@@ -31380,7 +32294,7 @@ interface ListUsageActivityResponse {
|
|
|
31380
32294
|
interface ListUsageActivityDailyRequestHeaders {
|
|
31381
32295
|
}
|
|
31382
32296
|
interface ListUsageActivityDailyRequestQuery {
|
|
31383
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
32297
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
31384
32298
|
dateFrom?: string;
|
|
31385
32299
|
dateUntil?: string;
|
|
31386
32300
|
nextToken?: string;
|
|
@@ -31714,6 +32628,10 @@ interface UpsertFileResponse {
|
|
|
31714
32628
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
31715
32629
|
*/
|
|
31716
32630
|
name?: string;
|
|
32631
|
+
/**
|
|
32632
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
32633
|
+
*/
|
|
32634
|
+
alias?: string;
|
|
31717
32635
|
};
|
|
31718
32636
|
/**
|
|
31719
32637
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -31750,6 +32668,7 @@ interface ListFilesRequestQuery {
|
|
|
31750
32668
|
* @maxItems 50
|
|
31751
32669
|
*/
|
|
31752
32670
|
ids?: string[];
|
|
32671
|
+
indexed?: boolean;
|
|
31753
32672
|
}
|
|
31754
32673
|
interface ListFilesRequestParams {
|
|
31755
32674
|
}
|
|
@@ -31840,6 +32759,10 @@ interface ListFilesResponse {
|
|
|
31840
32759
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
31841
32760
|
*/
|
|
31842
32761
|
name?: string;
|
|
32762
|
+
/**
|
|
32763
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
32764
|
+
*/
|
|
32765
|
+
alias?: string;
|
|
31843
32766
|
};
|
|
31844
32767
|
/**
|
|
31845
32768
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -31948,6 +32871,10 @@ interface GetFileResponse {
|
|
|
31948
32871
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
31949
32872
|
*/
|
|
31950
32873
|
name?: string;
|
|
32874
|
+
/**
|
|
32875
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
32876
|
+
*/
|
|
32877
|
+
alias?: string;
|
|
31951
32878
|
};
|
|
31952
32879
|
/**
|
|
31953
32880
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -32070,6 +32997,10 @@ interface UpdateFileMetadataResponse {
|
|
|
32070
32997
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
32071
32998
|
*/
|
|
32072
32999
|
name?: string;
|
|
33000
|
+
/**
|
|
33001
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
33002
|
+
*/
|
|
33003
|
+
alias?: string;
|
|
32073
33004
|
};
|
|
32074
33005
|
/**
|
|
32075
33006
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -32180,6 +33111,10 @@ interface CopyFileResponse {
|
|
|
32180
33111
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
32181
33112
|
*/
|
|
32182
33113
|
name?: string;
|
|
33114
|
+
/**
|
|
33115
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
33116
|
+
*/
|
|
33117
|
+
alias?: string;
|
|
32183
33118
|
};
|
|
32184
33119
|
/**
|
|
32185
33120
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -32566,6 +33501,10 @@ interface ListTablesResponse {
|
|
|
32566
33501
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
32567
33502
|
*/
|
|
32568
33503
|
frozen?: boolean;
|
|
33504
|
+
/**
|
|
33505
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
33506
|
+
*/
|
|
33507
|
+
keyColumn?: string | null;
|
|
32569
33508
|
schema: {
|
|
32570
33509
|
$schema?: string;
|
|
32571
33510
|
/**
|
|
@@ -32711,6 +33650,10 @@ interface GetTableResponse {
|
|
|
32711
33650
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
32712
33651
|
*/
|
|
32713
33652
|
frozen?: boolean;
|
|
33653
|
+
/**
|
|
33654
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
33655
|
+
*/
|
|
33656
|
+
keyColumn?: string | null;
|
|
32714
33657
|
schema: {
|
|
32715
33658
|
$schema?: string;
|
|
32716
33659
|
/**
|
|
@@ -32856,6 +33799,10 @@ interface GetOrCreateTableRequestBody {
|
|
|
32856
33799
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
32857
33800
|
*/
|
|
32858
33801
|
frozen?: boolean;
|
|
33802
|
+
/**
|
|
33803
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
33804
|
+
*/
|
|
33805
|
+
keyColumn?: string | null;
|
|
32859
33806
|
/**
|
|
32860
33807
|
* Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
|
|
32861
33808
|
*/
|
|
@@ -32892,6 +33839,10 @@ interface GetOrCreateTableResponse {
|
|
|
32892
33839
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
32893
33840
|
*/
|
|
32894
33841
|
frozen?: boolean;
|
|
33842
|
+
/**
|
|
33843
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
33844
|
+
*/
|
|
33845
|
+
keyColumn?: string | null;
|
|
32895
33846
|
schema: {
|
|
32896
33847
|
$schema?: string;
|
|
32897
33848
|
/**
|
|
@@ -33044,6 +33995,10 @@ interface CreateTableRequestBody {
|
|
|
33044
33995
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
33045
33996
|
*/
|
|
33046
33997
|
frozen?: boolean;
|
|
33998
|
+
/**
|
|
33999
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
34000
|
+
*/
|
|
34001
|
+
keyColumn?: string | null;
|
|
33047
34002
|
/**
|
|
33048
34003
|
* Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
|
|
33049
34004
|
*/
|
|
@@ -33080,6 +34035,10 @@ interface CreateTableResponse {
|
|
|
33080
34035
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
33081
34036
|
*/
|
|
33082
34037
|
frozen?: boolean;
|
|
34038
|
+
/**
|
|
34039
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
34040
|
+
*/
|
|
34041
|
+
keyColumn?: string | null;
|
|
33083
34042
|
schema: {
|
|
33084
34043
|
$schema?: string;
|
|
33085
34044
|
/**
|
|
@@ -33234,6 +34193,10 @@ interface DuplicateTableResponse {
|
|
|
33234
34193
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
33235
34194
|
*/
|
|
33236
34195
|
frozen?: boolean;
|
|
34196
|
+
/**
|
|
34197
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
34198
|
+
*/
|
|
34199
|
+
keyColumn?: string | null;
|
|
33237
34200
|
schema: {
|
|
33238
34201
|
$schema?: string;
|
|
33239
34202
|
/**
|
|
@@ -33372,7 +34335,7 @@ interface ExportTableResponse {
|
|
|
33372
34335
|
id: string;
|
|
33373
34336
|
botId: string;
|
|
33374
34337
|
tableId: string;
|
|
33375
|
-
type: "export" | "import";
|
|
34338
|
+
type: "export" | "import" | "clear_column" | "clear_vectors";
|
|
33376
34339
|
status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
|
|
33377
34340
|
progress?: number;
|
|
33378
34341
|
inputFileId: string | null;
|
|
@@ -33397,7 +34360,7 @@ interface GetTableJobsResponse {
|
|
|
33397
34360
|
id: string;
|
|
33398
34361
|
botId: string;
|
|
33399
34362
|
tableId: string;
|
|
33400
|
-
type: "export" | "import";
|
|
34363
|
+
type: "export" | "import" | "clear_column" | "clear_vectors";
|
|
33401
34364
|
status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
|
|
33402
34365
|
progress?: number;
|
|
33403
34366
|
inputFileId: string | null;
|
|
@@ -33426,7 +34389,7 @@ interface ImportTableResponse {
|
|
|
33426
34389
|
id: string;
|
|
33427
34390
|
botId: string;
|
|
33428
34391
|
tableId: string;
|
|
33429
|
-
type: "export" | "import";
|
|
34392
|
+
type: "export" | "import" | "clear_column" | "clear_vectors";
|
|
33430
34393
|
status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
|
|
33431
34394
|
progress?: number;
|
|
33432
34395
|
inputFileId: string | null;
|
|
@@ -33452,6 +34415,10 @@ interface UpdateTableRequestBody {
|
|
|
33452
34415
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
33453
34416
|
*/
|
|
33454
34417
|
frozen?: boolean;
|
|
34418
|
+
/**
|
|
34419
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
34420
|
+
*/
|
|
34421
|
+
keyColumn?: string | null;
|
|
33455
34422
|
/**
|
|
33456
34423
|
* Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
|
|
33457
34424
|
*/
|
|
@@ -33492,6 +34459,10 @@ interface UpdateTableResponse {
|
|
|
33492
34459
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
33493
34460
|
*/
|
|
33494
34461
|
frozen?: boolean;
|
|
34462
|
+
/**
|
|
34463
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
34464
|
+
*/
|
|
34465
|
+
keyColumn?: string | null;
|
|
33495
34466
|
schema: {
|
|
33496
34467
|
$schema?: string;
|
|
33497
34468
|
/**
|
|
@@ -33649,6 +34620,10 @@ interface RenameTableColumnResponse {
|
|
|
33649
34620
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
33650
34621
|
*/
|
|
33651
34622
|
frozen?: boolean;
|
|
34623
|
+
/**
|
|
34624
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
34625
|
+
*/
|
|
34626
|
+
keyColumn?: string | null;
|
|
33652
34627
|
schema: {
|
|
33653
34628
|
$schema?: string;
|
|
33654
34629
|
/**
|
|
@@ -34251,6 +35226,10 @@ interface Bot {
|
|
|
34251
35226
|
* Status of the integration version verification
|
|
34252
35227
|
*/
|
|
34253
35228
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
35229
|
+
/**
|
|
35230
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
35231
|
+
*/
|
|
35232
|
+
lifecycleStatus: "published" | "deprecated";
|
|
34254
35233
|
};
|
|
34255
35234
|
};
|
|
34256
35235
|
/**
|
|
@@ -34327,6 +35306,10 @@ interface Bot {
|
|
|
34327
35306
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
34328
35307
|
*/
|
|
34329
35308
|
visibility: "public" | "private" | "unlisted";
|
|
35309
|
+
/**
|
|
35310
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
35311
|
+
*/
|
|
35312
|
+
lifecycleStatus: "published" | "deprecated";
|
|
34330
35313
|
};
|
|
34331
35314
|
};
|
|
34332
35315
|
/**
|
|
@@ -34537,6 +35520,10 @@ interface Bot {
|
|
|
34537
35520
|
* Name of the [Bot](#schema_bot)
|
|
34538
35521
|
*/
|
|
34539
35522
|
name: string;
|
|
35523
|
+
/**
|
|
35524
|
+
* Description of the [Bot](#schema_bot)
|
|
35525
|
+
*/
|
|
35526
|
+
description?: string;
|
|
34540
35527
|
/**
|
|
34541
35528
|
* Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
|
|
34542
35529
|
*/
|
|
@@ -34556,7 +35543,7 @@ interface Bot {
|
|
|
34556
35543
|
/**
|
|
34557
35544
|
* Status of the bot
|
|
34558
35545
|
*/
|
|
34559
|
-
status: "active" | "deploying";
|
|
35546
|
+
status: "active" | "deploying" | "deleting";
|
|
34560
35547
|
/**
|
|
34561
35548
|
* Media files associated with the [Bot](#schema_bot)
|
|
34562
35549
|
*/
|
|
@@ -34955,6 +35942,10 @@ interface Integration {
|
|
|
34955
35942
|
* Status of the integration version verification
|
|
34956
35943
|
*/
|
|
34957
35944
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
35945
|
+
/**
|
|
35946
|
+
* The lifecycle status of the integration. When an integration is deprecated, it can no longer be installed.
|
|
35947
|
+
*/
|
|
35948
|
+
lifecycleStatus: "published" | "deprecated";
|
|
34958
35949
|
/**
|
|
34959
35950
|
* 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.
|
|
34960
35951
|
*/
|
|
@@ -35314,6 +36305,10 @@ interface Plugin {
|
|
|
35314
36305
|
* The plugin's visibility. Public plugins are available to all and cannot be updated without creating a new version. Unlisted plugins behave identically to public plugins, but they are not listed in the plugin hub. By default, plugins are private and only accessible to the workspace that created them.
|
|
35315
36306
|
*/
|
|
35316
36307
|
visibility: "public" | "private" | "unlisted";
|
|
36308
|
+
/**
|
|
36309
|
+
* The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed.
|
|
36310
|
+
*/
|
|
36311
|
+
lifecycleStatus: "published" | "deprecated";
|
|
35317
36312
|
}
|
|
35318
36313
|
interface Workspace {
|
|
35319
36314
|
id: string;
|
|
@@ -35375,7 +36370,7 @@ interface Usage {
|
|
|
35375
36370
|
/**
|
|
35376
36371
|
* Usage type that can be used
|
|
35377
36372
|
*/
|
|
35378
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
36373
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
35379
36374
|
}
|
|
35380
36375
|
interface Issue {
|
|
35381
36376
|
id: string;
|
|
@@ -35773,6 +36768,10 @@ interface Table {
|
|
|
35773
36768
|
* A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
|
|
35774
36769
|
*/
|
|
35775
36770
|
frozen?: boolean;
|
|
36771
|
+
/**
|
|
36772
|
+
* Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
|
|
36773
|
+
*/
|
|
36774
|
+
keyColumn?: string | null;
|
|
35776
36775
|
schema: {
|
|
35777
36776
|
$schema?: string;
|
|
35778
36777
|
/**
|
|
@@ -36052,6 +37051,10 @@ interface File {
|
|
|
36052
37051
|
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
|
|
36053
37052
|
*/
|
|
36054
37053
|
name?: string;
|
|
37054
|
+
/**
|
|
37055
|
+
* This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.
|
|
37056
|
+
*/
|
|
37057
|
+
alias?: string;
|
|
36055
37058
|
};
|
|
36056
37059
|
/**
|
|
36057
37060
|
* Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
|
|
@@ -36087,6 +37090,8 @@ declare class Client$1 {
|
|
|
36087
37090
|
readonly updateMessage: (input: UpdateMessageInput) => Promise<UpdateMessageResponse>;
|
|
36088
37091
|
readonly listMessages: (input: ListMessagesInput) => Promise<ListMessagesResponse>;
|
|
36089
37092
|
readonly deleteMessage: (input: DeleteMessageInput) => Promise<DeleteMessageResponse>;
|
|
37093
|
+
readonly initializeIncomingMessage: (input: InitializeIncomingMessageInput) => Promise<InitializeIncomingMessageResponse>;
|
|
37094
|
+
readonly importMessages: (input: ImportMessagesInput) => Promise<ImportMessagesResponse>;
|
|
36090
37095
|
readonly createUser: (input: CreateUserInput) => Promise<CreateUserResponse>;
|
|
36091
37096
|
readonly getUser: (input: GetUserInput) => Promise<GetUserResponse>;
|
|
36092
37097
|
readonly listUsers: (input: ListUsersInput) => Promise<ListUsersResponse>;
|
|
@@ -36332,6 +37337,8 @@ declare class Client extends Client$1 implements IClient {
|
|
|
36332
37337
|
tags?: {
|
|
36333
37338
|
[x: string]: string;
|
|
36334
37339
|
} | undefined;
|
|
37340
|
+
afterDate?: string | undefined;
|
|
37341
|
+
beforeDate?: string | undefined;
|
|
36335
37342
|
conversationId?: string | undefined;
|
|
36336
37343
|
}) => AsyncCollection<{
|
|
36337
37344
|
id: string;
|
|
@@ -36353,7 +37360,12 @@ declare class Client extends Client$1 implements IClient {
|
|
|
36353
37360
|
tags?: {
|
|
36354
37361
|
[x: string]: string;
|
|
36355
37362
|
} | undefined;
|
|
37363
|
+
sortField?: "updatedAt" | "createdAt" | undefined;
|
|
37364
|
+
sortDirection?: "asc" | "desc" | undefined;
|
|
37365
|
+
afterDate?: string | undefined;
|
|
37366
|
+
beforeDate?: string | undefined;
|
|
36356
37367
|
conversationId?: string | undefined;
|
|
37368
|
+
rangeField?: "updatedAt" | "createdAt" | undefined;
|
|
36357
37369
|
}) => AsyncCollection<{
|
|
36358
37370
|
id: string;
|
|
36359
37371
|
createdAt: string;
|
|
@@ -36416,6 +37428,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
36416
37428
|
public: boolean;
|
|
36417
37429
|
visibility: "public" | "private" | "unlisted";
|
|
36418
37430
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
37431
|
+
lifecycleStatus: "published" | "deprecated";
|
|
36419
37432
|
ownerWorkspace: {
|
|
36420
37433
|
id: string;
|
|
36421
37434
|
handle: string | null;
|
|
@@ -36502,6 +37515,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
36502
37515
|
public: boolean;
|
|
36503
37516
|
visibility: "public" | "private" | "unlisted";
|
|
36504
37517
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
37518
|
+
lifecycleStatus: "published" | "deprecated";
|
|
36505
37519
|
matchedOn?: {
|
|
36506
37520
|
name?: boolean;
|
|
36507
37521
|
title?: boolean;
|
|
@@ -36560,6 +37574,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
36560
37574
|
readmeUrl: string;
|
|
36561
37575
|
public: boolean;
|
|
36562
37576
|
visibility: "public" | "private" | "unlisted";
|
|
37577
|
+
lifecycleStatus: "published" | "deprecated";
|
|
36563
37578
|
}>;
|
|
36564
37579
|
publicPlugins: (props: {
|
|
36565
37580
|
name?: string | undefined;
|
|
@@ -36576,6 +37591,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
36576
37591
|
readmeUrl: string;
|
|
36577
37592
|
public: boolean;
|
|
36578
37593
|
visibility: "public" | "private" | "unlisted";
|
|
37594
|
+
lifecycleStatus: "published" | "deprecated";
|
|
36579
37595
|
}>;
|
|
36580
37596
|
activities: (props: {
|
|
36581
37597
|
botId: string;
|
|
@@ -36595,6 +37611,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
36595
37611
|
sortField?: "key" | "size" | "createdAt" | "updatedAt" | "status" | undefined;
|
|
36596
37612
|
sortDirection?: "asc" | "desc" | undefined;
|
|
36597
37613
|
ids?: string[] | undefined;
|
|
37614
|
+
indexed?: boolean | undefined;
|
|
36598
37615
|
}) => AsyncCollection<{
|
|
36599
37616
|
id: string;
|
|
36600
37617
|
botId: string;
|
|
@@ -36619,6 +37636,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
36619
37636
|
type: "bot" | "integration" | "user";
|
|
36620
37637
|
id?: string;
|
|
36621
37638
|
name?: string;
|
|
37639
|
+
alias?: string;
|
|
36622
37640
|
};
|
|
36623
37641
|
indexingStack?: "v1" | "v2";
|
|
36624
37642
|
}>;
|
|
@@ -36651,7 +37669,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
36651
37669
|
};
|
|
36652
37670
|
}>;
|
|
36653
37671
|
usageActivity: (props: {
|
|
36654
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
37672
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
36655
37673
|
id: string;
|
|
36656
37674
|
timestampFrom?: string | undefined;
|
|
36657
37675
|
timestampUntil?: string | undefined;
|
|
@@ -36664,7 +37682,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
36664
37682
|
};
|
|
36665
37683
|
}>;
|
|
36666
37684
|
usageActivityDaily: (props: {
|
|
36667
|
-
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count";
|
|
37685
|
+
type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive" | "indexed_file_count" | "file_max_size_bytes";
|
|
36668
37686
|
id: string;
|
|
36669
37687
|
dateFrom?: string | undefined;
|
|
36670
37688
|
dateUntil?: string | undefined;
|