velirapay 0.1.1 → 0.2.0

package/dist/cjs/resources/overview.d.ts

@@ -1,8 +1,106 @@
+import type { Asset, Currency, Mode, OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
-/** The dashboard's figures for the last 30 days. Everything else it carries, such as the funnel and what needs attention, is read with get(). */
+/** The days an overview covers: the last 30, today included. */
+export interface OverviewPeriod {
+    /** The first day, at midnight UTC. */
+    from: Date | null;
+    /** The last day, today, at midnight UTC. */
+    to: Date | null;
+}
+/** How the period's attempts to pay ended, each in exactly one bucket; a new quote or a switch of coin carries an attempt on rather than starting another. */
+export interface OverviewFunnel {
+    /** How many attempts were started. */
+    started: number;
+    /** How many were paid. */
+    paid: number;
+    /** How many are still pending or underpaid. */
+    waiting: number;
+    /** How many expired or were canceled without a transfer. */
+    abandoned: number;
+    /** How many expired or were canceled after a transfer arrived. */
+    incomplete: number;
+    /** The attempts per coin, the most started first. */
+    assets: OverviewFunnelAsset[];
+}
+/** How the period's attempts to pay in one coin ended. */
+export interface OverviewFunnelAsset {
+    asset: OrString<Asset>;
+    started: number;
+    paid: number;
+    abandoned: number;
+}
+/** What needs a person now. */
+export interface OverviewAttention {
+    /** The latest underpaid charges that received something, at most five, to accept or chase. */
+    underpaidCharges: OverviewChargeAmount[];
+    /** The latest expired or canceled charges with a payment still waiting to be accepted, at most five. */
+    latePayments: OverviewChargeAmount[];
+    /** The payouts per coin that wait for a payout address. */
+    payoutsWaitingForAddress: OverviewWaitingPayouts[];
+    /** How many active webhook endpoints had a delivery fail in the last 7 days. */
+    failingWebhookEndpoints: number;
+}
+/** A charge that needs a person, with what it asked for and what arrived. */
+export interface OverviewChargeAmount {
+    /** The charge's id. */
+    id: string;
+    asset: OrString<Asset>;
+    /** What the charge asked for, in the coin. */
+    amount: string;
+    /** What arrived, in the coin: for a late payment, what came after the charge closed. */
+    receivedAmount: string;
+}
+/** How many payouts in one coin wait for a payout address. */
+export interface OverviewWaitingPayouts {
+    asset: OrString<Asset>;
+    count: number;
+}
+/** One coin's share of the period's paid charges. */
+export interface OverviewAsset {
+    asset: OrString<Asset>;
+    /** How many charges in the coin were paid. */
+    paidCharges: number;
+    /** Their share of every paid charge, in percent. */
+    sharePercent: number;
+}
+/** A payment link among those paid through most in the period. */
+export interface OverviewPaymentLink {
+    /** The link's id. */
+    id: string | null;
+    title: string | null;
+    /** How many charges were paid through it. */
+    paidCharges: number;
+}
+/** Which first steps the account has taken in the mode. */
+export interface OverviewSetup {
+    /** Whether it has a payout address. */
+    payoutAddress: boolean;
+    /** Whether it has a payment link. */
+    paymentLink: boolean;
+    /** Whether a charge has been paid. */
+    paidCharge: boolean;
+    /** Whether it has a webhook endpoint. */
+    webhookEndpoint: boolean;
+    /** Whether its public profile has a logo, a display name or a website. */
+    publicProfile: boolean;
+}
+/** One day of the period. */
+export interface OverviewDay {
+    /** The day, at midnight UTC. */
+    date: Date | null;
+    /** What was paid that day in the overview's currency. */
+    volume: string;
+    /** What the payouts confirmed that day came to. */
+    sentVolume: string;
+    /** How many charges in the overview's currency were paid that day. */
+    paidCharges: number;
+}
+/** The dashboard's figures for the last 30 days, and what needs attention now. */
 export declare class Overview extends ApiResource {
-    /** The currency the amounts are in. */
-    readonly currency: string;
+    /** The days the figures cover. */
+    readonly period: OverviewPeriod;
+    /** The currency the amounts are in: the one most charges were paid in lately, or the account's default. */
+    readonly currency: OrString<Currency>;
     /** What was paid in the period. */
     readonly volume: string;
     /** How the volume changed against the 30 days before, in percent, or null when nothing was paid then. */
@@ -21,5 +119,19 @@ export declare class Overview extends ApiResource {
     readonly openInvoices: number;
     /** How many open invoices are past due. */
     readonly overdueInvoices: number;
-    constructor(attributes: Attributes);
+    /** How the period's attempts to pay ended, in all and per coin. */
+    readonly funnel: OverviewFunnel;
+    /** What needs a person now: short and late payments, payouts without an address and failing webhook endpoints. */
+    readonly attention: OverviewAttention;
+    /** Each coin's share of the period's paid charges, the most paid first. */
+    readonly assets: OverviewAsset[];
+    /** The payment links paid through most in the period. */
+    readonly topPaymentLinks: OverviewPaymentLink[];
+    /** Which first steps the account has taken in the mode. */
+    readonly setup: OverviewSetup;
+    /** Every day of the period, oldest first. */
+    readonly daily: OverviewDay[];
+    /** The mode of the API key that fetched the overview: "live" or "test". */
+    readonly mode: OrString<Mode> | null;
+    constructor(attributes: Attributes, meta?: Attributes);
 }

package/dist/cjs/resources/overview.js

@@ -2,9 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Overview = void 0;
 const api_resource_ts_1 = require("./api-resource.js");
-/** The dashboard's figures for the last 30 days. Everything else it carries, such as the funnel and what needs attention, is read with get(). */
+/** The dashboard's figures for the last 30 days, and what needs attention now. */
 class Overview extends api_resource_ts_1.ApiResource {
-    /** The currency the amounts are in. */
+    /** The days the figures cover. */
+    period;
+    /** The currency the amounts are in: the one most charges were paid in lately, or the account's default. */
     currency;
     /** What was paid in the period. */
     volume;
@@ -24,8 +26,27 @@ class Overview extends api_resource_ts_1.ApiResource {
     openInvoices;
     /** How many open invoices are past due. */
     overdueInvoices;
-    constructor(attributes) {
+    /** How the period's attempts to pay ended, in all and per coin. */
+    funnel;
+    /** What needs a person now: short and late payments, payouts without an address and failing webhook endpoints. */
+    attention;
+    /** Each coin's share of the period's paid charges, the most paid first. */
+    assets;
+    /** The payment links paid through most in the period. */
+    topPaymentLinks;
+    /** Which first steps the account has taken in the mode. */
+    setup;
+    /** Every day of the period, oldest first. */
+    daily;
+    /** The mode of the API key that fetched the overview: "live" or "test". */
+    mode;
+    constructor(attributes, meta = {}) {
         super(attributes);
+        const period = (0, api_resource_ts_1.map)(attributes, 'period');
+        const funnel = (0, api_resource_ts_1.map)(attributes, 'funnel');
+        const attention = (0, api_resource_ts_1.map)(attributes, 'attention');
+        const setup = (0, api_resource_ts_1.map)(attributes, 'setup');
+        this.period = { from: (0, api_resource_ts_1.date)(period, 'from'), to: (0, api_resource_ts_1.date)(period, 'to') };
         this.currency = (0, api_resource_ts_1.string)(attributes, 'currency');
         this.volume = (0, api_resource_ts_1.string)(attributes, 'volume', '0');
         this.volumeChangePercent = (0, api_resource_ts_1.nullableNumber)(attributes, 'volume_change_percent');
@@ -36,6 +57,58 @@ class Overview extends api_resource_ts_1.ApiResource {
         this.activePaymentLinks = (0, api_resource_ts_1.int)(attributes, 'active_payment_links');
         this.openInvoices = (0, api_resource_ts_1.int)(attributes, 'open_invoices');
         this.overdueInvoices = (0, api_resource_ts_1.int)(attributes, 'overdue_invoices');
+        this.funnel = {
+            started: (0, api_resource_ts_1.int)(funnel, 'started'),
+            paid: (0, api_resource_ts_1.int)(funnel, 'paid'),
+            waiting: (0, api_resource_ts_1.int)(funnel, 'waiting'),
+            abandoned: (0, api_resource_ts_1.int)(funnel, 'abandoned'),
+            incomplete: (0, api_resource_ts_1.int)(funnel, 'incomplete'),
+            assets: (0, api_resource_ts_1.records)(funnel, 'assets').map((row) => ({
+                asset: (0, api_resource_ts_1.string)(row, 'asset'),
+                started: (0, api_resource_ts_1.int)(row, 'started'),
+                paid: (0, api_resource_ts_1.int)(row, 'paid'),
+                abandoned: (0, api_resource_ts_1.int)(row, 'abandoned'),
+            })),
+        };
+        this.attention = {
+            underpaidCharges: (0, api_resource_ts_1.records)(attention, 'underpaid_charges').map(chargeAmount),
+            latePayments: (0, api_resource_ts_1.records)(attention, 'late_payments').map(chargeAmount),
+            payoutsWaitingForAddress: (0, api_resource_ts_1.records)(attention, 'payouts_waiting_for_address').map((row) => ({ asset: (0, api_resource_ts_1.string)(row, 'asset'), count: (0, api_resource_ts_1.int)(row, 'count') })),
+            failingWebhookEndpoints: (0, api_resource_ts_1.int)(attention, 'failing_webhook_endpoints'),
+        };
+        this.assets = (0, api_resource_ts_1.records)(attributes, 'assets').map((row) => ({
+            asset: (0, api_resource_ts_1.string)(row, 'asset'),
+            paidCharges: (0, api_resource_ts_1.int)(row, 'paid_charges'),
+            sharePercent: (0, api_resource_ts_1.number)(row, 'share_percent'),
+        }));
+        this.topPaymentLinks = (0, api_resource_ts_1.records)(attributes, 'top_payment_links').map((link) => ({
+            id: (0, api_resource_ts_1.nullableString)(link, 'id'),
+            title: (0, api_resource_ts_1.nullableString)(link, 'title'),
+            paidCharges: (0, api_resource_ts_1.int)(link, 'paid_charges'),
+        }));
+        this.setup = {
+            payoutAddress: (0, api_resource_ts_1.bool)(setup, 'payout_address'),
+            paymentLink: (0, api_resource_ts_1.bool)(setup, 'payment_link'),
+            paidCharge: (0, api_resource_ts_1.bool)(setup, 'paid_charge'),
+            webhookEndpoint: (0, api_resource_ts_1.bool)(setup, 'webhook_endpoint'),
+            publicProfile: (0, api_resource_ts_1.bool)(setup, 'public_profile'),
+        };
+        this.daily = (0, api_resource_ts_1.records)(attributes, 'daily').map((day) => ({
+            date: (0, api_resource_ts_1.date)(day, 'date'),
+            volume: (0, api_resource_ts_1.string)(day, 'volume', '0'),
+            sentVolume: (0, api_resource_ts_1.string)(day, 'sent_volume', '0'),
+            paidCharges: (0, api_resource_ts_1.int)(day, 'paid_charges'),
+        }));
+        this.mode = (0, api_resource_ts_1.nullableString)(meta, 'mode');
     }
 }
 exports.Overview = Overview;
+/** Read a charge that needs a person. */
+function chargeAmount(row) {
+    return {
+        id: (0, api_resource_ts_1.string)(row, 'id'),
+        asset: (0, api_resource_ts_1.string)(row, 'asset'),
+        amount: (0, api_resource_ts_1.string)(row, 'amount', '0'),
+        receivedAmount: (0, api_resource_ts_1.string)(row, 'received_amount', '0'),
+    };
+}

package/dist/cjs/resources/payment-link.d.ts

@@ -1,4 +1,4 @@
-import { PaymentLinkStatus, PricingType, type OrString } from '../enums.ts';
+import { PaymentLinkStatus, PricingType, type Asset, type Currency, type OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** A question a payment link's checkout asks. */
 export interface CheckoutQuestion {
@@ -24,9 +24,9 @@ export declare class PaymentLink extends ApiResource {
     /** The most a customer may pay on an open-price link. */
     readonly maxAmount: string | null;
     /** The fiat currency the link is priced in. */
-    readonly currency: string;
+    readonly currency: OrString<Currency>;
     /** The coins the link takes, or null for every coin the account can receive. */
-    readonly acceptedAssets: string[] | null;
+    readonly acceptedAssets: OrString<Asset>[] | null;
     /** One of the PaymentLinkStatus values: active or archived. */
     readonly status: OrString<PaymentLinkStatus>;
     /** Where the customer is sent after paying. */

package/dist/cjs/resources/payout.d.ts

@@ -1,4 +1,4 @@
-import { PayoutStatus, type Asset, type OrString } from '../enums.ts';
+import { PayoutStatus, type AddressNetwork, type Asset, type Currency, type OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** What became of one paid charge: what came in, what was kept, what was sent and the transaction that carried it. */
 export declare class Payout extends ApiResource {
@@ -19,7 +19,7 @@ export declare class Payout extends ApiResource {
     /** What the fee was worth in fiat, at the rate the charge was locked at. */
     readonly feeFiatAmount: string | null;
     /** The fiat currency of feeFiatAmount and exchangeRate. */
-    readonly fiatCurrency: string | null;
+    readonly fiatCurrency: OrString<Currency> | null;
     /** The rate the charge was locked at. */
     readonly exchangeRate: string | null;
     /** What the merchant is owed, before the chain's own fee. */
@@ -76,14 +76,14 @@ export declare class PayoutSummary extends ApiResource {
 }
 /** Where the account's payouts on one network go. */
 export declare class PayoutAddress extends ApiResource {
-    /** The network, such as "bitcoin" or "evm", which is also its id in the paths. */
-    readonly network: string;
+    /** One of the AddressNetwork values, such as "bitcoin" or "evm", which is also its id in the paths. */
+    readonly network: OrString<AddressNetwork>;
     /** The network's name. */
     readonly name: string;
     /** Where payouts go, null while there is no address: payouts in its coins then wait for one. */
     readonly address: string | null;
     /** The coins on offer on this network. */
-    readonly assets: string[];
+    readonly assets: OrString<Asset>[];
     /** Until when payouts to a newly saved address wait. */
     readonly payoutsHeldUntil: Date | null;
     /** When the address was last saved. */

package/dist/cjs/resources/payout.js

@@ -120,7 +120,7 @@ class PayoutSummary extends api_resource_ts_1.ApiResource {
 exports.PayoutSummary = PayoutSummary;
 /** Where the account's payouts on one network go. */
 class PayoutAddress extends api_resource_ts_1.ApiResource {
-    /** The network, such as "bitcoin" or "evm", which is also its id in the paths. */
+    /** One of the AddressNetwork values, such as "bitcoin" or "evm", which is also its id in the paths. */
     network;
     /** The network's name. */
     name;

package/dist/cjs/resources/pro-payment.d.ts

@@ -1,3 +1,4 @@
+import type { Asset, Currency, OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** A crypto payment for a month of Pro: where to pay it and what to send. */
 export declare class ProPayment extends ApiResource {
@@ -6,9 +7,9 @@ export declare class ProPayment extends ApiResource {
     /** What it costs, in currency. */
     readonly price: string;
     /** The currency of the price. */
-    readonly currency: string;
+    readonly currency: OrString<Currency>;
     /** The coin it is paid in. */
-    readonly asset: string;
+    readonly asset: OrString<Asset>;
     /** What to send, in the coin. */
     readonly assetAmount: string;
     /** The page to pay it on. */

package/dist/cjs/resources/supported-asset.d.ts

@@ -1,4 +1,4 @@
-import { Asset, type OrString } from '../enums.ts';
+import { Asset, type Currency, type OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** A coin that can be paid in the API key's mode, with the lowest price a charge in it can have. */
 export declare class SupportedAsset extends ApiResource {
@@ -21,7 +21,7 @@ export declare class SupportedAsset extends ApiResource {
     /** Whether the account takes it right now, which needs a payout address for that network. */
     readonly accepted: boolean | null;
     /** The currency exchangeRate and minimumPrice are in. */
-    readonly currency: string;
+    readonly currency: OrString<Currency>;
     /** What one unit of the coin is worth in that currency right now, or null while no rate is available. */
     readonly exchangeRate: string | null;
     /** The least a charge in it can come to, in the coin itself, or null when it has no minimum of its own. */

package/dist/cjs/resources/webhook-endpoint.d.ts

@@ -1,3 +1,4 @@
+import { WebhookDeliveryStatus, type EventType, type OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** Where webhooks are delivered, and whether it can receive them. Its signing secret is only returned when it is added or rotated. */
 export declare class WebhookEndpoint extends ApiResource {
@@ -8,7 +9,7 @@ export declare class WebhookEndpoint extends ApiResource {
     /** What the merchant noted about it. */
     readonly description: string | null;
     /** The EventType values it subscribes to. */
-    readonly events: string[];
+    readonly events: OrString<EventType>[];
     /** Whether it is switched on. */
     readonly active: boolean;
     /** Whether it has answered the verification challenge; it receives nothing until it has. */
@@ -36,13 +37,13 @@ export declare class WebhookDelivery extends ApiResource {
     /** The delivery's id, the X-VeliraPay-Delivery header it was sent with. */
     readonly id: string;
     /** The EventType value it carried. */
-    readonly event: string;
+    readonly event: OrString<EventType>;
     /** The id of the event it carried, null for a test delivery. */
     readonly eventId: string | null;
     /** Whether it was a test event, which describes no real payment. */
     readonly test: boolean;
-    /** "pending", "succeeded" or "failed". */
-    readonly status: string;
+    /** One of the WebhookDeliveryStatus values: pending, succeeded or failed. */
+    readonly status: OrString<WebhookDeliveryStatus>;
     /** How many times it was sent. */
     readonly attempts: number;
     /** The HTTP status the endpoint last answered with. */

package/dist/cjs/resources/webhook-endpoint.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookDeliveryAttempt = exports.WebhookDelivery = exports.WebhookEndpoint = void 0;
+const enums_ts_1 = require("../enums.js");
 const api_resource_ts_1 = require("./api-resource.js");
 /** Where webhooks are delivered, and whether it can receive them. Its signing secret is only returned when it is added or rotated. */
 class WebhookEndpoint extends api_resource_ts_1.ApiResource {
@@ -62,7 +63,7 @@ class WebhookDelivery extends api_resource_ts_1.ApiResource {
     eventId;
     /** Whether it was a test event, which describes no real payment. */
     test;
-    /** "pending", "succeeded" or "failed". */
+    /** One of the WebhookDeliveryStatus values: pending, succeeded or failed. */
     status;
     /** How many times it was sent. */
     attempts;
@@ -105,7 +106,7 @@ class WebhookDelivery extends api_resource_ts_1.ApiResource {
     }
     /** Whether the endpoint accepted the delivery. */
     succeeded() {
-        return this.status === 'succeeded';
+        return this.status === enums_ts_1.WebhookDeliveryStatus.Succeeded;
     }
 }
 exports.WebhookDelivery = WebhookDelivery;

package/dist/cjs/services/account.js

@@ -15,7 +15,7 @@ class AccountService extends service_ts_1.Service {
     }
     /** Change the default currency, the payment tolerances, the checkout language or invoice reminders. Needs payment_settings:write. */
     async updatePaymentSettings(params, options) {
-        return account(await this.respond('PATCH', '/v1/payment-settings', params, options));
+        return account(await this.respond('PATCH', '/v1/payment-settings', (0, service_ts_1.withDecimalAmounts)(params, 'underpayment_tolerance', 'overpayment_threshold'), options));
     }
 }
 exports.AccountService = AccountService;

package/dist/cjs/services/api-keys.d.ts

@@ -8,7 +8,13 @@ export declare class ApiKeyService extends Service {
     list(params?: PageParams): Promise<Page<ApiKey>>;
     /** Iterate over every active key, newest first, fetching pages as they are reached. */
     iterator(params?: Omit<PageParams, 'page'>): AsyncGenerator<ApiKey, void, undefined>;
-    /** Create a key in the API key's mode. Its key property holds the key itself, shown this once; leaving permissions out gives full access. */
+    /**
+     * Create a key in the API key's mode. Its key property holds the key itself, shown this once; leaving permissions out gives full access.
+     *
+     * The answer is never kept for the idempotency key, so when it is lost, the library's retry or a repeat throws a ConflictError whose
+     * wasReplayed() is true: the key was made, but cannot be shown again. Find it with list() by its name and createdAt, revoke() it,
+     * and create another with a fresh idempotency key.
+     */
     create(params: ApiKeyCreateParams, options?: RequestOptions): Promise<ApiKey>;
     /** Change a key's name, permissions or allowed_ips, only those given; null permissions gives full access and null allowed_ips anywhere. */
     update(id: string, params: ApiKeyUpdateParams, options?: RequestOptions): Promise<ApiKey>;

package/dist/cjs/services/api-keys.js

@@ -13,7 +13,13 @@ class ApiKeyService extends service_ts_1.Service {
     async *iterator(params = {}) {
         yield* (await this.list(params)).autoPagingIterator();
     }
-    /** Create a key in the API key's mode. Its key property holds the key itself, shown this once; leaving permissions out gives full access. */
+    /**
+     * Create a key in the API key's mode. Its key property holds the key itself, shown this once; leaving permissions out gives full access.
+     *
+     * The answer is never kept for the idempotency key, so when it is lost, the library's retry or a repeat throws a ConflictError whose
+     * wasReplayed() is true: the key was made, but cannot be shown again. Find it with list() by its name and createdAt, revoke() it,
+     * and create another with a fresh idempotency key.
+     */
     async create(params, options) {
         return new api_key_ts_1.ApiKey(await this.request('POST', '/v1/api-keys', params, options));
     }

package/dist/cjs/services/assets.d.ts

@@ -1,9 +1,8 @@
-import type { Page } from '../page.ts';
+import { AssetPage } from '../page.ts';
 import type { AssetListParams } from '../params.ts';
-import { SupportedAsset } from '../resources/supported-asset.ts';
 import { Service } from './service.ts';
 /** The /v1/assets endpoint. */
 export declare class AssetService extends Service {
-    /** List the coins that can be paid in the API key's mode, with the lowest price each can be charged at, in one page. */
-    list(params?: AssetListParams): Promise<Page<SupportedAsset>>;
+    /** List the coins that can be paid in the API key's mode, with the lowest price each can be charged at, in one page that also gives the currencies prices can be asked in. */
+    list(params?: AssetListParams): Promise<AssetPage>;
 }

package/dist/cjs/services/assets.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetService = void 0;
+const page_ts_1 = require("../page.js");
 const supported_asset_ts_1 = require("../resources/supported-asset.js");
 const service_ts_1 = require("./service.js");
 /** The /v1/assets endpoint. */
 class AssetService extends service_ts_1.Service {
-    /** List the coins that can be paid in the API key's mode, with the lowest price each can be charged at, in one page. */
+    /** List the coins that can be paid in the API key's mode, with the lowest price each can be charged at, in one page that also gives the currencies prices can be asked in. */
     async list(params = {}) {
-        return this.page('/v1/assets', params, (asset) => new supported_asset_ts_1.SupportedAsset(asset));
+        return this.page('/v1/assets', params, (asset) => new supported_asset_ts_1.SupportedAsset(asset), page_ts_1.AssetPage);
     }
 }
 exports.AssetService = AssetService;

package/dist/cjs/services/charges.js

@@ -7,7 +7,7 @@ const service_ts_1 = require("./service.js");
 class ChargeService extends service_ts_1.Service {
     /** Charge a customer: create a charge with what you already know about them, and send them to its checkoutUrl. */
     async create(params, options) {
-        return apiCharge(await this.request('POST', '/v1/charges', params, options));
+        return apiCharge(await this.request('POST', '/v1/charges', (0, service_ts_1.withDecimalAmounts)(params, 'amount'), options));
     }
     /** Retrieve a charge by its id. */
     async retrieve(id) {
@@ -27,7 +27,7 @@ class ChargeService extends service_ts_1.Service {
     }
     /** Record a refund you sent the customer from your own wallet. An underpaid charge or a late payment is accepted first, and the network surcharge is never refundable. */
     async recordRefund(id, params, options) {
-        return apiCharge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/refunds', id), params, options));
+        return apiCharge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/refunds', id), (0, service_ts_1.withDecimalAmounts)(params, 'amount'), options));
     }
     /** Email the customer the payment page of a pending charge. */
     async send(id, options) {
@@ -39,7 +39,7 @@ class ChargeService extends service_ts_1.Service {
     }
     /** Pay a test-mode charge without coins, in full or by a chosen amount in the charge's coin. */
     async simulate(id, params = {}, options) {
-        return apiCharge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/simulate', id), Object.keys(params).length === 0 ? undefined : params, options));
+        return apiCharge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/simulate', id), Object.keys(params).length === 0 ? undefined : (0, service_ts_1.withDecimalAmounts)(params, 'amount'), options));
     }
 }
 exports.ChargeService = ChargeService;

package/dist/cjs/services/coupons.js

@@ -7,7 +7,7 @@ const service_ts_1 = require("./service.js");
 class CouponService extends service_ts_1.Service {
     /** Create a coupon taking either percent_off or amount_off; currency is required with amount_off or min_amount. */
     async create(params, options) {
-        return new coupon_ts_1.Coupon(await this.request('POST', '/v1/coupons', params, options));
+        return new coupon_ts_1.Coupon(await this.request('POST', '/v1/coupons', (0, service_ts_1.withDecimalAmounts)(params, 'percent_off', 'amount_off', 'min_amount'), options));
     }
     /** Retrieve a coupon by its code, in any case. */
     async retrieve(id) {

package/dist/cjs/services/invoices.js

@@ -7,7 +7,11 @@ const service_ts_1 = require("./service.js");
 class InvoiceService extends service_ts_1.Service {
     /** Create an invoice, for a total or a list of items, and optionally email it to the customer. */
     async create(params, options) {
-        return new invoice_ts_1.Invoice(await this.request('POST', '/v1/invoices', params, options));
+        const body = (0, service_ts_1.withDecimalAmounts)(params, 'amount');
+        if (Array.isArray(params.items)) {
+            body.items = params.items.map((item) => (0, service_ts_1.withDecimalAmounts)(item, 'quantity', 'unit_amount'));
+        }
+        return new invoice_ts_1.Invoice(await this.request('POST', '/v1/invoices', body, options));
     }
     /** Retrieve an invoice by its id. */
     async retrieve(id) {

package/dist/cjs/services/members.d.ts

@@ -8,7 +8,7 @@ export declare class MemberService extends Service {
     list(params?: PageParams): Promise<Page<Member>>;
     /** Iterate over every member, oldest first, fetching pages as they are reached. */
     iterator(params?: Omit<PageParams, 'page'>): AsyncGenerator<Member, void, undefined>;
-    /** Give a member another role: "admin", "finance", "support" or "viewer". An owner is never changed this way. */
+    /** Give a member another role: admin, finance, support or viewer, as the MemberRole values name them. An owner is never changed this way. */
     update(id: string, params: MemberUpdateParams, options?: RequestOptions): Promise<Member>;
     /** Remove a member, which also revokes the API keys they made. An owner is never removed this way. */
     remove(id: string, options?: RequestOptions): Promise<void>;
@@ -19,7 +19,7 @@ export declare class InvitationService extends Service {
     list(params?: PageParams): Promise<Page<Invitation>>;
     /** Iterate over every waiting invitation, newest first, fetching pages as they are reached. */
     iterator(params?: Omit<PageParams, 'page'>): AsyncGenerator<Invitation, void, undefined>;
-    /** Email someone an invitation to join as an "admin", "finance", "support" or "viewer", in the name of whoever made the API key. */
+    /** Email someone an invitation to join as an admin, finance, support or viewer, in the name of whoever made the API key. */
     create(params: InvitationCreateParams, options?: RequestOptions): Promise<Invitation>;
     /** Withdraw an invitation, so its link stops working. */
     cancel(id: string, options?: RequestOptions): Promise<void>;

package/dist/cjs/services/members.js

@@ -13,7 +13,7 @@ class MemberService extends service_ts_1.Service {
     async *iterator(params = {}) {
         yield* (await this.list(params)).autoPagingIterator();
     }
-    /** Give a member another role: "admin", "finance", "support" or "viewer". An owner is never changed this way. */
+    /** Give a member another role: admin, finance, support or viewer, as the MemberRole values name them. An owner is never changed this way. */
     async update(id, params, options) {
         return new member_ts_1.Member(await this.request('PATCH', (0, service_ts_1.path)('/v1/members/%s', id), params, options));
     }
@@ -33,7 +33,7 @@ class InvitationService extends service_ts_1.Service {
     async *iterator(params = {}) {
         yield* (await this.list(params)).autoPagingIterator();
     }
-    /** Email someone an invitation to join as an "admin", "finance", "support" or "viewer", in the name of whoever made the API key. */
+    /** Email someone an invitation to join as an admin, finance, support or viewer, in the name of whoever made the API key. */
     async create(params, options) {
         return new member_ts_1.Invitation(await this.request('POST', '/v1/invitations', params, options));
     }

package/dist/cjs/services/overview.d.ts

@@ -2,6 +2,6 @@ import { Overview } from '../resources/overview.ts';
 import { Service } from './service.ts';
 /** The /v1/overview endpoint. Needs overview:read. */
 export declare class OverviewService extends Service {
-    /** Retrieve the dashboard's figures for the last 30 days, in the API key's mode. */
+    /** Retrieve the dashboard's figures for the last 30 days, in the API key's mode, and what needs attention now. */
     retrieve(): Promise<Overview>;
 }

package/dist/cjs/services/overview.js

@@ -5,9 +5,10 @@ const overview_ts_1 = require("../resources/overview.js");
 const service_ts_1 = require("./service.js");
 /** The /v1/overview endpoint. Needs overview:read. */
 class OverviewService extends service_ts_1.Service {
-    /** Retrieve the dashboard's figures for the last 30 days, in the API key's mode. */
+    /** Retrieve the dashboard's figures for the last 30 days, in the API key's mode, and what needs attention now. */
     async retrieve() {
-        return new overview_ts_1.Overview(await this.request('GET', '/v1/overview'));
+        const response = await this.respond('GET', '/v1/overview');
+        return new overview_ts_1.Overview((0, service_ts_1.data)(response), (0, service_ts_1.meta)(response));
     }
 }
 exports.OverviewService = OverviewService;

package/dist/cjs/services/payment-links.js

@@ -3,11 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PaymentLinkService = void 0;
 const payment_link_ts_1 = require("../resources/payment-link.js");
 const service_ts_1 = require("./service.js");
+/** The amounts a payment link takes, which go out as decimal strings. */
+const AMOUNTS = ['amount', 'suggested_amounts', 'min_amount', 'max_amount'];
 /** The /v1/payment-links endpoints. */
 class PaymentLinkService extends service_ts_1.Service {
     /** Create a payment link: one reusable public page, never one per customer. */
     async create(params, options) {
-        return new payment_link_ts_1.PaymentLink(await this.request('POST', '/v1/payment-links', params, options));
+        return new payment_link_ts_1.PaymentLink(await this.request('POST', '/v1/payment-links', (0, service_ts_1.withDecimalAmounts)(params, ...AMOUNTS), options));
     }
     /** Retrieve a payment link by its id. */
     async retrieve(id) {
@@ -15,7 +17,7 @@ class PaymentLinkService extends service_ts_1.Service {
     }
     /** Change any of a payment link's fields. */
     async update(id, params, options) {
-        return new payment_link_ts_1.PaymentLink(await this.request('PATCH', (0, service_ts_1.path)('/v1/payment-links/%s', id), params, options));
+        return new payment_link_ts_1.PaymentLink(await this.request('PATCH', (0, service_ts_1.path)('/v1/payment-links/%s', id), (0, service_ts_1.withDecimalAmounts)(params, ...AMOUNTS), options));
     }
     /** List payment links, newest first. */
     async list(params = {}) {

package/dist/cjs/services/payout-addresses.d.ts

@@ -1,12 +1,17 @@
+import type { AddressNetwork, OrString } from '../enums.ts';
 import type { PayoutAddressUpdateParams, RequestOptions } from '../params.ts';
 import { PayoutAddress } from '../resources/payout.ts';
 import { Service } from './service.ts';
-/** The /v1/payout-addresses endpoints. Reading needs payout_addresses:read; changing needs payout_addresses:write and an owner's switch under Payment settings. */
+/**
+ * The /v1/payout-addresses endpoints, one address per network family: bitcoin, litecoin, dogecoin, bitcoincash, evm (Ethereum),
+ * bsc (BNB Chain), base, arbitrum, polygon, tron, monero, solana or lightning, as the AddressNetwork values name them.
+ * Reading needs payout_addresses:read; changing needs payout_addresses:write and an owner's switch under Payment settings.
+ */
 export declare class PayoutAddressService extends Service {
     /** List where payouts go in the API key's mode: one entry per network with coins on offer, its address null while there is none. */
     list(): Promise<PayoutAddress[]>;
-    /** Point the payouts of one network, such as "bitcoin" or "evm", at an address. */
-    update(network: string, params: PayoutAddressUpdateParams, options?: RequestOptions): Promise<PayoutAddress>;
+    /** Point the payouts of one network, such as AddressNetwork.Bitcoin or "evm", at an address. */
+    update(network: OrString<AddressNetwork>, params: PayoutAddressUpdateParams, options?: RequestOptions): Promise<PayoutAddress>;
     /** Remove the address of one network, so its payouts wait for a new one. */
-    delete(network: string, options?: RequestOptions): Promise<PayoutAddress>;
+    delete(network: OrString<AddressNetwork>, options?: RequestOptions): Promise<PayoutAddress>;
 }