recombee_api_client 0.1.0

data/lib/recombee_api_client/api/list_series_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 series, sorted according to their time index values.
+  class ListSeriesItems < ApiRequest
+    attr_reader :series_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +series_id+ -> ID of the series items of which are to be listed.
+  #
+    def initialize(series_id)
+      @series_id = series_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}/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/list_user_bookmarks.rb

@@ -0,0 +1,53 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #List all the bookmarks ever made by a given user.
+  class ListUserBookmarks < ApiRequest
+    attr_reader :user_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user whose bookmarks are to be listed.
+  #
+    def initialize(user_id)
+      @user_id = user_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}/users/#{@user_id}/bookmarks/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/users/#{@user_id}/bookmarks/"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/list_user_cart_additions.rb

@@ -0,0 +1,53 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #List all the cart additions ever made by a given user.
+  class ListUserCartAdditions < ApiRequest
+    attr_reader :user_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user whose cart additions are to be listed.
+  #
+    def initialize(user_id)
+      @user_id = user_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}/users/#{@user_id}/cartadditions/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/users/#{@user_id}/cartadditions/"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/list_user_detail_views.rb

@@ -0,0 +1,53 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Lists all the detail views of different items ever made by a given user.
+  class ListUserDetailViews < ApiRequest
+    attr_reader :user_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user whose detail views are to be listed.
+  #
+    def initialize(user_id)
+      @user_id = user_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}/users/#{@user_id}/detailviews/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/users/#{@user_id}/detailviews/"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/list_user_purchases.rb

@@ -0,0 +1,53 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #List all the purchases ever made by a given user.
+  class ListUserPurchases < ApiRequest
+    attr_reader :user_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user whose purchases are to be listed.
+  #
+    def initialize(user_id)
+      @user_id = user_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}/users/#{@user_id}/purchases/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/users/#{@user_id}/purchases/"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/list_user_ratings.rb

@@ -0,0 +1,53 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #List all the ratings ever submitted by a given user.
+  class ListUserRatings < ApiRequest
+    attr_reader :user_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user whose ratings are to be listed.
+  #
+    def initialize(user_id)
+      @user_id = user_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}/users/#{@user_id}/ratings/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/users/#{@user_id}/ratings/"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/list_users.rb

@@ -0,0 +1,50 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Gets a list of IDs of users currently present in the catalog.
+  class ListUsers < ApiRequest
+  
+    attr_accessor :timeout
+  
+  ##
+  #
+    def initialize()
+      @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}/users/list/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/users/list/"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/merge_users.rb

@@ -0,0 +1,72 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Merges purchases, ratings, bookmarks, and detail views of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.
+  #
+  #
+  #Merging happens between two users referred to as the *source* and the *target*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted** unless special parameter `keepSourceUser` is set `true`.
+  #
+  class MergeUsers < ApiRequest
+    attr_reader :target_user_id, :source_user_id, :keep_source_user
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +target_user_id+ -> ID of the source user.
+  #   - +source_user_id+ -> ID of the target user.
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +keepSourceUser+ -> If true, the source user will not be deleted, but also kept in the database..
+  #
+    def initialize(target_user_id, source_user_id, optional = {})
+      @target_user_id = target_user_id
+      @source_user_id = source_user_id
+      @keep_source_user = optional['keepSourceUser']
+      @optional = optional
+      @timeout = 1000
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["keepSourceUser"].include? par
+      end
+    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['keepSourceUser'] = @optional['keepSourceUser'] if @optional['keepSourceUser']
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/users/#{@target_user_id}/merge/#{@source_user_id}"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/users/#{@target_user_id}/merge/#{@source_user_id}"
+      if @optional.include? 'keepSourceUser'
+        p += (p.include? '?') ? '&' : '?'
+        p += "keepSourceUser=#{@optional['keepSourceUser']}"
+      end
+      p
+    end
+  end
+end