starling.js

  1. import Customer from './entities/customer';
  2. import Account from './entities/account';
  3. import Address from './entities/address';
  4. import Transaction from './entities/transaction';
  5. import Card from './entities/card';
  6. import OAuth from './entities/oauth';
  7. import Contact from './entities/contact';
  8. import Payment from './entities/payment';
  9. import Mandate from './entities/mandate';
  11. /**
  12.  * Facade to dispatch operations to services
  13.  */
  14. class Starling {
  16.   /**
  17.    * Create an instance of the starling client
  18.    * @param {Object=} options - configuration parameters
  19.    */
  20.   constructor (options) {
  21.     const defaults = {
  22.       apiUrl: 'https://api.starlingbank.com',
  23.       oauthUrl: 'https://oauth.starlingbank.com',
  24.       clientId: '',
  25.       clientSecret: ''
  26.     };
  28.     this.config = Object.assign({}, defaults, options);
  30.     this.customer = new Customer(this.config);
  31.     this.account = new Account(this.config);
  32.     this.address = new Address(this.config);
  33.     this.transaction = new Transaction(this.config);
  34.     this.payment = new Payment(this.config);
  35.     this.mandate = new Mandate(this.config);
  36.     this.contact = new Contact(this.config);
  37.     this.card = new Card(this.config);
  38.     this.oAuth = new OAuth(this.config);
  39.   }
  41.   /**
  42.    * Gets the customer's details
  43.    * @param {string=} accessToken - the oauth bearer token. If not
  44.    * specified, the accessToken on the options object is used.
  45.    * @return {Promise} - the http request promise
  46.    */
  47.   getCustomer (accessToken = this.config.accessToken) {
  48.     return this.customer.getCustomer(accessToken);
  49.   }
  51.   /**
  52.    * Gets the customer's account details
  53.    * @param {string=} accessToken - the oauth bearer token.  If not
  54.    * specified, the accessToken on the options object is used.
  55.    * @return {Promise} - the http request promise
  56.    */
  57.   getAccount (accessToken = this.config.accessToken) {
  58.     return this.account.getAccount(accessToken);
  59.   }
  61.   /**
  62.    * Gets the customer's balance
  63.    * @param {string=} accessToken - the oauth bearer token.  If not
  64.    * specified, the accessToken on the options object is used.
  65.    * @return {Promise} - the http request promise
  66.    */
  67.   getBalance (accessToken = this.config.accessToken) {
  68.     return this.account.getBalance(accessToken);
  69.   }
  71.   /**
  72.    * Gets the customer's addresses (current and previous)
  73.    * @param {string=} accessToken - the oauth bearer token.  If not
  74.    * specified, the accessToken on the options object is used.
  75.    * @return {Promise} - the http request promise
  76.    */
  77.   getAddresses (accessToken = this.config.accessToken) {
  78.     return this.address.getAddresses(accessToken);
  79.   }
  81.   /**
  82.    * Gets the customer's transaction history
  83.    * @param {string=} accessToken - the oauth bearer token.  If not
  84.    * specified, the accessToken on the options object is used.
  85.    * @param {string} fromDate - filter transactions after this date. Format: YYYY-MM-DD (optional,
  86.    *   defaults to most recent 100 transactions)
  87.    * @param {string} toDate - filter transactions before this date. Format: YYYY-MM-DD (optional,
  88.    *   defaults to current date if not provided)
  89.    * @param {string=} source - the transaction type (e.g. faster payments, mastercard).
  90.    * If not specified, results are not filtered by source.
  91.    * @return {Promise} - the http request promise
  92.    */
  93.   getTransactions (accessToken = this.config.accessToken, fromDate, toDate, source) {
  94.     return this.transaction.getTransactions(accessToken, fromDate, toDate, source);
  95.   }
  97.   /**
  98.    * Gets the full details of a single transaction
  99.    * @param {string=} accessToken - the oauth bearer token.  If not
  100.    * specified, the accessToken on the options object is used.
  101.    * @param {string} transactionId - the unique transaction ID
  102.    * @param {string=} source - the transaction type (e.g. faster payments, mastercard).
  103.    * If not specified, only generic transaction information will be returned.
  104.    * @return {Promise} - the http request promise
  105.    */
  106.   getTransaction (accessToken = this.config.accessToken, transactionId, source) {
  107.     return this.transaction.getTransaction(accessToken, transactionId, source);
  108.   }
  110.   /**
  111.    * Gets the customer's current direct-debit mandates
  112.    * @param {string=} accessToken - the oauth bearer token.  If not
  113.    * specified, the accessToken on the options object is used.
  114.    * @return {Promise} - the http request promise
  115.    */
  116.   listMandates (accessToken = this.config.accessToken) {
  117.     return this.mandate.listMandates(accessToken);
  118.   }
  120.   /**
  121.    * Deletes specific direct debit mandate
  122.    * @param {string} accessToken - the oauth bearer token.
  123.    * @param {string} mandateId - the unique mandate ID
  124.    * @return {Promise} - the http request promise
  125.    */
  126.   deleteMandate (accessToken = this.config.accessToken, mandateId) {
  127.     return this.mandate.deleteMandate(accessToken, mandateId);
  128.   }
  130.   /**
  131.    * Lists the customer's scheduled payments
  132.    * @param {string} accessToken - the oauth bearer token.
  133.    * @return {Promise} - the http request promise
  134.    */
  135.   listScheduledPayments (accessToken = this.config.accessToken) {
  136.     return this.payment.listScheduledPayments(accessToken);
  137.   }
  139.   /**
  140.    * Makes a payment on behalf of the customer to another UK bank account using the Faster Payments network
  141.    * @param {string} accessToken - the oauth bearer token.
  142.    *  @param {string} destinationAccountId - the account identifier of the recipient
  143.    * @param {string} reference - The payment reference, max. 18 characters.
  144.    * @param {string} amount - the amount to be send.
  145.    * @param {string=} currency - the currency, optional, defaults to "GBP".
  146.    * @return {Promise} - the http request promise
  147.    */
  148.   makeLocalPayment (accessToken = this.config.accessToken, destinationAccountId, reference, amount, currency = 'GBP') {
  149.     return this.payment.makeLocalPayment(accessToken, destinationAccountId, reference, amount, currency);
  150.   }
  152.   /**
  153.    * Gets the customer's contacts (payees)
  154.    * @param {string} accessToken - the oauth bearer token.
  155.    * @return {Promise} - the http request promise
  156.    */
  157.   getContacts (accessToken = this.config.accessToken) {
  158.     return this.contact.getContacts(accessToken);
  159.   }
  161.   /**
  162.    * Gets a specific contact (payee)
  163.    * @param {string} accessToken - the oauth bearer token.
  164.    * @param {string} contactId - the contact's ID.
  165.    * @return {Promise} - the http request promise
  166.    */
  167.   getContactAccount (accessToken = this.config.accessToken, contactId) {
  168.     return this.contact.getContactAccount(accessToken, contactId);
  169.   }
  171.   /**
  172.    * Creates a contact (payee) for the customer
  173.    * @param {string} accessToken - the oauth bearer token.
  174.    * @param {string} name - the name of the new contact.
  175.    * @param {string=} accountType - the account type (domestic or international), optional and defaults to UK_ACCOUNT_AND_SORT_CODE.
  176.    * @param {string} accountNumber - the contact's bank account number.
  177.    * @param {string} sortCode - the contact's sort code.
  178.    * @param {string} customerId - the customer's ID.
  179.    * @return {Promise} - the http request promise
  180.    */
  181.   createContact (accessToken = this.config.accessToken, name, accountType = 'UK_ACCOUNT_AND_SORT_CODE', accountNumber, sortCode, customerId) {
  182.     return this.contact.createContact(accessToken, name, accountType, accountNumber, sortCode, customerId);
  183.   }
  185.   deleteContact (accessToken, contactId) {
  186.     return this.contact.deleteContact(accessToken, contactId);
  187.   }
  189.   /**
  190.    * Gets the customer's card
  191.    * @param {string=} accessToken - the oauth bearer token.  If not
  192.    * specified, the accessToken on the options object is used.
  193.    * @return {Promise} - the http request promise
  194.    */
  195.   getCard (accessToken = this.config.accessToken) {
  196.     return this.card.getCard(accessToken);
  197.   }
  199.   /**
  200.    * Exchanges the authorization code for an access token
  201.    * @param {string} authorizationCode - the authorization code, acquired from the user agent after the
  202.    * user authenticates with starling
  203.    * @return {Promise} - the http request promise
  204.    */
  205.   getAccessToken (authorizationCode) {
  206.     return this.oAuth.getAccessToken(authorizationCode);
  207.   }
  209.   /**
  210.    * Exchanges the authorization code for an access token
  211.    * @param {string} refreshToken - the oauth refresh token, used to claim a new access token when the access token
  212.    * expires. A new refresh token is also returned.
  213.    * @return {Promise} - the http request promise
  214.    */
  215.   refreshAccessToken (refreshToken) {
  216.     return this.oAuth.refreshAccessToken(refreshToken);
  217.   }
  218. }
  220. module.exports = Starling;