@paid-ai/paid-node 0.5.1 → 1.0.1-alpha0

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Tracks the usage of an entitlement for a customer
  */

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 /**
  * An error response from the Paid API
  */

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

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

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

@@ -0,0 +1,40 @@
+import type * as Paid from "../index.mjs";
+/**
+ * An invoice for an order
+ */
+export interface Invoice {
+    id?: string;
+    /** Human-readable invoice number */
+    displayId?: string;
+    organizationId?: string;
+    customerId?: string;
+    orderId?: string;
+    status?: Invoice.Status;
+    currency?: string;
+    /** Total before tax (in smallest currency unit) */
+    subtotal?: number;
+    /** Tax amount (in smallest currency unit) */
+    tax?: number;
+    /** Total amount including tax (in smallest currency unit) */
+    total?: number;
+    /** Amount already paid (in smallest currency unit) */
+    amountPaid?: number;
+    /** Amount still due (in smallest currency unit) */
+    amountDue?: number;
+    dueDate?: string;
+    paidAt?: string;
+    voidedAt?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    customer?: Paid.Customer;
+}
+export declare namespace Invoice {
+    const Status: {
+        readonly Draft: "draft";
+        readonly Open: "open";
+        readonly Paid: "paid";
+        readonly Void: "void";
+        readonly Uncollectible: "uncollectible";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

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

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+export var Invoice;
+(function (Invoice) {
+    Invoice.Status = {
+        Draft: "draft",
+        Open: "open",
+        Paid: "paid",
+        Void: "void",
+        Uncollectible: "uncollectible",
+    };
+})(Invoice || (Invoice = {}));

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 export interface Order {
     id?: string;
     name?: string;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 export interface OrderLine {
     id?: string;
     orderId?: string;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 export interface OrderLineAttribute {
     agentAttributeId?: string;
     quantity?: number;

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

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

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

@@ -1,4 +1 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export type OrderLineAttributeCreateOne = unknown;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 export interface OrderLineAttributePricing {
     eventName?: string;
     chargeType?: Paid.ChargeType;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 export interface OrderLineCreate {
     /** Paid's internal ID for the product */
     productId?: string;

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Pagination metadata for cost traces
  */

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

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

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

@@ -0,0 +1,54 @@
+/**
+ * A customer's payment method
+ */
+export interface PaymentMethod {
+    /** The payment method ID (typically from Stripe) */
+    id?: string;
+    /** The type of payment method */
+    type?: PaymentMethod.Type;
+    /** Card details (present when type is 'card') */
+    card?: PaymentMethod.Card;
+    /** US bank account details (present when type is 'us_bank_account') */
+    usBankAccount?: PaymentMethod.UsBankAccount;
+    /** Whether this is the customer's default payment method */
+    isDefault?: boolean;
+    createdAt?: string;
+}
+export declare namespace PaymentMethod {
+    /** The type of payment method */
+    const Type: {
+        readonly Card: "card";
+        readonly UsBankAccount: "us_bank_account";
+        readonly SepaDebit: "sepa_debit";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+    /**
+     * Card details (present when type is 'card')
+     */
+    interface Card {
+        /** Card brand (visa, mastercard, amex, etc.) */
+        brand?: string;
+        /** Last 4 digits of the card number */
+        last4?: string;
+        /** Expiration month (1-12) */
+        expMonth?: number;
+        /** Expiration year */
+        expYear?: number;
+    }
+    /**
+     * US bank account details (present when type is 'us_bank_account')
+     */
+    interface UsBankAccount {
+        bankName?: string;
+        /** Last 4 digits of the account number */
+        last4?: string;
+        accountType?: UsBankAccount.AccountType;
+    }
+    namespace UsBankAccount {
+        const AccountType: {
+            readonly Checking: "checking";
+            readonly Savings: "savings";
+        };
+        type AccountType = (typeof AccountType)[keyof typeof AccountType];
+    }
+}

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

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+export var PaymentMethod;
+(function (PaymentMethod) {
+    /** The type of payment method */
+    PaymentMethod.Type = {
+        Card: "card",
+        UsBankAccount: "us_bank_account",
+        SepaDebit: "sepa_debit",
+    };
+    let UsBankAccount;
+    (function (UsBankAccount) {
+        UsBankAccount.AccountType = {
+            Checking: "checking",
+            Savings: "savings",
+        };
+    })(UsBankAccount = PaymentMethod.UsBankAccount || (PaymentMethod.UsBankAccount = {}));
+})(PaymentMethod || (PaymentMethod = {}));

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

@@ -1,6 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+import type * as Paid from "../index.mjs";
 /**
  * A plan containing products and their attributes
  */
@@ -36,6 +34,8 @@ export declare namespace Plan {
             productId?: string;
             createdAt?: string;
             updatedAt?: string;
+            /** The product associated with this plan product */
+            product?: Paid.Product;
             /** The product attributes with pricing for this plan */
             planProductAttribute?: Item.PlanProductAttribute.Item[];
         }

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 /**
  * A plan group containing multiple plans
  */

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 export interface PricePoint {
     currency?: string;
     unitPrice?: number;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 export interface Pricing {
     eventName?: string;
     taxable: boolean;

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

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

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

@@ -1,10 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type PricingModelType = "PerUnit" | "VolumePricing" | "GraduatedPricing" | "PrepaidCredits";
 export declare const PricingModelType: {
     readonly PerUnit: "PerUnit";
     readonly VolumePricing: "VolumePricing";
     readonly GraduatedPricing: "GraduatedPricing";
     readonly PrepaidCredits: "PrepaidCredits";
 };
+export type PricingModelType = (typeof PricingModelType)[keyof typeof PricingModelType];

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

@@ -1,6 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 export const PricingModelType = {
     PerUnit: "PerUnit",
     VolumePricing: "VolumePricing",

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 /**
  * A product in the Paid system (previously called Agent)
  */
@@ -24,13 +21,11 @@ export interface Product {
     updatedAt?: string;
 }
 export declare namespace Product {
-    /**
-     * The type of product
-     */
-    type Type = "agent" | "product" | "prepaidCreditBundle";
+    /** The type of product */
     const Type: {
         readonly Agent: "agent";
         readonly Product: "product";
         readonly PrepaidCreditBundle: "prepaidCreditBundle";
     };
+    type Type = (typeof Type)[keyof typeof Type];
 }

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

@@ -1,8 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 export var Product;
 (function (Product) {
+    /** The type of product */
     Product.Type = {
         Agent: "agent",
         Product: "product",

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 export interface ProductUpdate {
     name?: string;
     description?: string;
@@ -14,10 +11,10 @@ export interface ProductUpdate {
     metadata?: Record<string, unknown>;
 }
 export declare namespace ProductUpdate {
-    type Type = "agent" | "product" | "prepaidCreditBundle";
     const Type: {
         readonly Agent: "agent";
         readonly Product: "product";
         readonly PrepaidCreditBundle: "prepaidCreditBundle";
     };
+    type Type = (typeof Type)[keyof typeof Type];
 }

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

@@ -1,6 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 export var ProductUpdate;
 (function (ProductUpdate) {
     ProductUpdate.Type = {

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

@@ -0,0 +1,11 @@
+/**
+ * An attribute update for a proration upgrade
+ */
+export interface ProrationAttributeUpdate {
+    /** The ID of the order line attribute to update */
+    orderLineAttributeId: string;
+    /** The new pricing configuration */
+    newPricing: Record<string, unknown>;
+    /** Optional new quantity for the attribute */
+    newQuantity?: number;
+}

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * Details about the proration calculation for an attribute
+ */
+export interface ProrationDetail {
+    oldAttributeId?: string;
+    newAttributeId?: string;
+    creditLineId?: string;
+    oldPrice?: number;
+    newPrice?: number;
+    /** The credit amount applied for the unused portion */
+    creditAmount?: number;
+    /** Number of days remaining in the current billing cycle */
+    remainingDays?: number;
+    /** Total number of days in the billing cycle */
+    totalDaysInCycle?: number;
+}

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

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

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

@@ -0,0 +1,22 @@
+import type * as Paid from "../index.mjs";
+/**
+ * Response after successfully scheduling a plan change
+ */
+export interface ProrationUpgradeResponse {
+    /** The ID of the order */
+    orderId: string;
+    /** The ID of the amendment record */
+    amendmentId: string;
+    /** The new version of the order after the amendment */
+    version: number;
+    /** The effective date of the plan change */
+    effectiveDate: string;
+    /** IDs of order lines that were ended */
+    endedLineIds: string[];
+    /** IDs of new order lines that were created */
+    createdLineIds: string[];
+    /** IDs of credit lines that were created */
+    creditLineIds: string[];
+    /** Detailed proration calculations for each updated attribute */
+    prorationDetails: Paid.ProrationDetail[];
+}

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

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

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

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type Salutation = "Mr." | "Mrs." | "Miss" | "Ms." | "Dr." | "Prof.";
 export declare const Salutation: {
     readonly Mr: "Mr.";
     readonly Mrs: "Mrs.";
@@ -10,3 +6,4 @@ export declare const Salutation: {
     readonly Dr: "Dr.";
     readonly Prof: "Prof.";
 };
+export type Salutation = (typeof Salutation)[keyof typeof Salutation];

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

@@ -1,6 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 export const Salutation = {
     Mr: "Mr.",
     Mrs: "Mrs.",

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * DEPRECATED: Use SignalV2 instead for cleaner field names.
  */

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * V2 signal schema with clean field names. Use either internal IDs (product_id, customer_id) or external IDs (external_product_id, external_customer_id).
  */

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

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

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

@@ -1,9 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type TaxExemptStatus = "none" | "exempt" | "reverse";
 export declare const TaxExemptStatus: {
     readonly None: "none";
     readonly Exempt: "exempt";
     readonly Reverse: "reverse";
 };
+export type TaxExemptStatus = (typeof TaxExemptStatus)[keyof typeof TaxExemptStatus];

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

@@ -1,6 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 export const TaxExemptStatus = {
     None: "none",
     Exempt: "exempt",

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface Tier {
     lowerBound?: number;
     upperBound?: number;

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 /**
  * A single cost trace record with customer and product info
  */

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

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

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Paid from "../index.mjs";
+import type * as Paid from "../index.mjs";
 /**
  * Response containing cost traces and pagination metadata
  */

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Pagination metadata for usage summaries
  */

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

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