@companieshouse/api-sdk-node 2.0.24 → 2.0.27

package/dist/services/order/certificates/types.d.ts

@@ -1,3 +1,4 @@
+import { ItemOptionsDeliveryTimescaleConfigurable } from "../types";
 export interface CertificateItemResource {
     company_name: string;
     company_number: string;
@@ -120,13 +121,12 @@ export interface ItemCosts {
     itemCost: string;
     productType: string;
 }
-export interface ItemOptions {
+export interface ItemOptions extends ItemOptionsDeliveryTimescaleConfigurable {
     certificateType: string;
     collectionLocation: string;
     companyType: string;
     contactNumber: string;
     deliveryMethod: string;
-    deliveryTimescale: string;
     designatedMemberDetails?: DesignatedMemberDetails;
     directorDetails?: DirectorOrSecretaryDetails;
     forename: string;

package/dist/services/order/certified-copies/types.d.ts

@@ -1,3 +1,4 @@
+import { ItemOptionsDeliveryTimescaleConfigurable } from "../types";
 export interface CertifiedCopyItemResource {
     company_name: string;
     company_number: string;
@@ -66,14 +67,13 @@ export interface ItemCosts {
     itemCost: string;
     productType: string;
 }
-export interface ItemOptions {
-    collectionLocation?: string;
-    contactNumber?: string;
-    deliveryMethod?: string;
-    deliveryTimescale?: string;
-    filingHistoryDocuments?: FilingHistoryDocuments[];
-    forename?: string;
-    surname?: string;
+export interface ItemOptions extends ItemOptionsDeliveryTimescaleConfigurable {
+    collectionLocation: string;
+    contactNumber: string;
+    deliveryMethod: string;
+    filingHistoryDocuments: FilingHistoryDocuments[];
+    forename: string;
+    surname: string;
 }
 export interface Links {
     self: string;
@@ -88,6 +88,15 @@ export interface FilingHistoryDocuments {
 }
 export interface CertifiedCopyItemPatchRequest {
     customerReference?: string;
-    itemOptions?: ItemOptions;
+    itemOptions?: PatchItemOptions;
     quantity?: number;
 }
+export interface PatchItemOptions {
+    collectionLocation?: string;
+    contactNumber?: string;
+    deliveryMethod?: string;
+    deliveryTimescale?: string;
+    filingHistoryDocuments?: FilingHistoryDocuments[];
+    forename?: string;
+    surname?: string;
+}

package/dist/services/order/checkout/types.d.ts

@@ -18,13 +18,13 @@ export interface Checkout {
         self: string;
         payment: string;
     };
-    paidAt: string;
+    paidAt?: string;
     checkedOutBy: {
         email: string;
         id: string;
     };
     status: string;
-    paymentReference: string;
+    paymentReference?: string;
     reference: string;
     totalOrderCost: string;
 }

package/dist/services/order/order-item/service.d.ts

@@ -0,0 +1,9 @@
+import { IHttpClient } from "../../../http";
+import { ApiResult } from "../../../services/resource";
+import { Item } from "../order";
+export default class OrderItemService {
+    private readonly client;
+    private static readonly EXCLUDED_FIELDS;
+    constructor(client: IHttpClient);
+    getOrderItem(orderId: string, itemId: string): Promise<ApiResult<Item>>;
+}

package/dist/services/order/order-item/service.js

@@ -0,0 +1,46 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const result_1 = require("../../../services/result");
+const mapping_1 = __importDefault(require("../../../mapping/mapping"));
+class OrderItemService {
+    constructor(client) {
+        this.client = client;
+    }
+    getOrderItem(orderId, itemId) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.client.httpGet(`/orders/${orderId}/items/${itemId}`);
+            if (resp.error) {
+                return result_1.failure({
+                    httpStatusCode: resp.status,
+                    errors: ((_a = resp === null || resp === void 0 ? void 0 : resp.error) === null || _a === void 0 ? void 0 : _a.errors) || resp.error
+                });
+            }
+            const body = resp.body;
+            const result = mapping_1.default.camelCaseKeys(body, OrderItemService.EXCLUDED_FIELDS);
+            return result_1.success(result);
+        });
+    }
+}
+exports.default = OrderItemService;
+OrderItemService.EXCLUDED_FIELDS = {
+    deep: true,
+    stopPaths: [
+        "description_values",
+        "item_options.filing_history_description_values",
+        "item_options.filing_history_documents.filing_history_description_values" // certified copies
+    ]
+};
+//# sourceMappingURL=service.js.map

package/dist/services/order/order-item/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../../src/services/order/order-item/service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAEA,qDAA4D;AAC5D,uEAA+C;AAG/C,MAAqB,gBAAgB;IAUjC,YAA8B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAI,CAAC;IAEzC,YAAY,CAAE,OAAe,EAAE,MAAc;;;YACtD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,OAAO,UAAU,MAAM,EAAE,CAAC,CAAC;YAE7E,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,OAAO,gBAAO,CAAC;oBACX,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,MAAM,EAAE,OAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,0CAAE,MAAM,KAAI,IAAI,CAAC,KAAK;iBAC5C,CAAC,CAAC;aACN;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAoB,CAAC;YAEvC,MAAM,MAAM,GAAS,iBAAO,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;YACnF,OAAO,gBAAO,CAAC,MAAM,CAAC,CAAC;;KAC1B;;AA1BL,mCA2BC;AA1B2B,gCAAe,GAAG;IACtC,IAAI,EAAE,IAAI;IACV,SAAS,EAAE;QACP,oBAAoB;QACpB,gDAAgD;QAChD,yEAAyE,CAAC,mBAAmB;KAChG;CACJ,CAAC"}

package/dist/services/order/types.d.ts

@@ -0,0 +1,3 @@
+export interface ItemOptionsDeliveryTimescaleConfigurable {
+    deliveryTimescale: string;
+}

package/dist/services/order/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/services/order/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/order/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@companieshouse/api-sdk-node",
-  "version": "2.0.24",
+  "version": "2.0.27",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [