@companieshouse/api-sdk-node 2.0.283 → 2.0.285
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 +4 -0
- package/dist/client.d.ts +2 -0
- package/dist/client.js +2 -0
- package/dist/client.js.map +1 -1
- package/dist/services/sic-code/index.d.ts +2 -0
- package/dist/services/sic-code/index.js +20 -0
- package/dist/services/sic-code/index.js.map +1 -0
- package/dist/services/sic-code/service.d.ts +8 -0
- package/dist/services/sic-code/service.js +37 -0
- package/dist/services/sic-code/service.js.map +1 -0
- package/dist/services/sic-code/types.d.ts +4 -0
- package/dist/services/sic-code/types.js +3 -0
- package/dist/services/sic-code/types.js.map +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,10 @@ This SDK abstract the calls to our public APIs.
|
|
|
4
4
|
|
|
5
5
|
Intended for use when making cross-web-service calls, supporting ERIC and the propagation of authentication details through to other services.
|
|
6
6
|
|
|
7
|
+
## Compatible Node versions
|
|
8
|
+
|
|
9
|
+
This package has been upgraded to be compatible with Node v24. Presently, it's backward compatible with v20 and v18 but compatibility is primarily required for v24 as all CH Node services are in the process of being upgraded to v24.
|
|
10
|
+
|
|
7
11
|
## Quick start
|
|
8
12
|
|
|
9
13
|
Use NPM to install the SDK in your project;
|
package/dist/client.d.ts
CHANGED
|
@@ -30,6 +30,7 @@ import { AccountsFilingService } from "./services/accounts-filing";
|
|
|
30
30
|
import PscService from "./services/psc/service";
|
|
31
31
|
import { LimitedPartnershipsService } from "./services/limited-partnerships";
|
|
32
32
|
import AssociationsService from "./services/associations/service";
|
|
33
|
+
import { CondensedSicCodeService } from "./services/sic-code";
|
|
33
34
|
/**
|
|
34
35
|
* ApiClient is the class that all service objects hang off.
|
|
35
36
|
*/
|
|
@@ -72,5 +73,6 @@ export default class ApiClient {
|
|
|
72
73
|
readonly pscService: PscService;
|
|
73
74
|
readonly limitedPartnershipsService: LimitedPartnershipsService;
|
|
74
75
|
readonly associationsService: AssociationsService;
|
|
76
|
+
readonly sicCodeService: CondensedSicCodeService;
|
|
75
77
|
constructor(apiClient: IHttpClient, accountClient: IHttpClient);
|
|
76
78
|
}
|
package/dist/client.js
CHANGED
|
@@ -33,6 +33,7 @@ const accounts_filing_1 = require("./services/accounts-filing");
|
|
|
33
33
|
const service_20 = __importDefault(require("./services/psc/service"));
|
|
34
34
|
const limited_partnerships_1 = require("./services/limited-partnerships");
|
|
35
35
|
const service_21 = __importDefault(require("./services/associations/service"));
|
|
36
|
+
const sic_code_1 = require("./services/sic-code");
|
|
36
37
|
/**
|
|
37
38
|
* ApiClient is the class that all service objects hang off.
|
|
38
39
|
*/
|
|
@@ -78,6 +79,7 @@ class ApiClient {
|
|
|
78
79
|
this.pscService = new service_20.default(apiClient);
|
|
79
80
|
this.limitedPartnershipsService = new limited_partnerships_1.LimitedPartnershipsService(apiClient);
|
|
80
81
|
this.associationsService = new service_21.default(accountClient);
|
|
82
|
+
this.sicCodeService = new sic_code_1.CondensedSicCodeService(apiClient);
|
|
81
83
|
}
|
|
82
84
|
}
|
|
83
85
|
exports.default = ApiClient;
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAO2B;AAC3B,iDAAqD;AACrD,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,2FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AACjF,oEAAqE;AACrE,8DAAwE;AACxE,mFAAmE;AACnE,sFAAyE;AACzE,iFAAqE;AACrE,uEAAkD;AAClD,2FAAwF;AAExF,gEAAmE;AACnE,wFAA8E;AAC9E,gEAAmE;AACnE,sEAAgD;AAChD,0EAA4E;AAC5E,+EAAkE;
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAO2B;AAC3B,iDAAqD;AACrD,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,2FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AACjF,oEAAqE;AACrE,8DAAwE;AACxE,mFAAmE;AACnE,sFAAyE;AACzE,iFAAqE;AACrE,uEAAkD;AAClD,2FAAwF;AAExF,gEAAmE;AACnE,wFAA8E;AAC9E,gEAAmE;AACnE,sEAAgD;AAChD,0EAA4E;AAC5E,+EAAkE;AAClE,kDAA8D;AAE9D;;GAEG;AACH,MAAqB,SAAS;IAuC1B,YAAsB,SAAsB,EAAW,aAA0B;QAA3D,cAAS,GAAT,SAAS,CAAa;QAAW,kBAAa,GAAb,aAAa,CAAa;QAC7E,iDAAiD;QACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,8BAAwB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,iBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA2B,CAAC,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,4BAA4B,GAAG,IAAI,qDAA4B,CAAC,SAAS,CAAC,CAAC;QAChF,IAAI,CAAC,WAAW,GAAG,IAAI,0BAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,eAAe,GAAG,IAAI,8BAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAc,CAAC,SAAS,CAAC,CAAC,CAAC,6EAA6E;QAC3H,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAe,CAAC,SAAS,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAmB,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAY,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAgB,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,kBAAoB,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,kBAAW,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,CAAC,qBAAqB,GAAG,IAAI,gCAAqB,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,GAAG,GAAG,IAAI,kBAAU,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,IAAI,iBAAyB,CAAC,SAAS,CAAC,CAAC;QACnE,IAAI,CAAC,eAAe,GAAG,IAAI,iBAAsB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,cAAc,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,iEAAiE;QACjE,4DAA4D;QAC5D,IAAI,CAAC,YAAY,GAAG,IAAI,mCAAmB,CAAC,aAAa,CAAC,CAAC;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,iBAAqB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,oBAAoB,GAAG,IAAI,kBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,6BAA6B,GAAG,IAAI,kBAA6B,CAAC,SAAS,CAAC,CAAC;QAClF,IAAI,CAAC,cAAc,GAAG,IAAI,uCAAqB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,sBAAsB,GAAG,IAAI,kBAAsB,CAAC,SAAS,CAAC,CAAC;QACpE,IAAI,CAAC,qBAAqB,GAAG,IAAI,uCAAqB,CAAC,SAAS,CAAC,CAAC;QAClE,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAU,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,CAAC,0BAA0B,GAAG,IAAI,iDAA0B,CAAC,SAAS,CAAC,CAAC;QAC5E,IAAI,CAAC,mBAAmB,GAAG,IAAI,kBAAmB,CAAC,aAAa,CAAC,CAAC;QAClE,IAAI,CAAC,cAAc,GAAG,IAAI,kCAAuB,CAAC,SAAS,CAAC,CAAC;IACjE,CAAC;CACJ;AAhFD,4BAgFC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
|
|
5
|
+
}) : (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
o[k2] = m[k];
|
|
8
|
+
}));
|
|
9
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
10
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
11
|
+
};
|
|
12
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
13
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
14
|
+
};
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.CondensedSicCodeService = void 0;
|
|
17
|
+
__exportStar(require("./types"), exports);
|
|
18
|
+
var service_1 = require("./service");
|
|
19
|
+
Object.defineProperty(exports, "CondensedSicCodeService", { enumerable: true, get: function () { return __importDefault(service_1).default; } });
|
|
20
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/sic-code/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,qCAA+D;AAAtD,mIAAA,OAAO,OAA2B"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { CondensedSicCodeData } from "./types";
|
|
2
|
+
import { IHttpClient } from "../../http";
|
|
3
|
+
import Resource from "../resource";
|
|
4
|
+
export default class {
|
|
5
|
+
private readonly client;
|
|
6
|
+
constructor(client: IHttpClient);
|
|
7
|
+
getCondensedSicCodes(): Promise<Resource<CondensedSicCodeData[]>>;
|
|
8
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
class default_1 {
|
|
13
|
+
constructor(client) {
|
|
14
|
+
this.client = client;
|
|
15
|
+
}
|
|
16
|
+
getCondensedSicCodes() {
|
|
17
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
18
|
+
const url = "/internal/condensed-sic-codes";
|
|
19
|
+
const resp = yield this.client.httpGet(url);
|
|
20
|
+
const resource = {
|
|
21
|
+
httpStatusCode: resp.status
|
|
22
|
+
};
|
|
23
|
+
if (resp.error && resp.status !== 400) {
|
|
24
|
+
resource.resource = resp.error;
|
|
25
|
+
return resource;
|
|
26
|
+
}
|
|
27
|
+
const apiResource = resp.body ? resp.body : resp.error;
|
|
28
|
+
if (!apiResource) {
|
|
29
|
+
throw new Error(`No body or error body returned from ${url} API call - http status from API = ${resp.status}`);
|
|
30
|
+
}
|
|
31
|
+
resource.resource = apiResource;
|
|
32
|
+
return resource;
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
exports.default = default_1;
|
|
37
|
+
//# sourceMappingURL=service.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/sic-code/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA;IACI,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAExC,oBAAoB;;YAC7B,MAAM,GAAG,GAAW,+BAA+B,CAAC;YAEpD,MAAM,IAAI,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAE1D,MAAM,QAAQ,GAAqC;gBAC/C,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,EAAE;gBACnC,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC;gBAC/B,OAAO,QAAQ,CAAC;aACnB;YAED,MAAM,WAAW,GAA2B,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;YAE/E,IAAI,CAAC,WAAW,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,uCAAuC,GAAG,sCAAsC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;aAClH;YACD,QAAQ,CAAC,QAAQ,GAAG,WAAW,CAAC;YAEhC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AA1BD,4BA0BC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/sic-code/types.ts"],"names":[],"mappings":""}
|