Release: v5.0.0

- Support new Recommend Items to Item Segment endpoint
- Series API improvements:
	- Add Series endpoint creates associated Item for the Series automatically (based on the cascadeCreate parameter)
	- Breaking change: Remove From Series no longer requires the time parameter
- Removed deprecated Groups endpoints

Author: OndraFiedler

README.md

@@ -177,4 +177,4 @@ rescue ApiTimeout => e
 rescue APIError => e
   # APIError is parent of both ResponseError and ApiTimeout
 end
-```
+```

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/4.1.0'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/5.0.0'}
 
     ##
     #   - +account+ -> Name of your account at Recombee

lib/recombee_api_client/api/add_bookmark.rb

@@ -34,7 +34,7 @@ def initialize(user_id, item_id, optional = {})
       @recomm_id = optional['recommId']
       @additional_data = optional['additionalData']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","recommId","additionalData"].include? par

lib/recombee_api_client/api/add_cart_addition.rb

@@ -38,7 +38,7 @@ def initialize(user_id, item_id, optional = {})
       @recomm_id = optional['recommId']
       @additional_data = optional['additionalData']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","recommId","additionalData"].include? par

lib/recombee_api_client/api/add_detail_view.rb

@@ -36,7 +36,7 @@ def initialize(user_id, item_id, optional = {})
       @recomm_id = optional['recommId']
       @additional_data = optional['additionalData']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp","duration","cascadeCreate","recommId","additionalData"].include? par

lib/recombee_api_client/api/add_group.rb

@@ -22,7 +22,7 @@ class AddItem < ApiRequest
   #
     def initialize(item_id)
       @item_id = item_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/add_item.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   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.
+  #Adding an item property is somewhat 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

lib/recombee_api_client/api/add_item_property.rb

@@ -40,7 +40,7 @@ def initialize(user_id, item_id, optional = {})
       @recomm_id = optional['recommId']
       @additional_data = optional['additionalData']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","profit","recommId","additionalData"].include? par

lib/recombee_api_client/api/add_purchase.rb

@@ -36,7 +36,7 @@ def initialize(user_id, item_id, rating, optional = {})
       @recomm_id = optional['recommId']
       @additional_data = optional['additionalData']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","recommId","additionalData"].include? par

lib/recombee_api_client/api/add_rating.rb

@@ -9,18 +9,27 @@ module RecombeeApiClient
   ##
   #Creates a new series in the database.
   class AddSeries < ApiRequest
-    attr_reader :series_id
+    attr_reader :series_id, :cascade_create
     attr_accessor :timeout
     attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
   #   - +series_id+ -> ID of the series to be created.
   #
-    def initialize(series_id)
+  # * *Optional arguments (given as hash optional)*
+  #   - +cascadeCreate+ -> If set to `true`, the item will be created with the same ID as the series. Default is `true`.
+  #
+    def initialize(series_id, optional = {})
       @series_id = series_id
-      @timeout = 1000
+      optional = normalize_optional(optional)
+      @cascade_create = optional['cascadeCreate']
+      @optional = optional
+      @timeout = 3000
       @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
+      end
     end
 
     # HTTP method
@@ -31,6 +40,7 @@ def method
     # Values of body parameters as a Hash
     def body_parameters
       p = Hash.new
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
       p
     end
 

lib/recombee_api_client/api/add_series.rb

@@ -20,7 +20,7 @@ class AddUser < ApiRequest
   #
     def initialize(user_id)
       @user_id = user_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/add_user.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
 
   ##
-  #Adding a user property is somehow equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
+  #Adding a user property is somewhat equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
   #
   class AddUserProperty < ApiRequest
     attr_reader :property_name, :type

lib/recombee_api_client/api/add_user_property.rb

@@ -28,7 +28,7 @@ def initialize(user_id, item_id, optional = {})
       optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par

lib/recombee_api_client/api/delete_bookmark.rb

@@ -28,7 +28,7 @@ def initialize(user_id, item_id, optional = {})
       optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par

lib/recombee_api_client/api/delete_cart_addition.rb

@@ -28,7 +28,7 @@ def initialize(user_id, item_id, optional = {})
       optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par

lib/recombee_api_client/api/delete_detail_view.rb

@@ -24,7 +24,7 @@ class DeleteItem < ApiRequest
   #
     def initialize(item_id)
       @item_id = item_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/delete_group.rb

@@ -21,7 +21,7 @@ class DeleteMoreItems < ApiRequest
   #
     def initialize(filter)
       @filter = filter
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/delete_item.rb

@@ -28,7 +28,7 @@ def initialize(user_id, item_id, optional = {})
       optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par

lib/recombee_api_client/api/delete_more_items.rb

@@ -28,7 +28,7 @@ def initialize(user_id, item_id, optional = {})
       optional = normalize_optional(optional)
       @timestamp = optional['timestamp']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par

lib/recombee_api_client/api/delete_purchase.rb

@@ -12,18 +12,27 @@ module RecombeeApiClient
   #Deleting a series will only delete assignment of items to it, not the items themselves!
   #
   class DeleteSeries < ApiRequest
-    attr_reader :series_id
+    attr_reader :series_id, :cascade_delete
     attr_accessor :timeout
     attr_accessor :ensure_https
 
   ##
   # * *Required arguments*
   #   - +series_id+ -> ID of the series to be deleted.
   #
-    def initialize(series_id)
+  # * *Optional arguments (given as hash optional)*
+  #   - +cascadeDelete+ -> If set to `true`, item with the same ID as seriesId will be also deleted. Default is `false`.
+  #
+    def initialize(series_id, optional = {})
       @series_id = series_id
-      @timeout = 1000
+      optional = normalize_optional(optional)
+      @cascade_delete = optional['cascadeDelete']
+      @optional = optional
+      @timeout = 3000
       @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["cascadeDelete"].include? par
+      end
     end
 
     # HTTP method
@@ -34,6 +43,7 @@ def method
     # Values of body parameters as a Hash
     def body_parameters
       p = Hash.new
+      p['cascadeDelete'] = @optional['cascadeDelete'] if @optional.include? 'cascadeDelete'
       p
     end
 

lib/recombee_api_client/api/delete_rating.rb

@@ -22,7 +22,7 @@ class DeleteUser < ApiRequest
   #
     def initialize(user_id)
       @user_id = user_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/delete_series.rb

@@ -28,7 +28,7 @@ def initialize(user_id, item_id, optional = {})
       optional = normalize_optional(optional)
       @session_id = optional['sessionId']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["sessionId"].include? par

lib/recombee_api_client/api/delete_user.rb

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

lib/recombee_api_client/api/delete_view_portion.rb

@@ -21,7 +21,7 @@ class GetItemValues < ApiRequest
   #
     def initialize(item_id)
       @item_id = item_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
 

lib/recombee_api_client/api/get_item_property_info.rb

@@ -21,7 +21,7 @@ class GetUserValues < ApiRequest
   #
     def initialize(user_id)
       @user_id = user_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end