Skip to content

Commit 14167c7

Browse files
joeluong-sfccjoeluong-sfcc
committed
update README
1 parent 584d232 commit 14167c7

File tree

5 files changed

+173
-25
lines changed

5 files changed

+173
-25
lines changed

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,10 @@ import type { ShopperLoginTypes } from "commerce-sdk"
101101

102102
// demo client credentials, if you have access to your own please replace them below.
103103
// do not store client secret as plaintext. Store it in a secure location.
104+
// For guidance on generating a private client with a client secret, please refer to:
105+
// https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/use-a-slas-private-client.html
106+
const CLIENT_SECRET = "<INSERT_CLIENT_SECRET>";
104107
const CLIENT_ID = "da422690-7800-41d1-8ee4-3ce983961078";
105-
const CLIENT_SECRET = "D*HHUrgO2%qADp2JTIUi";
106108
const ORG_ID = "f_ecom_zzte_053";
107109
const SHORT_CODE = "kv7kzm78";
108110
const SITE_ID = "RefArch";

‎docs/assets/js/search.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/index.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,10 @@ <h3>Sample Code</h3>
188188

189189
<span class="hljs-comment">// demo client credentials, if you have access to your own please replace them below.</span>
190190
<span class="hljs-comment">// do not store client secret as plaintext. Store it in a secure location.</span>
191+
<span class="hljs-comment">// For guidance on generating a private client with a client secret, please refer to:</span>
192+
<span class="hljs-comment">// https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/use-a-slas-private-client.html</span>
193+
<span class="hljs-keyword">const</span> CLIENT_SECRET = <span class="hljs-string">&quot;&lt;INSERT_CLIENT_SECRET&gt;&quot;</span>;
191194
<span class="hljs-keyword">const</span> CLIENT_ID = <span class="hljs-string">&quot;da422690-7800-41d1-8ee4-3ce983961078&quot;</span>;
192-
<span class="hljs-keyword">const</span> CLIENT_SECRET = <span class="hljs-string">&quot;D*HHUrgO2%qADp2JTIUi&quot;</span>;
193195
<span class="hljs-keyword">const</span> ORG_ID = <span class="hljs-string">&quot;f_ecom_zzte_053&quot;</span>;
194196
<span class="hljs-keyword">const</span> SHORT_CODE = <span class="hljs-string">&quot;kv7kzm78&quot;</span>;
195197
<span class="hljs-keyword">const</span> SITE_ID = <span class="hljs-string">&quot;RefArch&quot;</span>;
@@ -623,7 +625,7 @@ <h2>Security</h2>
623625
<p>For more information about security considerations related to developing headless commerce applications, see
624626
<a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/security-considerations-for-headless-commerce.html">Security Considerations for Headless Commerce</a> on the
625627
<a href="https://developer.salesforce.com/developer-centers/commerce-cloud">Commerce Cloud Developer Center</a>.</p>
626-
<p>If you discover any potential security issues, please report them to <a href="mailto:&#x73;&#101;&#x63;&#117;&#114;&#105;&#116;&#121;&#64;&#x73;&#x61;&#x6c;&#x65;&#115;&#x66;&#111;&#x72;&#99;&#x65;&#x2e;&#x63;&#x6f;&#x6d;">&#x73;&#101;&#x63;&#117;&#114;&#105;&#116;&#121;&#64;&#x73;&#x61;&#x6c;&#x65;&#115;&#x66;&#111;&#x72;&#99;&#x65;&#x2e;&#x63;&#x6f;&#x6d;</a> as soon as possible.</p>
628+
<p>If you discover any potential security issues, please report them to <a href="mailto:&#x73;&#101;&#99;&#x75;&#114;&#105;&#116;&#121;&#x40;&#x73;&#97;&#108;&#x65;&#x73;&#102;&#x6f;&#x72;&#x63;&#101;&#x2e;&#x63;&#x6f;&#x6d;">&#x73;&#101;&#99;&#x75;&#114;&#105;&#116;&#121;&#x40;&#x73;&#97;&#108;&#x65;&#x73;&#102;&#x6f;&#x72;&#x63;&#101;&#x2e;&#x63;&#x6f;&#x6d;</a> as soon as possible.</p>
627629
<a href="#additional-documentation" id="additional-documentation" style="color: inherit; text-decoration: none;">
628630
<h2>Additional Documentation</h2>
629631
</a>

‎docs/modules/assignments.AssignmentsTypes.html‎

Lines changed: 56 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ <h3>Type aliases</h3>
9999
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#range2filter" class="tsd-kind-icon">Range2<wbr>Filter</a></li>
100100
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#range2filterfiltermodeenum" class="tsd-kind-icon">Range2<wbr>Filter<wbr>Filter<wbr>Mode<wbr>Enum</a></li>
101101
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#rangefilter" class="tsd-kind-icon">Range<wbr>Filter</a></li>
102+
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#rangefilterfrom" class="tsd-kind-icon">Range<wbr>Filter<wbr>From</a></li>
103+
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#rangefilterto" class="tsd-kind-icon">Range<wbr>Filter<wbr>To</a></li>
102104
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#recurrence" class="tsd-kind-icon">Recurrence</a></li>
103105
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#recurrencedayofweekenum" class="tsd-kind-icon">Recurrence<wbr>Day<wbr>OfWeek<wbr>Enum</a></li>
104106
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#resultbase" class="tsd-kind-icon">Result<wbr>Base</a></li>
@@ -111,6 +113,7 @@ <h3>Type aliases</h3>
111113
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#termfilteroperatorenum" class="tsd-kind-icon">Term<wbr>Filter<wbr>Operator<wbr>Enum</a></li>
112114
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#termquery" class="tsd-kind-icon">Term<wbr>Query</a></li>
113115
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#termqueryoperatorenum" class="tsd-kind-icon">Term<wbr>Query<wbr>Operator<wbr>Enum</a></li>
116+
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#termqueryvaluesinner" class="tsd-kind-icon">Term<wbr>Query<wbr>Values<wbr>Inner</a></li>
114117
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#textquery" class="tsd-kind-icon">Text<wbr>Query</a></li>
115118
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="assignments.assignmentstypes.html#timeofday" class="tsd-kind-icon">Time<wbr>OfDay</a></li>
116119
</ul>
@@ -350,13 +353,33 @@ <h3>Range<wbr>Filter</h3>
350353
</ul>
351354
</aside>
352355
</section>
356+
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace">
357+
<a name="rangefilterfrom" class="tsd-anchor"></a>
358+
<h3>Range<wbr>Filter<wbr>From</h3>
359+
<div class="tsd-signature tsd-kind-icon">Range<wbr>Filter<wbr>From<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.RangeFilterFrom</span></div>
360+
<aside class="tsd-sources">
361+
<ul>
362+
<li>Defined in renderedTemplates/assignments/index.ts:35</li>
363+
</ul>
364+
</aside>
365+
</section>
366+
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace">
367+
<a name="rangefilterto" class="tsd-anchor"></a>
368+
<h3>Range<wbr>Filter<wbr>To</h3>
369+
<div class="tsd-signature tsd-kind-icon">Range<wbr>Filter<wbr>To<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.RangeFilterTo</span></div>
370+
<aside class="tsd-sources">
371+
<ul>
372+
<li>Defined in renderedTemplates/assignments/index.ts:36</li>
373+
</ul>
374+
</aside>
375+
</section>
353376
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace">
354377
<a name="recurrence" class="tsd-anchor"></a>
355378
<h3>Recurrence</h3>
356379
<div class="tsd-signature tsd-kind-icon">Recurrence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.Recurrence</span></div>
357380
<aside class="tsd-sources">
358381
<ul>
359-
<li>Defined in renderedTemplates/assignments/index.ts:35</li>
382+
<li>Defined in renderedTemplates/assignments/index.ts:37</li>
360383
</ul>
361384
</aside>
362385
</section>
@@ -366,7 +389,7 @@ <h3>Recurrence<wbr>Day<wbr>OfWeek<wbr>Enum</h3>
366389
<div class="tsd-signature tsd-kind-icon">Recurrence<wbr>Day<wbr>OfWeek<wbr>Enum<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.RecurrenceDayOfWeekEnum</span></div>
367390
<aside class="tsd-sources">
368391
<ul>
369-
<li>Defined in renderedTemplates/assignments/index.ts:36</li>
392+
<li>Defined in renderedTemplates/assignments/index.ts:38</li>
370393
</ul>
371394
</aside>
372395
</section>
@@ -376,7 +399,7 @@ <h3>Result<wbr>Base</h3>
376399
<div class="tsd-signature tsd-kind-icon">Result<wbr>Base<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.ResultBase</span></div>
377400
<aside class="tsd-sources">
378401
<ul>
379-
<li>Defined in renderedTemplates/assignments/index.ts:37</li>
402+
<li>Defined in renderedTemplates/assignments/index.ts:39</li>
380403
</ul>
381404
</aside>
382405
</section>
@@ -386,7 +409,7 @@ <h3>Schedule</h3>
386409
<div class="tsd-signature tsd-kind-icon">Schedule<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.Schedule</span></div>
387410
<aside class="tsd-sources">
388411
<ul>
389-
<li>Defined in renderedTemplates/assignments/index.ts:38</li>
412+
<li>Defined in renderedTemplates/assignments/index.ts:40</li>
390413
</ul>
391414
</aside>
392415
</section>
@@ -396,7 +419,7 @@ <h3>Search<wbr>Request</h3>
396419
<div class="tsd-signature tsd-kind-icon">Search<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.SearchRequest</span></div>
397420
<aside class="tsd-sources">
398421
<ul>
399-
<li>Defined in renderedTemplates/assignments/index.ts:39</li>
422+
<li>Defined in renderedTemplates/assignments/index.ts:41</li>
400423
</ul>
401424
</aside>
402425
</section>
@@ -406,7 +429,7 @@ <h3>Sort</h3>
406429
<div class="tsd-signature tsd-kind-icon">Sort<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.Sort</span></div>
407430
<aside class="tsd-sources">
408431
<ul>
409-
<li>Defined in renderedTemplates/assignments/index.ts:40</li>
432+
<li>Defined in renderedTemplates/assignments/index.ts:42</li>
410433
</ul>
411434
</aside>
412435
</section>
@@ -416,7 +439,7 @@ <h3>Sort<wbr>Sort<wbr>Order<wbr>Enum</h3>
416439
<div class="tsd-signature tsd-kind-icon">Sort<wbr>Sort<wbr>Order<wbr>Enum<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.SortSortOrderEnum</span></div>
417440
<aside class="tsd-sources">
418441
<ul>
419-
<li>Defined in renderedTemplates/assignments/index.ts:41</li>
442+
<li>Defined in renderedTemplates/assignments/index.ts:43</li>
420443
</ul>
421444
</aside>
422445
</section>
@@ -426,7 +449,7 @@ <h3>Tag</h3>
426449
<div class="tsd-signature tsd-kind-icon">Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.Tag</span></div>
427450
<aside class="tsd-sources">
428451
<ul>
429-
<li>Defined in renderedTemplates/assignments/index.ts:42</li>
452+
<li>Defined in renderedTemplates/assignments/index.ts:44</li>
430453
</ul>
431454
</aside>
432455
</section>
@@ -436,7 +459,7 @@ <h3>Term<wbr>Filter</h3>
436459
<div class="tsd-signature tsd-kind-icon">Term<wbr>Filter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.TermFilter</span></div>
437460
<aside class="tsd-sources">
438461
<ul>
439-
<li>Defined in renderedTemplates/assignments/index.ts:43</li>
462+
<li>Defined in renderedTemplates/assignments/index.ts:45</li>
440463
</ul>
441464
</aside>
442465
</section>
@@ -446,7 +469,7 @@ <h3>Term<wbr>Filter<wbr>Operator<wbr>Enum</h3>
446469
<div class="tsd-signature tsd-kind-icon">Term<wbr>Filter<wbr>Operator<wbr>Enum<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.TermFilterOperatorEnum</span></div>
447470
<aside class="tsd-sources">
448471
<ul>
449-
<li>Defined in renderedTemplates/assignments/index.ts:44</li>
472+
<li>Defined in renderedTemplates/assignments/index.ts:46</li>
450473
</ul>
451474
</aside>
452475
</section>
@@ -456,7 +479,7 @@ <h3>Term<wbr>Query</h3>
456479
<div class="tsd-signature tsd-kind-icon">Term<wbr>Query<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.TermQuery</span></div>
457480
<aside class="tsd-sources">
458481
<ul>
459-
<li>Defined in renderedTemplates/assignments/index.ts:45</li>
482+
<li>Defined in renderedTemplates/assignments/index.ts:47</li>
460483
</ul>
461484
</aside>
462485
</section>
@@ -466,7 +489,17 @@ <h3>Term<wbr>Query<wbr>Operator<wbr>Enum</h3>
466489
<div class="tsd-signature tsd-kind-icon">Term<wbr>Query<wbr>Operator<wbr>Enum<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.TermQueryOperatorEnum</span></div>
467490
<aside class="tsd-sources">
468491
<ul>
469-
<li>Defined in renderedTemplates/assignments/index.ts:46</li>
492+
<li>Defined in renderedTemplates/assignments/index.ts:48</li>
493+
</ul>
494+
</aside>
495+
</section>
496+
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace">
497+
<a name="termqueryvaluesinner" class="tsd-anchor"></a>
498+
<h3>Term<wbr>Query<wbr>Values<wbr>Inner</h3>
499+
<div class="tsd-signature tsd-kind-icon">Term<wbr>Query<wbr>Values<wbr>Inner<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.TermQueryValuesInner</span></div>
500+
<aside class="tsd-sources">
501+
<ul>
502+
<li>Defined in renderedTemplates/assignments/index.ts:49</li>
470503
</ul>
471504
</aside>
472505
</section>
@@ -476,7 +509,7 @@ <h3>Text<wbr>Query</h3>
476509
<div class="tsd-signature tsd-kind-icon">Text<wbr>Query<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.TextQuery</span></div>
477510
<aside class="tsd-sources">
478511
<ul>
479-
<li>Defined in renderedTemplates/assignments/index.ts:47</li>
512+
<li>Defined in renderedTemplates/assignments/index.ts:50</li>
480513
</ul>
481514
</aside>
482515
</section>
@@ -486,7 +519,7 @@ <h3>Time<wbr>OfDay</h3>
486519
<div class="tsd-signature tsd-kind-icon">Time<wbr>OfDay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AssignmentsModelTypes.TimeOfDay</span></div>
487520
<aside class="tsd-sources">
488521
<ul>
489-
<li>Defined in renderedTemplates/assignments/index.ts:48</li>
522+
<li>Defined in renderedTemplates/assignments/index.ts:51</li>
490523
</ul>
491524
</aside>
492525
</section>
@@ -579,6 +612,12 @@ <h3>Time<wbr>OfDay</h3>
579612
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
580613
<a href="assignments.assignmentstypes.html#rangefilter" class="tsd-kind-icon">Range<wbr>Filter</a>
581614
</li>
615+
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
616+
<a href="assignments.assignmentstypes.html#rangefilterfrom" class="tsd-kind-icon">Range<wbr>Filter<wbr>From</a>
617+
</li>
618+
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
619+
<a href="assignments.assignmentstypes.html#rangefilterto" class="tsd-kind-icon">Range<wbr>Filter<wbr>To</a>
620+
</li>
582621
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
583622
<a href="assignments.assignmentstypes.html#recurrence" class="tsd-kind-icon">Recurrence</a>
584623
</li>
@@ -615,6 +654,9 @@ <h3>Time<wbr>OfDay</h3>
615654
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
616655
<a href="assignments.assignmentstypes.html#termqueryoperatorenum" class="tsd-kind-icon">Term<wbr>Query<wbr>Operator<wbr>Enum</a>
617656
</li>
657+
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
658+
<a href="assignments.assignmentstypes.html#termqueryvaluesinner" class="tsd-kind-icon">Term<wbr>Query<wbr>Values<wbr>Inner</a>
659+
</li>
618660
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
619661
<a href="assignments.assignmentstypes.html#textquery" class="tsd-kind-icon">Text<wbr>Query</a>
620662
</li>

0 commit comments

Comments
 (0)