entities/mandate.js

  1. import axios from 'axios';
  2. import debug from 'debug';
  3. import {defaultHeaders} from '../utils/http';
  4. import {typeValidation} from '../utils/validator';
  6. const log = debug('starling:mandate-service');
  9. /**
  10.  * Service to interact with a customer's transactions
  11.  */
  12. class Mandate {
  13.   /**
  14.    * Create a new transaction service
  15.    * @param {Object} options - configuration parameters
  16.    */
  17.   constructor (options) {
  18.     this.options = options;
  19.   }
  21.   /**
  22.    * Gets a list of the customer's current direct debit mandates
  23.    * @param {string} accessToken - the oauth bearer token.
  24.    * @return {Promise} - the http request promise
  25.    */
  26.   listMandates (accessToken) {
  27.     typeValidation(arguments, listMandatesParameterDefinition);
  28.     const url = `${this.options.apiUrl}/api/v1/direct-debit/mandates`;
  29.     log(`GET ${url}`);
  30.     return axios({
  31.       method: 'GET',
  32.       url,
  33.       headers: defaultHeaders(accessToken)
  34.     });
  35.   }
  37.   /**
  38.    * Deletes specific direct debit mandate
  39.    * @param {string} accessToken - the oauth bearer token.
  40.    * @param {string} mandateId - the unique mandate ID
  41.    * @return {Promise} - the http request promise
  42.    */
  43.   deleteMandate (accessToken, mandateId) {
  44.     typeValidation(arguments, deleteMandateParameterDefinition);
  45.     const url = `${this.options.apiUrl}/api/v1/direct-debit/mandates/${mandateId}`;
  46.     log(`DELETE ${url}`);
  47.     return axios({
  48.       method: 'DELETE',
  49.       url,
  50.       headers: defaultHeaders(accessToken)
  51.     });
  52.   }
  53. }
  55. const listMandatesParameterDefinition = [
  56.   {name: 'accessToken', validations: ['required', 'string']}
  57. ];
  59. const deleteMandateParameterDefinition = [
  60.   {name: 'accessToken', validations: ['required', 'string']},
  61.   {name: 'mandateId', validations: ['required', 'string']}
  62. ];
  64. module.exports = Mandate;