@companieshouse/api-sdk-node 2.0.109 → 2.0.110

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

@@ -1,5 +1,5 @@
 import { IHttpClient } from "../../http";
-import { BeneficialOwnersPrivateData, HttpStatusCode, OverseasEntity, OverseasEntityCreated, OverseasEntityExtraDetails, ManagingOfficersPrivateData } from "./types";
+import { HttpStatusCode, OverseasEntity, OverseasEntityCreated, OverseasEntityExtraDetails, BeneficialOwnerPrivateData, ManagingOfficerPrivateData } from "./types";
 import Resource, { ApiErrorResponse } from "../resource";
 export default class OverseasEntityService {
     private readonly client;
@@ -13,6 +13,11 @@ export default class OverseasEntityService {
      * @param transactionId of the entity
      * @param overseasEntityId of the entity
      */
-    getBeneficialOwnerPrivateData(transactionId: string, overseasEntityId: string): Promise<Resource<BeneficialOwnersPrivateData> | ApiErrorResponse>;
-    getManagingOfficersPrivateData(transactionId: string, overseasEntityId: string): Promise<Resource<ManagingOfficersPrivateData> | ApiErrorResponse>;
+    getBeneficialOwnersPrivateData(transactionId: string, overseasEntityId: string): Promise<Resource<BeneficialOwnerPrivateData[]> | ApiErrorResponse>;
+    /**
+     * Get private managing officer data for an overseas entity
+     * @param transactionId of the entity
+     * @param overseasEntityId of the entity
+     */
+    getManagingOfficersPrivateData(transactionId: string, overseasEntityId: string): Promise<Resource<ManagingOfficerPrivateData[]> | ApiErrorResponse>;
 }

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

@@ -89,7 +89,7 @@ class OverseasEntityService {
      * @param transactionId of the entity
      * @param overseasEntityId of the entity
      */
-    getBeneficialOwnerPrivateData(transactionId, overseasEntityId) {
+    getBeneficialOwnersPrivateData(transactionId, overseasEntityId) {
         return __awaiter(this, void 0, void 0, function* () {
             const URL = `private/transactions/${transactionId}/overseas-entity/${overseasEntityId}/beneficial-owners`;
             const response = yield this.client.httpGet(URL);
@@ -106,6 +106,11 @@ class OverseasEntityService {
             return resource;
         });
     }
+    /**
+     * Get private managing officer data for an overseas entity
+     * @param transactionId of the entity
+     * @param overseasEntityId of the entity
+     */
     getManagingOfficersPrivateData(transactionId, overseasEntityId) {
         return __awaiter(this, void 0, void 0, function* () {
             const URL = `private/transactions/${transactionId}/overseas-entity/${overseasEntityId}/managing-officers`;

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

@@ -1 +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"}
+{"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,8BAA8B,CAAE,aAAqB,EAAE,gBAAwB;;YACxF,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,GAA2C;gBACrD,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,iBAAO,CAAC,aAAa,CAA+B,QAAQ,CAAC,IAA4C,CAAC;aACvH,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;;;OAIG;IACU,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,GAA2C;gBACrD,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,iBAAO,CAAC,aAAa,CAA+B,QAAQ,CAAC,IAA4C,CAAC;aACvH,CAAC;YAEF,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AAhID,wCAgIC"}

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

@@ -208,12 +208,6 @@ export interface BeneficialOwnerPrivateDataResource {
     usual_residential_address?: PrivateAddressResource;
     principal_address?: PrivateAddressResource;
 }
-export interface BeneficialOwnersPrivateDataResource {
-    bo_private_data: BeneficialOwnerPrivateDataResource[];
-}
-export interface BeneficialOwnersPrivateData {
-    boPrivateData: BeneficialOwnerPrivateData[];
-}
 export interface BeneficialOwnerPrivateData {
     hashedId?: string;
     dateBecameRegistrable?: string;
@@ -314,7 +308,7 @@ export interface ManagingOfficerCorporateResource {
     start_date?: string;
     resigned_on?: string;
 }
-export interface ManagingOfficerDataResource {
+export interface ManagingOfficerPrivateDataResource {
     managingOfficerAppointmentId?: string;
     residential_address?: PrivateAddressResource;
     principal_address?: PrivateAddressResource;
@@ -323,6 +317,15 @@ export interface ManagingOfficerDataResource {
     contact_email_address?: string;
     hashed_id?: string;
 }
+export interface ManagingOfficerPrivateData {
+    managingOfficerAppointmentId?: string;
+    residentialAddress?: PrivateAddress;
+    principalAddress?: PrivateAddress;
+    dateOfBirth?: string;
+    contactNameFull?: string;
+    contactEmailAddress?: string;
+    hashedId?: string;
+}
 export interface PrivateAddressResource {
     address_line_1?: string;
     address_line_2?: string;
@@ -334,21 +337,6 @@ export interface PrivateAddressResource {
     premises?: string;
     region?: string;
 }
-export interface ManagingOfficersPrivateDataResource {
-    mo_private_data: ManagingOfficerDataResource[];
-}
-export interface ManagingOfficersPrivateData {
-    moPrivateData: ManagingOfficerData[];
-}
-export interface ManagingOfficerData {
-    managingOfficerAppointmentId?: string;
-    residentialAddress?: PrivateAddress;
-    principalAddress?: PrivateAddress;
-    dateOfBirth?: string;
-    contactNameFull?: string;
-    contactEmailAddress?: string;
-    hashedId?: string;
-}
 export interface PrivateAddress {
     addressLine1?: string;
     addressLine2?: string;

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;;;AAskBH,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"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAsjBH,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

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