Merge pull request #214 from companieshouse/ncs-578-add-psc-statements-to-sdk

Add psc statements service to sdk

Author: ICoxCH

src/client.ts

@@ -13,6 +13,7 @@ import EnhancedSearchService from "./services/search/enhanced-search/service";
 import PSCDiscrepancyService from "./services/psc-discrepancies/service";
 import PSCDiscrepanciesReportService from "./services/psc-discrepancies-report/service";
 import TransactionService from "./services/transaction/service";
+import CompanyPscStatementsService from "./services/company-psc-statements/service";
 
 /**
  * ApiClient is the class that all service objects hang off.
@@ -22,7 +23,8 @@ export default class ApiClient {
   public readonly companyOfficers: CompanyOfficersService;
   public readonly companyFilingHistory: CompanyFilingHistoryService;
   public readonly companyProfile: CompanyProfileService;
-  public readonly companyPsc : CompanyPscService ;
+  public readonly companyPsc: CompanyPscService;
+  public readonly companyPscStatements: CompanyPscStatementsService;
   public readonly certificate: CertificateService;
   public readonly certifiedCopies: CertifiedCopiesService;
   public readonly basket: BasketService;
@@ -44,6 +46,7 @@ export default class ApiClient {
       this.companyFilingHistory = new CompanyFilingHistoryService(apiClient);
       this.companyProfile = new CompanyProfileService(apiClient);
       this.companyPsc = new CompanyPscService(apiClient);
+      this.companyPscStatements = new CompanyPscStatementsService(apiClient);
       this.certificate = new CertificateService(apiClient);
       this.certifiedCopies = new CertifiedCopiesService(apiClient);
       this.basket = new BasketService(apiClient);

src/services/company-psc-statements/index.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./service";

src/services/company-psc-statements/service.ts

@@ -0,0 +1,51 @@
+import { IHttpClient } from "../../http";
+import Resource, { ApiErrorResponse } from "../resource";
+import Mapping from "../../mapping/mapping";
+import {
+    CompanyPersonsWithSignificantControlStatements,
+    CompanyPersonsWithSignificantControlStatementsResource
+} from "./types";
+
+/**
+ * https://developer-specs.company-information.service.gov.uk/companies-house-public-data-api/reference/persons-with-significant-control/list-statements
+ */
+export default class CompanyPscStatementsService {
+    constructor (private readonly client: IHttpClient) { }
+
+    /**
+     * Get the PSC statements for a company.
+     *
+     * @param companyNumber the company number to look up
+     * @param pageSize the size of the page to return
+     * @param pageIndex the index of the page to return
+     * @param registerView Display register specific information.
+     */
+    public async getCompanyPscStatements (companyNumber: string, pageSize: number, pageIndex: number, registerView: boolean = false): Promise<Resource<CompanyPersonsWithSignificantControlStatements> | ApiErrorResponse> {
+        let url = `/company/${companyNumber}/persons-with-significant-control-statements`;
+        url = url.concat("?",
+            `page_size=${pageSize}`,
+            "&",
+            `page_index=${pageIndex}`,
+            "&",
+            `register_view=${registerView}`);
+
+        const resp = await this.client.httpGet(url);
+
+        if (resp.status !== 200) {
+            return {
+                httpStatusCode: resp.status,
+                errors: resp.error
+            }
+        }
+
+        const sdkResponse: Resource<CompanyPersonsWithSignificantControlStatements> = {
+            httpStatusCode: resp.status
+        };
+
+        const body = resp.body as CompanyPersonsWithSignificantControlStatementsResource;
+
+        sdkResponse.resource = Mapping.camelCaseKeys<CompanyPersonsWithSignificantControlStatements>(body);
+
+        return sdkResponse;
+    }
+}

src/services/company-psc-statements/types.ts

@@ -0,0 +1,53 @@
+/**
+ * CompanyPersonsWithSignificantControlStatementsResource is what is returned from the api.
+ */
+export interface CompanyPersonsWithSignificantControlStatementsResource {
+    active_count: string,
+    ceased_count: string,
+    items: CompanyPersonWithSignificantControlStatementResource[],
+    items_per_page?: string,
+    links: { self : string },
+    start_index?: string,
+    total_results: string
+}
+
+export interface CompanyPersonWithSignificantControlStatementResource {
+    ceased_on?: string,
+    etag: string,
+    kind: string,
+    linked_psc_name?: string,
+    links: {
+        person_with_significant_control?: string,
+        self: string
+    },
+    notified_on: string,
+    restrictions_notice_withdrawal_reason?: string,
+    statement: string
+}
+
+/**
+ * CompanyPersonsWithSignificantControlStatements is what is returned from the sdk.
+ */
+export interface CompanyPersonsWithSignificantControlStatements {
+    activeCount: string,
+    ceasedCount: string,
+    items: CompanyPersonWithSignificantControlStatement[],
+    itemsPerPage?: string,
+    links: { self : string },
+    startIndex?: string,
+    totalResults: string
+}
+
+export interface CompanyPersonWithSignificantControlStatement {
+    ceasedOn?: string,
+    etag: string,
+    kind: string,
+    linkedPscName?: string,
+    links: {
+        personWithSignificantControl?: string,
+        self: string
+    },
+    notifiedOn: string,
+    restrictionsNoticeWithdrawalReason?: string,
+    statement: string
+}

test/services/company-psc-statements/service.spec.ts

@@ -0,0 +1,90 @@
+import chai from "chai";
+import sinon from "sinon";
+
+import { RequestClient } from "../../../src/http";
+import CompanyPscStatementsService from "../../../src/services/company-psc-statements/service";
+import {
+    CompanyPersonsWithSignificantControlStatements,
+    CompanyPersonsWithSignificantControlStatementsResource
+} from "../../../src/services/company-psc-statements";
+import Resource from "../../../src/services/resource";
+const expect = chai.expect;
+
+const requestClient = new RequestClient({ baseUrl: "URL-NOT-USED", oauthToken: "TOKEN-NOT-USED" });
+
+describe("company-psc-statements", () => {
+    beforeEach(() => {
+        sinon.reset();
+        sinon.restore();
+    });
+
+    afterEach(done => {
+        sinon.reset();
+        sinon.restore();
+        done();
+    });
+
+    it("returns an error response on failure", async () => {
+        const mockGetResponse = {
+            status: 401,
+            error: "An error occurred"
+        };
+        sinon.stub(requestClient, "httpGet").resolves(mockGetResponse);
+        const companyPscStatement : CompanyPscStatementsService = new CompanyPscStatementsService(requestClient);
+        const data = await companyPscStatement.getCompanyPscStatements("NUMBER-NOT-IMPORTANT", 2, 1);
+
+        expect(data.httpStatusCode).to.equal(401);
+    });
+
+    it("maps the psc statement data items correctly", async () => {
+        const mockResponseBody : CompanyPersonsWithSignificantControlStatementsResource = ({
+            active_count: "1",
+            ceased_count: "0",
+            items_per_page: "1",
+            start_index: "0",
+            total_results: "1",
+            links: {
+                self: "statementsSelfLink"
+            },
+            items: [
+                {
+                    ceased_on: "ceased",
+                    etag: "etag",
+                    kind: "kind",
+                    links: { self: "statementSelfLink" },
+                    notified_on: "notifiedOn",
+                    statement: "statement"
+                }
+            ]
+        });
+
+        const mockGetResponse = {
+            status: 200,
+            body: mockResponseBody
+        };
+
+        sinon.stub(requestClient, "httpGet").resolves(mockGetResponse);
+        const companyPscStatementService : CompanyPscStatementsService = new CompanyPscStatementsService(requestClient);
+        const data = await companyPscStatementService.getCompanyPscStatements("NUMBER-NOT-IMPORTANT", 2, 1);
+
+        expect(data.httpStatusCode).to.equal(200);
+
+        const castedResponse: Resource<CompanyPersonsWithSignificantControlStatements> = data as Resource<CompanyPersonsWithSignificantControlStatements>
+
+        expect(castedResponse.resource.activeCount).to.equal(mockResponseBody.active_count);
+        expect(castedResponse.resource.ceasedCount).to.equal(mockResponseBody.ceased_count);
+        expect(castedResponse.resource.itemsPerPage).to.equal(mockResponseBody.items_per_page);
+        expect(castedResponse.resource.startIndex).to.equal(mockResponseBody.start_index);
+        expect(castedResponse.resource.totalResults).to.equal(mockResponseBody.total_results);
+
+        expect(castedResponse.resource.links.self).to.equal(mockResponseBody.links.self);
+
+        expect(castedResponse.resource.items.length).to.equal(mockResponseBody.items.length);
+
+        expect(castedResponse.resource.items[0].ceasedOn).to.equal(mockResponseBody.items[0].ceased_on);
+        expect(castedResponse.resource.items[0].etag).to.equal(mockResponseBody.items[0].etag);
+        expect(castedResponse.resource.items[0].kind).to.equal(mockResponseBody.items[0].kind);
+        expect(castedResponse.resource.items[0].notifiedOn).to.equal(mockResponseBody.items[0].notified_on);
+        expect(castedResponse.resource.items[0].statement).to.equal(mockResponseBody.items[0].statement);
+    });
+});