@companieshouse/api-sdk-node 2.0.248 → 2.0.249

package/dist/services/psc/service.d.ts

@@ -8,10 +8,10 @@ export default class PscService {
     private readonly client;
     constructor(client: IHttpClient);
     /**
-   * Get the PSC details for an individual person.
+   * Get the PSC individual details including their optional verification state.
    *
-   * @param companyNumber the company number to look up
-   * @param notificationId the PSC Notification Id to retrieve
+   * @param companyNumber the Company Number to look up
+   * @param pscNotificationId the PSC Notification ID to retrieve
    */
-    getPscIndividual(companyNumber: string, notificationId: string): Promise<Resource<PersonWithSignificantControl> | ApiErrorResponse>;
+    getPscIndividual(companyNumber: string, pscNotificationId: string): Promise<Resource<PersonWithSignificantControl> | ApiErrorResponse>;
 }

package/dist/services/psc/service.js

@@ -21,26 +21,27 @@ class PscService {
         this.client = client;
     }
     /**
-   * Get the PSC details for an individual person.
+   * Get the PSC individual details including their optional verification state.
    *
-   * @param companyNumber the company number to look up
-   * @param notificationId the PSC Notification Id to retrieve
+   * @param companyNumber the Company Number to look up
+   * @param pscNotificationId the PSC Notification ID to retrieve
    */
-    getPscIndividual(companyNumber, notificationId) {
+    getPscIndividual(companyNumber, pscNotificationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.client.httpGet(`/company/${companyNumber}/persons-with-significant-control/individual/${notificationId}`);
-            const resource = {
-                httpStatusCode: response.status
-            };
+            const resourceUri = `/company/${companyNumber}/persons-with-significant-control/individual/${pscNotificationId}/verification-state`;
+            const response = yield this.client.httpGet(resourceUri);
             if (response.error) {
                 return {
                     httpStatusCode: response.status,
                     errors: [response.error]
                 };
             }
+            const frontEndResource = {
+                httpStatusCode: response.status
+            };
             const body = response.body;
-            resource.resource = mapping_1.default.camelCaseKeys(body);
-            return resource;
+            frontEndResource.resource = mapping_1.default.camelCaseKeys(body);
+            return frontEndResource;
         });
     }
 }

package/dist/services/psc/service.js.map

@@ -1 +1 @@
-{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,oEAA4C;AAI5C;;GAEG;AACH,MAAqB,UAAU;IAC3B,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEtD;;;;;KAKC;IACY,gBAAgB,CAAE,aAAqB,EAAE,cAAsB;;YACxE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,aAAa,gDAAgD,cAAc,EAAE,CAAC,CAAC;YAEtI,MAAM,QAAQ,GAA2C;gBACrD,cAAc,EAAE,QAAQ,CAAC,MAAM;aAClC,CAAC;YAEF,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAA;aACJ;YAED,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA4C,CAAC;YACnE,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAA+B,IAAI,CAAC,CAAC;YAE9E,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AA5BD,6BA4BC"}
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,oEAA4C;AAI5C;;GAEG;AACH,MAAqB,UAAU;IAC3B,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEtD;;;;;KAKC;IACY,gBAAgB,CAAE,aAAqB,EAAE,iBAAyB;;YAC3E,MAAM,WAAW,GAAG,YAAY,aAAa,gDAAgD,iBAAiB,qBAAqB,CAAC;YACpI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAExD,IAAI,QAAQ,CAAC,KAAK,EAAE;gBAChB,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAA;aACJ;YAED,MAAM,gBAAgB,GAA2C;gBAC7D,cAAc,EAAE,QAAQ,CAAC,MAAM;aAClC,CAAC;YAEF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA4C,CAAC;YACnE,gBAAgB,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAA+B,IAAI,CAAC,CAAC;YAEtF,OAAO,gBAAgB,CAAC;QAC5B,CAAC;KAAA;CACJ;AA7BD,6BA6BC"}

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

@@ -1,5 +1,5 @@
 /**
- * PersonWithSignificantControlResource is what is returned from the api.
+ * PersonWithSignificantControlResource is what is returned from the PSC data API, and will apply to individual PSC types only.
  */
 export interface PersonWithSignificantControlResource {
     address: AddressResource;
@@ -14,13 +14,14 @@ export interface PersonWithSignificantControlResource {
     natures_of_control: string[];
     notified_on: string;
     is_sanctioned?: boolean;
-    kind?: string;
-    identification?: IdentificationResource;
+    kind?: KindEnum;
+    verification_state?: VerificationStateResource;
 }
 export interface AddressResource {
     address_line_1: string;
     address_line_2?: string;
     careOf?: string;
+    country?: string;
     locality: string;
     poBox?: string;
     postal_code?: string;
@@ -39,14 +40,6 @@ export interface NameElementsResource {
     middle_name?: string;
     surname: string;
 }
-export interface IdentificationResource {
-    identification_type?: string;
-    legal_authority?: string;
-    legal_form?: string;
-    place_registered?: string;
-    registration_number?: string;
-    country_registered?: string;
-}
 export interface ResultsLinksResource {
     self: string;
     persons_with_significant_control_statements_list?: string;
@@ -55,6 +48,19 @@ export interface ItemLinksResource {
     self: string;
     statement?: string;
 }
+export interface VerificationStateResource {
+    verification_status?: VerificationStatusEnum;
+    verification_start_date?: Date;
+    verification_statement_due_date?: Date;
+}
+export declare enum VerificationStatusEnum {
+    UNVERIFIED = "UNVERIFIED",
+    VERIFIED = "VERIFIED",
+    PENDING = "PENDING"
+}
+export declare enum KindEnum {
+    INDIVIDUAL_PERSON_WITH_SIGNIFICANT_CONTROL = "individual-person-with-significant-control"
+}
 export interface PersonWithSignificantControl {
     address: any;
     countryOfResidence: string;
@@ -68,13 +74,14 @@ export interface PersonWithSignificantControl {
     naturesOfControl: string[];
     notifiedOn: string;
     isSanctioned?: boolean;
-    kind?: string;
-    identification?: Identification;
+    kind?: KindEnum;
+    verificationState?: VerificationState;
 }
 export interface Address {
     addressLine1: string;
     addressLine2?: string;
     careOf?: string;
+    country?: string;
     locality: string;
     poBox?: string;
     postalCode?: string;
@@ -93,14 +100,6 @@ export interface NameElements {
     middleName?: string;
     surname: string;
 }
-export interface Identification {
-    identificationType?: string;
-    legalAuthority?: string;
-    legalForm?: string;
-    placeRegistered?: string;
-    registrationNumber?: string;
-    countryRegistered?: string;
-}
 export interface ResultsLinks {
     self: string;
     personsWithSignificantControlStatementsList?: string;
@@ -109,3 +108,8 @@ export interface ItemLinks {
     self: string;
     statement?: string;
 }
+export interface VerificationState {
+    verificationStatus?: VerificationStatusEnum;
+    verificationStartDate?: Date;
+    verificationStatementDueDate?: Date;
+}

package/dist/services/psc/types.js

@@ -1,16 +1,25 @@
 "use strict";
 /**
- * PersonWithSignificantControlResource is what is returned from the api.
+ * PersonWithSignificantControlResource is what is returned from the PSC data API, and will apply to individual PSC types only.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.KindEnum = exports.VerificationStatusEnum = void 0;
 ;
 ;
 ;
 ;
 ;
 ;
-;
-;
+var VerificationStatusEnum;
+(function (VerificationStatusEnum) {
+    VerificationStatusEnum["UNVERIFIED"] = "UNVERIFIED";
+    VerificationStatusEnum["VERIFIED"] = "VERIFIED";
+    VerificationStatusEnum["PENDING"] = "PENDING";
+})(VerificationStatusEnum = exports.VerificationStatusEnum || (exports.VerificationStatusEnum = {}));
+var KindEnum;
+(function (KindEnum) {
+    KindEnum["INDIVIDUAL_PERSON_WITH_SIGNIFICANT_CONTROL"] = "individual-person-with-significant-control";
+})(KindEnum = exports.KindEnum || (exports.KindEnum = {}));
 ;
 ;
 ;

package/dist/services/psc/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/psc/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAiBF,CAAC;AAWD,CAAC;AAMD,CAAC;AAQD,CAAC;AASD,CAAC;AAKD,CAAC;AAKD,CAAC;AAiBD,CAAC;AAWD,CAAC;AAMD,CAAC;AAQD,CAAC;AASD,CAAC;AAKD,CAAC;AAKD,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/psc/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAiBF,CAAC;AAYD,CAAC;AAMD,CAAC;AAQD,CAAC;AAKD,CAAC;AAKD,CAAC;AAQF,IAAY,sBAIX;AAJD,WAAY,sBAAsB;IAChC,mDAAyB,CAAA;IACzB,+CAAqB,CAAA;IACrB,6CAAmB,CAAA;AACrB,CAAC,EAJW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAIjC;AAED,IAAY,QAEX;AAFD,WAAY,QAAQ;IAClB,qGAAyF,CAAA;AAC3F,CAAC,EAFW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAEnB;AAiBA,CAAC;AAYD,CAAC;AAMD,CAAC;AAQD,CAAC;AAKD,CAAC;AAKD,CAAC"}

package/package.json

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