@companieshouse/api-sdk-node 2.0.301 → 2.0.303

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.
package/dist/client.d.ts CHANGED
@@ -26,6 +26,7 @@ import RegisteredEmailAddressService from "./services/registered-email-address/s
26
26
  import { ClientType } from "./enums";
27
27
  import { PostcodeLookupService } from "./services/postcode-lookup";
28
28
  import PscVerificationService from "./services/psc-verification-link/service";
29
+ import PscExtensionsService from "./services/psc-extensions-link/service";
29
30
  import { AccountsFilingService } from "./services/accounts-filing";
30
31
  import PscService from "./services/psc/service";
31
32
  import { LimitedPartnershipsService } from "./services/limited-partnerships";
@@ -69,6 +70,7 @@ export default class ApiClient {
69
70
  readonly acsp: AcspService;
70
71
  readonly postCodeLookup: PostcodeLookupService;
71
72
  readonly pscVerificationService: PscVerificationService;
73
+ readonly pscExtensionsService: PscExtensionsService;
72
74
  readonly accountsFilingService: AccountsFilingService;
73
75
  readonly pscService: PscService;
74
76
  readonly limitedPartnershipsService: LimitedPartnershipsService;
package/dist/client.js CHANGED
@@ -29,10 +29,11 @@ const service_17 = __importDefault(require("./services/acsp/service"));
29
29
  const service_18 = __importDefault(require("./services/registered-email-address/service"));
30
30
  const postcode_lookup_1 = require("./services/postcode-lookup");
31
31
  const service_19 = __importDefault(require("./services/psc-verification-link/service"));
32
+ const service_20 = __importDefault(require("./services/psc-extensions-link/service"));
32
33
  const accounts_filing_1 = require("./services/accounts-filing");
33
- const service_20 = __importDefault(require("./services/psc/service"));
34
+ const service_21 = __importDefault(require("./services/psc/service"));
34
35
  const limited_partnerships_1 = require("./services/limited-partnerships");
35
- const service_21 = __importDefault(require("./services/associations/service"));
36
+ const service_22 = __importDefault(require("./services/associations/service"));
36
37
  const sic_code_1 = require("./services/sic-code");
37
38
  /**
38
39
  * ApiClient is the class that all service objects hang off.
@@ -74,11 +75,12 @@ class ApiClient {
74
75
  this.transaction = new service_11.default(apiClient);
75
76
  this.registeredEmailAddressService = new service_18.default(apiClient);
76
77
  this.postCodeLookup = new postcode_lookup_1.PostcodeLookupService(apiClient);
78
+ this.pscExtensionsService = new service_20.default(apiClient);
77
79
  this.pscVerificationService = new service_19.default(apiClient);
78
80
  this.accountsFilingService = new accounts_filing_1.AccountsFilingService(apiClient);
79
- this.pscService = new service_20.default(apiClient);
81
+ this.pscService = new service_21.default(apiClient);
80
82
  this.limitedPartnershipsService = new limited_partnerships_1.LimitedPartnershipsService(apiClient);
81
- this.associationsService = new service_21.default(accountClient);
83
+ this.associationsService = new service_22.default(accountClient);
82
84
  this.sicCodeService = new sic_code_1.CondensedSicCodeService(apiClient);
83
85
  }
84
86
  }
@@ -1 +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;AACnE,sEAAgD;AAChD,0EAA4E;AAC5E,+EAAkE;AAClE,kDAA8D;AAE9D;;GAEG;AACH,MAAqB,SAAS;IAuC1B,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;QAC5C,IAAI,CAAC,0BAA0B,GAAG,IAAI,iDAA0B,CAAC,SAAS,CAAC,CAAC;QAC5E,IAAI,CAAC,mBAAmB,GAAG,IAAI,kBAAmB,CAAC,aAAa,CAAC,CAAC;QAClE,IAAI,CAAC,cAAc,GAAG,IAAI,kCAAuB,CAAC,SAAS,CAAC,CAAC;IACjE,CAAC;CACJ;AAhFD,4BAgFC"}
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,sFAA0E;AAC1E,gEAAmE;AACnE,sEAAgD;AAChD,0EAA4E;AAC5E,+EAAkE;AAClE,kDAA8D;AAE9D;;GAEG;AACH,MAAqB,SAAS;IAwC1B,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,oBAAoB,GAAG,IAAI,kBAAoB,CAAC,SAAS,CAAC,CAAC;QAChE,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;QAC5C,IAAI,CAAC,0BAA0B,GAAG,IAAI,iDAA0B,CAAC,SAAS,CAAC,CAAC;QAC5E,IAAI,CAAC,mBAAmB,GAAG,IAAI,kBAAmB,CAAC,aAAa,CAAC,CAAC;QAClE,IAAI,CAAC,cAAc,GAAG,IAAI,kCAAuB,CAAC,SAAS,CAAC,CAAC;IACjE,CAAC;CACJ;AAlFD,4BAkFC"}
@@ -0,0 +1,2 @@
1
+ export * from "./types";
2
+ export { default as PscExtensionService } from "./service";
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
5
+ }) : (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ o[k2] = m[k];
8
+ }));
9
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
10
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11
+ };
12
+ var __importDefault = (this && this.__importDefault) || function (mod) {
13
+ return (mod && mod.__esModule) ? mod : { "default": mod };
14
+ };
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.PscExtensionService = void 0;
17
+ __exportStar(require("./types"), exports);
18
+ var service_1 = require("./service");
19
+ Object.defineProperty(exports, "PscExtensionService", { enumerable: true, get: function () { return __importDefault(service_1).default; } });
20
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/psc-extensions-link/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,qCAA2D;AAAlD,+HAAA,OAAO,OAAuB"}
@@ -0,0 +1,36 @@
1
+ import { PscExtension, PscExtensionData } from "./types";
2
+ import { Headers, IHttpClient } from "../../http";
3
+ import Resource, { ApiErrorResponse } from "../resource";
4
+ /**
5
+ * Service class for handling PSC (Person with Significant Control) extension-related operations.
6
+ * This class provides methods to interact with the PSC extensions API, including creating, retrieving,
7
+ * and checking the validation of PSC extensions request
8
+ */
9
+ export default class PscExtensionService {
10
+ private readonly client;
11
+ constructor(client: IHttpClient);
12
+ /**
13
+ * Submits a new PSC extension for a given transaction.
14
+ *
15
+ * @param transactionId - The unique identifier of the transaction.
16
+ * @param pscExtension - The PSC extension data to be submitted.
17
+ * @returns A promise that resolves to either:
18
+ * - A `Resource<PscExtension>` object containing the created PSC extension details.
19
+ * - An `ApiErrorResponse` object if an error occurs during the request.
20
+ */
21
+ postPscExtension(transactionId: string, pscExtension: PscExtensionData, headers?: Headers): Promise<Resource<PscExtension> | ApiErrorResponse>;
22
+ /**
23
+ * Maps the response body to a front-end resource format with camelCase keys.
24
+ *
25
+ * @param response - The HTTP response received from the API.
26
+ * @returns A `Resource<PscExtension>` object containing the mapped resource.
27
+ */
28
+ private populateFrontEndResource;
29
+ /**
30
+ * Handles error responses from the API by mapping error details to camelCase keys.
31
+ *
32
+ * @param response - The HTTP response containing the error details.
33
+ * @returns An `ApiErrorResponse` object with the mapped error details.
34
+ */
35
+ private handleErrorResponse;
36
+ }
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __importDefault = (this && this.__importDefault) || function (mod) {
12
+ return (mod && mod.__esModule) ? mod : { "default": mod };
13
+ };
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ const mapping_1 = __importDefault(require("../../mapping/mapping"));
16
+ /**
17
+ * Service class for handling PSC (Person with Significant Control) extension-related operations.
18
+ * This class provides methods to interact with the PSC extensions API, including creating, retrieving,
19
+ * and checking the validation of PSC extensions request
20
+ */
21
+ class PscExtensionService {
22
+ constructor(client) {
23
+ this.client = client;
24
+ }
25
+ /**
26
+ * Submits a new PSC extension for a given transaction.
27
+ *
28
+ * @param transactionId - The unique identifier of the transaction.
29
+ * @param pscExtension - The PSC extension data to be submitted.
30
+ * @returns A promise that resolves to either:
31
+ * - A `Resource<PscExtension>` object containing the created PSC extension details.
32
+ * - An `ApiErrorResponse` object if an error occurs during the request.
33
+ */
34
+ postPscExtension(transactionId, pscExtension, headers) {
35
+ return __awaiter(this, void 0, void 0, function* () {
36
+ const resourceUri = `/transactions/${transactionId}/persons-with-significant-control-extensions`;
37
+ const pscExtensionResource = mapping_1.default.snakeCaseKeys(pscExtension);
38
+ const response = yield this.client.httpPost(resourceUri, pscExtensionResource, headers);
39
+ if (response.error) {
40
+ return this.handleErrorResponse(response);
41
+ }
42
+ return this.populateFrontEndResource(response);
43
+ });
44
+ }
45
+ /**
46
+ * Maps the response body to a front-end resource format with camelCase keys.
47
+ *
48
+ * @param response - The HTTP response received from the API.
49
+ * @returns A `Resource<PscExtension>` object containing the mapped resource.
50
+ */
51
+ populateFrontEndResource(response) {
52
+ const frontEndResource = {
53
+ httpStatusCode: response.status,
54
+ resource: response.body
55
+ };
56
+ const body = response.body;
57
+ frontEndResource.resource = mapping_1.default.camelCaseKeys(body);
58
+ return frontEndResource;
59
+ }
60
+ /**
61
+ * Handles error responses from the API by mapping error details to camelCase keys.
62
+ *
63
+ * @param response - The HTTP response containing the error details.
64
+ * @returns An `ApiErrorResponse` object with the mapped error details.
65
+ */
66
+ handleErrorResponse(response) {
67
+ return {
68
+ httpStatusCode: response.status,
69
+ errors: [mapping_1.default.camelCaseKeys(response.error)]
70
+ };
71
+ }
72
+ }
73
+ exports.default = PscExtensionService;
74
+ //# sourceMappingURL=service.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc-extensions-link/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAIA,oEAA4C;AAG5C;;;;GAIG;AACH,MAAqB,mBAAmB;IACpC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAErD;;;;;;;;OAQG;IACU,gBAAgB,CAAE,aAAqB,EAAE,YAA8B,EAAE,OAAiB;;YACnG,MAAM,WAAW,GAAG,iBAAiB,aAAa,8CAA8C,CAAC;YACjG,MAAM,oBAAoB,GAAG,iBAAO,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YACjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;YAExF,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;aAC7C;YAED,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAED;;;;;OAKG;IACK,wBAAwB,CAAE,QAAsB;QACpD,MAAM,gBAAgB,GAA2B;YAC7C,cAAc,EAAE,QAAQ,CAAC,MAAM;YAC/B,QAAQ,EAAE,QAAQ,CAAC,IAAoB;SAC1C,CAAC;QAEF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA4C,CAAC;QACnE,gBAAgB,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAe,IAAI,CAAC,CAAC;QAEtE,OAAO,gBAAgB,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACK,mBAAmB,CAAE,QAAsB;QAC/C,OAAO;YACH,cAAc,EAAE,QAAQ,CAAC,MAAM;YAC/B,MAAM,EAAE,CAAC,iBAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAClD,CAAC;IACN,CAAC;CACJ;AAtDD,sCAsDC"}
@@ -0,0 +1,150 @@
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
+ }
16
+ export interface PersonWithSignificantControl {
17
+ address: Address;
18
+ countryOfResidence: string;
19
+ dateOfBirth: DateOfBirth;
20
+ ceasedOn?: string;
21
+ etag: string;
22
+ links: ItemLinks;
23
+ name: string;
24
+ nameElements: NameElements;
25
+ nationality: string;
26
+ naturesOfControl: string[];
27
+ notifiedOn: string;
28
+ isSanctioned?: boolean;
29
+ kind?: string;
30
+ }
31
+ export interface AddressResource {
32
+ address_line_1: string;
33
+ address_line_2?: string;
34
+ careOf?: string;
35
+ locality: string;
36
+ poBox?: string;
37
+ postal_code?: string;
38
+ premises?: string;
39
+ region?: string;
40
+ }
41
+ export interface Address {
42
+ addressLine1: string;
43
+ addressLine2?: string;
44
+ careOf?: string;
45
+ locality: string;
46
+ poBox?: string;
47
+ postalCode?: string;
48
+ premises?: string;
49
+ region?: string;
50
+ }
51
+ export interface DateOfBirthResource {
52
+ day?: string;
53
+ month: string;
54
+ year: string;
55
+ }
56
+ export interface DateOfBirth {
57
+ day?: string;
58
+ month: string;
59
+ year: string;
60
+ }
61
+ export interface ResultsLinksResource {
62
+ self: string;
63
+ persons_with_significant_control_statements_list?: string;
64
+ }
65
+ export interface ResultsLinks {
66
+ self: string;
67
+ personsWithSignificantControlStatementsList?: string;
68
+ }
69
+ export interface ItemLinksResource {
70
+ self: string;
71
+ statement?: string;
72
+ }
73
+ export interface ItemLinks {
74
+ self: string;
75
+ statement?: string;
76
+ }
77
+ export interface LinksResource {
78
+ self: string;
79
+ validation_status: string;
80
+ }
81
+ export interface Links {
82
+ self: string;
83
+ validationStatus: string;
84
+ }
85
+ export interface NameElementsResource {
86
+ forename?: string;
87
+ other_forenames?: string;
88
+ middlename?: string;
89
+ surname?: string;
90
+ title?: string;
91
+ }
92
+ export interface NameElements {
93
+ title?: string;
94
+ forename?: string;
95
+ otherForenames?: string;
96
+ middleName?: string;
97
+ surname: string;
98
+ }
99
+ export interface PscExtensionResource {
100
+ created_at: Date;
101
+ updated_at: Date;
102
+ links: LinksResource;
103
+ data: PscExtensionDataResource;
104
+ }
105
+ export interface PscExtensionDataResource {
106
+ company_number?: string;
107
+ psc_notification_id?: string;
108
+ extensionDetails?: ExtensionDetailsResource;
109
+ }
110
+ export interface PscExtension {
111
+ createdAt: Date;
112
+ updatedAt: Date;
113
+ links: Links;
114
+ data: PscExtensionData;
115
+ }
116
+ export interface PscExtensionData {
117
+ companyNumber?: string;
118
+ pscNotificationId?: string;
119
+ extensionDetails?: ExtensionDetails;
120
+ }
121
+ export interface ExtensionDetailsResource {
122
+ extensionReason?: string;
123
+ nameMismatchReason?: string;
124
+ extensionRequestDate?: string;
125
+ }
126
+ export interface ExtensionDetails {
127
+ extensionReason?: string;
128
+ nameMismatchReason?: string;
129
+ extensionRequestDate?: string;
130
+ }
131
+ export interface ValidationStatusError {
132
+ error: string;
133
+ location: string;
134
+ type?: string;
135
+ locationType: string;
136
+ }
137
+ export interface ValidationStatusResponse {
138
+ errors: ValidationStatusError[];
139
+ isValid?: boolean;
140
+ }
141
+ export interface ValidationStatusErrorResource {
142
+ error: string;
143
+ location: string;
144
+ location_type: string;
145
+ type?: string;
146
+ }
147
+ export interface ValidationStatusResponseResource {
148
+ errors: ValidationStatusErrorResource[];
149
+ is_valid?: boolean;
150
+ }
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ ;
4
+ ;
5
+ ;
6
+ ;
7
+ ;
8
+ ;
9
+ ;
10
+ ;
11
+ ;
12
+ ;
13
+ ;
14
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/psc-extensions-link/types.ts"],"names":[],"mappings":";;AAcC,CAAC;AAgBD,CAAC;AAWD,CAAC;AAWD,CAAC;AAMD,CAAC;AAMD,CAAC;AAKD,CAAC;AAKD,CAAC;AAKD,CAAC;AAKD,CAAC;AA0BD,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companieshouse/api-sdk-node",
3
- "version": "2.0.301",
3
+ "version": "2.0.303",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [