Merge pull request #30 from zero-bites/master

[Feature] Add support for Invoice

Author: Aman Alam

.gitignore

@@ -8,4 +8,5 @@ bower
 __MACOSX
 .eslintrc.js
 .vscode
+.idea
 dist/

lib/Client.ts

@@ -80,14 +80,14 @@ export class Client {
   async get<T>(endPoint: string): Promise<T> {
     const date: any = new Date();
     const timestamp = Math.round(date / 1000);
-    const authoriation = this.generateAuthorization(timestamp, endPoint, "GET");
+    const authorization = this.generateAuthorization(timestamp, endPoint, "GET");
     const options = {
       uri: endPoint,
       baseUrl: this.config.apiBase,
       method: "GET",
       headers: {
         "Content-Type": "application/json",
-        Authorization: authoriation,
+        Authorization: authorization,
         "X-PR-Timestamp": timestamp,
       },
     };

lib/Configuration.ts

@@ -103,7 +103,7 @@ export class Configuration {
         // tslint:disable-next-line:no-http-string
         return "http://api.local.dev:3000";
       case "sandbox":
-        return "https://api.sandbox.paymentrails.com";
+        return "https://api.railz.io";
       case "production":
         return "https://api.paymentrails.com";
       default:

lib/Gateway.ts

@@ -5,7 +5,9 @@ import { BatchGateway } from "./BatchGateway";
 import { PaymentGateway } from "./PaymentGateway";
 import { BalancesGateway } from "./BalancesGateway";
 import { OfflinePaymentGateway } from "./OfflinePaymentGateway";
+import { InvoiceGateway } from "./InvoiceGateway";
 import { Client } from "./Client";
+import { InvoiceLineGateway } from "./InvoiceLineGateway";
 
 export class Gateway {
   config: Configuration;
@@ -16,6 +18,8 @@ export class Gateway {
   balances: BalancesGateway;
   payment: PaymentGateway;
   offlinePayment: OfflinePaymentGateway;
+  invoice: InvoiceGateway;
+  invoiceLine: InvoiceLineGateway;
 
   /**
    * This should be called by the connect() method to setup a client gateway
@@ -31,5 +35,7 @@ export class Gateway {
     this.balances = new BalancesGateway(this);
     this.payment = new PaymentGateway(this);
     this.offlinePayment = new OfflinePaymentGateway(this);
+    this.invoice = new InvoiceGateway(this);
+    this.invoiceLine = new InvoiceLineGateway(this);
   }
 }

lib/Invoice.ts

@@ -0,0 +1,39 @@
+import { InvoiceLine, InvoiceLineInput } from "./InvoiceLine";
+import { Amount } from "./Types";
+
+export interface InvoiceInput {
+    recipientId: string;
+    description: string;
+    externalId: string;
+    invoiceDate: string;
+    dueDate: string;
+    lines: InvoiceLineInput[];
+}
+
+export class Invoice {
+    id: string = "";
+    recipientId: string = "";
+    description: string = "";
+    externalId: string = "";
+    invoiceDate: string  = "";
+    invoiceNumber: number = 0;
+    dueDate: string = "";
+    status: string = "";
+    releaseAfter: string = "";
+    createdAt: string = "";
+    updatedAt: string = "";
+    lines: InvoiceLine[] = [];
+    tags: string[] = [];
+    totalAmount: Amount = {
+        currency: "",
+        value: 0,
+    };
+    paidAmount: Amount = {
+        currency: "",
+        value: 0,
+    };
+    dueAmount: Amount = {
+        currency: "",
+        value: 0,
+    };
+}

lib/InvoiceGateway.ts

@@ -0,0 +1,77 @@
+import { Configuration } from './Configuration';
+import { Gateway } from './Gateway';
+import { Invoice, InvoiceInput } from './Invoice';
+import { ApiResponse } from './types';
+import { buildURL } from './util';
+
+export class InvoiceGateway {
+    gateway: Gateway;
+    config: Configuration;
+
+    constructor(gateway: Gateway) {
+        this.gateway = gateway;
+        this.config = this.gateway.config;
+    }
+
+    async find(invoiceId: string) {
+        const endPoint = buildURL('invoices/get');
+
+        const result = await this.gateway.client.post<ApiResponse<Invoice>>(
+            endPoint,
+            {
+                invoiceId: invoiceId,
+            },
+        );
+
+        return Object.assign(new Invoice(), result.invoice);
+    }
+
+    async create(body: InvoiceInput) {
+        const endPoint = buildURL('invoices/create');
+
+        const result = await this.gateway.client.post<ApiResponse<Invoice>>(
+            endPoint,
+            body,
+        );
+
+        return Object.assign(new Invoice(), result.invoice);
+    }
+
+    async update(invoiceId: string, body: InvoiceInput) {
+        const endPoint = buildURL('invoices/update');
+
+        const result = await this.gateway.client.post<ApiResponse<Invoice>>(
+            endPoint,
+            {
+                invoiceId: invoiceId,
+                ...body,
+            },
+        );
+
+        return Object.assign(new Invoice(), result.invoice);
+    }
+
+    async remove(invoiceIds: string[]) {
+        const endPoint = buildURL('invoices/delete');
+
+        const result = await this.gateway.client.post<ApiResponse<Invoice>>(
+            endPoint,
+            {
+                invoiceIds: invoiceIds,
+            },
+        );
+
+        return true;
+    }
+
+    async search(body: any) {
+        const endPoint = buildURL('invoices/search');
+
+        const result = await this.gateway.client.post<ApiResponse<Invoice[]>>(
+          endPoint,
+          body,
+        );
+
+        return result.invoices.map((line: Invoice) => Object.assign(new Invoice(), line));
+    }
+}

lib/InvoiceLine.ts

@@ -0,0 +1,57 @@
+import { Amount } from "./Types";
+
+export interface InvoiceLineInput {
+    unitAmount: Amount;
+    category: InvoiceLineCategory;
+    description: string;
+    externalId: string;
+    taxReportable: boolean;
+    forceUsTaxActivity: boolean;
+    tags: string[];
+}
+
+enum InvoiceLineCategory {
+    'services',
+    'rent',
+    'royalties',
+    'royalties_film',
+    'prizes',
+    'education',
+    'refunds',
+}
+
+export class InvoiceLine {
+    id: string = '';
+    status: string = '';
+    description: string = '';
+    quantity: number = 0;
+    externalId: string = '';
+    taxReportable: boolean = false;
+    tags: string[] = [];
+    category: string = '';
+    forceUsTaxActivity: boolean = false;
+    unitAmount: Amount = {
+        currency: '',
+        value: 0,
+    };
+    discountAmount: Amount = {
+        currency: '',
+        value: 0,
+    };
+    taxAmount: Amount = {
+        currency: '',
+        value: 0,
+    };
+    totalAmount: Amount = {
+        currency: '',
+        value: 0,
+    };
+    dueAmount: Amount = {
+        currency: '',
+        value: 0,
+    };
+    paidAmount: Amount = {
+        currency: '',
+        value: 0,
+    };
+}

lib/InvoiceLineGateway.ts

@@ -0,0 +1,58 @@
+import { Gateway } from "./Gateway";
+import { Configuration } from "./Configuration";
+import { buildURL } from "./util";
+import { ApiResponse } from "./types";
+import { InvoiceLine, InvoiceLineInput } from "./InvoiceLine";
+import { Invoice } from "./Invoice";
+
+export class InvoiceLineGateway {
+  gateway: Gateway;
+  config: Configuration;
+
+  constructor(gateway: Gateway) {
+    this.gateway = gateway;
+    this.config = gateway.config;
+  }
+
+  async create(invoiceId: string, invoiceLines: InvoiceLineInput[]) {
+    const endPoint = buildURL('invoices/create-lines');
+
+    const result = await this.gateway.client.post<ApiResponse<Invoice>>(
+      endPoint,
+      {
+        invoiceId: invoiceId,
+        ...{ lines: invoiceLines },
+      },
+    );
+
+    return result.invoice.lines.map((line: InvoiceLine) => Object.assign(new InvoiceLine(), line));
+  }
+
+  async update(invoiceId: string, body: any) {
+    const endPoint = buildURL('invoices/update-lines');
+
+    const result = await this.gateway.client.post<ApiResponse<Invoice>>(
+      endPoint,
+      {
+        invoiceId: invoiceId,
+        ...body,
+      },
+    );
+
+    return Object.assign(new Invoice(), result.invoice);
+  }
+
+  async delete(invoiceId: string, lineIds: string[]) {
+    const endPoint = buildURL('invoices/delete-lines');
+
+    const result = await this.gateway.client.post<ApiResponse<Invoice>>(
+      endPoint,
+      {
+        invoiceId: invoiceId,
+        invoiceLineIds: lineIds,
+      },
+    );
+
+    return true;
+  }
+}

lib/index.ts

@@ -8,6 +8,7 @@ export { Balance } from "./Balance";
 export { Batch } from "./Batch";
 export { Payment } from "./Payment";
 export { OfflinePayment } from "./OfflinePayment";
+export { Invoice } from "./Invoice";
 
 /**
  * Create a client for the Payment Rails JavasScript API

lib/types.ts

@@ -5,6 +5,8 @@
 // tslint:disable:no-shadowed-variable
 // tslint:disable:prefer-method-signature
 
+import { Invoice } from "./Invoice";
+
 /**
  * @hidden
  */
@@ -598,3 +600,13 @@ export namespace BankInfo {
     lookupData: BankInfo;
   };
 }
+
+export interface ApiResponse<T> {
+    [key: string]: any;
+    ok: boolean;
+}
+
+export type Amount = {
+  value: number;
+  currency: string;
+};