fix(premium-schedule): added 0 and 4 as acceptable inputs (#440)

## Introduction ✏️ Premium schedule endpoint did not allow `premiumFrequencyId` with valid inputs. ## Resolution ✔️ * Updated `min` and `max` decorators. * Updated documentation. * Updated API test cases to cater all the `premiumFrequencyId` values (0 - 4) ## Miscellaneous ➕ * Dependencies update Co-authored-by: Abhi Markan <abhi.markan@ukexportfinance.gov.uk>
UK-Export-Finance · Sep 1, 2023 · 270b405 · 270b405
1 parent d62f78c
commit 270b405
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 6 deletions.
diff --git a/src/modules/premium-schedules/dto/create-premium-schedule.dto.ts b/src/modules/premium-schedules/dto/create-premium-schedule.dto.ts
@@ -30,11 +30,11 @@ export class CreatePremiumScheduleDto {
 
   @IsNumber()
   @IsNotEmpty()
-  @Min(1)
-  @Max(3)
+  @Min(0)
+  @Max(4)
   @ApiProperty({
     example: 1,
-    description: 'Payment frequency. It can be: 1 -> Monthly, 2 -> Quarterly, 3-> Semi-annually or 4 -> Annually',
+    description: 'Payment frequency. It can be: 0 -> Null (At maturity), 1 -> Monthly, 2 -> Quarterly, 3-> Semi-annually or 4 -> Annually',
   })
   readonly premiumFrequencyId: number;
 

diff --git a/test/docs/__snapshots__/get-docs-yaml.api-test.ts.snap b/test/docs/__snapshots__/get-docs-yaml.api-test.ts.snap
@@ -850,7 +850,7 @@ components:
           type: number
           example: 1
           description: >-
-            Payment frequency. It can be: 1 -> Monthly, 2 -> Quarterly, 3->
+            Payment frequency. It can be: 0 -> Null (At maturity), 1 -> Monthly, 2 -> Quarterly, 3->
             Semi-annually or 4 -> Annually
         guaranteeCommencementDate:
           format: date-time

diff --git a/test/premium-schedules/premium-schedules.api-test.ts b/test/premium-schedules/premium-schedules.api-test.ts
@@ -43,6 +43,30 @@ describe('Premium schedules', () => {
   /**
    * To get existing premium schedules we need to generate them first.
    */
+  it('POST /premium/schedule as BSS with `At maturity` fee frequency', async () => {
+    const createSchedules = [
+      {
+        facilityURN: chance.natural({ min: 10000000, max: 99999999 }),
+        productGroup: PRODUCTS.BS,
+        premiumTypeId: 1,
+        premiumFrequencyId: 0,
+        guaranteeCommencementDate: '2023-01-19',
+        guaranteeExpiryDate: '2023-02-19',
+        guaranteePercentage: 80,
+        guaranteeFeePercentage: 1.35,
+        dayBasis: '360',
+        exposurePeriod: 1,
+        cumulativeAmount: null,
+        maximumLiability: 40000,
+      },
+    ];
+    const postResponse = await api.post(createSchedules).to('/premium/schedule');
+
+    expect(postResponse.status).toBe(201);
+    expect(postResponse.body).toHaveLength(1);
+    expect(postResponse.body).toEqual(expect.arrayContaining([expect.objectContaining(premiumScheduleSchema)]));
+  });
+
   it('POST /premium/schedule and then GET /premium/segments/{facilityId}', async () => {
     const createSchedules = [
       {
@@ -81,7 +105,7 @@ describe('Premium schedules', () => {
         facilityURN: chance.natural({ min: 10000000, max: 99999999 }),
         productGroup: PRODUCTS.BS,
         premiumTypeId: 1,
-        premiumFrequencyId: 1,
+        premiumFrequencyId: 2,
         guaranteeCommencementDate: '2023-01-19',
         guaranteeExpiryDate: '2023-02-19',
         guaranteePercentage: 80,
@@ -105,7 +129,31 @@ describe('Premium schedules', () => {
         facilityURN: chance.natural({ min: 10000000, max: 99999999 }),
         productGroup: PRODUCTS.BS,
         premiumTypeId: 1,
-        premiumFrequencyId: 1,
+        premiumFrequencyId: 3,
+        guaranteeCommencementDate: '2023-01-19',
+        guaranteeExpiryDate: '2023-02-19',
+        guaranteePercentage: 80,
+        guaranteeFeePercentage: 1.35,
+        dayBasis: '360',
+        exposurePeriod: 1,
+        cumulativeAmount: null,
+        maximumLiability: 40000,
+      },
+    ];
+    const postResponse = await api.post(createSchedules).to('/premium/schedule');
+
+    expect(postResponse.status).toBe(201);
+    expect(postResponse.body).toHaveLength(1);
+    expect(postResponse.body).toEqual(expect.arrayContaining([expect.objectContaining(premiumScheduleSchema)]));
+  });
+
+  it('POST /premium/schedule as EWCS with `Annually` fee frequency', async () => {
+    const createSchedules = [
+      {
+        facilityURN: chance.natural({ min: 10000000, max: 99999999 }),
+        productGroup: PRODUCTS.BS,
+        premiumTypeId: 1,
+        premiumFrequencyId: 4,
         guaranteeCommencementDate: '2023-01-19',
         guaranteeExpiryDate: '2023-02-19',
         guaranteePercentage: 80,