beyond_api 0.5.1.pre → 0.6.0.pre

data/lib/beyond_api/resources/payment_methods.rb

@@ -13,14 +13,14 @@ module BeyondApi
     #       -H 'Accept: application/hal+json' \
     #       -H 'Authorization: Bearer <Access token>'
     #
-    # @beyond_api.scopes pymt:u
+    # @beyond_api.scopes +pymt:u+
     #
     # @param payment_method_id [String] the payment method UUID
     #
     # @return true
     #
     # @example
-    #   session.payment_methods.activate("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #   session.payment_methods.activate("da313b73-ea6b-49c7-8a3d-d707934098b8")
     #
     def activate(payment_method_id)
       response, status = BeyondApi::Request.post(@session, "/payment-methods/#{payment_method_id}/activate")
@@ -36,7 +36,7 @@ module BeyondApi
     #       -H 'Accept: application/hal+json' \
     #       -H 'Authorization: Bearer <Access token>'
     #
-    # @beyond_api.scopes +pymt:r
+    # @beyond_api.scopes +pymt:r+
     #
     # @option params [Integer] :size the page size
     # @option params [Integer] :page the page number
@@ -44,7 +44,7 @@ module BeyondApi
     # @return [OpenStruct]
     #
     # @example
-    #   session.payment_methods.all(size: 100, page: 0)
+    #   @payment_methods = session.payment_methods.all(size: 100, page: 0)
     #
     def all(params = {})
       response, status = BeyondApi::Request.get(@session, "/payment-methods", params)
@@ -59,14 +59,14 @@ module BeyondApi
     #       -H 'Accept: application/hal+json' \
     #       -H 'Authorization: Bearer <Access token>'
     #
-    # @beyond_api.scopes pymt:u
+    # @beyond_api.scopes +pymt:u+
     #
     # @param payment_method_id [String] the payment method UUID
     #
     # @return true
     #
     # @example
-    #   session.payment_methods.deactivate("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #   session.payment_methods.deactivate("157f930f-328a-4d7a-974d-66bc3b4dd28e")
     #
     def deactivate(payment_method_id)
       response, status = BeyondApi::Request.post(@session, "/payment-methods/#{payment_method_id}/deactivate")
@@ -75,16 +75,21 @@ module BeyondApi
     end
 
     #
-    # A +GET+ request is used to activate a webhook subscription.
+    # A +GET+ request is used to retrieve the details of a payment method.
     #
-    # @beyond_api.scopes +pymt:r
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/payment-methods/7d964402-8f67-48f3-af86-6c35abe4fa08' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
     #
-    # @param payment_method_id [String] the paument method UUID
+    # @beyond_api.scopes +pymt:r+
+    #
+    # @param payment_method_id [String] the payment method UUID
     #
     # @return [OpenStruct]
     #
     # @example
-    #   session.payment_methods.find("268a8629-55cd-4890-9013-936b9b5ea14c")
+    #   @payment_method = session.payment_methods.find("7d964402-8f67-48f3-af86-6c35abe4fa08")
     #
     def find(payment_method_id)
       response, status = BeyondApi::Request.get(@session, "/payment-methods/#{payment_method_id}")
@@ -98,12 +103,12 @@ module BeyondApi
     #   $ curl 'https://api-shop.beyondshop.cloud/api/payment-methods' -i -X PUT \
     #       -H 'Content-Type: text/uri-list' \
     #       -H 'Authorization: Bearer <Access token>' \
-    #       -d 'https://api-shop.beyondshop.cloud/api/payment-methods/80fa2f12-53e4-42c4-8991-c5a3ddb7596e
-    #           https://api-shop.beyondshop.cloud/api/payment-methods/8b54c275-b766-44be-9ed5-c1e269594e0f
-    #           https://api-shop.beyondshop.cloud/api/payment-methods/779d08fb-a26d-447e-aef8-ed3642f05e5b
-    #           https://api-shop.beyondshop.cloud/api/payment-methods/c02de15b-1e6d-4990-9318-83749
+    #       -d 'https://api-shop.beyondshop.cloud/api/payment-methods/dd59a52b-0661-49f9-82c3-e063ff80328f
+    #           https://api-shop.beyondshop.cloud/api/payment-methods/66b22fb2-2184-4ea1-9143-44ae1d230d49
+    #           https://api-shop.beyondshop.cloud/api/payment-methods/a9462eae-ed72-4e29-b853-f04537c8ab11
+    #           https://api-shop.beyondshop.cloud/api/payment-methods/84172da4-5baa-4a99-b779-33d673bed6d1'
     #
-    # @beyond_api.scopes +pymt:u
+    # @beyond_api.scopes +pymt:u+
     #
     # @param payment_method_ids [Array] the payment method UUIDs
     #
@@ -111,18 +116,16 @@ module BeyondApi
     #
     # @example
     #   payment_method_ids = [
-    #     '6f3bc033-c2d1-4f44-80e3-1b668f6bd699',
-    #     '6f3bc033-c2d1-4f44-80e3-1b618f6sd692',
-    #     '6f3bc033-c2d1-4f44-80e3-1b628f6br698'
+    #     "dd59a52b-0661-49f9-82c3-e063ff80328f",
+    #     "66b22fb2-2184-4ea1-9143-44ae1d230d49",
+    #     "a9462eae-ed72-4e29-b853-f04537c8ab11",
+    #     "84172da4-5baa-4a99-b779-33d673bed6d1"
     #   ]
     #
-    #   session.payment_methods.sort(paymen)
+    #   session.payment_methods.sort(payment_method_ids)
     #
     def sort(payment_method_ids)
-      body = []
-      payment_method_ids.each do |payment_method|
-        body << "#{@session.api_url}/payment-methods/#{payment_method}"
-      end
+      body = payment_method_ids.map { |id| "#{@session.api_url}/payment-methods/#{id}" }
       response, status = BeyondApi::Request.put(@session, "/payment-methods", body)
 
       handle_response(response, status, respond_with_true: true)
@@ -154,7 +157,7 @@ module BeyondApi
     #           }
     #       }'
     #
-    # @beyond_api.scopes +pymt:u
+    # @beyond_api.scopes +pymt:u+
     #
     # @param payment_method_id [String] the payment method UUID
     # @param body [Hash] the request body
@@ -181,7 +184,7 @@ module BeyondApi
     #     }
     #   }
     #
-    #   @payment_method = session.payment_methods.update("6f3bc033-c2d1-4f44-80e3-1b668f6bd699", body)
+    #   @payment_method = session.payment_methods.update("dc00a5af-d21e-49f0-99f2-ef67ca6fa782", body)
     #
     def update(payment_method_id, body)
       response, status = BeyondApi::Request.put(@session, "/payment-methods/#{payment_method_id}", body)

data/lib/beyond_api/resources/product_attribute_definitions.rb

@@ -73,11 +73,9 @@ module BeyondApi
     end
 
     #
-    # A +DELETE+ request is used to delete a product attachment.
+    # A +DELETE+ request is used to delete a product attribute definition.
     #
-    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/00add006-beaa-46fe-bb73-f8ebae15082d/attachments/9a44e585-571a-4253-9248-54a4c418c7e2' -i -X DELETE \
-    #       -H 'Content-Type: application/hal+json' \
-    #       -H 'Accept: application/hal+json' \
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-attribute-definitions/color' -i -X DELETE \
     #       -H 'Authorization: Bearer <Access token>'
     #
     # @beyond_api.scopes +prad:d+
@@ -87,7 +85,7 @@ module BeyondApi
     # @return [true]
     #
     # @example
-    #   session.product_attribute_definitions.delete("filling_capacity")
+    #   session.product_attribute_definitions.delete("color")
     #
     def delete(product_attribute_name)
       response, status = BeyondApi::Request.delete(@session, "/product-attribute-definitions/#{product_attribute_name}")

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

@@ -6,35 +6,34 @@ module BeyondApi
   module ProductAttachments
 
     #
-    # A +POST+ request is used to list all the attachments of a product.
+    # A +POST+ request is used to create an attachment and add it to a product.
     #
     #   $ curl 'https://api-shop.beyondshop.cloud/api/products/ecb997ce-79c3-4367-9373-058089a313e3/attachments' -i -X POST \
     #       -H 'Content-Type: application/hal+json' \
     #       -H 'Accept: application/hal+json' \
     #       -H 'Authorization: Bearer <Access token>' \
     #       -d '{
-    #     "mimeType" : "application/pdf",
-    #     "length" : 1,
-    #     "label" : "Handbuch",
-    #     "dataUri" : "my_document_1.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225666"
+    #       "mimeType" : "application/pdf",
+    #       "length" : 1,
+    #       "label" : "Handbuch",
+    #       "dataUri" : "my_document_1.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225666"
     #   }'
     #
     # @beyond_api.scopes +prod:u+
     #
     # @param product_id [String] the product UUID
-    # @option params [Integer] :size the page size
-    # @option params [Integer] :page the page number
+    # @param body [Hash] the request body
     #
     # @return [OpenStruct]
     #
     # @example
     #   body = {
-    #     "mimeType" => "application/pdf",
+    #     "mime_type" => "application/pdf",
     #     "length" => 1,
     #     "label" => "Handbuch",
-    #     "dataUri" => "my_document_1.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225666"
+    #     "data_uri" => "my_document_1.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225666"
     #   }
-    #   @attachment = session.products.add_attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", body)
+    #   @attachment = session.products.add_attachment("ecb997ce-79c3-4367-9373-058089a313e3", body)
     #
     def add_attachment(product_id, body)
       response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/attachments", body)
@@ -58,7 +57,7 @@ module BeyondApi
     # @return [OpenStruct]
     #
     # @example
-    #   @attachment = session.products.attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "36933722-f13f-4ee2-858c-0835ae0a884e")
+    #   @attachment = session.products.attachment("eb11b53a-5017-4ae7-9ba1-c02c12c80b61", "36933722-f13f-4ee2-858c-0835ae0a884e")
     #
     def attachment(product_id, attachment_id)
       response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attachments/#{attachment_id}")
@@ -83,9 +82,9 @@ module BeyondApi
     # @return [OpenStruct]
     #
     # @example
-    #   @attachments = session.products.attachments("fd60a63e-c4c0-496d-af49-c4ed224cca2a", size: 100, page: 0)
+    #   @attachments = session.products.attachments("fd60a63e-c4c0-496d-af49-c4ed224cca2a", {size: 100, page: 0})
     #
-    def attachments(product_id, params)
+    def attachments(product_id, params = {})
       response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attachments", params)
 
       handle_response(response, status)
@@ -107,7 +106,7 @@ module BeyondApi
     # @return [true]
     #
     # @example
-    #   session.products.delete_attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "36933722-f13f-4ee2-858c-0835ae0a884e")
+    #   session.products.delete_attachment("00add006-beaa-46fe-bb73-f8ebae15082d", "9a44e585-571a-4253-9248-54a4c418c7e2")
     #
     def delete_attachment(product_id, attachment_id)
       response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}/attachments/#{attachment_id}")

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

@@ -17,14 +17,15 @@ module BeyondApi
     # @beyond_api.scopes +prda:u+
     #
     # @param product_id [String] the product UUID
+    # @param relative_amount [Integer] the relative amount
     #
     # @return [OpenStruct]
     #
     # @example
-    #   @availability = session.products.adjust_stock_level(product_id, { relativeAmount => -1 })
+    #   @availability = session.products.adjust_stock_level("685f483e-cdda-40af-8091-d5bc31249409", { relativeAmount => -1 })
     #
-    def adjust_stock_level(product_id, body)
-      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/enable-stock-management", body)
+    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 })
 
       handle_response(response, status)
     end
@@ -67,7 +68,7 @@ module BeyondApi
     # @return true
     #
     # @example
-    #   session.products.disable_purchasability("17e3a92b-6f3b-4415-bd8f-c9c8921a5a73")
+    #   session.products.disable_purchasability("6b30255e-650f-475c-b345-e7247f957689")
     #
     def disable_purchasability(product_id)
       response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/disable-purchasability")
@@ -90,7 +91,7 @@ module BeyondApi
     # @return true
     #
     # @example
-    #   session.products.disable_stock_management("e966cb17-4047-4b82-ade4-33e7f0978c89", respond_with_true: true)
+    #   session.products.disable_stock_management("e966cb17-4047-4b82-ade4-33e7f0978c89")
     #
     def disable_stock_management(product_id)
       response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/disable-stock-management")
@@ -139,8 +140,8 @@ module BeyondApi
     #
     # @example
     #   body = {
-    #     "initialAvailableStock" => 100,
-    #     "stockThreshold" => 2
+    #     "initial_available_stock" => 100,
+    #     "stock_threshold" => 2
     #   }
     #   @availability = session.products.enable_stock_management("101fa968-9bb8-4dbe-b166-3add1fc1b35e", body)
     #
@@ -162,14 +163,15 @@ module BeyondApi
     # @beyond_api.scopes +prda:u+
     #
     # @param product_id [String] the product UUID
+    # @param stock_threshold [Integer] the stock threshold
     #
     # @return [OpenStruct]
     #
     # @example
-    #   session.products.update_reserve_stock("f74b5f57-43cc-4176-97aa-c6eb9fdeb37c", { stockThreshold => 5 })
+    #   session.products.update_reserve_stock("f74b5f57-43cc-4176-97aa-c6eb9fdeb37c", { stock_threshold => 5 })
     #
-    def update_reserve_stock(product_id, body)
-      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/update-stock-threshold", body)
+    def update_reserve_stock(product_id, stock_threshold)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/update-stock-threshold", { stock_threshold: stock_threshold })
 
       handle_response(response, status)
     end

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

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  module ProductCrossSells
+
+    #
+    # A +POST+ request is used to create a cross-sell for a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/43df85ec-e123-4a56-bcc3-c3c52eb23ca9/cross-sells' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "name" : "Red wines from Spain cross-sell",
+    #       "type" : "MANUAL",
+    #       "queries" : [ {
+    #         "ids" : [ "22e8b6a6-7d8e-4b08-be63-dde9bced2604", "b18e9e3c-685c-4e37-837c-9047b88fc91e" ],
+    #         "strategy" : "all-ids-match"
+    #       } ]
+    #   }'
+    #
+    # @beyond_api.scopes +prcs:c+
+    #
+    # @param product_id [String] the product UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     name => "Red wines from Spain cross-sell",
+    #     type => "MANUAL",
+    #     queries => [ {
+    #       "ids" : [ "22e8b6a6-7d8e-4b08-be63-dde9bced2604", "b18e9e3c-685c-4e37-837c-9047b88fc91e" ],
+    #       "strategy" : "all-ids-match"
+    #     } ]
+    #   }
+    #
+    #   @cross_sell = session.products.create_cross_sell("43df85ec-e123-4a56-bcc3-c3c52eb23ca9", body)
+    #
+    def create_cross_sell(product_id, body)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/cross-sells", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the cross-sell of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/20174c3f-1a3f-4401-91f6-c7498e897c82/cross-sells/6176b350-06ff-4c52-b3cf-ba032ea79468' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prcs:r+
+    #
+    # @param product_id [String] the product UUID
+    # @param cross_sell_id [String] the cross-sell UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #
+    #   @cross_sell = session.products.cross_sell("20174c3f-1a3f-4401-91f6-c7498e897c82", "6176b350-06ff-4c52-b3cf-ba032ea79468")
+    #
+    def cross_sell(product_id, cross_sell_id)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/cross-sells/#{cross_sell_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the cross-sells of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/a21188a2-7109-4cd1-8253-2f366d86ff5d/cross-sells' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prcs:r+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #
+    #   @cross_sells = session.products.cross_sells("a21188a2-7109-4cd1-8253-2f366d86ff5d")
+    #
+    def cross_sells(product_id)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/cross-sells")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a product attribute.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/b80cdb11-0e97-41e3-8559-4d426bd28ba1/cross-sells/67ecb3ef-8472-4509-9e5a-c76945e8d963' -i -X DELETE \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prcs:d+
+    #
+    # @param product_id [String] the product UUID
+    # @param cross_sell_id [String] the cross-sell UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #
+    #   session.products.cross_sell("b80cdb11-0e97-41e3-8559-4d426bd28ba1", "67ecb3ef-8472-4509-9e5a-c76945e8d963")
+    #
+    def delete_cross_sell(product_id, cross_sell_id)
+      response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}/cross-sells/#{cross_sell_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +PUT+ request is used to update a cross-sell for a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/4ed7a15a-9ef8-415f-8161-87498b1ecd4f/cross-sells/b18d96f4-dfdf-47f3-b2dc-ce1653829674' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "name" : "sale rose wine cross-selling",
+    #       "type" : "SMART",
+    #       "queries" : [ {
+    #         "tags" : [ "Rosé Wine", "Sale" ],
+    #         "strategy" : "any-tags-match"
+    #       } ]
+    #   }'
+    #
+    # @beyond_api.scopes +prcs:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param cross_sell_id [String] the cross-sell UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     name => "sale rose wine cross-selling",
+    #     type => "SMART",
+    #     queries => [ {
+    #         tags => [ "Rosé Wine", "Sale" ],
+    #         strategy => "any-tags-match"
+    #     } ]
+    #   }
+    #
+    #   @cross_sell = session.products.update_cross_sell("4ed7a15a-9ef8-415f-8161-87498b1ecd4f", "b18d96f4-dfdf-47f3-b2dc-ce1653829674", body)
+    #
+    def update_cross_sell(product_id, attribute_name, body)
+      response, status = BeyondApi::Request.put(@session, "/products/#{product_id}/cross-sells/#{cross_sell_id}", body)
+
+      handle_response(response, status)
+    end
+  end
+end

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

@@ -12,8 +12,8 @@ module BeyondApi
     #       -H 'Content-Type: application/json' \
     #       -H 'Authorization: Bearer <Access token>' \
     #       -d '{
-    #     "key" : "colour",
-    #     "value" : "Yellow"
+    #       "key" : "colour",
+    #       "value" : "Yellow"
     #   }'
     #
     # @beyond_api.scopes +prat:c+
@@ -29,7 +29,7 @@ module BeyondApi
     #     "value" => "Yellow"
     #   }
     #
-    #   @custom_attribute = session.products.attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", body)
+    #   @custom_attribute = session.products.create_custom_attribute("0c0e1699-d2a4-44d0-bed9-64b2fa1a7713", body)
     #
     def create_custom_attribute(product_id, body)
       response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/attributes", body)
@@ -53,7 +53,7 @@ module BeyondApi
     #
     # @example
     #
-    #   @custom_attribute = session.products.custom_attribute("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "key")
+    #   @custom_attribute = session.products.custom_attribute("d389347c-568e-4785-8216-91e4f8850c66", "key")
     #
     def custom_attribute(product_id, attribute_name)
       response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attributes/#{attribute_name}")
@@ -76,7 +76,7 @@ module BeyondApi
     #
     # @example
     #
-    #   @custom_attributes = session.products.custom_attributes("fd60a63e-c4c0-496d-af49-c4ed224cca2a")
+    #   @custom_attributes = session.products.custom_attributes("57f0ef04-9dac-462f-9dd4-606f7551cc7b")
     #
     def custom_attributes(product_id)
       response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attributes")
@@ -99,7 +99,7 @@ module BeyondApi
     #
     # @example
     #
-    #   session.products.custom_attribute("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "key")
+    #   session.products.delete_custom_attribute("fec3b6f3-83d0-467a-abc5-d51019e57b51", "farbe")
     #
     def delete_custom_attribute(product_id, attribute_name)
       response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}/attributes/#{attribute_name}")
@@ -130,7 +130,7 @@ module BeyondApi
     #     "value" : "green"
     #    }
     #
-    #   @custom_attribute = session.products.update_custom_attribute("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "key", body)
+    #   @custom_attribute = session.products.update_custom_attribute("82ed44e9-664d-47c0-8b07-09adecfdbf20", "key", body)
     #
     def update_custom_attribute(product_id, attribute_name, body)
       response, status = BeyondApi::Request.put(@session, "/products/#{product_id}/attributes/#{attribute_name}", body)

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

@@ -5,7 +5,7 @@ require "beyond_api/utils"
 module BeyondApi
   module ProductImages
 
-
+    #
     # A +POST+ request is used to create an image and add it to a product.
     #
     #   $ curl 'https://api-shop.beyondshop.cloud/api/products/7a7d1f18-f760-46a9-b794-dbe5a88c6b44/images' -i -X POST \
@@ -13,8 +13,10 @@ module BeyondApi
     #       -H 'Accept: application/hal+json' \
     #       -H 'Authorization: Bearer <Access token>' \
     #       -d '{
-    #     "dataUri" : "photostore-2.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998"
-    #   }'
+    #           "dataUri" : "photostore-2.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998",
+    #           "width" : 600,
+    #           "height" : 300
+    #       }'
     #
     # @beyond_api.scopes +prod:u+
     #
@@ -24,10 +26,15 @@ module BeyondApi
     # @return [OpenStruct]
     #
     # @example
-    #   @image = session.products.add_image(product_id, { dataUri: "photostore-2.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998" })
+    #   body = {
+    #     "data_uri" => "photostore-2.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998",
+    #     "width" => 600,
+    #     "height" => 300
+    #   }
+    #   @image = session.products.add_image("7a7d1f18-f760-46a9-b794-dbe5a88c6b44", body)
     #
-    def add_image(product_id, image_uri)
-      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/images", { dataUri: image_uri})
+    def add_image(product_id, body)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/images", body)
 
       handle_response(response, status)
     end
@@ -73,7 +80,7 @@ module BeyondApi
     # @return [OpenStruct]
     #
     # @example
-    #   @products = session.products.images("7f32696a-df56-4380-a91b-fffb97f025b4", { size: 20, page: 0 })
+    #   @images = session.products.images("7f32696a-df56-4380-a91b-fffb97f025b4", { size: 20, page: 0 })
     #
     def images(product_id, params = {})
       response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/images", params)
@@ -124,7 +131,39 @@ module BeyondApi
     #
     def set_image_as_default(product_id, image_id)
       response, status = BeyondApi::Request.put(@session, "/products/#{product_id}",
-                                                "#{@session.api_url}/productsimages/#{image_id}")
+                                                "#{@session.api_url}/images/#{image_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    # A +PUT+ request is used to sort the product images. This is done by passing the self-links of the images to the desired product. The request must contain URIs for all images of the given page.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/3f4b2b56-c22d-4d80-b4ed-d5b33ed161eb/images' -i -X PUT \
+    #       -H 'Content-Type: text/uri-list' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d 'http://localhost/products/3f4b2b56-c22d-4d80-b4ed-d5b33ed161eb/images/c9082802-a0d0-416e-9039-02fa465a027e
+    #           http://localhost/products/3f4b2b56-c22d-4d80-b4ed-d5b33ed161eb/images/78e9993d-8db3-45d8-8f76-6b8f2aea9c45
+    #           http://localhost/products/3f4b2b56-c22d-4d80-b4ed-d5b33ed161eb/images/9233ee97-5dbb-4c00-a7b2-e1512c69a938'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param images [Array] the image UUIDS
+    #
+    # @return true
+    #
+    # @example
+    #   body = [
+    #     "c9082802-a0d0-416e-9039-02fa465a027e",
+    #     "78e9993d-8db3-45d8-8f76-6b8f2aea9c45",
+    #     "9233ee97-5dbb-4c00-a7b2-e1512c69a938"
+    #   ]
+    #   session.products.sort_images("3f4b2b56-c22d-4d80-b4ed-d5b33ed161eb", body)
+    #
+    def sort_images(product_id, image_ids)
+      body = image_ids.map { |image_id| "#{@session.api_url}/products/#{product_id}/images/#{image_id}" }
+      response, status = BeyondApi::Request.put(@session, "/products/#{product_id}/images", body)
 
       handle_response(response, status, respond_with_true: true)
     end