package
0.0.3
Repository: https://github.com/harrybrwn/apizza.git
Documentation: pkg.go.dev

# Functions

GetNearbyStores is a way of getting all the nearby stores except they will by full initialized.
InitOrder will make sure that an order is initialized correctly.
InitStore allows for the creation of arbitrary store objects.
IsFailure will tell you if an error given by a function from the dawg package is an error thrown from dominos' servers.
IsOk will tell you if the error returned does not contain any fatal errors or warnings from Dominos' servers.
IsWarning will tell you if the error given contains a warning from the dominos server.
NearestStore gets the dominos location closest to the given address.
NewCard will create a new Card objected.
NewStore returns the default Store object given a store id.
OrderProductFromItem will construct an order product from an Item.
OrderToJSON converts an Order to the json string.
ParseAddress will parse a raw address and return an address object.
ReadableOptions gives an Item's options in a format meant for humans.
ReadableToppings is the same as ReadableOptions but it looks in the menu for the names of toppings instead outputting the topping code.
SignIn will create a new UserProfile and sign in the account.
StreetAddrFromAddress returns a StreetAddr pointer from an Address interface.
ToPayment converts a card interface to a Payment struct.
UserAddressFromAddress converts an address to a UserAddress.
ValidateCard will return an error if the card given has any bad data.
ValidateOrder sends and order to the validation endpoint to be validated by Dominos' servers.

# Constants

Carryout is a dominos service method that will require users to go and pickup their pizza.
DefaultLang is the package language variable.
Delivery is a dominos service method that will result in a pizza delivery.
FailureStatus is the status code dominos serves use for a failure.
OkStatus is the status code dominos serves use to signify no problems.
ToppingFull is the code sent to dominos to tell them you want a topping that covers the whole pizza.
ToppingLeft is the code sent to dominos to tell them you want a topping that covers the left side of the pizza.
ToppingRight is the code sent to dominos to tell them you want a topping that covers the right side of the pizza.
WarningStatus is the status code dominos serves use for a warning.

# Variables

BadExpiration is a zero datetime object the is returned on error.
ErrBadService is returned if a service is needed but the service validation failed.
ErrNoUserService is thrown when a user has no service method.
Warnings is a package switch for turning warnings on or off.

# Structs

CustomerLoyalty is a struct that holds account meta-data used by Dominos to keep track of customer rewards.
DominosError represents an error sent back by the dominos servers.
EasyOrder is an easy order.
ItemCommon has the common fields between Product and Variant.
Menu represents the dominos menu.
MenuCategory is a category on the dominos menu.
The Order struct is the main work horse of the api wrapper.
OrderProduct represents an item that will be sent to and from dominos within the Order struct.
Payment just a way to compartmentalize a payment sent to dominos.
PreConfiguredProduct is pre-configured product.
Product is the structure representing a dominos product.
The Store object represents a physical dominos location.
StoreHours is a struct that holds Dominos store hours.
StoreLocs is an internal struct and should not be used.
StreetAddr represents a street address.
Topping is a simple struct that represents a topping on the menu.
UserAddress is an address that is saved by dominos and returned when a user signs in.
UserCard holds the card data that Dominos stores and send back to users.
UserProfile is a Dominos user profile.
Variant is a structure that represents a base component of the Dominos menu.

# Interfaces

Address is a guid for how addresses should be used as input.
Card is an interface representing a credit or debit card.
Item defines an interface for all objects that are items on the dominos menu.
ItemContainer defines an interface for objects that get Variants and Products.
URLParam is an interface that represents a url parameter.

# Type aliases

Params represents parameters passed to a url.