@botpress/api 1.72.1 → 1.73.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 +1311 -183
- package/dist/src/gen/billing/state.d.ts +1103 -162
- package/dist/src/gen/runtime/state.d.ts +41 -0
- package/dist/src/gen/state.d.ts +41 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -276951,6 +276951,14 @@ var state = {
|
|
|
276951
276951
|
"maxLength": 4e4,
|
|
276952
276952
|
"description": "URI of the user picture"
|
|
276953
276953
|
},
|
|
276954
|
+
"attributes": {
|
|
276955
|
+
"type": "object",
|
|
276956
|
+
"additionalProperties": {
|
|
276957
|
+
"type": "string",
|
|
276958
|
+
"maxLength": 200
|
|
276959
|
+
},
|
|
276960
|
+
"description": "Optional attributes"
|
|
276961
|
+
},
|
|
276954
276962
|
"discriminateByTags": {
|
|
276955
276963
|
"type": "array",
|
|
276956
276964
|
"items": {
|
|
@@ -277241,6 +277249,14 @@ var state = {
|
|
|
277241
277249
|
"type": "string",
|
|
277242
277250
|
"maxLength": 4e4,
|
|
277243
277251
|
"description": "URI of the user picture"
|
|
277252
|
+
},
|
|
277253
|
+
"attributes": {
|
|
277254
|
+
"type": "object",
|
|
277255
|
+
"additionalProperties": {
|
|
277256
|
+
"type": "string",
|
|
277257
|
+
"maxLength": 200
|
|
277258
|
+
},
|
|
277259
|
+
"description": "Optional attributes"
|
|
277244
277260
|
}
|
|
277245
277261
|
},
|
|
277246
277262
|
"required": [
|
|
@@ -277495,6 +277511,14 @@ var state = {
|
|
|
277495
277511
|
"maxLength": 4e4,
|
|
277496
277512
|
"description": "URI of the user picture"
|
|
277497
277513
|
},
|
|
277514
|
+
"attributes": {
|
|
277515
|
+
"type": "object",
|
|
277516
|
+
"additionalProperties": {
|
|
277517
|
+
"type": "string",
|
|
277518
|
+
"maxLength": 200
|
|
277519
|
+
},
|
|
277520
|
+
"description": "Optional attributes"
|
|
277521
|
+
},
|
|
277498
277522
|
"discriminateByTags": {
|
|
277499
277523
|
"type": "array",
|
|
277500
277524
|
"items": {
|
|
@@ -277606,6 +277630,15 @@ var state = {
|
|
|
277606
277630
|
"maxLength": 4e4,
|
|
277607
277631
|
"nullable": true,
|
|
277608
277632
|
"description": "URI of the user picture"
|
|
277633
|
+
},
|
|
277634
|
+
"attributes": {
|
|
277635
|
+
"type": "object",
|
|
277636
|
+
"additionalProperties": {
|
|
277637
|
+
"type": "string",
|
|
277638
|
+
"maxLength": 200,
|
|
277639
|
+
"nullable": true
|
|
277640
|
+
},
|
|
277641
|
+
"description": "Optional attributes. Set attributes to null to remove them"
|
|
277609
277642
|
}
|
|
277610
277643
|
},
|
|
277611
277644
|
"title": "updateUserBody",
|
|
@@ -279445,7 +279478,7 @@ var state = {
|
|
|
279445
279478
|
"title": "Botpress Runtime API",
|
|
279446
279479
|
"description": "API for Botpress Runtime",
|
|
279447
279480
|
"server": "https://api.botpress.cloud",
|
|
279448
|
-
"version": "1.
|
|
279481
|
+
"version": "1.73.0",
|
|
279449
279482
|
"prefix": "v1"
|
|
279450
279483
|
},
|
|
279451
279484
|
"defaultParameters": {
|
|
@@ -279729,6 +279762,14 @@ var state = {
|
|
|
279729
279762
|
"type": "string",
|
|
279730
279763
|
"maxLength": 4e4,
|
|
279731
279764
|
"description": "Picture URL of the [User](#schema_user)"
|
|
279765
|
+
},
|
|
279766
|
+
"attributes": {
|
|
279767
|
+
"type": "object",
|
|
279768
|
+
"additionalProperties": {
|
|
279769
|
+
"type": "string",
|
|
279770
|
+
"maxLength": 200
|
|
279771
|
+
},
|
|
279772
|
+
"description": "Optional attributes"
|
|
279732
279773
|
}
|
|
279733
279774
|
},
|
|
279734
279775
|
"required": [
|
|
@@ -295994,7 +296035,7 @@ var state2 = {
|
|
|
295994
296035
|
"title": "Botpress Admin API",
|
|
295995
296036
|
"description": "API for Botpress Cloud Manager",
|
|
295996
296037
|
"server": "https://api.botpress.cloud",
|
|
295997
|
-
"version": "1.
|
|
296038
|
+
"version": "1.73.0",
|
|
295998
296039
|
"prefix": "v1"
|
|
295999
296040
|
},
|
|
296000
296041
|
"defaultParameters": {
|
|
@@ -301515,7 +301556,7 @@ var state3 = {
|
|
|
301515
301556
|
"title": "Botpress Files API",
|
|
301516
301557
|
"description": "API for Botpress Files",
|
|
301517
301558
|
"server": "https://api.botpress.cloud",
|
|
301518
|
-
"version": "1.
|
|
301559
|
+
"version": "1.73.0",
|
|
301519
301560
|
"prefix": "v1"
|
|
301520
301561
|
},
|
|
301521
301562
|
"defaultParameters": {
|
|
@@ -303811,7 +303852,7 @@ var state4 = {
|
|
|
303811
303852
|
"title": "Botpress Tables API",
|
|
303812
303853
|
"description": "API for Botpress Tables",
|
|
303813
303854
|
"server": "https://api.botpress.cloud",
|
|
303814
|
-
"version": "1.
|
|
303855
|
+
"version": "1.73.0",
|
|
303815
303856
|
"prefix": "v1"
|
|
303816
303857
|
},
|
|
303817
303858
|
"defaultParameters": {
|
|
@@ -305677,6 +305718,14 @@ var state5 = {
|
|
|
305677
305718
|
"maxLength": 4e4,
|
|
305678
305719
|
"description": "URI of the user picture"
|
|
305679
305720
|
},
|
|
305721
|
+
"attributes": {
|
|
305722
|
+
"type": "object",
|
|
305723
|
+
"additionalProperties": {
|
|
305724
|
+
"type": "string",
|
|
305725
|
+
"maxLength": 200
|
|
305726
|
+
},
|
|
305727
|
+
"description": "Optional attributes"
|
|
305728
|
+
},
|
|
305680
305729
|
"discriminateByTags": {
|
|
305681
305730
|
"type": "array",
|
|
305682
305731
|
"items": {
|
|
@@ -305948,6 +305997,14 @@ var state5 = {
|
|
|
305948
305997
|
"type": "string",
|
|
305949
305998
|
"maxLength": 4e4,
|
|
305950
305999
|
"description": "URI of the user picture"
|
|
306000
|
+
},
|
|
306001
|
+
"attributes": {
|
|
306002
|
+
"type": "object",
|
|
306003
|
+
"additionalProperties": {
|
|
306004
|
+
"type": "string",
|
|
306005
|
+
"maxLength": 200
|
|
306006
|
+
},
|
|
306007
|
+
"description": "Optional attributes"
|
|
305951
306008
|
}
|
|
305952
306009
|
},
|
|
305953
306010
|
"required": [
|
|
@@ -306147,6 +306204,14 @@ var state5 = {
|
|
|
306147
306204
|
"maxLength": 4e4,
|
|
306148
306205
|
"description": "URI of the user picture"
|
|
306149
306206
|
},
|
|
306207
|
+
"attributes": {
|
|
306208
|
+
"type": "object",
|
|
306209
|
+
"additionalProperties": {
|
|
306210
|
+
"type": "string",
|
|
306211
|
+
"maxLength": 200
|
|
306212
|
+
},
|
|
306213
|
+
"description": "Optional attributes"
|
|
306214
|
+
},
|
|
306150
306215
|
"discriminateByTags": {
|
|
306151
306216
|
"type": "array",
|
|
306152
306217
|
"items": {
|
|
@@ -306221,6 +306286,15 @@ var state5 = {
|
|
|
306221
306286
|
"maxLength": 4e4,
|
|
306222
306287
|
"nullable": true,
|
|
306223
306288
|
"description": "URI of the user picture"
|
|
306289
|
+
},
|
|
306290
|
+
"attributes": {
|
|
306291
|
+
"type": "object",
|
|
306292
|
+
"additionalProperties": {
|
|
306293
|
+
"type": "string",
|
|
306294
|
+
"maxLength": 200,
|
|
306295
|
+
"nullable": true
|
|
306296
|
+
},
|
|
306297
|
+
"description": "Optional attributes. Set attributes to null to remove them"
|
|
306224
306298
|
}
|
|
306225
306299
|
},
|
|
306226
306300
|
"title": "updateUserBody",
|
|
@@ -325384,7 +325458,7 @@ var state5 = {
|
|
|
325384
325458
|
"title": "Botpress API",
|
|
325385
325459
|
"description": "API for Botpress Cloud",
|
|
325386
325460
|
"server": "https://api.botpress.cloud",
|
|
325387
|
-
"version": "1.
|
|
325461
|
+
"version": "1.73.0",
|
|
325388
325462
|
"prefix": "v1"
|
|
325389
325463
|
},
|
|
325390
325464
|
"errors": [
|
|
@@ -328371,6 +328445,14 @@ var state5 = {
|
|
|
328371
328445
|
"type": "string",
|
|
328372
328446
|
"maxLength": 4e4,
|
|
328373
328447
|
"description": "Picture URL of the [User](#schema_user)"
|
|
328448
|
+
},
|
|
328449
|
+
"attributes": {
|
|
328450
|
+
"type": "object",
|
|
328451
|
+
"additionalProperties": {
|
|
328452
|
+
"type": "string",
|
|
328453
|
+
"maxLength": 200
|
|
328454
|
+
},
|
|
328455
|
+
"description": "Optional attributes"
|
|
328374
328456
|
}
|
|
328375
328457
|
},
|
|
328376
328458
|
"required": [
|
|
@@ -329876,6 +329958,110 @@ var state6 = {
|
|
|
329876
329958
|
}
|
|
329877
329959
|
}
|
|
329878
329960
|
},
|
|
329961
|
+
"getBillingAddress": {
|
|
329962
|
+
"name": "getBillingAddress",
|
|
329963
|
+
"description": "Get billing address for the authenticated workspace",
|
|
329964
|
+
"method": "get",
|
|
329965
|
+
"path": "/v2/billing/address",
|
|
329966
|
+
"response": {
|
|
329967
|
+
"description": "Workspace billing address",
|
|
329968
|
+
"status": 200,
|
|
329969
|
+
"schema": {
|
|
329970
|
+
"type": "object",
|
|
329971
|
+
"properties": {
|
|
329972
|
+
"address": {
|
|
329973
|
+
"type": "object",
|
|
329974
|
+
"properties": {
|
|
329975
|
+
"lineOne": {
|
|
329976
|
+
"type": "string"
|
|
329977
|
+
},
|
|
329978
|
+
"lineTwo": {
|
|
329979
|
+
"type": "string"
|
|
329980
|
+
},
|
|
329981
|
+
"city": {
|
|
329982
|
+
"type": "string"
|
|
329983
|
+
},
|
|
329984
|
+
"state": {
|
|
329985
|
+
"type": "string"
|
|
329986
|
+
},
|
|
329987
|
+
"postalCode": {
|
|
329988
|
+
"type": "string"
|
|
329989
|
+
},
|
|
329990
|
+
"country": {
|
|
329991
|
+
"type": "string"
|
|
329992
|
+
}
|
|
329993
|
+
},
|
|
329994
|
+
"nullable": true,
|
|
329995
|
+
"additionalProperties": false
|
|
329996
|
+
}
|
|
329997
|
+
},
|
|
329998
|
+
"required": [
|
|
329999
|
+
"address"
|
|
330000
|
+
],
|
|
330001
|
+
"title": "getBillingAddressResponse",
|
|
330002
|
+
"additionalProperties": false
|
|
330003
|
+
}
|
|
330004
|
+
},
|
|
330005
|
+
"parameters": {
|
|
330006
|
+
"x-workspace-id": {
|
|
330007
|
+
"in": "header",
|
|
330008
|
+
"type": "string",
|
|
330009
|
+
"description": "Workspace ID",
|
|
330010
|
+
"required": true
|
|
330011
|
+
}
|
|
330012
|
+
}
|
|
330013
|
+
},
|
|
330014
|
+
"setBillingAddress": {
|
|
330015
|
+
"name": "setBillingAddress",
|
|
330016
|
+
"description": "Set billing address for the authenticated workspace",
|
|
330017
|
+
"method": "put",
|
|
330018
|
+
"path": "/v2/billing/address",
|
|
330019
|
+
"requestBody": {
|
|
330020
|
+
"description": "Billing address",
|
|
330021
|
+
"schema": {
|
|
330022
|
+
"type": "object",
|
|
330023
|
+
"properties": {
|
|
330024
|
+
"lineOne": {
|
|
330025
|
+
"type": "string"
|
|
330026
|
+
},
|
|
330027
|
+
"lineTwo": {
|
|
330028
|
+
"type": "string"
|
|
330029
|
+
},
|
|
330030
|
+
"city": {
|
|
330031
|
+
"type": "string"
|
|
330032
|
+
},
|
|
330033
|
+
"state": {
|
|
330034
|
+
"type": "string"
|
|
330035
|
+
},
|
|
330036
|
+
"postalCode": {
|
|
330037
|
+
"type": "string"
|
|
330038
|
+
},
|
|
330039
|
+
"country": {
|
|
330040
|
+
"type": "string"
|
|
330041
|
+
}
|
|
330042
|
+
},
|
|
330043
|
+
"title": "setBillingAddressBody",
|
|
330044
|
+
"additionalProperties": false
|
|
330045
|
+
}
|
|
330046
|
+
},
|
|
330047
|
+
"response": {
|
|
330048
|
+
"description": "Updated",
|
|
330049
|
+
"status": 200,
|
|
330050
|
+
"schema": {
|
|
330051
|
+
"type": "object",
|
|
330052
|
+
"title": "setBillingAddressResponse",
|
|
330053
|
+
"additionalProperties": false
|
|
330054
|
+
}
|
|
330055
|
+
},
|
|
330056
|
+
"parameters": {
|
|
330057
|
+
"x-workspace-id": {
|
|
330058
|
+
"in": "header",
|
|
330059
|
+
"type": "string",
|
|
330060
|
+
"description": "Workspace ID",
|
|
330061
|
+
"required": true
|
|
330062
|
+
}
|
|
330063
|
+
}
|
|
330064
|
+
},
|
|
329879
330065
|
"getPlan": {
|
|
329880
330066
|
"name": "getPlan",
|
|
329881
330067
|
"description": "Get plan details",
|
|
@@ -330201,13 +330387,13 @@ var state6 = {
|
|
|
330201
330387
|
},
|
|
330202
330388
|
"parameters": {}
|
|
330203
330389
|
},
|
|
330204
|
-
"
|
|
330205
|
-
"name": "
|
|
330206
|
-
"description": "Get
|
|
330390
|
+
"getSubscription": {
|
|
330391
|
+
"name": "getSubscription",
|
|
330392
|
+
"description": "Get subscription for a workspace",
|
|
330207
330393
|
"method": "get",
|
|
330208
|
-
"path": "/v2/billing/subscriptions
|
|
330394
|
+
"path": "/v2/billing/subscriptions",
|
|
330209
330395
|
"response": {
|
|
330210
|
-
"description": "
|
|
330396
|
+
"description": "Subscription details",
|
|
330211
330397
|
"status": 200,
|
|
330212
330398
|
"schema": {
|
|
330213
330399
|
"type": "object",
|
|
@@ -330356,175 +330542,7 @@ var state6 = {
|
|
|
330356
330542
|
"plan",
|
|
330357
330543
|
"addons"
|
|
330358
330544
|
],
|
|
330359
|
-
"title": "
|
|
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",
|
|
330375
|
-
"method": "get",
|
|
330376
|
-
"path": "/v2/billing/subscriptions/next",
|
|
330377
|
-
"response": {
|
|
330378
|
-
"description": "Next subscription details",
|
|
330379
|
-
"status": 200,
|
|
330380
|
-
"schema": {
|
|
330381
|
-
"type": "object",
|
|
330382
|
-
"properties": {
|
|
330383
|
-
"plan": {
|
|
330384
|
-
"type": "object",
|
|
330385
|
-
"properties": {
|
|
330386
|
-
"current": {
|
|
330387
|
-
"type": "object",
|
|
330388
|
-
"properties": {
|
|
330389
|
-
"status": {
|
|
330390
|
-
"type": "string",
|
|
330391
|
-
"enum": [
|
|
330392
|
-
"active",
|
|
330393
|
-
"canceled",
|
|
330394
|
-
"past_due",
|
|
330395
|
-
"action_required",
|
|
330396
|
-
"grace_period"
|
|
330397
|
-
]
|
|
330398
|
-
},
|
|
330399
|
-
"planId": {
|
|
330400
|
-
"type": "string"
|
|
330401
|
-
},
|
|
330402
|
-
"interval": {
|
|
330403
|
-
"type": "string",
|
|
330404
|
-
"enum": [
|
|
330405
|
-
"month",
|
|
330406
|
-
"year"
|
|
330407
|
-
]
|
|
330408
|
-
},
|
|
330409
|
-
"price": {
|
|
330410
|
-
"type": "number"
|
|
330411
|
-
},
|
|
330412
|
-
"proratedPrice": {
|
|
330413
|
-
"type": "number"
|
|
330414
|
-
},
|
|
330415
|
-
"cancelAtPeriodEnd": {
|
|
330416
|
-
"type": "boolean"
|
|
330417
|
-
},
|
|
330418
|
-
"periodEnd": {
|
|
330419
|
-
"type": "string"
|
|
330420
|
-
}
|
|
330421
|
-
},
|
|
330422
|
-
"required": [
|
|
330423
|
-
"status",
|
|
330424
|
-
"planId",
|
|
330425
|
-
"interval",
|
|
330426
|
-
"price",
|
|
330427
|
-
"cancelAtPeriodEnd",
|
|
330428
|
-
"periodEnd"
|
|
330429
|
-
],
|
|
330430
|
-
"additionalProperties": false
|
|
330431
|
-
},
|
|
330432
|
-
"next": {
|
|
330433
|
-
"type": "object",
|
|
330434
|
-
"properties": {
|
|
330435
|
-
"planId": {
|
|
330436
|
-
"type": "string"
|
|
330437
|
-
},
|
|
330438
|
-
"interval": {
|
|
330439
|
-
"type": "string",
|
|
330440
|
-
"enum": [
|
|
330441
|
-
"month",
|
|
330442
|
-
"year"
|
|
330443
|
-
]
|
|
330444
|
-
},
|
|
330445
|
-
"price": {
|
|
330446
|
-
"type": "number",
|
|
330447
|
-
"nullable": true
|
|
330448
|
-
},
|
|
330449
|
-
"effectiveDate": {
|
|
330450
|
-
"type": "string"
|
|
330451
|
-
}
|
|
330452
|
-
},
|
|
330453
|
-
"required": [
|
|
330454
|
-
"planId",
|
|
330455
|
-
"interval",
|
|
330456
|
-
"price",
|
|
330457
|
-
"effectiveDate"
|
|
330458
|
-
],
|
|
330459
|
-
"nullable": true,
|
|
330460
|
-
"additionalProperties": false
|
|
330461
|
-
}
|
|
330462
|
-
},
|
|
330463
|
-
"required": [
|
|
330464
|
-
"current",
|
|
330465
|
-
"next"
|
|
330466
|
-
],
|
|
330467
|
-
"additionalProperties": false
|
|
330468
|
-
},
|
|
330469
|
-
"addons": {
|
|
330470
|
-
"type": "object",
|
|
330471
|
-
"additionalProperties": {
|
|
330472
|
-
"type": "object",
|
|
330473
|
-
"properties": {
|
|
330474
|
-
"current": {
|
|
330475
|
-
"type": "object",
|
|
330476
|
-
"properties": {
|
|
330477
|
-
"quantity": {
|
|
330478
|
-
"type": "number"
|
|
330479
|
-
},
|
|
330480
|
-
"price": {
|
|
330481
|
-
"type": "number"
|
|
330482
|
-
},
|
|
330483
|
-
"proratedPrice": {
|
|
330484
|
-
"type": "number"
|
|
330485
|
-
}
|
|
330486
|
-
},
|
|
330487
|
-
"required": [
|
|
330488
|
-
"quantity",
|
|
330489
|
-
"price"
|
|
330490
|
-
],
|
|
330491
|
-
"additionalProperties": false
|
|
330492
|
-
},
|
|
330493
|
-
"next": {
|
|
330494
|
-
"type": "object",
|
|
330495
|
-
"properties": {
|
|
330496
|
-
"quantity": {
|
|
330497
|
-
"type": "number"
|
|
330498
|
-
},
|
|
330499
|
-
"price": {
|
|
330500
|
-
"type": "number"
|
|
330501
|
-
},
|
|
330502
|
-
"effectiveDate": {
|
|
330503
|
-
"type": "string"
|
|
330504
|
-
}
|
|
330505
|
-
},
|
|
330506
|
-
"required": [
|
|
330507
|
-
"quantity",
|
|
330508
|
-
"price",
|
|
330509
|
-
"effectiveDate"
|
|
330510
|
-
],
|
|
330511
|
-
"nullable": true,
|
|
330512
|
-
"additionalProperties": false
|
|
330513
|
-
}
|
|
330514
|
-
},
|
|
330515
|
-
"required": [
|
|
330516
|
-
"current",
|
|
330517
|
-
"next"
|
|
330518
|
-
],
|
|
330519
|
-
"additionalProperties": false
|
|
330520
|
-
}
|
|
330521
|
-
}
|
|
330522
|
-
},
|
|
330523
|
-
"required": [
|
|
330524
|
-
"plan",
|
|
330525
|
-
"addons"
|
|
330526
|
-
],
|
|
330527
|
-
"title": "getNextSubscriptionResponse",
|
|
330545
|
+
"title": "getSubscriptionResponse",
|
|
330528
330546
|
"additionalProperties": false
|
|
330529
330547
|
}
|
|
330530
330548
|
},
|
|
@@ -331219,6 +331237,728 @@ var state6 = {
|
|
|
331219
331237
|
}
|
|
331220
331238
|
}
|
|
331221
331239
|
},
|
|
331240
|
+
"setCancelAtPeriodEnd": {
|
|
331241
|
+
"name": "setCancelAtPeriodEnd",
|
|
331242
|
+
"description": "Set whether to cancel the subscription at the end of the current period",
|
|
331243
|
+
"method": "put",
|
|
331244
|
+
"path": "/v2/billing/subscriptions/cancel",
|
|
331245
|
+
"requestBody": {
|
|
331246
|
+
"description": "Cancel at period end",
|
|
331247
|
+
"schema": {
|
|
331248
|
+
"type": "object",
|
|
331249
|
+
"properties": {
|
|
331250
|
+
"cancelAtPeriodEnd": {
|
|
331251
|
+
"type": "boolean"
|
|
331252
|
+
}
|
|
331253
|
+
},
|
|
331254
|
+
"required": [
|
|
331255
|
+
"cancelAtPeriodEnd"
|
|
331256
|
+
],
|
|
331257
|
+
"title": "setCancelAtPeriodEndBody",
|
|
331258
|
+
"additionalProperties": false
|
|
331259
|
+
}
|
|
331260
|
+
},
|
|
331261
|
+
"response": {
|
|
331262
|
+
"description": "Updated subscription details",
|
|
331263
|
+
"status": 200,
|
|
331264
|
+
"schema": {
|
|
331265
|
+
"type": "object",
|
|
331266
|
+
"properties": {
|
|
331267
|
+
"plan": {
|
|
331268
|
+
"type": "object",
|
|
331269
|
+
"properties": {
|
|
331270
|
+
"current": {
|
|
331271
|
+
"type": "object",
|
|
331272
|
+
"properties": {
|
|
331273
|
+
"status": {
|
|
331274
|
+
"type": "string",
|
|
331275
|
+
"enum": [
|
|
331276
|
+
"active",
|
|
331277
|
+
"canceled",
|
|
331278
|
+
"past_due",
|
|
331279
|
+
"action_required",
|
|
331280
|
+
"grace_period"
|
|
331281
|
+
]
|
|
331282
|
+
},
|
|
331283
|
+
"planId": {
|
|
331284
|
+
"type": "string"
|
|
331285
|
+
},
|
|
331286
|
+
"interval": {
|
|
331287
|
+
"type": "string",
|
|
331288
|
+
"enum": [
|
|
331289
|
+
"month",
|
|
331290
|
+
"year"
|
|
331291
|
+
]
|
|
331292
|
+
},
|
|
331293
|
+
"price": {
|
|
331294
|
+
"type": "number"
|
|
331295
|
+
},
|
|
331296
|
+
"proratedPrice": {
|
|
331297
|
+
"type": "number"
|
|
331298
|
+
},
|
|
331299
|
+
"cancelAtPeriodEnd": {
|
|
331300
|
+
"type": "boolean"
|
|
331301
|
+
},
|
|
331302
|
+
"periodEnd": {
|
|
331303
|
+
"type": "string"
|
|
331304
|
+
}
|
|
331305
|
+
},
|
|
331306
|
+
"required": [
|
|
331307
|
+
"status",
|
|
331308
|
+
"planId",
|
|
331309
|
+
"interval",
|
|
331310
|
+
"price",
|
|
331311
|
+
"cancelAtPeriodEnd",
|
|
331312
|
+
"periodEnd"
|
|
331313
|
+
],
|
|
331314
|
+
"additionalProperties": false
|
|
331315
|
+
},
|
|
331316
|
+
"next": {
|
|
331317
|
+
"type": "object",
|
|
331318
|
+
"properties": {
|
|
331319
|
+
"planId": {
|
|
331320
|
+
"type": "string"
|
|
331321
|
+
},
|
|
331322
|
+
"interval": {
|
|
331323
|
+
"type": "string",
|
|
331324
|
+
"enum": [
|
|
331325
|
+
"month",
|
|
331326
|
+
"year"
|
|
331327
|
+
]
|
|
331328
|
+
},
|
|
331329
|
+
"price": {
|
|
331330
|
+
"type": "number",
|
|
331331
|
+
"nullable": true
|
|
331332
|
+
},
|
|
331333
|
+
"effectiveDate": {
|
|
331334
|
+
"type": "string"
|
|
331335
|
+
}
|
|
331336
|
+
},
|
|
331337
|
+
"required": [
|
|
331338
|
+
"planId",
|
|
331339
|
+
"interval",
|
|
331340
|
+
"price",
|
|
331341
|
+
"effectiveDate"
|
|
331342
|
+
],
|
|
331343
|
+
"nullable": true,
|
|
331344
|
+
"additionalProperties": false
|
|
331345
|
+
}
|
|
331346
|
+
},
|
|
331347
|
+
"required": [
|
|
331348
|
+
"current",
|
|
331349
|
+
"next"
|
|
331350
|
+
],
|
|
331351
|
+
"additionalProperties": false
|
|
331352
|
+
},
|
|
331353
|
+
"addons": {
|
|
331354
|
+
"type": "object",
|
|
331355
|
+
"additionalProperties": {
|
|
331356
|
+
"type": "object",
|
|
331357
|
+
"properties": {
|
|
331358
|
+
"current": {
|
|
331359
|
+
"type": "object",
|
|
331360
|
+
"properties": {
|
|
331361
|
+
"quantity": {
|
|
331362
|
+
"type": "number"
|
|
331363
|
+
},
|
|
331364
|
+
"price": {
|
|
331365
|
+
"type": "number"
|
|
331366
|
+
},
|
|
331367
|
+
"proratedPrice": {
|
|
331368
|
+
"type": "number"
|
|
331369
|
+
}
|
|
331370
|
+
},
|
|
331371
|
+
"required": [
|
|
331372
|
+
"quantity",
|
|
331373
|
+
"price"
|
|
331374
|
+
],
|
|
331375
|
+
"additionalProperties": false
|
|
331376
|
+
},
|
|
331377
|
+
"next": {
|
|
331378
|
+
"type": "object",
|
|
331379
|
+
"properties": {
|
|
331380
|
+
"quantity": {
|
|
331381
|
+
"type": "number"
|
|
331382
|
+
},
|
|
331383
|
+
"price": {
|
|
331384
|
+
"type": "number"
|
|
331385
|
+
},
|
|
331386
|
+
"effectiveDate": {
|
|
331387
|
+
"type": "string"
|
|
331388
|
+
}
|
|
331389
|
+
},
|
|
331390
|
+
"required": [
|
|
331391
|
+
"quantity",
|
|
331392
|
+
"price",
|
|
331393
|
+
"effectiveDate"
|
|
331394
|
+
],
|
|
331395
|
+
"nullable": true,
|
|
331396
|
+
"additionalProperties": false
|
|
331397
|
+
}
|
|
331398
|
+
},
|
|
331399
|
+
"required": [
|
|
331400
|
+
"current",
|
|
331401
|
+
"next"
|
|
331402
|
+
],
|
|
331403
|
+
"additionalProperties": false
|
|
331404
|
+
}
|
|
331405
|
+
}
|
|
331406
|
+
},
|
|
331407
|
+
"required": [
|
|
331408
|
+
"plan",
|
|
331409
|
+
"addons"
|
|
331410
|
+
],
|
|
331411
|
+
"description": "Subscription details including current plan, addons, and costs",
|
|
331412
|
+
"title": "setCancelAtPeriodEndResponse",
|
|
331413
|
+
"additionalProperties": false
|
|
331414
|
+
}
|
|
331415
|
+
},
|
|
331416
|
+
"parameters": {
|
|
331417
|
+
"x-workspace-id": {
|
|
331418
|
+
"in": "header",
|
|
331419
|
+
"type": "string",
|
|
331420
|
+
"description": "Workspace ID",
|
|
331421
|
+
"required": true
|
|
331422
|
+
}
|
|
331423
|
+
}
|
|
331424
|
+
},
|
|
331425
|
+
"getAutoRechargeSettings": {
|
|
331426
|
+
"name": "getAutoRechargeSettings",
|
|
331427
|
+
"description": "Get auto recharge settings for the authenticated workspace",
|
|
331428
|
+
"method": "get",
|
|
331429
|
+
"path": "/v2/billing/auto-recharge/settings",
|
|
331430
|
+
"response": {
|
|
331431
|
+
"description": "Auto recharge settings",
|
|
331432
|
+
"status": 200,
|
|
331433
|
+
"schema": {
|
|
331434
|
+
"type": "object",
|
|
331435
|
+
"properties": {
|
|
331436
|
+
"settings": {
|
|
331437
|
+
"type": "object",
|
|
331438
|
+
"properties": {
|
|
331439
|
+
"table_row_count": {
|
|
331440
|
+
"type": "object",
|
|
331441
|
+
"properties": {
|
|
331442
|
+
"enabled": {
|
|
331443
|
+
"type": "boolean"
|
|
331444
|
+
},
|
|
331445
|
+
"threshold": {
|
|
331446
|
+
"type": "number",
|
|
331447
|
+
"minimum": 1,
|
|
331448
|
+
"maximum": 100
|
|
331449
|
+
},
|
|
331450
|
+
"limit": {
|
|
331451
|
+
"type": "number",
|
|
331452
|
+
"minimum": 1
|
|
331453
|
+
},
|
|
331454
|
+
"disabledReason": {
|
|
331455
|
+
"type": "string"
|
|
331456
|
+
}
|
|
331457
|
+
},
|
|
331458
|
+
"required": [
|
|
331459
|
+
"enabled"
|
|
331460
|
+
],
|
|
331461
|
+
"additionalProperties": false
|
|
331462
|
+
},
|
|
331463
|
+
"invocation_calls": {
|
|
331464
|
+
"type": "object",
|
|
331465
|
+
"properties": {
|
|
331466
|
+
"enabled": {
|
|
331467
|
+
"type": "boolean"
|
|
331468
|
+
},
|
|
331469
|
+
"threshold": {
|
|
331470
|
+
"type": "number",
|
|
331471
|
+
"minimum": 1,
|
|
331472
|
+
"maximum": 100
|
|
331473
|
+
},
|
|
331474
|
+
"limit": {
|
|
331475
|
+
"type": "number",
|
|
331476
|
+
"minimum": 1
|
|
331477
|
+
},
|
|
331478
|
+
"disabledReason": {
|
|
331479
|
+
"type": "string"
|
|
331480
|
+
}
|
|
331481
|
+
},
|
|
331482
|
+
"required": [
|
|
331483
|
+
"enabled"
|
|
331484
|
+
],
|
|
331485
|
+
"additionalProperties": false
|
|
331486
|
+
},
|
|
331487
|
+
"knowledgebase_vector_storage": {
|
|
331488
|
+
"type": "object",
|
|
331489
|
+
"properties": {
|
|
331490
|
+
"enabled": {
|
|
331491
|
+
"type": "boolean"
|
|
331492
|
+
},
|
|
331493
|
+
"threshold": {
|
|
331494
|
+
"type": "number",
|
|
331495
|
+
"minimum": 1,
|
|
331496
|
+
"maximum": 100
|
|
331497
|
+
},
|
|
331498
|
+
"limit": {
|
|
331499
|
+
"type": "number",
|
|
331500
|
+
"minimum": 1
|
|
331501
|
+
},
|
|
331502
|
+
"disabledReason": {
|
|
331503
|
+
"type": "string"
|
|
331504
|
+
}
|
|
331505
|
+
},
|
|
331506
|
+
"required": [
|
|
331507
|
+
"enabled"
|
|
331508
|
+
],
|
|
331509
|
+
"additionalProperties": false
|
|
331510
|
+
},
|
|
331511
|
+
"storage_count": {
|
|
331512
|
+
"type": "object",
|
|
331513
|
+
"properties": {
|
|
331514
|
+
"enabled": {
|
|
331515
|
+
"type": "boolean"
|
|
331516
|
+
},
|
|
331517
|
+
"threshold": {
|
|
331518
|
+
"type": "number",
|
|
331519
|
+
"minimum": 1,
|
|
331520
|
+
"maximum": 100
|
|
331521
|
+
},
|
|
331522
|
+
"limit": {
|
|
331523
|
+
"type": "number",
|
|
331524
|
+
"minimum": 1
|
|
331525
|
+
},
|
|
331526
|
+
"disabledReason": {
|
|
331527
|
+
"type": "string"
|
|
331528
|
+
}
|
|
331529
|
+
},
|
|
331530
|
+
"required": [
|
|
331531
|
+
"enabled"
|
|
331532
|
+
],
|
|
331533
|
+
"additionalProperties": false
|
|
331534
|
+
}
|
|
331535
|
+
},
|
|
331536
|
+
"required": [
|
|
331537
|
+
"table_row_count",
|
|
331538
|
+
"invocation_calls",
|
|
331539
|
+
"knowledgebase_vector_storage",
|
|
331540
|
+
"storage_count"
|
|
331541
|
+
],
|
|
331542
|
+
"additionalProperties": false
|
|
331543
|
+
}
|
|
331544
|
+
},
|
|
331545
|
+
"required": [
|
|
331546
|
+
"settings"
|
|
331547
|
+
],
|
|
331548
|
+
"title": "getAutoRechargeSettingsResponse",
|
|
331549
|
+
"additionalProperties": false
|
|
331550
|
+
}
|
|
331551
|
+
},
|
|
331552
|
+
"parameters": {
|
|
331553
|
+
"x-workspace-id": {
|
|
331554
|
+
"in": "header",
|
|
331555
|
+
"type": "string",
|
|
331556
|
+
"description": "Workspace ID",
|
|
331557
|
+
"required": true
|
|
331558
|
+
}
|
|
331559
|
+
}
|
|
331560
|
+
},
|
|
331561
|
+
"setAutoRechargeSettings": {
|
|
331562
|
+
"name": "setAutoRechargeSettings",
|
|
331563
|
+
"description": "Set auto recharge settings for the authenticated workspace",
|
|
331564
|
+
"method": "put",
|
|
331565
|
+
"path": "/v2/billing/auto-recharge/settings",
|
|
331566
|
+
"requestBody": {
|
|
331567
|
+
"description": "Auto recharge settings (partial update)",
|
|
331568
|
+
"schema": {
|
|
331569
|
+
"type": "object",
|
|
331570
|
+
"properties": {
|
|
331571
|
+
"settings": {
|
|
331572
|
+
"type": "object",
|
|
331573
|
+
"properties": {
|
|
331574
|
+
"table_row_count": {
|
|
331575
|
+
"type": "object",
|
|
331576
|
+
"properties": {
|
|
331577
|
+
"enabled": {
|
|
331578
|
+
"type": "boolean"
|
|
331579
|
+
},
|
|
331580
|
+
"threshold": {
|
|
331581
|
+
"type": "number",
|
|
331582
|
+
"minimum": 1,
|
|
331583
|
+
"maximum": 100
|
|
331584
|
+
},
|
|
331585
|
+
"limit": {
|
|
331586
|
+
"type": "number",
|
|
331587
|
+
"minimum": 1
|
|
331588
|
+
},
|
|
331589
|
+
"disabledReason": {
|
|
331590
|
+
"type": "string"
|
|
331591
|
+
}
|
|
331592
|
+
},
|
|
331593
|
+
"required": [
|
|
331594
|
+
"enabled"
|
|
331595
|
+
],
|
|
331596
|
+
"additionalProperties": false
|
|
331597
|
+
},
|
|
331598
|
+
"invocation_calls": {
|
|
331599
|
+
"type": "object",
|
|
331600
|
+
"properties": {
|
|
331601
|
+
"enabled": {
|
|
331602
|
+
"type": "boolean"
|
|
331603
|
+
},
|
|
331604
|
+
"threshold": {
|
|
331605
|
+
"type": "number",
|
|
331606
|
+
"minimum": 1,
|
|
331607
|
+
"maximum": 100
|
|
331608
|
+
},
|
|
331609
|
+
"limit": {
|
|
331610
|
+
"type": "number",
|
|
331611
|
+
"minimum": 1
|
|
331612
|
+
},
|
|
331613
|
+
"disabledReason": {
|
|
331614
|
+
"type": "string"
|
|
331615
|
+
}
|
|
331616
|
+
},
|
|
331617
|
+
"required": [
|
|
331618
|
+
"enabled"
|
|
331619
|
+
],
|
|
331620
|
+
"additionalProperties": false
|
|
331621
|
+
},
|
|
331622
|
+
"knowledgebase_vector_storage": {
|
|
331623
|
+
"type": "object",
|
|
331624
|
+
"properties": {
|
|
331625
|
+
"enabled": {
|
|
331626
|
+
"type": "boolean"
|
|
331627
|
+
},
|
|
331628
|
+
"threshold": {
|
|
331629
|
+
"type": "number",
|
|
331630
|
+
"minimum": 1,
|
|
331631
|
+
"maximum": 100
|
|
331632
|
+
},
|
|
331633
|
+
"limit": {
|
|
331634
|
+
"type": "number",
|
|
331635
|
+
"minimum": 1
|
|
331636
|
+
},
|
|
331637
|
+
"disabledReason": {
|
|
331638
|
+
"type": "string"
|
|
331639
|
+
}
|
|
331640
|
+
},
|
|
331641
|
+
"required": [
|
|
331642
|
+
"enabled"
|
|
331643
|
+
],
|
|
331644
|
+
"additionalProperties": false
|
|
331645
|
+
},
|
|
331646
|
+
"storage_count": {
|
|
331647
|
+
"type": "object",
|
|
331648
|
+
"properties": {
|
|
331649
|
+
"enabled": {
|
|
331650
|
+
"type": "boolean"
|
|
331651
|
+
},
|
|
331652
|
+
"threshold": {
|
|
331653
|
+
"type": "number",
|
|
331654
|
+
"minimum": 1,
|
|
331655
|
+
"maximum": 100
|
|
331656
|
+
},
|
|
331657
|
+
"limit": {
|
|
331658
|
+
"type": "number",
|
|
331659
|
+
"minimum": 1
|
|
331660
|
+
},
|
|
331661
|
+
"disabledReason": {
|
|
331662
|
+
"type": "string"
|
|
331663
|
+
}
|
|
331664
|
+
},
|
|
331665
|
+
"required": [
|
|
331666
|
+
"enabled"
|
|
331667
|
+
],
|
|
331668
|
+
"additionalProperties": false
|
|
331669
|
+
}
|
|
331670
|
+
},
|
|
331671
|
+
"additionalProperties": false
|
|
331672
|
+
}
|
|
331673
|
+
},
|
|
331674
|
+
"required": [
|
|
331675
|
+
"settings"
|
|
331676
|
+
],
|
|
331677
|
+
"title": "setAutoRechargeSettingsBody",
|
|
331678
|
+
"additionalProperties": false
|
|
331679
|
+
}
|
|
331680
|
+
},
|
|
331681
|
+
"response": {
|
|
331682
|
+
"description": "Updated auto recharge settings",
|
|
331683
|
+
"status": 200,
|
|
331684
|
+
"schema": {
|
|
331685
|
+
"type": "object",
|
|
331686
|
+
"properties": {
|
|
331687
|
+
"settings": {
|
|
331688
|
+
"type": "object",
|
|
331689
|
+
"properties": {
|
|
331690
|
+
"table_row_count": {
|
|
331691
|
+
"type": "object",
|
|
331692
|
+
"properties": {
|
|
331693
|
+
"enabled": {
|
|
331694
|
+
"type": "boolean"
|
|
331695
|
+
},
|
|
331696
|
+
"threshold": {
|
|
331697
|
+
"type": "number",
|
|
331698
|
+
"minimum": 1,
|
|
331699
|
+
"maximum": 100
|
|
331700
|
+
},
|
|
331701
|
+
"limit": {
|
|
331702
|
+
"type": "number",
|
|
331703
|
+
"minimum": 1
|
|
331704
|
+
},
|
|
331705
|
+
"disabledReason": {
|
|
331706
|
+
"type": "string"
|
|
331707
|
+
}
|
|
331708
|
+
},
|
|
331709
|
+
"required": [
|
|
331710
|
+
"enabled"
|
|
331711
|
+
],
|
|
331712
|
+
"additionalProperties": false
|
|
331713
|
+
},
|
|
331714
|
+
"invocation_calls": {
|
|
331715
|
+
"type": "object",
|
|
331716
|
+
"properties": {
|
|
331717
|
+
"enabled": {
|
|
331718
|
+
"type": "boolean"
|
|
331719
|
+
},
|
|
331720
|
+
"threshold": {
|
|
331721
|
+
"type": "number",
|
|
331722
|
+
"minimum": 1,
|
|
331723
|
+
"maximum": 100
|
|
331724
|
+
},
|
|
331725
|
+
"limit": {
|
|
331726
|
+
"type": "number",
|
|
331727
|
+
"minimum": 1
|
|
331728
|
+
},
|
|
331729
|
+
"disabledReason": {
|
|
331730
|
+
"type": "string"
|
|
331731
|
+
}
|
|
331732
|
+
},
|
|
331733
|
+
"required": [
|
|
331734
|
+
"enabled"
|
|
331735
|
+
],
|
|
331736
|
+
"additionalProperties": false
|
|
331737
|
+
},
|
|
331738
|
+
"knowledgebase_vector_storage": {
|
|
331739
|
+
"type": "object",
|
|
331740
|
+
"properties": {
|
|
331741
|
+
"enabled": {
|
|
331742
|
+
"type": "boolean"
|
|
331743
|
+
},
|
|
331744
|
+
"threshold": {
|
|
331745
|
+
"type": "number",
|
|
331746
|
+
"minimum": 1,
|
|
331747
|
+
"maximum": 100
|
|
331748
|
+
},
|
|
331749
|
+
"limit": {
|
|
331750
|
+
"type": "number",
|
|
331751
|
+
"minimum": 1
|
|
331752
|
+
},
|
|
331753
|
+
"disabledReason": {
|
|
331754
|
+
"type": "string"
|
|
331755
|
+
}
|
|
331756
|
+
},
|
|
331757
|
+
"required": [
|
|
331758
|
+
"enabled"
|
|
331759
|
+
],
|
|
331760
|
+
"additionalProperties": false
|
|
331761
|
+
},
|
|
331762
|
+
"storage_count": {
|
|
331763
|
+
"type": "object",
|
|
331764
|
+
"properties": {
|
|
331765
|
+
"enabled": {
|
|
331766
|
+
"type": "boolean"
|
|
331767
|
+
},
|
|
331768
|
+
"threshold": {
|
|
331769
|
+
"type": "number",
|
|
331770
|
+
"minimum": 1,
|
|
331771
|
+
"maximum": 100
|
|
331772
|
+
},
|
|
331773
|
+
"limit": {
|
|
331774
|
+
"type": "number",
|
|
331775
|
+
"minimum": 1
|
|
331776
|
+
},
|
|
331777
|
+
"disabledReason": {
|
|
331778
|
+
"type": "string"
|
|
331779
|
+
}
|
|
331780
|
+
},
|
|
331781
|
+
"required": [
|
|
331782
|
+
"enabled"
|
|
331783
|
+
],
|
|
331784
|
+
"additionalProperties": false
|
|
331785
|
+
}
|
|
331786
|
+
},
|
|
331787
|
+
"required": [
|
|
331788
|
+
"table_row_count",
|
|
331789
|
+
"invocation_calls",
|
|
331790
|
+
"knowledgebase_vector_storage",
|
|
331791
|
+
"storage_count"
|
|
331792
|
+
],
|
|
331793
|
+
"additionalProperties": false
|
|
331794
|
+
}
|
|
331795
|
+
},
|
|
331796
|
+
"required": [
|
|
331797
|
+
"settings"
|
|
331798
|
+
],
|
|
331799
|
+
"title": "setAutoRechargeSettingsResponse",
|
|
331800
|
+
"additionalProperties": false
|
|
331801
|
+
}
|
|
331802
|
+
},
|
|
331803
|
+
"parameters": {
|
|
331804
|
+
"x-workspace-id": {
|
|
331805
|
+
"in": "header",
|
|
331806
|
+
"type": "string",
|
|
331807
|
+
"description": "Workspace ID",
|
|
331808
|
+
"required": true
|
|
331809
|
+
}
|
|
331810
|
+
}
|
|
331811
|
+
},
|
|
331812
|
+
"getTrials": {
|
|
331813
|
+
"name": "getTrials",
|
|
331814
|
+
"description": "Get trials for the authenticated workspace",
|
|
331815
|
+
"method": "get",
|
|
331816
|
+
"path": "/v2/billing/trials",
|
|
331817
|
+
"response": {
|
|
331818
|
+
"description": "Workspace trials",
|
|
331819
|
+
"status": 200,
|
|
331820
|
+
"schema": {
|
|
331821
|
+
"type": "object",
|
|
331822
|
+
"properties": {
|
|
331823
|
+
"trials": {
|
|
331824
|
+
"type": "array",
|
|
331825
|
+
"items": {
|
|
331826
|
+
"type": "object",
|
|
331827
|
+
"properties": {
|
|
331828
|
+
"id": {
|
|
331829
|
+
"type": "string"
|
|
331830
|
+
},
|
|
331831
|
+
"trialPlan": {
|
|
331832
|
+
"type": "string"
|
|
331833
|
+
},
|
|
331834
|
+
"fromPlan": {
|
|
331835
|
+
"type": "string"
|
|
331836
|
+
},
|
|
331837
|
+
"endsAt": {
|
|
331838
|
+
"type": "string"
|
|
331839
|
+
},
|
|
331840
|
+
"isActive": {
|
|
331841
|
+
"type": "boolean"
|
|
331842
|
+
}
|
|
331843
|
+
},
|
|
331844
|
+
"required": [
|
|
331845
|
+
"id",
|
|
331846
|
+
"trialPlan",
|
|
331847
|
+
"fromPlan",
|
|
331848
|
+
"endsAt",
|
|
331849
|
+
"isActive"
|
|
331850
|
+
]
|
|
331851
|
+
}
|
|
331852
|
+
}
|
|
331853
|
+
},
|
|
331854
|
+
"required": [
|
|
331855
|
+
"trials"
|
|
331856
|
+
],
|
|
331857
|
+
"title": "getTrialsResponse",
|
|
331858
|
+
"additionalProperties": false
|
|
331859
|
+
}
|
|
331860
|
+
},
|
|
331861
|
+
"parameters": {
|
|
331862
|
+
"x-workspace-id": {
|
|
331863
|
+
"in": "header",
|
|
331864
|
+
"type": "string",
|
|
331865
|
+
"description": "Workspace ID",
|
|
331866
|
+
"required": true
|
|
331867
|
+
}
|
|
331868
|
+
}
|
|
331869
|
+
},
|
|
331870
|
+
"createTrial": {
|
|
331871
|
+
"name": "createTrial",
|
|
331872
|
+
"description": "Create a trial for the authenticated workspace",
|
|
331873
|
+
"method": "post",
|
|
331874
|
+
"path": "/v2/billing/trials",
|
|
331875
|
+
"requestBody": {
|
|
331876
|
+
"description": "Trial parameters",
|
|
331877
|
+
"schema": {
|
|
331878
|
+
"type": "object",
|
|
331879
|
+
"properties": {
|
|
331880
|
+
"lengthInDays": {
|
|
331881
|
+
"type": "integer",
|
|
331882
|
+
"minimum": 0,
|
|
331883
|
+
"exclusiveMinimum": true
|
|
331884
|
+
},
|
|
331885
|
+
"plan": {
|
|
331886
|
+
"type": "string"
|
|
331887
|
+
}
|
|
331888
|
+
},
|
|
331889
|
+
"required": [
|
|
331890
|
+
"lengthInDays",
|
|
331891
|
+
"plan"
|
|
331892
|
+
],
|
|
331893
|
+
"title": "createTrialBody",
|
|
331894
|
+
"additionalProperties": false
|
|
331895
|
+
}
|
|
331896
|
+
},
|
|
331897
|
+
"response": {
|
|
331898
|
+
"description": "Created trial",
|
|
331899
|
+
"status": 200,
|
|
331900
|
+
"schema": {
|
|
331901
|
+
"type": "object",
|
|
331902
|
+
"properties": {
|
|
331903
|
+
"id": {
|
|
331904
|
+
"type": "string"
|
|
331905
|
+
},
|
|
331906
|
+
"trialPlan": {
|
|
331907
|
+
"type": "string"
|
|
331908
|
+
},
|
|
331909
|
+
"fromPlan": {
|
|
331910
|
+
"type": "string"
|
|
331911
|
+
},
|
|
331912
|
+
"endsAt": {
|
|
331913
|
+
"type": "string"
|
|
331914
|
+
},
|
|
331915
|
+
"isActive": {
|
|
331916
|
+
"type": "boolean"
|
|
331917
|
+
}
|
|
331918
|
+
},
|
|
331919
|
+
"required": [
|
|
331920
|
+
"id",
|
|
331921
|
+
"trialPlan",
|
|
331922
|
+
"fromPlan",
|
|
331923
|
+
"endsAt",
|
|
331924
|
+
"isActive"
|
|
331925
|
+
],
|
|
331926
|
+
"title": "createTrialResponse",
|
|
331927
|
+
"additionalProperties": false
|
|
331928
|
+
}
|
|
331929
|
+
},
|
|
331930
|
+
"parameters": {
|
|
331931
|
+
"x-workspace-id": {
|
|
331932
|
+
"in": "header",
|
|
331933
|
+
"type": "string",
|
|
331934
|
+
"description": "Workspace ID",
|
|
331935
|
+
"required": true
|
|
331936
|
+
}
|
|
331937
|
+
}
|
|
331938
|
+
},
|
|
331939
|
+
"removeTrial": {
|
|
331940
|
+
"name": "removeTrial",
|
|
331941
|
+
"description": "Remove the active trial for the authenticated workspace",
|
|
331942
|
+
"method": "delete",
|
|
331943
|
+
"path": "/v2/billing/trials",
|
|
331944
|
+
"response": {
|
|
331945
|
+
"description": "Trial removed",
|
|
331946
|
+
"status": 200,
|
|
331947
|
+
"schema": {
|
|
331948
|
+
"type": "object",
|
|
331949
|
+
"title": "removeTrialResponse",
|
|
331950
|
+
"additionalProperties": false
|
|
331951
|
+
}
|
|
331952
|
+
},
|
|
331953
|
+
"parameters": {
|
|
331954
|
+
"x-workspace-id": {
|
|
331955
|
+
"in": "header",
|
|
331956
|
+
"type": "string",
|
|
331957
|
+
"description": "Workspace ID",
|
|
331958
|
+
"required": true
|
|
331959
|
+
}
|
|
331960
|
+
}
|
|
331961
|
+
},
|
|
331222
331962
|
"listInvoices": {
|
|
331223
331963
|
"name": "listInvoices",
|
|
331224
331964
|
"description": "List invoices for the authenticated workspace",
|
|
@@ -331630,7 +332370,7 @@ var state6 = {
|
|
|
331630
332370
|
"title": "Botpress Billing Public API",
|
|
331631
332371
|
"description": "API for Botpress Billing",
|
|
331632
332372
|
"server": "https://api.botpress.cloud",
|
|
331633
|
-
"version": "1.
|
|
332373
|
+
"version": "1.73.0",
|
|
331634
332374
|
"prefix": "v2"
|
|
331635
332375
|
},
|
|
331636
332376
|
"defaultParameters": {
|
|
@@ -331776,24 +332516,35 @@ var state6 = {
|
|
|
331776
332516
|
"refs": {
|
|
331777
332517
|
"parameters": {},
|
|
331778
332518
|
"requestBodies": {
|
|
332519
|
+
"setBillingAddressBody": true,
|
|
331779
332520
|
"previewSubscriptionUpdateBody": true,
|
|
331780
332521
|
"setPlanBody": true,
|
|
331781
332522
|
"setAddonsBody": true,
|
|
332523
|
+
"setCancelAtPeriodEndBody": true,
|
|
332524
|
+
"setAutoRechargeSettingsBody": true,
|
|
332525
|
+
"createTrialBody": true,
|
|
331782
332526
|
"payInvoiceBody": true,
|
|
331783
332527
|
"setPaymentMethodBody": true,
|
|
331784
332528
|
"createPaymentMethodIntentBody": true
|
|
331785
332529
|
},
|
|
331786
332530
|
"responses": {
|
|
331787
332531
|
"getBillingReadonlyResponse": true,
|
|
332532
|
+
"getBillingAddressResponse": true,
|
|
332533
|
+
"setBillingAddressResponse": true,
|
|
331788
332534
|
"getPlanResponse": true,
|
|
331789
332535
|
"listPlansResponse": true,
|
|
331790
332536
|
"getAddonResponse": true,
|
|
331791
332537
|
"listAddonsResponse": true,
|
|
331792
|
-
"
|
|
331793
|
-
"getNextSubscriptionResponse": true,
|
|
332538
|
+
"getSubscriptionResponse": true,
|
|
331794
332539
|
"previewSubscriptionUpdateResponse": true,
|
|
331795
332540
|
"setPlanResponse": true,
|
|
331796
332541
|
"setAddonsResponse": true,
|
|
332542
|
+
"setCancelAtPeriodEndResponse": true,
|
|
332543
|
+
"getAutoRechargeSettingsResponse": true,
|
|
332544
|
+
"setAutoRechargeSettingsResponse": true,
|
|
332545
|
+
"getTrialsResponse": true,
|
|
332546
|
+
"createTrialResponse": true,
|
|
332547
|
+
"removeTrialResponse": true,
|
|
331797
332548
|
"listInvoicesResponse": true,
|
|
331798
332549
|
"payInvoiceResponse": true,
|
|
331799
332550
|
"getPaymentMethodResponse": true,
|
|
@@ -331808,7 +332559,14 @@ var state6 = {
|
|
|
331808
332559
|
"SubscriptionUpdateParams": true,
|
|
331809
332560
|
"SubscriptionDetails": true,
|
|
331810
332561
|
"SetPlanParams": true,
|
|
331811
|
-
"SetAddonsParams": true
|
|
332562
|
+
"SetAddonsParams": true,
|
|
332563
|
+
"SetCancelAtPeriodEndParams": true,
|
|
332564
|
+
"BillingAddress": true,
|
|
332565
|
+
"Trial": true,
|
|
332566
|
+
"GetTrialsResponse": true,
|
|
332567
|
+
"CreateTrialParams": true,
|
|
332568
|
+
"GetAutoRechargeSettingsResponse": true,
|
|
332569
|
+
"SetAutoRechargeSettingsParams": true
|
|
331812
332570
|
}
|
|
331813
332571
|
},
|
|
331814
332572
|
"schemas": {
|
|
@@ -332413,6 +333171,376 @@ var state6 = {
|
|
|
332413
333171
|
"description": "Addons update parameters. Set quantity to 0 to remove an addon.",
|
|
332414
333172
|
"additionalProperties": false
|
|
332415
333173
|
}
|
|
333174
|
+
},
|
|
333175
|
+
"SetCancelAtPeriodEndParams": {
|
|
333176
|
+
"section": "subscription",
|
|
333177
|
+
"schema": {
|
|
333178
|
+
"type": "object",
|
|
333179
|
+
"properties": {
|
|
333180
|
+
"cancelAtPeriodEnd": {
|
|
333181
|
+
"type": "boolean"
|
|
333182
|
+
}
|
|
333183
|
+
},
|
|
333184
|
+
"required": [
|
|
333185
|
+
"cancelAtPeriodEnd"
|
|
333186
|
+
],
|
|
333187
|
+
"additionalProperties": false
|
|
333188
|
+
}
|
|
333189
|
+
},
|
|
333190
|
+
"BillingAddress": {
|
|
333191
|
+
"section": "subscription",
|
|
333192
|
+
"schema": {
|
|
333193
|
+
"type": "object",
|
|
333194
|
+
"properties": {
|
|
333195
|
+
"lineOne": {
|
|
333196
|
+
"type": "string"
|
|
333197
|
+
},
|
|
333198
|
+
"lineTwo": {
|
|
333199
|
+
"type": "string"
|
|
333200
|
+
},
|
|
333201
|
+
"city": {
|
|
333202
|
+
"type": "string"
|
|
333203
|
+
},
|
|
333204
|
+
"state": {
|
|
333205
|
+
"type": "string"
|
|
333206
|
+
},
|
|
333207
|
+
"postalCode": {
|
|
333208
|
+
"type": "string"
|
|
333209
|
+
},
|
|
333210
|
+
"country": {
|
|
333211
|
+
"type": "string"
|
|
333212
|
+
}
|
|
333213
|
+
},
|
|
333214
|
+
"additionalProperties": false
|
|
333215
|
+
}
|
|
333216
|
+
},
|
|
333217
|
+
"Trial": {
|
|
333218
|
+
"section": "subscription",
|
|
333219
|
+
"schema": {
|
|
333220
|
+
"type": "object",
|
|
333221
|
+
"properties": {
|
|
333222
|
+
"id": {
|
|
333223
|
+
"type": "string"
|
|
333224
|
+
},
|
|
333225
|
+
"trialPlan": {
|
|
333226
|
+
"type": "string"
|
|
333227
|
+
},
|
|
333228
|
+
"fromPlan": {
|
|
333229
|
+
"type": "string"
|
|
333230
|
+
},
|
|
333231
|
+
"endsAt": {
|
|
333232
|
+
"type": "string"
|
|
333233
|
+
},
|
|
333234
|
+
"isActive": {
|
|
333235
|
+
"type": "boolean"
|
|
333236
|
+
}
|
|
333237
|
+
},
|
|
333238
|
+
"required": [
|
|
333239
|
+
"id",
|
|
333240
|
+
"trialPlan",
|
|
333241
|
+
"fromPlan",
|
|
333242
|
+
"endsAt",
|
|
333243
|
+
"isActive"
|
|
333244
|
+
],
|
|
333245
|
+
"additionalProperties": false
|
|
333246
|
+
}
|
|
333247
|
+
},
|
|
333248
|
+
"GetTrialsResponse": {
|
|
333249
|
+
"section": "subscription",
|
|
333250
|
+
"schema": {
|
|
333251
|
+
"type": "object",
|
|
333252
|
+
"properties": {
|
|
333253
|
+
"trials": {
|
|
333254
|
+
"type": "array",
|
|
333255
|
+
"items": {
|
|
333256
|
+
"type": "object",
|
|
333257
|
+
"properties": {
|
|
333258
|
+
"id": {
|
|
333259
|
+
"type": "string"
|
|
333260
|
+
},
|
|
333261
|
+
"trialPlan": {
|
|
333262
|
+
"type": "string"
|
|
333263
|
+
},
|
|
333264
|
+
"fromPlan": {
|
|
333265
|
+
"type": "string"
|
|
333266
|
+
},
|
|
333267
|
+
"endsAt": {
|
|
333268
|
+
"type": "string"
|
|
333269
|
+
},
|
|
333270
|
+
"isActive": {
|
|
333271
|
+
"type": "boolean"
|
|
333272
|
+
}
|
|
333273
|
+
},
|
|
333274
|
+
"required": [
|
|
333275
|
+
"id",
|
|
333276
|
+
"trialPlan",
|
|
333277
|
+
"fromPlan",
|
|
333278
|
+
"endsAt",
|
|
333279
|
+
"isActive"
|
|
333280
|
+
]
|
|
333281
|
+
}
|
|
333282
|
+
}
|
|
333283
|
+
},
|
|
333284
|
+
"required": [
|
|
333285
|
+
"trials"
|
|
333286
|
+
],
|
|
333287
|
+
"additionalProperties": false
|
|
333288
|
+
}
|
|
333289
|
+
},
|
|
333290
|
+
"CreateTrialParams": {
|
|
333291
|
+
"section": "subscription",
|
|
333292
|
+
"schema": {
|
|
333293
|
+
"type": "object",
|
|
333294
|
+
"properties": {
|
|
333295
|
+
"lengthInDays": {
|
|
333296
|
+
"type": "integer",
|
|
333297
|
+
"minimum": 0,
|
|
333298
|
+
"exclusiveMinimum": true
|
|
333299
|
+
},
|
|
333300
|
+
"plan": {
|
|
333301
|
+
"type": "string"
|
|
333302
|
+
}
|
|
333303
|
+
},
|
|
333304
|
+
"required": [
|
|
333305
|
+
"lengthInDays",
|
|
333306
|
+
"plan"
|
|
333307
|
+
],
|
|
333308
|
+
"additionalProperties": false
|
|
333309
|
+
}
|
|
333310
|
+
},
|
|
333311
|
+
"GetAutoRechargeSettingsResponse": {
|
|
333312
|
+
"section": "subscription",
|
|
333313
|
+
"schema": {
|
|
333314
|
+
"type": "object",
|
|
333315
|
+
"properties": {
|
|
333316
|
+
"settings": {
|
|
333317
|
+
"type": "object",
|
|
333318
|
+
"properties": {
|
|
333319
|
+
"table_row_count": {
|
|
333320
|
+
"type": "object",
|
|
333321
|
+
"properties": {
|
|
333322
|
+
"enabled": {
|
|
333323
|
+
"type": "boolean"
|
|
333324
|
+
},
|
|
333325
|
+
"threshold": {
|
|
333326
|
+
"type": "number",
|
|
333327
|
+
"minimum": 1,
|
|
333328
|
+
"maximum": 100
|
|
333329
|
+
},
|
|
333330
|
+
"limit": {
|
|
333331
|
+
"type": "number",
|
|
333332
|
+
"minimum": 1
|
|
333333
|
+
},
|
|
333334
|
+
"disabledReason": {
|
|
333335
|
+
"type": "string"
|
|
333336
|
+
}
|
|
333337
|
+
},
|
|
333338
|
+
"required": [
|
|
333339
|
+
"enabled"
|
|
333340
|
+
],
|
|
333341
|
+
"additionalProperties": false
|
|
333342
|
+
},
|
|
333343
|
+
"invocation_calls": {
|
|
333344
|
+
"type": "object",
|
|
333345
|
+
"properties": {
|
|
333346
|
+
"enabled": {
|
|
333347
|
+
"type": "boolean"
|
|
333348
|
+
},
|
|
333349
|
+
"threshold": {
|
|
333350
|
+
"type": "number",
|
|
333351
|
+
"minimum": 1,
|
|
333352
|
+
"maximum": 100
|
|
333353
|
+
},
|
|
333354
|
+
"limit": {
|
|
333355
|
+
"type": "number",
|
|
333356
|
+
"minimum": 1
|
|
333357
|
+
},
|
|
333358
|
+
"disabledReason": {
|
|
333359
|
+
"type": "string"
|
|
333360
|
+
}
|
|
333361
|
+
},
|
|
333362
|
+
"required": [
|
|
333363
|
+
"enabled"
|
|
333364
|
+
],
|
|
333365
|
+
"additionalProperties": false
|
|
333366
|
+
},
|
|
333367
|
+
"knowledgebase_vector_storage": {
|
|
333368
|
+
"type": "object",
|
|
333369
|
+
"properties": {
|
|
333370
|
+
"enabled": {
|
|
333371
|
+
"type": "boolean"
|
|
333372
|
+
},
|
|
333373
|
+
"threshold": {
|
|
333374
|
+
"type": "number",
|
|
333375
|
+
"minimum": 1,
|
|
333376
|
+
"maximum": 100
|
|
333377
|
+
},
|
|
333378
|
+
"limit": {
|
|
333379
|
+
"type": "number",
|
|
333380
|
+
"minimum": 1
|
|
333381
|
+
},
|
|
333382
|
+
"disabledReason": {
|
|
333383
|
+
"type": "string"
|
|
333384
|
+
}
|
|
333385
|
+
},
|
|
333386
|
+
"required": [
|
|
333387
|
+
"enabled"
|
|
333388
|
+
],
|
|
333389
|
+
"additionalProperties": false
|
|
333390
|
+
},
|
|
333391
|
+
"storage_count": {
|
|
333392
|
+
"type": "object",
|
|
333393
|
+
"properties": {
|
|
333394
|
+
"enabled": {
|
|
333395
|
+
"type": "boolean"
|
|
333396
|
+
},
|
|
333397
|
+
"threshold": {
|
|
333398
|
+
"type": "number",
|
|
333399
|
+
"minimum": 1,
|
|
333400
|
+
"maximum": 100
|
|
333401
|
+
},
|
|
333402
|
+
"limit": {
|
|
333403
|
+
"type": "number",
|
|
333404
|
+
"minimum": 1
|
|
333405
|
+
},
|
|
333406
|
+
"disabledReason": {
|
|
333407
|
+
"type": "string"
|
|
333408
|
+
}
|
|
333409
|
+
},
|
|
333410
|
+
"required": [
|
|
333411
|
+
"enabled"
|
|
333412
|
+
],
|
|
333413
|
+
"additionalProperties": false
|
|
333414
|
+
}
|
|
333415
|
+
},
|
|
333416
|
+
"required": [
|
|
333417
|
+
"table_row_count",
|
|
333418
|
+
"invocation_calls",
|
|
333419
|
+
"knowledgebase_vector_storage",
|
|
333420
|
+
"storage_count"
|
|
333421
|
+
],
|
|
333422
|
+
"additionalProperties": false
|
|
333423
|
+
}
|
|
333424
|
+
},
|
|
333425
|
+
"required": [
|
|
333426
|
+
"settings"
|
|
333427
|
+
],
|
|
333428
|
+
"additionalProperties": false
|
|
333429
|
+
}
|
|
333430
|
+
},
|
|
333431
|
+
"SetAutoRechargeSettingsParams": {
|
|
333432
|
+
"section": "subscription",
|
|
333433
|
+
"schema": {
|
|
333434
|
+
"type": "object",
|
|
333435
|
+
"properties": {
|
|
333436
|
+
"settings": {
|
|
333437
|
+
"type": "object",
|
|
333438
|
+
"properties": {
|
|
333439
|
+
"table_row_count": {
|
|
333440
|
+
"type": "object",
|
|
333441
|
+
"properties": {
|
|
333442
|
+
"enabled": {
|
|
333443
|
+
"type": "boolean"
|
|
333444
|
+
},
|
|
333445
|
+
"threshold": {
|
|
333446
|
+
"type": "number",
|
|
333447
|
+
"minimum": 1,
|
|
333448
|
+
"maximum": 100
|
|
333449
|
+
},
|
|
333450
|
+
"limit": {
|
|
333451
|
+
"type": "number",
|
|
333452
|
+
"minimum": 1
|
|
333453
|
+
},
|
|
333454
|
+
"disabledReason": {
|
|
333455
|
+
"type": "string"
|
|
333456
|
+
}
|
|
333457
|
+
},
|
|
333458
|
+
"required": [
|
|
333459
|
+
"enabled"
|
|
333460
|
+
],
|
|
333461
|
+
"additionalProperties": false
|
|
333462
|
+
},
|
|
333463
|
+
"invocation_calls": {
|
|
333464
|
+
"type": "object",
|
|
333465
|
+
"properties": {
|
|
333466
|
+
"enabled": {
|
|
333467
|
+
"type": "boolean"
|
|
333468
|
+
},
|
|
333469
|
+
"threshold": {
|
|
333470
|
+
"type": "number",
|
|
333471
|
+
"minimum": 1,
|
|
333472
|
+
"maximum": 100
|
|
333473
|
+
},
|
|
333474
|
+
"limit": {
|
|
333475
|
+
"type": "number",
|
|
333476
|
+
"minimum": 1
|
|
333477
|
+
},
|
|
333478
|
+
"disabledReason": {
|
|
333479
|
+
"type": "string"
|
|
333480
|
+
}
|
|
333481
|
+
},
|
|
333482
|
+
"required": [
|
|
333483
|
+
"enabled"
|
|
333484
|
+
],
|
|
333485
|
+
"additionalProperties": false
|
|
333486
|
+
},
|
|
333487
|
+
"knowledgebase_vector_storage": {
|
|
333488
|
+
"type": "object",
|
|
333489
|
+
"properties": {
|
|
333490
|
+
"enabled": {
|
|
333491
|
+
"type": "boolean"
|
|
333492
|
+
},
|
|
333493
|
+
"threshold": {
|
|
333494
|
+
"type": "number",
|
|
333495
|
+
"minimum": 1,
|
|
333496
|
+
"maximum": 100
|
|
333497
|
+
},
|
|
333498
|
+
"limit": {
|
|
333499
|
+
"type": "number",
|
|
333500
|
+
"minimum": 1
|
|
333501
|
+
},
|
|
333502
|
+
"disabledReason": {
|
|
333503
|
+
"type": "string"
|
|
333504
|
+
}
|
|
333505
|
+
},
|
|
333506
|
+
"required": [
|
|
333507
|
+
"enabled"
|
|
333508
|
+
],
|
|
333509
|
+
"additionalProperties": false
|
|
333510
|
+
},
|
|
333511
|
+
"storage_count": {
|
|
333512
|
+
"type": "object",
|
|
333513
|
+
"properties": {
|
|
333514
|
+
"enabled": {
|
|
333515
|
+
"type": "boolean"
|
|
333516
|
+
},
|
|
333517
|
+
"threshold": {
|
|
333518
|
+
"type": "number",
|
|
333519
|
+
"minimum": 1,
|
|
333520
|
+
"maximum": 100
|
|
333521
|
+
},
|
|
333522
|
+
"limit": {
|
|
333523
|
+
"type": "number",
|
|
333524
|
+
"minimum": 1
|
|
333525
|
+
},
|
|
333526
|
+
"disabledReason": {
|
|
333527
|
+
"type": "string"
|
|
333528
|
+
}
|
|
333529
|
+
},
|
|
333530
|
+
"required": [
|
|
333531
|
+
"enabled"
|
|
333532
|
+
],
|
|
333533
|
+
"additionalProperties": false
|
|
333534
|
+
}
|
|
333535
|
+
},
|
|
333536
|
+
"additionalProperties": false
|
|
333537
|
+
}
|
|
333538
|
+
},
|
|
333539
|
+
"required": [
|
|
333540
|
+
"settings"
|
|
333541
|
+
],
|
|
333542
|
+
"additionalProperties": false
|
|
333543
|
+
}
|
|
332416
333544
|
}
|
|
332417
333545
|
},
|
|
332418
333546
|
"sections": [
|