EPT-2621 Add categories preview endpoint (#57)

* Add categories preview endpoint

* Update categories_view.rb

* Update version.rb

Author: k4th

CHANGELOG.md

@@ -1,3 +1,9 @@
+### v0.24.0.pre
+
+* features
+  * Add category preview method
+    * `CategoriesView#preview`
+
 ### v0.23.0.pre
 
 * feature
@@ -20,6 +26,7 @@
 
 * features
   * Add  `Variations#sort_images` method
+
 ### v0.20.0.pre
 
 * features

lib/beyond_api/resources/categories_view.rb

@@ -48,6 +48,64 @@ def find(category_id)
       handle_response(response, status)
     end
 
+    #
+    # A +POST+ request is read-only and cannot create data. It is used to find products that match the filter criteria.
+    # Thus, it can be used to preview all products that are included in a category that shares the respective filter criteria.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/categories/preview?page=0&size=10&sortBy=NEWEST_FIRST' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Content-Type: application/json' \
+    #       -d '{
+    #     "filters" : [ {
+    #       "key" : "manufacturer",
+    #       "values" : [ "Grape Vineyard" ]
+    #     }, {
+    #       "key" : "all_tags",
+    #       "values" : [ "Power Bar", "Bestseller", "High Protein" ]
+    #     }, {
+    #       "key" : "price_range",
+    #       "min" : 3.7,
+    #       "max" : 13.7
+    #     } ]
+    #   }'
+    #
+    # @param body [Hash] the request body
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    # @option params [String] :sort_by the sorting applied to the list of products
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     filters => [ 
+    #       {
+    #         key => "manufacturer",
+    #         values => [ "Grape Vineyard" ]
+    #       },
+    #       {
+    #         key => "all_tags",
+    #         values => [ "Power Bar", "Bestseller", "High Protein" ]
+    #       },
+    #       {
+    #         key => "price_range",
+    #         min => 3.7,
+    #         max => 13.7
+    #       } 
+    #     ]
+    #   }
+    #
+    #   @products = session.categories_view.preview(body, { size: 100, page: 0, sort_by: "NEWEST_FIRST" })
+    #
+    def preview(body, params = {})
+      response, status = BeyondApi::Request.post(@session,
+                                                 "/product-view/categories/preview",
+                                                 body,
+                                                 params)
+
+      handle_response(response, status)
+    end
+
     #
     # A +GET+ request is used to list all products of a category.
     #

lib/beyond_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BeyondApi
-  VERSION = "0.23.0.pre"
+  VERSION = "0.24.0.pre"
 end