@temboplus/afloat 0.1.81 → 0.2.0-beta.2

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

@@ -0,0 +1,203 @@
+import { z } from "zod";
+/**
+ * Beneficiary API contract
+ * Defines the REST endpoints for managing beneficiaries
+ *
+ * @property {Object} createBeneficiary - Create a new beneficiary (POST /)
+ * @property {Object} editBeneficiary - Update an existing beneficiary (PATCH /:id)
+ * @property {Object} getBeneficiaries - Retrieve beneficiaries list (GET /)
+ * @property {Object} deleteBeneficiary - Delete a beneficiary (DELETE /:id)
+ */
+export declare const contract: {
+    createBeneficiary: {
+        method: "POST";
+        body: z.ZodObject<{
+            displayName: z.ZodString;
+            accountNo: z.ZodString;
+            channel: z.ZodString;
+            type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
+        }, "strip", z.ZodTypeAny, {
+            type: import("./beneficiary.dtos.js").BeneficiaryType;
+            displayName: string;
+            accountNo: string;
+            channel: string;
+        }, {
+            type: import("./beneficiary.dtos.js").BeneficiaryType;
+            displayName: string;
+            accountNo: string;
+            channel: string;
+        }>;
+        path: "/";
+        responses: {
+            201: z.ZodObject<{
+                id: z.ZodString;
+                profileId: z.ZodString;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            } & {
+                displayName: z.ZodString;
+                accountNo: z.ZodString;
+                channel: z.ZodString;
+                type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
+            }, "strip", z.ZodTypeAny, {
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
+                createdAt: string;
+                id: string;
+                displayName: string;
+                accountNo: string;
+                profileId: string;
+                updatedAt: string;
+                channel: string;
+            }, {
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
+                createdAt: string;
+                id: string;
+                displayName: string;
+                accountNo: string;
+                profileId: string;
+                updatedAt: string;
+                channel: string;
+            }>;
+        };
+    };
+    editBeneficiary: {
+        method: "PATCH";
+        body: z.ZodObject<{
+            displayName: z.ZodString;
+            accountNo: z.ZodString;
+            channel: z.ZodString;
+            type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
+        }, "strip", z.ZodTypeAny, {
+            type: import("./beneficiary.dtos.js").BeneficiaryType;
+            displayName: string;
+            accountNo: string;
+            channel: string;
+        }, {
+            type: import("./beneficiary.dtos.js").BeneficiaryType;
+            displayName: string;
+            accountNo: string;
+            channel: string;
+        }>;
+        path: "/:id";
+        responses: {
+            200: z.ZodObject<{
+                id: z.ZodString;
+                profileId: z.ZodString;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            } & {
+                displayName: z.ZodString;
+                accountNo: z.ZodString;
+                channel: z.ZodString;
+                type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
+            }, "strip", z.ZodTypeAny, {
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
+                createdAt: string;
+                id: string;
+                displayName: string;
+                accountNo: string;
+                profileId: string;
+                updatedAt: string;
+                channel: string;
+            }, {
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
+                createdAt: string;
+                id: string;
+                displayName: string;
+                accountNo: string;
+                profileId: string;
+                updatedAt: string;
+                channel: string;
+            }>;
+        };
+    };
+    getBeneficiaries: {
+        query: z.ZodObject<{
+            orderByDesc: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            orderByDesc: string;
+        }, {
+            orderByDesc: string;
+        }>;
+        method: "GET";
+        path: "/";
+        responses: {
+            200: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                profileId: z.ZodString;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            } & {
+                displayName: z.ZodString;
+                accountNo: z.ZodString;
+                channel: z.ZodString;
+                type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
+            }, "strip", z.ZodTypeAny, {
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
+                createdAt: string;
+                id: string;
+                displayName: string;
+                accountNo: string;
+                profileId: string;
+                updatedAt: string;
+                channel: string;
+            }, {
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
+                createdAt: string;
+                id: string;
+                displayName: string;
+                accountNo: string;
+                profileId: string;
+                updatedAt: string;
+                channel: string;
+            }>, "many">;
+        };
+    };
+    getByID: {
+        method: "GET";
+        path: "/:id";
+        responses: {
+            200: z.ZodObject<{
+                id: z.ZodString;
+                profileId: z.ZodString;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            } & {
+                displayName: z.ZodString;
+                accountNo: z.ZodString;
+                channel: z.ZodString;
+                type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
+            }, "strip", z.ZodTypeAny, {
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
+                createdAt: string;
+                id: string;
+                displayName: string;
+                accountNo: string;
+                profileId: string;
+                updatedAt: string;
+                channel: string;
+            }, {
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
+                createdAt: string;
+                id: string;
+                displayName: string;
+                accountNo: string;
+                profileId: string;
+                updatedAt: string;
+                channel: string;
+            }>;
+        };
+    };
+    deleteBeneficiary: {
+        method: "DELETE";
+        body: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        path: "/:id";
+        responses: {
+            200: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        };
+    };
+};
+/**
+ * Export type for use in client implementations
+ */
+export type BeneficiaryAPI = typeof contract;

package/dist/modules/beneficiary/beneficiary.dtos.d.ts

@@ -0,0 +1,84 @@
+import { z } from "zod";
+/**
+ * Schema for beneficiary channel types.
+ *
+ * @remarks
+ * Currently supports two channel types:
+ * - "Bank": For traditional banking channels
+ * - "Mobile": For mobile money channels
+ *
+ * @see {@link BeneficiaryType} for the inferred type
+ */
+export declare enum BeneficiaryType {
+    Bank = "Bank",
+    Mobile = "Mobile"
+}
+/**
+ * Type representing user-provided beneficiary information.
+ * Used for creating or updating beneficiaries.
+ *
+ * @see {@link beneficiaryInputSchema} for validation rules
+ * @see {@link BeneficiaryDTOSchemas} for all available schemas
+ */
+export type BeneficiaryInputDTO = z.infer<typeof BeneficiaryDTOSchemas.beneficiaryInputDTO>;
+/**
+ * Type representing a complete beneficiary record.
+ * Includes both user-provided and system-generated fields.
+ *
+ * @see {@link beneficiarySchema} for validation rules
+ */
+export type BeneficiaryDTO = z.infer<typeof BeneficiaryDTOSchemas.beneficiaryDTO>;
+/**
+ * Collection of all beneficiary-related schemas.
+ */
+export declare const BeneficiaryDTOSchemas: {
+    /** Schema for complete beneficiary records */
+    beneficiaryDTO: z.ZodObject<{
+        id: z.ZodString;
+        profileId: z.ZodString;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    } & {
+        displayName: z.ZodString;
+        accountNo: z.ZodString;
+        channel: z.ZodString;
+        type: z.ZodNativeEnum<typeof BeneficiaryType>;
+    }, "strip", z.ZodTypeAny, {
+        type: BeneficiaryType;
+        createdAt: string;
+        id: string;
+        displayName: string;
+        accountNo: string;
+        profileId: string;
+        updatedAt: string;
+        channel: string;
+    }, {
+        type: BeneficiaryType;
+        createdAt: string;
+        id: string;
+        displayName: string;
+        accountNo: string;
+        profileId: string;
+        updatedAt: string;
+        channel: string;
+    }>;
+    /** Schema for beneficiary input validation */
+    beneficiaryInputDTO: z.ZodObject<{
+        displayName: z.ZodString;
+        accountNo: z.ZodString;
+        channel: z.ZodString;
+        type: z.ZodNativeEnum<typeof BeneficiaryType>;
+    }, "strip", z.ZodTypeAny, {
+        type: BeneficiaryType;
+        displayName: string;
+        accountNo: string;
+        channel: string;
+    }, {
+        type: BeneficiaryType;
+        displayName: string;
+        accountNo: string;
+        channel: string;
+    }>;
+    /** Schema for beneficiary channel types */
+    beneficiaryType: z.ZodNativeEnum<typeof BeneficiaryType>;
+};