Starling Helper
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 = ;helperapiKey = '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 = {};paramscontactID = 'mycontactUUID'helperparams = params; helper;
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
- getMerchant
- Goals
- getAllSavingGoals
- getGoalByID
savingsGoalID
- getGoalsRecurringTransfers
savingsGoalID
- getGoalPhoto
savingsGoalID
Tests and Coverage
npm test
License
MIT © Dave Grix