Merge pull request #10 from Print-one/feat/PO-1446-get-batches-more-f…

…ilters
Print-one · Mar 25, 2024 · 45629a9 · 45629a9
2 parents c526300 + 9795b9d
commit 45629a9
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 14 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/PrintOne.ts b/src/PrintOne.ts
@@ -30,6 +30,7 @@ import { CreateCsvOrder, CsvOrder } from "./models/CsvOrder";
 import { ICsvOrder } from "./models/_interfaces/ICsvOrder";
 import { Batch, CreateBatch } from "./models/Batch";
 import { IBatch } from "./models/_interfaces/IBatch";
+import { BatchStatus } from "./enums/BatchStatus";
 
 export type RequestHandler = new (
   token: string,
@@ -445,7 +446,9 @@ export class PrintOne {
         sendDate?: DateFilter | boolean;
         finish?: InFilter;
         templates?: InFilter<string | Template>;
-        //TODO format, status, isBillable
+        format?: InFilter;
+        status?: InFilter<BatchStatus>;
+        isBillable?: boolean;
       };
     } = {},
   ): Promise<PaginatedResponse<Batch>> {
@@ -456,8 +459,17 @@ export class PrintOne {
       ...dateFilterToQuery("createdAt", options.filter?.createdAt),
       ...dateFilterToQuery("updatedAt", options.filter?.updatedAt),
       ...inFilterToQuery("finish", options.filter?.finish),
+      ...inFilterToQuery("format", options.filter?.format),
+      ...inFilterToQuery("status", options.filter?.status),
     };
 
+    if (typeof options.filter?.isBillable === "boolean") {
+      params = {
+        ...params,
+        "filter.isBillable": `$eq:${options.filter.isBillable}`,
+      };
+    }
+
     if (options.filter?.templates) {
       if (!Array.isArray(options.filter.templates)) {
         options.filter.templates = [options.filter.templates];

diff --git a/src/models/Batch.ts b/src/models/Batch.ts
@@ -7,6 +7,7 @@ import { PaginatedResponse } from "./PaginatedResponse";
 import { Order } from "./Order";
 import { Address } from "./Address";
 import { IOrder } from "./_interfaces/IOrder";
+import { Format } from "../enums/Format";
 import { CreateBatchCsvOrder, CsvOrder } from "./CsvOrder";
 import { ICsvOrder } from "./_interfaces/ICsvOrder";
 
@@ -53,6 +54,10 @@ export class Batch {
     return this._data.finish as Finish;
   }
 
+  public get format(): Format {
+    return this._data.format as Format;
+  }
+
   public get isBillable(): boolean {
     return this._data.isBillable;
   }

diff --git a/src/models/_interfaces/IBatch.ts b/src/models/_interfaces/IBatch.ts
@@ -4,6 +4,7 @@ export type IBatch = {
   name: string;
   billingId: string;
   finish: string;
+  format: string;
   isBillable: boolean;
   templateId: string;
   estimatedPrice: number;

diff --git a/test/Batch.spec.ts b/test/Batch.spec.ts
@@ -126,7 +126,7 @@ describe("createCsvOrder", function () {
     expect(csvOrder.sender).toEqual(undefined);
     expect(csvOrder.recipientMapping).toEqual(mapping.recipient);
     expect(csvOrder.templateId).toEqual(template.id);
-    expect(csvOrder.mergeVariableMapping).toEqual(mapping.mergeVariables);
+    expect(csvOrder.mergeVariableMapping).toStrictEqual({});
     expect(csvOrder.billingId).toEqual(
       expect.toBeOneOf([undefined, expect.any(String)]),
     );
@@ -181,7 +181,7 @@ describe("getCsvOrder", function () {
     expect(csvOrder.sender).toEqual(undefined);
     expect(csvOrder.recipientMapping).toEqual(mapping.recipient);
     expect(csvOrder.templateId).toEqual(template.id);
-    expect(csvOrder.mergeVariableMapping).toEqual(mapping.mergeVariables);
+    expect(csvOrder.mergeVariableMapping).toStrictEqual({});
     expect(csvOrder.billingId).toBeOneOf([undefined, expect.any(String)]);
     expect(csvOrder.finish).toEqual(expect.any(String));
     expect(csvOrder.format).toEqual(expect.any(String));

diff --git a/test/PrintOne.spec.ts b/test/PrintOne.spec.ts
@@ -720,7 +720,7 @@ describe("createCsvOrder", function () {
     expect(csvOrder.sender).toEqual(undefined);
     expect(csvOrder.recipientMapping).toEqual(mapping.recipient);
     expect(csvOrder.templateId).toEqual(template.id);
-    expect(csvOrder.mergeVariableMapping).toEqual(mapping.mergeVariables);
+    expect(csvOrder.mergeVariableMapping).toStrictEqual({});
     expect(csvOrder.billingId).toBeOneOf([undefined, expect.any(String)]);
     expect(csvOrder.finish).toEqual(expect.any(String));
     expect(csvOrder.format).toEqual(expect.any(String));
@@ -844,7 +844,7 @@ describe("getCsvOrder", function () {
     expect(csvOrder.sender).toEqual(undefined);
     expect(csvOrder.recipientMapping).toEqual(mapping.recipient);
     expect(csvOrder.templateId).toEqual(template.id);
-    expect(csvOrder.mergeVariableMapping).toEqual(mapping.mergeVariables);
+    expect(csvOrder.mergeVariableMapping).toStrictEqual({});
     expect(csvOrder.billingId).toBeOneOf([undefined, expect.any(String)]);
     expect(csvOrder.finish).toEqual(expect.any(String));
     expect(csvOrder.format).toEqual(expect.any(String));
@@ -1617,6 +1617,28 @@ describe("getBatches", function () {
     expect(batch.billingId).toEqual("test");
   });
 
+  it("should apply the isBillable filter", async function () {
+    // arrange
+
+    // act
+    const batches = await client.getBatches({
+      limit: 1,
+      filter: {
+        isBillable: true,
+      },
+    });
+    const batch = batches.data[0];
+
+    if (batch === undefined) {
+      console.warn("No orders found, skipping test");
+      return;
+    }
+
+    // assert
+    expect(batch).toBeDefined();
+    expect(batch.isBillable).toEqual(true);
+  });
+
   it("should apply the name filter", async function () {
     // arrange
     const batchName = (await client.getBatches()).data[1]?.name ?? "test";