ORV2-3491 Add claimed company validation to verify-client endpoint. (#1836)

Author: praju-aot

vehicles/src/modules/company-user-management/company/company.controller.ts

@@ -20,6 +20,7 @@ import {
   ApiOkResponse,
   ApiOperation,
   ApiTags,
+  ApiUnprocessableEntityResponse,
 } from '@nestjs/swagger';
 import { DataNotFoundException } from '../../../common/exception/data-not-found.exception';
 import { ExceptionDto } from '../../../common/exception/exception.dto';
@@ -63,6 +64,10 @@ import { doesUserHaveRole } from '../../../common/helper/auth.helper';
   description: 'The Company Api Internal Server Error Response',
   type: ExceptionDto,
 })
+@ApiUnprocessableEntityResponse({
+  description: 'The Company Entity could not be processed.',
+  type: ExceptionDto,
+})
 @ApiBearerAuth()
 @Controller('companies')
 export class CompanyController {
@@ -228,8 +233,9 @@ export class CompanyController {
   }
 
   /**
-   * A POST method defined with a route of /verify-client that verifies
-   * the existence of a migrated/onRoute BC client and their permit in the system.
+   * A POST method is defined with a route of /verify-client that verifies
+   * the existence of a migrated/OnRouteBC client and their permit in the system.
+   * A 422 unprocessable exception will be thrown if it is found that the company has already been claimed in OnRouteBC.
    *
    * @returns The verified client details with response object {@link ReadVerifyClientDto}.
    */
@@ -240,7 +246,7 @@ export class CompanyController {
   @ApiOperation({
     summary: 'Verify Migrated/onRouteBC Client',
     description:
-      'Verifies the existence of a migrated/onRouteBC client and their permit in the database',
+      'Verifies the existence of a migrated/onRouteBC client and their permit in the database. A 422 unprocessable exception will be thrown if it is found that the company has already been claimed in OnRouteBC.',
   })
   @AuthOnly()
   @Post('verify-client')

vehicles/src/modules/company-user-management/company/company.service.ts

@@ -53,6 +53,7 @@ import { ReadVerifyClientDto } from './dto/response/read-verify-client.dto';
 import { Permit } from '../../permit-application-payment/permit/entities/permit.entity';
 import { DopsService } from '../../common/dops.service';
 import { INotificationDocument } from '../../../common/interface/notification-document.interface';
+import { throwUnprocessableEntityException } from '../../../common/helper/exception.helper';
 
 @Injectable()
 export class CompanyService {
@@ -792,8 +793,9 @@ export class CompanyService {
    * The verifyClient() method attempts to validate the existence and correct linkage of a specified client
    * and their associated permit within the system. The process involves searching for a company using a provided
    * client number (including handling legacy client number scenarios) and then verifying the existence of a
-   * permit that correlates with the identified company. The outcome is encapsulated in a ReadVerifyClientDto
-   * object indicating the presence of the client, the permit, and the successful verification if applicable.
+   * permit that correlates with the identified company. If the company has been claimed already, an unprocessable
+   * entity error is thrown. The outcome is encapsulated in a ReadVerifyClientDto object indicating the presence
+   * of the client, the permit, and the successful verification if applicable.
    *
    * @param currentUser The current logged in user's JWT token.
    * @param verifyClientDto The DTO containing the client and permit number to verify.
@@ -850,6 +852,12 @@ export class CompanyService {
       if (permit) {
         verifyClient.foundPermit = true;
         if (permit.company?.companyId === company?.companyId) {
+          //Throw an error if the company has already been claimed
+          if (company?.companyUsers?.length) {
+            throwUnprocessableEntityException(
+              `You do not have the necessary authorization to view this page. Please contact your administrator.`,
+            );
+          }
           verifyClient.verifiedClient =
             await this.mapCompanyEntityToCompanyDto(company);
         }