@companieshouse/api-sdk-node 2.0.171 → 2.0.173

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.
@@ -23,4 +23,10 @@ export default class {
23
23
  * @param userId the id of the user whose application will be deleted
24
24
  */
25
25
  deleteSavedApplication(userId: string): Promise<HttpResponse>;
26
+ /**
27
+ * Send a confirmation email for application complete
28
+ * @param userId the id of the user who will recieve the email
29
+ * @param applicationReference the reference number of the application
30
+ */
31
+ sendConfirmationEmail(userId: string, applicationReference: string): Promise<HttpResponse>;
26
32
  }
@@ -87,6 +87,18 @@ class default_1 {
87
87
  return resp;
88
88
  });
89
89
  }
90
+ /**
91
+ * Send a confirmation email for application complete
92
+ * @param userId the id of the user who will recieve the email
93
+ * @param applicationReference the reference number of the application
94
+ */
95
+ sendConfirmationEmail(userId, applicationReference) {
96
+ return __awaiter(this, void 0, void 0, function* () {
97
+ const url = `/acsp-api/user/${userId}/application-submit/${applicationReference}`;
98
+ const resp = yield this.client.httpPost(url);
99
+ return resp;
100
+ });
101
+ }
90
102
  }
91
103
  exports.default = default_1;
92
104
  //# sourceMappingURL=service.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/acsp/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAOA,oEAA4C;AAE5C;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,OAAO,CAAE,aAAqB,EAAE,EAAU;;YACnD,MAAM,GAAG,GAAG,iBAAiB,aAAa,SAAS,EAAE,EAAE,CAAC;YACxD,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE1D,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,MAAM,QAAQ,GAAuB;gBACjC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAe,CAAC;YAElC,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAW,IAAI,CAAC,CAAC;YAC1D,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;;;OAIG;IACU,QAAQ,CAAE,aAAqB,EAAE,IAAc;;YACxD,MAAM,GAAG,GAAG,iBAAiB,aAAa,OAAO,CAAC;YAElD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAEnD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,OAAO;gBACH,cAAc,EAAE,IAAI,CAAC,MAAM;gBAC3B,QAAQ,EAAE,IAAI,CAAC,IAAI;aACI,CAAC;QAChC,CAAC;KAAA;IAED;;;;OAIG;IACU,OAAO,CAAE,aAAqB,EAAE,IAAc;;YACvD,MAAM,GAAG,GAAG,iBAAiB,aAAa,OAAO,CAAC;YAElD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAElD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,OAAO;gBACH,cAAc,EAAE,IAAI,CAAC,MAAM;gBAC3B,QAAQ,EAAE,IAAI,CAAC,IAAI;aACI,CAAC;QAChC,CAAC;KAAA;IAED,2BAA2B;IACd,mBAAmB,CAAE,MAAc;;YAC5C,MAAM,GAAG,GAAG,kBAAkB,MAAM,cAAc,CAAC;YACnD,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC1D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAED;;;OAGG;IACU,sBAAsB,CAAE,MAAc;;YAC/C,MAAM,GAAG,GAAG,kBAAkB,MAAM,cAAc,CAAC;YACnD,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;CACJ;AA7ED,4BA6EC"}
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/acsp/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAOA,oEAA4C;AAE5C;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,OAAO,CAAE,aAAqB,EAAE,EAAU;;YACnD,MAAM,GAAG,GAAG,iBAAiB,aAAa,SAAS,EAAE,EAAE,CAAC;YACxD,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE1D,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,MAAM,QAAQ,GAAuB;gBACjC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAe,CAAC;YAElC,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAW,IAAI,CAAC,CAAC;YAC1D,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;;;OAIG;IACU,QAAQ,CAAE,aAAqB,EAAE,IAAc;;YACxD,MAAM,GAAG,GAAG,iBAAiB,aAAa,OAAO,CAAC;YAElD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAEnD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,OAAO;gBACH,cAAc,EAAE,IAAI,CAAC,MAAM;gBAC3B,QAAQ,EAAE,IAAI,CAAC,IAAI;aACI,CAAC;QAChC,CAAC;KAAA;IAED;;;;OAIG;IACU,OAAO,CAAE,aAAqB,EAAE,IAAc;;YACvD,MAAM,GAAG,GAAG,iBAAiB,aAAa,OAAO,CAAC;YAElD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAElD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,OAAO;gBACH,cAAc,EAAE,IAAI,CAAC,MAAM;gBAC3B,QAAQ,EAAE,IAAI,CAAC,IAAI;aACI,CAAC;QAChC,CAAC;KAAA;IAED,2BAA2B;IACd,mBAAmB,CAAE,MAAc;;YAC5C,MAAM,GAAG,GAAG,kBAAkB,MAAM,cAAc,CAAC;YACnD,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC1D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAED;;;OAGG;IACU,sBAAsB,CAAE,MAAc;;YAC/C,MAAM,GAAG,GAAG,kBAAkB,MAAM,cAAc,CAAC;YACnD,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAED;;;;OAIG;IACU,qBAAqB,CAAE,MAAc,EAAE,oBAA4B;;YAC5E,MAAM,GAAG,GAAG,kBAAkB,MAAM,uBAAuB,oBAAoB,EAAE,CAAC;YAClF,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;CACJ;AAxFD,4BAwFC"}
@@ -1,11 +1,16 @@
1
- import { PscVerification, PscVerificationResource } from "./types";
1
+ import { PscVerification, PscVerificationData } from "./types";
2
2
  import { IHttpClient } from "../../http";
3
3
  import Resource, { ApiErrorResponse } from "../resource";
4
+ /**
5
+ * The PSC Verification Service expects request body data to be configured in camelCase format and will
6
+ * unwrap this data into snake case format before submitting this on to the PSC verification API. Response
7
+ * body data received from the API is then converted from snake case back into camel case before it is returned.
8
+ */
4
9
  export default class PscVerificationService {
5
10
  private readonly client;
6
11
  constructor(client: IHttpClient);
7
- postPscVerification(transactionId: string, pscVerification: PscVerification): Promise<Resource<PscVerificationResource> | ApiErrorResponse>;
8
- getPscVerification(transactionId: string, pscVerificationId: string): Promise<Resource<PscVerificationResource> | ApiErrorResponse>;
9
- patchPscVerification(transactionId: string, filingId: string, pscVerificationPatch: PscVerification): Promise<Resource<PscVerificationResource> | ApiErrorResponse>;
10
- private populateResource;
12
+ postPscVerification(transactionId: string, pscVerification: PscVerificationData): Promise<Resource<PscVerification> | ApiErrorResponse>;
13
+ getPscVerification(transactionId: string, pscVerificationId: string): Promise<Resource<PscVerification> | ApiErrorResponse>;
14
+ patchPscVerification(transactionId: string, filingId: string, pscVerificationPatch: PscVerificationData): Promise<Resource<PscVerification> | ApiErrorResponse>;
15
+ private populateFrontEndResource;
11
16
  }
@@ -8,7 +8,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
8
8
  step((generator = generator.apply(thisArg, _arguments || [])).next());
9
9
  });
10
10
  };
11
+ var __importDefault = (this && this.__importDefault) || function (mod) {
12
+ return (mod && mod.__esModule) ? mod : { "default": mod };
13
+ };
11
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
+ const mapping_1 = __importDefault(require("../../mapping/mapping"));
16
+ /**
17
+ * The PSC Verification Service expects request body data to be configured in camelCase format and will
18
+ * unwrap this data into snake case format before submitting this on to the PSC verification API. Response
19
+ * body data received from the API is then converted from snake case back into camel case before it is returned.
20
+ */
12
21
  class PscVerificationService {
13
22
  constructor(client) {
14
23
  this.client = client;
@@ -16,14 +25,15 @@ class PscVerificationService {
16
25
  postPscVerification(transactionId, pscVerification) {
17
26
  return __awaiter(this, void 0, void 0, function* () {
18
27
  const resourceUri = `/transactions/${transactionId}/persons-with-significant-control-verification`;
19
- const response = yield this.client.httpPost(resourceUri, pscVerification);
28
+ const pscVerificationResource = mapping_1.default.snakeCaseKeys(pscVerification);
29
+ const response = yield this.client.httpPost(resourceUri, pscVerificationResource);
20
30
  if (response.error) {
21
31
  return {
22
32
  httpStatusCode: response.status,
23
33
  errors: [response.error]
24
34
  };
25
35
  }
26
- return this.populateResource(response);
36
+ return this.populateFrontEndResource(response);
27
37
  });
28
38
  }
29
39
  getPscVerification(transactionId, pscVerificationId) {
@@ -36,33 +46,32 @@ class PscVerificationService {
36
46
  errors: [response.error]
37
47
  };
38
48
  }
39
- return this.populateResource(response);
49
+ return this.populateFrontEndResource(response);
40
50
  });
41
51
  }
42
52
  patchPscVerification(transactionId, filingId, pscVerificationPatch) {
43
53
  return __awaiter(this, void 0, void 0, function* () {
44
54
  const additionalHeaders = { "Content-Type": "application/merge-patch+json" };
45
55
  const resourceUri = `/transactions/${transactionId}/persons-with-significant-control-verification/${filingId}`;
46
- const response = yield this.client.httpPatch(resourceUri, pscVerificationPatch, additionalHeaders);
56
+ const pscVerificationPatchResource = mapping_1.default.snakeCaseKeys(pscVerificationPatch);
57
+ const response = yield this.client.httpPatch(resourceUri, pscVerificationPatchResource, additionalHeaders);
47
58
  if (response.error) {
48
59
  return {
49
60
  httpStatusCode: response.status,
50
61
  errors: [response.error]
51
62
  };
52
63
  }
53
- const resource = {
54
- httpStatusCode: response.status,
55
- resource: response.body
56
- };
57
- return resource;
64
+ return this.populateFrontEndResource(response);
58
65
  });
59
66
  }
60
- populateResource(response) {
61
- const resource = {
67
+ populateFrontEndResource(response) {
68
+ const frontEndResource = {
62
69
  httpStatusCode: response.status,
63
70
  resource: response.body
64
71
  };
65
- return resource;
72
+ const body = response.body;
73
+ frontEndResource.resource = mapping_1.default.camelCaseKeys(body);
74
+ return frontEndResource;
66
75
  }
67
76
  }
68
77
  exports.default = PscVerificationService;
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAOA,MAAqB,sBAAsB;IACvC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,mBAAmB,CAAE,aAAqB,EAAE,eAAgC;;YACrF,MAAM,WAAW,GAAG,iBAAiB,aAAa,gDAAgD,CAAC;YACnG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;YAE1E,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,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC3C,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,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC;KAAA;IAEY,oBAAoB,CAAE,aAAqB,EAAE,QAAgB,EAAE,oBAAqC;;YAC7G,MAAM,iBAAiB,GAAG,EAAE,cAAc,EAAE,8BAA8B,EAAE,CAAC;YAC7E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,QAAQ,EAAE,CAAC;YAC/G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,oBAAoB,EAAE,iBAAiB,CAAC,CAAC;YAEnG,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;gBAC/B,QAAQ,EAAE,QAAQ,CAAC,IAAI;aAC1B,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEO,gBAAgB,CAAE,QAAsB;QAC5C,MAAM,QAAQ,GAAsC;YAChD,cAAc,EAAE,QAAQ,CAAC,MAAM;YAC/B,QAAQ,EAAE,QAAQ,CAAC,IAA+B;SACrD,CAAC;QAEF,OAAO,QAAQ,CAAC;IACpB,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;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,44 +1,172 @@
1
- export interface NameElements {
1
+ export interface PersonWithSignificantControlResource {
2
+ address: AddressResource;
3
+ country_of_residence: string;
4
+ date_of_birth: DateOfBirthResource;
5
+ ceased_on?: string;
6
+ etag: string;
7
+ links: ItemLinksResource;
8
+ name: string;
9
+ name_elements: NameElementsResource;
10
+ nationality: string;
11
+ natures_of_control: string[];
12
+ notified_on: string;
13
+ is_sanctioned?: boolean;
14
+ kind?: string;
15
+ identification?: IdentificationResource;
16
+ }
17
+ export interface PersonWithSignificantControl {
18
+ address: Address;
19
+ countryOfResidence: string;
20
+ dateOfBirth: DateOfBirth;
21
+ ceasedOn?: string;
22
+ etag: string;
23
+ links: ItemLinks;
24
+ name: string;
25
+ nameElements: NameElements;
26
+ nationality: string;
27
+ naturesOfControl: string[];
28
+ notifiedOn: string;
29
+ isSanctioned?: boolean;
30
+ kind?: string;
31
+ identification?: Identification;
32
+ }
33
+ export interface AddressResource {
34
+ address_line_1: string;
35
+ address_line_2?: string;
36
+ careOf?: string;
37
+ locality: string;
38
+ poBox?: string;
39
+ postal_code?: string;
40
+ premises?: string;
41
+ region?: string;
42
+ }
43
+ export interface Address {
44
+ addressLine1: string;
45
+ addressLine2?: string;
46
+ careOf?: string;
47
+ locality: string;
48
+ poBox?: string;
49
+ postalCode?: string;
50
+ premises?: string;
51
+ region?: string;
52
+ }
53
+ export interface DateOfBirthResource {
54
+ day?: string;
55
+ month: string;
56
+ year: string;
57
+ }
58
+ export interface DateOfBirth {
59
+ day?: string;
60
+ month: string;
61
+ year: string;
62
+ }
63
+ export interface ResultsLinksResource {
64
+ self: string;
65
+ persons_with_significant_control_statements_list?: string;
66
+ }
67
+ export interface ResultsLinks {
68
+ self: string;
69
+ personsWithSignificantControlStatementsList?: string;
70
+ }
71
+ export interface ItemLinksResource {
72
+ self: string;
73
+ statement?: string;
74
+ }
75
+ export interface ItemLinks {
76
+ self: string;
77
+ statement?: string;
78
+ }
79
+ export interface LinksResource {
80
+ self: string;
81
+ validation_status: string;
82
+ }
83
+ export interface Links {
84
+ self: string;
85
+ validationStatus: string;
86
+ }
87
+ export interface NameElementsResource {
2
88
  forename?: string;
3
89
  other_forenames?: string;
4
90
  middlename?: string;
5
91
  surname?: string;
6
92
  title?: string;
7
93
  }
8
- export interface RelevantOfficer {
9
- name_elements?: NameElements;
94
+ export interface NameElements {
95
+ title?: string;
96
+ forename?: string;
97
+ otherForenames?: string;
98
+ middleName?: string;
99
+ surname: string;
100
+ }
101
+ export interface IdentificationResource {
102
+ identification_type?: string;
103
+ legal_authority?: string;
104
+ legal_form?: string;
105
+ place_registered?: string;
106
+ registration_number?: string;
107
+ country_registered?: string;
108
+ }
109
+ export interface Identification {
110
+ identificationType?: string;
111
+ legalAuthority?: string;
112
+ legalForm?: string;
113
+ placeRegistered?: string;
114
+ registrationNumber?: string;
115
+ countryRegistered?: string;
116
+ }
117
+ export interface RelevantOfficerResource {
118
+ name_elements?: NameElementsResource;
10
119
  date_of_birth?: Date;
11
120
  is_employee?: boolean;
12
121
  is_director?: boolean;
13
122
  }
14
- export declare enum NameMismatchReason {
123
+ export interface RelevantOfficer {
124
+ nameElements?: NameElements;
125
+ dateOfBirth?: Date;
126
+ isEmployee?: boolean;
127
+ isDirector?: boolean;
128
+ }
129
+ export interface PscVerificationResource {
130
+ created_at: Date;
131
+ updated_at: Date;
132
+ links: LinksResource;
133
+ data: PscVerificationDataResource;
134
+ }
135
+ export interface PscVerificationDataResource {
136
+ company_number?: string;
137
+ psc_appointment_id?: string;
138
+ relevant_officer?: RelevantOfficerResource;
139
+ verification_details?: VerificationDetailsResource;
140
+ }
141
+ export interface PscVerification {
142
+ createdAt: Date;
143
+ updatedAt: Date;
144
+ links: Links;
145
+ data: PscVerificationData;
146
+ }
147
+ export interface PscVerificationData {
148
+ companyNumber?: string;
149
+ pscAppointmentId?: string;
150
+ relevantOfficer?: RelevantOfficer;
151
+ verificationDetails?: VerificationDetails;
152
+ }
153
+ export interface VerificationDetailsResource {
154
+ uvid?: string;
155
+ name_mismatch_reason?: NameMismatchReasonEnum;
156
+ verification_statements?: VerificationStatementEnum[];
157
+ }
158
+ export interface VerificationDetails {
159
+ uvid?: string;
160
+ nameMismatchReason?: NameMismatchReasonEnum;
161
+ verificationStatements?: VerificationStatementEnum[];
162
+ }
163
+ export declare enum NameMismatchReasonEnum {
15
164
  PREFERRED_NAME = "PREFERRED_NAME",
16
165
  MAIDEN_NAME = "MAIDEN_NAME"
17
166
  }
18
- export declare enum VerificationStatement {
167
+ export declare enum VerificationStatementEnum {
19
168
  INDIVIDUAL_VERIFIED = "INDIVIDUAL_VERIFIED",
20
169
  RO_IDENTIFIED = "RO_IDENTIFIED",
21
170
  RO_VERIFIED = "RO_VERIFIED",
22
171
  RO_DECLARATION = "RO_DECLARATION"
23
172
  }
24
- export interface VerificationDetails {
25
- uvid?: string;
26
- name_mismatch_reason?: NameMismatchReason;
27
- verification_statements?: VerificationStatement[];
28
- }
29
- export interface PscVerification {
30
- company_number?: string;
31
- psc_appointment_id?: string;
32
- relevant_officer?: RelevantOfficer;
33
- verification_details?: VerificationDetails;
34
- }
35
- export interface Links {
36
- self: string;
37
- validation_status: string;
38
- }
39
- export interface PscVerificationResource {
40
- created_at: Date;
41
- updated_at: Date;
42
- links: Links;
43
- data: PscVerification;
44
- }
@@ -1,16 +1,29 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.VerificationStatement = exports.NameMismatchReason = void 0;
4
- var NameMismatchReason;
5
- (function (NameMismatchReason) {
6
- NameMismatchReason["PREFERRED_NAME"] = "PREFERRED_NAME";
7
- NameMismatchReason["MAIDEN_NAME"] = "MAIDEN_NAME";
8
- })(NameMismatchReason = exports.NameMismatchReason || (exports.NameMismatchReason = {}));
9
- var VerificationStatement;
10
- (function (VerificationStatement) {
11
- VerificationStatement["INDIVIDUAL_VERIFIED"] = "INDIVIDUAL_VERIFIED";
12
- VerificationStatement["RO_IDENTIFIED"] = "RO_IDENTIFIED";
13
- VerificationStatement["RO_VERIFIED"] = "RO_VERIFIED";
14
- VerificationStatement["RO_DECLARATION"] = "RO_DECLARATION";
15
- })(VerificationStatement = exports.VerificationStatement || (exports.VerificationStatement = {}));
3
+ exports.VerificationStatementEnum = exports.NameMismatchReasonEnum = void 0;
4
+ ;
5
+ ;
6
+ ;
7
+ ;
8
+ ;
9
+ ;
10
+ ;
11
+ ;
12
+ ;
13
+ ;
14
+ ;
15
+ ;
16
+ ;
17
+ var NameMismatchReasonEnum;
18
+ (function (NameMismatchReasonEnum) {
19
+ NameMismatchReasonEnum["PREFERRED_NAME"] = "PREFERRED_NAME";
20
+ NameMismatchReasonEnum["MAIDEN_NAME"] = "MAIDEN_NAME";
21
+ })(NameMismatchReasonEnum = exports.NameMismatchReasonEnum || (exports.NameMismatchReasonEnum = {}));
22
+ var VerificationStatementEnum;
23
+ (function (VerificationStatementEnum) {
24
+ VerificationStatementEnum["INDIVIDUAL_VERIFIED"] = "INDIVIDUAL_VERIFIED";
25
+ VerificationStatementEnum["RO_IDENTIFIED"] = "RO_IDENTIFIED";
26
+ VerificationStatementEnum["RO_VERIFIED"] = "RO_VERIFIED";
27
+ VerificationStatementEnum["RO_DECLARATION"] = "RO_DECLARATION";
28
+ })(VerificationStatementEnum = exports.VerificationStatementEnum || (exports.VerificationStatementEnum = {}));
16
29
  //# sourceMappingURL=types.js.map
@@ -1 +1 @@
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"}
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,sBAGX;AAHD,WAAY,sBAAsB;IAC9B,2DAAiC,CAAA;IACjC,qDAA2B,CAAA;AAC/B,CAAC,EAHW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAGjC;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.171",
3
+ "version": "2.0.173",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [