All files / lib/resources pix.js

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60                                                                                                                       
/**
 * @name PixKeys
 * @description This module exposes functions
 *              related to the `/pix` path.
 *
 * @module pixKeys
 **/
import routes from '../routes'
import request from '../request'
 
/**
 * `POST /pix/key`
 * Creates a pix from the given payload.
 *
 * @param {Object} opts An options params which
 *                      is usually already bound
 *                      by `connect` functions.
 * @param {Object} body The payload for the request
 *
 * @returns {Promise} Resolves to the result of
 *                    the request or to an error.
 */
const create = (opts, body) =>
  request.post(opts, routes.pix.keys, body || {})
 
/**
* `GET /pix/keys`
* Makes a request to /pix/keys
*
* @param {Object} opts - An options params which
*                      is usually already bound
*                      by `connect` functions.
*
*/
const all = opts =>
  request.get(opts, routes.pix.keys)
 
 
/**
 * `DELETE /pix/keys/:id`
 *
 * Deletes the pix key with the given ID
 *
 * @param {Object} opts An options params which
 *                      is usually already bound
 *                      by `connect` functions.
 * @param {String} id The pix key id
 *
 * @returns {Promise} Resolves to the result of
 *                    the request or to an error.
 */
const destroy = (opts, id) =>
  request.delete(opts, routes.pix.destroy(id), {})
 
export default {
  create,
  all,
  destroy,
}