beyond_api 0.1.0.pre

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  module ProductAttachments
+
+    #
+    # A +POST+ request is used to list all the attachments of 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"
+    #   }'
+    #
+    # @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
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "mimeType" => "application/pdf",
+    #     "length" => 1,
+    #     "label" => "Handbuch",
+    #     "dataUri" => "my_document_1.pdf?hash=8a627f655c68f56dfbbf217ab7d5563281225666"
+    #   }
+    #   @attachment = session.products.add_attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", body)
+    #
+    def add_attachment(product_id, body)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/attachments", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve a single attachment of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/eb11b53a-5017-4ae7-9ba1-c02c12c80b61/attachments/36933722-f13f-4ee2-858c-0835ae0a884e' -i -X GET \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param product_id [String] the product UUID
+    # @param attachment_id [String] the attachment UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @attachment = session.products.attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "36933722-f13f-4ee2-858c-0835ae0a884e")
+    #
+    def attachment(product_id, attachment_id)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attachments/#{attachment_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all the attachments of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/fd60a63e-c4c0-496d-af49-c4ed224cca2a/attachments' -i -X GET \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param product_id [String] the product UUID
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @attachments = session.products.attachments("fd60a63e-c4c0-496d-af49-c4ed224cca2a", size: 100, page: 0)
+    #
+    def attachments(product_id, params)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attachments", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a product attachment
+    #
+    #   $ 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' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param attachment_id [String] the attachment UUID
+    #
+    # @return [true]
+    #
+    # @example
+    #   session.products.delete_attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "36933722-f13f-4ee2-858c-0835ae0a884e")
+    #
+    def delete_attachment(product_id, attachment_id)
+      response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}/attachments/#{attachment_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+  end
+end

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

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  module ProductAvailability
+
+    #
+    # A +POST+ request is used to adjust the available stock of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/685f483e-cdda-40af-8091-d5bc31249409/availability/adjust-available-stock' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{ "relativeAmount" : -1 }'
+    #
+    # @beyond_api.scopes +prda:u+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @availability = session.products.adjust_stock_level(product_id, { relativeAmount => -1 })
+    #
+    def adjust_stock_level(product_id, body)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/enable-stock-management", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the availability of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/fb22d408-00dc-47e3-ae58-e35769bdb428/availability' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prda:r+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @availability = session.products.availability("fb22d408-00dc-47e3-ae58-e35769bdb428")
+    #
+    def availability(product_id)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/availability")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to disable purchasability for a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/6b30255e-650f-475c-b345-e7247f957689/availability/disable-purchasability' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prda:u+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.products.disable_purchasability("17e3a92b-6f3b-4415-bd8f-c9c8921a5a73")
+    #
+    def disable_purchasability(product_id)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/disable-purchasability")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +POST+ request is used to disable stock management for a product or variation product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/e966cb17-4047-4b82-ade4-33e7f0978c89/availability/disable-stock-management' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prda:u+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.products.disable_stock_management("e966cb17-4047-4b82-ade4-33e7f0978c89", respond_with_true: true)
+    #
+    def disable_stock_management(product_id)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/disable-stock-management")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +POST+ request is used to enable purchasability for a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/17e3a92b-6f3b-4415-bd8f-c9c8921a5a73/availability/enable-purchasability' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prda:u+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.products.enable_purchasability("17e3a92b-6f3b-4415-bd8f-c9c8921a5a73")
+    #
+    def enable_purchasability(product_id)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/enable-purchasability")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +POST+ request is used to enable stock management for a product or variation product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/101fa968-9bb8-4dbe-b166-3add1fc1b35e/availability/enable-stock-management' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{ "initialAvailableStock" : 100, "stockThreshold" : 2 }'
+    #
+    # @beyond_api.scopes +prda:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "initialAvailableStock" => 100,
+    #     "stockThreshold" => 2
+    #   }
+    #   @availability = session.products.enable_stock_management("101fa968-9bb8-4dbe-b166-3add1fc1b35e", body)
+    #
+    def enable_stock_management(product_id, body)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/enable-stock-management", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to update the reserve stock by changing the +stockThreshold+ value of a product or variation product (incl. all of its variations). Reserve stock refers to an inventory level that indicates that a product needs to be reordered.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/f74b5f57-43cc-4176-97aa-c6eb9fdeb37c/availability/update-stock-threshold' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{ "stockThreshold" : 5 }'
+    #
+    # @beyond_api.scopes +prda:u+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   session.products.update_reserve_stock("f74b5f57-43cc-4176-97aa-c6eb9fdeb37c", { stockThreshold => 5 })
+    #
+    def update_reserve_stock(product_id, body)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/availability/update-stock-threshold", body)
+
+      handle_response(response, status)
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  module ProductCustomAttribute
+
+    #
+    # A +POST+ request is used to create a product attribute, which defines the value of a certain {product attribute definition}[http://docs.beyondshop.cloud/#resources-product-attribute-definitions] for a specific {product}[http://docs.beyondshop.cloud/#resources-products].
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/0c0e1699-d2a4-44d0-bed9-64b2fa1a7713/attributes' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "key" : "colour",
+    #     "value" : "Yellow"
+    #   }'
+    #
+    # @beyond_api.scopes +prat:c+
+    #
+    # @param product_id [String] the product UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "key" => "colour",
+    #     "value" => "Yellow"
+    #   }
+    #
+    #   @custom_attribute = session.products.attachment("fd60a63e-c4c0-496d-af49-c4ed224cca2a", body)
+    #
+    def create_custom_attribute(product_id, body)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/attributes", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve detailed information about a specific product attribute.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/d389347c-568e-4785-8216-91e4f8850c66/attributes/key' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prat:r+
+    #
+    # @param product_id [String] the product UUID
+    # @param attribute_name [String] the key of custom attribute
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #
+    #   @custom_attribute = session.products.custom_attribute("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "key")
+    #
+    def custom_attribute(product_id, attribute_name)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attributes/#{attribute_name}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve all product attributes for a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/57f0ef04-9dac-462f-9dd4-606f7551cc7b/attributes' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prat:r+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #
+    #   @custom_attributes = session.products.custom_attributes("fd60a63e-c4c0-496d-af49-c4ed224cca2a")
+    #
+    def custom_attributes(product_id)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/attributes")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a product attribute.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/fec3b6f3-83d0-467a-abc5-d51019e57b51/attributes/farbe' -i -X DELETE \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prat:d+
+    #
+    # @param product_id [String] the product UUID
+    # @param attribute_name [String] the key of custom attribute
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #
+    #   session.products.custom_attribute("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "key")
+    #
+    def delete_custom_attribute(product_id, attribute_name)
+      response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}/attributes/#{attribute_name}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +PUT+ request is used to update the value of a product attribute. If the specified product attribute doesn’t exist, it will be created with the response as described in {Create product attribute}[http://docs.beyondshop.cloud/#resources-product-attribute-create].
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/82ed44e9-664d-47c0-8b07-09adecfdbf20/attributes/key' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "value" : "green"
+    #   }'
+    #
+    # @beyond_api.scopes +prat:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param attribute_name [String] the key of custom attribute
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "value" : "green"
+    #    }
+    #
+    #   @custom_attribute = session.products.update_custom_attribute("fd60a63e-c4c0-496d-af49-c4ed224cca2a", "key", body)
+    #
+    def update_custom_attribute(product_id, attribute_name, body)
+      response, status = BeyondApi::Request.put(@session, "/products/#{product_id}/attributes/#{attribute_name}", body)
+
+      handle_response(response, status)
+    end
+  end
+end

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

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+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 \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "dataUri" : "photostore-2.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998"
+    #   }'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param image_uri [String] the image url
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @image = session.products.add_image(product_id, { dataUri: "photostore-2.JPG?hash=8a627f655c68f56dfbbf217ab7d5563281225998" })
+    #
+    def add_image(product_id, image_uri)
+      response, status = BeyondApi::Request.post(@session, "/products/#{product_id}/images", { dataUri: image_uri})
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a product image.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/8f5e979e-4a47-47ca-84ce-7c026d623974/images/ac318d53-df29-4f43-9356-d91aed8bdb39' -i -X DELETE \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param image_id [String] the image UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.products.delete_image("8f5e979e-4a47-47ca-84ce-7c026d623974", "ac318d53-df29-4f43-9356-d91aed8bdb39")
+    #
+    def delete_image(product_id, image_id)
+      response, status = BeyondApi::Request.delete(@session, "/products/#{product_id}/images/#{image_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the images of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/7f32696a-df56-4380-a91b-fffb97f025b4/images' -i -X GET \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param product_id [String] the product UUID
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @products = 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)
+
+      handle_response(response, status)
+    end
+
+    # A +GET+ request is used to retrieve a single image of a product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/124c5c94-4e62-410a-8599-e5b29dae3491/images/715f5154-9fde-4213-bcab-41ceaaf8b70e' -i -X GET \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param product_id [String] the product UUID
+    # @param image_id [String] the image UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @image = session.products.image("124c5c94-4e62-410a-8599-e5b29dae3491", "715f5154-9fde-4213-bcab-41ceaaf8b70e")
+    #
+    def image(product_id, image_id)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/images/#{image_id}")
+
+      handle_response(response, status)
+    end
+
+    # A +PUT+ request is used to assign a product image as the default image. The request contains a single URI of the image to assign.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/150015b9-0b9b-45a2-bcfb-f9006b16a8b8/default-image' -i -X PUT \
+    #       -H 'Content-Type: text/uri-list' \
+    #       -H 'Accept: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d 'http://localhost/products/images/8ef3591c-d05f-4aa1-acf6-950ba51ec4f7'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param image_id [String] the image UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.products.set_image_as_default("150015b9-0b9b-45a2-bcfb-f9006b16a8b8", "8ef3591c-d05f-4aa1-acf6-950ba51ec4f7")
+    #
+    def set_image_as_default(product_id, image_id)
+      response, status = BeyondApi::Request.put(@session, "/products/#{product_id}",
+                                                "#{@session.api_url}/productsimages/#{image_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    # A +POST+ request is used to upload an image and add it to a product. The body of the request must contain the content of the image.
+    #
+    #   $ curl --data-binary '@/home/epages/file.png' 'https://api-shop.beyondshop.cloud/api/products/4125b993-49fc-47c8-b9b3-76d8871e4e06/images?fileName=file.png' -X POST \
+    #       -H 'Content-Type: image/png' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:u+
+    #
+    # @param product_id [String] the product UUID
+    # @param image_path [String] the image path
+    # @param image_name [String] the image name
+    #
+    # @return true
+    #
+    # @example
+    #   session.products.upload_image("4125b993-49fc-47c8-b9b3-76d8871e4e06", "/home/epages/file.png", "file.png")
+    #
+    def upload_image(product_id, image_path, image_name)
+      content_type = case File.extname(image_path)
+        when ".png"
+          "image/png"
+        when ".jpg", ".jpeg"
+          "image/jpeg"
+        when ".gif"
+          "image/gif"
+        end
+      image_binary = File.binread(image_path)
+
+      response, status = BeyondApi::Request.upload(@session, "/products/#{product_id}/images", image_binary, content_type, { file_name: image_name })
+
+      handle_response(response, status, respond_with_true: true)
+    end
+  end
+end