Merge pull request #773 from companieshouse/feature/lp-686-remove-general-partner

lp-686 : limited partnerships service - delete general partner

Author: lduranteau

src/services/limited-partnerships/service.ts

@@ -141,4 +141,17 @@ export default class LimitedPartnershipsService {
             resource: { ...response.body }
         };
     }
+
+    public async deleteGeneralPartner (
+        transactionId: string,
+        generalPartnerId: string
+    ): Promise<Resource<void> | ApiErrorResponse> {
+        const URL = `/transactions/${transactionId}/limited-partnership/general-partner/${generalPartnerId}`;
+        const response: HttpResponse = await this.client.httpDelete(URL);
+
+        return {
+            httpStatusCode: response.status,
+            resource: { ...response.body }
+        };
+    }
 }

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

@@ -193,3 +193,9 @@ export const mockPatchGeneralPartnerResponse = {
     400: { status: 400, body: { error: BAD_REQUEST } },
     401: { status: 401, body: { error: UNAUTHORISED } }
 };
+
+export const mockDeleteGeneralPartnerResponse = {
+    204: { status: 204 },
+    404: { status: 404, body: { error: NOT_FOUND } },
+    401: { status: 401, body: { error: UNAUTHORISED } }
+};

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

@@ -652,4 +652,28 @@ describe("LimitedPartnershipsService", () => {
             expect(response.httpStatusCode).to.equal(400);
         });
     })
+
+    describe("deleteGeneralPartner", () => {
+        it("should return 204 patchGeneralPartner method", async () => {
+            const mockRequest = sinon
+                .stub(mockValues.requestClient, "httpDelete")
+                .resolves(mockValues.mockDeleteGeneralPartnerResponse[204]);
+            const service = new LimitedPartnershipsService(
+                mockValues.requestClient
+            );
+            const response = (await service.deleteGeneralPartner(
+                mockValues.TRANSACTION_ID,
+                mockValues.GENERAL_PARTNER_ID
+            )) as Resource<void>;
+
+            expect(mockRequest).to.have.been.calledOnce;
+            expect(
+                mockRequest.calledWith(
+                    "/transactions/12345/limited-partnership/general-partner/00112233"
+                )
+            ).to.be.true;
+
+            expect(response.httpStatusCode).to.equal(204);
+        });
+    })
 });