@companieshouse/api-sdk-node 2.0.91 → 2.0.93

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/dist/client.d.ts CHANGED
@@ -21,6 +21,7 @@ import { CheckoutSearchService } from "./services/order/search/service";
21
21
  import OrderItemService from "./services/order/order-item/service";
22
22
  import CheckoutItemService from "./services/order/checkout-item/service";
23
23
  import OfficerFilingService from "./services/officer-filing/service";
24
+ import RegisteredEmailAddressService from "./services/registered-email-address/service";
24
25
  import { ClientType } from "./enums";
25
26
  /**
26
27
  * ApiClient is the class that all service objects hang off.
@@ -54,6 +55,7 @@ export default class ApiClient {
54
55
  readonly pscDiscrepancies: PSCDiscrepancyService;
55
56
  readonly pscDiscrepancyReport: PSCDiscrepanciesReportService;
56
57
  readonly transaction: TransactionService;
58
+ readonly registeredEmailAddressService: RegisteredEmailAddressService;
57
59
  readonly overseasEntity: OverseasEntityService;
58
60
  readonly officerFiling: OfficerFilingService;
59
61
  constructor(apiClient: IHttpClient, accountClient: IHttpClient);
package/dist/client.js CHANGED
@@ -25,6 +25,7 @@ const service_13 = require("./services/order/search/service");
25
25
  const service_14 = __importDefault(require("./services/order/order-item/service"));
26
26
  const service_15 = __importDefault(require("./services/order/checkout-item/service"));
27
27
  const service_16 = __importDefault(require("./services/officer-filing/service"));
28
+ const service_17 = __importDefault(require("./services/registered-email-address/service"));
28
29
  /**
29
30
  * ApiClient is the class that all service objects hang off.
30
31
  */
@@ -62,6 +63,7 @@ class ApiClient {
62
63
  this.pscDiscrepancies = new service_9.default(apiClient);
63
64
  this.pscDiscrepancyReport = new service_10.default(apiClient);
64
65
  this.transaction = new service_11.default(apiClient);
66
+ this.registeredEmailAddressService = new service_17.default(apiClient);
65
67
  }
66
68
  }
67
69
  exports.default = ApiClient;
@@ -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;AAGrE;;GAEG;AACH,MAAqB,SAAS;IA8B5B,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,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;IACzD,CAAC;CACF;AA9DD,4BA8DC"}
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,2FAAwF;AAGxF;;GAEG;AACH,MAAqB,SAAS;IA+B5B,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,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;IACtF,CAAC;CACF;AAhED,4BAgEC"}
@@ -10,6 +10,9 @@ export interface CompanyOfficerResource {
10
10
  identification?: IdentificationResource;
11
11
  links: CompanyOfficerResourceLinks;
12
12
  name: string;
13
+ forename?: string;
14
+ surname?: string;
15
+ other_forenames?: string;
13
16
  nationality?: string;
14
17
  occupation?: string;
15
18
  officer_role: string;
@@ -75,6 +78,9 @@ export interface CompanyOfficer {
75
78
  identification?: Identification;
76
79
  links: CompanyOfficerLinks;
77
80
  name: string;
81
+ forename?: string;
82
+ surname?: string;
83
+ otherForenames?: string;
78
84
  nationality?: string;
79
85
  occupation?: string;
80
86
  officerRole: string;
@@ -0,0 +1,16 @@
1
+ import { IHttpClient } from "../../http";
2
+ import Resource, { ApiErrorResponse } from "../resource";
3
+ import { RegisteredEmailAddress } from "./types";
4
+ export default class RegisteredEmailAddressService {
5
+ private readonly client;
6
+ constructor(client: IHttpClient);
7
+ /**
8
+ * Create a Registered Email Address.
9
+ *
10
+ * @param transactionId
11
+ * @param registeredEmailAddress
12
+ */
13
+ postRegisteredEmailAddress(transactionId: string, registeredEmailAddress: RegisteredEmailAddress): Promise<Resource<RegisteredEmailAddress> | ApiErrorResponse>;
14
+ private populateResource;
15
+ private mapToResource;
16
+ }
@@ -0,0 +1,51 @@
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 RegisteredEmailAddressService {
13
+ constructor(client) {
14
+ this.client = client;
15
+ }
16
+ /**
17
+ * Create a Registered Email Address.
18
+ *
19
+ * @param transactionId
20
+ * @param registeredEmailAddress
21
+ */
22
+ postRegisteredEmailAddress(transactionId, registeredEmailAddress) {
23
+ return __awaiter(this, void 0, void 0, function* () {
24
+ const url = `/transactions/${registeredEmailAddress}/registered-email-address`;
25
+ const registeredEmailAddressResource = this.mapToResource(registeredEmailAddress);
26
+ const resp = yield this.client.httpPost(url, registeredEmailAddressResource);
27
+ if (resp.error) {
28
+ return Promise.reject(resp);
29
+ }
30
+ const resource = {
31
+ httpStatusCode: resp.status
32
+ };
33
+ // cast the response body to the expected type
34
+ const body = resp.body;
35
+ this.populateResource(resource, body);
36
+ return Promise.resolve(resource);
37
+ });
38
+ }
39
+ populateResource(resource, body) {
40
+ resource.resource = {
41
+ registeredEmailAddress: body.registered_email_address
42
+ };
43
+ }
44
+ mapToResource(registeredEmailAddress) {
45
+ return {
46
+ registered_email_address: registeredEmailAddress.registeredEmailAddress
47
+ };
48
+ }
49
+ }
50
+ exports.default = RegisteredEmailAddressService;
51
+ //# sourceMappingURL=service.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/services/registered-email-address/service.ts"],"names":[],"mappings":";;;;;;;;;;;AAIA,MAAqB,6BAA6B;IAC9C,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IACjD,CAAC;IAED;;;;;OAKG;IACU,0BAA0B,CAAE,aAAqB,EAAE,sBAA8C;;YAC1G,MAAM,GAAG,GAAG,iBAAiB,sBAAsB,2BAA2B,CAAC;YAE/E,MAAM,8BAA8B,GAAmC,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;YAElH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,8BAA8B,CAAC,CAAC;YAE7E,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;aAC/B;YAED,MAAM,QAAQ,GAAqC;gBAC/C,cAAc,EAAE,IAAI,CAAC,MAAM;aAC9B,CAAC;YAEF,8CAA8C;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAsC,CAAC;YAEzD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAEtC,OAAO,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC;KAAA;IAEO,gBAAgB,CAAE,QAA0C,EAAE,IAAoC;QACtG,QAAQ,CAAC,QAAQ,GAAG;YAChB,sBAAsB,EAAE,IAAI,CAAC,wBAAwB;SACxD,CAAC;IACN,CAAC;IAEO,aAAa,CAAE,sBAA8C;QACjE,OAAO;YACH,wBAAwB,EAAE,sBAAsB,CAAC,sBAAsB;SAC1E,CAAA;IACL,CAAC;CACJ;AA5CD,gDA4CC"}
@@ -0,0 +1,9 @@
1
+ /**
2
+ * RegisteredEmailAddressResource is what is returned from the api.
3
+ */
4
+ export interface RegisteredEmailAddressResource {
5
+ registered_email_address: string;
6
+ }
7
+ export interface RegisteredEmailAddress {
8
+ registeredEmailAddress: string;
9
+ }
@@ -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/registered-email-address/types.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companieshouse/api-sdk-node",
3
- "version": "2.0.91",
3
+ "version": "2.0.93",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [