@leaflow/sdk 0.213.1 → 0.215.0

package/dist/billing/v1/generated/functions.js

@@ -266,7 +266,7 @@ export const getListCurrenciesUrl = (params) => {
         : `https://billing.leaflow.cloud/api/v1/currencies`;
 };
 /**
- * Currencies a new billing account can be opened in, and prices and quotes without an account can be given in, for anyone, signed in or not. Retired currencies are not listed.
+ * Currencies a new billing account can be opened in, and prices and checkout previews without an account can be given in, for anyone, signed in or not. Retired currencies are not listed.
  * @summary List currencies accounts can be opened in
  */
 export const listCurrencies = async (params, options, fetchFn) => {
@@ -1045,6 +1045,49 @@ export const listAccountDiscounts = async (params, options, fetchFn) => {
     const data = body ? JSON.parse(body) : {};
     return { data, status: res.status, headers: res.headers };
 };
+export const getListTrialGrantsUrl = (params) => {
+    const normalizedParams = new URLSearchParams();
+    Object.entries(params || {}).forEach(([key, value]) => {
+        if (value !== undefined) {
+            normalizedParams.append(key, value === null ? "null" : String(value));
+        }
+    });
+    const stringifiedParams = normalizedParams.toString();
+    return stringifiedParams.length > 0
+        ? `https://billing.leaflow.cloud/api/v1/trial-grants?${stringifiedParams}`
+        : `https://billing.leaflow.cloud/api/v1/trial-grants`;
+};
+/**
+ * Free trials held by your billing accounts. Choose an available grant when checking out a purchase its offer
+ * covers, by saving its ID as `trial_grant_id` on the Checkout Session; a session and its preview list the grants that
+ * can be used for it.
+ * @summary List free trial grants
+ */
+export const listTrialGrants = async (params, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getListTrialGrantsUrl(params), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
+export const getGetTrialGrantUrl = (trialGrantId) => {
+    return `https://billing.leaflow.cloud/api/v1/trial-grants/${encodeURIComponent(String(trialGrantId))}`;
+};
+/**
+ * A free trial held by one of your billing accounts. Returns 404 if it does not exist or is not yours.
+ * @summary Get a free trial grant
+ */
+export const getTrialGrant = async (trialGrantId, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getGetTrialGrantUrl(trialGrantId), {
+        ...options,
+        method: "GET",
+    });
+    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
+    const data = body ? JSON.parse(body) : {};
+    return { data, status: res.status, headers: res.headers };
+};
 export const getListCreditGrantsUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1327,53 +1370,6 @@ export const cancelSubscription = async (subscriptionId, cancelSubscriptionReque
     const data = body ? JSON.parse(body) : {};
     return { data, status: res.status, headers: res.headers };
 };
-export const getGetQuoteUrl = () => {
-    return `https://billing.leaflow.cloud/api/v1/quotes`;
-};
-/**
- * Calculates what a proposed purchase, a change of your subscriptions or their renewal would invoice now, and
- * what each purchased or changed line renews at. Nothing is saved, reserved or redeemed.
- *
- * With `billing_account_id`, the quote is for that billing account: its currency, account discounts,
- * tax and funds apply, changes and renewals use the account currently paying for each subscription, and an
- * access token is required. The account must be yours or currently pay for a project you are a member of.
- * Without it, proposed items are priced in `currency` for anyone, signed in or not: no account discount or funds
- * apply, and tax that would be added is included only for the customer's `address`.
- *
- * A change is priced as the service that owns the subscription would order it: pass the returned `total` as the
- * expected amount and, for an immediate change, `proration_date` to that service when making the change.
- *
- * A promotion code is evaluated without being applied. It is applied only when a Checkout Session is completed
- * with it; conditions that depend on the account, such as a first purchase, are checked only with an account
- * and otherwise reported as `unverified`. Future usage of metered prices is estimated with `estimate-usage`.
- * @summary Get a quote
- */
-export const getQuote = async (quoteRequest, options, fetchFn) => {
-    const getHeaders = (h) => {
-        if (!h)
-            return {};
-        if (h instanceof Headers)
-            return Object.fromEntries(h.entries());
-        if (Symbol.iterator in h) {
-            return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
-        }
-        const headers = {};
-        for (const [name, value] of Object.entries(h)) {
-            if (value !== undefined)
-                headers[name] = value;
-        }
-        return headers;
-    };
-    const res = await (fetchFn ?? fetch)(getGetQuoteUrl(), {
-        ...options,
-        method: "QUERY",
-        headers: { "Content-Type": "application/json", ...getHeaders(options?.headers) },
-        body: JSON.stringify(quoteRequest),
-    });
-    const body = [204, 205, 304].includes(res.status) ? null : await res.text();
-    const data = body ? JSON.parse(body) : {};
-    return { data, status: res.status, headers: res.headers };
-};
 export const getEstimateUsageUrl = () => {
     return `https://billing.leaflow.cloud/api/v1/usage-estimates`;
 };
@@ -1452,8 +1448,9 @@ export const getCreateCancellationUrl = () => {
  *
  * `mode` must be allowed for every item. Metered and one-time items end only `immediate`. A licensed item ends
  * `period_end` while its subscription's paid term lasts, and `immediate` unless its terms allow only the end of
- * the paid term and that term has not ended. For `period_end` the paid terms of all items must end at the same
- * time.
+ * the paid term and that term has not ended. During a free trial a licensed item ends either way whatever its
+ * terms, `period_end` meaning the end of the trial, and nothing is refunded. For `period_end` the paid terms of
+ * all items must end at the same time.
  *
  * Refused with:
  *
@@ -1676,7 +1673,8 @@ export const getListCheckoutSessionsUrl = (params) => {
         : `https://billing.leaflow.cloud/api/v1/checkout-sessions`;
 };
 /**
- * Checkout Sessions of your billing accounts, newest first; members of a project list its sessions with `project_ids`. An open session is a purchase waiting for checkout to be completed.
+ * Checkout Sessions of your billing accounts, newest first; members of a project list its sessions with
+ * `project_ids`. An open session is a purchase waiting for checkout to be completed.
  * @summary List Checkout Sessions
  */
 export const listCheckoutSessions = async (params, options, fetchFn) => {
@@ -1695,9 +1693,10 @@ export const getCreateCheckoutSessionUrl = () => {
  * Opens a Checkout Session renewing one or more subscriptions in one order, such as a machine and the separately
  * bought volumes and elastic IPs attached to it, with periods and price chosen as in renewing. Every subscription
  * must be paid by the same billing account and belong to the same project and service. Nothing is charged until
- * you complete it, when a promotion code can be applied; each subscription then renews from its current_term_end
- * at that time. To renew one subscription at once from credit grants, balance or a payment method, renew the
- * subscription instead. Purchases and changes of a service's resources are created through that service.
+ * you complete it; save a promotion code on it first with `update-checkout-session`. Each subscription then renews
+ * from its current_term_end at that time. To renew one subscription at once from credit grants, balance or a
+ * payment method, renew the subscription instead. Purchases and changes of a service's resources are created
+ * through that service.
  *
  * Open to the owner of the subscriptions' current billing account and to members of their project with the
  * project permission `billing:finance.manage`. Keep `checkout_session_id` and read the session after an
@@ -1730,40 +1729,65 @@ export const createCheckoutSession = async (checkoutSessionCreate, options, fetc
     const data = body ? JSON.parse(body) : {};
     return { data, status: res.status, headers: res.headers };
 };
-export const getGetCheckoutSessionUrl = (checkoutSessionId) => {
-    return `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}`;
+export const getPreviewCheckoutSessionUrl = () => {
+    return `https://billing.leaflow.cloud/api/v1/checkout-sessions:preview`;
 };
 /**
- * A Checkout Session of your billing account or of a project you are a member of. Poll it to follow checkout; once it is complete, read its order for payment and delivery. An unknown session returns 404; any other session returns 403.
- * @summary Get a Checkout Session
+ * What a Checkout Session for a purchase, a change of your subscriptions or their renewal would invoice if it
+ * were completed now, returned as a session that is not saved: it has no `id`, and nothing is ordered, reserved
+ * or redeemed. Use it to show prices before buying; the service that sells a resource creates the session for its
+ * purchase or change, and you create renewal sessions here.
+ *
+ * With `billing_account_id` the preview is for that billing account: its currency, account discounts, tax,
+ * funds and free trial grants apply, changes and renewals use the account currently paying for each
+ * subscription, and an access token is required. The account must be yours or currently pay for a project you
+ * are a member of. Without it, a purchase is priced in `currency` for anyone, signed in or not: no account
+ * discount, funds or trial grant apply, and tax that would be added is included only for `address`.
+ *
+ * A promotion code is evaluated without being applied; conditions that depend on the account, such as a first
+ * purchase, are checked only with an account and otherwise reported as `unverified`. An invalid or inapplicable
+ * code or trial grant fails the request. Future usage of metered prices is estimated with `estimate-usage`.
+ * @summary Preview a Checkout Session
  */
-export const getCheckoutSession = async (checkoutSessionId, options, fetchFn) => {
-    const res = await (fetchFn ?? fetch)(getGetCheckoutSessionUrl(checkoutSessionId), {
+export const previewCheckoutSession = async (checkoutSessionPreviewRequest, options, fetchFn) => {
+    const getHeaders = (h) => {
+        if (!h)
+            return {};
+        if (h instanceof Headers)
+            return Object.fromEntries(h.entries());
+        if (Symbol.iterator in h) {
+            return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+        }
+        const headers = {};
+        for (const [name, value] of Object.entries(h)) {
+            if (value !== undefined)
+                headers[name] = value;
+        }
+        return headers;
+    };
+    const res = await (fetchFn ?? fetch)(getPreviewCheckoutSessionUrl(), {
         ...options,
-        method: "GET",
+        method: "QUERY",
+        headers: { "Content-Type": "application/json", ...getHeaders(options?.headers) },
+        body: JSON.stringify(checkoutSessionPreviewRequest),
     });
     const body = [204, 205, 304].includes(res.status) ? null : await res.text();
     const data = body ? JSON.parse(body) : {};
     return { data, status: res.status, headers: res.headers };
 };
-export const getListCheckoutSessionItemsUrl = (checkoutSessionId, params) => {
-    const normalizedParams = new URLSearchParams();
-    Object.entries(params || {}).forEach(([key, value]) => {
-        if (value !== undefined) {
-            normalizedParams.append(key, value === null ? "null" : String(value));
-        }
-    });
-    const stringifiedParams = normalizedParams.toString();
-    return stringifiedParams.length > 0
-        ? `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}/items?${stringifiedParams}`
-        : `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}/items`;
+export const getGetCheckoutSessionUrl = (checkoutSessionId) => {
+    return `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}`;
 };
 /**
- * What the session buys, by position. Prices and amounts are in its quote. Readable by whoever can read the session.
- * @summary List Checkout Session items
+ * A Checkout Session of your billing account or of a project you are a member of, with what completing it now
+ * would invoice under the choices saved on it. A saved promotion code or trial grant that can no longer be applied
+ * is left out of the amounts; `discount` and the subscriptions' `trial_grant_id` show what applies, and confirming
+ * fails until the session is updated. Poll it to follow checkout; once it is complete, read its order for payment
+ * and delivery. An unknown session returns 404; any other session returns 403.
+ * @summary Get a Checkout Session
  */
-export const listCheckoutSessionItems = async (checkoutSessionId, params, options, fetchFn) => {
-    const res = await (fetchFn ?? fetch)(getListCheckoutSessionItemsUrl(checkoutSessionId, params), {
+export const getCheckoutSession = async (checkoutSessionId, options, fetchFn) => {
+    const res = await (fetchFn ?? fetch)(getGetCheckoutSessionUrl(checkoutSessionId), {
         ...options,
         method: "GET",
     });
@@ -1771,35 +1795,45 @@ export const listCheckoutSessionItems = async (checkoutSessionId, params, option
     const data = body ? JSON.parse(body) : {};
     return { data, status: res.status, headers: res.headers };
 };
-export const getGetCheckoutSessionQuoteUrl = (checkoutSessionId, params) => {
-    const normalizedParams = new URLSearchParams();
-    Object.entries(params || {}).forEach(([key, value]) => {
-        if (value !== undefined) {
-            normalizedParams.append(key, value === null ? "null" : String(value));
-        }
-    });
-    const stringifiedParams = normalizedParams.toString();
-    return stringifiedParams.length > 0
-        ? `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}/quote?${stringifiedParams}`
-        : `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}/quote`;
+export const getUpdateCheckoutSessionUrl = (checkoutSessionId) => {
+    return `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}`;
 };
 /**
- * What completing this open session now would invoice, with `promotion_code` or otherwise the best applicable
- * account discount, and the account funds available for it. Nothing is applied, reserved or redeemed. An invalid
- * or inapplicable code fails the request without changing the session.
+ * Saves your checkout choices on an open session: a promotion code, a free trial grant and automatic renewal.
+ * Choices left out keep their values, and null removes a code or a grant. The session is returned with its
+ * amounts calculated under the new choices; nothing is redeemed until it is completed.
  *
- * Complete the session with the returned `total` as `expected_amount`, the same `promotion_code` and, for an
- * immediate change, the returned `proration_date`. An expired session is refused with
- * `BILLING_CHECKOUT_SESSION_EXPIRED`, and a complete one with `BILLING_CHECKOUT_SESSION_COMPLETE`; read its order
- * instead.
+ * A code that does not exist or cannot be applied is refused with its promotion error, and a grant that cannot be
+ * used with `BILLING_TRIAL_GRANT_INAPPLICABLE`; the session is then unchanged. A grant applies to the first new
+ * subscription of the session whose lines its offer all covers, and that has a licensed line and no trial of its
+ * own. `auto_renew` turns automatic renewal on or off for every subscription with licensed items the session
+ * opens; for a free trial, it decides whether the trial converts to paid when it ends. A session that is not
+ * open is refused with `BILLING_CHECKOUT_SESSION_COMPLETE` or `BILLING_CHECKOUT_SESSION_EXPIRED`.
  *
  * Open to the owner of the session's billing account and to members of its project.
- * @summary Quote a Checkout Session
+ * @summary Update a Checkout Session
  */
-export const getCheckoutSessionQuote = async (checkoutSessionId, params, options, fetchFn) => {
-    const res = await (fetchFn ?? fetch)(getGetCheckoutSessionQuoteUrl(checkoutSessionId, params), {
+export const updateCheckoutSession = async (checkoutSessionId, checkoutSessionUpdate, options, fetchFn) => {
+    const getHeaders = (h) => {
+        if (!h)
+            return {};
+        if (h instanceof Headers)
+            return Object.fromEntries(h.entries());
+        if (Symbol.iterator in h) {
+            return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+        }
+        const headers = {};
+        for (const [name, value] of Object.entries(h)) {
+            if (value !== undefined)
+                headers[name] = value;
+        }
+        return headers;
+    };
+    const res = await (fetchFn ?? fetch)(getUpdateCheckoutSessionUrl(checkoutSessionId), {
         ...options,
-        method: "GET",
+        method: "PATCH",
+        headers: { "Content-Type": "application/json", ...getHeaders(options?.headers) },
+        body: JSON.stringify(checkoutSessionUpdate),
     });
     const body = [204, 205, 304].includes(res.status) ? null : await res.text();
     const data = body ? JSON.parse(body) : {};
@@ -1809,11 +1843,13 @@ export const getConfirmCheckoutSessionUrl = (checkoutSessionId) => {
     return `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}:confirm`;
 };
 /**
- * Completes an open session: applies `promotion_code`, or otherwise the best applicable account discount, checks
- * the total against `expected_amount` and creates the order with its invoice issued. A zero-total invoice is paid
- * at once; otherwise pay the invoice next. A failed payment leaves the order and its terms as they are, and the
- * invoice can be paid again until the order expires. Nothing is created when the code is invalid or
- * inapplicable or the total differs, which fails with `BILLING_AMOUNT_CHANGED`.
+ * Completes an open session under the choices saved on it: its promotion code, or otherwise the best applicable
+ * account discount, and its free trial grant. Checks the total against `expected_amount` and creates the order
+ * with its invoice issued. A zero-total invoice is paid at once; otherwise pay the invoice next. A failed payment
+ * leaves the order and its terms as they are, and the invoice can be paid again until the order expires. Nothing
+ * is created when the total differs, which fails with `BILLING_AMOUNT_CHANGED`, or when a saved code or grant can
+ * no longer be applied, which fails with its error until the session is updated. A trial grant used by an order
+ * that is later canceled or fails can be used again.
  *
  * Confirming a complete session again with the same terms returns it with its order; different terms are refused
  * with `BILLING_CHECKOUT_SESSION_COMPLETE`. An expired session is refused with `BILLING_CHECKOUT_SESSION_EXPIRED`.
@@ -1852,7 +1888,9 @@ export const getExpireCheckoutSessionUrl = (checkoutSessionId) => {
     return `https://billing.leaflow.cloud/api/v1/checkout-sessions/${encodeURIComponent(String(checkoutSessionId))}:expire`;
 };
 /**
- * Ends an open session without an order; the service that created it releases what it was holding for the purchase. An expired session is returned unchanged. Open to the owner of the session's billing account and to members of its project.
+ * Ends an open session without an order; the service that created it releases what it was holding for
+ * the purchase. An expired session is returned unchanged. Open to the owner of the session's billing account and
+ * to members of its project.
  * @summary Expire a Checkout Session
  */
 export const expireCheckoutSession = async (checkoutSessionId, options, fetchFn) => {