@botpress/api 0.11.0 → 0.12.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.
Files changed (5) hide show
  1. package/dist/gen/state.d.ts +93 -4
  2. package/dist/index.js +105 -9
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +108 -9
package/src/gen/state.ts CHANGED
@@ -3048,6 +3048,10 @@ export const state = {
3048
3048
  type: "string",
3049
3049
  enum: ["free", "premium"],
3050
3050
  },
3051
+ plan: {
3052
+ type: "string",
3053
+ enum: ["community", "team", "enterprise"],
3054
+ },
3051
3055
  blocked: {
3052
3056
  type: "boolean",
3053
3057
  },
@@ -3063,6 +3067,7 @@ export const state = {
3063
3067
  "updatedAt",
3064
3068
  "botCount",
3065
3069
  "accountType",
3070
+ "plan",
3066
3071
  "blocked",
3067
3072
  "spendingLimit",
3068
3073
  ],
@@ -3115,6 +3120,10 @@ export const state = {
3115
3120
  type: "string",
3116
3121
  enum: ["free", "premium"],
3117
3122
  },
3123
+ plan: {
3124
+ type: "string",
3125
+ enum: ["community", "team", "enterprise"],
3126
+ },
3118
3127
  blocked: {
3119
3128
  type: "boolean",
3120
3129
  },
@@ -3130,6 +3139,7 @@ export const state = {
3130
3139
  "updatedAt",
3131
3140
  "botCount",
3132
3141
  "accountType",
3142
+ "plan",
3133
3143
  "blocked",
3134
3144
  "spendingLimit",
3135
3145
  ],
@@ -3413,6 +3423,10 @@ export const state = {
3413
3423
  type: "string",
3414
3424
  enum: ["free", "premium"],
3415
3425
  },
3426
+ plan: {
3427
+ type: "string",
3428
+ enum: ["community", "team", "enterprise"],
3429
+ },
3416
3430
  blocked: {
3417
3431
  type: "boolean",
3418
3432
  },
@@ -3428,6 +3442,7 @@ export const state = {
3428
3442
  "updatedAt",
3429
3443
  "botCount",
3430
3444
  "accountType",
3445
+ "plan",
3431
3446
  "blocked",
3432
3447
  "spendingLimit",
3433
3448
  ],
@@ -3485,6 +3500,10 @@ export const state = {
3485
3500
  type: "string",
3486
3501
  enum: ["free", "premium"],
3487
3502
  },
3503
+ plan: {
3504
+ type: "string",
3505
+ enum: ["community", "team", "enterprise"],
3506
+ },
3488
3507
  blocked: {
3489
3508
  type: "boolean",
3490
3509
  },
@@ -3500,6 +3519,7 @@ export const state = {
3500
3519
  "updatedAt",
3501
3520
  "botCount",
3502
3521
  "accountType",
3522
+ "plan",
3503
3523
  "blocked",
3504
3524
  "spendingLimit",
3505
3525
  ],
@@ -3582,6 +3602,10 @@ export const state = {
3582
3602
  type: "string",
3583
3603
  enum: ["free", "premium"],
3584
3604
  },
3605
+ plan: {
3606
+ type: "string",
3607
+ enum: ["community", "team", "enterprise"],
3608
+ },
3585
3609
  blocked: {
3586
3610
  type: "boolean",
3587
3611
  },
@@ -3597,6 +3621,7 @@ export const state = {
3597
3621
  "updatedAt",
3598
3622
  "botCount",
3599
3623
  "accountType",
3624
+ "plan",
3600
3625
  "blocked",
3601
3626
  "spendingLimit",
3602
3627
  ],
@@ -3989,9 +4014,19 @@ export const state = {
3989
4014
  description:
3990
4015
  "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
3991
4016
  },
4017
+ identifier: {
4018
+ type: "object",
4019
+ properties: {
4020
+ required: {
4021
+ type: "boolean",
4022
+ },
4023
+ linkTemplateScript: {
4024
+ type: "string",
4025
+ },
4026
+ },
4027
+ additionalProperties: false,
4028
+ },
3992
4029
  },
3993
- required: ["schema"],
3994
- description: "Configuration definition",
3995
4030
  additionalProperties: false,
3996
4031
  },
3997
4032
  states: {
@@ -4085,6 +4120,15 @@ export const state = {
4085
4120
  additionalProperties: false,
4086
4121
  },
4087
4122
  },
4123
+ identifier: {
4124
+ type: "object",
4125
+ properties: {
4126
+ extractScript: {
4127
+ type: "string",
4128
+ },
4129
+ },
4130
+ additionalProperties: false,
4131
+ },
4088
4132
  channels: {
4089
4133
  type: "object",
4090
4134
  additionalProperties: {
@@ -4329,9 +4373,20 @@ export const state = {
4329
4373
  description:
4330
4374
  "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
4331
4375
  },
4376
+ identifier: {
4377
+ type: "object",
4378
+ properties: {
4379
+ linkTemplateScript: {
4380
+ type: "string",
4381
+ nullable: true,
4382
+ },
4383
+ required: {
4384
+ type: "boolean",
4385
+ },
4386
+ },
4387
+ additionalProperties: false,
4388
+ },
4332
4389
  },
4333
- required: ["schema"],
4334
- description: "Configuration definition",
4335
4390
  additionalProperties: false,
4336
4391
  },
4337
4392
  channels: {
@@ -4447,6 +4502,16 @@ export const state = {
4447
4502
  additionalProperties: false,
4448
4503
  },
4449
4504
  },
4505
+ identifier: {
4506
+ type: "object",
4507
+ properties: {
4508
+ extractScript: {
4509
+ type: "string",
4510
+ nullable: true,
4511
+ },
4512
+ },
4513
+ additionalProperties: false,
4514
+ },
4450
4515
  actions: {
4451
4516
  type: "object",
4452
4517
  additionalProperties: {
@@ -5223,7 +5288,7 @@ export const state = {
5223
5288
  title: "Botpress API",
5224
5289
  description: "API for Botpress Cloud",
5225
5290
  server: "https://api.botpress.cloud",
5226
- version: "0.11.0",
5291
+ version: "0.12.0",
5227
5292
  prefix: "v1",
5228
5293
  },
5229
5294
  errors: [
@@ -5864,6 +5929,19 @@ export const state = {
5864
5929
  description:
5865
5930
  "Updating date of the [Integration](#schema_integration) in ISO 8601 format",
5866
5931
  },
5932
+ identifier: {
5933
+ type: "object",
5934
+ properties: {
5935
+ extractScript: {
5936
+ type: "string",
5937
+ description:
5938
+ "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth",
5939
+ },
5940
+ },
5941
+ description:
5942
+ "Global identifier configuration of the [Integration](#schema_integration)",
5943
+ additionalProperties: false,
5944
+ },
5867
5945
  name: {
5868
5946
  type: "string",
5869
5947
  description: "Name of the [Integration](#schema_integration)",
@@ -5875,6 +5953,21 @@ export const state = {
5875
5953
  configuration: {
5876
5954
  type: "object",
5877
5955
  properties: {
5956
+ identifier: {
5957
+ type: "object",
5958
+ properties: {
5959
+ linkTemplateScript: {
5960
+ type: "string",
5961
+ },
5962
+ required: {
5963
+ type: "boolean",
5964
+ },
5965
+ },
5966
+ required: ["required"],
5967
+ description:
5968
+ "Identifier configuration of the [Integration](#schema_integration)",
5969
+ additionalProperties: false,
5970
+ },
5878
5971
  schema: {
5879
5972
  type: "object",
5880
5973
  additionalProperties: true,
@@ -5882,7 +5975,7 @@ export const state = {
5882
5975
  "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
5883
5976
  },
5884
5977
  },
5885
- required: ["schema"],
5978
+ required: ["identifier"],
5886
5979
  description: "Configuration definition",
5887
5980
  additionalProperties: false,
5888
5981
  },
@@ -6175,6 +6268,7 @@ export const state = {
6175
6268
  "id",
6176
6269
  "createdAt",
6177
6270
  "updatedAt",
6271
+ "identifier",
6178
6272
  "name",
6179
6273
  "version",
6180
6274
  "configuration",
@@ -6219,6 +6313,10 @@ export const state = {
6219
6313
  type: "string",
6220
6314
  enum: ["free", "premium"],
6221
6315
  },
6316
+ plan: {
6317
+ type: "string",
6318
+ enum: ["community", "team", "enterprise"],
6319
+ },
6222
6320
  blocked: {
6223
6321
  type: "boolean",
6224
6322
  },
@@ -6234,6 +6332,7 @@ export const state = {
6234
6332
  "updatedAt",
6235
6333
  "botCount",
6236
6334
  "accountType",
6335
+ "plan",
6237
6336
  "blocked",
6238
6337
  "spendingLimit",
6239
6338
  ],
@@ -6441,7 +6540,7 @@ export const state = {
6441
6540
  type: "string",
6442
6541
  },
6443
6542
  description:
6444
- "Set of [Tags](#tags) that you can attach to a [User](#schema_user). The set of [Tags](#tags) available on a [User](#schema_user) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
6543
+ "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.",
6445
6544
  },
6446
6545
  },
6447
6546
  required: ["id", "createdAt", "updatedAt", "tags"],
@@ -6487,7 +6586,7 @@ export const state = {
6487
6586
  type: "string",
6488
6587
  },
6489
6588
  description:
6490
- "Set of [Tags](#tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
6589
+ "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.",
6491
6590
  },
6492
6591
  },
6493
6592
  required: [
@@ -6579,7 +6678,7 @@ export const state = {
6579
6678
  type: "string",
6580
6679
  },
6581
6680
  description:
6582
- "Set of [Tags](#tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
6681
+ "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.",
6583
6682
  },
6584
6683
  },
6585
6684
  required: [