recombee_api_client 0.1.0

data/lib/recombee_api_client/api/add_item.rb

@@ -0,0 +1,56 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Adds new item of given `itemId` to the items catalog.
+  #
+  #All the item properties for the newly created items are set null.
+  #
+  class AddItem < ApiRequest
+    attr_reader :item_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +item_id+ -> ID of the item to be created.
+  #
+    def initialize(item_id)
+      @item_id = item_id
+      @timeout = 1000
+    end
+  
+    # HTTP method
+    def method
+      :put
+    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/add_item_property.rb

@@ -0,0 +1,59 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Adding an item property is somehow equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.
+  #
+  class AddItemProperty < ApiRequest
+    attr_reader :property_name, :type
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +property_name+ -> Name of the item property to be created. Currently, the following names are reserved:`id`, `itemid`, case insensitively. Also, the length of the property name must not exceed 63 characters.
+  #
+  #   - +type+ -> Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`
+  #
+  #
+    def initialize(property_name, type)
+      @property_name = property_name
+      @type = type
+      @timeout = 1000
+    end
+  
+    # HTTP method
+    def method
+      :put
+    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['type'] = @type
+      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}?type=#{@type}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/add_purchase.rb

@@ -0,0 +1,70 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Adds a purchase of a given item made by a given user.
+  #
+  class AddPurchase < ApiRequest
+    attr_reader :user_id, :item_id, :timestamp, :cascade_create
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> User who purchased the item
+  #   - +item_id+ -> Purchased item
+  #   - +timestamp+ -> Unix timestamp of the purchase. If you don't have the timestamp value available, you may use some artificial value, such as 0. It is preferable, however, to provide the timestamp whenever possible as the user's preferences may evolve over time.
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+  #
+    def initialize(user_id, item_id, timestamp, optional = {})
+      @user_id = user_id
+      @item_id = item_id
+      @timestamp = timestamp
+      @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['userId'] = @user_id
+      p['itemId'] = @item_id
+      p['timestamp'] = @timestamp
+      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}/purchases/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/purchases/"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/add_rating.rb

@@ -0,0 +1,73 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Adds a rating of given item made by a given user.
+  #
+  class AddRating < ApiRequest
+    attr_reader :user_id, :item_id, :timestamp, :rating, :cascade_create
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> User who submitted the rating
+  #   - +item_id+ -> Rated item
+  #   - +timestamp+ -> Unix timestamp of the rating. If you don't have the timestamp value available, you may use some artificial value, such as 0. It is preferable, however, to provide the timestamp whenever possible as the user's preferences may evolve over time.
+  #   - +rating+ -> Rating rescaled to interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating. For example, in the case of 5-star evaluations, rating = (numStars-3)/2 formula may be used for the conversion.
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+  #
+    def initialize(user_id, item_id, timestamp, rating, optional = {})
+      @user_id = user_id
+      @item_id = item_id
+      @timestamp = timestamp
+      @rating = rating
+      @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['userId'] = @user_id
+      p['itemId'] = @item_id
+      p['timestamp'] = @timestamp
+      p['rating'] = @rating
+      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}/ratings/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/ratings/"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/add_series.rb

@@ -0,0 +1,53 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Creates new series in the database.
+  class AddSeries < ApiRequest
+    attr_reader :series_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +series_id+ -> ID of the series to be created.
+  #
+    def initialize(series_id)
+      @series_id = series_id
+      @timeout = 1000
+    end
+  
+    # HTTP method
+    def method
+      :put
+    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}/series/#{@series_id}"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/series/#{@series_id}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/add_user.rb

@@ -0,0 +1,54 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Adds a new user to the database.
+  #
+  class AddUser < 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
+      :put
+    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/batch.rb

@@ -0,0 +1,64 @@
+require 'json'
+require 'cgi'
+require_relative 'request'
+
+module RecombeeApiClient
+  ##
+  # Batch processing allows you to submit arbitrary sequence of requests
+  #
+  class Batch < ApiRequest
+    attr_reader :requests
+    attr_accessor :timeout
+    ##
+    # * *Required arguments*
+    #   - +requests+ -> Array of API requests.
+    #
+    def initialize(requests)
+      @requests = requests
+      @body_parameters = requests_to_batch_hash
+      @timeout = requests.map{|r| r.timeout}.reduce(:+)
+    end
+
+    # HTTP method
+    def method
+      :post
+    end
+
+    # Values of body parameters as a Hash
+    attr_reader :body_parameters
+
+    # Get values of parameters in form a Hash.
+    # name of parameter => value of the parameter
+    def params_hash
+    end
+
+    # Relative path to the endpoint
+    def path
+      p = '/{databaseId}/batch/'
+      p
+    end
+
+    private
+
+    def requests_to_batch_hash
+      reqs = []
+      @requests.each { |r| reqs.push(request_to_batch_hash r) }
+      {'requests' => reqs}
+    end
+
+    def request_to_batch_hash(req)
+      path = req.basic_path
+      path.slice! ('/{databaseId}')
+      bh = {
+        'method' => req.method.to_s.upcase,
+        'path' => path
+      }
+      params = req.query_parameters
+      if req.body_parameters
+        params = params.merge(req.body_parameters)
+      end
+      bh['params'] = params if params.size > 0
+      bh
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_bookmark.rb

@@ -0,0 +1,61 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes a bookmark uniquely specified by `userId`, `itemId`, and `timestamp`.
+  #
+  class DeleteBookmark < ApiRequest
+    attr_reader :user_id, :item_id, :timestamp
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user who made the bookmark.
+  #   - +item_id+ -> ID of the item of which was bookmarked.
+  #   - +timestamp+ -> Unix timestamp of the bookmark.
+  #
+    def initialize(user_id, item_id, timestamp)
+      @user_id = user_id
+      @item_id = item_id
+      @timestamp = timestamp
+      @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['userId'] = @user_id
+      params['itemId'] = @item_id
+      params['timestamp'] = @timestamp
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/bookmarks/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/bookmarks/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p
+    end
+  end
+end