@botpress/api 0.15.11 → 0.16.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/index.js +446 -135
- package/dist/src/gen/state.d.ts +261 -1
- package/package.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +282 -11
package/src/gen/state.ts
CHANGED
|
@@ -2096,6 +2096,26 @@ export const state = {
|
|
|
2096
2096
|
additionalProperties: false,
|
|
2097
2097
|
},
|
|
2098
2098
|
},
|
|
2099
|
+
subscriptions: {
|
|
2100
|
+
type: "object",
|
|
2101
|
+
properties: {
|
|
2102
|
+
events: {
|
|
2103
|
+
type: "object",
|
|
2104
|
+
additionalProperties: {
|
|
2105
|
+
type: "object",
|
|
2106
|
+
additionalProperties: {
|
|
2107
|
+
readOnly: true,
|
|
2108
|
+
},
|
|
2109
|
+
},
|
|
2110
|
+
nullable: true,
|
|
2111
|
+
description:
|
|
2112
|
+
'Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.',
|
|
2113
|
+
},
|
|
2114
|
+
},
|
|
2115
|
+
required: ["events"],
|
|
2116
|
+
description: "Subscriptions of the bot",
|
|
2117
|
+
additionalProperties: false,
|
|
2118
|
+
},
|
|
2099
2119
|
configuration: {
|
|
2100
2120
|
type: "object",
|
|
2101
2121
|
properties: {
|
|
@@ -2495,6 +2515,24 @@ export const state = {
|
|
|
2495
2515
|
additionalProperties: false,
|
|
2496
2516
|
},
|
|
2497
2517
|
},
|
|
2518
|
+
subscriptions: {
|
|
2519
|
+
type: "object",
|
|
2520
|
+
properties: {
|
|
2521
|
+
events: {
|
|
2522
|
+
type: "object",
|
|
2523
|
+
additionalProperties: {
|
|
2524
|
+
type: "object",
|
|
2525
|
+
additionalProperties: {
|
|
2526
|
+
readOnly: true,
|
|
2527
|
+
},
|
|
2528
|
+
nullable: true,
|
|
2529
|
+
},
|
|
2530
|
+
nullable: true,
|
|
2531
|
+
},
|
|
2532
|
+
},
|
|
2533
|
+
required: ["events"],
|
|
2534
|
+
additionalProperties: false,
|
|
2535
|
+
},
|
|
2498
2536
|
code: {
|
|
2499
2537
|
type: "string",
|
|
2500
2538
|
description: "JavaScript code of the bot",
|
|
@@ -3520,6 +3558,32 @@ export const state = {
|
|
|
3520
3558
|
spendingLimit: {
|
|
3521
3559
|
type: "number",
|
|
3522
3560
|
},
|
|
3561
|
+
about: {
|
|
3562
|
+
default: "",
|
|
3563
|
+
type: "string",
|
|
3564
|
+
},
|
|
3565
|
+
profilePicture: {
|
|
3566
|
+
default: "",
|
|
3567
|
+
type: "string",
|
|
3568
|
+
},
|
|
3569
|
+
contactEmail: {
|
|
3570
|
+
default: "",
|
|
3571
|
+
type: "string",
|
|
3572
|
+
},
|
|
3573
|
+
website: {
|
|
3574
|
+
default: "",
|
|
3575
|
+
type: "string",
|
|
3576
|
+
},
|
|
3577
|
+
socialAccounts: {
|
|
3578
|
+
default: [],
|
|
3579
|
+
type: "array",
|
|
3580
|
+
items: {
|
|
3581
|
+
type: "string",
|
|
3582
|
+
},
|
|
3583
|
+
},
|
|
3584
|
+
isPublic: {
|
|
3585
|
+
type: "boolean",
|
|
3586
|
+
},
|
|
3523
3587
|
},
|
|
3524
3588
|
required: [
|
|
3525
3589
|
"id",
|
|
@@ -3597,6 +3661,32 @@ export const state = {
|
|
|
3597
3661
|
spendingLimit: {
|
|
3598
3662
|
type: "number",
|
|
3599
3663
|
},
|
|
3664
|
+
about: {
|
|
3665
|
+
default: "",
|
|
3666
|
+
type: "string",
|
|
3667
|
+
},
|
|
3668
|
+
profilePicture: {
|
|
3669
|
+
default: "",
|
|
3670
|
+
type: "string",
|
|
3671
|
+
},
|
|
3672
|
+
contactEmail: {
|
|
3673
|
+
default: "",
|
|
3674
|
+
type: "string",
|
|
3675
|
+
},
|
|
3676
|
+
website: {
|
|
3677
|
+
default: "",
|
|
3678
|
+
type: "string",
|
|
3679
|
+
},
|
|
3680
|
+
socialAccounts: {
|
|
3681
|
+
default: [],
|
|
3682
|
+
type: "array",
|
|
3683
|
+
items: {
|
|
3684
|
+
type: "string",
|
|
3685
|
+
},
|
|
3686
|
+
},
|
|
3687
|
+
isPublic: {
|
|
3688
|
+
type: "boolean",
|
|
3689
|
+
},
|
|
3600
3690
|
},
|
|
3601
3691
|
required: [
|
|
3602
3692
|
"id",
|
|
@@ -3984,9 +4074,31 @@ export const state = {
|
|
|
3984
4074
|
minimum: 5,
|
|
3985
4075
|
maximum: 1000,
|
|
3986
4076
|
},
|
|
4077
|
+
about: {
|
|
4078
|
+
type: "string",
|
|
4079
|
+
},
|
|
4080
|
+
profilePicture: {
|
|
4081
|
+
type: "string",
|
|
4082
|
+
},
|
|
4083
|
+
contactEmail: {
|
|
4084
|
+
type: "string",
|
|
4085
|
+
},
|
|
4086
|
+
website: {
|
|
4087
|
+
type: "string",
|
|
4088
|
+
},
|
|
4089
|
+
socialAccounts: {
|
|
4090
|
+
type: "array",
|
|
4091
|
+
items: {
|
|
4092
|
+
type: "string",
|
|
4093
|
+
},
|
|
4094
|
+
maxItems: 5,
|
|
4095
|
+
},
|
|
4096
|
+
isPublic: {
|
|
4097
|
+
type: "boolean",
|
|
4098
|
+
},
|
|
3987
4099
|
},
|
|
3988
|
-
title: "updateWorkspaceBody",
|
|
3989
4100
|
additionalProperties: false,
|
|
4101
|
+
title: "updateWorkspaceBody",
|
|
3990
4102
|
},
|
|
3991
4103
|
},
|
|
3992
4104
|
response: {
|
|
@@ -4030,6 +4142,32 @@ export const state = {
|
|
|
4030
4142
|
spendingLimit: {
|
|
4031
4143
|
type: "number",
|
|
4032
4144
|
},
|
|
4145
|
+
about: {
|
|
4146
|
+
default: "",
|
|
4147
|
+
type: "string",
|
|
4148
|
+
},
|
|
4149
|
+
profilePicture: {
|
|
4150
|
+
default: "",
|
|
4151
|
+
type: "string",
|
|
4152
|
+
},
|
|
4153
|
+
contactEmail: {
|
|
4154
|
+
default: "",
|
|
4155
|
+
type: "string",
|
|
4156
|
+
},
|
|
4157
|
+
website: {
|
|
4158
|
+
default: "",
|
|
4159
|
+
type: "string",
|
|
4160
|
+
},
|
|
4161
|
+
socialAccounts: {
|
|
4162
|
+
default: [],
|
|
4163
|
+
type: "array",
|
|
4164
|
+
items: {
|
|
4165
|
+
type: "string",
|
|
4166
|
+
},
|
|
4167
|
+
},
|
|
4168
|
+
isPublic: {
|
|
4169
|
+
type: "boolean",
|
|
4170
|
+
},
|
|
4033
4171
|
},
|
|
4034
4172
|
required: [
|
|
4035
4173
|
"id",
|
|
@@ -4112,6 +4250,32 @@ export const state = {
|
|
|
4112
4250
|
spendingLimit: {
|
|
4113
4251
|
type: "number",
|
|
4114
4252
|
},
|
|
4253
|
+
about: {
|
|
4254
|
+
default: "",
|
|
4255
|
+
type: "string",
|
|
4256
|
+
},
|
|
4257
|
+
profilePicture: {
|
|
4258
|
+
default: "",
|
|
4259
|
+
type: "string",
|
|
4260
|
+
},
|
|
4261
|
+
contactEmail: {
|
|
4262
|
+
default: "",
|
|
4263
|
+
type: "string",
|
|
4264
|
+
},
|
|
4265
|
+
website: {
|
|
4266
|
+
default: "",
|
|
4267
|
+
type: "string",
|
|
4268
|
+
},
|
|
4269
|
+
socialAccounts: {
|
|
4270
|
+
default: [],
|
|
4271
|
+
type: "array",
|
|
4272
|
+
items: {
|
|
4273
|
+
type: "string",
|
|
4274
|
+
},
|
|
4275
|
+
},
|
|
4276
|
+
isPublic: {
|
|
4277
|
+
type: "boolean",
|
|
4278
|
+
},
|
|
4115
4279
|
},
|
|
4116
4280
|
required: [
|
|
4117
4281
|
"id",
|
|
@@ -4219,6 +4383,32 @@ export const state = {
|
|
|
4219
4383
|
spendingLimit: {
|
|
4220
4384
|
type: "number",
|
|
4221
4385
|
},
|
|
4386
|
+
about: {
|
|
4387
|
+
default: "",
|
|
4388
|
+
type: "string",
|
|
4389
|
+
},
|
|
4390
|
+
profilePicture: {
|
|
4391
|
+
default: "",
|
|
4392
|
+
type: "string",
|
|
4393
|
+
},
|
|
4394
|
+
contactEmail: {
|
|
4395
|
+
default: "",
|
|
4396
|
+
type: "string",
|
|
4397
|
+
},
|
|
4398
|
+
website: {
|
|
4399
|
+
default: "",
|
|
4400
|
+
type: "string",
|
|
4401
|
+
},
|
|
4402
|
+
socialAccounts: {
|
|
4403
|
+
default: [],
|
|
4404
|
+
type: "array",
|
|
4405
|
+
items: {
|
|
4406
|
+
type: "string",
|
|
4407
|
+
},
|
|
4408
|
+
},
|
|
4409
|
+
isPublic: {
|
|
4410
|
+
type: "boolean",
|
|
4411
|
+
},
|
|
4222
4412
|
},
|
|
4223
4413
|
required: [
|
|
4224
4414
|
"id",
|
|
@@ -4406,6 +4596,9 @@ export const state = {
|
|
|
4406
4596
|
email: {
|
|
4407
4597
|
type: "string",
|
|
4408
4598
|
},
|
|
4599
|
+
createdAt: {
|
|
4600
|
+
type: "string",
|
|
4601
|
+
},
|
|
4409
4602
|
role: {
|
|
4410
4603
|
type: "string",
|
|
4411
4604
|
enum: [
|
|
@@ -4418,7 +4611,7 @@ export const state = {
|
|
|
4418
4611
|
],
|
|
4419
4612
|
},
|
|
4420
4613
|
},
|
|
4421
|
-
required: ["id", "email", "role"],
|
|
4614
|
+
required: ["id", "email", "createdAt", "role"],
|
|
4422
4615
|
},
|
|
4423
4616
|
},
|
|
4424
4617
|
meta: {
|
|
@@ -4508,6 +4701,9 @@ export const state = {
|
|
|
4508
4701
|
email: {
|
|
4509
4702
|
type: "string",
|
|
4510
4703
|
},
|
|
4704
|
+
createdAt: {
|
|
4705
|
+
type: "string",
|
|
4706
|
+
},
|
|
4511
4707
|
role: {
|
|
4512
4708
|
type: "string",
|
|
4513
4709
|
enum: [
|
|
@@ -4520,7 +4716,7 @@ export const state = {
|
|
|
4520
4716
|
],
|
|
4521
4717
|
},
|
|
4522
4718
|
},
|
|
4523
|
-
required: ["id", "email", "role"],
|
|
4719
|
+
required: ["id", "email", "createdAt", "role"],
|
|
4524
4720
|
title: "createWorkspaceMemberResponse",
|
|
4525
4721
|
additionalProperties: false,
|
|
4526
4722
|
},
|
|
@@ -4576,6 +4772,9 @@ export const state = {
|
|
|
4576
4772
|
email: {
|
|
4577
4773
|
type: "string",
|
|
4578
4774
|
},
|
|
4775
|
+
createdAt: {
|
|
4776
|
+
type: "string",
|
|
4777
|
+
},
|
|
4579
4778
|
role: {
|
|
4580
4779
|
type: "string",
|
|
4581
4780
|
enum: [
|
|
@@ -4588,7 +4787,7 @@ export const state = {
|
|
|
4588
4787
|
],
|
|
4589
4788
|
},
|
|
4590
4789
|
},
|
|
4591
|
-
required: ["id", "email", "role"],
|
|
4790
|
+
required: ["id", "email", "createdAt", "role"],
|
|
4592
4791
|
title: "updateWorkspaceMemberResponse",
|
|
4593
4792
|
additionalProperties: false,
|
|
4594
4793
|
},
|
|
@@ -4914,7 +5113,7 @@ export const state = {
|
|
|
4914
5113
|
type: "string",
|
|
4915
5114
|
},
|
|
4916
5115
|
description:
|
|
4917
|
-
"Secrets are integration-wide values available in the code via environment variables formatted
|
|
5116
|
+
"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.",
|
|
4918
5117
|
},
|
|
4919
5118
|
code: {
|
|
4920
5119
|
type: "string",
|
|
@@ -5301,7 +5500,7 @@ export const state = {
|
|
|
5301
5500
|
nullable: true,
|
|
5302
5501
|
},
|
|
5303
5502
|
description:
|
|
5304
|
-
"Secrets are integration-wide values available in the code via environment variables formatted
|
|
5503
|
+
"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.",
|
|
5305
5504
|
},
|
|
5306
5505
|
code: {
|
|
5307
5506
|
type: "string",
|
|
@@ -5983,7 +6182,7 @@ export const state = {
|
|
|
5983
6182
|
title: "Botpress API",
|
|
5984
6183
|
description: "API for Botpress Cloud",
|
|
5985
6184
|
server: "https://api.botpress.cloud",
|
|
5986
|
-
version: "0.
|
|
6185
|
+
version: "0.16.0",
|
|
5987
6186
|
prefix: "v1",
|
|
5988
6187
|
},
|
|
5989
6188
|
errors: [
|
|
@@ -6581,12 +6780,50 @@ export const state = {
|
|
|
6581
6780
|
type: "object",
|
|
6582
6781
|
additionalProperties: true,
|
|
6583
6782
|
},
|
|
6783
|
+
failedAttempts: {
|
|
6784
|
+
type: "number",
|
|
6785
|
+
description:
|
|
6786
|
+
"The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully.",
|
|
6787
|
+
},
|
|
6788
|
+
lastFailureReason: {
|
|
6789
|
+
type: "string",
|
|
6790
|
+
maxLength: 2000,
|
|
6791
|
+
description:
|
|
6792
|
+
"The reason why the recurring event failed to run in the last attempt.",
|
|
6793
|
+
nullable: true,
|
|
6794
|
+
},
|
|
6584
6795
|
},
|
|
6585
|
-
required: [
|
|
6796
|
+
required: [
|
|
6797
|
+
"schedule",
|
|
6798
|
+
"type",
|
|
6799
|
+
"payload",
|
|
6800
|
+
"failedAttempts",
|
|
6801
|
+
"lastFailureReason",
|
|
6802
|
+
],
|
|
6586
6803
|
additionalProperties: false,
|
|
6587
6804
|
},
|
|
6588
6805
|
description: "Recurring events",
|
|
6589
6806
|
},
|
|
6807
|
+
subscriptions: {
|
|
6808
|
+
type: "object",
|
|
6809
|
+
properties: {
|
|
6810
|
+
events: {
|
|
6811
|
+
type: "object",
|
|
6812
|
+
additionalProperties: {
|
|
6813
|
+
type: "object",
|
|
6814
|
+
additionalProperties: {
|
|
6815
|
+
readOnly: true,
|
|
6816
|
+
},
|
|
6817
|
+
},
|
|
6818
|
+
nullable: true,
|
|
6819
|
+
description:
|
|
6820
|
+
'Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.',
|
|
6821
|
+
},
|
|
6822
|
+
},
|
|
6823
|
+
required: ["events"],
|
|
6824
|
+
description: "Subscriptions of the bot",
|
|
6825
|
+
additionalProperties: false,
|
|
6826
|
+
},
|
|
6590
6827
|
name: {
|
|
6591
6828
|
type: "string",
|
|
6592
6829
|
description: "Name of the [Bot](#schema_bot)",
|
|
@@ -6648,6 +6885,7 @@ export const state = {
|
|
|
6648
6885
|
"configuration",
|
|
6649
6886
|
"events",
|
|
6650
6887
|
"recurringEvents",
|
|
6888
|
+
"subscriptions",
|
|
6651
6889
|
"name",
|
|
6652
6890
|
"dev",
|
|
6653
6891
|
"alwaysAlive",
|
|
@@ -7033,7 +7271,7 @@ export const state = {
|
|
|
7033
7271
|
type: "string",
|
|
7034
7272
|
},
|
|
7035
7273
|
description:
|
|
7036
|
-
"Secrets are integration-wide values available in the code via environment variables formatted
|
|
7274
|
+
"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.",
|
|
7037
7275
|
},
|
|
7038
7276
|
},
|
|
7039
7277
|
required: [
|
|
@@ -7100,6 +7338,32 @@ export const state = {
|
|
|
7100
7338
|
spendingLimit: {
|
|
7101
7339
|
type: "number",
|
|
7102
7340
|
},
|
|
7341
|
+
about: {
|
|
7342
|
+
default: "",
|
|
7343
|
+
type: "string",
|
|
7344
|
+
},
|
|
7345
|
+
profilePicture: {
|
|
7346
|
+
default: "",
|
|
7347
|
+
type: "string",
|
|
7348
|
+
},
|
|
7349
|
+
contactEmail: {
|
|
7350
|
+
default: "",
|
|
7351
|
+
type: "string",
|
|
7352
|
+
},
|
|
7353
|
+
website: {
|
|
7354
|
+
default: "",
|
|
7355
|
+
type: "string",
|
|
7356
|
+
},
|
|
7357
|
+
socialAccounts: {
|
|
7358
|
+
default: [],
|
|
7359
|
+
type: "array",
|
|
7360
|
+
items: {
|
|
7361
|
+
type: "string",
|
|
7362
|
+
},
|
|
7363
|
+
},
|
|
7364
|
+
isPublic: {
|
|
7365
|
+
type: "boolean",
|
|
7366
|
+
},
|
|
7103
7367
|
},
|
|
7104
7368
|
required: [
|
|
7105
7369
|
"id",
|
|
@@ -7132,6 +7396,9 @@ export const state = {
|
|
|
7132
7396
|
email: {
|
|
7133
7397
|
type: "string",
|
|
7134
7398
|
},
|
|
7399
|
+
createdAt: {
|
|
7400
|
+
type: "string",
|
|
7401
|
+
},
|
|
7135
7402
|
role: {
|
|
7136
7403
|
type: "string",
|
|
7137
7404
|
enum: [
|
|
@@ -7144,7 +7411,7 @@ export const state = {
|
|
|
7144
7411
|
],
|
|
7145
7412
|
},
|
|
7146
7413
|
},
|
|
7147
|
-
required: ["id", "email", "role"],
|
|
7414
|
+
required: ["id", "email", "createdAt", "role"],
|
|
7148
7415
|
additionalProperties: false,
|
|
7149
7416
|
},
|
|
7150
7417
|
},
|
|
@@ -7469,8 +7736,12 @@ export const state = {
|
|
|
7469
7736
|
description:
|
|
7470
7737
|
"ID of the [Message](#schema_message) to link the event to.",
|
|
7471
7738
|
},
|
|
7739
|
+
status: {
|
|
7740
|
+
type: "string",
|
|
7741
|
+
description: "Status of the event (e.g. `ignored`, `processed`)",
|
|
7742
|
+
},
|
|
7472
7743
|
},
|
|
7473
|
-
required: ["id", "createdAt", "type", "payload"],
|
|
7744
|
+
required: ["id", "createdAt", "type", "payload", "status"],
|
|
7474
7745
|
description: "The event object represents an action or an occurrence.",
|
|
7475
7746
|
additionalProperties: false,
|
|
7476
7747
|
},
|