@companieshouse/api-sdk-node 2.0.291 → 2.0.293

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -76,7 +76,7 @@ Change the definition of the `prepare` script in the package.json file to match
76
76
 
77
77
  (The `husky install` command should only be present if already there in the `prepare` script definition of your project)
78
78
 
79
- Once done it should just be necessary to restart your project's service in Tilt (assumes that your local project is running in 'development mode').
79
+ Once done it should just be necessary to restart your project's service in docker-chs-development (assumes that your local project is running in 'development mode').
80
80
 
81
81
  Note that the `prepare` script change will need to be reverted, if wishing build and run unit-tests from the command-line, outside of the Docker environment. The change should NOT be committed or pushed to the project repository.
82
82
 
@@ -25,5 +25,14 @@ export default class {
25
25
  * @param acspApplicationId the id of the user whose application will be deleted
26
26
  */
27
27
  deleteSavedApplication(transactionId: string, acspApplicationId: string): Promise<HttpResponse>;
28
- sendIdentityVerificationEmail(emailData: ClientVerificationEmail): Promise<HttpResponse>;
28
+ /**
29
+ * Send an identity verification email to verify or reverify a client identity web app.
30
+ * @param emailData the email data containing verification details
31
+ * @param queryParams optional query parameters
32
+ * @param queryParams.application_type optional application type to filter the verification or reverification services.
33
+ * @returns Promise that resolves to the HTTP response from the API
34
+ */
35
+ sendIdentityVerificationEmail(emailData: ClientVerificationEmail, queryParams?: {
36
+ application_type?: string;
37
+ }): Promise<HttpResponse>;
29
38
  }
@@ -91,9 +91,19 @@ class default_1 {
91
91
  return resp;
92
92
  });
93
93
  }
94
- sendIdentityVerificationEmail(emailData) {
94
+ /**
95
+ * Send an identity verification email to verify or reverify a client identity web app.
96
+ * @param emailData the email data containing verification details
97
+ * @param queryParams optional query parameters
98
+ * @param queryParams.application_type optional application type to filter the verification or reverification services.
99
+ * @returns Promise that resolves to the HTTP response from the API
100
+ */
101
+ sendIdentityVerificationEmail(emailData, queryParams) {
95
102
  return __awaiter(this, void 0, void 0, function* () {
96
- const url = `/acsp-api/verify-client-identity/send-identity-verification-email`;
103
+ let url = `/acsp-api/verify-client-identity/send-identity-verification-email`;
104
+ if (queryParams === null || queryParams === void 0 ? void 0 : queryParams.application_type) {
105
+ url += `?application_type=${queryParams.application_type}`;
106
+ }
97
107
  return this.client.httpPost(url, emailData);
98
108
  });
99
109
  }
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/acsp/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAQA,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;;;;OAIG;IACU,sBAAsB,CAAE,aAAqB,EAAE,iBAAyB;;YACjF,MAAM,GAAG,GAAG,iBAAiB,aAAa,uDAAuD,iBAAiB,EAAE,CAAC;YACrH,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAEY,6BAA6B,CAAE,SAAkC;;YAC1E,MAAM,GAAG,GAAG,mEAAmE,CAAC;YAChF,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAChD,CAAC;KAAA;CACJ;AAtFD,4BAsFC"}
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/acsp/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAQA,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;;;;OAIG;IACU,sBAAsB,CAAE,aAAqB,EAAE,iBAAyB;;YACjF,MAAM,GAAG,GAAG,iBAAiB,aAAa,uDAAuD,iBAAiB,EAAE,CAAC;YACrH,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,6BAA6B,CAAE,SAAkC,EAAE,WAA2C;;YACvH,IAAI,GAAG,GAAG,mEAAmE,CAAC;YAC9E,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,EAAE;gBAC/B,GAAG,IAAI,qBAAqB,WAAW,CAAC,gBAAgB,EAAE,CAAC;aAC9D;YACD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAChD,CAAC;KAAA;CACJ;AAhGD,4BAgGC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companieshouse/api-sdk-node",
3
- "version": "2.0.291",
3
+ "version": "2.0.293",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [