feat: adds reminder-mail endpoints

lib/types.ts

@@ -16,6 +16,7 @@ import {
   Membership,
   Payment,
   Schedule,
+  ReminderMail,
 } from "@calcom/prisma/client";
 
 // Base response, used for all responses
@@ -160,3 +161,11 @@ export type WebhookResponse = BaseResponse & {
 export type WebhooksResponse = BaseResponse & {
   data?: Partial<Webhook>[];
 };
+
+// ReminderMail
+export type ReminderMailResponse = BaseResponse & {
+  data?: Partial<ReminderMail>;
+};
+export type ReminderMailsResponse = BaseResponse & {
+  data?: Partial<ReminderMail>[];
+};

lib/validations/reminder-mail.ts

@@ -0,0 +1,24 @@
+import { withValidation } from "next-validations";
+import { z } from "zod";
+
+import { _ReminderMailModel as ReminderMail } from "@calcom/prisma/zod";
+
+export const schemaReminderMailBaseBodyParams = ReminderMail.omit({ id: true }).partial();
+
+export const schemaReminderMailPublic = ReminderMail.omit({});
+
+const schemaReminderMailRequiredParams = z.object({
+  referenceId: z.number().int(),
+  reminderType: z.enum(["PENDING_BOOKING_CONFIRMATION"]),
+  elapsedMinutes: z.number().int(),
+});
+
+export const schemaReminderMailBodyParams = schemaReminderMailBaseBodyParams.merge(
+  schemaReminderMailRequiredParams
+);
+
+export const withValidReminderMail = withValidation({
+  schema: schemaReminderMailBodyParams,
+  type: "Zod",
+  mode: "body",
+});

pages/api/reminder-mails/[id]/delete.ts

@@ -0,0 +1,50 @@
+import type { NextApiRequest, NextApiResponse } from "next";
+
+import prisma from "@calcom/prisma";
+
+import { withMiddleware } from "@lib/helpers/withMiddleware";
+import type { BaseResponse } from "@lib/types";
+import {
+  schemaQueryIdParseInt,
+  withValidQueryIdTransformParseInt,
+} from "@lib/validations/shared/queryIdTransformParseInt";
+
+/**
+ * @swagger
+ * /api/reminder-mails/{id}/delete:
+ *   delete:
+ *     summary: Remove an existing reminderMail
+ *    parameters:
+ *      - in: path
+ *        name: id
+ *        schema:
+ *          type: integer
+ *        required: true
+ *        description: Numeric ID of the reminderMail to delete
+ *     tags:
+ *     - reminderMails
+ *     responses:
+ *       201:
+ *         description: OK, reminderMail removed successfuly
+ *         model: ReminderMail
+ *       400:
+ *        description: Bad request. ReminderMail id is invalid.
+ *       401:
+ *        description: Authorization information is missing or invalid.
+ */
+export async function deleteReminderMail(req: NextApiRequest, res: NextApiResponse<BaseResponse>) {
+  const safe = await schemaQueryIdParseInt.safeParse(req.query);
+  if (!safe.success) throw new Error("Invalid request query", safe.error);
+
+  const data = await prisma.reminderMail.delete({ where: { id: safe.data.id } });
+
+  if (data) res.status(200).json({ message: `ReminderMail with id: ${safe.data.id} deleted successfully` });
+  else
+    (error: Error) =>
+      res.status(400).json({
+        message: `ReminderMail with id: ${safe.data.id} was not able to be processed`,
+        error,
+      });
+}
+
+export default withMiddleware("HTTP_DELETE")(withValidQueryIdTransformParseInt(deleteReminderMail));

pages/api/reminder-mails/[id]/edit.ts

@@ -0,0 +1,62 @@
+import type { NextApiRequest, NextApiResponse } from "next";
+
+import prisma from "@calcom/prisma";
+
+import { withMiddleware } from "@lib/helpers/withMiddleware";
+import type { ReminderMailResponse } from "@lib/types";
+import {
+  schemaReminderMailBodyParams,
+  schemaReminderMailPublic,
+  withValidReminderMail,
+} from "@lib/validations/reminder-mail";
+import {
+  schemaQueryIdParseInt,
+  withValidQueryIdTransformParseInt,
+} from "@lib/validations/shared/queryIdTransformParseInt";
+
+/**
+ * @swagger
+ * /api/reminder-mails/{id}/edit:
+ *   patch:
+ *     summary: Edit an existing reminderMail
+ *    parameters:
+ *      - in: path
+ *        name: id
+ *        schema:
+ *          type: integer
+ *        required: true
+ *        description: Numeric ID of the reminderMail to edit
+ *     tags:
+ *     - reminderMails
+ *     responses:
+ *       201:
+ *         description: OK, reminderMail edited successfuly
+ *         model: ReminderMail
+ *       400:
+ *        description: Bad request. ReminderMail body is invalid.
+ *       401:
+ *        description: Authorization information is missing or invalid.
+ */
+export async function editReminderMail(req: NextApiRequest, res: NextApiResponse<ReminderMailResponse>) {
+  const safeQuery = await schemaQueryIdParseInt.safeParse(req.query);
+  const safeBody = await schemaReminderMailBodyParams.safeParse(req.body);
+
+  if (!safeQuery.success || !safeBody.success) throw new Error("Invalid request");
+  const reminderMail = await prisma.reminderMail.update({
+    where: { id: safeQuery.data.id },
+    data: safeBody.data,
+  });
+  const data = schemaReminderMailPublic.parse(reminderMail);
+
+  if (data) res.status(200).json({ data });
+  else
+    (error: Error) =>
+      res.status(404).json({
+        message: `Event type with ID ${safeQuery.data.id} not found and wasn't updated`,
+        error,
+      });
+}
+
+export default withMiddleware("HTTP_PATCH")(
+  withValidQueryIdTransformParseInt(withValidReminderMail(editReminderMail))
+);

pages/api/reminder-mails/[id]/index.ts

@@ -0,0 +1,51 @@
+import type { NextApiRequest, NextApiResponse } from "next";
+
+import prisma from "@calcom/prisma";
+
+import { withMiddleware } from "@lib/helpers/withMiddleware";
+import type { ReminderMailResponse } from "@lib/types";
+import { schemaReminderMailPublic } from "@lib/validations/reminder-mail";
+import {
+  schemaQueryIdParseInt,
+  withValidQueryIdTransformParseInt,
+} from "@lib/validations/shared/queryIdTransformParseInt";
+
+/**
+ * @swagger
+ * /api/reminder-mails/{id}:
+ *   get:
+ *   summary: Get a reminderMail by ID
+ *    parameters:
+ *      - in: path
+ *        name: id
+ *        schema:
+ *          type: integer
+ *        required: true
+ *        description: Numeric ID of the reminderMail to get
+ *     tags:
+ *     - reminderMails
+ *     responses:
+ *       200:
+ *         description: OK
+ *       401:
+ *        description: Authorization information is missing or invalid.
+ *       404:
+ *         description: ReminderMail was not found
+ */
+export async function reminderMailById(req: NextApiRequest, res: NextApiResponse<ReminderMailResponse>) {
+  const safe = await schemaQueryIdParseInt.safeParse(req.query);
+  if (!safe.success) throw new Error("Invalid request query");
+
+  const reminderMail = await prisma.reminderMail.findUnique({ where: { id: safe.data.id } });
+  const data = schemaReminderMailPublic.parse(reminderMail);
+
+  if (reminderMail) res.status(200).json({ data });
+  else
+    (error: Error) =>
+      res.status(404).json({
+        message: "ReminderMail was not found",
+        error,
+      });
+}
+
+export default withMiddleware("HTTP_GET")(withValidQueryIdTransformParseInt(reminderMailById));

pages/api/reminder-mails/index.ts

@@ -0,0 +1,37 @@
+import type { NextApiRequest, NextApiResponse } from "next";
+
+import prisma from "@calcom/prisma";
+
+import { withMiddleware } from "@lib/helpers/withMiddleware";
+import { ReminderMailsResponse } from "@lib/types";
+import { schemaReminderMailPublic } from "@lib/validations/reminder-mail";
+
+/**
+ * @swagger
+ * /api/reminder-mails:
+ *   get:
+ *     summary: Get all reminderMails
+ *     tags:
+ *     - reminderMails
+ *     responses:
+ *       200:
+ *         description: OK
+ *       401:
+ *        description: Authorization information is missing or invalid.
+ *       404:
+ *         description: No reminderMails were found
+ */
+async function allReminderMails(_: NextApiRequest, res: NextApiResponse<ReminderMailsResponse>) {
+  const reminderMails = await prisma.reminderMail.findMany();
+  const data = reminderMails.map((reminderMail) => schemaReminderMailPublic.parse(reminderMail));
+
+  if (data) res.status(200).json({ data });
+  else
+    (error: Error) =>
+      res.status(404).json({
+        message: "No ReminderMails were found",
+        error,
+      });
+}
+
+export default withMiddleware("HTTP_GET")(allReminderMails);

pages/api/reminder-mails/new.ts

@@ -0,0 +1,52 @@
+import type { NextApiRequest, NextApiResponse } from "next";
+
+import prisma from "@calcom/prisma";
+
+import { withMiddleware } from "@lib/helpers/withMiddleware";
+import type { ReminderMailResponse } from "@lib/types";
+import {
+  schemaReminderMailBodyParams,
+  schemaReminderMailPublic,
+  withValidReminderMail,
+} from "@lib/validations/reminder-mail";
+
+/**
+ * @swagger
+ * /api/reminder-mails/new:
+ *   post:
+ *     summary: Creates a new reminderMail
+ *   requestBody:
+ *     description: Optional description in *Markdown*
+ *     required: true
+ *     content:
+ *       application/json:
+ *           schema:
+ *           $ref: '#/components/schemas/ReminderMail'
+ *     tags:
+ *     - reminderMails
+ *     responses:
+ *       201:
+ *         description: OK, reminderMail created
+ *         model: ReminderMail
+ *       400:
+ *        description: Bad request. ReminderMail body is invalid.
+ *       401:
+ *        description: Authorization information is missing or invalid.
+ */
+async function createReminderMail(req: NextApiRequest, res: NextApiResponse<ReminderMailResponse>) {
+  const safe = schemaReminderMailBodyParams.safeParse(req.body);
+  if (!safe.success) throw new Error("Invalid request body", safe.error);
+
+  const reminderMail = await prisma.reminderMail.create({ data: safe.data });
+  const data = schemaReminderMailPublic.parse(reminderMail);
+
+  if (data) res.status(201).json({ data, message: "ReminderMail created successfully" });
+  else
+    (error: Error) =>
+      res.status(400).json({
+        message: "Could not create new reminderMail",
+        error,
+      });
+}
+
+export default withMiddleware("HTTP_POST")(withValidReminderMail(createReminderMail));