openrest4js

#openrest4js

[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url]

OpenRest (founded early 2011) is a cloud-based service that enables restaurant owners to easily create online ordering websites, mobile websites and native mobile apps. As of September 2014, a total of almost a thousand restaurants power their online ordering systems with OpenRest.

OpenRest offers an open API for developers. The OpenRest API is exposed as a standard web service communicating JSON over HTTPS.

OpenRest was acquired by Wix.com in later 2014, and can now be found as Wix Restaurants.

This package contains three different modules:

Client

To use the client, it is perfered to use the derived openrest4node

Fixture

Fixtures let you create openrest objects using functions. Example:
``javascript
import {fixtures} from 'openrest4js';

const charge = fixtures.ChargeV2().
deliveryTypes(['delivery']).
displayConditionDeliveryTypes(['delivery', 'pickup']).
platforms(['mobileweb', 'web']).
val();
`
List of available fixtures:


$3


Creates a ChargeV2 object
- `fixtures.ChargeV2.title(val)` - Updates the title of the charge. Assumes 'en_US' locale.
- `fixtures.ChargeV2.description(val)` - Updates the description of the charge. Assumes 'en_US' locale.
- `fixtures.ChargeV2.percentageDiscount({percentage, itemIds})` - Sets the charge as a percentage discount. percentage is times 100 (eg, 1234 means 12.34%). itemIds is a list of itemIds to calculate the percentage on.
- `fixtures.ChargeV2.tax({percentage, itemIds})` - Sets the charge as a tax charge. percentage is times 100 (eg, 1234 means 12.34%). itemIds is a list of itemIds to calculate the percentage on.
- `fixtures.ChargeV2.fixedDiscount({price})` - Sets the charge as a fixed discount. price is times 100 (eg, 1234 means $12.34).
- `fixtures.ChargeV2.deliveryTypes(types)` - Sets the list of delivery types in the charge's condition.
- `fixtures.ChargeV2.displayConditionDeliveryTypes(types)` - Sets the list of delivery types in the charge's display condition.
- `fixtures.ChargeV2.platforms(platforms)` - Sets the list of platforms in the charge's condition.
- `fixtures.ChargeV2.displayConditionPlatforms(platforms)` - Sets the list of platforms in the charge's display condition.
- `fixtures.ChargeV2.min(min)` - Sets the minimum price in the charge's condition.
- `fixtures.ChargeV2.displayConditionMin(min)` - Sets the minimum price in the charge's display condition.
- `fixtures.ChargeV2.deliveryTime(availability)` - Sets the weekly availability in the charge's condition.
- `fixtures.ChargeV2.displayConditionDeliveryTime(availability)` - Sets the weekly availability in the charge's display condition.
- `fixtures.ChargeV2.close()` - Sets the state of the charge to 'closed'.
- `fixtures.ChargeV2.val()` - Returns the final charge created.

$3

Creates an Availability object
- `fixtures.Avalability.addWeeklyFromDate({start, end})` - Adds duration to the availability.weekly field, translating the start and end to minutes of week (mainly used for testing).

Helpers

$3

Helper functions to work with ChargeV2 objects.
- `isApplicable({charge, deliveryTime, deliveryType, orderItems, source, platform})` - Checks if a charge is applicable to the current parameters.
- `isDisplayable({charge, deliveryTime, deliveryType, orderItems, source, platform})` - Checks if a charge is displayable to the current parameters.
- `calculateAmount({charge, orderItems, orderCharges, extraCost})` - Calculates the amount the matching OrderCharge should contain.

$3

Helper functions to work with OrderItems objects.
- `getTotalPrice({orderItem})` - Calculates the total price of an OrderItem (including variations).

$3

Helper functions to work with Order objects.
- `getOrderCharges({order, chargesV2})` - Returns the orderCharges calculated, that should be added to the order object. Receives an existing order object that should contain order.deilvery.type, order.delivery.time, and order.orderItems to calculate correctly. chargeV2 should be from the menu.

$3

Helper functions to work with image URLs.
- `fill({url, width, height})`` - Returns a URL that serves the resized image. Passing 0 for width or height means maximum size.

[downloads-image]: https://img.shields.io/npm/dm/openrest4js.svg

[npm-url]: https://npmjs.org/package/openrest4js
[npm-image]: https://img.shields.io/npm/v/openrest4js.svg