@paid-ai/paid-node 1.7.1 → 2.0.0

package/dist/esm/api/types/CustomerUnitCapEndedPolicy.d.mts

@@ -0,0 +1,26 @@
+import type * as Paid from "../index.mjs";
+/**
+ * The cap version that was in force at the time of the call, now ended (`effectiveUntil` set). `null` when no version was in force — only scheduled versions were ended.
+ */
+export interface CustomerUnitCapEndedPolicy {
+    /** The cap, in credits of the currency. JSON number; exact within ±2^53. */
+    amount: number;
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    frequency: CustomerUnitCapEndedPolicy.Frequency;
+    schedule: Paid.CustomerUnitCapSchedule;
+    /** When this cap version started applying. The schedule independently defines its spend window. */
+    effectiveFrom: string;
+    /** When this cap version stopped applying (exclusive). */
+    effectiveUntil: string;
+    /** When this cap version was set. */
+    createdAt: string;
+    /** Where this cap version was set from. */
+    source: string;
+}
+export declare namespace CustomerUnitCapEndedPolicy {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    const Frequency: {
+        readonly Monthly: "MONTHLY";
+    };
+    type Frequency = (typeof Frequency)[keyof typeof Frequency];
+}

package/dist/esm/api/types/CustomerUnitCapEndedPolicy.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomerUnitCapEndedPolicy;
+(function (CustomerUnitCapEndedPolicy) {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    CustomerUnitCapEndedPolicy.Frequency = {
+        Monthly: "MONTHLY",
+    };
+})(CustomerUnitCapEndedPolicy || (CustomerUnitCapEndedPolicy = {}));

package/dist/esm/api/types/CustomerUnitCapPeriod.d.mts

@@ -0,0 +1,6 @@
+export interface CustomerUnitCapPeriod {
+    /** Inclusive start of the period, UTC. */
+    start: string;
+    /** Exclusive end of the period, UTC. */
+    end: string;
+}

package/dist/esm/api/types/CustomerUnitCapPeriod.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitCapPolicy.d.mts

@@ -0,0 +1,26 @@
+import type * as Paid from "../index.mjs";
+/**
+ * The cap version in force now.
+ */
+export interface CustomerUnitCapPolicy {
+    /** The cap, in credits of the currency. JSON number; exact within ±2^53. */
+    amount: number;
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    frequency: CustomerUnitCapPolicy.Frequency;
+    schedule: Paid.CustomerUnitCapSchedule;
+    /** When this cap version started applying. The schedule independently defines its spend window. */
+    effectiveFrom: string;
+    /** When this cap version stopped applying (exclusive). `null` while it is open. */
+    effectiveUntil: string | null;
+    /** When this cap version was set. */
+    createdAt: string;
+    /** Where this cap version was set from. */
+    source: string;
+}
+export declare namespace CustomerUnitCapPolicy {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    const Frequency: {
+        readonly Monthly: "MONTHLY";
+    };
+    type Frequency = (typeof Frequency)[keyof typeof Frequency];
+}

package/dist/esm/api/types/CustomerUnitCapPolicy.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomerUnitCapPolicy;
+(function (CustomerUnitCapPolicy) {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    CustomerUnitCapPolicy.Frequency = {
+        Monthly: "MONTHLY",
+    };
+})(CustomerUnitCapPolicy || (CustomerUnitCapPolicy = {}));

package/dist/esm/api/types/CustomerUnitCapResponse.d.mts

@@ -0,0 +1,11 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerUnitCapResponse {
+    /** Your own id for the unit (its `externalId`), the identifier the unit and cap routes take. */
+    externalCustomerUnitId: string;
+    /** The Paid display id of the customer the unit belongs to. */
+    customerId: string;
+    /** The credits currency this response is about: the requested `creditsCurrencyId`, or the organization's only credits currency when it was omitted. */
+    creditsCurrencyId: string;
+    policy: Paid.CustomerUnitCapPolicy;
+    currentPeriod: Paid.CustomerUnitCapCurrentPeriod | null;
+}

package/dist/esm/api/types/CustomerUnitCapResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitCapSavedPolicy.d.mts

@@ -0,0 +1,26 @@
+import type * as Paid from "../index.mjs";
+/**
+ * The new version, or the existing version covering the requested effectiveFrom when changed is false. New versions are open; an existing version may have a finite end.
+ */
+export interface CustomerUnitCapSavedPolicy {
+    /** The cap, in credits of the currency. JSON number; exact within ±2^53. */
+    amount: number;
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    frequency: CustomerUnitCapSavedPolicy.Frequency;
+    schedule: Paid.CustomerUnitCapSchedule;
+    /** When this cap version started applying. The schedule independently defines its spend window. */
+    effectiveFrom: string;
+    /** When this cap version stopped applying (exclusive). `null` while it is open. */
+    effectiveUntil: string | null;
+    /** When this cap version was set. */
+    createdAt: string;
+    /** Where this cap version was set from. */
+    source: string;
+}
+export declare namespace CustomerUnitCapSavedPolicy {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    const Frequency: {
+        readonly Monthly: "MONTHLY";
+    };
+    type Frequency = (typeof Frequency)[keyof typeof Frequency];
+}

package/dist/esm/api/types/CustomerUnitCapSavedPolicy.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomerUnitCapSavedPolicy;
+(function (CustomerUnitCapSavedPolicy) {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    CustomerUnitCapSavedPolicy.Frequency = {
+        Monthly: "MONTHLY",
+    };
+})(CustomerUnitCapSavedPolicy || (CustomerUnitCapSavedPolicy = {}));

package/dist/esm/api/types/CustomerUnitCapSchedule.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Monthly UTC boundaries: an anchored day, or the first of each calendar month.
+ */
+export type CustomerUnitCapSchedule = {
+    type: "ANCHORED";
+    anchorDay: number;
+} | {
+    type: "CALENDAR";
+};

package/dist/esm/api/types/CustomerUnitCapSchedule.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitCapScheduleInput.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Omit to inherit the schedule in force at effectiveFrom. If none applies, use the creation-time UTC day. An explicit change counts spend from the new schedule’s ordinary period start, including earlier spend.
+ */
+export type CustomerUnitCapScheduleInput = {
+    type: "ANCHORED";
+    anchorDay: number;
+} | {
+    type: "CALENDAR";
+};

package/dist/esm/api/types/CustomerUnitCapScheduleInput.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitCapSet.d.mts

@@ -0,0 +1,19 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerUnitCapSet {
+    /** The cap, in credits of the currency, per period. Must be positive. */
+    amount: number;
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    frequency?: CustomerUnitCapSet.Frequency;
+    schedule?: Paid.CustomerUnitCapScheduleInput;
+    /** The credits currency to cap. Omit it only when the organization has exactly one credits currency, which is then used; otherwise it is required. */
+    creditsCurrencyId?: string;
+    /** ISO 8601 timestamp. When the cap starts applying, independently of its schedule. Defaults to now. Spend earlier in the schedule’s current period still counts. */
+    effectiveFrom?: string;
+}
+export declare namespace CustomerUnitCapSet {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    const Frequency: {
+        readonly Monthly: "MONTHLY";
+    };
+    type Frequency = (typeof Frequency)[keyof typeof Frequency];
+}

package/dist/esm/api/types/CustomerUnitCapSet.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomerUnitCapSet;
+(function (CustomerUnitCapSet) {
+    /** Monthly UTC periods, with boundaries defined by `schedule`. */
+    CustomerUnitCapSet.Frequency = {
+        Monthly: "MONTHLY",
+    };
+})(CustomerUnitCapSet || (CustomerUnitCapSet = {}));

package/dist/esm/api/types/CustomerUnitCapSetResponse.d.mts

@@ -0,0 +1,13 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerUnitCapSetResponse {
+    /** Your own id for the unit (its `externalId`), the identifier the unit and cap routes take. */
+    externalCustomerUnitId: string;
+    /** The Paid display id of the customer the unit belongs to. */
+    customerId: string;
+    /** The credits currency the cap was set on: the requested `creditsCurrencyId`, or the organization's only credits currency when it was omitted. */
+    creditsCurrencyId: string;
+    /** Whether this save created a policy version. False when the effective timeline was already identical. */
+    changed: boolean;
+    policy: Paid.CustomerUnitCapSavedPolicy;
+    currentPeriod: Paid.CustomerUnitCapCurrentPeriod | null;
+}

package/dist/esm/api/types/CustomerUnitCapSetResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitCreate.d.mts

@@ -0,0 +1,14 @@
+export interface CustomerUnitCreate {
+    /** Your own id for the unit: required, immutable, at most 255 characters, and unique within the organization: no other customer's unit id, external id or alias may be the same, ignoring letter case. Every unit route addresses the unit by it (percent-encode it in the path), and so do signals (`customerUnit.externalCustomerUnitId`). Cannot be `.` or `..`. */
+    externalId: string;
+    /** Display name (defaults to the external ID). */
+    name?: string;
+    /** Your structural vocabulary for the unit (`department`, `tenant`, `team`, ...). Free text; filterable; Paid never branches on it. */
+    externalType?: string;
+    /** Your external ID of the parent unit; omit it to create the root unit. */
+    parentExternalId?: string;
+    /** Freeform JSON for your own use. */
+    metadata?: Record<string, unknown> | null;
+    /** `false` makes the unit non-billable, together with every unit under it (a dev or QA environment, say). Defaults to `true`. The root unit is always billable (`409 ROOT_UNIT_ALWAYS_BILLABLE`): a customer that should never be billed simply has no order. Sending `false` needs non-billable units enabled for your organization (`403 FEATURE_NOT_ENABLED` otherwise). Usage on a non-billable unit is still recorded but not billed: it burns no credits, adds nothing to invoices or overage, and counts toward no cap, on a price whose usage comes from a meter (read from your events when the invoice closes) too. A meter's derived signal, and a correlation-window meter's window, follow the source event they take their unit from (the window's closing event, else its opening event): they are not billed when that event was not. Usage is still billed when it is sent with a customer API key, and on cost-plus pricing, which bills from costs that carry no unit. Only signals sent to `/api/v2/signals` that resolve to an active unit, by its key or through an alias on it, can be non-billable, and a change applies to signals received afterwards. */
+    billable?: boolean;
+}

package/dist/esm/api/types/CustomerUnitCreate.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitCreatedUnderParent.d.mts

@@ -0,0 +1,34 @@
+export interface CustomerUnitCreatedUnderParent {
+    /** Your own id for the unit, unique within the customer; the identifier every unit route takes. */
+    externalId: string;
+    /** Paid's id of the customer the unit belongs to (`cus_…`). `null` only for a legacy customer that has no Paid id; `customerExternalId` still names it. */
+    customerId: string | null;
+    /** Your external id of that customer, when it has one. */
+    customerExternalId: string | null;
+    /** Display name. Never used to address the unit. */
+    name: string;
+    /** Your structural vocabulary for the unit. */
+    externalType: string | null;
+    /** ACTIVE; DELETED after a soft delete (one-way); or DRAFT, a placeholder that holds the key for this customer until you create the unit with that key (which promotes it) or delete it (soft, the key stays reserved, as for any unit). A draft is never a parent and never carries a cap. */
+    status: CustomerUnitCreatedUnderParent.Status;
+    /** `externalId` of the parent unit; `null` only on the customer's root unit. */
+    parentExternalId: string | null;
+    /** Whether this unit is the customer's root: the one unit without a parent. Derived from the missing parent, not stored. At most one active root per customer; the root cannot be moved, and once deleted a new root can be created. */
+    isRoot: boolean;
+    /** The unit's own setting, as last created or updated: `false` marks it, and every unit under it, non-billable. Always `true` on the root. `effectiveBillable` says whether the unit is billable once its ancestors are counted. Usage on a non-billable unit is still recorded but not billed: it burns no credits, adds nothing to invoices or overage, and counts toward no cap, on a price whose usage comes from a meter (read from your events when the invoice closes) too. A meter's derived signal, and a correlation-window meter's window, follow the source event they take their unit from (the window's closing event, else its opening event): they are not billed when that event was not. Usage is still billed when it is sent with a customer API key, and on cost-plus pricing, which bills from costs that carry no unit. Only signals sent to `/api/v2/signals` that resolve to an active unit, by its key or through an alias on it, can be non-billable, and a change applies to signals received afterwards. */
+    billable: boolean;
+    /** Read-only. Whether the unit is billable in effect: `false` when the unit or any unit above it has `billable: false`. A unit cannot make itself billable under a non-billable ancestor, and moving a unit under one makes it non-billable. */
+    effectiveBillable: boolean;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export declare namespace CustomerUnitCreatedUnderParent {
+    /** ACTIVE; DELETED after a soft delete (one-way); or DRAFT, a placeholder that holds the key for this customer until you create the unit with that key (which promotes it) or delete it (soft, the key stays reserved, as for any unit). A draft is never a parent and never carries a cap. */
+    const Status: {
+        readonly Active: "ACTIVE";
+        readonly Deleted: "DELETED";
+        readonly Draft: "DRAFT";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/CustomerUnitCreatedUnderParent.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomerUnitCreatedUnderParent;
+(function (CustomerUnitCreatedUnderParent) {
+    /** ACTIVE; DELETED after a soft delete (one-way); or DRAFT, a placeholder that holds the key for this customer until you create the unit with that key (which promotes it) or delete it (soft, the key stays reserved, as for any unit). A draft is never a parent and never carries a cap. */
+    CustomerUnitCreatedUnderParent.Status = {
+        Active: "ACTIVE",
+        Deleted: "DELETED",
+        Draft: "DRAFT",
+    };
+})(CustomerUnitCreatedUnderParent || (CustomerUnitCreatedUnderParent = {}));

package/dist/esm/api/types/CustomerUnitListResponse.d.mts

@@ -0,0 +1,6 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerUnitListResponse {
+    /** Flat list ordered by creation time; assemble the tree client-side from `parentExternalId` (`null` on the root). */
+    data: Paid.CustomerUnit[];
+    pagination: Paid.Pagination;
+}

package/dist/esm/api/types/CustomerUnitListResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitSpendResponse.d.mts

@@ -0,0 +1,12 @@
+import type * as Paid from "../index.mjs";
+export interface CustomerUnitSpendResponse {
+    /** Your own id for the unit (its `externalId`), the identifier the unit and cap routes take. */
+    externalCustomerUnitId: string;
+    /** The Paid display id of the customer the unit belongs to. */
+    customerId: string;
+    /** The credits currency this response is about: the requested `creditsCurrencyId`, or the organization's only credits currency when it was omitted. */
+    creditsCurrencyId: string;
+    window: Paid.CustomerUnitSpendWindow;
+    /** Credits of this currency spent by this unit and every unit beneath it during the window, net of reversals. Counted whether or not the unit has a cap. JSON number; exact within ±2^53. */
+    spent: number;
+}

package/dist/esm/api/types/CustomerUnitSpendResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitSpendWindow.d.mts

@@ -0,0 +1,9 @@
+/**
+ * The window `spent` covers: the one requested, or the current calendar month (UTC) when none was given.
+ */
+export interface CustomerUnitSpendWindow {
+    /** Inclusive start of the window, UTC. */
+    start: string;
+    /** Exclusive end of the window, UTC. */
+    end: string;
+}

package/dist/esm/api/types/CustomerUnitSpendWindow.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/CustomerUnitUpdate.d.mts

@@ -0,0 +1,12 @@
+export interface CustomerUnitUpdate {
+    /** Display name. Never used to address the unit. */
+    name?: string;
+    /** Your structural vocabulary for the unit (`department`, `tenant`, `team`, ...). Free text; filterable; Paid never branches on it. */
+    externalType?: string | null;
+    /** Your external ID of the new parent unit; moves the unit and its subtree. */
+    parentExternalId?: string;
+    /** Freeform JSON for your own use. */
+    metadata?: Record<string, unknown> | null;
+    /** Flips the unit's own setting either way. Under a non-billable ancestor the unit stays non-billable in effect (`effectiveBillable`) whatever its own value. Refused on the root unit, which is always billable (`409 ROOT_UNIT_ALWAYS_BILLABLE`). Sending `false` needs non-billable units enabled for your organization (`403 FEATURE_NOT_ENABLED` otherwise). Usage on a non-billable unit is still recorded but not billed: it burns no credits, adds nothing to invoices or overage, and counts toward no cap, on a price whose usage comes from a meter (read from your events when the invoice closes) too. A meter's derived signal, and a correlation-window meter's window, follow the source event they take their unit from (the window's closing event, else its opening event): they are not billed when that event was not. Usage is still billed when it is sent with a customer API key, and on cost-plus pricing, which bills from costs that carry no unit. Only signals sent to `/api/v2/signals` that resolve to an active unit, by its key or through an alias on it, can be non-billable, and a change applies to signals received afterwards. */
+    billable?: boolean;
+}

package/dist/esm/api/types/CustomerUnitUpdate.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DeliveredValueCalculation.d.mts

@@ -0,0 +1,11 @@
+import type * as Paid from "../index.mjs";
+export interface DeliveredValueCalculation {
+    /** First signal this configuration priced, within the requested period. */
+    startDate: string;
+    /** Last signal this configuration priced, within the requested period. */
+    endDate: string;
+    /** Folds left to right into unitTotal, e.g. 40 tickets × 45 minutes ÷ 60 = 30 hours. */
+    terms: Paid.DeliveredValueCalculationTerm[];
+    /** What the terms fold to, in the metric's own unit. */
+    unitTotal: number;
+}

package/dist/esm/api/types/DeliveredValueCalculation.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DeliveredValueCalculationTerm.d.mts

@@ -0,0 +1,34 @@
+export interface DeliveredValueCalculationTerm {
+    /** How this term applies to the running total. Absent on the leading occurrence-count term. */
+    operator?: DeliveredValueCalculationTerm.Operator;
+    /** Customer-facing name of this term, e.g. 'minutes saved'. */
+    label: string;
+    /** The term's raw value. When format is 'percent' this is the stored ratio (0.02 = 2%). */
+    value: number;
+    /** Display-only formatting hint for the value. */
+    format?: DeliveredValueCalculationTerm.Format;
+    /** The unit a 'duration' format is expressed in. */
+    formatUnit?: DeliveredValueCalculationTerm.FormatUnit;
+}
+export declare namespace DeliveredValueCalculationTerm {
+    /** How this term applies to the running total. Absent on the leading occurrence-count term. */
+    const Operator: {
+        readonly Multiply: "×";
+        readonly Divide: "÷";
+    };
+    type Operator = (typeof Operator)[keyof typeof Operator];
+    /** Display-only formatting hint for the value. */
+    const Format: {
+        readonly Percent: "percent";
+        readonly Duration: "duration";
+    };
+    type Format = (typeof Format)[keyof typeof Format];
+    /** The unit a 'duration' format is expressed in. */
+    const FormatUnit: {
+        readonly Seconds: "seconds";
+        readonly Minutes: "minutes";
+        readonly Hours: "hours";
+        readonly Days: "days";
+    };
+    type FormatUnit = (typeof FormatUnit)[keyof typeof FormatUnit];
+}

package/dist/esm/api/types/DeliveredValueCalculationTerm.mjs

@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+export var DeliveredValueCalculationTerm;
+(function (DeliveredValueCalculationTerm) {
+    /** How this term applies to the running total. Absent on the leading occurrence-count term. */
+    DeliveredValueCalculationTerm.Operator = {
+        Multiply: "\u00D7",
+        Divide: "\u00F7",
+    };
+    /** Display-only formatting hint for the value. */
+    DeliveredValueCalculationTerm.Format = {
+        Percent: "percent",
+        Duration: "duration",
+    };
+    /** The unit a 'duration' format is expressed in. */
+    DeliveredValueCalculationTerm.FormatUnit = {
+        Seconds: "seconds",
+        Minutes: "minutes",
+        Hours: "hours",
+        Days: "days",
+    };
+})(DeliveredValueCalculationTerm || (DeliveredValueCalculationTerm = {}));

package/dist/esm/api/types/DeliveredValueMetric.d.mts

@@ -0,0 +1,54 @@
+import type * as Paid from "../index.mjs";
+export interface DeliveredValueMetric {
+    slug: string;
+    name: string;
+    category: string | null;
+    unit: Paid.ValueMetricUnit;
+    description: string | null;
+    longDescription: string | null;
+    sources: DeliveredValueMetric.Sources.Item[] | null;
+    archivedAt: string | null;
+    monetaryConversion: DeliveredValueMetric.MonetaryConversion | null;
+    formula: DeliveredValueMetric.Formula | null;
+    /** Display-ready calculations, oldest first, each one the strip a value receipt renders. Normally a single entry. If the value model changed during the period there is one entry per configuration, each folding the figures that configuration actually priced. Each strip is in the unit that configuration measured, so they sum to unitTotal unless the unit itself changed during the period. Absent when the metric's formula cannot be represented faithfully as a flat strip (e.g. conditions, or signals with differing values), or when nothing was delivered in the period. */
+    calculations?: Paid.DeliveredValueCalculation[];
+    /** Total measured value delivered over the period, in the metric's own unit (see unit). Durations are in the authored durationUnit (e.g. hours), never normalized to seconds. If the unit changed during the period, durations are restated in the current durationUnit. Absent where no total can be stated in one unit: a change of unit type, a renamed custom unit, or a figure mixing rows measured in a known unit with rows whose configuration can no longer be identified. The per-configuration calculations carry the figures instead. */
+    unitTotal?: number;
+    /** Monetary value delivered over the period, in decimal units of the response currency (12.5 = $12.50), not cents. Null when the metric delivered no money and converts none — never reported as 0. A metric priced under a conversion the value model has since dropped still reports what it delivered. */
+    monetaryTotal: number | null;
+    /** Signals that contributed to this metric in the period, counted by quantity — one signal reporting a batch of 100 counts as 100. Fractional where the signals reported fractional quantities. */
+    signalCount: number;
+}
+export declare namespace DeliveredValueMetric {
+    type Sources = Sources.Item[];
+    namespace Sources {
+        interface Item {
+            name: string;
+            url: string;
+        }
+    }
+    interface MonetaryConversion {
+        /** The flat rate, when this conversion is the 'unit_value * rate' shape this API and Value Studio produce. Null for a conversion authored through the whole-manifest upload that this API cannot express — read `expression` and `variables` for those, and edit them with PUT /api/v2/value-models. */
+        valuePerUnit: number | null;
+        /** The rate variable's customer-facing label. Null when valuePerUnit is null. */
+        label: string | null;
+        expression: string;
+        variables: MonetaryConversion.Variables.Item[];
+    }
+    namespace MonetaryConversion {
+        type Variables = Variables.Item[];
+        namespace Variables {
+            interface Item {
+                id: string;
+                label: string;
+                default: number;
+            }
+        }
+    }
+    interface Formula {
+        id: string;
+        label: string;
+        expression: string;
+        variables: Paid.ValueMetricFormulaVariable[];
+    }
+}

package/dist/esm/api/types/DeliveredValueMetric.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DeliveredValueResponse.d.mts

@@ -0,0 +1,34 @@
+import type * as Paid from "../index.mjs";
+export interface DeliveredValueResponse {
+    /** Currency for every monetary field in this response — the customer's override when one exists, else the value model's currency. */
+    currency: string;
+    /** The resolved period, echoing date-only inputs expanded to full UTC date-times. */
+    period: DeliveredValueResponse.Period;
+    customer: DeliveredValueResponse.Customer;
+    /** One entry per value metric, ordered by the value model's display order. Archived metrics appear only when they delivered value in the period. */
+    valueMetrics: Paid.DeliveredValueMetric[];
+    /** Per-event activity behind the metric totals, one entry per event. An event that feeds several value metrics appears once, and states its occurrences and its values once. */
+    signals: Paid.DeliveredValueSignal[];
+    totals: DeliveredValueResponse.Totals;
+}
+export declare namespace DeliveredValueResponse {
+    /**
+     * The resolved period, echoing date-only inputs expanded to full UTC date-times.
+     */
+    interface Period {
+        startDate: string;
+        endDate: string;
+    }
+    interface Customer {
+        /** The Paid customer ID. */
+        id: string;
+        externalId: string | null;
+        name: string;
+    }
+    interface Totals {
+        /** Money delivered over the period, in decimal units of the response currency, not cents. Adds up the signals array exactly, so the breakdown always reconciles with this figure. That includes value whose metric the value model no longer defines, which is why this can exceed the sum of valueMetrics. Signals the value model no longer lists are outside the report altogether and appear in neither. */
+        monetaryTotal: number;
+        /** Total signal occurrences, counted the way a value receipt's footer counts them: events that delivered value, plus display-only events that fired. Quantity-weighted, so fractional where the signals reported fractional quantities. */
+        signalCount: number;
+    }
+}

package/dist/esm/api/types/DeliveredValueResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DeliveredValueSignal.d.mts

@@ -0,0 +1,14 @@
+import type * as Paid from "../index.mjs";
+export interface DeliveredValueSignal {
+    eventName: string;
+    label: string;
+    /** Customer-facing description of this signal. The value model's own description for the event wins. Without one, this is the description of the first metric the signal feeds. */
+    description: string | null;
+    /** Every value metric this signal feeds, in the order the value model binds them. A signal may feed more than one. Empty for a display-only signal. This list comes from the value model, so it does not change with the period. Read values for what each metric actually delivered. */
+    valueTypeSlugs: string[];
+    tags: string[];
+    /** Quantity-weighted occurrences of this event in the period. Fractional where the signals reported fractional quantities. */
+    count: number;
+    /** Delivered value per metric this event contributed to. Empty when the event fired but delivered no value. */
+    values: Paid.DeliveredValueSignalValue[];
+}

package/dist/esm/api/types/DeliveredValueSignal.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DeliveredValueSignalValue.d.mts

@@ -0,0 +1,8 @@
+export interface DeliveredValueSignalValue {
+    /** The value metric this value counted toward. */
+    valueTypeSlug: string;
+    /** Value delivered by this event, in the metric's own unit. Absent for the same reason the metric's unitTotal can be: the period mixes units that do not convert. */
+    unitValue?: number;
+    /** Monetary value delivered by this event, in decimal units of the response currency, not cents. */
+    monetaryValue: number;
+}

package/dist/esm/api/types/DeliveredValueSignalValue.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DeliveredValueSummaryBucket.d.mts

@@ -0,0 +1,20 @@
+export interface DeliveredValueSummaryBucket {
+    /** Start of the bucket (inclusive), UTC. Clipped to the requested startDate when the window starts mid-period. */
+    periodStart: string;
+    /** Last instant of the bucket (inclusive), UTC. Clipped to the requested endDate when the window ends mid-period. */
+    periodEnd: string;
+    /** The group this bucket belongs to. For valueMetric grouping, the metric's slug; an archived metric still appears when it delivered value in the window. For dimension grouping, the payload value of dimensionKey; a signal whose payload lacks the key, or holds it empty, groups under the empty string. For formulaCondition grouping, the metric's slug, a colon, and the band: the zero-based index of the condition that priced the rows, "default" where every condition missed, or "none" where the metric priced them through a formula that has no conditions. Read valueMetric and conditionIndex rather than parsing this. For signal grouping, the name of the source event, as the signals array of GET /delivered-value names it. */
+    groupKey: string;
+    /** Slug of the metric this band belongs to. Present only under formulaCondition grouping. */
+    valueMetric?: string;
+    /** Zero-based index of the formula condition that priced this band's rows, in the order the value model authors them. Present only under formulaCondition grouping, and only for a band that is a condition — absent for the "default" and "none" groups. */
+    conditionIndex?: number;
+    /** The condition that priced this band, as field, operator and value — a stable descriptor, not display copy. A metric priced through several formulas states the label they agree on; where they band differently at this index, no one condition describes the group and the label is absent. */
+    conditionLabel?: string;
+    /** Value delivered in this bucket in the metric's own unit — minutes saved, tickets resolved — as GET /delivered-value states it. Present under valueMetric and formulaCondition grouping, where every row in a group belongs to one metric and so shares its unit. Under dimension and signal grouping it is present only when the request names a valueMetric, which narrows the rows to that one metric; without it the groups sum across metrics that need not measure the same thing (a signal may feed more than one), and no unit describes the sum. */
+    unitTotal?: number;
+    /** Money delivered in this bucket, in decimal units of the response currency (12.5 = $12.50), not cents. */
+    monetaryTotal: number;
+    /** Signals that contributed to this group in this bucket, counted by quantity — one signal reporting a batch of 100 counts as 100. For valueMetric grouping, a signal feeding two metrics counts under both groups. For dimension and signal grouping, it counts once in its group. */
+    signalCount: number;
+}

package/dist/esm/api/types/DeliveredValueSummaryBucket.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};