@companieshouse/api-sdk-node 2.0.221 → 2.0.222

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/services/psc-verification-link/service.d.ts +3 -2
  2. package/dist/services/psc-verification-link/service.js +16 -0
  3. package/dist/services/psc-verification-link/service.js.map +1 -1
  4. package/dist/services/psc-verification-link/types.d.ts +6 -0
  5. package/dist/services/psc-verification-link/types.js.map +1 -1
  6. package/package.json +1 -1
package/dist/services/psc-verification-link/service.d.ts CHANGED
@@ -1,6 +1,6 @@
1
- import { PscVerification, PscVerificationData } from "./types";
1
+ import { PlannedMaintenance, PscVerification, PscVerificationData } from "./types";
2
2
  import { IHttpClient } from "../../http";
3
- import Resource, { ApiErrorResponse } from "../resource";
3
+ import Resource, { ApiErrorResponse, ApiResponse } from "../resource";
4
4
  /**
5
5
  * The PSC Verification Service expects request body data to be configured in camelCase format and will
6
6
  * unwrap this data into snake case format before submitting this on to the PSC verification API. Response
@@ -12,5 +12,6 @@ export default class PscVerificationService {
12
12
  postPscVerification(transactionId: string, pscVerification: PscVerificationData): Promise<Resource<PscVerification> | ApiErrorResponse>;
13
13
  getPscVerification(transactionId: string, pscVerificationId: string): Promise<Resource<PscVerification> | ApiErrorResponse>;
14
14
  patchPscVerification(transactionId: string, filingId: string, pscVerificationPatch: PscVerificationData): Promise<Resource<PscVerification> | ApiErrorResponse>;
15
+ checkPlannedMaintenance(): Promise<ApiResponse<PlannedMaintenance> | ApiErrorResponse>;
15
16
  private populateFrontEndResource;
16
17
  }
package/dist/services/psc-verification-link/service.js CHANGED
@@ -64,6 +64,22 @@ class PscVerificationService {
64
64
  return this.populateFrontEndResource(response);
65
65
  });
66
66
  }
67
+ checkPlannedMaintenance() {
68
+ return __awaiter(this, void 0, void 0, function* () {
69
+ const maintenanceUri = `/persons-with-significant-control-verification/maintenance`;
70
+ const response = yield this.client.httpGet(maintenanceUri);
71
+ if (response.error) {
72
+ return {
73
+ httpStatusCode: response.status,
74
+ errors: [response.error]
75
+ };
76
+ }
77
+ return {
78
+ httpStatusCode: response.status,
79
+ resource: response.body
80
+ };
81
+ });
82
+ }
67
83
  populateFrontEndResource(response) {
68
84
  const frontEndResource = {
69
85
  httpStatusCode: response.status,
package/dist/services/psc-verification-link/service.js.map CHANGED
@@ -1 +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"}
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;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;AA5ED,yCA4EC"}
package/dist/services/psc-verification-link/types.d.ts CHANGED
@@ -160,6 +160,12 @@ export interface VerificationDetails {
160
160
  nameMismatchReason?: NameMismatchReasonEnum;
161
161
  verificationStatements?: VerificationStatementEnum[];
162
162
  }
163
+ export interface PlannedMaintenance {
164
+ status: string;
165
+ message: string;
166
+ maintenance_start_time: Date;
167
+ maintenance_end_time: Date;
168
+ }
163
169
  export declare enum NameMismatchReasonEnum {
164
170
  PREFERRED_NAME = "PREFERRED_NAME",
165
171
  LEGAL_NAME_CHANGE = "LEGAL_NAME_CHANGE",
package/dist/services/psc-verification-link/types.js.map CHANGED
@@ -1 +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"}
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;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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companieshouse/api-sdk-node",
3
- "version": "2.0.221",
3
+ "version": "2.0.222",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [