@leaflow/sdk 0.127.1 → 0.129.1

package/dist/billing/v1/generated/validators/scheduledChange.zod.js

@@ -0,0 +1,26 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Financial operations require an account access token and billing-account authorization. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { OrderStatus } from "./orderStatus.zod.js";
+export const ScheduledChange = zod
+    .strictObject({
+    order_id: zod.uuid(),
+    status: OrderStatus,
+    effective_at: zod.iso
+        .datetime({ offset: true })
+        .describe("When the target terms take effect, normally the end of the current paid period."),
+    plan_id: zod.uuid(),
+    plan_name: zod.string(),
+    price_id: zod.uuid(),
+    quantity: zod.string(),
+    recurring_amount: zod.string().describe("The target prepaid renewal amount before tax."),
+    currency: zod.string(),
+    interval: zod.enum(["day", "month", "year"]),
+    interval_count: zod.int().min(1),
+})
+    .describe("The next accepted period-end change for a subscription. It describes the target terms and does not change the current subscription until effective_at.");

package/dist/billing/v1/generated/validators/subscription.zod.d.ts

@@ -68,6 +68,30 @@ export declare const Subscription: zod.ZodObject<{
         failure_code: zod.ZodOptional<zod.ZodString>;
         failure_reason: zod.ZodOptional<zod.ZodString>;
     }, zod.z.core.$strict>>;
+    scheduled_change: zod.ZodOptional<zod.ZodUnion<readonly [zod.ZodObject<{
+        order_id: zod.ZodUUID;
+        status: zod.ZodEnum<{
+            pending: "pending";
+            completed: "completed";
+            failed: "failed";
+            canceled: "canceled";
+            accepted: "accepted";
+            partially_completed: "partially_completed";
+        }>;
+        effective_at: zod.z.ZodISODateTime;
+        plan_id: zod.ZodUUID;
+        plan_name: zod.ZodString;
+        price_id: zod.ZodUUID;
+        quantity: zod.ZodString;
+        recurring_amount: zod.ZodString;
+        currency: zod.ZodString;
+        interval: zod.ZodEnum<{
+            day: "day";
+            month: "month";
+            year: "year";
+        }>;
+        interval_count: zod.ZodInt;
+    }, zod.z.core.$strict>, zod.ZodNull]>>;
     default_payment_method_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
     created_at: zod.ZodOptional<zod.z.ZodISODateTime>;
     id: zod.ZodUUID;

package/dist/billing/v1/generated/validators/subscription.zod.js

@@ -12,6 +12,7 @@ import { ObjectIdentity } from "./objectIdentity.zod.js";
 import { Product } from "./product.zod.js";
 import { ProductID } from "./productID.zod.js";
 import { RefundPolicy } from "./refundPolicy.zod.js";
+import { ScheduledChange } from "./scheduledChange.zod.js";
 import { SubscriptionCancellation } from "./subscriptionCancellation.zod.js";
 import { TerminationPolicy } from "./terminationPolicy.zod.js";
 export const subscriptionDiscountedRenewalsRemainingMin = 0;
@@ -41,6 +42,10 @@ export const Subscription = zod
     suspend_reason: zod.string().optional(),
     billing_cycle_anchor: zod.iso.datetime({ offset: true }).optional(),
     cancellation: SubscriptionCancellation.optional(),
+    scheduled_change: zod
+        .union([ScheduledChange, zod.null()])
+        .optional()
+        .describe("The accepted period-end change currently scheduled for this subscription. Null when no such change exists."),
     default_payment_method_id: zod
         .uuid()
         .nullish()

package/dist/billing/v1/generated/validators/subscriptionList.zod.d.ts

@@ -68,6 +68,30 @@ export declare const SubscriptionList: zod.ZodObject<{
             failure_code: zod.ZodOptional<zod.ZodString>;
             failure_reason: zod.ZodOptional<zod.ZodString>;
         }, zod.z.core.$strict>>;
+        scheduled_change: zod.ZodOptional<zod.ZodUnion<readonly [zod.ZodObject<{
+            order_id: zod.ZodUUID;
+            status: zod.ZodEnum<{
+                pending: "pending";
+                completed: "completed";
+                failed: "failed";
+                canceled: "canceled";
+                accepted: "accepted";
+                partially_completed: "partially_completed";
+            }>;
+            effective_at: zod.z.ZodISODateTime;
+            plan_id: zod.ZodUUID;
+            plan_name: zod.ZodString;
+            price_id: zod.ZodUUID;
+            quantity: zod.ZodString;
+            recurring_amount: zod.ZodString;
+            currency: zod.ZodString;
+            interval: zod.ZodEnum<{
+                day: "day";
+                month: "month";
+                year: "year";
+            }>;
+            interval_count: zod.ZodInt;
+        }, zod.z.core.$strict>, zod.ZodNull]>>;
         default_payment_method_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
         created_at: zod.ZodOptional<zod.z.ZodISODateTime>;
         id: zod.ZodUUID;

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

@@ -2271,6 +2271,49 @@ export declare const SubscriptionInterval: {
     readonly month: "month";
     readonly year: "year";
 };
+/**
+ * Follows the items. `pending` is not yet accepted and may be unpaid or paid; its invoice shows
+ * whether payment is still needed, and it can expire or be canceled. `accepted` is accepted with items still
+ * being set up. `completed` means every item was set up. `partially_completed` means some items were set up
+ * and the others failed or were canceled and were refunded to their original payment sources. `failed` means
+ * no item was delivered and at least one failed; collected amounts for the undelivered items are refunded.
+ * `canceled` means every item was withdrawn without delivery; collected amounts are returned to their original
+ * payment sources. No status establishes service delivery by itself.
+ */
+export type OrderStatus = (typeof OrderStatus)[keyof typeof OrderStatus];
+export declare const OrderStatus: {
+    readonly pending: "pending";
+    readonly accepted: "accepted";
+    readonly completed: "completed";
+    readonly partially_completed: "partially_completed";
+    readonly failed: "failed";
+    readonly canceled: "canceled";
+};
+export type ScheduledChangeInterval = (typeof ScheduledChangeInterval)[keyof typeof ScheduledChangeInterval];
+export declare const ScheduledChangeInterval: {
+    readonly day: "day";
+    readonly month: "month";
+    readonly year: "year";
+};
+/**
+ * The next accepted period-end change for a subscription. It describes the target terms and does not change the current subscription until effective_at.
+ */
+export interface ScheduledChange {
+    order_id: string;
+    status: OrderStatus;
+    /** When the target terms take effect, normally the end of the current paid period. */
+    effective_at: string;
+    plan_id: string;
+    plan_name: string;
+    price_id: string;
+    quantity: string;
+    /** The target prepaid renewal amount before tax. */
+    recurring_amount: string;
+    currency: string;
+    interval: ScheduledChangeInterval;
+    /** @minimum 1 */
+    interval_count: number;
+}
 /**
  * pending means the purchase relationship exists but its order has not been accepted.
  * provisioning means the service accepted the order and is delivering. For a service-owned
@@ -2335,6 +2378,8 @@ export interface Subscription {
     suspend_reason?: string;
     billing_cycle_anchor?: string;
     cancellation?: SubscriptionCancellation;
+    /** The accepted period-end change currently scheduled for this subscription. Null when no such change exists. */
+    scheduled_change?: ScheduledChange | null;
     /**
      * The saved payment method automatic renewal charges after the account's balance and credits,
      * before the account's default payment method. Set when the purchase, a renewal or a change is paid with a
@@ -2511,24 +2556,6 @@ export interface RenewalOrderRequest {
 export interface AutoRenewSet {
     auto_renew: boolean;
 }
-/**
- * Follows the items. `pending` is not yet accepted and may be unpaid or paid; its invoice shows
- * whether payment is still needed, and it can expire or be canceled. `accepted` is accepted with items still
- * being set up. `completed` means every item was set up. `partially_completed` means some items were set up
- * and the others failed or were canceled and were refunded to their original payment sources. `failed` means
- * no item was delivered and at least one failed; collected amounts for the undelivered items are refunded.
- * `canceled` means every item was withdrawn without delivery; collected amounts are returned to their original
- * payment sources. No status establishes service delivery by itself.
- */
-export type OrderStatus = (typeof OrderStatus)[keyof typeof OrderStatus];
-export declare const OrderStatus: {
-    readonly pending: "pending";
-    readonly accepted: "accepted";
-    readonly completed: "completed";
-    readonly partially_completed: "partially_completed";
-    readonly failed: "failed";
-    readonly canceled: "canceled";
-};
 /**
  * `pending` is waiting to be set up. `completed` was confirmed by the service.
  * `failed` was not set up and its amount was refunded to the original payment sources.
@@ -2688,9 +2715,15 @@ export interface OrderItem {
     /** `gross_amount` less `discount_amount`. */
     amount?: Money;
     currency: string;
-    /** @nullable */
+    /**
+     * The start of the service period this line paid for. Frozen at placement for renewals and period-end changes; for a prepaid line of a new purchase, fixed from the second its invoice is paid and kept when delivery is confirmed. Absent for postpaid and one-time lines.
+     * @nullable
+     */
     period_start?: string | null;
-    /** @nullable */
+    /**
+     * The end of that service period, exclusive.
+     * @nullable
+     */
     period_end?: string | null;
     status: OrderItemStatus;
 }

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

@@ -259,6 +259,19 @@ export const SubscriptionInterval = {
     month: "month",
     year: "year",
 };
+export const OrderStatus = {
+    pending: "pending",
+    accepted: "accepted",
+    completed: "completed",
+    partially_completed: "partially_completed",
+    failed: "failed",
+    canceled: "canceled",
+};
+export const ScheduledChangeInterval = {
+    day: "day",
+    month: "month",
+    year: "year",
+};
 export const SubscriptionStatus = {
     pending: "pending",
     provisioning: "provisioning",
@@ -282,14 +295,6 @@ export const RenewalOrderRequestInterval = {
     month: "month",
     year: "year",
 };
-export const OrderStatus = {
-    pending: "pending",
-    accepted: "accepted",
-    completed: "completed",
-    partially_completed: "partially_completed",
-    failed: "failed",
-    canceled: "canceled",
-};
 export const OrderItemStatus = {
     pending: "pending",
     completed: "completed",

package/dist/canopy/v1/generated/validators/orderItem.zod.js

@@ -88,8 +88,14 @@ export const OrderItem = zod
     discount_amount: Money.optional().describe("The reduction on this line: from the coupon the order uses and, for a renewal at the agreed terms,\nfrom the discount the subscription carries.\n\nA carried discount is part of the agreed amount. It is listed here, and `gross_amount` is then\n`unit_amount` times `quantity`, except in two cases where `gross_amount` is the agreed amount and\nthe carried discount is already reflected in it: the renewal order also uses a coupon the account\nholds, or the account's tax rate is inclusive."),
     amount: Money.optional().describe("`gross_amount` less `discount_amount`."),
     currency: zod.string(),
-    period_start: zod.iso.datetime({ offset: true }).nullish(),
-    period_end: zod.iso.datetime({ offset: true }).nullish(),
+    period_start: zod.iso
+        .datetime({ offset: true })
+        .nullish()
+        .describe("The start of the service period this line paid for. Frozen at placement for renewals and period-end changes; for a prepaid line of a new purchase, fixed from the second its invoice is paid and kept when delivery is confirmed. Absent for postpaid and one-time lines."),
+    period_end: zod.iso
+        .datetime({ offset: true })
+        .nullish()
+        .describe("The end of that service period, exclusive."),
     status: OrderItemStatus,
 })
     .describe("Frozen purchase terms. Monetary fields come from related invoice-line snapshots and are zero\nfor a line with no immediate charge, such as postpaid admission. Later catalog changes do not reprice this line. A new service\npurchase creates its pending subscription when this item is recorded, not when payment succeeds.");

package/dist/canopy/v1/generated/validators/scheduledChange.zod.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Canopy API
+ * Management of API keys, together with the models available and the usage recorded against them.
+ *
+ * **These endpoints do not perform inference.** Requests are issued to the forwarding address, which accepts the OpenAI, Anthropic and Gemini request formats:
+ *
+ * ```
+ * POST /v1/chat/completions                    OpenAI
+ * POST /v1/messages                            Anthropic
+ * POST /v1beta/models/{model}:generateContent  Gemini
+ * ```
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * These endpoints do not accept an API key, and the forwarding endpoints do not accept a scoped token.
+ *
+ * ## Conventions
+ *
+ * - **The plaintext of an API key is returned once.** The `secret` appears in the response that issues it and is returned by no other endpoint. A key that has been lost has to be revoked and reissued.
+ * - **Disabling and revoking are distinct.** A disabled key may be enabled again at any time, while a revocation is irreversible and is intended for a key that has been exposed. Neither removes the record, and the usage the key accrued remains readable.
+ * - **A usage query must carry a time range**, spanning no more than 31 days. `from` and `to` carry a timezone offset, which the server does not infer.
+ * - **The request and response bodies do not appear in the ledger.** They are not recorded. Quote the `upstream_request_id` from the response when reporting a problem.
+ * - **Usage may be estimated.** The upstream provider does not report usage on every request. Where it does not, `usage_source` is `estimated` and the figures are derived from the character classes of the payload, to within roughly fifteen per cent.
+ * - **The service is enabled before use.** A project enables the model platform once, through `create-service`; the forwarding endpoints refuse its requests until the service is `active`. Requests are then billed under the service's subscription by the tokens they use, at the rates stated in each model's `pricing`.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+export declare const ScheduledChange: zod.ZodObject<{
+    order_id: zod.ZodUUID;
+    status: zod.ZodEnum<{
+        pending: "pending";
+        completed: "completed";
+        failed: "failed";
+        canceled: "canceled";
+        accepted: "accepted";
+        partially_completed: "partially_completed";
+    }>;
+    effective_at: zod.z.ZodISODateTime;
+    plan_id: zod.ZodUUID;
+    plan_name: zod.ZodString;
+    price_id: zod.ZodUUID;
+    quantity: zod.ZodString;
+    recurring_amount: zod.ZodString;
+    currency: zod.ZodString;
+    interval: zod.ZodEnum<{
+        day: "day";
+        month: "month";
+        year: "year";
+    }>;
+    interval_count: zod.ZodInt;
+}, zod.z.core.$strict>;
+export type ScheduledChange = zod.input<typeof ScheduledChange>;
+export type ScheduledChangeOutput = zod.output<typeof ScheduledChange>;

package/dist/canopy/v1/generated/validators/scheduledChange.zod.js

@@ -0,0 +1,49 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Canopy API
+ * Management of API keys, together with the models available and the usage recorded against them.
+ *
+ * **These endpoints do not perform inference.** Requests are issued to the forwarding address, which accepts the OpenAI, Anthropic and Gemini request formats:
+ *
+ * ```
+ * POST /v1/chat/completions                    OpenAI
+ * POST /v1/messages                            Anthropic
+ * POST /v1beta/models/{model}:generateContent  Gemini
+ * ```
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * These endpoints do not accept an API key, and the forwarding endpoints do not accept a scoped token.
+ *
+ * ## Conventions
+ *
+ * - **The plaintext of an API key is returned once.** The `secret` appears in the response that issues it and is returned by no other endpoint. A key that has been lost has to be revoked and reissued.
+ * - **Disabling and revoking are distinct.** A disabled key may be enabled again at any time, while a revocation is irreversible and is intended for a key that has been exposed. Neither removes the record, and the usage the key accrued remains readable.
+ * - **A usage query must carry a time range**, spanning no more than 31 days. `from` and `to` carry a timezone offset, which the server does not infer.
+ * - **The request and response bodies do not appear in the ledger.** They are not recorded. Quote the `upstream_request_id` from the response when reporting a problem.
+ * - **Usage may be estimated.** The upstream provider does not report usage on every request. Where it does not, `usage_source` is `estimated` and the figures are derived from the character classes of the payload, to within roughly fifteen per cent.
+ * - **The service is enabled before use.** A project enables the model platform once, through `create-service`; the forwarding endpoints refuse its requests until the service is `active`. Requests are then billed under the service's subscription by the tokens they use, at the rates stated in each model's `pricing`.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+import { OrderStatus } from "./orderStatus.zod.js";
+export const ScheduledChange = zod
+    .strictObject({
+    order_id: zod.uuid(),
+    status: OrderStatus,
+    effective_at: zod.iso
+        .datetime({ offset: true })
+        .describe("When the target terms take effect, normally the end of the current paid period."),
+    plan_id: zod.uuid(),
+    plan_name: zod.string(),
+    price_id: zod.uuid(),
+    quantity: zod.string(),
+    recurring_amount: zod.string().describe("The target prepaid renewal amount before tax."),
+    currency: zod.string(),
+    interval: zod.enum(["day", "month", "year"]),
+    interval_count: zod.int().min(1),
+})
+    .describe("The next accepted period-end change for a subscription. It describes the target terms and does not change the current subscription until effective_at.");

package/dist/canopy/v1/generated/validators/subscription.zod.d.ts

@@ -91,6 +91,30 @@ export declare const Subscription: zod.ZodObject<{
         failure_code: zod.ZodOptional<zod.ZodString>;
         failure_reason: zod.ZodOptional<zod.ZodString>;
     }, zod.z.core.$strict>>;
+    scheduled_change: zod.ZodOptional<zod.ZodUnion<readonly [zod.ZodObject<{
+        order_id: zod.ZodUUID;
+        status: zod.ZodEnum<{
+            pending: "pending";
+            completed: "completed";
+            failed: "failed";
+            canceled: "canceled";
+            accepted: "accepted";
+            partially_completed: "partially_completed";
+        }>;
+        effective_at: zod.z.ZodISODateTime;
+        plan_id: zod.ZodUUID;
+        plan_name: zod.ZodString;
+        price_id: zod.ZodUUID;
+        quantity: zod.ZodString;
+        recurring_amount: zod.ZodString;
+        currency: zod.ZodString;
+        interval: zod.ZodEnum<{
+            day: "day";
+            month: "month";
+            year: "year";
+        }>;
+        interval_count: zod.ZodInt;
+    }, zod.z.core.$strict>, zod.ZodNull]>>;
     default_payment_method_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
     created_at: zod.ZodOptional<zod.z.ZodISODateTime>;
     id: zod.ZodUUID;

package/dist/canopy/v1/generated/validators/subscription.zod.js

@@ -35,6 +35,7 @@ import { ObjectIdentity } from "./objectIdentity.zod.js";
 import { Product } from "./product.zod.js";
 import { ProductID } from "./productID.zod.js";
 import { RefundPolicy } from "./refundPolicy.zod.js";
+import { ScheduledChange } from "./scheduledChange.zod.js";
 import { SubscriptionCancellation } from "./subscriptionCancellation.zod.js";
 import { TerminationPolicy } from "./terminationPolicy.zod.js";
 export const subscriptionDiscountedRenewalsRemainingMin = 0;
@@ -64,6 +65,10 @@ export const Subscription = zod
     suspend_reason: zod.string().optional(),
     billing_cycle_anchor: zod.iso.datetime({ offset: true }).optional(),
     cancellation: SubscriptionCancellation.optional(),
+    scheduled_change: zod
+        .union([ScheduledChange, zod.null()])
+        .optional()
+        .describe("The accepted period-end change currently scheduled for this subscription. Null when no such change exists."),
     default_payment_method_id: zod
         .uuid()
         .nullish()

package/dist/canopy/v1/generated/validators/subscriptionList.zod.d.ts

@@ -91,6 +91,30 @@ export declare const SubscriptionList: zod.ZodObject<{
             failure_code: zod.ZodOptional<zod.ZodString>;
             failure_reason: zod.ZodOptional<zod.ZodString>;
         }, zod.z.core.$strict>>;
+        scheduled_change: zod.ZodOptional<zod.ZodUnion<readonly [zod.ZodObject<{
+            order_id: zod.ZodUUID;
+            status: zod.ZodEnum<{
+                pending: "pending";
+                completed: "completed";
+                failed: "failed";
+                canceled: "canceled";
+                accepted: "accepted";
+                partially_completed: "partially_completed";
+            }>;
+            effective_at: zod.z.ZodISODateTime;
+            plan_id: zod.ZodUUID;
+            plan_name: zod.ZodString;
+            price_id: zod.ZodUUID;
+            quantity: zod.ZodString;
+            recurring_amount: zod.ZodString;
+            currency: zod.ZodString;
+            interval: zod.ZodEnum<{
+                day: "day";
+                month: "month";
+                year: "year";
+            }>;
+            interval_count: zod.ZodInt;
+        }, zod.z.core.$strict>, zod.ZodNull]>>;
         default_payment_method_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
         created_at: zod.ZodOptional<zod.z.ZodISODateTime>;
         id: zod.ZodUUID;

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

@@ -4217,6 +4217,49 @@ export declare const SubscriptionInterval: {
     readonly month: "month";
     readonly year: "year";
 };
+/**
+ * Follows the items. `pending` is not yet accepted and may be unpaid or paid; its invoice shows
+ * whether payment is still needed, and it can expire or be canceled. `accepted` is accepted with items still
+ * being set up. `completed` means every item was set up. `partially_completed` means some items were set up
+ * and the others failed or were canceled and were refunded to their original payment sources. `failed` means
+ * no item was delivered and at least one failed; collected amounts for the undelivered items are refunded.
+ * `canceled` means every item was withdrawn without delivery; collected amounts are returned to their original
+ * payment sources. No status establishes service delivery by itself.
+ */
+export type OrderStatus = (typeof OrderStatus)[keyof typeof OrderStatus];
+export declare const OrderStatus: {
+    readonly pending: "pending";
+    readonly accepted: "accepted";
+    readonly completed: "completed";
+    readonly partially_completed: "partially_completed";
+    readonly failed: "failed";
+    readonly canceled: "canceled";
+};
+export type ScheduledChangeInterval = (typeof ScheduledChangeInterval)[keyof typeof ScheduledChangeInterval];
+export declare const ScheduledChangeInterval: {
+    readonly day: "day";
+    readonly month: "month";
+    readonly year: "year";
+};
+/**
+ * The next accepted period-end change for a subscription. It describes the target terms and does not change the current subscription until effective_at.
+ */
+export interface ScheduledChange {
+    order_id: string;
+    status: OrderStatus;
+    /** When the target terms take effect, normally the end of the current paid period. */
+    effective_at: string;
+    plan_id: string;
+    plan_name: string;
+    price_id: string;
+    quantity: string;
+    /** The target prepaid renewal amount before tax. */
+    recurring_amount: string;
+    currency: string;
+    interval: ScheduledChangeInterval;
+    /** @minimum 1 */
+    interval_count: number;
+}
 /**
  * pending means the purchase relationship exists but its order has not been accepted.
  * provisioning means the service accepted the order and is delivering. For a service-owned
@@ -4281,6 +4324,8 @@ export interface Subscription {
     suspend_reason?: string;
     billing_cycle_anchor?: string;
     cancellation?: SubscriptionCancellation;
+    /** The accepted period-end change currently scheduled for this subscription. Null when no such change exists. */
+    scheduled_change?: ScheduledChange | null;
     /**
      * The saved payment method automatic renewal charges after the account's balance and credits,
      * before the account's default payment method. Set when the purchase, a renewal or a change is paid with a
@@ -4457,24 +4502,6 @@ export interface RenewalOrderRequest {
 export interface AutoRenewSet {
     auto_renew: boolean;
 }
-/**
- * Follows the items. `pending` is not yet accepted and may be unpaid or paid; its invoice shows
- * whether payment is still needed, and it can expire or be canceled. `accepted` is accepted with items still
- * being set up. `completed` means every item was set up. `partially_completed` means some items were set up
- * and the others failed or were canceled and were refunded to their original payment sources. `failed` means
- * no item was delivered and at least one failed; collected amounts for the undelivered items are refunded.
- * `canceled` means every item was withdrawn without delivery; collected amounts are returned to their original
- * payment sources. No status establishes service delivery by itself.
- */
-export type OrderStatus = (typeof OrderStatus)[keyof typeof OrderStatus];
-export declare const OrderStatus: {
-    readonly pending: "pending";
-    readonly accepted: "accepted";
-    readonly completed: "completed";
-    readonly partially_completed: "partially_completed";
-    readonly failed: "failed";
-    readonly canceled: "canceled";
-};
 /**
  * `pending` is waiting to be set up. `completed` was confirmed by the service.
  * `failed` was not set up and its amount was refunded to the original payment sources.
@@ -4634,9 +4661,15 @@ export interface OrderItem {
     /** `gross_amount` less `discount_amount`. */
     amount?: Money;
     currency: string;
-    /** @nullable */
+    /**
+     * The start of the service period this line paid for. Frozen at placement for renewals and period-end changes; for a prepaid line of a new purchase, fixed from the second its invoice is paid and kept when delivery is confirmed. Absent for postpaid and one-time lines.
+     * @nullable
+     */
     period_start?: string | null;
-    /** @nullable */
+    /**
+     * The end of that service period, exclusive.
+     * @nullable
+     */
     period_end?: string | null;
     status: OrderItemStatus;
 }

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

@@ -557,6 +557,19 @@ export const SubscriptionInterval = {
     month: "month",
     year: "year",
 };
+export const OrderStatus = {
+    pending: "pending",
+    accepted: "accepted",
+    completed: "completed",
+    partially_completed: "partially_completed",
+    failed: "failed",
+    canceled: "canceled",
+};
+export const ScheduledChangeInterval = {
+    day: "day",
+    month: "month",
+    year: "year",
+};
 export const SubscriptionStatus = {
     pending: "pending",
     provisioning: "provisioning",
@@ -580,14 +593,6 @@ export const RenewalOrderRequestInterval = {
     month: "month",
     year: "year",
 };
-export const OrderStatus = {
-    pending: "pending",
-    accepted: "accepted",
-    completed: "completed",
-    partially_completed: "partially_completed",
-    failed: "failed",
-    canceled: "canceled",
-};
 export const OrderItemStatus = {
     pending: "pending",
     completed: "completed",

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

@@ -81,8 +81,14 @@ export const OrderItem = zod
     discount_amount: Money.optional().describe("The reduction on this line: from the coupon the order uses and, for a renewal at the agreed terms,\nfrom the discount the subscription carries.\n\nA carried discount is part of the agreed amount. It is listed here, and `gross_amount` is then\n`unit_amount` times `quantity`, except in two cases where `gross_amount` is the agreed amount and\nthe carried discount is already reflected in it: the renewal order also uses a coupon the account\nholds, or the account's tax rate is inclusive."),
     amount: Money.optional().describe("`gross_amount` less `discount_amount`."),
     currency: zod.string(),
-    period_start: zod.iso.datetime({ offset: true }).nullish(),
-    period_end: zod.iso.datetime({ offset: true }).nullish(),
+    period_start: zod.iso
+        .datetime({ offset: true })
+        .nullish()
+        .describe("The start of the service period this line paid for. Frozen at placement for renewals and period-end changes; for a prepaid line of a new purchase, fixed from the second its invoice is paid and kept when delivery is confirmed. Absent for postpaid and one-time lines."),
+    period_end: zod.iso
+        .datetime({ offset: true })
+        .nullish()
+        .describe("The end of that service period, exclusive."),
     status: OrderItemStatus,
 })
     .describe("Frozen purchase terms. Monetary fields come from related invoice-line snapshots and are zero\nfor a line with no immediate charge, such as postpaid admission. Later catalog changes do not reprice this line. A new service\npurchase creates its pending subscription when this item is recorded, not when payment succeeds.");