@temboplus/tembo-dashboard 0.2.7 → 0.3.0-rc.1

package/dist/modules/settlement/settlement.api-contract.d.ts

@@ -0,0 +1,255 @@
+import { z } from "zod";
+export declare const settlementContract: {
+    getSettlements: {
+        query: z.ZodObject<{
+            status: z.ZodOptional<z.ZodEnum<typeof import("./settlement.types.js").SETTLEMENT_STATUS>>;
+            accountNo: z.ZodOptional<z.ZodString>;
+            walletId: z.ZodOptional<z.ZodString>;
+        }, z.core.$catchall<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
+        summary: "List settlements";
+        description: "Retrieve settlements belonging to your vendor, with optional filtering and sorting via query params";
+        method: "GET";
+        path: "";
+        responses: {
+            200: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                date: z.ZodString;
+                initiatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                initiatedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                actionedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                actionedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                vendorId: z.ZodString;
+                walletId: z.ZodString;
+                accountNo: z.ZodString;
+                status: z.ZodEnum<typeof import("./settlement.types.js").SETTLEMENT_STATUS>;
+                statusCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                description: z.ZodString;
+                bankAccountNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                bankAccountName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                bankCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                amount: z.ZodNumber;
+                payoutId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            }, z.core.$strip>>;
+            401: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<401>;
+            }, z.core.$strip>;
+            403: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<403>;
+            }, z.core.$strip>;
+            500: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<500>;
+            }, z.core.$strip>;
+        };
+    };
+    getSettlement: {
+        pathParams: z.ZodObject<{
+            id: z.ZodString;
+        }, z.core.$strip>;
+        summary: "Get settlement details";
+        description: "Retrieve detailed information about a specific settlement";
+        method: "GET";
+        path: "/:id";
+        responses: {
+            200: z.ZodObject<{
+                id: z.ZodString;
+                date: z.ZodString;
+                initiatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                initiatedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                actionedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                actionedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                vendorId: z.ZodString;
+                walletId: z.ZodString;
+                accountNo: z.ZodString;
+                status: z.ZodEnum<typeof import("./settlement.types.js").SETTLEMENT_STATUS>;
+                statusCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                description: z.ZodString;
+                bankAccountNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                bankAccountName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                bankCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                amount: z.ZodNumber;
+                payoutId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            }, z.core.$strip>;
+            401: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<401>;
+            }, z.core.$strip>;
+            403: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<403>;
+            }, z.core.$strip>;
+            404: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<404>;
+            }, z.core.$strip>;
+            500: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<500>;
+            }, z.core.$strip>;
+        };
+    };
+    createSettlement: {
+        summary: "Create settlement";
+        description: string;
+        method: "POST";
+        body: z.ZodObject<{
+            accountNo: z.ZodString;
+            description: z.ZodString;
+            amount: z.ZodNumber;
+        }, z.core.$strip>;
+        path: "";
+        responses: {
+            201: z.ZodObject<{
+                status: z.ZodEnum<typeof import("./settlement.types.js").CREATE_SETTLEMENT_STATUS>;
+                data: z.ZodOptional<z.ZodObject<{
+                    id: z.ZodString;
+                    date: z.ZodString;
+                    initiatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    initiatedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    actionedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    actionedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    vendorId: z.ZodString;
+                    walletId: z.ZodString;
+                    accountNo: z.ZodString;
+                    status: z.ZodEnum<typeof import("./settlement.types.js").SETTLEMENT_STATUS>;
+                    statusCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    description: z.ZodString;
+                    bankAccountNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    bankAccountName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    bankCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    amount: z.ZodNumber;
+                    payoutId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    createdAt: z.ZodString;
+                    updatedAt: z.ZodString;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+            400: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<400>;
+            }, z.core.$strip>;
+            401: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<401>;
+            }, z.core.$strip>;
+            403: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<403>;
+            }, z.core.$strip>;
+            500: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<500>;
+            }, z.core.$strip>;
+        };
+    };
+    actionSettlement: {
+        pathParams: z.ZodObject<{
+            id: z.ZodString;
+        }, z.core.$strip>;
+        summary: "Action settlement";
+        description: string;
+        method: "POST";
+        body: z.ZodObject<{
+            status: z.ZodEnum<typeof import("./settlement.types.js").SETTLEMENT_ACTION>;
+        }, z.core.$strip>;
+        path: "/:id/action";
+        responses: {
+            201: z.ZodObject<{
+                status: z.ZodEnum<typeof import("./settlement.types.js").ACTION_SETTLEMENT_STATUS>;
+                data: z.ZodOptional<z.ZodObject<{
+                    id: z.ZodString;
+                    date: z.ZodString;
+                    initiatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    initiatedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    actionedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    actionedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    vendorId: z.ZodString;
+                    walletId: z.ZodString;
+                    accountNo: z.ZodString;
+                    status: z.ZodEnum<typeof import("./settlement.types.js").SETTLEMENT_STATUS>;
+                    statusCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    description: z.ZodString;
+                    bankAccountNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    bankAccountName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    bankCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    amount: z.ZodNumber;
+                    payoutId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    createdAt: z.ZodString;
+                    updatedAt: z.ZodString;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+            400: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<400>;
+            }, z.core.$strip>;
+            401: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<401>;
+            }, z.core.$strip>;
+            403: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<403>;
+            }, z.core.$strip>;
+            500: z.ZodObject<{
+                reason: z.ZodOptional<z.ZodString>;
+                error: z.ZodOptional<z.ZodString>;
+                details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                message: z.ZodOptional<z.ZodString>;
+                statusCode: z.ZodLiteral<500>;
+            }, z.core.$strip>;
+        };
+    };
+};
+export type SettlementContract = typeof settlementContract;
+//# sourceMappingURL=settlement.api-contract.d.ts.map

package/dist/modules/settlement/settlement.api-contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settlement.api-contract.d.ts","sourceRoot":"","sources":["../../../src/modules/settlement/settlement.api-contract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwE7B,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,OAAO,kBAAkB,CAAC"}

package/dist/modules/settlement/settlement.model.d.ts

@@ -0,0 +1,106 @@
+import { Amount } from "@temboplus/frontend-core";
+import { SETTLEMENT_STATUS } from "./settlement.types.js";
+export interface SettlementStatusInfo {
+    label: string;
+    description: string;
+    category: "success" | "pending" | "failed";
+    color: "success" | "warning" | "error";
+    userFriendlyMessage: string;
+}
+export declare const SETTLEMENT_STATUS_INFO: Record<SETTLEMENT_STATUS, SettlementStatusInfo>;
+/**
+ * Raw settlement data as returned by the API.
+ */
+export interface SettlementData {
+    id: string;
+    date: string;
+    initiatedAt?: string | null;
+    initiatedById?: string | null;
+    actionedAt?: string | null;
+    actionedById?: string | null;
+    vendorId: string;
+    walletId: string;
+    accountNo: string;
+    status: SETTLEMENT_STATUS;
+    statusCode?: string | null;
+    description: string;
+    bankAccountNo?: string | null;
+    bankAccountName?: string | null;
+    bankCode?: string | null;
+    amount: number;
+    payoutId?: string | null;
+    transactionId?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Represents a settlement — a movement of funds from a vendor's
+ * wallet to their bank account.
+ */
+export declare class Settlement {
+    readonly id: string;
+    readonly date: Date;
+    readonly initiatedAt?: Date;
+    readonly initiatedById?: string | null;
+    readonly actionedAt?: Date;
+    readonly actionedById?: string | null;
+    readonly vendorId: string;
+    readonly walletId: string;
+    readonly accountNo: string;
+    readonly status: SETTLEMENT_STATUS;
+    readonly statusCode?: string | null;
+    readonly description: string;
+    readonly bankAccountNo?: string | null;
+    readonly bankAccountName?: string | null;
+    readonly bankCode?: string | null;
+    readonly amount: Amount;
+    readonly payoutId?: string | null;
+    readonly transactionId?: string | null;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+    private readonly _originalData;
+    constructor(data: SettlementData);
+    /**
+     * Get access to the original data used to create this settlement
+     */
+    getOriginalData(): Readonly<SettlementData>;
+    /**
+     * Check if the settlement is awaiting approval
+     */
+    isPending(): boolean;
+    /**
+     * Check if the settlement was approved
+     */
+    isApproved(): boolean;
+    /**
+     * Check if the settlement was rejected
+     */
+    isRejected(): boolean;
+    /**
+     * Check if the settlement can still be approved or rejected.
+     * Only PENDING settlements can be actioned, and never by the
+     * user who initiated them (enforced server-side).
+     */
+    canBeActioned(): boolean;
+    /**
+     * Get status color and label
+     */
+    getStatusInfo(): SettlementStatusInfo;
+    /**
+     * Create Settlement instance from raw API data
+     */
+    static from(data: unknown): Settlement | undefined;
+    /**
+     * Create multiple Settlement instances from raw API data
+     */
+    static createMany(dataArray: unknown[]): Settlement[];
+    /**
+     * Create Settlement instance from JSON (same shape as SettlementData)
+     */
+    static fromJSON(json: SettlementData): Settlement | undefined;
+    /**
+     * Convert to JSON representation (same shape as SettlementData)
+     */
+    toJSON(): SettlementData;
+}
+//# sourceMappingURL=settlement.model.d.ts.map

package/dist/modules/settlement/settlement.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settlement.model.d.ts","sourceRoot":"","sources":["../../../src/modules/settlement/settlement.model.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAI1D,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC3C,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;IACvC,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAsBlF,CAAC;AAkBF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAID;;;GAGG;AACH,qBAAa,UAAU;IACrB,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,SAAgB,IAAI,EAAE,IAAI,CAAC;IAC3B,SAAgB,WAAW,CAAC,EAAE,IAAI,CAAC;IACnC,SAAgB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9C,SAAgB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClC,SAAgB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7C,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,SAAgB,MAAM,EAAE,iBAAiB,CAAC;IAC1C,SAAgB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9C,SAAgB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChD,SAAgB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,SAAgB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9C,SAAgB,SAAS,EAAE,IAAI,CAAC;IAChC,SAAgB,SAAS,EAAE,IAAI,CAAC;IAGhC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiB;gBAEnC,IAAI,EAAE,cAAc;IA2BhC;;OAEG;IACH,eAAe,IAAI,QAAQ,CAAC,cAAc,CAAC;IAI3C;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,UAAU,IAAI,OAAO;IAIrB;;OAEG;IACH,UAAU,IAAI,OAAO;IAIrB;;;;OAIG;IACH,aAAa,IAAI,OAAO;IAIxB;;OAEG;IACH,aAAa,IAAI,oBAAoB;IAIrC;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS;IAclD;;OAEG;IACH,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE;IAWrD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,UAAU,GAAG,SAAS;IAI7D;;OAEG;IACH,MAAM,IAAI,cAAc;CAGzB"}

package/dist/modules/settlement/settlement.repository.d.ts

@@ -0,0 +1,75 @@
+import { BaseRepository } from "../../lib/api/index.js";
+import { settlementContract } from "./settlement.api-contract.js";
+import { Settlement } from "./settlement.model.js";
+import { type ACTION_SETTLEMENT_STATUS, type CREATE_SETTLEMENT_STATUS, SETTLEMENT_ACTION, type SettlementFilters } from "./settlement.types.js";
+/**
+ * Input for creating a new settlement request.
+ */
+export interface CreateSettlementInput {
+    /** Source wallet account number — must belong to your vendor */
+    accountNo: string;
+    description: string;
+    /** Must not be 0 */
+    amount: number;
+}
+/**
+ * Outcome of a settlement creation request.
+ * `settlement` is only present when `status` is `SUCCESS`.
+ */
+export interface CreateSettlementResult {
+    status: CREATE_SETTLEMENT_STATUS;
+    settlement?: Settlement;
+}
+/**
+ * Outcome of a settlement approval/rejection request.
+ * `settlement` is present when `status` is `SUCCESS` (updated state)
+ * or `INVALID_STATE` (current state).
+ */
+export interface ActionSettlementResult {
+    status: ACTION_SETTLEMENT_STATUS;
+    settlement?: Settlement;
+}
+/**
+ * Repository class for managing settlements through API interactions.
+ * Handles listing, creating and actioning (approving/rejecting) settlements.
+ *
+ * The create and action endpoints report expected failures via a `status`
+ * field in the response body rather than HTTP errors — the corresponding
+ * methods return that status instead of throwing, so callers must inspect it.
+ */
+export declare class SettlementRepository extends BaseRepository<typeof settlementContract> {
+    constructor(options?: {
+        token?: string;
+        root?: string;
+    });
+    /**
+     * Get all settlements belonging to your vendor, with optional
+     * filtering/sorting (e.g. `{ status: SETTLEMENT_STATUS.PENDING }`)
+     */
+    getSettlements(filters?: SettlementFilters): Promise<Settlement[]>;
+    /**
+     * Get a specific settlement by ID
+     */
+    getSettlement(id: string): Promise<Settlement>;
+    /**
+     * Create a new settlement request, initiated by the authenticated user.
+     * Inspect `status` on the result — expected failures (e.g.
+     * `WALLET_NOT_FOUND`, `MISSING_BANK_DETAILS`) do not throw.
+     */
+    createSettlement(input: CreateSettlementInput): Promise<CreateSettlementResult>;
+    /**
+     * Approve or reject a PENDING settlement, actioned by the authenticated
+     * user. Inspect `status` on the result — expected failures (e.g.
+     * `INVALID_STATE`, `SELF_ACTION_NOT_ALLOWED`) do not throw.
+     */
+    actionSettlement(id: string, action: SETTLEMENT_ACTION): Promise<ActionSettlementResult>;
+    /**
+     * Convenience wrapper for approving a settlement
+     */
+    approveSettlement(id: string): Promise<ActionSettlementResult>;
+    /**
+     * Convenience wrapper for rejecting a settlement
+     */
+    rejectSettlement(id: string): Promise<ActionSettlementResult>;
+}
+//# sourceMappingURL=settlement.repository.d.ts.map

package/dist/modules/settlement/settlement.repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settlement.repository.d.ts","sourceRoot":"","sources":["../../../src/modules/settlement/settlement.repository.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,UAAU,EAAuB,MAAM,uBAAuB,CAAC;AACxE,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,iBAAiB,EACjB,KAAK,iBAAiB,EACvB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,wBAAwB,CAAC;IACjC,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,wBAAwB,CAAC;IACjC,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CAAC,OAAO,kBAAkB,CAAC;gBACrE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;IAIvD;;;OAGG;IACG,cAAc,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAMxE;;OAEG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAUpD;;;;OAIG;IACG,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAarF;;;;OAIG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAgB9F;;OAEG;IACG,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAIpE;;OAEG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAGpE"}

package/dist/modules/settlement/settlement.types.d.ts

@@ -0,0 +1,140 @@
+import { z } from "zod";
+/**
+ * Lifecycle statuses of a settlement.
+ */
+export declare enum SETTLEMENT_STATUS {
+    PENDING = "PENDING",
+    APPROVED = "APPROVED",
+    REJECTED = "REJECTED"
+}
+/**
+ * Actions that can be taken on a `PENDING` settlement.
+ */
+export declare enum SETTLEMENT_ACTION {
+    APPROVED = "APPROVED",
+    REJECTED = "REJECTED"
+}
+/**
+ * Outcome statuses returned in the body of `POST /settlement`.
+ * The API responds with HTTP success even for expected failures —
+ * callers must inspect this status, not just the HTTP status code.
+ */
+export declare enum CREATE_SETTLEMENT_STATUS {
+    SUCCESS = "SUCCESS",
+    WALLET_NOT_FOUND = "WALLET_NOT_FOUND",
+    INITIATOR_NOT_AUTHORIZED = "INITIATOR_NOT_AUTHORIZED",
+    MISSING_BANK_DETAILS = "MISSING_BANK_DETAILS",
+    UNSUPPORTED_BANK_CODE = "UNSUPPORTED_BANK_CODE",
+    FAILED = "FAILED"
+}
+/**
+ * Outcome statuses returned in the body of `POST /settlement/:id/action`.
+ * The API responds with HTTP success even for expected failures —
+ * callers must inspect this status, not just the HTTP status code.
+ */
+export declare enum ACTION_SETTLEMENT_STATUS {
+    SUCCESS = "SUCCESS",
+    SETTLEMENT_NOT_FOUND = "SETTLEMENT_NOT_FOUND",
+    ACTIONER_NOT_AUTHORIZED = "ACTIONER_NOT_AUTHORIZED",
+    SELF_ACTION_NOT_ALLOWED = "SELF_ACTION_NOT_ALLOWED",
+    INVALID_STATE = "INVALID_STATE",
+    FAILED = "FAILED"
+}
+export declare const SettlementDTOSchemas: {
+    settlement: z.ZodObject<{
+        id: z.ZodString;
+        date: z.ZodString;
+        initiatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        initiatedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        actionedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        actionedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        vendorId: z.ZodString;
+        walletId: z.ZodString;
+        accountNo: z.ZodString;
+        status: z.ZodEnum<typeof SETTLEMENT_STATUS>;
+        statusCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        description: z.ZodString;
+        bankAccountNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        bankAccountName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        bankCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        amount: z.ZodNumber;
+        payoutId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>;
+    settlementStatus: z.ZodEnum<typeof SETTLEMENT_STATUS>;
+    settlementAction: z.ZodEnum<typeof SETTLEMENT_ACTION>;
+    settlementFilters: z.ZodObject<{
+        status: z.ZodOptional<z.ZodEnum<typeof SETTLEMENT_STATUS>>;
+        accountNo: z.ZodOptional<z.ZodString>;
+        walletId: z.ZodOptional<z.ZodString>;
+    }, z.core.$catchall<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>;
+    createSettlementRequest: z.ZodObject<{
+        accountNo: z.ZodString;
+        description: z.ZodString;
+        amount: z.ZodNumber;
+    }, z.core.$strip>;
+    createSettlementStatus: z.ZodEnum<typeof CREATE_SETTLEMENT_STATUS>;
+    createSettlementResponse: z.ZodObject<{
+        status: z.ZodEnum<typeof CREATE_SETTLEMENT_STATUS>;
+        data: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            date: z.ZodString;
+            initiatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            initiatedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            actionedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            actionedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            vendorId: z.ZodString;
+            walletId: z.ZodString;
+            accountNo: z.ZodString;
+            status: z.ZodEnum<typeof SETTLEMENT_STATUS>;
+            statusCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            description: z.ZodString;
+            bankAccountNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            bankAccountName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            bankCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            amount: z.ZodNumber;
+            payoutId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            createdAt: z.ZodString;
+            updatedAt: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    actionSettlementRequest: z.ZodObject<{
+        status: z.ZodEnum<typeof SETTLEMENT_ACTION>;
+    }, z.core.$strip>;
+    actionSettlementStatus: z.ZodEnum<typeof ACTION_SETTLEMENT_STATUS>;
+    actionSettlementResponse: z.ZodObject<{
+        status: z.ZodEnum<typeof ACTION_SETTLEMENT_STATUS>;
+        data: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            date: z.ZodString;
+            initiatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            initiatedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            actionedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            actionedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            vendorId: z.ZodString;
+            walletId: z.ZodString;
+            accountNo: z.ZodString;
+            status: z.ZodEnum<typeof SETTLEMENT_STATUS>;
+            statusCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            description: z.ZodString;
+            bankAccountNo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            bankAccountName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            bankCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            amount: z.ZodNumber;
+            payoutId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            transactionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            createdAt: z.ZodString;
+            updatedAt: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+};
+export type SettlementDTO = z.infer<typeof SettlementDTOSchemas.settlement>;
+export type SettlementFilters = z.infer<typeof SettlementDTOSchemas.settlementFilters>;
+export type CreateSettlementRequestDTO = z.infer<typeof SettlementDTOSchemas.createSettlementRequest>;
+export type CreateSettlementResponseDTO = z.infer<typeof SettlementDTOSchemas.createSettlementResponse>;
+export type ActionSettlementRequestDTO = z.infer<typeof SettlementDTOSchemas.actionSettlementRequest>;
+export type ActionSettlementResponseDTO = z.infer<typeof SettlementDTOSchemas.actionSettlementResponse>;
+//# sourceMappingURL=settlement.types.d.ts.map

package/dist/modules/settlement/settlement.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settlement.types.d.ts","sourceRoot":"","sources":["../../../src/modules/settlement/settlement.types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED;;;;GAIG;AACH,oBAAY,wBAAwB;IAClC,OAAO,YAAY;IACnB,gBAAgB,qBAAqB;IACrC,wBAAwB,6BAA6B;IACrD,oBAAoB,yBAAyB;IAC7C,qBAAqB,0BAA0B;IAC/C,MAAM,WAAW;CAClB;AAED;;;;GAIG;AACH,oBAAY,wBAAwB;IAClC,OAAO,YAAY;IACnB,oBAAoB,yBAAyB;IAC7C,uBAAuB,4BAA4B;IACnD,uBAAuB,4BAA4B;IACnD,aAAa,kBAAkB;IAC/B,MAAM,WAAW;CAClB;AAoED,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAWhC,CAAC;AAGF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAC5E,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;AACvF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;AACtG,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;AACxG,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;AACtG,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,wBAAwB,CAAC,CAAC"}

package/dist/modules/vendor/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./vendor.api-contract.js";
+export * from "./vendor.model.js";
+export * from "./vendor.repository.js";
+export * from "./vendor.types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/vendor/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/vendor/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC"}

package/dist/modules/vendor/vendor.api-contract.d.ts

@@ -0,0 +1,45 @@
+export declare const vendorContract: {
+    getMe: {
+        summary: "Get vendor profile";
+        description: "Retrieve the vendor profile of the authenticated user, including feature flags and bank details";
+        method: "GET";
+        path: "/me";
+        responses: {
+            200: import("zod").ZodObject<{
+                businessName: import("zod").ZodString;
+                tradeName: import("zod").ZodString;
+                enableCollections: import("zod").ZodNumber;
+                enablePayouts: import("zod").ZodNumber;
+                enableRemittance: import("zod").ZodNumber;
+                bankAccountNo: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                bankAccountName: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                bankCode: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                enableAutoSettlement: import("zod").ZodNumber;
+                disablePaymentApproval: import("zod").ZodNumber;
+            }, import("zod/v4/core").$strip>;
+            401: import("zod").ZodObject<{
+                reason: import("zod").ZodOptional<import("zod").ZodString>;
+                error: import("zod").ZodOptional<import("zod").ZodString>;
+                details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+                message: import("zod").ZodOptional<import("zod").ZodString>;
+                statusCode: import("zod").ZodLiteral<401>;
+            }, import("zod/v4/core").$strip>;
+            403: import("zod").ZodObject<{
+                reason: import("zod").ZodOptional<import("zod").ZodString>;
+                error: import("zod").ZodOptional<import("zod").ZodString>;
+                details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+                message: import("zod").ZodOptional<import("zod").ZodString>;
+                statusCode: import("zod").ZodLiteral<403>;
+            }, import("zod/v4/core").$strip>;
+            500: import("zod").ZodObject<{
+                reason: import("zod").ZodOptional<import("zod").ZodString>;
+                error: import("zod").ZodOptional<import("zod").ZodString>;
+                details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+                message: import("zod").ZodOptional<import("zod").ZodString>;
+                statusCode: import("zod").ZodLiteral<500>;
+            }, import("zod/v4/core").$strip>;
+        };
+    };
+};
+export type VendorContract = typeof vendorContract;
+//# sourceMappingURL=vendor.api-contract.d.ts.map

package/dist/modules/vendor/vendor.api-contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vendor.api-contract.d.ts","sourceRoot":"","sources":["../../../src/modules/vendor/vendor.api-contract.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAczB,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC"}