node-flinks
    TypeScript icon, indicating that this package has built-in type declarations

    0.4.0 • Public • Published

    Node Flinks

    Build status

    A Flinks API wrapper for Node.js

    Usage

    Installation

    npm install node-flinks

    Creating a client

    import FlinksClient from 'node-flinks';
    
    const flinks = new FlinksClient(
      instanceName: 'toolbox', // Flinks sandbox instance
      clientId: '43387ca6-0391-4c82-857d-70d95f087ecb' // Flinks sandbox clientId
    );

    Creating a token

    When using OAuth with Flinks you must first make a token request where you exchange a clientId, and secret for a response that contains an accessToken.

    const flinksTokenResponse = await flinks.token( clientId: '<your clientId>', secret: '<your secret>');

    Making an authorize request

    After creating a token or if not using OAuth you need make an authorize request where you exchange a loginId for a requestId.

    const requestId = await flinks.authorize({ loginId: '<your loginId>' });

    Requesting accounts detail

    Once you have a requestId you can request the user's accounts detail.

    const accountsDetail = await flinks.getAccountsDetail({ requestId: '<your requestId from earlier' });

    Debugging

    This library uses the debug library. To print debug messages for node-flinks set DEBUG=node-flinks:*.

    API

    The API of this library mostly follows the Flinks API as specified in the REST API docs. The main difference is that the Flinks API uses PascalCase for object keys and this library uses camelCase.

    Here is a list of all the Flinks API endpoints along with the corresponding library method. We have not yet implemented all the endpoints in the Flinks REST API. If an endpoint you need is missing please consider submitting a pull request.

    Endpoint Client Method Reference
    /AnswerMFAQuestions Not implemented Docs
    /Attributes Not implemented Docs
    /Authorize authorize Docs
    /DeleteCard Not implemented Docs
    /GenerateAuthorizeToken Not implemented Docs
    /GetAccountsDetail getAccountsDetail Docs
    /GetAccountsDetailAsync getAccountsDetailAsync Docs
    /GetAccountsSummary getAccountsSummary Docs
    /GetAccountsSummaryAsync getAccountsSummaryAsync Docs
    /GetAllAttributes Not implemented Docs
    /GetCreditRiskAttributes Not implemented Docs
    /GetIncomeAttributes Not implemented Docs
    /GetMFAQuestions Not implemented Docs
    /GetStatements getStatements Docs
    /GetUserAnalysisAttributes Not implemented Docs
    /Investments Not implemented Docs
    /SetScheduledRefresh Not implemented Docs
    /Token token Docs

    Contributing

    Development

    1. Clone this repo
    2. npm install
    3. npm link
    4. In the package you want to test in run npm link node-flinks
    5. Build package with npm run build or turn on watch mode with npm run watch

    Testing

    npm test

    Building

    npm run build

    If you need to clear the build cache run npm run clean

    Publishing

    1. Update the version in package.json
    2. Add a CHANGELOG entry
    3. Commit your changes
    4. Run npm pack --dry-run to see what will be published
    5. Run npm publish
    6. Create a release on GitHub. Use the version as the tag and release name. For example for version 1.0.0 the tag and release name would be v1.0.0.

    Keywords

    none

    Install

    npm i node-flinks

    DownloadsWeekly Downloads

    575

    Version

    0.4.0

    License

    MIT

    Unpacked Size

    63.1 kB

    Total Files

    42

    Last publish

    Collaborators

    • cghenneneo
    • rahulkambojneo
    • punit.patel
    • brayden_sc_neo
    • anna_benemanskaia
    • hrishikeshkale
    • kyle-elyk-neo
    • michelepiperni
    • neo-youre_pena
    • neo-michal-kowal
    • cole.murphy
    • niconeiman
    • mateus-cerqueira-neo
    • neodiegobeltran
    • stburke
    • johnzhou2022
    • marcelo.matos
    • neoricardogcolombo
    • carolina-bury-neo
    • matheusicaro
    • divanshu
    • neo-vahid-haghighat
    • maiahneo
    • chloe_eunsuk
    • kimberlytranneo
    • rjberry
    • dean.rud
    • neo-carlos-pieren
    • mohamedalhammoud
    • neo-hasanpreetsingh
    • irakitnykh
    • ravi-patel
    • katrinaw
    • neo_daraakitoye
    • jcavalcanti
    • dbhalotia
    • hozefa_neo
    • stephanie-wang-neo
    • kaelanneofinancial
    • slava_korenblit
    • vinicius-barcelos
    • neo-ife-ojikutu
    • arshroop-neo
    • moushumi-das
    • benx-neo
    • mhowitt-neo
    • malcolm-neo
    • neo-seol-kim
    • kevingiang-neo
    • brentcam
    • teena_
    • neo-prince-chavez
    • seungwan.yuk
    • christyc
    • deankim
    • herculesjr
    • matthew.belford
    • rishbar
    • anandpatel1
    • neo-baonguyen
    • caio.andrade
    • phuan516
    • scott.wiedemann
    • thomawstrahn
    • luan.le
    • dennisbarthel
    • lavanya.mohan
    • richard.scheid
    • leosbelsotomayor
    • dilushaneo
    • flaviosilva-neo
    • dhruvang
    • varunhasteer
    • neo-rodrigoraval
    • jordan.brauer
    • joeljwood
    • ctataryn
    • nahom-neo
    • stefan.amyotte
    • timothy.couch.neofinancial
    • rsbarnard
    • lianafilizola
    • donniewalsh
    • neo-patrick-weckworth
    • scottkayeneo
    • leah-is-offline
    • rogersnick
    • omolara
    • ryan.liew
    • ar-ies
    • cjnewman
    • sidney.dizon
    • amber.bhatt
    • vidalrmrz
    • rnetto46
    • iansu
    • darrenpicard25
    • maxgoo
    • stschmaltz
    • usernameseb
    • eric.zaporzan.neo
    • lucasparreira
    • lewishorwood
    • kimwj0318
    • craigsiemens
    • diegobmy
    • neo.eduardoyuidy
    • joelsimpson
    • daniel.neo
    • jooh-lee
    • mkurapov-neo
    • mrjoedang
    • kasrababaei
    • heramb-sawant
    • mattlabarre
    • dadair-ca
    • u2v22
    • hypnocrit
    • johnclendvoy
    • demaestro
    • sudeep.sidhu
    • daylan.law
    • keithwyatt
    • bethelh
    • sean.heintz
    • andre.campestrini
    • neo-stephen
    • neogibson
    • beraki
    • vrochamaaia
    • rmagatti
    • d_fenniak
    • mato-gallardo
    • mbhagat
    • adamtranquilla
    • nehasingh1801
    • lucaslongarini
    • mitchell-gonzalez
    • erozonachi
    • faddoul
    • lovekesh1
    • paulohauck
    • jeffrey-dugas-neo
    • yash-coded
    • sean_kenny
    • pichatelli
    • dubby20
    • timajuma
    • geff-neo
    • npoltz-neo
    • david.tse