@companieshouse/api-sdk-node 2.0.64 → 2.0.65

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

@@ -1,11 +1,9 @@
-import { ActiveOfficerDetails } from "./types";
+import { CompanyOfficer } 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;
+    getListActiveDirectorDetails(transactionId: string): Promise<Resource<CompanyOfficer[]> | ApiErrorResponse>;
     private getOfficerFilingUrlIncTransactionId;
 }

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

@@ -8,7 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const mapping_1 = __importDefault(require("../../mapping/mapping"));
 class default_1 {
     constructor(client) {
         this.client = client;
@@ -21,31 +25,11 @@ class default_1 {
                 return { httpStatusCode: resp.status, errors: [resp.error] };
             }
             const resource = { httpStatusCode: resp.status };
-            resource.resource = this.mapToListActiveOfficerDetails(resp.body);
+            const body = resp.body;
+            resource.resource = mapping_1.default.camelCaseKeys(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`;
     }

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

@@ -1 +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,mCAAmC,CAAC,aAAa,CAAC,2BAA2B,CAAC;YAClG,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;CACJ;AA9DD,4BA8DC"}
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/officer-filing/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAMA,oEAA4C;AAE5C;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,4BAA4B,CAAE,aAAqB;;YAC5D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,mCAAmC,CAAC,aAAa,CAAC,2BAA2B,CAAC;YAClG,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,GAA+B,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YAE7E,MAAM,IAAI,GAAG,IAAI,CAAC,IAAgC,CAAC;YAEnD,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAmB,IAAI,CAAC,CAAC;YAElE,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEO,mCAAmC,CAAE,aAAqB;QAC9D,OAAO,iBAAiB,aAAa,WAAW,CAAC;IACrD,CAAC;CACJ;AAvBD,4BAuBC"}

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

@@ -1,65 +1,100 @@
-export interface Tm01Submission {
-    resigned_on: Date;
-    reference_etag: String;
-    reference_appointment_id: String;
+/**
+ * CompanyOfficerResource is what is returned from the api.
+ */
+export interface CompanyOfficerResource {
+    address: AddressResource;
+    appointed_on: string;
+    country_of_residence?: string;
+    date_of_birth?: DateOfBirthResource;
+    former_names?: FormerNameResource[];
+    identification?: IdentificationResource;
+    links: CompanyOfficerResourceLinks;
+    name: string;
+    nationality?: string;
+    occupation?: string;
+    officer_role: string;
+    resigned_on?: 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 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;
+}
+export interface DateOfBirthResource {
+    day?: string;
+    month: string;
+    year: 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;
+export interface FormerNameResource {
+    forenames?: string;
+    surname?: string;
+}
+export interface IdentificationResource {
+    identification_type?: string;
+    legal_authority?: string;
+    legal_form?: string;
     place_registered?: string;
     registration_number?: string;
-    law_governed?: string;
-    legal_form?: string;
-    identification_type?: string;
+}
+export interface CompanyOfficerResourceLinks {
+    officer: OfficerResourceLinks;
+}
+export interface OfficerResourceLinks {
+    appointments: string;
+}
+/**
+ * CompanyOfficers is the interface used within this SDK.
+ */
+export interface CompanyOfficer {
+    address: Address;
+    appointedOn: string;
+    countryOfResidence?: string;
+    dateOfBirth?: DateOfBirth;
+    formerNames?: FormerName[];
+    identification?: Identification;
+    links: CompanyOfficerLinks;
+    name: string;
+    nationality?: string;
+    occupation?: string;
+    officerRole: string;
+    resignedOn?: string;
 }
 export interface Address {
-    addressLine1?: string;
-    addressLine2?: string;
+    addressLine1: string;
+    addressLine2: string;
     careOf?: string;
-    country?: string;
-    locality?: 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;
+export interface DateOfBirth {
+    day?: string;
+    month: string;
+    year: string;
+}
+export interface FormerName {
+    forenames?: string;
+    surname?: string;
+}
+export interface Identification {
+    identificationType?: string;
+    legalAuthority?: string;
+    legalForm?: string;
+    placeRegistered?: string;
+    registrationNumber?: string;
+}
+export interface CompanyOfficerLinks {
+    officer: OfficerLinks;
+}
+export interface OfficerLinks {
+    appointments: string;
 }

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

@@ -1,3 +1,6 @@
 "use strict";
+/**
+ * CompanyOfficerResource is what is returned from the api.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=types.js.map

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

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

package/package.json

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