@companieshouse/api-sdk-node 2.0.103 → 2.0.105

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
@@ -6,6 +6,7 @@ import CompanyPscService from "./services/company-psc/service";
6
6
  import { LateFilingPenaltyService } from "./services/lfp";
7
7
  import { BasketService, CertificateService, CertifiedCopiesService, CheckoutService, MidService, OrderService } from "./services/order/";
8
8
  import { PaymentService } from "./services/payment/";
9
+ import * as BankruptOfficer from "./services/bankrupt-officer";
9
10
  import CompanyFilingHistoryService from "./services/company-filing-history/service";
10
11
  import { RefreshTokenService } from "./services/refresh-token";
11
12
  import AdvancedSearchService from "./services/search/advanced-search/service";
@@ -31,6 +32,7 @@ export default class ApiClient {
31
32
  readonly accountClient: IHttpClient;
32
33
  clientType: ClientType;
33
34
  readonly lateFilingPenalties: LateFilingPenaltyService;
35
+ readonly BankruptOfficer: BankruptOfficer.BadosService;
34
36
  readonly companyOfficers: CompanyOfficersService;
35
37
  readonly companyFilingHistory: CompanyFilingHistoryService;
36
38
  readonly companyProfile: CompanyProfileService;
@@ -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,2FAAwF;AAGxF;;GAEG;AACH,MAAqB,SAAS;IA+B5B,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;IACtF,CAAC;CACF;AAhED,4BAgEC"}
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;AAErD,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;AAGxF;;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;IACtF,CAAC;CACF;AAjED,4BAiEC"}
@@ -0,0 +1 @@
1
+ export { BadosService } from "./scottish";
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BadosService = void 0;
4
+ var scottish_1 = require("./scottish");
5
+ Object.defineProperty(exports, "BadosService", { enumerable: true, get: function () { return scottish_1.BadosService; } });
6
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/bankrupt-officer/index.ts"],"names":[],"mappings":";;;AAAA,uCAA0C;AAAjC,wGAAA,YAAY,OAAA"}
@@ -0,0 +1,2 @@
1
+ export * from "./types";
2
+ export { default as BadosService } 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.BadosService = void 0;
17
+ __exportStar(require("./types"), exports);
18
+ var service_1 = require("./service");
19
+ Object.defineProperty(exports, "BadosService", { 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/bankrupt-officer/scottish/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,qCAAoD;AAA3C,wHAAA,OAAO,OAAgB"}
@@ -0,0 +1,9 @@
1
+ import { IHttpClient } from "../../../http";
2
+ import Resource from "../../resource";
3
+ import { FullBankruptOfficer, BankruptOfficerSearchResults, BankruptOfficerSearchQuery } from "./types";
4
+ export default class {
5
+ private readonly client;
6
+ constructor(client: IHttpClient);
7
+ getBankruptOfficer(ephemeralKey: string): Promise<Resource<FullBankruptOfficer>>;
8
+ getBankruptOfficers(bankruptOfficerSearchQuery: BankruptOfficerSearchQuery): Promise<Resource<BankruptOfficerSearchResults>>;
9
+ }
@@ -0,0 +1,50 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ const BANKRUPT_OFFICER_SEARCH_API_URL = "/internal/officer-search/scottish-bankrupt-officers";
13
+ class default_1 {
14
+ constructor(client) {
15
+ this.client = client;
16
+ }
17
+ getBankruptOfficer(ephemeralKey) {
18
+ return __awaiter(this, void 0, void 0, function* () {
19
+ const resp = yield this.client.httpGet(`${BANKRUPT_OFFICER_SEARCH_API_URL}/${ephemeralKey}`);
20
+ const resource = {
21
+ httpStatusCode: resp.status
22
+ };
23
+ if (resp.error) {
24
+ return resource;
25
+ }
26
+ resource.resource = Object.assign({}, resp.body);
27
+ return resource;
28
+ });
29
+ }
30
+ getBankruptOfficers(bankruptOfficerSearchQuery) {
31
+ return __awaiter(this, void 0, void 0, function* () {
32
+ const resp = yield this.client.httpPost(BANKRUPT_OFFICER_SEARCH_API_URL, bankruptOfficerSearchQuery);
33
+ const resource = {
34
+ httpStatusCode: resp.status
35
+ };
36
+ if (resp.error) {
37
+ return resource;
38
+ }
39
+ resource.resource = {
40
+ itemsPerPage: resp.body.itemsPerPage,
41
+ startIndex: resp.body.startIndex,
42
+ totalResults: resp.body.totalResults,
43
+ items: [...resp.body.items]
44
+ };
45
+ return resource;
46
+ });
47
+ }
48
+ }
49
+ exports.default = default_1;
50
+ //# sourceMappingURL=service.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../../src/services/bankrupt-officer/scottish/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAQA,MAAM,+BAA+B,GAAG,qDAAqD,CAAC;AAE9F;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,kBAAkB,CAAE,YAAoB;;YACjD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,+BAA+B,IAAI,YAAY,EAAE,CAAC,CAAC;YAE7F,MAAM,QAAQ,GAAkC;gBAC5C,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,QAAQ,CAAC,QAAQ,qBAAQ,IAAI,CAAC,IAAI,CAAE,CAAA;YAEpC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEY,mBAAmB,CAAE,0BAAsD;;YACpF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,+BAA+B,EAAE,0BAA0B,CAAC,CAAC;YAErG,MAAM,QAAQ,GAA2C;gBACrD,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,QAAQ,CAAC,QAAQ,GAAG;gBAChB,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY;gBACpC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;gBAChC,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY;gBACpC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;aAC9B,CAAA;YAED,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AAvCD,4BAuCC"}
@@ -0,0 +1,43 @@
1
+ export interface Address {
2
+ addressLine1?: string;
3
+ addressLine2?: string;
4
+ addressLine3?: string;
5
+ town?: string;
6
+ county?: string;
7
+ postcode?: string;
8
+ }
9
+ export interface BankruptOfficer extends Address {
10
+ ephemeralKey: string;
11
+ forename1?: string;
12
+ forename2?: string;
13
+ alias?: string;
14
+ surname?: string;
15
+ dateOfBirth?: string;
16
+ debtorDischargeDate?: string;
17
+ caseType?: string;
18
+ }
19
+ export interface FullBankruptOfficer extends BankruptOfficer {
20
+ caseReference?: string;
21
+ bankruptcyType?: string;
22
+ startDate?: string;
23
+ trusteeDischargeDate?: string;
24
+ }
25
+ export interface BankruptOfficerSearchQuery {
26
+ startIndex: number;
27
+ itemsPerPage: number;
28
+ filters: BankruptOfficerSearchFilters;
29
+ }
30
+ export interface BankruptOfficerSearchFilters {
31
+ forename1?: string;
32
+ surname?: string;
33
+ alias?: string;
34
+ fromDateOfBirth?: string;
35
+ toDateOfBirth?: string;
36
+ postcode?: string;
37
+ }
38
+ export interface BankruptOfficerSearchResults {
39
+ itemsPerPage: number;
40
+ startIndex: number;
41
+ totalResults: number;
42
+ items: BankruptOfficer[];
43
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/services/bankrupt-officer/scottish/types.ts"],"names":[],"mappings":""}
@@ -1,5 +1,5 @@
1
1
  import { IHttpClient } from "../../http";
2
- import { HttpStatusCode, OverseasEntity, OverseasEntityCreated, OverseasEntityExtraDetails } from "./types";
2
+ import { BeneficialOwnersPrivateData, HttpStatusCode, OverseasEntity, OverseasEntityCreated, OverseasEntityExtraDetails, ManagingOfficersPrivateData } from "./types";
3
3
  import Resource, { ApiErrorResponse } from "../resource";
4
4
  export default class OverseasEntityService {
5
5
  private readonly client;
@@ -8,4 +8,11 @@ export default class OverseasEntityService {
8
8
  getOverseasEntityDetails(transactionId: string, overseasEntityId: string): Promise<Resource<OverseasEntityExtraDetails> | ApiErrorResponse>;
9
9
  postOverseasEntity(transactionId: string, body: OverseasEntity, isSaveAndResumeFeatureActive?: boolean): Promise<Resource<OverseasEntityCreated> | ApiErrorResponse>;
10
10
  putOverseasEntity(transactionId: string, overseasEntityId: string, body: OverseasEntity): Promise<Resource<HttpStatusCode> | ApiErrorResponse>;
11
+ /**
12
+ * Get private beneficial owner data for an overseas entity
13
+ * @param transactionId of the entity
14
+ * @param overseasEntityId of the entity
15
+ */
16
+ getBeneficialOwnerPrivateData(transactionId: string, overseasEntityId: string): Promise<Resource<BeneficialOwnersPrivateData> | ApiErrorResponse>;
17
+ getManagingOfficersPrivateData(transactionId: string, overseasEntityId: string): Promise<Resource<ManagingOfficersPrivateData> | ApiErrorResponse>;
11
18
  }
@@ -8,8 +8,12 @@ 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 });
12
15
  const mapping_1 = require("./mapping");
16
+ const mapping_2 = __importDefault(require("../../mapping/mapping"));
13
17
  class OverseasEntityService {
14
18
  constructor(client) {
15
19
  this.client = client;
@@ -80,6 +84,45 @@ class OverseasEntityService {
80
84
  return { httpStatusCode: resp.status };
81
85
  });
82
86
  }
87
+ /**
88
+ * Get private beneficial owner data for an overseas entity
89
+ * @param transactionId of the entity
90
+ * @param overseasEntityId of the entity
91
+ */
92
+ getBeneficialOwnerPrivateData(transactionId, overseasEntityId) {
93
+ return __awaiter(this, void 0, void 0, function* () {
94
+ const URL = `private/transactions/${transactionId}/overseas-entity/${overseasEntityId}/beneficial-owners`;
95
+ const response = yield this.client.httpGet(URL);
96
+ if (response.error) {
97
+ return {
98
+ httpStatusCode: response.status,
99
+ errors: [response.error]
100
+ };
101
+ }
102
+ const resource = {
103
+ httpStatusCode: response.status,
104
+ resource: mapping_2.default.camelCaseKeys(response.body)
105
+ };
106
+ return resource;
107
+ });
108
+ }
109
+ getManagingOfficersPrivateData(transactionId, overseasEntityId) {
110
+ return __awaiter(this, void 0, void 0, function* () {
111
+ const URL = `private/transactions/${transactionId}/overseas-entity/${overseasEntityId}/managing-officers`;
112
+ const response = yield this.client.httpGet(URL);
113
+ if (response.error) {
114
+ return {
115
+ httpStatusCode: response.status,
116
+ errors: [response.error]
117
+ };
118
+ }
119
+ const resource = {
120
+ httpStatusCode: response.status,
121
+ resource: mapping_2.default.camelCaseKeys(response.body)
122
+ };
123
+ return resource;
124
+ });
125
+ }
83
126
  }
84
127
  exports.default = OverseasEntityService;
85
128
  //# sourceMappingURL=service.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAQA,uCAAwG;AAExG,MAAqB,qBAAqB;IACtC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,iBAAiB,CAAE,aAAqB,EAAE,gBAAwB;;YAC3E,MAAM,GAAG,GAAG,gBAAgB,aAAa,oBAAoB,gBAAgB,EAAE,CAAA;YAC/E,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAC;aACL;YAED,MAAM,QAAQ,GAA6B;gBACvC,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,mCAAyB,CAAC,QAAQ,CAAC,IAAI,CAAC;aACrD,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEY,wBAAwB,CAAE,aAAqB,EAAE,gBAAwB;;YAClF,MAAM,GAAG,GAAG,wBAAwB,aAAa,oBAAoB,gBAAgB,UAAU,CAAA;YAC/F,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAC;aACL;YAED,MAAM,QAAQ,GAAyC;gBACnD,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,uCAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC;aACzD,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEY,kBAAkB,CAC3B,aAAqB,EACrB,IAAoB,EACpB,+BAAwC,KAAK;;YAE7C,MAAM,GAAG,GAAG,CAAC,4BAA4B,CAAC;gBACtC,CAAC,CAAC,iBAAiB,aAAa,wBAAwB;gBACxD,CAAC,CAAC,iBAAiB,aAAa,kBAAkB,CAAC;YACvD,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,2BAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;YAExF,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAC;aACL;YAED,MAAM,QAAQ,GAAoC;gBAC9C,cAAc,EAAE,QAAQ,CAAC,MAAM;aAClC,CAAC;YAEF,QAAQ,CAAC,QAAQ,qBAAQ,QAAQ,CAAC,IAAI,CAAE,CAAC;YACzC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEY,iBAAiB,CAAE,aAAqB,EAAE,gBAAwB,EAAE,IAAoB;;YACjG,MAAM,GAAG,GAAG,gBAAgB,aAAa,oBAAoB,gBAAgB,EAAE,CAAA;YAE/E,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,2BAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;YAErE,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QAC3C,CAAC;KAAA;CACJ;AAhFD,wCAgFC"}
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAYA,uCAAwG;AACxG,oEAA4C;AAE5C,MAAqB,qBAAqB;IACtC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,iBAAiB,CAAE,aAAqB,EAAE,gBAAwB;;YAC3E,MAAM,GAAG,GAAG,gBAAgB,aAAa,oBAAoB,gBAAgB,EAAE,CAAA;YAC/E,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAC;aACL;YAED,MAAM,QAAQ,GAA6B;gBACvC,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,mCAAyB,CAAC,QAAQ,CAAC,IAAI,CAAC;aACrD,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEY,wBAAwB,CAAE,aAAqB,EAAE,gBAAwB;;YAClF,MAAM,GAAG,GAAG,wBAAwB,aAAa,oBAAoB,gBAAgB,UAAU,CAAA;YAC/F,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAC;aACL;YAED,MAAM,QAAQ,GAAyC;gBACnD,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,uCAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC;aACzD,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEY,kBAAkB,CAC3B,aAAqB,EACrB,IAAoB,EACpB,+BAAwC,KAAK;;YAE7C,MAAM,GAAG,GAAG,CAAC,4BAA4B,CAAC;gBACtC,CAAC,CAAC,iBAAiB,aAAa,wBAAwB;gBACxD,CAAC,CAAC,iBAAiB,aAAa,kBAAkB,CAAC;YACvD,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,2BAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;YAExF,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAC;aACL;YAED,MAAM,QAAQ,GAAoC;gBAC9C,cAAc,EAAE,QAAQ,CAAC,MAAM;aAClC,CAAC;YAEF,QAAQ,CAAC,QAAQ,qBAAQ,QAAQ,CAAC,IAAI,CAAE,CAAC;YACzC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEY,iBAAiB,CAAE,aAAqB,EAAE,gBAAwB,EAAE,IAAoB;;YACjG,MAAM,GAAG,GAAG,gBAAgB,aAAa,oBAAoB,gBAAgB,EAAE,CAAA;YAE/E,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,2BAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;YAErE,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QAC3C,CAAC;KAAA;IAED;;;;OAIG;IACU,6BAA6B,CAAE,aAAqB,EAAE,gBAAwB;;YACvF,MAAM,GAAG,GAAG,wBAAwB,aAAa,oBAAoB,gBAAgB,oBAAoB,CAAA;YACzG,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAC;aACL;YAED,MAAM,QAAQ,GAA0C;gBACpD,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,iBAAO,CAAC,aAAa,CAA8B,QAAQ,CAAC,IAA2C,CAAC;aACrH,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEY,8BAA8B,CAAE,aAAqB,EAAE,gBAAwB;;YACxF,MAAM,GAAG,GAAG,wBAAwB,aAAa,oBAAoB,gBAAgB,oBAAoB,CAAC;YAC1G,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAC;aACL;YAED,MAAM,QAAQ,GAA0C;gBACpD,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,iBAAO,CAAC,aAAa,CAA8B,QAAQ,CAAC,IAA2C,CAAC;aACrH,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AA3HD,wCA2HC"}
@@ -200,6 +200,28 @@ export interface BeneficialOwnerGovernmentOrPublicAuthorityResource {
200
200
  beneficial_owner_nature_of_control_types?: NatureOfControlType[];
201
201
  non_legal_firm_members_nature_of_control_types?: NatureOfControlType[];
202
202
  }
203
+ export interface BeneficialOwnerPrivateDataResource {
204
+ hashed_id?: string;
205
+ date_became_registrable?: string;
206
+ date_of_birth?: string;
207
+ is_service_address_same_as_usual_address?: string;
208
+ usual_residential_address?: PrivateAddressResource;
209
+ principal_address?: PrivateAddressResource;
210
+ }
211
+ export interface BeneficialOwnersPrivateDataResource {
212
+ bo_private_data: BeneficialOwnerPrivateDataResource[];
213
+ }
214
+ export interface BeneficialOwnersPrivateData {
215
+ boPrivateData: BeneficialOwnerPrivateData[];
216
+ }
217
+ export interface BeneficialOwnerPrivateData {
218
+ hashedId?: string;
219
+ dateBecameRegistrable?: string;
220
+ dateOfBirth?: string;
221
+ isServiceAddressSameAsUsualAddress?: string;
222
+ usualResidentialAddress?: PrivateAddress;
223
+ principalAddress?: PrivateAddress;
224
+ }
203
225
  export interface ManagingOfficerIndividual {
204
226
  ch_reference?: string;
205
227
  first_name?: string;
@@ -288,6 +310,52 @@ export interface ManagingOfficerCorporateResource {
288
310
  start_date?: string;
289
311
  resigned_on?: string;
290
312
  }
313
+ export interface ManagingOfficerDataResource {
314
+ managingOfficerAppointmentId?: string;
315
+ residential_address?: PrivateAddressResource;
316
+ principal_address?: PrivateAddressResource;
317
+ date_of_birth?: string;
318
+ contact_name_full?: string;
319
+ contact_email_address?: string;
320
+ hashed_id?: string;
321
+ }
322
+ export interface PrivateAddressResource {
323
+ address_line_1?: string;
324
+ address_line_2?: string;
325
+ care_of?: string;
326
+ country?: string;
327
+ locality?: string;
328
+ po_box?: string;
329
+ postal_code?: string;
330
+ premises?: string;
331
+ region?: string;
332
+ }
333
+ export interface ManagingOfficersPrivateDataResource {
334
+ mo_private_data: ManagingOfficerDataResource[];
335
+ }
336
+ export interface ManagingOfficersPrivateData {
337
+ moPrivateData: ManagingOfficerData[];
338
+ }
339
+ export interface ManagingOfficerData {
340
+ managingOfficerAppointmentId?: string;
341
+ residentialAddress?: PrivateAddress;
342
+ principalAddress?: PrivateAddress;
343
+ dateOfBirth?: string;
344
+ contactNameFull?: string;
345
+ contactEmailAddress?: string;
346
+ hashedId?: string;
347
+ }
348
+ export interface PrivateAddress {
349
+ addressLine1?: string;
350
+ addressLine2?: string;
351
+ careOf?: string;
352
+ country?: string;
353
+ locality?: string;
354
+ poBox?: string;
355
+ postalCode?: string;
356
+ premises?: string;
357
+ region?: string;
358
+ }
291
359
  export interface Trust {
292
360
  trust_id: string;
293
361
  trust_name: string;
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAofH,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,6CAAM,CAAA;IACN,+CAAO,CAAA;AACX,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAQD,IAAY,6BAIX;AAJD,WAAY,6BAA6B;IACrC,0FAAyD,CAAA;IACzD,4FAA2D,CAAA;IAC3D,oEAAmC,CAAA;AACvC,CAAC,EAJW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAIxC;AAED,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC3B,8EAAuD,CAAA;IACvD,4FAAqE,CAAA;IACrE,gHAAyF,CAAA;IACzF,4FAAqE,CAAA;AACzE,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAkkBH,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,6CAAM,CAAA;IACN,+CAAO,CAAA;AACX,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAQD,IAAY,6BAIX;AAJD,WAAY,6BAA6B;IACrC,0FAAyD,CAAA;IACzD,4FAA2D,CAAA;IAC3D,oEAAmC,CAAA;AACvC,CAAC,EAJW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAIxC;AAED,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC3B,8EAAuD,CAAA;IACvD,4FAAqE,CAAA;IACrE,gHAAyF,CAAA;IACzF,4FAAqE,CAAA;AACzE,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companieshouse/api-sdk-node",
3
- "version": "2.0.103",
3
+ "version": "2.0.105",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [