@leaflow/sdk 0.125.1 → 0.127.0

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

@@ -0,0 +1,36 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Financial operations require an account access token and billing-account authorization. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const MonthlyStatement: zod.ZodObject<{
+    billing_account_id: zod.ZodInt;
+    currency: zod.ZodString;
+    period_start: zod.z.ZodISODateTime;
+    period_end: zod.z.ZodISODateTime;
+    finalized: zod.ZodBoolean;
+    finalized_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+    statement_count: zod.ZodInt;
+    billed: zod.ZodObject<{
+        subtotal: zod.ZodString;
+        discount_amount: zod.ZodString;
+        tax_amount: zod.ZodString;
+        total: zod.ZodString;
+    }, zod.z.core.$strict>;
+    credited_amount: zod.ZodString;
+    unbilled: zod.ZodOptional<zod.ZodObject<{
+        subtotal: zod.ZodString;
+        discount_amount: zod.ZodString;
+        tax_amount: zod.ZodString;
+        total: zod.ZodString;
+    }, zod.z.core.$strict>>;
+    credit_applied: zod.ZodString;
+    amount_paid: zod.ZodString;
+    amount_due: zod.ZodString;
+    amount_refunded: zod.ZodString;
+}, zod.z.core.$strict>;
+export type MonthlyStatement = zod.input<typeof MonthlyStatement>;
+export type MonthlyStatementOutput = zod.output<typeof MonthlyStatement>;

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

@@ -0,0 +1,30 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Financial operations require an account access token and billing-account authorization. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { Money } from "./money.zod.js";
+import { StatementAmounts } from "./statementAmounts.zod.js";
+export const MonthlyStatement = zod
+    .strictObject({
+    billing_account_id: zod.int(),
+    currency: zod.string(),
+    period_start: zod.iso.datetime({ offset: true }),
+    period_end: zod.iso.datetime({ offset: true }),
+    finalized: zod
+        .boolean()
+        .describe("True after the period's final closing, which applies minimum charges for the whole month. Usage priced later is still billed in supplement statements and added here."),
+    finalized_at: zod.iso.datetime({ offset: true }).optional(),
+    statement_count: zod.int().describe("Statements of the period, including the open one."),
+    billed: StatementAmounts,
+    credited_amount: Money,
+    unbilled: StatementAmounts.optional(),
+    credit_applied: Money,
+    amount_paid: Money,
+    amount_due: Money,
+    amount_refunded: Money,
+})
+    .describe("One billing account's usage billing for one UTC calendar month, summed over the month's statements. It is a summary, not something to pay; each closing's invoice is collected on its own.");

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

@@ -0,0 +1,43 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Financial operations require an account access token and billing-account authorization. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const MonthlyStatementList: zod.ZodObject<{
+    items: zod.ZodArray<zod.ZodObject<{
+        billing_account_id: zod.ZodInt;
+        currency: zod.ZodString;
+        period_start: zod.z.ZodISODateTime;
+        period_end: zod.z.ZodISODateTime;
+        finalized: zod.ZodBoolean;
+        finalized_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+        statement_count: zod.ZodInt;
+        billed: zod.ZodObject<{
+            subtotal: zod.ZodString;
+            discount_amount: zod.ZodString;
+            tax_amount: zod.ZodString;
+            total: zod.ZodString;
+        }, zod.z.core.$strict>;
+        credited_amount: zod.ZodString;
+        unbilled: zod.ZodOptional<zod.ZodObject<{
+            subtotal: zod.ZodString;
+            discount_amount: zod.ZodString;
+            tax_amount: zod.ZodString;
+            total: zod.ZodString;
+        }, zod.z.core.$strict>>;
+        credit_applied: zod.ZodString;
+        amount_paid: zod.ZodString;
+        amount_due: zod.ZodString;
+        amount_refunded: zod.ZodString;
+    }, 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 MonthlyStatementList = zod.input<typeof MonthlyStatementList>;
+export type MonthlyStatementListOutput = zod.output<typeof MonthlyStatementList>;

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

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Financial operations require an account access token and billing-account authorization. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+import { MonthlyStatement } from "./monthlyStatement.zod.js";
+import { OffsetPagination } from "./offsetPagination.zod.js";
+export const MonthlyStatementList = zod.strictObject({
+    items: zod.array(MonthlyStatement),
+    pagination: OffsetPagination,
+});

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

@@ -17,6 +17,11 @@ export declare const Statement: zod.ZodObject<{
         open: "open";
         closed: "closed";
     }>;
+    type: zod.ZodEnum<{
+        interim: "interim";
+        final: "final";
+        supplement: "supplement";
+    }>;
     estimated: zod.ZodBoolean;
     amounts: zod.ZodObject<{
         subtotal: zod.ZodString;

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

@@ -9,6 +9,7 @@ import * as zod from "zod";
 import { Money } from "./money.zod.js";
 import { StatementAmounts } from "./statementAmounts.zod.js";
 import { StatementStatus } from "./statementStatus.zod.js";
+import { StatementType } from "./statementType.zod.js";
 export const Statement = zod
     .strictObject({
     id: zod.uuid(),
@@ -16,13 +17,12 @@ export const Statement = zod
     currency: zod.string(),
     period_start: zod.iso.datetime({ offset: true }),
     period_end: zod.iso.datetime({ offset: true }),
-    sequence: zod
-        .int()
-        .describe("1 for the first closing of the period; higher for statements that collect usage priced after an earlier closing."),
+    sequence: zod.int().describe("Increases with each closing of the period."),
     status: StatementStatus,
+    type: StatementType,
     estimated: zod
         .boolean()
-        .describe("True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing."),
+        .describe("True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at the period's final closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing."),
     amounts: StatementAmounts,
     closed_at: zod.iso.datetime({ offset: true }).optional(),
     invoice_id: zod
@@ -33,4 +33,4 @@ export const Statement = zod
     calculated_at: zod.iso.datetime({ offset: true }).optional(),
     credited_amount: Money,
 })
-    .describe("An account's consumption for one billing period, collected at one closing. The first statement of a period (sequence 1) closes after the period ends. Usage priced after that closing is collected in a later statement for the same period, which closes and invoices separately; a closed statement is never rewritten. Payments apply to issued invoices.");
+    .describe("An account's consumption for one billing period, collected at one closing. Usage is billed after every settlement run, about hourly; each closing issues an invoice for the usage priced since the previous closing and collects it from credits and balance at once, and later usage is collected in the next statement of the same period. A closed statement is never rewritten. The period's consumption is the sum of its statements.");

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

@@ -18,6 +18,11 @@ export declare const StatementList: zod.ZodObject<{
             open: "open";
             closed: "closed";
         }>;
+        type: zod.ZodEnum<{
+            interim: "interim";
+            final: "final";
+            supplement: "supplement";
+        }>;
         estimated: zod.ZodBoolean;
         amounts: zod.ZodObject<{
             subtotal: zod.ZodString;

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

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Financial operations require an account access token and billing-account authorization. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export declare const StatementType: zod.ZodEnum<{
+    interim: "interim";
+    final: "final";
+    supplement: "supplement";
+}>;
+export type StatementType = zod.input<typeof StatementType>;
+export type StatementTypeOutput = zod.output<typeof StatementType>;

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

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Billing API
+ * Products, prices, orders, subscriptions and account billing. Financial operations require an account access token and billing-account authorization. Public catalogue operations declare no security requirement.
+ * OpenAPI spec version: v1
+ */
+import * as zod from "zod";
+export const StatementType = zod
+    .enum(["interim", "final", "supplement"])
+    .describe("interim: a closing before the period's usage is final; minimum charges are not applied. final: the first closing after the period ended and its late usage was settled; minimum charges for the whole period are applied. supplement: a closing after the final one, for usage priced late. An open statement is interim.");

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

@@ -3342,13 +3342,47 @@ export interface StatementAmounts {
     tax_amount: Money;
     total: Money;
 }
+/**
+ * One billing account's usage billing for one UTC calendar month, summed over the month's statements. It is a summary, not something to pay; each closing's invoice is collected on its own.
+ */
+export interface MonthlyStatement {
+    billing_account_id: number;
+    currency: string;
+    period_start: string;
+    period_end: string;
+    /** True after the period's final closing, which applies minimum charges for the whole month. Usage priced later is still billed in supplement statements and added here. */
+    finalized: boolean;
+    finalized_at?: string;
+    /** Statements of the period, including the open one. */
+    statement_count: number;
+    billed: StatementAmounts;
+    credited_amount: Money;
+    unbilled?: StatementAmounts;
+    credit_applied: Money;
+    amount_paid: Money;
+    amount_due: Money;
+    amount_refunded: Money;
+}
+export interface MonthlyStatementList {
+    items: MonthlyStatement[];
+    pagination: OffsetPagination;
+}
 export type StatementStatus = (typeof StatementStatus)[keyof typeof StatementStatus];
 export declare const StatementStatus: {
     readonly open: "open";
     readonly closed: "closed";
 };
 /**
- * An account's consumption for one billing period, collected at one closing. The first statement of a period (sequence 1) closes after the period ends. Usage priced after that closing is collected in a later statement for the same period, which closes and invoices separately; a closed statement is never rewritten. Payments apply to issued invoices.
+ * interim: a closing before the period's usage is final; minimum charges are not applied. final: the first closing after the period ended and its late usage was settled; minimum charges for the whole period are applied. supplement: a closing after the final one, for usage priced late. An open statement is interim.
+ */
+export type StatementType = (typeof StatementType)[keyof typeof StatementType];
+export declare const StatementType: {
+    readonly interim: "interim";
+    readonly final: "final";
+    readonly supplement: "supplement";
+};
+/**
+ * An account's consumption for one billing period, collected at one closing. Usage is billed after every settlement run, about hourly; each closing issues an invoice for the usage priced since the previous closing and collects it from credits and balance at once, and later usage is collected in the next statement of the same period. A closed statement is never rewritten. The period's consumption is the sum of its statements.
  */
 export interface Statement {
     id: string;
@@ -3356,10 +3390,11 @@ export interface Statement {
     currency: string;
     period_start: string;
     period_end: string;
-    /** 1 for the first closing of the period; higher for statements that collect usage priced after an earlier closing. */
+    /** Increases with each closing of the period. */
     sequence: number;
     status: StatementStatus;
-    /** True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing. */
+    type: StatementType;
+    /** True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at the period's final closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing. */
     estimated: boolean;
     amounts: StatementAmounts;
     closed_at?: string;

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

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

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

@@ -0,0 +1,59 @@
+/**
+ * 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 MonthlyStatement: zod.ZodObject<{
+    billing_account_id: zod.ZodInt;
+    currency: zod.ZodString;
+    period_start: zod.z.ZodISODateTime;
+    period_end: zod.z.ZodISODateTime;
+    finalized: zod.ZodBoolean;
+    finalized_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+    statement_count: zod.ZodInt;
+    billed: zod.ZodObject<{
+        subtotal: zod.ZodString;
+        discount_amount: zod.ZodString;
+        tax_amount: zod.ZodString;
+        total: zod.ZodString;
+    }, zod.z.core.$strict>;
+    credited_amount: zod.ZodString;
+    unbilled: zod.ZodOptional<zod.ZodObject<{
+        subtotal: zod.ZodString;
+        discount_amount: zod.ZodString;
+        tax_amount: zod.ZodString;
+        total: zod.ZodString;
+    }, zod.z.core.$strict>>;
+    credit_applied: zod.ZodString;
+    amount_paid: zod.ZodString;
+    amount_due: zod.ZodString;
+    amount_refunded: zod.ZodString;
+}, zod.z.core.$strict>;
+export type MonthlyStatement = zod.input<typeof MonthlyStatement>;
+export type MonthlyStatementOutput = zod.output<typeof MonthlyStatement>;

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

@@ -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";
+import { Money } from "./money.zod.js";
+import { StatementAmounts } from "./statementAmounts.zod.js";
+export const MonthlyStatement = zod
+    .strictObject({
+    billing_account_id: zod.int(),
+    currency: zod.string(),
+    period_start: zod.iso.datetime({ offset: true }),
+    period_end: zod.iso.datetime({ offset: true }),
+    finalized: zod
+        .boolean()
+        .describe("True after the period's final closing, which applies minimum charges for the whole month. Usage priced later is still billed in supplement statements and added here."),
+    finalized_at: zod.iso.datetime({ offset: true }).optional(),
+    statement_count: zod.int().describe("Statements of the period, including the open one."),
+    billed: StatementAmounts,
+    credited_amount: Money,
+    unbilled: StatementAmounts.optional(),
+    credit_applied: Money,
+    amount_paid: Money,
+    amount_due: Money,
+    amount_refunded: Money,
+})
+    .describe("One billing account's usage billing for one UTC calendar month, summed over the month's statements. It is a summary, not something to pay; each closing's invoice is collected on its own.");

package/dist/canopy/v1/generated/validators/monthlyStatementList.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 MonthlyStatementList: zod.ZodObject<{
+    items: zod.ZodArray<zod.ZodObject<{
+        billing_account_id: zod.ZodInt;
+        currency: zod.ZodString;
+        period_start: zod.z.ZodISODateTime;
+        period_end: zod.z.ZodISODateTime;
+        finalized: zod.ZodBoolean;
+        finalized_at: zod.ZodOptional<zod.z.ZodISODateTime>;
+        statement_count: zod.ZodInt;
+        billed: zod.ZodObject<{
+            subtotal: zod.ZodString;
+            discount_amount: zod.ZodString;
+            tax_amount: zod.ZodString;
+            total: zod.ZodString;
+        }, zod.z.core.$strict>;
+        credited_amount: zod.ZodString;
+        unbilled: zod.ZodOptional<zod.ZodObject<{
+            subtotal: zod.ZodString;
+            discount_amount: zod.ZodString;
+            tax_amount: zod.ZodString;
+            total: zod.ZodString;
+        }, zod.z.core.$strict>>;
+        credit_applied: zod.ZodString;
+        amount_paid: zod.ZodString;
+        amount_due: zod.ZodString;
+        amount_refunded: zod.ZodString;
+    }, 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 MonthlyStatementList = zod.input<typeof MonthlyStatementList>;
+export type MonthlyStatementListOutput = zod.output<typeof MonthlyStatementList>;

package/dist/canopy/v1/generated/validators/monthlyStatementList.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 { MonthlyStatement } from "./monthlyStatement.zod.js";
+import { OffsetPagination } from "./offsetPagination.zod.js";
+export const MonthlyStatementList = zod.strictObject({
+    items: zod.array(MonthlyStatement),
+    pagination: OffsetPagination,
+});

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

@@ -40,6 +40,11 @@ export declare const Statement: zod.ZodObject<{
         open: "open";
         closed: "closed";
     }>;
+    type: zod.ZodEnum<{
+        interim: "interim";
+        final: "final";
+        supplement: "supplement";
+    }>;
     estimated: zod.ZodBoolean;
     amounts: zod.ZodObject<{
         subtotal: zod.ZodString;

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

@@ -32,6 +32,7 @@ import * as zod from "zod";
 import { Money } from "./money.zod.js";
 import { StatementAmounts } from "./statementAmounts.zod.js";
 import { StatementStatus } from "./statementStatus.zod.js";
+import { StatementType } from "./statementType.zod.js";
 export const Statement = zod
     .strictObject({
     id: zod.uuid(),
@@ -39,13 +40,12 @@ export const Statement = zod
     currency: zod.string(),
     period_start: zod.iso.datetime({ offset: true }),
     period_end: zod.iso.datetime({ offset: true }),
-    sequence: zod
-        .int()
-        .describe("1 for the first closing of the period; higher for statements that collect usage priced after an earlier closing."),
+    sequence: zod.int().describe("Increases with each closing of the period."),
     status: StatementStatus,
+    type: StatementType,
     estimated: zod
         .boolean()
-        .describe("True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing."),
+        .describe("True while the statement is open. The estimate applies tier pricing to the period's usage so far and adds tax for the current invoice contact. Minimum charges are added at the period's final closing, and a tier reduction larger than this statement's own charges is credited to earlier invoices of the period at closing."),
     amounts: StatementAmounts,
     closed_at: zod.iso.datetime({ offset: true }).optional(),
     invoice_id: zod
@@ -56,4 +56,4 @@ export const Statement = zod
     calculated_at: zod.iso.datetime({ offset: true }).optional(),
     credited_amount: Money,
 })
-    .describe("An account's consumption for one billing period, collected at one closing. The first statement of a period (sequence 1) closes after the period ends. Usage priced after that closing is collected in a later statement for the same period, which closes and invoices separately; a closed statement is never rewritten. Payments apply to issued invoices.");
+    .describe("An account's consumption for one billing period, collected at one closing. Usage is billed after every settlement run, about hourly; each closing issues an invoice for the usage priced since the previous closing and collects it from credits and balance at once, and later usage is collected in the next statement of the same period. A closed statement is never rewritten. The period's consumption is the sum of its statements.");

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

@@ -41,6 +41,11 @@ export declare const StatementList: zod.ZodObject<{
             open: "open";
             closed: "closed";
         }>;
+        type: zod.ZodEnum<{
+            interim: "interim";
+            final: "final";
+            supplement: "supplement";
+        }>;
         estimated: zod.ZodBoolean;
         amounts: zod.ZodObject<{
             subtotal: zod.ZodString;

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

@@ -0,0 +1,38 @@
+/**
+ * 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 StatementType: zod.ZodEnum<{
+    interim: "interim";
+    final: "final";
+    supplement: "supplement";
+}>;
+export type StatementType = zod.input<typeof StatementType>;
+export type StatementTypeOutput = zod.output<typeof StatementType>;