Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
cadu
Advanced tools
Readme
A JavaScript library to interface with CadU API, it works in Node.js.
This library covers all your needs for integrating with CadU, providing:
First, install it:
yarn add cadu
Or using npm:
npm install cadu
CadU JavaScript library can be used in two ways:
Import like usual:
import cadu from 'cadu'
also works using require
:
const cadu = require('cadu')
All of CadU REST API endpoints are covered in the client
object. Every
function call issued to client
will return a Promise
which represents and
manages the result's lifecycle.
connect
When you call connect
, a Promise
which resolves to a client
or an
error will be returned. If an authentication error happens, you can catch
the error with the Promise
interface:
import cadujs from 'cadu'
cadujs.connect({
secret: '1234',
clientApplicationKey: '1234-1234-1234',
environment: 'sandbox',
userIdentifier: 'pagarme@pagar.me',
})
.then(client => client.Members.all())
.then(console.log)
.catch(console.error)
If your method doesn't require any parameter, you can just call it without them:
client.Members
.all() // https://cadu.api.com/members
.then((response) => console.log(response.data()))
.catch((response) => console.error(response.data()))
Every parameter that doesn't match a pattern {parameter-name}
in path will be sent as part of the query string:
client.Members.all({ legalName: 'Name' }) // https://cadu.api.com/member?legalname=Name
When a method requires a parameters and the method is called without it, Mappersmith will raise an error:
client.Member.byId(/* missing memberKey */)
// throw '[Mappersmith] required parameter missing (memberKey), "/members/{memberKey}" cannot be resolved'
To send values in the request body (usually for POST, PUT or PATCH methods) you will use the special parameter body
:
client.Members.create({
body: payload
}
})
Mappersmith will provide an instance of its own Response
object to the promises. This object has the methods:
request()
- Returns the original Requeststatus()
- Returns the status numbersuccess()
- Returns true for status greater than 200 and lower than 400headers()
- Returns an object with all headers, keys in lower caseheader(name)
- Returns the value of the headerdata()
- Returns the response data, if Content-Type
is application/json
it parses the response and returns an objectTo build for Node.js the library, use yarn build:commonjs
.
To run the library tests, use yarn test:all
.
The MIT License (MIT)
Copyright (c) 2017 Pagar.me Pagamentos S/A
FAQs
A JavaScript library to interface with CADU
The npm package cadu receives a total of 1,303 weekly downloads. As such, cadu popularity was classified as popular.
We found that cadu demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 18 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.