@tomei/rental 0.10.4 → 0.11.1

package/src/components/rental/rental.ts

@@ -1,861 +1,961 @@
-import { IRentalAttr } from '../../interfaces/rental-attr.interface';
-import { RentalStatusEnum } from '../../enum/rental-status.enum';
-import { RentalRepository } from './rental.repository';
-import { ClassError, ObjectBase } from '@tomei/general';
-import { ApplicationConfig } from '@tomei/config';
-import { LoginUser } from '@tomei/sso';
-import { RentalPrice } from '../rental-price/rental-price';
-import { Op, QueryTypes } from 'sequelize';
-import { ActionEnum, Activity } from '@tomei/activity-history';
-import { IRentalFindAllSearchAttr } from '../../interfaces/rental-find-all-search-attr.interface';
-import { RentalAccountTypeEnum } from '../../enum/account-type.enum';
-import { JointHirer } from '../joint-hirer/joint-hirer';
-import { JointHirerModel } from '../../models/joint-hirer.entity';
-import { AgreementRepository } from '../agreement/agreement.repository';
-import * as rentalDb from '../../database';
-import { RentalModel } from '../../models/rental.entity';
-import { JointHirerRepository } from '../joint-hirer/joint-hirer.repository';
-import { AgreementModel } from '../../models';
-import { Agreement } from '../agreement/agreement';
-import { AggrementStatusEnum } from '../../enum/aggrement-status.enum';
-
-export class Rental extends ObjectBase {
-  ObjectId: string;
-  ObjectName: string;
-  ObjectType = 'Rental';
-  TableName: string;
-  CustomerId: string;
-  CustomerType: string;
-  ItemId: string;
-  ItemType: string;
-  PriceId: string;
-  StartDateTime: Date;
-  EndDateTime: Date;
-  CancelRemarks: string;
-  TerminateRemarks: string;
-  AgreementNo: string;
-  AccountType: RentalAccountTypeEnum;
-  JointHirers: JointHirer[] = [];
-  protected _Status: RentalStatusEnum;
-  protected _EscheatmentYN: string = 'N';
-  protected _CreatedById: string;
-  protected _CreatedAt: Date;
-  protected _UpdatedById: string;
-  protected _UpdatedAt: Date;
-  protected static _Repo = new RentalRepository();
-  protected static _AgreementRepo = new AgreementRepository();
-  protected static _JointHirerRepo = new JointHirerRepository();
-
-  get RentalId(): string {
-    return this.ObjectId;
-  }
-
-  set RentalId(value: string) {
-    this.ObjectId = value;
-  }
-
-  get Status(): RentalStatusEnum {
-    return this._Status;
-  }
-
-  get EscheatmentYN(): string {
-    return this._EscheatmentYN;
-  }
-
-  get CreatedById(): string {
-    return this._CreatedById;
-  }
-
-  get CreatedAt(): Date {
-    return this._CreatedAt;
-  }
-
-  get UpdatedById(): string {
-    return this._UpdatedById;
-  }
-
-  get UpdatedAt(): Date {
-    return this._UpdatedAt;
-  }
-
-  private setTerminated() {
-    this._Status = RentalStatusEnum.TERMINATED;
-  }
-
-  protected constructor(rentalAttr?: IRentalAttr) {
-    super();
-    if (rentalAttr) {
-      this.RentalId = rentalAttr.RentalId;
-      this.CustomerId = rentalAttr.CustomerId;
-      this.CustomerType = rentalAttr.CustomerType;
-      this.ItemId = rentalAttr.ItemId;
-      this.ItemType = rentalAttr.ItemType;
-      this.PriceId = rentalAttr.PriceId;
-      this.StartDateTime = rentalAttr.StartDateTime;
-      this.EndDateTime = rentalAttr.EndDateTime;
-      this.CancelRemarks = rentalAttr.CancelRemarks;
-      this.TerminateRemarks = rentalAttr.TerminateRemarks;
-      this.AgreementNo = rentalAttr.AgreementNo;
-      this.AccountType = rentalAttr.AccountType;
-      this._Status = rentalAttr.Status;
-      this._EscheatmentYN = rentalAttr.EscheatmentYN;
-      this._CreatedById = rentalAttr.CreatedById;
-      this._CreatedAt = rentalAttr.CreatedAt;
-      this._UpdatedById = rentalAttr.UpdatedById;
-      this._UpdatedAt = rentalAttr.UpdatedAt;
-    }
-  }
-
-  public static async init(dbTransaction?: any, rentalId?: string) {
-    try {
-      if (rentalId) {
-        const rental = await Rental._Repo.findByPk(rentalId, dbTransaction);
-        if (rental) {
-          return new Rental(rental);
-        } else {
-          throw new ClassError('Rental', 'RentalErrMsg00', 'Rental Not Found');
-        }
-      }
-      return new Rental();
-    } catch (error) {
-      throw new ClassError(
-        'Rental',
-        'RentalErrMsg00',
-        'Failed To Initialize Price',
-      );
-    }
-  }
-
-  /**
-   * Create a new Rental record.
-   * @param {RentalPrice} rentalPrice - The rental pricing information.
-   * @param {LoginUser} loginUser - The user initiating the creation.
-   * @param {any} [dbTransaction] - Optional database transaction for atomic operations.
-   * @throws {ClassError} Throws an error if:
-   *   1. loginUser does not have 'Rental - Create' privilege.
-   *   2. Rental item is not available at the current date.
-   * @returns {Promise<any>} A Promise resolving to the created rental record.
-   */
-  public async create(
-    rentalPrice: RentalPrice,
-    loginUser: LoginUser,
-    jointHirers?: JointHirer[],
-    dbTransaction?: any,
-  ): Promise<any> {
-    try {
-      /*Part 1: Check Privilege*/
-      const systemCode =
-        ApplicationConfig.getComponentConfigValue('system-code');
-      const isPrivileged = await loginUser.checkPrivileges(
-        systemCode,
-        'Rental - Create',
-      );
-
-      if (!isPrivileged) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg01',
-          "You do not have 'Rental - Create' privilege.",
-        );
-      }
-
-      /*Part 2: Make Sure Rental Item Available*/
-      const isItemAvailable = await Rental.isItemAvailable(
-        this.ItemId,
-        this.ItemType,
-        this.StartDateTime,
-        this.EndDateTime,
-        dbTransaction,
-      );
-
-      if (!isItemAvailable) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg02',
-          'Rental Item is not available at current date.',
-        );
-      }
-
-      // Part 3: Create Rental Agreement Record
-      // Call Rental._AgreementRepo create method by passing:
-      // AgreementNo: this.AgreementNo
-      // Status: "Not Generated"
-      // dbTransaction
-      await Rental._AgreementRepo.create(
-        {
-          AgreementNo: this.AgreementNo,
-          Status: 'Not Generated',
-        },
-        {
-          transaction: dbTransaction,
-        },
-      );
-
-      /*Part 4: Insert Rental & The Agreed Rental Price*/
-      await rentalPrice.create(loginUser, dbTransaction);
-
-      this.PriceId = rentalPrice.PriceId;
-
-      this.RentalId = this.createId();
-      // if (!this.Status) {
-      this._Status = RentalStatusEnum.PENDING_SIGNING;
-      // }
-      this._CreatedById = loginUser.ObjectId;
-      this._UpdatedById = loginUser.ObjectId;
-      this._CreatedAt = new Date();
-      this._UpdatedAt = new Date();
-
-      const data = {
-        RentalId: this.RentalId,
-        CustomerId: this.CustomerId,
-        CustomerType: this.CustomerType,
-        ItemId: this.ItemId,
-        ItemType: this.ItemType,
-        PriceId: this.PriceId,
-        StartDateTime: this.StartDateTime,
-        EndDateTime: this.EndDateTime,
-        CancelRemarks: this.CancelRemarks,
-        TerminateRemarks: this.TerminateRemarks,
-        AgreementNo: this.AgreementNo,
-        AccountType: this.AccountType,
-        Status: this.Status,
-        EscheatmentYN: this.EscheatmentYN,
-        CreatedById: this.CreatedById,
-        CreatedAt: this.CreatedAt,
-        UpdatedById: this.UpdatedById,
-        UpdatedAt: this.UpdatedAt,
-      };
-
-      await Rental._Repo.create(data, {
-        transaction: dbTransaction,
-      });
-
-      //For every data inside Param.jointHirers, update the rentalId and call jointHirer.create
-      if (jointHirers) {
-        for (let i = 0; i < jointHirers.length; i++) {
-          jointHirers[i].RentalId = this.RentalId;
-          await jointHirers[i].create(loginUser, dbTransaction);
-          this.JointHirers.push(jointHirers[i]);
-        }
-      }
-
-      /*Part 5: Record Create Rental Activity*/
-      const activity = new Activity();
-      activity.ActivityId = activity.createId();
-      activity.Action = ActionEnum.ADD;
-      activity.Description = 'Add Rental';
-      activity.EntityType = 'Rental';
-      activity.EntityId = this.RentalId;
-      activity.EntityValueBefore = JSON.stringify({});
-      activity.EntityValueAfter = JSON.stringify(data);
-      await activity.create(loginUser.ObjectId, dbTransaction);
-
-      /*Part 6: Return Result*/
-      return this;
-    } catch (error) {
-      throw error;
-    }
-  }
-
-  public static async isItemAvailable(
-    itemId: string,
-    itemType: string,
-    startDateTime: Date,
-    endDateTime: Date,
-    dbTransaction?: any,
-  ) {
-    try {
-      const item = await Rental._Repo.findOne({
-        where: {
-          ItemId: itemId,
-          ItemType: itemType,
-          StartDateTime: {
-            [Op.lte]: endDateTime,
-          },
-          EndDateTime: {
-            [Op.gte]: startDateTime,
-          },
-        },
-        transaction: dbTransaction,
-      });
-
-      if (item) {
-        return false;
-      } else {
-        return true;
-      }
-    } catch (error) {
-      throw error;
-    }
-  }
-
-  public static async findAll(
-    loginUser: LoginUser,
-    dbTransaction: any,
-    page?: number,
-    row?: number,
-    search?: IRentalFindAllSearchAttr,
-  ) {
-    try {
-      const systemCode = await ApplicationConfig.getComponentConfigValue(
-        'system-code',
-      );
-
-      const isPrivileged = await loginUser.checkPrivileges(
-        systemCode,
-        'Rental - View',
-      );
-
-      if (!isPrivileged) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg01',
-          "You do not have 'Rental - View' privilege.",
-        );
-      }
-
-      const queryObj: any = {};
-
-      let options: any = {
-        transaction: dbTransaction,
-        order: [['CreatedAt', 'DESC']],
-      };
-
-      if (page && row) {
-        options = {
-          ...options,
-          limit: row,
-          offset: row * (page - 1),
-        };
-      }
-
-      if (search) {
-        Object.entries(search).forEach(([key, value]) => {
-          if (key === 'StartDateTime') {
-            queryObj[key] = {
-              [Op.gte]: value,
-            };
-          } else if (key === 'EndDateTime') {
-            queryObj[key] = {
-              [Op.lte]: value,
-            };
-          } else if (key === 'CustomerId') {
-            queryObj[key] = {
-              [Op.substring]: value,
-            };
-
-            options.include = [
-              {
-                model: JointHirerModel,
-                required: false,
-                where: {
-                  CustomerId: {
-                    [Op.substring]: value,
-                  },
-                },
-              },
-            ];
-          } else {
-            queryObj[key] = {
-              [Op.substring]: value,
-            };
-          }
-        });
-        if (options?.include?.length > 1) {
-          options.include.push({
-            model: AgreementModel,
-            required: false,
-          });
-        } else {
-          options.include = [
-            {
-              model: AgreementModel,
-              required: false,
-            },
-          ];
-        }
-
-        options = {
-          ...options,
-          where: queryObj,
-        };
-      }
-
-      return await Rental._Repo.findAndCountAll(options);
-    } catch (err) {
-      throw err;
-    }
-  }
-
-  public static async checkActiveByItemId(
-    loginUser: LoginUser,
-    itemId: string,
-    itemType: string,
-    dbTransaction?: any,
-  ) {
-    try {
-      const systemCode = await ApplicationConfig.getComponentConfigValue(
-        'system-code',
-      );
-
-      const isPrivileged = await loginUser.checkPrivileges(
-        systemCode,
-        'Rental - View',
-      );
-
-      if (!isPrivileged) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg01',
-          "You do not have 'Rental - View' privilege.",
-        );
-      }
-
-      const queryObj: any = {
-        ItemId: itemId,
-        ItemType: itemType,
-        Status: RentalStatusEnum.ACTIVE,
-      };
-
-      const options: any = {
-        transaction: dbTransaction,
-        where: queryObj,
-      };
-
-      const rental = await Rental._Repo.findOne(options);
-
-      if (rental) {
-        return true;
-      } else {
-        return false;
-      }
-    } catch (err) {
-      throw err;
-    }
-  }
-
-  /**
-   * Sets the StartDateTime property of the Rental class as custom setter.
-   * @param {Date} startDateTime - The start date and time of the rental.
-   * @throws {ClassError} Throws an error if:
-   *   1. startDateTime is a past date.
-   *   2. startDateTime is more than the EndDateTime.
-   * @returns {void}
-   */
-  setStartDateTime(startDateTime: Date): void {
-    const startDateTimeObject = new Date(startDateTime);
-    startDateTimeObject.setHours(0, 0, 0, 0);
-
-    /*Part 1: Make Sure Future Date Time*/
-    if (startDateTimeObject < new Date(new Date().setHours(0, 0, 0, 0))) {
-      throw new ClassError(
-        'Rental',
-        'RentalErrMsg02',
-        'StartDateTime cannot be a past datetime.',
-      );
-    }
-
-    /*Part 2: Make Sure Less Than End Date Time*/
-    if (this.EndDateTime && startDateTimeObject > this.EndDateTime) {
-      throw new ClassError(
-        'Rental',
-        'RentalErrMsg03',
-        'StartDateTime cannot be more than EndDateTime.',
-      );
-    }
-
-    /*Part 3: Set Status Whether Reserved or Active*/
-    if (startDateTimeObject > new Date(new Date().setHours(0, 0, 0, 0))) {
-      this._Status = RentalStatusEnum.RESERVED;
-    } else {
-      this._Status = RentalStatusEnum.ACTIVE;
-    }
-  }
-
-  public async periodEndProcess(
-    loginUser: LoginUser,
-    dbTransaction: any,
-    stockInventory: any,
-  ) {
-    try {
-      // Privilege Checking
-      const systemCode = await ApplicationConfig.getComponentConfigValue(
-        'system-code',
-      );
-
-      const isPrivileged = await loginUser.checkPrivileges(
-        systemCode,
-        'Rental – PeriodEndProcess',
-      );
-
-      if (!isPrivileged) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg04',
-          "You do not have 'Rental - PeriodEndProcess' privilege.",
-        );
-      }
-
-      // Validate Existing Rental
-      if (this.AgreementNo === undefined || this.AgreementNo === null) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg05',
-          'Rental must be existing rental.',
-        );
-      }
-
-      // Validate Rental End Period
-      if (this.EndDateTime === new Date(new Date().setHours(0, 0, 0, 0))) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg06',
-          'Rental period is not ending today.',
-        );
-      }
-
-      // Mark Rental Item as Available
-      await stockInventory.setAvailable(loginUser, dbTransaction);
-
-      // Capture Record Info Before Changes
-      const entityValueBefore = {
-        RentalId: this.RentalId,
-        CustomerId: this.CustomerId,
-        CustomerType: this.CustomerType,
-        ItemId: this.ItemId,
-        ItemType: this.ItemType,
-        PriceId: this.PriceId,
-        StartDateTime: this.StartDateTime,
-        EndDateTime: this.EndDateTime,
-        CancelRemarks: this.CancelRemarks,
-        TerminateRemarks: this.TerminateRemarks,
-        AgreementNo: this.AgreementNo,
-        AccountType: this.AccountType,
-        Status: this.Status,
-        EscheatmentYN: this.EscheatmentYN,
-        CreatedById: this.CreatedById,
-        CreatedAt: this.CreatedAt,
-        UpdatedById: this.UpdatedById,
-        UpdatedAt: this.UpdatedAt,
-      };
-
-      // Mark Rental as Terminated and Capture Updater Info
-      this.setTerminated();
-      this._UpdatedById = loginUser.ObjectId;
-      this._UpdatedAt = new Date();
-
-      // Capture Record Info after Changes
-      const entityValueAfter = {
-        RentalId: this.RentalId,
-        CustomerId: this.CustomerId,
-        CustomerType: this.CustomerType,
-        ItemId: this.ItemId,
-        ItemType: this.ItemType,
-        PriceId: this.PriceId,
-        StartDateTime: this.StartDateTime,
-        EndDateTime: this.EndDateTime,
-        CancelRemarks: this.CancelRemarks,
-        TerminateRemarks: this.TerminateRemarks,
-        AgreementNo: this.AgreementNo,
-        AccountType: this.AccountType,
-        Status: this.Status,
-        EscheatmentYN: this.EscheatmentYN,
-        CreatedById: this.CreatedById,
-        CreatedAt: this.CreatedAt,
-        UpdatedById: this.UpdatedById,
-        UpdatedAt: this.UpdatedAt,
-      };
-
-      // Record the Update Activity
-      const activity = new Activity();
-      activity.ActivityId = activity.createId();
-      activity.Action = ActionEnum.UPDATE;
-      activity.Description = 'Set Rental as Terminated';
-      activity.EntityType = 'Rental';
-      activity.EntityId = this.RentalId;
-      activity.EntityValueBefore = JSON.stringify(entityValueBefore);
-      activity.EntityValueAfter = JSON.stringify(entityValueAfter);
-      await activity.create(loginUser.ObjectId, dbTransaction);
-
-      return this;
-    } catch (err) {
-      throw err;
-    }
-  }
-
-  async getCustomerActiveRentals(
-    loginUser: LoginUser,
-    dbTransaction: any,
-    CustomerId: string,
-  ): Promise<IRentalAttr[]> {
-    try {
-      // Part 1: Privilege Checking
-      // Call loginUser.checkPrivileges() by passing:
-      // SystemCode: <get_from_app_config>
-      // PrivilegeCode: "RENTAL_VIEW"
-      const systemCode =
-        ApplicationConfig.getComponentConfigValue('system-code');
-      const isPrivileged = loginUser.checkPrivileges(systemCode, 'RENTAL_VIEW');
-
-      if (!isPrivileged) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg01',
-          "You do not have 'Rental - View' privilege.",
-        );
-      }
-
-      // Part 2: Retrieve Rentals and Returns
-      // Call Rental._Repo findAll method by passing:
-      // where:
-      // Status: "Active"
-      // [Op.OR]:
-      // CustomerId: Params.CustomerId
-      // '$JointHirers.CustomerId$': Params.CustomerId
-      // include:
-      // model: JointHirerModel
-      // attributes: []
-      const query = `
-      SELECT 
-          r.*
-      FROM 
-          rental_Rental r
-      LEFT JOIN 
-          rental_JointHirer jh ON r.RentalId = jh.RentalId
-      WHERE 
-          r.Status = 'Active'
-          AND (
-              r.CustomerId = '${CustomerId}' 
-              OR jh.CustomerId = '${CustomerId}'
-          )
-      GROUP BY
-          r.RentalId
-      `;
-      const db = rentalDb.getConnection();
-      const result = await db.query(query, {
-        type: QueryTypes.SELECT,
-        transaction: dbTransaction,
-        model: RentalModel,
-        mapToModel: true,
-      });
-
-      // Format the returned records
-      const records: IRentalAttr[] = result.map((record: RentalModel) => {
-        return {
-          RentalId: record.RentalId,
-          CustomerId: record.CustomerId,
-          CustomerType: record.CustomerType,
-          ItemId: record.ItemId,
-          ItemType: record.ItemType,
-          PriceId: record.PriceId,
-          StartDateTime: record.StartDateTime,
-          EndDateTime: record.EndDateTime,
-          CancelRemarks: record.CancelRemarks,
-          TerminateRemarks: record.TerminateRemarks,
-          AgreementNo: record.AgreementNo,
-          AccountType: record.AccountType,
-          Status: record.Status,
-          EscheatmentYN: record.EscheatmentYN,
-          CreatedById: record.CreatedById,
-          CreatedAt: record.CreatedAt,
-          UpdatedById: record.UpdatedById,
-          UpdatedAt: record.UpdatedAt,
-        };
-      });
-      // Return the returned records.
-      return records;
-    } catch (error) {
-      throw error;
-    }
-  }
-
-  async getCustomerIds(loginUser: LoginUser, dbTransaction: any) {
-    try {
-      // Part 1: Privilege Checking
-      // Call loginUser.checkPrivileges() by passing:
-      // SystemCode: <get_from_app_config>
-      // PrivilegeCode: "RENTAL_VIEW"
-      const systemCode =
-        ApplicationConfig.getComponentConfigValue('system-code');
-      const isPrivileged = loginUser.checkPrivileges(systemCode, 'RENTAL_VIEW');
-
-      if (!isPrivileged) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg01',
-          "You do not have 'Rental - View' privilege.",
-        );
-      }
-
-      // Part 2: Validation
-      // Make sure this.RentalId exists, if not throw new ClassError by passing
-      if (!this.RentalId) {
-        throw new ClassError('Rental', 'RentalErrMsg01', 'RentalId is missing');
-      }
-
-      //Part 3: Retrieve Listing and Returns
-      // 3.1  Call Rental._JointHirerRepo findAll method by passing:
-      //      where:
-      //          RentalId: this.RentalId
-      //      dbTransaction
-      const options: any = {
-        where: {
-          RentalId: this.RentalId,
-        },
-        transaction: dbTransaction,
-      };
-
-      const joinHirers = await Rental._JointHirerRepo.findAll(options);
-
-      // 3.2 Create a new array variable and set its value to joint hirer and Rental.CustomerId
-      // array translated to only CustomerId. Then, append this.CustomerId to the array.
-      const customerIds: string[] = [this.CustomerId];
-      for (let i = 0; i < joinHirers.length; i++) {
-        const jointHirer = joinHirers[i];
-        customerIds.push(jointHirer.CustomerId);
-      }
-
-      // 3.3 Return the array.
-      return customerIds;
-    } catch (error) {
-      throw error;
-    }
-  }
-
-  async signAgreement(loginUser: LoginUser, dbTransaction: any) {
-    try {
-      // Part 1: Privilege Checking
-      // Call loginUser.checkPrivileges() by passing:
-      // SystemCode: <get_from_app_config>
-      // PrivilegeCode: "RENTAL_SIGN"
-      const systemCode =
-        ApplicationConfig.getComponentConfigValue('system-code');
-      const isPrivileged = loginUser.checkPrivileges(systemCode, 'RENTAL_SIGN');
-
-      if (!isPrivileged) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg01',
-          "You do not have 'RENTAL_SIGN' privilege.",
-        );
-      }
-
-      // Part 2: Validation
-      // Make sure this.Status is "Pending Signing" and agreementStatus is "Generated", if not throw new ClassError
-      const agreement = await Agreement.init(this.AgreementNo, dbTransaction);
-      if (
-        this.Status !== RentalStatusEnum.PENDING_SIGNING &&
-        agreement.Status !== AggrementStatusEnum.GENERATED
-      ) {
-        throw new ClassError(
-          'Rental',
-          'RentalErrMsg01',
-          'Rental is not ready to be signed yet.',
-        );
-      }
-
-      //Part 3: Update Agreement Status
-      // 3.1  Set EntityValueBefore to current agreement instance.
-      const entityValueAgreementBefore = {
-        AgreementNo: agreement.AgreementNo,
-        Status: agreement.Status,
-        DateSigned: agreement.DateSigned,
-      };
-
-      // 3.2  Set below agreement attributes:
-      // DateSigned: current date & time
-      // Status: "Signed"
-      const payload = {
-        DateSigned: new Date(),
-        Status: AggrementStatusEnum.SIGNED,
-      };
-
-      // 3.3  Call Rental._AgreementRepo update()
-      await Rental._AgreementRepo.update(payload, {
-        where: {
-          AgreementNo: this.AgreementNo,
-        },
-        transaction: dbTransaction,
-      });
-
-      const entityValueAgreementAfter = {
-        entityValueAgreementBefore,
-        ...payload,
-      };
-
-      // Part 4: Record Update Agreement Activity
-      const activity = new Activity();
-      activity.ActivityId = activity.createId();
-      activity.Action = ActionEnum.UPDATE;
-      activity.Description = 'Update agreement';
-      activity.EntityType = 'RentalAgreement';
-      activity.EntityId = this.AgreementNo;
-      activity.EntityValueBefore = JSON.stringify(entityValueAgreementBefore);
-      activity.EntityValueAfter = JSON.stringify(entityValueAgreementAfter);
-      await activity.create(loginUser.ObjectId, dbTransaction);
-
-      // Part 5: Update Rental Status
-      // 5.1  Set EntityValueBefore to current rental instance.
-      const entityValueRentalBefore = {
-        RentalId: this.RentalId,
-        CustomerId: this.CustomerId,
-        CustomerType: this.CustomerType,
-        ItemId: this.ItemId,
-        ItemType: this.ItemType,
-        PriceId: this.PriceId,
-        StartDateTime: this.StartDateTime,
-        EndDateTime: this.EndDateTime,
-        CancelRemarks: this.CancelRemarks,
-        TerminateRemarks: this.TerminateRemarks,
-        AgreementNo: this.AgreementNo,
-        AccountType: this.AccountType,
-        Status: this.Status,
-        EscheatmentYN: this.EscheatmentYN,
-        CreatedById: this.CreatedById,
-        CreatedAt: this.CreatedAt,
-        UpdatedById: this.UpdatedById,
-        UpdatedAt: this.UpdatedAt,
-      };
-      // 5.2:  Set below rental attributes:
-      // Status: "Pending Key Collection"
-      // UpdatedById: loginUser.ObjectId
-      // UpdatedAt: current date & time
-
-      const payloadRental = {
-        Status: RentalStatusEnum.PENDING_KEY_COLLECTION,
-        UpdatedById: loginUser.ObjectId,
-        UpdatedAt: new Date(),
-      };
-
-      // 5.3:  Call Rental._Repo update() method by passing:
-      // populate rental instance attributes
-      // dbTransaction
-      await Rental._Repo.update(payloadRental, {
-        where: {
-          RentalId: this.RentalId,
-        },
-        transaction: dbTransaction,
-      });
-
-      const entityValueRentalAfter = {
-        entityValueRentalBefore,
-        ...payloadRental,
-      };
-
-      // Part 6: Record Update Agreement Activity
-      const rentalActivity = new Activity();
-      rentalActivity.ActivityId = activity.createId();
-      rentalActivity.Action = ActionEnum.UPDATE;
-      rentalActivity.Description = 'Sign rental agreement';
-      rentalActivity.EntityType = 'Rental';
-      rentalActivity.EntityId = this.RentalId;
-      rentalActivity.EntityValueBefore = JSON.stringify(
-        entityValueRentalBefore,
-      );
-      rentalActivity.EntityValueAfter = JSON.stringify(entityValueRentalAfter);
-      await rentalActivity.create(loginUser.ObjectId, dbTransaction);
-    } catch (error) {
-      throw error;
-    }
-  }
-}
+import { IRentalAttr } from '../../interfaces/rental-attr.interface';
+import { RentalStatusEnum } from '../../enum/rental-status.enum';
+import { RentalRepository } from './rental.repository';
+import { ClassError, ObjectBase } from '@tomei/general';
+import { ApplicationConfig } from '@tomei/config';
+import { LoginUser } from '@tomei/sso';
+import { RentalPrice } from '../rental-price/rental-price';
+import { Op, QueryTypes } from 'sequelize';
+import { ActionEnum, Activity } from '@tomei/activity-history';
+import { IRentalFindAllSearchAttr } from '../../interfaces/rental-find-all-search-attr.interface';
+import { RentalAccountTypeEnum } from '../../enum/account-type.enum';
+import { JointHirer } from '../joint-hirer/joint-hirer';
+import { JointHirerModel } from '../../models/joint-hirer.entity';
+import { AgreementRepository } from '../agreement/agreement.repository';
+import * as rentalDb from '../../database';
+import { RentalModel } from '../../models/rental.entity';
+import { JointHirerRepository } from '../joint-hirer/joint-hirer.repository';
+import { AgreementModel } from '../../models';
+import { Agreement } from '../agreement/agreement';
+import { AggrementStatusEnum } from '../../enum/aggrement-status.enum';
+
+export class Rental extends ObjectBase {
+  ObjectId: string;
+  ObjectName: string;
+  ObjectType = 'Rental';
+  TableName: string;
+  CustomerId: string;
+  CustomerType: string;
+  ItemId: string;
+  ItemType: string;
+  PriceId: string;
+  StartDateTime: Date;
+  EndDateTime: Date;
+  CancelRemarks: string;
+  TerminateRemarks: string;
+  AgreementNo: string;
+  AccountType: RentalAccountTypeEnum;
+  JointHirers: JointHirer[] = [];
+  protected _Status: RentalStatusEnum;
+  protected _EscheatmentYN: string = 'N';
+  protected _CreatedById: string;
+  protected _CreatedAt: Date;
+  protected _UpdatedById: string;
+  protected _UpdatedAt: Date;
+  protected static _Repo = new RentalRepository();
+  protected static _AgreementRepo = new AgreementRepository();
+  protected static _JointHirerRepo = new JointHirerRepository();
+
+  get RentalId(): string {
+    return this.ObjectId;
+  }
+
+  set RentalId(value: string) {
+    this.ObjectId = value;
+  }
+
+  get Status(): RentalStatusEnum {
+    return this._Status;
+  }
+
+  get EscheatmentYN(): string {
+    return this._EscheatmentYN;
+  }
+
+  get CreatedById(): string {
+    return this._CreatedById;
+  }
+
+  get CreatedAt(): Date {
+    return this._CreatedAt;
+  }
+
+  get UpdatedById(): string {
+    return this._UpdatedById;
+  }
+
+  get UpdatedAt(): Date {
+    return this._UpdatedAt;
+  }
+
+  private setTerminated() {
+    this._Status = RentalStatusEnum.TERMINATED;
+  }
+
+  protected constructor(rentalAttr?: IRentalAttr) {
+    super();
+    if (rentalAttr) {
+      this.RentalId = rentalAttr.RentalId;
+      this.CustomerId = rentalAttr.CustomerId;
+      this.CustomerType = rentalAttr.CustomerType;
+      this.ItemId = rentalAttr.ItemId;
+      this.ItemType = rentalAttr.ItemType;
+      this.PriceId = rentalAttr.PriceId;
+      this.StartDateTime = rentalAttr.StartDateTime;
+      this.EndDateTime = rentalAttr.EndDateTime;
+      this.CancelRemarks = rentalAttr.CancelRemarks;
+      this.TerminateRemarks = rentalAttr.TerminateRemarks;
+      this.AgreementNo = rentalAttr.AgreementNo;
+      this.AccountType = rentalAttr.AccountType;
+      this._Status = rentalAttr.Status;
+      this._EscheatmentYN = rentalAttr.EscheatmentYN;
+      this._CreatedById = rentalAttr.CreatedById;
+      this._CreatedAt = rentalAttr.CreatedAt;
+      this._UpdatedById = rentalAttr.UpdatedById;
+      this._UpdatedAt = rentalAttr.UpdatedAt;
+    }
+  }
+
+  public static async init(dbTransaction?: any, rentalId?: string) {
+    try {
+      if (rentalId) {
+        const rental = await Rental._Repo.findByPk(rentalId, dbTransaction);
+        if (rental) {
+          return new Rental(rental);
+        } else {
+          throw new ClassError('Rental', 'RentalErrMsg00', 'Rental Not Found');
+        }
+      }
+      return new Rental();
+    } catch (error) {
+      throw new ClassError(
+        'Rental',
+        'RentalErrMsg00',
+        'Failed To Initialize Price',
+      );
+    }
+  }
+
+  /**
+   * Create a new Rental record.
+   * @param {RentalPrice} rentalPrice - The rental pricing information.
+   * @param {LoginUser} loginUser - The user initiating the creation.
+   * @param {any} [dbTransaction] - Optional database transaction for atomic operations.
+   * @throws {ClassError} Throws an error if:
+   *   1. loginUser does not have 'Rental - Create' privilege.
+   *   2. Rental item is not available at the current date.
+   * @returns {Promise<any>} A Promise resolving to the created rental record.
+   */
+  public async create(
+    rentalPrice: RentalPrice,
+    loginUser: LoginUser,
+    jointHirers?: JointHirer[],
+    dbTransaction?: any,
+  ): Promise<any> {
+    try {
+      /*Part 1: Check Privilege*/
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'Rental - Create',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg01',
+          "You do not have 'Rental - Create' privilege.",
+        );
+      }
+
+      /*Part 2: Make Sure Rental Item Available*/
+      const isItemAvailable = await Rental.isItemAvailable(
+        this.ItemId,
+        this.ItemType,
+        this.StartDateTime,
+        this.EndDateTime,
+        dbTransaction,
+      );
+
+      if (!isItemAvailable) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg02',
+          'Rental Item is not available at current date.',
+        );
+      }
+
+      // Part 3: Create Rental Agreement Record
+      // Call Rental._AgreementRepo create method by passing:
+      // AgreementNo: this.AgreementNo
+      // Status: "Not Generated"
+      // dbTransaction
+      await Rental._AgreementRepo.create(
+        {
+          AgreementNo: this.AgreementNo,
+          Status: 'Not Generated',
+        },
+        {
+          transaction: dbTransaction,
+        },
+      );
+
+      /*Part 4: Insert Rental & The Agreed Rental Price*/
+      await rentalPrice.create(loginUser, dbTransaction);
+
+      this.PriceId = rentalPrice.PriceId;
+
+      this.RentalId = this.createId();
+      // if (!this.Status) {
+      this._Status = RentalStatusEnum.PENDING_SIGNING;
+      // }
+      this._CreatedById = loginUser.ObjectId;
+      this._UpdatedById = loginUser.ObjectId;
+      this._CreatedAt = new Date();
+      this._UpdatedAt = new Date();
+
+      const data = {
+        RentalId: this.RentalId,
+        CustomerId: this.CustomerId,
+        CustomerType: this.CustomerType,
+        ItemId: this.ItemId,
+        ItemType: this.ItemType,
+        PriceId: this.PriceId,
+        StartDateTime: this.StartDateTime,
+        EndDateTime: this.EndDateTime,
+        CancelRemarks: this.CancelRemarks,
+        TerminateRemarks: this.TerminateRemarks,
+        AgreementNo: this.AgreementNo,
+        AccountType: this.AccountType,
+        Status: this.Status,
+        EscheatmentYN: this.EscheatmentYN,
+        CreatedById: this.CreatedById,
+        CreatedAt: this.CreatedAt,
+        UpdatedById: this.UpdatedById,
+        UpdatedAt: this.UpdatedAt,
+      };
+
+      await Rental._Repo.create(data, {
+        transaction: dbTransaction,
+      });
+
+      //For every data inside Param.jointHirers, update the rentalId and call jointHirer.create
+      if (jointHirers) {
+        for (let i = 0; i < jointHirers.length; i++) {
+          jointHirers[i].RentalId = this.RentalId;
+          await jointHirers[i].create(loginUser, dbTransaction);
+          this.JointHirers.push(jointHirers[i]);
+        }
+      }
+
+      /*Part 5: Record Create Rental Activity*/
+      const activity = new Activity();
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.ADD;
+      activity.Description = 'Add Rental';
+      activity.EntityType = 'Rental';
+      activity.EntityId = this.RentalId;
+      activity.EntityValueBefore = JSON.stringify({});
+      activity.EntityValueAfter = JSON.stringify(data);
+      await activity.create(loginUser.ObjectId, dbTransaction);
+
+      /*Part 6: Return Result*/
+      return this;
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  public static async isItemAvailable(
+    itemId: string,
+    itemType: string,
+    startDateTime: Date,
+    endDateTime: Date,
+    dbTransaction?: any,
+  ) {
+    try {
+      const item = await Rental._Repo.findOne({
+        where: {
+          ItemId: itemId,
+          ItemType: itemType,
+          StartDateTime: {
+            [Op.lte]: endDateTime,
+          },
+          EndDateTime: {
+            [Op.gte]: startDateTime,
+          },
+        },
+        transaction: dbTransaction,
+      });
+
+      if (item) {
+        return false;
+      } else {
+        return true;
+      }
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  public static async findAll(
+    loginUser: LoginUser,
+    dbTransaction: any,
+    page?: number,
+    row?: number,
+    search?: IRentalFindAllSearchAttr,
+  ) {
+    try {
+      const systemCode = await ApplicationConfig.getComponentConfigValue(
+        'system-code',
+      );
+
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'Rental - View',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg01',
+          "You do not have 'Rental - View' privilege.",
+        );
+      }
+
+      const queryObj: any = {};
+
+      let options: any = {
+        transaction: dbTransaction,
+        order: [['CreatedAt', 'DESC']],
+      };
+
+      if (page && row) {
+        options = {
+          ...options,
+          limit: row,
+          offset: row * (page - 1),
+        };
+      }
+
+      if (search) {
+        Object.entries(search).forEach(([key, value]) => {
+          if (key === 'StartDateTime') {
+            queryObj[key] = {
+              [Op.gte]: value,
+            };
+          } else if (key === 'EndDateTime') {
+            queryObj[key] = {
+              [Op.lte]: value,
+            };
+          } else if (key === 'CustomerId') {
+            queryObj[key] = {
+              [Op.substring]: value,
+            };
+
+            options.include = [
+              {
+                model: JointHirerModel,
+                required: false,
+                where: {
+                  CustomerId: {
+                    [Op.substring]: value,
+                  },
+                },
+              },
+            ];
+          } else {
+            queryObj[key] = {
+              [Op.substring]: value,
+            };
+          }
+        });
+        if (options?.include?.length > 1) {
+          options.include.push({
+            model: AgreementModel,
+            required: false,
+          });
+        } else {
+          options.include = [
+            {
+              model: AgreementModel,
+              required: false,
+            },
+          ];
+        }
+
+        options = {
+          ...options,
+          where: queryObj,
+        };
+      }
+
+      return await Rental._Repo.findAndCountAll(options);
+    } catch (err) {
+      throw err;
+    }
+  }
+
+  public static async checkActiveByItemId(
+    loginUser: LoginUser,
+    itemId: string,
+    itemType: string,
+    dbTransaction?: any,
+  ) {
+    try {
+      const systemCode = await ApplicationConfig.getComponentConfigValue(
+        'system-code',
+      );
+
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'Rental - View',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg01',
+          "You do not have 'Rental - View' privilege.",
+        );
+      }
+
+      const queryObj: any = {
+        ItemId: itemId,
+        ItemType: itemType,
+        Status: RentalStatusEnum.ACTIVE,
+      };
+
+      const options: any = {
+        transaction: dbTransaction,
+        where: queryObj,
+      };
+
+      const rental = await Rental._Repo.findOne(options);
+
+      if (rental) {
+        return true;
+      } else {
+        return false;
+      }
+    } catch (err) {
+      throw err;
+    }
+  }
+
+  /**
+   * Sets the StartDateTime property of the Rental class as custom setter.
+   * @param {Date} startDateTime - The start date and time of the rental.
+   * @throws {ClassError} Throws an error if:
+   *   1. startDateTime is a past date.
+   *   2. startDateTime is more than the EndDateTime.
+   * @returns {void}
+   */
+  setStartDateTime(startDateTime: Date): void {
+    const startDateTimeObject = new Date(startDateTime);
+    startDateTimeObject.setHours(0, 0, 0, 0);
+
+    /*Part 1: Make Sure Future Date Time*/
+    if (startDateTimeObject < new Date(new Date().setHours(0, 0, 0, 0))) {
+      throw new ClassError(
+        'Rental',
+        'RentalErrMsg02',
+        'StartDateTime cannot be a past datetime.',
+      );
+    }
+
+    /*Part 2: Make Sure Less Than End Date Time*/
+    if (this.EndDateTime && startDateTimeObject > this.EndDateTime) {
+      throw new ClassError(
+        'Rental',
+        'RentalErrMsg03',
+        'StartDateTime cannot be more than EndDateTime.',
+      );
+    }
+
+    /*Part 3: Set Status Whether Reserved or Active*/
+    if (startDateTimeObject > new Date(new Date().setHours(0, 0, 0, 0))) {
+      this._Status = RentalStatusEnum.RESERVED;
+    } else {
+      this._Status = RentalStatusEnum.ACTIVE;
+    }
+  }
+
+  public async periodEndProcess(
+    loginUser: LoginUser,
+    dbTransaction: any,
+    stockInventory: any,
+  ) {
+    try {
+      // Privilege Checking
+      const systemCode = await ApplicationConfig.getComponentConfigValue(
+        'system-code',
+      );
+
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'Rental – PeriodEndProcess',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg04',
+          "You do not have 'Rental - PeriodEndProcess' privilege.",
+        );
+      }
+
+      // Validate Existing Rental
+      if (this.AgreementNo === undefined || this.AgreementNo === null) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg05',
+          'Rental must be existing rental.',
+        );
+      }
+
+      // Validate Rental End Period
+      if (this.EndDateTime === new Date(new Date().setHours(0, 0, 0, 0))) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg06',
+          'Rental period is not ending today.',
+        );
+      }
+
+      // Mark Rental Item as Available
+      await stockInventory.setAvailable(loginUser, dbTransaction);
+
+      // Capture Record Info Before Changes
+      const entityValueBefore = {
+        RentalId: this.RentalId,
+        CustomerId: this.CustomerId,
+        CustomerType: this.CustomerType,
+        ItemId: this.ItemId,
+        ItemType: this.ItemType,
+        PriceId: this.PriceId,
+        StartDateTime: this.StartDateTime,
+        EndDateTime: this.EndDateTime,
+        CancelRemarks: this.CancelRemarks,
+        TerminateRemarks: this.TerminateRemarks,
+        AgreementNo: this.AgreementNo,
+        AccountType: this.AccountType,
+        Status: this.Status,
+        EscheatmentYN: this.EscheatmentYN,
+        CreatedById: this.CreatedById,
+        CreatedAt: this.CreatedAt,
+        UpdatedById: this.UpdatedById,
+        UpdatedAt: this.UpdatedAt,
+      };
+
+      // Mark Rental as Terminated and Capture Updater Info
+      this.setTerminated();
+      this._UpdatedById = loginUser.ObjectId;
+      this._UpdatedAt = new Date();
+
+      // Capture Record Info after Changes
+      const entityValueAfter = {
+        RentalId: this.RentalId,
+        CustomerId: this.CustomerId,
+        CustomerType: this.CustomerType,
+        ItemId: this.ItemId,
+        ItemType: this.ItemType,
+        PriceId: this.PriceId,
+        StartDateTime: this.StartDateTime,
+        EndDateTime: this.EndDateTime,
+        CancelRemarks: this.CancelRemarks,
+        TerminateRemarks: this.TerminateRemarks,
+        AgreementNo: this.AgreementNo,
+        AccountType: this.AccountType,
+        Status: this.Status,
+        EscheatmentYN: this.EscheatmentYN,
+        CreatedById: this.CreatedById,
+        CreatedAt: this.CreatedAt,
+        UpdatedById: this.UpdatedById,
+        UpdatedAt: this.UpdatedAt,
+      };
+
+      // Record the Update Activity
+      const activity = new Activity();
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.UPDATE;
+      activity.Description = 'Set Rental as Terminated';
+      activity.EntityType = 'Rental';
+      activity.EntityId = this.RentalId;
+      activity.EntityValueBefore = JSON.stringify(entityValueBefore);
+      activity.EntityValueAfter = JSON.stringify(entityValueAfter);
+      await activity.create(loginUser.ObjectId, dbTransaction);
+
+      return this;
+    } catch (err) {
+      throw err;
+    }
+  }
+
+  async getCustomerActiveRentals(
+    loginUser: LoginUser,
+    dbTransaction: any,
+    CustomerId: string,
+  ): Promise<IRentalAttr[]> {
+    try {
+      // Part 1: Privilege Checking
+      // Call loginUser.checkPrivileges() by passing:
+      // SystemCode: <get_from_app_config>
+      // PrivilegeCode: "RENTAL_VIEW"
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = loginUser.checkPrivileges(systemCode, 'RENTAL_VIEW');
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg01',
+          "You do not have 'Rental - View' privilege.",
+        );
+      }
+
+      // Part 2: Retrieve Rentals and Returns
+      // Call Rental._Repo findAll method by passing:
+      // where:
+      // Status: "Active"
+      // [Op.OR]:
+      // CustomerId: Params.CustomerId
+      // '$JointHirers.CustomerId$': Params.CustomerId
+      // include:
+      // model: JointHirerModel
+      // attributes: []
+      const query = `
+      SELECT 
+          r.*
+      FROM 
+          rental_Rental r
+      LEFT JOIN 
+          rental_JointHirer jh ON r.RentalId = jh.RentalId
+      WHERE 
+          r.Status = 'Active'
+          AND (
+              r.CustomerId = '${CustomerId}' 
+              OR jh.CustomerId = '${CustomerId}'
+          )
+      GROUP BY
+          r.RentalId
+      `;
+      const db = rentalDb.getConnection();
+      const result = await db.query(query, {
+        type: QueryTypes.SELECT,
+        transaction: dbTransaction,
+        model: RentalModel,
+        mapToModel: true,
+      });
+
+      // Format the returned records
+      const records: IRentalAttr[] = result.map((record: RentalModel) => {
+        return {
+          RentalId: record.RentalId,
+          CustomerId: record.CustomerId,
+          CustomerType: record.CustomerType,
+          ItemId: record.ItemId,
+          ItemType: record.ItemType,
+          PriceId: record.PriceId,
+          StartDateTime: record.StartDateTime,
+          EndDateTime: record.EndDateTime,
+          CancelRemarks: record.CancelRemarks,
+          TerminateRemarks: record.TerminateRemarks,
+          AgreementNo: record.AgreementNo,
+          AccountType: record.AccountType,
+          Status: record.Status,
+          EscheatmentYN: record.EscheatmentYN,
+          CreatedById: record.CreatedById,
+          CreatedAt: record.CreatedAt,
+          UpdatedById: record.UpdatedById,
+          UpdatedAt: record.UpdatedAt,
+        };
+      });
+      // Return the returned records.
+      return records;
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  async getCustomerIds(loginUser: LoginUser, dbTransaction: any) {
+    try {
+      // Part 1: Privilege Checking
+      // Call loginUser.checkPrivileges() by passing:
+      // SystemCode: <get_from_app_config>
+      // PrivilegeCode: "RENTAL_VIEW"
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = loginUser.checkPrivileges(systemCode, 'RENTAL_VIEW');
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg01',
+          "You do not have 'Rental - View' privilege.",
+        );
+      }
+
+      // Part 2: Validation
+      // Make sure this.RentalId exists, if not throw new ClassError by passing
+      if (!this.RentalId) {
+        throw new ClassError('Rental', 'RentalErrMsg01', 'RentalId is missing');
+      }
+
+      //Part 3: Retrieve Listing and Returns
+      // 3.1  Call Rental._JointHirerRepo findAll method by passing:
+      //      where:
+      //          RentalId: this.RentalId
+      //      dbTransaction
+      const options: any = {
+        where: {
+          RentalId: this.RentalId,
+        },
+        transaction: dbTransaction,
+      };
+
+      const joinHirers = await Rental._JointHirerRepo.findAll(options);
+
+      // 3.2 Create a new array variable and set its value to joint hirer and Rental.CustomerId
+      // array translated to only CustomerId. Then, append this.CustomerId to the array.
+      const customerIds: string[] = [this.CustomerId];
+      for (let i = 0; i < joinHirers.length; i++) {
+        const jointHirer = joinHirers[i];
+        customerIds.push(jointHirer.CustomerId);
+      }
+
+      // 3.3 Return the array.
+      return customerIds;
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  async signAgreement(loginUser: LoginUser, dbTransaction: any) {
+    try {
+      // Part 1: Privilege Checking
+      // Call loginUser.checkPrivileges() by passing:
+      // SystemCode: <get_from_app_config>
+      // PrivilegeCode: "RENTAL_SIGN"
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = loginUser.checkPrivileges(systemCode, 'RENTAL_SIGN');
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg01',
+          "You do not have 'RENTAL_SIGN' privilege.",
+        );
+      }
+
+      // Part 2: Validation
+      // Make sure this.Status is "Pending Signing" and agreementStatus is "Generated", if not throw new ClassError
+      const agreement = await Agreement.init(this.AgreementNo, dbTransaction);
+      if (
+        this.Status !== RentalStatusEnum.PENDING_SIGNING &&
+        agreement.Status !== AggrementStatusEnum.GENERATED
+      ) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg01',
+          'Rental is not ready to be signed yet.',
+        );
+      }
+
+      //Part 3: Update Agreement Status
+      // 3.1  Set EntityValueBefore to current agreement instance.
+      const entityValueAgreementBefore = {
+        AgreementNo: agreement.AgreementNo,
+        Status: agreement.Status,
+        DateSigned: agreement.DateSigned,
+      };
+
+      // 3.2  Set below agreement attributes:
+      // DateSigned: current date & time
+      // Status: "Signed"
+      const payload = {
+        DateSigned: new Date(),
+        Status: AggrementStatusEnum.SIGNED,
+      };
+
+      // 3.3  Call Rental._AgreementRepo update()
+      await Rental._AgreementRepo.update(payload, {
+        where: {
+          AgreementNo: this.AgreementNo,
+        },
+        transaction: dbTransaction,
+      });
+
+      const entityValueAgreementAfter = {
+        entityValueAgreementBefore,
+        ...payload,
+      };
+
+      // Part 4: Record Update Agreement Activity
+      const activity = new Activity();
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.UPDATE;
+      activity.Description = 'Update agreement';
+      activity.EntityType = 'RentalAgreement';
+      activity.EntityId = this.AgreementNo;
+      activity.EntityValueBefore = JSON.stringify(entityValueAgreementBefore);
+      activity.EntityValueAfter = JSON.stringify(entityValueAgreementAfter);
+      await activity.create(loginUser.ObjectId, dbTransaction);
+
+      // Part 5: Update Rental Status
+      // 5.1  Set EntityValueBefore to current rental instance.
+      const entityValueRentalBefore = {
+        RentalId: this.RentalId,
+        CustomerId: this.CustomerId,
+        CustomerType: this.CustomerType,
+        ItemId: this.ItemId,
+        ItemType: this.ItemType,
+        PriceId: this.PriceId,
+        StartDateTime: this.StartDateTime,
+        EndDateTime: this.EndDateTime,
+        CancelRemarks: this.CancelRemarks,
+        TerminateRemarks: this.TerminateRemarks,
+        AgreementNo: this.AgreementNo,
+        AccountType: this.AccountType,
+        Status: this.Status,
+        EscheatmentYN: this.EscheatmentYN,
+        CreatedById: this.CreatedById,
+        CreatedAt: this.CreatedAt,
+        UpdatedById: this.UpdatedById,
+        UpdatedAt: this.UpdatedAt,
+      };
+      // 5.2:  Set below rental attributes:
+      // Status: "Pending Key Collection"
+      // UpdatedById: loginUser.ObjectId
+      // UpdatedAt: current date & time
+
+      const payloadRental = {
+        Status: RentalStatusEnum.PENDING_KEY_COLLECTION,
+        UpdatedById: loginUser.ObjectId,
+        UpdatedAt: new Date(),
+      };
+
+      // 5.3:  Call Rental._Repo update() method by passing:
+      // populate rental instance attributes
+      // dbTransaction
+      await Rental._Repo.update(payloadRental, {
+        where: {
+          RentalId: this.RentalId,
+        },
+        transaction: dbTransaction,
+      });
+
+      const entityValueRentalAfter = {
+        entityValueRentalBefore,
+        ...payloadRental,
+      };
+
+      // Part 6: Record Update Agreement Activity
+      const rentalActivity = new Activity();
+      rentalActivity.ActivityId = activity.createId();
+      rentalActivity.Action = ActionEnum.UPDATE;
+      rentalActivity.Description = 'Sign rental agreement';
+      rentalActivity.EntityType = 'Rental';
+      rentalActivity.EntityId = this.RentalId;
+      rentalActivity.EntityValueBefore = JSON.stringify(
+        entityValueRentalBefore,
+      );
+      rentalActivity.EntityValueAfter = JSON.stringify(entityValueRentalAfter);
+      await rentalActivity.create(loginUser.ObjectId, dbTransaction);
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  async generateAgreement(
+    loginUser: LoginUser,
+    dbTransaction: any,
+    MediaId: string,
+  ) {
+    //This method will generate a new rental agreement.
+    try {
+      // Part 1: Privilege Checking
+      // Call loginUser.checkPrivileges() by passing:
+      // SystemCode: "<get_from_app_config>"
+      // PrivilegeCode: "RENTAL_AGREEMENT_CREATE"
+
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = loginUser.checkPrivileges(
+        systemCode,
+        'RENTAL_AGREEMENT_CREATE',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg01',
+          "You do not have 'RENTAL_AGREEMENT_CREATE' privilege.",
+        );
+      }
+
+      // Part 2: Validation
+      // Instantiate existing RentalAgreement by passing:
+      // dbTransaction
+      // AgreementNo: this.AgreementNo
+      // Make sure Params.MediaId exists, if not throw new ClassError by passing:
+      // Classname: "Rental"
+      // MessageCode: "RentalErrMsg0X"
+      // Message: "MediaId is required."
+      const agreement = await Agreement.init(this.AgreementNo, dbTransaction);
+      if (!MediaId) {
+        throw new ClassError(
+          'Rental',
+          'RentalErrMsg0X',
+          'MediaId is required.',
+        );
+      }
+
+      // Part 3: Update Agreement Record
+      // Set EntityValueBefore to the agreement instance.
+      // Set below agreement attributes:
+      // Status: "Generated"
+      // MediaId: Params.MediaId
+
+      const EntityValueBefore = agreement;
+      agreement.Status = AggrementStatusEnum.GENERATED;
+      agreement.MediaId = MediaId;
+
+      // Call Rental._AgreementRepo update method by passing:
+      // Status: agreement.Status
+      // MediaId: agreement.MediaId
+      // dbTransaction
+
+      await Rental._AgreementRepo.update(
+        {
+          Status: agreement.Status,
+          MediaId: agreement.MediaId,
+        },
+        {
+          where: {
+            AgreementNo: this.AgreementNo,
+          },
+          transaction: dbTransaction,
+        },
+      );
+
+      // Part 4: Record Update Agreement Activity
+      // Initialise EntityValueAfter variable and set to agreement instance
+      const EntityValueAfter = agreement;
+      // Instantiate new activity from Activity class, call createId() method, then set:
+      const activity = new Activity();
+      // Action: ActionEnum.UPDATE
+      // Description: "Generate agreement."
+      // EntityType: "RentalAgreement"
+      // EntityId: this.AgreementNo
+      // EntityValueBefore: EntityValueBefore
+      // EntityValueAfter: EntityValueAfter
+      activity.ActivityId = activity.createId();
+      activity.Action = ActionEnum.UPDATE;
+      activity.Description = 'Generate agreement.';
+      activity.EntityType = 'RentalAgreement';
+      activity.EntityId = this.AgreementNo;
+      activity.EntityValueBefore = JSON.stringify(EntityValueBefore);
+      activity.EntityValueAfter = JSON.stringify(EntityValueAfter);
+
+      // Call new activity create method by passing:
+      // dbTransaction
+      // userId: loginUser.ObjectId
+      await activity.create(loginUser.ObjectId, dbTransaction);
+    } catch (error) {
+      throw error;
+    }
+  }
+}