@leaflow/sdk 0.121.0 → 0.123.0

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

@@ -0,0 +1,71 @@
+/**
+ * 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 { ObjectIdentity } from "./objectIdentity.zod.js";
+import { PaymentCancellationReason } from "./paymentCancellationReason.zod.js";
+import { TransactionType } from "./transactionType.zod.js";
+export const Transaction = zod
+    .strictObject({
+    invoice_id: zod.uuid().optional(),
+    transaction_id: zod.uuid().optional(),
+    credit_grant_id: zod
+        .uuid()
+        .optional()
+        .describe("The credit grant that paid, or for a refund, the credit grant restored."),
+    credit_grant: ObjectIdentity.optional(),
+    refund_id: zod.uuid().optional(),
+    refund_destination: zod
+        .enum(["balance", "credit", "gateway"])
+        .optional()
+        .describe("Present on refunds. Where this part of the refund goes.\n\n- `balance`: back to the account balance.\n- `credit`: back to the credit grant that paid, which keeps its original expiry.\n- `gateway`: back to the payment method it was paid with."),
+    status: zod
+        .enum(["pending", "succeeded", "failed", "canceled"])
+        .optional()
+        .describe("`failed` means the operation did not succeed; for a gateway payment, that the gateway declined\nit. `canceled` means a gateway payment was withdrawn without collecting money. After either,\nan invoice the payment was meant to pay remains open for another payment."),
+    cancellation_reason: PaymentCancellationReason.optional(),
+    payment_gateway: zod.string().optional(),
+    method_type: zod.string().optional(),
+    failure_reason: zod
+        .string()
+        .optional()
+        .describe("Why it failed. Present with `failed`. For a declined gateway payment the value is the\ngateway's own code, passed on unchanged: the card issuer's decline code when there is one\n(Stripe's decline_code, such as insufficient_funds or lost_card), otherwise the gateway's\nerror 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."),
+    settled_at: zod.iso.datetime({ offset: true }).optional(),
+    id: zod.uuid(),
+    billing_account_id: zod.int().optional(),
+    type: TransactionType,
+    amount: Money.describe("Signed by type: positive for `topup` and `payment`, negative for `refund`.\nAn `adjustment` is positive when it adds to the balance and negative when it takes from\nit. For the other types the sign does not tell the effect on the balance: a payment from\nthe balance lowers it, while a payment by gateway or by credit leaves it unchanged."),
+    remaining_amount: Money.describe("How much of this transaction is still available in the balance. Only top-ups, positive\nadjustments and gateway payments later returned to the balance can be non-zero."),
+    currency: zod.string(),
+    reason: zod.string().optional(),
+    created_at: zod.iso.datetime({ offset: true }),
+})
+    .describe("A funds operation. Each payment has one source; refunds identify the original successful transaction. Unknown gateway results remain pending. Payments from the balance or a gateway are distinct from credit-grant payments.");

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

@@ -0,0 +1,83 @@
+/**
+ * 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 TransactionList: zod.ZodObject<{
+    items: 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>>;
+    pagination: zod.ZodObject<{
+        page: zod.ZodInt;
+        page_size: zod.ZodInt;
+        total_count: zod.ZodOptional<zod.ZodInt>;
+    }, zod.z.core.$strict>;
+}, zod.z.core.$strict>;
+export type TransactionList = zod.input<typeof TransactionList>;
+export type TransactionListOutput = zod.output<typeof TransactionList>;

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

@@ -0,0 +1,37 @@
+/**
+ * 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 { OffsetPagination } from "./offsetPagination.zod.js";
+import { Transaction } from "./transaction.zod.js";
+export const TransactionList = zod.strictObject({
+    items: zod.array(Transaction),
+    pagination: OffsetPagination,
+});

package/dist/canopy/v1/generated/validators/transactionType.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 TransactionType: zod.ZodEnum<{
+    topup: "topup";
+    payment: "payment";
+    refund: "refund";
+    adjustment: "adjustment";
+}>;
+export type TransactionType = zod.input<typeof TransactionType>;
+export type TransactionTypeOutput = zod.output<typeof TransactionType>;

package/dist/canopy/v1/generated/validators/transactionType.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 TransactionType = zod
+    .enum(["topup", "payment", "refund", "adjustment"])
+    .describe("topup adds to the balance; payment settles an invoice; refund returns original funds; adjustment changes the balance with an audit reason.");

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

@@ -0,0 +1,66 @@
+/**
+ * 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 UsageCharge: zod.ZodObject<{
+    subscription_id: zod.ZodUUID;
+    id: zod.ZodUUID;
+    project_id: zod.ZodOptional<zod.ZodUUID>;
+    project: zod.ZodOptional<zod.ZodUnion<readonly [zod.ZodObject<{
+        id: zod.ZodUUID;
+        name: zod.ZodString;
+    }, zod.z.core.$strict>, zod.ZodNull]>>;
+    product: zod.ZodObject<{
+        id: zod.ZodString;
+        name: zod.ZodString;
+        description: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>;
+    resource_id: zod.ZodOptional<zod.ZodString>;
+    meter: zod.ZodObject<{
+        lookup_key: zod.ZodOptional<zod.ZodString>;
+        id: zod.ZodUUID;
+        name: zod.ZodString;
+    }, zod.z.core.$strict>;
+    unit: zod.ZodOptional<zod.ZodString>;
+    dimensions: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+    window_start: zod.z.ZodISODateTime;
+    window_end: zod.z.ZodISODateTime;
+    gross_quantity: zod.ZodOptional<zod.ZodString>;
+    deducted_quantity: zod.ZodOptional<zod.ZodString>;
+    quantity: zod.ZodString;
+    unit_amount: zod.ZodOptional<zod.ZodString>;
+    amount: zod.ZodString;
+    currency: zod.ZodString;
+    invoice_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+    invoice_item_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+    statement_id: zod.ZodOptional<zod.ZodUUID>;
+}, zod.z.core.$strict>;
+export type UsageCharge = zod.input<typeof UsageCharge>;
+export type UsageChargeOutput = zod.output<typeof UsageCharge>;

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

@@ -0,0 +1,80 @@
+/**
+ * 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 { NamedIdentity } from "./namedIdentity.zod.js";
+import { ObjectIdentity } from "./objectIdentity.zod.js";
+import { Product } from "./product.zod.js";
+export const UsageCharge = zod.strictObject({
+    subscription_id: zod.uuid(),
+    id: zod.uuid(),
+    project_id: zod.uuid().optional(),
+    project: zod
+        .union([NamedIdentity, zod.null()])
+        .optional()
+        .describe("The project and its current name, for display. Absent when the project no longer exists or its\ndetails cannot be read at the moment; `project_id` still identifies it."),
+    product: Product,
+    resource_id: zod
+        .string()
+        .optional()
+        .describe("Which resource this was charged for. Empty for charges not tied to one."),
+    meter: ObjectIdentity,
+    unit: zod.string().optional(),
+    dimensions: zod
+        .record(zod.string(), zod.string())
+        .optional()
+        .describe("The attributes the rate was chosen by, such as region and machine type."),
+    window_start: zod.iso.datetime({ offset: true }),
+    window_end: zod.iso.datetime({ offset: true }).describe("Exclusive."),
+    gross_quantity: zod
+        .string()
+        .optional()
+        .describe("How much was used, before any included allowance."),
+    deducted_quantity: zod
+        .string()
+        .optional()
+        .describe("How much of that was covered by an allowance."),
+    quantity: zod
+        .string()
+        .describe("What was charged for — the gross quantity less the part covered."),
+    unit_amount: Money.optional(),
+    amount: Money,
+    currency: zod.string(),
+    invoice_id: zod
+        .uuid()
+        .nullish()
+        .describe("Present after the statement is closed and its invoice is issued."),
+    invoice_item_id: zod
+        .uuid()
+        .nullish()
+        .describe("Present after the statement is closed and its invoice is issued."),
+    statement_id: zod.uuid().optional().describe("The statement this charge was collected into."),
+});

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

@@ -0,0 +1,73 @@
+/**
+ * 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 UsageChargeList: zod.ZodObject<{
+    items: zod.ZodArray<zod.ZodObject<{
+        subscription_id: zod.ZodUUID;
+        id: zod.ZodUUID;
+        project_id: zod.ZodOptional<zod.ZodUUID>;
+        project: zod.ZodOptional<zod.ZodUnion<readonly [zod.ZodObject<{
+            id: zod.ZodUUID;
+            name: zod.ZodString;
+        }, zod.z.core.$strict>, zod.ZodNull]>>;
+        product: zod.ZodObject<{
+            id: zod.ZodString;
+            name: zod.ZodString;
+            description: zod.ZodOptional<zod.ZodString>;
+        }, zod.z.core.$strict>;
+        resource_id: zod.ZodOptional<zod.ZodString>;
+        meter: zod.ZodObject<{
+            lookup_key: zod.ZodOptional<zod.ZodString>;
+            id: zod.ZodUUID;
+            name: zod.ZodString;
+        }, zod.z.core.$strict>;
+        unit: zod.ZodOptional<zod.ZodString>;
+        dimensions: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+        window_start: zod.z.ZodISODateTime;
+        window_end: zod.z.ZodISODateTime;
+        gross_quantity: zod.ZodOptional<zod.ZodString>;
+        deducted_quantity: zod.ZodOptional<zod.ZodString>;
+        quantity: zod.ZodString;
+        unit_amount: zod.ZodOptional<zod.ZodString>;
+        amount: zod.ZodString;
+        currency: zod.ZodString;
+        invoice_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+        invoice_item_id: zod.ZodOptional<zod.ZodNullable<zod.ZodUUID>>;
+        statement_id: zod.ZodOptional<zod.ZodUUID>;
+    }, zod.z.core.$strict>>;
+    pagination: zod.ZodObject<{
+        page: zod.ZodInt;
+        page_size: zod.ZodInt;
+        total_count: zod.ZodOptional<zod.ZodInt>;
+    }, zod.z.core.$strict>;
+}, zod.z.core.$strict>;
+export type UsageChargeList = zod.input<typeof UsageChargeList>;
+export type UsageChargeListOutput = zod.output<typeof UsageChargeList>;

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

@@ -0,0 +1,37 @@
+/**
+ * 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 { OffsetPagination } from "./offsetPagination.zod.js";
+import { UsageCharge } from "./usageCharge.zod.js";
+export const UsageChargeList = zod.strictObject({
+    items: zod.array(UsageCharge),
+    pagination: OffsetPagination,
+});