entities/feedItem.js

  1. import axios from 'axios'
  2. import debug from 'debug'
  3. import { defaultHeaders } from '../utils/http'
  4. import { struct, minAPIParameterDefintion } from '../utils/validator'
  6. const log = debug('starling:feed-item-service')
  8. /**
  9.  * Service to interact with a customer's feed items
  10.  */
  11. class FeedItem {
  12.   /**
  13.    * Create a new feed item service
  14.    * @param {Object} options - configuration parameters
  15.    */
  16.   constructor (options) {
  17.     this.options = options
  18.   }
  20.   /**
  21.    * Get feed items created between two timestamps
  22.    * @param {string} parameters.apiUrl - the API URL
  23.    * @param {string} parameters.accessToken - the oauth bearer token
  24.    * @param {string} parameters.accountUid - the account uid
  25.    * @param {string} parameters.categoryUid - the category uid
  26.    * @param {string} parameters.minTransactionTimestamp - timestamp e.g. '2019-10-25T12:34:56.789Z'
  27.    * @param {string} parameters.maxTransactionTimestamp - timestamp e.g. '2019-10-26T12:34:56.789Z'
  28.    * @return {Promise} - the http request promise
  29.    */
  30.   getFeedItemsBetween (parameters) {
  31.     parameters = Object.assign({}, this.options, parameters)
  32.     getFeedItemsBetweenParameterValidator(parameters)
  33.     const { apiUrl, accessToken, accountUid, categoryUid, minTransactionTimestamp, maxTransactionTimestamp } = parameters
  35.     const url = `${apiUrl}/api/v2/feed/account/${accountUid}/category/${categoryUid}/transactions-between`
  36.     log(`GET ${url}`)
  38.     return axios({
  39.       method: 'GET',
  40.       url,
  41.       params: {
  42.         minTransactionTimestamp,
  43.         maxTransactionTimestamp
  44.       },
  45.       headers: defaultHeaders(accessToken)
  46.     })
  47.   }
  49.   /**
  50.    * Get a feed item
  51.    * @param {string} parameters.apiUrl - the API URL
  52.    * @param {string} parameters.accessToken - the oauth bearer token
  53.    * @param {string} parameters.accountUid - the account uid
  54.    * @param {string} parameters.categoryUid - the category uid
  55.    * @param {string} parameters.feedItemUid - the feed item uid
  56.    * @return {Promise} - the http request promise
  57.    */
  58.   getFeedItem (parameters) {
  59.     parameters = Object.assign({}, this.options, parameters)
  60.     getFeedItemParameterValidator(parameters)
  61.     const { apiUrl, accessToken, accountUid, categoryUid, feedItemUid } = parameters
  63.     const url = `${apiUrl}/api/v2/feed/account/${accountUid}/category/${categoryUid}/${feedItemUid}`
  64.     log(`GET ${url}`)
  66.     return axios({
  67.       method: 'GET',
  68.       url,
  69.       headers: defaultHeaders(accessToken)
  70.     })
  71.   }
  73.   /**
  74.    * Get feed items created or updated since a given timestamp
  75.    * @param {string} parameters.apiUrl - the API URL
  76.    * @param {string} parameters.accessToken - the oauth bearer token
  77.    * @param {string} parameters.accountUid - the account uid
  78.    * @param {string} parameters.categoryUid - the category uid
  79.    * @param {string} parameters.changesSince - timestamp e.g. '2019-10-25T12:34:56.789Z'
  80.    * @return {Promise} - the http request promise
  81.    */
  82.   getFeedItemsChangedSince (parameters) {
  83.     parameters = Object.assign({}, this.options, parameters)
  84.     getFeedItemsChangedSinceParameterValidator(parameters)
  85.     const { apiUrl, accessToken, accountUid, categoryUid, changesSince } = parameters
  87.     const url = `${apiUrl}/api/v2/feed/account/${accountUid}/category/${categoryUid}`
  88.     log(`GET ${url}`)
  90.     return axios({
  91.       method: 'GET',
  92.       url,
  93.       params: {
  94.         changesSince
  95.       },
  96.       headers: defaultHeaders(accessToken)
  97.     })
  98.   }
  99. }
  101. const getFeedItemsBetweenParameterValidator = struct.interface({
  102.   ...minAPIParameterDefintion,
  103.   accountUid: 'uuid',
  104.   categoryUid: 'uuid',
  105.   minTransactionTimestamp: 'timestamp',
  106.   maxTransactionTimestamp: 'timestamp'
  107. })
  109. const getFeedItemParameterValidator = struct.interface({
  110.   ...minAPIParameterDefintion,
  111.   accountUid: 'uuid',
  112.   categoryUid: 'uuid',
  113.   feedItemUid: 'uuid'
  114. })
  116. const getFeedItemsChangedSinceParameterValidator = struct.interface({
  117.   ...minAPIParameterDefintion,
  118.   accountUid: 'uuid',
  119.   categoryUid: 'uuid',
  120.   changesSince: 'timestamp'
  121. })
  123. module.exports = FeedItem