beyond_api 0.1.0.pre

data/lib/beyond_api/resources/categories.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class Categories < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to list all available categories in a paged manner.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/categories' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +catg:r+
+    #
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @categories = session.categories.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/categories", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to create a category.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/categories' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{"name":"Power Bars","label":"power-bar","type":"SMART","query":{"bool":{"filter":{"term":{"tags":"power-bar"}}}}}'
+    #
+    # @beyond_api.scopes +catg:c+
+    #
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "name" => "Power Bars",
+    #     "label" => "power-bar",
+    #     "type" => "SMART",
+    #     "query" => { "bool" => { "filter" => { "term" : { "tags" => "power-bar" } } } }
+    #   }
+    #   @category = session.categories.create(body)
+    #
+    def create(body)
+      response, status = BeyondApi::Request.post(@session, "/categories", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a category.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/categories/f461fb56-1984-4ade-bd4e-007c273cc923' -i -X DELETE \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +catg:d+
+    #
+    # @param category_id [String] the category UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.categories.delete("f461fb56-1984-4ade-bd4e-007c273cc923")
+    #
+    def delete(category_id)
+      response, status = BeyondApi::Request.delete(@session, "/categories/#{category_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the details of a category.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/categories/27a94b71-9b17-4f06-9596-fbbf4d18021f' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +catg:r+
+    #
+    # @param category_id [String] the category UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @category = session.categories.find(category_id)
+    #
+    def find(category_id)
+      response, status = BeyondApi::Request.get(@session, "/categories/#{category_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PATCH+ request is used to update a category partially with json patch content type.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/categories/49250b7a-79a8-48d0-a71c-fc417965928d' -i -X PATCH \
+    #       -H 'Content-Type: application/json-patch+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{"name":"patched name","type":"MANUAL","query":{"bool":{"filter":[{"terms":{"id":["6c449297-65fc-41aa-a49c-68a3561b33e5","6c449297-65fc-41aa-a49c-68a3561b33e6"]}}]}}}'
+    #
+    # @beyond_api.scopes +catg:u+
+    #
+    # @param category_id [String] the category UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body =  {
+    #     "name" => "patched name",
+    #     "type" => "MANUAL",
+    #     "query" => {"bool" => { "filter" => [ { "terms" => { "id" => [ "6c449297-65fc-41aa-a49c-68a3561b33e5", "6c449297-65fc-41aa-a49c-68a3561b33e6" ] } } ] } }
+    #   }
+    #   @category = session.categories.update("49250b7a-79a8-48d0-a71c-fc417965928d", body)
+    #
+    def patch(category_id, body)
+      response, status = BeyondApi::Request.patch(@session, "/categories/#{category_id}", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A PUT request is issued to update all category properties with application/json content type.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/categories/cb2058dc-871a-4e64-83ac-39a0be9e6f82' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{"name":"updated name","label":"updated-name","type":"MANUAL","query":{"bool":{"filter":[{"terms":{"id":["6c449297-65fc-41aa-a49c-68a3561b33e5","6c449297-65fc-41aa-a49c-68a3561b33e6"]}}]}}}'
+    #
+    # @beyond_api.scopes +catg:u+
+    #
+    # @param category_id [String] the category UUID
+    # @param body [Hash] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #     "name" => "updated name",
+    #     "label" => "updated-name",
+    #     "type" => "MANUAL",
+    #     "query" => { "bool" => { "filter" => [ { "terms" => { "id" => [ "6c449297-65fc-41aa-a49c-68a3561b33e5", "6c449297-65fc-41aa-a49c-68a3561b33e6" ] } } ] } }
+    #   }
+    #   @category = session.categories.update(category_id, body)
+    #
+    def update(category_id, body)
+      response, status = BeyondApi::Request.put(@session, "/categories/#{category_id}", body)
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/categories_view.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class CategoriesView < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to list all product categories.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/categories' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json'
+    #
+    #
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @categories = session.categories_view.all(size: 100, page: 0)
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/product-view/categories", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the details of a product category.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/categories/23bb1430-6e82-40e4-9a92-4cb404da74a8' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json'
+    #
+    # @param category_id [String] the category UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @category = session.categories_view.find("23bb1430-6e82-40e4-9a92-4cb404da74a8")
+    #
+    def find(category_id)
+      response, status = BeyondApi::Request.get(@session, "/product-view/categories/#{category_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all products of a category.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/categories/681beef2-cd3e-4ce3-8034-4d07c1184447/products' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json'
+    #
+    # @param category_id [String] the category UUID
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @products = session.categories_view.products("681beef2-cd3e-4ce3-8034-4d07c1184447", { size: 100, page: 0 })
+    #
+    def products(category_id, params = {})
+      response, status = BeyondApi::Request.get(@session, "/product-view/categories/#{category_id}/products", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to find a product category by its unique label.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/categories/search/find-by-label?label=power-bar' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json'
+    #
+    # @param label [String] the label of the category
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @category = session.categories_view.search_by_label("power-bar")
+    #
+    def search_by_label(label)
+      response, status = BeyondApi::Request.get(@session, "/product-view/categories/search/find-by-label", { label: label })
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all product categories a product is part of using the request parameter productId.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/categories/search/find-by-product?productId=ba68427f-603c-4741-9185-3b379f7769b5' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json'
+    #
+    # @param product_id [String] the product UUID of the category
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @category = session.categories_view.search_by_product_id("ba68427f-603c-4741-9185-3b379f7769b5")
+    #
+    def search_by_product_id(product_id, params = {})
+      response, status = BeyondApi::Request.get(@session, "/product-view/categories/search/find-by-product", params.merge(product_id: product_id))
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to search for categories a new product will be part of using the request body. An existing product can also be part of the call. This endpoint can handle all properties a product can have.
+    # This request is read-only and cannot create data.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/categories/search/find-by-product' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json'
+    #       -d '{
+    #     "tags" : [ "books" ],
+    #     "manufacturer" : "The Standard Manufacturer",
+    #     "salesPrice" : {
+    #       "amount" : 10.0,
+    #       "currency" : "EUR"
+    #     }
+    #   }'
+    #
+    # @param product_id [String] the product UUID of the category
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @category = session.categories_view.search_by_product_id("ba68427f-603c-4741-9185-3b379f7769b5")
+    #
+    def search_by_product(body, params = {})
+      response, status = BeyondApi::Request.post(@session, "/product-view/categories/search/find-by-product", body, params)
+
+      handle_response(response, status = {})
+    end
+  end
+end

data/lib/beyond_api/resources/checkout_settings.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class CheckoutSettings < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to retrieve the checkout settings.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/checkout-settings' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +cset:r+
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @checkout_settiongs = session.checkout_settings.all
+    #
+    def all
+      response, status = BeyondApi::Request.get(@session, "/checkout-settings")
+
+      handle_response(response, status)
+    end
+
+    # A +PUT+ request is used to update the checkout settings.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/checkout-settings' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d ' {
+    #       "minimumOrderValue" : {
+    #         "currency" : "EUR",
+    #         "amount" : 50
+    #       },
+    #       "mustAcceptTermsAndConditions" : true
+    #   }'
+    def update(body)
+      response, status = BeyondApi::Request.put(@session, "/checkout-settings", body)
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/newsletter_target.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class NewsletterTarget < Base
+    include BeyondApi::Utils
+
+    #
+    # A +POST+ request is used to create the newsletter target. Each shop can only have one newsletter target.
+    # You can update this target at any time, or delete the existing one and create a new target.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/newsletter-target' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "submitUrl": "https://example.org/cgi-bin/subscribe.php"
+    #   }'
+    #
+    # @beyond_api.scopes +nltg:m+
+    #
+    # @param submit_url [String] the URL stating where to submit the newsletter
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   session.newsletter_target.create({ submit_url: "https://example.org/cgi-bin/subscribe.php" })
+    #
+    def create(submit_url)
+      response, status = BeyondApi::Request.post(@session, "/newsletter-target", { submit_url: submit_url})
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete the existing newsletter target.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/newsletter-target' -i -X DELETE \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +nltg:m+
+    #
+    # @return true
+    #
+    # @example
+    #   session.newsletter_target.delete
+    #
+    def delete
+      response, status = BeyondApi::Request.delete(@session, "/newsletter-target")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the newsletter target.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/newsletter-target' -i -X GET
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   session.newsletter_target.find
+    #
+    def find
+      response, status = BeyondApi::Request.get(@session, "/newsletter-target")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +PUT+ request is used to update the existing newsletter target
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/newsletter-target' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "submitUrl": "https://example.org/api/newsletter/subscription"
+    #   }'
+    #
+    # @beyond_api.scopes +nltg:m+
+    #
+    # @param submit_url [String] the URL stating where to submit the newsletter
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   session.newsletter_target.update({ submit_url: "https://example.org/cgi-bin/subscribe.php" })
+    #
+    def update(submit_url)
+      response, status = BeyondApi::Request.put(@session, "/newsletter-target", { submit_url: submit_url })
+
+      handle_response(response, status)
+    end
+  end
+end