Merge pull request #763 from companieshouse/feature/lp-595-general-partner

lp-595 : LimitedPartnershipService - patchGeneralPartner

Author: lduranteau

src/services/limited-partnerships/service.ts

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

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

@@ -122,6 +122,7 @@ export const LIMITED_PARTNERSHIP_INCORPORATION_OBJECT_MOCK_WITH_SUB: LimitedPart
 
 export const TRANSACTION_ID = "12345";
 export const SUBMISSION_ID = "09876";
+export const GENERAL_PARTNER_ID = "00112233";
 export const LIMITED_PARTNERSHIP_ID = "00112233";
 export const FILE_RESOURCE_ID = "a1b2c3";
 export const UNAUTHORISED = "Unauthorised";
@@ -173,3 +174,9 @@ export const mockGetGeneralPartnerResponse = {
     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 } },
+    401: { status: 401, body: { error: UNAUTHORISED } }
+};

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

@@ -577,4 +577,54 @@ describe("LimitedPartnershipsService", () => {
             expect(response.resource.error).to.equal(mockValues.NOT_FOUND);
         });
     })
+
+    describe("patchGeneralPartner", () => {
+        it("should return 200 patchGeneralPartner method", async () => {
+            const mockRequest = sinon
+                .stub(mockValues.requestClient, "httpPatch")
+                .resolves(mockValues.mockPatchGeneralPartnerResponse[200]);
+            const service = new LimitedPartnershipsService(
+                mockValues.requestClient
+            );
+            const response = (await service.patchGeneralPartner(
+                mockValues.TRANSACTION_ID,
+                mockValues.GENERAL_PARTNER_ID,
+                mockValues.GENERAL_PARTNER_OBJECT_MOCK.data
+            )) as Resource<void>;
+
+            expect(mockRequest).to.have.been.calledOnce;
+            expect(
+                mockRequest.calledWith(
+                    "/transactions/12345/limited-partnership/general-partner/00112233",
+                    mockValues.GENERAL_PARTNER_OBJECT_MOCK.data
+                )
+            ).to.be.true;
+
+            expect(response.httpStatusCode).to.equal(200);
+        });
+
+        it("should return error 400 (Bad Request)", async () => {
+            const mockRequest = sinon
+                .stub(mockValues.requestClient, "httpPatch")
+                .resolves(mockValues.mockPatchGeneralPartnerResponse[400]);
+            const service = new LimitedPartnershipsService(
+                mockValues.requestClient
+            );
+            const response = (await service.patchGeneralPartner(
+                mockValues.TRANSACTION_ID,
+                mockValues.GENERAL_PARTNER_ID,
+                {}
+            )) as Resource<LimitedPartnershipResourceCreated>;
+
+            expect(mockRequest).to.have.been.calledOnce;
+            expect(
+                mockRequest.calledWith(
+                    "/transactions/12345/limited-partnership/general-partner/00112233",
+                    {}
+                )
+            ).to.be.true;
+
+            expect(response.httpStatusCode).to.equal(400);
+        });
+    })
 });