@companieshouse/api-sdk-node 2.0.221 → 2.0.223

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

@@ -1,6 +1,6 @@
-import { PscVerification, PscVerificationData } from "./types";
+import { PlannedMaintenance, PscVerification, PscVerificationData } from "./types";
 import { IHttpClient } from "../../http";
-import Resource, { ApiErrorResponse } from "../resource";
+import Resource, { ApiErrorResponse, ApiResponse } from "../resource";
 /**
  * The PSC Verification Service expects request body data to be configured in camelCase format and will
  * unwrap this data into snake case format before submitting this on to the PSC verification API. Response
@@ -12,5 +12,7 @@ export default class PscVerificationService {
     postPscVerification(transactionId: string, pscVerification: PscVerificationData): Promise<Resource<PscVerification> | ApiErrorResponse>;
     getPscVerification(transactionId: string, pscVerificationId: string): Promise<Resource<PscVerification> | ApiErrorResponse>;
     patchPscVerification(transactionId: string, filingId: string, pscVerificationPatch: PscVerificationData): Promise<Resource<PscVerification> | ApiErrorResponse>;
+    getValidationStatus(transactionId: string, pscVerificationId: string): Promise<Resource<PscVerification> | ApiErrorResponse>;
+    checkPlannedMaintenance(): Promise<ApiResponse<PlannedMaintenance> | ApiErrorResponse>;
     private populateFrontEndResource;
 }

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

@@ -64,6 +64,35 @@ class PscVerificationService {
             return this.populateFrontEndResource(response);
         });
     }
+    getValidationStatus(transactionId, pscVerificationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resourceUri = `/transactions/${transactionId}/persons-with-significant-control-verification/${pscVerificationId}/validation_status`;
+            const response = yield this.client.httpGet(resourceUri);
+            if (response.status >= 400) {
+                return { httpStatusCode: response.status, errors: [response.error] };
+            }
+            const resource = { httpStatusCode: response.status };
+            const body = response.body;
+            resource.resource = mapping_1.default.camelCaseKeys(body);
+            return resource;
+        });
+    }
+    checkPlannedMaintenance() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const maintenanceUri = `/persons-with-significant-control-verification/maintenance`;
+            const response = yield this.client.httpGet(maintenanceUri);
+            if (response.error) {
+                return {
+                    httpStatusCode: response.status,
+                    errors: [response.error]
+                };
+            }
+            return {
+                httpStatusCode: response.status,
+                resource: response.body
+            };
+        });
+    }
     populateFrontEndResource(response) {
         const frontEndResource = {
             httpStatusCode: response.status,

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

@@ -1 +1 @@
-{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAIA,oEAA4C;AAE5C;;;;GAIG;AACH,MAAqB,sBAAsB;IACvC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,mBAAmB,CAAE,aAAqB,EAAE,eAAoC;;YACzF,MAAM,WAAW,GAAG,iBAAiB,aAAa,gDAAgD,CAAC;YACnG,MAAM,uBAAuB,GAAG,iBAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;YACvE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAC;YAElF,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,kBAAkB,CAAE,aAAqB,EAAE,iBAAyB;;YAC7E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,iBAAiB,EAAE,CAAC;YACxH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAExD,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,oBAAoB,CAAE,aAAqB,EAAE,QAAgB,EAAE,oBAAyC;;YACjH,MAAM,iBAAiB,GAAG,EAAE,cAAc,EAAE,8BAA8B,EAAE,CAAC;YAC7E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,QAAQ,EAAE,CAAC;YAC/G,MAAM,4BAA4B,GAAG,iBAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YACjF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,4BAA4B,EAAE,iBAAiB,CAAC,CAAC;YAE3G,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEO,wBAAwB,CAAE,QAAsB;QACpD,MAAM,gBAAgB,GAA8B;YAChD,cAAc,EAAE,QAAQ,CAAC,MAAM;YAC/B,QAAQ,EAAE,QAAQ,CAAC,IAAuB;SAC7C,CAAC;QAEF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA4C,CAAC;QACnE,gBAAgB,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAkB,IAAI,CAAC,CAAC;QAEzE,OAAO,gBAAgB,CAAC;IAC5B,CAAC;CACJ;AA3DD,yCA2DC"}
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAIA,oEAA4C;AAE5C;;;;GAIG;AACH,MAAqB,sBAAsB;IACvC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,mBAAmB,CAAE,aAAqB,EAAE,eAAoC;;YACzF,MAAM,WAAW,GAAG,iBAAiB,aAAa,gDAAgD,CAAC;YACnG,MAAM,uBAAuB,GAAG,iBAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;YACvE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAC;YAElF,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,kBAAkB,CAAE,aAAqB,EAAE,iBAAyB;;YAC7E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,iBAAiB,EAAE,CAAC;YACxH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAExD,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,oBAAoB,CAAE,aAAqB,EAAE,QAAgB,EAAE,oBAAyC;;YACjH,MAAM,iBAAiB,GAAG,EAAE,cAAc,EAAE,8BAA8B,EAAE,CAAC;YAC7E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,QAAQ,EAAE,CAAC;YAC/G,MAAM,4BAA4B,GAAG,iBAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YACjF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,4BAA4B,EAAE,iBAAiB,CAAC,CAAC;YAE3G,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,mBAAmB,CAAE,aAAqB,EAAE,iBAAyB;;YAC9E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,iBAAiB,oBAAoB,CAAC;YAC1I,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAExD,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;gBACxB,OAAO,EAAE,cAAc,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;aACxE;YAED,MAAM,QAAQ,GAAuC,EAAE,cAAc,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;YAEzF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAwC,CAAC;YAE/D,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAA2B,IAAI,CAAC,CAAC;YAE1E,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEY,uBAAuB;;YAChC,MAAM,cAAc,GAAG,4DAA4D,CAAC;YACpF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAE3D,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,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,QAAQ,CAAC,IAA0B;aAChD,CAAC;QACN,CAAC;KAAA;IAEO,wBAAwB,CAAE,QAAsB;QACpD,MAAM,gBAAgB,GAA8B;YAChD,cAAc,EAAE,QAAQ,CAAC,MAAM;YAC/B,QAAQ,EAAE,QAAQ,CAAC,IAAuB;SAC7C,CAAC;QAEF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA4C,CAAC;QACnE,gBAAgB,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAkB,IAAI,CAAC,CAAC;QAEzE,OAAO,gBAAgB,CAAC;IAC5B,CAAC;CACJ;AA7FD,yCA6FC"}

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

@@ -160,6 +160,12 @@ export interface VerificationDetails {
     nameMismatchReason?: NameMismatchReasonEnum;
     verificationStatements?: VerificationStatementEnum[];
 }
+export interface PlannedMaintenance {
+    status: string;
+    message: string;
+    maintenance_start_time: Date;
+    maintenance_end_time: Date;
+}
 export declare enum NameMismatchReasonEnum {
     PREFERRED_NAME = "PREFERRED_NAME",
     LEGAL_NAME_CHANGE = "LEGAL_NAME_CHANGE",
@@ -173,3 +179,23 @@ export declare enum VerificationStatementEnum {
     RO_VERIFIED = "RO_VERIFIED",
     RO_DECLARATION = "RO_DECLARATION"
 }
+export interface ValidationStatusError {
+    error: string;
+    location: string;
+    type?: string;
+    locationType: string;
+}
+export interface ValidationStatusResponse {
+    errors: ValidationStatusError[];
+    isValid?: boolean;
+}
+export interface ValidationStatusErrorResource {
+    error: string;
+    location: string;
+    location_type: string;
+    type?: string;
+}
+export interface ValidationStatusResponseResource {
+    errors: ValidationStatusErrorResource[];
+    is_valid?: boolean;
+}

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/types.ts"],"names":[],"mappings":";;;AAeC,CAAC;AAiBD,CAAC;AAWD,CAAC;AAWD,CAAC;AAMD,CAAC;AAMD,CAAC;AAKD,CAAC;AAKD,CAAC;AAKD,CAAC;AAKD,CAAC;AA0BD,CAAC;AASD,CAAC;AASD,CAAC;AAuDF,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAC9B,2DAAiC,CAAA;IACjC,iEAAuC,CAAA;IACvC,qFAA2D,CAAA;IAC3D,yEAA+C,CAAA;IAC/C,iEAAuC,CAAA;AAC3C,CAAC,EANW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAMjC;AAED,IAAY,yBAKX;AALD,WAAY,yBAAyB;IACjC,wEAA2C,CAAA;IAC3C,4DAA+B,CAAA;IAC/B,wDAA0B,CAAA;IAC1B,8DAAiC,CAAA;AACrC,CAAC,EALW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAKpC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/types.ts"],"names":[],"mappings":";;;AAeC,CAAC;AAiBD,CAAC;AAWD,CAAC;AAWD,CAAC;AAMD,CAAC;AAMD,CAAC;AAKD,CAAC;AAKD,CAAC;AAKD,CAAC;AAKD,CAAC;AA0BD,CAAC;AASD,CAAC;AASD,CAAC;AA8DF,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAC9B,2DAAiC,CAAA;IACjC,iEAAuC,CAAA;IACvC,qFAA2D,CAAA;IAC3D,yEAA+C,CAAA;IAC/C,iEAAuC,CAAA;AAC3C,CAAC,EANW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAMjC;AAED,IAAY,yBAKX;AALD,WAAY,yBAAyB;IACjC,wEAA2C,CAAA;IAC3C,4DAA+B,CAAA;IAC/B,wDAA0B,CAAA;IAC1B,8DAAiC,CAAA;AACrC,CAAC,EALW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAKpC"}

package/package.json

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