Merge pull request #74 from mathewmeconry/fix/bills_v4

fix(bills): add BillStatusFilter enum and update list method documentation

Author: mathewmeconry

src/interfaces/BillsV4Static.ts

@@ -155,14 +155,21 @@ export namespace BillsV4Static {
     DUPLICATE = "DUPLICATE",
   }
 
+  export enum BillStatusFilter {
+    DRAFTS = "DRAFTS",
+    TODO = "TODO", 
+    PAID = "PAID",
+    OVERDUE = "OVERDUE",
+  }
+
   export interface ListOptions {
     limit?: number;
     page?: number;
     order?: "asc" | "desc";
     sort?: string;
     search_term?: string;
     "fields[]"?: string[];
-    status?: "DRAFTS" | "TODO" | "PAID" | "OVERDUE";
+    status?: BillStatusFilter;
     bill_date_start?: string;
     bill_date_end?: string;
     due_date_start?: string;

src/resources/BillsV4.ts

@@ -14,22 +14,27 @@ export default class BillsV4 extends BaseCrud<
     super(apiToken, "/4.0/purchase/bills");
   }
 
+
   /**
-   * Lists the bills
+   * Lists the ressource
    *
    * @param {BillsV4Static.ListOptions} [options]
-   * @returns {Promise<BillsV4Static.Bill[]>}
+   * @returns {Promise<Array<BillsV4Static.Bill>>}
    * @memberof BillsV4
    */
   public async list(
     options?: BillsV4Static.ListOptions
-  ): Promise<BillsV4Static.Bill[]> {
-    const response = await this.request<{ data: BillsV4Static.Bill[] }>(
-      "GET",
-      "/4.0/purchase/bills",
-      options
-    );
-    return response.data;
+  ): Promise<Array<BillsV4Static.Bill>> {
+    const resp = await this.request<{
+      data: Array<BillsV4Static.Bill>;
+      paging: {
+        page: number;
+        page_size: number;
+        page_count: number;
+        item_count: number;
+      };
+    }>("GET", this.apiEndpoint, options);
+    return resp.data;
   }
 
   /**
@@ -103,4 +108,4 @@ export default class BillsV4 extends BaseCrud<
       { document_no: documentNo }
     );
   }
-}
+}

src/tests/BillsV4.test.ts

@@ -2,33 +2,41 @@ import BaseCrud from "../resources/BaseCrud";
 import BillsV4 from "../resources/BillsV4";
 import Chance from "chance";
 import { BillsV4Static } from "../interfaces/BillsV4Static";
-
-jest.mock("../resources/BaseCrud");
+import { BaseStatic } from "../interfaces/BaseStatic";
 
 const seedgenerator = new Chance();
 const seed = seedgenerator.hash();
 console.log(`using chance seed ${seed}`);
 const chance = new Chance(seed);
 
 describe("BillsV4", () => {
+  let requestSpy: jest.SpyInstance;
+
+  beforeEach(() => {
+    requestSpy = jest
+      .spyOn(BaseCrud.prototype as any, "request")
+      .mockResolvedValue({});
+  });
+
   afterEach(() => {
-    jest.resetAllMocks();
+    requestSpy.mockRestore();
   });
 
   it("Should use init the base correctly", () => {
     const token = chance.string();
-    new BillsV4(token);
-    expect(BaseCrud).toHaveBeenCalledWith(token, "/4.0/purchase/bills");
+    const billsV4 = new BillsV4(token);
+    // @ts-ignore
+    expect(billsV4.apiToken).toBe(token);
+    // @ts-ignore
+    expect(billsV4.apiEndpoint).toBe("/4.0/purchase/bills");
   });
 
   describe("list", () => {
     it("Should call request with GET", async () => {
       const billsV4 = new BillsV4(chance.string());
-      // @ts-ignore
-      BaseCrud.prototype.request.mockResolvedValue({ data: [] });
+      requestSpy.mockResolvedValue({ data: [] });
       await billsV4.list();
-      // @ts-ignore
-      expect(BaseCrud.prototype.request).toHaveBeenCalledWith(
+      expect(requestSpy).toHaveBeenCalledWith(
         "GET",
         "/4.0/purchase/bills",
         undefined
@@ -37,23 +45,87 @@ describe("BillsV4", () => {
 
     it("Should pass options to request", async () => {
       const billsV4 = new BillsV4(chance.string());
-      const options: BillsV4Static.ListOptions = { limit: chance.integer({ min: 0 }) };
-      // @ts-ignore
-      BaseCrud.prototype.request.mockResolvedValue({ data: [] });
+      const options: BaseStatic.BaseOptions = { limit: chance.integer() };
+      requestSpy.mockResolvedValue({ data: [] });
       await billsV4.list(options);
-      // @ts-ignore
-      expect(BaseCrud.prototype.request).toHaveBeenCalledWith(
+      expect(requestSpy).toHaveBeenCalledWith(
+        "GET",
+        "/4.0/purchase/bills",
+        options
+      );
+    });
+
+    it("should list bills with options", async () => {
+      const billsV4 = new BillsV4(chance.string());
+      const bills = [
+        { id: chance.guid(), document_no: "B-1", lastname_company: "Test" },
+      ];
+      requestSpy.mockResolvedValue({ data: bills });
+
+      const options: BillsV4Static.ListOptions = {
+        limit: 10,
+        page: 1,
+        "fields[]": ["document_no", "title"],
+      };
+      const result = await billsV4.list(options);
+
+      expect(requestSpy).toHaveBeenCalledWith(
         "GET",
         "/4.0/purchase/bills",
         options
       );
+      expect(result).toEqual(bills);
+    });
+  });
+
+  describe("updateStatus", () => {
+    it("Should call request with PUT and correct path", async () => {
+      const billsV4 = new BillsV4(chance.string());
+      const id = chance.guid();
+      const status = BillsV4Static.BillStatusUpdate.BOOKED;
+      await billsV4.updateStatus(id, status);
+      expect(requestSpy).toHaveBeenCalledWith(
+        "PUT",
+        `/4.0/purchase/bills/${id}/bookings/${status}`
+      );
+    });
+  });
+
+  describe("executeAction", () => {
+    it("Should call request with POST and correct path and data", async () => {
+      const billsV4 = new BillsV4(chance.string());
+      const id = chance.guid();
+      const action = BillsV4Static.BillAction.DUPLICATE;
+      await billsV4.executeAction(id, action);
+      expect(requestSpy).toHaveBeenCalledWith(
+        "POST",
+        `/4.0/purchase/bills/${id}/actions`,
+        undefined,
+        { action }
+      );
+    });
+  });
+
+  describe("validateDocumentNumber", () => {
+    it("Should call request with GET and correct path and data", async () => {
+      const billsV4 = new BillsV4(chance.string());
+      const documentNo = chance.string();
+      requestSpy.mockResolvedValue({ valid: true });
+      await billsV4.validateDocumentNumber(documentNo);
+      expect(requestSpy).toHaveBeenCalledWith(
+        "GET",
+        "/4.0/purchase/documentnumbers/bills",
+        { document_no: documentNo }
+      );
     });
   });
 
   describe("search", () => {
     it("Should throw not implemented error", async () => {
       const billsV4 = new BillsV4(chance.string());
-      await expect(billsV4.search([])).rejects.toThrow("not implemented by Bexio yet");
+      await expect(billsV4.search([])).rejects.toThrow(
+        "not implemented by Bexio yet"
+      );
     });
   });
 
@@ -66,7 +138,7 @@ describe("BillsV4", () => {
       // @ts-ignore
       expect(BaseCrud.prototype.request).toHaveBeenCalledWith(
         "PUT",
-        `undefined/${id}/bookings/${status}`
+        `/4.0/purchase/bills/${id}/bookings/${status}`
       );
     });
   });
@@ -80,7 +152,7 @@ describe("BillsV4", () => {
       // @ts-ignore
       expect(BaseCrud.prototype.request).toHaveBeenCalledWith(
         "POST",
-        `undefined/${id}/actions`,
+        `/4.0/purchase/bills/${id}/actions`,
         undefined,
         { action }
       );