Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

starling_helper

0.0.6 • Public • Published

Starling Helper

npm version

Description

Starling Helper is a library to help you connect to your Starling account, it assumes you are using a personal access key and no oAuth is implemented.

Currently all get requests are available and I am working on the POST and DELETE requests.

Please see the below examples on how to get started.

Installation

npm install --save starling_helper

Usage

You will need to include the package in your app, and initialize it your personal access token

const helper = require('starling_helper');
helper.apiKey = 'mylongpersonalaccesstoken'

You are now ready to use the library.

Some end points require variables, a full list is available in the variables table below. You set a variable into an object and pass this to the library like below

// /api/v1/contacts/{id}
 
const params = {};
params.contactID = 'mycontactUUID'
helper.params = params;
 
helper.getData('getContactByID')
.then(contactInfo => {
    //...
})
.catch(contactInfoError => {
    //...
});

Available End Points and Calls

The following are currently Available

  • Accounts
    • getAccounts
    • getAccountBalances
  • Addresses
    • getAddresses
  • Contacts
    • getContacts
    • getContactByID
      • contactID
    • getContactAccounts
      • contactID
    • getContactAccountByID
      • contactID
      • contactAccountID
  • Customers
    • getCustomers
  • Direct Debit Mandates
    • getDirectDebitMandates
    • getDirectDebitMandatesByUID
      • mandateUID
  • Who Am I?
    • getMe
  • Cards
    • getCards
  • Payments
    • getPaymentSchedule
  • Transactions
    • getTodaysTransactions
    • getWeeksTransactions
    • getMonthsTransactions
    • getYearsTransactions
    • getAllTransactions
  • Merchants
    • getMerchant
      • merchantID
    • getMerchantLocation
      • merchantID
      • merchantLocationID
  • Goals
    • getAllSavingGoals
    • getGoalByID
      • savingsGoalID
    • getGoalsRecurringTransfers
      • savingsGoalID
    • getGoalPhoto
      • savingsGoalID

Tests and Coverage

npm test

License

MIT © Dave Grix

Install

npm i starling_helper

DownloadsWeekly Downloads

3

Version

0.0.6

License

MIT

Last publish

Collaborators

  • avatar