@leaflow/sdk 0.0.0-dev.236.gebd337c → 0.0.0-dev.240.gecb1b07

package/dist/billing/account/v1/index.d.ts

@@ -105,10 +105,10 @@ export type CreateCancellationRequestBody = NonNullable<operations["create-cance
 export type GetCancellationRequestResult = operations["get-cancellation-request"]["responses"][200]["content"]["application/json"];
 /** The success response body of `POST /account/v1/cancellation-requests/{cancellationRequestId}/cancel`. */
 export type CancelCancellationRequestResult = operations["cancel-cancellation-request"]["responses"][200]["content"]["application/json"];
-/** The success response body of `POST /account/v1/cancellations/preview`. */
-export type CreateCancellationPreviewResult = operations["create-cancellation-preview"]["responses"][200]["content"]["application/json"];
-/** The request body of `POST /account/v1/cancellations/preview`. */
-export type CreateCancellationPreviewBody = NonNullable<operations["create-cancellation-preview"]["requestBody"]>["content"]["application/json"];
+/** The success response body of `POST /account/v1/quotes`. */
+export type CreateQuoteResult = operations["create-quote"]["responses"][200]["content"]["application/json"];
+/** The request body of `POST /account/v1/quotes`. */
+export type CreateQuoteBody = NonNullable<operations["create-quote"]["requestBody"]>["content"]["application/json"];
 /** The success response body of `POST /account/v1/cancellations`. */
 export type CreateCancellationResult = operations["create-cancellation"]["responses"][200]["content"]["application/json"];
 /** The request body of `POST /account/v1/cancellations`. */

package/dist/billing/account/v1/schema.d.ts

@@ -697,7 +697,7 @@ export interface paths {
          * @deprecated
          * @description Reads confirmed terms and paid-period value without recording a request or locking a refund amount.
          *
-         *     Use create-cancellation-preview, which previews the subscriptions released together.
+         *     Use create-quote with a `cancellation`, which quotes the subscriptions released together.
          */
         get: operations["preview-cancellation"];
         put?: never;
@@ -781,7 +781,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/account/v1/cancellations/preview": {
+    "/account/v1/quotes": {
         parameters: {
             query?: never;
             header?: never;
@@ -791,15 +791,27 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Preview a cancellation
-         * @description What canceling these subscriptions together would return, computed now under the refund terms
-         *     agreed when each was bought. This request does not create a resource: nothing is recorded or
-         *     reserved.
+         * Quote renewals or a cancellation
+         * @description Priced in the currency of the billing account that pays for the subscriptions, and at any rate
+         *     negotiated for that account. Nothing is reserved and nothing is recorded, so this may be called
+         *     as often as required. Prices may change between quoting and renewing, so a quote should be
+         *     refreshed before a final confirmation is shown.
          *
-         *     It is refused with the same errors as creating the cancellation, except that the amount is not
-         *     checked. Give the returned `proration_date` and `refundable_amount` when creating it.
+         *     A renewal is priced exactly as renewing would charge it: at the agreed amount or the price
+         *     named, with the discounts the account holds, and with tax.
+         *
+         *     A cancellation is quoted as creating it would compute the refund, as of now and under the refund
+         *     terms agreed when each subscription was bought. It is quoted on its own: combined with renewals
+         *     the request is refused with HTTP 400 `BILLING_PURCHASE_INVALID` and `meta.field`
+         *     `cancellation`. It is refused with the same errors as creating the cancellation, except that the
+         *     amount is not checked. Give the returned `cancellation.proration_date` and
+         *     `cancellation.refundable_amount` when creating it.
+         *
+         *     Every subscription must be paid for by the same one of your billing accounts; otherwise the
+         *     request is refused with HTTP 400 `BILLING_PURCHASE_INVALID`. Returns 404 when a subscription does
+         *     not exist, and 403 `BILLING_ACCOUNT_FORBIDDEN` when it is paid for by an account you do not own.
          */
-        post: operations["create-cancellation-preview"];
+        post: operations["create-quote"];
         delete?: never;
         options?: never;
         head?: never;
@@ -853,9 +865,8 @@ export interface paths {
          *       (`meta.cancellation_id`) or reclaimed (`meta.job_id`);
          *     - 409 `BILLING_ORDER_PAYMENT_IN_FLIGHT` while an online payment for a renewal of one of them
          *       is in progress;
-         *     - 422 `BILLING_CANCELLATION_UNSUPPORTED` when the service cannot yet be canceled here;
          *     - 409 `BILLING_CANCELLATION_REFUND_CHANGED` when the refund is no longer
-         *       `expected_refundable_amount`; preview again.
+         *       `expected_refundable_amount`; quote again.
          *
          *     Sending the same request again, for the same subscriptions, mode and amount while that
          *     cancellation is still open, returns it with 200 rather than creating another. Renewal orders
@@ -1196,13 +1207,91 @@ export interface components {
          * @enum {string}
          */
         RefundPolicy: "none" | "prorated";
-        CancellationPreviewRequest: {
+        /** @description Specify renewals for existing subscriptions, or one cancellation on its own. */
+        QuoteRequest: {
+            renewals?: components["schemas"]["QuoteRenewal"][];
+            cancellation?: components["schemas"]["QuoteCancellation"];
+        };
+        /**
+         * @description Price renewing a prepaid subscription. Give `price_id`, or `interval` with
+         *     `interval_count`, to renew for another term at the price currently sold for it. Naming
+         *     the current term, or giving neither, renews at the agreed amount.
+         */
+        QuoteRenewal: {
+            /** Format: uuid */
+            subscription_id: string;
+            /** Format: uuid */
+            price_id?: string;
+            /** @enum {string} */
+            interval?: "day" | "month" | "year";
+            interval_count?: number;
+            /**
+             * @description How many consecutive periods to renew for.
+             * @default 1
+             */
+            periods?: number;
+        };
+        /**
+         * @description What renewing would charge. Renewing the same subscription for the same term and number
+         *     of periods charges exactly `total`, unless prices or the discounts the account holds
+         *     change in between.
+         */
+        QuoteRenewalResult: {
+            /** @description Which renewal of the request this answers. */
+            index: number;
+            /** Format: uuid */
+            subscription_id: string;
+            /**
+             * Format: uuid
+             * @description The price the renewal is charged under.
+             */
+            price_id: string;
+            /** @enum {string} */
+            interval: "day" | "month" | "year";
+            interval_count: number;
+            periods: number;
+            /**
+             * @description The price of the periods before the discounts the account holds. A discount the
+             *     subscription already carries is reflected here. Contains tax only where the price
+             *     itself includes it.
+             */
+            amount: components["schemas"]["Money"];
+            /** @description The reduction from a discount the account holds. */
+            discount_amount: components["schemas"]["Money"];
+            /** @description Tax on the discounted amount. */
+            tax_amount: components["schemas"]["Money"];
+            /** @description The part of `tax_amount` already contained in `amount`. */
+            tax_included_amount: components["schemas"]["Money"];
+            /**
+             * @description What renewing would charge: `amount` less `discount_amount`, plus `tax_amount`, less
+             *     `tax_included_amount`.
+             */
+            total: components["schemas"]["Money"];
+        };
+        Quote: {
+            renewals?: components["schemas"]["QuoteRenewalResult"][];
+            /** @description What the cancellation requested would return. Present only when one was requested. */
+            cancellation?: components["schemas"]["CancellationRefundPreview"];
+            /**
+             * @description What the renewals would charge in total. Amounts to be returned are not netted off it: a
+             *     quote of a cancellation alone has a total of zero, and what it would return is in
+             *     `cancellation`.
+             */
+            total: components["schemas"]["Money"];
+            currency: string;
+        };
+        /**
+         * @description A cancellation to quote: what ending these subscriptions together would return. One mode per
+         *     request; to compare, quote `immediate` and `period_end` separately.
+         */
+        QuoteCancellation: {
             /** @description The subscriptions to end together, all of one service. Every subscription released with a resource must be included. */
             subscription_ids: string[];
             mode: components["schemas"]["TerminationPolicy"];
         };
         /**
-         * @description What the cancellation would return, subscription by subscription and in total, as of now.
+         * @description What the cancellation would return, subscription by subscription and in total, as of now. Give
+         *     `proration_date` and `refundable_amount` when creating the cancellation.
          *
          *     - `unused_amount`: before tax, the value of the paid service still unused, whatever the refund
          *       terms say.
@@ -1236,7 +1325,7 @@ export interface components {
             forfeited_amount: components["schemas"]["Money"];
             items: components["schemas"]["CancellationRefundPreviewItem"][];
         };
-        /** @description One subscription of the preview. The amounts mean what they mean in the preview. */
+        /** @description One subscription of the quoted cancellation. The amounts mean what they mean in the total. */
         CancellationRefundPreviewItem: {
             /** Format: uuid */
             subscription_id: string;
@@ -1255,16 +1344,16 @@ export interface components {
             forfeited_amount: components["schemas"]["Money"];
         };
         CancellationCreate: {
-            /** @description As in the preview. */
+            /** @description As in the quote. */
             subscription_ids: string[];
             mode: components["schemas"]["TerminationPolicy"];
             /**
              * Format: date-time
-             * @description For `immediate`, the `proration_date` of the preview: a whole second, not in the future and
+             * @description For `immediate`, the `proration_date` of the quote: a whole second, not in the future and
              *     at most ten minutes old. The refund is computed as of it. Now when omitted.
              */
             proration_date?: string;
-            /** @description The `refundable_amount` of the preview. The cancellation is refused when the refund differs. */
+            /** @description The `refundable_amount` of the quote. The cancellation is refused when the refund differs. */
             expected_refundable_amount: string;
             /** @description A note from the account holder. It is kept with the cancellation and not shown elsewhere. */
             reason?: string;
@@ -2801,9 +2890,33 @@ export interface components {
              */
             plan_name: string;
             quantity: string;
+            /**
+             * @description The unit amount of the price this line is charged under. Absent for a tiered price, which has no
+             *     single unit amount, and for a change that takes effect at once, which is charged the prorated
+             *     difference.
+             */
             unit_amount?: components["schemas"]["Money"];
+            /**
+             * @description Before discounts: the price applied to the quantity, which for a per-unit price is `unit_amount`
+             *     times `quantity`; a minimum charge can make it higher. For a change that takes effect at once it is
+             *     the prorated difference. The setup fee is not part of it; see `setup_amount`.
+             *
+             *     Under an inclusive tax rate it includes tax, as the price does, and the included part is
+             *     `tax_included_amount`. A renewal at the agreed terms is the exception: the agreed amount excludes
+             *     tax, and tax is added to it.
+             */
             gross_amount?: components["schemas"]["Money"];
+            /**
+             * @description The reduction on this line: from the coupon the order uses and, for a renewal at the agreed terms,
+             *     from the discount the subscription carries.
+             *
+             *     A carried discount is part of the agreed amount. It is listed here, and `gross_amount` is then
+             *     `unit_amount` times `quantity`, except in two cases where `gross_amount` is the agreed amount and
+             *     the carried discount is already reflected in it: the renewal order also uses a coupon the account
+             *     holds, or the account's tax rate is inclusive.
+             */
             discount_amount?: components["schemas"]["Money"];
+            /** @description `gross_amount` less `discount_amount`. */
             amount?: components["schemas"]["Money"];
             currency: string;
             /** Format: date-time */
@@ -3978,7 +4091,7 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
-    "create-cancellation-preview": {
+    "create-quote": {
         parameters: {
             query?: never;
             header?: never;
@@ -3987,7 +4100,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["CancellationPreviewRequest"];
+                "application/json": components["schemas"]["QuoteRequest"];
             };
         };
         responses: {
@@ -3997,7 +4110,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["CancellationRefundPreview"];
+                    "application/json": components["schemas"]["Quote"];
                 };
             };
             default: components["responses"]["Error"];

package/dist/billing/project/v1/index.d.ts

@@ -19,10 +19,6 @@ export type ListProjectSubscriptionsQuery = operations["list-project-subscriptio
 export type SetProjectAutoRenewResult = operations["set-project-auto-renew"]["responses"][200]["content"]["application/json"];
 /** The request body of `PUT /api/v1/projects/{projectId}/subscriptions/{subscriptionId}/auto-renew`. */
 export type SetProjectAutoRenewBody = NonNullable<operations["set-project-auto-renew"]["requestBody"]>["content"]["application/json"];
-/** The success response body of `POST /api/v1/projects/{projectId}/cancellations/preview`. */
-export type CreateProjectCancellationPreviewResult = operations["create-project-cancellation-preview"]["responses"][200]["content"]["application/json"];
-/** The request body of `POST /api/v1/projects/{projectId}/cancellations/preview`. */
-export type CreateProjectCancellationPreviewBody = NonNullable<operations["create-project-cancellation-preview"]["requestBody"]>["content"]["application/json"];
 /** The success response body of `POST /api/v1/projects/{projectId}/cancellations`. */
 export type CreateProjectCancellationResult = operations["create-project-cancellation"]["responses"][200]["content"]["application/json"];
 /** The request body of `POST /api/v1/projects/{projectId}/cancellations`. */

package/dist/billing/project/v1/schema.d.ts

@@ -121,33 +121,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/api/v1/projects/{projectId}/cancellations/preview": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                projectId: components["parameters"]["ProjectId"];
-            };
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Preview a cancellation
-         * @description What canceling these subscriptions together would return, computed now under the refund terms
-         *     agreed when each was bought. This request does not create a resource: nothing is recorded or
-         *     reserved.
-         *
-         *     It is refused with the same errors as creating the cancellation, except that the amount is not
-         *     checked. Give the returned `proration_date` and `refundable_amount` when creating it.
-         */
-        post: operations["create-project-cancellation-preview"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/api/v1/projects/{projectId}/cancellations": {
         parameters: {
             query?: never;
@@ -197,9 +170,8 @@ export interface paths {
          *       (`meta.cancellation_id`) or reclaimed (`meta.job_id`);
          *     - 409 `BILLING_ORDER_PAYMENT_IN_FLIGHT` while an online payment for a renewal of one of them
          *       is in progress;
-         *     - 422 `BILLING_CANCELLATION_UNSUPPORTED` when the service cannot yet be canceled here;
          *     - 409 `BILLING_CANCELLATION_REFUND_CHANGED` when the refund is no longer
-         *       `expected_refundable_amount`; preview again.
+         *       `expected_refundable_amount`; quote again.
          *
          *     Sending the same request again, for the same subscriptions, mode and amount while that
          *     cancellation is still open, returns it with 200 rather than creating another. Renewal orders
@@ -345,8 +317,15 @@ export interface paths {
          *     A renewal is priced exactly as renewing would charge it: at the agreed amount or the price
          *     named, with the discounts the account holds, and with tax.
          *
-         *     Returns 404 when the project has no billing account, or when a subscription to be renewed
-         *     does not belong to this project.
+         *     A cancellation is quoted as creating it would compute the refund, as of now and under the refund
+         *     terms agreed when each subscription was bought. It is quoted on its own: combined with lines or
+         *     renewals the request is refused with HTTP 400 `BILLING_PURCHASE_INVALID` and `meta.field`
+         *     `cancellation`. It is refused with the same errors as creating the cancellation, except that the
+         *     amount is not checked. Give the returned `cancellation.proration_date` and
+         *     `cancellation.refundable_amount` when creating it.
+         *
+         *     Returns 404 when the project has no billing account, or when a subscription to be renewed or
+         *     canceled does not belong to this project.
          */
         post: operations["create-project-quote"];
         delete?: never;
@@ -439,13 +418,18 @@ export interface components {
          * @enum {string}
          */
         RefundPolicy: "none" | "prorated";
-        CancellationPreviewRequest: {
+        /**
+         * @description A cancellation to quote: what ending these subscriptions together would return. One mode per
+         *     request; to compare, quote `immediate` and `period_end` separately.
+         */
+        QuoteCancellation: {
             /** @description The subscriptions to end together, all of one service. Every subscription released with a resource must be included. */
             subscription_ids: string[];
             mode: components["schemas"]["TerminationPolicy"];
         };
         /**
-         * @description What the cancellation would return, subscription by subscription and in total, as of now.
+         * @description What the cancellation would return, subscription by subscription and in total, as of now. Give
+         *     `proration_date` and `refundable_amount` when creating the cancellation.
          *
          *     - `unused_amount`: before tax, the value of the paid service still unused, whatever the refund
          *       terms say.
@@ -479,7 +463,7 @@ export interface components {
             forfeited_amount: components["schemas"]["Money"];
             items: components["schemas"]["CancellationRefundPreviewItem"][];
         };
-        /** @description One subscription of the preview. The amounts mean what they mean in the preview. */
+        /** @description One subscription of the quoted cancellation. The amounts mean what they mean in the total. */
         CancellationRefundPreviewItem: {
             /** Format: uuid */
             subscription_id: string;
@@ -498,16 +482,16 @@ export interface components {
             forfeited_amount: components["schemas"]["Money"];
         };
         CancellationCreate: {
-            /** @description As in the preview. */
+            /** @description As in the quote. */
             subscription_ids: string[];
             mode: components["schemas"]["TerminationPolicy"];
             /**
              * Format: date-time
-             * @description For `immediate`, the `proration_date` of the preview: a whole second, not in the future and
+             * @description For `immediate`, the `proration_date` of the quote: a whole second, not in the future and
              *     at most ten minutes old. The refund is computed as of it. Now when omitted.
              */
             proration_date?: string;
-            /** @description The `refundable_amount` of the preview. The cancellation is refused when the refund differs. */
+            /** @description The `refundable_amount` of the quote. The cancellation is refused when the refund differs. */
             expected_refundable_amount: string;
             /** @description A note from the account holder. It is kept with the cancellation and not shown elsewhere. */
             reason?: string;
@@ -712,10 +696,14 @@ export interface components {
              */
             periods?: number;
         };
-        /** @description Specify lines for new purchases and renewals for existing subscriptions. The total includes all requested items. */
+        /**
+         * @description Specify lines for new purchases and renewals for existing subscriptions, or one cancellation on
+         *     its own. The total includes all requested lines and renewals.
+         */
         QuoteRequest: {
             lines?: components["schemas"]["QuoteLine"][];
             renewals?: components["schemas"]["QuoteRenewal"][];
+            cancellation?: components["schemas"]["QuoteCancellation"];
         };
         QuoteLineResult: {
             /** @description Tax included in the account quote. Absent in public catalogue estimates. */
@@ -802,9 +790,12 @@ export interface components {
         Quote: {
             lines?: components["schemas"]["QuoteLineResult"][];
             renewals?: components["schemas"]["QuoteRenewalResult"][];
+            /** @description What the cancellation requested would return. Present only when one was requested. */
+            cancellation?: components["schemas"]["CancellationRefundPreview"];
             /**
              * @description What would be owed in total, renewals included. Amounts to be returned are not netted
-             *     off it.
+             *     off it: a quote of a cancellation alone has a total of zero, and what it would return is
+             *     in `cancellation`.
              *
              *     Null when any line could not be priced. What would be owed is not knowable then, and a
              *     total that silently left the unpriced lines out would read as a smaller bill rather than
@@ -1207,9 +1198,33 @@ export interface components {
              */
             plan_name: string;
             quantity: string;
+            /**
+             * @description The unit amount of the price this line is charged under. Absent for a tiered price, which has no
+             *     single unit amount, and for a change that takes effect at once, which is charged the prorated
+             *     difference.
+             */
             unit_amount?: components["schemas"]["Money"];
+            /**
+             * @description Before discounts: the price applied to the quantity, which for a per-unit price is `unit_amount`
+             *     times `quantity`; a minimum charge can make it higher. For a change that takes effect at once it is
+             *     the prorated difference. The setup fee is not part of it; see `setup_amount`.
+             *
+             *     Under an inclusive tax rate it includes tax, as the price does, and the included part is
+             *     `tax_included_amount`. A renewal at the agreed terms is the exception: the agreed amount excludes
+             *     tax, and tax is added to it.
+             */
             gross_amount?: components["schemas"]["Money"];
+            /**
+             * @description The reduction on this line: from the coupon the order uses and, for a renewal at the agreed terms,
+             *     from the discount the subscription carries.
+             *
+             *     A carried discount is part of the agreed amount. It is listed here, and `gross_amount` is then
+             *     `unit_amount` times `quantity`, except in two cases where `gross_amount` is the agreed amount and
+             *     the carried discount is already reflected in it: the renewal order also uses a coupon the account
+             *     holds, or the account's tax rate is inclusive.
+             */
             discount_amount?: components["schemas"]["Money"];
+            /** @description `gross_amount` less `discount_amount`. */
             amount?: components["schemas"]["Money"];
             currency: string;
             /** Format: date-time */
@@ -1531,33 +1546,6 @@ export interface operations {
             default: components["responses"]["Error"];
         };
     };
-    "create-project-cancellation-preview": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                projectId: components["parameters"]["ProjectId"];
-            };
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["CancellationPreviewRequest"];
-            };
-        };
-        responses: {
-            /** @description OK */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CancellationRefundPreview"];
-                };
-            };
-            default: components["responses"]["Error"];
-        };
-    };
     "list-project-cancellations": {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leaflow/sdk",
-  "version": "0.0.0-dev.236.gebd337c",
+  "version": "0.0.0-dev.240.gecb1b07",
   "description": "Leaflow 平台 API 的 TypeScript SDK",
   "license": "MIT",
   "repository": {