@companieshouse/api-sdk-node 2.0.30 → 2.0.33

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 (12) hide show
  1. package/dist/client.d.ts +2 -0
  2. package/dist/client.js +2 -0
  3. package/dist/client.js.map +1 -1
  4. package/dist/services/order/basket/mapping.js +1 -0
  5. package/dist/services/order/basket/mapping.js.map +1 -1
  6. package/dist/services/order/basket/types.d.ts +6 -0
  7. package/dist/services/order/checkout/types.d.ts +2 -0
  8. package/dist/services/order/checkout-item/service.d.ts +13 -0
  9. package/dist/services/order/checkout-item/service.js +46 -0
  10. package/dist/services/order/checkout-item/service.js.map +1 -0
  11. package/dist/services/order/order/types.d.ts +2 -0
  12. package/package.json +1 -1
package/dist/client.d.ts CHANGED
@@ -18,6 +18,7 @@ import { ConfirmationStatementService } from "./services/confirmation-statement"
18
18
  import { OverseasEntityService } from "./services/overseas-entities";
19
19
  import { CheckoutSearchService } from "./services/order/search/service";
20
20
  import OrderItemService from "./services/order/order-item/service";
21
+ import CheckoutItemService from "./services/order/checkout-item/service";
21
22
  /**
22
23
  * ApiClient is the class that all service objects hang off.
23
24
  */
@@ -36,6 +37,7 @@ export default class ApiClient {
36
37
  readonly basket: BasketService;
37
38
  readonly payment: PaymentService;
38
39
  readonly checkout: CheckoutService;
40
+ readonly checkoutItem: CheckoutItemService;
39
41
  readonly order: OrderService;
40
42
  readonly orderItem: OrderItemService;
41
43
  readonly checkoutSearchService: CheckoutSearchService;
package/dist/client.js CHANGED
@@ -22,6 +22,7 @@ const confirmation_statement_1 = require("./services/confirmation-statement");
22
22
  const overseas_entities_1 = require("./services/overseas-entities");
23
23
  const service_12 = require("./services/order/search/service");
24
24
  const service_13 = __importDefault(require("./services/order/order-item/service"));
25
+ const service_14 = __importDefault(require("./services/order/checkout-item/service"));
25
26
  /**
26
27
  * ApiClient is the class that all service objects hang off.
27
28
  */
@@ -42,6 +43,7 @@ class ApiClient {
42
43
  this.basket = new order_1.BasketService(apiClient);
43
44
  this.payment = new payment_1.PaymentService(apiClient); // TODO split payments url/domain into a separate config item and http client
44
45
  this.checkout = new order_1.CheckoutService(apiClient);
46
+ this.checkoutItem = new service_14.default(apiClient);
45
47
  this.order = new order_1.OrderService(apiClient);
46
48
  this.orderItem = new service_13.default(apiClient);
47
49
  this.checkoutSearchService = new service_12.CheckoutSearchService(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,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,8DAAwE;AACxE,mFAAmE;AAEnE;;GAEG;AACH,MAAqB,SAAS;IA0B5B,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,SAAS,GAAG,IAAI,kBAAgB,CAAC,SAAS,CAAC,CAAC;QACjD,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,iBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AAvDD,4BAuDC"}
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,8DAAwE;AACxE,mFAAmE;AACnE,sFAAyE;AAEzE;;GAEG;AACH,MAAqB,SAAS;IA2B5B,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,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,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,iBAA6B,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AAzDD,4BAyDC"}
package/dist/services/order/basket/mapping.js CHANGED
@@ -13,6 +13,7 @@ class BasketMapping {
13
13
  delivery_details: {
14
14
  address_line_1: basketRequest.deliveryDetails.addressLine1,
15
15
  address_line_2: basketRequest.deliveryDetails.addressLine2,
16
+ company_name: basketRequest.deliveryDetails.companyName,
16
17
  country: basketRequest.deliveryDetails.country,
17
18
  forename: basketRequest.deliveryDetails.forename,
18
19
  locality: basketRequest.deliveryDetails.locality,
package/dist/services/order/basket/mapping.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"mapping.js","sourceRoot":"","sources":["../../../../src/services/order/basket/mapping.ts"],"names":[],"mappings":";;AAEA,MAAqB,aAAa;IAC9B;;;;;;OAMG;IACI,MAAM,CAAC,uCAAuC,CAAE,aAAiC;QACpF,OAAO;YACH,gBAAgB,EAAE;gBACd,cAAc,EAAE,aAAa,CAAC,eAAe,CAAC,YAAY;gBAC1D,cAAc,EAAE,aAAa,CAAC,eAAe,CAAC,YAAY;gBAC1D,OAAO,EAAE,aAAa,CAAC,eAAe,CAAC,OAAO;gBAC9C,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,QAAQ;gBAChD,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,QAAQ;gBAChD,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,KAAK;gBAC3C,WAAW,EAAE,aAAa,CAAC,eAAe,CAAC,UAAU;gBACrD,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,MAAM;gBAC5C,OAAO,EAAE,aAAa,CAAC,eAAe,CAAC,OAAO;aACjD;SACJ,CAAC;IACN,CAAC;CACJ;AAvBD,gCAuBC"}
1
+ {"version":3,"file":"mapping.js","sourceRoot":"","sources":["../../../../src/services/order/basket/mapping.ts"],"names":[],"mappings":";;AAEA,MAAqB,aAAa;IAC9B;;;;;;OAMG;IACI,MAAM,CAAC,uCAAuC,CAAE,aAAiC;QACpF,OAAO;YACH,gBAAgB,EAAE;gBACd,cAAc,EAAE,aAAa,CAAC,eAAe,CAAC,YAAY;gBAC1D,cAAc,EAAE,aAAa,CAAC,eAAe,CAAC,YAAY;gBAC1D,YAAY,EAAE,aAAa,CAAC,eAAe,CAAC,WAAW;gBACvD,OAAO,EAAE,aAAa,CAAC,eAAe,CAAC,OAAO;gBAC9C,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,QAAQ;gBAChD,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,QAAQ;gBAChD,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,KAAK;gBAC3C,WAAW,EAAE,aAAa,CAAC,eAAe,CAAC,UAAU;gBACrD,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,MAAM;gBAC5C,OAAO,EAAE,aAAa,CAAC,eAAe,CAAC,OAAO;aACjD;SACJ,CAAC;IACN,CAAC;CACJ;AAxBD,gCAwBC"}
package/dist/services/order/basket/types.d.ts CHANGED
@@ -13,6 +13,7 @@ export interface BasketResource {
13
13
  export interface DeliveryDetailsResource {
14
14
  address_line_1: string;
15
15
  address_line_2?: string;
16
+ company_name?: string;
16
17
  country: string;
17
18
  forename: string;
18
19
  locality: string;
@@ -35,6 +36,7 @@ export interface Basket {
35
36
  export interface DeliveryDetails {
36
37
  addressLine1: string;
37
38
  addressLine2?: string;
39
+ companyName?: string;
38
40
  country: string;
39
41
  forename: string;
40
42
  locality: string;
@@ -49,6 +51,7 @@ export interface BasketRequestResource {
49
51
  export interface DeliveryDetailsRequestResource {
50
52
  address_line_1: string;
51
53
  address_line_2?: string;
54
+ company_name?: string;
52
55
  country: string;
53
56
  forename: string;
54
57
  locality: string;
@@ -63,6 +66,7 @@ export interface BasketPatchRequest {
63
66
  export interface DeliveryDetailsRequest {
64
67
  addressLine1: string;
65
68
  addressLine2?: string | null;
69
+ companyName?: string | null;
66
70
  country: string;
67
71
  forename: string;
68
72
  locality: string;
@@ -82,6 +86,7 @@ export interface CheckoutResource {
82
86
  delivery_details: {
83
87
  address_line_1?: string;
84
88
  address_line_2?: string;
89
+ company_name?: string;
85
90
  country?: string;
86
91
  forename?: string;
87
92
  locality?: string;
@@ -111,6 +116,7 @@ export interface Checkout {
111
116
  deliveryDetails: {
112
117
  addressLine1?: string;
113
118
  addressLine2?: string;
119
+ companyName?: string;
114
120
  country?: string;
115
121
  forename?: string;
116
122
  locality?: string;
package/dist/services/order/checkout/types.d.ts CHANGED
@@ -3,6 +3,7 @@ export interface Checkout {
3
3
  deliveryDetails?: {
4
4
  addressLine1: string;
5
5
  addressLine2: string;
6
+ companyName?: string;
6
7
  country: string;
7
8
  forename: string;
8
9
  locality: string;
@@ -32,6 +33,7 @@ export interface CheckoutResource {
32
33
  delivery_details?: {
33
34
  address_line_1: string;
34
35
  address_line_2: string;
36
+ company_name?: string;
35
37
  country: string;
36
38
  forename: string;
37
39
  locality: string;
package/dist/services/order/checkout-item/service.d.ts ADDED
@@ -0,0 +1,13 @@
1
+ import { IHttpClient } from "../../../http";
2
+ import { Result } from "../../../services/result";
3
+ import { Item } from "../order";
4
+ export declare type CheckoutItemErrorResponse = {
5
+ httpStatusCode?: number;
6
+ error?: string;
7
+ };
8
+ export default class CheckoutItemService {
9
+ private readonly client;
10
+ private static readonly EXCLUDED_FIELDS;
11
+ constructor(client: IHttpClient);
12
+ getCheckoutItem(orderId: string, itemId: string): Promise<Result<Item, CheckoutItemErrorResponse>>;
13
+ }
package/dist/services/order/checkout-item/service.js ADDED
@@ -0,0 +1,46 @@
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
+ const result_1 = require("../../../services/result");
16
+ const mapping_1 = __importDefault(require("../../../mapping/mapping"));
17
+ class CheckoutItemService {
18
+ constructor(client) {
19
+ this.client = client;
20
+ }
21
+ getCheckoutItem(orderId, itemId) {
22
+ var _a;
23
+ return __awaiter(this, void 0, void 0, function* () {
24
+ const resp = yield this.client.httpGet(`/checkouts/${orderId}/items/${itemId}`);
25
+ if (resp.error) {
26
+ return result_1.failure({
27
+ httpStatusCode: resp.status,
28
+ error: (_a = resp.error) === null || _a === void 0 ? void 0 : _a.error
29
+ });
30
+ }
31
+ const body = resp.body;
32
+ const result = mapping_1.default.camelCaseKeys(body, CheckoutItemService.EXCLUDED_FIELDS);
33
+ return result_1.success(result);
34
+ });
35
+ }
36
+ }
37
+ exports.default = CheckoutItemService;
38
+ CheckoutItemService.EXCLUDED_FIELDS = {
39
+ deep: true,
40
+ stopPaths: [
41
+ "description_values",
42
+ "item_options.filing_history_description_values",
43
+ "item_options.filing_history_documents.filing_history_description_values" // certified copies
44
+ ]
45
+ };
46
+ //# sourceMappingURL=service.js.map
package/dist/services/order/checkout-item/service.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../../../../src/services/order/checkout-item/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,qDAAoE;AACpE,uEAA+C;AAQ/C,MAAqB,mBAAmB;IAUpC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,eAAe,CAAE,OAAe,EAAE,MAAc;;;YACzD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,OAAO,UAAU,MAAM,EAAE,CAAC,CAAC;YAEhF,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,gBAAO,CAAC;oBACX,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,KAAK,QAAE,IAAI,CAAC,KAAK,0CAAE,KAAK;iBAC3B,CAAC,CAAC;aACN;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAoB,CAAC;YAEvC,MAAM,MAAM,GAAS,iBAAO,CAAC,aAAa,CAAC,IAAI,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC;YACtF,OAAO,gBAAO,CAAC,MAAM,CAAC,CAAC;;KAC1B;;AA1BL,sCA2BC;AA1B2B,mCAAe,GAAG;IACtC,IAAI,EAAE,IAAI;IACV,SAAS,EAAE;QACP,oBAAoB;QACpB,gDAAgD;QAChD,yEAAyE,CAAC,mBAAmB;KAChG;CACJ,CAAC"}
package/dist/services/order/order/types.d.ts CHANGED
@@ -8,6 +8,7 @@ export interface Order {
8
8
  deliveryDetails?: {
9
9
  addressLine1: string;
10
10
  addressLine2: string;
11
+ companyName?: string;
11
12
  country: string;
12
13
  forename: string;
13
14
  locality: string;
@@ -68,6 +69,7 @@ export interface OrderResource {
68
69
  delivery_details?: {
69
70
  address_line_1: string;
70
71
  address_line_2: string;
72
+ company_name?: string;
71
73
  country: string;
72
74
  forename: string;
73
75
  locality: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companieshouse/api-sdk-node",
3
- "version": "2.0.30",
3
+ "version": "2.0.33",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "files": [