Merge pull request #451 from companieshouse/feature/fix_order_item_error_model

Change data structure of order item err model

Author: dlgroves-ch

src/services/order/order-item/service.ts

@@ -1,9 +1,13 @@
 import { IHttpClient } from "../../../http";
-import { ApiResult } from "../../../services/resource";
-import { failure, success } from "../../../services/result";
+import { failure, Result, success } from "../../../services/result";
 import Mapping from "../../../mapping/mapping";
 import { Item, ItemResource } from "../order";
 
+export type OrderItemErrorResponse = {
+    httpStatusCode?: number;
+    error?: string;
+};
+
 export default class OrderItemService {
     private static readonly EXCLUDED_FIELDS = {
         deep: true,
@@ -16,13 +20,13 @@ export default class OrderItemService {
 
     constructor (private readonly client: IHttpClient) { }
 
-    public async getOrderItem (orderId: string, itemId: string): Promise<ApiResult<Item>> {
+    public async getOrderItem (orderId: string, itemId: string): Promise<Result<Item, OrderItemErrorResponse>> {
         const resp = await this.client.httpGet(`/orders/${orderId}/items/${itemId}`);
 
         if (resp.error) {
             return failure({
                 httpStatusCode: resp.status,
-                errors: resp?.error?.errors || resp.error
+                error: resp.error?.error
             });
         }
 

test/services/order-item/service.spec.ts

@@ -1,6 +1,6 @@
 import sinon from "sinon";
 import { IHttpClient, RequestClient } from "../../../src";
-import OrderItemService from "../../../src/services/order/order-item/service";
+import OrderItemService, { OrderItemErrorResponse } from "../../../src/services/order/order-item/service";
 import { expect } from "chai";
 import { Success } from "../../../src/services/result";
 import { Item } from "../../../src/services/order/order";
@@ -154,7 +154,9 @@ describe("OrderItemService", () => {
             // given
             const serverResponse = {
                 status: 401,
-                error: "An error occurred"
+                error: {
+                    error: "An error occurred"
+                }
             };
             sandbox.mock(requestClient)
                 .expects("httpGet")
@@ -164,11 +166,11 @@ describe("OrderItemService", () => {
             const orderItemService = new OrderItemService(requestClient);
 
             // when
-            const actual = await orderItemService.getOrderItem("ORD-123123-123123", "CCD-123456-123456") as Failure<Item, ApiErrorResponse>;
+            const actual = await orderItemService.getOrderItem("ORD-123123-123123", "CCD-123456-123456") as Failure<Item, OrderItemErrorResponse>;
 
             expect(actual.isFailure()).to.be.true;
             expect(actual.value.httpStatusCode).to.equal(401);
-            expect(actual.value.errors).to.equal("An error occurred");
+            expect(actual.value.error).to.equal("An error occurred");
         });
     });
 });