starling.js

  1. import Customer from './customer';
  2. import Account from './account';
  3. import Address from './address';
  4. import Transaction from './transaction';
  5. import Card from './card';
  6. import Contact from './contact';
  8. /**
  9.  * Facade to dispatch operations to services
  10.  */
  11. class Starling {
  13.   /**
  14.    * Create an instance of the starling client
  15.    * @param {Object=} options - configuration parameters
  16.    */
  17.   constructor (options) {
  18.     const defaults = {
  19.       apiUrl: 'https://api.starlingbank.com'
  20.     };
  22.     this.config = Object.assign({}, defaults, options);
  24.     this.customer = new Customer(this.config);
  25.     this.account = new Account(this.config);
  26.     this.address = new Address(this.config);
  27.     this.transaction = new Transaction(this.config);
  28.     this.contact = new Contact(this.config);
  29.     this.card = new Card(this.config);
  30.   }
  32.   /**
  33.    * Gets the customer's details
  34.    * @param {string=} accessToken - the oauth bearer token. If not
  35.    * specified, the accessToken on the options object is used.
  36.    * @return {Promise} - the http request promise
  37.    */
  38.   getCustomer (accessToken = this.config.accessToken) {
  39.     return this.customer.getCustomer(accessToken);
  40.   }
  42.   /**
  43.    * Gets the customer's account details
  44.    * @param {string=} accessToken - the oauth bearer token.  If not
  45.    * specified, the accessToken on the options object is used.
  46.    * @return {Promise} - the http request promise
  47.    */
  48.   getAccount (accessToken = this.config.accessToken) {
  49.     return this.account.getAccount(accessToken);
  50.   }
  52.   /**
  53.    * Gets the customer's balance
  54.    * @param {string=} accessToken - the oauth bearer token.  If not
  55.    * specified, the accessToken on the options object is used.
  56.    * @return {Promise} - the http request promise
  57.    */
  58.   getBalance (accessToken = this.config.accessToken) {
  59.     return this.account.getBalance(accessToken);
  60.   }
  62.   /**
  63.    * Gets the customer's addresses (current and previous)
  64.    * @param {string=} accessToken - the oauth bearer token.  If not
  65.    * specified, the accessToken on the options object is used.
  66.    * @return {Promise} - the http request promise
  67.    */
  68.   getAddresses (accessToken = this.config.accessToken) {
  69.     return this.address.getAddresses(accessToken);
  70.   }
  72.   /**
  73.    * Gets the customer's transaction history
  74.    * @param {string} fromDate - filter transactions after this date. Format: YYYY-MM-DD (optional,
  75.    *   defaults to one month in past if not provided)
  76.    * @param {string} toDate - filter transactions before this date. Format: YYYY-MM-DD (optional,
  77.    *   defaults to current date if not provided)
  78.    * @param {string=} accessToken - the oauth bearer token.  If not
  79.    * specified, the accessToken on the options object is used.
  80.    * @return {Promise} - the http request promise
  81.    */
  82.   getTransactions (fromDate, toDate, accessToken = this.config.accessToken) {
  83.     return this.transaction.getTransactions(fromDate, toDate, accessToken);
  84.   }
  86.   /**
  87.    * Gets the full details of a single transaction
  88.    * @param {string} transactionID - the unique transaction ID
  89.    * @param {string=} accessToken - the oauth bearer token.  If not
  90.    * specified, the accessToken on the options object is used.
  91.    * @return {Promise} - the http request promise
  92.    */
  93.   getTransaction (transactionID, accessToken = this.config.accessToken) {
  94.     return this.transaction.getTransaction(transactionID, accessToken);
  95.   }
  97.   /**
  98.    * Gets the customer's balance
  99.    * @param {string=} accessToken - the oauth bearer token.  If not
  100.    * specified, the accessToken on the options object is used.
  101.    * @return {Promise} - the http request promise
  102.    */
  103.   getContacts (accessToken = this.config.accessToken) {
  104.     return this.contact.getContacts(accessToken);
  105.   }
  107.   /**
  108.    * Gets the customer's card
  109.    * @param {string=} accessToken - the oauth bearer token.  If not
  110.    * specified, the accessToken on the options object is used.
  111.    * @return {Promise} - the http request promise
  112.    */
  113.   getCard (accessToken = this.config.accessToken) {
  114.     return this.card.getCard(accessToken);
  115.   }
  116. }
  118. module.exports = Starling;