@paid-ai/paid-node 1.7.0 → 1.8.0

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

@@ -27,6 +27,7 @@ export var CreateOrderLineAttributeRequest;
             VolumePricing: "volumePricing",
             GraduatedPricing: "graduatedPricing",
             PrepaidCredits: "prepaidCredits",
+            BracketedPrepaidCredits: "bracketedPrepaidCredits",
             Flat: "flat",
         };
         Pricing.BillingFrequency = {
@@ -62,9 +63,16 @@ export var CreateOrderLineAttributeRequest;
                 };
                 Item.CreditGrantTiming = {
                     OnPayment: "on_payment",
+                    OnInvoicePosted: "on_invoice_posted",
                     OnOrderActivation: "on_order_activation",
                 };
             })(Item = CreditBenefits.Item || (CreditBenefits.Item = {}));
         })(CreditBenefits = Pricing.CreditBenefits || (Pricing.CreditBenefits = {}));
+        let PricingInput;
+        (function (PricingInput) {
+            PricingInput.Kind = {
+                SignalQuantity: "signalQuantity",
+            };
+        })(PricingInput = Pricing.PricingInput || (Pricing.PricingInput = {}));
     })(Pricing = CreateOrderLineAttributeRequest.Pricing || (CreateOrderLineAttributeRequest.Pricing = {}));
 })(CreateOrderLineAttributeRequest || (CreateOrderLineAttributeRequest = {}));

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

@@ -1,4 +1,7 @@
 import type * as Paid from "../index.mjs";
+/**
+ * When override `attributes` are omitted, the order will match the base product (or default plan if plans are configured).
+ */
 export interface CreateOrderLineRequest {
     productId: string;
     name?: string;
@@ -6,4 +9,5 @@ export interface CreateOrderLineRequest {
     startDate?: string;
     endDate?: string;
     attributes?: Paid.CreateOrderLineAttributeRequest[];
+    lineType?: Paid.WritableOrderLineType;
 }

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

@@ -3,9 +3,11 @@ export interface CreditBalance {
     creditsCurrencyId: string;
     currencyName: string;
     currencyKey: string;
-    /** Effective spendable balance across all grants in this pool, rollover-capped during rollover windows. Equals sum(grants[].available). */
+    /** Effective spendable balance across all grants in this pool, rollover-capped during rollover windows. Equals sum(grants[].available). JSON number; exact within ±2^53 — balances are sums and can legitimately exceed it. */
     available: number;
+    /** JSON number; exact within ±2^53 — balances are sums and can legitimately exceed it. */
     used: number;
+    /** JSON number; exact within ±2^53 — balances are sums and can legitimately exceed it. */
     total: number;
     /** Aggregate min(periodStart) across grants in this pool. Does not correspond to any real billing period when grants overlap. Use grants[].periodStart instead. Will be removed in a future API version. */
     periodStart: string | null;

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

@@ -1,14 +1,16 @@
 export interface CreditBenefitInput {
     creditsCurrencyId: string;
+    /** Credit amount, exact to at most 6 decimal places. */
     amount: number;
     recipient?: CreditBenefitInput.Recipient;
     isInfiniteTotal?: boolean;
     allocationCadence?: CreditBenefitInput.AllocationCadence;
-    creditGrantTiming?: CreditBenefitInput.CreditGrantTiming;
-    overageUnitPrice?: number;
-    rolloverAmount?: number;
-    rolloverDuration?: number;
-    rolloverDurationUnit?: string;
+    creditGrantTiming?: CreditBenefitInput.CreditGrantTiming | null;
+    overageUnitPrice?: number | null;
+    /** Credit amount, exact to at most 6 decimal places. */
+    rolloverAmount?: number | null;
+    rolloverDuration?: number | null;
+    rolloverDurationUnit?: string | null;
 }
 export declare namespace CreditBenefitInput {
     const Recipient: {

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

@@ -1,13 +1,13 @@
 export interface CreditBenefitOutput {
     id: string;
-    creditsCurrencyId: string;
+    creditsCurrencyId: string | null;
     amount: number;
     recipient: string;
     isInfiniteTotal: boolean;
     allocationCadence: string;
-    creditGrantTiming?: string;
-    overageUnitPrice?: number;
-    rolloverAmount?: number;
-    rolloverDuration?: number;
-    rolloverDurationUnit?: string;
+    creditGrantTiming?: string | null;
+    overageUnitPrice?: number | null;
+    rolloverAmount?: number | null;
+    rolloverDuration?: number | null;
+    rolloverDurationUnit?: string | null;
 }

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

@@ -1,9 +1,26 @@
 export interface CreditCurrency {
+    /** Unique identifier for this credit currency. */
     id: string;
+    /** Human-readable name shown for this credit currency. */
     name: string;
+    /** Stable machine-readable key for this credit currency. Keys are unique within an organization. */
     key: string;
+    /** Whether this credit currency is active or archived. */
+    status: CreditCurrency.Status;
+    /** Optional description for this credit currency. */
     description: string | null;
+    /** When this credit currency was archived. Null means the currency is active. */
     archivedAt: string | null;
+    /** When this credit currency was created. */
     createdAt: string;
+    /** When this credit currency was last updated. */
     updatedAt: string;
 }
+export declare namespace CreditCurrency {
+    /** Whether this credit currency is active or archived. */
+    const Status: {
+        readonly Active: "active";
+        readonly Archived: "archived";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

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

@@ -1,2 +1,9 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var CreditCurrency;
+(function (CreditCurrency) {
+    /** Whether this credit currency is active or archived. */
+    CreditCurrency.Status = {
+        Active: "active",
+        Archived: "archived",
+    };
+})(CreditCurrency || (CreditCurrency = {}));

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

@@ -1,6 +1,9 @@
 export interface CreditGrant {
+    /** JSON number; exact within ±2^53 — balances are sums and can legitimately exceed it. */
     available: number;
+    /** JSON number; exact within ±2^53 — balances are sums and can legitimately exceed it. */
     used: number;
+    /** JSON number; exact within ±2^53 — balances are sums and can legitimately exceed it. */
     total: number;
     rolloverAmount: number | null;
     periodStart: string;

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

@@ -0,0 +1,24 @@
+import type * as Paid from "../index.mjs";
+export interface CreditGrantAddAxisOptions {
+    relevance: Paid.AmendmentAxisRelevance;
+    /** Pricing this axis applies to. Match every non-empty list. Empty lists constrain nothing. Evaluate against the attribute you are adding. */
+    appliesTo: Paid.AmendmentPricingClause[];
+    options: CreditGrantAddAxisOptions.Options.Item[];
+    /** Accepts any additional properties */
+    [key: string]: any;
+}
+export declare namespace CreditGrantAddAxisOptions {
+    type Options = Options.Item[];
+    namespace Options {
+        interface Item {
+            value: Paid.CreditGrantValue;
+            /** True when this is the value used if you omit the choice. */
+            isDefault: boolean;
+            unsupportedReason?: string;
+            /** Extra pricing constraint on this option. Empty means choosable wherever the axis applies. */
+            requires?: Paid.AmendmentPricingClause[];
+            /** Accepts any additional properties */
+            [key: string]: any;
+        }
+    }
+}

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

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

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

@@ -0,0 +1,23 @@
+import type * as Paid from "../index.mjs";
+export interface CreditGrantAxisOptions {
+    relevance: Paid.AmendmentAxisRelevance;
+    options: CreditGrantAxisOptions.Options.Item[];
+    /** Accepts any additional properties */
+    [key: string]: any;
+}
+export declare namespace CreditGrantAxisOptions {
+    type Options = Options.Item[];
+    namespace Options {
+        interface Item {
+            value: Paid.CreditGrantValue;
+            /** True when this is the value used if you omit the choice. */
+            isDefault: boolean;
+            /** False when this option cannot be chosen for this intent. */
+            available: boolean;
+            /** Why the option is unavailable, when `available` is false. */
+            unavailableReason?: string;
+            /** Accepts any additional properties */
+            [key: string]: any;
+        }
+    }
+}

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

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

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

@@ -0,0 +1,10 @@
+export interface CreditGrantCreateRequest {
+    /** Stable machine-readable key for the active credit currency to grant. */
+    creditCurrencyKey: string;
+    /** Number of credits to grant, exact to at most 6 decimal places. This is not a monetary amount. */
+    amount: number;
+    /** When these credits become spendable, as an RFC3339 datetime with timezone. Must be at or before the current server time. Defaults to the current server time when omitted. */
+    startsAt?: string;
+    /** When these credits expire, as an RFC3339 datetime with timezone. Omit or set null for credits that do not expire. */
+    expiresAt?: string | null;
+}

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

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

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

@@ -0,0 +1,6 @@
+export interface CreditGrantCurrency {
+    /** Stable machine-readable key for this credit currency. */
+    key: string;
+    /** Human-readable name for this credit currency. */
+    name: string;
+}

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

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

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

@@ -0,0 +1,6 @@
+export interface CreditGrantCustomer {
+    /** Stable Paid customer display ID. */
+    id: string;
+    /** Customer ID from the caller's system, if set. */
+    externalId: string | null;
+}

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

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

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

@@ -0,0 +1,19 @@
+export interface CreditGrantResult {
+    /** Whole-credit projection of the amount granted, truncated toward zero. May be 0 for a sub-unit grant. Exact for values within ±2^53; see amountDecimal for the exact value at any magnitude. */
+    amount: number;
+    /** Exact number of credits granted, as a decimal string. Exact at any magnitude, and at the full 6 decimal places. */
+    amountDecimal: string;
+    /** When these credits become spendable, as an RFC3339 datetime with timezone. */
+    startsAt: string;
+    /** When these credits expire, as an RFC3339 datetime with timezone. Null when the credits do not expire. */
+    expiresAt: string | null;
+    /** Credit grants are active immediately when created. */
+    status: CreditGrantResult.Status;
+}
+export declare namespace CreditGrantResult {
+    /** Credit grants are active immediately when created. */
+    const Status: {
+        readonly Active: "active";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

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

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CreditGrantResult;
+(function (CreditGrantResult) {
+    /** Credit grants are active immediately when created. */
+    CreditGrantResult.Status = {
+        Active: "active",
+    };
+})(CreditGrantResult || (CreditGrantResult = {}));

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

@@ -0,0 +1,7 @@
+/** How much of the credit benefit is granted for the current period. none and prorated are reserved. */
+export declare const CreditGrantValue: {
+    readonly Full: "full";
+    readonly None: "none";
+    readonly Prorated: "prorated";
+};
+export type CreditGrantValue = (typeof CreditGrantValue)[keyof typeof CreditGrantValue];

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

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+/** How much of the credit benefit is granted for the current period. none and prorated are reserved. */
+export const CreditGrantValue = {
+    Full: "full",
+    None: "none",
+    Prorated: "prorated",
+};

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

@@ -0,0 +1,31 @@
+import type * as Paid from "../index.mjs";
+export interface CreditTransaction {
+    /** Unique identifier for this credit transaction. */
+    id: string;
+    customer: Paid.CreditTransactionCustomer;
+    creditCurrency: Paid.CreditTransactionCurrency;
+    /** Transaction type: `grant` adds credits, `spend` consumes them (negative amount), `pendingGrant` records credits awaiting payment. */
+    type: CreditTransaction.Type;
+    /** Exact signed transaction amount in credits, as a decimal string: positive for grants, negative for spends. Exact at any magnitude, and at the full 6 decimal places. */
+    amount: string;
+    /** Origin of the credit pool this transaction touched (e.g. `purchased`, or a custom label). `unknown` when the transaction is not linked to a pool with an origin. */
+    originCode: string;
+    /** Usage event that produced this spend. Null for grants and non-signal spends. */
+    eventName: string | null;
+    /** ID of the usage signal that produced this spend, resolvable via `GET /api/v2/signals/{id}` (including the signal's data payload). Null for grants and non-signal spends. */
+    signalId: string | null;
+    /** Paid order display ID this transaction is linked to, if any. */
+    orderId: string | null;
+    product: Paid.CreditTransactionProduct | null;
+    /** When the originating signal was recorded, or when the transaction was recorded if it has no signal. */
+    createdAt: string;
+}
+export declare namespace CreditTransaction {
+    /** Transaction type: `grant` adds credits, `spend` consumes them (negative amount), `pendingGrant` records credits awaiting payment. */
+    const Type: {
+        readonly Grant: "grant";
+        readonly Spend: "spend";
+        readonly PendingGrant: "pendingGrant";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

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

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CreditTransaction;
+(function (CreditTransaction) {
+    /** Transaction type: `grant` adds credits, `spend` consumes them (negative amount), `pendingGrant` records credits awaiting payment. */
+    CreditTransaction.Type = {
+        Grant: "grant",
+        Spend: "spend",
+        PendingGrant: "pendingGrant",
+    };
+})(CreditTransaction || (CreditTransaction = {}));

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

@@ -0,0 +1,6 @@
+export interface CreditTransactionCurrency {
+    /** Stable machine-readable key for this credit currency. */
+    key: string;
+    /** Human-readable name for this credit currency. */
+    name: string;
+}

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

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

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

@@ -0,0 +1,6 @@
+export interface CreditTransactionCustomer {
+    /** Stable Paid customer display ID. */
+    id: string;
+    /** Customer ID from the caller's system, if set. */
+    externalId: string | null;
+}

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

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

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

@@ -0,0 +1,6 @@
+import type * as Paid from "../index.mjs";
+export interface CreditTransactionListResponse {
+    /** Credit transactions, newest first. */
+    data: Paid.CreditTransaction[];
+    pagination: Paid.Pagination;
+}

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

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

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

@@ -0,0 +1,11 @@
+/**
+ * Product this transaction is scoped to. Null for org-wide transactions.
+ */
+export interface CreditTransactionProduct {
+    /** Stable Paid product display ID. */
+    id: string;
+    /** Product ID from the caller's system, if set. */
+    externalId: string | null;
+    /** Product name. */
+    name: string;
+}

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * ISO 4217 currency code, for example USD, EUR, or GBP.
+ */
+export type CurrencyCode = string;

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

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

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

@@ -0,0 +1,25 @@
+export interface CustomView {
+    /** Stable public identifier used in preview/embed URLs. */
+    displayId: string;
+    name: string;
+    /** A view is DRAFT until explicitly published. For customer-scoped views, only PUBLISHED views are embeddable and served to end-customers; a DRAFT is not. For organization-scoped views, publishing is only a 'ready to use' marker — both DRAFT and PUBLISHED are visible to your organization's members in Paid (publishing does not change who in the org can see it), and neither is ever embeddable to an end-customer. */
+    status: CustomView.Status;
+    /** Absolute URL to open this view in the Paid app for preview. Surface it to the user after creating or publishing a view. Null when the app URL is not configured. */
+    previewUrl: string | null;
+    /** 'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only. */
+    scope: CustomView.Scope;
+}
+export declare namespace CustomView {
+    /** A view is DRAFT until explicitly published. For customer-scoped views, only PUBLISHED views are embeddable and served to end-customers; a DRAFT is not. For organization-scoped views, publishing is only a 'ready to use' marker — both DRAFT and PUBLISHED are visible to your organization's members in Paid (publishing does not change who in the org can see it), and neither is ever embeddable to an end-customer. */
+    const Status: {
+        readonly Draft: "DRAFT";
+        readonly Published: "PUBLISHED";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /** 'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only. */
+    const Scope: {
+        readonly Customer: "customer";
+        readonly Organization: "organization";
+    };
+    type Scope = (typeof Scope)[keyof typeof Scope];
+}

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

@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomView;
+(function (CustomView) {
+    /** A view is DRAFT until explicitly published. For customer-scoped views, only PUBLISHED views are embeddable and served to end-customers; a DRAFT is not. For organization-scoped views, publishing is only a 'ready to use' marker — both DRAFT and PUBLISHED are visible to your organization's members in Paid (publishing does not change who in the org can see it), and neither is ever embeddable to an end-customer. */
+    CustomView.Status = {
+        Draft: "DRAFT",
+        Published: "PUBLISHED",
+    };
+    /** 'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only. */
+    CustomView.Scope = {
+        Customer: "customer",
+        Organization: "organization",
+    };
+})(CustomView || (CustomView = {}));

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

@@ -0,0 +1,69 @@
+import type * as Paid from "../index.mjs";
+export interface CustomViewAuthoringDetail {
+    displayId: string;
+    name: string;
+    description: string | null;
+    status: CustomViewAuthoringDetail.Status;
+    /** Ids of the result sets the render bundle will receive. */
+    queryIds: string[];
+    /** Self-contained HTML document rendered inside the isolated sandbox iframe. */
+    renderBundle: string;
+    /** The view's current default date range, or null if it uses no adjustable period. */
+    period: CustomViewAuthoringDetail.Period | null;
+    /** The filter parameters this view accepts per request (pass values as `filter_<name>` query params on the data endpoint), or null if it declares none. Embedding hosts can render controls from the declared values. */
+    filters: Paid.CustomViewFilter[] | null;
+    /** 'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only. */
+    scope: CustomViewAuthoringDetail.Scope;
+    queries: Paid.CustomViewQuery[];
+    createdBy: string;
+    createdAt: string;
+    updatedAt: string;
+    schemaVersion: number;
+    /** The authoring guide (only when includeGuide=true) — same content as getCustomViewAuthoringGuide, returned inline to save a round trip. */
+    guide?: string;
+    /** The render-bundle template (only when includeGuide=true). */
+    sampleBundle?: string;
+}
+export declare namespace CustomViewAuthoringDetail {
+    const Status: {
+        readonly Draft: "DRAFT";
+        readonly Published: "PUBLISHED";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /**
+     * The view's current default date range, or null if it uses no adjustable period.
+     */
+    interface Period {
+        /** 'relative' = a rolling window ending today (set `unit` + `amount`); 'absolute' = a fixed calendar range (set `start` + `end`). */
+        kind: Period.Kind;
+        /** relative only: the unit of the rolling window. */
+        unit?: Period.Unit;
+        /** relative only: how many units back from today (e.g. unit 'day', amount 30 = last 30 days). */
+        amount?: number;
+        /** absolute only: inclusive start date (YYYY-MM-DD). */
+        start?: string;
+        /** absolute only: inclusive end date (YYYY-MM-DD). */
+        end?: string;
+    }
+    namespace Period {
+        /** 'relative' = a rolling window ending today (set `unit` + `amount`); 'absolute' = a fixed calendar range (set `start` + `end`). */
+        const Kind: {
+            readonly Relative: "relative";
+            readonly Absolute: "absolute";
+        };
+        type Kind = (typeof Kind)[keyof typeof Kind];
+        /** relative only: the unit of the rolling window. */
+        const Unit: {
+            readonly Day: "day";
+            readonly Month: "month";
+            readonly Year: "year";
+        };
+        type Unit = (typeof Unit)[keyof typeof Unit];
+    }
+    /** 'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only. */
+    const Scope: {
+        readonly Customer: "customer";
+        readonly Organization: "organization";
+    };
+    type Scope = (typeof Scope)[keyof typeof Scope];
+}

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

@@ -0,0 +1,27 @@
+// This file was auto-generated by Fern from our API Definition.
+export var CustomViewAuthoringDetail;
+(function (CustomViewAuthoringDetail) {
+    CustomViewAuthoringDetail.Status = {
+        Draft: "DRAFT",
+        Published: "PUBLISHED",
+    };
+    let Period;
+    (function (Period) {
+        /** 'relative' = a rolling window ending today (set `unit` + `amount`); 'absolute' = a fixed calendar range (set `start` + `end`). */
+        Period.Kind = {
+            Relative: "relative",
+            Absolute: "absolute",
+        };
+        /** relative only: the unit of the rolling window. */
+        Period.Unit = {
+            Day: "day",
+            Month: "month",
+            Year: "year",
+        };
+    })(Period = CustomViewAuthoringDetail.Period || (CustomViewAuthoringDetail.Period = {}));
+    /** 'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only. */
+    CustomViewAuthoringDetail.Scope = {
+        Customer: "customer",
+        Organization: "organization",
+    };
+})(CustomViewAuthoringDetail || (CustomViewAuthoringDetail = {}));

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

@@ -0,0 +1,6 @@
+export interface CustomViewAuthoringGuide {
+    /** Markdown guide for authoring a custom view: SQL query conventions, the render-bundle data contract, the no-network/inline rules, and interactivity requirements. */
+    guide: string;
+    /** A complete, interactive, copy-paste render-bundle template (HTML) to start from. */
+    sampleBundle: string;
+}

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

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

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

@@ -0,0 +1,60 @@
+import type * as Paid from "../index.mjs";
+export interface CustomViewDetail {
+    displayId: string;
+    name: string;
+    description: string | null;
+    status: CustomViewDetail.Status;
+    /** Ids of the result sets the render bundle will receive. */
+    queryIds: string[];
+    /** Self-contained HTML document rendered inside the isolated sandbox iframe. */
+    renderBundle: string;
+    /** The view's current default date range, or null if it uses no adjustable period. */
+    period: CustomViewDetail.Period | null;
+    /** The filter parameters this view accepts per request (pass values as `filter_<name>` query params on the data endpoint), or null if it declares none. Embedding hosts can render controls from the declared values. */
+    filters: Paid.CustomViewFilter[] | null;
+    /** 'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only. */
+    scope: CustomViewDetail.Scope;
+}
+export declare namespace CustomViewDetail {
+    const Status: {
+        readonly Draft: "DRAFT";
+        readonly Published: "PUBLISHED";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    /**
+     * The view's current default date range, or null if it uses no adjustable period.
+     */
+    interface Period {
+        /** 'relative' = a rolling window ending today (set `unit` + `amount`); 'absolute' = a fixed calendar range (set `start` + `end`). */
+        kind: Period.Kind;
+        /** relative only: the unit of the rolling window. */
+        unit?: Period.Unit;
+        /** relative only: how many units back from today (e.g. unit 'day', amount 30 = last 30 days). */
+        amount?: number;
+        /** absolute only: inclusive start date (YYYY-MM-DD). */
+        start?: string;
+        /** absolute only: inclusive end date (YYYY-MM-DD). */
+        end?: string;
+    }
+    namespace Period {
+        /** 'relative' = a rolling window ending today (set `unit` + `amount`); 'absolute' = a fixed calendar range (set `start` + `end`). */
+        const Kind: {
+            readonly Relative: "relative";
+            readonly Absolute: "absolute";
+        };
+        type Kind = (typeof Kind)[keyof typeof Kind];
+        /** relative only: the unit of the rolling window. */
+        const Unit: {
+            readonly Day: "day";
+            readonly Month: "month";
+            readonly Year: "year";
+        };
+        type Unit = (typeof Unit)[keyof typeof Unit];
+    }
+    /** 'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only. */
+    const Scope: {
+        readonly Customer: "customer";
+        readonly Organization: "organization";
+    };
+    type Scope = (typeof Scope)[keyof typeof Scope];
+}