Skip to content

Commit 660a802

Browse files
author
Evan Yan
committed
Update docs
1 parent 47c2bd1 commit 660a802

20 files changed

+3831
-611
lines changed

‎docs/ConstructorIO.html‎

Lines changed: 69 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<input type="text" id="nav-search" placeholder="Search" />
3232

3333

34-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ConstructorIO.html">ConstructorIO</a><ul class='methods'><li data-type='method'><a href="ConstructorIO.html#setClientOptions">setClientOptions</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-assistant.html">assistant</a><ul class='methods'><li data-type='method'><a href="module-assistant.html#~getAssistantResultsStream">getAssistantResultsStream</a></li></ul></li><li><a href="module-autocomplete.html">autocomplete</a><ul class='methods'><li data-type='method'><a href="module-autocomplete.html#~getAutocompleteResults">getAutocompleteResults</a></li></ul></li><li><a href="module-browse.html">browse</a><ul class='methods'><li data-type='method'><a href="module-browse.html#~getBrowseFacetOptions">getBrowseFacetOptions</a></li><li data-type='method'><a href="module-browse.html#~getBrowseFacets">getBrowseFacets</a></li><li data-type='method'><a href="module-browse.html#~getBrowseGroups">getBrowseGroups</a></li><li data-type='method'><a href="module-browse.html#~getBrowseResults">getBrowseResults</a></li><li data-type='method'><a href="module-browse.html#~getBrowseResultsForItemIds">getBrowseResultsForItemIds</a></li></ul></li><li><a href="module-quizzes.html">quizzes</a><ul class='methods'><li data-type='method'><a href="module-quizzes.html#~getQuizNextQuestion">getQuizNextQuestion</a></li><li data-type='method'><a href="module-quizzes.html#~getQuizResults">getQuizResults</a></li><li data-type='method'><a href="module-quizzes.html#~getQuizResultsConfig">getQuizResultsConfig</a></li></ul></li><li><a href="module-recommendations.html">recommendations</a><ul class='methods'><li data-type='method'><a href="module-recommendations.html#~getRecommendations">getRecommendations</a></li></ul></li><li><a href="module-search.html">search</a><ul class='methods'><li data-type='method'><a href="module-search.html#~getSearchResults">getSearchResults</a></li><li data-type='method'><a href="module-search.html#~getVoiceSearchResults">getVoiceSearchResults</a></li></ul></li><li><a href="module-tracker.html">tracker</a><ul class='methods'><li data-type='method'><a href="module-tracker.html#~on">on</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultClick">trackAssistantResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultLoadFinished">trackAssistantResultLoadFinished</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultLoadStarted">trackAssistantResultLoadStarted</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultView">trackAssistantResultView</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantSearchSubmit">trackAssistantSearchSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantSubmit">trackAssistantSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackAutocompleteSelect">trackAutocompleteSelect</a></li><li data-type='method'><a href="module-tracker.html#~trackBrowseResultClick">trackBrowseResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackBrowseResultsLoaded">trackBrowseResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackConversion">trackConversion</a></li><li data-type='method'><a href="module-tracker.html#~trackGenericResultClick">trackGenericResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackInputFocus">trackInputFocus</a></li><li data-type='method'><a href="module-tracker.html#~trackItemDetailLoad">trackItemDetailLoad</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentAnswerFeedback">trackProductInsightsAgentAnswerFeedback</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentAnswerView">trackProductInsightsAgentAnswerView</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentFocus">trackProductInsightsAgentFocus</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentOutOfView">trackProductInsightsAgentOutOfView</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentQuestionClick">trackProductInsightsAgentQuestionClick</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentQuestionSubmit">trackProductInsightsAgentQuestionSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentView">trackProductInsightsAgentView</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentViews">trackProductInsightsAgentViews</a></li><li data-type='method'><a href="module-tracker.html#~trackPurchase">trackPurchase</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizConversion">trackQuizConversion</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizResultClick">trackQuizResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizResultsLoaded">trackQuizResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackRecommendationClick">trackRecommendationClick</a></li><li data-type='method'><a href="module-tracker.html#~trackRecommendationView">trackRecommendationView</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchResultClick">trackSearchResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchResultsLoaded">trackSearchResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchSubmit">trackSearchSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackSessionStart">trackSessionStart</a></li></ul></li></ul>
34+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ConstructorIO.html">ConstructorIO</a><ul class='methods'><li data-type='method'><a href="ConstructorIO.html#setClientOptions">setClientOptions</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-agent.html">agent</a><ul class='methods'><li data-type='method'><a href="module-agent.html#~getAgentResultsStream">getAgentResultsStream</a></li></ul></li><li><a href="module-assistant.html">assistant</a></li><li><a href="module-autocomplete.html">autocomplete</a><ul class='methods'><li data-type='method'><a href="module-autocomplete.html#~getAutocompleteResults">getAutocompleteResults</a></li></ul></li><li><a href="module-browse.html">browse</a><ul class='methods'><li data-type='method'><a href="module-browse.html#~getBrowseFacetOptions">getBrowseFacetOptions</a></li><li data-type='method'><a href="module-browse.html#~getBrowseFacets">getBrowseFacets</a></li><li data-type='method'><a href="module-browse.html#~getBrowseGroups">getBrowseGroups</a></li><li data-type='method'><a href="module-browse.html#~getBrowseResults">getBrowseResults</a></li><li data-type='method'><a href="module-browse.html#~getBrowseResultsForItemIds">getBrowseResultsForItemIds</a></li></ul></li><li><a href="module-quizzes.html">quizzes</a><ul class='methods'><li data-type='method'><a href="module-quizzes.html#~getQuizNextQuestion">getQuizNextQuestion</a></li><li data-type='method'><a href="module-quizzes.html#~getQuizResults">getQuizResults</a></li><li data-type='method'><a href="module-quizzes.html#~getQuizResultsConfig">getQuizResultsConfig</a></li></ul></li><li><a href="module-recommendations.html">recommendations</a><ul class='methods'><li data-type='method'><a href="module-recommendations.html#~getRecommendations">getRecommendations</a></li></ul></li><li><a href="module-search.html">search</a><ul class='methods'><li data-type='method'><a href="module-search.html#~getSearchResults">getSearchResults</a></li><li data-type='method'><a href="module-search.html#~getVoiceSearchResults">getVoiceSearchResults</a></li></ul></li><li><a href="module-tracker.html">tracker</a><ul class='methods'><li data-type='method'><a href="module-tracker.html#~on">on</a></li><li data-type='method'><a href="module-tracker.html#~trackAgentResultClick">trackAgentResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackAgentResultLoadFinished">trackAgentResultLoadFinished</a></li><li data-type='method'><a href="module-tracker.html#~trackAgentResultLoadStarted">trackAgentResultLoadStarted</a></li><li data-type='method'><a href="module-tracker.html#~trackAgentResultView">trackAgentResultView</a></li><li data-type='method'><a href="module-tracker.html#~trackAgentSearchSubmit">trackAgentSearchSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackAgentSubmit">trackAgentSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultClick">trackAssistantResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultLoadFinished">trackAssistantResultLoadFinished</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultLoadStarted">trackAssistantResultLoadStarted</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantResultView">trackAssistantResultView</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantSearchSubmit">trackAssistantSearchSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackAssistantSubmit">trackAssistantSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackAutocompleteSelect">trackAutocompleteSelect</a></li><li data-type='method'><a href="module-tracker.html#~trackBrowseResultClick">trackBrowseResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackBrowseResultsLoaded">trackBrowseResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackConversion">trackConversion</a></li><li data-type='method'><a href="module-tracker.html#~trackGenericResultClick">trackGenericResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackInputFocus">trackInputFocus</a></li><li data-type='method'><a href="module-tracker.html#~trackItemDetailLoad">trackItemDetailLoad</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentAnswerFeedback">trackProductInsightsAgentAnswerFeedback</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentAnswerView">trackProductInsightsAgentAnswerView</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentFocus">trackProductInsightsAgentFocus</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentOutOfView">trackProductInsightsAgentOutOfView</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentQuestionClick">trackProductInsightsAgentQuestionClick</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentQuestionSubmit">trackProductInsightsAgentQuestionSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentView">trackProductInsightsAgentView</a></li><li data-type='method'><a href="module-tracker.html#~trackProductInsightsAgentViews">trackProductInsightsAgentViews</a></li><li data-type='method'><a href="module-tracker.html#~trackPurchase">trackPurchase</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizConversion">trackQuizConversion</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizResultClick">trackQuizResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackQuizResultsLoaded">trackQuizResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackRecommendationClick">trackRecommendationClick</a></li><li data-type='method'><a href="module-tracker.html#~trackRecommendationView">trackRecommendationView</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchResultClick">trackSearchResultClick</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchResultsLoaded">trackSearchResultsLoaded</a></li><li data-type='method'><a href="module-tracker.html#~trackSearchSubmit">trackSearchSubmit</a></li><li data-type='method'><a href="module-tracker.html#~trackSessionStart">trackSessionStart</a></li></ul></li></ul>
3535

3636
</nav>
3737

@@ -83,7 +83,7 @@ <h4 class="name" id="ConstructorIO"><span class="type-signature"></span>new Cons
8383

8484
<dt class="tag-source">Source:</dt>
8585
<dd class="tag-source"><ul class="dummy"><li>
86-
<a href="constructorio.js.html">constructorio.js</a>, <a href="constructorio.js.html#line35">line 35</a>
86+
<a href="constructorio.js.html">constructorio.js</a>, <a href="constructorio.js.html#line36">line 36</a>
8787
</li></ul></dd>
8888

8989

@@ -288,6 +288,30 @@ <h5 class="subsection-title">Properties:</h5>
288288

289289

290290

291+
<tr>
292+
293+
<td class="name"><code>agent</code></td>
294+
295+
296+
<td class="type">
297+
298+
299+
<span class="param-type">object</span>
300+
301+
302+
303+
304+
</td>
305+
306+
307+
308+
309+
310+
<td class="description last">Interface to <a href="module-agent.html">module:agent</a></td>
311+
</tr>
312+
313+
314+
291315
<tr>
292316

293317
<td class="name"><code>assistant</code></td>
@@ -513,6 +537,46 @@ <h6>Properties</h6>
513537

514538

515539

540+
<tr>
541+
542+
<td class="name"><code>agentServiceUrl</code></td>
543+
544+
545+
<td class="type">
546+
547+
548+
<span class="param-type">string</span>
549+
550+
551+
552+
553+
</td>
554+
555+
556+
<td class="attributes">
557+
558+
&lt;optional><br>
559+
560+
561+
562+
563+
564+
</td>
565+
566+
567+
568+
<td class="default">
569+
570+
<code>'https://agent.cnstrc.com'</code>
571+
572+
</td>
573+
574+
575+
<td class="description last">AI Shopping Agent API URL endpoint</td>
576+
</tr>
577+
578+
579+
516580
<tr>
517581

518582
<td class="name"><code>assistantServiceUrl</code></td>
@@ -548,7 +612,7 @@ <h6>Properties</h6>
548612
</td>
549613

550614

551-
<td class="description last">AI Assistant API URL endpoint</td>
615+
<td class="description last">AI Shopping Assistant API URL endpoint</td>
552616
</tr>
553617

554618

@@ -1275,7 +1339,7 @@ <h4 class="name" id="setClientOptions"><span class="type-signature"></span>setCl
12751339

12761340
<dt class="tag-source">Source:</dt>
12771341
<dd class="tag-source"><ul class="dummy"><li>
1278-
<a href="constructorio.js.html">constructorio.js</a>, <a href="constructorio.js.html#line156">line 156</a>
1342+
<a href="constructorio.js.html">constructorio.js</a>, <a href="constructorio.js.html#line162">line 162</a>
12791343
</li></ul></dd>
12801344

12811345

@@ -1607,7 +1671,7 @@ <h6>Properties</h6>
16071671
<br class="clear">
16081672

16091673
<footer>
1610-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jul 15 2025 13:59:42 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1674+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jul 15 2025 16:08:40 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
16111675
</footer>
16121676

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

0 commit comments

Comments
 (0)