beyond_api 0.1.0.pre

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  module ProductSearches
+
+    #
+    # A +GET+ request is used to search for a product by SKU.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/search/find-by-sku?sku=vino020' -i -X GET \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param sku [String] the product sku to search
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @product = session.product.search_by_sku("vino020")
+    #
+    def search_by_sku(sku)
+      response, status = BeyondApi::Request.get(@session, "/products/search/find-by-sku", sku: sku)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to search used tags by a starting string. All strings are sorted by usage, starting with the biggest.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/search/tags?startsWith=aw' -i -X GET \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param starts_with [String] the tag start to search
+    # @option param [Integer] :size the page size
+    # @option param [Integer] :page the page numbe
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @tags = session.product.search_tags_starting_by("aw")
+    #
+    def search_tags_starting_by(starts_with, params = {})
+      response, status = BeyondApi::Request.get(@session, "/products/search/tags", params.merge(starts_with: starts_with))
+
+      handle_response(response, status)
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  module ProductVariationProperties
+
+    #
+    # A +PATCH+ request is used to update the variation properties of a variation product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/51953b86-7ccc-4e80-acbd-1a2fc921fc2e/variation-properties' -i -X PATCH \
+    #       -H 'Content-Type: application/hal+json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '[ {
+    #     "property" : "salesPrice",
+    #     "enabled" : true
+    #     }, {
+    #       "property" : "listPrice",
+    #       "enabled" : true
+    #     }, {
+    #       "property" : "refPrice",
+    #       "enabled" : true
+    #     }, {
+    #       "property" : "manufacturerPrice",
+    #       "enabled" : true
+    #     }, {
+    #       "property" : "productIdentifiers",
+    #       "enabled" : true
+    #   } ]'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param product_id [String] the product UUID
+    # @param body [Array<Hash>] the request body
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = [{
+    #   	"property": "salesPrice",
+    #   	"enabled": true
+    #   }, {
+    #   	"property": "listPrice",
+    #   	"enabled": true
+    #   }, {
+    #   	"property": "refPrice",
+    #   	"enabled": true
+    #   }, {
+    #   	"property": "manufacturerPrice",
+    #   	"enabled": true
+    #   }, {
+    #   	"property": "productIdentifiers",
+    #   	"enabled": true
+    #   }]
+    #
+    #   @variation_properties = session.products.update_variation_properties("7f32696a-df56-4380-a91b-fffb97f025b4", body)
+    #
+    def update_variation_properties(product_id, body)
+      response, status = BeyondApi::Request.patch(@session, "/products/#{product_id}/variation-properties", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve the variation properties of a variation product.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/products/ea81446c-8fec-418c-8b3c-6e43fdee713a/variation-properties' -i -X GET \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +prod:r+
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @variation_properties = session.products.variation_properties("7f32696a-df56-4380-a91b-fffb97f025b4")
+    #
+    def variation_properties(product_id)
+      response, status = BeyondApi::Request.get(@session, "/products/#{product_id}/variation-properties")
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/products_view.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class ProductsView < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to list all products.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/products' -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
+    #   @products = session.product_view_products.all(page: 0, size: 100)
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/product-view/products")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to list all available tags.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/products/search/find-available-tags' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json'
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @tags = session.product_view_products.available_tags
+    #
+    def available_tags
+      response, status = BeyondApi::Request.get(@session, "/product-view/products/search/find-available-tags")
+
+      handle_response(response, status)
+    end
+
+    #
+    # TODO: To be documented.
+    # NOTE: 10.4 10.5 and 10.6 are the same call with different response.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/products/f75f8fb2-5a48-4d94-aad6-3d3692c06472' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json'
+    #
+    # @param product_id [String] the product UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @product = session.product_view_products.find("e3e86c45-de19-4179-87a4-f5f7756a0294")
+    #
+    def find(product_id)
+      response, status = BeyondApi::Request.get(@session, "/product-view/products/#{product_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to search for products using a query provided as request body.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/products/search/find-by-query' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -d '{ "query": {"bool":{"filter":[{"term":{"tags":"number0"}},{"range":{"salesPrice.amount":{"lte":8.7}}},{"range":{"createdAt":{"gte":"now-1h"}}}]}}, "sort": "name.keyword"}'
+    #
+    # @param query [String] the hash to search
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   body = {
+    #   	"query"=> {
+    #   		"bool"=> {
+    #   			"filter"=> [{
+    #   				"term"=> {
+    #   					"tags"=> "number0"
+    #   				}
+    #   			}, {
+    #   				"range"=> {
+    #   					"salesPrice.amount"=> {
+    #   						"lte"=> 8.7
+    #   					}
+    #   				}
+    #   			}, {
+    #   				"range"=> {
+    #   					"createdAt"=> {
+    #   						"gte"=> "now-1h"
+    #   					}
+    #   				}
+    #   			}]
+    #   		}
+    #   	},
+    #   	"sort"=> "name.keyword"
+    #   }
+    #   @products = session.product_view_products.search_by_query(body)
+    #
+    def search_by_query(query)
+      response, status = BeyondApi::Request.post(@session, "/product-view/products/search/find-by-query", body)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to search for products matching any tag of the list given by a client. The intention is to offer product search capabilities for a shop’s storefront.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/products/search/find-by-tags?tag=number0' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json'
+    #
+    # @param tag [String] the tag to search
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @products = session.product_view_products.search_by_tag("number0", page: 0, size: 100)
+    #
+    def search_by_tag(tag, params = {})
+      response, status = BeyondApi::Request.get(@session, "/product-view/products/search/find-by-tags", params.merge(tag: tag))
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to search for products matching any tag of the list given by a client. The intention is to offer product search capabilities for a shop’s storefront.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/product-view/products/search/find-by-term?query=search+snippet' -i -X GET \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json'
+    #
+    # @param term [String] the term to search
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @products = session.product_view_products.search_by_term("search snippet", page: 0, size: 100)
+    #
+    def search_by_term(term, params = {})
+      response, status = BeyondApi::Request.get(@session, "/product-view/products/search/find-by-term", params.merge(query: term))
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/scopes.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class Scopes < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request will list all scopes in the system.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/scopes' -i -X GET \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +scop:r+
+    #
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @scopes = session.scopes.all(size: 20, page: 0)
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/scopes", params)
+
+      handle_response(response, status)
+    end
+  end
+end

data/lib/beyond_api/resources/script_tags.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "beyond_api/utils"
+
+module BeyondApi
+  class ScriptTags < Base
+    include BeyondApi::Utils
+
+    #
+    # A +GET+ request is used to retrieve a list of all script tags for a shop.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/script-tags' -i -X GET \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @option params [Integer] :size the page size
+    # @option params [Integer] :page the page number
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @script_tags = session.script_tags.all(size: 20, page: 0)
+    #
+    def all(params = {})
+      response, status = BeyondApi::Request.get(@session, "/script-tags", params)
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +GET+ request is used to retrieve a single script tag.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/script-tags/df170ab1-13ae-4955-8b51-2478246acf59' -i -X GET \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @param script_tag_id [String] the script tag UUID
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @script_tag = session.script_tags.find("df170ab1-13ae-4955-8b51-2478246acf59")
+    #
+    def find(script_tag_id)
+      response, status = BeyondApi::Request.get(@session, "/script-tags/#{script_tag_id}")
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +POST+ request is used to create a script tag.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/script-tags' -i -X POST \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #       "scriptUrl": "https://example.org/js/fancy-script.js"
+    #   }'
+    #
+    # @beyond_api.scopes +sctg:m+
+    #
+    # @param script_tag_url [String] the url of the script
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @script_tag = session.script_tags.create("https://example.org/js/fancy-script.js")
+    #
+    def create(script_tag_url)
+      response, status = BeyondApi::Request.post(@session, "/script-tags", { script_url: script_tag_url })
+
+      handle_response(response, status)
+    end
+
+    #
+    # A +DELETE+ request is used to delete a script tag. You can only delete a script tag created by your app.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/script-tags/4a9f7776-d74d-4311-8ddb-121bd5407520' -i -X DELETE \
+    #       -H 'Authorization: Bearer <Access token>'
+    #
+    # @beyond_api.scopes +sctg:m+
+    #
+    # @param script_tag_id [String] the script tag UUID
+    #
+    # @return true
+    #
+    # @example
+    #   session.script_tags.delete("4a9f7776-d74d-4311-8ddb-121bd5407520")
+    #
+    def delete(script_tag_id)
+      response, status = BeyondApi::Request.delete(@session, "/script-tags/#{script_tag_id}")
+
+      handle_response(response, status, respond_with_true: true)
+    end
+
+    #
+    # A +PUT+ request is used to update an existing script tag. You can only update a script tag created by your app.
+    #
+    #   $ curl 'https://api-shop.beyondshop.cloud/api/script-tags/d6c7b3d2-4984-4fa6-b5f2-b0f5cfc63bd3' -i -X PUT \
+    #       -H 'Content-Type: application/json' \
+    #       -H 'Accept: application/hal+json' \
+    #       -H 'Authorization: Bearer <Access token>' \
+    #       -d '{
+    #     "scriptUrl": "https://example.org/scripts/someOtherScript.js"
+    #   }'
+    #
+    # @beyond_api.scopes +sctg:m+
+    #
+    # @param script_tag_id [String] the script tag UUID
+    # @param script_tag_url [String] the url of the script
+    #
+    # @return [OpenStruct]
+    #
+    # @example
+    #   @script_tag = session.script_tags.create("https://example.org/scripts/someOtherScript.js")
+    #
+    def update(script_tag_id, script_tag_url)
+      response, status = BeyondApi::Request.put(@session, "/script-tags/#{script_tag_id}", { script_url: script_tag_url })
+
+      handle_response(response, status)
+    end
+  end
+end