@companieshouse/api-sdk-node 1.0.96 → 1.0.99

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.
Files changed (30) hide show
  1. package/dist/client.d.ts +4 -0
  2. package/dist/client.js +4 -0
  3. package/dist/client.js.map +1 -1
  4. package/dist/services/order/search/index.d.ts +2 -0
  5. package/dist/services/order/search/index.js +17 -0
  6. package/dist/services/order/search/index.js.map +1 -0
  7. package/dist/services/order/search/service.d.ts +8 -0
  8. package/dist/services/order/search/service.js +44 -0
  9. package/dist/services/order/search/service.js.map +1 -0
  10. package/dist/services/order/search/types.d.ts +18 -0
  11. package/dist/services/order/search/types.js +3 -0
  12. package/dist/services/order/search/types.js.map +1 -0
  13. package/dist/services/overseas-entities/index.d.ts +2 -0
  14. package/dist/services/overseas-entities/index.js +20 -0
  15. package/dist/services/overseas-entities/index.js.map +1 -0
  16. package/dist/services/overseas-entities/mapping.d.ts +2 -0
  17. package/dist/services/overseas-entities/mapping.js +11 -0
  18. package/dist/services/overseas-entities/mapping.js.map +1 -0
  19. package/dist/services/overseas-entities/service.d.ts +8 -0
  20. package/dist/services/overseas-entities/service.js +36 -0
  21. package/dist/services/overseas-entities/service.js.map +1 -0
  22. package/dist/services/overseas-entities/types.d.ts +56 -0
  23. package/dist/services/overseas-entities/types.js +19 -0
  24. package/dist/services/overseas-entities/types.js.map +1 -0
  25. package/dist/services/search/advanced-search/service.d.ts +1 -1
  26. package/dist/services/search/advanced-search/service.js +5 -1
  27. package/dist/services/search/advanced-search/service.js.map +1 -1
  28. package/dist/services/search/advanced-search/types.d.ts +2 -0
  29. package/dist/services/transaction/types.d.ts +1 -1
  30. package/package.json +1 -1
package/dist/client.d.ts CHANGED
@@ -15,6 +15,8 @@ import PSCDiscrepanciesReportService from "./services/psc-discrepancies-report/s
15
15
  import TransactionService from "./services/transaction/service";
16
16
  import CompanyPscStatementsService from "./services/company-psc-statements/service";
17
17
  import { ConfirmationStatementService } from "./services/confirmation-statement";
18
+ import { OverseasEntityService } from "./services/overseas-entities";
19
+ import { OrderSearchService } from "./services/order/search/service";
18
20
  /**
19
21
  * ApiClient is the class that all service objects hang off.
20
22
  */
@@ -34,6 +36,7 @@ export default class ApiClient {
34
36
  readonly payment: PaymentService;
35
37
  readonly checkout: CheckoutService;
36
38
  readonly order: OrderService;
39
+ readonly orderSearchService: OrderSearchService;
37
40
  readonly mid: MidService;
38
41
  readonly refreshToken: RefreshTokenService;
39
42
  readonly alphabeticalSearch: AlphabeticalSearchService;
@@ -42,5 +45,6 @@ export default class ApiClient {
42
45
  readonly pscDiscrepancies: PSCDiscrepancyService;
43
46
  readonly pscDiscrepancyReport: PSCDiscrepanciesReportService;
44
47
  readonly transaction: TransactionService;
48
+ readonly overseasEntity: OverseasEntityService;
45
49
  constructor(apiClient: IHttpClient, accountClient: IHttpClient);
46
50
  }
package/dist/client.js CHANGED
@@ -19,6 +19,8 @@ const service_9 = __importDefault(require("./services/psc-discrepancies-report/s
19
19
  const service_10 = __importDefault(require("./services/transaction/service"));
20
20
  const service_11 = __importDefault(require("./services/company-psc-statements/service"));
21
21
  const confirmation_statement_1 = require("./services/confirmation-statement");
22
+ const overseas_entities_1 = require("./services/overseas-entities");
23
+ const service_12 = require("./services/order/search/service");
22
24
  /**
23
25
  * ApiClient is the class that all service objects hang off.
24
26
  */
@@ -40,10 +42,12 @@ class ApiClient {
40
42
  this.payment = new payment_1.PaymentService(apiClient); // TODO split payments url/domain into a separate config item and http client
41
43
  this.checkout = new order_1.CheckoutService(apiClient);
42
44
  this.order = new order_1.OrderService(apiClient);
45
+ this.orderSearchService = new service_12.OrderSearchService(apiClient);
43
46
  this.mid = new order_1.MidService(apiClient);
44
47
  this.alphabeticalSearch = new service_6.default(apiClient);
45
48
  this.dissolvedSearch = new service_7.default(apiClient);
46
49
  this.advancedSearch = new service_5.default(apiClient);
50
+ this.overseasEntity = new overseas_entities_1.OverseasEntityService(apiClient);
47
51
  // service on the account/identity domain using the accountClient
48
52
  // e.g. user profile service can be added here when required
49
53
  this.refreshToken = new refresh_token_1.RefreshTokenService(accountClient);
@@ -1 +1 @@
1
- {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAAyI;AACzI,iDAAqD;AACrD,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,0FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AAEjF;;GAEG;AACH,MAAqB,SAAS;IAuB5B,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,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,KAAK,GAAG,IAAI,oBAAY,CAAC,SAAS,CAAC,CAAC;QACzC,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,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,iBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AAjDD,4BAiDC"}
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;AACA,kFAAyE;AACzE,iFAAuE;AACvE,6EAA+D;AAC/D,wCAA0D;AAC1D,6CAAyI;AACzI,iDAAqD;AACrD,wFAAoF;AACpF,4DAA+D;AAC/D,wFAA8E;AAC9E,4FAAsF;AACtF,yFAAgF;AAChF,mFAAyE;AACzE,0FAAwF;AACxF,8EAAgE;AAChE,yFAAoF;AACpF,8EAAiF;AACjF,oEAAqE;AACrE,8DAAqE;AAErE;;GAEG;AACH,MAAqB,SAAS;IAyB5B,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,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,KAAK,GAAG,IAAI,oBAAY,CAAC,SAAS,CAAC,CAAC;QACzC,IAAI,CAAC,kBAAkB,GAAG,IAAI,6BAAkB,CAAC,SAAS,CAAC,CAAC;QAC5D,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,iBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AArDD,4BAqDC"}
@@ -0,0 +1,2 @@
1
+ export * from "./types";
2
+ export { OrderSearchService } from "./service";
@@ -0,0 +1,17 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
13
+ exports.OrderSearchService = void 0;
14
+ __exportStar(require("./types"), exports);
15
+ var service_1 = require("./service");
16
+ Object.defineProperty(exports, "OrderSearchService", { enumerable: true, get: function () { return service_1.OrderSearchService; } });
17
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/order/search/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,0CAAwB;AACxB,qCAA+C;AAAtC,6GAAA,kBAAkB,OAAA"}
@@ -0,0 +1,8 @@
1
+ import { ApiResponse, ApiResult } from "../../resource";
2
+ import { SearchRequest, SearchResponse } from "./types";
3
+ import { IHttpClient } from "../../../http";
4
+ export declare class OrderSearchService {
5
+ private readonly client;
6
+ constructor(client: IHttpClient);
7
+ search(request: SearchRequest): Promise<ApiResult<ApiResponse<SearchResponse>>>;
8
+ }
@@ -0,0 +1,44 @@
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
+ var __importDefault = (this && this.__importDefault) || function (mod) {
12
+ return (mod && mod.__esModule) ? mod : { "default": mod };
13
+ };
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.OrderSearchService = void 0;
16
+ const result_1 = require("../../result");
17
+ const mapping_1 = __importDefault(require("../../../mapping/mapping"));
18
+ class OrderSearchService {
19
+ constructor(client) {
20
+ this.client = client;
21
+ }
22
+ search(request) {
23
+ return __awaiter(this, void 0, void 0, function* () {
24
+ const serverRequest = mapping_1.default.snakeCaseKeys(request);
25
+ const queryParams = Object.keys(serverRequest).map(key => key + "=" + serverRequest[key]).join("&");
26
+ const serverResponse = yield this.client.httpGet("/orders/search" + queryParams ? "?" + queryParams : "");
27
+ const response = {
28
+ httpStatusCode: serverResponse.status
29
+ };
30
+ if (serverResponse.error) {
31
+ return result_1.failure({
32
+ httpStatusCode: serverResponse.status,
33
+ errors: serverResponse.error.errors
34
+ });
35
+ }
36
+ else {
37
+ response.resource = mapping_1.default.camelCaseKeys(serverResponse.body);
38
+ return result_1.success(response);
39
+ }
40
+ });
41
+ }
42
+ }
43
+ exports.OrderSearchService = OrderSearchService;
44
+ //# sourceMappingURL=service.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../../src/services/order/search/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAGA,yCAAgD;AAChD,uEAA+C;AAE/C,MAAa,kBAAkB;IAC3B,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IACjD,CAAC;IAEY,MAAM,CAAE,OAAsB;;YACvC,MAAM,aAAa,GAAG,iBAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACrD,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACpG,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC1G,MAAM,QAAQ,GAAgC;gBAC1C,cAAc,EAAE,cAAc,CAAC,MAAM;aACxC,CAAC;YAEF,IAAI,cAAc,CAAC,KAAK,EAAE;gBACtB,OAAO,gBAAO,CAAC;oBACX,cAAc,EAAE,cAAc,CAAC,MAAM;oBACrC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,MAAM;iBACtC,CAAC,CAAC;aACN;iBAAM;gBACH,QAAQ,CAAC,QAAQ,GAAG,iBAAO,CAAC,aAAa,CAAiB,cAAc,CAAC,IAAI,CAAC,CAAC;gBAC/E,OAAO,gBAAO,CAAC,QAAQ,CAAC,CAAC;aAC5B;QACL,CAAC;KAAA;CACJ;AAtBD,gDAsBC"}
@@ -0,0 +1,18 @@
1
+ export interface SearchRequest {
2
+ orderNumber?: string;
3
+ email?: string;
4
+ companyNumber?: string;
5
+ }
6
+ export interface SearchResponse {
7
+ totalOrders: number;
8
+ orderSummaries: OrderSummary[];
9
+ }
10
+ export interface OrderSummary {
11
+ id: string;
12
+ email: string;
13
+ companyNumber: string;
14
+ productLine: string;
15
+ orderDate: string;
16
+ paymentStatus: string;
17
+ resourceLink: string;
18
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/services/order/search/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export * from "./types";
2
+ export { default as OverseasEntityService } from "./service";
@@ -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.OverseasEntityService = void 0;
17
+ __exportStar(require("./types"), exports);
18
+ var service_1 = require("./service");
19
+ Object.defineProperty(exports, "OverseasEntityService", { 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/overseas-entities/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,qCAA6D;AAApD,iIAAA,OAAO,OAAyB"}
@@ -0,0 +1,2 @@
1
+ import { OverseasEntity } from "./types";
2
+ export declare const mapOverseasEntity: (body: OverseasEntity) => OverseasEntity;
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.mapOverseasEntity = void 0;
4
+ const mapOverseasEntity = (body) => {
5
+ return {
6
+ presenter: Object.assign({}, body.presenter),
7
+ entity: Object.assign({}, body.entity)
8
+ };
9
+ };
10
+ exports.mapOverseasEntity = mapOverseasEntity;
11
+ //# sourceMappingURL=mapping.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mapping.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/mapping.ts"],"names":[],"mappings":";;;AAEO,MAAM,iBAAiB,GAAG,CAAC,IAAoB,EAAkB,EAAE;IACtE,OAAO;QACH,SAAS,oBAAO,IAAI,CAAC,SAAS,CAAE;QAChC,MAAM,oBAAO,IAAI,CAAC,MAAM,CAAE;KAC7B,CAAC;AACN,CAAC,CAAC;AALW,QAAA,iBAAiB,qBAK5B"}
@@ -0,0 +1,8 @@
1
+ import { IHttpClient } from "../../http";
2
+ import { OverseasEntity, OverseasEntityCreated } from "./types";
3
+ import Resource, { ApiErrorResponse } from "../resource";
4
+ export default class OverseasEntityService {
5
+ private readonly client;
6
+ constructor(client: IHttpClient);
7
+ postOverseasEntity(transactionId: string, body: OverseasEntity): Promise<Resource<OverseasEntityCreated> | ApiErrorResponse>;
8
+ }
@@ -0,0 +1,36 @@
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
+ const mapping_1 = require("./mapping");
13
+ class OverseasEntityService {
14
+ constructor(client) {
15
+ this.client = client;
16
+ }
17
+ postOverseasEntity(transactionId, body) {
18
+ return __awaiter(this, void 0, void 0, function* () {
19
+ const URL = `/transactions/${transactionId}/overseas-entity`;
20
+ const response = yield this.client.httpPost(URL, mapping_1.mapOverseasEntity(body));
21
+ if (response.error && response.status !== 400) {
22
+ return {
23
+ httpStatusCode: response.status,
24
+ errors: [response.error]
25
+ };
26
+ }
27
+ const resource = {
28
+ httpStatusCode: response.status
29
+ };
30
+ resource.resource = Object.assign({}, response.body);
31
+ return resource;
32
+ });
33
+ }
34
+ }
35
+ exports.default = OverseasEntityService;
36
+ //# sourceMappingURL=service.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,uCAA8C;AAE9C,MAAqB,qBAAqB;IACtC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,kBAAkB,CAAE,aAAqB,EAAE,IAAoB;;YACxE,MAAM,GAAG,GAAG,iBAAiB,aAAa,kBAAkB,CAAC;YAC7D,MAAM,QAAQ,GAAiB,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,2BAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;YAExF,IAAI,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;gBAC3C,OAAO;oBACH,cAAc,EAAE,QAAQ,CAAC,MAAM;oBAC/B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC3B,CAAC;aACL;YAED,MAAM,QAAQ,GAAoC;gBAC9C,cAAc,EAAE,QAAQ,CAAC,MAAM;aAClC,CAAC;YAEF,QAAQ,CAAC,QAAQ,qBAAQ,QAAQ,CAAC,IAAI,CAAE,CAAC;YACzC,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AArBD,wCAqBC"}
@@ -0,0 +1,56 @@
1
+ /**
2
+ * Overseas Entity interface used within this SDK
3
+ */
4
+ export interface OverseasEntity {
5
+ presenter?: Presenter;
6
+ entity?: Entity;
7
+ }
8
+ export interface OverseasEntityCreated {
9
+ id: string;
10
+ }
11
+ /**
12
+ * Overseas Entities interface used on OverseasEntity object
13
+ */
14
+ export interface Presenter {
15
+ full_name?: string;
16
+ phone_number?: string;
17
+ role?: presenterRole;
18
+ role_title?: string;
19
+ anti_money_laundering_registration_number?: string;
20
+ }
21
+ export interface Entity {
22
+ name?: string;
23
+ incorporation_country?: string;
24
+ principal_address?: Address;
25
+ is_service_address_same_as_principal_address?: yesNoResponse;
26
+ service_address?: Address;
27
+ email?: string;
28
+ legal_form?: string;
29
+ law_governed?: string;
30
+ public_register_name?: string;
31
+ registration_number?: string;
32
+ }
33
+ /**
34
+ * Shared Data Type
35
+ */
36
+ export interface Address {
37
+ property_name_number?: string;
38
+ line_1?: string;
39
+ line_2?: string;
40
+ town?: string;
41
+ county?: string;
42
+ country?: string;
43
+ postcode?: string;
44
+ }
45
+ declare enum yesNoResponse {
46
+ No = 0,
47
+ Yes = 1
48
+ }
49
+ declare enum presenterRole {
50
+ administrator = "administrator",
51
+ agent = "agent",
52
+ solicitor = "solicitor",
53
+ beneficial_owner = "beneficial_owner",
54
+ other = "other"
55
+ }
56
+ export {};
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ /**
3
+ * Overseas Entity interface used within this SDK
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ var yesNoResponse;
7
+ (function (yesNoResponse) {
8
+ yesNoResponse[yesNoResponse["No"] = 0] = "No";
9
+ yesNoResponse[yesNoResponse["Yes"] = 1] = "Yes";
10
+ })(yesNoResponse || (yesNoResponse = {}));
11
+ var presenterRole;
12
+ (function (presenterRole) {
13
+ presenterRole["administrator"] = "administrator";
14
+ presenterRole["agent"] = "agent";
15
+ presenterRole["solicitor"] = "solicitor";
16
+ presenterRole["beneficial_owner"] = "beneficial_owner";
17
+ presenterRole["other"] = "other";
18
+ })(presenterRole || (presenterRole = {}));
19
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/overseas-entities/types.ts"],"names":[],"mappings":";AAAA;;GAEG;;AA+CH,IAAK,aAGJ;AAHD,WAAK,aAAa;IACd,6CAAM,CAAA;IACN,+CAAO,CAAA;AACX,CAAC,EAHI,aAAa,KAAb,aAAa,QAGjB;AAED,IAAK,aAMJ;AAND,WAAK,aAAa;IACd,gDAA+B,CAAA;IAC/B,gCAAe,CAAA;IACf,wCAAuB,CAAA;IACvB,sDAAqC,CAAA;IACrC,gCAAe,CAAA;AACnB,CAAC,EANI,aAAa,KAAb,aAAa,QAMjB"}
@@ -5,5 +5,5 @@ import "url-search-params-polyfill";
5
5
  export default class AdvancedSearchService {
6
6
  private readonly client;
7
7
  constructor(client: IHttpClient);
8
- getCompanies(startIndex: number | null, companyNameIncludes: string | null, companyNameExcludes: string | null, location: string | null, incorporatedFrom: string | null, incorporatedTo: string | null, sicCodes: string | null, companyStatus: string | null, companyType: string | null, dissolvedFrom: string | null, dissolvedTo: string | null, size: number | null, requestId: string): Promise<Resource<CompaniesResource>>;
8
+ getCompanies(startIndex: number | null, companyNameIncludes: string | null, companyNameExcludes: string | null, location: string | null, incorporatedFrom: string | null, incorporatedTo: string | null, sicCodes: string | null, companyStatus: string | null, companyType: string | null, companySubtype: string | null, dissolvedFrom: string | null, dissolvedTo: string | null, size: number | null, requestId: string): Promise<Resource<CompaniesResource>>;
9
9
  }
@@ -14,7 +14,7 @@ class AdvancedSearchService {
14
14
  constructor(client) {
15
15
  this.client = client;
16
16
  }
17
- getCompanies(startIndex, companyNameIncludes, companyNameExcludes, location, incorporatedFrom, incorporatedTo, sicCodes, companyStatus, companyType, dissolvedFrom, dissolvedTo, size, requestId) {
17
+ getCompanies(startIndex, companyNameIncludes, companyNameExcludes, location, incorporatedFrom, incorporatedTo, sicCodes, companyStatus, companyType, companySubtype, dissolvedFrom, dissolvedTo, size, requestId) {
18
18
  return __awaiter(this, void 0, void 0, function* () {
19
19
  const START_INDEX_QUERY = "start_index";
20
20
  const COMPANY_NAME_INCLUDES_QUERY = "company_name_includes";
@@ -25,6 +25,7 @@ class AdvancedSearchService {
25
25
  const SIC_CODES_QUERY = "sic_codes";
26
26
  const COMPANY_STATUS_QUERY = "company_status";
27
27
  const COMPANY_TYPE_QUERY = "company_type";
28
+ const COMPANY_SUBTYPE_QUERY = "company_subtype";
28
29
  const DISSOLVED_FROM_QUERY_PARAMETER = "dissolved_from";
29
30
  const DISSOLVED_TO_QUERY_PARAMETER = "dissolved_to";
30
31
  const SIZE_QUERY_PARAMETER = "size";
@@ -60,6 +61,9 @@ class AdvancedSearchService {
60
61
  if (companyType !== null) {
61
62
  buildAdvancedSearchURL.append(COMPANY_TYPE_QUERY, companyType);
62
63
  }
64
+ if (companySubtype !== null) {
65
+ buildAdvancedSearchURL.append(COMPANY_SUBTYPE_QUERY, companySubtype);
66
+ }
63
67
  if (dissolvedFrom !== null) {
64
68
  buildAdvancedSearchURL.append(DISSOLVED_FROM_QUERY_PARAMETER, dissolvedFrom);
65
69
  }
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../../src/services/search/advanced-search/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,sCAAoC;AAEpC,MAAqB,qBAAqB;IACtC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IACzC,YAAY,CAAE,UAAyB,EAAE,mBAAkC,EAAE,mBAAkC,EAAE,QAAuB,EAAE,gBAA+B,EAClL,cAA6B,EAAE,QAAuB,EAAE,aAA4B,EAAE,WAA0B,EAAE,aAA4B,EAC9I,WAA0B,EAAE,IAAmB,EAAE,SAAiB;;YAClE,MAAM,iBAAiB,GAAG,aAAa,CAAC;YACxC,MAAM,2BAA2B,GAAG,uBAAuB,CAAC;YAC5D,MAAM,2BAA2B,GAAG,uBAAuB,CAAA;YAC3D,MAAM,cAAc,GAAG,UAAU,CAAC;YAClC,MAAM,uBAAuB,GAAG,mBAAmB,CAAC;YACpD,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;YAChD,MAAM,eAAe,GAAG,WAAW,CAAC;YACpC,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;YAC9C,MAAM,kBAAkB,GAAG,cAAc,CAAC;YAC1C,MAAM,8BAA8B,GAAG,gBAAgB,CAAC;YACxD,MAAM,4BAA4B,GAAG,cAAc,CAAC;YACpD,MAAM,oBAAoB,GAAG,MAAM,CAAC;YACpC,MAAM,iBAAiB,GAAG;gBACtB,cAAc,EAAE,SAAS;gBACzB,cAAc,EAAE,kBAAkB;aACrC,CAAA;YAED,MAAM,sBAAsB,GAAG,IAAI,eAAe,CAAC,6BAA6B,CAAC,CAAC;YAElF,IAAI,UAAU,KAAK,IAAI,EAAE;gBACrB,sBAAsB,CAAC,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;aACxE;YAED,IAAI,mBAAmB,KAAK,IAAI,EAAE;gBAC9B,sBAAsB,CAAC,MAAM,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,CAAA;aAClF;YAED,IAAI,mBAAmB,KAAK,IAAI,EAAE;gBAC9B,sBAAsB,CAAC,MAAM,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,CAAA;aAClF;YAED,IAAI,QAAQ,KAAK,IAAI,EAAE;gBACnB,sBAAsB,CAAC,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;aAC1D;YAED,IAAI,gBAAgB,KAAK,IAAI,EAAE;gBAC3B,sBAAsB,CAAC,MAAM,CAAC,uBAAuB,EAAE,gBAAgB,CAAC,CAAA;aAC3E;YAED,IAAI,cAAc,KAAK,IAAI,EAAE;gBACzB,sBAAsB,CAAC,MAAM,CAAC,qBAAqB,EAAE,cAAc,CAAC,CAAA;aACvE;YAED,IAAI,QAAQ,KAAK,IAAI,EAAE;gBACnB,sBAAsB,CAAC,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAA;aAC3D;YAED,IAAI,aAAa,KAAK,IAAI,EAAE;gBACxB,sBAAsB,CAAC,MAAM,CAAC,oBAAoB,EAAE,aAAa,CAAC,CAAC;aACtE;YAED,IAAI,WAAW,KAAK,IAAI,EAAE;gBACtB,sBAAsB,CAAC,MAAM,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAA;aACjE;YAED,IAAI,aAAa,KAAK,IAAI,EAAE;gBACxB,sBAAsB,CAAC,MAAM,CAAC,8BAA8B,EAAE,aAAa,CAAC,CAAA;aAC/E;YAED,IAAI,WAAW,KAAK,IAAI,EAAE;gBACtB,sBAAsB,CAAC,MAAM,CAAC,4BAA4B,EAAE,WAAW,CAAC,CAAA;aAC3E;YAED,IAAI,IAAI,KAAK,IAAI,EAAE;gBACf,sBAAsB,CAAC,MAAM,CAAC,oBAAoB,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;aACpE;YAED,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,QAAQ,EAAE,CAAC;YAE5D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;YAE7E,MAAM,QAAQ,GAAgC;gBAC1C,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAyB,CAAC;YAEnD,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AAxFD,wCAwFC"}
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../../src/services/search/advanced-search/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,sCAAoC;AAEpC,MAAqB,qBAAqB;IACtC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IACzC,YAAY,CAAE,UAAyB,EAAE,mBAAkC,EAAE,mBAAkC,EAAE,QAAuB,EAAE,gBAA+B,EAClL,cAA6B,EAAE,QAAuB,EAAE,aAA4B,EAAE,WAA0B,EAAE,cAA6B,EAAE,aAA4B,EAC7K,WAA0B,EAAE,IAAmB,EAAE,SAAiB;;YAClE,MAAM,iBAAiB,GAAG,aAAa,CAAC;YACxC,MAAM,2BAA2B,GAAG,uBAAuB,CAAC;YAC5D,MAAM,2BAA2B,GAAG,uBAAuB,CAAA;YAC3D,MAAM,cAAc,GAAG,UAAU,CAAC;YAClC,MAAM,uBAAuB,GAAG,mBAAmB,CAAC;YACpD,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;YAChD,MAAM,eAAe,GAAG,WAAW,CAAC;YACpC,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;YAC9C,MAAM,kBAAkB,GAAG,cAAc,CAAC;YAC1C,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;YAChD,MAAM,8BAA8B,GAAG,gBAAgB,CAAC;YACxD,MAAM,4BAA4B,GAAG,cAAc,CAAC;YACpD,MAAM,oBAAoB,GAAG,MAAM,CAAC;YACpC,MAAM,iBAAiB,GAAG;gBACtB,cAAc,EAAE,SAAS;gBACzB,cAAc,EAAE,kBAAkB;aACrC,CAAA;YAED,MAAM,sBAAsB,GAAG,IAAI,eAAe,CAAC,6BAA6B,CAAC,CAAC;YAElF,IAAI,UAAU,KAAK,IAAI,EAAE;gBACrB,sBAAsB,CAAC,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;aACxE;YAED,IAAI,mBAAmB,KAAK,IAAI,EAAE;gBAC9B,sBAAsB,CAAC,MAAM,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,CAAA;aAClF;YAED,IAAI,mBAAmB,KAAK,IAAI,EAAE;gBAC9B,sBAAsB,CAAC,MAAM,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,CAAA;aAClF;YAED,IAAI,QAAQ,KAAK,IAAI,EAAE;gBACnB,sBAAsB,CAAC,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;aAC1D;YAED,IAAI,gBAAgB,KAAK,IAAI,EAAE;gBAC3B,sBAAsB,CAAC,MAAM,CAAC,uBAAuB,EAAE,gBAAgB,CAAC,CAAA;aAC3E;YAED,IAAI,cAAc,KAAK,IAAI,EAAE;gBACzB,sBAAsB,CAAC,MAAM,CAAC,qBAAqB,EAAE,cAAc,CAAC,CAAA;aACvE;YAED,IAAI,QAAQ,KAAK,IAAI,EAAE;gBACnB,sBAAsB,CAAC,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAA;aAC3D;YAED,IAAI,aAAa,KAAK,IAAI,EAAE;gBACxB,sBAAsB,CAAC,MAAM,CAAC,oBAAoB,EAAE,aAAa,CAAC,CAAC;aACtE;YAED,IAAI,WAAW,KAAK,IAAI,EAAE;gBACtB,sBAAsB,CAAC,MAAM,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAA;aACjE;YAED,IAAI,cAAc,KAAK,IAAI,EAAE;gBACzB,sBAAsB,CAAC,MAAM,CAAC,qBAAqB,EAAE,cAAc,CAAC,CAAA;aACvE;YAED,IAAI,aAAa,KAAK,IAAI,EAAE;gBACxB,sBAAsB,CAAC,MAAM,CAAC,8BAA8B,EAAE,aAAa,CAAC,CAAA;aAC/E;YAED,IAAI,WAAW,KAAK,IAAI,EAAE;gBACtB,sBAAsB,CAAC,MAAM,CAAC,4BAA4B,EAAE,WAAW,CAAC,CAAA;aAC3E;YAED,IAAI,IAAI,KAAK,IAAI,EAAE;gBACf,sBAAsB,CAAC,MAAM,CAAC,oBAAoB,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;aACpE;YAED,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,QAAQ,EAAE,CAAC;YAE5D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;YAE7E,MAAM,QAAQ,GAAgC;gBAC1C,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,QAAQ,CAAC;aACnB;YAED,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAyB,CAAC;YAEnD,OAAO,QAAQ,CAAC;QACpB,CAAC;KAAA;CACJ;AA7FD,wCA6FC"}
@@ -10,6 +10,7 @@ export interface Items {
10
10
  company_number: string;
11
11
  company_status: string;
12
12
  company_type: string;
13
+ company_subtype: string;
13
14
  kind: string;
14
15
  links: Links;
15
16
  date_of_cessation: Date;
@@ -31,6 +32,7 @@ export interface TopHit {
31
32
  company_number: string;
32
33
  company_status: string;
33
34
  company_type: string;
35
+ company_subtype: string;
34
36
  kind: string;
35
37
  links: Links;
36
38
  date_of_cessation: Date;
@@ -40,7 +40,7 @@ export interface Transaction {
40
40
  status?: string;
41
41
  kind?: string;
42
42
  companyName?: string;
43
- companyNumber: string;
43
+ companyNumber?: string;
44
44
  createdAt?: string;
45
45
  createdBy?: {
46
46
  language: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companieshouse/api-sdk-node",
3
- "version": "1.0.96",
3
+ "version": "1.0.99",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [