Skip to content

Commit aab22f4

Browse files
melissaluumelissaluu
committed
Update schema and docs
1 parent 4bd5f4e commit aab22f4

21 files changed

+410
-228
lines changed

‎docs/CheckoutResource.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3032,7 +3032,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
30323032
<br class="clear">
30333033

30343034
<footer>
3035-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
3035+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
30363036
</footer>
30373037

30383038
<script> prettyPrint(); </script>

‎docs/Client.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
627627
<br class="clear">
628628

629629
<footer>
630-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
630+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
631631
</footer>
632632

633633
<script> prettyPrint(); </script>

‎docs/CollectionResource.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1278,7 +1278,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
12781278
<br class="clear">
12791279

12801280
<footer>
1281-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
1281+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
12821282
</footer>
12831283

12841284
<script> prettyPrint(); </script>

‎docs/Config.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
282282
<br class="clear">
283283

284284
<footer>
285-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
285+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
286286
</footer>
287287

288288
<script> prettyPrint(); </script>

‎docs/ImageHelpers.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
385385
<br class="clear">
386386

387387
<footer>
388-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
388+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
389389
</footer>
390390

391391
<script> prettyPrint(); </script>

‎docs/ImageResource.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
161161
<br class="clear">
162162

163163
<footer>
164-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
164+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
165165
</footer>
166166

167167
<script> prettyPrint(); </script>

‎docs/ProductHelpers.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
315315
<br class="clear">
316316

317317
<footer>
318-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
318+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
319319
</footer>
320320

321321
<script> prettyPrint(); </script>

‎docs/ProductResource.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1389,7 +1389,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
13891389
<br class="clear">
13901390

13911391
<footer>
1392-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
1392+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
13931393
</footer>
13941394

13951395
<script> prettyPrint(); </script>

‎docs/ShopResource.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
406406
<br class="clear">
407407

408408
<footer>
409-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
409+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
410410
</footer>
411411

412412
<script> prettyPrint(); </script>

‎docs/checkout-resource.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
373373
<br class="clear">
374374

375375
<footer>
376-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
376+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
377377
</footer>
378378

379379
<script> prettyPrint(); </script>

‎docs/client.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
144144
<br class="clear">
145145

146146
<footer>
147-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
147+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
148148
</footer>
149149

150150
<script> prettyPrint(); </script>

‎docs/collection-resource.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
172172
<br class="clear">
173173

174174
<footer>
175-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
175+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
176176
</footer>
177177

178178
<script> prettyPrint(); </script>

‎docs/config.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
115115
<br class="clear">
116116

117117
<footer>
118-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
118+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
119119
</footer>
120120

121121
<script> prettyPrint(); </script>

‎docs/image-helpers.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
7878
<br class="clear">
7979

8080
<footer>
81-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
81+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
8282
</footer>
8383

8484
<script> prettyPrint(); </script>

‎docs/image-resource.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
5656
<br class="clear">
5757

5858
<footer>
59-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
59+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
6060
</footer>
6161

6262
<script> prettyPrint(); </script>

‎docs/index.html

+16-16
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ <h3 id="fetching-products">Fetching Products</h3>
144144
});
145145

146146
// Fetch a single product by ID
147-
const productId = 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0Lzc4NTc5ODkzODQ=';
147+
const productId = 'gid://shopify/Product/7857989384';
148148

149149
client.product.fetch(productId).then((product) => {
150150
// Do something with the product
@@ -168,7 +168,7 @@ <h3 id="fetching-collections">Fetching Collections</h3>
168168
});
169169

170170
// Fetch a single collection by ID, including its products
171-
const collectionId = 'Z2lkOi8vc2hvcGlmeS9Db2xsZWN0aW9uLzM2OTMxMjU4NA==';
171+
const collectionId = 'gid://shopify/Collection/369312584';
172172
// Set a parameter for first x products, defaults to 20 if you don't provide a param
173173

174174
client.collection.fetchWithProducts(collectionId, {productsFirst: 10}).then((collection) => {
@@ -185,18 +185,18 @@ <h3 id="creating-a-checkout">Creating a Checkout</h3>
185185
});
186186
</code></pre>
187187
<h3 id="updating-checkout-attributes">Updating checkout attributes</h3>
188-
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'Z2lkOi8vc2hvcGlmeS9DaGVja291dC9kMTZmM2EzMDM4Yjc4N=';
188+
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'gid://shopify/Checkout/e3bd71f7248c806f33725a53e33931ef?key=47092e448529068d1be52e5051603af8';
189189
const input = {customAttributes: [{key: &quot;MyKey&quot;, value: &quot;MyValue&quot;}]};
190190

191191
client.checkout.updateAttributes(checkoutId, input).then((checkout) => {
192192
// Do something with the updated checkout
193193
});
194194
</code></pre>
195195
<h3 id="adding-line-items">Adding Line Items</h3>
196-
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0SW1hZ2UvMTgyMTc3ODc1OTI='; // ID of an existing checkout
196+
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'gid://shopify/Checkout/e3bd71f7248c806f33725a53e33931ef?key=47092e448529068d1be52e5051603af8'; // ID of an existing checkout
197197
const lineItemsToAdd = [
198198
{
199-
variantId: 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0VmFyaWFudC8yOTEwNjAyMjc5Mg==',
199+
variantId: 'gid://shopify/ProductVariant/29106064584',
200200
quantity: 5,
201201
customAttributes: [{key: &quot;MyKey&quot;, value: &quot;MyValue&quot;}]
202202
}
@@ -209,39 +209,39 @@ <h3 id="adding-line-items">Adding Line Items</h3>
209209
});
210210
</code></pre>
211211
<h3 id="updating-line-items">Updating Line Items</h3>
212-
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0SW1hZ2UvMTgyMTc3ODc1OTI='; // ID of an existing checkout
212+
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'gid://shopify/Checkout/e3bd71f7248c806f33725a53e33931ef?key=47092e448529068d1be52e5051603af8'; // ID of an existing checkout
213213
const lineItemsToUpdate = [
214-
{id: 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0Lzc4NTc5ODkzODQ=', quantity: 2}
214+
{id: 'gid://shopify/Product/7857989384', quantity: 2}
215215
];
216216

217217
// Update the line item on the checkout (change the quantity or variant)
218218
client.checkout.updateLineItems(checkoutId, lineItemsToUpdate).then((checkout) => {
219219
// Do something with the updated checkout
220-
console.log(checkout.lineItems); // Quantity of line item 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0Lzc4NTc5ODkzODQ=' updated to 2
220+
console.log(checkout.lineItems); // Quantity of line item 'gid://shopify/Product/7857989384' updated to 2
221221
});
222222
</code></pre>
223223
<h3 id="removing-line-items">Removing Line Items</h3>
224-
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0SW1hZ2UvMTgyMTc3ODc1OTI='; // ID of an existing checkout
224+
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'gid://shopify/Checkout/e3bd71f7248c806f33725a53e33931ef?key=47092e448529068d1be52e5051603af8'; // ID of an existing checkout
225225
const lineItemIdsToRemove = [
226-
'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0Lzc4NTc5ODkzODQ='
226+
'gid://shopify/Product/7857989384'
227227
];
228228

229229
// Remove an item from the checkout
230230
client.checkout.removeLineItems(checkoutId, lineItemIdsToRemove).then((checkout) => {
231231
// Do something with the updated checkout
232-
console.log(checkout.lineItems); // Checkout with line item 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0Lzc4NTc5ODkzODQ=' removed
232+
console.log(checkout.lineItems); // Checkout with line item 'gid://shopify/Product/7857989384' removed
233233
});
234234
</code></pre>
235235
<h3 id="fetching-a-checkout">Fetching a Checkout</h3>
236-
<pre class="prettyprint source lang-javascript"><code>const checkoutId = '2U4NWNkYzI4ZWEyOTdlOD9rZXk9MDVjMzY3Zjk3YWM0YWJjNGRhMTkwMDgwYTUzOGJmYmI='
236+
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'gid://shopify/Checkout/e3bd71f7248c806f33725a53e33931ef?key=47092e448529068d1be52e5051603af8'
237237

238238
client.checkout.fetch(checkoutId).then((checkout) => {
239239
// Do something with the checkout
240240
console.log(checkout);
241241
});
242242
</code></pre>
243243
<h3 id="adding-a-discount">Adding a Discount</h3>
244-
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0SW1hZ2UvMTgyMTc3ODc1OTI='; // ID of an existing checkout
244+
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'gid://shopify/Checkout/e3bd71f7248c806f33725a53e33931ef?key=47092e448529068d1be52e5051603af8'; // ID of an existing checkout
245245
const discountCode = 'best-discount-ever';
246246

247247
// Add a discount code to the checkout
@@ -251,7 +251,7 @@ <h3 id="adding-a-discount">Adding a Discount</h3>
251251
});
252252
</code></pre>
253253
<h3 id="removing-a-discount">Removing a Discount</h3>
254-
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0SW1hZ2UvMTgyMTc3ODc1OTI='; // ID of an existing checkout
254+
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'gid://shopify/Checkout/e3bd71f7248c806f33725a53e33931ef?key=47092e448529068d1be52e5051603af8'; // ID of an existing checkout
255255

256256
// Removes the applied discount from an existing checkout.
257257
client.checkout.removeDiscount(checkoutId).then(checkout => {
@@ -260,7 +260,7 @@ <h3 id="removing-a-discount">Removing a Discount</h3>
260260
});
261261
</code></pre>
262262
<h3 id="updating-a-shipping-address">Updating a Shipping Address</h3>
263-
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0SW1hZ2UvMTgyMTc3ODc1OTI='; // ID of an existing checkout
263+
<pre class="prettyprint source lang-javascript"><code>const checkoutId = 'gid://shopify/Checkout/e3bd71f7248c806f33725a53e33931ef?key=47092e448529068d1be52e5051603af8'; // ID of an existing checkout
264264

265265
const shippingAddress = {
266266
address1: 'Chestnut Street 92',
@@ -342,7 +342,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
342342
<br class="clear">
343343

344344
<footer>
345-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
345+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
346346
</footer>
347347

348348
<script> prettyPrint(); </script>

‎docs/product-helpers.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
7070
<br class="clear">
7171

7272
<footer>
73-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
73+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
7474
</footer>
7575

7676
<script> prettyPrint(); </script>

‎docs/product-resource.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
186186
<br class="clear">
187187

188188
<footer>
189-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
189+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
190190
</footer>
191191

192192
<script> prettyPrint(); </script>

‎docs/shop-resource.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
9090
<br class="clear">
9191

9292
<footer>
93-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
93+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
9494
</footer>
9595

9696
<script> prettyPrint(); </script>

‎docs/tutorial-MIGRATION_GUIDE.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ImageH
276276
<br class="clear">
277277

278278
<footer>
279-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Jul 04 2022 13:51:51 GMT-0400 (Eastern Daylight Time)
279+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Thu Oct 06 2022 14:19:55 GMT-0400 (Eastern Daylight Time)
280280
</footer>
281281

282282
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)