recombee_api_client 5.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01199f5f35eecc707fae959cf983926aeb1a27a0abbeba5c04d3aedacf1a750b'
-  data.tar.gz: 96df288201b167f39e340732398f1e084d9cf503b778b220e5fadc0638df4b76
+  metadata.gz: 88fa1bd148ace9bb4ddfa4c75037c4242bf693a96e7395de3b0c23dafb325d03
+  data.tar.gz: c4bbc5474baf87cfaabc58f07b0c4e5161190473e1816e2b6f6ab61b90d32347
 SHA512:
-  metadata.gz: d248ef770c97da18c94379e924ab57943dfea87b7a4f2483fc28f328623763281853362352321c8d5c25cb8b5556bbf82cf688574ded90da8e530bf611b9407c
-  data.tar.gz: 8c7748c00edff1a6e5459aa853d18cb743a96ec6e4b0d796ade5b6ec69cd0567fc8e3dfbda3b061141a069439e6011447e26540d41e527d1f67e6ef2104c2d02
+  metadata.gz: ba77e029c00f29e3e4ec1d8b7790620d205e13bb4cbcc16b06061f0ce3045b74b39b815706bf0cde69d88964460a6149d8012f976e2563c9f2188464833ebc2b
+  data.tar.gz: 3a6abbe8a347b15d2fec1ec457a23870c4321839c18f75e344adaf607dcb95b2e379b20057af1d90a3edb023eb97643d2788a35088c853588cfe368e7a9a7abe

data/lib/recombee_api_client/api/add_bookmark.rb

@@ -5,30 +5,29 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds a bookmark of the given item made by the given user.
+  # Adds a bookmark of the given item made by the given user.
   #
   class AddBookmark < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :cascade_create, :recomm_id, :additional_data
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> User who bookmarked the item
-  #   - +item_id+ -> Bookmarked item
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +timestamp+ -> UTC timestamp of the bookmark 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.
-  #   - +recommId+ -> If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-  #   - +additionalData+ -> A dictionary of additional data for the interaction.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> User who bookmarked the item
+    #   - +item_id+ -> Bookmarked item
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +timestamp+ -> UTC timestamp of the bookmark 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.
+    #   - +recommId+ -> If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+    #   - +additionalData+ -> A dictionary of additional data for the interaction.
+    #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @recomm_id = optional['recommId']
@@ -37,37 +36,38 @@ module RecombeeApiClient
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","recommId","additionalData"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[timestamp cascadeCreate recommId
+                                                          additionalData].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :post
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['userId'] = @user_id
       p['itemId'] = @item_id
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
       p['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
       p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData'
+
       p
     end
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/bookmarks/"
+      '/{databaseId}/bookmarks/'
     end
   end
 end

data/lib/recombee_api_client/api/add_cart_addition.rb

@@ -5,32 +5,31 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds a cart addition of the given item made by the given user.
+  # Adds a cart addition of the given item made by the given user.
   #
   class AddCartAddition < ApiRequest
     attr_reader :user_id, :item_id, :timestamp, :cascade_create, :amount, :price, :recomm_id, :additional_data
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> User who added the item to the cart
-  #   - +item_id+ -> Item added to the cart
-  #
-  # * *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 2.
-  #   - +price+ -> Price of the added item. If `amount` is greater than 1, the sum of prices of all the items should be given.
-  #   - +recommId+ -> If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-  #   - +additionalData+ -> A dictionary of additional data for the interaction.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> User who added the item to the cart
+    #   - +item_id+ -> Item added to the cart
+    #
+    # * *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 2.
+    #   - +price+ -> Price of the added item. If `amount` is greater than 1, the sum of prices of all the items should be given.
+    #   - +recommId+ -> If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+    #   - +additionalData+ -> A dictionary of additional data for the interaction.
+    #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @timestamp = optional['timestamp']
       @cascade_create = optional['cascadeCreate']
       @amount = optional['amount']
@@ -41,18 +40,19 @@ module RecombeeApiClient
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","recommId","additionalData"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[timestamp cascadeCreate amount price recommId
+                                                          additionalData].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :post
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['userId'] = @user_id
       p['itemId'] = @item_id
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
@@ -61,19 +61,19 @@ module RecombeeApiClient
       p['price'] = @optional['price'] if @optional.include? 'price'
       p['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
       p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData'
+
       p
     end
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/cartadditions/"
+      '/{databaseId}/cartadditions/'
     end
   end
 end

data/lib/recombee_api_client/api/add_detail_view.rb

@@ -5,52 +5,55 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds a detail view of the given item made by the given user.
+  # Adds a detail view of the given item made by the given user.
   #
   class AddDetailView < ApiRequest
-    attr_reader :user_id, :item_id, :timestamp, :duration, :cascade_create, :recomm_id, :additional_data
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> User who viewed the item
-  #   - +item_id+ -> Viewed item
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +timestamp+ -> UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
-  #   - +duration+ -> Duration of the view
-  #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
-  #   - +recommId+ -> If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.
-  #   - +additionalData+ -> A dictionary of additional data for the interaction.
-  #
+    attr_reader :user_id, :item_id, :timestamp, :duration, :cascade_create, :recomm_id, :additional_data,
+                :auto_presented
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> User who viewed the item
+    #   - +item_id+ -> Viewed item
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +timestamp+ -> UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
+    #   - +duration+ -> Duration of the view
+    #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+    #   - +recommId+ -> If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+    #   - +additionalData+ -> A dictionary of additional data for the interaction.
+    #   - +autoPresented+ -> Indicates whether the item was automatically presented to the user (e.g., in a swiping feed) or explicitly requested by the user (e.g., by clicking on a link). Defaults to `false`.
+    #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @timestamp = optional['timestamp']
       @duration = optional['duration']
       @cascade_create = optional['cascadeCreate']
       @recomm_id = optional['recommId']
       @additional_data = optional['additionalData']
+      @auto_presented = optional['autoPresented']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp","duration","cascadeCreate","recommId","additionalData"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[timestamp duration cascadeCreate recommId
+                                                          additionalData autoPresented].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :post
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['userId'] = @user_id
       p['itemId'] = @item_id
       p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
@@ -58,19 +61,20 @@ module RecombeeApiClient
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
       p['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
       p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData'
+      p['autoPresented'] = @optional['autoPresented'] if @optional.include? 'autoPresented'
+
       p
     end
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/detailviews/"
+      '/{databaseId}/detailviews/'
     end
   end
 end

data/lib/recombee_api_client/api/add_item.rb

@@ -5,45 +5,42 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds new item of the given `itemId` to the items catalog.
+  # Adds new item of the given `itemId` to the items catalog.
   #
-  #All the item properties for the newly created items are set to null.
+  # All the item properties for the newly created items are set to null.
   #
   class AddItem < ApiRequest
     attr_reader :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item to be created.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item to be created.
+    #
     def initialize(item_id)
       @item_id = item_id
       @timeout = 3000
       @ensure_https = false
     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 parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
-  
+
     # Relative path to the endpoint
     def path
       "/{databaseId}/items/#{@item_id}"

data/lib/recombee_api_client/api/add_item_property.rb

@@ -5,64 +5,63 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #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.
+  # 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
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +property_name+ -> Name of the item property to be created. Currently, the following names are reserved: `id`, `itemid`, case-insensitively. Also, the length of the property name must not exceed 63 characters.
-  #
-  #   - +type+ -> Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
-  #
-  #* `int`- Signed integer number.
-  #
-  #* `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
-  #
-  #* `string` - UTF-8 string.
-  #
-  #* `boolean` - *true* / *false*
-  #
-  #* `timestamp` - Value representing date and time.
-  #
-  #* `set` - Set of strings.
-  #
-  #* `image` - URL of an image (`jpeg`, `png` or `gif`).
-  #
-  #* `imageList` - List of URLs that refer to images. 
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +property_name+ -> Name of the item property to be created. Currently, the following names are reserved: `id`, `itemid`, case-insensitively. Also, the length of the property name must not exceed 63 characters.
+    #
+    #   - +type+ -> Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
+    #
+    # * `int`- Signed integer number.
+    #
+    # * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
+    #
+    # * `string` - UTF-8 string.
+    #
+    # * `boolean` - *true* / *false*
+    #
+    # * `timestamp` - Value representing date and time.
+    #
+    # * `set` - Set of strings.
+    #
+    # * `image` - URL of an image (`jpeg`, `png` or `gif`).
+    #
+    # * `imageList` - List of URLs that refer to images.
+    #
+    #
     def initialize(property_name, type)
       @property_name = property_name
       @type = type
-      @timeout = 100000
+      @timeout = 100_000
       @ensure_https = false
     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 parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
       params['type'] = @type
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
       "/{databaseId}/items/properties/#{@property_name}"

data/lib/recombee_api_client/api/add_manual_reql_segment.rb

@@ -5,62 +5,61 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Adds a new Segment into a Manual ReQL Segmentation.
+  # Adds a new Segment into a Manual ReQL Segmentation.
   #
-  #The new Segment is defined by a [ReQL](https://docs.recombee.com/reql) filter that returns `true` for an item in case that this item belongs to the segment.
+  # The new Segment is defined by a [ReQL](https://docs.recombee.com/reql) filter that returns `true` for an item in case that this item belongs to the segment.
   #
   class AddManualReqlSegment < ApiRequest
     attr_reader :segmentation_id, :segment_id, :filter, :title
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +segmentation_id+ -> ID of the Segmentation to which the new Segment should be added
-  #   - +segment_id+ -> ID of the newly created Segment
-  #   - +filter+ -> ReQL filter that returns `true` for items that belong to this Segment. Otherwise returns `false`.
-  #
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +title+ -> Human-readable name of the Segment that is shown in the Recombee Admin UI.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +segmentation_id+ -> ID of the Segmentation to which the new Segment should be added
+    #   - +segment_id+ -> ID of the newly created Segment
+    #   - +filter+ -> ReQL filter that returns `true` for items that belong to this Segment. Otherwise returns `false`.
+    #
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +title+ -> Human-readable name of the Segment that is shown in the Recombee Admin UI.
+    #
+    #
     def initialize(segmentation_id, segment_id, filter, optional = {})
       @segmentation_id = segmentation_id
       @segment_id = segment_id
       @filter = filter
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @title = optional['title']
       @optional = optional
-      @timeout = 10000
+      @timeout = 10_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["title"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['title'].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :put
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['filter'] = @filter
       p['title'] = @optional['title'] if @optional.include? 'title'
+
       p
     end
-  
+
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params
+      {}
     end
-  
+
     # Relative path to the endpoint
     def path
       "/{databaseId}/segmentations/manual-reql/#{@segmentation_id}/segments/#{@segment_id}"