@companieshouse/api-sdk-node 2.0.59 → 2.0.61

package/dist/client.d.ts

@@ -20,6 +20,7 @@ import { OverseasEntityService } from "./services/overseas-entities";
 import { CheckoutSearchService } from "./services/order/search/service";
 import OrderItemService from "./services/order/order-item/service";
 import CheckoutItemService from "./services/order/checkout-item/service";
+import OfficerFilingService from "./services/officer-filing/service";
 /**
  * ApiClient is the class that all service objects hang off.
  */
@@ -52,5 +53,6 @@ export default class ApiClient {
     readonly pscDiscrepancyReport: PSCDiscrepanciesReportService;
     readonly transaction: TransactionService;
     readonly overseasEntity: OverseasEntityService;
+    readonly officerFiling: OfficerFilingService;
     constructor(apiClient: IHttpClient, accountClient: IHttpClient);
 }

package/dist/client.js

@@ -24,6 +24,7 @@ const overseas_entities_1 = require("./services/overseas-entities");
 const service_13 = require("./services/order/search/service");
 const service_14 = __importDefault(require("./services/order/order-item/service"));
 const service_15 = __importDefault(require("./services/order/checkout-item/service"));
+const service_16 = __importDefault(require("./services/officer-filing/service"));
 /**
  * ApiClient is the class that all service objects hang off.
  */
@@ -48,6 +49,7 @@ class ApiClient {
         this.checkoutItem = new service_15.default(apiClient);
         this.order = new order_1.OrderService(apiClient);
         this.orderItem = new service_14.default(apiClient);
+        this.officerFiling = new service_16.default(apiClient);
         this.checkoutSearchService = new service_13.CheckoutSearchService(apiClient);
         this.mid = new order_1.MidService(apiClient);
         this.alphabeticalSearch = new service_7.default(apiClient);

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAAyI;AACzI,iDAAqD;AACrD,mFAA2E;AAC3E,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;AAEzE;;GAEG;AACH,MAAqB,SAAS;IA4B5B,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,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,uBAAuB,GAAG,IAAI,iBAAuB,CAAC,SAAS,CAAC,CAAC;QACtE,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,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;IACzD,CAAC;CACF;AA3DD,4BA2DC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAAyI;AACzI,iDAAqD;AACrD,mFAA2E;AAC3E,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;AAErE;;GAEG;AACH,MAAqB,SAAS;IA6B5B,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,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,uBAAuB,GAAG,IAAI,iBAAuB,CAAC,SAAS,CAAC,CAAC;QACtE,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;IACzD,CAAC;CACF;AA7DD,4BA6DC"}

package/dist/services/officer-filing/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export { default as OfficerFilingService } from "./service";

package/dist/services/officer-filing/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OfficerFilingService = void 0;
+__exportStar(require("./types"), exports);
+var service_1 = require("./service");
+Object.defineProperty(exports, "OfficerFilingService", { enumerable: true, get: function () { return __importDefault(service_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/services/officer-filing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/officer-filing/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,qCAA4D;AAAnD,gIAAA,OAAO,OAAwB"}

package/dist/services/officer-filing/service.d.ts

@@ -0,0 +1,12 @@
+import { ActiveOfficerDetails } from "./types";
+import { IHttpClient } from "../../http";
+import Resource, { ApiErrorResponse } from "../resource";
+export default class {
+    private readonly client;
+    constructor(client: IHttpClient);
+    getListActiveDirectorDetails(transactionId: string): Promise<Resource<ActiveOfficerDetails[]> | ApiErrorResponse>;
+    private mapToListActiveOfficerDetails;
+    private mapToAddress;
+    private getOfficerFilingUrlIncTransactionId;
+    private getPrivateOfficerFilingUrlIncTransactionId;
+}

package/dist/services/officer-filing/service.js

@@ -0,0 +1,57 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+class default_1 {
+    constructor(client) {
+        this.client = client;
+    }
+    getListActiveDirectorDetails(transactionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `${this.getPrivateOfficerFilingUrlIncTransactionId(transactionId)}/active-directors-details`;
+            const resp = yield this.client.httpGet(url);
+            if (resp.status >= 400) {
+                return { httpStatusCode: resp.status, errors: [resp.error] };
+            }
+            const resource = { httpStatusCode: resp.status };
+            resource.resource = this.mapToListActiveOfficerDetails(resp.body);
+            return resource;
+        });
+    }
+    mapToListActiveOfficerDetails(officerResourceList) {
+        const officerList = [];
+        for (let index = 0; index < officerResourceList.length; index++) {
+            const officerResource = officerResourceList[index];
+            officerList[index] = Object.assign(Object.assign(Object.assign({ foreName1: officerResource.fore_name_1, foreName2: officerResource.fore_name_2, surname: officerResource.surname, occupation: officerResource.occupation, nationality: officerResource.nationality, dateOfBirth: officerResource.date_of_birth, dateOfAppointment: officerResource.date_of_appointment, countryOfResidence: officerResource.country_of_residence }, (officerResource.service_address && { serviceAddress: this.mapToAddress(officerResource.service_address) })), (officerResource.residential_address && { residentialAddress: this.mapToAddress(officerResource.residential_address) })), { isCorporate: officerResource.is_corporate, role: officerResource.role, placeRegistered: officerResource.place_registered, registrationNumber: officerResource.registration_number, lawGoverned: officerResource.law_governed, legalForm: officerResource.legal_form, identificationType: officerResource.identification_type });
+        }
+        return officerList;
+    }
+    mapToAddress(addressResource) {
+        return {
+            addressLine1: addressResource.address_line_1,
+            addressLine2: addressResource.address_line_2,
+            careOf: addressResource.care_of,
+            country: addressResource.country,
+            locality: addressResource.locality,
+            poBox: addressResource.po_box,
+            postalCode: addressResource.postal_code,
+            premises: addressResource.premises,
+            region: addressResource.region
+        };
+    }
+    getOfficerFilingUrlIncTransactionId(transactionId) {
+        return `/transactions/${transactionId}/officers`;
+    }
+    getPrivateOfficerFilingUrlIncTransactionId(transactionId) {
+        return `private/transactions/${transactionId}/officers`;
+    }
+}
+exports.default = default_1;
+//# sourceMappingURL=service.js.map

package/dist/services/officer-filing/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/officer-filing/service.ts"],"names":[],"mappings":";;;;;;;;;;;AASA;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,4BAA4B,CAAE,aAAqB;;YAC5D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,0CAA0C,CAAC,aAAa,CAAC,2BAA2B,CAAC;YACzG,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,GAAqC,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YAEnF,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAElE,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEO,6BAA6B,CAAE,mBAAmD;QACtF,MAAM,WAAW,GAA2B,EAAE,CAAC;QAC/C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAC7D,MAAM,eAAe,GAAiC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YACjF,WAAW,CAAC,KAAK,CAAC,+CACd,SAAS,EAAE,eAAe,CAAC,WAAW,EACtC,SAAS,EAAE,eAAe,CAAC,WAAW,EACtC,OAAO,EAAE,eAAe,CAAC,OAAO,EAChC,UAAU,EAAE,eAAe,CAAC,UAAU,EACtC,WAAW,EAAE,eAAe,CAAC,WAAW,EACxC,WAAW,EAAE,eAAe,CAAC,aAAa,EAC1C,iBAAiB,EAAE,eAAe,CAAC,mBAAmB,EACtD,kBAAkB,EAAE,eAAe,CAAC,oBAAoB,IACrD,CAAC,eAAe,CAAC,eAAe,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,eAAe,CAAC,EAAE,CAAC,GAC3G,CAAC,eAAe,CAAC,mBAAmB,IAAI,EAAE,kBAAkB,EAAE,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,mBAAmB,CAAC,EAAE,CAAC,KAC1H,WAAW,EAAE,eAAe,CAAC,YAAY,EACzC,IAAI,EAAE,eAAe,CAAC,IAAI,EAC1B,eAAe,EAAE,eAAe,CAAC,gBAAgB,EACjD,kBAAkB,EAAE,eAAe,CAAC,mBAAmB,EACvD,WAAW,EAAE,eAAe,CAAC,YAAY,EACzC,SAAS,EAAE,eAAe,CAAC,UAAU,EACrC,kBAAkB,EAAE,eAAe,CAAC,mBAAmB,GAC1D,CAAA;SACJ;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;IAEO,YAAY,CAAE,eAAgC;QAClD,OAAO;YACH,YAAY,EAAE,eAAe,CAAC,cAAc;YAC5C,YAAY,EAAE,eAAe,CAAC,cAAc;YAC5C,MAAM,EAAE,eAAe,CAAC,OAAO;YAC/B,OAAO,EAAE,eAAe,CAAC,OAAO;YAChC,QAAQ,EAAE,eAAe,CAAC,QAAQ;YAClC,KAAK,EAAE,eAAe,CAAC,MAAM;YAC7B,UAAU,EAAE,eAAe,CAAC,WAAW;YACvC,QAAQ,EAAE,eAAe,CAAC,QAAQ;YAClC,MAAM,EAAE,eAAe,CAAC,MAAM;SACjC,CAAA;IACL,CAAC;IAEO,mCAAmC,CAAE,aAAqB;QAC9D,OAAO,iBAAiB,aAAa,WAAW,CAAC;IACrD,CAAC;IAEO,0CAA0C,CAAE,aAAqB;QACrE,OAAO,wBAAwB,aAAa,WAAW,CAAC;IAC5D,CAAC;CACJ;AAlED,4BAkEC"}

package/dist/services/officer-filing/types.d.ts

@@ -0,0 +1,65 @@
+export interface Tm01Submission {
+    resigned_on: Date;
+    reference_etag: String;
+    reference_appointment_id: String;
+}
+export interface ActiveOfficerDetails {
+    foreName1: string;
+    foreName2?: string;
+    surname: string;
+    occupation: string;
+    nationality: string;
+    dateOfBirth: string;
+    dateOfAppointment: string;
+    countryOfResidence: string;
+    serviceAddress: Address;
+    residentialAddress: Address;
+    isCorporate: boolean;
+    role: string;
+    placeRegistered?: string;
+    registrationNumber?: string;
+    lawGoverned?: string;
+    legalForm?: string;
+    identificationType?: string;
+}
+export interface ActiveOfficerDetailsResource {
+    fore_name_1: string;
+    fore_name_2?: string;
+    surname: string;
+    occupation: string;
+    nationality: string;
+    date_of_birth: string;
+    date_of_appointment: string;
+    country_of_residence: string;
+    service_address: AddressResource;
+    residential_address: AddressResource;
+    is_corporate: boolean;
+    role: string;
+    place_registered?: string;
+    registration_number?: string;
+    law_governed?: string;
+    legal_form?: string;
+    identification_type?: string;
+}
+export interface Address {
+    addressLine1?: string;
+    addressLine2?: string;
+    careOf?: string;
+    country?: string;
+    locality?: string;
+    poBox?: string;
+    postalCode?: string;
+    premises?: string;
+    region?: string;
+}
+export interface AddressResource {
+    address_line_1?: string;
+    address_line_2?: string;
+    care_of?: string;
+    country?: string;
+    locality?: string;
+    po_box?: string;
+    postal_code?: string;
+    premises?: string;
+    region?: string;
+}

package/dist/services/officer-filing/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/services/officer-filing/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/officer-filing/types.ts"],"names":[],"mappings":""}

package/package.json

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