@paid-ai/paid-node 1.8.0 → 2.0.0

package/dist/cjs/api/types/ProvisionOrderLineAttribute.d.ts

@@ -0,0 +1,96 @@
+export interface ProvisionOrderLineAttribute {
+    name: string;
+    quantity?: number;
+    /** When omitted, the line uses the pricing of the product attribute with the same name, unchanged. This includes pricing models that this request cannot express. Send pricing only to override the catalog price for this order. */
+    pricing?: ProvisionOrderLineAttribute.Pricing;
+    /** Overrides the credit amount on every credit benefit this attribute carries onto the order line. Paid grants creditAmount × quantity per allocation. When omitted, the product attribute's configured benefit amount applies. */
+    creditAmount?: number | null;
+    /** Overrides the overage unit price, in the currency's minor units, for credits consumed beyond the granted balance, on this attribute only: applied to every credit benefit this attribute carries onto the order line, or to the attribute's pricing when it carries no benefits, and it replaces this attribute's per-currency price for the order currency, so it is what this attribute bills in every currency. Other attributes on the order that price the same credits currency keep their own overage prices, and the invoice bills the highest entry for its currency across all of them. When omitted, the product attribute's configured overage applies; null clears it, so the attribute takes its order-currency per-currency price, or none if it has no map. */
+    overageUnitPrice?: number | null;
+    /** Overrides this attribute's per-currency overage prices, in each currency's minor units keyed by uppercase ISO 4217 currency code, wherever overageUnitPrice would land. An entry for the order currency also becomes the attribute's overageUnitPrice. Keys must be currencies the product is priced in. When omitted, the product attribute's configured per-currency prices apply; null removes them, leaving only the scalar overage. */
+    overageUnitPrices?: Record<string, number | null> | null;
+    discountType?: ProvisionOrderLineAttribute.DiscountType;
+    /** Percentage discount, greater than 0 and at most 100, with at most 2 decimal places. Required when `discountType` is `percentage`. */
+    discountPercent?: number;
+    /** Fixed discount in minor currency units (cents). Required when `discountType` is `fixed`. */
+    discountAmount?: number;
+}
+export declare namespace ProvisionOrderLineAttribute {
+    /**
+     * When omitted, the line uses the pricing of the product attribute with the same name, unchanged. This includes pricing models that this request cannot express. Send pricing only to override the catalog price for this order.
+     */
+    interface Pricing {
+        eventName?: string;
+        chargeType: Pricing.ChargeType;
+        pricePoints: Pricing.PricePoints;
+        pricingModel: Pricing.PricingModel;
+        billingFrequency?: Pricing.BillingFrequency;
+        billingFrequencyCustomMonths?: number;
+        /** When the charge is billed. Usage charges must use arrears. */
+        billingType?: Pricing.BillingType;
+    }
+    namespace Pricing {
+        const ChargeType: {
+            readonly Usage: "usage";
+            readonly Recurring: "recurring";
+            readonly OneTime: "oneTime";
+            readonly SeatBased: "seatBased";
+        };
+        type ChargeType = (typeof ChargeType)[keyof typeof ChargeType];
+        interface PricePoints {
+            currency?: string;
+            /** Price per unit, as a whole number in minor currency units (cents): 4900 is $49.00. Must be 0 or more. For a discount or credit, send a positive price on a line with `lineType: CREDIT`. */
+            unitPrice: number;
+            /** Optional pricing tiers for volume/graduated pricing models. When provided, overrides the default flat unitPrice structure. */
+            tiers?: PricePoints.Tiers.Item[];
+        }
+        namespace PricePoints {
+            type Tiers = Tiers.Item[];
+            namespace Tiers {
+                interface Item {
+                    /** Flat fee for this tier, in minor currency units (cents). Must be 0 or more. */
+                    flatAmount?: number;
+                    index?: number;
+                    lowerBound: number;
+                    number?: number;
+                    tierBillingType?: Item.TierBillingType;
+                    /** Price per unit in this tier, in minor currency units (cents). Must be 0 or more. */
+                    unitAmount?: number;
+                    upperBound?: number;
+                }
+                namespace Item {
+                    const TierBillingType: {
+                        readonly Flat: "flat";
+                        readonly PerUnit: "perUnit";
+                    };
+                    type TierBillingType = (typeof TierBillingType)[keyof typeof TierBillingType];
+                }
+            }
+        }
+        const PricingModel: {
+            readonly PerUnit: "perUnit";
+            readonly VolumePricing: "volumePricing";
+            readonly GraduatedPricing: "graduatedPricing";
+        };
+        type PricingModel = (typeof PricingModel)[keyof typeof PricingModel];
+        const BillingFrequency: {
+            readonly Monthly: "monthly";
+            readonly Quarterly: "quarterly";
+            readonly SemiAnnually: "semiAnnually";
+            readonly Annual: "annual";
+            readonly Custom: "custom";
+        };
+        type BillingFrequency = (typeof BillingFrequency)[keyof typeof BillingFrequency];
+        /** When the charge is billed. Usage charges must use arrears. */
+        const BillingType: {
+            readonly Advance: "advance";
+            readonly Arrears: "arrears";
+        };
+        type BillingType = (typeof BillingType)[keyof typeof BillingType];
+    }
+    const DiscountType: {
+        readonly Percentage: "percentage";
+        readonly Fixed: "fixed";
+    };
+    type DiscountType = (typeof DiscountType)[keyof typeof DiscountType];
+}

package/dist/cjs/api/types/ProvisionOrderLineAttribute.js

@@ -0,0 +1,50 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProvisionOrderLineAttribute = void 0;
+var ProvisionOrderLineAttribute;
+(function (ProvisionOrderLineAttribute) {
+    let Pricing;
+    (function (Pricing) {
+        Pricing.ChargeType = {
+            Usage: "usage",
+            Recurring: "recurring",
+            OneTime: "oneTime",
+            SeatBased: "seatBased",
+        };
+        let PricePoints;
+        (function (PricePoints) {
+            let Tiers;
+            (function (Tiers) {
+                let Item;
+                (function (Item) {
+                    Item.TierBillingType = {
+                        Flat: "flat",
+                        PerUnit: "perUnit",
+                    };
+                })(Item = Tiers.Item || (Tiers.Item = {}));
+            })(Tiers = PricePoints.Tiers || (PricePoints.Tiers = {}));
+        })(PricePoints = Pricing.PricePoints || (Pricing.PricePoints = {}));
+        Pricing.PricingModel = {
+            PerUnit: "perUnit",
+            VolumePricing: "volumePricing",
+            GraduatedPricing: "graduatedPricing",
+        };
+        Pricing.BillingFrequency = {
+            Monthly: "monthly",
+            Quarterly: "quarterly",
+            SemiAnnually: "semiAnnually",
+            Annual: "annual",
+            Custom: "custom",
+        };
+        /** When the charge is billed. Usage charges must use arrears. */
+        Pricing.BillingType = {
+            Advance: "advance",
+            Arrears: "arrears",
+        };
+    })(Pricing = ProvisionOrderLineAttribute.Pricing || (ProvisionOrderLineAttribute.Pricing = {}));
+    ProvisionOrderLineAttribute.DiscountType = {
+        Percentage: "percentage",
+        Fixed: "fixed",
+    };
+})(ProvisionOrderLineAttribute || (exports.ProvisionOrderLineAttribute = ProvisionOrderLineAttribute = {}));

package/dist/cjs/api/types/ProvisionOrderLineType.d.ts

@@ -0,0 +1,7 @@
+export declare const ProvisionOrderLineType: {
+    readonly Standard: "STANDARD";
+    readonly ProrationCredit: "PRORATION_CREDIT";
+    readonly ProrationCharge: "PRORATION_CHARGE";
+    readonly Credit: "CREDIT";
+};
+export type ProvisionOrderLineType = (typeof ProvisionOrderLineType)[keyof typeof ProvisionOrderLineType];

package/dist/cjs/api/types/ProvisionOrderLineType.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProvisionOrderLineType = void 0;
+exports.ProvisionOrderLineType = {
+    Standard: "STANDARD",
+    ProrationCredit: "PRORATION_CREDIT",
+    ProrationCharge: "PRORATION_CHARGE",
+    Credit: "CREDIT",
+};

package/dist/cjs/api/types/ProvisionProduct.d.ts

@@ -0,0 +1,95 @@
+import type * as Paid from "../index.js";
+export interface ProvisionProduct {
+    name: string;
+    externalId: string;
+    productCode?: string;
+    description?: string;
+    /** Product attributes to create or update on the provisioned product. These are upserted by name. If pricing.pricePoints.currency is omitted, the request order currency is used. */
+    attributes?: ProvisionProduct.Attributes.Item[];
+}
+export declare namespace ProvisionProduct {
+    type Attributes = Attributes.Item[];
+    namespace Attributes {
+        interface Item {
+            name: string;
+            description?: string;
+            active?: boolean;
+            sequence?: number;
+            timeEstimateMinutes?: number;
+            pricing: Item.Pricing;
+            /** Credit benefits granted by this product attribute. These flow to every order line that selects this attribute. */
+            creditBenefits?: Paid.ProvisionCreditBenefit[];
+        }
+        namespace Item {
+            interface Pricing {
+                eventName?: string;
+                chargeType: Pricing.ChargeType;
+                pricePoints: Pricing.PricePoints;
+                pricingModel: Pricing.PricingModel;
+                billingFrequency?: Pricing.BillingFrequency;
+                billingFrequencyCustomMonths?: number;
+                /** When the charge is billed. Usage charges must use arrears. */
+                billingType?: Pricing.BillingType;
+            }
+            namespace Pricing {
+                const ChargeType: {
+                    readonly Usage: "usage";
+                    readonly Recurring: "recurring";
+                    readonly OneTime: "oneTime";
+                    readonly SeatBased: "seatBased";
+                };
+                type ChargeType = (typeof ChargeType)[keyof typeof ChargeType];
+                interface PricePoints {
+                    currency?: string;
+                    /** Price per unit, as a whole number in minor currency units (cents): 4900 is $49.00. Must be 0 or more. For a discount or credit, send a positive price on a line with `lineType: CREDIT`. */
+                    unitPrice: number;
+                    /** Optional pricing tiers for volume/graduated pricing models. When provided, overrides the default flat unitPrice structure. */
+                    tiers?: PricePoints.Tiers.Item[];
+                }
+                namespace PricePoints {
+                    type Tiers = Tiers.Item[];
+                    namespace Tiers {
+                        interface Item {
+                            /** Flat fee for this tier, in minor currency units (cents). Must be 0 or more. */
+                            flatAmount?: number;
+                            index?: number;
+                            lowerBound: number;
+                            number?: number;
+                            tierBillingType?: Item.TierBillingType;
+                            /** Price per unit in this tier, in minor currency units (cents). Must be 0 or more. */
+                            unitAmount?: number;
+                            upperBound?: number;
+                        }
+                        namespace Item {
+                            const TierBillingType: {
+                                readonly Flat: "flat";
+                                readonly PerUnit: "perUnit";
+                            };
+                            type TierBillingType = (typeof TierBillingType)[keyof typeof TierBillingType];
+                        }
+                    }
+                }
+                const PricingModel: {
+                    readonly PerUnit: "perUnit";
+                    readonly VolumePricing: "volumePricing";
+                    readonly GraduatedPricing: "graduatedPricing";
+                };
+                type PricingModel = (typeof PricingModel)[keyof typeof PricingModel];
+                const BillingFrequency: {
+                    readonly Monthly: "monthly";
+                    readonly Quarterly: "quarterly";
+                    readonly SemiAnnually: "semiAnnually";
+                    readonly Annual: "annual";
+                    readonly Custom: "custom";
+                };
+                type BillingFrequency = (typeof BillingFrequency)[keyof typeof BillingFrequency];
+                /** When the charge is billed. Usage charges must use arrears. */
+                const BillingType: {
+                    readonly Advance: "advance";
+                    readonly Arrears: "arrears";
+                };
+                type BillingType = (typeof BillingType)[keyof typeof BillingType];
+            }
+        }
+    }
+}

package/dist/cjs/api/types/ProvisionProduct.js

@@ -0,0 +1,52 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProvisionProduct = void 0;
+var ProvisionProduct;
+(function (ProvisionProduct) {
+    let Attributes;
+    (function (Attributes) {
+        let Item;
+        (function (Item_1) {
+            let Pricing;
+            (function (Pricing) {
+                Pricing.ChargeType = {
+                    Usage: "usage",
+                    Recurring: "recurring",
+                    OneTime: "oneTime",
+                    SeatBased: "seatBased",
+                };
+                let PricePoints;
+                (function (PricePoints) {
+                    let Tiers;
+                    (function (Tiers) {
+                        let Item;
+                        (function (Item) {
+                            Item.TierBillingType = {
+                                Flat: "flat",
+                                PerUnit: "perUnit",
+                            };
+                        })(Item = Tiers.Item || (Tiers.Item = {}));
+                    })(Tiers = PricePoints.Tiers || (PricePoints.Tiers = {}));
+                })(PricePoints = Pricing.PricePoints || (Pricing.PricePoints = {}));
+                Pricing.PricingModel = {
+                    PerUnit: "perUnit",
+                    VolumePricing: "volumePricing",
+                    GraduatedPricing: "graduatedPricing",
+                };
+                Pricing.BillingFrequency = {
+                    Monthly: "monthly",
+                    Quarterly: "quarterly",
+                    SemiAnnually: "semiAnnually",
+                    Annual: "annual",
+                    Custom: "custom",
+                };
+                /** When the charge is billed. Usage charges must use arrears. */
+                Pricing.BillingType = {
+                    Advance: "advance",
+                    Arrears: "arrears",
+                };
+            })(Pricing = Item_1.Pricing || (Item_1.Pricing = {}));
+        })(Item = Attributes.Item || (Attributes.Item = {}));
+    })(Attributes = ProvisionProduct.Attributes || (ProvisionProduct.Attributes = {}));
+})(ProvisionProduct || (exports.ProvisionProduct = ProvisionProduct = {}));

package/dist/cjs/api/types/ProvisionResponse.d.ts

@@ -0,0 +1,17 @@
+import type * as Paid from "../index.js";
+export interface ProvisionResponse {
+    /** Mirrors order.provisionStatus. created (HTTP 201): the order was created; updated (HTTP 200): an existing draft order with the same externalId was updated */
+    status: ProvisionResponse.Status;
+    createdAt: string;
+    customer: Paid.ProvisionCreatedCustomer;
+    contact?: Paid.ProvisionCreatedContact;
+    order: Paid.ProvisionCreatedOrder;
+}
+export declare namespace ProvisionResponse {
+    /** Mirrors order.provisionStatus. created (HTTP 201): the order was created; updated (HTTP 200): an existing draft order with the same externalId was updated */
+    const Status: {
+        readonly Created: "created";
+        readonly Updated: "updated";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/cjs/api/types/ProvisionResponse.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProvisionResponse = void 0;
+var ProvisionResponse;
+(function (ProvisionResponse) {
+    /** Mirrors order.provisionStatus. created (HTTP 201): the order was created; updated (HTTP 200): an existing draft order with the same externalId was updated */
+    ProvisionResponse.Status = {
+        Created: "created",
+        Updated: "updated",
+    };
+})(ProvisionResponse || (exports.ProvisionResponse = ProvisionResponse = {}));

package/dist/cjs/api/types/SeatBasedPrepaidCreditsInput.d.ts

@@ -4,6 +4,9 @@ export interface SeatBasedPrepaidCreditsInput {
     /** Credit amount, exact to at most 6 decimal places. */
     creditCost: number;
     unitValue?: number;
+    overageUnitPrice?: number;
+    /** Overage price per credit in the currency's minor units (40 is $0.40 for USD, ¥40 for JPY, 0.040 KWD for KWD), keyed by uppercase ISO 4217 currency code. On an invoice, an entry for the invoice currency on any of the order's pricing or credit benefits beats every overageUnitPrice; overageUnitPrice applies only when no holder has an entry for that currency. Writes keep the two consistent for the primary currency (the organization's default when the product is priced in it, else the product's only pricing currency; an order line's own currency): a map entry for it sets overageUnitPrice, winning when a write sends both, and an overageUnitPrice sent without the map updates an existing entry for it. A write that sends only overageUnitPrice never creates a map. */
+    overageUnitPrices?: Record<string, number | null> | null;
     billingFrequency: SeatBasedPrepaidCreditsInput.BillingFrequency;
     billingFrequencyCustomMonths?: number;
     billingType?: SeatBasedPrepaidCreditsInput.BillingType;

package/dist/cjs/api/types/Signal.d.ts

@@ -1,11 +1,17 @@
 import type * as Paid from "../index.js";
+/**
+ * One usage event. Name its customer with `customer`, its customer unit with `customerUnit`, or both: at least one is required, and a batch with a signal that names neither is refused with `400 VALIDATION_ERROR`.
+ */
 export interface Signal {
+    /** The name of the usage event, such as `email_sent`. Meters and usage prices select signals by this name. */
     eventName: string;
-    customer: Paid.CustomerAttribution;
+    customer?: Paid.CustomerAttribution;
     customerUnit?: Paid.CustomerUnitAttribution;
     attribution?: Paid.Attribution;
-    /** True event timestamp in RFC3339 format with timezone (e.g. 2026-01-31T23:00:00Z) */
+    /** True event timestamp in RFC3339 format with timezone (e.g. 2026-01-31T23:00:00Z). Omit it to use the time Paid receives the signal. */
     timestamp?: string;
+    /** Your event data. The top-level keys `_derived`, `_dims` and `_billing`, and any top-level key starting with `_billing.`, are reserved for Paid: a batch in which any signal's `data` carries one is refused with `400 RESERVED_SIGNAL_DATA_FIELD`. */
     data?: Record<string, unknown>;
+    /** Your unique key for this event. A signal whose key was already sent, earlier or in the same batch, is skipped and counted in `duplicates` instead of `ingested`. */
     idempotencyKey?: string;
 }

package/dist/cjs/api/types/SignalListItem.d.ts

@@ -13,7 +13,7 @@ export interface SignalListItem {
     externalProductId: string | null;
     /** Distributed trace ID, or null if none was recorded. */
     traceId: string | null;
-    /** The data payload submitted with the signal. */
+    /** The data payload submitted with the signal. A signal whose active customer unit was not billable in effect when it arrived (`effectiveBillable: false` on the unit) also carries `_billing`: `{ "excluded": true, "externalCustomerUnitId": "<the unit's key>" }`, unless it was sent with a customer API key. A meter's derived signal (one carrying `_derived`) follows the source event it takes its unit from (the window's closing event, else its opening event): it carries `_billing` when that event did and it still resolves to that same active unit. Billing records that usage without billing it. A price whose usage comes from a meter (read from your events when the invoice closes) leaves those signals out as well; a correlation-window meter leaves out a whole window when the event it takes its unit from (the closing event, else the opening one) carries `_billing`. */
     data: Record<string, unknown> | null;
     /** When the signal was ingested (ISO 8601, UTC). */
     createdAt: string;

package/dist/cjs/api/types/SignalLookupResponse.d.ts

@@ -0,0 +1,7 @@
+import type * as Paid from "../index.js";
+export interface SignalLookupResponse {
+    /** The signals found, in the order their IDs were requested. Each item has the same shape as `GET /api/v2/signals/{id}`, including the data payload. */
+    data: Paid.SignalListItem[];
+    /** Requested IDs that match no signal in your organization, in request order. Malformed IDs are reported here rather than rejected. */
+    notFound: string[];
+}

package/dist/cjs/api/types/SignalLookupResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/SignalSummaryBandsDimension.d.ts

@@ -0,0 +1,21 @@
+export interface SignalSummaryBandsDimension {
+    /** Key into the signal's data payload. Dots address nested fields, for example dimensions.pages. */
+    path: string;
+    appliesTo: string[];
+    brackets: SignalSummaryBandsDimension.Brackets.Item[];
+    /** Column collecting values that are missing, non-numeric, or below the floor. Always present, even when empty. */
+    overflowSlug?: string;
+}
+export declare namespace SignalSummaryBandsDimension {
+    type Brackets = Brackets.Item[];
+    namespace Brackets {
+        interface Item {
+            /** Inclusive lower bound. Only meaningful on the first bracket, where it sets the floor of the banded range. Defaults to 1. */
+            from?: number;
+            /** Inclusive upper bound for this band. Null on the final bracket for an open-ended top band. */
+            upTo: number | null;
+            slug?: string;
+            group?: string;
+        }
+    }
+}

package/dist/cjs/api/types/SignalSummaryBandsDimension.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/SignalSummaryColumn.d.ts

@@ -0,0 +1,8 @@
+export interface SignalSummaryColumn {
+    /** Unique column name, as it appears in the file's third header row. */
+    name: string;
+    /** First header row label for this column. */
+    signalGroup: string;
+    /** Second header row label, or null when no dimension applies to this column. */
+    dimensionGroup: string | null;
+}

package/dist/cjs/api/types/SignalSummaryColumn.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/SignalSummaryDefinitionSpec.d.ts

@@ -0,0 +1,21 @@
+import type * as Paid from "../index.js";
+/**
+ * The shape this export ran, stored here so the file stays explainable. Pass this export's id as copyFrom to reproduce its columns.
+ */
+export interface SignalSummaryDefinitionSpec {
+    name: string;
+    /** Bucket size for each row. Only monthly buckets are supported today. */
+    interval?: SignalSummaryDefinitionSpec.Interval;
+    signalNames: Paid.SignalSummarySignalSelection[];
+    dimensions?: Paid.SignalSummaryDefinitionSpecDimensionsItem[];
+    measures: Paid.SignalSummaryMeasure[];
+    /** How a column's name is composed. {signal} is the signal's slug; {dim1} and {dim2} are the slugs of the first and second dimensions that apply to it. Placeholders with no value are dropped, so a signal with no dimensions renders as its slug alone. Use this to control ordering — {dim1}_{signal}_{dim2} yields names like ticket_runs_1_step. */
+    columnNameTemplate?: string;
+}
+export declare namespace SignalSummaryDefinitionSpec {
+    /** Bucket size for each row. Only monthly buckets are supported today. */
+    const Interval: {
+        readonly Month: "month";
+    };
+    type Interval = (typeof Interval)[keyof typeof Interval];
+}

package/dist/cjs/api/types/SignalSummaryDefinitionSpec.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignalSummaryDefinitionSpec = void 0;
+var SignalSummaryDefinitionSpec;
+(function (SignalSummaryDefinitionSpec) {
+    /** Bucket size for each row. Only monthly buckets are supported today. */
+    SignalSummaryDefinitionSpec.Interval = {
+        Month: "month",
+    };
+})(SignalSummaryDefinitionSpec || (exports.SignalSummaryDefinitionSpec = SignalSummaryDefinitionSpec = {}));

package/dist/cjs/api/types/SignalSummaryDefinitionSpecDimensionsItem.d.ts

@@ -0,0 +1,10 @@
+import type * as Paid from "../index.js";
+export type SignalSummaryDefinitionSpecDimensionsItem = Paid.SignalSummaryDefinitionSpecDimensionsItem.Presence | Paid.SignalSummaryDefinitionSpecDimensionsItem.Bands;
+export declare namespace SignalSummaryDefinitionSpecDimensionsItem {
+    interface Presence extends Paid.SignalSummaryPresenceDimension {
+        kind: "presence";
+    }
+    interface Bands extends Paid.SignalSummaryBandsDimension {
+        kind: "bands";
+    }
+}

package/dist/cjs/api/types/SignalSummaryDefinitionSpecDimensionsItem.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/SignalSummaryExport.d.ts

@@ -0,0 +1,36 @@
+import type * as Paid from "../index.js";
+export interface SignalSummaryExport {
+    id: string;
+    status: SignalSummaryExport.Status;
+    spec: Paid.SignalSummaryDefinitionSpec;
+    /** Columns in the file, in order. */
+    columns: Paid.SignalSummaryColumn[];
+    /** Format this export's file was written in. */
+    format: SignalSummaryExport.Format;
+    from: string;
+    to: string;
+    rowCount: number | null;
+    /** Short-lived download link, present only while the export is succeeded and unexpired. A new link is issued each time this export is fetched. */
+    downloadUrl: string | null;
+    /** When the stored file stops being downloadable. */
+    expiresAt: string | null;
+    /** Why the export failed, or null. */
+    error: string | null;
+    createdAt: string;
+    completedAt: string | null;
+}
+export declare namespace SignalSummaryExport {
+    const Status: {
+        readonly Pending: "pending";
+        readonly Running: "running";
+        readonly Succeeded: "succeeded";
+        readonly Failed: "failed";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /** Format this export's file was written in. */
+    const Format: {
+        readonly Json: "json";
+        readonly Csv: "csv";
+    };
+    type Format = (typeof Format)[keyof typeof Format];
+}

package/dist/cjs/api/types/SignalSummaryExport.js

@@ -0,0 +1,18 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignalSummaryExport = void 0;
+var SignalSummaryExport;
+(function (SignalSummaryExport) {
+    SignalSummaryExport.Status = {
+        Pending: "pending",
+        Running: "running",
+        Succeeded: "succeeded",
+        Failed: "failed",
+    };
+    /** Format this export's file was written in. */
+    SignalSummaryExport.Format = {
+        Json: "json",
+        Csv: "csv",
+    };
+})(SignalSummaryExport || (exports.SignalSummaryExport = SignalSummaryExport = {}));

package/dist/cjs/api/types/SignalSummaryGroups.d.ts

@@ -0,0 +1,9 @@
+/**
+ * How many groups kept their own series, and how many were summed under "other". Present only when groupBy is set.
+ */
+export interface SignalSummaryGroups {
+    /** Groups that kept their own series. At most 100. */
+    kept: number;
+    /** Groups summed under the key "other" instead of keeping their own series. Zero means every group kept its own figure, so the breakdown is complete. Above zero, this many groups have no figure of their own in the response. */
+    truncated: number;
+}

package/dist/cjs/api/types/SignalSummaryGroups.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/SignalSummaryMeasure.d.ts

@@ -0,0 +1,16 @@
+export interface SignalSummaryMeasure {
+    fn: SignalSummaryMeasure.Fn;
+    /** Key into the signal's data payload. Dots address nested fields, for example dimensions.pages. */
+    path?: string;
+    slug?: string;
+}
+export declare namespace SignalSummaryMeasure {
+    const Fn: {
+        readonly Count: "count";
+        readonly Sum: "sum";
+        readonly Min: "min";
+        readonly Max: "max";
+        readonly Avg: "avg";
+    };
+    type Fn = (typeof Fn)[keyof typeof Fn];
+}

package/dist/cjs/api/types/SignalSummaryMeasure.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignalSummaryMeasure = void 0;
+var SignalSummaryMeasure;
+(function (SignalSummaryMeasure) {
+    SignalSummaryMeasure.Fn = {
+        Count: "count",
+        Sum: "sum",
+        Min: "min",
+        Max: "max",
+        Avg: "avg",
+    };
+})(SignalSummaryMeasure || (exports.SignalSummaryMeasure = SignalSummaryMeasure = {}));

package/dist/cjs/api/types/SignalSummaryPage.d.ts

@@ -0,0 +1,8 @@
+export interface SignalSummaryPage {
+    /** The page size that applied. */
+    limit: number;
+    /** Whether more points follow this page. */
+    hasMore: boolean;
+    /** Pass as cursor to fetch the next page. Null on the last page. */
+    nextCursor: string | null;
+}

package/dist/cjs/api/types/SignalSummaryPage.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/SignalSummaryPoint.d.ts

@@ -0,0 +1,16 @@
+export interface SignalSummaryPoint {
+    /** Start of the period (inclusive), UTC. Clipped to the requested startDate when the window starts mid-period. */
+    periodStart: string;
+    /** Last instant of the period (inclusive), UTC. Clipped to the requested endDate when the window ends mid-period. */
+    periodEnd: string;
+    /**
+     * The group this point belongs to. Present only when groupBy is set. For signalName grouping, the signal's name. For dimension grouping, the payload value of dimensionKey, or an empty string when the signal carries no value.
+     *
+     * The key "other" sums the groups that did not keep their own series. A payload value that is itself literally "other" joins that same bucket.
+     */
+    groupKey?: string;
+    /** Signals recorded in this period, counted one per signal. */
+    signalCount: number;
+    /** Quantity reported by those signals — one signal reporting a batch of 100 adds 100. Equals signalCount when every signal reported a single occurrence. */
+    quantityTotal: number;
+}

package/dist/cjs/api/types/SignalSummaryPoint.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });