beyond_api 0.6.0.pre → 0.7.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31b8f47b376a95d1575e48fb7661397aa5c4e374fc6ac680b44d16dcd7bb4e5d
-  data.tar.gz: 5fb3e444da729827dee2f3ae336771b6ffc9d278150bcd371b115d9e7496dd7d
+  metadata.gz: 3f7a8343a55357062e3c00e229c0b16c1c88af900347165145739372d005cb99
+  data.tar.gz: 10ff509e60617197670305f7a0a6a32171018693f4100b8da9626ae636e492ec
 SHA512:
-  metadata.gz: fcf18ac9f5037a904f630cef79698edfe2ab1d4a9bdc417cf27a1f9e354d0df760dd2ff18416790774dc451bba569c7227de8c5bee7644b42cce35796dccc82a
-  data.tar.gz: 1126ed97396c7db4fdf721106a49471ba9c68c4f6c61f0a35f061b23e262acbdf78a9ea091a53eb8052a65ddb7edf9cb02a18a1920ae108fd949464745a1d692
+  metadata.gz: c3edbc6973b4f630cb38ca5c1eb7a4855df7deb85fa43a74315133a4e3df86695955fd5c461ff1d645ad79ea1d1aa296b245c42af2738d16cd0b9ec6fefd9980
+  data.tar.gz: bdf3dc796e6cbf47981daaf40b71ec83d937213e0640f24ad32c250e0a68ce842205289b9fb6b3290425bc849b334680054516eeda3e2b932c4cfc39f52d0788

data/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

data/GETTING_STARTED.md

@@ -37,6 +37,8 @@ session.token.refresh
 
 ## Consuming the API
 
+Check the [_rubydoc_ documentation](https://rubydoc.info/github/ePages-de/beyond_api-ruby_client) for more information on the Beyond API Ruby Client.
+
 Here you can find a list with all available methods:
 
 * Carts

data/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

data/README.md

@@ -1,6 +1,7 @@
 # Beyond API Ruby Client
 
 ![Gem Version](https://img.shields.io/gem/v/beyond_api?label=gem%20version)
+[![Docs](https://img.shields.io/badge/docs-rubydoc-blue)](https://rubydoc.info/github/ePages-de/beyond_api-ruby_client)
 [![Maintainability](https://api.codeclimate.com/v1/badges/1d173fa0b393e8eaf2a2/maintainability)](https://codeclimate.com/github/ePages-de/beyond_api-ruby_client/maintainability)
 ![License](https://img.shields.io/github/license/ePages-de/beyond_api-ruby_client)
 

data/lib/beyond_api/resources/products.rb

@@ -252,6 +252,33 @@ module BeyondApi
       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

data/lib/beyond_api/resources/products/availability.rb

@@ -22,7 +22,7 @@ module BeyondApi
     # @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 })

data/lib/beyond_api/resources/variations/availability.rb

@@ -18,15 +18,15 @@ module BeyondApi
     #
     # @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

data/lib/beyond_api/resources/variations/images.rb

@@ -139,7 +139,7 @@ module BeyondApi
     #     "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)

data/lib/beyond_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.6.0.pre
+  version: 0.7.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler