velirapay 0.1.1 → 0.2.1

package/dist/esm/enums.js

@@ -1,5 +1,5 @@
 /** A coin on one particular network, such as USDT on Ethereum or USDT_TRON on Tron. The account lists the ones it accepts right now. */
-export const Asset = {
+export const Asset = Object.freeze({
     BTC: 'BTC',
     BTC_LIGHTNING: 'BTC_LIGHTNING',
     LTC: 'LTC',
@@ -23,41 +23,41 @@ export const Asset = {
     ETH_BASE: 'ETH_BASE',
     ETH_ARBITRUM: 'ETH_ARBITRUM',
     POL: 'POL',
-};
+});
 /** The states a charge moves through. */
-export const ChargeStatus = {
+export const ChargeStatus = Object.freeze({
     Pending: 'pending',
     Underpaid: 'underpaid',
     Paid: 'paid',
     Expired: 'expired',
     Canceled: 'canceled',
-};
+});
 /** The states an invoice moves through. */
-export const InvoiceStatus = {
+export const InvoiceStatus = Object.freeze({
     Open: 'open',
     Paid: 'paid',
     Void: 'void',
-};
+});
 /** Where a payout has got to. */
-export const PayoutStatus = {
+export const PayoutStatus = Object.freeze({
     Pending: 'pending',
     Sending: 'sending',
     Sent: 'sent',
     Failed: 'failed',
     Manual: 'manual',
-};
+});
 /** Whether a payment link takes payments. */
-export const PaymentLinkStatus = {
+export const PaymentLinkStatus = Object.freeze({
     Active: 'active',
     Archived: 'archived',
-};
+});
 /** How a payment link is priced: at a set amount, or at one the customer names. */
-export const PricingType = {
+export const PricingType = Object.freeze({
     Fixed: 'fixed',
     Open: 'open',
-};
+});
 /** The events a charge, an invoice or a payout reports, through webhooks and the events API. */
-export const EventType = {
+export const EventType = Object.freeze({
     ChargeCreated: 'charge.created',
     ChargePaymentDetected: 'charge.payment_detected',
     ChargePaid: 'charge.paid',
@@ -73,20 +73,20 @@ export const EventType = {
     InvoiceVoided: 'invoice.voided',
     PayoutSent: 'payout.sent',
     PayoutConfirmed: 'payout.confirmed',
-};
+});
 /** The mode an API key, object or webhook belongs to. */
-export const Mode = {
+export const Mode = Object.freeze({
     Live: 'live',
     Test: 'test',
-};
+});
 /** What kind of legal entity runs an account. */
-export const BusinessType = {
+export const BusinessType = Object.freeze({
     Individual: 'individual',
     Company: 'company',
     NonProfit: 'non_profit',
-};
+});
 /** What an account sells, broadly. */
-export const Industry = {
+export const Industry = Object.freeze({
     DigitalProducts: 'digital_products',
     Software: 'software',
     Hosting: 'hosting',
@@ -99,17 +99,17 @@ export const Industry = {
     Travel: 'travel',
     Donations: 'donations',
     Other: 'other',
-};
+});
 /** How much an account expects to take in a month, in US dollars. */
-export const MonthlyVolume = {
+export const MonthlyVolume = Object.freeze({
     Under1k: 'under_1k',
     Under10k: '1k_10k',
     Under50k: '10k_50k',
     Under250k: '50k_250k',
     Over250k: 'over_250k',
-};
+});
 /** What a restricted API key may do. Full access gives every permission but the sensitive ones, which have to be ticked. */
-export const ApiKeyPermission = {
+export const ApiKeyPermission = Object.freeze({
     ChargesRead: 'charges:read',
     ChargesWrite: 'charges:write',
     ChargesAccept: 'charges:accept',
@@ -135,4 +135,129 @@ export const ApiKeyPermission = {
     MembersRead: 'members:read',
     MembersWrite: 'members:write',
     BillingWrite: 'billing:write',
-};
+});
+/** The fiat currencies prices can be set in. */
+export const Currency = Object.freeze({
+    USD: 'USD',
+    EUR: 'EUR',
+    GBP: 'GBP',
+    CAD: 'CAD',
+    AUD: 'AUD',
+    CHF: 'CHF',
+    TRY: 'TRY',
+});
+/** The roles people have in an account. Owner only appears in answers: invitations and role changes take the others. */
+export const MemberRole = Object.freeze({
+    Owner: 'owner',
+    Admin: 'admin',
+    Finance: 'finance',
+    Support: 'support',
+    Viewer: 'viewer',
+});
+/** The network families that each have one payout address, as payoutAddresses.update() and delete() name them. */
+export const AddressNetwork = Object.freeze({
+    Bitcoin: 'bitcoin',
+    Litecoin: 'litecoin',
+    Dogecoin: 'dogecoin',
+    BitcoinCash: 'bitcoincash',
+    Evm: 'evm',
+    Bsc: 'bsc',
+    Base: 'base',
+    Arbitrum: 'arbitrum',
+    Polygon: 'polygon',
+    Tron: 'tron',
+    Monero: 'monero',
+    Solana: 'solana',
+    Lightning: 'lightning',
+});
+/** How the checkout looks: following the customer's device, or always light or dark. */
+export const CheckoutAppearance = Object.freeze({
+    Auto: 'auto',
+    Light: 'light',
+    Dark: 'dark',
+});
+/** Where a webhook delivery has got to. */
+export const WebhookDeliveryStatus = Object.freeze({
+    Pending: 'pending',
+    Succeeded: 'succeeded',
+    Failed: 'failed',
+});
+/** The plans an account can be on: Free keeps a fee of every payment, Pro keeps none. */
+export const PlanName = Object.freeze({
+    Free: 'free',
+    Pro: 'pro',
+});
+/** Whether an account is one person's or an organization's. */
+export const AccountType = Object.freeze({
+    Personal: 'personal',
+    Organization: 'organization',
+});
+/** The languages the checkout can fall back on when the customer's browser asks for none of them. */
+export const CheckoutLocale = Object.freeze({
+    English: 'en',
+    French: 'fr',
+    German: 'de',
+    Spanish: 'es',
+    Turkish: 'tr',
+    Portuguese: 'pt',
+    Russian: 'ru',
+    Arabic: 'ar',
+});
+/** What the activity log records. The API adds actions from time to time, so expect others too. */
+export const ActivityAction = Object.freeze({
+    WalletsChanged: 'wallets.changed',
+    PayoutAddressAccessChanged: 'wallets.api_access_changed',
+    SecondFactorRequirementChanged: 'team.second_factor_requirement_changed',
+    PaymentSettingsUpdated: 'payment_settings.updated',
+    ProfileUpdated: 'profile.updated',
+    BusinessDetailsUpdated: 'business_details.updated',
+    ApiKeyCreated: 'api_key.created',
+    ApiKeyUpdated: 'api_key.updated',
+    ApiKeyRevoked: 'api_key.revoked',
+    WebhookCreated: 'webhook.created',
+    WebhookUpdated: 'webhook.updated',
+    WebhookDeleted: 'webhook.deleted',
+    WebhookSecretRotated: 'webhook.secret_rotated',
+    MemberInvited: 'member.invited',
+    MemberJoined: 'member.joined',
+    MemberRoleChanged: 'member.role_changed',
+    MemberRemoved: 'member.removed',
+    PaymentLinkCreated: 'payment_link.created',
+    PaymentLinkUpdated: 'payment_link.updated',
+    PaymentLinkArchived: 'payment_link.archived',
+    PaymentLinkRestored: 'payment_link.restored',
+    InvitationCanceled: 'member.invitation_canceled',
+    ChargePaymentRequested: 'charge.payment_requested',
+    WebhookDisabled: 'webhook.disabled',
+    ChargeCanceled: 'charge.canceled',
+    ChargeAccepted: 'charge.accepted',
+    RefundRecorded: 'refund.recorded',
+    InvoiceVoided: 'invoice.voided',
+    PlanPaymentStarted: 'plan.payment_started',
+    SubscriptionCanceled: 'plan.subscription_canceled',
+    SubscriptionResumed: 'plan.subscription_resumed',
+    SignedIn: 'auth.signed_in',
+    SignInFailed: 'auth.sign_in_failed',
+    PasswordChanged: 'auth.password_changed',
+    TwoFactorEnabled: 'auth.two_factor_enabled',
+    TwoFactorDisabled: 'auth.two_factor_disabled',
+    SignedOutElsewhere: 'auth.signed_out_elsewhere',
+    TwoFactorFailed: 'auth.two_factor_failed',
+    EmailChanged: 'auth.email_changed',
+    PasskeyAdded: 'auth.passkey_added',
+    PasskeyRemoved: 'auth.passkey_removed',
+    CouponCreated: 'coupon.created',
+    CouponUpdated: 'coupon.updated',
+    CouponDeleted: 'coupon.deleted',
+    AppConnected: 'auth.app_connected',
+    AppDisconnected: 'auth.app_disconnected',
+    ChatConnected: 'chat.connected',
+    ChatUpdated: 'chat.updated',
+    ChatRemoved: 'chat.removed',
+    ChatDisabled: 'chat.disabled',
+    SanctionsMatched: 'sanctions.matched',
+    SanctionsAccepted: 'sanctions.accepted',
+    SanctionsReturnRequested: 'sanctions.return_requested',
+    SocialAccountConnected: 'auth.social_connected',
+    SocialAccountDisconnected: 'auth.social_disconnected',
+});

package/dist/esm/errors.d.ts

@@ -28,8 +28,17 @@ export declare class PermissionError extends ApiError {
 /** The object does not exist for this account and mode (404). */
 export declare class NotFoundError extends ApiError {
 }
-/** The object's state does not allow the action, or an idempotency key was reused for a different request or is held by one still being processed (409). */
+/**
+ * The object's state does not allow the action, or an idempotency key was reused for a different request, is held by one
+ * still being processed, or belongs to a request that succeeded but whose answer carried a secret, which wasReplayed() tells (409).
+ */
 export declare class ConflictError extends ApiError {
+    /**
+     * Whether the API answered from an earlier request with the same idempotency key that succeeded: one that made an API key or
+     * a webhook endpoint, or rotated an endpoint's signing secret, whose answer is never kept because it carried the key or
+     * secret. The library's own retry after a lost answer gets this too. The write was carried out, but its key or secret cannot be shown again.
+     */
+    wasReplayed(): boolean;
 }
 /** The request failed validation (422). */
 export declare class ValidationError extends ApiError {

package/dist/esm/errors.js

@@ -58,8 +58,19 @@ export class PermissionError extends ApiError {
 /** The object does not exist for this account and mode (404). */
 export class NotFoundError extends ApiError {
 }
-/** The object's state does not allow the action, or an idempotency key was reused for a different request or is held by one still being processed (409). */
+/**
+ * The object's state does not allow the action, or an idempotency key was reused for a different request, is held by one
+ * still being processed, or belongs to a request that succeeded but whose answer carried a secret, which wasReplayed() tells (409).
+ */
 export class ConflictError extends ApiError {
+    /**
+     * Whether the API answered from an earlier request with the same idempotency key that succeeded: one that made an API key or
+     * a webhook endpoint, or rotated an endpoint's signing secret, whose answer is never kept because it carried the key or
+     * secret. The library's own retry after a lost answer gets this too. The write was carried out, but its key or secret cannot be shown again.
+     */
+    wasReplayed() {
+        return this.response.wasReplayed();
+    }
 }
 /** The request failed validation (422). */
 export class ValidationError extends ApiError {

package/dist/esm/http/transport.js

@@ -1,8 +1,10 @@
 import { randomUUID } from 'node:crypto';
 import { ApiError, ConnectionError, InvalidArgumentError } from '../errors.js';
 import { ApiResponse } from './api-response.js';
-/** The statuses worth another attempt for any request. */
-const RETRYABLE_STATUSES = [429, 502, 503, 504];
+/** The statuses worth another attempt for any request, Cloudflare's 520 to 524 for an origin it got no answer from included. */
+const RETRYABLE_STATUSES = [429, 502, 503, 504, 520, 521, 522, 523, 524];
+/** The codes Node gives a connection that could not be made or was cut off, which a fetch implementation may throw as they are. */
+const NETWORK_ERROR_CODES = ['ECONNRESET', 'ECONNREFUSED', 'ETIMEDOUT', 'EPIPE', 'EAI_AGAIN', 'ENOTFOUND', 'EHOSTUNREACH', 'ENETUNREACH'];
 /** Sends requests to the VeliraPay API and turns its answers into responses or errors. */
 export class HttpTransport {
     #options;
@@ -15,6 +17,9 @@ export class HttpTransport {
     /** Send a request and return the successful response. */
     async request(method, path, query = {}, body, idempotencyKey) {
         method = method.toUpperCase();
+        if (typeof idempotencyKey === 'string' && idempotencyKey.trim() === '') {
+            throw new InvalidArgumentError('An idempotency key cannot be blank: give one such as order-1042-attempt-1, or leave it out.');
+        }
         // A retried write must not be carried out twice, so every attempt carries the same key.
         if (method !== 'GET' && idempotencyKey === undefined && this.#options.maxRetries > 0) {
             idempotencyKey = randomUUID();
@@ -128,7 +133,17 @@ export class HttpTransport {
 }
 /** Whether fetch failed to reach the API, or to read its answer, rather than the code calling it failing. */
 function isNetworkError(error) {
-    return error instanceof TypeError || (error instanceof Error && (error.name === 'TimeoutError' || error.name === 'AbortError'));
+    if (error instanceof TypeError) {
+        return true;
+    }
+    if (!(error instanceof Error)) {
+        return false;
+    }
+    // node-fetch reports a connection or a body read that failed as a FetchError of the "system" type.
+    if (error.name === 'TimeoutError' || error.name === 'AbortError' || (error.name === 'FetchError' && 'type' in error && error.type === 'system')) {
+        return true;
+    }
+    return 'code' in error && typeof error.code === 'string' && NETWORK_ERROR_CODES.includes(error.code);
 }
 /** The wait before an attempt, in seconds: half a second, doubling each time, with some jitter. */
 function backoff(attempt) {

package/dist/esm/index.d.ts

@@ -1,10 +1,10 @@
 export { VeliraPayClient, type ClientOptions } from './client.ts';
 export { VERSION } from './version.ts';
-export { ApiKeyPermission, Asset, BusinessType, ChargeStatus, EventType, Industry, InvoiceStatus, Mode, MonthlyVolume, PaymentLinkStatus, PayoutStatus, PricingType, type Currency, type MemberRole, type OrString, } from './enums.ts';
+export { AccountType, ActivityAction, AddressNetwork, ApiKeyPermission, Asset, BusinessType, ChargeStatus, CheckoutAppearance, CheckoutLocale, Currency, EventType, Industry, InvoiceStatus, MemberRole, Mode, MonthlyVolume, PaymentLinkStatus, PayoutStatus, PlanName, PricingType, WebhookDeliveryStatus, type AssignableMemberRole, type OrString, } from './enums.ts';
 export { ApiError, AuthenticationError, ConflictError, ConnectionError, InvalidArgumentError, InvalidRequestError, NotFoundError, PermissionError, RateLimitError, ServerError, SignatureVerificationError, UnexpectedResponseError, ValidationError, VeliraPayError, } from './errors.ts';
 export { ApiResponse } from './http/api-response.ts';
 export type { Fetch } from './http/transport.ts';
-export { Page, type PagePosition } from './page.ts';
+export { AssetPage, Page, type PagePosition } from './page.ts';
 export type * from './params.ts';
 export { Account, AccountBusiness, Address, type AccountCheckout, type AccountInvoices } from './resources/account.ts';
 export { Activity } from './resources/activity.ts';
@@ -15,7 +15,7 @@ export { Coupon } from './resources/coupon.ts';
 export { Event } from './resources/event.ts';
 export { Invoice, InvoiceItem, type InvoiceCharge } from './resources/invoice.ts';
 export { Invitation, Member } from './resources/member.ts';
-export { Overview } from './resources/overview.ts';
+export { Overview, type OverviewAsset, type OverviewAttention, type OverviewChargeAmount, type OverviewDay, type OverviewFunnel, type OverviewFunnelAsset, type OverviewPaymentLink, type OverviewPeriod, type OverviewSetup, type OverviewWaitingPayouts, } from './resources/overview.ts';
 export { PaymentLink, type CheckoutQuestion } from './resources/payment-link.ts';
 export { Payout, PayoutAddress, PayoutSummary } from './resources/payout.ts';
 export { ProPayment } from './resources/pro-payment.ts';

package/dist/esm/index.js

@@ -1,9 +1,9 @@
 export { VeliraPayClient } from './client.js';
 export { VERSION } from './version.js';
-export { ApiKeyPermission, Asset, BusinessType, ChargeStatus, EventType, Industry, InvoiceStatus, Mode, MonthlyVolume, PaymentLinkStatus, PayoutStatus, PricingType, } from './enums.js';
+export { AccountType, ActivityAction, AddressNetwork, ApiKeyPermission, Asset, BusinessType, ChargeStatus, CheckoutAppearance, CheckoutLocale, Currency, EventType, Industry, InvoiceStatus, MemberRole, Mode, MonthlyVolume, PaymentLinkStatus, PayoutStatus, PlanName, PricingType, WebhookDeliveryStatus, } from './enums.js';
 export { ApiError, AuthenticationError, ConflictError, ConnectionError, InvalidArgumentError, InvalidRequestError, NotFoundError, PermissionError, RateLimitError, ServerError, SignatureVerificationError, UnexpectedResponseError, ValidationError, VeliraPayError, } from './errors.js';
 export { ApiResponse } from './http/api-response.js';
-export { Page } from './page.js';
+export { AssetPage, Page } from './page.js';
 export { Account, AccountBusiness, Address } from './resources/account.js';
 export { Activity } from './resources/activity.js';
 export { ApiKey } from './resources/api-key.js';
@@ -13,7 +13,7 @@ export { Coupon } from './resources/coupon.js';
 export { Event } from './resources/event.js';
 export { Invoice, InvoiceItem } from './resources/invoice.js';
 export { Invitation, Member } from './resources/member.js';
-export { Overview } from './resources/overview.js';
+export { Overview, } from './resources/overview.js';
 export { PaymentLink } from './resources/payment-link.js';
 export { Payout, PayoutAddress, PayoutSummary } from './resources/payout.js';
 export { ProPayment } from './resources/pro-payment.js';

package/dist/esm/page.d.ts

@@ -1,4 +1,6 @@
-import type { ApiResource } from './resources/api-resource.ts';
+import type { Currency, Mode, OrString } from './enums.ts';
+import { type ApiResource, type Attributes } from './resources/api-resource.ts';
+import type { SupportedAsset } from './resources/supported-asset.ts';
 /** Where a page sits in its list. */
 export interface PagePosition {
     currentPage: number;
@@ -19,7 +21,11 @@ export declare class Page<T extends ApiResource> implements Iterable<T> {
     readonly perPage: number;
     /** How many objects the whole list holds. */
     readonly total: number;
-    constructor(data: T[], position: PagePosition, fetch: (page: number) => Promise<Page<T>>);
+    /** What the answer said about the list besides its objects, as the API sent it: its position, and anything else, such as its mode. */
+    readonly meta: Attributes;
+    /** The mode the list is in, for the lists whose answer says it, such as the coins on offer and the activity log; null for the others. */
+    readonly mode: OrString<Mode> | null;
+    constructor(data: T[], position: PagePosition, fetch: (page: number) => Promise<Page<T>>, meta?: Attributes);
     /** Whether there are pages after this one. */
     hasMore(): boolean;
     /** Fetch the next page, or null when this is the last. */
@@ -31,3 +37,9 @@ export declare class Page<T extends ApiResource> implements Iterable<T> {
     /** Whether this page holds no objects. */
     isEmpty(): boolean;
 }
+/** The coins on offer, which assets.list() answers with in a single page, with the currencies their prices can be asked in. */
+export declare class AssetPage extends Page<SupportedAsset> {
+    /** The currencies assets.list() can give prices in, which its currency parameter takes. */
+    readonly currencies: OrString<Currency>[];
+    constructor(data: SupportedAsset[], position: PagePosition, fetch: (page: number) => Promise<Page<SupportedAsset>>, meta?: Attributes);
+}

package/dist/esm/page.js

@@ -1,3 +1,4 @@
+import { nullableString, strings } from './resources/api-resource.js';
 /** One page of a list, able to fetch the pages after it. */
 export class Page {
     /** The objects on this page. */
@@ -10,13 +11,19 @@ export class Page {
     perPage;
     /** How many objects the whole list holds. */
     total;
+    /** What the answer said about the list besides its objects, as the API sent it: its position, and anything else, such as its mode. */
+    meta;
+    /** The mode the list is in, for the lists whose answer says it, such as the coins on offer and the activity log; null for the others. */
+    mode;
     #fetch;
-    constructor(data, position, fetch) {
+    constructor(data, position, fetch, meta = {}) {
         this.data = data;
         this.currentPage = position.currentPage;
         this.lastPage = position.lastPage;
         this.perPage = position.perPage;
         this.total = position.total;
+        this.meta = meta;
+        this.mode = nullableString(meta, 'mode');
         this.#fetch = fetch;
     }
     /** Whether there are pages after this one. */
@@ -59,3 +66,12 @@ export class Page {
         return this.data.length === 0;
     }
 }
+/** The coins on offer, which assets.list() answers with in a single page, with the currencies their prices can be asked in. */
+export class AssetPage extends Page {
+    /** The currencies assets.list() can give prices in, which its currency parameter takes. */
+    currencies;
+    constructor(data, position, fetch, meta = {}) {
+        super(data, position, fetch, meta);
+        this.currencies = strings(meta, 'currencies');
+    }
+}

package/dist/esm/params.d.ts

@@ -1,11 +1,18 @@
-import type { ApiKeyPermission, Asset, BusinessType, ChargeStatus, Currency, EventType, Industry, InvoiceStatus, MemberRole, Mode, MonthlyVolume, OrString, PaymentLinkStatus, PayoutStatus, PricingType } from './enums.ts';
-/** An amount of money or of a coin. Pass a string, such as "49.90", to keep every decimal. */
+import type { ActivityAction, ApiKeyPermission, Asset, AssignableMemberRole, BusinessType, ChargeStatus, CheckoutAppearance, CheckoutLocale, Currency, EventType, Industry, InvoiceStatus, Mode, MonthlyVolume, OrString, PaymentLinkStatus, PayoutStatus, PricingType, WebhookDeliveryStatus } from './enums.ts';
+/** An amount of money or of a coin. Pass a string, such as "49.90", to keep every decimal: a number is rounded to 14 significant digits. */
 export type Amount = string | number;
 /** Your own key-value data: up to 20 keys of at most 40 characters, each a string of at most 500 characters, a number, a boolean or null. */
 export type Metadata = Record<string, string | number | boolean | null>;
 /** Options for a request that changes something. */
 export interface RequestOptions {
-    /** Up to 255 characters, such as an order number. For 24 hours, a repeat with the same key gets the first successful response instead of being carried out again. */
+    /**
+     * Up to 255 characters and not blank, such as "order-1042-attempt-1". For 24 hours, a repeat with the same key gets the first successful response
+     * instead of being carried out again. Reuse a key only to retry the same request: a new attempt, such as a charge replacing one
+     * that expired, needs a new key, or it gets the old charge back, and a different body under the same key throws a ConflictError.
+     * The answers that carry a new API key or webhook signing secret are the exception: they are never kept, so a repeat of
+     * apiKeys.create(), webhookEndpoints.create() or rotateSecret() throws a ConflictError whose wasReplayed() is true, meaning the
+     * first one succeeded.
+     */
     idempotencyKey?: string;
 }
 /** Which page of a list to fetch. */
@@ -86,6 +93,10 @@ export interface InvoiceCreateParams {
     memo?: string | null;
     /** The day it is due, as YYYY-MM-DD. */
     due_at?: string | null;
+    /** A public https:// address the customer is offered a button back to once they have paid. */
+    success_url?: string | null;
+    /** A public https:// address the customer can go back to from the invoice without paying. */
+    cancel_url?: string | null;
     send_email?: boolean;
 }
 export interface InvoiceListParams extends PageParams {
@@ -172,7 +183,7 @@ export interface WebhookEndpointCreateParams {
 }
 export type WebhookEndpointUpdateParams = Partial<WebhookEndpointCreateParams>;
 export interface WebhookDeliveryListParams extends PageParams {
-    status?: OrString<'pending' | 'succeeded' | 'failed'>;
+    status?: OrString<WebhookDeliveryStatus>;
     event?: OrString<EventType>;
 }
 export interface ApiKeyCreateParams {
@@ -184,15 +195,15 @@ export interface ApiKeyCreateParams {
 }
 export type ApiKeyUpdateParams = Partial<ApiKeyCreateParams>;
 export interface MemberUpdateParams {
-    role: OrString<MemberRole>;
+    role: OrString<AssignableMemberRole>;
 }
 export interface InvitationCreateParams {
     email: string;
-    role: OrString<MemberRole>;
+    role: OrString<AssignableMemberRole>;
 }
 export interface ActivityListParams extends PageParams {
-    /** An action, or "sensitive". */
-    action?: string;
+    /** An action, or "sensitive" for those that touch money or access. */
+    action?: OrString<ActivityAction | 'sensitive'>;
     person?: string;
     /** A subject or the start of an IP address. */
     q?: string;
@@ -223,7 +234,7 @@ export interface AccountUpdateParams {
     refund_policy_url?: string | null;
     brand_color?: string | null;
     checkout?: {
-        appearance?: OrString<'auto' | 'light' | 'dark'>;
+        appearance?: OrString<CheckoutAppearance>;
         coin_order?: OrString<Asset>[];
         default_coin?: OrString<Asset> | null;
         success_url?: string | null;
@@ -259,6 +270,6 @@ export interface PaymentSettingsUpdateParams {
     default_currency?: OrString<Currency>;
     underpayment_tolerance?: Amount;
     overpayment_threshold?: Amount;
-    checkout_locale?: OrString<'en' | 'fr' | 'de' | 'es' | 'tr' | 'pt' | 'ru' | 'ar'> | null;
+    checkout_locale?: OrString<CheckoutLocale> | null;
     invoice_reminders?: boolean;
 }

package/dist/esm/resources/account.d.ts

@@ -1,13 +1,13 @@
-import { BusinessType, Industry, Mode, MonthlyVolume, type OrString } from '../enums.ts';
+import { AccountType, BusinessType, CheckoutAppearance, Industry, Mode, MonthlyVolume, PlanName, type Asset, type CheckoutLocale, type Currency, type OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** How the account's checkout looks and what it falls back on. */
 export interface AccountCheckout {
-    /** "auto", "light" or "dark". */
-    appearance: string;
+    /** One of the CheckoutAppearance values: auto, light or dark. */
+    appearance: OrString<CheckoutAppearance>;
     /** The order coins are listed in. */
-    coinOrder: string[];
+    coinOrder: OrString<Asset>[];
     /** The coin the checkout starts on, or null when the merchant has not picked one. */
-    defaultCoin: string | null;
+    defaultCoin: OrString<Asset> | null;
     successUrl: string | null;
     cancelUrl: string | null;
     successMessage: string | null;
@@ -23,8 +23,8 @@ export interface AccountInvoices {
 export declare class Account extends ApiResource {
     /** The account's slug. */
     readonly id: string;
-    /** Either "personal" or "organization". */
-    readonly type: string;
+    /** One of the AccountType values: personal or organization. */
+    readonly type: OrString<AccountType>;
     /** The account's name. */
     readonly name: string;
     /** The name customers see. */
@@ -48,13 +48,13 @@ export declare class Account extends ApiResource {
     /** Who runs the account and what it sells; every field is null until it is filled in, and for a key without the sensitive account:write permission. */
     readonly business: AccountBusiness;
     /** The currency new links and reports default to. */
-    readonly defaultCurrency: string;
+    readonly defaultCurrency: OrString<Currency>;
     /** How far short of the amount due, in percent, still counts as paid. */
     readonly underpaymentTolerance: string;
     /** How much surplus, in percent, is ignored before a charge is flagged as overpaid. */
     readonly overpaymentThreshold: string;
-    /** "free" or "pro". */
-    readonly plan: string;
+    /** One of the PlanName values: free or pro. */
+    readonly plan: OrString<PlanName>;
     /** The share of each payment kept as the platform's fee, in percent. */
     readonly feePercent: string;
     /** When Pro ends, or null while it renews, has no end or the account is on the free plan. */
@@ -63,8 +63,8 @@ export declare class Account extends ApiResource {
     readonly checkout: AccountCheckout | null;
     /** The invoice numbering, footer and business details settings. */
     readonly invoices: AccountInvoices | null;
-    /** The fallback checkout language, or null for English. */
-    readonly checkoutLocale: string | null;
+    /** The checkout's fallback language, one of the CheckoutLocale values, or null for English. */
+    readonly checkoutLocale: OrString<CheckoutLocale> | null;
     /** Whether automatic invoice reminders are enabled. */
     readonly invoiceReminders: boolean;
     /** Whether the owner allows API keys and AI apps to change payout addresses. */
@@ -74,7 +74,7 @@ export declare class Account extends ApiResource {
     /** The mode of the API key that fetched the account: "live" or "test". */
     readonly mode: OrString<Mode> | null;
     /** The coins the account can be paid in right now, in that mode. */
-    readonly acceptedAssets: string[];
+    readonly acceptedAssets: OrString<Asset>[];
     constructor(attributes: Attributes, meta?: Attributes);
     /** Whether the account is on Pro, which keeps no fee. */
     isPro(): boolean;

package/dist/esm/resources/account.js

@@ -1,10 +1,10 @@
-import { BusinessType, Industry, Mode, MonthlyVolume } from '../enums.js';
+import { AccountType, BusinessType, CheckoutAppearance, Industry, Mode, MonthlyVolume, PlanName, } from '../enums.js';
 import { ApiResource, bool, date, isRecord, map, nullableString, oneOf, string, strings } from './api-resource.js';
 /** The account an API key belongs to: a personal account or an organization. */
 export class Account extends ApiResource {
     /** The account's slug. */
     id;
-    /** Either "personal" or "organization". */
+    /** One of the AccountType values: personal or organization. */
     type;
     /** The account's name. */
     name;
@@ -34,7 +34,7 @@ export class Account extends ApiResource {
     underpaymentTolerance;
     /** How much surplus, in percent, is ignored before a charge is flagged as overpaid. */
     overpaymentThreshold;
-    /** "free" or "pro". */
+    /** One of the PlanName values: free or pro. */
     plan;
     /** The share of each payment kept as the platform's fee, in percent. */
     feePercent;
@@ -44,7 +44,7 @@ export class Account extends ApiResource {
     checkout;
     /** The invoice numbering, footer and business details settings. */
     invoices;
-    /** The fallback checkout language, or null for English. */
+    /** The checkout's fallback language, one of the CheckoutLocale values, or null for English. */
     checkoutLocale;
     /** Whether automatic invoice reminders are enabled. */
     invoiceReminders;
@@ -77,11 +77,11 @@ export class Account extends ApiResource {
         this.defaultCurrency = string(attributes, 'default_currency');
         this.underpaymentTolerance = string(attributes, 'underpayment_tolerance', '0');
         this.overpaymentThreshold = string(attributes, 'overpayment_threshold', '0');
-        this.plan = string(plan, 'name', 'free');
+        this.plan = string(plan, 'name', PlanName.Free);
         this.feePercent = string(plan, 'fee_percent', '0');
         this.proEndsAt = date(plan, 'pro_ends_at');
         this.checkout = isRecord(checkout) ? {
-            appearance: string(checkout, 'appearance', 'auto'),
+            appearance: string(checkout, 'appearance', CheckoutAppearance.Auto),
             coinOrder: strings(checkout, 'coin_order'),
             defaultCoin: nullableString(checkout, 'default_coin'),
             successUrl: nullableString(checkout, 'success_url'),
@@ -103,11 +103,11 @@ export class Account extends ApiResource {
     }
     /** Whether the account is on Pro, which keeps no fee. */
     isPro() {
-        return this.plan === 'pro';
+        return this.plan === PlanName.Pro;
     }
     /** Whether this is an organization rather than a personal account. */
     isOrganization() {
-        return this.type === 'organization';
+        return this.type === AccountType.Organization;
     }
     /** Whether the key that fetched the account works in test mode. */
     isTestMode() {