@companieshouse/api-sdk-node 2.0.152 → 2.0.153

package/dist/client.d.ts

@@ -24,6 +24,7 @@ import OfficerFilingService from "./services/officer-filing/service";
 import RegisteredEmailAddressService from "./services/registered-email-address/service";
 import { ClientType } from "./enums";
 import { PostcodeLookupService } from "./services/postcode-lookup";
+import PscVerificationService from "./services/psc-verification-link/service";
 /**
  * ApiClient is the class that all service objects hang off.
  */
@@ -60,5 +61,6 @@ export default class ApiClient {
     readonly overseasEntity: OverseasEntityService;
     readonly officerFiling: OfficerFilingService;
     readonly postCodeLookup: PostcodeLookupService;
+    readonly pscVerificationService: PscVerificationService;
     constructor(apiClient: IHttpClient, accountClient: IHttpClient);
 }

package/dist/client.js

@@ -27,6 +27,7 @@ const service_15 = __importDefault(require("./services/order/checkout-item/servi
 const service_16 = __importDefault(require("./services/officer-filing/service"));
 const service_17 = __importDefault(require("./services/registered-email-address/service"));
 const postcode_lookup_1 = require("./services/postcode-lookup");
+const service_18 = __importDefault(require("./services/psc-verification-link/service"));
 /**
  * ApiClient is the class that all service objects hang off.
  */
@@ -66,6 +67,7 @@ class ApiClient {
         this.transaction = new service_11.default(apiClient);
         this.registeredEmailAddressService = new service_17.default(apiClient);
         this.postCodeLookup = new postcode_lookup_1.PostcodeLookupService(apiClient);
+        this.pscVerificationService = new service_18.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,2FAAwF;AAExF,gEAAmE;AAEnE;;GAEG;AACH,MAAqB,SAAS;IAgC5B,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,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;IAC/D,CAAC;CACF;AAlED,4BAkEC"}
+{"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,2FAAwF;AAExF,gEAAmE;AACnE,wFAA8E;AAE9E;;GAEG;AACH,MAAqB,SAAS;IAiC5B,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,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;IACxE,CAAC;CACF;AApED,4BAoEC"}

package/dist/services/psc-verification-link/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export { default as PscVerificationService } from "./service";

package/dist/services/psc-verification-link/index.js

@@ -0,0 +1,20 @@
+"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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PscVerificationService = void 0;
+__exportStar(require("./types"), exports);
+var service_1 = require("./service");
+Object.defineProperty(exports, "PscVerificationService", { enumerable: true, get: function () { return __importDefault(service_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/services/psc-verification-link/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,0CAAwB;AACxB,qCAA8D;AAArD,kIAAA,OAAO,OAA0B"}

package/dist/services/psc-verification-link/service.d.ts

@@ -0,0 +1,9 @@
+import { PscVerification, PscVerificationResource } from "./types";
+import { IHttpClient } from "../../http";
+import Resource, { ApiErrorResponse } from "../resource";
+export default class {
+    private readonly client;
+    constructor(client: IHttpClient);
+    postPscVerification(transactionId: string, pscVerification: PscVerification): Promise<Resource<PscVerificationResource> | ApiErrorResponse>;
+    private populateResource;
+}

package/dist/services/psc-verification-link/service.js

@@ -0,0 +1,39 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+class default_1 {
+    constructor(client) {
+        this.client = client;
+    }
+    postPscVerification(transactionId, pscVerification) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `/transactions/${transactionId}/persons-with-significant-control-verification`;
+            const response = yield this.client.httpPost(url, pscVerification);
+            if (response.error) {
+                return {
+                    httpStatusCode: response.status,
+                    errors: [response.error]
+                };
+            }
+            const resource = {
+                httpStatusCode: response.status
+            };
+            const body = response.body;
+            this.populateResource(resource, body);
+            return resource;
+        });
+    }
+    populateResource(resource, body) {
+        resource.resource = body;
+    }
+}
+exports.default = default_1;
+//# sourceMappingURL=service.js.map

package/dist/services/psc-verification-link/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAOA;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,mBAAmB,CAAE,aAAqB,EAAE,eAAgC;;YACrF,MAAM,GAAG,GAAG,iBAAiB,aAAa,gDAAgD,CAAC;YAC3F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;YAElE,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,QAAQ,GAAsC;gBAChD,cAAc,EAAE,QAAQ,CAAC,MAAM;aAClC,CAAC;YACF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA+B,CAAA;YACrD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEO,gBAAgB,CAAE,QAA2C,EAAE,IAA6B;QAChG,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC;IAC7B,CAAC;CACJ;AAzBD,4BAyBC"}

package/dist/services/psc-verification-link/types.d.ts

@@ -0,0 +1,43 @@
+export interface NameElements {
+    forename?: string;
+    other_forenames?: string;
+    middlename?: string;
+    surname?: string;
+    title?: string;
+}
+export interface RelevantOfficer {
+    name_elements: NameElements;
+    date_of_birth: Date;
+    is_employee: boolean;
+    is_director: boolean;
+}
+export declare enum NameMismatchReason {
+    PREFERRED_NAME = "PREFERRED_NAME",
+    MAIDEN_NAME = "MAIDEN_NAME"
+}
+export declare enum VerificationStatement {
+    INDIVIDUAL_VERIFIED = "INDIVIDUAL_VERIFIED",
+    RO_IDENTIFIED = "RO_IDENTIFIED",
+    RO_VERIFIED = "RO_VERIFIED",
+    RO_DECLARATION = "RO_DECLARATION"
+}
+export interface VerificationDetails {
+    name_mismatch_reason?: NameMismatchReason;
+    verification_statements: VerificationStatement[];
+}
+export interface PscVerification {
+    company_number: string;
+    psc_appointment_id: string;
+    relevant_officer?: RelevantOfficer;
+    verification_details: VerificationDetails;
+}
+export interface Links {
+    self: string;
+    validation_status: string;
+}
+export interface PscVerificationResource {
+    created_at: Date;
+    updated_at: Date;
+    links: Links;
+    data: PscVerification;
+}

package/dist/services/psc-verification-link/types.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VerificationStatement = exports.NameMismatchReason = void 0;
+var NameMismatchReason;
+(function (NameMismatchReason) {
+    NameMismatchReason["PREFERRED_NAME"] = "PREFERRED_NAME";
+    NameMismatchReason["MAIDEN_NAME"] = "MAIDEN_NAME";
+})(NameMismatchReason = exports.NameMismatchReason || (exports.NameMismatchReason = {}));
+var VerificationStatement;
+(function (VerificationStatement) {
+    VerificationStatement["INDIVIDUAL_VERIFIED"] = "INDIVIDUAL_VERIFIED";
+    VerificationStatement["RO_IDENTIFIED"] = "RO_IDENTIFIED";
+    VerificationStatement["RO_VERIFIED"] = "RO_VERIFIED";
+    VerificationStatement["RO_DECLARATION"] = "RO_DECLARATION";
+})(VerificationStatement = exports.VerificationStatement || (exports.VerificationStatement = {}));
+//# sourceMappingURL=types.js.map

package/dist/services/psc-verification-link/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/types.ts"],"names":[],"mappings":";;;AAeA,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC1B,uDAAiC,CAAA;IACjC,iDAA2B,CAAA;AAC/B,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B;AAED,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC7B,oEAA2C,CAAA;IAC3C,wDAA8B,CAAA;IAC9B,oDAA2B,CAAA;IAC3B,0DAAiC,CAAA;AACrC,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC"}

package/package.json

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