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

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 declare const DEFAULT_BASE_URL = "https://app.dimepayments.com";
-declare const VERSION = "1.2.0";
+declare const VERSION = "1.3.0";
 interface ConfigOptions {
     /** Sanctum personal access token (sent as Bearer). */
     token: string;
@@ -28,7 +28,7 @@ declare class Config {
     baseUri(): string;
 }
 
-type Raw$w = Record<string, unknown>;
+type Raw$x = Record<string, unknown>;
 declare class Address {
     readonly id?: number | undefined;
     readonly recipient?: string | undefined;
@@ -39,14 +39,14 @@ declare class Address {
     readonly state?: string | undefined;
     readonly zip?: string | undefined;
     constructor(id?: number | undefined, recipient?: string | undefined, lineOne?: string | undefined, lineTwo?: string | undefined, lineThree?: string | undefined, city?: string | undefined, state?: string | undefined, zip?: string | undefined);
-    static fromRaw(data: Raw$w): Address;
+    static fromRaw(data: Raw$x): Address;
 }
 
-type Raw$v = Record<string, unknown>;
+type Raw$w = Record<string, unknown>;
 declare class MessageResult {
     readonly message?: string | undefined;
     constructor(message?: string | undefined);
-    static fromRaw(data: Raw$v): MessageResult;
+    static fromRaw(data: Raw$w): MessageResult;
 }
 
 type PageFetcher<T> = (cursor: string) => Promise<CursorPage<T>>;
@@ -66,7 +66,7 @@ declare class CursorPage<T> {
     get length(): number;
 }
 
-type Raw$u = Record<string, unknown>;
+type Raw$v = Record<string, unknown>;
 declare class Transport {
     private readonly config;
     private readonly fetchFn;
@@ -81,32 +81,32 @@ declare class Transport {
      * serialised into the query string (`data[sid]=…&filters[status]=…`) and no
      * body is sent; every other method sends the envelope as a JSON body.
      */
-    request(method: string, path: string, body?: Raw$u, query?: Record<string, string>): Promise<Raw$u>;
+    request(method: string, path: string, body?: Raw$v, query?: Record<string, string>): Promise<Raw$v>;
     private attempt;
     private sleep;
 }
 
-type Raw$t = Record<string, unknown>;
+type Raw$u = Record<string, unknown>;
 declare abstract class AbstractResource {
     protected readonly transport: Transport;
     constructor(transport: Transport);
     /**
      * Build the standard Dime request envelope, dropping null/undefined values.
      */
-    protected envelope(data?: Raw$t, filters?: Raw$t): Raw$t;
-    protected paginate<T>(method: string, path: string, body: Raw$t, map: (item: Raw$t) => T, query?: Record<string, string>): Promise<CursorPage<T>>;
+    protected envelope(data?: Raw$u, filters?: Raw$u): Raw$u;
+    protected paginate<T>(method: string, path: string, body: Raw$u, map: (item: Raw$u) => T, query?: Record<string, string>): Promise<CursorPage<T>>;
 }
 
-type Raw$s = Record<string, unknown>;
+type Raw$t = Record<string, unknown>;
 declare class Addresses extends AbstractResource {
     list(sid: string, uuid: string): Promise<CursorPage<Address>>;
     show(sid: string, uuid: string, addressId: number | string): Promise<Address>;
-    create(sid: string, uuid: string, attributes: Raw$s): Promise<Address>;
-    update(sid: string, uuid: string, addressId: number | string, attributes: Raw$s): Promise<Address>;
+    create(sid: string, uuid: string, attributes: Raw$t): Promise<Address>;
+    update(sid: string, uuid: string, addressId: number | string, attributes: Raw$t): Promise<Address>;
     delete(sid: string, uuid: string, addressId: number | string): Promise<MessageResult>;
 }
 
-type Raw$r = Record<string, unknown>;
+type Raw$s = Record<string, unknown>;
 declare class Customer {
     readonly uuid?: string | undefined;
     readonly firstName?: string | undefined;
@@ -121,19 +121,19 @@ declare class Customer {
     readonly zip?: string | undefined;
     readonly country?: string | undefined;
     constructor(uuid?: string | undefined, firstName?: string | undefined, lastName?: string | undefined, phone?: string | undefined, email?: string | undefined, addr1?: string | undefined, addr2?: string | undefined, addr3?: string | undefined, city?: string | undefined, state?: string | undefined, zip?: string | undefined, country?: string | undefined);
-    static fromRaw(data: Raw$r): Customer;
+    static fromRaw(data: Raw$s): Customer;
 }
 
-type Raw$q = Record<string, unknown>;
+type Raw$r = Record<string, unknown>;
 declare class Customers extends AbstractResource {
-    list(sid: string, filters?: Raw$q): Promise<CursorPage<Customer>>;
-    show(sid: string, filters: Raw$q): Promise<Customer>;
-    create(sid: string, attributes: Raw$q): Promise<Customer>;
-    update(sid: string, filters: Raw$q, attributes: Raw$q): Promise<Customer>;
-    delete(sid: string, filters: Raw$q): Promise<MessageResult>;
+    list(sid: string, filters?: Raw$r): Promise<CursorPage<Customer>>;
+    show(sid: string, filters: Raw$r): Promise<Customer>;
+    create(sid: string, attributes: Raw$r): Promise<Customer>;
+    update(sid: string, filters: Raw$r, attributes: Raw$r): Promise<Customer>;
+    delete(sid: string, filters: Raw$r): Promise<MessageResult>;
 }
 
-type Raw$p = Record<string, unknown>;
+type Raw$q = Record<string, unknown>;
 declare class Deposit {
     readonly transactionDate?: string | undefined;
     readonly fundDate?: string | undefined;
@@ -145,10 +145,10 @@ declare class Deposit {
     readonly sweepId?: string | undefined;
     readonly type?: string | undefined;
     constructor(transactionDate?: string | undefined, fundDate?: string | undefined, transactionInfoId?: string | undefined, transactionId?: string | undefined, transactionDetailAccount?: string | undefined, authorizationAmount?: string | undefined, netAmount?: string | undefined, sweepId?: string | undefined, type?: string | undefined);
-    static fromRaw(data: Raw$p): Deposit;
+    static fromRaw(data: Raw$q): Deposit;
 }
 
-type Raw$o = Record<string, unknown>;
+type Raw$p = Record<string, unknown>;
 declare class TransactionAddress {
     readonly firstName?: string | undefined;
     readonly lastName?: string | undefined;
@@ -158,10 +158,10 @@ declare class TransactionAddress {
     readonly state?: string | undefined;
     readonly zip?: string | undefined;
     constructor(firstName?: string | undefined, lastName?: string | undefined, addr1?: string | undefined, addr2?: string | undefined, city?: string | undefined, state?: string | undefined, zip?: string | undefined);
-    static fromRaw(data: Raw$o): TransactionAddress;
+    static fromRaw(data: Raw$p): TransactionAddress;
 }
 
-type Raw$n = Record<string, unknown>;
+type Raw$o = Record<string, unknown>;
 declare class Transaction {
     readonly transactionType?: string | undefined;
     readonly transactionStatus?: string | undefined;
@@ -184,10 +184,10 @@ declare class Transaction {
     readonly billingAddress: TransactionAddress;
     readonly shippingAddress: TransactionAddress;
     constructor(transactionType?: string | undefined, transactionStatus?: string | undefined, transactionStatusDescription?: string | undefined, transactionNumber?: string | undefined, transactionDate?: string | undefined, fundDate?: string | undefined, settleDate?: string | undefined, amount?: string | undefined, description?: string | undefined, statusCode?: string | undefined, statusText?: string | undefined, email?: string | undefined, phone?: string | undefined, customerUuid?: string | undefined, multiUseToken?: string | undefined, pending?: boolean, transactionInfoId?: string | undefined, parentTransactionInfoId?: string | undefined, billingAddress?: TransactionAddress, shippingAddress?: TransactionAddress);
-    static fromRaw(data: Raw$n): Transaction;
+    static fromRaw(data: Raw$o): Transaction;
 }
 
-type Raw$m = Record<string, unknown>;
+type Raw$n = Record<string, unknown>;
 declare class DepositWithTransactions {
     readonly sid?: string | undefined;
     readonly transactionInfoId?: string | undefined;
@@ -199,23 +199,52 @@ declare class DepositWithTransactions {
     readonly transTotal?: string | undefined;
     readonly transactions: Transaction[];
     constructor(sid?: string | undefined, transactionInfoId?: string | undefined, transactionId?: string | undefined, transactionDate?: string | undefined, fundDate?: string | undefined, type?: string | undefined, countOfTransactions?: number | undefined, transTotal?: string | undefined, transactions?: Transaction[]);
-    static fromRaw(data: Raw$m): DepositWithTransactions;
+    static fromRaw(data: Raw$n): DepositWithTransactions;
 }
 
-type Raw$l = Record<string, unknown>;
+type Raw$m = Record<string, unknown>;
 declare class DepositGroup {
     readonly sid?: string | undefined;
     readonly count?: number | undefined;
     readonly deposits: DepositWithTransactions[];
     constructor(sid?: string | undefined, count?: number | undefined, deposits?: DepositWithTransactions[]);
-    static fromRaw(data: Raw$l): DepositGroup;
+    static fromRaw(data: Raw$m): DepositGroup;
 }
 
-type Raw$k = Record<string, unknown>;
+type Raw$l = Record<string, unknown>;
 declare class Deposits extends AbstractResource {
-    list(sid: string, filters?: Raw$k): Promise<CursorPage<Deposit>>;
-    listWithTransactions(sid: string, filters: Raw$k): Promise<DepositGroup>;
-    show(sid: string, identifier: Raw$k): Promise<DepositWithTransactions>;
+    list(sid: string, filters?: Raw$l): Promise<CursorPage<Deposit>>;
+    listWithTransactions(sid: string, filters: Raw$l): Promise<DepositGroup>;
+    show(sid: string, identifier: Raw$l): Promise<DepositWithTransactions>;
+}
+
+type Raw$k = Record<string, unknown>;
+/**
+ * The processing fee a cover-fee invoice adds on top of what the customer pays,
+ * quoted for both payment methods.
+ *
+ * Present on an {@link Invoice} only when `coverFeeRequired` is true. The fee is
+ * NOT a line item and is NOT part of the invoice's `total`: the merchant is owed
+ * `total`, and the customer is charged `total` plus this fee. Card and ACH rates
+ * differ, so the amount depends on how the customer chooses to pay — `ccTotal` is
+ * the higher of the two and what the invoice and its emails lead with.
+ *
+ * `basis` names what the quote was computed against — currently always `balance`,
+ * the amount still outstanding. Paying a partial amount re-quotes the fee against
+ * that amount, so treat these as a quote for settling in full today rather than a
+ * fixed charge.
+ *
+ * Monetary values are kept as strings to avoid float rounding.
+ */
+declare class CoverFeeQuote {
+    readonly basis?: string | undefined;
+    readonly base?: string | undefined;
+    readonly ccFee?: string | undefined;
+    readonly ccTotal?: string | undefined;
+    readonly achFee?: string | undefined;
+    readonly achTotal?: string | undefined;
+    constructor(basis?: string | undefined, base?: string | undefined, ccFee?: string | undefined, ccTotal?: string | undefined, achFee?: string | undefined, achTotal?: string | undefined);
+    static fromRaw(data: Raw$k): CoverFeeQuote;
 }
 
 type Raw$j = Record<string, unknown>;
@@ -251,12 +280,20 @@ declare class InvoiceLineItem {
 }
 
 type Raw$g = Record<string, unknown>;
+/**
+ * A payment recorded against an invoice.
+ *
+ * `amount` is what was credited to the invoice; `coverFee` is the processing fee
+ * charged on top of it, so `amount + coverFee` is what the customer actually paid.
+ * It is zero unless the invoice required the customer to cover fees.
+ */
 declare class InvoicePayment {
     readonly amount?: string | undefined;
     readonly paidAt?: string | undefined;
     readonly method?: string | undefined;
     readonly transactionId?: string | undefined;
-    constructor(amount?: string | undefined, paidAt?: string | undefined, method?: string | undefined, transactionId?: string | undefined);
+    readonly coverFee?: string | undefined;
+    constructor(amount?: string | undefined, paidAt?: string | undefined, method?: string | undefined, transactionId?: string | undefined, coverFee?: string | undefined);
     static fromRaw(data: Raw$g): InvoicePayment;
 }
 
@@ -283,7 +320,9 @@ declare class Invoice {
     readonly items: InvoiceLineItem[];
     readonly payments: InvoicePayment[];
     readonly events: InvoiceEvent[];
-    constructor(id?: number | undefined, invoiceNumber?: string | undefined, status?: string | undefined, token?: string | undefined, paymentTerms?: string | undefined, issueDate?: string | undefined, dueDate?: string | undefined, isOverdue?: boolean, subtotal?: string | undefined, total?: string | undefined, amountPaid?: string | undefined, balance?: string | undefined, allowPartialPayment?: boolean, thankYouNote?: string | undefined, customerName?: string | undefined, customerEmail?: string | undefined, publicUrl?: string | undefined, customer?: InvoiceCustomer, items?: InvoiceLineItem[], payments?: InvoicePayment[], events?: InvoiceEvent[]);
+    readonly coverFeeRequired: boolean;
+    readonly coverFeeQuote?: CoverFeeQuote | undefined;
+    constructor(id?: number | undefined, invoiceNumber?: string | undefined, status?: string | undefined, token?: string | undefined, paymentTerms?: string | undefined, issueDate?: string | undefined, dueDate?: string | undefined, isOverdue?: boolean, subtotal?: string | undefined, total?: string | undefined, amountPaid?: string | undefined, balance?: string | undefined, allowPartialPayment?: boolean, thankYouNote?: string | undefined, customerName?: string | undefined, customerEmail?: string | undefined, publicUrl?: string | undefined, customer?: InvoiceCustomer, items?: InvoiceLineItem[], payments?: InvoicePayment[], events?: InvoiceEvent[], coverFeeRequired?: boolean, coverFeeQuote?: CoverFeeQuote | undefined);
     static fromRaw(data: Raw$f): Invoice;
 }
 
@@ -337,7 +376,13 @@ declare class Invoices extends AbstractResource {
      *   `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`,
-     *   `reminder_settings`.
+     *   `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.
      */
     create(sid: string, attributes: Raw$c): Promise<Invoice>;
     /**
@@ -366,6 +411,12 @@ declare class Invoices extends AbstractResource {
      *   `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`.
      */
     pay(sid: string, invoiceId: number | string, attributes: Raw$c): Promise<Invoice>;
     /** Get the public pay link (and token) for an invoice. */
@@ -498,7 +549,8 @@ declare class RecurringInvoice {
     readonly items: InvoiceLineItem[];
     readonly upcomingRunDates: string[];
     readonly invoices: Invoice[];
-    constructor(id?: number | undefined, status?: string | undefined, recurrenceSchedule?: string | undefined, paymentTerms?: string | undefined, startDate?: string | undefined, endDate?: string | undefined, nextRunDate?: string | undefined, lastRunDate?: string | undefined, customerName?: string | undefined, thankYouNote?: string | undefined, customer?: InvoiceCustomer, items?: InvoiceLineItem[], upcomingRunDates?: string[], invoices?: Invoice[]);
+    readonly coverFeeRequired: boolean;
+    constructor(id?: number | undefined, status?: string | undefined, recurrenceSchedule?: string | undefined, paymentTerms?: string | undefined, startDate?: string | undefined, endDate?: string | undefined, nextRunDate?: string | undefined, lastRunDate?: string | undefined, customerName?: string | undefined, thankYouNote?: string | undefined, customer?: InvoiceCustomer, items?: InvoiceLineItem[], upcomingRunDates?: string[], invoices?: Invoice[], coverFeeRequired?: boolean);
     static fromRaw(data: Raw$6): RecurringInvoice;
 }
 
@@ -527,6 +579,9 @@ declare class RecurringInvoices extends AbstractResource {
      *   `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.
      */
     create(sid: string, attributes: Raw$5): Promise<RecurringInvoice>;
     cancel(sid: string, recurringInvoiceId: number | string): Promise<RecurringInvoice>;
@@ -670,4 +725,4 @@ declare class ServerException extends DimeException {
 declare class ConnectionException extends DimeException {
 }
 
-export { Address, ApiException, AuthenticationException, Client, Config, ConnectionException, CursorPage, Customer, DEFAULT_BASE_URL, Deposit, DepositGroup, DepositWithTransactions, DimeException, FormLink, Invoice, InvoiceCustomer, InvoiceEvent, InvoiceItem, InvoiceLineItem, InvoiceLink, InvoicePayment, Merchant, MessageResult, NotFoundException, PaymentMethod, PermissionDeniedException, RateLimitException, RecurringInvoice, RecurringPayment, RecurringPaymentMethod, ServerException, TokenizeResult, Transaction, TransactionAddress, VERSION, ValidationException };
+export { Address, ApiException, AuthenticationException, Client, Config, ConnectionException, CoverFeeQuote, CursorPage, Customer, DEFAULT_BASE_URL, Deposit, DepositGroup, DepositWithTransactions, DimeException, FormLink, Invoice, InvoiceCustomer, InvoiceEvent, InvoiceItem, InvoiceLineItem, InvoiceLink, InvoicePayment, Merchant, MessageResult, NotFoundException, PaymentMethod, PermissionDeniedException, RateLimitException, RecurringInvoice, RecurringPayment, RecurringPaymentMethod, ServerException, TokenizeResult, Transaction, TransactionAddress, VERSION, ValidationException };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 declare const DEFAULT_BASE_URL = "https://app.dimepayments.com";
-declare const VERSION = "1.2.0";
+declare const VERSION = "1.3.0";
 interface ConfigOptions {
     /** Sanctum personal access token (sent as Bearer). */
     token: string;
@@ -28,7 +28,7 @@ declare class Config {
     baseUri(): string;
 }
 
-type Raw$w = Record<string, unknown>;
+type Raw$x = Record<string, unknown>;
 declare class Address {
     readonly id?: number | undefined;
     readonly recipient?: string | undefined;
@@ -39,14 +39,14 @@ declare class Address {
     readonly state?: string | undefined;
     readonly zip?: string | undefined;
     constructor(id?: number | undefined, recipient?: string | undefined, lineOne?: string | undefined, lineTwo?: string | undefined, lineThree?: string | undefined, city?: string | undefined, state?: string | undefined, zip?: string | undefined);
-    static fromRaw(data: Raw$w): Address;
+    static fromRaw(data: Raw$x): Address;
 }
 
-type Raw$v = Record<string, unknown>;
+type Raw$w = Record<string, unknown>;
 declare class MessageResult {
     readonly message?: string | undefined;
     constructor(message?: string | undefined);
-    static fromRaw(data: Raw$v): MessageResult;
+    static fromRaw(data: Raw$w): MessageResult;
 }
 
 type PageFetcher<T> = (cursor: string) => Promise<CursorPage<T>>;
@@ -66,7 +66,7 @@ declare class CursorPage<T> {
     get length(): number;
 }
 
-type Raw$u = Record<string, unknown>;
+type Raw$v = Record<string, unknown>;
 declare class Transport {
     private readonly config;
     private readonly fetchFn;
@@ -81,32 +81,32 @@ declare class Transport {
      * serialised into the query string (`data[sid]=…&filters[status]=…`) and no
      * body is sent; every other method sends the envelope as a JSON body.
      */
-    request(method: string, path: string, body?: Raw$u, query?: Record<string, string>): Promise<Raw$u>;
+    request(method: string, path: string, body?: Raw$v, query?: Record<string, string>): Promise<Raw$v>;
     private attempt;
     private sleep;
 }
 
-type Raw$t = Record<string, unknown>;
+type Raw$u = Record<string, unknown>;
 declare abstract class AbstractResource {
     protected readonly transport: Transport;
     constructor(transport: Transport);
     /**
      * Build the standard Dime request envelope, dropping null/undefined values.
      */
-    protected envelope(data?: Raw$t, filters?: Raw$t): Raw$t;
-    protected paginate<T>(method: string, path: string, body: Raw$t, map: (item: Raw$t) => T, query?: Record<string, string>): Promise<CursorPage<T>>;
+    protected envelope(data?: Raw$u, filters?: Raw$u): Raw$u;
+    protected paginate<T>(method: string, path: string, body: Raw$u, map: (item: Raw$u) => T, query?: Record<string, string>): Promise<CursorPage<T>>;
 }
 
-type Raw$s = Record<string, unknown>;
+type Raw$t = Record<string, unknown>;
 declare class Addresses extends AbstractResource {
     list(sid: string, uuid: string): Promise<CursorPage<Address>>;
     show(sid: string, uuid: string, addressId: number | string): Promise<Address>;
-    create(sid: string, uuid: string, attributes: Raw$s): Promise<Address>;
-    update(sid: string, uuid: string, addressId: number | string, attributes: Raw$s): Promise<Address>;
+    create(sid: string, uuid: string, attributes: Raw$t): Promise<Address>;
+    update(sid: string, uuid: string, addressId: number | string, attributes: Raw$t): Promise<Address>;
     delete(sid: string, uuid: string, addressId: number | string): Promise<MessageResult>;
 }
 
-type Raw$r = Record<string, unknown>;
+type Raw$s = Record<string, unknown>;
 declare class Customer {
     readonly uuid?: string | undefined;
     readonly firstName?: string | undefined;
@@ -121,19 +121,19 @@ declare class Customer {
     readonly zip?: string | undefined;
     readonly country?: string | undefined;
     constructor(uuid?: string | undefined, firstName?: string | undefined, lastName?: string | undefined, phone?: string | undefined, email?: string | undefined, addr1?: string | undefined, addr2?: string | undefined, addr3?: string | undefined, city?: string | undefined, state?: string | undefined, zip?: string | undefined, country?: string | undefined);
-    static fromRaw(data: Raw$r): Customer;
+    static fromRaw(data: Raw$s): Customer;
 }
 
-type Raw$q = Record<string, unknown>;
+type Raw$r = Record<string, unknown>;
 declare class Customers extends AbstractResource {
-    list(sid: string, filters?: Raw$q): Promise<CursorPage<Customer>>;
-    show(sid: string, filters: Raw$q): Promise<Customer>;
-    create(sid: string, attributes: Raw$q): Promise<Customer>;
-    update(sid: string, filters: Raw$q, attributes: Raw$q): Promise<Customer>;
-    delete(sid: string, filters: Raw$q): Promise<MessageResult>;
+    list(sid: string, filters?: Raw$r): Promise<CursorPage<Customer>>;
+    show(sid: string, filters: Raw$r): Promise<Customer>;
+    create(sid: string, attributes: Raw$r): Promise<Customer>;
+    update(sid: string, filters: Raw$r, attributes: Raw$r): Promise<Customer>;
+    delete(sid: string, filters: Raw$r): Promise<MessageResult>;
 }
 
-type Raw$p = Record<string, unknown>;
+type Raw$q = Record<string, unknown>;
 declare class Deposit {
     readonly transactionDate?: string | undefined;
     readonly fundDate?: string | undefined;
@@ -145,10 +145,10 @@ declare class Deposit {
     readonly sweepId?: string | undefined;
     readonly type?: string | undefined;
     constructor(transactionDate?: string | undefined, fundDate?: string | undefined, transactionInfoId?: string | undefined, transactionId?: string | undefined, transactionDetailAccount?: string | undefined, authorizationAmount?: string | undefined, netAmount?: string | undefined, sweepId?: string | undefined, type?: string | undefined);
-    static fromRaw(data: Raw$p): Deposit;
+    static fromRaw(data: Raw$q): Deposit;
 }
 
-type Raw$o = Record<string, unknown>;
+type Raw$p = Record<string, unknown>;
 declare class TransactionAddress {
     readonly firstName?: string | undefined;
     readonly lastName?: string | undefined;
@@ -158,10 +158,10 @@ declare class TransactionAddress {
     readonly state?: string | undefined;
     readonly zip?: string | undefined;
     constructor(firstName?: string | undefined, lastName?: string | undefined, addr1?: string | undefined, addr2?: string | undefined, city?: string | undefined, state?: string | undefined, zip?: string | undefined);
-    static fromRaw(data: Raw$o): TransactionAddress;
+    static fromRaw(data: Raw$p): TransactionAddress;
 }
 
-type Raw$n = Record<string, unknown>;
+type Raw$o = Record<string, unknown>;
 declare class Transaction {
     readonly transactionType?: string | undefined;
     readonly transactionStatus?: string | undefined;
@@ -184,10 +184,10 @@ declare class Transaction {
     readonly billingAddress: TransactionAddress;
     readonly shippingAddress: TransactionAddress;
     constructor(transactionType?: string | undefined, transactionStatus?: string | undefined, transactionStatusDescription?: string | undefined, transactionNumber?: string | undefined, transactionDate?: string | undefined, fundDate?: string | undefined, settleDate?: string | undefined, amount?: string | undefined, description?: string | undefined, statusCode?: string | undefined, statusText?: string | undefined, email?: string | undefined, phone?: string | undefined, customerUuid?: string | undefined, multiUseToken?: string | undefined, pending?: boolean, transactionInfoId?: string | undefined, parentTransactionInfoId?: string | undefined, billingAddress?: TransactionAddress, shippingAddress?: TransactionAddress);
-    static fromRaw(data: Raw$n): Transaction;
+    static fromRaw(data: Raw$o): Transaction;
 }
 
-type Raw$m = Record<string, unknown>;
+type Raw$n = Record<string, unknown>;
 declare class DepositWithTransactions {
     readonly sid?: string | undefined;
     readonly transactionInfoId?: string | undefined;
@@ -199,23 +199,52 @@ declare class DepositWithTransactions {
     readonly transTotal?: string | undefined;
     readonly transactions: Transaction[];
     constructor(sid?: string | undefined, transactionInfoId?: string | undefined, transactionId?: string | undefined, transactionDate?: string | undefined, fundDate?: string | undefined, type?: string | undefined, countOfTransactions?: number | undefined, transTotal?: string | undefined, transactions?: Transaction[]);
-    static fromRaw(data: Raw$m): DepositWithTransactions;
+    static fromRaw(data: Raw$n): DepositWithTransactions;
 }
 
-type Raw$l = Record<string, unknown>;
+type Raw$m = Record<string, unknown>;
 declare class DepositGroup {
     readonly sid?: string | undefined;
     readonly count?: number | undefined;
     readonly deposits: DepositWithTransactions[];
     constructor(sid?: string | undefined, count?: number | undefined, deposits?: DepositWithTransactions[]);
-    static fromRaw(data: Raw$l): DepositGroup;
+    static fromRaw(data: Raw$m): DepositGroup;
 }
 
-type Raw$k = Record<string, unknown>;
+type Raw$l = Record<string, unknown>;
 declare class Deposits extends AbstractResource {
-    list(sid: string, filters?: Raw$k): Promise<CursorPage<Deposit>>;
-    listWithTransactions(sid: string, filters: Raw$k): Promise<DepositGroup>;
-    show(sid: string, identifier: Raw$k): Promise<DepositWithTransactions>;
+    list(sid: string, filters?: Raw$l): Promise<CursorPage<Deposit>>;
+    listWithTransactions(sid: string, filters: Raw$l): Promise<DepositGroup>;
+    show(sid: string, identifier: Raw$l): Promise<DepositWithTransactions>;
+}
+
+type Raw$k = Record<string, unknown>;
+/**
+ * The processing fee a cover-fee invoice adds on top of what the customer pays,
+ * quoted for both payment methods.
+ *
+ * Present on an {@link Invoice} only when `coverFeeRequired` is true. The fee is
+ * NOT a line item and is NOT part of the invoice's `total`: the merchant is owed
+ * `total`, and the customer is charged `total` plus this fee. Card and ACH rates
+ * differ, so the amount depends on how the customer chooses to pay — `ccTotal` is
+ * the higher of the two and what the invoice and its emails lead with.
+ *
+ * `basis` names what the quote was computed against — currently always `balance`,
+ * the amount still outstanding. Paying a partial amount re-quotes the fee against
+ * that amount, so treat these as a quote for settling in full today rather than a
+ * fixed charge.
+ *
+ * Monetary values are kept as strings to avoid float rounding.
+ */
+declare class CoverFeeQuote {
+    readonly basis?: string | undefined;
+    readonly base?: string | undefined;
+    readonly ccFee?: string | undefined;
+    readonly ccTotal?: string | undefined;
+    readonly achFee?: string | undefined;
+    readonly achTotal?: string | undefined;
+    constructor(basis?: string | undefined, base?: string | undefined, ccFee?: string | undefined, ccTotal?: string | undefined, achFee?: string | undefined, achTotal?: string | undefined);
+    static fromRaw(data: Raw$k): CoverFeeQuote;
 }
 
 type Raw$j = Record<string, unknown>;
@@ -251,12 +280,20 @@ declare class InvoiceLineItem {
 }
 
 type Raw$g = Record<string, unknown>;
+/**
+ * A payment recorded against an invoice.
+ *
+ * `amount` is what was credited to the invoice; `coverFee` is the processing fee
+ * charged on top of it, so `amount + coverFee` is what the customer actually paid.
+ * It is zero unless the invoice required the customer to cover fees.
+ */
 declare class InvoicePayment {
     readonly amount?: string | undefined;
     readonly paidAt?: string | undefined;
     readonly method?: string | undefined;
     readonly transactionId?: string | undefined;
-    constructor(amount?: string | undefined, paidAt?: string | undefined, method?: string | undefined, transactionId?: string | undefined);
+    readonly coverFee?: string | undefined;
+    constructor(amount?: string | undefined, paidAt?: string | undefined, method?: string | undefined, transactionId?: string | undefined, coverFee?: string | undefined);
     static fromRaw(data: Raw$g): InvoicePayment;
 }
 
@@ -283,7 +320,9 @@ declare class Invoice {
     readonly items: InvoiceLineItem[];
     readonly payments: InvoicePayment[];
     readonly events: InvoiceEvent[];
-    constructor(id?: number | undefined, invoiceNumber?: string | undefined, status?: string | undefined, token?: string | undefined, paymentTerms?: string | undefined, issueDate?: string | undefined, dueDate?: string | undefined, isOverdue?: boolean, subtotal?: string | undefined, total?: string | undefined, amountPaid?: string | undefined, balance?: string | undefined, allowPartialPayment?: boolean, thankYouNote?: string | undefined, customerName?: string | undefined, customerEmail?: string | undefined, publicUrl?: string | undefined, customer?: InvoiceCustomer, items?: InvoiceLineItem[], payments?: InvoicePayment[], events?: InvoiceEvent[]);
+    readonly coverFeeRequired: boolean;
+    readonly coverFeeQuote?: CoverFeeQuote | undefined;
+    constructor(id?: number | undefined, invoiceNumber?: string | undefined, status?: string | undefined, token?: string | undefined, paymentTerms?: string | undefined, issueDate?: string | undefined, dueDate?: string | undefined, isOverdue?: boolean, subtotal?: string | undefined, total?: string | undefined, amountPaid?: string | undefined, balance?: string | undefined, allowPartialPayment?: boolean, thankYouNote?: string | undefined, customerName?: string | undefined, customerEmail?: string | undefined, publicUrl?: string | undefined, customer?: InvoiceCustomer, items?: InvoiceLineItem[], payments?: InvoicePayment[], events?: InvoiceEvent[], coverFeeRequired?: boolean, coverFeeQuote?: CoverFeeQuote | undefined);
     static fromRaw(data: Raw$f): Invoice;
 }
 
@@ -337,7 +376,13 @@ declare class Invoices extends AbstractResource {
      *   `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`,
-     *   `reminder_settings`.
+     *   `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.
      */
     create(sid: string, attributes: Raw$c): Promise<Invoice>;
     /**
@@ -366,6 +411,12 @@ declare class Invoices extends AbstractResource {
      *   `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`.
      */
     pay(sid: string, invoiceId: number | string, attributes: Raw$c): Promise<Invoice>;
     /** Get the public pay link (and token) for an invoice. */
@@ -498,7 +549,8 @@ declare class RecurringInvoice {
     readonly items: InvoiceLineItem[];
     readonly upcomingRunDates: string[];
     readonly invoices: Invoice[];
-    constructor(id?: number | undefined, status?: string | undefined, recurrenceSchedule?: string | undefined, paymentTerms?: string | undefined, startDate?: string | undefined, endDate?: string | undefined, nextRunDate?: string | undefined, lastRunDate?: string | undefined, customerName?: string | undefined, thankYouNote?: string | undefined, customer?: InvoiceCustomer, items?: InvoiceLineItem[], upcomingRunDates?: string[], invoices?: Invoice[]);
+    readonly coverFeeRequired: boolean;
+    constructor(id?: number | undefined, status?: string | undefined, recurrenceSchedule?: string | undefined, paymentTerms?: string | undefined, startDate?: string | undefined, endDate?: string | undefined, nextRunDate?: string | undefined, lastRunDate?: string | undefined, customerName?: string | undefined, thankYouNote?: string | undefined, customer?: InvoiceCustomer, items?: InvoiceLineItem[], upcomingRunDates?: string[], invoices?: Invoice[], coverFeeRequired?: boolean);
     static fromRaw(data: Raw$6): RecurringInvoice;
 }
 
@@ -527,6 +579,9 @@ declare class RecurringInvoices extends AbstractResource {
      *   `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.
      */
     create(sid: string, attributes: Raw$5): Promise<RecurringInvoice>;
     cancel(sid: string, recurringInvoiceId: number | string): Promise<RecurringInvoice>;
@@ -670,4 +725,4 @@ declare class ServerException extends DimeException {
 declare class ConnectionException extends DimeException {
 }
 
-export { Address, ApiException, AuthenticationException, Client, Config, ConnectionException, CursorPage, Customer, DEFAULT_BASE_URL, Deposit, DepositGroup, DepositWithTransactions, DimeException, FormLink, Invoice, InvoiceCustomer, InvoiceEvent, InvoiceItem, InvoiceLineItem, InvoiceLink, InvoicePayment, Merchant, MessageResult, NotFoundException, PaymentMethod, PermissionDeniedException, RateLimitException, RecurringInvoice, RecurringPayment, RecurringPaymentMethod, ServerException, TokenizeResult, Transaction, TransactionAddress, VERSION, ValidationException };
+export { Address, ApiException, AuthenticationException, Client, Config, ConnectionException, CoverFeeQuote, CursorPage, Customer, DEFAULT_BASE_URL, Deposit, DepositGroup, DepositWithTransactions, DimeException, FormLink, Invoice, InvoiceCustomer, InvoiceEvent, InvoiceItem, InvoiceLineItem, InvoiceLink, InvoicePayment, Merchant, MessageResult, NotFoundException, PaymentMethod, PermissionDeniedException, RateLimitException, RecurringInvoice, RecurringPayment, RecurringPaymentMethod, ServerException, TokenizeResult, Transaction, TransactionAddress, VERSION, ValidationException };