@leaflow/sdk 0.141.0 → 0.143.0

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

@@ -1,7 +1,31 @@
+export const ReasoningDiagnosticsTranslation = {
+    translate: "translate",
+    passthrough: "passthrough",
+    strip: "strip",
+};
 export const EmbeddingRequestEncodingFormat = {
     float: "float",
     base64: "base64",
 };
+export const Modality = {
+    text: "text",
+    image: "image",
+    audio: "audio",
+    video: "video",
+    file: "file",
+    embedding: "embedding",
+};
+export const ModelEndpoint = {
+    "/v1/chat/completions": "/v1/chat/completions",
+    "/v1/responses": "/v1/responses",
+    "/v1/embeddings": "/v1/embeddings",
+    "/v1/images/generations": "/v1/images/generations",
+    "/v1/images/edits": "/v1/images/edits",
+    "/v1/audio/transcriptions": "/v1/audio/transcriptions",
+    "/v1/audio/translations": "/v1/audio/translations",
+    "/v1/audio/speech": "/v1/audio/speech",
+    "/v1/realtime": "/v1/realtime",
+};
 export const APIKeyResourceStatus = {
     active: "active",
     disabled: "disabled",
@@ -56,7 +80,6 @@ export const InvoiceStatus = {
     open: "open",
     paid: "paid",
     void: "void",
-    uncollectible: "uncollectible",
 };
 export const WithdrawalItemStatus = {
     pending: "pending",
@@ -94,10 +117,13 @@ export const QuotedDiscountType = {
     promotion_code: "promotion_code",
     account_discount: "account_discount",
 };
-export const CancellationRefundPreviewItemChargeType = {
-    postpaid: "postpaid",
-    prepaid: "prepaid",
+export const PriceType = {
     one_time: "one_time",
+    recurring: "recurring",
+};
+export const UsageType = {
+    licensed: "licensed",
+    metered: "metered",
 };
 export const CancellationStatus = {
     requested: "requested",
@@ -112,11 +138,6 @@ export const CancellationOrigin = {
     operator: "operator",
     project_deletion: "project_deletion",
 };
-export const CancellationItemChargeType = {
-    postpaid: "postpaid",
-    prepaid: "prepaid",
-    one_time: "one_time",
-};
 export const CancellationItemStatus = {
     requested: "requested",
     scheduled: "scheduled",
@@ -142,15 +163,9 @@ export const BillingAccountStatus = {
     suspended: "suspended",
     closed: "closed",
 };
-export const PriceOptionBillingScheme = {
+export const BillingScheme = {
     per_unit: "per_unit",
     tiered: "tiered",
-    rated: "rated",
-};
-export const PriceOptionType = {
-    postpaid: "postpaid",
-    prepaid: "prepaid",
-    one_time: "one_time",
 };
 export const PriceOptionInterval = {
     none: "none",
@@ -262,11 +277,6 @@ export const RefundReason = {
     payment_not_applied: "payment_not_applied",
     operator: "operator",
 };
-export const SubscriptionChargeType = {
-    postpaid: "postpaid",
-    prepaid: "prepaid",
-    one_time: "one_time",
-};
 export const SubscriptionInterval = {
     none: "none",
     day: "day",
@@ -338,11 +348,6 @@ export const OrderItemInterval = {
     month: "month",
     year: "year",
 };
-export const OrderItemChargeType = {
-    postpaid: "postpaid",
-    prepaid: "prepaid",
-    one_time: "one_time",
-};
 export const DiscountStatus = {
     scheduled: "scheduled",
     active: "active",
@@ -376,16 +381,6 @@ export const FeatureGrantStatus = {
     expired: "expired",
     voided: "voided",
 };
-export const PriceType = {
-    postpaid: "postpaid",
-    prepaid: "prepaid",
-    one_time: "one_time",
-};
-export const PriceBillingScheme = {
-    per_unit: "per_unit",
-    tiered: "tiered",
-    rated: "rated",
-};
 export const PriceTiersMode = {
     none: "none",
     graduated: "graduated",
@@ -397,20 +392,17 @@ export const PriceInterval = {
     month: "month",
     year: "year",
 };
-export const RateBillingScheme = {
-    per_unit: "per_unit",
-    tiered: "tiered",
+export const RateInterval = {
+    none: "none",
+    day: "day",
+    month: "month",
+    year: "year",
 };
 export const RateTiersMode = {
     none: "none",
     graduated: "graduated",
     volume: "volume",
 };
-export const QuoteItemInputPriceType = {
-    postpaid: "postpaid",
-    prepaid: "prepaid",
-    one_time: "one_time",
-};
 export const QuoteItemInputInterval = {
     none: "none",
     day: "day",

package/dist/canopy/v1/generated/schemas.zod.d.ts

@@ -31,6 +31,33 @@
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from "zod";
+/**
+ * Supports JSON, SSE and native upstream response storage. Stored continuation is restricted to the current project and original provider credential. WebSocket clients connect with GET /v1/responses and send response.create events; one response may be active on a connection at a time. The connection stays on its initial model and provider credential.
+ * @summary Create a model response
+ */
+export declare const CreateResponseBody: zod.ZodObject<{
+    model: zod.ZodOptional<zod.ZodString>;
+    input: zod.ZodOptional<zod.ZodUnknown>;
+    instructions: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
+    store: zod.ZodDefault<zod.ZodBoolean>;
+    stream: zod.ZodDefault<zod.ZodBoolean>;
+    previous_response_id: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
+    reasoning: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+    tools: zod.ZodOptional<zod.ZodArray<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>>;
+    max_output_tokens: zod.ZodOptional<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get a stored response
+ */
+export declare const GetResponseParams: zod.ZodObject<{
+    response: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * @summary Delete a stored response
+ */
+export declare const DeleteResponseParams: zod.ZodObject<{
+    response: zod.ZodString;
+}, zod.z.core.$strict>;
 /**
  * Authenticated project inference. Billing ownership comes only from the verified project token; no Canopy API key or project header is required.
  * @summary Create a chat completion

package/dist/canopy/v1/generated/schemas.zod.js

@@ -35,7 +35,25 @@ import { ChatCompletionRequest } from "./validators/chatCompletionRequest.zod.js
 import { CreateAPIKeyRequestBody } from "./validators/createAPIKeyRequestBody.zod.js";
 import { CreateServiceRequestBody } from "./validators/createServiceRequestBody.zod.js";
 import { EmbeddingRequest } from "./validators/embeddingRequest.zod.js";
+import { ResponseCreate } from "./validators/responseCreate.zod.js";
 import { UpdateAPIKeyRequestBody } from "./validators/updateAPIKeyRequestBody.zod.js";
+/**
+ * Supports JSON, SSE and native upstream response storage. Stored continuation is restricted to the current project and original provider credential. WebSocket clients connect with GET /v1/responses and send response.create events; one response may be active on a connection at a time. The connection stays on its initial model and provider credential.
+ * @summary Create a model response
+ */
+export const CreateResponseBody = ResponseCreate;
+/**
+ * @summary Get a stored response
+ */
+export const GetResponseParams = zod.strictObject({
+    response: zod.string(),
+});
+/**
+ * @summary Delete a stored response
+ */
+export const DeleteResponseParams = zod.strictObject({
+    response: zod.string(),
+});
 /**
  * Authenticated project inference. Billing ownership comes only from the verified project token; no Canopy API key or project header is required.
  * @summary Create a chat completion

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

@@ -63,18 +63,20 @@ export declare const AccountBalance: zod.ZodObject<{
                     id: zod.ZodUUID;
                     name: zod.ZodString;
                 }, zod.z.core.$strict>;
-                billing_scheme: zod.ZodEnum<{
+                billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                     per_unit: "per_unit";
                     tiered: "tiered";
-                    rated: "rated";
-                }>;
+                }>>;
                 unit_quantity: zod.ZodString;
                 id: zod.ZodUUID;
                 currency: zod.ZodString;
                 type: zod.ZodEnum<{
-                    postpaid: "postpaid";
-                    prepaid: "prepaid";
                     one_time: "one_time";
+                    recurring: "recurring";
+                }>;
+                usage_type: zod.ZodEnum<{
+                    licensed: "licensed";
+                    metered: "metered";
                 }>;
                 interval: zod.ZodEnum<{
                     none: "none";
@@ -86,7 +88,14 @@ export declare const AccountBalance: zod.ZodObject<{
                 unit_amount: zod.ZodOptional<zod.ZodString>;
                 active: zod.ZodBoolean;
             }, zod.z.core.$strict>>>;
-            price_types: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
+            price_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+                one_time: "one_time";
+                recurring: "recurring";
+            }>>>;
+            usage_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+                licensed: "licensed";
+                metered: "metered";
+            }>>>;
             operations: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
                 new: "new";
                 renew: "renew";
@@ -115,18 +124,20 @@ export declare const AccountBalance: zod.ZodObject<{
                     id: zod.ZodUUID;
                     name: zod.ZodString;
                 }, zod.z.core.$strict>;
-                billing_scheme: zod.ZodEnum<{
+                billing_scheme: zod.ZodOptional<zod.ZodEnum<{
                     per_unit: "per_unit";
                     tiered: "tiered";
-                    rated: "rated";
-                }>;
+                }>>;
                 unit_quantity: zod.ZodString;
                 id: zod.ZodUUID;
                 currency: zod.ZodString;
                 type: zod.ZodEnum<{
-                    postpaid: "postpaid";
-                    prepaid: "prepaid";
                     one_time: "one_time";
+                    recurring: "recurring";
+                }>;
+                usage_type: zod.ZodEnum<{
+                    licensed: "licensed";
+                    metered: "metered";
                 }>;
                 interval: zod.ZodEnum<{
                     none: "none";

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

@@ -36,17 +36,17 @@ import { Money } from "./money.zod.js";
 export const AccountBalance = zod
     .strictObject({
     available_credit: Money.describe("Balance minus pending balance returns and the part of unbilled_amount and due that estimated_credit_applied does not cover. Negative only when the balance and applicable credit fall short of what the account owes."),
-    estimated_credit_applied: Money.describe("Credit expected to pay unbilled_amount and due. Each charge is matched to grants whose scope, validity and conditions it meets, in the order credit is applied at payment. Nothing is reserved or deducted until an invoice is paid, so credits still includes this amount."),
-    unbilled_amount: Money.describe("Current estimate of rated usage that has not been invoiced. Final pricing and tax are fixed at issuance."),
+    estimated_credit_applied: Money.describe("Credit expected to pay unbilled_amount and due, matching each charge to the grants whose scope, validity and conditions it meets, in the order credit is applied at payment. Nothing is deducted until an invoice is paid, so credits still includes this amount."),
+    unbilled_amount: Money.describe("Current estimate of priced usage that has not been invoiced. Final pricing and tax are fixed at issuance."),
     billing_account_id: zod.int(),
     currency: zod.string(),
-    balance: Money.describe("Prepaid funds in the account currency, excluding credits. May be negative after a payment\ndispute. Outstanding charges are reported separately in due; this value is not a withdrawal quote."),
-    credits: Money.describe("The recorded remaining credit, including restricted grants. It is not withdrawable\nand is not part of balance. credit_groups describes currently valid credit by permitted use; a positive\ncredits balance does not imply that due is zero."),
-    restricted_credits: Money.describe("Currently valid credit whose use has applicable product, operation or eligibility conditions. Included in credits, separate from the balance."),
+    balance: Money.describe("Topped-up funds in the account's currency, excluding credits. May be negative after a payment dispute. Amounts owed are reported in due; this is not a withdrawable amount."),
+    credits: Money.describe("Remaining credit, including restricted grants; not withdrawable and not part of balance. credit_groups shows currently valid credit by permitted use; positive credits do not mean due is zero."),
+    restricted_credits: Money.describe("Currently valid credit restricted to certain products, operations or conditions; part of credits, not of balance."),
     credit_groups: zod
         .array(CreditGroup)
-        .describe("Currently valid, unspent credit grouped by permitted use. Restrictions and\nvalidity dates determine which charges a group can cover, so these groups are not a general\nspendable balance and may differ from the recorded credits total."),
-    due: Money.describe("Amount still payable on issued invoices. The invoice of an order not yet accepted is a request to pay for that order rather than a debt, so it is excluded here and from available_credit. Unbilled usage is reported separately; arrears depend on actual eligible funding and grace terms."),
+        .describe("Currently valid unspent credit grouped by permitted use. Each group covers only the charges its restrictions and validity allow, and the groups may differ from the recorded credits total."),
+    due: Money.describe("Amount still payable on issued invoices. The invoice of an order not yet accepted is excluded, here and from available_credit. Usage not yet invoiced is reported separately."),
     pending_returns_amount: Money,
 })
-    .describe("Account balance, credits, and unpaid charges are reported separately.");
+    .describe("Balance, credits and unpaid charges, each reported separately.");

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

@@ -41,21 +41,24 @@ export const ActiveResource = zod
     state_changed_at: zod.iso.datetime({ offset: true }).optional(),
     subscription_id: zod
         .uuid()
-        .describe("The postpaid subscription charged for this metering record, including shared services."),
+        .describe("The metered subscription charged for this metering record."),
     resource_id: zod.string(),
     product: Product,
-    resource_type: zod.string().optional().describe("What it is, as its own service names it."),
+    resource_type: zod
+        .string()
+        .optional()
+        .describe("The resource type, as the owning service names it."),
     meter: ObjectIdentity,
     unit: zod.string().optional(),
     quantity: zod
         .string()
-        .describe("How much is held — cores, MiB, cards. Not how much has been used."),
+        .describe("How much is held, such as cores, MiB or cards; not how much was used."),
     dimensions: zod.record(zod.string(), zod.string()).optional(),
     status: zod.enum(["active", "suspended", "closing", "closed"]),
     started_at: zod.iso.datetime({ offset: true }),
     project_id: zod.uuid().optional(),
     usage_generated_until: zod.iso
         .datetime({ offset: true })
-        .describe("Usage has been generated up to this boundary; it does not imply invoicing or payment."),
+        .describe("Usage has been generated up to this boundary; it says nothing about invoicing or payment."),
 })
-    .describe("A resource currently accruing charges by the second.");
+    .describe("A resource charged continuously by the second.");

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

@@ -46,7 +46,7 @@ export const Allowance = zod.strictObject({
     unit: zod.string().optional().describe("The unit it is counted in, such as `MiB`."),
     category: zod
         .enum(["paid", "promotional"])
-        .describe("Whether the quantity was paid for or granted free of charge. Both are consumed the same way."),
+        .describe("Whether the quantity was paid for or granted free; both are consumed the same way."),
     dimensions: zod
         .record(zod.string(), zod.string())
         .describe("Exact values for a subset of the meter's dimensions. Only usage with these values is deducted;\nomitted dimensions are not restricted."),
@@ -56,11 +56,11 @@ export const Allowance = zod.strictObject({
     priority: zod
         .int()
         .optional()
-        .describe("Lower values are consumed first. At equal priority, earlier expiry and then earlier issuance take\nprecedence."),
+        .describe("Lower values are consumed first; at equal priority, earlier expiry and then earlier issuance."),
     status: zod.enum(["active", "depleted", "expired", "voided"]),
     valid_from: zod.iso.datetime({ offset: true }),
     valid_until: zod.iso
         .datetime({ offset: true })
         .nullish()
-        .describe("When it lapses. Anything unused at that point is lost; it is not refunded and does\nnot carry over. Absent when it does not expire on its own."),
+        .describe("When the allowance lapses; unused quantity is lost. Absent when it does not expire."),
 });

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

@@ -53,18 +53,20 @@ export declare const Applicability: zod.ZodObject<{
             id: zod.ZodUUID;
             name: zod.ZodString;
         }, zod.z.core.$strict>;
-        billing_scheme: zod.ZodEnum<{
+        billing_scheme: zod.ZodOptional<zod.ZodEnum<{
             per_unit: "per_unit";
             tiered: "tiered";
-            rated: "rated";
-        }>;
+        }>>;
         unit_quantity: zod.ZodString;
         id: zod.ZodUUID;
         currency: zod.ZodString;
         type: zod.ZodEnum<{
-            postpaid: "postpaid";
-            prepaid: "prepaid";
             one_time: "one_time";
+            recurring: "recurring";
+        }>;
+        usage_type: zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
         }>;
         interval: zod.ZodEnum<{
             none: "none";
@@ -76,7 +78,14 @@ export declare const Applicability: zod.ZodObject<{
         unit_amount: zod.ZodOptional<zod.ZodString>;
         active: zod.ZodBoolean;
     }, zod.z.core.$strict>>>;
-    price_types: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
+    price_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+        one_time: "one_time";
+        recurring: "recurring";
+    }>>>;
+    usage_types: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
+        licensed: "licensed";
+        metered: "metered";
+    }>>>;
     operations: zod.ZodOptional<zod.ZodArray<zod.ZodEnum<{
         new: "new";
         renew: "renew";
@@ -105,18 +114,20 @@ export declare const Applicability: zod.ZodObject<{
             id: zod.ZodUUID;
             name: zod.ZodString;
         }, zod.z.core.$strict>;
-        billing_scheme: zod.ZodEnum<{
+        billing_scheme: zod.ZodOptional<zod.ZodEnum<{
             per_unit: "per_unit";
             tiered: "tiered";
-            rated: "rated";
-        }>;
+        }>>;
         unit_quantity: zod.ZodString;
         id: zod.ZodUUID;
         currency: zod.ZodString;
         type: zod.ZodEnum<{
-            postpaid: "postpaid";
-            prepaid: "prepaid";
             one_time: "one_time";
+            recurring: "recurring";
+        }>;
+        usage_type: zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
         }>;
         interval: zod.ZodEnum<{
             none: "none";

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

@@ -33,19 +33,28 @@
 import * as zod from "zod";
 import { ApplicablePlan } from "./applicablePlan.zod.js";
 import { PriceOption } from "./priceOption.zod.js";
+import { PriceType } from "./priceType.zod.js";
 import { Product } from "./product.zod.js";
 import { PurchaseOperation } from "./purchaseOperation.zod.js";
+import { UsageType } from "./usageType.zod.js";
 export const Applicability = zod
     .strictObject({
     products: zod.array(Product).optional(),
     plans: zod.array(ApplicablePlan).optional(),
     prices: zod.array(PriceOption).optional(),
-    price_types: zod.array(zod.string()).optional(),
+    price_types: zod
+        .array(PriceType)
+        .optional()
+        .describe("The price types covered; empty covers both."),
+    usage_types: zod
+        .array(UsageType)
+        .optional()
+        .describe("The usage types covered; empty covers both."),
     operations: zod.array(PurchaseOperation).optional(),
     min_term_months: zod
         .int()
         .optional()
-        .describe("The shortest term a purchase may have, in months. A purchase with no term, such as\nmetered usage, never qualifies while this is set."),
+        .describe("The shortest term a purchase may have, in months. Purchases without a term, such as metered usage, do not qualify while this is set."),
     max_term_months: zod
         .int()
         .optional()
@@ -54,4 +63,4 @@ export const Applicability = zod
     excluded_plans: zod.array(ApplicablePlan).optional(),
     excluded_prices: zod.array(PriceOption).optional(),
 })
-    .describe("Anything not excluded that matches an inclusion, or anything not excluded when no inclusion is\ngiven, subject to the charge type, operation and term conditions. Entries always include their\ndisplay fields; archived plans and prices stay listed with active set to false.");
+    .describe("Covers anything not excluded that matches an inclusion, or anything not excluded when no inclusion is given, subject to the price type, usage type, operation and term conditions. Archived plans and prices stay listed with active false.");

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

@@ -37,4 +37,4 @@ export const ApplicablePlan = zod
     name: zod.string(),
     active: zod.boolean(),
 })
-    .describe("A plan it refers to. active is false once the plan is archived; it still applies to subscriptions already on this plan.");
+    .describe("A plan referenced by an applicability; active is false once it is archived, and the reference still applies.");

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

@@ -35,22 +35,22 @@ export const BillingAccount = zod.strictObject({
     invoice_contact_id: zod
         .uuid()
         .nullish()
-        .describe("The active contact used for invoicing. Must belong to this account; null clears the selection."),
+        .describe("The active contact used for invoices, of this account; null clears it."),
     id: zod.int(),
-    name: zod.string().optional().describe("What you call this account."),
+    name: zod.string().optional().describe("Your name for the account."),
     currency: zod.string().describe("Fixed when the account was opened."),
     status: zod.enum(["active", "suspended", "closed"]),
     grace_amount: zod
         .string()
         .optional()
-        .describe('How far past the suspension threshold this account may go before its resources are\nsuspended. "0" means none: the account is suspended as soon as it crosses the threshold.'),
+        .describe("How far past the suspension threshold the account may go before its resources are suspended; `0` means none."),
     grace_period_seconds: zod
         .int()
         .optional()
-        .describe("How long this account has to top up after crossing the suspension threshold.\n0 means none. Whichever runs out first — this or grace_amount — ends the grace."),
+        .describe("How long the account has to top up after crossing the suspension threshold, in seconds; `0` means none. Grace ends when this or grace_amount runs out."),
     closed_at: zod.iso
         .datetime({ offset: true })
         .nullish()
-        .describe("The actual time this account was closed, in UTC (RFC 3339).\nNull or absent if the account is not closed or its historical close time is unknown."),
+        .describe("When the account was closed. Null if it is not closed or the time is unknown."),
     created_at: zod.iso.datetime({ offset: true }),
 });

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

@@ -36,6 +36,6 @@ export const BillingAccountUpdate = zod.strictObject({
     invoice_contact_id: zod
         .uuid()
         .nullish()
-        .describe("The active contact used for invoicing. Must belong to this account; null clears the selection."),
+        .describe("The active contact used for invoices, of this account; null clears it."),
     name: zod.string().max(billingAccountUpdateNameMax).optional(),
 });

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

@@ -0,0 +1,39 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Canopy API
+ * Canopy model inference, API keys, model catalogue, service enablement and recorded usage.
+ *
+ * OpenAI-compatible project inference is served on this host at `/v1/chat/completions`,
+ * `/v1/embeddings`, `/v1/models` and `/v1/models/{model}`. Use `https://canopy.leaflow.cloud/v1`
+ * as the OpenAI SDK base URL. Chat completions support `stream=true` SSE.
+ *
+ * Management operations use `/api/v1`. The management model catalogue includes pricing;
+ * `/v1/models` returns the OpenAI model format with Canopy capabilities and parameter limits.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * Management and project inference accept the same verified IAM scoped token. The token is the
+ * sole billing project authority; `OpenAI-Project` and historical identity headers cannot
+ * override it. These endpoints do not accept a Canopy API key. The separate API-key gateway
+ * accepts Canopy API keys and supports OpenAI, Anthropic and Gemini request formats.
+ *
+ * ## 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 BillingScheme: zod.ZodEnum<{
+    per_unit: "per_unit";
+    tiered: "tiered";
+}>;
+export type BillingScheme = zod.input<typeof BillingScheme>;
+export type BillingSchemeOutput = zod.output<typeof BillingScheme>;

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

@@ -0,0 +1,36 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Canopy API
+ * Canopy model inference, API keys, model catalogue, service enablement and recorded usage.
+ *
+ * OpenAI-compatible project inference is served on this host at `/v1/chat/completions`,
+ * `/v1/embeddings`, `/v1/models` and `/v1/models/{model}`. Use `https://canopy.leaflow.cloud/v1`
+ * as the OpenAI SDK base URL. Chat completions support `stream=true` SSE.
+ *
+ * Management operations use `/api/v1`. The management model catalogue includes pricing;
+ * `/v1/models` returns the OpenAI model format with Canopy capabilities and parameter limits.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * Management and project inference accept the same verified IAM scoped token. The token is the
+ * sole billing project authority; `OpenAI-Project` and historical identity headers cannot
+ * override it. These endpoints do not accept a Canopy API key. The separate API-key gateway
+ * accepts Canopy API keys and supports OpenAI, Anthropic and Gemini request formats.
+ *
+ * ## 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 const BillingScheme = zod
+    .enum(["per_unit", "tiered"])
+    .describe("`per_unit` multiplies a unit amount; `tiered` walks a ladder.");

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

@@ -64,10 +64,13 @@ export declare const Cancellation: zod.ZodObject<{
         subscription_id: zod.ZodUUID;
         plan_id: zod.ZodUUID;
         plan_name: zod.ZodString;
-        charge_type: zod.ZodEnum<{
-            postpaid: "postpaid";
-            prepaid: "prepaid";
+        type: zod.ZodEnum<{
             one_time: "one_time";
+            recurring: "recurring";
+        }>;
+        usage_type: zod.ZodEnum<{
+            licensed: "licensed";
+            metered: "metered";
         }>;
         status: zod.ZodEnum<{
             completed: "completed";

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

@@ -46,16 +46,16 @@ export const Cancellation = zod
         .describe("For `immediate`, the second the refund is computed as of."),
     origin: zod
         .enum(["customer", "operator", "project_deletion"])
-        .describe("Who asked for it. `project_deletion` means the project was deleted."),
+        .describe("Who requested it; `project_deletion` means the project was deleted."),
     billing_account_id: zod
         .int()
-        .describe("The billing account that paid for these subscriptions when the cancellation was created: the\naccount of an account-level purchase, or the account the project was linked to."),
+        .describe("The billing account paying for these subscriptions when the cancellation was created: the purchasing account of an account-level purchase, or the project's linked account."),
     currency: zod.string(),
-    expected_refundable_amount: Money.optional().describe("The refund confirmed when it was created. Absent when the platform created it."),
+    expected_refundable_amount: Money.optional().describe("The refund confirmed when the cancellation was created. Absent when the platform created it."),
     failure_code: zod
         .string()
         .optional()
-        .describe("Present with `failed`. A code of the service that provides the resources, such as a disk\nthat can only be released with its server. Clients map it to their own wording."),
+        .describe("Present with `failed`: the owning service's code, such as for a disk that can only be released with its server."),
     requested_at: zod.iso.datetime({ offset: true }),
     completed_at: zod.iso.datetime({ offset: true }).optional(),
     canceled_at: zod.iso.datetime({ offset: true }).optional(),