@fiatden/openpay 0.0.0-stage → 0.0.2

package/dist/http.js

@@ -0,0 +1,56 @@
+"use strict";
+// ── HTTP Client ──────────────────────────────────────────────
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpClient = exports.FTDNApiError = void 0;
+class FTDNApiError extends Error {
+    status;
+    code;
+    constructor(message, status, code) {
+        super(message);
+        this.name = 'FTDNApiError';
+        this.status = status;
+        this.code = code;
+    }
+}
+exports.FTDNApiError = FTDNApiError;
+class HttpClient {
+    /** Exposed for resources that need raw fetch (CSV export, HTML invoice). */
+    baseUrl;
+    apiKey;
+    constructor(apiKey, baseUrl) {
+        this.apiKey = apiKey;
+        this.baseUrl = baseUrl.replace(/\/$/, '');
+    }
+    async request(path, options = {}) {
+        const { method = 'GET', body, params, idempotencyKey } = options;
+        const bodyIdempotencyKey = body && typeof body === 'object' && 'idempotency_key' in body
+            ? String(body.idempotency_key || '')
+            : undefined;
+        const effectiveIdempotencyKey = idempotencyKey || bodyIdempotencyKey || undefined;
+        let url = `${this.baseUrl}${path}`;
+        if (params) {
+            const qs = Object.entries(params)
+                .filter(([, v]) => v !== undefined)
+                .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`)
+                .join('&');
+            if (qs)
+                url += `?${qs}`;
+        }
+        const headers = {
+            'Content-Type': 'application/json',
+            'x-api-key': this.apiKey,
+            ...(effectiveIdempotencyKey ? { 'Idempotency-Key': effectiveIdempotencyKey } : {}),
+        };
+        const response = await fetch(url, {
+            method,
+            headers,
+            body: body ? JSON.stringify(body) : undefined,
+        });
+        const data = await response.json();
+        if (!response.ok) {
+            throw new FTDNApiError(data.message || data.error || `HTTP ${response.status}`, response.status, data.code);
+        }
+        return data;
+    }
+}
+exports.HttpClient = HttpClient;

package/dist/http.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=http.test.d.ts.map

package/dist/http.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.test.d.ts","sourceRoot":"","sources":["../src/http.test.ts"],"names":[],"mappings":""}

package/dist/http.test.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const http_1 = require("./http");
+const mockFetch = vitest_1.vi.fn();
+global.fetch = mockFetch;
+(0, vitest_1.describe)('HttpClient', () => {
+    (0, vitest_1.beforeEach)(() => {
+        mockFetch.mockReset();
+        mockFetch.mockResolvedValue({
+            ok: true,
+            status: 200,
+            json: async () => ({ data: { ok: true } }),
+        });
+    });
+    (0, vitest_1.it)('forwards an explicit idempotency key as the request header', async () => {
+        const client = new http_1.HttpClient('pk_test', 'https://api.example.test/');
+        await client.request('/v1/charges', {
+            method: 'POST',
+            body: { amount: 1000 },
+            idempotencyKey: 'charge-attempt-1',
+        });
+        (0, vitest_1.expect)(mockFetch).toHaveBeenCalledWith('https://api.example.test/v1/charges', vitest_1.expect.objectContaining({
+            method: 'POST',
+            headers: vitest_1.expect.objectContaining({
+                'Idempotency-Key': 'charge-attempt-1',
+                'x-api-key': 'pk_test',
+            }),
+        }));
+    });
+    (0, vitest_1.it)('derives the idempotency header from a compatible body field', async () => {
+        const client = new http_1.HttpClient('pk_test', 'https://api.example.test');
+        await client.request('/v1/checkout/sessions', {
+            method: 'POST',
+            body: { amount: 1000, idempotency_key: 'checkout-attempt-1' },
+        });
+        const [, init] = mockFetch.mock.calls[0];
+        (0, vitest_1.expect)(init.headers['Idempotency-Key']).toBe('checkout-attempt-1');
+        (0, vitest_1.expect)(init.body).toBe(JSON.stringify({ amount: 1000, idempotency_key: 'checkout-attempt-1' }));
+    });
+    (0, vitest_1.it)('does not add an idempotency header to ordinary reads', async () => {
+        const client = new http_1.HttpClient('pk_test', 'https://api.example.test');
+        await client.request('/v1/charges');
+        const [, init] = mockFetch.mock.calls[0];
+        (0, vitest_1.expect)(init.headers['Idempotency-Key']).toBeUndefined();
+    });
+});

package/dist/index.d.ts

@@ -0,0 +1,157 @@
+import { FTDNApiError } from './http';
+import { ChargesResource } from './resources/charges';
+import { MerchantsResource } from './resources/merchants';
+import { SubscriptionsResource } from './resources/subscriptions';
+import { PayoutsResource } from './resources/payouts';
+import { InvoicesResource } from './resources/invoices';
+import { DisputesResource } from './resources/disputes';
+import { ApiKeysResource } from './resources/apiKeys';
+import { WebhooksResource } from './resources/webhooks';
+import { ReferralsResource } from './resources/referrals';
+import { ProvidersResource } from './resources/providers';
+import { CheckoutResource } from './resources/checkout';
+import { AuthResource } from './resources/auth';
+import { CouponsResource } from './resources/coupons';
+import { MeteringResource } from './resources/metering';
+import { ReconciliationResource } from './resources/reconciliation';
+import { FxResource } from './resources/fx';
+import { CurrenciesResource } from './resources/currencies';
+import { AnalyticsResource } from './resources/analytics';
+import { AppsResource } from './resources/apps';
+import { CustomersResource } from './resources/customers';
+import { PaymentLinksResource } from './resources/paymentLinks';
+import { TotpResource } from './resources/totp';
+import { EmailTemplatesResource } from './resources/emailTemplates';
+import { RiskReviewResource } from './resources/riskReview';
+import { BillingResource } from './resources/billing';
+import { WalletsResource } from './resources/wallets';
+import { FinancialAccountsResource } from './resources/financialAccounts';
+import { CurrencyPortfolioResource } from './resources/currencyPortfolio';
+import { PaymentMethodsResource } from './resources/paymentMethods';
+import { PlatformResource } from './resources/platform';
+import { StatusResource } from './resources/status';
+import { RolesResource } from './resources/roles';
+import { PlatformOverview } from './types';
+export interface OpenPayConfig {
+    baseUrl?: string;
+    platformName?: string;
+}
+/** @deprecated Use {@link OpenPayConfig}. Retained for backwards compatibility. */
+export type FTDNApiConfig = OpenPayConfig;
+/**
+ * Open Pay SDK — Stripe-style payment orchestrator client.
+ *
+ * Fully featured SDK for the Open Pay (whitelabel) payment platform.
+ * Supports payments, subscriptions, coupons, metering, reconciliation,
+ * multi-currency FX, hosted checkout, and full auth flow with refresh tokens.
+ *
+ * @example
+ * ```ts
+ * import { OpenPayApi } from '@fiatden/openpay';
+ *
+ * const openpay = new OpenPayApi('pk_your_api_key', { baseUrl: 'https://api.openpay.example.com' });
+ *
+ * // Auth
+ * const { token } = await openpay.auth.login({ email: 'merchant@example.com', password: '...' });
+ *
+ * // Payments
+ * const charge = await openpay.charges.create({
+ *   amount: 500000, // ₦5,000
+ *   email: 'customer@gmail.com',
+ * });
+ *
+ * // Hosted checkout
+ * const session = await openpay.checkout.create({
+ *   amount: 1000000,
+ *   email: 'customer@gmail.com',
+ *   coupon_code: 'WELCOME10',
+ * });
+ * window.open(session.checkout_url);
+ *
+ * // Lago-style billing: billable metrics + events
+ * await openpay.billing.createMetric({ name: 'API Calls', code: 'api_calls', aggregation_type: 'count_agg' });
+ * await openpay.billing.ingestEvent({ transaction_id: 'evt_123', code: 'api_calls', properties: { endpoint: '/v1/charges' } });
+ * const agg = await openpay.billing.aggregateMetric(metric.id, { from: '2026-01-01', to: '2026-02-01' });
+ *
+ * // Wallet-as-a-Service: one wallet per end-user PER WORKSPACE (app)
+ * const wallet = await openpay.wallets.get(appId, customerId);
+ * await openpay.wallets.topup(appId, customerId, { amount: 500000 }); // ₦5,000 via API credit
+ * const { checkout } = await openpay.wallets.createCheckout(appId, customerId, { amount: 500000 }); // or via checkout
+ * window.open(checkout.checkout_url);
+ * if ((await openpay.wallets.check(appId, customerId, { amount: 10000 })).allowed) {
+ *   await openpay.wallets.debit(appId, customerId, { amount: 10000, description: 'API usage' });
+ * }
+ * // Workspace financial account (platform custodies the funds; balance is live)
+ * const account = await openpay.financialAccounts.get(appId);
+ *
+ * // Usage metering (legacy, still supported)
+ * await openpay.metering.record('api_calls', 1);
+ * const report = await openpay.metering.report('api_calls', 'day');
+ *
+ * // Analytics
+ * const overview = await openpay.analytics.getOverview();
+ * const pnl = await openpay.analytics.getPnl({ period_start: '2024-01-01', period_end: '2024-01-31' });
+ * const circuits = await openpay.analytics.getCircuitStatus();
+ *
+ * // Refresh tokens
+ * const { token: newToken } = await openpay.auth.refresh(refreshToken);
+ * ```
+ */
+export declare class OpenPayApi {
+    readonly charges: ChargesResource;
+    readonly merchants: MerchantsResource;
+    readonly subscriptions: SubscriptionsResource;
+    readonly payouts: PayoutsResource;
+    readonly disputes: DisputesResource;
+    readonly apiKeys: ApiKeysResource;
+    readonly webhooks: WebhooksResource;
+    readonly referrals: ReferralsResource;
+    readonly providers: ProvidersResource;
+    readonly checkout: CheckoutResource;
+    readonly auth: AuthResource;
+    readonly coupons: CouponsResource;
+    readonly metering: MeteringResource;
+    readonly reconciliation: ReconciliationResource;
+    readonly fx: FxResource;
+    readonly currencies: CurrenciesResource;
+    readonly analytics: AnalyticsResource;
+    readonly apps: AppsResource;
+    readonly customers: CustomersResource;
+    readonly paymentLinks: PaymentLinksResource;
+    readonly totp: TotpResource;
+    readonly emailTemplates: EmailTemplatesResource;
+    readonly riskReview: RiskReviewResource;
+    readonly billing: BillingResource;
+    readonly wallets: WalletsResource;
+    readonly financialAccounts: FinancialAccountsResource;
+    readonly currencyPortfolio: CurrencyPortfolioResource;
+    readonly paymentMethods: PaymentMethodsResource;
+    readonly platform: PlatformResource;
+    readonly status: StatusResource;
+    readonly invoices: InvoicesResource;
+    readonly roles: RolesResource;
+    readonly platformName: string;
+    private http;
+    /**
+     * @param apiKey - Your Open Pay API key (from dashboard or POST /v1/api-keys)
+     * @param config - Optional configuration (baseUrl, platformName)
+     */
+    constructor(apiKey: string, config?: OpenPayConfig);
+    /** Get platform-wide analytics. */
+    getOverview(): Promise<PlatformOverview>;
+    /** Get P&L statement. */
+    getPnl(params?: {
+        start_date?: string;
+        end_date?: string;
+    }): Promise<any>;
+    /** Get trial balance. */
+    getTrialBalance(asOfDate?: string): Promise<any>;
+    /** Get circuit breaker status for all providers. */
+    getCircuitStatus(): Promise<{
+        data: any[];
+    }>;
+}
+export { FTDNApiError, FTDNApiError as OpenPayError };
+export { OpenPayApi as FTDNApi };
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,YAAY,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,mFAAmF;AACnF,MAAM,MAAM,aAAa,GAAG,aAAa,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,qBAAa,UAAU;IACrB,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,qBAAqB,CAAC;IAC9C,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;IACtC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,cAAc,EAAE,sBAAsB,CAAC;IAChD,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IACxC,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;IACtC,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC;IAC5C,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,cAAc,EAAE,sBAAsB,CAAC;IAChD,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,iBAAiB,EAAE,yBAAyB,CAAC;IACtD,QAAQ,CAAC,iBAAiB,EAAE,yBAAyB,CAAC;IACtD,QAAQ,CAAC,cAAc,EAAE,sBAAsB,CAAC;IAChD,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAE9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,OAAO,CAAC,IAAI,CAAa;IAEzB;;;OAGG;gBACS,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,aAAkB;IAuCtD,mCAAmC;IAC7B,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAI9C,yBAAyB;IACnB,MAAM,CAAC,MAAM,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/E,yBAAyB;IACnB,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAItD,oDAAoD;IAC9C,gBAAgB,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,GAAG,EAAE,CAAA;KAAE,CAAC;CAGnD;AAED,OAAO,EAAE,YAAY,EAAE,YAAY,IAAI,YAAY,EAAE,CAAC;AAEtD,OAAO,EAAE,UAAU,IAAI,OAAO,EAAE,CAAC;AACjC,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,207 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FTDNApi = exports.OpenPayError = exports.FTDNApiError = exports.OpenPayApi = void 0;
+const http_1 = require("./http");
+Object.defineProperty(exports, "FTDNApiError", { enumerable: true, get: function () { return http_1.FTDNApiError; } });
+Object.defineProperty(exports, "OpenPayError", { enumerable: true, get: function () { return http_1.FTDNApiError; } });
+const charges_1 = require("./resources/charges");
+const merchants_1 = require("./resources/merchants");
+const subscriptions_1 = require("./resources/subscriptions");
+const payouts_1 = require("./resources/payouts");
+const invoices_1 = require("./resources/invoices");
+const disputes_1 = require("./resources/disputes");
+const apiKeys_1 = require("./resources/apiKeys");
+const webhooks_1 = require("./resources/webhooks");
+const referrals_1 = require("./resources/referrals");
+const providers_1 = require("./resources/providers");
+const checkout_1 = require("./resources/checkout");
+const auth_1 = require("./resources/auth");
+const coupons_1 = require("./resources/coupons");
+const metering_1 = require("./resources/metering");
+const reconciliation_1 = require("./resources/reconciliation");
+const fx_1 = require("./resources/fx");
+const currencies_1 = require("./resources/currencies");
+const analytics_1 = require("./resources/analytics");
+const apps_1 = require("./resources/apps");
+const customers_1 = require("./resources/customers");
+const paymentLinks_1 = require("./resources/paymentLinks");
+const totp_1 = require("./resources/totp");
+const emailTemplates_1 = require("./resources/emailTemplates");
+const riskReview_1 = require("./resources/riskReview");
+const billing_1 = require("./resources/billing");
+const wallets_1 = require("./resources/wallets");
+const financialAccounts_1 = require("./resources/financialAccounts");
+const currencyPortfolio_1 = require("./resources/currencyPortfolio");
+const paymentMethods_1 = require("./resources/paymentMethods");
+const platform_1 = require("./resources/platform");
+const status_1 = require("./resources/status");
+const roles_1 = require("./resources/roles");
+/**
+ * Open Pay SDK — Stripe-style payment orchestrator client.
+ *
+ * Fully featured SDK for the Open Pay (whitelabel) payment platform.
+ * Supports payments, subscriptions, coupons, metering, reconciliation,
+ * multi-currency FX, hosted checkout, and full auth flow with refresh tokens.
+ *
+ * @example
+ * ```ts
+ * import { OpenPayApi } from '@fiatden/openpay';
+ *
+ * const openpay = new OpenPayApi('pk_your_api_key', { baseUrl: 'https://api.openpay.example.com' });
+ *
+ * // Auth
+ * const { token } = await openpay.auth.login({ email: 'merchant@example.com', password: '...' });
+ *
+ * // Payments
+ * const charge = await openpay.charges.create({
+ *   amount: 500000, // ₦5,000
+ *   email: 'customer@gmail.com',
+ * });
+ *
+ * // Hosted checkout
+ * const session = await openpay.checkout.create({
+ *   amount: 1000000,
+ *   email: 'customer@gmail.com',
+ *   coupon_code: 'WELCOME10',
+ * });
+ * window.open(session.checkout_url);
+ *
+ * // Lago-style billing: billable metrics + events
+ * await openpay.billing.createMetric({ name: 'API Calls', code: 'api_calls', aggregation_type: 'count_agg' });
+ * await openpay.billing.ingestEvent({ transaction_id: 'evt_123', code: 'api_calls', properties: { endpoint: '/v1/charges' } });
+ * const agg = await openpay.billing.aggregateMetric(metric.id, { from: '2026-01-01', to: '2026-02-01' });
+ *
+ * // Wallet-as-a-Service: one wallet per end-user PER WORKSPACE (app)
+ * const wallet = await openpay.wallets.get(appId, customerId);
+ * await openpay.wallets.topup(appId, customerId, { amount: 500000 }); // ₦5,000 via API credit
+ * const { checkout } = await openpay.wallets.createCheckout(appId, customerId, { amount: 500000 }); // or via checkout
+ * window.open(checkout.checkout_url);
+ * if ((await openpay.wallets.check(appId, customerId, { amount: 10000 })).allowed) {
+ *   await openpay.wallets.debit(appId, customerId, { amount: 10000, description: 'API usage' });
+ * }
+ * // Workspace financial account (platform custodies the funds; balance is live)
+ * const account = await openpay.financialAccounts.get(appId);
+ *
+ * // Usage metering (legacy, still supported)
+ * await openpay.metering.record('api_calls', 1);
+ * const report = await openpay.metering.report('api_calls', 'day');
+ *
+ * // Analytics
+ * const overview = await openpay.analytics.getOverview();
+ * const pnl = await openpay.analytics.getPnl({ period_start: '2024-01-01', period_end: '2024-01-31' });
+ * const circuits = await openpay.analytics.getCircuitStatus();
+ *
+ * // Refresh tokens
+ * const { token: newToken } = await openpay.auth.refresh(refreshToken);
+ * ```
+ */
+class OpenPayApi {
+    charges;
+    merchants;
+    subscriptions;
+    payouts;
+    disputes;
+    apiKeys;
+    webhooks;
+    referrals;
+    providers;
+    checkout;
+    auth;
+    coupons;
+    metering;
+    reconciliation;
+    fx;
+    currencies;
+    analytics;
+    apps;
+    customers;
+    paymentLinks;
+    totp;
+    emailTemplates;
+    riskReview;
+    billing;
+    wallets;
+    financialAccounts;
+    currencyPortfolio;
+    paymentMethods;
+    platform;
+    status;
+    invoices;
+    roles;
+    platformName;
+    http;
+    /**
+     * @param apiKey - Your Open Pay API key (from dashboard or POST /v1/api-keys)
+     * @param config - Optional configuration (baseUrl, platformName)
+     */
+    constructor(apiKey, config = {}) {
+        const baseUrl = config.baseUrl || 'http://localhost:3000';
+        this.platformName = config.platformName || 'Open Pay';
+        this.http = new http_1.HttpClient(apiKey, baseUrl);
+        this.charges = new charges_1.ChargesResource(this.http);
+        this.merchants = new merchants_1.MerchantsResource(this.http);
+        this.subscriptions = new subscriptions_1.SubscriptionsResource(this.http);
+        this.payouts = new payouts_1.PayoutsResource(this.http);
+        this.disputes = new disputes_1.DisputesResource(this.http);
+        this.apiKeys = new apiKeys_1.ApiKeysResource(this.http);
+        this.webhooks = new webhooks_1.WebhooksResource(this.http);
+        this.referrals = new referrals_1.ReferralsResource(this.http);
+        this.providers = new providers_1.ProvidersResource(this.http);
+        this.checkout = new checkout_1.CheckoutResource(this.http);
+        this.auth = new auth_1.AuthResource(this.http);
+        this.coupons = new coupons_1.CouponsResource(this.http);
+        this.metering = new metering_1.MeteringResource(this.http);
+        this.reconciliation = new reconciliation_1.ReconciliationResource(this.http);
+        this.fx = new fx_1.FxResource(this.http);
+        this.currencies = new currencies_1.CurrenciesResource(this.http);
+        this.analytics = new analytics_1.AnalyticsResource(this.http);
+        this.apps = new apps_1.AppsResource(this.http);
+        this.customers = new customers_1.CustomersResource(this.http);
+        this.paymentLinks = new paymentLinks_1.PaymentLinksResource(this.http);
+        this.totp = new totp_1.TotpResource(this.http);
+        this.emailTemplates = new emailTemplates_1.EmailTemplatesResource(this.http);
+        this.riskReview = new riskReview_1.RiskReviewResource(this.http);
+        this.billing = new billing_1.BillingResource(this.http);
+        this.wallets = new wallets_1.WalletsResource(this.http);
+        this.financialAccounts = new financialAccounts_1.FinancialAccountsResource(this.http);
+        this.currencyPortfolio = new currencyPortfolio_1.CurrencyPortfolioResource(this.http);
+        this.paymentMethods = new paymentMethods_1.PaymentMethodsResource(this.http);
+        this.platform = new platform_1.PlatformResource(this.http);
+        this.status = new status_1.StatusResource(this.http);
+        this.invoices = new invoices_1.InvoicesResource(this.http);
+        this.roles = new roles_1.RolesResource(this.http);
+    }
+    /** Get platform-wide analytics. */
+    async getOverview() {
+        return this.analytics.getOverview();
+    }
+    /** Get P&L statement. */
+    async getPnl(params) {
+        return this.analytics.getPnl(params);
+    }
+    /** Get trial balance. */
+    async getTrialBalance(asOfDate) {
+        return this.analytics.getTrialBalance(asOfDate);
+    }
+    /** Get circuit breaker status for all providers. */
+    async getCircuitStatus() {
+        return this.analytics.getCircuitStatus();
+    }
+}
+exports.OpenPayApi = OpenPayApi;
+exports.FTDNApi = OpenPayApi;
+__exportStar(require("./types"), exports);

package/dist/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index.test.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const index_1 = require("./index");
+const mockFetch = vitest_1.vi.fn();
+global.fetch = mockFetch;
+(0, vitest_1.describe)('OpenPayApi surface', () => {
+    (0, vitest_1.beforeEach)(() => {
+        mockFetch.mockReset();
+        mockFetch.mockResolvedValue({
+            ok: true,
+            status: 200,
+            json: async () => ({ data: {} }),
+        });
+    });
+    (0, vitest_1.it)('exposes every platform resource, including the new ones', () => {
+        const openpay = new index_1.OpenPayApi('pk_test', { baseUrl: 'https://api.example.test' });
+        for (const r of [
+            'charges', 'checkout', 'subscriptions', 'coupons', 'customers', 'apps',
+            'payouts', 'disputes', 'apiKeys', 'webhooks', 'metering', 'reconciliation',
+            'fx', 'currencies', 'analytics', 'providers', 'paymentLinks', 'referrals',
+            'riskReview', 'emailTemplates', 'totp', 'auth', 'billing', 'wallets',
+            'financialAccounts', 'currencyPortfolio', 'paymentMethods', 'platform', 'status',
+            'invoices', 'roles',
+        ]) {
+            (0, vitest_1.expect)(openpay[r], `missing resource ${r}`).toBeDefined();
+        }
+    });
+    (0, vitest_1.it)('scopes wallet reads to a workspace via app_id', async () => {
+        const openpay = new index_1.OpenPayApi('pk_test', { baseUrl: 'https://api.example.test' });
+        await openpay.wallets.get('app-1', 'cust-1');
+        (0, vitest_1.expect)(mockFetch.mock.calls[0][0]).toBe('https://api.example.test/v1/wallets/cust-1?app_id=app-1');
+    });
+    (0, vitest_1.it)('sends app_id in wallet top-up bodies', async () => {
+        const openpay = new index_1.OpenPayApi('pk_test', { baseUrl: 'https://api.example.test' });
+        await openpay.wallets.topup('app-1', 'cust-1', { amount: 500000 });
+        const [, init] = mockFetch.mock.calls[0];
+        (0, vitest_1.expect)(mockFetch.mock.calls[0][0]).toBe('https://api.example.test/v1/wallets/cust-1/topup');
+        (0, vitest_1.expect)(JSON.parse(init.body)).toEqual({ app_id: 'app-1', amount: 500000 });
+    });
+    (0, vitest_1.it)('exposes the financial-account statement endpoints', async () => {
+        const openpay = new index_1.OpenPayApi('pk_test', { baseUrl: 'https://api.example.test' });
+        await openpay.financialAccounts.get('app-1');
+        await openpay.financialAccounts.statement('app-1');
+        (0, vitest_1.expect)(mockFetch.mock.calls[0][0]).toBe('https://api.example.test/v1/financial-accounts/app-1');
+        (0, vitest_1.expect)(mockFetch.mock.calls[1][0]).toBe('https://api.example.test/v1/financial-accounts/app-1/statement');
+    });
+    (0, vitest_1.it)('exposes the admin platform + public status resources', async () => {
+        const openpay = new index_1.OpenPayApi('pk_test', { baseUrl: 'https://api.example.test' });
+        await openpay.platform.getStatus();
+        await openpay.status.get();
+        (0, vitest_1.expect)(mockFetch.mock.calls[0][0]).toBe('https://api.example.test/v1/platform/status');
+        (0, vitest_1.expect)(mockFetch.mock.calls[1][0]).toBe('https://api.example.test/status');
+    });
+});