@companieshouse/api-sdk-node 2.0.222 → 2.0.224

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.
@@ -1,10 +1,11 @@
1
1
  import { IHttpClient } from "../../http";
2
- import { LimitedPartnership, LimitedPartnershipCreated } from "./types";
2
+ import { LimitedPartnership, LimitedPartnershipResourceCreated } from "./types";
3
3
  import Resource, { ApiErrorResponse } from "../resource";
4
4
  export default class LimitedPartnershipsService {
5
5
  private readonly client;
6
6
  constructor(client: IHttpClient);
7
- postLimitedPartnership(transactionId: string, body: LimitedPartnership): Promise<Resource<LimitedPartnershipCreated> | ApiErrorResponse>;
7
+ postLimitedPartnership(transactionId: string, body: LimitedPartnership): Promise<Resource<LimitedPartnershipResourceCreated> | ApiErrorResponse>;
8
8
  patchLimitedPartnership(transactionId: string, submissionId: string, body: LimitedPartnership["data"]): Promise<Resource<void> | ApiErrorResponse>;
9
9
  getLimitedPartnership(transactionId: string, submissionId: string): Promise<Resource<LimitedPartnership> | ApiErrorResponse>;
10
+ postLimitedPartnershipIncorporation(transactionId: string): Promise<Resource<LimitedPartnershipResourceCreated> | ApiErrorResponse>;
10
11
  }
@@ -43,6 +43,19 @@ class LimitedPartnershipsService {
43
43
  };
44
44
  });
45
45
  }
46
+ /*
47
+ * Calls to incorporation endpoints
48
+ */
49
+ postLimitedPartnershipIncorporation(transactionId) {
50
+ return __awaiter(this, void 0, void 0, function* () {
51
+ const URL = `/transactions/${transactionId}/incorporation/limited-partnership`;
52
+ const response = yield this.client.httpPost(URL);
53
+ return {
54
+ httpStatusCode: response.status,
55
+ resource: Object.assign({}, response.body)
56
+ };
57
+ });
58
+ }
46
59
  }
47
60
  exports.default = LimitedPartnershipsService;
48
61
  //# sourceMappingURL=service.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/limited-partnerships/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,MAAqB,0BAA0B;IAC3C,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,sBAAsB,CAC/B,aAAqB,EACrB,IAAwB;;YAExB,MAAM,GAAG,GAAG,iBAAiB,aAAa,kCAAkC,CAAC;YAC7E,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAErE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,uBAAuB,CAChC,aAAqB,EACrB,YAAoB,EACpB,IAAgC;;YAEhC,MAAM,GAAG,GAAG,iBAAiB,aAAa,oCAAoC,YAAY,EAAE,CAAC;YAC7F,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,qBAAqB,CAC9B,aAAqB,EACrB,YAAoB;;YAEpB,MAAM,GAAG,GAAG,iBAAiB,aAAa,oCAAoC,YAAY,EAAE,CAAC;YAC7F,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;CACJ;AA1CD,6CA0CC"}
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/limited-partnerships/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,MAAqB,0BAA0B;IAC3C,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,sBAAsB,CAC/B,aAAqB,EACrB,IAAwB;;YAExB,MAAM,GAAG,GAAG,iBAAiB,aAAa,kCAAkC,CAAC;YAC7E,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAErE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,uBAAuB,CAChC,aAAqB,EACrB,YAAoB,EACpB,IAAgC;;YAEhC,MAAM,GAAG,GAAG,iBAAiB,aAAa,oCAAoC,YAAY,EAAE,CAAC;YAC7F,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAEY,qBAAqB,CAC9B,aAAqB,EACrB,YAAoB;;YAEpB,MAAM,GAAG,GAAG,iBAAiB,aAAa,oCAAoC,YAAY,EAAE,CAAC;YAC7F,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9D,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;IAED;;OAEG;IAEU,mCAAmC,CAC5C,aAAqB;;YACrB,MAAM,GAAG,GAAG,iBAAiB,aAAa,oCAAoC,CAAC;YAC/E,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAE/D,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,oBAAO,QAAQ,CAAC,IAAI,CAAE;aACjC,CAAC;QACN,CAAC;KAAA;CACJ;AAzDD,6CAyDC"}
@@ -16,7 +16,7 @@ export interface LimitedPartnership {
16
16
  * The data structure returned by the API when a new Limited Partnership resource has
17
17
  * successfully been created.
18
18
  */
19
- export interface LimitedPartnershipCreated {
19
+ export interface LimitedPartnershipResourceCreated {
20
20
  id: string;
21
21
  }
22
22
  export declare enum NameEndingType {
@@ -12,6 +12,7 @@ export default class PscVerificationService {
12
12
  postPscVerification(transactionId: string, pscVerification: PscVerificationData): Promise<Resource<PscVerification> | ApiErrorResponse>;
13
13
  getPscVerification(transactionId: string, pscVerificationId: string): Promise<Resource<PscVerification> | ApiErrorResponse>;
14
14
  patchPscVerification(transactionId: string, filingId: string, pscVerificationPatch: PscVerificationData): Promise<Resource<PscVerification> | ApiErrorResponse>;
15
+ getValidationStatus(transactionId: string, pscVerificationId: string): Promise<Resource<PscVerification> | ApiErrorResponse>;
15
16
  checkPlannedMaintenance(): Promise<ApiResponse<PlannedMaintenance> | ApiErrorResponse>;
16
17
  private populateFrontEndResource;
17
18
  }
@@ -64,6 +64,19 @@ class PscVerificationService {
64
64
  return this.populateFrontEndResource(response);
65
65
  });
66
66
  }
67
+ getValidationStatus(transactionId, pscVerificationId) {
68
+ return __awaiter(this, void 0, void 0, function* () {
69
+ const resourceUri = `/transactions/${transactionId}/persons-with-significant-control-verification/${pscVerificationId}/validation_status`;
70
+ const response = yield this.client.httpGet(resourceUri);
71
+ if (response.status >= 400) {
72
+ return { httpStatusCode: response.status, errors: [response.error] };
73
+ }
74
+ const resource = { httpStatusCode: response.status };
75
+ const body = response.body;
76
+ resource.resource = mapping_1.default.camelCaseKeys(body);
77
+ return resource;
78
+ });
79
+ }
67
80
  checkPlannedMaintenance() {
68
81
  return __awaiter(this, void 0, void 0, function* () {
69
82
  const maintenanceUri = `/persons-with-significant-control-verification/maintenance`;
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAIA,oEAA4C;AAE5C;;;;GAIG;AACH,MAAqB,sBAAsB;IACvC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,mBAAmB,CAAE,aAAqB,EAAE,eAAoC;;YACzF,MAAM,WAAW,GAAG,iBAAiB,aAAa,gDAAgD,CAAC;YACnG,MAAM,uBAAuB,GAAG,iBAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;YACvE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAC;YAElF,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,kBAAkB,CAAE,aAAqB,EAAE,iBAAyB;;YAC7E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,iBAAiB,EAAE,CAAC;YACxH,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,oBAAoB,CAAE,aAAqB,EAAE,QAAgB,EAAE,oBAAyC;;YACjH,MAAM,iBAAiB,GAAG,EAAE,cAAc,EAAE,8BAA8B,EAAE,CAAC;YAC7E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,QAAQ,EAAE,CAAC;YAC/G,MAAM,4BAA4B,GAAG,iBAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YACjF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,4BAA4B,EAAE,iBAAiB,CAAC,CAAC;YAE3G,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,uBAAuB;;YAChC,MAAM,cAAc,GAAG,4DAA4D,CAAC;YACpF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAE3D,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,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,QAAQ,CAAC,IAA0B;aAChD,CAAC;QACN,CAAC;KAAA;IAEO,wBAAwB,CAAE,QAAsB;QACpD,MAAM,gBAAgB,GAA8B;YAChD,cAAc,EAAE,QAAQ,CAAC,MAAM;YAC/B,QAAQ,EAAE,QAAQ,CAAC,IAAuB;SAC7C,CAAC;QAEF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA4C,CAAC;QACnE,gBAAgB,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAkB,IAAI,CAAC,CAAC;QAEzE,OAAO,gBAAgB,CAAC;IAC5B,CAAC;CACJ;AA5ED,yCA4EC"}
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/psc-verification-link/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAIA,oEAA4C;AAE5C;;;;GAIG;AACH,MAAqB,sBAAsB;IACvC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,mBAAmB,CAAE,aAAqB,EAAE,eAAoC;;YACzF,MAAM,WAAW,GAAG,iBAAiB,aAAa,gDAAgD,CAAC;YACnG,MAAM,uBAAuB,GAAG,iBAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;YACvE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAC;YAElF,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,kBAAkB,CAAE,aAAqB,EAAE,iBAAyB;;YAC7E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,iBAAiB,EAAE,CAAC;YACxH,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,oBAAoB,CAAE,aAAqB,EAAE,QAAgB,EAAE,oBAAyC;;YACjH,MAAM,iBAAiB,GAAG,EAAE,cAAc,EAAE,8BAA8B,EAAE,CAAC;YAC7E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,QAAQ,EAAE,CAAC;YAC/G,MAAM,4BAA4B,GAAG,iBAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YACjF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,4BAA4B,EAAE,iBAAiB,CAAC,CAAC;YAE3G,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,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;KAAA;IAEY,mBAAmB,CAAE,aAAqB,EAAE,iBAAyB;;YAC9E,MAAM,WAAW,GAAG,iBAAiB,aAAa,kDAAkD,iBAAiB,oBAAoB,CAAC;YAC1I,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAExD,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;gBACxB,OAAO,EAAE,cAAc,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;aACxE;YAED,MAAM,QAAQ,GAAuC,EAAE,cAAc,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;YAEzF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAwC,CAAC;YAE/D,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAA2B,IAAI,CAAC,CAAC;YAE1E,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAEY,uBAAuB;;YAChC,MAAM,cAAc,GAAG,4DAA4D,CAAC;YACpF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAE3D,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,OAAO;gBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;gBAC/B,QAAQ,EAAE,QAAQ,CAAC,IAA0B;aAChD,CAAC;QACN,CAAC;KAAA;IAEO,wBAAwB,CAAE,QAAsB;QACpD,MAAM,gBAAgB,GAA8B;YAChD,cAAc,EAAE,QAAQ,CAAC,MAAM;YAC/B,QAAQ,EAAE,QAAQ,CAAC,IAAuB;SAC7C,CAAC;QAEF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA4C,CAAC;QACnE,gBAAgB,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAkB,IAAI,CAAC,CAAC;QAEzE,OAAO,gBAAgB,CAAC;IAC5B,CAAC;CACJ;AA7FD,yCA6FC"}
@@ -179,3 +179,23 @@ export declare enum VerificationStatementEnum {
179
179
  RO_VERIFIED = "RO_VERIFIED",
180
180
  RO_DECLARATION = "RO_DECLARATION"
181
181
  }
182
+ export interface ValidationStatusError {
183
+ error: string;
184
+ location: string;
185
+ type?: string;
186
+ locationType: string;
187
+ }
188
+ export interface ValidationStatusResponse {
189
+ errors: ValidationStatusError[];
190
+ isValid?: boolean;
191
+ }
192
+ export interface ValidationStatusErrorResource {
193
+ error: string;
194
+ location: string;
195
+ location_type: string;
196
+ type?: string;
197
+ }
198
+ export interface ValidationStatusResponseResource {
199
+ errors: ValidationStatusErrorResource[];
200
+ is_valid?: boolean;
201
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companieshouse/api-sdk-node",
3
- "version": "2.0.222",
3
+ "version": "2.0.224",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [