recombee_api_client 0.1.0

data/lib/recombee_api_client/api/delete_user.rb

@@ -0,0 +1,56 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes a user of given *userId* from the database.
+  #
+  #If there are any purchases, ratings, bookmarks, cart additions or detail views made by the user present in the database, they will be deleted in cascade as well.
+  #
+  class DeleteUser < ApiRequest
+    attr_reader :user_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user to be added.
+  #
+    def initialize(user_id)
+      @user_id = user_id
+      @timeout = 1000
+    end
+  
+    # HTTP method
+    def method
+      :delete
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/users/#{@user_id}"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/users/#{@user_id}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/get_item_property_info.rb

@@ -0,0 +1,54 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Gets information about specified item property.
+  #
+  class GetItemPropertyInfo < ApiRequest
+    attr_reader :property_name
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +property_name+ -> Name of the property about which the information is to be retrieved.
+  #
+    def initialize(property_name)
+      @property_name = property_name
+      @timeout = 1000
+    end
+  
+    # HTTP method
+    def method
+      :get
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/items/properties/#{@property_name}"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/items/properties/#{@property_name}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/get_item_values.rb

@@ -0,0 +1,55 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Get all the current property values of a given item.
+  #
+  class GetItemValues < ApiRequest
+    attr_reader :item_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +item_id+ -> ID of the item properties of which are to be obtained.
+  #
+  #
+    def initialize(item_id)
+      @item_id = item_id
+      @timeout = 1000
+    end
+  
+    # HTTP method
+    def method
+      :get
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/items/#{@item_id}"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/items/#{@item_id}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/insert_to_group.rb

@@ -0,0 +1,69 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Inserts an existing item/group into group of given `groupId`.
+  #
+  class InsertToGroup < ApiRequest
+    attr_reader :group_id, :item_type, :item_id, :cascade_create
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +group_id+ -> ID of the group to be inserted into.
+  #   - +item_type+ -> `item` iff the regular item from the catalog is to be inserted, `group` iff group is inserted as the item.
+  #   - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the group iff `itemType` is `group`.
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.
+  #
+    def initialize(group_id, item_type, item_id, optional = {})
+      @group_id = group_id
+      @item_type = item_type
+      @item_id = item_id
+      @cascade_create = optional['cascadeCreate']
+      @optional = optional
+      @timeout = 1000
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['itemType'] = @item_type
+      p['itemId'] = @item_id
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
+      p
+    end
+  
+    # Values of query path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/groups/#{@group_id}/items/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/groups/#{@group_id}/items/"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/insert_to_series.rb

@@ -0,0 +1,72 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Inserts an existing item/series into series of given seriesId at position determined by time.
+  #
+  class InsertToSeries < ApiRequest
+    attr_reader :series_id, :item_type, :item_id, :time, :cascade_create
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +series_id+ -> ID of the series to be inserted into.
+  #   - +item_type+ -> `item` iff the regular item from the catalog is to be inserted, `series` iff series is inserted as the item.
+  #   - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.
+  #   - +time+ -> Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.
+  #
+    def initialize(series_id, item_type, item_id, time, optional = {})
+      @series_id = series_id
+      @item_type = item_type
+      @item_id = item_id
+      @time = time
+      @cascade_create = optional['cascadeCreate']
+      @optional = optional
+      @timeout = 1000
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['itemType'] = @item_type
+      p['itemId'] = @item_id
+      p['time'] = @time
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
+      p
+    end
+  
+    # Values of query path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/series/#{@series_id}/items/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/series/#{@series_id}/items/"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/item_based_recommendation.rb

@@ -0,0 +1,131 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Recommends set of items that are somehow related to one given item, *X*. Typical scenario for using item-based recommendation is when user *A* is viewing *X*. Then you may display items to the user that he might be also interested in. Item-recommendation request gives you Top-N such items, optionally taking the target user *A* into account.
+  #
+  class ItemBasedRecommendation < ApiRequest
+    attr_reader :item_id, :count, :target_user_id, :user_impact, :filter, :booster, :allow_nonexistent, :diversity, :min_relevance, :rotation_rate, :rotation_time
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +item_id+ -> ID of the item recommendations for which are to be generated.
+  #   - +count+ -> Number of items to be recommended (N for the top-N recommendation).
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +targetUserId+ -> ID of the user who will see the recommendations.
+  #   - +userImpact+ -> If *targetUserId* parameter is present, the recommendations are biased towards the user given. Using *userImpact*, you may control this bias. For an extreme case of `userImpact=0.0`, the interactions made by the user are not taken into account at all (with the exception of history-based blacklisting), for `userImpact=1.0`, you'll get user-based recommendation. The default value is `0.1`
+  #
+  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended items based on the values of their attributes.
+  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some items based on the values of their attributes.
+  #   - +allowNonexistent+ -> If the user does not exist in the database, returns a list of non-personalized recommendations instead of causing HTTP 404 error.
+  #   - +diversity+ -> **Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended items be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
+  #
+  #   - +minRelevance+ -> **Expert option** Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to *count* at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested qualit, and may return less than *count* items when there is not enough data to fulfill it.
+  #
+  #   - +rotationRate+ -> **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items.
+  #
+  #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to fully recover from the penalization. By example, `rotationTime=7200.0` means that items recommended more than 2 hours ago are definitely not penalized anymore. Currently, the penalization is linear, so for `rotationTime=7200.0`, an item is still penalized by `0.5` to the user after 1 hour. |
+  #
+  #
+    def initialize(item_id, count, optional = {})
+      @item_id = item_id
+      @count = count
+      @target_user_id = optional['targetUserId']
+      @user_impact = optional['userImpact']
+      @filter = optional['filter']
+      @booster = optional['booster']
+      @allow_nonexistent = optional['allowNonexistent']
+      @diversity = optional['diversity']
+      @min_relevance = optional['minRelevance']
+      @rotation_rate = optional['rotationRate']
+      @rotation_time = optional['rotationTime']
+      @optional = optional
+      @timeout = 3000
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["targetUserId","userImpact","filter","booster","allowNonexistent","diversity","minRelevance","rotationRate","rotationTime"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :get
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params['count'] = @count
+      params['targetUserId'] = @optional['targetUserId'] if @optional['targetUserId']
+      params['userImpact'] = @optional['userImpact'] if @optional['userImpact']
+      params['filter'] = @optional['filter'] if @optional['filter']
+      params['booster'] = @optional['booster'] if @optional['booster']
+      params['allowNonexistent'] = @optional['allowNonexistent'] if @optional['allowNonexistent']
+      params['diversity'] = @optional['diversity'] if @optional['diversity']
+      params['minRelevance'] = @optional['minRelevance'] if @optional['minRelevance']
+      params['rotationRate'] = @optional['rotationRate'] if @optional['rotationRate']
+      params['rotationTime'] = @optional['rotationTime'] if @optional['rotationTime']
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/items/#{@item_id}/recomms/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/items/#{@item_id}/recomms/?count=#{@count}"
+      if @optional.include? 'targetUserId'
+        p += (p.include? '?') ? '&' : '?'
+        p += "targetUserId=#{@optional['targetUserId']}"
+      end
+      if @optional.include? 'userImpact'
+        p += (p.include? '?') ? '&' : '?'
+        p += "userImpact=#{@optional['userImpact']}"
+      end
+      if @optional.include? 'filter'
+        p += (p.include? '?') ? '&' : '?'
+        p += "filter=#{@optional['filter']}"
+      end
+      if @optional.include? 'booster'
+        p += (p.include? '?') ? '&' : '?'
+        p += "booster=#{@optional['booster']}"
+      end
+      if @optional.include? 'allowNonexistent'
+        p += (p.include? '?') ? '&' : '?'
+        p += "allowNonexistent=#{@optional['allowNonexistent']}"
+      end
+      if @optional.include? 'diversity'
+        p += (p.include? '?') ? '&' : '?'
+        p += "diversity=#{@optional['diversity']}"
+      end
+      if @optional.include? 'minRelevance'
+        p += (p.include? '?') ? '&' : '?'
+        p += "minRelevance=#{@optional['minRelevance']}"
+      end
+      if @optional.include? 'rotationRate'
+        p += (p.include? '?') ? '&' : '?'
+        p += "rotationRate=#{@optional['rotationRate']}"
+      end
+      if @optional.include? 'rotationTime'
+        p += (p.include? '?') ? '&' : '?'
+        p += "rotationTime=#{@optional['rotationTime']}"
+      end
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/list_group_items.rb

@@ -0,0 +1,53 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #List all the items present in the given group.
+  class ListGroupItems < ApiRequest
+    attr_reader :group_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +group_id+ -> ID of the group items of which are to be listed.
+  #
+    def initialize(group_id)
+      @group_id = group_id
+      @timeout = 1000
+    end
+  
+    # HTTP method
+    def method
+      :get
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/groups/#{@group_id}/items/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/groups/#{@group_id}/items/"
+      p
+    end
+  end
+end