recombee_api_client 1.1.0 → 1.2.0

data/lib/recombee_api_client/api/delete_detail_view.rb

@@ -12,18 +12,26 @@ module RecombeeApiClient
   class DeleteDetailView < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who made the detail view.
   #   - +item_id+ -> ID of the item of which the details were viewed.
-  #   - +timestamp+ -> Unix timestamp of the detail view.
   #
-    def initialize(user_id, item_id, timestamp)
+  # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> Unix timestamp of the detail view. If the `timestamp` is omitted, then all the detail views with given `userId` and `itemId` are deleted.
+  #
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
+      @optional = optional
       @timeout = 1000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+      end
     end
   
     # HTTP method
@@ -43,7 +51,7 @@ module RecombeeApiClient
       params = {}
       params['userId'] = @user_id
       params['itemId'] = @item_id
-      params['timestamp'] = @timestamp
+      params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       params
     end
   
@@ -54,7 +62,11 @@ module RecombeeApiClient
   
     # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/detailviews/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p = "/{databaseId}/detailviews/?userId=#{@user_id}&itemId=#{@item_id}"
+      if @optional.include? 'timestamp'
+        p += (p.include? '?') ? '&' : '?'
+        p += "timestamp=#{@optional['timestamp']}"
+      end
       p
     end
   end

data/lib/recombee_api_client/api/delete_group.rb

@@ -14,6 +14,7 @@ module RecombeeApiClient
   class DeleteGroup < ApiRequest
     attr_reader :group_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -22,6 +23,7 @@ module RecombeeApiClient
     def initialize(group_id)
       @group_id = group_id
       @timeout = 1000
+      @ensure_https = false
     end
   
     # HTTP method

data/lib/recombee_api_client/api/delete_item.rb

@@ -16,6 +16,7 @@ module RecombeeApiClient
   class DeleteItem < ApiRequest
     attr_reader :item_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -24,6 +25,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/delete_item_property.rb

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

data/lib/recombee_api_client/api/delete_purchase.rb

@@ -12,18 +12,26 @@ module RecombeeApiClient
   class DeletePurchase < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who made the purchase.
   #   - +item_id+ -> ID of the item of which was purchased.
-  #   - +timestamp+ -> Unix timestamp of the purchase.
   #
-    def initialize(user_id, item_id, timestamp)
+  # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> Unix timestamp of the purchase. If the `timestamp` is omitted, then all the purchases with given `userId` and `itemId` are deleted.
+  #
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
+      @optional = optional
       @timeout = 1000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+      end
     end
   
     # HTTP method
@@ -43,7 +51,7 @@ module RecombeeApiClient
       params = {}
       params['userId'] = @user_id
       params['itemId'] = @item_id
-      params['timestamp'] = @timestamp
+      params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       params
     end
   
@@ -54,7 +62,11 @@ module RecombeeApiClient
   
     # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/purchases/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p = "/{databaseId}/purchases/?userId=#{@user_id}&itemId=#{@item_id}"
+      if @optional.include? 'timestamp'
+        p += (p.include? '?') ? '&' : '?'
+        p += "timestamp=#{@optional['timestamp']}"
+      end
       p
     end
   end

data/lib/recombee_api_client/api/delete_rating.rb

@@ -12,18 +12,26 @@ module RecombeeApiClient
   class DeleteRating < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who rated the item.
   #   - +item_id+ -> ID of the item which was rated.
-  #   - +timestamp+ -> Unix timestamp of the rating.
   #
-    def initialize(user_id, item_id, timestamp)
+  # * *Optional arguments (given as hash optional)*
+  #   - +timestamp+ -> Unix timestamp of the rating. If the `timestamp` is omitted, then all the ratings with given `userId` and `itemId` are deleted.
+  #
+    def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      @timestamp = timestamp
+      @timestamp = optional['timestamp']
+      @optional = optional
       @timeout = 1000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+      end
     end
   
     # HTTP method
@@ -43,7 +51,7 @@ module RecombeeApiClient
       params = {}
       params['userId'] = @user_id
       params['itemId'] = @item_id
-      params['timestamp'] = @timestamp
+      params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
       params
     end
   
@@ -54,7 +62,11 @@ module RecombeeApiClient
   
     # Relative path to the endpoint including query parameters
     def path
-      p = "/{databaseId}/ratings/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p = "/{databaseId}/ratings/?userId=#{@user_id}&itemId=#{@item_id}"
+      if @optional.include? 'timestamp'
+        p += (p.include? '?') ? '&' : '?'
+        p += "timestamp=#{@optional['timestamp']}"
+      end
       p
     end
   end

data/lib/recombee_api_client/api/delete_series.rb

@@ -14,6 +14,7 @@ module RecombeeApiClient
   class DeleteSeries < ApiRequest
     attr_reader :series_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -22,6 +23,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/delete_user.rb

@@ -14,6 +14,7 @@ module RecombeeApiClient
   class DeleteUser < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -22,6 +23,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/get_item_property_info.rb

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

data/lib/recombee_api_client/api/get_item_values.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class GetItemValues < ApiRequest
     attr_reader :item_id
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -21,6 +22,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/insert_to_group.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class InsertToGroup < ApiRequest
     attr_reader :group_id, :item_type, :item_id, :cascade_create
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -29,6 +30,7 @@ module RecombeeApiClient
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
+      @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
       end

data/lib/recombee_api_client/api/insert_to_series.rb

@@ -12,6 +12,7 @@ module RecombeeApiClient
   class InsertToSeries < ApiRequest
     attr_reader :series_id, :item_type, :item_id, :time, :cascade_create
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -31,6 +32,7 @@ module RecombeeApiClient
       @cascade_create = optional['cascadeCreate']
       @optional = optional
       @timeout = 1000
+      @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
       end

data/lib/recombee_api_client/api/item_based_recommendation.rb

@@ -10,8 +10,9 @@ module RecombeeApiClient
   #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_reader :item_id, :count, :target_user_id, :user_impact, :filter, :booster, :allow_nonexistent, :cascade_create, :scenario, :diversity, :min_relevance, :rotation_rate, :rotation_time
     attr_accessor :timeout
+    attr_accessor :ensure_https
   
   ##
   # * *Required arguments*
@@ -24,7 +25,9 @@ module RecombeeApiClient
   #
   #   - +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+ -> Instead of causing HTTP 404 error, returns some (non-personalized) recommendations if either item of given *itemId* or user of given *targetUserId* does not exist in the database. It creates neither of the missing entities in the database.
+  #   - +cascadeCreate+ -> If item of given *itemId* or user of given *targetUserId* doesn't exist in the database, it creates the missing enity/entities and returns some (non-personalized) recommendations. This allows for example rotations in the following recommendations for the user of given *targetUserId*, 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.
@@ -42,14 +45,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 ["targetUserId","userImpact","filter","booster","allowNonexistent","diversity","minRelevance","rotationRate","rotationTime"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["targetUserId","userImpact","filter","booster","allowNonexistent","cascadeCreate","scenario","diversity","minRelevance","rotationRate","rotationTime"].include? par
       end
     end
   
@@ -74,6 +80,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']
@@ -109,6 +117,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/api/list_group_items.rb

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

data/lib/recombee_api_client/api/list_groups.rb

@@ -11,11 +11,13 @@ module RecombeeApiClient
   class ListGroups < 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_bookmarks.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListItemBookmarks < 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_cart_additions.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListItemCartAdditions < 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_detail_views.rb

@@ -11,6 +11,7 @@ module RecombeeApiClient
   class ListItemDetailViews < 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