Added parameters amount,price,profit to AddPurchase and amount,price to AddCartAddition

Author: OndraFiedler

lib/recombee_api_client.rb

@@ -18,7 +18,7 @@ class RecombeeClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/1.5.0'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/1.6.0'}
 
     ##
     #   - +account+ -> Name of your account at Recombee

lib/recombee_api_client/api/add_cart_addition.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   #Adds a cart addition of a given item made by a given user.
   #
   class AddCartAddition < ApiRequest
-    attr_reader :user_id, :item_id, :timestamp, :cascade_create
+    attr_reader :user_id, :item_id, :timestamp, :cascade_create, :amount, :price
     attr_accessor :timeout
     attr_accessor :ensure_https
 
@@ -22,17 +22,21 @@ class AddCartAddition < ApiRequest
   # * *Optional arguments (given as hash optional)*
   #   - +timestamp+ -> UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
   #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+  #   - +amount+ -> Amount (number) added to cart. The default is 1. For example if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal to 2.
+  #   - +price+ -> Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
   #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
+      @amount = optional['amount']
+      @price = optional['price']
       @optional = optional
       @timeout = 1000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price"].include? par
       end
     end
 
@@ -48,6 +52,8 @@ def body_parameters
       p['itemId'] = @item_id
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['amount'] = @optional['amount'] if @optional.include? 'amount'
+      p['price'] = @optional['price'] if @optional.include? 'price'
       p
     end
 

lib/recombee_api_client/api/add_item_property.rb

@@ -24,7 +24,7 @@ class AddItemProperty < ApiRequest
     def initialize(property_name, type)
       @property_name = property_name
       @type = type
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/add_purchase.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   #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_reader :user_id, :item_id, :timestamp, :cascade_create, :amount, :price, :profit
     attr_accessor :timeout
     attr_accessor :ensure_https
 
@@ -22,17 +22,23 @@ class AddPurchase < ApiRequest
   # * *Optional arguments (given as hash optional)*
   #   - +timestamp+ -> UTC timestamp of the purchase as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
   #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+  #   - +amount+ -> Amount (number) of purchased items. The default is 1. For example if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal to 2.
+  #   - +price+ -> Price paid by the user for the item. If `amount` is greater than 1, sum of prices of all the items should be given.
+  #   - +profit+ -> Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.
   #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
+      @amount = optional['amount']
+      @price = optional['price']
+      @profit = optional['profit']
       @optional = optional
       @timeout = 1000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate"].include? par
+        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","profit"].include? par
       end
     end
 
@@ -48,6 +54,9 @@ def body_parameters
       p['itemId'] = @item_id
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['amount'] = @optional['amount'] if @optional.include? 'amount'
+      p['price'] = @optional['price'] if @optional.include? 'price'
+      p['profit'] = @optional['profit'] if @optional.include? 'profit'
       p
     end
 

lib/recombee_api_client/api/add_user_property.rb

@@ -24,7 +24,7 @@ class AddUserProperty < ApiRequest
     def initialize(property_name, type)
       @property_name = property_name
       @type = type
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/delete_item_property.rb

@@ -20,7 +20,7 @@ class DeleteItemProperty < ApiRequest
   #
     def initialize(property_name)
       @property_name = property_name
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/delete_user_property.rb

@@ -20,7 +20,7 @@ class DeleteUserProperty < ApiRequest
   #
     def initialize(property_name)
       @property_name = property_name
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/get_user_property_info.rb

@@ -20,7 +20,7 @@ class GetUserPropertyInfo < ApiRequest
   #
     def initialize(property_name)
       @property_name = property_name
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/list_group_items.rb

@@ -19,7 +19,7 @@ class ListGroupItems < ApiRequest
   #
     def initialize(group_id)
       @group_id = group_id
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/list_groups.rb

@@ -16,7 +16,7 @@ class ListGroups < ApiRequest
   ##
   #
     def initialize()
-      @timeout = 239000
+      @timeout = 100000
       @ensure_https = false
     end