@leaflow/sdk 0.120.0 → 0.122.0

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

@@ -0,0 +1,53 @@
+/**
+ * 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 PaymentPreview: zod.ZodObject<{
+    currency: zod.ZodString;
+    amount_due: zod.ZodString;
+    credit_applied: zod.ZodString;
+    credit_grants: zod.ZodArray<zod.ZodObject<{
+        credit_grant_id: zod.ZodUUID;
+        name: zod.ZodString;
+        amount: zod.ZodString;
+    }, zod.z.core.$strict>>;
+    balance_applied: zod.ZodString;
+    gateway_amount: zod.ZodString;
+    balance_after: zod.ZodString;
+    invoices: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+        invoice_id: zod.ZodUUID;
+        order_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+        amount_due: zod.ZodString;
+        credit_applied: zod.ZodString;
+        balance_applied: zod.ZodString;
+    }, zod.z.core.$strict>>>;
+}, zod.z.core.$strict>;
+export type PaymentPreview = zod.input<typeof PaymentPreview>;
+export type PaymentPreviewOutput = zod.output<typeof PaymentPreview>;

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { AppliedCredit } from "./appliedCredit.zod.js";
+import { Money } from "./money.zod.js";
+import { PaymentPreviewInvoice } from "./paymentPreviewInvoice.zod.js";
+export const PaymentPreview = zod
+    .strictObject({
+    currency: zod.string(),
+    amount_due: Money.describe("What is outstanding before paying."),
+    credit_applied: Money.describe("What credit grants would pay. Grants restricted to other purchases pay nothing here."),
+    credit_grants: zod
+        .array(AppliedCredit)
+        .describe("The credit grants that would pay, in the order they would be used."),
+    balance_applied: Money.describe("What the balance would pay."),
+    gateway_amount: Money.describe("What would remain to be paid online. Paying without a gateway is refused with `BILLING_INSUFFICIENT_FUNDS` while this is above zero."),
+    balance_after: Money.describe("The available balance after paying."),
+    invoices: zod
+        .array(PaymentPreviewInvoice)
+        .optional()
+        .describe("Paying together only. Each invoice, in the order it would be paid."),
+})
+    .describe("What paying would take, computed as paying computes it. Nothing is charged or reserved.");

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

@@ -0,0 +1,40 @@
+/**
+ * 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 PaymentPreviewInvoice: zod.ZodObject<{
+    invoice_id: zod.ZodUUID;
+    order_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+    amount_due: zod.ZodString;
+    credit_applied: zod.ZodString;
+    balance_applied: zod.ZodString;
+}, zod.z.core.$strict>;
+export type PaymentPreviewInvoice = zod.input<typeof PaymentPreviewInvoice>;
+export type PaymentPreviewInvoiceOutput = zod.output<typeof PaymentPreviewInvoice>;

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { Money } from "./money.zod.js";
+export const PaymentPreviewInvoice = zod.strictObject({
+    invoice_id: zod.uuid(),
+    order_id: zod.uuid().nullish(),
+    amount_due: Money,
+    credit_applied: Money,
+    balance_applied: Money,
+});

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

@@ -0,0 +1,109 @@
+/**
+ * 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 PaymentResult: zod.ZodObject<{
+    transactions: zod.ZodArray<zod.ZodObject<{
+        invoice_id: zod.ZodOptional<zod.ZodUUID>;
+        transaction_id: zod.ZodOptional<zod.ZodUUID>;
+        credit_grant_id: zod.ZodOptional<zod.ZodUUID>;
+        credit_grant: zod.ZodOptional<zod.ZodObject<{
+            lookup_key: zod.ZodOptional<zod.ZodString>;
+            id: zod.ZodUUID;
+            name: zod.ZodString;
+        }, zod.z.core.$strict>>;
+        refund_id: zod.ZodOptional<zod.ZodUUID>;
+        refund_destination: zod.ZodOptional<zod.ZodEnum<{
+            balance: "balance";
+            credit: "credit";
+            gateway: "gateway";
+        }>>;
+        status: zod.ZodOptional<zod.ZodEnum<{
+            pending: "pending";
+            failed: "failed";
+            canceled: "canceled";
+            succeeded: "succeeded";
+        }>>;
+        cancellation_reason: zod.ZodOptional<zod.ZodEnum<{
+            abandoned: "abandoned";
+            requested_by_customer: "requested_by_customer";
+        }>>;
+        payment_gateway: zod.ZodOptional<zod.ZodString>;
+        method_type: zod.ZodOptional<zod.ZodString>;
+        failure_reason: zod.ZodOptional<zod.ZodString>;
+        settled_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+        id: zod.ZodUUID;
+        billing_account_id: zod.ZodOptional<zod.ZodInt>;
+        type: zod.ZodEnum<{
+            topup: "topup";
+            payment: "payment";
+            refund: "refund";
+            adjustment: "adjustment";
+        }>;
+        amount: zod.ZodString;
+        remaining_amount: zod.ZodString;
+        currency: zod.ZodString;
+        reason: zod.ZodOptional<zod.ZodString>;
+        created_at: zod.z.ZodISODateTime;
+    }, zod.z.core.$strict>>;
+    transaction_id: zod.ZodOptional<zod.ZodUUID>;
+    status: zod.ZodEnum<{
+        failed: "failed";
+        succeeded: "succeeded";
+        processing: "processing";
+        requires_action: "requires_action";
+    }>;
+    amount_paid: zod.ZodString;
+    amount_due: zod.ZodString;
+    currency: zod.ZodString;
+    credit_applied: zod.ZodOptional<zod.ZodString>;
+    gateway_amount: zod.ZodOptional<zod.ZodString>;
+    payment_gateway: zod.ZodOptional<zod.ZodString>;
+    method_type: zod.ZodOptional<zod.ZodString>;
+    balance_applied: zod.ZodOptional<zod.ZodString>;
+    action: zod.ZodOptional<zod.ZodObject<{
+        type: zod.ZodEnum<{
+            redirect: "redirect";
+            qr_code: "qr_code";
+            sdk: "sdk";
+        }>;
+        provider: zod.ZodOptional<zod.ZodString>;
+        url: zod.ZodOptional<zod.ZodURL>;
+        qr_code: zod.ZodOptional<zod.ZodString>;
+        client_secret: zod.ZodOptional<zod.ZodString>;
+        public_key: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>>;
+    retriable: zod.ZodOptional<zod.ZodBoolean>;
+    invoice_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+    order_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+    failure_reason: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type PaymentResult = zod.input<typeof PaymentResult>;
+export type PaymentResultOutput = zod.output<typeof PaymentResult>;

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

@@ -0,0 +1,62 @@
+/**
+ * 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 { Money } from "./money.zod.js";
+import { PaymentAction } from "./paymentAction.zod.js";
+import { PaymentStatus } from "./paymentStatus.zod.js";
+import { Transaction } from "./transaction.zod.js";
+export const PaymentResult = zod.strictObject({
+    transactions: zod.array(Transaction),
+    transaction_id: zod
+        .uuid()
+        .optional()
+        .describe("The gateway transaction, when one is involved. Balance and credit-grant payments are separate transactions."),
+    status: PaymentStatus,
+    amount_paid: Money,
+    amount_due: Money.describe("What is still outstanding. Zero once the payment succeeds. Unchanged while\n`processing`: nothing is collected until the gateway confirms it."),
+    currency: zod.string(),
+    credit_applied: Money.optional(),
+    gateway_amount: Money.optional(),
+    payment_gateway: zod.string().optional(),
+    method_type: zod.string().optional(),
+    balance_applied: Money.optional().describe("The amount already paid from the account's balance toward this invoice. Retrying an online remainder\ndoes not debit it again. A canceled purchase returns funds through its refund process."),
+    action: PaymentAction.optional(),
+    retriable: zod
+        .boolean()
+        .optional()
+        .describe("Whether paying again is worth attempting. False for a refusal that will keep\nhappening — a closed account, an amount over a limit — so that a client does not\nretry in a loop."),
+    invoice_id: zod.uuid().nullish(),
+    order_id: zod.uuid().nullish(),
+    failure_reason: zod
+        .string()
+        .optional()
+        .describe("Why the payment did not go through. Present with `failed`. For a declined gateway payment the\nvalue is the gateway's own code, passed on unchanged: the card issuer's decline code when\nthere is one (Stripe's decline_code, such as insufficient_funds or lost_card), otherwise the\ngateway's error code (Stripe's code, such as card_declined, expired_card or\npayment_intent_authentication_failure). Clients map it to their own wording and treat an\nunknown value as a generic decline."),
+});

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

@@ -0,0 +1,39 @@
+/**
+ * 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 PaymentStatus: zod.ZodEnum<{
+    failed: "failed";
+    succeeded: "succeeded";
+    processing: "processing";
+    requires_action: "requires_action";
+}>;
+export type PaymentStatus = zod.input<typeof PaymentStatus>;
+export type PaymentStatusOutput = zod.output<typeof PaymentStatus>;

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

@@ -0,0 +1,34 @@
+/**
+ * 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 const PaymentStatus = zod
+    .enum(["succeeded", "processing", "requires_action", "failed"])
+    .describe("The current payment outcome.\n\nsucceeded means payment is complete. processing means confirmation is pending; poll the invoice or\norder rather than submitting another payment. requires_action means the customer must complete the\nsupplied action. failed means the attempt did not succeed and failure_reason explains the outcome; a\ndeclined gateway payment is withdrawn at the gateway, and paying again starts a new payment with the\nsame or another method.");

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

@@ -30,8 +30,30 @@
  */
 import * as zod from "zod";
 export declare const PlacedOrder: zod.ZodObject<{
-    invoice_id: zod.ZodNullable<zod.ZodUUID>;
     order_id: zod.ZodUUID;
+    invoice_id: zod.ZodUUID;
+    invoice: zod.ZodObject<{
+        id: zod.ZodUUID;
+        number: zod.ZodOptional<zod.ZodString>;
+        currency: zod.ZodString;
+        status: zod.ZodEnum<{
+            void: "void";
+            open: "open";
+            draft: "draft";
+            paid: "paid";
+            uncollectible: "uncollectible";
+        }>;
+        subtotal: zod.ZodString;
+        discount_amount: zod.ZodString;
+        tax_amount: zod.ZodString;
+        total: zod.ZodString;
+        amount_paid: zod.ZodString;
+        pre_payment_credit_notes_amount: zod.ZodString;
+        post_payment_credit_notes_amount: zod.ZodString;
+        amount_due: zod.ZodString;
+        amount_refunded: zod.ZodString;
+        due_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+    }, zod.z.core.$strict>;
 }, zod.z.core.$strict>;
 export type PlacedOrder = zod.input<typeof PlacedOrder>;
 export type PlacedOrderOutput = zod.output<typeof PlacedOrder>;

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

@@ -29,14 +29,11 @@
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from "zod";
+import { InvoiceSummary } from "./invoiceSummary.zod.js";
 export const PlacedOrder = zod
     .strictObject({
-    invoice_id: zod
-        .uuid()
-        .nullable()
-        .describe("The invoice for this purchase, which may still be a draft awaiting checkout. Null when no invoice has been created. Its presence or absence does not establish whether delivery may begin."),
-    order_id: zod
-        .uuid()
-        .describe("The order, including for purchases without an immediate charge. Payment alone does not imply that the service has completed delivery."),
+    order_id: zod.uuid(),
+    invoice_id: zod.uuid().describe("The order's invoice, the same as invoice.id."),
+    invoice: InvoiceSummary.describe("What the purchase charges. A draft shows the base price in total and is paid through Billing, where a\npromotion code can still be applied; an open invoice is issued and awaits its amount_due; a paid one\nneeds nothing further. A zero-total invoice is issued and paid at placement."),
 })
-    .describe("Identifies the purchase. Read the order for purchase progress and its invoice for amounts and payment status.");
+    .describe("The Billing order this purchase placed and its invoice as they stood at placement. Read the order and\nthe invoice in Billing for current progress: the service starts delivery only after Billing accepts the\norder, and payment alone does not mean delivery has completed.");

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

@@ -0,0 +1,54 @@
+/**
+ * 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 Plan: zod.ZodObject<{
+    active: zod.ZodBoolean;
+    lookup_key: zod.ZodOptional<zod.ZodString>;
+    product: zod.ZodObject<{
+        id: zod.ZodString;
+        name: zod.ZodString;
+        description: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>;
+    features: zod.ZodArray<zod.ZodObject<{
+        feature: zod.ZodObject<{
+            lookup_key: zod.ZodOptional<zod.ZodString>;
+            id: zod.ZodUUID;
+            name: zod.ZodString;
+        }, zod.z.core.$strict>;
+        name: zod.ZodString;
+    }, zod.z.core.$strict>>;
+    id: zod.ZodUUID;
+    product_id: zod.ZodString;
+    name: zod.ZodString;
+    description: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+export type Plan = zod.input<typeof Plan>;
+export type PlanOutput = zod.output<typeof Plan>;

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

@@ -0,0 +1,46 @@
+/**
+ * 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 { PlanFeature } from "./planFeature.zod.js";
+import { Product } from "./product.zod.js";
+import { ProductID } from "./productID.zod.js";
+export const Plan = zod.strictObject({
+    active: zod
+        .boolean()
+        .describe("False once archived. An archived plan cannot be bought until it is active again."),
+    lookup_key: zod.string().optional(),
+    product: Product,
+    features: zod.array(PlanFeature),
+    id: zod.uuid(),
+    product_id: ProductID,
+    name: zod.string(),
+    description: zod.string().optional(),
+});

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

@@ -0,0 +1,41 @@
+/**
+ * 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 PlanFeature: zod.ZodObject<{
+    feature: zod.ZodObject<{
+        lookup_key: zod.ZodOptional<zod.ZodString>;
+        id: zod.ZodUUID;
+        name: zod.ZodString;
+    }, zod.z.core.$strict>;
+    name: zod.ZodString;
+}, zod.z.core.$strict>;
+export type PlanFeature = zod.input<typeof PlanFeature>;
+export type PlanFeatureOutput = zod.output<typeof PlanFeature>;