peachy-client

Peachy API client

Install

npm i peachymarket/peachy-client

Usage

1import PeachyClient from 'peachy-client'
2
3const client = new PeachyClient()
4
5async function example() {
6  // authenticate the client (client.token now holds the bearer token)
7  await client.authenticate(username, password) 
8
9  // get user's info
10  await client.me() // { id, firstName, lastName, email, ... }
11
12  // get user's default address
13  await client.listAddresses({ isDefault: true }) // [{ id, address, unit, city, state, zip, country, ... }]
14}

Documentation

All methods return a promise.

new PeachyClient(options)

options {Object}

• baseURL defaults to https://api.peachymarket.com/v1

Generic Requests

• get(path, query)
• post(path, body)
• patch(path, body)
• put(path, body)
• delete(path)

Authentication

• authenticate(username, password)
• me()

Search

• search(keyword)

Users

• addUser(data)
• getUser(id)
• listUsers(query)
• updateUser(id, data)
• deleteUser(id

Addresses

• addAddress(data)
• getAddress(id)
• listAddresses(query)
• updateAddress(id, data)
• deleteAddress(id)

Payment Methods

• addPaymentMethod(data)
• getPaymentMethod(id)
• listPaymentMethods(query)
• updatePaymentMethod(id, data)
• deletePaymentMethod(id)

Cart

• addItemToCart(data)
• listItemsInCart(query)
• updateItemInCart(id, data)
• deleteItemInCart(id)

Orders

• getCheckoutInfo()
• submitOrder(data)
• listOrders(query)
• cancelOrder(id, data)

Vendors

• addVendor(data)
• getVendor(id)
• listVendors(query)
• updateVendor(id, data)
• deleteVendor(id)

Products

• addProduct(data)
• getProduct(id)
• listProducts(query)
• updateProduct(id, data)
• deleteProduct(id)