Merge remote-tracking branch 'upstream/master'

Author: unabris

CHANGELOG.md

@@ -1,3 +1,11 @@
+### v0.7.0.pre
+
+* features
+  * Add `Products#assign_variation_images_differentiator` method
+
+* deprecations
+  * `Variations#adjust_stock_level` receives parameter `relative_amount` instead of `body`
+
 ### v0.6.0.pre
 
 * bug-fixes

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.6.0.pre)
+    beyond_api (0.7.0.pre)
       faraday (~> 0.15)
 
 GEM

lib/beyond_api/resources/products.rb

@@ -252,6 +252,33 @@ def update(product_id, body)
       handle_response(response, status)
     end
 
+    #
+    # A +PUT+ request is used to assign a variation images differentiator for a variation product. The differentiator can be one of the variation attributes defined by the merchant, e.g. name, size, or color.
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/30839efc-47f7-4d55-aa13-aac7532982b6/variation-images-differentiator' -i -X PUT \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "differentiator" : "size"
+    #   }'
+    #
+    # @param product_id [String] the product UUID
+    # @param differentiator [String] the differentiator
+    #
+    # @return [true]
+    #
+    # @example
+    #   session.products.assign_variation_images_differentiator("30839efc-47f7-4d55-aa13-aac7532982b6", "size")
+    #
+    def assign_variation_images_differentiator(product_id, differentiator)
+      response, status = BeyondApi::Request.put(@session, "/products/#{product_id}/variation-images-differentiator", differentiator: differentiator)
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
     alias_method :create_variation, :create
     alias_method :find_variation,   :find
     alias_method :update_variation, :update

lib/beyond_api/resources/products/availability.rb

@@ -22,7 +22,7 @@ module ProductAvailability
     # @return [OpenStruct]
     #
     # @example
-    #   @availability = session.products.adjust_stock_level("685f483e-cdda-40af-8091-d5bc31249409", { relativeAmount => -1 })
+    #   @availability = session.products.adjust_stock_level("685f483e-cdda-40af-8091-d5bc31249409", -1)
     #
     def adjust_stock_level(product_id, relative_amount)
       response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/adjust-available-stock", { relative_amount: relative_amount })

lib/beyond_api/resources/variations/availability.rb

@@ -18,15 +18,15 @@ module VariationAvailability
     #
     # @param product_id [String] the product UUID
     # @param variation_id [String] the product variation UUID
-    # @param body [Hash] the request body
+    # @param relative_amount [Integer] the relative amount
     #
     # @return [OpenStruct]
     #
     # @example
     #   @availability = session.variations.adjust_stock_level(product_id, variation_id, { relativeAmount => -1 })
     #
-    def adjust_stock_level(product_id, variation_id, body)
-      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/adjust-available-stock", body)
+    def adjust_stock_level(product_id, variation_id, relative_amount)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/variations/#{variation_id}/availability/adjust-available-stock", relative_amount: relative_amount)
 
       handle_response(response, status)
     end

lib/beyond_api/resources/variations/images.rb

@@ -139,7 +139,7 @@ def images(product_id, variation_id, params = {})
     #     "source" => "https://vimeo.com/7265982"
     #   }
     #
-    #   session.variation.upload_image("4125b993-49fc-47c8-b9b3-76d8871e4e06", "d7fecf94-2e57-4122-8c94-a0acd840c111", "/home/epages/file.png", "file.png")
+    #   session.variations.upload_image("4125b993-49fc-47c8-b9b3-76d8871e4e06", "d7fecf94-2e57-4122-8c94-a0acd840c111", "/home/epages/file.png", "file.png")
     #
     def upload_image(product_id, variation_id, image_path, image_name)
       content_type = case File.extname(image_path)

lib/beyond_api/version.rb

@@ -1,3 +1,3 @@
 module BeyondApi
-  VERSION = "0.6.0.pre".freeze
+  VERSION = "0.7.0.pre".freeze
 end