All files / lib/resources settlements.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                                                                                                           
/**
 * @name settlements
 * @description This module exposes functions
 *              related to the `/recipient/:id/settlements` path.
 *
 * @module settlements
 **/
import routes from '../routes'
import request from '../request'
 
/**
 * `GET /recipients/:id/settlements`
 * Get settlements for a specfic recipient.
 *
 * @param {Object} opts An options params which
 *                      is usually already bound
 *                      by `connect` functions.
 * @param {String} [body.recipientId] - The ID of the recipient
 *
  *
 * @param {Object} body https://docs.pagar.me/reference?showHidden=7e035#retornando-pagamentos.
 *
 * @returns {Promise} Resolves to the result of
 *                    the request or to an error.
 */
const all = (opts, body) =>
  request.get(opts, routes.settlements.all(body.recipientId), body)
 
/**
 * `GET /recipients/:id/settlements/contracts`
 * Get settlements for a specfic recipient.
 *
 * @param {Object} opts An options params which
 *                      is usually already bound
 *                      by `connect` functions.
 * @param {String} [body.recipientId] - The ID of the recipient
 *
  *
 * @param {Object} body https://docs.pagar.me/reference?showHidden=7e035#retornando-pagamentos.
 *
 * @returns {Promise} Resolves to the result of
 *                    the request or to an error.
 */
const contractsAll = (opts, body) =>
  request.get(opts, routes.settlements.contracts.all(body.recipientId), body)
 
 
export default {
  all,
  contracts: {
    all: contractsAll,
  },
}