recombee_api_client 1.1.0 → 1.2.0

data/lib/recombee_api_client/api/list_item_properties.rb

@@ -12,11 +12,13 @@ module RecombeeApiClient
   class ListItemProperties < ApiRequest
   
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   #
     def initialize()
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/list_item_purchases.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListItemPurchases < ApiRequest
     attr_reader :item_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -20,6 +21,7 @@ module RecombeeApiClient
     def initialize(item_id)
       @item_id = item_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/list_item_ratings.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListItemRatings < ApiRequest
     attr_reader :item_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -20,6 +21,7 @@ module RecombeeApiClient
     def initialize(item_id)
       @item_id = item_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/list_items.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListItems < ApiRequest
     attr_reader :filter
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   #
@@ -21,6 +22,7 @@ module RecombeeApiClient
       @filter = optional['filter']
       @optional = optional
       @timeout = 1000
+      @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["filter"].include? par
       end

data/lib/recombee_api_client/api/list_series.rb

@@ -11,11 +11,13 @@ module RecombeeApiClient
   class ListSeries < ApiRequest
   
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   #
     def initialize()
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/list_series_items.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListSeriesItems < ApiRequest
     attr_reader :series_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -19,6 +20,7 @@ module RecombeeApiClient
     def initialize(series_id)
       @series_id = series_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/list_user_bookmarks.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListUserBookmarks < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -19,6 +20,7 @@ module RecombeeApiClient
     def initialize(user_id)
       @user_id = user_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/list_user_cart_additions.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListUserCartAdditions < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -19,6 +20,7 @@ module RecombeeApiClient
     def initialize(user_id)
       @user_id = user_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/list_user_detail_views.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListUserDetailViews < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -19,6 +20,7 @@ module RecombeeApiClient
     def initialize(user_id)
       @user_id = user_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/list_user_purchases.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListUserPurchases < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -19,6 +20,7 @@ module RecombeeApiClient
     def initialize(user_id)
       @user_id = user_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/list_user_ratings.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListUserRatings < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -19,6 +20,7 @@ module RecombeeApiClient
     def initialize(user_id)
       @user_id = user_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/list_users.rb

@@ -11,11 +11,13 @@ module RecombeeApiClient
   class ListUsers < ApiRequest
   
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   #
     def initialize()
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/merge_users.rb

@@ -15,6 +15,7 @@ module RecombeeApiClient
   class MergeUsers < ApiRequest
     attr_reader :target_user_id, :source_user_id, :keep_source_user
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -30,6 +31,7 @@ module RecombeeApiClient
       @keep_source_user = optional['keepSourceUser']
       @optional = optional
       @timeout = 1000
+      @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["keepSourceUser"].include? par
       end

data/lib/recombee_api_client/api/remove_from_group.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class RemoveFromGroup < ApiRequest
     attr_reader :group_id, :item_type, :item_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -23,6 +24,7 @@ module RecombeeApiClient
       @item_type = item_type
       @item_id = item_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/remove_from_series.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class RemoveFromSeries < ApiRequest
     attr_reader :series_id, :item_type, :item_id, :time
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -25,6 +26,7 @@ module RecombeeApiClient
       @item_id = item_id
       @time = time
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/reset_database.rb

@@ -12,11 +12,13 @@ module RecombeeApiClient
   class ResetDatabase < ApiRequest
   
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   #
     def initialize()
-      @timeout = 3000
+      @timeout = 5000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/set_item_values.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class SetItemValues < ApiRequest
     attr_reader :item_id, :values
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -35,6 +36,7 @@ module RecombeeApiClient
       @item_id = item_id
       @values = values
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/user_based_recommendation.rb

@@ -10,8 +10,9 @@ module RecombeeApiClient
   #Based on user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for a given user.
   #
   class UserBasedRecommendation < ApiRequest
-    attr_reader :user_id, :count, :filter, :booster, :allow_nonexistent, :diversity, :min_relevance, :rotation_rate, :rotation_time
+    attr_reader :user_id, :count, :filter, :booster, :allow_nonexistent, :cascade_create, :scenario, :diversity, :min_relevance, :rotation_rate, :rotation_time
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -21,7 +22,9 @@ module RecombeeApiClient
   # * *Optional arguments (given as hash optional)*
   #   - +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.
+  #   - +allowNonexistent+ -> If the user does not exist in the database, returns a list of non-personalized recommendations instead of causing HTTP 404 error. It doesn't create the user in the database.
+  #   - +cascadeCreate+ -> If the user does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows for example rotations in the following recommendations for that user, as the user will be already known to the system.
+  #   - +scenario+ -> Scenario defines a particular application of recommendations. It can be for example "homepage" or "cart". The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
   #   - +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.
@@ -37,14 +40,17 @@ module RecombeeApiClient
       @filter = optional['filter']
       @booster = optional['booster']
       @allow_nonexistent = optional['allowNonexistent']
+      @cascade_create = optional['cascadeCreate']
+      @scenario = optional['scenario']
       @diversity = optional['diversity']
       @min_relevance = optional['minRelevance']
       @rotation_rate = optional['rotationRate']
       @rotation_time = optional['rotationTime']
       @optional = optional
       @timeout = 3000
+      @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["filter","booster","allowNonexistent","diversity","minRelevance","rotationRate","rotationTime"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["filter","booster","allowNonexistent","cascadeCreate","scenario","diversity","minRelevance","rotationRate","rotationTime"].include? par
       end
     end
   
@@ -67,6 +73,8 @@ module RecombeeApiClient
       params['filter'] = @optional['filter'] if @optional['filter']
       params['booster'] = @optional['booster'] if @optional['booster']
       params['allowNonexistent'] = @optional['allowNonexistent'] if @optional['allowNonexistent']
+      params['cascadeCreate'] = @optional['cascadeCreate'] if @optional['cascadeCreate']
+      params['scenario'] = @optional['scenario'] if @optional['scenario']
       params['diversity'] = @optional['diversity'] if @optional['diversity']
       params['minRelevance'] = @optional['minRelevance'] if @optional['minRelevance']
       params['rotationRate'] = @optional['rotationRate'] if @optional['rotationRate']
@@ -94,6 +102,14 @@ module RecombeeApiClient
         p += (p.include? '?') ? '&' : '?'
         p += "allowNonexistent=#{@optional['allowNonexistent']}"
       end
+      if @optional.include? 'cascadeCreate'
+        p += (p.include? '?') ? '&' : '?'
+        p += "cascadeCreate=#{@optional['cascadeCreate']}"
+      end
+      if @optional.include? 'scenario'
+        p += (p.include? '?') ? '&' : '?'
+        p += "scenario=#{@optional['scenario']}"
+      end
       if @optional.include? 'diversity'
         p += (p.include? '?') ? '&' : '?'
         p += "diversity=#{@optional['diversity']}"

data/lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ondřej Fiedler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json