@companieshouse/api-sdk-node 2.0.89 → 2.0.91

package/dist/client.d.ts

@@ -1,6 +1,7 @@
 import IHttpClient from "./http/http-client";
 import CompanyOfficersService from "./services/company-officers/service";
 import CompanyProfileService from "./services/company-profile/service";
+import CompanyMetricsService from "./services/company-metrics/service";
 import CompanyPscService from "./services/company-psc/service";
 import { LateFilingPenaltyService } from "./services/lfp";
 import { BasketService, CertificateService, CertifiedCopiesService, CheckoutService, MidService, OrderService } from "./services/order/";
@@ -32,6 +33,7 @@ export default class ApiClient {
     readonly companyOfficers: CompanyOfficersService;
     readonly companyFilingHistory: CompanyFilingHistoryService;
     readonly companyProfile: CompanyProfileService;
+    readonly companyMetrics: CompanyMetricsService;
     readonly companyPsc: CompanyPscService;
     readonly companyPscStatements: CompanyPscStatementsService;
     readonly confirmationStatementService: ConfirmationStatementService;

package/dist/client.js

@@ -5,25 +5,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const service_1 = __importDefault(require("./services/company-officers/service"));
 const service_2 = __importDefault(require("./services/company-profile/service"));
-const service_3 = __importDefault(require("./services/company-psc/service"));
+const service_3 = __importDefault(require("./services/company-metrics/service"));
+const service_4 = __importDefault(require("./services/company-psc/service"));
 const lfp_1 = require("./services/lfp");
 const order_1 = require("./services/order/");
 const payment_1 = require("./services/payment/");
-const service_4 = __importDefault(require("./services/company-filing-history/service"));
+const service_5 = __importDefault(require("./services/company-filing-history/service"));
 const refresh_token_1 = require("./services/refresh-token");
-const service_5 = __importDefault(require("./services/search/advanced-search/service"));
-const service_6 = __importDefault(require("./services/search/alphabetical-search/service"));
-const service_7 = __importDefault(require("./services/search/dissolved-search/service"));
-const service_8 = __importDefault(require("./services/psc-discrepancies/service"));
-const service_9 = __importDefault(require("./services/psc-discrepancies-report/service"));
-const service_10 = __importDefault(require("./services/transaction/service"));
-const service_11 = __importDefault(require("./services/company-psc-statements/service"));
+const service_6 = __importDefault(require("./services/search/advanced-search/service"));
+const service_7 = __importDefault(require("./services/search/alphabetical-search/service"));
+const service_8 = __importDefault(require("./services/search/dissolved-search/service"));
+const service_9 = __importDefault(require("./services/psc-discrepancies/service"));
+const service_10 = __importDefault(require("./services/psc-discrepancies-report/service"));
+const service_11 = __importDefault(require("./services/transaction/service"));
+const service_12 = __importDefault(require("./services/company-psc-statements/service"));
 const confirmation_statement_1 = require("./services/confirmation-statement");
 const overseas_entities_1 = require("./services/overseas-entities");
-const service_12 = require("./services/order/search/service");
-const service_13 = __importDefault(require("./services/order/order-item/service"));
-const service_14 = __importDefault(require("./services/order/checkout-item/service"));
-const service_15 = __importDefault(require("./services/officer-filing/service"));
+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.
  */
@@ -34,32 +35,33 @@ class ApiClient {
         // services on the api domain using the apiClient
         this.lateFilingPenalties = new lfp_1.LateFilingPenaltyService(apiClient);
         this.companyOfficers = new service_1.default(apiClient);
-        this.companyFilingHistory = new service_4.default(apiClient);
+        this.companyFilingHistory = new service_5.default(apiClient);
         this.companyProfile = new service_2.default(apiClient);
-        this.companyPsc = new service_3.default(apiClient);
-        this.companyPscStatements = new service_11.default(apiClient);
+        this.companyMetrics = new service_3.default(apiClient);
+        this.companyPsc = new service_4.default(apiClient);
+        this.companyPscStatements = new service_12.default(apiClient);
         this.confirmationStatementService = new confirmation_statement_1.ConfirmationStatementService(apiClient);
         this.certificate = new order_1.CertificateService(apiClient);
         this.certifiedCopies = new order_1.CertifiedCopiesService(apiClient);
         this.basket = new order_1.BasketService(apiClient);
         this.payment = new payment_1.PaymentService(apiClient); // TODO split payments url/domain into a separate config item and http client
         this.checkout = new order_1.CheckoutService(apiClient);
-        this.checkoutItem = new service_14.default(apiClient);
+        this.checkoutItem = new service_15.default(apiClient);
         this.order = new order_1.OrderService(apiClient);
-        this.orderItem = new service_13.default(apiClient);
-        this.officerFiling = new service_15.default(apiClient);
-        this.checkoutSearchService = new service_12.CheckoutSearchService(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_6.default(apiClient);
-        this.dissolvedSearch = new service_7.default(apiClient);
-        this.advancedSearch = new service_5.default(apiClient);
+        this.alphabeticalSearch = new service_7.default(apiClient);
+        this.dissolvedSearch = new service_8.default(apiClient);
+        this.advancedSearch = new service_6.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);
-        this.pscDiscrepancies = new service_8.default(apiClient);
-        this.pscDiscrepancyReport = new service_9.default(apiClient);
-        this.transaction = new service_10.default(apiClient);
+        this.pscDiscrepancies = new service_9.default(apiClient);
+        this.pscDiscrepancyReport = new service_10.default(apiClient);
+        this.transaction = new service_11.default(apiClient);
     }
 }
 exports.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,6CAO2B;AAC3B,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;AACrE,8DAAwE;AACxE,mFAAmE;AACnE,sFAAyE;AACzE,iFAAqE;AAGrE;;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,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,iBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AA5DD,4BA4DC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAO2B;AAC3B,iDAAqD;AACrD,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;AAGrE;;GAEG;AACH,MAAqB,SAAS;IA8B5B,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,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,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;AA9DD,4BA8DC"}

package/dist/services/company-metrics/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./service";

package/dist/services/company-metrics/index.js

@@ -0,0 +1,15 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/services/company-metrics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/company-metrics/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAAwB;AACxB,4CAA0B"}

package/dist/services/company-metrics/service.d.ts

@@ -0,0 +1,13 @@
+import { IHttpClient } from "../../http";
+import { MetricsApi } from "./types";
+import Resource from "../resource";
+export default class CompanyMetricsService {
+    private readonly client;
+    constructor(client: IHttpClient);
+    /**
+    * Get the metrics for a company.
+    *
+    * @param number the company number to look up
+    */
+    getCompanyMetrics(number: string): Promise<Resource<MetricsApi>>;
+}

package/dist/services/company-metrics/service.js

@@ -0,0 +1,42 @@
+"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());
+    });
+};
+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 CompanyMetricsService {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+    * Get the metrics for a company.
+    *
+    * @param number the company number to look up
+    */
+    getCompanyMetrics(number) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.client.httpGet(`/company/${number}/metrics`);
+            const resource = {
+                httpStatusCode: resp.status
+            };
+            if (resp.error) {
+                return resource;
+            }
+            // cast the response body to the expected type
+            const body = resp.body;
+            resource.resource = mapping_1.default.camelCaseKeys(body);
+            return resource;
+        });
+    }
+}
+exports.default = CompanyMetricsService;
+//# sourceMappingURL=service.js.map

package/dist/services/company-metrics/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/company-metrics/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,oEAA4C;AAI5C,MAAqB,qBAAqB;IACtC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEtD;;;;MAIE;IACW,iBAAiB,CAAE,MAAc;;YAC1C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,MAAM,UAAU,CAAC,CAAC;YAErE,MAAM,QAAQ,GAAyB;gBACnC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,8CAA8C;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,IAA0B,CAAC;YAE7C,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAa,IAAI,CAAC,CAAC;YAE5D,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AA1BD,wCA0BC"}

package/dist/services/company-metrics/types.d.ts

@@ -0,0 +1,93 @@
+/**
+ * MetricsApi is what is returned from the api.
+ */
+export interface MetricsApi {
+    etag: string;
+    counts: CountsApi;
+    mortgage: MortgageApi;
+    registers?: RegistersApi;
+}
+export interface MetricsApiResource {
+    etag: string;
+    counts: CountsApi;
+    mortgage: MortgageApi;
+    registers?: RegistersApi;
+}
+export interface CountsApi {
+    personsWithSignificantControl?: PscApi;
+    appointments: AppointmentsApi;
+}
+export interface CountsApiResource {
+    persons_with_significant_control?: PscApi;
+    appointments: AppointmentsApi;
+}
+export interface PscApi {
+    statementsCount: number;
+    ceasedPscsCount: number;
+    totalCount: number;
+    activePscsCount: number;
+    withdrawnStatementsCount: number;
+    activeStatementsCount: number;
+    pscsCount: number;
+}
+export interface PscApiResource {
+    statements_count: number;
+    ceased_pscs_count: number;
+    total_count: number;
+    active_pscs_count: number;
+    withdrawn_statements_count: number;
+    active_statements_count: number;
+    pscs_count: number;
+}
+export interface AppointmentsApi {
+    activeDirectorsCount: number;
+    activeSecretariesCount: number;
+    activeCount: number;
+    resignedCount: number;
+    totalCount: number;
+    activeLlpMembersCount: number;
+}
+export interface AppointmentsApiResource {
+    active_directors_count: number;
+    active_secretaries_count: number;
+    active_count: number;
+    resigned_count: number;
+    total_count: number;
+    active_llp_members_count: number;
+}
+export interface MortgageApi {
+    satisfiedCount: number;
+    partSatisfiedCount: number;
+    totalCount: number;
+}
+export interface MortgageApiResource {
+    satisfied_count: number;
+    part_satisfied_count: number;
+    total_count: number;
+}
+export interface RegistersApi {
+    directors: RegisterApi;
+    members: RegisterApi;
+    secretaries: RegisterApi;
+    usualResidentialAddress: RegisterApi;
+    personsWithSignificantControl: RegisterApi;
+    llpMembers: RegisterApi;
+    llpUsualResidentialAddress: RegisterApi;
+}
+export interface RegistersApiResource {
+    directors: RegisterApi;
+    members: RegisterApi;
+    secretaries: RegisterApi;
+    usual_residential_address: RegisterApi;
+    persons_with_significant_control: RegisterApi;
+    llp_members: RegisterApi;
+    llp_usual_residential_address: RegisterApi;
+}
+export interface RegisterApi {
+    registerMovedTo: string;
+    movedOn: string;
+}
+export interface RegisterApiResource {
+    register_moved_to: string;
+    moved_on: string;
+}

package/dist/services/company-metrics/types.js

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

package/dist/services/company-metrics/types.js.map

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

package/dist/services/company-officers/types.d.ts

@@ -28,6 +28,7 @@ export interface CompanyOfficerResource {
     nationality?: string;
     occupation?: string;
     officer_role: string;
+    contact_details?: ContactDetailsResource;
     responsibilities?: string;
     resigned_on?: string;
 }
@@ -65,6 +66,9 @@ export interface CompanyOfficerResourceLinks {
 export interface OfficerResourceLinks {
     appointments: string;
 }
+export interface ContactDetailsResource {
+    contact_name?: string;
+}
 /**
  * CompanyOfficers is the interface used within this SDK.
  */
@@ -95,6 +99,7 @@ export interface CompanyOfficer {
     nationality?: string;
     occupation?: string;
     officerRole: string;
+    contactDetails: ContactDetails;
     responsibilities?: string;
     resignedOn?: string;
 }
@@ -132,3 +137,6 @@ export interface CompanyOfficerLinks {
 export interface OfficerLinks {
     appointments: string;
 }
+export interface ContactDetails {
+    contactName?: string;
+}

package/package.json

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