Merge remote-tracking branch 'upstream/master'

Author: gersanco

CHANGELOG.md

@@ -1,3 +1,9 @@
+### v0.20.0.pre
+
+* features
+  * Add product search method
+    * `Products#search`
+
 ### v0.19.0.pre
 
 * features

lib/beyond_api/resources/products/searches.rb

@@ -4,6 +4,67 @@
 
 module BeyondApi
   module ProductSearches
+    #
+    # A +POST+ request is used to search for products by a search term. Optionally, you can also filter the search results.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/search' -i -X POST \
+    #       -H 'Content-Type: application/hal+json;charset=UTF-8' \
+    #       -H 'Accept: application/hal+json' \
+    #         -H 'Authorization: Bearer <Access token>'
+    #         -d '{
+    #       "search" : {
+    #         "term" : "Tony Highfinger, Poloshirt, Men",
+    #         "category" : "NAME"
+    #       },
+    #       "filters" : [ {
+    #         "key" : "status",
+    #         "values" : [ "PUBLISHED" ]
+    #       } ],
+    #       "paging" : {
+    #         "page" : 0,
+    #         "pageSize" : 20,
+    #         "sort" : {
+    #           "property" : "name",
+    #           "direction" : "ASC"
+    #         }
+    #       }
+    #   }'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param body [String] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     search: {
+    #       term: "Tony Highfinger, Poloshirt, Men",
+    #       category: "NAME"
+    #     },
+    #     filters: [ {
+    #       key: "status",
+    #       values: [ "PUBLISHED" ]
+    #     } ],
+    #     paging: {
+    #       page: 0,
+    #       page_size: 20,
+    #       sort: {
+    #         property: "name",
+    #         direction: "ASC"
+    #       }
+    #     }
+    #   }
+    #   @products = session.product.search(body)
+    #
+    def search(body)
+      response, status = BeyondApi::Request.post(@session,
+                                                 "/products/search",
+                                                 body)
+
+      handle_response(response, status)
+    end
+
     #
     # A +GET+ request is used to search for a product by SKU.
     #

lib/beyond_api/version.rb

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