update inline docs

Author: zero-bites

lib/InvoicePaymentGateway.ts

@@ -13,6 +13,11 @@ export class InvoicePaymentGateway {
         this.config = gateway.config;
     }
 
+    /**
+     * Create a new invoice payment
+     * @param invoicePayment Body of the invoice payment
+     * @returns InvoicePayment
+     */
     async create(invoicePayment: InvoicePaymentInput) {
         const endPoint = buildURL('invoices/payment/create');
 
@@ -24,6 +29,11 @@ export class InvoicePaymentGateway {
         return Object.assign(new InvoicePayment(), result.invoicePayment);
     }
 
+    /**
+     * Update an existing invoice payment
+     * @param invoicePayment Body of the invoice payment
+     * @returns InvoicePayment
+     */
     async update(payload: any) {
         const endPoint = buildURL('invoices/payment/update');
 
@@ -35,6 +45,11 @@ export class InvoicePaymentGateway {
         return result.ok;
     }
 
+    /**
+     * Delete an existing invoice payment
+     * @param invoicePayment Body of the invoice payment
+     * @returns boolean
+     */
     async delete(payload: any) {
         const endPoint = buildURL('invoices/payment/delete');
 
@@ -46,6 +61,11 @@ export class InvoicePaymentGateway {
         return result.ok;
     }
 
+    /**
+     * Search for invoice payments
+     * @param payload Search parameters
+     * @returns InvoicePayment[]
+     */
     async search(payload?: any) {
         const endPoint = buildURL('invoices/payment/search');
 

lib/RecipientGateway.ts

@@ -132,6 +132,11 @@ export class RecipientGateway {
     return true;
   }
 
+  /**
+   * Find acitivity logs for a given recipient
+   * @param recipientId The Trolley recipient ID (e.g. R-xyzzy)
+   * @returns An array of logs
+   */
   async findLogs(recipientId: string) {
     const endPoint = buildURL('recipients', recipientId, 'logs');
 
@@ -140,6 +145,11 @@ export class RecipientGateway {
     return result.recipientLogs.map((r: Log) => Object.assign(new Log(), r));
   }
 
+  /**
+   * Find payments for a given recipient
+   * @param recipientId The Trolley recipient ID (e.g. R-xyzzy)
+   * @returns An array of payments
+   */
   async findPayments(recipientId: string) {
     const endPoint = buildURL('recipients', recipientId, 'payments');
 
@@ -148,6 +158,11 @@ export class RecipientGateway {
     return result.payments.map((r: Payment) => Object.assign(new Payment(), r));
   }
 
+  /**
+   * Find offline payments for a given recipient
+   * @param recipientId The Trolley recipient ID (e.g. R-xyzzy)
+   * @returns An array of offline payments
+   */
   async findOfflinePayments(recipientId: string) {
     const endPoint = buildURL('recipients', recipientId, 'offlinePayments');