monzo-api

v1.0.9

Published

2 years ago

Easy interaction with monzo-api

Downloads

0High
0Medium
0Low

pr00f

monzo-api

Node Monzo API easy integration

Instalation

npm i monzo-api -S

Usage

import MonzoApi from 'monzo-api';

const clientId = 'your-app-client-id';
const clientSecret = 'your-app-client-secret';
const verificationCode = 'code-that-server-gets-after-the-redirection';
const verificationStateToken = 'state-token-received-in-query-string-after-redirection';
const monzoApi = new MonzoApi(clientId, clientSecret);

monzoApi.redirectUrl = 'http://127.0.0.1/monzo-validation';

console.log('Redirect the user to', monzoApi.authorizationUrl);

monzoApi.authenticate(code, 'exampleStateToken')
        .then((res) => {
            console.log("Congrats, you're logged in", res);
        })
        .catch((err) => {
            console.error('Uh Oh! Something wrong happened. :(');
            console.error(err);
        });

Documentation

MonzoApi
- new MonzoApi(clientId, clientSecret)
- .clientId
- .clientId ⇒ string
- .clientSecret
- .clientSecret ⇒ string
- .redirectUrl
- .redirectUrl ⇒ string
- .refreshToken
- .refreshToken ⇒ string
- .accessToken
- .accessToken ⇒ string
- .code ⇒ string
- .stateToken ⇒ string
- .stateToken ⇒ string
- .authorizationUrl ⇒ string
- .generateStateToken() ⇒ String
- .authenticate(code, stateToken, [verifyStateToken]) ⇒ Promise.<object, Error>
- .refreshAccess([refreshToken]) ⇒ Promise.<object, Error>
- .ping([acessToken]) ⇒ Promise.<object, Error>
- .accounts([acessToken]) ⇒ Promise.<object, Error>
- .balance(accountId, [acessToken]) ⇒ Promise.<object, Error>
- .transaction(transactionId, [expanded], [acessToken]) ⇒ Promise.<object, Error>
- .transactions(accountId, [expanded], [query], [acessToken]) ⇒ Promise.<object, Error>
- .annotate(transactionId, metadata, [acessToken]) ⇒ Promise.<object, Error>
- .feedItem(accountId, [url], [type], [params], [acessToken]) ⇒ Promise.<object, Error>
- .registerWebhook(accountId, url, [acessToken]) ⇒ Promise.<object, Error>
- .webhooks(accountId, [acessToken]) ⇒ Promise.<object, Error>
- .deleteWebhook(webhookId, [acessToken]) ⇒ Promise.<object, Error>
- .uploadImage(file, fileName, fileType) ⇒ Promise.<object, Error>
- .registerAttachment(externalId, fileUrl, fileType, [acessToken]) ⇒ Promise.<object, Error>
- .deregisterAttachment(attachmentId, [acessToken]) ⇒ Promise.<object, Error>
- .makeRequest(requestType, requestEndpoint, requestData, [useBearer]) ⇒ Promise.<object, Error>

new MonzoApi(clientId, clientSecret)

Create a monzo api instance.

| Param | Type | Description | | --- | --- | --- | | clientId | string | The client id value. | | clientSecret | string | The client secret value. |

monzoApi.clientId

Set the clientId value.

Kind: instance property of MonzoApi

| Param | Type | Description | | --- | --- | --- | | value | string | The clientId value. |

monzoApi.clientId ⇒ string

Get the clientId value.

Kind: instance property of MonzoApi Returns: string - The clientId value.

monzoApi.clientSecret

Set the clientSecret value.

Kind: instance property of MonzoApi

| Param | Type | Description | | --- | --- | --- | | value | string | The clientSecret value. |

monzoApi.clientSecret ⇒ string

Get the clientSecret value.

Kind: instance property of MonzoApi Returns: string - The clientSecret value.

monzoApi.redirectUrl

Set the redirectUrl value.

Kind: instance property of MonzoApi

| Param | Type | Description | | --- | --- | --- | | value | string | The redirectUrl value. |

monzoApi.redirectUrl ⇒ string

Get the redirectUrl value.

Kind: instance property of MonzoApi Returns: string - The redirectUrl value.

monzoApi.refreshToken

Set the refreshToken value.

Kind: instance property of MonzoApi

| Param | Type | Description | | --- | --- | --- | | value | string | The refreshToken value. |

monzoApi.refreshToken ⇒ string

Get the refreshToken value.

Kind: instance property of MonzoApi Returns: string - The refreshToken value.

monzoApi.accessToken

Set the accessToken value.

Kind: instance property of MonzoApi

| Param | Type | Description | | --- | --- | --- | | value | string | The accessToken value. |

monzoApi.accessToken ⇒ string

Get the accessToken value.

Kind: instance property of MonzoApi Returns: string - The accessToken value.

monzoApi.code ⇒ string

Get the code value. It will be set when authenticate method gets called

Kind: instance property of MonzoApi Returns: string - The code value.

monzoApi.stateToken ⇒ string

Get the stateToken value. Value that will be matched against the one provided when a user authenticates. The values must match otherwise the authentication won't proceed

Kind: instance property of MonzoApi Returns: string - The stateToken value.

monzoApi.stateToken ⇒ string

Set the stateToken

Kind: instance property of MonzoApi Returns: string - The stateToken value.

monzoApi.authorizationUrl ⇒ string

Get the authorizationUrl value. The user needs to be redirected to this url in order to authenticate

Kind: instance property of MonzoApi Returns: string - The authorizationUrl value.

monzoApi.generateStateToken() ⇒ String

Create a state token that gets send on the authorizationUrl

Kind: instance method of MonzoApi Returns: String - The token value that was stored and needs to be compared on authorization

monzoApi.authenticate(code, stateToken, [verifyStateToken]) ⇒ Promise.<object, Error>

Authenticate the user given the code and the stateToken found in the query string of the redirectUrl