All files / lib/resources zipcodes.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                                                                     
/**
 * @name Zipcodes
 * @description This module exposes functions
 *              related to the `/zipcodes` path.
 *
 * @module zipcodes
 **/
 
import { curry } from 'ramda'
 
import routes from '../routes'
import request from '../request'
 
/**
 * `GET /zipcodes`
 * Makes a request to /zipcodes/:zipcode
 *
 * @param {Object} opts An options params which
 *                      is usually already bound
 *                      by `connect` functions.
 *
 * @param {Object} body The payload for the request.
 * {@link https://docs.pagar.me/v2017-07-17/reference#consulta-de-cep|API Reference for this payload}
 * @param {String} [body.zipcode] The zipcode you want more information about.
 *                                If not sent an API error will be returned instead.
*/
 
const find = curry((opts, body) =>
  request.get(opts, routes.zipcodes.details(body.zipcode), {})
)
 
export default {
  find,
}