FeedItem

FeedItem

Service to interact with a customer's feed items

Constructor

new FeedItem(options)

Create a new feed item service

Source:
Parameters:
Name Type Description
options Object

configuration parameters

Methods

getFeedItem() → {Promise}

Get a feed item

Source:
Parameters:
Name Type Description
parameters.apiUrl string

the API URL

parameters.accessToken string

the oauth bearer token

parameters.accountUid string

the account uid

parameters.categoryUid string

the category uid

parameters.feedItemUid string

the feed item uid

Returns:
Type:
Promise
  • the http request promise

getFeedItemsBetween() → {Promise}

Get feed items created between two timestamps

Source:
Parameters:
Name Type Description
parameters.apiUrl string

the API URL

parameters.accessToken string

the oauth bearer token

parameters.accountUid string

the account uid

parameters.categoryUid string

the category uid

parameters.minTransactionTimestamp string

timestamp e.g. '2019-10-25T12:34:56.789Z'

parameters.maxTransactionTimestamp string

timestamp e.g. '2019-10-26T12:34:56.789Z'

Returns:
Type:
Promise
  • the http request promise

getFeedItemsChangedSince() → {Promise}

Get feed items created or updated since a given timestamp

Source:
Parameters:
Name Type Description
parameters.apiUrl string

the API URL

parameters.accessToken string

the oauth bearer token

parameters.accountUid string

the account uid

parameters.categoryUid string

the category uid

parameters.changesSince string

timestamp e.g. '2019-10-25T12:34:56.789Z'

Returns:
Type:
Promise
  • the http request promise