@companieshouse/api-sdk-node 2.0.190 → 2.0.192

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

@@ -4,7 +4,7 @@ import Resource, { ApiErrorResponse } from "../resource";
 export default class {
     private readonly client;
     constructor(client: IHttpClient);
-    getAcsp(transactionId: string, id: string): Promise<Resource<AcspData> | ApiErrorResponse>;
+    getAcsp(transactionId: string, acspApplicationId: string): Promise<Resource<AcspData> | ApiErrorResponse>;
     /**
      * Post an ACSP object to create on the API.
      * @param transactionId transaction id associated with the data to be saved
@@ -14,19 +14,14 @@ export default class {
     /**
      * Put an ACSP object to update on the API.
      * @param transactionId transaction id associated with the data to be saved
+     * @param acspApplicationId acsp application id unique to the application
      * @param acsp the data to be saved
      */
-    putACSP(transactionId: string, acsp: AcspData): Promise<Resource<AcspResponse> | ApiErrorResponse>;
-    getSavedApplication(userId: string): Promise<HttpResponse>;
+    putACSP(transactionId: string, acspApplicationId: string, acsp: AcspData): Promise<Resource<AcspResponse> | ApiErrorResponse>;
+    getSavedApplication(acspApplicationId: string): Promise<HttpResponse>;
     /**
      * Delete an existing ACSP application from MongoDB
-     * @param userId the id of the user whose application will be deleted
+     * @param acspApplicationId the id of the user whose application will be deleted
      */
-    deleteSavedApplication(userId: string): Promise<HttpResponse>;
-    /**
-     * Send a confirmation email for application complete
-     * @param userId the id of the user who will recieve the email
-     * @param applicationReference the reference number of the application
-     */
-    sendConfirmationEmail(userId: string, applicationReference: string): Promise<HttpResponse>;
+    deleteSavedApplication(acspApplicationId: string): Promise<HttpResponse>;
 }

package/dist/services/acsp/service.js

@@ -17,9 +17,9 @@ class default_1 {
     constructor(client) {
         this.client = client;
     }
-    getAcsp(transactionId, id) {
+    getAcsp(transactionId, acspApplicationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = `/transactions/${transactionId}/acsp/${id}`;
+            const url = `/transactions/${transactionId}/authorised-corporate-service-provider-applications/${acspApplicationId}`;
             const resp = yield this.client.httpGet(url);
             if (resp.status >= 400) {
                 return { httpStatusCode: resp.status, errors: [resp.error] };
@@ -39,8 +39,9 @@ class default_1 {
      */
     postACSP(transactionId, acsp) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = `/transactions/${transactionId}/acsp`;
-            const resp = yield this.client.httpPost(url, acsp);
+            const url = `/transactions/${transactionId}/authorised-corporate-service-provider-applications`;
+            const acspDto = mapping_1.default.snakeCaseKeys(acsp);
+            const resp = yield this.client.httpPost(url, acspDto);
             if (resp.status >= 400) {
                 return { httpStatusCode: resp.status, errors: [resp.error] };
             }
@@ -53,12 +54,14 @@ class default_1 {
     /**
      * Put an ACSP object to update on the API.
      * @param transactionId transaction id associated with the data to be saved
+     * @param acspApplicationId acsp application id unique to the application
      * @param acsp the data to be saved
      */
-    putACSP(transactionId, acsp) {
+    putACSP(transactionId, acspApplicationId, acsp) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = `/transactions/${transactionId}/acsp`;
-            const resp = yield this.client.httpPut(url, acsp);
+            const url = `/transactions/${transactionId}/authorised-corporate-service-provider-applications/${acspApplicationId}`;
+            const acspDto = mapping_1.default.snakeCaseKeys(acsp);
+            const resp = yield this.client.httpPut(url, acspDto);
             if (resp.status >= 400) {
                 return { httpStatusCode: resp.status, errors: [resp.error] };
             }
@@ -69,36 +72,24 @@ class default_1 {
         });
     }
     /* get saved application */
-    getSavedApplication(userId) {
+    getSavedApplication(acspApplicationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = `/acsp-api/user/${userId}/application`;
+            const url = `/acsp-api/user/${acspApplicationId}/application`;
             const resp = yield this.client.httpGet(url);
             return resp;
         });
     }
     /**
      * Delete an existing ACSP application from MongoDB
-     * @param userId the id of the user whose application will be deleted
+     * @param acspApplicationId the id of the user whose application will be deleted
      */
-    deleteSavedApplication(userId) {
+    deleteSavedApplication(acspApplicationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = `/acsp-api/user/${userId}/application`;
+            const url = `/acsp-api/user/${acspApplicationId}/application`;
             const resp = yield this.client.httpDelete(url);
             return resp;
         });
     }
-    /**
-     * Send a confirmation email for application complete
-     * @param userId the id of the user who will recieve the email
-     * @param applicationReference the reference number of the application
-     */
-    sendConfirmationEmail(userId, applicationReference) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const url = `/acsp-api/user/${userId}/application-submit/${applicationReference}`;
-            const resp = yield this.client.httpPost(url);
-            return resp;
-        });
-    }
 }
 exports.default = default_1;
 //# sourceMappingURL=service.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/acsp/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAOA,oEAA4C;AAE5C;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,OAAO,CAAE,aAAqB,EAAE,EAAU;;YACnD,MAAM,GAAG,GAAG,iBAAiB,aAAa,SAAS,EAAE,EAAE,CAAC;YACxD,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE1D,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,MAAM,QAAQ,GAAuB;gBACjC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAe,CAAC;YAElC,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAW,IAAI,CAAC,CAAC;YAC1D,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;;;OAIG;IACU,QAAQ,CAAE,aAAqB,EAAE,IAAc;;YACxD,MAAM,GAAG,GAAG,iBAAiB,aAAa,OAAO,CAAC;YAElD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAEnD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,OAAO;gBACH,cAAc,EAAE,IAAI,CAAC,MAAM;gBAC3B,QAAQ,EAAE,IAAI,CAAC,IAAI;aACI,CAAC;QAChC,CAAC;KAAA;IAED;;;;OAIG;IACU,OAAO,CAAE,aAAqB,EAAE,IAAc;;YACvD,MAAM,GAAG,GAAG,iBAAiB,aAAa,OAAO,CAAC;YAElD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAElD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,OAAO;gBACH,cAAc,EAAE,IAAI,CAAC,MAAM;gBAC3B,QAAQ,EAAE,IAAI,CAAC,IAAI;aACI,CAAC;QAChC,CAAC;KAAA;IAED,2BAA2B;IACd,mBAAmB,CAAE,MAAc;;YAC5C,MAAM,GAAG,GAAG,kBAAkB,MAAM,cAAc,CAAC;YACnD,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC1D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAED;;;OAGG;IACU,sBAAsB,CAAE,MAAc;;YAC/C,MAAM,GAAG,GAAG,kBAAkB,MAAM,cAAc,CAAC;YACnD,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAED;;;;OAIG;IACU,qBAAqB,CAAE,MAAc,EAAE,oBAA4B;;YAC5E,MAAM,GAAG,GAAG,kBAAkB,MAAM,uBAAuB,oBAAoB,EAAE,CAAC;YAClF,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;CACJ;AAxFD,4BAwFC"}
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/acsp/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAOA,oEAA4C;AAE5C;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,OAAO,CAAE,aAAqB,EAAE,iBAAyB;;YAClE,MAAM,GAAG,GAAG,iBAAiB,aAAa,uDAAuD,iBAAiB,EAAE,CAAC;YACrH,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE1D,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,MAAM,QAAQ,GAAuB;gBACjC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAmB,CAAC;YAEtC,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAW,IAAI,CAAC,CAAC;YAC1D,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;;;OAIG;IACU,QAAQ,CAAE,aAAqB,EAAE,IAAc;;YACxD,MAAM,GAAG,GAAG,iBAAiB,aAAa,qDAAqD,CAAC;YAEhG,MAAM,OAAO,GAAG,iBAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAE5C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAEtD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,OAAO;gBACH,cAAc,EAAE,IAAI,CAAC,MAAM;gBAC3B,QAAQ,EAAE,IAAI,CAAC,IAAI;aACI,CAAC;QAChC,CAAC;KAAA;IAED;;;;;OAKG;IACU,OAAO,CAAE,aAAqB,EAAE,iBAAyB,EAAE,IAAc;;YAClF,MAAM,GAAG,GAAG,iBAAiB,aAAa,uDAAuD,iBAAiB,EAAE,CAAC;YACrH,MAAM,OAAO,GAAG,iBAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC5C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAErD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE;gBACpB,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;aAChE;YAED,OAAO;gBACH,cAAc,EAAE,IAAI,CAAC,MAAM;gBAC3B,QAAQ,EAAE,IAAI,CAAC,IAAI;aACI,CAAC;QAChC,CAAC;KAAA;IAED,2BAA2B;IACd,mBAAmB,CAAE,iBAAyB;;YACvD,MAAM,GAAG,GAAG,kBAAkB,iBAAiB,cAAc,CAAC;YAC9D,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC1D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAED;;;OAGG;IACU,sBAAsB,CAAE,iBAAyB;;YAC1D,MAAM,GAAG,GAAG,kBAAkB,iBAAiB,cAAc,CAAC;YAC9D,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;CACJ;AAhFD,4BAgFC"}

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

@@ -1,24 +1,3 @@
-export interface AddressResource {
-    address_line_1: string;
-    address_line_2?: string;
-    care_of?: string;
-    country: string;
-    locality: string;
-    po_box?: string;
-    postal_code?: string;
-    premises?: string;
-    region?: string;
-}
-export interface DateOfBirthResource {
-    day?: string;
-    month: string;
-    year: string;
-}
-export interface DateOfBirth {
-    day?: string;
-    month: string;
-    year: string;
-}
 export interface Address {
     premises?: string;
     addressLine1?: string;
@@ -51,10 +30,8 @@ export interface ApplicantDetails {
     correspondenceAddress?: Address;
     correspondenceAddressIsSameAsRegisteredOfficeAddress?: boolean;
 }
-export interface AcspDto {
+export interface AcspData {
     id: string;
-    transactionId?: string;
-    roleInTheBusiness?: string;
     registeredOfficeAddress?: Address;
     typeOfBusiness?: string;
     roleType?: string;
@@ -67,25 +44,52 @@ export interface AcspDto {
     howAreYouRegisteredWithAml?: string;
     applicantDetails?: ApplicantDetails;
 }
-export interface AcspData {
+export interface AcspResponse {
+    data: AcspDataDto;
+}
+export interface AcspDataDto {
     id: string;
-    transactionId?: string;
-    roleInTheBusiness?: string;
-    registeredOfficeAddress?: Address;
-    typeOfBusiness?: string;
-    roleType?: string;
+    registered_office_address?: AddressDto;
+    type_of_business?: string;
+    role_type?: string;
     verified?: boolean;
-    businessName?: string;
-    workSector?: string;
-    amlSupervisoryBodies?: AmlSupervisoryBody[];
-    companyDetails?: Company;
-    companyAuthCodeProvided?: boolean;
-    howAreYouRegisteredWithAml?: string;
-    applicantDetails?: ApplicantDetails;
+    business_name?: string;
+    work_sector?: string;
+    aml_supervisory_bodies?: AmlSupervisoryBodyDto[];
+    company_details?: CompanyDto;
+    company_auth_code_provided?: boolean;
+    how_are_you_registered_with_aml?: string;
+    applicant_details?: ApplicantDetailsDto;
 }
-export interface AcspResponse {
-    data: AcspData;
+export interface ApplicantDetailsDto {
+    first_name?: string;
+    middle_name?: string;
+    last_name?: string;
+    date_of_birth?: Date;
+    nationality?: NationalityDto;
+    country_of_residence?: string;
+    correspondence_address?: AddressDto;
+    correspondence_address_is_same_as_registered_office_address?: boolean;
+}
+export interface AddressDto {
+    premises?: string;
+    address_line_1?: string;
+    address_line_2?: string;
+    locality?: string;
+    region?: string;
+    country?: string;
+    postal_code?: string;
+}
+export interface CompanyDto {
+    company_name?: string;
+    company_number?: string;
+}
+export interface AmlSupervisoryBodyDto {
+    aml_supervisory_body?: string;
+    membership_id?: string;
 }
-export interface AcspResponseDto {
-    data: AcspDto;
+export interface NationalityDto {
+    first_nationality: string;
+    second_nationality?: string;
+    third_nationality?: string;
 }

package/package.json

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