1.2.2 • Published 6 years ago

payrex-js-sdk-base v1.2.2

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

PAYREX-JS-SDK-BASE

Build Status codecov

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

Install

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

Usage

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

const options = {/* ... options ... */};
const sdkBase = new PayrexSdkBase(options);
OptionTypeUsageDescription
credentialsstringoptionalAPI secret key
baseUrlstringoptionalAPI base url (default "http://localhost:3000/")
fetchfunctionrequiredFetch function
HeadersfunctionrequiredFetch Headers
UrlobjectrequiredUrl class

get(path, [options])

Make HTTP-GET request to API.

ParamTypeDescription
pathstringPath (ex. "/users" or "/users/1")
optionsobjectOptions
options.queryParamsobjectAdditional query params to merge
sdkBase
  .get('/users?status=ACTIVE')
  .then(response => { /* ... */})
  .catch(err => {/* Process error */})

post(path, body, [options])

Make HTTP-POST request to API.

ParamTypeDescription
pathstringPath (ex. "/users" or "/users/1")
bodyobjectBody data
optionsobjectOptions
options.queryParamsobjectAdditional query params to merge
sdkBase
  .post('/users', {
    name: 'John Doe',
    status: 'ACTIVE'
  })
  .then(response => { /* ... */})
  .catch(err => {/* Process error */})

put(path, body, [options])

Make HTTP-PUT request to API.

ParamTypeDescription
pathstringPath (ex. "/users" or "/users/1")
bodyobjectBody data
optionsobjectOptions
options.queryParamsobjectAdditional query params to merge
sdkBase
  .put('/users', {
    name: 'Johnny Doe'
  })
  .then(response => { /* ... */})
  .catch(err => {/* Process error */})

remove(path, [options])

Make HTTP-DELETE request to API.

ParamTypeDescription
pathstringPath (ex. "/users" or "/users/1")
optionsobjectOptions
options.queryParamsobjectAdditional query params to merge
sdkBase
  .remove('/users/1')
  .then(response => { /* ... */})
  .catch(err => {/* Process error */})
1.2.2

6 years ago

1.2.1

6 years ago

1.2.0

6 years ago

1.1.7

6 years ago

1.1.6

6 years ago

1.1.5

6 years ago

1.1.4

6 years ago

1.1.3

6 years ago

1.1.2

6 years ago

1.1.1

6 years ago

1.1.0

6 years ago

1.0.3

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago