@dime-technology/dime-js-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,438 @@
+declare const DEFAULT_BASE_URL = "https://app.dimepayments.com";
+declare const VERSION = "1.0.0";
+interface ConfigOptions {
+    /** Sanctum personal access token (sent as Bearer). */
+    token: string;
+    /** Base URL; defaults to https://app.dimepayments.com. */
+    baseUrl?: string;
+    /** Per-request timeout in seconds. Default 30. */
+    timeout?: number;
+    /** How many times to retry 429/5xx/network errors. Default 2. */
+    maxRetries?: number;
+    /** Base seconds for exponential backoff. Default 0.5. */
+    retryBaseDelay?: number;
+    /** Custom fetch implementation — inject a mock in tests. */
+    fetch?: typeof globalThis.fetch;
+    /** Custom sleep implementation — inject a no-op in tests to skip delays. */
+    sleep?: (ms: number) => Promise<void>;
+}
+declare class Config {
+    readonly token: string;
+    readonly baseUrl: string;
+    readonly timeout: number;
+    readonly maxRetries: number;
+    readonly retryBaseDelay: number;
+    readonly fetch?: typeof globalThis.fetch;
+    readonly sleep?: (ms: number) => Promise<void>;
+    constructor(options: ConfigOptions | string, baseUrl?: string);
+    baseUri(): string;
+}
+
+type Raw$m = Record<string, unknown>;
+declare class Address {
+    readonly id?: number | undefined;
+    readonly recipient?: string | undefined;
+    readonly lineOne?: string | undefined;
+    readonly lineTwo?: string | undefined;
+    readonly lineThree?: string | undefined;
+    readonly city?: string | undefined;
+    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$m): Address;
+}
+
+type Raw$l = Record<string, unknown>;
+declare class MessageResult {
+    readonly message?: string | undefined;
+    constructor(message?: string | undefined);
+    static fromRaw(data: Raw$l): MessageResult;
+}
+
+type PageFetcher<T> = (cursor: string) => Promise<CursorPage<T>>;
+declare class CursorPage<T> {
+    readonly data: T[];
+    readonly nextCursor?: string | undefined;
+    readonly prevCursor?: string | undefined;
+    readonly perPage?: number | undefined;
+    readonly path?: string | undefined;
+    private readonly fetcher?;
+    constructor(data: T[], nextCursor?: string | undefined, prevCursor?: string | undefined, perPage?: number | undefined, path?: string | undefined, fetcher?: PageFetcher<T> | undefined);
+    hasMore(): boolean;
+    next(): Promise<CursorPage<T> | null>;
+    /** Lazily iterate every item across all remaining pages. */
+    autoPaging(): AsyncGenerator<T>;
+    [Symbol.iterator](): Iterator<T>;
+    get length(): number;
+}
+
+type Raw$k = Record<string, unknown>;
+declare class Transport {
+    private readonly config;
+    private readonly fetchFn;
+    private readonly sleepFn;
+    constructor(config: Config);
+    /**
+     * 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.
+     */
+    request(method: string, path: string, body?: Raw$k, query?: Record<string, string>): Promise<Raw$k>;
+    private attempt;
+    private sleep;
+}
+
+type Raw$j = 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$j, filters?: Raw$j): Raw$j;
+    protected paginate<T>(method: string, path: string, body: Raw$j, map: (item: Raw$j) => T, query?: Record<string, string>): Promise<CursorPage<T>>;
+}
+
+type Raw$i = 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$i): Promise<Address>;
+    update(sid: string, uuid: string, addressId: number | string, attributes: Raw$i): Promise<Address>;
+    delete(sid: string, uuid: string, addressId: number | string): Promise<MessageResult>;
+}
+
+type Raw$h = Record<string, unknown>;
+declare class Customer {
+    readonly uuid?: string | undefined;
+    readonly firstName?: string | undefined;
+    readonly lastName?: string | undefined;
+    readonly phone?: string | undefined;
+    readonly email?: string | undefined;
+    readonly addr1?: string | undefined;
+    readonly addr2?: string | undefined;
+    readonly addr3?: string | undefined;
+    readonly city?: string | undefined;
+    readonly state?: string | undefined;
+    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$h): Customer;
+}
+
+type Raw$g = Record<string, unknown>;
+declare class Customers extends AbstractResource {
+    list(sid: string, filters?: Raw$g): Promise<CursorPage<Customer>>;
+    show(sid: string, filters: Raw$g): Promise<Customer>;
+    create(sid: string, attributes: Raw$g): Promise<Customer>;
+    update(sid: string, filters: Raw$g, attributes: Raw$g): Promise<Customer>;
+    delete(sid: string, filters: Raw$g): Promise<MessageResult>;
+}
+
+type Raw$f = Record<string, unknown>;
+declare class Deposit {
+    readonly transactionDate?: string | undefined;
+    readonly fundDate?: string | undefined;
+    readonly transactionInfoId?: string | undefined;
+    readonly transactionId?: string | undefined;
+    readonly transactionDetailAccount?: string | undefined;
+    readonly authorizationAmount?: string | undefined;
+    readonly netAmount?: string | undefined;
+    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$f): Deposit;
+}
+
+type Raw$e = Record<string, unknown>;
+declare class TransactionAddress {
+    readonly firstName?: string | undefined;
+    readonly lastName?: string | undefined;
+    readonly addr1?: string | undefined;
+    readonly addr2?: string | undefined;
+    readonly city?: string | undefined;
+    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$e): TransactionAddress;
+}
+
+type Raw$d = Record<string, unknown>;
+declare class Transaction {
+    readonly transactionType?: string | undefined;
+    readonly transactionStatus?: string | undefined;
+    readonly transactionStatusDescription?: string | undefined;
+    readonly transactionNumber?: string | undefined;
+    readonly transactionDate?: string | undefined;
+    readonly fundDate?: string | undefined;
+    readonly settleDate?: string | undefined;
+    readonly amount?: string | undefined;
+    readonly description?: string | undefined;
+    readonly statusCode?: string | undefined;
+    readonly statusText?: string | undefined;
+    readonly email?: string | undefined;
+    readonly phone?: string | undefined;
+    readonly customerUuid?: string | undefined;
+    readonly multiUseToken?: string | undefined;
+    readonly pending: boolean;
+    readonly transactionInfoId?: string | undefined;
+    readonly parentTransactionInfoId?: string | undefined;
+    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$d): Transaction;
+}
+
+type Raw$c = Record<string, unknown>;
+declare class DepositWithTransactions {
+    readonly sid?: string | undefined;
+    readonly transactionInfoId?: string | undefined;
+    readonly transactionId?: string | undefined;
+    readonly transactionDate?: string | undefined;
+    readonly fundDate?: string | undefined;
+    readonly type?: string | undefined;
+    readonly countOfTransactions?: number | undefined;
+    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$c): DepositWithTransactions;
+}
+
+type Raw$b = 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$b): DepositGroup;
+}
+
+type Raw$a = Record<string, unknown>;
+declare class Deposits extends AbstractResource {
+    list(sid: string, filters?: Raw$a): Promise<CursorPage<Deposit>>;
+    listWithTransactions(sid: string, filters: Raw$a): Promise<DepositGroup>;
+    show(sid: string, identifier: Raw$a): Promise<DepositWithTransactions>;
+}
+
+type Raw$9 = Record<string, unknown>;
+declare class FormLink {
+    readonly link?: string | undefined;
+    constructor(link?: string | undefined);
+    static fromRaw(data: Raw$9): FormLink;
+}
+
+type Raw$8 = Record<string, unknown>;
+declare class Merchant {
+    readonly name?: string | undefined;
+    readonly sid?: string | undefined;
+    readonly mcc?: string | undefined;
+    readonly slug?: string | undefined;
+    readonly pubApiKey?: string | undefined;
+    readonly processorMid?: string | undefined;
+    readonly active: boolean;
+    readonly activeAt?: string | undefined;
+    readonly gPay: boolean;
+    readonly aPay: boolean;
+    readonly pciCompliance: boolean;
+    readonly website?: string | undefined;
+    readonly addr1?: string | undefined;
+    readonly addr2?: string | undefined;
+    readonly city?: string | undefined;
+    readonly state?: string | undefined;
+    readonly zip?: string | undefined;
+    readonly phone?: string | undefined;
+    readonly primaryPhone?: string | undefined;
+    readonly primaryEmail?: string | undefined;
+    readonly primaryName?: string | undefined;
+    constructor(name?: string | undefined, sid?: string | undefined, mcc?: string | undefined, slug?: string | undefined, pubApiKey?: string | undefined, processorMid?: string | undefined, active?: boolean, activeAt?: string | undefined, gPay?: boolean, aPay?: boolean, pciCompliance?: boolean, website?: string | undefined, addr1?: string | undefined, addr2?: string | undefined, city?: string | undefined, state?: string | undefined, zip?: string | undefined, phone?: string | undefined, primaryPhone?: string | undefined, primaryEmail?: string | undefined, primaryName?: string | undefined);
+    static fromRaw(data: Raw$8): Merchant;
+}
+
+type Raw$7 = Record<string, unknown>;
+declare class Merchants extends AbstractResource {
+    list(filters?: Raw$7): Promise<CursorPage<Merchant>>;
+    show(sid: string): Promise<Merchant>;
+    create(attributes: Raw$7): Promise<Merchant>;
+    update(sid: string, attributes: Raw$7): Promise<Merchant>;
+    getFormLink(sid: string): Promise<FormLink>;
+}
+
+type Raw$6 = Record<string, unknown>;
+declare class PaymentMethod {
+    readonly id?: number | undefined;
+    readonly type?: string | undefined;
+    readonly token?: string | undefined;
+    readonly firstName?: string | undefined;
+    readonly lastName?: string | undefined;
+    readonly ccNameOnCard?: string | undefined;
+    readonly ccLastFour?: string | undefined;
+    readonly ccExpirationDate?: string | undefined;
+    readonly ccBrand?: string | undefined;
+    readonly achBankAccountName?: string | undefined;
+    readonly achRoutingNumber?: string | undefined;
+    readonly achAccountNumber?: string | undefined;
+    readonly achOwnershipType?: string | undefined;
+    readonly achAccountType?: string | undefined;
+    readonly achBankName?: string | undefined;
+    readonly status?: string | undefined;
+    readonly statusDate?: string | undefined;
+    readonly enabled: boolean;
+    readonly isDefault: boolean;
+    readonly addr1?: string | undefined;
+    readonly addr2?: string | undefined;
+    readonly addr3?: string | undefined;
+    readonly city?: string | undefined;
+    readonly state?: string | undefined;
+    readonly zip?: string | undefined;
+    constructor(id?: number | undefined, type?: string | undefined, token?: string | undefined, firstName?: string | undefined, lastName?: string | undefined, ccNameOnCard?: string | undefined, ccLastFour?: string | undefined, ccExpirationDate?: string | undefined, ccBrand?: string | undefined, achBankAccountName?: string | undefined, achRoutingNumber?: string | undefined, achAccountNumber?: string | undefined, achOwnershipType?: string | undefined, achAccountType?: string | undefined, achBankName?: string | undefined, status?: string | undefined, statusDate?: string | undefined, enabled?: boolean, isDefault?: boolean, addr1?: string | undefined, addr2?: string | undefined, addr3?: string | undefined, city?: string | undefined, state?: string | undefined, zip?: string | undefined);
+    static fromRaw(data: Raw$6): PaymentMethod;
+}
+
+type Raw$5 = Record<string, unknown>;
+declare class PaymentMethods extends AbstractResource {
+    list(sid: string, filters: Raw$5): Promise<CursorPage<PaymentMethod>>;
+    show(sid: string, paymentMethodId: number | string, filters: Raw$5): Promise<PaymentMethod>;
+    create(sid: string, attributes: Raw$5): Promise<PaymentMethod>;
+    update(sid: string, attributes: Raw$5): Promise<PaymentMethod>;
+    delete(sid: string, paymentMethodId: number | string, uuid: string): Promise<MessageResult>;
+}
+
+type Raw$4 = Record<string, unknown>;
+declare class RecurringPaymentMethod {
+    readonly id?: number | undefined;
+    readonly type?: string | undefined;
+    readonly lastFour?: string | undefined;
+    readonly expiration?: string | undefined;
+    readonly zip?: string | undefined;
+    readonly nameOnCard?: string | undefined;
+    readonly bankAccountName?: string | undefined;
+    readonly routingNumber?: string | undefined;
+    readonly accountNumber?: string | undefined;
+    readonly ownershipType?: string | undefined;
+    readonly accountType?: string | undefined;
+    readonly bankName?: string | undefined;
+    constructor(id?: number | undefined, type?: string | undefined, lastFour?: string | undefined, expiration?: string | undefined, zip?: string | undefined, nameOnCard?: string | undefined, bankAccountName?: string | undefined, routingNumber?: string | undefined, accountNumber?: string | undefined, ownershipType?: string | undefined, accountType?: string | undefined, bankName?: string | undefined);
+    static fromRaw(data: Raw$4): RecurringPaymentMethod;
+}
+
+type Raw$3 = Record<string, unknown>;
+declare class RecurringPayment {
+    readonly id?: number | undefined;
+    readonly name?: string | undefined;
+    readonly amount?: string | undefined;
+    readonly startDate?: string | undefined;
+    readonly endDate?: string | undefined;
+    readonly recurrenceSchedule?: string | undefined;
+    readonly lastRunDate?: string | undefined;
+    readonly lastRunStatus?: string | undefined;
+    readonly lastRunFailedCount?: number | undefined;
+    readonly nextRunDate?: string | undefined;
+    readonly status?: string | undefined;
+    readonly pausedUntilDate?: string | undefined;
+    readonly customerUuid?: string | undefined;
+    readonly cancelledAt?: string | undefined;
+    readonly error?: string | undefined;
+    readonly paymentMethod: RecurringPaymentMethod;
+    readonly shippingAddress: TransactionAddress;
+    constructor(id?: number | undefined, name?: string | undefined, amount?: string | undefined, startDate?: string | undefined, endDate?: string | undefined, recurrenceSchedule?: string | undefined, lastRunDate?: string | undefined, lastRunStatus?: string | undefined, lastRunFailedCount?: number | undefined, nextRunDate?: string | undefined, status?: string | undefined, pausedUntilDate?: string | undefined, customerUuid?: string | undefined, cancelledAt?: string | undefined, error?: string | undefined, paymentMethod?: RecurringPaymentMethod, shippingAddress?: TransactionAddress);
+    static fromRaw(data: Raw$3): RecurringPayment;
+}
+
+type Raw$2 = Record<string, unknown>;
+declare class RecurringPayments extends AbstractResource {
+    list(sid: string, filters?: Raw$2): Promise<CursorPage<RecurringPayment>>;
+    show(sid: string, recurringPaymentId: number | string): Promise<RecurringPayment>;
+    create(sid: string, attributes: Raw$2): Promise<RecurringPayment>;
+    edit(sid: string, recurringPaymentId: number | string, attributes: Raw$2): Promise<RecurringPayment>;
+    pause(sid: string, recurringPaymentId: number | string, pauseUntilDate?: string): Promise<RecurringPayment>;
+    cancel(sid: string, recurringPaymentId: number | string): Promise<RecurringPayment>;
+    activate(sid: string, recurringPaymentId: number | string): Promise<RecurringPayment>;
+    delete(sid: string, recurringPaymentId: number | string): Promise<MessageResult>;
+}
+
+type Raw$1 = Record<string, unknown>;
+declare class TokenizeResult {
+    readonly token?: string | undefined;
+    constructor(token?: string | undefined);
+    static fromRaw(data: Raw$1): TokenizeResult;
+}
+
+type Raw = Record<string, unknown>;
+declare class Transactions extends AbstractResource {
+    list(sid: string, filters?: Raw): Promise<CursorPage<Transaction>>;
+    show(sid: string, identifier: Raw): Promise<Transaction>;
+    chargeCard(sid: string, attributes: Raw): Promise<Transaction>;
+    /** @deprecated The API marks this deprecated; prefer chargeCard() with a token. */
+    chargeCardToken(sid: string, attributes: Raw): Promise<Transaction>;
+    chargeAch(sid: string, attributes: Raw): Promise<Transaction>;
+    tokenizeCard(sid: string, attributes: Raw): Promise<TokenizeResult>;
+    refund(sid: string, attributes: Raw): Promise<MessageResult>;
+    void(sid: string, transactionType: string, transactionId: number | string): Promise<MessageResult>;
+}
+
+/**
+ * Entry point for the Dime Payments API.
+ *
+ * ```ts
+ * const dime = new Client('your-api-token')
+ * const txn = await dime.transactions.chargeCard('000010', {
+ *   amount: '49.99',
+ *   token: 'tok_abc123',
+ * })
+ * ```
+ */
+declare class Client {
+    readonly transactions: Transactions;
+    readonly customers: Customers;
+    readonly paymentMethods: PaymentMethods;
+    readonly merchants: Merchants;
+    readonly addresses: Addresses;
+    readonly deposits: Deposits;
+    readonly recurringPayments: RecurringPayments;
+    private readonly _config;
+    constructor(token: string | Config, baseUrl?: string);
+    config(): Config;
+}
+
+declare class DimeException extends Error {
+    readonly statusCode?: number | undefined;
+    readonly responseBody: Record<string, unknown>;
+    constructor(message: string, statusCode?: number | undefined, responseBody?: Record<string, unknown>, cause?: unknown);
+    getStatusCode(): number | undefined;
+    getResponseBody(): Record<string, unknown>;
+}
+
+declare class ValidationException extends DimeException {
+    readonly errors: Record<string, string[]>;
+    constructor(message: string, errors?: Record<string, string[]>, statusCode?: number, responseBody?: Record<string, unknown>, cause?: unknown);
+    getErrors(): Record<string, string[]>;
+    firstError(): string | undefined;
+}
+
+declare class RateLimitException extends DimeException {
+    readonly retryAfter?: number | undefined;
+    constructor(message: string, retryAfter?: number | undefined, statusCode?: number, responseBody?: Record<string, unknown>, cause?: unknown);
+    getRetryAfter(): number | undefined;
+}
+
+declare class ApiException extends DimeException {
+}
+
+declare class AuthenticationException extends DimeException {
+}
+
+declare class PermissionDeniedException extends DimeException {
+}
+
+declare class NotFoundException extends DimeException {
+}
+
+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, Merchant, MessageResult, NotFoundException, PaymentMethod, PermissionDeniedException, RateLimitException, RecurringPayment, RecurringPaymentMethod, ServerException, TokenizeResult, Transaction, TransactionAddress, VERSION, ValidationException };