@dime-technology/dime-js-sdk 1.0.0 → 1.3.0

package/dist/index.js

@@ -1,6 +1,6 @@
 // src/config.ts
 var DEFAULT_BASE_URL = "https://app.dimepayments.com";
-var VERSION = "1.0.0";
+var VERSION = "1.3.0";
 var Config = class {
   token;
   baseUrl;
@@ -169,25 +169,31 @@ var Transport = class {
   /**
    * Execute a request and return the decoded JSON body.
    *
-   * The Dime API expects request parameters in the JSON body even for GET
-   * requests; this transport always sends the payload as a JSON body regardless
-   * of HTTP method, matching the server's expectation.
+   * The Dime API reads the same `{ data, filters }` envelope whether it arrives
+   * as a JSON body or as nested query parameters. The Fetch standard forbids a
+   * body on GET/HEAD (undici throws), so for those methods the envelope is
+   * serialised into the query string (`data[sid]=…&filters[status]=…`) and no
+   * body is sent; every other method sends the envelope as a JSON body.
    */
   async request(method, path, body = {}, query = {}) {
     let url = `${this.config.baseUri()}${path.replace(/^\//, "")}`;
-    if (Object.keys(query).length > 0) {
-      url += "?" + new URLSearchParams(query).toString();
+    const bodyless = method.toUpperCase() === "GET" || method.toUpperCase() === "HEAD";
+    const params = { ...query };
+    if (bodyless) Object.assign(params, flattenParams(body));
+    if (Object.keys(params).length > 0) {
+      url += "?" + new URLSearchParams(params).toString();
     }
-    const hasBody = Object.keys(body).length > 0;
+    const sendBody = !bodyless && Object.keys(body).length > 0;
+    const headers = {
+      Authorization: `Bearer ${this.config.token}`,
+      Accept: "application/json",
+      "X-Dime-Sdk": `dime-js-sdk/${VERSION}`
+    };
+    if (sendBody) headers["Content-Type"] = "application/json";
     const init = {
       method,
-      headers: {
-        Authorization: `Bearer ${this.config.token}`,
-        Accept: "application/json",
-        "Content-Type": "application/json",
-        "X-Dime-Sdk": `dime-js-sdk/${VERSION}`
-      },
-      ...hasBody ? { body: JSON.stringify(body) } : {}
+      headers,
+      ...sendBody ? { body: JSON.stringify(body) } : {}
     };
     return this.attempt(url, init, 0);
   }
@@ -227,6 +233,23 @@ var Transport = class {
     await this.sleepFn(ms);
   }
 };
+function flattenParams(obj, prefix = "") {
+  const out = {};
+  for (const [key, value] of Object.entries(obj)) {
+    if (value === null || value === void 0) continue;
+    const name = prefix ? `${prefix}[${key}]` : key;
+    if (Array.isArray(value)) {
+      value.forEach((item, i) => {
+        Object.assign(out, flattenParams({ [i]: item }, name));
+      });
+    } else if (typeof value === "object") {
+      Object.assign(out, flattenParams(value, name));
+    } else {
+      out[name] = typeof value === "boolean" ? value ? "1" : "0" : String(value);
+    }
+  }
+  return out;
+}
 function parseRetryAfter(response) {
   const header = response.headers.get("Retry-After");
   if (header !== null && /^\d+$/.test(header)) return parseInt(header, 10);
@@ -272,6 +295,11 @@ function arrObjectFrom(data, keys) {
   }
   return {};
 }
+function arrArrayFrom(data, key) {
+  const value = data[key];
+  if (Array.isArray(value)) return value;
+  return [];
+}
 
 // src/data-objects/address.ts
 var Address = class _Address {
@@ -401,9 +429,7 @@ function extractCursor(meta, key) {
   return typeof v === "string" && v !== "" ? v : void 0;
 }
 function pruneNulls(obj) {
-  return Object.fromEntries(
-    Object.entries(obj).filter(([, v]) => v !== null && v !== void 0)
-  );
+  return Object.fromEntries(Object.entries(obj).filter(([, v]) => v !== null && v !== void 0));
 }
 
 // src/resources/addresses.ts
@@ -412,19 +438,35 @@ var Addresses = class extends AbstractResource {
     return this.paginate("GET", "address/list", this.envelope({ sid, uuid }), Address.fromRaw);
   }
   async show(sid, uuid, addressId) {
-    const raw = await this.transport.request("GET", "address/show", this.envelope({ sid, uuid, address_id: addressId }));
+    const raw = await this.transport.request(
+      "GET",
+      "address/show",
+      this.envelope({ sid, uuid, address_id: addressId })
+    );
     return Address.fromRaw(raw["data"] ?? {});
   }
   async create(sid, uuid, attributes) {
-    const raw = await this.transport.request("POST", "address/create", this.envelope({ sid, uuid, ...attributes }));
+    const raw = await this.transport.request(
+      "POST",
+      "address/create",
+      this.envelope({ sid, uuid, ...attributes })
+    );
     return Address.fromRaw(raw["data"] ?? {});
   }
   async update(sid, uuid, addressId, attributes) {
-    const raw = await this.transport.request("PATCH", "address/update", this.envelope({ sid, uuid, address_id: addressId, ...attributes }));
+    const raw = await this.transport.request(
+      "PATCH",
+      "address/update",
+      this.envelope({ sid, uuid, address_id: addressId, ...attributes })
+    );
     return Address.fromRaw(raw["data"] ?? {});
   }
   async delete(sid, uuid, addressId) {
-    const raw = await this.transport.request("POST", "address/delete", this.envelope({ sid, uuid, address_id: addressId }));
+    const raw = await this.transport.request(
+      "POST",
+      "address/delete",
+      this.envelope({ sid, uuid, address_id: addressId })
+    );
     return MessageResult.fromRaw(raw["data"] ?? raw);
   }
 };
@@ -481,19 +523,35 @@ var Customers = class extends AbstractResource {
     return this.paginate("GET", "customer/list", this.envelope({ sid }, filters), Customer.fromRaw);
   }
   async show(sid, filters) {
-    const raw = await this.transport.request("GET", "customer/show", this.envelope({ sid }, filters));
+    const raw = await this.transport.request(
+      "GET",
+      "customer/show",
+      this.envelope({ sid }, filters)
+    );
     return Customer.fromRaw(raw["data"] ?? {});
   }
   async create(sid, attributes) {
-    const raw = await this.transport.request("POST", "customer/create", this.envelope({ sid, ...attributes }));
+    const raw = await this.transport.request(
+      "POST",
+      "customer/create",
+      this.envelope({ sid, ...attributes })
+    );
     return Customer.fromRaw(raw["data"] ?? {});
   }
   async update(sid, filters, attributes) {
-    const raw = await this.transport.request("PATCH", "customer/update", this.envelope({ sid, ...attributes }, filters));
+    const raw = await this.transport.request(
+      "PATCH",
+      "customer/update",
+      this.envelope({ sid, ...attributes }, filters)
+    );
     return Customer.fromRaw(raw["data"] ?? {});
   }
   async delete(sid, filters) {
-    const raw = await this.transport.request("POST", "customer/delete", this.envelope({ sid }, filters));
+    const raw = await this.transport.request(
+      "POST",
+      "customer/delete",
+      this.envelope({ sid }, filters)
+    );
     return MessageResult.fromRaw(raw["data"] ?? raw);
   }
 };
@@ -702,15 +760,465 @@ var Deposits = class extends AbstractResource {
     return this.paginate("GET", "deposit/list", this.envelope({ sid }, filters), Deposit.fromRaw);
   }
   async listWithTransactions(sid, filters) {
-    const raw = await this.transport.request("GET", "deposit/list-with-trans", this.envelope({ sid }, filters));
+    const raw = await this.transport.request(
+      "GET",
+      "deposit/list-with-trans",
+      this.envelope({ sid }, filters)
+    );
     return DepositGroup.fromRaw(raw["data"] ?? {});
   }
   async show(sid, identifier) {
-    const raw = await this.transport.request("GET", "deposit/show", this.envelope({ sid, ...identifier }));
+    const raw = await this.transport.request(
+      "GET",
+      "deposit/show",
+      this.envelope({ sid, ...identifier })
+    );
     return DepositWithTransactions.fromRaw(raw["data"] ?? {});
   }
 };
 
+// src/data-objects/cover-fee-quote.ts
+var CoverFeeQuote = class _CoverFeeQuote {
+  constructor(basis, base, ccFee, ccTotal, achFee, achTotal) {
+    this.basis = basis;
+    this.base = base;
+    this.ccFee = ccFee;
+    this.ccTotal = ccTotal;
+    this.achFee = achFee;
+    this.achTotal = achTotal;
+  }
+  basis;
+  base;
+  ccFee;
+  ccTotal;
+  achFee;
+  achTotal;
+  static fromRaw(data) {
+    const cc = arrObjectFrom(data, ["cc"]);
+    const ach = arrObjectFrom(data, ["ach"]);
+    return new _CoverFeeQuote(
+      arrString(data, "basis"),
+      arrString(data, "base"),
+      arrString(cc, "fee"),
+      arrString(cc, "total"),
+      arrString(ach, "fee"),
+      arrString(ach, "total")
+    );
+  }
+};
+
+// src/data-objects/invoice-customer.ts
+var InvoiceCustomer = class _InvoiceCustomer {
+  constructor(id, name, email) {
+    this.id = id;
+    this.name = name;
+    this.email = email;
+  }
+  id;
+  name;
+  email;
+  static fromRaw(data) {
+    return new _InvoiceCustomer(
+      arrInt(data, "id"),
+      arrString(data, "name"),
+      arrString(data, "email")
+    );
+  }
+};
+
+// src/data-objects/invoice-event.ts
+var InvoiceEvent = class _InvoiceEvent {
+  constructor(type, label, description, createdAt) {
+    this.type = type;
+    this.label = label;
+    this.description = description;
+    this.createdAt = createdAt;
+  }
+  type;
+  label;
+  description;
+  createdAt;
+  static fromRaw(data) {
+    return new _InvoiceEvent(
+      arrString(data, "type"),
+      arrString(data, "label"),
+      arrString(data, "description"),
+      arrString(data, "created_at")
+    );
+  }
+};
+
+// src/data-objects/invoice-line-item.ts
+var InvoiceLineItem = class _InvoiceLineItem {
+  constructor(id, itemId, name, description, quantity, unitPrice, amount) {
+    this.id = id;
+    this.itemId = itemId;
+    this.name = name;
+    this.description = description;
+    this.quantity = quantity;
+    this.unitPrice = unitPrice;
+    this.amount = amount;
+  }
+  id;
+  itemId;
+  name;
+  description;
+  quantity;
+  unitPrice;
+  amount;
+  static fromRaw(data) {
+    return new _InvoiceLineItem(
+      arrInt(data, "id"),
+      arrInt(data, "item_id"),
+      arrString(data, "name"),
+      arrString(data, "description"),
+      arrString(data, "quantity"),
+      arrString(data, "unit_price"),
+      arrString(data, "amount")
+    );
+  }
+};
+
+// src/data-objects/invoice-payment.ts
+var InvoicePayment = class _InvoicePayment {
+  constructor(amount, paidAt, method, transactionId, coverFee) {
+    this.amount = amount;
+    this.paidAt = paidAt;
+    this.method = method;
+    this.transactionId = transactionId;
+    this.coverFee = coverFee;
+  }
+  amount;
+  paidAt;
+  method;
+  transactionId;
+  coverFee;
+  static fromRaw(data) {
+    return new _InvoicePayment(
+      arrString(data, "amount"),
+      arrString(data, "paid_at"),
+      arrString(data, "method"),
+      arrString(data, "transaction_id"),
+      arrString(data, "cover_fee")
+    );
+  }
+};
+
+// src/data-objects/invoice.ts
+var Invoice = class _Invoice {
+  constructor(id, invoiceNumber, status, token, paymentTerms, issueDate, dueDate, isOverdue = false, subtotal, total, amountPaid, balance, allowPartialPayment = false, thankYouNote, customerName, customerEmail, publicUrl, customer = new InvoiceCustomer(), items = [], payments = [], events = [], coverFeeRequired = false, coverFeeQuote) {
+    this.id = id;
+    this.invoiceNumber = invoiceNumber;
+    this.status = status;
+    this.token = token;
+    this.paymentTerms = paymentTerms;
+    this.issueDate = issueDate;
+    this.dueDate = dueDate;
+    this.isOverdue = isOverdue;
+    this.subtotal = subtotal;
+    this.total = total;
+    this.amountPaid = amountPaid;
+    this.balance = balance;
+    this.allowPartialPayment = allowPartialPayment;
+    this.thankYouNote = thankYouNote;
+    this.customerName = customerName;
+    this.customerEmail = customerEmail;
+    this.publicUrl = publicUrl;
+    this.customer = customer;
+    this.items = items;
+    this.payments = payments;
+    this.events = events;
+    this.coverFeeRequired = coverFeeRequired;
+    this.coverFeeQuote = coverFeeQuote;
+  }
+  id;
+  invoiceNumber;
+  status;
+  token;
+  paymentTerms;
+  issueDate;
+  dueDate;
+  isOverdue;
+  subtotal;
+  total;
+  amountPaid;
+  balance;
+  allowPartialPayment;
+  thankYouNote;
+  customerName;
+  customerEmail;
+  publicUrl;
+  customer;
+  items;
+  payments;
+  events;
+  coverFeeRequired;
+  coverFeeQuote;
+  static fromRaw(data) {
+    return new _Invoice(
+      arrInt(data, "id"),
+      arrString(data, "invoice_number"),
+      arrString(data, "status"),
+      arrString(data, "token"),
+      arrString(data, "payment_terms"),
+      arrString(data, "issue_date"),
+      arrString(data, "due_date"),
+      arrBool(data, "is_overdue"),
+      arrString(data, "subtotal"),
+      arrString(data, "total"),
+      arrString(data, "amount_paid"),
+      arrString(data, "balance"),
+      arrBool(data, "allow_partial_payment"),
+      arrString(data, "thank_you_note"),
+      arrString(data, "customer_name"),
+      arrString(data, "customer_email"),
+      arrString(data, "public_url"),
+      InvoiceCustomer.fromRaw(arrObjectFrom(data, ["customer"])),
+      arrArrayFrom(data, "items").map(InvoiceLineItem.fromRaw),
+      arrArrayFrom(data, "payments").map(InvoicePayment.fromRaw),
+      arrArrayFrom(data, "events").map(InvoiceEvent.fromRaw),
+      arrBool(data, "cover_fee_required"),
+      data["cover_fee_quote"] && typeof data["cover_fee_quote"] === "object" ? CoverFeeQuote.fromRaw(data["cover_fee_quote"]) : void 0
+    );
+  }
+};
+
+// src/data-objects/invoice-item.ts
+var InvoiceItem = class _InvoiceItem {
+  constructor(id, name, description, price, taxDeductible = false) {
+    this.id = id;
+    this.name = name;
+    this.description = description;
+    this.price = price;
+    this.taxDeductible = taxDeductible;
+  }
+  id;
+  name;
+  description;
+  price;
+  taxDeductible;
+  static fromRaw(data) {
+    return new _InvoiceItem(
+      arrInt(data, "id"),
+      arrString(data, "name"),
+      arrString(data, "description"),
+      arrString(data, "price"),
+      arrBool(data, "tax_deductible")
+    );
+  }
+};
+
+// src/data-objects/invoice-link.ts
+var InvoiceLink = class _InvoiceLink {
+  constructor(publicUrl, token) {
+    this.publicUrl = publicUrl;
+    this.token = token;
+  }
+  publicUrl;
+  token;
+  static fromRaw(data) {
+    return new _InvoiceLink(arrString(data, "public_url"), arrString(data, "token"));
+  }
+};
+
+// src/resources/invoices.ts
+var Invoices = class extends AbstractResource {
+  /**
+   * List invoices for a merchant.
+   *
+   * @param filters `status` — draft | sent | paid | partial | void | overdue
+   */
+  async list(sid, filters = {}) {
+    return this.paginate("GET", "invoices", this.envelope({ sid }, filters), Invoice.fromRaw);
+  }
+  async show(sid, invoiceId) {
+    const raw = await this.transport.request(
+      "GET",
+      "invoice",
+      this.envelope({ sid, invoice_id: invoiceId })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  /**
+   * Create a draft invoice with its line items. Every line must reference a
+   * Merchant `item_id`; the line name and unit price are snapshotted.
+   *
+   * @param attributes
+   *   `customer_uuid` (or `customer_id`), `customer_name`, `customer_email`,
+   *   `payment_terms` (`due_on_receipt` | `net_15` | `net_30` | `net_60`) and
+   *   `lines` are required. `lines[]` takes `item_id`, `name`, `quantity`,
+   *   `unit_price` and optional `description`. Optional: `invoice_number`,
+   *   `issue_date` (Y-m-d, defaults to today — `due_date` is derived from
+   *   `payment_terms`), `thank_you_note`, `allow_partial_payment`,
+   *   `cover_fee_required`, `reminder_settings`.
+   *
+   *   Set `cover_fee_required` to make the customer pay the processing fee. The
+   *   fee is added on top of the invoice at payment time rather than becoming a
+   *   line item, so `total` stays the amount owed to the merchant — read
+   *   `invoice.coverFeeQuote` for what the customer will actually be charged.
+   *   Omitting the field inherits the merchant's invoice setting.
+   */
+  async create(sid, attributes) {
+    const raw = await this.transport.request(
+      "POST",
+      "invoice/create",
+      this.envelope({ sid, ...attributes })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  /**
+   * Update a draft invoice. Only drafts can be edited, and passing `lines`
+   * replaces the existing line items.
+   *
+   * @param attributes same shape as {@link Invoices.create}
+   */
+  async update(sid, invoiceId, attributes) {
+    const raw = await this.transport.request(
+      "PATCH",
+      "invoice/update",
+      this.envelope({ sid, invoice_id: invoiceId, ...attributes })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  async delete(sid, invoiceId) {
+    const raw = await this.transport.request(
+      "POST",
+      "invoice/delete",
+      this.envelope({ sid, invoice_id: invoiceId })
+    );
+    return MessageResult.fromRaw(raw["data"] ?? raw);
+  }
+  /** Email the invoice to the customer and advance it to Sent. */
+  async send(sid, invoiceId) {
+    const raw = await this.transport.request(
+      "POST",
+      "invoice/send",
+      this.envelope({ sid, invoice_id: invoiceId })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  /** Activate a draft invoice for payment without emailing it. */
+  async markSent(sid, invoiceId) {
+    const raw = await this.transport.request(
+      "POST",
+      "invoice/mark-sent",
+      this.envelope({ sid, invoice_id: invoiceId })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  async void(sid, invoiceId) {
+    const raw = await this.transport.request(
+      "PATCH",
+      "invoice/void",
+      this.envelope({ sid, invoice_id: invoiceId })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  /** Clone any invoice into a new draft with a freshly allocated number. */
+  async duplicate(sid, invoiceId) {
+    const raw = await this.transport.request(
+      "POST",
+      "invoice/duplicate",
+      this.envelope({ sid, invoice_id: invoiceId })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  /**
+   * Record a merchant-initiated (MOTO) card or ACH payment against an open
+   * invoice.
+   *
+   * @param attributes
+   *   `payment_type` is required and is `cc` or `ach`. For a card, pass a stored
+   *   `token` or raw `cardholder_name` / `card_number` / `expiration_date` (m/Y)
+   *   plus optional `cvv`; for ACH, pass `routing_number` / `account_number` /
+   *   `account_type` (Checking | Savings) / `account_name`. Omit `amount` to pay
+   *   the full balance — partial amounts require the invoice to allow them.
+   *   Optional: `memo`, `billing_address`.
+   *
+   *   On a cover-fee invoice the processing fee for `payment_type` is charged on
+   *   top of `amount`, so the card or bank account is debited more than the
+   *   invoice is credited. The fee lands as `coverFee` on the matching entry in
+   *   `invoice.payments`. Card and ACH rates differ, so the same `amount` settles
+   *   differently per `payment_type`.
+   */
+  async pay(sid, invoiceId, attributes) {
+    const raw = await this.transport.request(
+      "POST",
+      "invoice/pay",
+      this.envelope({ sid, invoice_id: invoiceId, ...attributes })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  /** Get the public pay link (and token) for an invoice. */
+  async getLink(sid, invoiceId) {
+    const raw = await this.transport.request(
+      "GET",
+      "invoice/link",
+      this.envelope({ sid, invoice_id: invoiceId })
+    );
+    return InvoiceLink.fromRaw(raw["data"] ?? {});
+  }
+  /**
+   * Append a single line item to a draft invoice.
+   *
+   * @param attributes `item_id`, `name`, `quantity` and `unit_price` are
+   *   required; `description` is optional.
+   */
+  async addLineItem(sid, invoiceId, attributes) {
+    const raw = await this.transport.request(
+      "POST",
+      "invoice/line-item/add",
+      this.envelope({ sid, invoice_id: invoiceId, ...attributes })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  /**
+   * Update a single line item on a draft invoice.
+   *
+   * @param attributes any of `item_id`, `name`, `description`, `quantity`,
+   *   `unit_price`
+   */
+  async updateLineItem(sid, invoiceId, lineItemId, attributes) {
+    const raw = await this.transport.request(
+      "PATCH",
+      "invoice/line-item/update",
+      this.envelope({ sid, invoice_id: invoiceId, line_item_id: lineItemId, ...attributes })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  /** Remove a single line item from a draft invoice. */
+  async deleteLineItem(sid, invoiceId, lineItemId) {
+    const raw = await this.transport.request(
+      "POST",
+      "invoice/line-item/delete",
+      this.envelope({ sid, invoice_id: invoiceId, line_item_id: lineItemId })
+    );
+    return Invoice.fromRaw(raw["data"] ?? {});
+  }
+  /** List the Merchant's items (funds/designations) available as invoice line items. */
+  async listItems(sid) {
+    const raw = await this.transport.request("GET", "invoice/items", this.envelope({ sid }));
+    const items = Array.isArray(raw["data"]) ? raw["data"] : [];
+    return items.map(InvoiceItem.fromRaw);
+  }
+  /**
+   * Create an invoicing-only item (fund/designation) for the Merchant. The item
+   * is hidden from public giving pages and can be referenced as a line's
+   * `item_id`.
+   *
+   * @param attributes `name` is required; `description`, `price` and
+   *   `tax_deductible` are optional.
+   */
+  async createItem(sid, attributes) {
+    const raw = await this.transport.request(
+      "POST",
+      "invoice/item/create",
+      this.envelope({ sid, ...attributes })
+    );
+    return InvoiceItem.fromRaw(raw["data"] ?? {});
+  }
+};
+
 // src/data-objects/form-link.ts
 var FormLink = class _FormLink {
   constructor(link) {
@@ -809,11 +1317,19 @@ var Merchants = class extends AbstractResource {
     return Merchant.fromRaw(raw["data"] ?? {});
   }
   async update(sid, attributes) {
-    const raw = await this.transport.request("PATCH", "merchant/update", this.envelope({ sid, ...attributes }));
+    const raw = await this.transport.request(
+      "PATCH",
+      "merchant/update",
+      this.envelope({ sid, ...attributes })
+    );
     return Merchant.fromRaw(raw["data"] ?? {});
   }
   async getFormLink(sid) {
-    const raw = await this.transport.request("GET", "merchant/get-form-link", this.envelope({ sid }));
+    const raw = await this.transport.request(
+      "GET",
+      "merchant/get-form-link",
+      this.envelope({ sid })
+    );
     return FormLink.fromRaw(raw["data"] ?? {});
   }
 };
@@ -906,26 +1422,159 @@ var PaymentMethod = class _PaymentMethod {
 // src/resources/payment-methods.ts
 var PaymentMethods = class extends AbstractResource {
   async list(sid, filters) {
-    return this.paginate("GET", "payment-method/list", this.envelope({ sid }, filters), PaymentMethod.fromRaw);
+    return this.paginate(
+      "GET",
+      "payment-method/list",
+      this.envelope({ sid }, filters),
+      PaymentMethod.fromRaw
+    );
   }
   async show(sid, paymentMethodId, filters) {
-    const raw = await this.transport.request("GET", "payment-method/show", this.envelope({ sid, payment_method_id: paymentMethodId }, filters));
+    const raw = await this.transport.request(
+      "GET",
+      "payment-method/show",
+      this.envelope({ sid, payment_method_id: paymentMethodId }, filters)
+    );
     return PaymentMethod.fromRaw(raw["data"] ?? {});
   }
   async create(sid, attributes) {
-    const raw = await this.transport.request("POST", "payment-method/create", this.envelope({ sid, ...attributes }));
+    const raw = await this.transport.request(
+      "POST",
+      "payment-method/create",
+      this.envelope({ sid, ...attributes })
+    );
     return PaymentMethod.fromRaw(raw["data"] ?? {});
   }
   async update(sid, attributes) {
-    const raw = await this.transport.request("PATCH", "payment-method/update", this.envelope({ sid, ...attributes }));
+    const raw = await this.transport.request(
+      "PATCH",
+      "payment-method/update",
+      this.envelope({ sid, ...attributes })
+    );
     return PaymentMethod.fromRaw(raw["data"] ?? {});
   }
   async delete(sid, paymentMethodId, uuid) {
-    const raw = await this.transport.request("POST", "payment-method/delete", this.envelope({ sid, payment_method_id: paymentMethodId, uuid }));
+    const raw = await this.transport.request(
+      "POST",
+      "payment-method/delete",
+      this.envelope({ sid, payment_method_id: paymentMethodId, uuid })
+    );
     return MessageResult.fromRaw(raw["data"] ?? raw);
   }
 };
 
+// src/data-objects/recurring-invoice.ts
+var RecurringInvoice = class _RecurringInvoice {
+  constructor(id, status, recurrenceSchedule, paymentTerms, startDate, endDate, nextRunDate, lastRunDate, customerName, thankYouNote, customer = new InvoiceCustomer(), items = [], upcomingRunDates = [], invoices = [], coverFeeRequired = false) {
+    this.id = id;
+    this.status = status;
+    this.recurrenceSchedule = recurrenceSchedule;
+    this.paymentTerms = paymentTerms;
+    this.startDate = startDate;
+    this.endDate = endDate;
+    this.nextRunDate = nextRunDate;
+    this.lastRunDate = lastRunDate;
+    this.customerName = customerName;
+    this.thankYouNote = thankYouNote;
+    this.customer = customer;
+    this.items = items;
+    this.upcomingRunDates = upcomingRunDates;
+    this.invoices = invoices;
+    this.coverFeeRequired = coverFeeRequired;
+  }
+  id;
+  status;
+  recurrenceSchedule;
+  paymentTerms;
+  startDate;
+  endDate;
+  nextRunDate;
+  lastRunDate;
+  customerName;
+  thankYouNote;
+  customer;
+  items;
+  upcomingRunDates;
+  invoices;
+  coverFeeRequired;
+  static fromRaw(data) {
+    const runDates = data["upcoming_run_dates"];
+    return new _RecurringInvoice(
+      arrInt(data, "id"),
+      arrString(data, "status"),
+      arrString(data, "recurrence_schedule"),
+      arrString(data, "payment_terms"),
+      arrString(data, "start_date"),
+      arrString(data, "end_date"),
+      arrString(data, "next_run_date"),
+      arrString(data, "last_run_date"),
+      arrString(data, "customer_name"),
+      arrString(data, "thank_you_note"),
+      InvoiceCustomer.fromRaw(arrObjectFrom(data, ["customer"])),
+      arrArrayFrom(data, "items").map(InvoiceLineItem.fromRaw),
+      Array.isArray(runDates) ? runDates.map((d) => String(d)) : [],
+      arrArrayFrom(data, "invoices").map(Invoice.fromRaw),
+      arrBool(data, "cover_fee_required")
+    );
+  }
+};
+
+// src/resources/recurring-invoices.ts
+var RecurringInvoices = class extends AbstractResource {
+  /**
+   * List recurring-invoice templates.
+   *
+   * @param filters `status` — Active | Paused | Cancelled | Completed
+   */
+  async list(sid, filters = {}) {
+    return this.paginate(
+      "GET",
+      "recurring-invoices",
+      this.envelope({ sid }, filters),
+      RecurringInvoice.fromRaw
+    );
+  }
+  async show(sid, recurringInvoiceId) {
+    const raw = await this.transport.request(
+      "GET",
+      "recurring-invoice",
+      this.envelope({ sid, recurring_invoice_id: recurringInvoiceId })
+    );
+    return RecurringInvoice.fromRaw(raw["data"] ?? {});
+  }
+  /**
+   * Create a recurring-invoice template. When `recurring_start_date` is today the
+   * first invoice is generated and sent immediately.
+   *
+   * @param attributes
+   *   `customer_uuid` (or `customer_id`), `payment_terms` (`due_on_receipt` |
+   *   `net_15` | `net_30` | `net_60`), `recurring_frequency` (`Weekly` |
+   *   `Biweekly` | `FirstFifteenth` | `Monthly` | `Yearly`),
+   *   `recurring_start_date` (Y-m-d) and `lines` are required. Optional:
+   *   `recurring_end_date` (Y-m-d, on or after the start date),
+   *   `thank_you_note`.
+   *
+   *   `cover_fee_required` makes the customer cover the processing fee on every
+   *   invoice this template generates.
+   */
+  async create(sid, attributes) {
+    const raw = await this.transport.request(
+      "POST",
+      "recurring-invoice/create",
+      this.envelope({ sid, ...attributes })
+    );
+    return RecurringInvoice.fromRaw(raw["data"] ?? {});
+  }
+  async cancel(sid, recurringInvoiceId) {
+    const raw = await this.transport.request(
+      "POST",
+      "recurring-invoice/cancel",
+      this.envelope({ sid, recurring_invoice_id: recurringInvoiceId })
+    );
+    return RecurringInvoice.fromRaw(raw["data"] ?? {});
+  }
+};
+
 // src/data-objects/recurring-payment-method.ts
 var RecurringPaymentMethod = class _RecurringPaymentMethod {
   constructor(id, type, lastFour, expiration, zip, nameOnCard, bankAccountName, routingNumber, accountNumber, ownershipType, accountType, bankName) {
@@ -1036,34 +1685,71 @@ var RecurringPayment = class _RecurringPayment {
 // src/resources/recurring-payments.ts
 var RecurringPayments = class extends AbstractResource {
   async list(sid, filters = {}) {
-    return this.paginate("GET", "recurring-payment/list", this.envelope({ sid }, filters), RecurringPayment.fromRaw);
+    return this.paginate(
+      "GET",
+      "recurring-payment/list",
+      this.envelope({ sid }, filters),
+      RecurringPayment.fromRaw
+    );
   }
   async show(sid, recurringPaymentId) {
-    const raw = await this.transport.request("GET", "recurring-payment/show", this.envelope({ sid, recurring_payment_id: recurringPaymentId }));
+    const raw = await this.transport.request(
+      "GET",
+      "recurring-payment/show",
+      this.envelope({ sid, recurring_payment_id: recurringPaymentId })
+    );
     return RecurringPayment.fromRaw(raw["data"] ?? {});
   }
   async create(sid, attributes) {
-    const raw = await this.transport.request("POST", "recurring-payment/create", this.envelope({ sid, ...attributes }));
+    const raw = await this.transport.request(
+      "POST",
+      "recurring-payment/create",
+      this.envelope({ sid, ...attributes })
+    );
     return RecurringPayment.fromRaw(raw["data"] ?? {});
   }
   async edit(sid, recurringPaymentId, attributes) {
-    const raw = await this.transport.request("PATCH", "recurring-payment/edit", this.envelope({ sid, recurring_payment_id: recurringPaymentId, ...attributes }));
+    const raw = await this.transport.request(
+      "PATCH",
+      "recurring-payment/edit",
+      this.envelope({ sid, recurring_payment_id: recurringPaymentId, ...attributes })
+    );
     return RecurringPayment.fromRaw(raw["data"] ?? {});
   }
   async pause(sid, recurringPaymentId, pauseUntilDate) {
-    const raw = await this.transport.request("PATCH", "recurring-payment/pause", this.envelope({ sid, recurring_payment_id: recurringPaymentId, pause_until_date: pauseUntilDate }));
+    const raw = await this.transport.request(
+      "PATCH",
+      "recurring-payment/pause",
+      this.envelope({
+        sid,
+        recurring_payment_id: recurringPaymentId,
+        pause_until_date: pauseUntilDate
+      })
+    );
     return RecurringPayment.fromRaw(raw["data"] ?? {});
   }
   async cancel(sid, recurringPaymentId) {
-    const raw = await this.transport.request("PATCH", "recurring-payment/cancel", this.envelope({ sid, recurring_payment_id: recurringPaymentId }));
+    const raw = await this.transport.request(
+      "PATCH",
+      "recurring-payment/cancel",
+      this.envelope({ sid, recurring_payment_id: recurringPaymentId })
+    );
     return RecurringPayment.fromRaw(raw["data"] ?? {});
   }
   async activate(sid, recurringPaymentId) {
-    const raw = await this.transport.request("PATCH", "recurring-payment/activate", this.envelope({ sid, recurring_payment_id: recurringPaymentId }));
+    const raw = await this.transport.request(
+      "PATCH",
+      "recurring-payment/activate",
+      this.envelope({ sid, recurring_payment_id: recurringPaymentId })
+    );
     return RecurringPayment.fromRaw(raw["data"] ?? {});
   }
   async delete(sid, recurringPaymentId) {
-    const raw = await this.transport.request("POST", "recurring-payment/delete", this.envelope({ sid, recurring_payment_id: recurringPaymentId }));
+    const raw = await this.transport.request(
+      "POST",
+      "recurring-payment/delete",
+      this.envelope({ sid, recurring_payment_id: recurringPaymentId })
+    );
     return MessageResult.fromRaw(raw["data"] ?? raw);
   }
 };
@@ -1082,35 +1768,68 @@ var TokenizeResult = class _TokenizeResult {
 // src/resources/transactions.ts
 var Transactions = class extends AbstractResource {
   async list(sid, filters = {}) {
-    return this.paginate("GET", "transactions", this.envelope({ sid }, filters), Transaction.fromRaw);
+    return this.paginate(
+      "GET",
+      "transactions",
+      this.envelope({ sid }, filters),
+      Transaction.fromRaw
+    );
   }
   async show(sid, identifier) {
-    const raw = await this.transport.request("GET", "transaction", this.envelope({ sid, ...identifier }));
+    const raw = await this.transport.request(
+      "GET",
+      "transaction",
+      this.envelope({ sid, ...identifier })
+    );
     return Transaction.fromRaw(raw["data"] ?? {});
   }
   async chargeCard(sid, attributes) {
-    const raw = await this.transport.request("POST", "transaction/charge-card", this.envelope({ sid, ...attributes }));
+    const raw = await this.transport.request(
+      "POST",
+      "transaction/charge-card",
+      this.envelope({ sid, ...attributes })
+    );
     return Transaction.fromRaw(raw["data"] ?? {});
   }
   /** @deprecated The API marks this deprecated; prefer chargeCard() with a token. */
   async chargeCardToken(sid, attributes) {
-    const raw = await this.transport.request("POST", "transaction/charge-card-token", this.envelope({ sid, ...attributes }));
+    const raw = await this.transport.request(
+      "POST",
+      "transaction/charge-card-token",
+      this.envelope({ sid, ...attributes })
+    );
     return Transaction.fromRaw(raw["data"] ?? {});
   }
   async chargeAch(sid, attributes) {
-    const raw = await this.transport.request("POST", "transaction/charge-ach", this.envelope({ sid, ...attributes }));
+    const raw = await this.transport.request(
+      "POST",
+      "transaction/charge-ach",
+      this.envelope({ sid, ...attributes })
+    );
     return Transaction.fromRaw(raw["data"] ?? {});
   }
   async tokenizeCard(sid, attributes) {
-    const raw = await this.transport.request("POST", "transaction/tokenize-card", this.envelope({ sid, ...attributes }));
+    const raw = await this.transport.request(
+      "POST",
+      "transaction/tokenize-card",
+      this.envelope({ sid, ...attributes })
+    );
     return TokenizeResult.fromRaw(raw["data"] ?? {});
   }
   async refund(sid, attributes) {
-    const raw = await this.transport.request("POST", "transaction/refund", this.envelope({ sid, ...attributes }));
+    const raw = await this.transport.request(
+      "POST",
+      "transaction/refund",
+      this.envelope({ sid, ...attributes })
+    );
     return MessageResult.fromRaw(raw["data"] ?? raw);
   }
   async void(sid, transactionType, transactionId) {
-    const raw = await this.transport.request("PATCH", "transaction/void", this.envelope({ sid, transaction_type: transactionType, transaction_id: transactionId }));
+    const raw = await this.transport.request(
+      "PATCH",
+      "transaction/void",
+      this.envelope({ sid, transaction_type: transactionType, transaction_id: transactionId })
+    );
     return MessageResult.fromRaw(raw["data"] ?? raw);
   }
 };
@@ -1124,6 +1843,8 @@ var Client = class {
   addresses;
   deposits;
   recurringPayments;
+  invoices;
+  recurringInvoices;
   _config;
   constructor(token, baseUrl = DEFAULT_BASE_URL) {
     this._config = token instanceof Config ? token : new Config(token, baseUrl);
@@ -1135,6 +1856,8 @@ var Client = class {
     this.addresses = new Addresses(transport);
     this.deposits = new Deposits(transport);
     this.recurringPayments = new RecurringPayments(transport);
+    this.invoices = new Invoices(transport);
+    this.recurringInvoices = new RecurringInvoices(transport);
   }
   config() {
     return this._config;
@@ -1147,6 +1870,7 @@ export {
   Client,
   Config,
   ConnectionException,
+  CoverFeeQuote,
   CursorPage,
   Customer,
   DEFAULT_BASE_URL,
@@ -1155,12 +1879,20 @@ export {
   DepositWithTransactions,
   DimeException,
   FormLink,
+  Invoice,
+  InvoiceCustomer,
+  InvoiceEvent,
+  InvoiceItem,
+  InvoiceLineItem,
+  InvoiceLink,
+  InvoicePayment,
   Merchant,
   MessageResult,
   NotFoundException,
   PaymentMethod,
   PermissionDeniedException,
   RateLimitException,
+  RecurringInvoice,
   RecurringPayment,
   RecurringPaymentMethod,
   ServerException,