Merge pull request #117 from xendit/feat/add-missing-recurring-paymen…

…t-properties #116 Add missing recurring payment properties
xendit · Nov 2, 2021 · 59529ba · 59529ba
2 parents d9daa75 + 98b8ce9
commit 59529ba
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 2021-11-01
+
+- Add missing recurring payment properties
+
 ## 2021-06-01
 
 - Add missing Customer and DirectDebit services types to index definition file

diff --git a/README.md b/README.md
@@ -513,8 +513,8 @@ Refer to [Xendit API Reference](https://developers.xendit.co/api-reference/#recu
 ```ts
 rp.createPayment(data: {
   externalID: string;
-  payerEmail: string;
-  description: string;
+  payerEmail?: string;
+  description?: string;
   amount: number;
   interval: Interval;
   intervalCount: number;
@@ -530,6 +530,11 @@ rp.createPayment(data: {
   chargeImmediately?: boolean;
   currency?: string;
   rescheduleAt?: Date;
+  customer?: object;
+  customerNotificationPreference?: object;
+  reminderTimeUnit?: string;
+  reminderTime?: number;
+  paymentMethodId?: string;
 })
 ```
 
@@ -551,6 +556,11 @@ rp.editPayment(data: {
   shouldSendEmail?: boolean;
   invoiceDuration?: number;
   missedPaymentAction?: Action;
+  rescheduleAt?: Date;
+  customerId?: string;
+  reminderTimeUnit?: string;
+  reminderTime?: number;
+  paymentMethodId?: string;
 })
 ```
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "xendit-node",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "description": "NodeJS client for Xendit API",
   "main": "index.js",
   "types": "index.d.ts",

diff --git a/src/recurring/manage_payments.d.ts b/src/recurring/manage_payments.d.ts
@@ -10,8 +10,8 @@ enum Action {
 
 export function createPayment(data: {
   externalID: string;
-  payerEmail: string;
-  description: string;
+  payerEmail?: string;
+  description?: string;
   amount: number;
   interval: Interval;
   intervalCount: number;
@@ -27,6 +27,11 @@ export function createPayment(data: {
   chargeImmediately?: boolean;
   currency?: string;
   rescheduleAt?: Date;
+  customer?: object;
+  customerNotificationPreference?: object;
+  reminderTimeUnit?: string;
+  reminderTime?: number;
+  paymentMethodId?: string;
 }): Promise<object>;
 
 export function getPayment(data: { id: string }): Promise<object>;
@@ -41,4 +46,8 @@ export function editPayment(data: {
   invoiceDuration?: number;
   missedPaymentAction?: Action;
   rescheduleAt?: Date;
+  customerId?: string;
+  reminderTimeUnit?: string;
+  reminderTime?: number;
+  paymentMethodId?: string;
 }): Promise<object>;
diff --git a/src/recurring/manage_payments.js b/src/recurring/manage_payments.js
@@ -4,8 +4,6 @@ function createPayment(data) {
   return promWithJsErr((resolve, reject) => {
     const compulsoryFields = [
       'externalID',
-      'payerEmail',
-      'description',
       'amount',
       'interval',
       'intervalCount',
@@ -39,6 +37,11 @@ function createPayment(data) {
         reschedule_at: data.rescheduleAt
           ? data.rescheduleAt.toISOString()
           : undefined,
+        customer: data.customer,
+        customer_notification_preference: data.customerNotificationPreference,
+        reminder_time_unit: data.reminderTimeUnit,
+        reminder_time: data.reminderTime,
+        payment_method_id: data.paymentMethodId,
       }),
     })
       .then(resolve)
@@ -80,6 +83,10 @@ function editPayment(data) {
         reschedule_at: data.rescheduleAt
           ? data.rescheduleAt.toISOString()
           : undefined,
+        customer_id: data.customerId,
+        reminder_time_unit: data.reminderTimeUnit,
+        reminder_time: data.reminderTime,
+        payment_method_id: data.paymentMethodId,
       }),
     })
       .then(resolve)

diff --git a/test/recurring/constants.js b/test/recurring/constants.js
@@ -1,11 +1,17 @@
 const EXT_ID = '123';
-const PAYER_EMAIL = 'stanley@xendit.co';
+const PAYER_EMAIL = 'dummy@email.co';
 const DESCRIPTION = 'Payment for something';
 const AMOUNT = 10000;
 const INTERVAL = 'MONTH';
 const INTERVAL_COUNT = 1;
 const PAYMENT_ID = '5e0577bdf4d38b20d542009b';
 const START_DATE = '2020-01-31T17:00:00.000Z';
+const CUSTOMER = {
+  given_names: 'stan',
+  email: '[email protected]',
+  mobile_number: '',
+  address: '',
+};
 
 const PAYMENT_DETAILS = {
   id: PAYMENT_ID,
@@ -16,6 +22,7 @@ const PAYMENT_DETAILS = {
   interval: INTERVAL,
   interval_count: INTERVAL_COUNT,
   start_date: START_DATE,
+  customer: CUSTOMER,
 };
 
 const UPDATED_AMOUNT = 20000;
@@ -35,4 +42,5 @@ module.exports = {
   START_DATE,
   UPDATED_AMOUNT,
   UPDATED_PAYMENT_DETAILS,
+  CUSTOMER,
 };
diff --git a/test/recurring/manage_payments.test.js b/test/recurring/manage_payments.test.js
@@ -23,6 +23,7 @@ module.exports = function(x) {
         interval: TestConstants.INTERVAL,
         interval_count: TestConstants.INTERVAL_COUNT,
         start_date: TestConstants.START_DATE,
+        customer: TestConstants.CUSTOMER,
       })
       .reply(201, TestConstants.PAYMENT_DETAILS);
     nock(rp.API_ENDPOINT)
@@ -46,6 +47,7 @@ module.exports = function(x) {
           interval: RecurringPayment.Interval.Month,
           intervalCount: TestConstants.INTERVAL_COUNT,
           startDate: new Date(TestConstants.PAYMENT_DETAILS.start_date),
+          customer: TestConstants.CUSTOMER,
         }),
       )
         .to.eventually.deep.equal(TestConstants.PAYMENT_DETAILS)