@dalmore/api-contracts 0.0.0-dev.4bb6b7a → 0.0.0-dev.4db6454

package/contracts/clients/kyc/index.d.ts

@@ -0,0 +1,345 @@
+import { z } from 'zod';
+export declare const kycContract: {
+    createKyc: {
+        method: "POST";
+        metadata: {
+            auth: boolean;
+        };
+        body: z.ZodObject<{
+            kycFirstName: z.ZodString;
+            kycLastName: z.ZodString;
+            kycDocumentType: z.ZodNativeEnum<typeof import("../../..").KYCDocumentType>;
+            kycDocumentId: z.ZodString;
+            kycDocumentIssuer: z.ZodNativeEnum<{
+                [x: string]: string;
+            }>;
+            kycDocumentIssuedDate: z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>;
+            kycDocumentExpirationDate: z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>;
+            kycDocumentDob: z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>;
+            kycProvider: z.ZodNativeEnum<typeof import("../../..").KYCPlatformProvider>;
+            kycLog: z.ZodEffects<z.ZodString, string, string>;
+            kycDocumentFrontFileId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+            kycDocumentBackFileId: z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>;
+            kycSelfieFileId: z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>;
+        }, "strip", z.ZodTypeAny, {
+            kycFirstName: string;
+            kycLastName: string;
+            kycDocumentType: import("../../..").KYCDocumentType;
+            kycDocumentId: string;
+            kycDocumentIssuer: string;
+            kycDocumentIssuedDate: Date | null;
+            kycDocumentExpirationDate: Date | null;
+            kycDocumentDob: Date | null;
+            kycProvider: import("../../..").KYCPlatformProvider;
+            kycLog: string;
+            kycDocumentFrontFileId: string;
+            kycDocumentBackFileId?: string | undefined;
+            kycSelfieFileId?: string | undefined;
+        }, {
+            kycFirstName: string;
+            kycLastName: string;
+            kycDocumentType: import("../../..").KYCDocumentType;
+            kycDocumentId: string;
+            kycDocumentIssuer: string;
+            kycDocumentIssuedDate: string | null;
+            kycDocumentExpirationDate: string | null;
+            kycDocumentDob: string | null;
+            kycProvider: import("../../..").KYCPlatformProvider;
+            kycLog: string;
+            kycDocumentFrontFileId: string;
+            kycDocumentBackFileId?: string | undefined;
+            kycSelfieFileId?: string | undefined;
+        }>;
+        pathParams: z.ZodObject<{
+            id: z.ZodEffects<z.ZodString, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+        }, {
+            id: string;
+        }>;
+        summary: "Create KYC record for individual";
+        path: "kycs/:id";
+        responses: {
+            201: z.ZodObject<{
+                id: z.ZodString;
+                __entity: z.ZodOptional<z.ZodString>;
+                createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+                updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+                deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+            } & {
+                tid: z.ZodNullable<z.ZodString>;
+                platform: z.ZodString;
+                individualId: z.ZodString;
+                documentType: z.ZodString;
+                documentImage: z.ZodString;
+                kycStatus: z.ZodNativeEnum<typeof import("../../..").KYCStatus>;
+                reason: z.ZodNullable<z.ZodString>;
+                response: z.ZodNullable<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                createdAt: string | Date;
+                updatedAt: string | Date;
+                deletedAt: string | Date | null;
+                platform: string;
+                kycStatus: import("../../..").KYCStatus;
+                tid: string | null;
+                individualId: string;
+                documentType: string;
+                documentImage: string;
+                reason: string | null;
+                response: string | null;
+                __entity?: string | undefined;
+            }, {
+                id: string;
+                createdAt: string | Date;
+                updatedAt: string | Date;
+                deletedAt: string | Date | null;
+                platform: string;
+                kycStatus: import("../../..").KYCStatus;
+                tid: string | null;
+                individualId: string;
+                documentType: string;
+                documentImage: string;
+                reason: string | null;
+                response: string | null;
+                __entity?: string | undefined;
+            }>;
+            400: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            401: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            403: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            404: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            500: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+        };
+    };
+    updateKyc: {
+        method: "PATCH";
+        metadata: {
+            auth: boolean;
+        };
+        body: z.ZodObject<{
+            kycFirstName: z.ZodOptional<z.ZodString>;
+            kycLastName: z.ZodOptional<z.ZodString>;
+            kycDocumentType: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").KYCDocumentType>>;
+            kycDocumentId: z.ZodOptional<z.ZodString>;
+            kycDocumentIssuer: z.ZodOptional<z.ZodNativeEnum<{
+                [x: string]: string;
+            }>>;
+            kycDocumentIssuedDate: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
+            kycDocumentExpirationDate: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
+            kycDocumentDob: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
+            kycProvider: z.ZodOptional<z.ZodNativeEnum<typeof import("../../..").KYCPlatformProvider>>;
+            kycLog: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+            kycDocumentFrontFileId: z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>;
+            kycDocumentBackFileId: z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>;
+            kycSelfieFileId: z.ZodOptional<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>;
+        }, "strip", z.ZodTypeAny, {
+            kycFirstName?: string | undefined;
+            kycLastName?: string | undefined;
+            kycDocumentType?: import("../../..").KYCDocumentType | undefined;
+            kycDocumentId?: string | undefined;
+            kycDocumentIssuer?: string | undefined;
+            kycDocumentIssuedDate?: Date | null | undefined;
+            kycDocumentExpirationDate?: Date | null | undefined;
+            kycDocumentDob?: Date | null | undefined;
+            kycProvider?: import("../../..").KYCPlatformProvider | undefined;
+            kycLog?: string | undefined;
+            kycDocumentFrontFileId?: string | undefined;
+            kycDocumentBackFileId?: string | undefined;
+            kycSelfieFileId?: string | undefined;
+        }, {
+            kycFirstName?: string | undefined;
+            kycLastName?: string | undefined;
+            kycDocumentType?: import("../../..").KYCDocumentType | undefined;
+            kycDocumentId?: string | undefined;
+            kycDocumentIssuer?: string | undefined;
+            kycDocumentIssuedDate?: string | null | undefined;
+            kycDocumentExpirationDate?: string | null | undefined;
+            kycDocumentDob?: string | null | undefined;
+            kycProvider?: import("../../..").KYCPlatformProvider | undefined;
+            kycLog?: string | undefined;
+            kycDocumentFrontFileId?: string | undefined;
+            kycDocumentBackFileId?: string | undefined;
+            kycSelfieFileId?: string | undefined;
+        }>;
+        pathParams: z.ZodObject<{
+            id: z.ZodEffects<z.ZodString, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+        }, {
+            id: string;
+        }>;
+        summary: "Update KYC record for individual";
+        path: "kycs/:id";
+        responses: {
+            200: z.ZodObject<{
+                id: z.ZodString;
+                __entity: z.ZodOptional<z.ZodString>;
+                createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+                updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+                deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+            } & {
+                tid: z.ZodNullable<z.ZodString>;
+                platform: z.ZodString;
+                individualId: z.ZodString;
+                documentType: z.ZodString;
+                documentImage: z.ZodString;
+                kycStatus: z.ZodNativeEnum<typeof import("../../..").KYCStatus>;
+                reason: z.ZodNullable<z.ZodString>;
+                response: z.ZodNullable<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                createdAt: string | Date;
+                updatedAt: string | Date;
+                deletedAt: string | Date | null;
+                platform: string;
+                kycStatus: import("../../..").KYCStatus;
+                tid: string | null;
+                individualId: string;
+                documentType: string;
+                documentImage: string;
+                reason: string | null;
+                response: string | null;
+                __entity?: string | undefined;
+            }, {
+                id: string;
+                createdAt: string | Date;
+                updatedAt: string | Date;
+                deletedAt: string | Date | null;
+                platform: string;
+                kycStatus: import("../../..").KYCStatus;
+                tid: string | null;
+                individualId: string;
+                documentType: string;
+                documentImage: string;
+                reason: string | null;
+                response: string | null;
+                __entity?: string | undefined;
+            }>;
+            400: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            401: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            403: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            404: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            500: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+        };
+    };
+};

package/contracts/clients/kyc/index.js

@@ -0,0 +1,49 @@
+import { initContract } from '@ts-rest/core';
+import { BadRequestError, ForbiddenError, InternalError, NotFoundError, PostKycBodySchema, PatchKycBodySchema, UnauthorizedError, individualIdSchema, KycZod, } from '../../../common/types/index.js';
+import { z } from 'zod';
+const c = initContract();
+export const kycContract = c.router({
+    createKyc: {
+        summary: 'Create KYC record for individual',
+        method: 'POST',
+        path: '/:id',
+        pathParams: z.object({
+            id: individualIdSchema,
+        }),
+        body: PostKycBodySchema,
+        metadata: {
+            auth: true,
+        },
+        responses: {
+            201: KycZod,
+            400: BadRequestError,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            404: NotFoundError,
+            500: InternalError,
+        },
+    },
+    updateKyc: {
+        summary: 'Update KYC record for individual',
+        method: 'PATCH',
+        path: '/:id',
+        pathParams: z.object({
+            id: individualIdSchema,
+        }),
+        body: PatchKycBodySchema,
+        metadata: {
+            auth: true,
+        },
+        responses: {
+            200: KycZod,
+            400: BadRequestError,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            404: NotFoundError,
+            500: InternalError,
+        },
+    },
+}, {
+    pathPrefix: 'kycs',
+});
+//# sourceMappingURL=index.js.map

package/contracts/clients/kyc/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,cAAc,EACd,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,MAAM,GACP,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CACjC;IACE,SAAS,EAAE;QACT,OAAO,EAAE,kCAAkC;QAC3C,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,SAAS,EAAE;YACT,GAAG,EAAE,MAAM;YACX,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,SAAS,EAAE;QACT,OAAO,EAAE,kCAAkC;QAC3C,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,IAAI,EAAE,kBAAkB;QACxB,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,SAAS,EAAE;YACT,GAAG,EAAE,MAAM;YACX,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;CACF,EACD;IACE,UAAU,EAAE,MAAM;CACnB,CACF,CAAC"}