Merge pull request #769 from companieshouse/feature/lp-237-review-general-partner

lp-237 : limited-partnership service

Author: lduranteau

src/services/limited-partnerships/service.ts

@@ -116,6 +116,18 @@ export default class LimitedPartnershipsService {
         };
     }
 
+    public async getGeneralPartners (
+        transactionId: string
+    ): Promise<Resource<GeneralPartner[]> | ApiErrorResponse> {
+        const URL = `/transactions/${transactionId}/limited-partnership/general-partners`;
+        const response: HttpResponse = await this.client.httpGet(URL, { transactionId });
+
+        return {
+            httpStatusCode: response.status,
+            resource: response.body
+        };
+    }
+
     public async patchGeneralPartner (
         transactionId: string,
         generalPartnerId: string,

src/services/limited-partnerships/types.ts

@@ -30,6 +30,7 @@ export interface LimitedPartnership {
 }
 
 export interface GeneralPartner {
+    id?: string;
     data?: {
         date_effective_from?: string;
         date_of_birth?: string;

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

@@ -48,6 +48,7 @@ export const LIMITED_PARTNERSHIP_OBJECT_MOCK: LimitedPartnership = {
 };
 
 export const GENERAL_PARTNER_OBJECT_MOCK: GeneralPartner = {
+    id: "123456",
     data: {
         date_effective_from: "2005-02-04",
         date_of_birth: "2000-05-01",
@@ -95,7 +96,7 @@ export const GENERAL_PARTNER_OBJECT_MOCK: GeneralPartner = {
             postal_code: "SC15 1N2"
         }
     }
-}
+};
 
 // This structure is used when POSTing Incorporation data
 export const INCORPORATION_OBJECT_MOCK: Incorporation = {
@@ -106,20 +107,22 @@ export const INCORPORATION_OBJECT_MOCK: Incorporation = {
 
 // These structures represent responses from GETing Incorporation data:
 
-export const LIMITED_PARTNERSHIP_INCORPORATION_OBJECT_MOCK: LimitedPartnershipIncorporation = {
-    etag: "",
-    kind: ""
-};
+export const LIMITED_PARTNERSHIP_INCORPORATION_OBJECT_MOCK: LimitedPartnershipIncorporation =
+    {
+        etag: "",
+        kind: ""
+    };
 
-export const LIMITED_PARTNERSHIP_INCORPORATION_OBJECT_MOCK_WITH_SUB: LimitedPartnershipIncorporation = {
-    etag: "",
-    kind: "",
-    sub_resources: {
-        general_partners: [],
-        limited_partners: [],
-        partnership: LIMITED_PARTNERSHIP_OBJECT_MOCK
-    }
-};
+export const LIMITED_PARTNERSHIP_INCORPORATION_OBJECT_MOCK_WITH_SUB: LimitedPartnershipIncorporation =
+    {
+        etag: "",
+        kind: "",
+        sub_resources: {
+            general_partners: [],
+            limited_partners: [],
+            partnership: LIMITED_PARTNERSHIP_OBJECT_MOCK
+        }
+    };
 
 export const TRANSACTION_ID = "12345";
 export const SUBMISSION_ID = "09876";
@@ -161,8 +164,11 @@ export const mockGetLimitedPartnershipIncorporationResponse = {
 };
 
 export const mockGetLimitedPartnershipIncorporationResponseWithSub = {
-    200: { status: 200, body: LIMITED_PARTNERSHIP_INCORPORATION_OBJECT_MOCK_WITH_SUB }
-}
+    200: {
+        status: 200,
+        body: LIMITED_PARTNERSHIP_INCORPORATION_OBJECT_MOCK_WITH_SUB
+    }
+};
 
 export const mockPostGeneralPartnerResponse = {
     201: { status: 201, body: mockLimitedPartnershipCreatedResource },
@@ -176,6 +182,12 @@ export const mockGetGeneralPartnerResponse = {
     401: { status: 401, body: { error: UNAUTHORISED } }
 };
 
+export const mockGetGeneralPartnersResponse = {
+    200: { status: 200, body: [GENERAL_PARTNER_OBJECT_MOCK] },
+    404: { status: 404, body: { error: NOT_FOUND } },
+    401: { status: 401, body: { error: UNAUTHORISED } }
+};
+
 export const mockPatchGeneralPartnerResponse = {
     200: { status: 200 },
     400: { status: 400, body: { error: BAD_REQUEST } },

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

@@ -578,6 +578,31 @@ describe("LimitedPartnershipsService", () => {
         });
     })
 
+    describe("getGeneralPartners", () => {
+        it("should return a status 200 and the generalPartner object", async () => {
+            const mockRequest = sinon
+                .stub(mockValues.requestClient, "httpGet")
+                .resolves(mockValues.mockGetGeneralPartnersResponse[200]);
+
+            const service = new LimitedPartnershipsService(
+                mockValues.requestClient
+            );
+
+            const response = await service.getGeneralPartners(
+                mockValues.TRANSACTION_ID
+            ) as Resource<GeneralPartner>;
+
+            expect(mockRequest).to.have.been.calledOnce;
+            expect(
+                mockRequest.calledWith(
+                    "/transactions/12345/limited-partnership/general-partners"
+                )
+            ).to.be.true;
+            expect(response.httpStatusCode).to.equal(200);
+            expect(response?.resource).to.eql([mockValues.GENERAL_PARTNER_OBJECT_MOCK]);
+        });
+    })
+
     describe("patchGeneralPartner", () => {
         it("should return 200 patchGeneralPartner method", async () => {
             const mockRequest = sinon