sapioweb/omnivore

Laravel 5 wrapper for omnivore

1.0.4 2017-05-08 16:20 UTC

Requires

• guzzlehttp/guzzle: ^6.2

MIT

• Andreas Beasley

README

Place these values into your .ENV

OMNIVORE_API_URL
OMNIVORE_API_KEY
OMNIVORE_LOCATION_ID
ES_FROM
ES_SIZE
OMNIVORE_API_URL

Add the following into the construct that will utilize the wrapper

function locationList()
{
  $this->omnivoreGeneral = new OmnivoreGeneral;

  $this->omnivoreTickets = new OmnivoreTickets;

  $this->omnivoreTables = new OmnivoreTables;
}

Class OmnivoreTickets

Interact with tickets of claimed locations from the POS.

Available Functions

List tickets for location

$ticketList = $this->omnivoreTickets->ticketList($locationId)
return response()->json($ticketList);

Open a new ticket

$ticketOpen = $this->omnivoreTickets->ticketOpen($locationId, $content)
return response()->json($ticketOpen);

Retrieve data for a specific ticket

$ticketRetrieve = $this->omnivoreTickets->ticketRetrieve($locationId, $ticketId);
return response()->json($ticketRetrieve);

Void a locations ticket

$ticketVoid = $this->omnivoreTickets->ticketVoid($locationId, $ticketId)
return response()->json($ticketVoid);

List discounts for a ticket

$ticketDiscountList = $this->omnivoreTickets->ticketDiscountList($locationId, $ticketId)
return response()->json($ticketDiscountList);

Apply a discount to a ticket

$ticketDiscountApply = $this->omnivoreTickets->ticketDiscountApply($locationId, $ticketId, $discount, $value)
return response()->json($ticketDiscountApply);

Retrieve a discount that was applied to a ticket

$ticketDiscountRetrieve = $this->omnivoreTickets->ticketDiscountRetrieve($locationId, $ticketId, $ticketDiscountId)
return response()->json($ticketDiscountRetrieve);

List items on a ticket

$ticketItemList = $this->omnivoreTickets->ticketItemList($locationId, $ticketId)
return response()->json($ticketItemList);

Add an item to a ticket

$ticketItemAdd = $this->omnivoreTickets->ticketItemAdd($locationId, $ticketId, $content)
return response()->json($ticketItemAdd);

Retrieve an item from a ticket

$ticketItemRetrieve = $this->omnivoreTickets->ticketItemRetrieve($locationId, $ticketId, $ticketItemId)
return response()->json($ticketItemRetrieve);

Void an item from a ticket

$ticketItemVoid = $this->omnivoreTickets->ticketItemVoid($locationId, $ticketId, $ticketItemId)
return response()->json($ticketItemVoid);

List modifiers form a ticket

$ticketItemModifierList = $this->omnivoreTickets->ticketItemModifierList($locationId, $ticketId, $ticketItemId)
return response()->json($ticketItemModifierList);

Retrieve a modifier form a ticket

$ticketItemModifierRetrieve = $this->omnivoreTickets->ticketItemModifierRetrieve($locationId, $ticketId, $ticketItemId, $ticketItemModifierId)
return response()->json($ticketItemModifierRetrieve);

List dicounts on a ticket

$ticketItemDiscountList = $this->omnivoreTickets->ticketItemDiscountList($locationId, $ticketId, $ticketItemId)
return response()->json($ticketItemDiscountList);

Retrieve a discount from a ticket

$ticketItemDiscountRetrieve = $this->omnivoreTickets->ticketItemDiscountRetrieve($locationId, $ticketId, $ticketItemId, $ticketItemDiscountId)
return response()->json($ticketItemDiscountRetrieve);

List payments

$paymentList = $this->omnivoreTickets->paymentList($locationId, $ticketId)
return response()->json($paymentList);

Retrieve a payment

$paymentRetrieve = $this->omnivoreTickets->paymentRetrieve($locationId, $ticketId, $paymentId)
return response()->json($paymentRetrieve);

Make a payment where a card is not present

$paymentCardNotPresent = $this->omnivoreTickets->paymentCardNotPresent($locationId, $ticketId, $content)
return response()->json($paymentCardNotPresent);

Make a payment where a card is present

$paymentCardPresent = $this->omnivoreTickets->paymentCardPresent($locationId, $ticketId, $content)
return response()->json($paymentCardPresent);

Make a payment with a 3rd party

$payment3rdParty = $this->omnivoreTickets->payment3rdParty($locationId, $ticketId, $content)
return response()->json($payment3rdParty);

Make a payment with a card

$paymentGiftCard = $this->omnivoreTickets->paymentGiftCard($locationId, $ticketId, $content)
return response()->json($paymentGiftCard);

Make a payment with cash

$paymentCash = $this->omnivoreTickets->paymentCash($locationId, $ticketId, $content)
return response()->json($paymentCash);

Class OmnivoreTables

Interact with tables of claimed locations from the POS.

Available Functions

List tables of claimed locations

$tableList = $this->omnivoreTables->tableList($locationId)
return response()->json($tableList);

Retrieve data for a specific table

$tableRetrieve = $this->omnivoreTables->tableRetrieve($locationId, $tableId)
return response()->json($tableRetrieve);

Class OmnivoreGeneral

Interact with general labeled actions of claimed locations from the POS.

Available Functions

List all locations claimed.

$locations = $this->omnivoreGeneral->locationList();
return response()->json($locations);

Retrieve information about a location

$locationRetrieve = $this->omnivoreGeneral->locationRetrieve($locationId)
return response()->json($locationRetrieve);

List employees of a location

$employeeList = $this->omnivoreGeneral->employeeList($locationId)
return response()->json($employeeList);

Retrieve data of a specific location

$employeeRetrieve = $this->omnivoreGeneral->employeeRetrieve($locationId, $employeeId)
return response()->json($employeeRetrieve);

List location types

$orderTypeList = $this->omnivoreGeneral->orderTypeList($locationId)
return response()->json($orderTypeList);

Retrieve a locations type

$orderTypeRetrieve = $this->omnivoreGeneral->orderTypeRetrieve($locationId, $orderTypeId)
return response()->json($orderTypeRetrieve);

List the types of tender the location accepts

$tenderTypeList = $this->omnivoreGeneral->tenderTypeList($locationId)
return response()->json($tenderTypeList);

Retrive the tender type

$tenderTypeRetrieve = $this->omnivoreGeneral->tenderTypeRetrieve($locationId, $tenderTypeId)
return response()->json($tenderTypeRetrieve);

List a locations revenue centers

$revenueCenterList = $this->omnivoreGeneral->revenueCenterList($locationId)
return response()->json($revenueCenterList);

Retrieve information of a payment center

$revenueCenterRetrieve = $this->omnivoreGeneral->revenueCenterRetrieve($locationId, $revenueCenterId)
return response()->json($revenueCenterRetrieve);

List the discounts of a location

$discountList = $this->omnivoreGeneral->discountList($locationId)
return response()->json($discountList);

Retrieve the discount

$discountRetrieve = $this->omnivoreGeneral->discountRetrieve($locationId, $discountId)
return response()->json($discountRetrieve);

Grab the menu from POS

$menu = $this->omnivoreGeneral->menu($locationId)
return response()->json($menu);

List the menu categories

$categoryList = $this->omnivoreGeneral->categoryList($locationId)
return response()->json($categoryList);

Retrieve a category

$categoryRetrieve = $this->omnivoreGeneral->categoryRetrieve($locationId, $categoryId)
return response()->json($categoryRetrieve);

List items in a menu

$menuItemList = $this->omnivoreGeneral->menuItemList($locationId)
return response()->json($menuItemList);

Retrieve a menu item

$menuItemRetrieve = $this->omnivoreGeneral->menuItemRetrieve($locationId, $menuItemId)
return response()->json($menuItemRetrieve);

List location modifiers

$modifierList = $this->omnivoreGeneral->modifierList($locationId)
return response()->json($modifierList);

Retrieve a modifier

$modifierRetrieve = $this->omnivoreGeneral->modifierRetrieve($locationId, $modifierId)
return response()->json($modifierRetrieve);

List modifier groups

$modifierGroupList = $this->omnivoreGeneral->modifierGroupList($locationId, $menuItemId)
return response()->json($modifierGroupList);

Retrieve a modifier group

$modifierGroupRetrieve = $this->omnivoreGeneral->modifierGroupRetrieve($locationId, $menuItemId, $modifierGroupId)
return response()->json($modifierGroupRetrieve);