@paid-ai/paid-node 1.7.1 → 2.0.0

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

@@ -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/cjs/api/types/DeliveredValueCalculationTerm.js

@@ -0,0 +1,24 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeliveredValueCalculationTerm = void 0;
+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 || (exports.DeliveredValueCalculationTerm = DeliveredValueCalculationTerm = {}));

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

@@ -0,0 +1,54 @@
+import type * as Paid from "../index.js";
+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/cjs/api/types/DeliveredValueMetric.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/DeliveredValueResponse.d.ts

@@ -0,0 +1,34 @@
+import type * as Paid from "../index.js";
+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/cjs/api/types/DeliveredValueResponse.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/DeliveredValueSignal.d.ts

@@ -0,0 +1,14 @@
+import type * as Paid from "../index.js";
+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/cjs/api/types/DeliveredValueSignal.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/DeliveredValueSignalValue.d.ts

@@ -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/cjs/api/types/DeliveredValueSignalValue.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/DeliveredValueSummaryBucket.d.ts

@@ -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/cjs/api/types/DeliveredValueSummaryBucket.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/DeliveredValueSummaryResponse.d.ts

@@ -0,0 +1,41 @@
+import type * as Paid from "../index.js";
+export interface DeliveredValueSummaryResponse {
+    /** Currency for every monetary field here, resolved as GET /delivered-value resolves it. */
+    currency: string;
+    customer: DeliveredValueSummaryResponse.Customer;
+    /** How the buckets are grouped. */
+    groupBy: DeliveredValueSummaryResponse.GroupBy;
+    /** The signal-payload key the buckets are grouped by, echoed from the query. Present only when groupBy is dimension. */
+    dimensionKey?: string;
+    /** The value metric the buckets are narrowed to, echoed from the query. Present only when the request named one. Every unitTotal in the response is then in this metric's unit. */
+    valueMetric?: string;
+    /** Period bucket size. */
+    interval: DeliveredValueSummaryResponse.Interval;
+    /** Buckets ordered by period, then by group key. Every period in the window appears, and every group appears in every period, so a chart never has to fill gaps itself. For valueMetric grouping the groups are the model's metrics, plus any archived metric that delivered value in the window. For dimension grouping the groups are the payload values observed in the window, so a window that delivered nothing has no rows. For signal grouping the groups are the signals the value model binds to a metric, plus any signal that delivered value in the window under a binding the model has since dropped. A row is one period of one group; a request producing more than 5000 rows is rejected rather than answered in part. */
+    data: Paid.DeliveredValueSummaryBucket[];
+}
+export declare namespace DeliveredValueSummaryResponse {
+    interface Customer {
+        /** The Paid customer ID. */
+        id: string;
+        externalId: string | null;
+        name: string;
+    }
+    /** How the buckets are grouped. */
+    const GroupBy: {
+        readonly ValueMetric: "valueMetric";
+        readonly Dimension: "dimension";
+        readonly FormulaCondition: "formulaCondition";
+        readonly Signal: "signal";
+    };
+    type GroupBy = (typeof GroupBy)[keyof typeof GroupBy];
+    /** Period bucket size. */
+    const Interval: {
+        readonly Hour: "hour";
+        readonly Day: "day";
+        readonly Week: "week";
+        readonly Month: "month";
+        readonly Quarter: "quarter";
+    };
+    type Interval = (typeof Interval)[keyof typeof Interval];
+}

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

@@ -0,0 +1,22 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeliveredValueSummaryResponse = void 0;
+var DeliveredValueSummaryResponse;
+(function (DeliveredValueSummaryResponse) {
+    /** How the buckets are grouped. */
+    DeliveredValueSummaryResponse.GroupBy = {
+        ValueMetric: "valueMetric",
+        Dimension: "dimension",
+        FormulaCondition: "formulaCondition",
+        Signal: "signal",
+    };
+    /** Period bucket size. */
+    DeliveredValueSummaryResponse.Interval = {
+        Hour: "hour",
+        Day: "day",
+        Week: "week",
+        Month: "month",
+        Quarter: "quarter",
+    };
+})(DeliveredValueSummaryResponse || (exports.DeliveredValueSummaryResponse = DeliveredValueSummaryResponse = {}));

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

@@ -0,0 +1,16 @@
+export interface EndAttributeIntent {
+    /** Attribute UUID from the options response. Not the order display id. */
+    orderLineAttributeId: string;
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    treatment?: EndAttributeIntent.Treatment;
+}
+export declare namespace EndAttributeIntent {
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    const Treatment: {
+        readonly None: "none";
+        readonly Prorate: "prorate";
+        readonly SignalsFromAmendment: "signalsFromAmendment";
+        readonly AllSignalsInPeriod: "allSignalsInPeriod";
+    };
+    type Treatment = (typeof Treatment)[keyof typeof Treatment];
+}

package/dist/cjs/api/types/EndAttributeIntent.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.EndAttributeIntent = void 0;
+var EndAttributeIntent;
+(function (EndAttributeIntent) {
+    /** Recurring charges pick next-cycle vs settle-now. Usage price changes pick new usage only vs the whole current period. */
+    EndAttributeIntent.Treatment = {
+        None: "none",
+        Prorate: "prorate",
+        SignalsFromAmendment: "signalsFromAmendment",
+        AllSignalsInPeriod: "allSignalsInPeriod",
+    };
+})(EndAttributeIntent || (exports.EndAttributeIntent = EndAttributeIntent = {}));

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

@@ -0,0 +1,9 @@
+import type * as Paid from "../index.js";
+export interface GrantCustomerCreditsResponse {
+    /** True when this request created a new grant. False when an earlier request with the same idempotencyKey already created it. */
+    created: boolean;
+    customer: Paid.CreditGrantCustomer;
+    creditCurrency: Paid.CreditGrantCurrency;
+    grant: Paid.CreditGrantResult;
+    createdAt: string;
+}

package/dist/cjs/api/types/GrantCustomerCreditsResponse.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/Invoice.d.ts

@@ -25,10 +25,13 @@ export interface Invoice {
     createdAt: string;
     updatedAt: string;
     paymentLink?: string | null;
+    /** Always null. The disputes feature is removed. Will be removed in a future API version. */
     disputeLink?: string | null;
     publicUrlToken?: string | null;
     taxExempt: boolean;
     billingContactId?: string | null;
+    /** Purchase order reference stamped on this invoice. */
+    purchaseOrderReference?: string | null;
 }
 export declare namespace Invoice {
     const Status: {

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

@@ -0,0 +1,23 @@
+import type * as Paid from "../index.js";
+export interface MoneyAxisOptions {
+    relevance: Paid.AmendmentAxisRelevance;
+    options: MoneyAxisOptions.Options.Item[];
+    /** Accepts any additional properties */
+    [key: string]: any;
+}
+export declare namespace MoneyAxisOptions {
+    type Options = Options.Item[];
+    namespace Options {
+        interface Item {
+            value: Paid.MoneyAxisValue;
+            /** 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/cjs/api/types/MoneyAxisOptions.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/MoneyAxisValue.d.ts

@@ -0,0 +1,6 @@
+/** none changes structure only and lets billing pick it up on its own schedule. prorate also settles the current period's difference now. */
+export declare const MoneyAxisValue: {
+    readonly None: "none";
+    readonly Prorate: "prorate";
+};
+export type MoneyAxisValue = (typeof MoneyAxisValue)[keyof typeof MoneyAxisValue];

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

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MoneyAxisValue = void 0;
+/** none changes structure only and lets billing pick it up on its own schedule. prorate also settles the current period's difference now. */
+exports.MoneyAxisValue = {
+    None: "none",
+    Prorate: "prorate",
+};

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

@@ -29,4 +29,5 @@ export interface Order {
     version: number;
     billingFrequencyOverridden: boolean;
     billingFrequencyOverride?: Paid.OrderBillingFrequencyOverride;
+    purchaseOrderReference: string | null;
 }

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

@@ -1,3 +1,4 @@
+import type * as Paid from "../index.js";
 export interface OrderLine {
     id: string;
     productId: string;
@@ -5,4 +6,5 @@ export interface OrderLine {
     description: string | null;
     startDate: string;
     endDate: string | null;
+    lineType: Paid.OrderLineType;
 }

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

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

package/dist/cjs/api/types/OrderLineType.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.OrderLineType = void 0;
+exports.OrderLineType = {
+    Standard: "STANDARD",
+    ProrationCredit: "PRORATION_CREDIT",
+    ProrationCharge: "PRORATION_CHARGE",
+    Credit: "CREDIT",
+};

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

@@ -0,0 +1,30 @@
+export interface Payment {
+    /** Unique payment identifier. */
+    id: string;
+    /** Sequential payment number within your organization (shown as "PAY-0001"). */
+    number: number;
+    /** The customer this payment belongs to. */
+    customerId: string;
+    /** The invoice this payment was collected for, when created by an automatic charge. Null for manually recorded payments. */
+    invoiceId: string | null;
+    /** The order this payment relates to, when known. */
+    orderId: string | null;
+    /** Payment amount in cents (minor currency units). */
+    amount: number;
+    /** Portion of the amount already allocated to invoice lines, in cents. */
+    allocatedAmount: number;
+    /** Unallocated remainder of the payment, in cents. */
+    balance: number;
+    /** Three-letter ISO currency code. */
+    currency: string;
+    /** When the payment was made. */
+    paymentDate: string;
+    /** How the payment was made, e.g. creditCard, bankTransfer, ach, cash, or check. */
+    paymentType: string;
+    /** Payment status: draft, posted, processing, requiresAction, failed, or canceled. */
+    status: string;
+    /** Key-value metadata stored on the payment. */
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/cjs/api/types/Payment.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/PaymentAllocation.d.ts

@@ -0,0 +1,21 @@
+export interface PaymentAllocation {
+    /** Unique payment allocation identifier. */
+    id: string;
+    /** The payment the amount was allocated from. */
+    paymentId: string;
+    /** The invoice the allocated line belongs to. */
+    invoiceId: string;
+    /** The invoice line the amount was allocated to, as returned by the invoice lines endpoint. */
+    invoiceLineId: string;
+    /** Allocated amount in cents (minor currency units). */
+    amount: number;
+    /** Three-letter ISO currency code. */
+    currency: string;
+    /** Allocation type: allocated or unallocated. */
+    type: string;
+    /** Allocation status: posted, applied, or cancelled. */
+    status: string;
+    /** When the allocation was made. */
+    allocationDate: string;
+    createdAt: string;
+}

package/dist/cjs/api/types/PaymentAllocation.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/PaymentAllocationCreateResponse.d.ts

@@ -0,0 +1,4 @@
+import type * as Paid from "../index.js";
+export interface PaymentAllocationCreateResponse {
+    data: Paid.PaymentAllocation[];
+}

package/dist/cjs/api/types/PaymentAllocationCreateResponse.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/PaymentAllocationInput.d.ts

@@ -0,0 +1,8 @@
+export interface PaymentAllocationInput {
+    /** Invoice line to allocate to, as returned by the invoice lines endpoint. */
+    invoiceLineId: string;
+    /** Amount to allocate in cents (minor currency units). */
+    amount: number;
+    /** Three-letter ISO currency code. Defaults to the payment's currency. */
+    currency?: string;
+}

package/dist/cjs/api/types/PaymentAllocationInput.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/PaymentAllocationListResponse.d.ts

@@ -0,0 +1,5 @@
+import type * as Paid from "../index.js";
+export interface PaymentAllocationListResponse {
+    data: Paid.PaymentAllocation[];
+    pagination: Paid.Pagination;
+}

package/dist/cjs/api/types/PaymentAllocationListResponse.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/PaymentCreateStatus.d.ts

@@ -0,0 +1,6 @@
+/** Initial status. Use draft to keep the payment editable, posted to record it as received. Defaults to posted. */
+export declare const PaymentCreateStatus: {
+    readonly Draft: "draft";
+    readonly Posted: "posted";
+};
+export type PaymentCreateStatus = (typeof PaymentCreateStatus)[keyof typeof PaymentCreateStatus];

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

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentCreateStatus = void 0;
+/** Initial status. Use draft to keep the payment editable, posted to record it as received. Defaults to posted. */
+exports.PaymentCreateStatus = {
+    Draft: "draft",
+    Posted: "posted",
+};

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

@@ -0,0 +1,5 @@
+import type * as Paid from "../index.js";
+export interface PaymentListResponse {
+    data: Paid.Payment[];
+    pagination: Paid.Pagination;
+}

package/dist/cjs/api/types/PaymentListResponse.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/PaymentMethod.d.ts

@@ -0,0 +1,15 @@
+import type * as Paid from "../index.js";
+export interface PaymentMethod {
+    /** Unique payment method identifier. */
+    id: string;
+    /** The customer this payment method belongs to. */
+    customerId: string;
+    /** The payment processor's identifier for this payment method (e.g. a Stripe payment method ID). */
+    externalPaymentMethodId: string;
+    /** Payment method type, e.g. "card". */
+    type: string;
+    /** Whether this is the customer's default payment method. */
+    isDefault: boolean;
+    card: Paid.PaymentMethodCard | null;
+    createdAt: string;
+}

package/dist/cjs/api/types/PaymentMethod.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/PaymentMethodCard.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Card details when the payment method is a card. Null for other types or when details are unavailable.
+ */
+export interface PaymentMethodCard {
+    /** Card brand, e.g. visa or mastercard. */
+    brand: string;
+    /** Last four digits of the card number. */
+    last4: string;
+    /** Card expiration month (1-12). */
+    expMonth: number;
+    /** Four-digit card expiration year. */
+    expYear: number;
+}

package/dist/cjs/api/types/PaymentMethodCard.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/PaymentMethodListResponse.d.ts

@@ -0,0 +1,5 @@
+import type * as Paid from "../index.js";
+export interface PaymentMethodListResponse {
+    data: Paid.PaymentMethod[];
+    pagination: Paid.Pagination;
+}

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

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