payrex-js-sdk-base

PAYREX-JS-SDK-BASE
==================


Base class for Payrex JS SDK.
Don't use this repo directly, you should use
payrex/js-sdk-node instead.

Install
-------

``bash
npm install --save payrex-js-sdk-base
`


Usage
-----

`javascript
const PayrexSdkBase = require('payrex-js-sdk-base');

const options = {/ ... options ... /};
const sdkBase = new PayrexSdkBase(options);
`

| Option | Type | Usage | Description |
|--------|------|-------|-------------|
| credentials | string | optional | API secret key |
| baseUrl | string | optional | API base url (default "http://localhost:3000/") |
| fetch | function | required | Fetch function |
| Headers | function | required | Fetch Headers |
| Url | object | required | Url class |

$3

Make HTTP-GET request to API.

| Param | Type | Description |
|-------|------|-------------|
| path | string | Path (ex. "/users" or "/users/1") |
| options | object | Options |
| options.queryParams | object | Additional query params to merge |

`js
sdkBase
.get('/users?status=ACTIVE')
.then(response => { / ... /})
.catch(err => {/ Process error /})
`

$3

Make HTTP-POST request to API.

| Param | Type | Description |
|-------|------|-------------|
| path | string | Path (ex. "/users" or "/users/1") |
| body | object | Body data |
| options | object | Options |
| options.queryParams | object | Additional query params to merge |

`js
sdkBase
.post('/users', {
name: 'John Doe',
status: 'ACTIVE'
})
.then(response => { / ... /})
.catch(err => {/ Process error /})
`

$3

Make HTTP-PUT request to API.

| Param | Type | Description |
|-------|------|-------------|
| path | string | Path (ex. "/users" or "/users/1") |
| body | object | Body data |
| options | object | Options |
| options.queryParams | object | Additional query params to merge |

`js
sdkBase
.put('/users', {
name: 'Johnny Doe'
})
.then(response => { / ... /})
.catch(err => {/ Process error /})
`

$3

Make HTTP-DELETE request to API.

| Param | Type | Description |
|-------|------|-------------|
| path | string | Path (ex. "/users" or "/users/1") |
| options | object | Options |
| options.queryParams | object | Additional query params to merge |

`js
sdkBase
.remove('/users/1')
.then(response => { / ... /})
.catch(err => {/ Process error /})
``