@companieshouse/api-sdk-node 2.0.158 → 2.0.159

package/dist/client.d.ts

@@ -27,6 +27,7 @@ import { ClientType } from "./enums";
 import { PostcodeLookupService } from "./services/postcode-lookup";
 import PscVerificationService from "./services/psc-verification-link/service";
 import { AccountsFilingService } from "./services/accounts-filing";
+import PscService from "./services/psc/service";
 /**
  * ApiClient is the class that all service objects hang off.
  */
@@ -66,5 +67,6 @@ export default class ApiClient {
     readonly postCodeLookup: PostcodeLookupService;
     readonly pscVerificationService: PscVerificationService;
     readonly accountsFilingService: AccountsFilingService;
+    readonly pscService: PscService;
     constructor(apiClient: IHttpClient, accountClient: IHttpClient);
 }

package/dist/client.js

@@ -30,6 +30,7 @@ const service_18 = __importDefault(require("./services/registered-email-address/
 const postcode_lookup_1 = require("./services/postcode-lookup");
 const service_19 = __importDefault(require("./services/psc-verification-link/service"));
 const accounts_filing_1 = require("./services/accounts-filing");
+const service_20 = __importDefault(require("./services/psc/service"));
 /**
  * ApiClient is the class that all service objects hang off.
  */
@@ -72,6 +73,7 @@ class ApiClient {
         this.postCodeLookup = new postcode_lookup_1.PostcodeLookupService(apiClient);
         this.pscVerificationService = new service_19.default(apiClient);
         this.accountsFilingService = new accounts_filing_1.AccountsFilingService(apiClient);
+        this.pscService = new service_20.default(apiClient);
     }
 }
 exports.default = ApiClient;

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAO2B;AAC3B,iDAAqD;AACrD,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,2FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AACjF,oEAAqE;AACrE,8DAAwE;AACxE,mFAAmE;AACnE,sFAAyE;AACzE,iFAAqE;AACrE,uEAAkD;AAClD,2FAAwF;AAExF,gEAAmE;AACnE,wFAA8E;AAC9E,gEAAmE;AAEnE;;GAEG;AACH,MAAqB,SAAS;IAmC5B,YAAsB,SAAsB,EAAW,aAA0B;QAA3D,cAAS,GAAT,SAAS,CAAa;QAAW,kBAAa,GAAb,aAAa,CAAa;QAC7E,iDAAiD;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,8BAAwB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,iBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,4BAA4B,GAAG,IAAI,qDAA4B,CAAC,SAAS,CAAC,CAAC;QAChF,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,eAAe,GAAG,IAAI,8BAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAc,CAAC,SAAS,CAAC,CAAC,CAAC,6EAA6E;QAC3H,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAe,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAmB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAY,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAgB,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,kBAAoB,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,kBAAW,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,qBAAqB,GAAG,IAAI,gCAAqB,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,GAAG,GAAG,IAAI,kBAAU,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,IAAI,iBAAyB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,iEAAiE;QACjE,4DAA4D;QAC5D,IAAI,CAAC,YAAY,GAAG,IAAI,mCAAmB,CAAC,aAAa,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,6BAA6B,GAAG,IAAI,kBAA6B,CAAC,SAAS,CAAC,CAAC;QAClF,IAAI,CAAC,cAAc,GAAG,IAAI,uCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,sBAAsB,GAAG,IAAI,kBAAsB,CAAC,SAAS,CAAC,CAAC;QACpE,IAAI,CAAC,qBAAqB,GAAG,IAAI,uCAAqB,CAAC,SAAS,CAAC,CAAC;IACtE,CAAC;CACF;AAxED,4BAwEC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAO2B;AAC3B,iDAAqD;AACrD,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,2FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AACjF,oEAAqE;AACrE,8DAAwE;AACxE,mFAAmE;AACnE,sFAAyE;AACzE,iFAAqE;AACrE,uEAAkD;AAClD,2FAAwF;AAExF,gEAAmE;AACnE,wFAA8E;AAC9E,gEAAmE;AACnE,sEAAgD;AAEhD;;GAEG;AACH,MAAqB,SAAS;IAoC5B,YAAsB,SAAsB,EAAW,aAA0B;QAA3D,cAAS,GAAT,SAAS,CAAa;QAAW,kBAAa,GAAb,aAAa,CAAa;QAC7E,iDAAiD;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,8BAAwB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,iBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,4BAA4B,GAAG,IAAI,qDAA4B,CAAC,SAAS,CAAC,CAAC;QAChF,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,eAAe,GAAG,IAAI,8BAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAc,CAAC,SAAS,CAAC,CAAC,CAAC,6EAA6E;QAC3H,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAe,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAmB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAY,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAgB,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,kBAAoB,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,kBAAW,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,qBAAqB,GAAG,IAAI,gCAAqB,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,GAAG,GAAG,IAAI,kBAAU,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,IAAI,iBAAyB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,iEAAiE;QACjE,4DAA4D;QAC5D,IAAI,CAAC,YAAY,GAAG,IAAI,mCAAmB,CAAC,aAAa,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,6BAA6B,GAAG,IAAI,kBAA6B,CAAC,SAAS,CAAC,CAAC;QAClF,IAAI,CAAC,cAAc,GAAG,IAAI,uCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,sBAAsB,GAAG,IAAI,kBAAsB,CAAC,SAAS,CAAC,CAAC;QACpE,IAAI,CAAC,qBAAqB,GAAG,IAAI,uCAAqB,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAU,CAAC,SAAS,CAAC,CAAC;IAChD,CAAC;CACF;AA1ED,4BA0EC"}

package/dist/services/psc/index.d.ts

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

package/dist/services/psc/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/services/psc/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/psc/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAAwB;AACxB,4CAA0B"}

package/dist/services/psc/service.d.ts

@@ -0,0 +1,17 @@
+import { IHttpClient } from "../../http";
+import Resource, { ApiErrorResponse } from "../resource";
+import { PersonWithSignificantControl } from "./types";
+/**
+ * https://developer-specs.company-information.service.gov.uk/companies-house-public-data-api/reference/persons-with-significant-control/get-individual
+ */
+export default class PscService {
+    private readonly client;
+    constructor(client: IHttpClient);
+    /**
+   * Get the PSC details for an individual person.
+   *
+   * @param companyNumber the company number to look up
+   * @param notificationId the PSC Notification Id to retrieve
+   */
+    getPscIndividual(companyNumber: string, notificationId: string): Promise<Resource<PersonWithSignificantControl> | ApiErrorResponse>;
+}

package/dist/services/psc/service.js

@@ -0,0 +1,48 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mapping_1 = __importDefault(require("../../mapping/mapping"));
+/**
+ * https://developer-specs.company-information.service.gov.uk/companies-house-public-data-api/reference/persons-with-significant-control/get-individual
+ */
+class PscService {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+   * Get the PSC details for an individual person.
+   *
+   * @param companyNumber the company number to look up
+   * @param notificationId the PSC Notification Id to retrieve
+   */
+    getPscIndividual(companyNumber, notificationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.client.httpGet(`/company/${companyNumber}/persons-with-significant-control/individual/${notificationId}`);
+            const resource = {
+                httpStatusCode: response.status
+            };
+            if (response.error) {
+                return {
+                    httpStatusCode: response.status,
+                    errors: [response.error]
+                };
+            }
+            const body = response.body;
+            resource.resource = mapping_1.default.camelCaseKeys(body);
+            return resource;
+        });
+    }
+}
+exports.default = PscService;
+//# sourceMappingURL=service.js.map

package/dist/services/psc/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,oEAA4C;AAI5C;;GAEG;AACH,MAAqB,UAAU;IAC3B,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEtD;;;;;KAKC;IACY,gBAAgB,CAAE,aAAqB,EAAE,cAAsB;;YACxE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,aAAa,gDAAgD,cAAc,EAAE,CAAC,CAAC;YAEtI,MAAM,QAAQ,GAA2C;gBACrD,cAAc,EAAE,QAAQ,CAAC,MAAM;aAClC,CAAC;YAEF,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAA;aACJ;YAED,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA4C,CAAC;YACnE,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAA+B,IAAI,CAAC,CAAC;YAE9E,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AA5BD,6BA4BC"}

package/dist/services/psc/types.d.ts

@@ -0,0 +1,111 @@
+/**
+ * PersonWithSignificantControlResource is what is returned from the api.
+ */
+export interface PersonWithSignificantControlResource {
+    address: AddressResource;
+    country_of_residence: string;
+    date_of_birth: DateOfBirthResource;
+    ceased_on?: string;
+    etag: string;
+    links: ItemLinksResource;
+    name: string;
+    name_elements: NameElementsResource;
+    nationality: string;
+    natures_of_control: string[];
+    notified_on: string;
+    is_sanctioned?: boolean;
+    kind?: string;
+    identification?: IdentificationResource;
+}
+export interface AddressResource {
+    address_line_1: string;
+    address_line_2?: string;
+    careOf?: string;
+    locality: string;
+    poBox?: string;
+    postal_code?: string;
+    premises?: string;
+    region?: string;
+}
+export interface DateOfBirthResource {
+    day?: string;
+    month: string;
+    year: string;
+}
+export interface NameElementsResource {
+    title?: string;
+    forename?: string;
+    other_forenames?: string;
+    middle_name?: string;
+    surname: string;
+}
+export interface IdentificationResource {
+    identification_type?: string;
+    legal_authority?: string;
+    legal_form?: string;
+    place_registered?: string;
+    registration_number?: string;
+    country_registered?: string;
+}
+export interface ResultsLinksResource {
+    self: string;
+    persons_with_significant_control_statements_list?: string;
+}
+export interface ItemLinksResource {
+    self: string;
+    statement?: string;
+}
+export interface PersonWithSignificantControl {
+    address: any;
+    countryOfResidence: string;
+    dateOfBirth: DateOfBirth;
+    ceasedOn?: string;
+    etag: string;
+    links: ItemLinks;
+    name: string;
+    nameElements: NameElements;
+    nationality: string;
+    naturesOfControl: string[];
+    notifiedOn: string;
+    isSanctioned?: boolean;
+    kind?: string;
+    identification?: Identification;
+}
+export interface Address {
+    addressLine1: string;
+    addressLine2?: string;
+    careOf?: string;
+    locality: string;
+    poBox?: string;
+    postalCode?: string;
+    premises?: string;
+    region?: string;
+}
+export interface DateOfBirth {
+    day?: string;
+    month: string;
+    year: string;
+}
+export interface NameElements {
+    title?: string;
+    forename?: string;
+    otherForenames?: string;
+    middleName?: string;
+    surname: string;
+}
+export interface Identification {
+    identificationType?: string;
+    legalAuthority?: string;
+    legalForm?: string;
+    placeRegistered?: string;
+    registrationNumber?: string;
+    countryRegistered?: string;
+}
+export interface ResultsLinks {
+    self: string;
+    personsWithSignificantControlStatementsList?: string;
+}
+export interface ItemLinks {
+    self: string;
+    statement?: string;
+}

package/dist/services/psc/types.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * PersonWithSignificantControlResource is what is returned from the api.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+//# sourceMappingURL=types.js.map

package/dist/services/psc/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/psc/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAiBF,CAAC;AAWD,CAAC;AAMD,CAAC;AAQD,CAAC;AASD,CAAC;AAKD,CAAC;AAKD,CAAC;AAiBD,CAAC;AAWD,CAAC;AAMD,CAAC;AAQD,CAAC;AASD,CAAC;AAKD,CAAC;AAKD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@companieshouse/api-sdk-node",
-    "version": "2.0.158",
+    "version": "2.0.159",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
     "files": [