@leaflow/sdk 0.125.0 → 0.126.0

package/dist/compute/v1/generated/validators/statementType.zod.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Compute API
+ * Leaflow Compute user API for managing instances, disks, snapshots, backups, images, private networks, subnets, routes, security groups, network interfaces and floating IPs.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `scopedTokenAuth` security scheme.
+ *
+ * ## Conventions
+ *
+ * - **Purchases.** A purchase that creates resources returns them together with a PlacedOrder. They are readable at once and start as `pending`: the order has not been accepted, nothing exists in the cloud, no inventory such as an address is held, and fields known only after allocation, such as addresses, are null. Once Billing accepts the order, a resource becomes `provisioning` and then reaches its usual status, such as `active` or `available`. When the order is declined, canceled or expires, or creation fails, the resource ends `failed` and `failure_reason` states why; the charge for a resource that failed after acceptance is refunded. Read the order in Billing for checkout and payment progress.
+ * - **Pricing.** Catalog items, such as instance types, disk types and public IP pools, carry `pricing`: the prepaid and postpaid options Billing offers for them, in the currency of the project's current billing account, or null when the project has no billing account. They are list amounts before promotion codes, not a checkout guarantee. A purchase chooses one option with `billing`, which applies to all of its components. Every purchase and change has a quote operation beside it, at the same path followed by `/quote`, which returns what checkout would collect without ordering anything.
+ * - **Checkout.** Omit `checkout` for automatic checkout, which pays from eligible credit grants and balance when the order is placed; insufficient funds refuse the request with HTTP 422 `BILLING_INSUFFICIENT_FUNDS`, and nothing is created. With `checkout.mode` set to `deferred`, the resources are returned `pending` and nothing is created until checkout is confirmed and paid through Billing. An order whose total is zero, such as a postpaid purchase with nothing due now, completes checkout at placement in either mode and proceeds to provisioning.
+ * - **Operations.** Requests such as starting, stopping, attaching or deleting return HTTP 202 with the resource as it is when the request is accepted. While an operation runs, the resource's `operation` field names it; the field is null once the operation has finished, and the resource then shows the result. A resource with an operation in progress refuses another operation with HTTP 409 `COMPUTE_RESOURCE_BUSY`; an operation involving two resources, such as attaching a disk, is refused when either has one. A purchased change, such as a resize, is an operation from the moment its order is placed until it is applied or its order is canceled, including while it awaits checkout. Renaming and replacing labels or notes are not operations and are accepted at any time.
+ * - **Billing relationships.** A purchased resource records its `order_id`, `order_item_id` and `subscription_id`. The subscription is `pending` until the order is accepted, `provisioning` while the resource is created, and `active` once it is delivered. Bandwidth is a property of its floating IP, not a separate resource. Snapshots use a purchased per-region count quota, and backups are metered on the region's backup service; neither has an order or subscription of its own.
+ * - **Availability zones.** A disk and an instance must reside in the same availability zone to be attached. Instance types and disk types are each bound to one availability zone, so choosing a type determines the zone.
+ * - **IPv6 is not sold separately.** Once enabled on a private network, IPv6 addresses are assigned to the instances in that network automatically; they can be neither requested nor released individually.
+ * - **Floating IPs have a cooldown period.** A released address is neither available for re-allocation nor handed to another user for some time, so that DNS records and allow-lists still pointing at it do not break immediately.
+ * - **Passwords are returned once.** A password generated by the platform during creation or rebuild appears only in that response. Store it immediately.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const StatementType: zod.ZodEnum<{
+    interim: "interim";
+    final: "final";
+    supplement: "supplement";
+}>;
+export type StatementType = zod.input<typeof StatementType>;
+export type StatementTypeOutput = zod.output<typeof StatementType>;

package/dist/compute/v1/generated/validators/statementType.zod.js

@@ -0,0 +1,27 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Compute API
+ * Leaflow Compute user API for managing instances, disks, snapshots, backups, images, private networks, subnets, routes, security groups, network interfaces and floating IPs.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `scopedTokenAuth` security scheme.
+ *
+ * ## Conventions
+ *
+ * - **Purchases.** A purchase that creates resources returns them together with a PlacedOrder. They are readable at once and start as `pending`: the order has not been accepted, nothing exists in the cloud, no inventory such as an address is held, and fields known only after allocation, such as addresses, are null. Once Billing accepts the order, a resource becomes `provisioning` and then reaches its usual status, such as `active` or `available`. When the order is declined, canceled or expires, or creation fails, the resource ends `failed` and `failure_reason` states why; the charge for a resource that failed after acceptance is refunded. Read the order in Billing for checkout and payment progress.
+ * - **Pricing.** Catalog items, such as instance types, disk types and public IP pools, carry `pricing`: the prepaid and postpaid options Billing offers for them, in the currency of the project's current billing account, or null when the project has no billing account. They are list amounts before promotion codes, not a checkout guarantee. A purchase chooses one option with `billing`, which applies to all of its components. Every purchase and change has a quote operation beside it, at the same path followed by `/quote`, which returns what checkout would collect without ordering anything.
+ * - **Checkout.** Omit `checkout` for automatic checkout, which pays from eligible credit grants and balance when the order is placed; insufficient funds refuse the request with HTTP 422 `BILLING_INSUFFICIENT_FUNDS`, and nothing is created. With `checkout.mode` set to `deferred`, the resources are returned `pending` and nothing is created until checkout is confirmed and paid through Billing. An order whose total is zero, such as a postpaid purchase with nothing due now, completes checkout at placement in either mode and proceeds to provisioning.
+ * - **Operations.** Requests such as starting, stopping, attaching or deleting return HTTP 202 with the resource as it is when the request is accepted. While an operation runs, the resource's `operation` field names it; the field is null once the operation has finished, and the resource then shows the result. A resource with an operation in progress refuses another operation with HTTP 409 `COMPUTE_RESOURCE_BUSY`; an operation involving two resources, such as attaching a disk, is refused when either has one. A purchased change, such as a resize, is an operation from the moment its order is placed until it is applied or its order is canceled, including while it awaits checkout. Renaming and replacing labels or notes are not operations and are accepted at any time.
+ * - **Billing relationships.** A purchased resource records its `order_id`, `order_item_id` and `subscription_id`. The subscription is `pending` until the order is accepted, `provisioning` while the resource is created, and `active` once it is delivered. Bandwidth is a property of its floating IP, not a separate resource. Snapshots use a purchased per-region count quota, and backups are metered on the region's backup service; neither has an order or subscription of its own.
+ * - **Availability zones.** A disk and an instance must reside in the same availability zone to be attached. Instance types and disk types are each bound to one availability zone, so choosing a type determines the zone.
+ * - **IPv6 is not sold separately.** Once enabled on a private network, IPv6 addresses are assigned to the instances in that network automatically; they can be neither requested nor released individually.
+ * - **Floating IPs have a cooldown period.** A released address is neither available for re-allocation nor handed to another user for some time, so that DNS records and allow-lists still pointing at it do not break immediately.
+ * - **Passwords are returned once.** A password generated by the platform during creation or rebuild appears only in that response. Store it immediately.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export const StatementType = zod
+    .enum(["interim", "final", "supplement"])
+    .describe("interim: a closing before the period's usage is final; minimum charges are not applied. final: the first closing after the period ended and its late usage was settled; minimum charges for the whole period are applied. supplement: a closing after the final one, for usage priced late. An open statement is interim.");

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export * as canopy from "./canopy/v1/index.js";
 export * as compute from "./compute/v1/index.js";
 export * as dns from "./dns/v1/index.js";
 export * as iam from "./iam/v1/index.js";
+export * as membership from "./membership/v1/index.js";
 export * as monitoring from "./monitoring/v1/index.js";
 export * as notification from "./notification/v1/index.js";
 export * as support from "./support/v1/index.js";

package/dist/index.js

@@ -5,6 +5,7 @@ export * as canopy from "./canopy/v1/index.js";
 export * as compute from "./compute/v1/index.js";
 export * as dns from "./dns/v1/index.js";
 export * as iam from "./iam/v1/index.js";
+export * as membership from "./membership/v1/index.js";
 export * as monitoring from "./monitoring/v1/index.js";
 export * as notification from "./notification/v1/index.js";
 export * as support from "./support/v1/index.js";

package/dist/membership/v1/generated/functions.d.ts

@@ -2,22 +2,7 @@
  * Generated by orval 🍺
  * Do not edit manually.
  * Leaflow Membership API
- * Membership plans and the memberships held by billing accounts.
- *
- * A membership is a prepaid subscription sold through Billing. For each paid period it issues the plan's benefits to the billing account. A plan can carry several benefits across services: credit for chosen services, coupons on purchases and metered usage, and usage allowances such as model tokens, and access to features of other services. Benefits are shared by every project paid for by the account.
- *
- * ## Authentication
- *
- * Plans are public. Memberships require an access token; see the `accessTokenAuth` security scheme. Only the owner of a billing account can read or change its membership; anyone else receives 403 `MEMBERSHIP_ACCOUNT_FORBIDDEN`.
- *
- * ## Conventions
- *
- * - **One membership per billing account.** A pending or active membership must end before another is bought; change plans with upgrade and downgrade instead.
- * - **Payment goes through Billing.** Purchases and upgrades return a Billing order. With `checkout.mode` `deferred`, pay the order's invoice through Billing. Benefits are issued once Billing reports the order ready; every order has an invoice, including a zero-total one, which is paid automatically.
- * - **Cancellation and auto-renewal are managed in Billing** on the membership's `subscription_id`. A cancellation takes effect at the end of the paid period without a refund, and the period's benefits remain until then.
- * - **An upgrade takes effect immediately** for the full difference between the two plans' period prices, whatever remains of the period. The difference in credit is issued in full and the new plan's discount applies from payment. Renewals are charged at the new plan's price.
- * - **A downgrade takes effect at the end of the paid period.** The current period keeps its benefits and nothing is refunded.
- * - **Amounts are decimal strings** in the billing account's currency. There is no currency conversion: a plan without a price or credit in the account's currency cannot be bought with it.
+ * Membership tiers and account memberships. Catalog queries support any configured currency; purchases use the billing account currency.
  * OpenAPI spec version: 1.0.0
  */
 import type { ErrorResponse, GetPlanParams, ListMembershipPeriodsParams, ListMembershipsParams, ListPlansParams, Membership, MembershipCreate, MembershipDowngrade, MembershipList, MembershipPurchase, MembershipUpgrade, PeriodList, Plan, PlanList } from "./models.js";
@@ -44,7 +29,7 @@ export type listPlansResponseError = listPlansResponseDefault & {
 export type listPlansResponse = listPlansResponseSuccess | listPlansResponseError;
 export declare const getListPlansUrl: (params?: ListPlansParams) => string;
 /**
- * Lists the plans on sale, in ascending rank, with their prices and benefits. No authentication is required.
+ * Lists tiers on sale with prices and benefits, ordered by rank.
  * @summary List plans
  */
 export declare const listPlans: (params?: ListPlansParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listPlansResponse>;
@@ -65,7 +50,7 @@ export type getPlanResponseError = getPlanResponseDefault & {
 export type getPlanResponse = getPlanResponseSuccess | getPlanResponseError;
 export declare const getGetPlanUrl: (planId: string, params?: GetPlanParams) => string;
 /**
- * Returns a plan on sale with its prices and benefits. No authentication is required.
+ * Returns a tier on sale with its prices and benefits.
  * @summary Get a plan
  */
 export declare const getPlan: (planId: string, params?: GetPlanParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<getPlanResponse>;
@@ -86,7 +71,7 @@ export type listMembershipsResponseError = listMembershipsResponseDefault & {
 export type listMembershipsResponse = listMembershipsResponseSuccess | listMembershipsResponseError;
 export declare const getListMembershipsUrl: (params: ListMembershipsParams) => string;
 /**
- * Lists the memberships of a billing account you own, newest first, including ended ones.
+ * Lists memberships of the specified account, including ended memberships, newest first.
  * @summary List memberships
  */
 export declare const listMemberships: (params: ListMembershipsParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listMembershipsResponse>;
@@ -107,10 +92,7 @@ export type createMembershipResponseError = createMembershipResponseDefault & {
 export type createMembershipResponse = createMembershipResponseSuccess | createMembershipResponseError;
 export declare const getCreateMembershipUrl: () => string;
 /**
- * Places a Billing order for the plan's price on a billing account you own, and returns the pending membership with the order.
- * The membership becomes active, and its first period's benefits are issued, once Billing reports the order ready.
- *
- * Fails with 409 `MEMBERSHIP_EXISTS` when the account already has a pending or active membership, and with 422 `MEMBERSHIP_PLAN_UNAVAILABLE` when the plan is not on sale or has no price or credit in the account's currency. Billing refusals, such as `BILLING_INSUFFICIENT_FUNDS`, are returned as Billing reports them.
+ * Places a purchase order and returns the membership and invoice. Activation follows successful benefit issuance and delivery confirmation. Returns 409 MEMBERSHIP_EXISTS or 422 MEMBERSHIP_PLAN_UNAVAILABLE.
  * @summary Buy a membership
  */
 export declare const createMembership: (membershipCreate: MembershipCreate, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<createMembershipResponse>;
@@ -151,7 +133,7 @@ export type listMembershipPeriodsResponseError = listMembershipPeriodsResponseDe
 export type listMembershipPeriodsResponse = listMembershipPeriodsResponseSuccess | listMembershipPeriodsResponseError;
 export declare const getListMembershipPeriodsUrl: (membershipId: string, params?: ListMembershipPeriodsParams) => string;
 /**
- * Lists the paid periods of a membership, newest first, each with the benefits issued for it.
+ * Lists fulfilled periods and their grants, newest first.
  * @summary List membership periods
  */
 export declare const listMembershipPeriods: (membershipId: string, params?: ListMembershipPeriodsParams, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<listMembershipPeriodsResponse>;
@@ -172,9 +154,7 @@ export type upgradeMembershipResponseError = upgradeMembershipResponseDefault &
 export type upgradeMembershipResponse = upgradeMembershipResponseSuccess | upgradeMembershipResponseError;
 export declare const getUpgradeMembershipUrl: (membershipId: string) => string;
 /**
- * Places a Billing order for the full difference between the current and the chosen plan's period prices. Once Billing reports it ready, the membership moves to the chosen plan for the rest of the period: the difference in credit is issued and the new plan's discount and allowances apply. Renewals are charged at the chosen plan's price.
- *
- * Fails with 409 `MEMBERSHIP_NOT_ACTIVE` unless the membership is active, and with 422 `MEMBERSHIP_UPGRADE_UNAVAILABLE` when the chosen plan does not rank above the current one or no upgrade is priced in the account's currency. A pending upgrade or a scheduled downgrade must finish or be canceled first (409 `MEMBERSHIP_CHANGE_PENDING`).
+ * Places an order for the full-period price difference. The upgrade takes effect after benefit issuance and delivery confirmation; renewal uses the target tier. Returns 409 MEMBERSHIP_NOT_ACTIVE or MEMBERSHIP_CHANGE_PENDING, or 422 MEMBERSHIP_UPGRADE_UNAVAILABLE.
  * @summary Upgrade a membership
  */
 export declare const upgradeMembership: (membershipId: string, membershipUpgrade: MembershipUpgrade, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<upgradeMembershipResponse>;
@@ -195,9 +175,7 @@ export type scheduleMembershipDowngradeResponseError = scheduleMembershipDowngra
 export type scheduleMembershipDowngradeResponse = scheduleMembershipDowngradeResponseSuccess | scheduleMembershipDowngradeResponseError;
 export declare const getScheduleMembershipDowngradeUrl: (membershipId: string) => string;
 /**
- * Schedules a move to a lower-ranked plan at the end of the paid period. Nothing is charged or refunded and the current period keeps its benefits. The membership's `scheduled_plan` shows the pending move.
- *
- * Fails with 409 `MEMBERSHIP_NOT_ACTIVE` unless the membership is active, 409 `MEMBERSHIP_CHANGE_PENDING` while another change is pending, and 422 `MEMBERSHIP_DOWNGRADE_INVALID` when the chosen plan does not rank below the current one or has no price in the account's currency for the membership's billing interval.
+ * Schedules a lower tier for the next period. Current benefits remain valid. Returns 409 MEMBERSHIP_NOT_ACTIVE or MEMBERSHIP_CHANGE_PENDING, or 422 MEMBERSHIP_DOWNGRADE_INVALID.
  * @summary Schedule a downgrade
  */
 export declare const scheduleMembershipDowngrade: (membershipId: string, membershipDowngrade: MembershipDowngrade, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<scheduleMembershipDowngradeResponse>;
@@ -218,7 +196,7 @@ export type cancelMembershipDowngradeResponseError = cancelMembershipDowngradeRe
 export type cancelMembershipDowngradeResponse = cancelMembershipDowngradeResponseSuccess | cancelMembershipDowngradeResponseError;
 export declare const getCancelMembershipDowngradeUrl: (membershipId: string) => string;
 /**
- * Keeps the current plan at renewal. Fails with 409 `MEMBERSHIP_CHANGE_PENDING` when no downgrade is scheduled.
+ * Cancels the scheduled downgrade. Returns 409 MEMBERSHIP_CHANGE_PENDING if none is scheduled.
  * @summary Cancel a scheduled downgrade
  */
 export declare const cancelMembershipDowngrade: (membershipId: string, options?: RequestInit, fetchFn?: typeof globalThis.fetch) => Promise<cancelMembershipDowngradeResponse>;

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

@@ -11,7 +11,7 @@ export const getListPlansUrl = (params) => {
         : `https://membership.leaflow.cloud/api/v1/plans`;
 };
 /**
- * Lists the plans on sale, in ascending rank, with their prices and benefits. No authentication is required.
+ * Lists tiers on sale with prices and benefits, ordered by rank.
  * @summary List plans
  */
 export const listPlans = async (params, options, fetchFn) => {
@@ -36,7 +36,7 @@ export const getGetPlanUrl = (planId, params) => {
         : `https://membership.leaflow.cloud/api/v1/plans/${encodeURIComponent(String(planId))}`;
 };
 /**
- * Returns a plan on sale with its prices and benefits. No authentication is required.
+ * Returns a tier on sale with its prices and benefits.
  * @summary Get a plan
  */
 export const getPlan = async (planId, params, options, fetchFn) => {
@@ -61,7 +61,7 @@ export const getListMembershipsUrl = (params) => {
         : `https://membership.leaflow.cloud/api/v1/memberships`;
 };
 /**
- * Lists the memberships of a billing account you own, newest first, including ended ones.
+ * Lists memberships of the specified account, including ended memberships, newest first.
  * @summary List memberships
  */
 export const listMemberships = async (params, options, fetchFn) => {
@@ -77,10 +77,7 @@ export const getCreateMembershipUrl = () => {
     return `https://membership.leaflow.cloud/api/v1/memberships`;
 };
 /**
- * Places a Billing order for the plan's price on a billing account you own, and returns the pending membership with the order.
- * The membership becomes active, and its first period's benefits are issued, once Billing reports the order ready.
- *
- * Fails with 409 `MEMBERSHIP_EXISTS` when the account already has a pending or active membership, and with 422 `MEMBERSHIP_PLAN_UNAVAILABLE` when the plan is not on sale or has no price or credit in the account's currency. Billing refusals, such as `BILLING_INSUFFICIENT_FUNDS`, are returned as Billing reports them.
+ * Places a purchase order and returns the membership and invoice. Activation follows successful benefit issuance and delivery confirmation. Returns 409 MEMBERSHIP_EXISTS or 422 MEMBERSHIP_PLAN_UNAVAILABLE.
  * @summary Buy a membership
  */
 export const createMembership = async (membershipCreate, options, fetchFn) => {
@@ -137,7 +134,7 @@ export const getListMembershipPeriodsUrl = (membershipId, params) => {
         : `https://membership.leaflow.cloud/api/v1/memberships/${encodeURIComponent(String(membershipId))}/periods`;
 };
 /**
- * Lists the paid periods of a membership, newest first, each with the benefits issued for it.
+ * Lists fulfilled periods and their grants, newest first.
  * @summary List membership periods
  */
 export const listMembershipPeriods = async (membershipId, params, options, fetchFn) => {
@@ -153,9 +150,7 @@ export const getUpgradeMembershipUrl = (membershipId) => {
     return `https://membership.leaflow.cloud/api/v1/memberships/${encodeURIComponent(String(membershipId))}/upgrade`;
 };
 /**
- * Places a Billing order for the full difference between the current and the chosen plan's period prices. Once Billing reports it ready, the membership moves to the chosen plan for the rest of the period: the difference in credit is issued and the new plan's discount and allowances apply. Renewals are charged at the chosen plan's price.
- *
- * Fails with 409 `MEMBERSHIP_NOT_ACTIVE` unless the membership is active, and with 422 `MEMBERSHIP_UPGRADE_UNAVAILABLE` when the chosen plan does not rank above the current one or no upgrade is priced in the account's currency. A pending upgrade or a scheduled downgrade must finish or be canceled first (409 `MEMBERSHIP_CHANGE_PENDING`).
+ * Places an order for the full-period price difference. The upgrade takes effect after benefit issuance and delivery confirmation; renewal uses the target tier. Returns 409 MEMBERSHIP_NOT_ACTIVE or MEMBERSHIP_CHANGE_PENDING, or 422 MEMBERSHIP_UPGRADE_UNAVAILABLE.
  * @summary Upgrade a membership
  */
 export const upgradeMembership = async (membershipId, membershipUpgrade, options, fetchFn) => {
@@ -188,9 +183,7 @@ export const getScheduleMembershipDowngradeUrl = (membershipId) => {
     return `https://membership.leaflow.cloud/api/v1/memberships/${encodeURIComponent(String(membershipId))}/downgrade`;
 };
 /**
- * Schedules a move to a lower-ranked plan at the end of the paid period. Nothing is charged or refunded and the current period keeps its benefits. The membership's `scheduled_plan` shows the pending move.
- *
- * Fails with 409 `MEMBERSHIP_NOT_ACTIVE` unless the membership is active, 409 `MEMBERSHIP_CHANGE_PENDING` while another change is pending, and 422 `MEMBERSHIP_DOWNGRADE_INVALID` when the chosen plan does not rank below the current one or has no price in the account's currency for the membership's billing interval.
+ * Schedules a lower tier for the next period. Current benefits remain valid. Returns 409 MEMBERSHIP_NOT_ACTIVE or MEMBERSHIP_CHANGE_PENDING, or 422 MEMBERSHIP_DOWNGRADE_INVALID.
  * @summary Schedule a downgrade
  */
 export const scheduleMembershipDowngrade = async (membershipId, membershipDowngrade, options, fetchFn) => {
@@ -223,7 +216,7 @@ export const getCancelMembershipDowngradeUrl = (membershipId) => {
     return `https://membership.leaflow.cloud/api/v1/memberships/${encodeURIComponent(String(membershipId))}/downgrade`;
 };
 /**
- * Keeps the current plan at renewal. Fails with 409 `MEMBERSHIP_CHANGE_PENDING` when no downgrade is scheduled.
+ * Cancels the scheduled downgrade. Returns 409 MEMBERSHIP_CHANGE_PENDING if none is scheduled.
  * @summary Cancel a scheduled downgrade
  */
 export const cancelMembershipDowngrade = async (membershipId, options, fetchFn) => {

package/dist/membership/v1/generated/models.d.ts

@@ -2,22 +2,7 @@
  * Generated by orval 🍺
  * Do not edit manually.
  * Leaflow Membership API
- * Membership plans and the memberships held by billing accounts.
- *
- * A membership is a prepaid subscription sold through Billing. For each paid period it issues the plan's benefits to the billing account. A plan can carry several benefits across services: credit for chosen services, coupons on purchases and metered usage, and usage allowances such as model tokens, and access to features of other services. Benefits are shared by every project paid for by the account.
- *
- * ## Authentication
- *
- * Plans are public. Memberships require an access token; see the `accessTokenAuth` security scheme. Only the owner of a billing account can read or change its membership; anyone else receives 403 `MEMBERSHIP_ACCOUNT_FORBIDDEN`.
- *
- * ## Conventions
- *
- * - **One membership per billing account.** A pending or active membership must end before another is bought; change plans with upgrade and downgrade instead.
- * - **Payment goes through Billing.** Purchases and upgrades return a Billing order. With `checkout.mode` `deferred`, pay the order's invoice through Billing. Benefits are issued once Billing reports the order ready; every order has an invoice, including a zero-total one, which is paid automatically.
- * - **Cancellation and auto-renewal are managed in Billing** on the membership's `subscription_id`. A cancellation takes effect at the end of the paid period without a refund, and the period's benefits remain until then.
- * - **An upgrade takes effect immediately** for the full difference between the two plans' period prices, whatever remains of the period. The difference in credit is issued in full and the new plan's discount applies from payment. Renewals are charged at the new plan's price.
- * - **A downgrade takes effect at the end of the paid period.** The current period keeps its benefits and nothing is refunded.
- * - **Amounts are decimal strings** in the billing account's currency. There is no currency conversion: a plan without a price or credit in the account's currency cannot be bought with it.
+ * Membership tiers and account memberships. Catalog queries support any configured currency; purchases use the billing account currency.
  * OpenAPI spec version: 1.0.0
  */
 /**
@@ -58,7 +43,7 @@ export interface PlanSummary {
     id: string;
     lookup_key: string;
     name: string;
-    /** Higher ranks are higher plans. Upgrades move up and downgrades move down. */
+    /** Higher values mean higher tiers. Upgrades move up and downgrades move down. */
     rank: number;
 }
 export type PlanPriceInterval = (typeof PlanPriceInterval)[keyof typeof PlanPriceInterval];
@@ -94,7 +79,7 @@ export interface NamedIdentity {
     name: string;
 }
 /**
- * Credit issued for each period in one currency. It never pays for memberships.
+ * Credit granted for each period.
  */
 export interface CreditBenefit {
     currency: Currency;
@@ -102,7 +87,7 @@ export interface CreditBenefit {
     /** The services and plans the credit can pay for. */
     applies_to: NamedIdentity;
     /**
-     * Days the credit can be used from issue. Null means it does not expire.
+     * Credit validity in days; null means no expiry.
      * @minimum 1
      * @nullable
      */
@@ -116,28 +101,28 @@ export declare const DiscountBenefitCouponType: {
     readonly free_setup: "free_setup";
 };
 /**
- * A Billing coupon the account holds during each period. Every type applies to purchases within its scope; a percentage coupon also reduces metered usage. Only one coupon applies to a purchase or a usage charge, the one that saves the most.
+ * A Billing coupon held during each period.
  */
 export interface DiscountBenefit {
     name: string;
     coupon_type: DiscountBenefitCouponType;
     /**
-     * Decimal string for a percentage coupon, such as "10" for ten per cent; null for other types.
+     * Percentage discount; null for other coupon types.
      * @nullable
      */
     percent_off: string | null;
-    /** The services and plans the coupon applies to. Null means every service other than memberships. */
+    /** Coupon applicability; null means unrestricted. */
     applies_to: NamedIdentity | null;
 }
 /**
- * A Leaflow service, such as compute or canopy.
+ * A Leaflow service.
  */
 export interface ProductIdentity {
     id: string;
     name: string;
 }
 /**
- * Access to a feature of a service for every project of the account during each period.
+ * Account-level feature access for each period.
  */
 export interface FeatureBenefit {
     product: ProductIdentity;
@@ -145,22 +130,22 @@ export interface FeatureBenefit {
     name: string;
 }
 /**
- * Exact dimension values the allowance is limited to, such as a model. Empty means every usage of the meter.
+ * Meter dimension selectors; empty means unrestricted usage.
  */
 export type AllowanceBenefitDimensions = {
     [key: string]: string;
 };
 /**
- * Usage of a service included in each period. Usage with the listed dimension values draws from it before it is charged.
+ * Metered usage included in each period.
  */
 export interface AllowanceBenefit {
     product: ProductIdentity;
     meter_id: string;
     meter_name: string;
     unit: string;
-    /** Decimal string in the meter's unit. */
+    /** Quantity in the meter's unit. */
     quantity: string;
-    /** Exact dimension values the allowance is limited to, such as a model. Empty means every usage of the meter. */
+    /** Meter dimension selectors; empty means unrestricted usage. */
     dimensions: AllowanceBenefitDimensions;
 }
 export type BenefitType = (typeof BenefitType)[keyof typeof BenefitType];
@@ -171,7 +156,7 @@ export declare const BenefitType: {
     readonly feature: "feature";
 };
 /**
- * One benefit of a plan. Exactly the object named by type is present.
+ * Exactly one benefit object matching type.
  */
 export interface Benefit {
     id: string;
@@ -186,7 +171,7 @@ export interface Plan {
     lookup_key: string;
     name: string;
     description: string;
-    /** Higher ranks are higher plans. */
+    /** Higher values mean higher tiers. */
     rank: number;
     prices: PlanPrice[];
     benefits: Benefit[];
@@ -214,7 +199,7 @@ export declare const GrantType: {
     readonly feature: "feature";
 };
 /**
- * revoked means it was withdrawn before the period ended; what had been used is kept.
+ * Revocation withdraws unused benefits.
  */
 export type GrantStatus = (typeof GrantStatus)[keyof typeof GrantStatus];
 export declare const GrantStatus: {
@@ -222,13 +207,13 @@ export declare const GrantStatus: {
     readonly revoked: "revoked";
 };
 /**
- * A benefit issued for a period, with the terms it was issued on. The Billing resource is listed in Billing.
+ * A benefit grant with frozen terms and Billing resource identifiers.
  */
 export interface Grant {
     id: string;
     benefit_id: string;
     type: GrantType;
-    /** revoked means it was withdrawn before the period ended; what had been used is kept. */
+    /** Revocation withdraws unused benefits. */
     status: GrantStatus;
     credit?: CreditBenefit;
     discount?: DiscountBenefit;
@@ -245,7 +230,7 @@ export interface Grant {
     issued_at: string;
 }
 /**
- * A paid period of a membership.
+ * A fulfilled membership period.
  */
 export interface Period {
     id: string;
@@ -261,7 +246,7 @@ export interface PeriodList {
     pagination: OffsetPagination;
 }
 /**
- * pending until Billing reports the first order ready; active while paid; ended afterwards.
+ * Pending until delivery is confirmed; active afterwards; ended when terminated.
  */
 export type MembershipStatus = (typeof MembershipStatus)[keyof typeof MembershipStatus];
 export declare const MembershipStatus: {
@@ -270,10 +255,7 @@ export declare const MembershipStatus: {
     readonly ended: "ended";
 };
 /**
- * canceled: the subscription was canceled and the paid period ended.
- * reclaimed: Billing reclaimed the subscription after non-payment.
- * revoked: an operator ended the membership.
- * abandoned: the first order was canceled or expired before payment.
+ * Cancellation, reclamation, operator revocation, or an unfulfilled first order.
  * @nullable
  */
 export type MembershipEndedReason = (typeof MembershipEndedReason)[keyof typeof MembershipEndedReason] | null;
@@ -287,24 +269,21 @@ export interface Membership {
     id: string;
     billing_account_id: number;
     plan: PlanSummary;
-    /** pending until Billing reports the first order ready; active while paid; ended afterwards. */
+    /** Pending until delivery is confirmed; active afterwards; ended when terminated. */
     status: MembershipStatus;
     /**
-     * canceled: the subscription was canceled and the paid period ended.
-     * reclaimed: Billing reclaimed the subscription after non-payment.
-     * revoked: an operator ended the membership.
-     * abandoned: the first order was canceled or expired before payment.
+     * Cancellation, reclamation, operator revocation, or an unfulfilled first order.
      * @nullable
      */
     ended_reason: MembershipEndedReason;
     /**
-     * The Billing subscription. Cancel it or change auto-renewal in Billing. Null until Billing reports the first order ready.
+     * Billing subscription ID; null until activation.
      * @nullable
      */
     subscription_id: string | null;
-    /** The period in effect now. Null when the membership is pending or ended. */
+    /** Current fulfilled period; null while pending or ended. */
     current_period: Period | null;
-    /** The plan a scheduled downgrade moves to at the end of the paid period. */
+    /** The scheduled downgrade target. */
     scheduled_plan: PlanSummary | null;
     created_at: string;
     /** @nullable */
@@ -381,7 +360,7 @@ export interface PlacedOrder {
     invoice: InvoiceSummary;
 }
 /**
- * The membership and the Billing order placed for it.
+ * The membership and its Billing purchase order.
  */
 export interface MembershipPurchase {
     membership: Membership;
@@ -421,17 +400,17 @@ export interface MembershipCreate {
     /** @minimum 1 */
     billing_account_id: number;
     plan_id: string;
-    /** One of the plan's prices in the account's currency. It sets the billing interval. */
+    /** A tier price matching the account currency and chosen billing interval. */
     price_id: string;
     checkout?: CheckoutOptions;
 }
 export interface MembershipUpgrade {
-    /** A plan ranked above the current one. */
+    /** A higher-ranked target tier. */
     plan_id: string;
     checkout?: CheckoutOptions;
 }
 export interface MembershipDowngrade {
-    /** A plan ranked below the current one, priced for the membership's billing interval in the account's currency. */
+    /** A lower-ranked tier supporting the account currency and billing interval. */
     plan_id: string;
 }
 /**
@@ -3192,7 +3171,16 @@ export declare const StatementStatus: {
     readonly closed: "closed";
 };
 /**
- * An account's consumption for one billing period, collected at one closing. The first statement of a period (sequence 1) closes after the period ends. Usage priced after that closing is collected in a later statement for the same period, which closes and invoices separately; a closed statement is never rewritten. Payments apply to issued invoices.
+ * interim: a closing before the period's usage is final; minimum charges are not applied. final: the first closing after the period ended and its late usage was settled; minimum charges for the whole period are applied. supplement: a closing after the final one, for usage priced late. An open statement is interim.
+ */
+export type StatementType = (typeof StatementType)[keyof typeof StatementType];
+export declare const StatementType: {
+    readonly interim: "interim";
+    readonly final: "final";
+    readonly supplement: "supplement";
+};
+/**
+ * An account's consumption for one billing period, collected at one closing. Usage is billed after every settlement run, about hourly; each closing issues an invoice for the usage priced since the previous closing and collects it from credits and balance at once, and later usage is collected in the next statement of the same period. A closed statement is never rewritten. The period's consumption is the sum of its statements.
  */
 export interface Statement {
     id: string;
@@ -3200,10 +3188,11 @@ export interface Statement {
     currency: string;
     period_start: string;
     period_end: string;
-    /** 1 for the first closing of the period; higher for statements that collect usage priced after an earlier closing. */
+    /** Increases with each closing of the period. */
     sequence: number;
     status: StatementStatus;
-    /** True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing. */
+    type: StatementType;
+    /** True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at the period's final closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing. */
     estimated: boolean;
     amounts: StatementAmounts;
     closed_at?: string;
@@ -3247,7 +3236,7 @@ export interface StatementSummary {
  */
 export type ErrorResponse = Error;
 /**
- * A billing account you own.
+ * The account to query.
  */
 export type BillingAccountIdQueryParameter = number;
 export type ListPlansParams = {
@@ -3264,13 +3253,13 @@ export type ListPlansParams = {
      */
     page_size?: number;
     /**
-     * Restricts prices and currency-specific benefits to this currency. All currencies are returned while it is absent.
+     * Filters prices and currency-specific benefits. Any configured currency is allowed; omit to return all currencies.
      */
     currency?: Currency;
 };
 export type GetPlanParams = {
     /**
-     * Restricts prices and currency-specific benefits to this currency.
+     * Filters prices and currency-specific benefits. Any configured currency is allowed; omit to return all currencies.
      */
     currency?: Currency;
 };
@@ -3288,7 +3277,7 @@ export type ListMembershipsParams = {
      */
     page_size?: number;
     /**
-     * A billing account you own.
+     * The account to query.
      * @minimum 1
      */
     billing_account_id: BillingAccountIdQueryParameter;

package/dist/membership/v1/generated/models.js

@@ -393,6 +393,11 @@ export const StatementStatus = {
     open: "open",
     closed: "closed",
 };
+export const StatementType = {
+    interim: "interim",
+    final: "final",
+    supplement: "supplement",
+};
 export const StatementSummaryGroupBy = {
     project: "project",
     product: "product",