@companieshouse/api-sdk-node 1.0.97 → 1.0.98

package/dist/client.d.ts

@@ -15,6 +15,7 @@ import PSCDiscrepanciesReportService from "./services/psc-discrepancies-report/s
 import TransactionService from "./services/transaction/service";
 import CompanyPscStatementsService from "./services/company-psc-statements/service";
 import { ConfirmationStatementService } from "./services/confirmation-statement";
+import { OverseasEntityService } from "./services/overseas-entities";
 /**
  * ApiClient is the class that all service objects hang off.
  */
@@ -42,5 +43,6 @@ export default class ApiClient {
     readonly pscDiscrepancies: PSCDiscrepancyService;
     readonly pscDiscrepancyReport: PSCDiscrepanciesReportService;
     readonly transaction: TransactionService;
+    readonly overseasEntity: OverseasEntityService;
     constructor(apiClient: IHttpClient, accountClient: IHttpClient);
 }

package/dist/client.js

@@ -19,6 +19,7 @@ const service_9 = __importDefault(require("./services/psc-discrepancies-report/s
 const service_10 = __importDefault(require("./services/transaction/service"));
 const service_11 = __importDefault(require("./services/company-psc-statements/service"));
 const confirmation_statement_1 = require("./services/confirmation-statement");
+const overseas_entities_1 = require("./services/overseas-entities");
 /**
  * ApiClient is the class that all service objects hang off.
  */
@@ -44,6 +45,7 @@ class ApiClient {
         this.alphabeticalSearch = new service_6.default(apiClient);
         this.dissolvedSearch = new service_7.default(apiClient);
         this.advancedSearch = new service_5.default(apiClient);
+        this.overseasEntity = new overseas_entities_1.OverseasEntityService(apiClient);
         // service on the account/identity domain using the accountClient
         // e.g. user profile service can be added here when required
         this.refreshToken = new refresh_token_1.RefreshTokenService(accountClient);

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,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,0FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AAEjF;;GAEG;AACH,MAAqB,SAAS;IAuB5B,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,QAAQ,GAAG,IAAI,uBAAe,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAY,CAAC,SAAS,CAAC,CAAC;QACzC,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,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,iBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AAjDD,4BAiDC"}
+{"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,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,0FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AACjF,oEAAqE;AAErE;;GAEG;AACH,MAAqB,SAAS;IAwB5B,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,QAAQ,GAAG,IAAI,uBAAe,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAY,CAAC,SAAS,CAAC,CAAC;QACzC,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,iBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AAnDD,4BAmDC"}

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

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

package/dist/services/overseas-entities/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.OverseasEntityService = void 0;
+__exportStar(require("./types"), exports);
+var service_1 = require("./service");
+Object.defineProperty(exports, "OverseasEntityService", { enumerable: true, get: function () { return __importDefault(service_1).default; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,qCAA6D;AAApD,iIAAA,OAAO,OAAyB"}

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

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

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapOverseasEntity = void 0;
+const mapOverseasEntity = (body) => {
+    return {
+        presenter: Object.assign({}, body.presenter),
+        entity: Object.assign({}, body.entity)
+    };
+};
+exports.mapOverseasEntity = mapOverseasEntity;
+//# sourceMappingURL=mapping.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,8 @@
+import { IHttpClient } from "../../http";
+import { OverseasEntity, OverseasEntityCreated } from "./types";
+import Resource, { ApiErrorResponse } from "../resource";
+export default class OverseasEntityService {
+    private readonly client;
+    constructor(client: IHttpClient);
+    postOverseasEntity(transactionId: string, body: OverseasEntity): Promise<Resource<OverseasEntityCreated> | ApiErrorResponse>;
+}

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

@@ -0,0 +1,36 @@
+"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 });
+const mapping_1 = require("./mapping");
+class OverseasEntityService {
+    constructor(client) {
+        this.client = client;
+    }
+    postOverseasEntity(transactionId, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const URL = `/transactions/${transactionId}/overseas-entity`;
+            const response = yield this.client.httpPost(URL, mapping_1.mapOverseasEntity(body));
+            if (response.error && response.status !== 400) {
+                return {
+                    httpStatusCode: response.status,
+                    errors: [response.error]
+                };
+            }
+            const resource = {
+                httpStatusCode: response.status
+            };
+            resource.resource = Object.assign({}, response.body);
+            return resource;
+        });
+    }
+}
+exports.default = OverseasEntityService;
+//# sourceMappingURL=service.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,uCAA8C;AAE9C,MAAqB,qBAAqB;IACtC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,kBAAkB,CAAE,aAAqB,EAAE,IAAoB;;YACxE,MAAM,GAAG,GAAG,iBAAiB,aAAa,kBAAkB,CAAC;YAC7D,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,2BAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;YAExF,IAAI,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;gBAC3C,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;CACJ;AArBD,wCAqBC"}

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

@@ -0,0 +1,56 @@
+/**
+ * Overseas Entity interface used within this SDK
+ */
+export interface OverseasEntity {
+    presenter?: Presenter;
+    entity?: Entity;
+}
+export interface OverseasEntityCreated {
+    id: string;
+}
+/**
+ * Overseas Entities interface used on OverseasEntity object
+ */
+export interface Presenter {
+    full_name?: string;
+    phone_number?: string;
+    role?: presenterRole;
+    role_title?: string;
+    anti_money_laundering_registration_number?: string;
+}
+export interface Entity {
+    name?: string;
+    incorporation_country?: string;
+    principal_address?: Address;
+    is_service_address_same_as_principal_address?: yesNoResponse;
+    service_address?: Address;
+    email?: string;
+    legal_form?: string;
+    law_governed?: string;
+    public_register_name?: string;
+    registration_number?: string;
+}
+/**
+ * Shared Data Type
+ */
+export interface Address {
+    property_name_number?: string;
+    line_1?: string;
+    line_2?: string;
+    town?: string;
+    county?: string;
+    country?: string;
+    postcode?: string;
+}
+declare enum yesNoResponse {
+    No = 0,
+    Yes = 1
+}
+declare enum presenterRole {
+    administrator = "administrator",
+    agent = "agent",
+    solicitor = "solicitor",
+    beneficial_owner = "beneficial_owner",
+    other = "other"
+}
+export {};

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

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * Overseas Entity interface used within this SDK
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+var yesNoResponse;
+(function (yesNoResponse) {
+    yesNoResponse[yesNoResponse["No"] = 0] = "No";
+    yesNoResponse[yesNoResponse["Yes"] = 1] = "Yes";
+})(yesNoResponse || (yesNoResponse = {}));
+var presenterRole;
+(function (presenterRole) {
+    presenterRole["administrator"] = "administrator";
+    presenterRole["agent"] = "agent";
+    presenterRole["solicitor"] = "solicitor";
+    presenterRole["beneficial_owner"] = "beneficial_owner";
+    presenterRole["other"] = "other";
+})(presenterRole || (presenterRole = {}));
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +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"}

package/dist/services/transaction/types.d.ts

@@ -40,7 +40,7 @@ export interface Transaction {
     status?: string;
     kind?: string;
     companyName?: string;
-    companyNumber: string;
+    companyNumber?: string;
     createdAt?: string;
     createdBy?: {
         language: string;

package/package.json

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