@companieshouse/api-sdk-node 2.0.79 → 2.0.80
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
|
-
import { CompanyOfficer, FilingResponse, OfficerFiling } from "./types";
|
|
1
|
+
import { CompanyOfficer, FilingResponse, OfficerFiling, ValidationStatusResponse } from "./types";
|
|
2
2
|
import { IHttpClient } from "../../http";
|
|
3
3
|
import Resource, { ApiErrorResponse } from "../resource";
|
|
4
4
|
export default class {
|
|
5
5
|
private readonly client;
|
|
6
6
|
constructor(client: IHttpClient);
|
|
7
7
|
getListActiveDirectorDetails(transactionId: string): Promise<Resource<CompanyOfficer[]> | ApiErrorResponse>;
|
|
8
|
+
getValidationStatus(transactionId: string, submissionId: string): Promise<Resource<ValidationStatusResponse> | ApiErrorResponse>;
|
|
8
9
|
private getOfficerFilingUrlIncTransactionId;
|
|
9
10
|
private getOfficerFilingUrlIncTransactionIdAndSubmissionId;
|
|
10
11
|
/**
|
|
@@ -15,6 +16,7 @@ export default class {
|
|
|
15
16
|
*/
|
|
16
17
|
getDirectorAndTerminationDate(transactionId: string, submissionId: string): Promise<Resource<CompanyOfficer> | ApiErrorResponse>;
|
|
17
18
|
getCurrentOrFutureDissolved(companyNumber: String): Promise<Resource<Boolean> | ApiErrorResponse>;
|
|
19
|
+
private getValidationStatusResponse;
|
|
18
20
|
/**
|
|
19
21
|
* Post an officer filing object to update on the API.
|
|
20
22
|
*/
|
|
@@ -23,6 +23,12 @@ class default_1 {
|
|
|
23
23
|
return this.getCompanyOfficerDetails(url);
|
|
24
24
|
});
|
|
25
25
|
}
|
|
26
|
+
getValidationStatus(transactionId, submissionId) {
|
|
27
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
28
|
+
const url = `${this.getOfficerFilingUrlIncTransactionIdAndSubmissionId(transactionId, submissionId)}/validation_status`;
|
|
29
|
+
return this.getValidationStatusResponse(url);
|
|
30
|
+
});
|
|
31
|
+
}
|
|
26
32
|
getOfficerFilingUrlIncTransactionId(transactionId) {
|
|
27
33
|
return `/transactions/${transactionId}/officers`;
|
|
28
34
|
}
|
|
@@ -51,6 +57,18 @@ class default_1 {
|
|
|
51
57
|
return { httpStatusCode: resp.status, resource: resp.body };
|
|
52
58
|
});
|
|
53
59
|
}
|
|
60
|
+
getValidationStatusResponse(url) {
|
|
61
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
62
|
+
const resp = yield this.client.httpGet(url);
|
|
63
|
+
if (resp.status >= 400) {
|
|
64
|
+
return { httpStatusCode: resp.status, errors: [resp.error] };
|
|
65
|
+
}
|
|
66
|
+
const resource = { httpStatusCode: resp.status };
|
|
67
|
+
const body = resp.body;
|
|
68
|
+
resource.resource = mapping_1.default.camelCaseKeys(body);
|
|
69
|
+
return resource;
|
|
70
|
+
});
|
|
71
|
+
}
|
|
54
72
|
/**
|
|
55
73
|
* Post an officer filing object to update on the API.
|
|
56
74
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/officer-filing/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/officer-filing/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAYA,oEAA4C;AAE5C;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,4BAA4B,CAAE,aAAqB;;YAC5D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,mCAAmC,CAAC,aAAa,CAAC,2BAA2B,CAAC;YAClG,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;KAAA;IAEY,mBAAmB,CAAE,aAAqB,EAAE,YAAoB;;YACzE,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,kDAAkD,CAAC,aAAa,EAAE,YAAY,CAAC,oBAAoB,CAAC;YACxH,OAAO,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;QACjD,CAAC;KAAA;IAEO,mCAAmC,CAAE,aAAqB;QAC9D,OAAO,iBAAiB,aAAa,WAAW,CAAC;IACrD,CAAC;IAEO,kDAAkD,CAAE,aAAqB,EAAE,YAAoB;QACnG,OAAO,iBAAiB,aAAa,aAAa,YAAY,GAAG,CAAC;IACtE,CAAC;IAED;;;;;MAKE;IACW,6BAA6B,CAAE,aAAqB,EAAE,YAAoB;;YACnF,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,kDAAkD,CAAC,aAAa,EAAE,YAAY,CAAC,uCAAuC,CAAC;YAC3I,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;KAAA;IAEY,2BAA2B,CAAE,aAAqB;;YAC3D,MAAM,GAAG,GAAG,2BAA2B,aAAa,0CAA0C,CAAC;YAC/F,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,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAe,EAAE,CAAC;QAC3E,CAAC;KAAA;IAEa,2BAA2B,CAAE,GAAW;;YAClD,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,GAAuC,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YAErF,MAAM,IAAI,GAAG,IAAI,CAAC,IAA0C,CAAC;YAE7D,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAA2B,IAAI,CAAC,CAAC;YAE1E,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;OAEG;IACU,iBAAiB,CAAE,aAAqB,EAAE,aAA4B;;YAC/E,MAAM,GAAG,GAAG,iBAAiB,aAAa,WAAW,CAAC;YACtD,MAAM,qBAAqB,GAAqB,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAE7E,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;YACpE,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,MAAM,QAAQ,GAA6B;gBACvC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YACF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAyB,CAAC;YAC5C,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;OAEG;IACU,kBAAkB,CAAE,aAAqB,EAAE,QAAgB,EAAE,aAA4B;;YAClG,MAAM,GAAG,GAAG,iBAAiB,aAAa,aAAa,QAAQ,EAAE,CAAC;YAClE,MAAM,qBAAqB,GAAqB,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAE7E,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;YACrE,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO;oBACH,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;iBACvB,CAAC;aACL;YAED,MAAM,QAAQ,GAA6B;gBACvC,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YACF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAyB,CAAC;YAC5C,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;IAED;;OAEG;IACK,QAAQ,CAAE,aAA4B;QAC1C,OAAO;YACH,wBAAwB,EAAE,aAAa,CAAC,sBAAsB;YAC9D,cAAc,EAAE,aAAa,CAAC,aAAa;YAC3C,WAAW,EAAE,aAAa,CAAC,UAAU;SACxC,CAAA;IACL,CAAC;IAED;;;;OAIG;IACK,gBAAgB,CAAE,QAAkC,EAAE,IAAuB;QACjF,QAAQ,CAAC,QAAQ,GAAG;YAChB,YAAY,EAAE,IAAI,CAAC,aAAa;YAChC,IAAI,EAAE,IAAI,CAAC,IAAI;SAClB,CAAC;IACN,CAAC;IAEa,wBAAwB,CAAE,GAAW;;YAC/C,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,GAA+B,EAAE,cAAc,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;YAE7E,MAAM,IAAI,GAAG,IAAI,CAAC,IAAgC,CAAC;YAEnD,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAmB,IAAI,CAAC,CAAC;YAElE,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AA/ID,4BA+IC"}
|
|
@@ -49,6 +49,16 @@ export interface CompanyOfficerResourceLinks {
|
|
|
49
49
|
export interface OfficerResourceLinks {
|
|
50
50
|
appointments: string;
|
|
51
51
|
}
|
|
52
|
+
export interface ValidationStatusErrorResource {
|
|
53
|
+
error: string;
|
|
54
|
+
location: string;
|
|
55
|
+
location_type: string;
|
|
56
|
+
type?: string;
|
|
57
|
+
}
|
|
58
|
+
export interface ValidationStatusResponseResource {
|
|
59
|
+
errors: ValidationStatusErrorResource[];
|
|
60
|
+
is_valid?: boolean;
|
|
61
|
+
}
|
|
52
62
|
/**
|
|
53
63
|
* CompanyOfficers is the interface used within this SDK.
|
|
54
64
|
*/
|
|
@@ -104,6 +114,16 @@ export interface CompanyOfficerLinks {
|
|
|
104
114
|
export interface OfficerLinks {
|
|
105
115
|
appointments: string;
|
|
106
116
|
}
|
|
117
|
+
export interface ValidationStatusError {
|
|
118
|
+
error: string;
|
|
119
|
+
location: string;
|
|
120
|
+
locationType: string;
|
|
121
|
+
type?: string;
|
|
122
|
+
}
|
|
123
|
+
export interface ValidationStatusResponse {
|
|
124
|
+
errors: ValidationStatusError[];
|
|
125
|
+
isValid?: boolean;
|
|
126
|
+
}
|
|
107
127
|
/**
|
|
108
128
|
* The response returned when a filing has been sent to the api. The submission ID can be used to refer back to the saved filing.
|
|
109
129
|
*/
|