@dalmore/api-contracts 0.0.0-dev.9d42e16 → 0.0.0-dev.a0bb940

package/common/types/mail-template.types.d.ts

@@ -0,0 +1,595 @@
+import { z } from 'zod';
+import { InvestorAccountType } from './common.types';
+export declare const IssuerWelcomeEmailTemplateZod: z.ZodObject<{
+    issuerName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    issuerName: string;
+}, {
+    issuerName: string;
+}>;
+export type IssuerWelcomeEmailTemplateZod = z.infer<typeof IssuerWelcomeEmailTemplateZod>;
+export declare const ResetPasswordEmailTemplateZod: z.ZodObject<{
+    name: z.ZodString;
+    resetPasswordLink: z.ZodString;
+    resetPasswordCode: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    resetPasswordLink: string;
+    resetPasswordCode: string;
+}, {
+    name: string;
+    resetPasswordLink: string;
+    resetPasswordCode: string;
+}>;
+export type ResetPasswordEmailTemplateZod = z.infer<typeof ResetPasswordEmailTemplateZod>;
+export declare const InvitationEmailTemplateZod: z.ZodObject<{
+    issuerName: z.ZodString;
+    role: z.ZodString;
+    invitationLink: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    role: string;
+    issuerName: string;
+    invitationLink: string;
+}, {
+    role: string;
+    issuerName: string;
+    invitationLink: string;
+}>;
+export type InvitationEmailTemplateZod = z.infer<typeof InvitationEmailTemplateZod>;
+export declare const InvestorWelcomeEmailTemplateZod: z.ZodObject<{
+    investorName: z.ZodString;
+    issuerName: z.ZodString;
+    loginLink: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    investorName: string;
+    issuerName: string;
+    loginLink: string;
+}, {
+    investorName: string;
+    issuerName: string;
+    loginLink: string;
+}>;
+export type InvestorWelcomeEmailTemplateZod = z.infer<typeof InvestorWelcomeEmailTemplateZod>;
+export declare const PlacedOrderLineItemsZod: z.ZodObject<{
+    name: z.ZodString;
+    pricePerShare: z.ZodNumber;
+    numberOfSharesPurchased: z.ZodNumber;
+    totalInvestment: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    pricePerShare: number;
+    numberOfSharesPurchased: number;
+    totalInvestment: number;
+}, {
+    name: string;
+    pricePerShare: number;
+    numberOfSharesPurchased: number;
+    totalInvestment: number;
+}>;
+export type PlacedOrderLineItemsZod = z.infer<typeof PlacedOrderLineItemsZod>;
+export declare const OrderPlacedEmailTemplateZod: z.ZodObject<{
+    issuerName: z.ZodString;
+    investorName: z.ZodString;
+    investorAccountType: z.ZodNativeEnum<typeof InvestorAccountType>;
+    lineItems: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        pricePerShare: z.ZodNumber;
+        numberOfSharesPurchased: z.ZodNumber;
+        totalInvestment: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        pricePerShare: number;
+        numberOfSharesPurchased: number;
+        totalInvestment: number;
+    }, {
+        name: string;
+        pricePerShare: number;
+        numberOfSharesPurchased: number;
+        totalInvestment: number;
+    }>, "many">;
+    tradeDetailsEndpoint: z.ZodString;
+    isWirePayment: z.ZodBoolean;
+    usAccountHolderName: z.ZodString;
+    usBankName: z.ZodString;
+    usRoutingNumber: z.ZodString;
+    usAccountNumber: z.ZodString;
+    reference: z.ZodString;
+    swiftId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    investorAccountType: InvestorAccountType;
+    lineItems: {
+        name: string;
+        pricePerShare: number;
+        numberOfSharesPurchased: number;
+        totalInvestment: number;
+    }[];
+    investorName: string;
+    issuerName: string;
+    usAccountHolderName: string;
+    usBankName: string;
+    usRoutingNumber: string;
+    usAccountNumber: string;
+    reference: string;
+    swiftId: string;
+    tradeDetailsEndpoint: string;
+    isWirePayment: boolean;
+}, {
+    investorAccountType: InvestorAccountType;
+    lineItems: {
+        name: string;
+        pricePerShare: number;
+        numberOfSharesPurchased: number;
+        totalInvestment: number;
+    }[];
+    investorName: string;
+    issuerName: string;
+    usAccountHolderName: string;
+    usBankName: string;
+    usRoutingNumber: string;
+    usAccountNumber: string;
+    reference: string;
+    swiftId: string;
+    tradeDetailsEndpoint: string;
+    isWirePayment: boolean;
+}>;
+export type OrderPlacedEmailTemplateZod = z.infer<typeof OrderPlacedEmailTemplateZod>;
+export declare const OrderApprovedEmailTemplateZod: z.ZodObject<{
+    investorAccountType: z.ZodNativeEnum<typeof InvestorAccountType>;
+    investorName: z.ZodString;
+    issuerName: z.ZodString;
+    tradeDetailsEndpoint: z.ZodString;
+} & {
+    pricePerShare: z.ZodNumber;
+    numberOfAssetsPurchased: z.ZodNumber;
+    name: z.ZodString;
+    totalAmount: z.ZodNumber;
+    isWirePayment: z.ZodBoolean;
+    usAccountHolderName: z.ZodString;
+    usBankName: z.ZodString;
+    usRoutingNumber: z.ZodString;
+    usAccountNumber: z.ZodString;
+    reference: z.ZodString;
+    swiftId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    investorAccountType: InvestorAccountType;
+    pricePerShare: number;
+    totalAmount: number;
+    investorName: string;
+    issuerName: string;
+    usAccountHolderName: string;
+    usBankName: string;
+    usRoutingNumber: string;
+    usAccountNumber: string;
+    reference: string;
+    swiftId: string;
+    tradeDetailsEndpoint: string;
+    isWirePayment: boolean;
+    numberOfAssetsPurchased: number;
+}, {
+    name: string;
+    investorAccountType: InvestorAccountType;
+    pricePerShare: number;
+    totalAmount: number;
+    investorName: string;
+    issuerName: string;
+    usAccountHolderName: string;
+    usBankName: string;
+    usRoutingNumber: string;
+    usAccountNumber: string;
+    reference: string;
+    swiftId: string;
+    tradeDetailsEndpoint: string;
+    isWirePayment: boolean;
+    numberOfAssetsPurchased: number;
+}>;
+export type OrderApprovedEmailTemplateZod = z.infer<typeof OrderApprovedEmailTemplateZod>;
+export declare const TaskAssignedEmailTemplateZod: z.ZodObject<{
+    userName: z.ZodString;
+    taskName: z.ZodString;
+    assignedBy: z.ZodString;
+    dueDate: z.ZodString;
+    taskType: z.ZodString;
+    priority: z.ZodString;
+    description: z.ZodString;
+    completeTaskEndpoint: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    description: string;
+    dueDate: string;
+    taskType: string;
+    priority: string;
+    userName: string;
+    taskName: string;
+    assignedBy: string;
+    completeTaskEndpoint: string;
+}, {
+    description: string;
+    dueDate: string;
+    taskType: string;
+    priority: string;
+    userName: string;
+    taskName: string;
+    assignedBy: string;
+    completeTaskEndpoint: string;
+}>;
+export type TaskAssignedEmailTemplateZod = z.infer<typeof TaskAssignedEmailTemplateZod>;
+export declare const ResetPasswordSuccessEmailTemplateZod: z.ZodObject<{
+    name: z.ZodString;
+    loginLink: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    loginLink: string;
+}, {
+    name: string;
+    loginLink: string;
+}>;
+export type ResetPasswordSuccessEmailTemplateZod = z.infer<typeof ResetPasswordSuccessEmailTemplateZod>;
+export declare const PaymentFailedEmailTemplateZod: z.ZodObject<{
+    firstName: z.ZodString;
+    tradeDetailsEndpoint: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    firstName: string;
+    tradeDetailsEndpoint: string;
+}, {
+    firstName: string;
+    tradeDetailsEndpoint: string;
+}>;
+export type PaymentFailedEmailTemplateZod = z.infer<typeof PaymentFailedEmailTemplateZod>;
+export declare const RetirementInstructionEmailTemplateZod: z.ZodObject<{
+    name: z.ZodString;
+    instruction: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    instruction: string;
+}, {
+    name: string;
+    instruction: string;
+}>;
+export type RetirementInstructionEmailTemplateZod = z.infer<typeof RetirementInstructionEmailTemplateZod>;
+export declare const ContactUsEmailTemplateZod: z.ZodObject<{
+    firstName: z.ZodString;
+    lastName: z.ZodString;
+    email: z.ZodString;
+    subject: z.ZodString;
+    message: z.ZodString;
+    timestamp: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    timestamp: string;
+    subject: string;
+}, {
+    message: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    timestamp: string;
+    subject: string;
+}>;
+export type ContactUsEmailTemplateZod = z.infer<typeof ContactUsEmailTemplateZod>;
+export declare const SignatureRequestEmailTemplateZod: z.ZodObject<{
+    investorName: z.ZodString;
+    requestedBy: z.ZodString;
+    requestedByEmail: z.ZodString;
+    documentName: z.ZodString;
+    expirationDate: z.ZodString;
+    signersList: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        email: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        email: string;
+        name: string;
+    }, {
+        email: string;
+        name: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    investorName: string;
+    expirationDate: string;
+    requestedBy: string;
+    requestedByEmail: string;
+    documentName: string;
+    signersList: {
+        email: string;
+        name: string;
+    }[];
+}, {
+    investorName: string;
+    expirationDate: string;
+    requestedBy: string;
+    requestedByEmail: string;
+    documentName: string;
+    signersList: {
+        email: string;
+        name: string;
+    }[];
+}>;
+export type SignatureRequestEmailTemplateZod = z.infer<typeof SignatureRequestEmailTemplateZod>;
+export declare const EMAIL_TEMPLATES: {
+    WELCOME_ISSUER: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    WELCOME_INVESTOR: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    RESET_PASSWORD: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    ISSUER_INVITATION: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    COMPLIANCE_INVITATION: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    ORDER_PLACED: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    ORDER_APPROVED: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    TASK_ASSIGNED: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    AML_PENDING: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    PAYMENT_FAILED: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    RESET_PASSWORD_SUCCESS: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    RETIREMENT_INSTRUCTION: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    EMAIL_NOTIFICATION: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    CONTACT_US: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    SUBMIT_PAYMENT: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+    SIGNATURE_REQUEST: {
+        subject: string;
+        path: string;
+        body: string;
+    };
+};
+export declare enum EmailTemplatesType {
+    WELCOME_ISSUER = "WELCOME_ISSUER",
+    WELCOME_INVESTOR = "WELCOME_INVESTOR",
+    RESET_PASSWORD = "RESET_PASSWORD",
+    RESET_PASSWORD_SUCCESS = "RESET_PASSWORD_SUCCESS",
+    ISSUER_INVITATION = "ISSUER_INVITATION",
+    COMPLIANCE_INVITATION = "COMPLIANCE_INVITATION",
+    EMAIL_NOTIFICATION = "EMAIL_NOTIFICATION",
+    ORDER_PLACED = "ORDER_PLACED",
+    ORDER_APPROVED = "ORDER_APPROVED",
+    TASK_ASSIGNED = "TASK_ASSIGNED",
+    PAYMENT_FAILED = "PAYMENT_FAILED",
+    UPDATE_PAYMENT = "UPDATE_PAYMENT",
+    KYC_VERIFICATION_REQUIRED = "KYC_VERIFICATION_REQUIRED",
+    DOCUMENT_SIGNATURE_PENDING = "DOCUMENT_SIGNATURE_PENDING",
+    VERIFY_ACCOUNT = "VERIFY_ACCOUNT",
+    SIGNATURE_REQUEST = "SIGNATURE_REQUEST",
+    SUBMIT_PAYMENT = "SUBMIT_PAYMENT",
+    RETIREMENT_INSTRUCTION = "RETIREMENT_INSTRUCTION",
+    AML_PENDING = "AML_PENDING",
+    CONTACT_US = "CONTACT_US",
+    NONE = "NONE"
+}
+export declare enum EmailAttachmentsType {
+    USER_MANUAL = "USER_MANUAL",
+    BROKER_DEALER = "BROKER_DEALER",
+    STREAM = "STREAM",
+    STREAMS = "STREAMS",
+    OTHER = "OTHER",
+    NONE = "NONE"
+}
+export declare const FooterZod: z.ZodObject<{
+    linkedinUrl: z.ZodNullable<z.ZodString>;
+    twitterUrl: z.ZodNullable<z.ZodString>;
+    facebookUrl: z.ZodNullable<z.ZodString>;
+    instagramUrl: z.ZodNullable<z.ZodString>;
+    mailSupporter: z.ZodNullable<z.ZodString>;
+    websiteUrl: z.ZodNullable<z.ZodString>;
+    otherUrls: z.ZodNullable<z.ZodArray<z.ZodNullable<z.ZodString>, "many">>;
+    poweredByImageUrl: z.ZodNullable<z.ZodString>;
+    contactUsUrl: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    linkedinUrl: string | null;
+    twitterUrl: string | null;
+    facebookUrl: string | null;
+    instagramUrl: string | null;
+    mailSupporter: string | null;
+    websiteUrl: string | null;
+    otherUrls: (string | null)[] | null;
+    poweredByImageUrl: string | null;
+    contactUsUrl: string | null;
+}, {
+    linkedinUrl: string | null;
+    twitterUrl: string | null;
+    facebookUrl: string | null;
+    instagramUrl: string | null;
+    mailSupporter: string | null;
+    websiteUrl: string | null;
+    otherUrls: (string | null)[] | null;
+    poweredByImageUrl: string | null;
+    contactUsUrl: string | null;
+}>;
+export type FooterZod = z.infer<typeof FooterZod>;
+export declare const HeaderZod: z.ZodObject<{
+    companyName: z.ZodString;
+    logoUrl: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    companyName: string;
+    logoUrl: string | null;
+}, {
+    companyName: string;
+    logoUrl: string | null;
+}>;
+export type HeaderZod = z.infer<typeof HeaderZod>;
+export declare const HeaderAndFooterZod: z.ZodObject<{
+    header: z.ZodObject<{
+        companyName: z.ZodString;
+        logoUrl: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        companyName: string;
+        logoUrl: string | null;
+    }, {
+        companyName: string;
+        logoUrl: string | null;
+    }>;
+    footer: z.ZodObject<{
+        linkedinUrl: z.ZodNullable<z.ZodString>;
+        twitterUrl: z.ZodNullable<z.ZodString>;
+        facebookUrl: z.ZodNullable<z.ZodString>;
+        instagramUrl: z.ZodNullable<z.ZodString>;
+        mailSupporter: z.ZodNullable<z.ZodString>;
+        websiteUrl: z.ZodNullable<z.ZodString>;
+        otherUrls: z.ZodNullable<z.ZodArray<z.ZodNullable<z.ZodString>, "many">>;
+        poweredByImageUrl: z.ZodNullable<z.ZodString>;
+        contactUsUrl: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        linkedinUrl: string | null;
+        twitterUrl: string | null;
+        facebookUrl: string | null;
+        instagramUrl: string | null;
+        mailSupporter: string | null;
+        websiteUrl: string | null;
+        otherUrls: (string | null)[] | null;
+        poweredByImageUrl: string | null;
+        contactUsUrl: string | null;
+    }, {
+        linkedinUrl: string | null;
+        twitterUrl: string | null;
+        facebookUrl: string | null;
+        instagramUrl: string | null;
+        mailSupporter: string | null;
+        websiteUrl: string | null;
+        otherUrls: (string | null)[] | null;
+        poweredByImageUrl: string | null;
+        contactUsUrl: string | null;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    header: {
+        companyName: string;
+        logoUrl: string | null;
+    };
+    footer: {
+        linkedinUrl: string | null;
+        twitterUrl: string | null;
+        facebookUrl: string | null;
+        instagramUrl: string | null;
+        mailSupporter: string | null;
+        websiteUrl: string | null;
+        otherUrls: (string | null)[] | null;
+        poweredByImageUrl: string | null;
+        contactUsUrl: string | null;
+    };
+}, {
+    header: {
+        companyName: string;
+        logoUrl: string | null;
+    };
+    footer: {
+        linkedinUrl: string | null;
+        twitterUrl: string | null;
+        facebookUrl: string | null;
+        instagramUrl: string | null;
+        mailSupporter: string | null;
+        websiteUrl: string | null;
+        otherUrls: (string | null)[] | null;
+        poweredByImageUrl: string | null;
+        contactUsUrl: string | null;
+    };
+}>;
+export type HeaderAndFooterZod = z.infer<typeof HeaderAndFooterZod>;
+export declare const EmailThemeSettingZod: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+export type EmailThemeSetting = z.infer<typeof EmailThemeSettingZod>;
+export declare const EmailThemeSettingsZod: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>, "many">;
+export type EmailThemeSettingsZod = z.infer<typeof EmailThemeSettingsZod>;
+/**
+ * Response from a successful email send operation.
+ * Based on SendGrid SDK's ClientResponse structure.
+ */
+export declare const EmailSendResponseSchema: z.ZodObject<{
+    /** HTTP status code from SendGrid (e.g., 202 for accepted) */
+    statusCode: z.ZodNumber;
+    /** SendGrid's x-message-id header for tracking emails in their dashboard */
+    messageId: z.ZodOptional<z.ZodString>;
+    /** Full response headers, available for debugging if needed */
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    statusCode: number;
+    headers?: Record<string, unknown> | undefined;
+    messageId?: string | undefined;
+}, {
+    statusCode: number;
+    headers?: Record<string, unknown> | undefined;
+    messageId?: string | undefined;
+}>;
+export type EmailSendResponse = z.infer<typeof EmailSendResponseSchema>;
+/**
+ * Error from a failed email send operation.
+ * Fields are optional because error shapes vary depending on failure type
+ * (network errors vs SendGrid API errors).
+ */
+export declare const EmailSendErrorSchema: z.ZodObject<{
+    /** Human-readable error message */
+    message: z.ZodString;
+    /** Network-level error code (e.g., 'ECONNREFUSED', 'ETIMEDOUT') */
+    code: z.ZodOptional<z.ZodString>;
+    /** HTTP status code if request reached SendGrid (e.g., 400, 401, 403, 413, 500) */
+    statusCode: z.ZodOptional<z.ZodNumber>;
+    /**
+     * SendGrid's error response body. Structure: { errors: [{ message, field, help, id }] }
+     * @see https://www.twilio.com/docs/sendgrid/api-reference/mail-send/mail-send#responses
+     */
+    response: z.ZodOptional<z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    code?: string | undefined;
+    statusCode?: number | undefined;
+    response?: unknown;
+}, {
+    message: string;
+    code?: string | undefined;
+    statusCode?: number | undefined;
+    response?: unknown;
+}>;
+export type EmailSendError = z.infer<typeof EmailSendErrorSchema>;