@nira-opencrvs/toolkit 1.9.11-rc.39d8d68

package/dist/commons/notification/UserNotifications.d.ts

@@ -0,0 +1,762 @@
+import { z } from 'zod';
+export declare const TriggerEvent: {
+    readonly USER_CREATED: "user-created";
+    readonly USER_UPDATED: "user-updated";
+    readonly USERNAME_REMINDER: "username-reminder";
+    readonly RESET_PASSWORD: "reset-password";
+    readonly RESET_PASSWORD_BY_ADMIN: "reset-password-by-admin";
+    readonly TWO_FA: "2fa";
+    readonly ALL_USER_NOTIFICATION: "all-user-notification";
+    readonly CHANGE_PHONE_NUMBER: "change-phone-number";
+    readonly CHANGE_EMAIL_ADDRESS: "change-email-address";
+};
+export type TriggerEvent = (typeof TriggerEvent)[keyof typeof TriggerEvent];
+export declare const Recipient: z.ZodObject<{
+    name: z.ZodOptional<z.ZodObject<{
+        firstname: z.ZodString;
+        surname: z.ZodString;
+        middlename: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    }, {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    }>>;
+    mobile: z.ZodOptional<z.ZodString>;
+    email: z.ZodOptional<z.ZodString>;
+    bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    name?: {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    } | undefined;
+    email?: string | undefined;
+    mobile?: string | undefined;
+    bcc?: string[] | undefined;
+}, {
+    name?: {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    } | undefined;
+    email?: string | undefined;
+    mobile?: string | undefined;
+    bcc?: string[] | undefined;
+}>;
+export type Recipient = z.infer<typeof Recipient>;
+export declare const BasePayload: z.ZodObject<{
+    recipient: z.ZodObject<{
+        name: z.ZodOptional<z.ZodObject<{
+            firstname: z.ZodString;
+            surname: z.ZodString;
+            middlename: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            firstname: string;
+            surname: string;
+            middlename?: string | undefined;
+        }, {
+            firstname: string;
+            surname: string;
+            middlename?: string | undefined;
+        }>>;
+        mobile: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+        bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        name?: {
+            firstname: string;
+            surname: string;
+            middlename?: string | undefined;
+        } | undefined;
+        email?: string | undefined;
+        mobile?: string | undefined;
+        bcc?: string[] | undefined;
+    }, {
+        name?: {
+            firstname: string;
+            surname: string;
+            middlename?: string | undefined;
+        } | undefined;
+        email?: string | undefined;
+        mobile?: string | undefined;
+        bcc?: string[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    recipient: {
+        name?: {
+            firstname: string;
+            surname: string;
+            middlename?: string | undefined;
+        } | undefined;
+        email?: string | undefined;
+        mobile?: string | undefined;
+        bcc?: string[] | undefined;
+    };
+}, {
+    recipient: {
+        name?: {
+            firstname: string;
+            surname: string;
+            middlename?: string | undefined;
+        } | undefined;
+        email?: string | undefined;
+        mobile?: string | undefined;
+        bcc?: string[] | undefined;
+    };
+}>;
+export type BasePayload = z.infer<typeof BasePayload>;
+export declare const TriggerPayload: {
+    readonly "user-created": z.ZodObject<z.objectUtil.extendShape<{
+        recipient: z.ZodObject<{
+            name: z.ZodOptional<z.ZodObject<{
+                firstname: z.ZodString;
+                surname: z.ZodString;
+                middlename: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }>>;
+            mobile: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+            bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }>;
+    }, {
+        username: z.ZodString;
+        temporaryPassword: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+        username: string;
+        temporaryPassword: string;
+    }, {
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+        username: string;
+        temporaryPassword: string;
+    }>;
+    readonly "user-updated": z.ZodObject<z.objectUtil.extendShape<{
+        recipient: z.ZodObject<{
+            name: z.ZodOptional<z.ZodObject<{
+                firstname: z.ZodString;
+                surname: z.ZodString;
+                middlename: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }>>;
+            mobile: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+            bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }>;
+    }, {
+        oldUsername: z.ZodString;
+        newUsername: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+        oldUsername: string;
+        newUsername: string;
+    }, {
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+        oldUsername: string;
+        newUsername: string;
+    }>;
+    readonly "username-reminder": z.ZodObject<z.objectUtil.extendShape<{
+        recipient: z.ZodObject<{
+            name: z.ZodOptional<z.ZodObject<{
+                firstname: z.ZodString;
+                surname: z.ZodString;
+                middlename: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }>>;
+            mobile: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+            bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }>;
+    }, {
+        username: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+        username: string;
+    }, {
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+        username: string;
+    }>;
+    readonly "reset-password": z.ZodObject<z.objectUtil.extendShape<{
+        recipient: z.ZodObject<{
+            name: z.ZodOptional<z.ZodObject<{
+                firstname: z.ZodString;
+                surname: z.ZodString;
+                middlename: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }>>;
+            mobile: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+            bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }>;
+    }, {
+        code: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        code: string;
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+    }, {
+        code: string;
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+    }>;
+    readonly "reset-password-by-admin": z.ZodObject<z.objectUtil.extendShape<{
+        recipient: z.ZodObject<{
+            name: z.ZodOptional<z.ZodObject<{
+                firstname: z.ZodString;
+                surname: z.ZodString;
+                middlename: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }>>;
+            mobile: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+            bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }>;
+    }, {
+        temporaryPassword: z.ZodString;
+        admin: z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodObject<{
+                firstname: z.ZodString;
+                surname: z.ZodString;
+                middlename: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }>;
+            role: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            name: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            };
+            role: string;
+        }, {
+            id: string;
+            name: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            };
+            role: string;
+        }>;
+    }>, "strip", z.ZodTypeAny, {
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+        temporaryPassword: string;
+        admin: {
+            id: string;
+            name: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            };
+            role: string;
+        };
+    }, {
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+        temporaryPassword: string;
+        admin: {
+            id: string;
+            name: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            };
+            role: string;
+        };
+    }>;
+    readonly "2fa": z.ZodObject<z.objectUtil.extendShape<{
+        recipient: z.ZodObject<{
+            name: z.ZodOptional<z.ZodObject<{
+                firstname: z.ZodString;
+                surname: z.ZodString;
+                middlename: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }>>;
+            mobile: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+            bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }>;
+    }, {
+        code: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        code: string;
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+    }, {
+        code: string;
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+    }>;
+    readonly "all-user-notification": z.ZodObject<z.objectUtil.extendShape<{
+        recipient: z.ZodObject<{
+            name: z.ZodOptional<z.ZodObject<{
+                firstname: z.ZodString;
+                surname: z.ZodString;
+                middlename: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }>>;
+            mobile: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+            bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }>;
+    }, {
+        subject: z.ZodString;
+        body: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        subject: string;
+        body: string;
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+    }, {
+        subject: string;
+        body: string;
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+    }>;
+    readonly "change-phone-number": z.ZodObject<z.objectUtil.extendShape<{
+        recipient: z.ZodObject<{
+            name: z.ZodOptional<z.ZodObject<{
+                firstname: z.ZodString;
+                surname: z.ZodString;
+                middlename: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }>>;
+            mobile: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+            bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }>;
+    }, {
+        code: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        code: string;
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+    }, {
+        code: string;
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+    }>;
+    readonly "change-email-address": z.ZodObject<z.objectUtil.extendShape<{
+        recipient: z.ZodObject<{
+            name: z.ZodOptional<z.ZodObject<{
+                firstname: z.ZodString;
+                surname: z.ZodString;
+                middlename: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }, {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            }>>;
+            mobile: z.ZodOptional<z.ZodString>;
+            email: z.ZodOptional<z.ZodString>;
+            bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }, {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        }>;
+    }, {
+        code: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        code: string;
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+    }, {
+        code: string;
+        recipient: {
+            name?: {
+                firstname: string;
+                surname: string;
+                middlename?: string | undefined;
+            } | undefined;
+            email?: string | undefined;
+            mobile?: string | undefined;
+            bcc?: string[] | undefined;
+        };
+    }>;
+};
+export type TriggerPayload = {
+    [K in TriggerEvent]: z.infer<(typeof TriggerPayload)[K]>;
+};
+export declare function triggerUserEventNotification<T extends TriggerEvent>({ event, payload, countryConfigUrl, authHeader }: {
+    event: T;
+    payload: TriggerPayload[T];
+    countryConfigUrl: string;
+    authHeader: {
+        Authorization: string;
+    };
+}): Promise<Response>;
+export declare function parseUserEventTrigger<T extends TriggerEvent>(event: T, body: unknown): TriggerPayload[T];
+//# sourceMappingURL=UserNotifications.d.ts.map