Progress on api/cross-sell.js

Author: taywils

src/api/cross-sell.js

@@ -0,0 +1,94 @@
+// @class CrossSell
+// Accessible via [analytics](#foxapi-analytics) property of [FoxApi](#foxapi) instance.
+
+import * as endpoints from '../endpoints';
+
+export default class CrossSell {
+  constructor(api) {
+    this.api = api;
+  }
+
+  /**
+   * @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
+   * 
+   * Example pointsObj
+   * 
+   * ```
+   * {
+   *    "points": [
+   *      {
+   *        "custID": 1,
+   *        "prodID": 4,
+   *        "chanID": 2,
+   *      } 
+   *    ]
+   * }
+   * ```
+   */
+  crossSellTrain(pointsObj) {
+    return this.api.post(endpoints.crossSellTrain, pointsObj);
+  }
+
+  /**
+   * @method crossSellRelated(productId: Int, channelId: Int): Promise
+   * @param {Int} productId 
+   * @param {Int} channelId 
+   * 
+   * Returns JSON of what products are similar to the productId in the query params.
+   * { "products": [ 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
+   * 
+   * ```
+   * {
+   *    "products": [
+   *      {
+   *        "id": 2,
+   *        "score": 0
+   *      },
+   *      {
+   *        "id": 1,
+   *        "score": 1
+   *      },
+   *      {
+   *        "id": 0,
+   *        "score": 0
+   *      }
+   *    ]
+   * }
+   */
+  crossSellRelated(productId, channelId) {
+    const query = `?channel=${channelId}`;
+    const url = `${endpoints.crossSellRelated}${productId}${query}`;
+    return this.api.get(url);
+  }
+}
+
+// @miniclass Point (CrossSell)
+// @field custID: Number
+// CustomerID number
+//
+// @field prodID: Number
+// ProductID number
+//
+// @field chanID: Number
+// Unique Channel ID number
+
+// @miniclass RelatedProduct (CrossSell)
+// @field id: Number
+// RelatedProduct ID number
+//
+// @field score: Number
+// RelatedProduct Similarity score

src/endpoints.js

@@ -57,3 +57,7 @@ export const order = referenceNumber => `/v1/my/orders/${referenceNumber}`;
 
 // analytics endpoints
 export const hal = '/v1/hal';
+
+// cross-sell endpoints
+export const crossSellTrain = '/v1/public/recommend/prod-prod/train';
+export const crossSellRelated = '/v1/public/recommend/prod-prod/';