@pulsebyshiga/node 0.2.0

package/dist/resources/banks.js

@@ -0,0 +1,21 @@
+export class Banks {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /** Supported banks (name + NIP code) for offramp payout targets. */
+    list() {
+        return this.http.request({
+            method: 'GET',
+            path: '/v1/banks',
+        });
+    }
+    /** Name enquiry — verify an account before creating an offramp order against it. */
+    resolve(params) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/banks/resolve',
+            body: params,
+        });
+    }
+}

package/dist/resources/collectionOrders.d.ts

@@ -0,0 +1,12 @@
+import type { HttpClient } from '../client.js';
+import type { CollectionOrder, ListOrdersParams, Page } from '../types.js';
+export declare class CollectionOrders {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Ground truth for an order — the fallback when a webhook is missed. */
+    retrieve(orderId: string): Promise<CollectionOrder>;
+    /** Re-lock the quote for an expired order (new 10-minute window). */
+    refreshQuote(orderId: string): Promise<CollectionOrder>;
+    /** Partner-scoped listing for reconciliation. */
+    list(params?: ListOrdersParams): Promise<Page<CollectionOrder>>;
+}

package/dist/resources/collectionOrders.js

@@ -0,0 +1,36 @@
+export class CollectionOrders {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /** Ground truth for an order — the fallback when a webhook is missed. */
+    retrieve(orderId) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/collection-orders/${encodeURIComponent(orderId)}`,
+        });
+    }
+    /** Re-lock the quote for an expired order (new 10-minute window). */
+    refreshQuote(orderId) {
+        return this.http.request({
+            method: 'POST',
+            path: `/v1/collection-orders/${encodeURIComponent(orderId)}/refresh_quote`,
+        });
+    }
+    /** Partner-scoped listing for reconciliation. */
+    list(params = {}) {
+        return this.http.request({
+            method: 'GET',
+            path: '/v1/collection-orders',
+            query: {
+                gate: params.gate,
+                status: params.status,
+                user_ref: params.user_ref,
+                created_after: params.created_after,
+                created_before: params.created_before,
+                limit: params.limit,
+                cursor: params.cursor,
+            },
+        });
+    }
+}

package/dist/resources/collectionSessions.d.ts

@@ -0,0 +1,16 @@
+import type { HttpClient } from '../client.js';
+import type { CollectionSession, CreateCollectionSessionParams } from '../types.js';
+export type CreateSessionOptions = {
+    /** Client idempotency key; auto-generated when omitted. */
+    idempotencyKey?: string;
+};
+export declare class CollectionSessions {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Create a collection order plus the single-order session token the hosted
+     * flow is opened with. Naira gate carries the account block (BVN/NIN on
+     * first use); USD gate carries no per-user identity.
+     */
+    create(params: CreateCollectionSessionParams, options?: CreateSessionOptions): Promise<CollectionSession>;
+}

package/dist/resources/collectionSessions.js

@@ -0,0 +1,19 @@
+export class CollectionSessions {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Create a collection order plus the single-order session token the hosted
+     * flow is opened with. Naira gate carries the account block (BVN/NIN on
+     * first use); USD gate carries no per-user identity.
+     */
+    create(params, options = {}) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/collection-sessions',
+            body: params,
+            idempotencyKey: options.idempotencyKey,
+        });
+    }
+}

package/dist/resources/offramp.d.ts

@@ -0,0 +1,11 @@
+import type { HttpClient } from '../client.js';
+import type { CreateOfframpOrderParams, OfframpOrder } from '../types.js';
+/** Crypto → fiat: user sends stablecoin to the order's deposit address; fiat settles to the bank account. */
+export declare class Offramp {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Create an offramp order from a live quote. Resolve the bank account first (banks.resolve). */
+    create(params: CreateOfframpOrderParams): Promise<OfframpOrder>;
+    /** Ground truth for an order's lifecycle — poll until a terminal status. */
+    retrieve(orderId: string): Promise<OfframpOrder>;
+}

package/dist/resources/offramp.js

@@ -0,0 +1,22 @@
+/** Crypto → fiat: user sends stablecoin to the order's deposit address; fiat settles to the bank account. */
+export class Offramp {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /** Create an offramp order from a live quote. Resolve the bank account first (banks.resolve). */
+    create(params) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/offramp/orders',
+            body: params,
+        });
+    }
+    /** Ground truth for an order's lifecycle — poll until a terminal status. */
+    retrieve(orderId) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/offramp/orders/${encodeURIComponent(orderId)}`,
+        });
+    }
+}

package/dist/resources/onramp.d.ts

@@ -0,0 +1,11 @@
+import type { HttpClient } from '../client.js';
+import type { CreateOnrampOrderParams, OnrampOrder } from '../types.js';
+/** Fiat → crypto: user pays the order's virtual bank account; crypto is sent to the destination address. */
+export declare class Onramp {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Create an onramp order from a live quote. The response carries the virtual account to pay. */
+    create(params: CreateOnrampOrderParams): Promise<OnrampOrder>;
+    /** Ground truth for an order's lifecycle — poll until a terminal status. */
+    retrieve(orderId: string): Promise<OnrampOrder>;
+}

package/dist/resources/onramp.js

@@ -0,0 +1,22 @@
+/** Fiat → crypto: user pays the order's virtual bank account; crypto is sent to the destination address. */
+export class Onramp {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /** Create an onramp order from a live quote. The response carries the virtual account to pay. */
+    create(params) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/onramp/orders',
+            body: params,
+        });
+    }
+    /** Ground truth for an order's lifecycle — poll until a terminal status. */
+    retrieve(orderId) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/onramp/orders/${encodeURIComponent(orderId)}`,
+        });
+    }
+}

package/dist/resources/quotes.d.ts

@@ -0,0 +1,11 @@
+import type { HttpClient } from '../client.js';
+import type { CreateQuoteParams, Quote } from '../types.js';
+export declare class Quotes {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Lock a price. The returned `quote.id` is what offramp/onramp orders are
+     * created from — create the order before `expires_at` passes.
+     */
+    create(params: CreateQuoteParams): Promise<Quote>;
+}

package/dist/resources/quotes.js

@@ -0,0 +1,17 @@
+export class Quotes {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Lock a price. The returned `quote.id` is what offramp/onramp orders are
+     * created from — create the order before `expires_at` passes.
+     */
+    create(params) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/quotes',
+            body: params,
+        });
+    }
+}

package/dist/resources/rates.d.ts

@@ -0,0 +1,38 @@
+import type { HttpClient } from '../client.js';
+import type { EngineNetwork } from '../types.js';
+export type RatePreviewParams = {
+    /** Source currency/asset, e.g. "USDC". */
+    from: string;
+    /** Destination currency, e.g. "NGN". */
+    to: string;
+    /** Decimal amount in the source currency, e.g. "100.00". */
+    amount: string;
+    network?: EngineNetwork;
+};
+/**
+ * A rate you can show before any transaction. Backed by a quote, so the price
+ * is real and locked — but no order exists and no funds move until you create
+ * one from `quoteId`.
+ */
+export type RatePreview = {
+    /** Units of `to` per one unit of `from`, decimal string. */
+    rate: string;
+    /** What the user parts with (equals the requested amount), decimal string. */
+    youSend: string;
+    /** What the user gets at this rate, decimal string. */
+    youReceive: string;
+    /** When the locked rate expires (ISO 8601). */
+    expiresAt: string;
+    /** Pass to offramp/onramp create to transact at exactly this locked rate. */
+    quoteId: string;
+};
+export declare class Rates {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Look up the live rate without placing an order. Wraps POST /v1/quotes and
+     * reshapes it for display; the returned `quoteId` lets you proceed to an
+     * order at the same locked price if the user decides to.
+     */
+    preview(params: RatePreviewParams): Promise<RatePreview>;
+}

package/dist/resources/rates.js

@@ -0,0 +1,30 @@
+export class Rates {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * Look up the live rate without placing an order. Wraps POST /v1/quotes and
+     * reshapes it for display; the returned `quoteId` lets you proceed to an
+     * order at the same locked price if the user decides to.
+     */
+    async preview(params) {
+        const quote = await this.http.request({
+            method: 'POST',
+            path: '/v1/quotes',
+            body: {
+                amount: params.amount,
+                source_currency: params.from,
+                destination_currency: params.to,
+                network: params.network,
+            },
+        });
+        return {
+            rate: quote.rate,
+            youSend: quote.source_amount,
+            youReceive: quote.destination_amount,
+            expiresAt: quote.expires_at,
+            quoteId: quote.id,
+        };
+    }
+}