refactor(api): Update remaining webhook routes to modular structure (#…

…2252)

api.planx.uk/hasura/metadata/index.ts

@@ -25,13 +25,18 @@ type RequiredScheduledEventArgs = Pick<
   "webhook" | "schedule_at" | "comment" | "payload"
 >;
 
+export interface ScheduledEventResponse {
+  message: "success";
+  event_id: string;
+}
+
 /**
  * POST a request to the Hasura Metadata API
  * https://hasura.io/docs/latest/graphql/core/api-reference/metadata-api/index/
  */
 const postToMetadataAPI = async (
   body: ScheduledEvent,
-): Promise<AxiosResponse<any>> => {
+): Promise<AxiosResponse<ScheduledEventResponse>> => {
   try {
     return await Axios.post(
       process.env.HASURA_METADATA_URL!,

api.planx.uk/inviteToPay/createPaymentSendEvents.test.ts

@@ -9,6 +9,11 @@ const mockedCreateScheduledEvent = createScheduledEvent as jest.MockedFunction<
   typeof createScheduledEvent
 >;
 
+const mockScheduledEventResponse = {
+  message: "success",
+  event_id: "abc123",
+} as const;
+
 describe("Create payment send events webhook", () => {
   const ENDPOINT = "/webhooks/hasura/create-payment-send-events";
 
@@ -83,29 +88,33 @@ describe("Create payment send events webhook", () => {
   });
 
   it("returns a 200 on successful event setup", async () => {
-    mockedCreateScheduledEvent.mockResolvedValue("test-event-id");
+    mockedCreateScheduledEvent.mockResolvedValue(mockScheduledEventResponse);
 
     await supertest(app)
       .post(ENDPOINT)
       .set({ Authorization: process.env.HASURA_PLANX_API_KEY })
       .send({ payload: { sessionId: "123" } })
       .expect(200)
       .then((response) => {
-        expect(response.body).toMatchObject({ email: "test-event-id" });
+        expect(response.body).toMatchObject({
+          email: mockScheduledEventResponse,
+        });
       });
   });
 
   it("passes the correct arguments along to createScheduledEvent", async () => {
     const body = { createdAt: new Date(), payload: { sessionId: "123" } };
-    mockedCreateScheduledEvent.mockResolvedValue("test-event-id");
+    mockedCreateScheduledEvent.mockResolvedValue(mockScheduledEventResponse);
 
     await supertest(app)
       .post(ENDPOINT)
       .set({ Authorization: process.env.HASURA_PLANX_API_KEY })
       .send(body)
       .expect(200)
       .then((response) => {
-        expect(response.body).toMatchObject({ email: "test-event-id" });
+        expect(response.body).toMatchObject({
+          email: mockScheduledEventResponse,
+        });
       });
 
     const mockArgs = mockedCreateScheduledEvent.mock.calls[0][0];

api.planx.uk/inviteToPay/createPaymentSendEvents.ts

@@ -3,7 +3,10 @@ import { NextFunction, Request, Response } from "express";
 import { gql } from "graphql-request";
 import { $admin } from "../client";
 import { adminGraphQLClient as adminClient } from "../hasura";
-import { createScheduledEvent } from "../hasura/metadata";
+import {
+  ScheduledEventResponse,
+  createScheduledEvent,
+} from "../hasura/metadata";
 import { getMostRecentPublishedFlow } from "../helpers";
 import { Flow, Node, Team } from "../types";
 
@@ -14,9 +17,9 @@ enum Destination {
 }
 
 interface CombinedResponse {
-  bops?: Record<string, string>;
-  uniform?: Record<string, string>;
-  email?: Record<string, string>;
+  bops?: ScheduledEventResponse;
+  uniform?: ScheduledEventResponse;
+  email?: ScheduledEventResponse;
 }
 
 // Create "One-off Scheduled Events" in Hasura when a payment request is paid