feat: new billing functions for referral customers

Author: Justintime50

CHANGELOG.md

@@ -4,6 +4,12 @@
 
 - Drop support for Node 12, 13, 14, and 15
 - Adds `webhook_secret` and `custom_headers` properties to Typescript definitions of a Webhook
+- Adds the following functions to assist ReferralCustomers add credit cards and bank accounts:
+  - `betaReferralCustomer.createCreditCardClientSecret`
+  - `betaReferralCustomer.createBankAccountClientSecret`
+  - `referralCustomer.addCreditCardFromStripe`
+  - `referralCustomer.addBankAccountFromStripe`
+- Properly returns the response body of the following functions: `addPaymentMethod`, `refundByAmount`, `refundByPaymentLog`
 - `findMatchingMockRequest` mocking function made private
 - Removes undocumented and unmaintained `repl`
 - Bumps dependencies

examples

@@ -10,7 +10,7 @@ export default (easypostClient) =>
      * @returns {Object} - A JSON object representing the payment method.
      */
     static async addPaymentMethod(stripeCustomerId, paymentMethodReference, priority = 'primary') {
-      const wrappedParams = {
+      const params = {
         payment_method: {
           stripe_customer_id: stripeCustomerId,
           payment_method_reference: paymentMethodReference,
@@ -20,9 +20,9 @@ export default (easypostClient) =>
 
       const url = 'beta/referral_customers/payment_method';
 
-      const response = await easypostClient._post(url, wrappedParams);
+      const response = await easypostClient._post(url, params);
 
-      return response;
+      return response.body;
     }
 
     /**
@@ -39,7 +39,7 @@ export default (easypostClient) =>
 
       const response = await easypostClient._post(url, params);
 
-      return response;
+      return response.body;
     }
 
     /**
@@ -56,6 +56,32 @@ export default (easypostClient) =>
 
       const response = await easypostClient._post(url, params);
 
-      return response;
+      return response.body;
+    }
+
+    /**
+     * Creates a client secret to use with Stripe when adding a credit card.
+     * @returns {object} - A JSON object representing the client secret.
+     */
+    static async createCreditCardClientSecret() {
+      const url = 'beta/setup_intents';
+
+      const response = await easypostClient._post(url, null);
+
+      return response.body;
+    }
+
+    /**
+     * Creates a client secret to use with Stripe when adding a credit card.
+     * @returns {object} - A JSON object representing the client secret.
+     */
+    static async createBankAccountClientSecret(returnUrl) {
+      const params = returnUrl ? { return_url: returnUrl } : null;
+
+      const url = 'beta/financial_connections_sessions';
+
+      const response = await easypostClient._post(url, params);
+
+      return response.body;
     }
   };

package-lock.json

@@ -121,7 +121,7 @@ export default (easypostClient) =>
     }
 
     /**
-     * Add a credit card to a {@link User referral customer's} account.
+     * Add a credit card to EasyPost for a ReferralCustomer without needing a Stripe account. This function requires the ReferralCustomer User's API key.
      * See {@link https://www.easypost.com/docs/api/node#create-credit-card EasyPost API Documentation} for more information.
      * @param {string} referralApiKey - The referral customer's production API key.
      * @param {string} number - The credit card number.
@@ -159,6 +159,51 @@ export default (easypostClient) =>
       return paymentMethod;
     }
 
+    /**
+     * Add a credit card to EasyPost for a ReferralCustomer with a payment method ID from Stripe.
+     * This function requires the ReferralCustomer User's API key.
+     * @returns {object} - A JSON object representing the credit card.
+     */
+    static async addCreditCardFromStripe(referralApiKey, paymentMethodId, priority = 'primary') {
+      const _client = _getReferralClient(easypostClient, referralApiKey);
+      const params = {
+        credit_card: {
+          payment_method_id: paymentMethodId,
+          priority: priority,
+        },
+      };
+      const url = 'credit_cards';
+
+      const response = await _client._post(url, params);
+
+      return this._convertToEasyPostObject(response.body, params);
+    }
+
+    /**
+     * Add a bank account to EasyPost for a ReferralCustomer.
+     * This function requires the ReferralCustomer User's API key.
+     * @returns {object} - A JSON object representing the bank account.
+     */
+    static async addBankAccountFromStripe(
+      referralApiKey,
+      financialConnectionsId,
+      mandateData,
+      priority = 'primary',
+    ) {
+      const _client = _getReferralClient(easypostClient, referralApiKey);
+      const params = {
+        financial_connections_id: financialConnectionsId,
+        mandate_data: mandateData,
+        priority: priority,
+      };
+
+      const url = 'bank_accounts';
+
+      const response = await _client._post(url, params);
+
+      return this._convertToEasyPostObject(response.body, params);
+    }
+
     /**
      * Retrieve all {@link User referral customers} associated with the current authenticated user.
      * See {@link https://www.easypost.com/docs/api/node#retrieve-a-list-of-referral-customers EasyPost API Documentation} for more information.