Update docs for crossSellTrain

Author: taywils

index.html

@@ -3201,50 +3201,28 @@ <h3 id='creditcardupdatepayload-field'>CreditCardUpdatePayload</h3>
 <h2 id='crosssell'>CrossSell</h2><p>Accessible via <a href="#foxapi-analytics">analytics</a> property of <a href="#foxapi">FoxApi</a> instance.</p>
 
 <section>
-<h3 id='crosssell-method'>Methods</h3>
+<h3 id='crosssell-example'>Usage example</h3>
 
 <section >
 
 
 
 <div class='section-comments'></div>
 
-<table><thead>
-	<tr>
-		<th>Method</th>
-		<th>Returns</th>
-		<th>Description</th>
-	</tr>
-	</thead><tbody>
-	<tr id='crosssell-crossselltrain'>
-		<td><code><b>crossSellTrain</b>(<nobr>&lt;object&gt;</nobr> <i>pointsObj</i>, <i>{Object} pointsObj</i>)</nobr></code></td>
-		<td><code>Promise</code></td>
-		<td>Sends a collection of &quot;points&quot; to populate a sparse matrix for cross-sell
-analytics and related product tracking. The POST body is an object with a &quot;points&quot; key
-and value filled with an array of &quot;Point&quot; objects
-Example pointsObj
+
 <pre><code>{
    &quot;points&quot;: [
      {
        &quot;custID&quot;: 1,
        &quot;prodID&quot;: 4,
        &quot;chanID&quot;: 2,
-     }
+     } 
    ]
 }
-</code></pre></td>
-	</tr>
-	<tr id='crosssell-crosssellrelated'>
-		<td><code><b>crossSellRelated</b>(<nobr>&lt;Int&gt;</nobr> <i>productId</i>, <nobr>&lt;Int&gt;</nobr> <i>channelId</i>, <i>{Int} productId</i>, <i>{Int} channelId</i>)</nobr></code></td>
-		<td><code>Promise</code></td>
-		<td>Returns JSON of what products are similar to the productId in the query params.
-{ &quot;products&quot;: [ RelatedProduct ] }
-Score == 1 means these products were purchased by the exact same set of customers. 
-Score == 0 means no customer has purchased both of these
-Example Request
-`/v1/public/recommend/prod-prod/3?channel=2
-Example Response
-```
+</code></pre>
+<p>`/v1/public/recommend/prod-prod/3?channel=2</p>
+
+<p>```
 {
    &quot;products&quot;: [
      {
@@ -3260,7 +3238,44 @@ <h3 id='crosssell-method'>Methods</h3>
        &quot;score&quot;: 0
      }
    ]
-}</td>
+}</p>
+
+
+
+</section>
+
+</section>
+<section>
+<h3 id='crosssell-method'>Methods</h3>
+
+<section >
+
+
+
+<div class='section-comments'></div>
+
+<table><thead>
+	<tr>
+		<th>Method</th>
+		<th>Returns</th>
+		<th>Description</th>
+	</tr>
+	</thead><tbody>
+	<tr id='crosssell-crossselltrain'>
+		<td><code><b>crossSellTrain</b>(<nobr>&lt;object&gt;</nobr> <i>pointsObj</i>, <i>{Object} pointsObj</i>)</nobr></code></td>
+		<td><code>Promise</code></td>
+		<td>Sends a collection of &quot;points&quot; to populate a sparse matrix for cross-sell
+analytics and related product tracking. The POST body is an object with a &quot;points&quot; key
+and value filled with an array of &quot;Point&quot; objects.
+This method is intended for Admin use only.</td>
+	</tr>
+	<tr id='crosssell-crosssellrelated'>
+		<td><code><b>crossSellRelated</b>(<nobr>&lt;Int&gt;</nobr> <i>productId</i>, <nobr>&lt;Int&gt;</nobr> <i>channelId</i>, <i>{Int} productId</i>, <i>{Int} channelId</i>)</nobr></code></td>
+		<td><code>Promise</code></td>
+		<td>Returns JSON of what products are similar to the productId in the query params.
+{ &quot;products&quot;: [ RelatedProduct ] }
+Score == 1 means these products were purchased by the exact same set of customers. 
+Score == 0 means no customer has purchased both of these</td>
 	</tr>
 </tbody></table>
 

src/api/cross-sell.js

@@ -9,14 +9,17 @@ export default class CrossSell {
   }
 
   /**
+   * @private
    * @method crossSellTrain(pointsObj: object): Promise
    * @param {Object} pointsObj 
    * 
    * Sends a collection of "points" to populate a sparse matrix for cross-sell
    * analytics and related product tracking. The POST body is an object with a "points" key
-   * and value filled with an array of "Point" objects
+   * and value filled with an array of "Point" objects.
    * 
-   * Example pointsObj
+   * This method is intended for Admin use only.
+   *
+   * @example pointsObj
    * 
    * ```
    * {
@@ -45,11 +48,11 @@ export default class CrossSell {
    * Score == 1 means these products were purchased by the exact same set of customers. 
    * Score == 0 means no customer has purchased both of these
    * 
-   * Example Request
+   * @example Request
    * 
    * `/v1/public/recommend/prod-prod/3?channel=2
    * 
-   * Example Response
+   * @example Response
    * 
    * ```
    * {