@arbidocs/client 0.4.115 → 0.4.116
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.d.cts +102 -78
- package/dist/index.d.ts +102 -78
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -170,14 +170,15 @@ interface paths {
|
|
|
170
170
|
put?: never;
|
|
171
171
|
/**
|
|
172
172
|
* Change Project Plan
|
|
173
|
-
* @description Change the plan: interval
|
|
173
|
+
* @description Change the plan: interval and/or pack count, both at period end.
|
|
174
174
|
*
|
|
175
175
|
* Interval: nothing is charged or refunded now; the billing loop applies the switch just
|
|
176
176
|
* before renewal (``addons.prepare_renewal``); the current interval clears a pending
|
|
177
|
-
* switch.
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
177
|
+
* switch. 409 while a legacy multi-pack plan renews (reduce it to one licence first).
|
|
178
|
+
* Packs: only one licence is sold, so ``packs`` is 1 or the subscription's current count
|
|
179
|
+
* (422 otherwise): 1 reduces a legacy multi-pack plan at period end with no refund; the
|
|
180
|
+
* current count undoes that. A subscription set to cancel at period end (downgrade to
|
|
181
|
+
* Free) is resumed.
|
|
181
182
|
*/
|
|
182
183
|
post: operations['change_project_plan'];
|
|
183
184
|
delete?: never;
|
|
@@ -300,7 +301,8 @@ interface paths {
|
|
|
300
301
|
put?: never;
|
|
301
302
|
/**
|
|
302
303
|
* Create Project Billing Portal
|
|
303
|
-
* @description A fresh Stripe customer-portal link for this project's subscription
|
|
304
|
+
* @description A fresh Stripe customer-portal link for this project's subscription: card, billing address / tax ID / email,
|
|
305
|
+
* receipts and cancelling at period end. Plan, interval and add-on changes are made in the app, not there.
|
|
304
306
|
*/
|
|
305
307
|
post: operations['create_project_billing_portal'];
|
|
306
308
|
delete?: never;
|
|
@@ -322,8 +324,9 @@ interface paths {
|
|
|
322
324
|
* Preview Project Plan Change
|
|
323
325
|
* @description Price a plan change before making it (same body as change-plan), using Stripe's invoice preview.
|
|
324
326
|
*
|
|
325
|
-
* Returns
|
|
326
|
-
*
|
|
327
|
+
* Returns the first renewal under the new plan (amount and date), incl. and ex the customer's VAT; nothing is
|
|
328
|
+
* charged now (every change applies at the next renewal). Same 422 / 409 refusals as change-plan. Nothing is
|
|
329
|
+
* changed.
|
|
327
330
|
*/
|
|
328
331
|
post: operations['preview_project_plan_change'];
|
|
329
332
|
delete?: never;
|
|
@@ -342,7 +345,8 @@ interface paths {
|
|
|
342
345
|
/**
|
|
343
346
|
* Quote Project Addon
|
|
344
347
|
* @description One more add-on block with tax for the owner's saved billing address (Stripe Tax): what adding it
|
|
345
|
-
* charges today (``now
|
|
348
|
+
* charges today (``now``: AI usage the full block price, annual plans the remaining months; storage the time
|
|
349
|
+
* left in the period, prorated by days) and what it adds to each renewal.
|
|
346
350
|
*/
|
|
347
351
|
get: operations['quote_project_addon'];
|
|
348
352
|
put?: never;
|
|
@@ -364,14 +368,14 @@ interface paths {
|
|
|
364
368
|
put?: never;
|
|
365
369
|
/**
|
|
366
370
|
* Add Project Ai Block
|
|
367
|
-
* @description Add one AI usage block (+£
|
|
371
|
+
* @description Add one AI usage block (+£25 of AI usage a month), charged now for the current period to the saved card.
|
|
368
372
|
*
|
|
369
373
|
* The block stays on the subscription and renews at the full block price each period until reduced.
|
|
370
374
|
*
|
|
371
|
-
*
|
|
372
|
-
* rate for each remaining month. A declined
|
|
373
|
-
* ``PAYMENT_DECLINED``); 3-D Secure returns ``requires_action`` with
|
|
374
|
-
* invoice to confirm. Refused with 402 ``ADDON_SPEND_CAP`` at the monthly cap.
|
|
375
|
+
* It grants the whole month's £25 at once, so monthly plans pay the full block price (£25 + VAT);
|
|
376
|
+
* annual plans pay the discounted monthly rate (£18.75) for each remaining month. A declined
|
|
377
|
+
* payment grants nothing (402 ``PAYMENT_DECLINED``); 3-D Secure returns ``requires_action`` with
|
|
378
|
+
* the hosted invoice to confirm. Refused with 402 ``ADDON_SPEND_CAP`` at the monthly cap.
|
|
375
379
|
*/
|
|
376
380
|
post: operations['add_project_ai_block'];
|
|
377
381
|
delete?: never;
|
|
@@ -391,7 +395,7 @@ interface paths {
|
|
|
391
395
|
put?: never;
|
|
392
396
|
/**
|
|
393
397
|
* Add Project Storage Block
|
|
394
|
-
* @description Add one storage block (+
|
|
398
|
+
* @description Add one storage block (+25 GB), charged now for the time left in the billing period (prorated by days).
|
|
395
399
|
*
|
|
396
400
|
* It stays on the subscription and renews each period until reduced.
|
|
397
401
|
*
|
|
@@ -441,7 +445,9 @@ interface paths {
|
|
|
441
445
|
put?: never;
|
|
442
446
|
/**
|
|
443
447
|
* Dismiss Project Pro Plus Upsell
|
|
444
|
-
* @
|
|
448
|
+
* @deprecated
|
|
449
|
+
* @description Deprecated no-op: the Pro Plus prompt was removed (Pro Plus is no longer sold). Kept so clients that still
|
|
450
|
+
* call it get the project back instead of a 404.
|
|
445
451
|
*/
|
|
446
452
|
post: operations['dismiss_project_pro_plus_upsell'];
|
|
447
453
|
delete?: never;
|
|
@@ -989,9 +995,10 @@ interface paths {
|
|
|
989
995
|
};
|
|
990
996
|
/**
|
|
991
997
|
* Get Products
|
|
992
|
-
* @description The Pro plan and its monthly / annual prices, with the
|
|
993
|
-
*
|
|
994
|
-
*
|
|
998
|
+
* @description The Pro plan (one licence: £10 of AI usage + 5 GB a month) and its monthly / annual prices, with the add-on
|
|
999
|
+
* block prices at each interval (+£25 of AI usage or +25 GB a month each). ``pack_prices`` lists only one
|
|
1000
|
+
* licence (Pro Plus and multi-pack plans are no longer sold). ``amount`` fields are incl. UK VAT,
|
|
1001
|
+
* ``amount_ex_vat`` the ex-VAT price Stripe charges (other countries: ``POST /v1/user/projects/quote``).
|
|
995
1002
|
*/
|
|
996
1003
|
get: operations['get_products'];
|
|
997
1004
|
put?: never;
|
|
@@ -1035,7 +1042,7 @@ interface paths {
|
|
|
1035
1042
|
put?: never;
|
|
1036
1043
|
/**
|
|
1037
1044
|
* Top Up Firm Pool
|
|
1038
|
-
* @description Add renewing AI usage
|
|
1045
|
+
* @description Add renewing AI usage steps (+£25 of AI usage a month each) to the firm's Box subscription. Box admins only.
|
|
1039
1046
|
*
|
|
1040
1047
|
* Central adds them to the subscription, invoices the prorated amount on its terms and raises the AI budget
|
|
1041
1048
|
* before answering. 409 when the deployment has no live Box subscription.
|
|
@@ -14649,7 +14656,8 @@ interface components {
|
|
|
14649
14656
|
};
|
|
14650
14657
|
/**
|
|
14651
14658
|
* FirmPoolResponse
|
|
14652
|
-
* @description This month's pool
|
|
14659
|
+
* @description This month's pool and the Box licence, as central reports them (``GET /box/pool``). When ``has_pool`` is false
|
|
14660
|
+
* the deployment has no Box licence and the rest is unset.
|
|
14653
14661
|
*/
|
|
14654
14662
|
FirmPoolResponse: {
|
|
14655
14663
|
/**
|
|
@@ -14670,12 +14678,21 @@ interface components {
|
|
|
14670
14678
|
* @default false
|
|
14671
14679
|
*/
|
|
14672
14680
|
premium_only: boolean;
|
|
14673
|
-
/**
|
|
14674
|
-
|
|
14675
|
-
/**
|
|
14676
|
-
|
|
14677
|
-
/** Ai
|
|
14678
|
-
|
|
14681
|
+
/** Users */
|
|
14682
|
+
users?: number | null;
|
|
14683
|
+
/** Storage Gb */
|
|
14684
|
+
storage_gb?: number | null;
|
|
14685
|
+
/** Ai Gbp */
|
|
14686
|
+
ai_gbp?: number | null;
|
|
14687
|
+
/** Unlimited Standard Ai */
|
|
14688
|
+
unlimited_standard_ai?: boolean | null;
|
|
14689
|
+
/** Interval */
|
|
14690
|
+
interval?: string | null;
|
|
14691
|
+
/** Kept Until */
|
|
14692
|
+
kept_until?: string | null;
|
|
14693
|
+
renews?: components['schemas']['FirmRenewingQuantities'] | null;
|
|
14694
|
+
/** Support */
|
|
14695
|
+
support?: string | null;
|
|
14679
14696
|
/** Addon Gbp */
|
|
14680
14697
|
addon_gbp?: number | null;
|
|
14681
14698
|
/** Base Gbp */
|
|
@@ -14684,6 +14701,8 @@ interface components {
|
|
|
14684
14701
|
auto_addons?: number | null;
|
|
14685
14702
|
/** Auto Addon Gbp */
|
|
14686
14703
|
auto_addon_gbp?: number | null;
|
|
14704
|
+
/** Auto Storage Gb */
|
|
14705
|
+
auto_storage_gb?: number | null;
|
|
14687
14706
|
/** Auto Addon Price Pence */
|
|
14688
14707
|
auto_addon_price_pence?: number | null;
|
|
14689
14708
|
/** Auto Addon Spent Pence */
|
|
@@ -14716,7 +14735,7 @@ interface components {
|
|
|
14716
14735
|
FirmPoolTopUpRequest: {
|
|
14717
14736
|
/**
|
|
14718
14737
|
* Ai Addons
|
|
14719
|
-
* @description Renewing AI usage
|
|
14738
|
+
* @description Renewing AI usage steps (+£25 of AI usage a month each) to add
|
|
14720
14739
|
*/
|
|
14721
14740
|
ai_addons: number;
|
|
14722
14741
|
};
|
|
@@ -14726,6 +14745,22 @@ interface components {
|
|
|
14726
14745
|
/** Invoice Url */
|
|
14727
14746
|
invoice_url?: string | null;
|
|
14728
14747
|
};
|
|
14748
|
+
/**
|
|
14749
|
+
* FirmRenewingQuantities
|
|
14750
|
+
* @description The Box subscription's renewing quantities (what the next renewal bills).
|
|
14751
|
+
*/
|
|
14752
|
+
FirmRenewingQuantities: {
|
|
14753
|
+
/** Users */
|
|
14754
|
+
users?: number | null;
|
|
14755
|
+
/** Storage Gb */
|
|
14756
|
+
storage_gb?: number | null;
|
|
14757
|
+
/** Ai Gbp */
|
|
14758
|
+
ai_gbp?: number | null;
|
|
14759
|
+
/** Unlimited Standard Ai */
|
|
14760
|
+
unlimited_standard_ai?: boolean | null;
|
|
14761
|
+
/** Support */
|
|
14762
|
+
support?: string | null;
|
|
14763
|
+
};
|
|
14729
14764
|
/**
|
|
14730
14765
|
* FolderRead
|
|
14731
14766
|
* @description A mail folder (Outlook), label (Gmail), or drive folder/site/library.
|
|
@@ -17299,46 +17334,6 @@ interface components {
|
|
|
17299
17334
|
/** Timestamp */
|
|
17300
17335
|
timestamp: string;
|
|
17301
17336
|
};
|
|
17302
|
-
/**
|
|
17303
|
-
* ProPlusUpsell
|
|
17304
|
-
* @description Upgrade prompt for Pro (fewer than 10 packs) projects that have add-ons: honest monthly figures.
|
|
17305
|
-
*
|
|
17306
|
-
* ``variant`` "save": the plan + add-ons already cost at least Pro Plus (``saving_monthly_pence`` > 0 or 0);
|
|
17307
|
-
* "compare": they cost less, so show both prices. Annual plans use monthly equivalents (annual price / 12).
|
|
17308
|
-
*/
|
|
17309
|
-
ProPlusUpsell: {
|
|
17310
|
-
/**
|
|
17311
|
-
* Variant
|
|
17312
|
-
* @enum {string}
|
|
17313
|
-
*/
|
|
17314
|
-
variant: 'compare' | 'save';
|
|
17315
|
-
/**
|
|
17316
|
-
* Interval
|
|
17317
|
-
* @enum {string}
|
|
17318
|
-
*/
|
|
17319
|
-
interval: 'month' | 'year';
|
|
17320
|
-
/** Add On Count */
|
|
17321
|
-
add_on_count: number;
|
|
17322
|
-
/** Current Monthly Pence */
|
|
17323
|
-
current_monthly_pence: number;
|
|
17324
|
-
/** Current Monthly Ex Vat Pence */
|
|
17325
|
-
current_monthly_ex_vat_pence: number;
|
|
17326
|
-
/** Pro Plus Monthly Pence */
|
|
17327
|
-
pro_plus_monthly_pence: number;
|
|
17328
|
-
/** Pro Plus Monthly Ex Vat Pence */
|
|
17329
|
-
pro_plus_monthly_ex_vat_pence: number;
|
|
17330
|
-
/** Pro Plus Period Pence */
|
|
17331
|
-
pro_plus_period_pence: number;
|
|
17332
|
-
/** Pro Plus Ai Gbp */
|
|
17333
|
-
pro_plus_ai_gbp: number;
|
|
17334
|
-
/** Pro Plus Storage Gb */
|
|
17335
|
-
pro_plus_storage_gb: number;
|
|
17336
|
-
/**
|
|
17337
|
-
* Saving Monthly Pence
|
|
17338
|
-
* @default 0
|
|
17339
|
-
*/
|
|
17340
|
-
saving_monthly_pence: number;
|
|
17341
|
-
};
|
|
17342
17337
|
/**
|
|
17343
17338
|
* ProbeAnswerEvent
|
|
17344
17339
|
* @description Out-of-band answer to a mid-run status probe ("how's it going?").
|
|
@@ -17480,6 +17475,36 @@ interface components {
|
|
|
17480
17475
|
* @default 0
|
|
17481
17476
|
*/
|
|
17482
17477
|
storage_blocks: number;
|
|
17478
|
+
/**
|
|
17479
|
+
* Legacy Ai Blocks
|
|
17480
|
+
* @default 0
|
|
17481
|
+
*/
|
|
17482
|
+
legacy_ai_blocks: number;
|
|
17483
|
+
/**
|
|
17484
|
+
* Legacy Storage Blocks
|
|
17485
|
+
* @default 0
|
|
17486
|
+
*/
|
|
17487
|
+
legacy_storage_blocks: number;
|
|
17488
|
+
/**
|
|
17489
|
+
* Legacy Block Ai Gbp
|
|
17490
|
+
* @default 10
|
|
17491
|
+
*/
|
|
17492
|
+
legacy_block_ai_gbp: number;
|
|
17493
|
+
/**
|
|
17494
|
+
* Legacy Block Storage Gb
|
|
17495
|
+
* @default 10
|
|
17496
|
+
*/
|
|
17497
|
+
legacy_block_storage_gb: number;
|
|
17498
|
+
/**
|
|
17499
|
+
* Blocks Ai Gbp
|
|
17500
|
+
* @default 0
|
|
17501
|
+
*/
|
|
17502
|
+
blocks_ai_gbp: number;
|
|
17503
|
+
/**
|
|
17504
|
+
* Blocks Storage Gb
|
|
17505
|
+
* @default 0
|
|
17506
|
+
*/
|
|
17507
|
+
blocks_storage_gb: number;
|
|
17483
17508
|
/** Ai Blocks Next */
|
|
17484
17509
|
ai_blocks_next?: number | null;
|
|
17485
17510
|
/** Storage Blocks Next */
|
|
@@ -17547,7 +17572,6 @@ interface components {
|
|
|
17547
17572
|
billing_error?: string | null;
|
|
17548
17573
|
/** Confirm Url */
|
|
17549
17574
|
confirm_url?: string | null;
|
|
17550
|
-
upsell?: components['schemas']['ProPlusUpsell'] | null;
|
|
17551
17575
|
payment?: components['schemas']['AddonPaymentState'] | null;
|
|
17552
17576
|
};
|
|
17553
17577
|
/**
|
|
@@ -17565,7 +17589,7 @@ interface components {
|
|
|
17565
17589
|
};
|
|
17566
17590
|
/**
|
|
17567
17591
|
* ProjectCheckoutRequest
|
|
17568
|
-
* @description Create a Stripe checkout session for this project's Pro plan
|
|
17592
|
+
* @description Create a Stripe checkout session for this project's Pro plan: one licence (``packs`` must be 1).
|
|
17569
17593
|
*/
|
|
17570
17594
|
ProjectCheckoutRequest: {
|
|
17571
17595
|
/**
|
|
@@ -17756,13 +17780,13 @@ interface components {
|
|
|
17756
17780
|
};
|
|
17757
17781
|
/**
|
|
17758
17782
|
* ProjectPlanChangeRequest
|
|
17759
|
-
* @description Change a Pro project's plan: billing interval and/or pack count
|
|
17783
|
+
* @description Change a Pro project's plan: billing interval and/or pack count.
|
|
17760
17784
|
*
|
|
17761
17785
|
* - ``interval``: switches at the end of the current billing period (no refunds); the
|
|
17762
|
-
* current interval clears a pending switch.
|
|
17763
|
-
* - ``packs``:
|
|
17764
|
-
*
|
|
17765
|
-
*
|
|
17786
|
+
* current interval clears a pending switch. 409 while a legacy multi-pack plan renews.
|
|
17787
|
+
* - ``packs``: only one licence is sold, so this is 1, or the count a legacy multi-pack
|
|
17788
|
+
* subscription already has (anything else: 422). 1 reduces a multi-pack plan at the end
|
|
17789
|
+
* of the period (no refund); its current count undoes that.
|
|
17766
17790
|
* On a subscription set to cancel at period end, a change also resumes it.
|
|
17767
17791
|
*/
|
|
17768
17792
|
ProjectPlanChangeRequest: {
|
|
@@ -17794,13 +17818,13 @@ interface components {
|
|
|
17794
17818
|
* ProjectQuoteRequest
|
|
17795
17819
|
* @description Price a plan (+ add-ons) with tax for a billing address, via Stripe Tax. Nothing is created or charged.
|
|
17796
17820
|
*
|
|
17797
|
-
* ``plan`` "pro"
|
|
17798
|
-
* before a project has a saved address; a US address also needs ``postal_code``. ``vat_number`` (EU / UK
|
|
17821
|
+
* One Pro licence (``plan`` "pro", ``packs`` 1: the only values accepted). ``billing_country`` (ISO alpha-2) is
|
|
17822
|
+
* required before a project has a saved address; a US address also needs ``postal_code``. ``vat_number`` (EU / UK
|
|
17799
17823
|
* businesses) lets Stripe apply the reverse charge where it is due.
|
|
17800
17824
|
*/
|
|
17801
17825
|
ProjectQuoteRequest: {
|
|
17802
17826
|
/** Plan */
|
|
17803
|
-
plan?:
|
|
17827
|
+
plan?: 'pro' | null;
|
|
17804
17828
|
/** Packs */
|
|
17805
17829
|
packs?: number | null;
|
|
17806
17830
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -170,14 +170,15 @@ interface paths {
|
|
|
170
170
|
put?: never;
|
|
171
171
|
/**
|
|
172
172
|
* Change Project Plan
|
|
173
|
-
* @description Change the plan: interval
|
|
173
|
+
* @description Change the plan: interval and/or pack count, both at period end.
|
|
174
174
|
*
|
|
175
175
|
* Interval: nothing is charged or refunded now; the billing loop applies the switch just
|
|
176
176
|
* before renewal (``addons.prepare_renewal``); the current interval clears a pending
|
|
177
|
-
* switch.
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
177
|
+
* switch. 409 while a legacy multi-pack plan renews (reduce it to one licence first).
|
|
178
|
+
* Packs: only one licence is sold, so ``packs`` is 1 or the subscription's current count
|
|
179
|
+
* (422 otherwise): 1 reduces a legacy multi-pack plan at period end with no refund; the
|
|
180
|
+
* current count undoes that. A subscription set to cancel at period end (downgrade to
|
|
181
|
+
* Free) is resumed.
|
|
181
182
|
*/
|
|
182
183
|
post: operations['change_project_plan'];
|
|
183
184
|
delete?: never;
|
|
@@ -300,7 +301,8 @@ interface paths {
|
|
|
300
301
|
put?: never;
|
|
301
302
|
/**
|
|
302
303
|
* Create Project Billing Portal
|
|
303
|
-
* @description A fresh Stripe customer-portal link for this project's subscription
|
|
304
|
+
* @description A fresh Stripe customer-portal link for this project's subscription: card, billing address / tax ID / email,
|
|
305
|
+
* receipts and cancelling at period end. Plan, interval and add-on changes are made in the app, not there.
|
|
304
306
|
*/
|
|
305
307
|
post: operations['create_project_billing_portal'];
|
|
306
308
|
delete?: never;
|
|
@@ -322,8 +324,9 @@ interface paths {
|
|
|
322
324
|
* Preview Project Plan Change
|
|
323
325
|
* @description Price a plan change before making it (same body as change-plan), using Stripe's invoice preview.
|
|
324
326
|
*
|
|
325
|
-
* Returns
|
|
326
|
-
*
|
|
327
|
+
* Returns the first renewal under the new plan (amount and date), incl. and ex the customer's VAT; nothing is
|
|
328
|
+
* charged now (every change applies at the next renewal). Same 422 / 409 refusals as change-plan. Nothing is
|
|
329
|
+
* changed.
|
|
327
330
|
*/
|
|
328
331
|
post: operations['preview_project_plan_change'];
|
|
329
332
|
delete?: never;
|
|
@@ -342,7 +345,8 @@ interface paths {
|
|
|
342
345
|
/**
|
|
343
346
|
* Quote Project Addon
|
|
344
347
|
* @description One more add-on block with tax for the owner's saved billing address (Stripe Tax): what adding it
|
|
345
|
-
* charges today (``now
|
|
348
|
+
* charges today (``now``: AI usage the full block price, annual plans the remaining months; storage the time
|
|
349
|
+
* left in the period, prorated by days) and what it adds to each renewal.
|
|
346
350
|
*/
|
|
347
351
|
get: operations['quote_project_addon'];
|
|
348
352
|
put?: never;
|
|
@@ -364,14 +368,14 @@ interface paths {
|
|
|
364
368
|
put?: never;
|
|
365
369
|
/**
|
|
366
370
|
* Add Project Ai Block
|
|
367
|
-
* @description Add one AI usage block (+£
|
|
371
|
+
* @description Add one AI usage block (+£25 of AI usage a month), charged now for the current period to the saved card.
|
|
368
372
|
*
|
|
369
373
|
* The block stays on the subscription and renews at the full block price each period until reduced.
|
|
370
374
|
*
|
|
371
|
-
*
|
|
372
|
-
* rate for each remaining month. A declined
|
|
373
|
-
* ``PAYMENT_DECLINED``); 3-D Secure returns ``requires_action`` with
|
|
374
|
-
* invoice to confirm. Refused with 402 ``ADDON_SPEND_CAP`` at the monthly cap.
|
|
375
|
+
* It grants the whole month's £25 at once, so monthly plans pay the full block price (£25 + VAT);
|
|
376
|
+
* annual plans pay the discounted monthly rate (£18.75) for each remaining month. A declined
|
|
377
|
+
* payment grants nothing (402 ``PAYMENT_DECLINED``); 3-D Secure returns ``requires_action`` with
|
|
378
|
+
* the hosted invoice to confirm. Refused with 402 ``ADDON_SPEND_CAP`` at the monthly cap.
|
|
375
379
|
*/
|
|
376
380
|
post: operations['add_project_ai_block'];
|
|
377
381
|
delete?: never;
|
|
@@ -391,7 +395,7 @@ interface paths {
|
|
|
391
395
|
put?: never;
|
|
392
396
|
/**
|
|
393
397
|
* Add Project Storage Block
|
|
394
|
-
* @description Add one storage block (+
|
|
398
|
+
* @description Add one storage block (+25 GB), charged now for the time left in the billing period (prorated by days).
|
|
395
399
|
*
|
|
396
400
|
* It stays on the subscription and renews each period until reduced.
|
|
397
401
|
*
|
|
@@ -441,7 +445,9 @@ interface paths {
|
|
|
441
445
|
put?: never;
|
|
442
446
|
/**
|
|
443
447
|
* Dismiss Project Pro Plus Upsell
|
|
444
|
-
* @
|
|
448
|
+
* @deprecated
|
|
449
|
+
* @description Deprecated no-op: the Pro Plus prompt was removed (Pro Plus is no longer sold). Kept so clients that still
|
|
450
|
+
* call it get the project back instead of a 404.
|
|
445
451
|
*/
|
|
446
452
|
post: operations['dismiss_project_pro_plus_upsell'];
|
|
447
453
|
delete?: never;
|
|
@@ -989,9 +995,10 @@ interface paths {
|
|
|
989
995
|
};
|
|
990
996
|
/**
|
|
991
997
|
* Get Products
|
|
992
|
-
* @description The Pro plan and its monthly / annual prices, with the
|
|
993
|
-
*
|
|
994
|
-
*
|
|
998
|
+
* @description The Pro plan (one licence: £10 of AI usage + 5 GB a month) and its monthly / annual prices, with the add-on
|
|
999
|
+
* block prices at each interval (+£25 of AI usage or +25 GB a month each). ``pack_prices`` lists only one
|
|
1000
|
+
* licence (Pro Plus and multi-pack plans are no longer sold). ``amount`` fields are incl. UK VAT,
|
|
1001
|
+
* ``amount_ex_vat`` the ex-VAT price Stripe charges (other countries: ``POST /v1/user/projects/quote``).
|
|
995
1002
|
*/
|
|
996
1003
|
get: operations['get_products'];
|
|
997
1004
|
put?: never;
|
|
@@ -1035,7 +1042,7 @@ interface paths {
|
|
|
1035
1042
|
put?: never;
|
|
1036
1043
|
/**
|
|
1037
1044
|
* Top Up Firm Pool
|
|
1038
|
-
* @description Add renewing AI usage
|
|
1045
|
+
* @description Add renewing AI usage steps (+£25 of AI usage a month each) to the firm's Box subscription. Box admins only.
|
|
1039
1046
|
*
|
|
1040
1047
|
* Central adds them to the subscription, invoices the prorated amount on its terms and raises the AI budget
|
|
1041
1048
|
* before answering. 409 when the deployment has no live Box subscription.
|
|
@@ -14649,7 +14656,8 @@ interface components {
|
|
|
14649
14656
|
};
|
|
14650
14657
|
/**
|
|
14651
14658
|
* FirmPoolResponse
|
|
14652
|
-
* @description This month's pool
|
|
14659
|
+
* @description This month's pool and the Box licence, as central reports them (``GET /box/pool``). When ``has_pool`` is false
|
|
14660
|
+
* the deployment has no Box licence and the rest is unset.
|
|
14653
14661
|
*/
|
|
14654
14662
|
FirmPoolResponse: {
|
|
14655
14663
|
/**
|
|
@@ -14670,12 +14678,21 @@ interface components {
|
|
|
14670
14678
|
* @default false
|
|
14671
14679
|
*/
|
|
14672
14680
|
premium_only: boolean;
|
|
14673
|
-
/**
|
|
14674
|
-
|
|
14675
|
-
/**
|
|
14676
|
-
|
|
14677
|
-
/** Ai
|
|
14678
|
-
|
|
14681
|
+
/** Users */
|
|
14682
|
+
users?: number | null;
|
|
14683
|
+
/** Storage Gb */
|
|
14684
|
+
storage_gb?: number | null;
|
|
14685
|
+
/** Ai Gbp */
|
|
14686
|
+
ai_gbp?: number | null;
|
|
14687
|
+
/** Unlimited Standard Ai */
|
|
14688
|
+
unlimited_standard_ai?: boolean | null;
|
|
14689
|
+
/** Interval */
|
|
14690
|
+
interval?: string | null;
|
|
14691
|
+
/** Kept Until */
|
|
14692
|
+
kept_until?: string | null;
|
|
14693
|
+
renews?: components['schemas']['FirmRenewingQuantities'] | null;
|
|
14694
|
+
/** Support */
|
|
14695
|
+
support?: string | null;
|
|
14679
14696
|
/** Addon Gbp */
|
|
14680
14697
|
addon_gbp?: number | null;
|
|
14681
14698
|
/** Base Gbp */
|
|
@@ -14684,6 +14701,8 @@ interface components {
|
|
|
14684
14701
|
auto_addons?: number | null;
|
|
14685
14702
|
/** Auto Addon Gbp */
|
|
14686
14703
|
auto_addon_gbp?: number | null;
|
|
14704
|
+
/** Auto Storage Gb */
|
|
14705
|
+
auto_storage_gb?: number | null;
|
|
14687
14706
|
/** Auto Addon Price Pence */
|
|
14688
14707
|
auto_addon_price_pence?: number | null;
|
|
14689
14708
|
/** Auto Addon Spent Pence */
|
|
@@ -14716,7 +14735,7 @@ interface components {
|
|
|
14716
14735
|
FirmPoolTopUpRequest: {
|
|
14717
14736
|
/**
|
|
14718
14737
|
* Ai Addons
|
|
14719
|
-
* @description Renewing AI usage
|
|
14738
|
+
* @description Renewing AI usage steps (+£25 of AI usage a month each) to add
|
|
14720
14739
|
*/
|
|
14721
14740
|
ai_addons: number;
|
|
14722
14741
|
};
|
|
@@ -14726,6 +14745,22 @@ interface components {
|
|
|
14726
14745
|
/** Invoice Url */
|
|
14727
14746
|
invoice_url?: string | null;
|
|
14728
14747
|
};
|
|
14748
|
+
/**
|
|
14749
|
+
* FirmRenewingQuantities
|
|
14750
|
+
* @description The Box subscription's renewing quantities (what the next renewal bills).
|
|
14751
|
+
*/
|
|
14752
|
+
FirmRenewingQuantities: {
|
|
14753
|
+
/** Users */
|
|
14754
|
+
users?: number | null;
|
|
14755
|
+
/** Storage Gb */
|
|
14756
|
+
storage_gb?: number | null;
|
|
14757
|
+
/** Ai Gbp */
|
|
14758
|
+
ai_gbp?: number | null;
|
|
14759
|
+
/** Unlimited Standard Ai */
|
|
14760
|
+
unlimited_standard_ai?: boolean | null;
|
|
14761
|
+
/** Support */
|
|
14762
|
+
support?: string | null;
|
|
14763
|
+
};
|
|
14729
14764
|
/**
|
|
14730
14765
|
* FolderRead
|
|
14731
14766
|
* @description A mail folder (Outlook), label (Gmail), or drive folder/site/library.
|
|
@@ -17299,46 +17334,6 @@ interface components {
|
|
|
17299
17334
|
/** Timestamp */
|
|
17300
17335
|
timestamp: string;
|
|
17301
17336
|
};
|
|
17302
|
-
/**
|
|
17303
|
-
* ProPlusUpsell
|
|
17304
|
-
* @description Upgrade prompt for Pro (fewer than 10 packs) projects that have add-ons: honest monthly figures.
|
|
17305
|
-
*
|
|
17306
|
-
* ``variant`` "save": the plan + add-ons already cost at least Pro Plus (``saving_monthly_pence`` > 0 or 0);
|
|
17307
|
-
* "compare": they cost less, so show both prices. Annual plans use monthly equivalents (annual price / 12).
|
|
17308
|
-
*/
|
|
17309
|
-
ProPlusUpsell: {
|
|
17310
|
-
/**
|
|
17311
|
-
* Variant
|
|
17312
|
-
* @enum {string}
|
|
17313
|
-
*/
|
|
17314
|
-
variant: 'compare' | 'save';
|
|
17315
|
-
/**
|
|
17316
|
-
* Interval
|
|
17317
|
-
* @enum {string}
|
|
17318
|
-
*/
|
|
17319
|
-
interval: 'month' | 'year';
|
|
17320
|
-
/** Add On Count */
|
|
17321
|
-
add_on_count: number;
|
|
17322
|
-
/** Current Monthly Pence */
|
|
17323
|
-
current_monthly_pence: number;
|
|
17324
|
-
/** Current Monthly Ex Vat Pence */
|
|
17325
|
-
current_monthly_ex_vat_pence: number;
|
|
17326
|
-
/** Pro Plus Monthly Pence */
|
|
17327
|
-
pro_plus_monthly_pence: number;
|
|
17328
|
-
/** Pro Plus Monthly Ex Vat Pence */
|
|
17329
|
-
pro_plus_monthly_ex_vat_pence: number;
|
|
17330
|
-
/** Pro Plus Period Pence */
|
|
17331
|
-
pro_plus_period_pence: number;
|
|
17332
|
-
/** Pro Plus Ai Gbp */
|
|
17333
|
-
pro_plus_ai_gbp: number;
|
|
17334
|
-
/** Pro Plus Storage Gb */
|
|
17335
|
-
pro_plus_storage_gb: number;
|
|
17336
|
-
/**
|
|
17337
|
-
* Saving Monthly Pence
|
|
17338
|
-
* @default 0
|
|
17339
|
-
*/
|
|
17340
|
-
saving_monthly_pence: number;
|
|
17341
|
-
};
|
|
17342
17337
|
/**
|
|
17343
17338
|
* ProbeAnswerEvent
|
|
17344
17339
|
* @description Out-of-band answer to a mid-run status probe ("how's it going?").
|
|
@@ -17480,6 +17475,36 @@ interface components {
|
|
|
17480
17475
|
* @default 0
|
|
17481
17476
|
*/
|
|
17482
17477
|
storage_blocks: number;
|
|
17478
|
+
/**
|
|
17479
|
+
* Legacy Ai Blocks
|
|
17480
|
+
* @default 0
|
|
17481
|
+
*/
|
|
17482
|
+
legacy_ai_blocks: number;
|
|
17483
|
+
/**
|
|
17484
|
+
* Legacy Storage Blocks
|
|
17485
|
+
* @default 0
|
|
17486
|
+
*/
|
|
17487
|
+
legacy_storage_blocks: number;
|
|
17488
|
+
/**
|
|
17489
|
+
* Legacy Block Ai Gbp
|
|
17490
|
+
* @default 10
|
|
17491
|
+
*/
|
|
17492
|
+
legacy_block_ai_gbp: number;
|
|
17493
|
+
/**
|
|
17494
|
+
* Legacy Block Storage Gb
|
|
17495
|
+
* @default 10
|
|
17496
|
+
*/
|
|
17497
|
+
legacy_block_storage_gb: number;
|
|
17498
|
+
/**
|
|
17499
|
+
* Blocks Ai Gbp
|
|
17500
|
+
* @default 0
|
|
17501
|
+
*/
|
|
17502
|
+
blocks_ai_gbp: number;
|
|
17503
|
+
/**
|
|
17504
|
+
* Blocks Storage Gb
|
|
17505
|
+
* @default 0
|
|
17506
|
+
*/
|
|
17507
|
+
blocks_storage_gb: number;
|
|
17483
17508
|
/** Ai Blocks Next */
|
|
17484
17509
|
ai_blocks_next?: number | null;
|
|
17485
17510
|
/** Storage Blocks Next */
|
|
@@ -17547,7 +17572,6 @@ interface components {
|
|
|
17547
17572
|
billing_error?: string | null;
|
|
17548
17573
|
/** Confirm Url */
|
|
17549
17574
|
confirm_url?: string | null;
|
|
17550
|
-
upsell?: components['schemas']['ProPlusUpsell'] | null;
|
|
17551
17575
|
payment?: components['schemas']['AddonPaymentState'] | null;
|
|
17552
17576
|
};
|
|
17553
17577
|
/**
|
|
@@ -17565,7 +17589,7 @@ interface components {
|
|
|
17565
17589
|
};
|
|
17566
17590
|
/**
|
|
17567
17591
|
* ProjectCheckoutRequest
|
|
17568
|
-
* @description Create a Stripe checkout session for this project's Pro plan
|
|
17592
|
+
* @description Create a Stripe checkout session for this project's Pro plan: one licence (``packs`` must be 1).
|
|
17569
17593
|
*/
|
|
17570
17594
|
ProjectCheckoutRequest: {
|
|
17571
17595
|
/**
|
|
@@ -17756,13 +17780,13 @@ interface components {
|
|
|
17756
17780
|
};
|
|
17757
17781
|
/**
|
|
17758
17782
|
* ProjectPlanChangeRequest
|
|
17759
|
-
* @description Change a Pro project's plan: billing interval and/or pack count
|
|
17783
|
+
* @description Change a Pro project's plan: billing interval and/or pack count.
|
|
17760
17784
|
*
|
|
17761
17785
|
* - ``interval``: switches at the end of the current billing period (no refunds); the
|
|
17762
|
-
* current interval clears a pending switch.
|
|
17763
|
-
* - ``packs``:
|
|
17764
|
-
*
|
|
17765
|
-
*
|
|
17786
|
+
* current interval clears a pending switch. 409 while a legacy multi-pack plan renews.
|
|
17787
|
+
* - ``packs``: only one licence is sold, so this is 1, or the count a legacy multi-pack
|
|
17788
|
+
* subscription already has (anything else: 422). 1 reduces a multi-pack plan at the end
|
|
17789
|
+
* of the period (no refund); its current count undoes that.
|
|
17766
17790
|
* On a subscription set to cancel at period end, a change also resumes it.
|
|
17767
17791
|
*/
|
|
17768
17792
|
ProjectPlanChangeRequest: {
|
|
@@ -17794,13 +17818,13 @@ interface components {
|
|
|
17794
17818
|
* ProjectQuoteRequest
|
|
17795
17819
|
* @description Price a plan (+ add-ons) with tax for a billing address, via Stripe Tax. Nothing is created or charged.
|
|
17796
17820
|
*
|
|
17797
|
-
* ``plan`` "pro"
|
|
17798
|
-
* before a project has a saved address; a US address also needs ``postal_code``. ``vat_number`` (EU / UK
|
|
17821
|
+
* One Pro licence (``plan`` "pro", ``packs`` 1: the only values accepted). ``billing_country`` (ISO alpha-2) is
|
|
17822
|
+
* required before a project has a saved address; a US address also needs ``postal_code``. ``vat_number`` (EU / UK
|
|
17799
17823
|
* businesses) lets Stripe apply the reverse charge where it is due.
|
|
17800
17824
|
*/
|
|
17801
17825
|
ProjectQuoteRequest: {
|
|
17802
17826
|
/** Plan */
|
|
17803
|
-
plan?:
|
|
17827
|
+
plan?: 'pro' | null;
|
|
17804
17828
|
/** Packs */
|
|
17805
17829
|
packs?: number | null;
|
|
17806
17830
|
/**
|
package/package.json
CHANGED