sapioweb/omnivore

Laravel 5 wrapper for omnivore

Omnivore classes and functions

Place these values into your .ENV, _(*1)

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, _(*2)

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., _(*3)

Available Functions

List tickets for location, _(*4)

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

Open a new ticket, _(*5)

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

Retrieve data for a specific ticket, _(*6)

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

Void a locations ticket, _(*7)

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

List discounts for a ticket, _(*8)

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

Apply a discount to a ticket, _(*9)

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

Retrieve a discount that was applied to a ticket, _(*10)

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

List items on a ticket, _(*11)

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

Add an item to a ticket, _(*12)

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

Retrieve an item from a ticket, _(*13)

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

Void an item from a ticket, _(*14)

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

List modifiers form a ticket, _(*15)

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

Retrieve a modifier form a ticket, _(*16)

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

List dicounts on a ticket, _(*17)

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

Retrieve a discount from a ticket, _(*18)

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

List payments, _(*19)

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

Retrieve a payment, _(*20)

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

Make a payment where a card is not present, _(*21)

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

Make a payment where a card is present, _(*22)

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

Make a payment with a 3rd party, _(*23)

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

Make a payment with a card, _(*24)

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

Make a payment with cash, _(*25)

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

Class OmnivoreTables

Interact with tables of claimed locations from the POS., _(*26)

Available Functions

List tables of claimed locations, _(*27)

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

Retrieve data for a specific table, _(*28)

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

Class OmnivoreGeneral

Interact with general labeled actions of claimed locations from the POS., _(*29)

Available Functions

List all locations claimed., _(*30)

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

Retrieve information about a location, _(*31)

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

List employees of a location, _(*32)

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

Retrieve data of a specific location, _(*33)

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

List location types, _(*34)

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

Retrieve a locations type, _(*35)

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

List the types of tender the location accepts, _(*36)

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

Retrive the tender type, _(*37)

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

List a locations revenue centers, _(*38)

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

Retrieve information of a payment center, _(*39)

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

List the discounts of a location, _(*40)

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

Retrieve the discount, _(*41)

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

Grab the menu from POS, _(*42)

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

List the menu categories, _(*43)

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

Retrieve a category, _(*44)

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

List items in a menu, _(*45)

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

Retrieve a menu item, _(*46)

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

List location modifiers, _(*47)

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

Retrieve a modifier, _(*48)

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

List modifier groups, _(*49)

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

Retrieve a modifier group, _(*50)

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