Merge pull request #748 from companieshouse/feature/lp-234-term-page

lp-234 : add term to LimitedPartnership

Author: lduranteau

src/services/limited-partnerships/types.ts

@@ -13,15 +13,16 @@ export interface LimitedPartnership {
         email?: string;
         jurisdiction?: Jurisdiction;
         registered_office_address?: Address;
-    }
+        term?: Term;
+    };
 }
 
 /**
  * The data structure returned by the API when a new Limited Partnership resource has
  * successfully been created.
  */
 export interface LimitedPartnershipResourceCreated {
-    id: string
+    id: string;
 }
 
 export enum NameEndingType {
@@ -30,30 +31,30 @@ export enum NameEndingType {
     L_DOT_P_DOT = "L.P.",
     PARTNERIAETH_CYFYNGEDIG = "Partneriaeth Cyfyngedig",
     PC = "PC",
-    P_DOT_C_DOT = "P.C."
+    P_DOT_C_DOT = "P.C.",
 }
 
 export enum PartnershipType {
     LP = "LP",
     PFLP = "PFLP",
     SLP = "SLP",
-    SPFLP = "SPFLP"
+    SPFLP = "SPFLP",
 }
 
 export enum Jurisdiction {
     ENGLAND_AND_WALES = "England and Wales",
     NORTHERN_IRELAND = "Northern Ireland",
-    SCOTLAND = "Scotland"
+    SCOTLAND = "Scotland",
 }
 
 export interface LimitedPartnershipIncorporation {
-    etag: string,
-    kind: string,
+    etag: string;
+    kind: string;
     sub_resources?: {
-        general_partners: any[],
-        limited_partners: any[],
-        partnership: LimitedPartnership
-    }
+        general_partners: any[];
+        limited_partners: any[];
+        partnership: LimitedPartnership;
+    };
 }
 
 export type Address = {
@@ -64,4 +65,10 @@ export type Address = {
     postal_code: string;
     premises: string;
     region?: string;
-  };
+};
+
+export enum Term {
+    BY_AGREEMENT = "BY_AGREEMENT",
+    UNTIL_DISSOLUTION = "UNTIL_DISSOLUTION",
+    NONE = "NONE",
+}

test/services/limited-partnerships/limited.partnerships.mock.ts

@@ -5,7 +5,8 @@ import {
     LimitedPartnershipIncorporation,
     NameEndingType,
     PartnershipType,
-    Jurisdiction
+    Jurisdiction,
+    Term
 } from "../../../src/services/limited-partnerships";
 
 export const requestClient = new RequestClient({
@@ -28,7 +29,8 @@ export const LIMITED_PARTNERSHIP_OBJECT_MOCK: LimitedPartnership = {
             region: "Some Region",
             country: "Some Country",
             postal_code: "SC12 1WE"
-        }
+        },
+        term: Term.BY_AGREEMENT
     }
 };
 

test/services/limited-partnerships/limited.partnerships.spec.ts

@@ -8,8 +8,7 @@ import {
     LimitedPartnershipResourceCreated,
     LimitedPartnershipsService,
     LimitedPartnershipIncorporation,
-    NameEndingType,
-    Jurisdiction
+    NameEndingType
 } from "../../../src/services/limited-partnerships";
 import Resource from "../../../src/services/resource";
 
@@ -39,9 +38,7 @@ describe("LimitedPartnershipsService", () => {
                     data: {
                         partnership_name: mockValues.LIMITED_PARTNERSHIP_OBJECT_MOCK.data?.partnership_name,
                         name_ending: mockValues.LIMITED_PARTNERSHIP_OBJECT_MOCK.data?.name_ending,
-                        partnership_type: mockValues.LIMITED_PARTNERSHIP_OBJECT_MOCK.data?.partnership_type,
-                        jurisdiction: mockValues.LIMITED_PARTNERSHIP_OBJECT_MOCK.data?.jurisdiction,
-                        registered_office_address: mockValues.LIMITED_PARTNERSHIP_OBJECT_MOCK.data?.registered_office_address
+                        partnership_type: mockValues.LIMITED_PARTNERSHIP_OBJECT_MOCK.data?.partnership_type
                     }
                 }
             )) as Resource<LimitedPartnershipResourceCreated>;
@@ -54,17 +51,7 @@ describe("LimitedPartnershipsService", () => {
                         data: {
                             partnership_name: "Legalised Asset Stashing",
                             name_ending: "Limited Partnership",
-                            partnership_type: "LP",
-                            jurisdiction: Jurisdiction.ENGLAND_AND_WALES,
-                            registered_office_address: {
-                                premises: "22",
-                                address_line_1: "Some Street",
-                                address_line_2: "Some Line 2",
-                                locality: "Some Locality",
-                                region: "Some Region",
-                                country: "Some Country",
-                                postal_code: "SC12 1WE"
-                            }
+                            partnership_type: "LP"
                         }
                     }
                 )
@@ -140,18 +127,14 @@ describe("LimitedPartnershipsService", () => {
             const response = await service.patchLimitedPartnership(
                 mockValues.TRANSACTION_ID,
                 mockValues.SUBMISSION_ID,
-                {
-                    email: "[email protected]"
-                }
+                mockValues.LIMITED_PARTNERSHIP_OBJECT_MOCK.data
             );
 
             expect(mockRequest).to.have.been.calledOnce;
             expect(
                 mockRequest.calledWith(
                     "/transactions/12345/limited-partnership/partnership/09876",
-                    {
-                        email: "[email protected]"
-                    }
+                    mockValues.LIMITED_PARTNERSHIP_OBJECT_MOCK.data
                 )
             ).to.be.true;
             expect(response.httpStatusCode).to.equal(200);