@botpress/api 1.72.0 → 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.
Files changed (3) hide show
  1. package/dist/index.js +1241 -187
  2. package/dist/src/gen/billing/state.d.ts +1105 -161
  3. package/package.json +2 -2
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.0",
279448
+ "version": "1.72.2",
279449
279449
  "prefix": "v1"
279450
279450
  },
279451
279451
  "defaultParameters": {
@@ -289557,6 +289557,8 @@ var state2 = {
289557
289557
  "SET_SPENDING_LIMIT",
289558
289558
  "SET_AI_SPENDING_LIMIT",
289559
289559
  "UPDATE_WORKSPACE_BILLING_READONLY",
289560
+ "UPDATE_WORKSPACE_PLAN_READONLY",
289561
+ "UPDATE_WORKSPACE_ADDONS_READONLY",
289560
289562
  "EXECUTE_AUTO_RECHARGE_SUCCESS",
289561
289563
  "EXECUTE_AUTO_RECHARGE_FAILED"
289562
289564
  ]
@@ -295992,7 +295994,7 @@ var state2 = {
295992
295994
  "title": "Botpress Admin API",
295993
295995
  "description": "API for Botpress Cloud Manager",
295994
295996
  "server": "https://api.botpress.cloud",
295995
- "version": "1.72.0",
295997
+ "version": "1.72.2",
295996
295998
  "prefix": "v1"
295997
295999
  },
295998
296000
  "defaultParameters": {
@@ -301513,7 +301515,7 @@ var state3 = {
301513
301515
  "title": "Botpress Files API",
301514
301516
  "description": "API for Botpress Files",
301515
301517
  "server": "https://api.botpress.cloud",
301516
- "version": "1.72.0",
301518
+ "version": "1.72.2",
301517
301519
  "prefix": "v1"
301518
301520
  },
301519
301521
  "defaultParameters": {
@@ -303809,7 +303811,7 @@ var state4 = {
303809
303811
  "title": "Botpress Tables API",
303810
303812
  "description": "API for Botpress Tables",
303811
303813
  "server": "https://api.botpress.cloud",
303812
- "version": "1.72.0",
303814
+ "version": "1.72.2",
303813
303815
  "prefix": "v1"
303814
303816
  },
303815
303817
  "defaultParameters": {
@@ -316224,6 +316226,8 @@ var state5 = {
316224
316226
  "SET_SPENDING_LIMIT",
316225
316227
  "SET_AI_SPENDING_LIMIT",
316226
316228
  "UPDATE_WORKSPACE_BILLING_READONLY",
316229
+ "UPDATE_WORKSPACE_PLAN_READONLY",
316230
+ "UPDATE_WORKSPACE_ADDONS_READONLY",
316227
316231
  "EXECUTE_AUTO_RECHARGE_SUCCESS",
316228
316232
  "EXECUTE_AUTO_RECHARGE_FAILED"
316229
316233
  ]
@@ -325380,7 +325384,7 @@ var state5 = {
325380
325384
  "title": "Botpress API",
325381
325385
  "description": "API for Botpress Cloud",
325382
325386
  "server": "https://api.botpress.cloud",
325383
- "version": "1.72.0",
325387
+ "version": "1.72.2",
325384
325388
  "prefix": "v1"
325385
325389
  },
325386
325390
  "errors": [
@@ -329839,21 +329843,25 @@ var state6 = {
329839
329843
  "operations": {
329840
329844
  "getBillingReadonly": {
329841
329845
  "name": "getBillingReadonly",
329842
- "description": "Get whether billing is readonly for the authenticated workspace",
329846
+ "description": "Get whether plan and addons are readonly for the authenticated workspace",
329843
329847
  "method": "get",
329844
329848
  "path": "/v2/billing/readonly",
329845
329849
  "response": {
329846
- "description": "Whether billing is readonly for this workspace",
329850
+ "description": "Whether plan and addons are readonly for this workspace",
329847
329851
  "status": 200,
329848
329852
  "schema": {
329849
329853
  "type": "object",
329850
329854
  "properties": {
329851
- "billingReadonly": {
329855
+ "planReadonly": {
329856
+ "type": "boolean"
329857
+ },
329858
+ "addonsReadonly": {
329852
329859
  "type": "boolean"
329853
329860
  }
329854
329861
  },
329855
329862
  "required": [
329856
- "billingReadonly"
329863
+ "planReadonly",
329864
+ "addonsReadonly"
329857
329865
  ],
329858
329866
  "title": "getBillingReadonlyResponse",
329859
329867
  "additionalProperties": false
@@ -329868,6 +329876,110 @@ var state6 = {
329868
329876
  }
329869
329877
  }
329870
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
+ },
329871
329983
  "getPlan": {
329872
329984
  "name": "getPlan",
329873
329985
  "description": "Get plan details",
@@ -330193,13 +330305,13 @@ var state6 = {
330193
330305
  },
330194
330306
  "parameters": {}
330195
330307
  },
330196
- "getCurrentSubscription": {
330197
- "name": "getCurrentSubscription",
330198
- "description": "Get current subscription for a workspace",
330308
+ "getSubscription": {
330309
+ "name": "getSubscription",
330310
+ "description": "Get subscription for a workspace",
330199
330311
  "method": "get",
330200
- "path": "/v2/billing/subscriptions/current",
330312
+ "path": "/v2/billing/subscriptions",
330201
330313
  "response": {
330202
- "description": "Current subscription details",
330314
+ "description": "Subscription details",
330203
330315
  "status": 200,
330204
330316
  "schema": {
330205
330317
  "type": "object",
@@ -330348,175 +330460,7 @@ var state6 = {
330348
330460
  "plan",
330349
330461
  "addons"
330350
330462
  ],
330351
- "title": "getCurrentSubscriptionResponse",
330352
- "additionalProperties": false
330353
- }
330354
- },
330355
- "parameters": {
330356
- "x-workspace-id": {
330357
- "in": "header",
330358
- "type": "string",
330359
- "description": "Workspace ID",
330360
- "required": true
330361
- }
330362
- }
330363
- },
330364
- "getNextSubscription": {
330365
- "name": "getNextSubscription",
330366
- "description": "Get next subscription details for a workspace",
330367
- "method": "get",
330368
- "path": "/v2/billing/subscriptions/next",
330369
- "response": {
330370
- "description": "Next subscription details",
330371
- "status": 200,
330372
- "schema": {
330373
- "type": "object",
330374
- "properties": {
330375
- "plan": {
330376
- "type": "object",
330377
- "properties": {
330378
- "current": {
330379
- "type": "object",
330380
- "properties": {
330381
- "status": {
330382
- "type": "string",
330383
- "enum": [
330384
- "active",
330385
- "canceled",
330386
- "past_due",
330387
- "action_required",
330388
- "grace_period"
330389
- ]
330390
- },
330391
- "planId": {
330392
- "type": "string"
330393
- },
330394
- "interval": {
330395
- "type": "string",
330396
- "enum": [
330397
- "month",
330398
- "year"
330399
- ]
330400
- },
330401
- "price": {
330402
- "type": "number"
330403
- },
330404
- "proratedPrice": {
330405
- "type": "number"
330406
- },
330407
- "cancelAtPeriodEnd": {
330408
- "type": "boolean"
330409
- },
330410
- "periodEnd": {
330411
- "type": "string"
330412
- }
330413
- },
330414
- "required": [
330415
- "status",
330416
- "planId",
330417
- "interval",
330418
- "price",
330419
- "cancelAtPeriodEnd",
330420
- "periodEnd"
330421
- ],
330422
- "additionalProperties": false
330423
- },
330424
- "next": {
330425
- "type": "object",
330426
- "properties": {
330427
- "planId": {
330428
- "type": "string"
330429
- },
330430
- "interval": {
330431
- "type": "string",
330432
- "enum": [
330433
- "month",
330434
- "year"
330435
- ]
330436
- },
330437
- "price": {
330438
- "type": "number",
330439
- "nullable": true
330440
- },
330441
- "effectiveDate": {
330442
- "type": "string"
330443
- }
330444
- },
330445
- "required": [
330446
- "planId",
330447
- "interval",
330448
- "price",
330449
- "effectiveDate"
330450
- ],
330451
- "nullable": true,
330452
- "additionalProperties": false
330453
- }
330454
- },
330455
- "required": [
330456
- "current",
330457
- "next"
330458
- ],
330459
- "additionalProperties": false
330460
- },
330461
- "addons": {
330462
- "type": "object",
330463
- "additionalProperties": {
330464
- "type": "object",
330465
- "properties": {
330466
- "current": {
330467
- "type": "object",
330468
- "properties": {
330469
- "quantity": {
330470
- "type": "number"
330471
- },
330472
- "price": {
330473
- "type": "number"
330474
- },
330475
- "proratedPrice": {
330476
- "type": "number"
330477
- }
330478
- },
330479
- "required": [
330480
- "quantity",
330481
- "price"
330482
- ],
330483
- "additionalProperties": false
330484
- },
330485
- "next": {
330486
- "type": "object",
330487
- "properties": {
330488
- "quantity": {
330489
- "type": "number"
330490
- },
330491
- "price": {
330492
- "type": "number"
330493
- },
330494
- "effectiveDate": {
330495
- "type": "string"
330496
- }
330497
- },
330498
- "required": [
330499
- "quantity",
330500
- "price",
330501
- "effectiveDate"
330502
- ],
330503
- "nullable": true,
330504
- "additionalProperties": false
330505
- }
330506
- },
330507
- "required": [
330508
- "current",
330509
- "next"
330510
- ],
330511
- "additionalProperties": false
330512
- }
330513
- }
330514
- },
330515
- "required": [
330516
- "plan",
330517
- "addons"
330518
- ],
330519
- "title": "getNextSubscriptionResponse",
330463
+ "title": "getSubscriptionResponse",
330520
330464
  "additionalProperties": false
330521
330465
  }
330522
330466
  },
@@ -331211,6 +331155,728 @@ var state6 = {
331211
331155
  }
331212
331156
  }
331213
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
+ },
331214
331880
  "listInvoices": {
331215
331881
  "name": "listInvoices",
331216
331882
  "description": "List invoices for the authenticated workspace",
@@ -331622,7 +332288,7 @@ var state6 = {
331622
332288
  "title": "Botpress Billing Public API",
331623
332289
  "description": "API for Botpress Billing",
331624
332290
  "server": "https://api.botpress.cloud",
331625
- "version": "1.72.0",
332291
+ "version": "1.72.2",
331626
332292
  "prefix": "v2"
331627
332293
  },
331628
332294
  "defaultParameters": {
@@ -331768,24 +332434,35 @@ var state6 = {
331768
332434
  "refs": {
331769
332435
  "parameters": {},
331770
332436
  "requestBodies": {
332437
+ "setBillingAddressBody": true,
331771
332438
  "previewSubscriptionUpdateBody": true,
331772
332439
  "setPlanBody": true,
331773
332440
  "setAddonsBody": true,
332441
+ "setCancelAtPeriodEndBody": true,
332442
+ "setAutoRechargeSettingsBody": true,
332443
+ "createTrialBody": true,
331774
332444
  "payInvoiceBody": true,
331775
332445
  "setPaymentMethodBody": true,
331776
332446
  "createPaymentMethodIntentBody": true
331777
332447
  },
331778
332448
  "responses": {
331779
332449
  "getBillingReadonlyResponse": true,
332450
+ "getBillingAddressResponse": true,
332451
+ "setBillingAddressResponse": true,
331780
332452
  "getPlanResponse": true,
331781
332453
  "listPlansResponse": true,
331782
332454
  "getAddonResponse": true,
331783
332455
  "listAddonsResponse": true,
331784
- "getCurrentSubscriptionResponse": true,
331785
- "getNextSubscriptionResponse": true,
332456
+ "getSubscriptionResponse": true,
331786
332457
  "previewSubscriptionUpdateResponse": true,
331787
332458
  "setPlanResponse": true,
331788
332459
  "setAddonsResponse": true,
332460
+ "setCancelAtPeriodEndResponse": true,
332461
+ "getAutoRechargeSettingsResponse": true,
332462
+ "setAutoRechargeSettingsResponse": true,
332463
+ "getTrialsResponse": true,
332464
+ "createTrialResponse": true,
332465
+ "removeTrialResponse": true,
331789
332466
  "listInvoicesResponse": true,
331790
332467
  "payInvoiceResponse": true,
331791
332468
  "getPaymentMethodResponse": true,
@@ -331800,7 +332477,14 @@ var state6 = {
331800
332477
  "SubscriptionUpdateParams": true,
331801
332478
  "SubscriptionDetails": true,
331802
332479
  "SetPlanParams": true,
331803
- "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
331804
332488
  }
331805
332489
  },
331806
332490
  "schemas": {
@@ -332405,6 +333089,376 @@ var state6 = {
332405
333089
  "description": "Addons update parameters. Set quantity to 0 to remove an addon.",
332406
333090
  "additionalProperties": false
332407
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
+ }
332408
333462
  }
332409
333463
  },
332410
333464
  "sections": [