feat: ORV2-2353 / ORV2-2351 Credit Account Hold and Close (#1451)

vehicles/src/common/constraint/credit-account-status-comment.constraint.ts

@@ -0,0 +1,40 @@
+import {
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
+  ValidationArguments,
+} from 'class-validator';
+import {
+  CreditAccountStatus,
+  CreditAccountStatusValidType,
+} from '../enum/credit-account-status-type.enum';
+
+@ValidatorConstraint({
+  name: 'CreditAccountStatusCommentConstraint',
+  async: false,
+})
+export class CreditAccountStatusCommentConstraint
+  implements ValidatorConstraintInterface
+{
+  validate(comment: string | undefined, args: ValidationArguments) {
+    const creditAccountStatusType = (
+      args.object as {
+        creditAccountStatusType?: CreditAccountStatusValidType;
+      }
+    ).creditAccountStatusType; // Access the searchString property from the same object
+
+    // If CreditAccountStatusType.ACCOUNT_CLOSED or CreditAccountStatusType.ACCOUNT_ON_HOLD , comment should exists
+    if (
+      (creditAccountStatusType === CreditAccountStatus.ACCOUNT_CLOSED ||
+        creditAccountStatusType === CreditAccountStatus.ACCOUNT_ON_HOLD) &&
+      !comment
+    ) {
+      return false;
+    }
+
+    return true;
+  }
+
+  defaultMessage() {
+    return `Comment is required when activity type is ${CreditAccountStatus.ACCOUNT_CLOSED} or ${CreditAccountStatus.ACCOUNT_ON_HOLD}`;
+  }
+}

vehicles/src/common/enum/credit-account-status-type.enum.ts

@@ -1,6 +1,19 @@
-export enum CreditAccountStatusType {
-  ACCOUNT_ON_HOLD = 'ONHOLD',
-  ACCOUNT_ACTIVE = 'ACTIVE',
-  ACCOUNT_SETUP_FAIL = 'SETUP_FAIL',
-  ACCOUNT_CLOSED = 'CLOSED',
-}
+export const CreditAccountStatus = {
+  ACCOUNT_ON_HOLD: 'ONHOLD',
+  ACCOUNT_ACTIVE: 'ACTIVE',
+  ACCOUNT_CLOSED: 'CLOSED',
+  ACCOUNT_SETUP_FAIL: 'SETUP_FAIL',
+} as const;
+
+export type CreditAccountStatusType =
+  (typeof CreditAccountStatus)[keyof typeof CreditAccountStatus];
+
+// Manually constructing the CreditAccountStatusValidType as a const
+export const CreditAccountStatusValid = {
+  ACCOUNT_ON_HOLD: CreditAccountStatus.ACCOUNT_ON_HOLD,
+  ACCOUNT_ACTIVE: CreditAccountStatus.ACCOUNT_ACTIVE,
+  ACCOUNT_CLOSED: CreditAccountStatus.ACCOUNT_CLOSED,
+} as const;
+
+export type CreditAccountStatusValidType =
+  (typeof CreditAccountStatus)[keyof typeof CreditAccountStatusValid];

vehicles/src/common/helper/credit-account.helper.ts

@@ -1,16 +1,47 @@
 import { CreditAccount } from '../../modules/credit-account/entities/credit-account.entity';
-import { CreditAccountStatusType } from '../enum/credit-account-status-type.enum';
+import { CreditAccountActivityType } from '../enum/credit-account-activity-type.enum';
+import {
+  CreditAccountStatus,
+  CreditAccountStatusType,
+  CreditAccountStatusValid,
+} from '../enum/credit-account-status-type.enum';
 
 export const isActiveCreditAccount = (creditAccount: CreditAccount) => {
   return (
     creditAccount?.creditAccountStatusType ===
-    CreditAccountStatusType.ACCOUNT_ACTIVE
+    CreditAccountStatus.ACCOUNT_ACTIVE
   );
 };
 
 export const isClosedCreditAccount = (creditAccount: CreditAccount) => {
   return (
     creditAccount?.creditAccountStatusType ===
-    CreditAccountStatusType.ACCOUNT_CLOSED
+    CreditAccountStatus.ACCOUNT_CLOSED
   );
 };
+
+export const isOnHoldCreditAccount = (creditAccount: CreditAccount) => {
+  return (
+    creditAccount?.creditAccountStatusType ===
+    CreditAccountStatus.ACCOUNT_ON_HOLD
+  );
+};
+
+export const getCreditAccountActivityType = (
+  creditAccount: CreditAccount,
+  statusToUpdateTo: CreditAccountStatusType,
+) => {
+  switch (statusToUpdateTo) {
+    case CreditAccountStatusValid.ACCOUNT_ACTIVE:
+      if (isClosedCreditAccount(creditAccount)) {
+        return CreditAccountActivityType.ACCOUNT_REOPENED;
+      } else if (isOnHoldCreditAccount(creditAccount)) {
+        return CreditAccountActivityType.ACCOUNT_HOLD_REMOVED;
+      }
+      break;
+    case CreditAccountStatusValid.ACCOUNT_ON_HOLD:
+      return CreditAccountActivityType.ACCOUNT_ON_HOLD;
+    case CreditAccountStatusValid.ACCOUNT_CLOSED:
+      return CreditAccountActivityType.ACCOUNT_CLOSED;
+  }
+};

vehicles/src/modules/credit-account/credit-account.controller.ts

@@ -1,4 +1,4 @@
-import { Body, Controller, Param, Post, Req } from '@nestjs/common';
+import { Body, Controller, Get, Param, Post, Put, Req } from '@nestjs/common';
 import {
   ApiBadRequestResponse,
   ApiBearerAuth,
@@ -21,6 +21,8 @@ import { CreditAccountService } from './credit-account.service';
 import { CreateCreditAccountDto } from './dto/request/create-credit-account.dto';
 import { ReadCreditAccountUserDto } from './dto/response/read-credit-account-user.dto';
 import { ReadCreditAccountDto } from './dto/response/read-credit-account.dto';
+import { CreditAccountIdPathParamDto } from './dto/request/pathParam/creditAccountUsers.path-params.dto';
+import { UpdateCreditAccountStatusDto } from './dto/request/update-credit-account-status.dto';
 
 @ApiBearerAuth()
 @ApiTags('Credit Accounts')
@@ -84,7 +86,7 @@ export class CreditAccountController {
     description: 'The retrieved credit account.',
     type: ReadCreditAccountDto,
   })
-  // @Get() - Uncomment when feature is ready
+  @Get()
   @Roles(Role.READ_CREDIT_ACCOUNT)
   async getCreditAccount(
     @Req() request: Request,
@@ -100,4 +102,40 @@ export class CreditAccountController {
     }
     return readCreditAccountDto;
   }
+
+  /**
+   * Updates the status of a credit account user.
+   *
+   * @param { companyId } - The companyId path parameter.
+   * @param { creditAccountId } - The creditAccountId path parameter.
+   * @param { creditAccountStatusType, comment } - The DTO containing status type and comment to update a credit account user.
+   * @returns The result of the update operation.
+   */
+  @ApiOperation({
+    summary: 'Updates the status of a credit account user.',
+    description:
+      'Updates the status of a credit account user, enforcing authentication.',
+  })
+  @ApiOkResponse({
+    description: 'The updated credit account status details.',
+    type: ReadCreditAccountUserDto,
+  })
+  @Put(':creditAccountId/status')
+  @Roles(Role.WRITE_CREDIT_ACCOUNT)
+  async updateCreditAccountStatus(
+    @Req() request: Request,
+    @Param() { companyId, creditAccountId }: CreditAccountIdPathParamDto,
+    @Body() { creditAccountStatusType, comment }: UpdateCreditAccountStatusDto,
+  ): Promise<ReadCreditAccountDto> {
+    const currentUser = request.user as IUserJWT;
+    return await this.creditAccountService.updateCreditAccountStatus(
+      currentUser,
+      {
+        creditAccountHolderId: companyId,
+        creditAccountId,
+        statusToUpdateTo: creditAccountStatusType,
+        comment: comment,
+      },
+    );
+  }
 }