Contents

# 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

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
beyond_api-0.19.0.pre	lib/beyond_api/resources/products/searches.rb
beyond_api-0.18.2.pre	lib/beyond_api/resources/products/searches.rb