@botpress/api 0.5.6 → 0.5.7
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/gen/state.d.ts +69 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.js +107 -32
- package/package.json +2 -2
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +96 -21
package/src/gen/state.ts
CHANGED
|
@@ -1237,6 +1237,48 @@ export const state = {
|
|
|
1237
1237
|
},
|
|
1238
1238
|
parameters: {},
|
|
1239
1239
|
},
|
|
1240
|
+
getAccount: {
|
|
1241
|
+
name: "getAccount",
|
|
1242
|
+
description:
|
|
1243
|
+
"Get details of the account authenticating with this endpoint.",
|
|
1244
|
+
method: "get",
|
|
1245
|
+
path: "/v1/admin/account/me",
|
|
1246
|
+
section: "account",
|
|
1247
|
+
disableDefaultParameters: {
|
|
1248
|
+
"x-workspace-id": true,
|
|
1249
|
+
},
|
|
1250
|
+
response: {
|
|
1251
|
+
description: "Success",
|
|
1252
|
+
schema: {
|
|
1253
|
+
type: "object",
|
|
1254
|
+
properties: {
|
|
1255
|
+
account: {
|
|
1256
|
+
type: "object",
|
|
1257
|
+
properties: {
|
|
1258
|
+
id: {
|
|
1259
|
+
type: "string",
|
|
1260
|
+
},
|
|
1261
|
+
email: {
|
|
1262
|
+
type: "string",
|
|
1263
|
+
},
|
|
1264
|
+
createdAt: {
|
|
1265
|
+
type: "string",
|
|
1266
|
+
format: "date-time",
|
|
1267
|
+
description:
|
|
1268
|
+
"Creation date of the [Account](#schema_account) in ISO 8601 format",
|
|
1269
|
+
},
|
|
1270
|
+
},
|
|
1271
|
+
required: ["id", "email", "createdAt"],
|
|
1272
|
+
additionalProperties: false,
|
|
1273
|
+
},
|
|
1274
|
+
},
|
|
1275
|
+
required: ["account"],
|
|
1276
|
+
title: "getAccountResponse",
|
|
1277
|
+
additionalProperties: false,
|
|
1278
|
+
},
|
|
1279
|
+
},
|
|
1280
|
+
parameters: {},
|
|
1281
|
+
},
|
|
1240
1282
|
listPublicIntegrations: {
|
|
1241
1283
|
name: "listPublicIntegrations",
|
|
1242
1284
|
description: "List public integration",
|
|
@@ -1293,13 +1335,13 @@ export const state = {
|
|
|
1293
1335
|
type: "string",
|
|
1294
1336
|
format: "date-time",
|
|
1295
1337
|
description:
|
|
1296
|
-
"Creation date of the [Integration](#schema_integration) in
|
|
1338
|
+
"Creation date of the [Integration](#schema_integration) in ISO 8601 format",
|
|
1297
1339
|
},
|
|
1298
1340
|
updatedAt: {
|
|
1299
1341
|
type: "string",
|
|
1300
1342
|
format: "date-time",
|
|
1301
1343
|
description:
|
|
1302
|
-
"Updating date of the [Integration](#schema_integration) in
|
|
1344
|
+
"Updating date of the [Integration](#schema_integration) in ISO 8601 format",
|
|
1303
1345
|
},
|
|
1304
1346
|
title: {
|
|
1305
1347
|
type: "string",
|
|
@@ -2019,13 +2061,13 @@ export const state = {
|
|
|
2019
2061
|
type: "string",
|
|
2020
2062
|
format: "date-time",
|
|
2021
2063
|
description:
|
|
2022
|
-
"Creation date of the [Bot](#schema_bot) in
|
|
2064
|
+
"Creation date of the [Bot](#schema_bot) in ISO 8601 format",
|
|
2023
2065
|
},
|
|
2024
2066
|
updatedAt: {
|
|
2025
2067
|
type: "string",
|
|
2026
2068
|
format: "date-time",
|
|
2027
2069
|
description:
|
|
2028
|
-
"Updating date of the [Bot](#schema_bot) in
|
|
2070
|
+
"Updating date of the [Bot](#schema_bot) in ISO 8601 format",
|
|
2029
2071
|
},
|
|
2030
2072
|
name: {
|
|
2031
2073
|
type: "string",
|
|
@@ -3746,13 +3788,13 @@ export const state = {
|
|
|
3746
3788
|
type: "string",
|
|
3747
3789
|
format: "date-time",
|
|
3748
3790
|
description:
|
|
3749
|
-
"Creation date of the [Integration](#schema_integration) in
|
|
3791
|
+
"Creation date of the [Integration](#schema_integration) in ISO 8601 format",
|
|
3750
3792
|
},
|
|
3751
3793
|
updatedAt: {
|
|
3752
3794
|
type: "string",
|
|
3753
3795
|
format: "date-time",
|
|
3754
3796
|
description:
|
|
3755
|
-
"Updating date of the [Integration](#schema_integration) in
|
|
3797
|
+
"Updating date of the [Integration](#schema_integration) in ISO 8601 format",
|
|
3756
3798
|
},
|
|
3757
3799
|
title: {
|
|
3758
3800
|
type: "string",
|
|
@@ -4151,7 +4193,7 @@ export const state = {
|
|
|
4151
4193
|
title: "Botpress API",
|
|
4152
4194
|
description: "API for Botpress Cloud",
|
|
4153
4195
|
server: "https://api.botpress.cloud",
|
|
4154
|
-
version: "0.5.
|
|
4196
|
+
version: "0.5.7",
|
|
4155
4197
|
prefix: "v1",
|
|
4156
4198
|
},
|
|
4157
4199
|
errors: [
|
|
@@ -4315,6 +4357,7 @@ export const state = {
|
|
|
4315
4357
|
patchStateResponse: true,
|
|
4316
4358
|
callActionResponse: true,
|
|
4317
4359
|
configureIntegrationResponse: true,
|
|
4360
|
+
getAccountResponse: true,
|
|
4318
4361
|
listPublicIntegrationsResponse: true,
|
|
4319
4362
|
getPublicIntegrationByIdResponse: true,
|
|
4320
4363
|
getPublicIntegrationResponse: true,
|
|
@@ -4357,6 +4400,7 @@ export const state = {
|
|
|
4357
4400
|
Integration: true,
|
|
4358
4401
|
Workspace: true,
|
|
4359
4402
|
WorkspaceMember: true,
|
|
4403
|
+
Account: true,
|
|
4360
4404
|
User: true,
|
|
4361
4405
|
Conversation: true,
|
|
4362
4406
|
Event: true,
|
|
@@ -4380,13 +4424,13 @@ export const state = {
|
|
|
4380
4424
|
type: "string",
|
|
4381
4425
|
format: "date-time",
|
|
4382
4426
|
description:
|
|
4383
|
-
"Creation date of the [Bot](#schema_bot) in
|
|
4427
|
+
"Creation date of the [Bot](#schema_bot) in ISO 8601 format",
|
|
4384
4428
|
},
|
|
4385
4429
|
updatedAt: {
|
|
4386
4430
|
type: "string",
|
|
4387
4431
|
format: "date-time",
|
|
4388
4432
|
description:
|
|
4389
|
-
"Updating date of the [Bot](#schema_bot) in
|
|
4433
|
+
"Updating date of the [Bot](#schema_bot) in ISO 8601 format",
|
|
4390
4434
|
},
|
|
4391
4435
|
signingSecret: {
|
|
4392
4436
|
type: "string",
|
|
@@ -4439,13 +4483,13 @@ export const state = {
|
|
|
4439
4483
|
type: "string",
|
|
4440
4484
|
format: "date-time",
|
|
4441
4485
|
description:
|
|
4442
|
-
"Creation date of the [Integration](#schema_integration) in
|
|
4486
|
+
"Creation date of the [Integration](#schema_integration) in ISO 8601 format",
|
|
4443
4487
|
},
|
|
4444
4488
|
updatedAt: {
|
|
4445
4489
|
type: "string",
|
|
4446
4490
|
format: "date-time",
|
|
4447
4491
|
description:
|
|
4448
|
-
"Updating date of the [Integration](#schema_integration) in
|
|
4492
|
+
"Updating date of the [Integration](#schema_integration) in ISO 8601 format",
|
|
4449
4493
|
},
|
|
4450
4494
|
title: {
|
|
4451
4495
|
type: "string",
|
|
@@ -4745,13 +4789,13 @@ export const state = {
|
|
|
4745
4789
|
type: "string",
|
|
4746
4790
|
format: "date-time",
|
|
4747
4791
|
description:
|
|
4748
|
-
"Creation date of the [Integration](#schema_integration) in
|
|
4792
|
+
"Creation date of the [Integration](#schema_integration) in ISO 8601 format",
|
|
4749
4793
|
},
|
|
4750
4794
|
updatedAt: {
|
|
4751
4795
|
type: "string",
|
|
4752
4796
|
format: "date-time",
|
|
4753
4797
|
description:
|
|
4754
|
-
"Updating date of the [Integration](#schema_integration) in
|
|
4798
|
+
"Updating date of the [Integration](#schema_integration) in ISO 8601 format",
|
|
4755
4799
|
},
|
|
4756
4800
|
name: {
|
|
4757
4801
|
type: "string",
|
|
@@ -5160,6 +5204,28 @@ export const state = {
|
|
|
5160
5204
|
additionalProperties: false,
|
|
5161
5205
|
},
|
|
5162
5206
|
},
|
|
5207
|
+
Account: {
|
|
5208
|
+
section: "account",
|
|
5209
|
+
schema: {
|
|
5210
|
+
type: "object",
|
|
5211
|
+
properties: {
|
|
5212
|
+
id: {
|
|
5213
|
+
type: "string",
|
|
5214
|
+
},
|
|
5215
|
+
email: {
|
|
5216
|
+
type: "string",
|
|
5217
|
+
},
|
|
5218
|
+
createdAt: {
|
|
5219
|
+
type: "string",
|
|
5220
|
+
format: "date-time",
|
|
5221
|
+
description:
|
|
5222
|
+
"Creation date of the [Account](#schema_account) in ISO 8601 format",
|
|
5223
|
+
},
|
|
5224
|
+
},
|
|
5225
|
+
required: ["id", "email", "createdAt"],
|
|
5226
|
+
additionalProperties: false,
|
|
5227
|
+
},
|
|
5228
|
+
},
|
|
5163
5229
|
User: {
|
|
5164
5230
|
section: "user",
|
|
5165
5231
|
schema: {
|
|
@@ -5173,13 +5239,13 @@ export const state = {
|
|
|
5173
5239
|
type: "string",
|
|
5174
5240
|
format: "date-time",
|
|
5175
5241
|
description:
|
|
5176
|
-
"Creation date of the [User](#schema_user) in
|
|
5242
|
+
"Creation date of the [User](#schema_user) in ISO 8601 format",
|
|
5177
5243
|
},
|
|
5178
5244
|
updatedAt: {
|
|
5179
5245
|
type: "string",
|
|
5180
5246
|
format: "date-time",
|
|
5181
5247
|
description:
|
|
5182
|
-
"Updating date of the [User](#schema_user) in
|
|
5248
|
+
"Updating date of the [User](#schema_user) in ISO 8601 format",
|
|
5183
5249
|
},
|
|
5184
5250
|
tags: {
|
|
5185
5251
|
type: "object",
|
|
@@ -5209,13 +5275,13 @@ export const state = {
|
|
|
5209
5275
|
type: "string",
|
|
5210
5276
|
format: "date-time",
|
|
5211
5277
|
description:
|
|
5212
|
-
"Creation date of the [Conversation](#schema_conversation) in
|
|
5278
|
+
"Creation date of the [Conversation](#schema_conversation) in ISO 8601 format",
|
|
5213
5279
|
},
|
|
5214
5280
|
updatedAt: {
|
|
5215
5281
|
type: "string",
|
|
5216
5282
|
format: "date-time",
|
|
5217
5283
|
description:
|
|
5218
|
-
"Updating date of the [Conversation](#schema_conversation) in
|
|
5284
|
+
"Updating date of the [Conversation](#schema_conversation) in ISO 8601 format",
|
|
5219
5285
|
},
|
|
5220
5286
|
channel: {
|
|
5221
5287
|
type: "string",
|
|
@@ -5262,7 +5328,7 @@ export const state = {
|
|
|
5262
5328
|
type: "string",
|
|
5263
5329
|
format: "date-time",
|
|
5264
5330
|
description:
|
|
5265
|
-
"Creation date of the [Event](#schema_event) in
|
|
5331
|
+
"Creation date of the [Event](#schema_event) in ISO 8601 format",
|
|
5266
5332
|
},
|
|
5267
5333
|
type: {
|
|
5268
5334
|
type: "string",
|
|
@@ -5293,7 +5359,7 @@ export const state = {
|
|
|
5293
5359
|
type: "string",
|
|
5294
5360
|
format: "date-time",
|
|
5295
5361
|
description:
|
|
5296
|
-
"Creation date of the [Message](#schema_message) in
|
|
5362
|
+
"Creation date of the [Message](#schema_message) in ISO 8601 format",
|
|
5297
5363
|
},
|
|
5298
5364
|
type: {
|
|
5299
5365
|
type: "string",
|
|
@@ -5356,13 +5422,13 @@ export const state = {
|
|
|
5356
5422
|
type: "string",
|
|
5357
5423
|
format: "date-time",
|
|
5358
5424
|
description:
|
|
5359
|
-
"Creation date of the [State](#schema_state) in
|
|
5425
|
+
"Creation date of the [State](#schema_state) in ISO 8601 format",
|
|
5360
5426
|
},
|
|
5361
5427
|
updatedAt: {
|
|
5362
5428
|
type: "string",
|
|
5363
5429
|
format: "date-time",
|
|
5364
5430
|
description:
|
|
5365
|
-
"Updating date of the [State](#schema_state) in
|
|
5431
|
+
"Updating date of the [State](#schema_state) in ISO 8601 format",
|
|
5366
5432
|
},
|
|
5367
5433
|
botId: {
|
|
5368
5434
|
type: "string",
|
|
@@ -5597,12 +5663,20 @@ export const state = {
|
|
|
5597
5663
|
],
|
|
5598
5664
|
schema: "WorkspaceMember",
|
|
5599
5665
|
},
|
|
5666
|
+
{
|
|
5667
|
+
description: "",
|
|
5668
|
+
title: "Account",
|
|
5669
|
+
name: "account",
|
|
5670
|
+
operations: ["getAccount"],
|
|
5671
|
+
schema: "Account",
|
|
5672
|
+
},
|
|
5600
5673
|
],
|
|
5601
5674
|
} satisfies State<
|
|
5602
5675
|
| "Bot"
|
|
5603
5676
|
| "Integration"
|
|
5604
5677
|
| "Workspace"
|
|
5605
5678
|
| "WorkspaceMember"
|
|
5679
|
+
| "Account"
|
|
5606
5680
|
| "User"
|
|
5607
5681
|
| "Conversation"
|
|
5608
5682
|
| "Event"
|
|
@@ -5622,4 +5696,5 @@ export const state = {
|
|
|
5622
5696
|
| "integration"
|
|
5623
5697
|
| "workspace"
|
|
5624
5698
|
| "workspaceMember"
|
|
5699
|
+
| "account"
|
|
5625
5700
|
>;
|