Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v3.0.1 #101

Merged
merged 3 commits into from
Mar 11, 2021
Merged

v3.0.1 #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7dd020d
updated v3.x doc refs to master doc refs
RIAEvangelist Mar 7, 2021
a86b5b4
added ./ to packagejson exports value
RIAEvangelist Mar 11, 2021
05bc517
rev for commonjs support via import
RIAEvangelist Mar 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ try{

The module now supports using multiple sets of endpoints that we have in `./utils/urls.js` or even custom endpoints. However, if you get hyour country working with custom endpoints, ***PLEASE CONTRIBUTE THEM BACK***! You will get credit as soon as your endpoints are merged back in.

See detailed information on how to use the international endpoints or custom endpoints here : [International Dominos Endpoints and how to use them](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/InternationalSupport.md)
See detailed information on how to use the international endpoints or custom endpoints here : [International Dominos Endpoints and how to use them](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/InternationalSupport.md)

### USA
USA is default so you really dont need to do anything other than `import {urls} from 'dominos';` if you want access to the usa endpoints.
Expand Down Expand Up @@ -280,7 +280,7 @@ USA is default so you really dont need to do anything other than `import {urls}

# Address

See the detailed docs on addresses here : [Address.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Address.md)
See the detailed docs on addresses here : [Address.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Address.md)

```js

Expand Down Expand Up @@ -340,7 +340,7 @@ See the detailed docs on addresses here : [Address.md](https://github.com/RIAEva

This provides a list of basic info on stores that are nearby an address.

See the detailed docs on finding nearby stores here : [NearbyStores.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/NearbyStores.md)
See the detailed docs on finding nearby stores here : [NearbyStores.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/NearbyStores.md)

``` js

Expand All @@ -367,7 +367,7 @@ See the detailed docs on finding nearby stores here : [NearbyStores.md](https://

This provides a detailed menu for a given store.

See the detailed docs on menus here : [Menu.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Menu.md)
See the detailed docs on menus here : [Menu.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Menu.md)

```js

Expand All @@ -385,7 +385,7 @@ console.dir(menu,{depth:1});

This provides detailed store information.

See the detailed docs on stores here : [Store.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Store.md)
See the detailed docs on stores here : [Store.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Store.md)

```js

Expand All @@ -403,7 +403,7 @@ See the detailed docs on stores here : [Store.md](https://github.com/RIAEvangeli

Items are used to place orders.

See the detailed docs on items here : [Item.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Item.md)
See the detailed docs on items here : [Item.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Item.md)

```js
import {Item} from 'dominos';
Expand All @@ -424,7 +424,7 @@ console.dir(pepperoniPizza);

This creates a customer object for use when making an order.

See the detailed docs on customers here : [Customer.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Customer.md)
See the detailed docs on customers here : [Customer.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Customer.md)

```js

Expand All @@ -451,7 +451,7 @@ The Image class will grab the image for a product code and base 64 encode it. It

![Pizza image](https://cache.dominos.com/olo/6_47_2/assets/build/market/US/_en/images/img/products/larges/S_PIZPX.jpg)

See the detailed docs on image here : [Image.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Image.md)
See the detailed docs on image here : [Image.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Image.md)

```js

Expand All @@ -477,7 +477,7 @@ pepperoniPizza.saveSync(pepperoniPizza.base64Image,savePath,productCode+'.jpg');

This class will initialize a creditcard payment object for an order.

See the detailed docs on payment here : [Payment.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Payment.md)
See the detailed docs on payment here : [Payment.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Payment.md)


```js
Expand All @@ -504,7 +504,7 @@ const myCard=new Payment(

***Finally...*** This class will order you pizza, and other things from the menu.

See the detailed docs on order here : [Order.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Order.md)
See the detailed docs on order here : [Order.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Order.md)


```js
Expand Down Expand Up @@ -583,7 +583,7 @@ This is how you track Pizzas! (and other things)

Rely on the `order.place` response. If the order fails, it will throw a `DominosPlaceOrderError`. Otherwise, your pizza is on the way. It also seems that orders placed via `dominos` module do not show up on the tracking website right now. These orders appear stealth at the moment.

See the detailed docs on tracking here : [Tracking.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Tracking.md)
See the detailed docs on tracking here : [Tracking.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Tracking.md)

```js

Expand Down Expand Up @@ -617,7 +617,7 @@ console.dir(trackingResult,{depth:1});

This class extends [`strong-type`](https://github.com/RIAEvangelist/strong-type) to allow strong and weak type checking of dominos specific types, errors and classes. It is used a lot in the `dominos` module to ensure correct types of arguments and errors. The `strong-type` module is really cool.

See the [DominosTypes.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosTypes.md) for more information.
See the [DominosTypes.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosTypes.md) for more information.

```js

Expand Down Expand Up @@ -650,7 +650,7 @@ isDominos.address(address);

These custom errors are added to the global object for use in your code and the `dominos` api. You can use them to validate errors or even throw your own if you are making a module ontop of this one.

See the detailed docs on DominosErrors here : [DominosErrors.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosErrors.md)
See the detailed docs on DominosErrors here : [DominosErrors.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosErrors.md)

|error |parameters |description|
|----- |---------- |-----------|
Expand Down
4 changes: 2 additions & 2 deletions docs/Address.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This is the primary Address Class used for all things Domnio's.
If you have cloned this repo, you can run the example with this command:
`node ./example/address.js`

extends `DominosFormat` class, see more in [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosFormat.md)
extends `DominosFormat` class, see more in [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosFormat.md)

Constructor
====
Expand All @@ -19,7 +19,7 @@ Constructor
Instance
====

Also check the [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosFormat.md) as this class extends it.
Also check the [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosFormat.md) as this class extends it.

|member/method|type |description|
|-------------|------|------- |
Expand Down
6 changes: 3 additions & 3 deletions docs/AmountsBreakdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ AmountsBreakdown
====
This is the primary AmountsBreakdown Class used for all things Domnio's.

Really unless you are working on the core of this module you don't need to understand this class as it is not used outside of the internals of the [Order Class](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Order.md) itself.
Really unless you are working on the core of this module you don't need to understand this class as it is not used outside of the internals of the [Order Class](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Order.md) itself.

extends `DominosFormat` class, see more in [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosFormat.md)
extends `DominosFormat` class, see more in [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosFormat.md)

Constructor
====
Expand Down Expand Up @@ -32,7 +32,7 @@ Constructor
Instance
====

Also check the [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosFormat.md) as this class extends it.
Also check the [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosFormat.md) as this class extends it.

|member/method|type |description|
|-------------|------|------- |
Expand Down
8 changes: 4 additions & 4 deletions docs/Customer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The customer class is used to create a customer instance for a Domino's Pizza Or
If you have cloned this repo, you can run the example with this command:
`node ./example/customer.js`

extends `DominosFormat` class, see more in [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosFormat.md)
extends `DominosFormat` class, see more in [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosFormat.md)

Constructor
====
Expand All @@ -14,7 +14,7 @@ Constructor

|params.argument|type |required|description|
|--------|------|--------|-------|
|address |[Address](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Address.md), AddressObject, AddressString|yes|customers Address. See more info on what is an acceptable Address/AddressObject or AddressString in the [Address.md doc](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Address.md)|
|address |[Address](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Address.md), AddressObject, AddressString|yes|customers Address. See more info on what is an acceptable Address/AddressObject or AddressString in the [Address.md doc](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Address.md)|
|firstName |String|yes||
|lastName |String|yes||
|email |String|yes||
Expand All @@ -23,11 +23,11 @@ Constructor
Instance
====

Also check the [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosFormat.md) as this class extends it.
Also check the [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosFormat.md) as this class extends it.

|member/method|type |description|
|-------------|------|------- |
|.address |[Address](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Address.md)|customers Address|
|.address |[Address](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Address.md)|customers Address|
|.firstName |String| |
|.lastName |String||
|.email |String||
Expand Down
6 changes: 3 additions & 3 deletions docs/DominosMenu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

The `menu.domniosAPIResponse` object is ***HUGE***! It contains the actual dominos menu response with information on everything you could imagine for a Store's Menu. We parse this information and provide a simpler to use menu in `menu.menu`.

If you want to see the easy to use parsed `.menu` object and documentation, check out the [parsed Dominos Pizza Menu.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Menu.md), it is designed to be much easier to use.
If you want to see the easy to use parsed `.menu` object and documentation, check out the [parsed Dominos Pizza Menu.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Menu.md), it is designed to be much easier to use.


## menu.domniosAPIResponse

|member |type |description|
|------ |---- |-----------|
|.Misc |Object|Contains general information about the API andmenu request to Dominos. Below you will find specific information for this request, and you can see some core information about the requests in the [Domino's API Response Doc](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosAPIResponse.md).|
|.Misc |Object|Contains general information about the API andmenu request to Dominos. Below you will find specific information for this request, and you can see some core information about the requests in the [Domino's API Response Doc](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosAPIResponse.md).|
|.Categorization |Object|This contains categories of products. Each Category includes Sub categories and all the available products in that sub category for a specific store menu.|
|.Coupons |Object||
|.Flavors |Object||
Expand Down Expand Up @@ -53,7 +53,7 @@ If you want to see the easy to use parsed `.menu` object and documentation, chec

# menu.domniosAPIResponse.Misc

The `menu.domniosAPIResponse.Misc` object contains a little bit of useful information like the `StoreID` and date and time at the stores location. You can see some core information about the requests in the [Domino's API Response Doc](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosAPIResponse.md).
The `menu.domniosAPIResponse.Misc` object contains a little bit of useful information like the `StoreID` and date and time at the stores location. You can see some core information about the requests in the [Domino's API Response Doc](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosAPIResponse.md).

```js

Expand Down
4 changes: 2 additions & 2 deletions docs/Item.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Items are used to track what products, quantities, and options a customer would
If you have cloned this repo, you can run the example with this command:
`node ./example/item.js`

extends `DominosFormat` class, see more in [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosFormat.md)
extends `DominosFormat` class, see more in [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosFormat.md)

Constructor
====
Expand All @@ -23,7 +23,7 @@ Constructor
Instance
====

Also check the [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosFormat.md) as this class extends it.
Also check the [DominosFormat.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosFormat.md) as this class extends it.

|member/method|type |description|
|-------------|------|------- |
Expand Down
4 changes: 2 additions & 2 deletions docs/Menu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Menu is constructed `async`, so when you instantiate it, you should await it, li

`.menu` provides ***HUGE*** amounts of well formatted menu data parsed from the `menu.dominosAPIResponse` object. This information is parsed from the dominos api when the instance is instantiated.

If you want to see the ***RAW*** `menu.dominosAPIResponse` object and documentation, check out the [RAW DominosMenu.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosMenu.md) instead. That object is huge and a little difficult to use which is why we provide this parsed menu.
If you want to see the ***RAW*** `menu.dominosAPIResponse` object and documentation, check out the [RAW DominosMenu.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosMenu.md) instead. That object is huge and a little difficult to use which is why we provide this parsed menu.

If you have cloned this repo, you can run the example with this command:
`node ./example/menu.js`
Expand Down Expand Up @@ -35,7 +35,7 @@ Instance
|member/method |type |description|
|------------- |------ |------- |
|.menu |object |parsed and more friendly menu for the store documented below.|
|.dominosAPIResponse|API response object|see more info in the [RAW DominosMenu.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosMenu.md)|
|.dominosAPIResponse|API response object|see more info in the [RAW DominosMenu.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosMenu.md)|


# .menu
Expand Down
8 changes: 4 additions & 4 deletions docs/NearbyStores.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Constructor

|argument |type |default |description|
|-------- |---- |------- |--------|
|address |[Address](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Address.md) instance, or AddressObject or AddressString | |either an instance of the Address class or anthing that could be passed to the `Address` class to make an instance|
|address |[Address](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Address.md) instance, or AddressObject or AddressString | |either an instance of the Address class or anthing that could be passed to the `Address` class to make an instance|
|type |String|`Delivery`|`Delivery`, `Carryout`, `all`|


Expand All @@ -22,14 +22,14 @@ Instance

|member/method |type |description|
|------------- |------|------- |
|address |[Address](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Address.md)|An Address Instance populated with the Domino's Store information|
|address |[Address](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Address.md)|An Address Instance populated with the Domino's Store information|
|stores |Array| Array of basic store objects, see below.|
|dominosAPIResponse |[Dominos API Response Object](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosAPIResponse.md)|Raw response from Domino's Each response is a little different, but you can see the core info in the [Domino's API Response Doc](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/DominosAPIResponse.md). |
|dominosAPIResponse |[Dominos API Response Object](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosAPIResponse.md)|Raw response from Domino's Each response is a little different, but you can see the core info in the [Domino's API Response Doc](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/DominosAPIResponse.md). |

### By PostalCode
***this yields a wide variety of stores*** because it is not a very specific address. To find stores closer to you (or your user), use a more specific address.

You can see the all the ways to pass an address [in the dominos pizza Address.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/v3.x/docs/Address.md).
You can see the all the ways to pass an address [in the dominos pizza Address.md](https://github.com/RIAEvangelist/node-dominos-pizza-api/blob/master/docs/Address.md).

```js

Expand Down
Loading