Merge pull request #835 from companieshouse/feature/DEEP-620-updating-getIsPscExtensionValid-endpoint-removing-transactionId

Updating getIsPscExtensionValid endpoint to match backend changes

Author: cbroadley-ch

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

@@ -62,16 +62,15 @@ export default class PscExtensionService {
     /**
      * 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`;
+    public async getIsPscExtensionValid (pscNotificationId: string, companyNumber: string, headers?: Headers): Promise<Resource<ValidationStatusResponse> | ApiErrorResponse> {
+        const resourceUri = `/persons-with-significant-control-extensions/${pscNotificationId}/${companyNumber}/isPscExtensionRequestValid`;
         const response = await this.client.httpGet(resourceUri, headers);
 
         if (response.error) {

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

@@ -152,7 +152,7 @@ describe("PSC Extensions Service", () => {
             sinon.stub(requestClient, "httpGet").resolves(mockGetIsPscExtensionValidResponse[200]);
 
             const response = (await pscExtensionService.getIsPscExtensionValid(
-                TRANSACTION_ID, PSC_NOTIFICATION_ID, COMPANY_NUMBER)) as Resource<ValidationStatusResponse>;
+                PSC_NOTIFICATION_ID, COMPANY_NUMBER)) as Resource<ValidationStatusResponse>;
 
             expect(response.httpStatusCode).to.equal(StatusCodes.OK);
             expect(response.resource!.valid).to.be.true;
@@ -163,7 +163,7 @@ describe("PSC Extensions Service", () => {
             sinon.stub(requestClient, "httpGet").resolves(mockGetIsPscExtensionValidInvalidResponse[200]);
 
             const response = (await pscExtensionService.getIsPscExtensionValid(
-                TRANSACTION_ID, PSC_NOTIFICATION_ID, COMPANY_NUMBER)) as Resource<ValidationStatusResponse>;
+                PSC_NOTIFICATION_ID, COMPANY_NUMBER)) as Resource<ValidationStatusResponse>;
 
             expect(response.httpStatusCode).to.equal(StatusCodes.OK);
             expect(response.resource!.valid).to.be.false;
@@ -175,7 +175,7 @@ describe("PSC Extensions Service", () => {
             sinon.stub(requestClient, "httpGet").resolves(mockGetIsPscExtensionValidResponse[400]);
 
             const response = await pscExtensionService.getIsPscExtensionValid(
-                TRANSACTION_ID, PSC_NOTIFICATION_ID, COMPANY_NUMBER) as ApiErrorResponse;
+                PSC_NOTIFICATION_ID, COMPANY_NUMBER) as ApiErrorResponse;
 
             expect(response.httpStatusCode).to.equal(StatusCodes.BAD_REQUEST);
             expect(response.errors?.[0]).to.equal(ReasonPhrases.BAD_REQUEST);
@@ -185,7 +185,7 @@ describe("PSC Extensions Service", () => {
             sinon.stub(requestClient, "httpGet").resolves(mockGetIsPscExtensionValidResponse[401]);
 
             const response = await pscExtensionService.getIsPscExtensionValid(
-                TRANSACTION_ID, PSC_NOTIFICATION_ID, COMPANY_NUMBER) as ApiErrorResponse;
+                PSC_NOTIFICATION_ID, COMPANY_NUMBER) as ApiErrorResponse;
 
             expect(response.httpStatusCode).to.equal(StatusCodes.UNAUTHORIZED);
             expect(response.errors?.[0]).to.equal(ReasonPhrases.UNAUTHORIZED);
@@ -195,7 +195,7 @@ describe("PSC Extensions Service", () => {
             sinon.stub(requestClient, "httpGet").resolves(mockGetIsPscExtensionValidResponse[404]);
 
             const response = await pscExtensionService.getIsPscExtensionValid(
-                TRANSACTION_ID, PSC_NOTIFICATION_ID, COMPANY_NUMBER) as ApiErrorResponse;
+                PSC_NOTIFICATION_ID, COMPANY_NUMBER) as ApiErrorResponse;
 
             expect(response.httpStatusCode).to.equal(StatusCodes.NOT_FOUND);
             expect(response.errors?.[0]).to.equal(ReasonPhrases.NOT_FOUND);
@@ -205,7 +205,7 @@ describe("PSC Extensions Service", () => {
             sinon.stub(requestClient, "httpGet").resolves(mockGetIsPscExtensionValidResponse[500]);
 
             const response = await pscExtensionService.getIsPscExtensionValid(
-                TRANSACTION_ID, PSC_NOTIFICATION_ID, COMPANY_NUMBER) as ApiErrorResponse;
+                PSC_NOTIFICATION_ID, COMPANY_NUMBER) as ApiErrorResponse;
 
             expect(response.httpStatusCode).to.equal(StatusCodes.INTERNAL_SERVER_ERROR);
             expect(response.errors?.[0]).to.equal(ReasonPhrases.INTERNAL_SERVER_ERROR);
@@ -215,7 +215,7 @@ describe("PSC Extensions Service", () => {
             const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetIsPscExtensionValidResponse[200]);
             const headers = { "X-Request-Id": "random-uuid" };
 
-            await pscExtensionService.getIsPscExtensionValid(TRANSACTION_ID, PSC_NOTIFICATION_ID, COMPANY_NUMBER, headers);
+            await pscExtensionService.getIsPscExtensionValid(PSC_NOTIFICATION_ID, COMPANY_NUMBER, headers);
 
             expect(mockRequest.calledOnce).to.be.true;
             expect(mockRequest.firstCall.args[1]).to.deep.equal(headers);