@botpress/api 1.72.1 → 1.72.2

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 CHANGED
@@ -279445,7 +279445,7 @@ var state = {
279445
279445
  "title": "Botpress Runtime API",
279446
279446
  "description": "API for Botpress Runtime",
279447
279447
  "server": "https://api.botpress.cloud",
279448
- "version": "1.72.1",
279448
+ "version": "1.72.2",
279449
279449
  "prefix": "v1"
279450
279450
  },
279451
279451
  "defaultParameters": {
@@ -295994,7 +295994,7 @@ var state2 = {
295994
295994
  "title": "Botpress Admin API",
295995
295995
  "description": "API for Botpress Cloud Manager",
295996
295996
  "server": "https://api.botpress.cloud",
295997
- "version": "1.72.1",
295997
+ "version": "1.72.2",
295998
295998
  "prefix": "v1"
295999
295999
  },
296000
296000
  "defaultParameters": {
@@ -301515,7 +301515,7 @@ var state3 = {
301515
301515
  "title": "Botpress Files API",
301516
301516
  "description": "API for Botpress Files",
301517
301517
  "server": "https://api.botpress.cloud",
301518
- "version": "1.72.1",
301518
+ "version": "1.72.2",
301519
301519
  "prefix": "v1"
301520
301520
  },
301521
301521
  "defaultParameters": {
@@ -303811,7 +303811,7 @@ var state4 = {
303811
303811
  "title": "Botpress Tables API",
303812
303812
  "description": "API for Botpress Tables",
303813
303813
  "server": "https://api.botpress.cloud",
303814
- "version": "1.72.1",
303814
+ "version": "1.72.2",
303815
303815
  "prefix": "v1"
303816
303816
  },
303817
303817
  "defaultParameters": {
@@ -325384,7 +325384,7 @@ var state5 = {
325384
325384
  "title": "Botpress API",
325385
325385
  "description": "API for Botpress Cloud",
325386
325386
  "server": "https://api.botpress.cloud",
325387
- "version": "1.72.1",
325387
+ "version": "1.72.2",
325388
325388
  "prefix": "v1"
325389
325389
  },
325390
325390
  "errors": [
@@ -329876,6 +329876,110 @@ var state6 = {
329876
329876
  }
329877
329877
  }
329878
329878
  },
329879
+ "getBillingAddress": {
329880
+ "name": "getBillingAddress",
329881
+ "description": "Get billing address for the authenticated workspace",
329882
+ "method": "get",
329883
+ "path": "/v2/billing/address",
329884
+ "response": {
329885
+ "description": "Workspace billing address",
329886
+ "status": 200,
329887
+ "schema": {
329888
+ "type": "object",
329889
+ "properties": {
329890
+ "address": {
329891
+ "type": "object",
329892
+ "properties": {
329893
+ "lineOne": {
329894
+ "type": "string"
329895
+ },
329896
+ "lineTwo": {
329897
+ "type": "string"
329898
+ },
329899
+ "city": {
329900
+ "type": "string"
329901
+ },
329902
+ "state": {
329903
+ "type": "string"
329904
+ },
329905
+ "postalCode": {
329906
+ "type": "string"
329907
+ },
329908
+ "country": {
329909
+ "type": "string"
329910
+ }
329911
+ },
329912
+ "nullable": true,
329913
+ "additionalProperties": false
329914
+ }
329915
+ },
329916
+ "required": [
329917
+ "address"
329918
+ ],
329919
+ "title": "getBillingAddressResponse",
329920
+ "additionalProperties": false
329921
+ }
329922
+ },
329923
+ "parameters": {
329924
+ "x-workspace-id": {
329925
+ "in": "header",
329926
+ "type": "string",
329927
+ "description": "Workspace ID",
329928
+ "required": true
329929
+ }
329930
+ }
329931
+ },
329932
+ "setBillingAddress": {
329933
+ "name": "setBillingAddress",
329934
+ "description": "Set billing address for the authenticated workspace",
329935
+ "method": "put",
329936
+ "path": "/v2/billing/address",
329937
+ "requestBody": {
329938
+ "description": "Billing address",
329939
+ "schema": {
329940
+ "type": "object",
329941
+ "properties": {
329942
+ "lineOne": {
329943
+ "type": "string"
329944
+ },
329945
+ "lineTwo": {
329946
+ "type": "string"
329947
+ },
329948
+ "city": {
329949
+ "type": "string"
329950
+ },
329951
+ "state": {
329952
+ "type": "string"
329953
+ },
329954
+ "postalCode": {
329955
+ "type": "string"
329956
+ },
329957
+ "country": {
329958
+ "type": "string"
329959
+ }
329960
+ },
329961
+ "title": "setBillingAddressBody",
329962
+ "additionalProperties": false
329963
+ }
329964
+ },
329965
+ "response": {
329966
+ "description": "Updated",
329967
+ "status": 200,
329968
+ "schema": {
329969
+ "type": "object",
329970
+ "title": "setBillingAddressResponse",
329971
+ "additionalProperties": false
329972
+ }
329973
+ },
329974
+ "parameters": {
329975
+ "x-workspace-id": {
329976
+ "in": "header",
329977
+ "type": "string",
329978
+ "description": "Workspace ID",
329979
+ "required": true
329980
+ }
329981
+ }
329982
+ },
329879
329983
  "getPlan": {
329880
329984
  "name": "getPlan",
329881
329985
  "description": "Get plan details",
@@ -330201,181 +330305,13 @@ var state6 = {
330201
330305
  },
330202
330306
  "parameters": {}
330203
330307
  },
330204
- "getCurrentSubscription": {
330205
- "name": "getCurrentSubscription",
330206
- "description": "Get current subscription for a workspace",
330207
- "method": "get",
330208
- "path": "/v2/billing/subscriptions/current",
330209
- "response": {
330210
- "description": "Current subscription details",
330211
- "status": 200,
330212
- "schema": {
330213
- "type": "object",
330214
- "properties": {
330215
- "plan": {
330216
- "type": "object",
330217
- "properties": {
330218
- "current": {
330219
- "type": "object",
330220
- "properties": {
330221
- "status": {
330222
- "type": "string",
330223
- "enum": [
330224
- "active",
330225
- "canceled",
330226
- "past_due",
330227
- "action_required",
330228
- "grace_period"
330229
- ]
330230
- },
330231
- "planId": {
330232
- "type": "string"
330233
- },
330234
- "interval": {
330235
- "type": "string",
330236
- "enum": [
330237
- "month",
330238
- "year"
330239
- ]
330240
- },
330241
- "price": {
330242
- "type": "number"
330243
- },
330244
- "proratedPrice": {
330245
- "type": "number"
330246
- },
330247
- "cancelAtPeriodEnd": {
330248
- "type": "boolean"
330249
- },
330250
- "periodEnd": {
330251
- "type": "string"
330252
- }
330253
- },
330254
- "required": [
330255
- "status",
330256
- "planId",
330257
- "interval",
330258
- "price",
330259
- "cancelAtPeriodEnd",
330260
- "periodEnd"
330261
- ],
330262
- "additionalProperties": false
330263
- },
330264
- "next": {
330265
- "type": "object",
330266
- "properties": {
330267
- "planId": {
330268
- "type": "string"
330269
- },
330270
- "interval": {
330271
- "type": "string",
330272
- "enum": [
330273
- "month",
330274
- "year"
330275
- ]
330276
- },
330277
- "price": {
330278
- "type": "number",
330279
- "nullable": true
330280
- },
330281
- "effectiveDate": {
330282
- "type": "string"
330283
- }
330284
- },
330285
- "required": [
330286
- "planId",
330287
- "interval",
330288
- "price",
330289
- "effectiveDate"
330290
- ],
330291
- "nullable": true,
330292
- "additionalProperties": false
330293
- }
330294
- },
330295
- "required": [
330296
- "current",
330297
- "next"
330298
- ],
330299
- "additionalProperties": false
330300
- },
330301
- "addons": {
330302
- "type": "object",
330303
- "additionalProperties": {
330304
- "type": "object",
330305
- "properties": {
330306
- "current": {
330307
- "type": "object",
330308
- "properties": {
330309
- "quantity": {
330310
- "type": "number"
330311
- },
330312
- "price": {
330313
- "type": "number"
330314
- },
330315
- "proratedPrice": {
330316
- "type": "number"
330317
- }
330318
- },
330319
- "required": [
330320
- "quantity",
330321
- "price"
330322
- ],
330323
- "additionalProperties": false
330324
- },
330325
- "next": {
330326
- "type": "object",
330327
- "properties": {
330328
- "quantity": {
330329
- "type": "number"
330330
- },
330331
- "price": {
330332
- "type": "number"
330333
- },
330334
- "effectiveDate": {
330335
- "type": "string"
330336
- }
330337
- },
330338
- "required": [
330339
- "quantity",
330340
- "price",
330341
- "effectiveDate"
330342
- ],
330343
- "nullable": true,
330344
- "additionalProperties": false
330345
- }
330346
- },
330347
- "required": [
330348
- "current",
330349
- "next"
330350
- ],
330351
- "additionalProperties": false
330352
- }
330353
- }
330354
- },
330355
- "required": [
330356
- "plan",
330357
- "addons"
330358
- ],
330359
- "title": "getCurrentSubscriptionResponse",
330360
- "additionalProperties": false
330361
- }
330362
- },
330363
- "parameters": {
330364
- "x-workspace-id": {
330365
- "in": "header",
330366
- "type": "string",
330367
- "description": "Workspace ID",
330368
- "required": true
330369
- }
330370
- }
330371
- },
330372
- "getNextSubscription": {
330373
- "name": "getNextSubscription",
330374
- "description": "Get next subscription details for a workspace",
330308
+ "getSubscription": {
330309
+ "name": "getSubscription",
330310
+ "description": "Get subscription for a workspace",
330375
330311
  "method": "get",
330376
- "path": "/v2/billing/subscriptions/next",
330312
+ "path": "/v2/billing/subscriptions",
330377
330313
  "response": {
330378
- "description": "Next subscription details",
330314
+ "description": "Subscription details",
330379
330315
  "status": 200,
330380
330316
  "schema": {
330381
330317
  "type": "object",
@@ -330524,7 +330460,7 @@ var state6 = {
330524
330460
  "plan",
330525
330461
  "addons"
330526
330462
  ],
330527
- "title": "getNextSubscriptionResponse",
330463
+ "title": "getSubscriptionResponse",
330528
330464
  "additionalProperties": false
330529
330465
  }
330530
330466
  },
@@ -331219,6 +331155,728 @@ var state6 = {
331219
331155
  }
331220
331156
  }
331221
331157
  },
331158
+ "setCancelAtPeriodEnd": {
331159
+ "name": "setCancelAtPeriodEnd",
331160
+ "description": "Set whether to cancel the subscription at the end of the current period",
331161
+ "method": "put",
331162
+ "path": "/v2/billing/subscriptions/cancel",
331163
+ "requestBody": {
331164
+ "description": "Cancel at period end",
331165
+ "schema": {
331166
+ "type": "object",
331167
+ "properties": {
331168
+ "cancelAtPeriodEnd": {
331169
+ "type": "boolean"
331170
+ }
331171
+ },
331172
+ "required": [
331173
+ "cancelAtPeriodEnd"
331174
+ ],
331175
+ "title": "setCancelAtPeriodEndBody",
331176
+ "additionalProperties": false
331177
+ }
331178
+ },
331179
+ "response": {
331180
+ "description": "Updated subscription details",
331181
+ "status": 200,
331182
+ "schema": {
331183
+ "type": "object",
331184
+ "properties": {
331185
+ "plan": {
331186
+ "type": "object",
331187
+ "properties": {
331188
+ "current": {
331189
+ "type": "object",
331190
+ "properties": {
331191
+ "status": {
331192
+ "type": "string",
331193
+ "enum": [
331194
+ "active",
331195
+ "canceled",
331196
+ "past_due",
331197
+ "action_required",
331198
+ "grace_period"
331199
+ ]
331200
+ },
331201
+ "planId": {
331202
+ "type": "string"
331203
+ },
331204
+ "interval": {
331205
+ "type": "string",
331206
+ "enum": [
331207
+ "month",
331208
+ "year"
331209
+ ]
331210
+ },
331211
+ "price": {
331212
+ "type": "number"
331213
+ },
331214
+ "proratedPrice": {
331215
+ "type": "number"
331216
+ },
331217
+ "cancelAtPeriodEnd": {
331218
+ "type": "boolean"
331219
+ },
331220
+ "periodEnd": {
331221
+ "type": "string"
331222
+ }
331223
+ },
331224
+ "required": [
331225
+ "status",
331226
+ "planId",
331227
+ "interval",
331228
+ "price",
331229
+ "cancelAtPeriodEnd",
331230
+ "periodEnd"
331231
+ ],
331232
+ "additionalProperties": false
331233
+ },
331234
+ "next": {
331235
+ "type": "object",
331236
+ "properties": {
331237
+ "planId": {
331238
+ "type": "string"
331239
+ },
331240
+ "interval": {
331241
+ "type": "string",
331242
+ "enum": [
331243
+ "month",
331244
+ "year"
331245
+ ]
331246
+ },
331247
+ "price": {
331248
+ "type": "number",
331249
+ "nullable": true
331250
+ },
331251
+ "effectiveDate": {
331252
+ "type": "string"
331253
+ }
331254
+ },
331255
+ "required": [
331256
+ "planId",
331257
+ "interval",
331258
+ "price",
331259
+ "effectiveDate"
331260
+ ],
331261
+ "nullable": true,
331262
+ "additionalProperties": false
331263
+ }
331264
+ },
331265
+ "required": [
331266
+ "current",
331267
+ "next"
331268
+ ],
331269
+ "additionalProperties": false
331270
+ },
331271
+ "addons": {
331272
+ "type": "object",
331273
+ "additionalProperties": {
331274
+ "type": "object",
331275
+ "properties": {
331276
+ "current": {
331277
+ "type": "object",
331278
+ "properties": {
331279
+ "quantity": {
331280
+ "type": "number"
331281
+ },
331282
+ "price": {
331283
+ "type": "number"
331284
+ },
331285
+ "proratedPrice": {
331286
+ "type": "number"
331287
+ }
331288
+ },
331289
+ "required": [
331290
+ "quantity",
331291
+ "price"
331292
+ ],
331293
+ "additionalProperties": false
331294
+ },
331295
+ "next": {
331296
+ "type": "object",
331297
+ "properties": {
331298
+ "quantity": {
331299
+ "type": "number"
331300
+ },
331301
+ "price": {
331302
+ "type": "number"
331303
+ },
331304
+ "effectiveDate": {
331305
+ "type": "string"
331306
+ }
331307
+ },
331308
+ "required": [
331309
+ "quantity",
331310
+ "price",
331311
+ "effectiveDate"
331312
+ ],
331313
+ "nullable": true,
331314
+ "additionalProperties": false
331315
+ }
331316
+ },
331317
+ "required": [
331318
+ "current",
331319
+ "next"
331320
+ ],
331321
+ "additionalProperties": false
331322
+ }
331323
+ }
331324
+ },
331325
+ "required": [
331326
+ "plan",
331327
+ "addons"
331328
+ ],
331329
+ "description": "Subscription details including current plan, addons, and costs",
331330
+ "title": "setCancelAtPeriodEndResponse",
331331
+ "additionalProperties": false
331332
+ }
331333
+ },
331334
+ "parameters": {
331335
+ "x-workspace-id": {
331336
+ "in": "header",
331337
+ "type": "string",
331338
+ "description": "Workspace ID",
331339
+ "required": true
331340
+ }
331341
+ }
331342
+ },
331343
+ "getAutoRechargeSettings": {
331344
+ "name": "getAutoRechargeSettings",
331345
+ "description": "Get auto recharge settings for the authenticated workspace",
331346
+ "method": "get",
331347
+ "path": "/v2/billing/auto-recharge/settings",
331348
+ "response": {
331349
+ "description": "Auto recharge settings",
331350
+ "status": 200,
331351
+ "schema": {
331352
+ "type": "object",
331353
+ "properties": {
331354
+ "settings": {
331355
+ "type": "object",
331356
+ "properties": {
331357
+ "table_row_count": {
331358
+ "type": "object",
331359
+ "properties": {
331360
+ "enabled": {
331361
+ "type": "boolean"
331362
+ },
331363
+ "threshold": {
331364
+ "type": "number",
331365
+ "minimum": 1,
331366
+ "maximum": 100
331367
+ },
331368
+ "limit": {
331369
+ "type": "number",
331370
+ "minimum": 1
331371
+ },
331372
+ "disabledReason": {
331373
+ "type": "string"
331374
+ }
331375
+ },
331376
+ "required": [
331377
+ "enabled"
331378
+ ],
331379
+ "additionalProperties": false
331380
+ },
331381
+ "invocation_calls": {
331382
+ "type": "object",
331383
+ "properties": {
331384
+ "enabled": {
331385
+ "type": "boolean"
331386
+ },
331387
+ "threshold": {
331388
+ "type": "number",
331389
+ "minimum": 1,
331390
+ "maximum": 100
331391
+ },
331392
+ "limit": {
331393
+ "type": "number",
331394
+ "minimum": 1
331395
+ },
331396
+ "disabledReason": {
331397
+ "type": "string"
331398
+ }
331399
+ },
331400
+ "required": [
331401
+ "enabled"
331402
+ ],
331403
+ "additionalProperties": false
331404
+ },
331405
+ "knowledgebase_vector_storage": {
331406
+ "type": "object",
331407
+ "properties": {
331408
+ "enabled": {
331409
+ "type": "boolean"
331410
+ },
331411
+ "threshold": {
331412
+ "type": "number",
331413
+ "minimum": 1,
331414
+ "maximum": 100
331415
+ },
331416
+ "limit": {
331417
+ "type": "number",
331418
+ "minimum": 1
331419
+ },
331420
+ "disabledReason": {
331421
+ "type": "string"
331422
+ }
331423
+ },
331424
+ "required": [
331425
+ "enabled"
331426
+ ],
331427
+ "additionalProperties": false
331428
+ },
331429
+ "storage_count": {
331430
+ "type": "object",
331431
+ "properties": {
331432
+ "enabled": {
331433
+ "type": "boolean"
331434
+ },
331435
+ "threshold": {
331436
+ "type": "number",
331437
+ "minimum": 1,
331438
+ "maximum": 100
331439
+ },
331440
+ "limit": {
331441
+ "type": "number",
331442
+ "minimum": 1
331443
+ },
331444
+ "disabledReason": {
331445
+ "type": "string"
331446
+ }
331447
+ },
331448
+ "required": [
331449
+ "enabled"
331450
+ ],
331451
+ "additionalProperties": false
331452
+ }
331453
+ },
331454
+ "required": [
331455
+ "table_row_count",
331456
+ "invocation_calls",
331457
+ "knowledgebase_vector_storage",
331458
+ "storage_count"
331459
+ ],
331460
+ "additionalProperties": false
331461
+ }
331462
+ },
331463
+ "required": [
331464
+ "settings"
331465
+ ],
331466
+ "title": "getAutoRechargeSettingsResponse",
331467
+ "additionalProperties": false
331468
+ }
331469
+ },
331470
+ "parameters": {
331471
+ "x-workspace-id": {
331472
+ "in": "header",
331473
+ "type": "string",
331474
+ "description": "Workspace ID",
331475
+ "required": true
331476
+ }
331477
+ }
331478
+ },
331479
+ "setAutoRechargeSettings": {
331480
+ "name": "setAutoRechargeSettings",
331481
+ "description": "Set auto recharge settings for the authenticated workspace",
331482
+ "method": "put",
331483
+ "path": "/v2/billing/auto-recharge/settings",
331484
+ "requestBody": {
331485
+ "description": "Auto recharge settings (partial update)",
331486
+ "schema": {
331487
+ "type": "object",
331488
+ "properties": {
331489
+ "settings": {
331490
+ "type": "object",
331491
+ "properties": {
331492
+ "table_row_count": {
331493
+ "type": "object",
331494
+ "properties": {
331495
+ "enabled": {
331496
+ "type": "boolean"
331497
+ },
331498
+ "threshold": {
331499
+ "type": "number",
331500
+ "minimum": 1,
331501
+ "maximum": 100
331502
+ },
331503
+ "limit": {
331504
+ "type": "number",
331505
+ "minimum": 1
331506
+ },
331507
+ "disabledReason": {
331508
+ "type": "string"
331509
+ }
331510
+ },
331511
+ "required": [
331512
+ "enabled"
331513
+ ],
331514
+ "additionalProperties": false
331515
+ },
331516
+ "invocation_calls": {
331517
+ "type": "object",
331518
+ "properties": {
331519
+ "enabled": {
331520
+ "type": "boolean"
331521
+ },
331522
+ "threshold": {
331523
+ "type": "number",
331524
+ "minimum": 1,
331525
+ "maximum": 100
331526
+ },
331527
+ "limit": {
331528
+ "type": "number",
331529
+ "minimum": 1
331530
+ },
331531
+ "disabledReason": {
331532
+ "type": "string"
331533
+ }
331534
+ },
331535
+ "required": [
331536
+ "enabled"
331537
+ ],
331538
+ "additionalProperties": false
331539
+ },
331540
+ "knowledgebase_vector_storage": {
331541
+ "type": "object",
331542
+ "properties": {
331543
+ "enabled": {
331544
+ "type": "boolean"
331545
+ },
331546
+ "threshold": {
331547
+ "type": "number",
331548
+ "minimum": 1,
331549
+ "maximum": 100
331550
+ },
331551
+ "limit": {
331552
+ "type": "number",
331553
+ "minimum": 1
331554
+ },
331555
+ "disabledReason": {
331556
+ "type": "string"
331557
+ }
331558
+ },
331559
+ "required": [
331560
+ "enabled"
331561
+ ],
331562
+ "additionalProperties": false
331563
+ },
331564
+ "storage_count": {
331565
+ "type": "object",
331566
+ "properties": {
331567
+ "enabled": {
331568
+ "type": "boolean"
331569
+ },
331570
+ "threshold": {
331571
+ "type": "number",
331572
+ "minimum": 1,
331573
+ "maximum": 100
331574
+ },
331575
+ "limit": {
331576
+ "type": "number",
331577
+ "minimum": 1
331578
+ },
331579
+ "disabledReason": {
331580
+ "type": "string"
331581
+ }
331582
+ },
331583
+ "required": [
331584
+ "enabled"
331585
+ ],
331586
+ "additionalProperties": false
331587
+ }
331588
+ },
331589
+ "additionalProperties": false
331590
+ }
331591
+ },
331592
+ "required": [
331593
+ "settings"
331594
+ ],
331595
+ "title": "setAutoRechargeSettingsBody",
331596
+ "additionalProperties": false
331597
+ }
331598
+ },
331599
+ "response": {
331600
+ "description": "Updated auto recharge settings",
331601
+ "status": 200,
331602
+ "schema": {
331603
+ "type": "object",
331604
+ "properties": {
331605
+ "settings": {
331606
+ "type": "object",
331607
+ "properties": {
331608
+ "table_row_count": {
331609
+ "type": "object",
331610
+ "properties": {
331611
+ "enabled": {
331612
+ "type": "boolean"
331613
+ },
331614
+ "threshold": {
331615
+ "type": "number",
331616
+ "minimum": 1,
331617
+ "maximum": 100
331618
+ },
331619
+ "limit": {
331620
+ "type": "number",
331621
+ "minimum": 1
331622
+ },
331623
+ "disabledReason": {
331624
+ "type": "string"
331625
+ }
331626
+ },
331627
+ "required": [
331628
+ "enabled"
331629
+ ],
331630
+ "additionalProperties": false
331631
+ },
331632
+ "invocation_calls": {
331633
+ "type": "object",
331634
+ "properties": {
331635
+ "enabled": {
331636
+ "type": "boolean"
331637
+ },
331638
+ "threshold": {
331639
+ "type": "number",
331640
+ "minimum": 1,
331641
+ "maximum": 100
331642
+ },
331643
+ "limit": {
331644
+ "type": "number",
331645
+ "minimum": 1
331646
+ },
331647
+ "disabledReason": {
331648
+ "type": "string"
331649
+ }
331650
+ },
331651
+ "required": [
331652
+ "enabled"
331653
+ ],
331654
+ "additionalProperties": false
331655
+ },
331656
+ "knowledgebase_vector_storage": {
331657
+ "type": "object",
331658
+ "properties": {
331659
+ "enabled": {
331660
+ "type": "boolean"
331661
+ },
331662
+ "threshold": {
331663
+ "type": "number",
331664
+ "minimum": 1,
331665
+ "maximum": 100
331666
+ },
331667
+ "limit": {
331668
+ "type": "number",
331669
+ "minimum": 1
331670
+ },
331671
+ "disabledReason": {
331672
+ "type": "string"
331673
+ }
331674
+ },
331675
+ "required": [
331676
+ "enabled"
331677
+ ],
331678
+ "additionalProperties": false
331679
+ },
331680
+ "storage_count": {
331681
+ "type": "object",
331682
+ "properties": {
331683
+ "enabled": {
331684
+ "type": "boolean"
331685
+ },
331686
+ "threshold": {
331687
+ "type": "number",
331688
+ "minimum": 1,
331689
+ "maximum": 100
331690
+ },
331691
+ "limit": {
331692
+ "type": "number",
331693
+ "minimum": 1
331694
+ },
331695
+ "disabledReason": {
331696
+ "type": "string"
331697
+ }
331698
+ },
331699
+ "required": [
331700
+ "enabled"
331701
+ ],
331702
+ "additionalProperties": false
331703
+ }
331704
+ },
331705
+ "required": [
331706
+ "table_row_count",
331707
+ "invocation_calls",
331708
+ "knowledgebase_vector_storage",
331709
+ "storage_count"
331710
+ ],
331711
+ "additionalProperties": false
331712
+ }
331713
+ },
331714
+ "required": [
331715
+ "settings"
331716
+ ],
331717
+ "title": "setAutoRechargeSettingsResponse",
331718
+ "additionalProperties": false
331719
+ }
331720
+ },
331721
+ "parameters": {
331722
+ "x-workspace-id": {
331723
+ "in": "header",
331724
+ "type": "string",
331725
+ "description": "Workspace ID",
331726
+ "required": true
331727
+ }
331728
+ }
331729
+ },
331730
+ "getTrials": {
331731
+ "name": "getTrials",
331732
+ "description": "Get trials for the authenticated workspace",
331733
+ "method": "get",
331734
+ "path": "/v2/billing/trials",
331735
+ "response": {
331736
+ "description": "Workspace trials",
331737
+ "status": 200,
331738
+ "schema": {
331739
+ "type": "object",
331740
+ "properties": {
331741
+ "trials": {
331742
+ "type": "array",
331743
+ "items": {
331744
+ "type": "object",
331745
+ "properties": {
331746
+ "id": {
331747
+ "type": "string"
331748
+ },
331749
+ "trialPlan": {
331750
+ "type": "string"
331751
+ },
331752
+ "fromPlan": {
331753
+ "type": "string"
331754
+ },
331755
+ "endsAt": {
331756
+ "type": "string"
331757
+ },
331758
+ "isActive": {
331759
+ "type": "boolean"
331760
+ }
331761
+ },
331762
+ "required": [
331763
+ "id",
331764
+ "trialPlan",
331765
+ "fromPlan",
331766
+ "endsAt",
331767
+ "isActive"
331768
+ ]
331769
+ }
331770
+ }
331771
+ },
331772
+ "required": [
331773
+ "trials"
331774
+ ],
331775
+ "title": "getTrialsResponse",
331776
+ "additionalProperties": false
331777
+ }
331778
+ },
331779
+ "parameters": {
331780
+ "x-workspace-id": {
331781
+ "in": "header",
331782
+ "type": "string",
331783
+ "description": "Workspace ID",
331784
+ "required": true
331785
+ }
331786
+ }
331787
+ },
331788
+ "createTrial": {
331789
+ "name": "createTrial",
331790
+ "description": "Create a trial for the authenticated workspace",
331791
+ "method": "post",
331792
+ "path": "/v2/billing/trials",
331793
+ "requestBody": {
331794
+ "description": "Trial parameters",
331795
+ "schema": {
331796
+ "type": "object",
331797
+ "properties": {
331798
+ "lengthInDays": {
331799
+ "type": "integer",
331800
+ "minimum": 0,
331801
+ "exclusiveMinimum": true
331802
+ },
331803
+ "plan": {
331804
+ "type": "string"
331805
+ }
331806
+ },
331807
+ "required": [
331808
+ "lengthInDays",
331809
+ "plan"
331810
+ ],
331811
+ "title": "createTrialBody",
331812
+ "additionalProperties": false
331813
+ }
331814
+ },
331815
+ "response": {
331816
+ "description": "Created trial",
331817
+ "status": 200,
331818
+ "schema": {
331819
+ "type": "object",
331820
+ "properties": {
331821
+ "id": {
331822
+ "type": "string"
331823
+ },
331824
+ "trialPlan": {
331825
+ "type": "string"
331826
+ },
331827
+ "fromPlan": {
331828
+ "type": "string"
331829
+ },
331830
+ "endsAt": {
331831
+ "type": "string"
331832
+ },
331833
+ "isActive": {
331834
+ "type": "boolean"
331835
+ }
331836
+ },
331837
+ "required": [
331838
+ "id",
331839
+ "trialPlan",
331840
+ "fromPlan",
331841
+ "endsAt",
331842
+ "isActive"
331843
+ ],
331844
+ "title": "createTrialResponse",
331845
+ "additionalProperties": false
331846
+ }
331847
+ },
331848
+ "parameters": {
331849
+ "x-workspace-id": {
331850
+ "in": "header",
331851
+ "type": "string",
331852
+ "description": "Workspace ID",
331853
+ "required": true
331854
+ }
331855
+ }
331856
+ },
331857
+ "removeTrial": {
331858
+ "name": "removeTrial",
331859
+ "description": "Remove the active trial for the authenticated workspace",
331860
+ "method": "delete",
331861
+ "path": "/v2/billing/trials",
331862
+ "response": {
331863
+ "description": "Trial removed",
331864
+ "status": 200,
331865
+ "schema": {
331866
+ "type": "object",
331867
+ "title": "removeTrialResponse",
331868
+ "additionalProperties": false
331869
+ }
331870
+ },
331871
+ "parameters": {
331872
+ "x-workspace-id": {
331873
+ "in": "header",
331874
+ "type": "string",
331875
+ "description": "Workspace ID",
331876
+ "required": true
331877
+ }
331878
+ }
331879
+ },
331222
331880
  "listInvoices": {
331223
331881
  "name": "listInvoices",
331224
331882
  "description": "List invoices for the authenticated workspace",
@@ -331630,7 +332288,7 @@ var state6 = {
331630
332288
  "title": "Botpress Billing Public API",
331631
332289
  "description": "API for Botpress Billing",
331632
332290
  "server": "https://api.botpress.cloud",
331633
- "version": "1.72.1",
332291
+ "version": "1.72.2",
331634
332292
  "prefix": "v2"
331635
332293
  },
331636
332294
  "defaultParameters": {
@@ -331776,24 +332434,35 @@ var state6 = {
331776
332434
  "refs": {
331777
332435
  "parameters": {},
331778
332436
  "requestBodies": {
332437
+ "setBillingAddressBody": true,
331779
332438
  "previewSubscriptionUpdateBody": true,
331780
332439
  "setPlanBody": true,
331781
332440
  "setAddonsBody": true,
332441
+ "setCancelAtPeriodEndBody": true,
332442
+ "setAutoRechargeSettingsBody": true,
332443
+ "createTrialBody": true,
331782
332444
  "payInvoiceBody": true,
331783
332445
  "setPaymentMethodBody": true,
331784
332446
  "createPaymentMethodIntentBody": true
331785
332447
  },
331786
332448
  "responses": {
331787
332449
  "getBillingReadonlyResponse": true,
332450
+ "getBillingAddressResponse": true,
332451
+ "setBillingAddressResponse": true,
331788
332452
  "getPlanResponse": true,
331789
332453
  "listPlansResponse": true,
331790
332454
  "getAddonResponse": true,
331791
332455
  "listAddonsResponse": true,
331792
- "getCurrentSubscriptionResponse": true,
331793
- "getNextSubscriptionResponse": true,
332456
+ "getSubscriptionResponse": true,
331794
332457
  "previewSubscriptionUpdateResponse": true,
331795
332458
  "setPlanResponse": true,
331796
332459
  "setAddonsResponse": true,
332460
+ "setCancelAtPeriodEndResponse": true,
332461
+ "getAutoRechargeSettingsResponse": true,
332462
+ "setAutoRechargeSettingsResponse": true,
332463
+ "getTrialsResponse": true,
332464
+ "createTrialResponse": true,
332465
+ "removeTrialResponse": true,
331797
332466
  "listInvoicesResponse": true,
331798
332467
  "payInvoiceResponse": true,
331799
332468
  "getPaymentMethodResponse": true,
@@ -331808,7 +332477,14 @@ var state6 = {
331808
332477
  "SubscriptionUpdateParams": true,
331809
332478
  "SubscriptionDetails": true,
331810
332479
  "SetPlanParams": true,
331811
- "SetAddonsParams": true
332480
+ "SetAddonsParams": true,
332481
+ "SetCancelAtPeriodEndParams": true,
332482
+ "BillingAddress": true,
332483
+ "Trial": true,
332484
+ "GetTrialsResponse": true,
332485
+ "CreateTrialParams": true,
332486
+ "GetAutoRechargeSettingsResponse": true,
332487
+ "SetAutoRechargeSettingsParams": true
331812
332488
  }
331813
332489
  },
331814
332490
  "schemas": {
@@ -332413,6 +333089,376 @@ var state6 = {
332413
333089
  "description": "Addons update parameters. Set quantity to 0 to remove an addon.",
332414
333090
  "additionalProperties": false
332415
333091
  }
333092
+ },
333093
+ "SetCancelAtPeriodEndParams": {
333094
+ "section": "subscription",
333095
+ "schema": {
333096
+ "type": "object",
333097
+ "properties": {
333098
+ "cancelAtPeriodEnd": {
333099
+ "type": "boolean"
333100
+ }
333101
+ },
333102
+ "required": [
333103
+ "cancelAtPeriodEnd"
333104
+ ],
333105
+ "additionalProperties": false
333106
+ }
333107
+ },
333108
+ "BillingAddress": {
333109
+ "section": "subscription",
333110
+ "schema": {
333111
+ "type": "object",
333112
+ "properties": {
333113
+ "lineOne": {
333114
+ "type": "string"
333115
+ },
333116
+ "lineTwo": {
333117
+ "type": "string"
333118
+ },
333119
+ "city": {
333120
+ "type": "string"
333121
+ },
333122
+ "state": {
333123
+ "type": "string"
333124
+ },
333125
+ "postalCode": {
333126
+ "type": "string"
333127
+ },
333128
+ "country": {
333129
+ "type": "string"
333130
+ }
333131
+ },
333132
+ "additionalProperties": false
333133
+ }
333134
+ },
333135
+ "Trial": {
333136
+ "section": "subscription",
333137
+ "schema": {
333138
+ "type": "object",
333139
+ "properties": {
333140
+ "id": {
333141
+ "type": "string"
333142
+ },
333143
+ "trialPlan": {
333144
+ "type": "string"
333145
+ },
333146
+ "fromPlan": {
333147
+ "type": "string"
333148
+ },
333149
+ "endsAt": {
333150
+ "type": "string"
333151
+ },
333152
+ "isActive": {
333153
+ "type": "boolean"
333154
+ }
333155
+ },
333156
+ "required": [
333157
+ "id",
333158
+ "trialPlan",
333159
+ "fromPlan",
333160
+ "endsAt",
333161
+ "isActive"
333162
+ ],
333163
+ "additionalProperties": false
333164
+ }
333165
+ },
333166
+ "GetTrialsResponse": {
333167
+ "section": "subscription",
333168
+ "schema": {
333169
+ "type": "object",
333170
+ "properties": {
333171
+ "trials": {
333172
+ "type": "array",
333173
+ "items": {
333174
+ "type": "object",
333175
+ "properties": {
333176
+ "id": {
333177
+ "type": "string"
333178
+ },
333179
+ "trialPlan": {
333180
+ "type": "string"
333181
+ },
333182
+ "fromPlan": {
333183
+ "type": "string"
333184
+ },
333185
+ "endsAt": {
333186
+ "type": "string"
333187
+ },
333188
+ "isActive": {
333189
+ "type": "boolean"
333190
+ }
333191
+ },
333192
+ "required": [
333193
+ "id",
333194
+ "trialPlan",
333195
+ "fromPlan",
333196
+ "endsAt",
333197
+ "isActive"
333198
+ ]
333199
+ }
333200
+ }
333201
+ },
333202
+ "required": [
333203
+ "trials"
333204
+ ],
333205
+ "additionalProperties": false
333206
+ }
333207
+ },
333208
+ "CreateTrialParams": {
333209
+ "section": "subscription",
333210
+ "schema": {
333211
+ "type": "object",
333212
+ "properties": {
333213
+ "lengthInDays": {
333214
+ "type": "integer",
333215
+ "minimum": 0,
333216
+ "exclusiveMinimum": true
333217
+ },
333218
+ "plan": {
333219
+ "type": "string"
333220
+ }
333221
+ },
333222
+ "required": [
333223
+ "lengthInDays",
333224
+ "plan"
333225
+ ],
333226
+ "additionalProperties": false
333227
+ }
333228
+ },
333229
+ "GetAutoRechargeSettingsResponse": {
333230
+ "section": "subscription",
333231
+ "schema": {
333232
+ "type": "object",
333233
+ "properties": {
333234
+ "settings": {
333235
+ "type": "object",
333236
+ "properties": {
333237
+ "table_row_count": {
333238
+ "type": "object",
333239
+ "properties": {
333240
+ "enabled": {
333241
+ "type": "boolean"
333242
+ },
333243
+ "threshold": {
333244
+ "type": "number",
333245
+ "minimum": 1,
333246
+ "maximum": 100
333247
+ },
333248
+ "limit": {
333249
+ "type": "number",
333250
+ "minimum": 1
333251
+ },
333252
+ "disabledReason": {
333253
+ "type": "string"
333254
+ }
333255
+ },
333256
+ "required": [
333257
+ "enabled"
333258
+ ],
333259
+ "additionalProperties": false
333260
+ },
333261
+ "invocation_calls": {
333262
+ "type": "object",
333263
+ "properties": {
333264
+ "enabled": {
333265
+ "type": "boolean"
333266
+ },
333267
+ "threshold": {
333268
+ "type": "number",
333269
+ "minimum": 1,
333270
+ "maximum": 100
333271
+ },
333272
+ "limit": {
333273
+ "type": "number",
333274
+ "minimum": 1
333275
+ },
333276
+ "disabledReason": {
333277
+ "type": "string"
333278
+ }
333279
+ },
333280
+ "required": [
333281
+ "enabled"
333282
+ ],
333283
+ "additionalProperties": false
333284
+ },
333285
+ "knowledgebase_vector_storage": {
333286
+ "type": "object",
333287
+ "properties": {
333288
+ "enabled": {
333289
+ "type": "boolean"
333290
+ },
333291
+ "threshold": {
333292
+ "type": "number",
333293
+ "minimum": 1,
333294
+ "maximum": 100
333295
+ },
333296
+ "limit": {
333297
+ "type": "number",
333298
+ "minimum": 1
333299
+ },
333300
+ "disabledReason": {
333301
+ "type": "string"
333302
+ }
333303
+ },
333304
+ "required": [
333305
+ "enabled"
333306
+ ],
333307
+ "additionalProperties": false
333308
+ },
333309
+ "storage_count": {
333310
+ "type": "object",
333311
+ "properties": {
333312
+ "enabled": {
333313
+ "type": "boolean"
333314
+ },
333315
+ "threshold": {
333316
+ "type": "number",
333317
+ "minimum": 1,
333318
+ "maximum": 100
333319
+ },
333320
+ "limit": {
333321
+ "type": "number",
333322
+ "minimum": 1
333323
+ },
333324
+ "disabledReason": {
333325
+ "type": "string"
333326
+ }
333327
+ },
333328
+ "required": [
333329
+ "enabled"
333330
+ ],
333331
+ "additionalProperties": false
333332
+ }
333333
+ },
333334
+ "required": [
333335
+ "table_row_count",
333336
+ "invocation_calls",
333337
+ "knowledgebase_vector_storage",
333338
+ "storage_count"
333339
+ ],
333340
+ "additionalProperties": false
333341
+ }
333342
+ },
333343
+ "required": [
333344
+ "settings"
333345
+ ],
333346
+ "additionalProperties": false
333347
+ }
333348
+ },
333349
+ "SetAutoRechargeSettingsParams": {
333350
+ "section": "subscription",
333351
+ "schema": {
333352
+ "type": "object",
333353
+ "properties": {
333354
+ "settings": {
333355
+ "type": "object",
333356
+ "properties": {
333357
+ "table_row_count": {
333358
+ "type": "object",
333359
+ "properties": {
333360
+ "enabled": {
333361
+ "type": "boolean"
333362
+ },
333363
+ "threshold": {
333364
+ "type": "number",
333365
+ "minimum": 1,
333366
+ "maximum": 100
333367
+ },
333368
+ "limit": {
333369
+ "type": "number",
333370
+ "minimum": 1
333371
+ },
333372
+ "disabledReason": {
333373
+ "type": "string"
333374
+ }
333375
+ },
333376
+ "required": [
333377
+ "enabled"
333378
+ ],
333379
+ "additionalProperties": false
333380
+ },
333381
+ "invocation_calls": {
333382
+ "type": "object",
333383
+ "properties": {
333384
+ "enabled": {
333385
+ "type": "boolean"
333386
+ },
333387
+ "threshold": {
333388
+ "type": "number",
333389
+ "minimum": 1,
333390
+ "maximum": 100
333391
+ },
333392
+ "limit": {
333393
+ "type": "number",
333394
+ "minimum": 1
333395
+ },
333396
+ "disabledReason": {
333397
+ "type": "string"
333398
+ }
333399
+ },
333400
+ "required": [
333401
+ "enabled"
333402
+ ],
333403
+ "additionalProperties": false
333404
+ },
333405
+ "knowledgebase_vector_storage": {
333406
+ "type": "object",
333407
+ "properties": {
333408
+ "enabled": {
333409
+ "type": "boolean"
333410
+ },
333411
+ "threshold": {
333412
+ "type": "number",
333413
+ "minimum": 1,
333414
+ "maximum": 100
333415
+ },
333416
+ "limit": {
333417
+ "type": "number",
333418
+ "minimum": 1
333419
+ },
333420
+ "disabledReason": {
333421
+ "type": "string"
333422
+ }
333423
+ },
333424
+ "required": [
333425
+ "enabled"
333426
+ ],
333427
+ "additionalProperties": false
333428
+ },
333429
+ "storage_count": {
333430
+ "type": "object",
333431
+ "properties": {
333432
+ "enabled": {
333433
+ "type": "boolean"
333434
+ },
333435
+ "threshold": {
333436
+ "type": "number",
333437
+ "minimum": 1,
333438
+ "maximum": 100
333439
+ },
333440
+ "limit": {
333441
+ "type": "number",
333442
+ "minimum": 1
333443
+ },
333444
+ "disabledReason": {
333445
+ "type": "string"
333446
+ }
333447
+ },
333448
+ "required": [
333449
+ "enabled"
333450
+ ],
333451
+ "additionalProperties": false
333452
+ }
333453
+ },
333454
+ "additionalProperties": false
333455
+ }
333456
+ },
333457
+ "required": [
333458
+ "settings"
333459
+ ],
333460
+ "additionalProperties": false
333461
+ }
332416
333462
  }
332417
333463
  },
332418
333464
  "sections": [