velirapay 0.1.1 → 0.2.1

package/dist/cjs/index.js

@@ -1,24 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PayoutAddress = exports.Payout = exports.PaymentLink = exports.Overview = exports.Member = exports.Invitation = exports.InvoiceItem = exports.Invoice = exports.Event = exports.Coupon = exports.Transaction = exports.Refund = exports.Customer = exports.Charge = exports.ApiResource = exports.ApiKey = exports.Activity = exports.Address = exports.AccountBusiness = exports.Account = exports.Page = exports.ApiResponse = exports.VeliraPayError = exports.ValidationError = exports.UnexpectedResponseError = exports.SignatureVerificationError = exports.ServerError = exports.RateLimitError = exports.PermissionError = exports.NotFoundError = exports.InvalidRequestError = exports.InvalidArgumentError = exports.ConnectionError = exports.ConflictError = exports.AuthenticationError = exports.ApiError = exports.PricingType = exports.PayoutStatus = exports.PaymentLinkStatus = exports.MonthlyVolume = exports.Mode = exports.InvoiceStatus = exports.Industry = exports.EventType = exports.ChargeStatus = exports.BusinessType = exports.Asset = exports.ApiKeyPermission = exports.VERSION = exports.VeliraPayClient = void 0;
-exports.WebhookEvent = exports.Webhook = exports.WebhookEndpointService = exports.Service = exports.PayoutService = exports.PayoutAddressService = exports.PaymentLinkService = exports.OverviewService = exports.MemberService = exports.InvitationService = exports.InvoiceService = exports.EventService = exports.CouponService = exports.ChargeService = exports.BillingService = exports.AssetService = exports.ApiKeyService = exports.ActivityService = exports.AccountService = exports.WebhookEndpoint = exports.WebhookDeliveryAttempt = exports.WebhookDelivery = exports.SupportedAsset = exports.ProPayment = exports.PayoutSummary = void 0;
+exports.Transaction = exports.Refund = exports.Customer = exports.Charge = exports.ApiResource = exports.ApiKey = exports.Activity = exports.Address = exports.AccountBusiness = exports.Account = exports.Page = exports.AssetPage = exports.ApiResponse = exports.VeliraPayError = exports.ValidationError = exports.UnexpectedResponseError = exports.SignatureVerificationError = exports.ServerError = exports.RateLimitError = exports.PermissionError = exports.NotFoundError = exports.InvalidRequestError = exports.InvalidArgumentError = exports.ConnectionError = exports.ConflictError = exports.AuthenticationError = exports.ApiError = exports.WebhookDeliveryStatus = exports.PricingType = exports.PlanName = exports.PayoutStatus = exports.PaymentLinkStatus = exports.MonthlyVolume = exports.Mode = exports.MemberRole = exports.InvoiceStatus = exports.Industry = exports.EventType = exports.Currency = exports.CheckoutLocale = exports.CheckoutAppearance = exports.ChargeStatus = exports.BusinessType = exports.Asset = exports.ApiKeyPermission = exports.AddressNetwork = exports.ActivityAction = exports.AccountType = exports.VERSION = exports.VeliraPayClient = void 0;
+exports.WebhookEvent = exports.Webhook = exports.WebhookEndpointService = exports.Service = exports.PayoutService = exports.PayoutAddressService = exports.PaymentLinkService = exports.OverviewService = exports.MemberService = exports.InvitationService = exports.InvoiceService = exports.EventService = exports.CouponService = exports.ChargeService = exports.BillingService = exports.AssetService = exports.ApiKeyService = exports.ActivityService = exports.AccountService = exports.WebhookEndpoint = exports.WebhookDeliveryAttempt = exports.WebhookDelivery = exports.SupportedAsset = exports.ProPayment = exports.PayoutSummary = exports.PayoutAddress = exports.Payout = exports.PaymentLink = exports.Overview = exports.Member = exports.Invitation = exports.InvoiceItem = exports.Invoice = exports.Event = exports.Coupon = void 0;
 var client_ts_1 = require("./client.js");
 Object.defineProperty(exports, "VeliraPayClient", { enumerable: true, get: function () { return client_ts_1.VeliraPayClient; } });
 var version_ts_1 = require("./version.js");
 Object.defineProperty(exports, "VERSION", { enumerable: true, get: function () { return version_ts_1.VERSION; } });
 var enums_ts_1 = require("./enums.js");
+Object.defineProperty(exports, "AccountType", { enumerable: true, get: function () { return enums_ts_1.AccountType; } });
+Object.defineProperty(exports, "ActivityAction", { enumerable: true, get: function () { return enums_ts_1.ActivityAction; } });
+Object.defineProperty(exports, "AddressNetwork", { enumerable: true, get: function () { return enums_ts_1.AddressNetwork; } });
 Object.defineProperty(exports, "ApiKeyPermission", { enumerable: true, get: function () { return enums_ts_1.ApiKeyPermission; } });
 Object.defineProperty(exports, "Asset", { enumerable: true, get: function () { return enums_ts_1.Asset; } });
 Object.defineProperty(exports, "BusinessType", { enumerable: true, get: function () { return enums_ts_1.BusinessType; } });
 Object.defineProperty(exports, "ChargeStatus", { enumerable: true, get: function () { return enums_ts_1.ChargeStatus; } });
+Object.defineProperty(exports, "CheckoutAppearance", { enumerable: true, get: function () { return enums_ts_1.CheckoutAppearance; } });
+Object.defineProperty(exports, "CheckoutLocale", { enumerable: true, get: function () { return enums_ts_1.CheckoutLocale; } });
+Object.defineProperty(exports, "Currency", { enumerable: true, get: function () { return enums_ts_1.Currency; } });
 Object.defineProperty(exports, "EventType", { enumerable: true, get: function () { return enums_ts_1.EventType; } });
 Object.defineProperty(exports, "Industry", { enumerable: true, get: function () { return enums_ts_1.Industry; } });
 Object.defineProperty(exports, "InvoiceStatus", { enumerable: true, get: function () { return enums_ts_1.InvoiceStatus; } });
+Object.defineProperty(exports, "MemberRole", { enumerable: true, get: function () { return enums_ts_1.MemberRole; } });
 Object.defineProperty(exports, "Mode", { enumerable: true, get: function () { return enums_ts_1.Mode; } });
 Object.defineProperty(exports, "MonthlyVolume", { enumerable: true, get: function () { return enums_ts_1.MonthlyVolume; } });
 Object.defineProperty(exports, "PaymentLinkStatus", { enumerable: true, get: function () { return enums_ts_1.PaymentLinkStatus; } });
 Object.defineProperty(exports, "PayoutStatus", { enumerable: true, get: function () { return enums_ts_1.PayoutStatus; } });
+Object.defineProperty(exports, "PlanName", { enumerable: true, get: function () { return enums_ts_1.PlanName; } });
 Object.defineProperty(exports, "PricingType", { enumerable: true, get: function () { return enums_ts_1.PricingType; } });
+Object.defineProperty(exports, "WebhookDeliveryStatus", { enumerable: true, get: function () { return enums_ts_1.WebhookDeliveryStatus; } });
 var errors_ts_1 = require("./errors.js");
 Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return errors_ts_1.ApiError; } });
 Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return errors_ts_1.AuthenticationError; } });
@@ -37,6 +46,7 @@ Object.defineProperty(exports, "VeliraPayError", { enumerable: true, get: functi
 var api_response_ts_1 = require("./http/api-response.js");
 Object.defineProperty(exports, "ApiResponse", { enumerable: true, get: function () { return api_response_ts_1.ApiResponse; } });
 var page_ts_1 = require("./page.js");
+Object.defineProperty(exports, "AssetPage", { enumerable: true, get: function () { return page_ts_1.AssetPage; } });
 Object.defineProperty(exports, "Page", { enumerable: true, get: function () { return page_ts_1.Page; } });
 var account_ts_1 = require("./resources/account.js");
 Object.defineProperty(exports, "Account", { enumerable: true, get: function () { return account_ts_1.Account; } });

package/dist/cjs/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/cjs/page.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Page = void 0;
+exports.AssetPage = exports.Page = void 0;
+const api_resource_ts_1 = require("./resources/api-resource.js");
 /** One page of a list, able to fetch the pages after it. */
 class Page {
     /** The objects on this page. */
@@ -13,13 +14,19 @@ 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 = (0, api_resource_ts_1.nullableString)(meta, 'mode');
         this.#fetch = fetch;
     }
     /** Whether there are pages after this one. */
@@ -63,3 +70,13 @@ class Page {
     }
 }
 exports.Page = Page;
+/** The coins on offer, which assets.list() answers with in a single page, with the currencies their prices can be asked in. */
+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 = (0, api_resource_ts_1.strings)(meta, 'currencies');
+    }
+}
+exports.AssetPage = AssetPage;

package/dist/cjs/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/cjs/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/cjs/resources/account.js

@@ -7,7 +7,7 @@ const api_resource_ts_1 = require("./api-resource.js");
 class Account extends api_resource_ts_1.ApiResource {
     /** The account's slug. */
     id;
-    /** Either "personal" or "organization". */
+    /** One of the AccountType values: personal or organization. */
     type;
     /** The account's name. */
     name;
@@ -37,7 +37,7 @@ class Account extends api_resource_ts_1.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;
@@ -47,7 +47,7 @@ class Account extends api_resource_ts_1.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;
@@ -80,11 +80,11 @@ class Account extends api_resource_ts_1.ApiResource {
         this.defaultCurrency = (0, api_resource_ts_1.string)(attributes, 'default_currency');
         this.underpaymentTolerance = (0, api_resource_ts_1.string)(attributes, 'underpayment_tolerance', '0');
         this.overpaymentThreshold = (0, api_resource_ts_1.string)(attributes, 'overpayment_threshold', '0');
-        this.plan = (0, api_resource_ts_1.string)(plan, 'name', 'free');
+        this.plan = (0, api_resource_ts_1.string)(plan, 'name', enums_ts_1.PlanName.Free);
         this.feePercent = (0, api_resource_ts_1.string)(plan, 'fee_percent', '0');
         this.proEndsAt = (0, api_resource_ts_1.date)(plan, 'pro_ends_at');
         this.checkout = (0, api_resource_ts_1.isRecord)(checkout) ? {
-            appearance: (0, api_resource_ts_1.string)(checkout, 'appearance', 'auto'),
+            appearance: (0, api_resource_ts_1.string)(checkout, 'appearance', enums_ts_1.CheckoutAppearance.Auto),
             coinOrder: (0, api_resource_ts_1.strings)(checkout, 'coin_order'),
             defaultCoin: (0, api_resource_ts_1.nullableString)(checkout, 'default_coin'),
             successUrl: (0, api_resource_ts_1.nullableString)(checkout, 'success_url'),
@@ -106,11 +106,11 @@ class Account extends api_resource_ts_1.ApiResource {
     }
     /** Whether the account is on Pro, which keeps no fee. */
     isPro() {
-        return this.plan === 'pro';
+        return this.plan === enums_ts_1.PlanName.Pro;
     }
     /** Whether this is an organization rather than a personal account. */
     isOrganization() {
-        return this.type === 'organization';
+        return this.type === enums_ts_1.AccountType.Organization;
     }
     /** Whether the key that fetched the account works in test mode. */
     isTestMode() {

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

@@ -1,10 +1,11 @@
+import type { ActivityAction, Mode, OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** One thing done in the account, from its activity log. */
 export declare class Activity extends ApiResource {
     /** The entry's id. */
     readonly id: string;
-    /** What was done, such as "api_key.created". */
-    readonly action: string;
+    /** One of the ActivityAction values, such as "api_key.created". */
+    readonly action: OrString<ActivityAction>;
     /** What was done, in words. */
     readonly description: string;
     /** Who did it: a member's name or an API key's. */
@@ -16,7 +17,7 @@ export declare class Activity extends ApiResource {
     /** The address it came from. */
     readonly ipAddress: string | null;
     /** "live" or "test", or null for what belongs to neither, such as a sign-in. */
-    readonly mode: string | null;
+    readonly mode: OrString<Mode> | null;
     /** When it was done. */
     readonly createdAt: Date | null;
     constructor(attributes: Attributes);

package/dist/cjs/resources/activity.js

@@ -6,7 +6,7 @@ const api_resource_ts_1 = require("./api-resource.js");
 class Activity extends api_resource_ts_1.ApiResource {
     /** The entry's id. */
     id;
-    /** What was done, such as "api_key.created". */
+    /** One of the ActivityAction values, such as "api_key.created". */
     action;
     /** What was done, in words. */
     description;

package/dist/cjs/resources/api-key.d.ts

@@ -1,3 +1,4 @@
+import type { ApiKeyPermission, Mode, OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** An API key of the account. The key itself is only in the answer that creates it. */
 export declare class ApiKey extends ApiResource {
@@ -10,9 +11,9 @@ export declare class ApiKey extends ApiResource {
     /** The key itself, only in the answer that created it. */
     readonly key: string | null;
     /** "live" or "test". */
-    readonly mode: string;
+    readonly mode: OrString<Mode>;
     /** The ApiKeyPermission values the key has, null for full access. */
-    readonly permissions: string[] | null;
+    readonly permissions: OrString<ApiKeyPermission>[] | null;
     /** The addresses and ranges it may be used from, null for anywhere. */
     readonly allowedIps: string[] | null;
     /** The name of the member who made it. */

package/dist/cjs/resources/api-resource.d.ts

@@ -23,6 +23,8 @@ export declare function nullableBool(data: Attributes, key: string): boolean | n
 export declare function int(data: Attributes, key: string, fallback?: number): number;
 /** Read an integer attribute that may be null. */
 export declare function nullableInt(data: Attributes, key: string): number | null;
+/** Read a number attribute. */
+export declare function number(data: Attributes, key: string, fallback?: number): number;
 /** Read a number attribute that may be null. */
 export declare function nullableNumber(data: Attributes, key: string): number | null;
 /** Read a timestamp or a date, which is taken as midnight UTC. */

package/dist/cjs/resources/api-resource.js

@@ -8,6 +8,7 @@ exports.bool = bool;
 exports.nullableBool = nullableBool;
 exports.int = int;
 exports.nullableInt = nullableInt;
+exports.number = number;
 exports.nullableNumber = nullableNumber;
 exports.date = date;
 exports.strings = strings;
@@ -71,6 +72,10 @@ function nullableInt(data, key) {
     }
     return typeof value === 'string' && /^\d+$/.test(value) ? Number(value) : null;
 }
+/** Read a number attribute. */
+function number(data, key, fallback = 0) {
+    return nullableNumber(data, key) ?? fallback;
+}
 /** Read a number attribute that may be null. */
 function nullableNumber(data, key) {
     const value = data[key];

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

@@ -1,4 +1,4 @@
-import { ChargeStatus, type Asset, type OrString } from '../enums.ts';
+import { ChargeStatus, type Asset, type Currency, type OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** One entry of a charge's history. */
 export interface ChargeTimelineEntry {
@@ -18,14 +18,18 @@ export declare class Charge extends ApiResource {
     readonly status: OrString<ChargeStatus>;
     /** The code of the payment link the charge was made through. */
     readonly paymentLink: string | null;
+    /** The title of that payment link, in webhooks alone; null in the API's answers, which only give its code. */
+    readonly paymentLinkTitle: string | null;
     /** The code of the invoice the charge pays. */
     readonly invoice: string | null;
+    /** The number of that invoice, such as "INV-0042", in webhooks alone; null in the API's answers, which only give its code. */
+    readonly invoiceNumber: string | null;
     /** The merchant's description of the charge. */
     readonly description: string | null;
     /** What the customer owes, in fiat. */
     readonly fiatAmount: string;
     /** The fiat currency, such as "USD". */
-    readonly fiatCurrency: string;
+    readonly fiatCurrency: OrString<Currency>;
     /** The coin and network paid with, such as "BTC" or "USDT". */
     readonly asset: OrString<Asset>;
     /** The exact amount of the coin to send. */
@@ -96,7 +100,7 @@ export declare class Charge extends ApiResource {
     /** Whether the charge can still be paid. */
     isOpen(): boolean;
 }
-/** A charge as the API answers with it, which always has its checkout page. Charges in webhooks and events stay plain charges, without one. */
+/** A charge as the API answers with it, the charges events carry included, which always has its checkout page. Charges in webhooks stay plain charges, without one. */
 export type ApiCharge = Charge & {
     readonly checkoutUrl: string;
 };

package/dist/cjs/resources/charge.js

@@ -11,8 +11,12 @@ class Charge extends api_resource_ts_1.ApiResource {
     status;
     /** The code of the payment link the charge was made through. */
     paymentLink;
+    /** The title of that payment link, in webhooks alone; null in the API's answers, which only give its code. */
+    paymentLinkTitle;
     /** The code of the invoice the charge pays. */
     invoice;
+    /** The number of that invoice, such as "INV-0042", in webhooks alone; null in the API's answers, which only give its code. */
+    invoiceNumber;
     /** The merchant's description of the charge. */
     description;
     /** What the customer owes, in fiat. */
@@ -80,7 +84,9 @@ class Charge extends api_resource_ts_1.ApiResource {
         this.id = (0, api_resource_ts_1.string)(attributes, 'id', (0, api_resource_ts_1.string)(attributes, 'code'));
         this.status = (0, api_resource_ts_1.string)(attributes, 'status');
         this.paymentLink = (0, api_resource_ts_1.reference)(attributes, 'payment_link');
+        this.paymentLinkTitle = (0, api_resource_ts_1.nullableString)((0, api_resource_ts_1.map)(attributes, 'payment_link'), 'title');
         this.invoice = (0, api_resource_ts_1.reference)(attributes, 'invoice');
+        this.invoiceNumber = (0, api_resource_ts_1.nullableString)((0, api_resource_ts_1.map)(attributes, 'invoice'), 'number');
         this.description = (0, api_resource_ts_1.nullableString)(attributes, 'description');
         this.fiatAmount = (0, api_resource_ts_1.string)(attributes, 'fiat_amount', '0');
         this.fiatCurrency = (0, api_resource_ts_1.string)(attributes, 'fiat_currency');

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

@@ -1,3 +1,4 @@
+import type { Currency, OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** A discount code customers enter at checkout, or that is applied for them through a payment link's URL or the API. */
 export declare class Coupon extends ApiResource {
@@ -10,7 +11,7 @@ export declare class Coupon extends ApiResource {
     /** The amount taken off, or null for a percentage. */
     readonly amountOff: string | null;
     /** The only fiat currency the coupon works in, or null for a percentage that works in every one. */
-    readonly currency: string | null;
+    readonly currency: OrString<Currency> | null;
     /** The least the price before the discount must be. */
     readonly minAmount: string | null;
     /** How many payments may use the coupon, or null for no limit. */

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

@@ -1,6 +1,6 @@
 import type { EventType, OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
-import { Charge } from './charge.ts';
+import { type ApiCharge } from './charge.ts';
 import { Invoice } from './invoice.ts';
 /** Something that happened to a charge or an invoice, as the events API lists it. */
 export declare class Event extends ApiResource {
@@ -12,8 +12,8 @@ export declare class Event extends ApiResource {
     readonly details: Record<string, unknown>;
     /** When it happened. */
     readonly createdAt: Date | null;
-    /** The charge the event is about, as it is now, without its timeline. */
-    readonly charge: Charge | null;
+    /** The charge the event is about, as it is now, with its checkout page but without its timeline. */
+    readonly charge: ApiCharge | null;
     /** The invoice the event is about. */
     readonly invoice: Invoice | null;
     constructor(attributes: Attributes);

package/dist/cjs/resources/event.js

@@ -14,7 +14,7 @@ class Event extends api_resource_ts_1.ApiResource {
     details;
     /** When it happened. */
     createdAt;
-    /** The charge the event is about, as it is now, without its timeline. */
+    /** The charge the event is about, as it is now, with its checkout page but without its timeline. */
     charge;
     /** The invoice the event is about. */
     invoice;

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

@@ -1,10 +1,10 @@
-import { InvoiceStatus, type OrString } from '../enums.ts';
+import { InvoiceStatus, type Asset, type ChargeStatus, type Currency, type OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** A charge made to pay an invoice, one per coin the customer tried. */
 export interface InvoiceCharge {
     id: string;
-    status: string;
-    asset: string;
+    status: OrString<ChargeStatus>;
+    asset: OrString<Asset>;
 }
 /** A bill sent to one customer, paid through a hosted page in the coin they choose. */
 export declare class Invoice extends ApiResource {
@@ -25,7 +25,7 @@ export declare class Invoice extends ApiResource {
     /** The total due. */
     readonly amount: string;
     /** The fiat currency, such as "USD". */
-    readonly currency: string;
+    readonly currency: OrString<Currency>;
     /** The lines of an itemised invoice. */
     readonly items: InvoiceItem[];
     /** The day the invoice is due, at midnight UTC. */
@@ -46,6 +46,10 @@ export declare class Invoice extends ApiResource {
     readonly voidedAt: Date | null;
     /** When it was created. */
     readonly createdAt: Date | null;
+    /** The page the customer is offered a button back to once they have paid; absent from webhooks. */
+    readonly successUrl: string | null;
+    /** The page the customer can go back to from the invoice without paying; absent from webhooks. */
+    readonly cancelUrl: string | null;
     constructor(attributes: Attributes);
     /** Whether the invoice can still be paid. */
     isOpen(): boolean;

package/dist/cjs/resources/invoice.js

@@ -43,6 +43,10 @@ class Invoice extends api_resource_ts_1.ApiResource {
     voidedAt;
     /** When it was created. */
     createdAt;
+    /** The page the customer is offered a button back to once they have paid; absent from webhooks. */
+    successUrl;
+    /** The page the customer can go back to from the invoice without paying; absent from webhooks. */
+    cancelUrl;
     constructor(attributes) {
         super(attributes);
         this.id = (0, api_resource_ts_1.string)(attributes, 'id', (0, api_resource_ts_1.string)(attributes, 'code'));
@@ -68,6 +72,8 @@ class Invoice extends api_resource_ts_1.ApiResource {
         this.paidAt = (0, api_resource_ts_1.date)(attributes, 'paid_at');
         this.voidedAt = (0, api_resource_ts_1.date)(attributes, 'voided_at');
         this.createdAt = (0, api_resource_ts_1.date)(attributes, 'created_at');
+        this.successUrl = (0, api_resource_ts_1.nullableString)(attributes, 'success_url');
+        this.cancelUrl = (0, api_resource_ts_1.nullableString)(attributes, 'cancel_url');
     }
     /** Whether the invoice can still be paid. */
     isOpen() {

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

@@ -1,3 +1,4 @@
+import type { MemberRole, OrString } from '../enums.ts';
 import { ApiResource, type Attributes } from './api-resource.ts';
 /** A person in the account, with their role. */
 export declare class Member extends ApiResource {
@@ -7,8 +8,8 @@ export declare class Member extends ApiResource {
     readonly name: string;
     /** The address they sign in with. */
     readonly email: string;
-    /** "owner", "admin", "finance", "support" or "viewer". */
-    readonly role: string | null;
+    /** One of the MemberRole values: owner, admin, finance, support or viewer. */
+    readonly role: OrString<MemberRole> | null;
     /** When they joined. */
     readonly joinedAt: Date | null;
     constructor(attributes: Attributes);
@@ -19,8 +20,8 @@ export declare class Invitation extends ApiResource {
     readonly id: string;
     /** Where it was sent. */
     readonly email: string;
-    /** The role it gives once accepted: "admin", "finance", "support" or "viewer". */
-    readonly role: string;
+    /** The role it gives once accepted: admin, finance, support or viewer. */
+    readonly role: OrString<MemberRole>;
     /** The name of the member who sent it. */
     readonly invitedBy: string | null;
     /** Whether it can no longer be accepted. */

package/dist/cjs/resources/member.js

@@ -10,7 +10,7 @@ class Member extends api_resource_ts_1.ApiResource {
     name;
     /** The address they sign in with. */
     email;
-    /** "owner", "admin", "finance", "support" or "viewer". */
+    /** One of the MemberRole values: owner, admin, finance, support or viewer. */
     role;
     /** When they joined. */
     joinedAt;
@@ -30,7 +30,7 @@ class Invitation extends api_resource_ts_1.ApiResource {
     id;
     /** Where it was sent. */
     email;
-    /** The role it gives once accepted: "admin", "finance", "support" or "viewer". */
+    /** The role it gives once accepted: admin, finance, support or viewer. */
     role;
     /** The name of the member who sent it. */
     invitedBy;