UNPKG

starling_helper

Version:

A helper library for starling

github.com/davegrix/Starling-Helper

davegrix/Starling-Helper

117 lines (92 loc) • 2.47 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# Starling Helper <!--@shields.plastic('npm')--> [![npm version](https://img.shields.io/npm/v/starling_helper.svg?style=plastic)](https://www.npmjs.com/package/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()--> ## Installation ```sh npm install --save starling_helper ``` <!--/@--> ## Usage You will need to include the package in your app, and initialize it your personal access token ```javascript 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 ```javascript // /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()--> ## License MIT © Dave Grix <!--/@-->