Merge pull request #635 from Shopify/version-2-1-0

Documentation and CHANGELOG for v2.1.0

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v2.1.0 (February 25, 2019)
+- Add support for the `checkoutShippingAddressUpdateV2` mutation, which allows clients to update the shipping address of a checkout.
+- Add the `checkoutUserErrors` field to all of the checkout mutation fragments that did not previously contain this.
+
 ### v2.0.1 (January 14, 2019)
 - Build an unoptimized release version that contains all fields that are available in the [Storefront API](https://help.shopify.com/en/api/custom-storefronts/storefront-api/reference).
 

docs/CheckoutResource.html

@@ -93,7 +93,7 @@ <h4 class="name" id="CheckoutResource"><span class="type-signature"></span>new C
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line21">line 21</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line22">line 22</a>
     </li></ul></dd>
 
 
@@ -271,7 +271,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line158">line 158</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line159">line 159</a>
     </li></ul></dd>
 
 
@@ -464,7 +464,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line137">line 137</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line138">line 138</a>
     </li></ul></dd>
 
 
@@ -839,7 +839,7 @@ <h6>Properties</h6>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line71">line 71</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line72">line 72</a>
     </li></ul></dd>
 
 
@@ -1012,7 +1012,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line34">line 34</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line35">line 35</a>
     </li></ul></dd>
 
 
@@ -1179,7 +1179,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line177">line 177</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line178">line 178</a>
     </li></ul></dd>
 
 
@@ -1371,7 +1371,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line198">line 198</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line199">line 199</a>
     </li></ul></dd>
 
 
@@ -1564,7 +1564,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line219">line 219</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line220">line 220</a>
     </li></ul></dd>
 
 
@@ -1904,7 +1904,7 @@ <h6>Properties</h6>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line95">line 95</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line96">line 96</a>
     </li></ul></dd>
 
 
@@ -2097,7 +2097,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line116">line 116</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line117">line 117</a>
     </li></ul></dd>
 
 
@@ -2290,7 +2290,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line246">line 246</a>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line247">line 247</a>
     </li></ul></dd>
 
 
@@ -2360,6 +2360,210 @@ <h5>Example</h5>
 
 
 
+
+
+
+
+
+    <h4 class="name" id="updateShippingAddress"><span class="type-signature"></span>updateShippingAddress<span class="signature">(checkoutId, shippingAddress)</span><span class="type-signature"> &rarr; {Promise|GraphModel}</span></h4>
+
+
+
+
+
+
+<div class="description">
+    <p>Updates shipping address on an existing checkout.</p>
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+
+
+<table class="params">
+    <thead>
+    <tr>
+
+        <th>Name</th>
+
+
+        <th>Type</th>
+
+
+
+
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+
+
+        <tr>
+
+                <td class="name"><code>checkoutId</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last"><p>The ID of the checkout to update shipping address.</p></td>
+        </tr>
+
+
+
+        <tr>
+
+                <td class="name"><code>shippingAddress</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last"><p>A shipping address.</p></td>
+        </tr>
+
+
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="checkout-resource.js.html">checkout-resource.js</a>, <a href="checkout-resource.js.html#line279">line 279</a>
+    </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+
+<div class="param-desc">
+    <p>A promise resolving with the updated checkout.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+
+<span class="param-type">Promise</span>
+|
+
+<span class="param-type">GraphModel</span>
+
+
+    </dd>
+</dl>
+
+
+
+
+
+
+    <h5>Example</h5>
+
+    <pre class="prettyprint"><code>const checkoutId = 'Z2lkOi8vc2hvcGlmeS9DaGVja291dC9kMTZmM2EzMDM4Yjc4N=';
+const shippingAddress = {
+   address1: 'Chestnut Street 92',
+   address2: 'Apartment 2"',
+   city: 'Louisville',
+   company: null,
+   country: 'United States',
+   firstName: 'Bob',
+   lastName: 'Norman',
+   phone: '555-625-1199',
+   province: 'Kentucky',
+   zip: '40202'
+ };
+
+client.checkout.updateShippingAddress(checkoutId, shippingAddress).then(checkout => {
+  // Do something with the updated checkout
+});</code></pre>
+
+
+
+
 
 
 
@@ -2381,7 +2585,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CheckoutR
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 11:45:20 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 25 2019 17:25:08 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/Client.html

@@ -621,7 +621,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CheckoutR
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 11:45:20 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 25 2019 17:25:08 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/CollectionResource.html

@@ -1264,7 +1264,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CheckoutR
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 11:45:20 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 25 2019 17:25:08 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/Config.html

@@ -280,7 +280,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CheckoutR
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 11:45:20 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 25 2019 17:25:08 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/ImageHelpers.html

@@ -383,7 +383,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CheckoutR
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 11:45:20 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 25 2019 17:25:08 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/ImageResource.html

@@ -159,7 +159,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CheckoutR
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 11:45:20 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 25 2019 17:25:08 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/ProductHelpers.html

@@ -313,7 +313,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CheckoutR
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 11:45:20 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 25 2019 17:25:08 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/ProductResource.html

@@ -1206,7 +1206,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CheckoutR
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 15 2019 11:45:20 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 25 2019 17:25:08 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>