Merge pull request #833 from companieshouse/feature/DEEP-620-add-endpoint-for-valid-first-request-psc-extensions

Adding new endpoints for psc extension service

Author: cbroadley-ch

src/services/psc-extensions-link/service.ts

@@ -1,4 +1,4 @@
-import { PscExtension, PscExtensionData } from "./types"
+import { PscExtension, PscExtensionData, ValidationStatusResponse } from "./types"
 
 import { Headers, HttpResponse, IHttpClient } from "../../http";
 import Resource, { ApiErrorResponse } from "../resource";
@@ -34,6 +34,58 @@ export default class PscExtensionService {
         return this.populateFrontEndResource(response);
     }
 
+    /**
+     * Retrieves the count of extension requests for a specific PSC notification.
+     *
+     * @param pscNotificationId - The unique identifier of the PSC notification.
+     * @param headers - Optional headers to include in the request.
+     * @returns A promise that resolves to either:
+     * - A `Resource<number>` object containing the extension count (0, 1, or 2).
+     * - An `ApiErrorResponse` object if an error occurs during the request.
+     */
+    public async getPscExtensionCount (pscNotificationId: string, headers?: Headers): Promise<Resource<number> | ApiErrorResponse> {
+        const resourceUri = `/persons-with-significant-control-extensions/${pscNotificationId}/extensionCount`;
+        const response = await this.client.httpGet(resourceUri, headers);
+
+        if (response.error) {
+            return this.handleErrorResponse(response);
+        }
+
+        const frontEndResource: Resource<number> = {
+            httpStatusCode: response.status,
+            resource: response.body as number
+        };
+
+        return frontEndResource;
+    }
+
+    /**
+     * Validates whether a PSC extension request is valid for the given parameters.
+     *
+     * @param transactionId - The unique identifier of the transaction.
+     * @param pscNotificationId - The unique identifier of the PSC notification.
+     * @param companyNumber - The company number.
+     * @param headers - Optional headers to include in the request.
+     * @returns A promise that resolves to either:
+     * - A `Resource<ValidationStatusResponse>` object containing validation results.
+     * - An `ApiErrorResponse` object if an error occurs during the request.
+     */
+    public async getIsPscExtensionValid (transactionId: string, pscNotificationId: string, companyNumber: string, headers?: Headers): Promise<Resource<ValidationStatusResponse> | ApiErrorResponse> {
+        const resourceUri = `/persons-with-significant-control-extensions/${transactionId}/${pscNotificationId}/${companyNumber}/isPscExtensionRequestValid`;
+        const response = await this.client.httpGet(resourceUri, headers);
+
+        if (response.error) {
+            return this.handleErrorResponse(response);
+        }
+
+        const frontEndResource: Resource<ValidationStatusResponse> = {
+            httpStatusCode: response.status,
+            resource: Mapping.camelCaseKeys<ValidationStatusResponse>(response.body)
+        };
+
+        return frontEndResource;
+    }
+
     /**
      * Maps the response body to a front-end resource format with camelCase keys.
      *

test/services/psc-extensions-link/service.mock.ts

@@ -0,0 +1,110 @@
+import { ReasonPhrases, StatusCodes } from "http-status-codes";
+import { RequestClient } from "../../../src";
+import { PscExtension, PscExtensionData, ValidationStatusResponse } from "../../../src/services/psc-extensions-link/types";
+
+export const requestClient = new RequestClient({ baseUrl: "URL_NOT_USED", oauthToken: "123" });
+export const TRANSACTION_ID = "1234-5678-9123";
+export const PSC_NOTIFICATION_ID = "123456";
+export const COMPANY_NUMBER = "00064000";
+
+const PSC_EXTENSION_DATA: PscExtensionData = {
+    companyNumber: COMPANY_NUMBER,
+    pscNotificationId: PSC_NOTIFICATION_ID,
+    extensionDetails: {
+        extensionReason: "Have arranged through GOV.UK One Login to verify identity at the Post Office",
+        extensionStatus: "pending",
+        extensionRequestDate: "2024-10-17"
+    }
+};
+
+const PSC_EXTENSION_RESOURCE = {
+    created_at: new Date("2024-10-17T10:30:00Z"),
+    updated_at: new Date("2024-10-17T10:30:00Z"),
+    links: {
+        self: `/transactions/${TRANSACTION_ID}/persons-with-significant-control-extensions/extension-id`,
+        validation_status: `/transactions/${TRANSACTION_ID}/persons-with-significant-control-extensions/extension-id/validation_status`
+    },
+    data: {
+        company_number: COMPANY_NUMBER,
+        psc_notification_id: PSC_NOTIFICATION_ID,
+        extension_details: {
+            extension_reason: "Have arranged through GOV.UK One Login to verify identity at the Post Office",
+            extension_status: "pending",
+            extension_request_date: "2024-10-17"
+        }
+    }
+};
+
+export const PSC_EXTENSION: PscExtension = {
+    createdAt: new Date("2024-10-17T10:30:00Z"),
+    updatedAt: new Date("2024-10-17T10:30:00Z"),
+    links: {
+        self: `/transactions/${TRANSACTION_ID}/persons-with-significant-control-extensions/extension-id`,
+        validationStatus: `/transactions/${TRANSACTION_ID}/persons-with-significant-control-extensions/extension-id/validation_status`
+    },
+    data: PSC_EXTENSION_DATA
+};
+
+const VALIDATION_STATUS_RESPONSE_RESOURCE = {
+    is_valid: true,
+    errors: []
+};
+
+export const VALIDATION_STATUS_RESPONSE: ValidationStatusResponse = {
+    isValid: true,
+    errors: []
+};
+
+const VALIDATION_STATUS_RESPONSE_INVALID_RESOURCE = {
+    is_valid: false,
+    errors: [
+        {
+            error: "PSC has exceeded maximum number of extension requests",
+            location: "$.",
+            location_type: "json-path",
+            type: "ch:validation"
+        }
+    ]
+};
+
+export const VALIDATION_STATUS_RESPONSE_INVALID: ValidationStatusResponse = {
+    isValid: false,
+    errors: [
+        {
+            error: "PSC has exceeded maximum number of extension requests",
+            location: "$.",
+            locationType: "json-path",
+            type: "ch:validation"
+        }
+    ]
+};
+
+export const mockPostPscExtensionResponse = {
+    201: { status: StatusCodes.CREATED, body: PSC_EXTENSION_RESOURCE },
+    400: { status: StatusCodes.BAD_REQUEST, error: ReasonPhrases.BAD_REQUEST },
+    401: { status: StatusCodes.UNAUTHORIZED, error: ReasonPhrases.UNAUTHORIZED },
+    404: { status: StatusCodes.NOT_FOUND, error: ReasonPhrases.NOT_FOUND },
+    500: { status: StatusCodes.INTERNAL_SERVER_ERROR, error: ReasonPhrases.INTERNAL_SERVER_ERROR }
+};
+
+export const mockGetPscExtensionCountResponse = {
+    200: { status: StatusCodes.OK, body: 1 },
+    400: { status: StatusCodes.BAD_REQUEST, error: ReasonPhrases.BAD_REQUEST },
+    401: { status: StatusCodes.UNAUTHORIZED, error: ReasonPhrases.UNAUTHORIZED },
+    404: { status: StatusCodes.NOT_FOUND, error: ReasonPhrases.NOT_FOUND },
+    500: { status: StatusCodes.INTERNAL_SERVER_ERROR, error: ReasonPhrases.INTERNAL_SERVER_ERROR }
+};
+
+export const mockGetIsPscExtensionValidResponse = {
+    200: { status: StatusCodes.OK, body: VALIDATION_STATUS_RESPONSE_RESOURCE },
+    400: { status: StatusCodes.BAD_REQUEST, error: ReasonPhrases.BAD_REQUEST },
+    401: { status: StatusCodes.UNAUTHORIZED, error: ReasonPhrases.UNAUTHORIZED },
+    404: { status: StatusCodes.NOT_FOUND, error: ReasonPhrases.NOT_FOUND },
+    500: { status: StatusCodes.INTERNAL_SERVER_ERROR, error: ReasonPhrases.INTERNAL_SERVER_ERROR }
+};
+
+export const mockGetIsPscExtensionValidInvalidResponse = {
+    200: { status: StatusCodes.OK, body: VALIDATION_STATUS_RESPONSE_INVALID_RESOURCE }
+};
+
+export { PSC_EXTENSION_DATA };