Merge pull request #43 from FoxComm/feature/product-review-api

add endpoints for product review api

Author: taywils

index.html

@@ -228,6 +228,11 @@ <h3 id='foxapi-property'>Properties</h3>
 		<td><code><a href='#orders'>Orders</a></code></td>
 		<td>Orders instance</td>
 	</tr>
+	<tr id='foxapi-reviews'>
+		<td><code><b>reviews</b>
+		<td><code><a href='#reviews'>Reviews</a></code></td>
+		<td>Reviews instance</td>
+	</tr>
 	<tr id='foxapi-analytics'>
 		<td><code><b>analytics</b>
 		<td><code><a href='#analytics'>Analytics</a></code></td>
@@ -3371,6 +3376,49 @@ <h3 id='orders-method'>Methods</h3>
 
 </section>
 
+</section>
+<h2 id='reviews'>Reviews</h2><p>Accessible via <a href="#foxapi-reviews">reviews</a> property of <a href="#foxapi">FoxApi</a> instance.</p>
+
+<section>
+<h3 id='reviews-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='reviews-add'>
+		<td><code><b>add</b>(<nobr>&lt;ReviewPayload&gt;</nobr> <i>review</i>)</nobr></code></td>
+		<td><code>Promise&lt;Review&gt;</code></td>
+		<td>Adds a new product review.</td>
+	</tr>
+	<tr id='reviews-update'>
+		<td><code><b>update</b>(<nobr>&lt;Number&gt;</nobr> <i>reviewId</i>, <nobr>&lt;ReviewPayload&gt;</nobr> <i>review</i>)</nobr></code></td>
+		<td><code>Promise&lt;Review&gt;</code></td>
+		<td>Updates the selected product review.</td>
+	</tr>
+	<tr id='reviews-delete'>
+		<td><code><b>delete</b>(<nobr>&lt;Number&gt;</nobr> <i>reviewId</i>)</nobr></code></td>
+		<td><code>Promise</code></td>
+		<td>Deletes the selected product review.</td>
+	</tr>
+	<tr id='reviews-search'>
+		<td><code><b>search</b>(<nobr>&lt;Object&gt;</nobr> <i>query</i>, <nobr>&lt;Number&gt;</nobr> <i>size</i>, <nobr>&lt;Number&gt;</nobr> <i>from</i>)</nobr></code></td>
+		<td><code>Promise</code></td>
+		<td>Uses <code>query</code> to search product reviews.</td>
+	</tr>
+</tbody></table>
+
+</section>
+
 </section>
 <h2 id='storecredits'>StoreCredits</h2><p>Accessible via <a href="#foxapi-storecredits">storeCredits</a> property of <a href="#foxapi">FoxApi</a> instance.</p>
 

src/api/reviews.js

@@ -0,0 +1,35 @@
+
+// @class Reviews
+// Accessible via [reviews](#foxapi-reviews) property of [FoxApi](#foxapi) instance.
+
+import * as endpoints from '../endpoints';
+
+export default class Reviews {
+  constructor(api) {
+    this.api = api;
+  }
+
+  // @method add(review: ReviewPayload): Promise<Review>
+  // Adds a new product review.
+  add(review) {
+    return this.api.post(endpoints.review, review);
+  }
+
+  // @method update(reviewId: Number, review: ReviewPayload): Promise<Review>
+  // Updates the selected product review.
+  update(reviewId, review) {
+    return this.api.patch(endpoints.review(reviewId), review);
+  }
+
+  // @method delete(reviewId: Number): Promise
+  // Deletes the selected product review.
+  delete(reviewId) {
+    return this.api.delete(endpoints.review(reviewId));
+  }
+
+  // @method search(query: Object, size: Number, from: Number): Promise
+  // Uses `query` to search product reviews.
+  search(query, size, from = 0) {
+    return this.api.post(endpoints.reviewSearch(size, from), query);
+  }
+}

src/endpoints.js

@@ -55,6 +55,11 @@ export const changePassword = '/v1/my/account/change-password';
 export const orders = '/v1/my/orders';
 export const order = referenceNumber => `/v1/my/orders/${referenceNumber}`;
 
+// review endpoints
+export const reviews = '/v1/my/review';
+export const review = reviewId => `/v1/my/review/${reviewId}`;
+export const reviewSearch = (size, from) => `/search/public/product_reviews_search_view/_search?size=${size}&from=${from}`;
+
 // analytics endpoints
 export const hal = '/v1/hal';
 

src/index.js

@@ -19,6 +19,7 @@ import StoreCredits from './api/store-credits';
 import Cart from './api/cart';
 import Account from './api/account';
 import Orders from './api/orders';
+import Reviews from './api/reviews';
 import jwtDecode from 'jwt-decode';
 import Analytics from './api/analytics';
 import CrossSell from './api/cross-sell';
@@ -65,6 +66,10 @@ export default class Api {
     // Orders instance
     this.orders = new Orders(this);
 
+    // @property reviews: Reviews
+    // Reviews instance
+    this.reviews = new Reviews(this);
+
     // @property analytics: Analytics
     // Analytics instance
     this.analytics = new Analytics(this);