@companieshouse/api-sdk-node 1.0.102 → 1.0.105

package/dist/services/overseas-entities/mapping.d.ts

@@ -1,2 +1,2 @@
-import { OverseasEntity } from "./types";
-export declare const mapOverseasEntity: (body: OverseasEntity) => OverseasEntity;
+import { OverseasEntity, OverseasEntityResource } from "./types";
+export declare const mapOverseasEntity: (body: OverseasEntity) => OverseasEntityResource;

package/dist/services/overseas-entities/mapping.js

@@ -1,11 +1,63 @@
 "use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapOverseasEntity = void 0;
 const mapOverseasEntity = (body) => {
     return {
         presenter: Object.assign({}, body.presenter),
-        entity: Object.assign({}, body.entity)
+        entity: Object.assign({}, body.entity),
+        beneficial_owners_statement: body.beneficial_owners_statement,
+        beneficial_owners_individual: mapBeneficialOwnersIndividual(body.beneficial_owners_individual),
+        beneficial_owners_corporate: mapBeneficialOwnersCorporate(body.beneficial_owners_corporate),
+        beneficial_owners_government_or_public_authority: Object.assign({}, body.beneficial_owners_government_or_public_authority)
     };
 };
 exports.mapOverseasEntity = mapOverseasEntity;
+/**
+ * Convert the BeneficialOwnerIndividual array data into the Resource format that the API expects
+ * (just converting dates currently)
+ * @param boIndividuals Array of BeneficialOwnerIndividual objects
+ * @returns Array of BeneficialOwnerIndividualResource
+ */
+const mapBeneficialOwnersIndividual = (boIndividuals = []) => {
+    const boIndividualResources = [];
+    boIndividuals.forEach(boIndividual => {
+        const { date_of_birth, start_date } = boIndividual, rest = __rest(boIndividual, ["date_of_birth", "start_date"]);
+        boIndividualResources.push(Object.assign(Object.assign({}, rest), { date_of_birth: convertDateToIsoDateString(date_of_birth.day, date_of_birth.month, date_of_birth.year), start_date: convertDateToIsoDateString(start_date.day, start_date.month, start_date.year) }));
+    });
+    return boIndividualResources;
+};
+/**
+ * Convert the BeneficialOwnerCorporate array data into the Resource format that the API expects
+ * (just converting dates currently)
+ * @param boCorporates Array of BeneficialOwnerCorporate objects
+ * @returns Array of BeneficialOwnerCorporateResource
+ */
+const mapBeneficialOwnersCorporate = (boCorporates = []) => {
+    const boCorporateResources = [];
+    boCorporates.forEach(boCorporate => {
+        const { start_date } = boCorporate, rest = __rest(boCorporate, ["start_date"]);
+        boCorporateResources.push(Object.assign(Object.assign({}, rest), { start_date: convertDateToIsoDateString(start_date.day, start_date.month, start_date.year) }));
+    });
+    return boCorporateResources;
+};
+const convertDateToIsoDateString = (day, month, year) => {
+    return `${year}-${zeroPadNumber(month)}-${zeroPadNumber(day)}`;
+};
+const zeroPadNumber = (input = "") => {
+    if (input.length === 1) {
+        return "0" + input;
+    }
+    return input;
+};
 //# sourceMappingURL=mapping.js.map

package/dist/services/overseas-entities/mapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"mapping.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/mapping.ts"],"names":[],"mappings":";;;AAEO,MAAM,iBAAiB,GAAG,CAAC,IAAoB,EAAkB,EAAE;IACtE,OAAO;QACH,SAAS,oBAAO,IAAI,CAAC,SAAS,CAAE;QAChC,MAAM,oBAAO,IAAI,CAAC,MAAM,CAAE;KAC7B,CAAC;AACN,CAAC,CAAC;AALW,QAAA,iBAAiB,qBAK5B"}
+{"version":3,"file":"mapping.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/mapping.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAEO,MAAM,iBAAiB,GAAG,CAAC,IAAoB,EAA0B,EAAE;IAC9E,OAAO;QACH,SAAS,oBAAO,IAAI,CAAC,SAAS,CAAE;QAChC,MAAM,oBAAO,IAAI,CAAC,MAAM,CAAE;QAC1B,2BAA2B,EAAE,IAAI,CAAC,2BAA2B;QAC7D,4BAA4B,EAAE,6BAA6B,CAAC,IAAI,CAAC,4BAA4B,CAAC;QAC9F,2BAA2B,EAAE,4BAA4B,CAAC,IAAI,CAAC,2BAA2B,CAAC;QAC3F,gDAAgD,oBAAO,IAAI,CAAC,gDAAgD,CAAE;KACjH,CAAC;AACN,CAAC,CAAC;AATW,QAAA,iBAAiB,qBAS5B;AAEF;;;;;GAKG;AACH,MAAM,6BAA6B,GAAG,CAAC,gBAA6C,EAAE,EAAuC,EAAE;IAC3H,MAAM,qBAAqB,GAAwC,EAAE,CAAC;IACtE,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;QACjC,MAAM,EAAE,aAAa,EAAE,UAAU,KAAc,YAAY,EAArB,IAAI,UAAK,YAAY,EAArD,+BAAsC,CAAe,CAAC;QAC5D,qBAAqB,CAAC,IAAI,iCACnB,IAAI,KACP,aAAa,EAAE,0BAA0B,CAAC,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,EACrG,UAAU,EAAE,0BAA0B,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,IAC3F,CAAA;IACN,CAAC,CAAC,CAAC;IACH,OAAO,qBAAqB,CAAC;AACjC,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,4BAA4B,GAAG,CAAC,eAA2C,EAAE,EAAsC,EAAE;IACvH,MAAM,oBAAoB,GAAuC,EAAE,CAAC;IACpE,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QAC/B,MAAM,EAAE,UAAU,KAAc,WAAW,EAApB,IAAI,UAAK,WAAW,EAArC,cAAuB,CAAc,CAAC;QAC5C,oBAAoB,CAAC,IAAI,iCAClB,IAAI,KACP,UAAU,EAAE,0BAA0B,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,IAC3F,CAAA;IACN,CAAC,CAAC,CAAC;IACH,OAAO,oBAAoB,CAAC;AAChC,CAAC,CAAA;AAED,MAAM,0BAA0B,GAAG,CAAC,GAAW,EAAE,KAAa,EAAE,IAAY,EAAU,EAAE;IACpF,OAAO,GAAG,IAAI,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;AACnE,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,EAAU,EAAE;IACjD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACpB,OAAO,GAAG,GAAG,KAAK,CAAC;KACtB;IACD,OAAO,KAAK,CAAC;AACjB,CAAC,CAAA"}

package/dist/services/overseas-entities/types.d.ts

@@ -4,6 +4,18 @@
 export interface OverseasEntity {
     presenter?: Presenter;
     entity?: Entity;
+    beneficial_owners_statement?: BeneficialOwnersStatementType;
+    beneficial_owners_individual?: BeneficialOwnerIndividual[];
+    beneficial_owners_corporate?: BeneficialOwnerCorporate[];
+    beneficial_owners_government_or_public_authority?: BeneficialOwnerGovernmentOrPublicAuthority[];
+}
+export interface OverseasEntityResource {
+    presenter?: Presenter;
+    entity?: Entity;
+    beneficial_owners_statement?: BeneficialOwnersStatementType;
+    beneficial_owners_individual?: BeneficialOwnerIndividualResource[];
+    beneficial_owners_corporate?: BeneficialOwnerCorporateResource[];
+    beneficial_owners_government_or_public_authority?: BeneficialOwnerGovernmentOrPublicAuthority[];
 }
 export interface OverseasEntityCreated {
     id: string;
@@ -30,6 +42,79 @@ export interface Entity {
     public_register_name?: string;
     registration_number?: string;
 }
+export interface BeneficialOwnerIndividual {
+    first_name?: string;
+    last_name?: string;
+    date_of_birth?: InputDate;
+    nationality?: string;
+    usual_residential_address?: Address;
+    service_address?: Address;
+    is_service_address_same_as_usual_residential_address?: yesNoResponse;
+    start_date?: InputDate;
+    beneficial_owner_nature_of_control_types?: NatureOfControlType[];
+    trustees_nature_of_control_types?: NatureOfControlType[];
+    non_legal_firm_members_nature_of_control_types?: NatureOfControlType[];
+    is_on_sanctions_list?: yesNoResponse;
+}
+export interface BeneficialOwnerIndividualResource {
+    first_name?: string;
+    last_name?: string;
+    date_of_birth?: string;
+    nationality?: string;
+    usual_residential_address?: Address;
+    service_address?: Address;
+    is_service_address_same_as_usual_residential_address?: yesNoResponse;
+    start_date?: string;
+    beneficial_owner_nature_of_control_types?: NatureOfControlType[];
+    trustees_nature_of_control_types?: NatureOfControlType[];
+    non_legal_firm_members_nature_of_control_types?: NatureOfControlType[];
+    is_on_sanctions_list?: yesNoResponse;
+}
+export interface BeneficialOwnerCorporate {
+    name?: string;
+    principal_address?: Address;
+    service_address?: Address;
+    is_service_address_same_as_principal_address?: yesNoResponse;
+    legal_form?: string;
+    law_governed?: string;
+    is_on_register_in_country_formed_in?: yesNoResponse;
+    register_name?: string;
+    registration_number?: string;
+    start_date?: InputDate;
+    beneficial_owner_nature_of_control_types?: NatureOfControlType[];
+    trustees_nature_of_control_types?: NatureOfControlType[];
+    non_legal_firm_members_nature_of_control_types?: NatureOfControlType[];
+    is_on_sanctions_list?: yesNoResponse;
+}
+export interface BeneficialOwnerCorporateResource {
+    name?: string;
+    principal_address?: Address;
+    service_address?: Address;
+    is_service_address_same_as_principal_address?: yesNoResponse;
+    legal_form?: string;
+    law_governed?: string;
+    is_on_register_in_country_formed_in?: yesNoResponse;
+    register_name?: string;
+    registration_number?: string;
+    start_date?: string;
+    beneficial_owner_nature_of_control_types?: NatureOfControlType[];
+    trustees_nature_of_control_types?: NatureOfControlType[];
+    non_legal_firm_members_nature_of_control_types?: NatureOfControlType[];
+    is_on_sanctions_list?: yesNoResponse;
+}
+export interface BeneficialOwnerGovernmentOrPublicAuthority {
+    name?: string;
+    principal_address?: Address;
+    service_address?: Address;
+    is_service_address_same_as_principal_address?: yesNoResponse;
+    legal_form?: string;
+    law_governed?: string;
+    is_on_register_in_country_formed_in?: yesNoResponse;
+    register_name?: string;
+    registration_number?: string;
+    beneficial_owner_nature_of_control_types?: NatureOfControlType;
+    non_legal_firm_members_nature_of_control_types?: NatureOfControlType;
+}
 /**
  * Shared Data Type
  */
@@ -42,10 +127,15 @@ export interface Address {
     country?: string;
     postcode?: string;
 }
-declare enum yesNoResponse {
+export declare enum yesNoResponse {
     No = 0,
     Yes = 1
 }
+export interface InputDate {
+    day: string;
+    month: string;
+    year: string;
+}
 declare enum presenterRole {
     administrator = "administrator",
     agent = "agent",
@@ -53,4 +143,17 @@ declare enum presenterRole {
     beneficial_owner = "beneficial_owner",
     other = "other"
 }
+export declare enum BeneficialOwnersStatementType {
+    all_identified_all_details = "all_identified_all_details",
+    all_identified_some_details = "all_identified_some_details",
+    some_identified_all_details = "some_identified_all_details",
+    some_identified_some_details = "some_identified_some_details",
+    none_identified = "none_identified"
+}
+export declare enum NatureOfControlType {
+    over_25_percent_of_shares = "over_25_percent_of_shares",
+    over_25_percent_of_voting_rights = "over_25_percent_of_voting_rights",
+    appoint_or_remove_majority_board_directors = "appoint_or_remove_majority_board_directors",
+    significant_influence_or_control = "significant_influence_or_control"
+}
 export {};

package/dist/services/overseas-entities/types.js

@@ -3,11 +3,12 @@
  * Overseas Entity interface used within this SDK
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.NatureOfControlType = exports.BeneficialOwnersStatementType = exports.yesNoResponse = void 0;
 var yesNoResponse;
 (function (yesNoResponse) {
     yesNoResponse[yesNoResponse["No"] = 0] = "No";
     yesNoResponse[yesNoResponse["Yes"] = 1] = "Yes";
-})(yesNoResponse || (yesNoResponse = {}));
+})(yesNoResponse = exports.yesNoResponse || (exports.yesNoResponse = {}));
 var presenterRole;
 (function (presenterRole) {
     presenterRole["administrator"] = "administrator";
@@ -16,4 +17,19 @@ var presenterRole;
     presenterRole["beneficial_owner"] = "beneficial_owner";
     presenterRole["other"] = "other";
 })(presenterRole || (presenterRole = {}));
+var BeneficialOwnersStatementType;
+(function (BeneficialOwnersStatementType) {
+    BeneficialOwnersStatementType["all_identified_all_details"] = "all_identified_all_details";
+    BeneficialOwnersStatementType["all_identified_some_details"] = "all_identified_some_details";
+    BeneficialOwnersStatementType["some_identified_all_details"] = "some_identified_all_details";
+    BeneficialOwnersStatementType["some_identified_some_details"] = "some_identified_some_details";
+    BeneficialOwnersStatementType["none_identified"] = "none_identified";
+})(BeneficialOwnersStatementType = exports.BeneficialOwnersStatementType || (exports.BeneficialOwnersStatementType = {}));
+var NatureOfControlType;
+(function (NatureOfControlType) {
+    NatureOfControlType["over_25_percent_of_shares"] = "over_25_percent_of_shares";
+    NatureOfControlType["over_25_percent_of_voting_rights"] = "over_25_percent_of_voting_rights";
+    NatureOfControlType["appoint_or_remove_majority_board_directors"] = "appoint_or_remove_majority_board_directors";
+    NatureOfControlType["significant_influence_or_control"] = "significant_influence_or_control";
+})(NatureOfControlType = exports.NatureOfControlType || (exports.NatureOfControlType = {}));
 //# sourceMappingURL=types.js.map

package/dist/services/overseas-entities/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;AA+CH,IAAK,aAGJ;AAHD,WAAK,aAAa;IACd,6CAAM,CAAA;IACN,+CAAO,CAAA;AACX,CAAC,EAHI,aAAa,KAAb,aAAa,QAGjB;AAED,IAAK,aAMJ;AAND,WAAK,aAAa;IACd,gDAA+B,CAAA;IAC/B,gCAAe,CAAA;IACf,wCAAuB,CAAA;IACvB,sDAAqC,CAAA;IACrC,gCAAe,CAAA;AACnB,CAAC,EANI,aAAa,KAAb,aAAa,QAMjB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA0IH,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,6CAAM,CAAA;IACN,+CAAO,CAAA;AACX,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAQD,IAAK,aAMJ;AAND,WAAK,aAAa;IACd,gDAA+B,CAAA;IAC/B,gCAAe,CAAA;IACf,wCAAuB,CAAA;IACvB,sDAAqC,CAAA;IACrC,gCAAe,CAAA;AACnB,CAAC,EANI,aAAa,KAAb,aAAa,QAMjB;AAED,IAAY,6BAMX;AAND,WAAY,6BAA6B;IACrC,0FAAyD,CAAA;IACzD,4FAA2D,CAAA;IAC3D,4FAA2D,CAAA;IAC3D,8FAA6D,CAAA;IAC7D,oEAAmC,CAAA;AACvC,CAAC,EANW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAMxC;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

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