[DEVREL-95] Support multiple batch deletion

Author: zero-bites

lib/Gateway.ts

@@ -8,6 +8,7 @@ import { OfflinePaymentGateway } from "./OfflinePaymentGateway";
 import { InvoiceGateway } from "./InvoiceGateway";
 import { Client } from "./Client";
 import { InvoiceLineGateway } from "./InvoiceLineGateway";
+import { InvoicePaymentGateway } from "./InvoicePaymentGateway";
 
 export class Gateway {
   config: Configuration;
@@ -20,6 +21,7 @@ export class Gateway {
   offlinePayment: OfflinePaymentGateway;
   invoice: InvoiceGateway;
   invoiceLine: InvoiceLineGateway;
+  invoicePayment: InvoicePaymentGateway;
 
   /**
    * This should be called by the connect() method to setup a client gateway
@@ -37,5 +39,6 @@ export class Gateway {
     this.offlinePayment = new OfflinePaymentGateway(this);
     this.invoice = new InvoiceGateway(this);
     this.invoiceLine = new InvoiceLineGateway(this);
+    this.invoicePayment = new InvoicePaymentGateway(this);
   }
 }

lib/Invoice.ts

@@ -26,14 +26,14 @@ export class Invoice {
     tags: string[] = [];
     totalAmount: Amount = {
         currency: "",
-        value: 0,
+        value: "0",
     };
     paidAmount: Amount = {
         currency: "",
-        value: 0,
+        value: "0",
     };
     dueAmount: Amount = {
         currency: "",
-        value: 0,
+        value: "0",
     };
 }

lib/InvoiceLine.ts

@@ -32,26 +32,26 @@ export class InvoiceLine {
     forceUsTaxActivity: boolean = false;
     unitAmount: Amount = {
         currency: '',
-        value: 0,
+        value: "0",
     };
     discountAmount: Amount = {
         currency: '',
-        value: 0,
+        value: "0",
     };
     taxAmount: Amount = {
         currency: '',
-        value: 0,
+        value: "0",
     };
     totalAmount: Amount = {
         currency: '',
-        value: 0,
+        value: "0",
     };
     dueAmount: Amount = {
         currency: '',
-        value: 0,
+        value: "0",
     };
     paidAmount: Amount = {
         currency: '',
-        value: 0,
+        value: "0",
     };
 }

lib/InvoiceLineGateway.ts

@@ -17,7 +17,7 @@ export class InvoiceLineGateway {
   async create(invoiceId: string, invoiceLines: InvoiceLineInput[]) {
     const endPoint = buildURL('invoices/create-lines');
 
-    const result = await this.gateway.client.post<ApiResponse<Invoice>>(
+    const result = await this.gateway.client.post<ApiResponse<InvoiceLine>>(
       endPoint,
       {
         invoiceId: invoiceId,
@@ -31,7 +31,7 @@ export class InvoiceLineGateway {
   async update(invoiceId: string, body: any) {
     const endPoint = buildURL('invoices/update-lines');
 
-    const result = await this.gateway.client.post<ApiResponse<Invoice>>(
+    const result = await this.gateway.client.post<ApiResponse<InvoiceLine>>(
       endPoint,
       {
         invoiceId: invoiceId,
@@ -45,7 +45,7 @@ export class InvoiceLineGateway {
   async delete(invoiceId: string, lineIds: string[]) {
     const endPoint = buildURL('invoices/delete-lines');
 
-    const result = await this.gateway.client.post<ApiResponse<Invoice>>(
+    const result = await this.gateway.client.post<ApiResponse<InvoiceLine>>(
       endPoint,
       {
         invoiceId: invoiceId,

lib/InvoicePayment.ts

@@ -0,0 +1,29 @@
+import { Amount } from "./types";
+
+export interface InvoicePaymentInput {
+    batchId?: string;
+    ids: InvoicePaymentInputRecord[];
+}
+
+interface InvoicePaymentInputRecord {
+    invoiceId?: string;
+    invoiceLineId?: string;
+    paymentId?: string;
+    amount: Amount;
+}
+
+export class InvoicePayment {
+    batchId: string = '';
+    paymentId: string = '';
+    invoicePayments: InvoicePaymentRecord[] = [];
+}
+
+export class InvoicePaymentRecord {
+    invoiceId: string = '';
+    invoiceLineId: string = '';
+    paymentId: string = '';
+    amount: Amount = {
+        currency: '',
+        value: '',
+    };
+}

lib/InvoicePaymentGateway.ts

@@ -0,0 +1,59 @@
+import { Gateway } from "./Gateway";
+import { Configuration } from "./Configuration";
+import { buildURL } from "./util";
+import { ApiResponse } from "./types";
+import { InvoicePayment, InvoicePaymentInput, InvoicePaymentRecord } from "./InvoicePayment";
+
+export class InvoicePaymentGateway {
+    gateway: Gateway;
+    config: Configuration;
+
+    constructor(gateway: Gateway) {
+        this.gateway = gateway;
+        this.config = gateway.config;
+    }
+
+    async create(invoicePayment: InvoicePaymentInput) {
+        const endPoint = buildURL('invoices/payment/create');
+
+        const result = await this.gateway.client.post<ApiResponse<InvoicePayment>>(
+            endPoint,
+            invoicePayment,
+        );
+
+        return Object.assign(new InvoicePayment(), result.invoicePayment);
+    }
+
+    async update(payload: any) {
+        const endPoint = buildURL('invoices/payment/update');
+
+        const result = await this.gateway.client.post<{ok: boolean}>(
+            endPoint,
+            payload,
+        );
+
+        return result.ok;
+    }
+
+    async delete(payload: any) {
+        const endPoint = buildURL('invoices/payment/delete');
+
+        const result = await this.gateway.client.post<{ok: boolean}>(
+            endPoint,
+            payload,
+        );
+
+        return result.ok;
+    }
+
+    async search(payload?: any) {
+        const endPoint = buildURL('invoices/payment/search');
+
+        const result = await this.gateway.client.post<ApiResponse<InvoicePayment[]>>(
+          endPoint,
+          payload,
+        );
+
+        return result.invoicePayments.map((ip: InvoicePaymentRecord) => Object.assign(new InvoicePaymentRecord(), ip));
+    }
+}

lib/types.ts

@@ -609,6 +609,6 @@ export interface ApiResponse<T> {
 }
 
 export type Amount = {
-  value: number;
+  value: string;
   currency: string;
 };

test/integration/InvoicePaymentSpec.ts

@@ -0,0 +1,144 @@
+import { InvoiceFactory } from "./factories/InvoiceFactory";
+import { startNockRec, testingApiClient } from "./helpers/integrationTestsHelpers";
+import * as assert from "assert";
+import { RecipientFactory } from "./factories/RecipientFactory";
+import { InvoicePaymentFactory } from "./factories/InvoicePaymentFactory";
+import { InvoiceLineFactory } from "./factories/InvoiceLineFactory";
+import { InvoicePayment, InvoicePaymentInput, InvoicePaymentRecord } from "../../lib/InvoicePayment";
+
+let recipientFactory: RecipientFactory;
+let invoiceFactory: InvoiceFactory;
+let invoiceLineFactory: InvoiceLineFactory;
+let invoicePaymentFactory: InvoicePaymentFactory;
+
+before(async () => {
+    recipientFactory = new RecipientFactory();
+    invoiceFactory = new InvoiceFactory();
+    invoiceLineFactory = new InvoiceLineFactory();
+    invoicePaymentFactory = new InvoicePaymentFactory();
+});
+
+describe("Invoice Payment", () => {
+    it("creates an invoice payment", async () => {
+        const nockDone = await startNockRec("invoice-payment-create.json");
+
+        const recipient = await recipientFactory.createResource();
+        const invoice = await invoiceFactory.createResource({ recipientId: recipient.id });
+        await invoiceLineFactory.createResource({ invoice: { id: invoice.id } });
+        const invoicePayment = await invoicePaymentFactory.createResource(
+            {
+                ids: [
+                    {
+                        invoiceId: invoice.id,
+                        amount: {
+                            currency: "USD",
+                            value: "100",
+                        },
+                    },
+                ],
+            },
+        );
+
+        nockDone();
+
+        assert.ok(invoicePayment instanceof InvoicePayment);
+        assert.strictEqual(invoicePayment.invoicePayments[0].amount.value, "100.00");
+        assert.strictEqual(invoicePayment.invoicePayments[0].amount.currency, "USD");
+    });
+
+    it("updates an invoice payment", async () => {
+        const nockDone = await startNockRec("invoice-payment-update.json");
+
+        const recipient = await recipientFactory.createResource();
+        const invoice = await invoiceFactory.createResource({ recipientId: recipient.id });
+        const invoiceLines = await invoiceLineFactory.createResource({ invoice: { id: invoice.id } });
+        const invoicePayment = await invoicePaymentFactory.createResource(
+            {
+                ids: [{ invoiceId: invoice.id }],
+            },
+        );
+
+        const updatedInvoicePayment = await testingApiClient.invoicePayment.update(
+          { paymentId: invoicePayment.paymentId,
+              invoiceLineId: invoicePayment.invoicePayments[0].invoiceLineId,
+              amount: {
+                  currency: "USD",
+                  value: "200",
+              },
+          },
+        );
+
+        nockDone();
+
+        assert.ok(updatedInvoicePayment);
+    });
+
+    it("deletes an invoice payment", async () => {
+        const nockDone = await startNockRec("invoice-payment-delete.json");
+
+        const recipient = await recipientFactory.createResource();
+        const invoice = await invoiceFactory.createResource({ recipientId: recipient.id });
+        await invoiceLineFactory.createResource({ invoice: { id: invoice.id } });
+        const invoicePayment = await invoicePaymentFactory.createResource(
+            {
+                ids: [{ invoiceId: invoice.id }],
+            },
+        );
+
+        const deletedInvoicePayment = await testingApiClient.invoicePayment.delete(
+          { paymentId: invoicePayment.paymentId,
+              invoiceLineIds: invoicePayment.invoicePayments.map((ip: InvoicePaymentRecord) => ip.invoiceLineId),
+          },
+        );
+
+        nockDone();
+
+        assert.ok(deletedInvoicePayment);
+    });
+
+    it("searches for invoice payments by invoiceIds", async () => {
+        const nockDone = await startNockRec("invoice-payment-search.json");
+
+        const recipient = await recipientFactory.createResource();
+        const invoice = await invoiceFactory.createResource({ recipientId: recipient.id });
+        await invoiceLineFactory.createResource({ invoice: { id: invoice.id } });
+        const invoicePayment = await invoicePaymentFactory.createResource(
+            {
+                ids: [{ invoiceId: invoice.id }],
+            },
+        );
+
+        const searchResults = await testingApiClient.invoicePayment.search(
+          { invoiceIds: [invoice.id] },
+        );
+
+        nockDone();
+
+        assert.ok(searchResults);
+        assert.strictEqual(searchResults.length, 1);
+        assert.strictEqual(searchResults[0].amount.value, "100.00");
+    });
+
+    it("searches for invoice payments by paymentIds", async () => {
+        const nockDone = await startNockRec("invoice-payment-search-by-payment-ids.json");
+
+        const recipient = await recipientFactory.createResource();
+        const invoice = await invoiceFactory.createResource({ recipientId: recipient.id });
+        await invoiceLineFactory.createResource({ invoice: { id: invoice.id } });
+        const invoicePayment = await invoicePaymentFactory.createResource(
+            {
+                ids: [{ invoiceId: invoice.id }],
+            },
+        );
+
+        const searchResults = await testingApiClient.invoicePayment.search(
+          { paymentIds: [invoicePayment.paymentId] },
+        );
+
+        nockDone();
+
+        assert.ok(searchResults);
+        assert.strictEqual(searchResults.length, 1);
+        assert.strictEqual(searchResults[0].amount.value, "100.00");
+    });
+});

test/integration/factories/InvoiceLineFactory.ts

@@ -1,5 +1,4 @@
 import { ApiFactory } from "./ApiFactory";
-import { Amount } from "../../../lib/types";
 import { InvoiceLineCategory } from "../../../lib/InvoiceLine";
 
 export class InvoiceLineFactory extends ApiFactory {

test/integration/factories/InvoicePaymentFactory.ts

@@ -0,0 +1,7 @@
+import { ApiFactory } from "./ApiFactory";
+
+export class InvoicePaymentFactory extends ApiFactory {
+  public async createResource(attrs: any = {}) {
+    return this.apiClient.invoicePayment.create(attrs);
+  }
+}