recombee_api_client 5.1.0 → 6.0.0

data/lib/recombee_api_client/api/composite_recommendation.rb

@@ -0,0 +1,132 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+
+  ##
+  # Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations.html)) and a list of related recommendations in a single response.
+  #
+  # It is ideal for use cases such as personalized homepage sections (*Articles from <category>*), *Because You Watched <movie>*, or *Artists Related to Your Favorite Artist <artist>*.
+  #
+  # See detailed **examples and configuration guidance** in the [Composite Scenarios documentation](https://docs.recombee.com/scenarios#composite-recommendations).
+  #
+  # **Structure**
+  #
+  # The endpoint operates in two stages:
+  # 1. Recommends the *source* (e.g., an Item Segment or item) to the user.
+  # 2. Recommends *results* (items or Item Segments) related to that *source*.
+  #
+  # For example, *Articles from <category>* can be decomposed into:
+  #  - [Recommend Item Segments To User](https://docs.recombee.com/api#recommend-item-segments-to-user) to find the category.
+  #  - [Recommend Items To Item Segment](https://docs.recombee.com/api#recommend-items-to-item-segment) to recommend articles from that category.
+  #
+  # Since the first step uses [Recommend Item Segments To User](https://docs.recombee.com/api#recommend-items-to-user), you must include the `userId` parameter in the *Composite Recommendation* request.
+  #
+  # Each *Composite Recommendation* counts as a single recommendation API request for billing.
+  #
+  # **Stage-specific Parameters**
+  #
+  # Additional parameters can be supplied via [sourceSettings](https://docs.recombee.com/api#composite-recommendation-param-sourceSettings) and [resultSettings](https://docs.recombee.com/api#composite-recommendation-param-resultSettings).
+  # In the example above:
+  #  - `sourceSettings` may include any parameter valid for [Recommend Item Segments To User](https://docs.recombee.com/api#recommend-items-to-user) (e.g., `filter`, `booster`).
+  #  - `resultSettings` may include any parameter valid for [Recommend Items To Item Segment](https://docs.recombee.com/api#recommend-items-to-item-segment).
+  #
+  # See [this example](https://docs.recombee.com/api#composite-recommendation-example-setting-parameters-for-individual-stages) for more details.
+  #
+  class CompositeRecommendation < ApiRequest
+    attr_reader :scenario, :count, :item_id, :user_id, :logic, :segment_id, :cascade_create, :source_settings,
+                :result_settings, :expert_settings
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +scenario+ -> Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
+    #
+    # You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
+    #
+    # The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
+    #
+    #   - +count+ -> Number of items to be recommended (N for the top-N recommendation).
+    #
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +itemId+ -> ID of the item for which the recommendations are to be generated.
+    #
+    #   - +userId+ -> ID of the user for which the recommendations are to be generated.
+    #
+    #   - +logic+ -> Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
+    # See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
+    #
+    # The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
+    #
+    # Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
+    #
+    #   - +segmentId+ -> ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
+    #
+    #   - +cascadeCreate+ -> If the entity for the source recommendation 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 entity, as the entity will be already known to the system.
+    #
+    #   - +sourceSettings+ -> Parameters applied for recommending the *Source* stage. The accepted parameters correspond with the recommendation sub-endpoint used to recommend the *Source*.
+    #
+    #   - +resultSettings+ -> Parameters applied for recommending the *Result* stage. The accepted parameters correspond with the recommendation sub-endpoint used to recommend the *Result*.
+    #
+    #   - +expertSettings+ -> Dictionary of custom options.
+    #
+    #
+    def initialize(scenario, count, optional = {})
+      @scenario = scenario
+      @count = count
+      optional = normalize_hash_to_camel_case(optional)
+      @item_id = optional['itemId']
+      @user_id = optional['userId']
+      @logic = optional['logic']
+      @segment_id = optional['segmentId']
+      @cascade_create = optional['cascadeCreate']
+      @source_settings = optional['sourceSettings']
+      @result_settings = optional['resultSettings']
+      @expert_settings = optional['expertSettings']
+      @optional = optional
+      @timeout = 3000
+      @ensure_https = false
+      @optional.each do |par, _|
+        raise UnknownOptionalParameter.new(par) unless %w[itemId userId logic segmentId cascadeCreate
+                                                          sourceSettings resultSettings expertSettings].include? par
+      end
+    end
+
+    # HTTP method
+    def method
+      :post
+    end
+
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = {}
+      p['scenario'] = @scenario
+      p['count'] = @count
+      p['itemId'] = @optional['itemId'] if @optional.include? 'itemId'
+      p['userId'] = @optional['userId'] if @optional.include? 'userId'
+      p['logic'] = @optional['logic'] if @optional.include? 'logic'
+      p['segmentId'] = @optional['segmentId'] if @optional.include? 'segmentId'
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['sourceSettings'] = @optional['sourceSettings'] if @optional.include? 'sourceSettings'
+      p['resultSettings'] = @optional['resultSettings'] if @optional.include? 'resultSettings'
+      p['expertSettings'] = @optional['expertSettings'] if @optional.include? 'expertSettings'
+
+      p
+    end
+
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      {}
+    end
+
+    # Relative path to the endpoint
+    def path
+      '/{databaseId}/recomms/composite/'
+    end
+  end
+end

data/lib/recombee_api_client/api/create_auto_reql_segmentation.rb

@@ -5,68 +5,67 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Segment the items using a [ReQL](https://docs.recombee.com/reql) expression.
+  # Segment the items using a [ReQL](https://docs.recombee.com/reql) expression.
   #
-  #For each item, the expression should return a set that contains IDs of segments to which the item belongs to.
+  # For each item, the expression should return a set that contains IDs of segments to which the item belongs to.
   #
   class CreateAutoReqlSegmentation < ApiRequest
     attr_reader :segmentation_id, :source_type, :expression, :title, :description
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +segmentation_id+ -> ID of the newly created Segmentation
-  #   - +source_type+ -> What type of data should be segmented. Currently only `items` are supported.
-  #
-  #   - +expression+ -> ReQL expression that returns for each item a set with IDs of segments to which the item belongs
-  #
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +title+ -> Human-readable name that is shown in the Recombee Admin UI.
-  #
-  #   - +description+ -> Description that is shown in the Recombee Admin UI.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +segmentation_id+ -> ID of the newly created Segmentation
+    #   - +source_type+ -> What type of data should be segmented. Currently only `items` are supported.
+    #
+    #   - +expression+ -> ReQL expression that returns for each item a set with IDs of segments to which the item belongs
+    #
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +title+ -> Human-readable name that is shown in the Recombee Admin UI.
+    #
+    #   - +description+ -> Description that is shown in the Recombee Admin UI.
+    #
+    #
     def initialize(segmentation_id, source_type, expression, optional = {})
       @segmentation_id = segmentation_id
       @source_type = source_type
       @expression = expression
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @title = optional['title']
       @description = optional['description']
       @optional = optional
-      @timeout = 10000
+      @timeout = 10_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["title","description"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[title description].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['sourceType'] = @source_type
       p['expression'] = @expression
       p['title'] = @optional['title'] if @optional.include? 'title'
       p['description'] = @optional['description'] if @optional.include? 'description'
+
       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/auto-reql/#{@segmentation_id}"

data/lib/recombee_api_client/api/create_manual_reql_segmentation.rb

@@ -5,64 +5,63 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Segment the items using multiple [ReQL](https://docs.recombee.com/reql) filters.
+  # Segment the items using multiple [ReQL](https://docs.recombee.com/reql) filters.
   #
-  #Use the Add Manual ReQL Items Segment endpoint to create the individual segments.
+  # Use the Add Manual ReQL Items Segment endpoint to create the individual segments.
   #
   class CreateManualReqlSegmentation < ApiRequest
     attr_reader :segmentation_id, :source_type, :title, :description
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +segmentation_id+ -> ID of the newly created Segmentation
-  #   - +source_type+ -> What type of data should be segmented. Currently only `items` are supported.
-  #
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +title+ -> Human-readable name that is shown in the Recombee Admin UI.
-  #
-  #   - +description+ -> Description that is shown in the Recombee Admin UI.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +segmentation_id+ -> ID of the newly created Segmentation
+    #   - +source_type+ -> What type of data should be segmented. Currently only `items` are supported.
+    #
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +title+ -> Human-readable name that is shown in the Recombee Admin UI.
+    #
+    #   - +description+ -> Description that is shown in the Recombee Admin UI.
+    #
+    #
     def initialize(segmentation_id, source_type, optional = {})
       @segmentation_id = segmentation_id
       @source_type = source_type
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @title = optional['title']
       @description = optional['description']
       @optional = optional
-      @timeout = 10000
+      @timeout = 10_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["title","description"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[title description].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['sourceType'] = @source_type
       p['title'] = @optional['title'] if @optional.include? 'title'
       p['description'] = @optional['description'] if @optional.include? 'description'
+
       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}"

data/lib/recombee_api_client/api/create_property_based_segmentation.rb

@@ -5,69 +5,68 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Creates a Segmentation that splits the items into segments based on values of a particular item property.
+  # Creates a Segmentation that splits the items into segments based on values of a particular item property.
   #
-  #A segment is created for each unique value of the property.
-  #In case of `set` properties, a segment is created for each value in the set. Item belongs to all these segments.
+  # A segment is created for each unique value of the property.
+  # In case of `set` properties, a segment is created for each value in the set. Item belongs to all these segments.
   #
   class CreatePropertyBasedSegmentation < ApiRequest
     attr_reader :segmentation_id, :source_type, :property_name, :title, :description
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +segmentation_id+ -> ID of the newly created Segmentation
-  #   - +source_type+ -> What type of data should be segmented. Currently only `items` are supported.
-  #
-  #   - +property_name+ -> Name of the property on which the Segmentation should be based
-  #
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +title+ -> Human-readable name that is shown in the Recombee Admin UI.
-  #
-  #   - +description+ -> Description that is shown in the Recombee Admin UI.
-  #
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +segmentation_id+ -> ID of the newly created Segmentation
+    #   - +source_type+ -> What type of data should be segmented. Currently only `items` are supported.
+    #
+    #   - +property_name+ -> Name of the property on which the Segmentation should be based
+    #
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +title+ -> Human-readable name that is shown in the Recombee Admin UI.
+    #
+    #   - +description+ -> Description that is shown in the Recombee Admin UI.
+    #
+    #
     def initialize(segmentation_id, source_type, property_name, optional = {})
       @segmentation_id = segmentation_id
       @source_type = source_type
       @property_name = property_name
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @title = optional['title']
       @description = optional['description']
       @optional = optional
-      @timeout = 10000
+      @timeout = 10_000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["title","description"].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[title description].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['sourceType'] = @source_type
       p['propertyName'] = @property_name
       p['title'] = @optional['title'] if @optional.include? 'title'
       p['description'] = @optional['description'] if @optional.include? 'description'
+
       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/property-based/#{@segmentation_id}"

data/lib/recombee_api_client/api/delete_all_search_synonyms.rb

@@ -5,43 +5,39 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deletes all synonyms defined in the database.
+  # Deletes all synonyms defined in the database.
   #
   class DeleteAllSearchSynonyms < ApiRequest
-  
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  #
-    def initialize()
-      @timeout = 10000
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    #
+    def initialize
+      @timeout = 10_000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :delete
     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}/synonyms/items/"
+      '/{databaseId}/synonyms/items/'
     end
   end
 end

data/lib/recombee_api_client/api/delete_bookmark.rb

@@ -5,47 +5,45 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deletes a bookmark uniquely specified by `userId`, `itemId`, and `timestamp` or all the bookmarks with the given `userId` and `itemId` if `timestamp` is omitted.
+  # Deletes a bookmark uniquely specified by `userId`, `itemId`, and `timestamp` or all the bookmarks with the given `userId` and `itemId` if `timestamp` is omitted.
   #
   class DeleteBookmark < 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 bookmark.
-  #   - +item_id+ -> ID of the item which was bookmarked.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +timestamp+ -> Unix timestamp of the bookmark. If the `timestamp` is omitted, then all the bookmarks with the given `userId` and `itemId` are deleted.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user who made the bookmark.
+    #   - +item_id+ -> ID of the item which was bookmarked.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +timestamp+ -> Unix timestamp of the bookmark. If the `timestamp` is omitted, then all the bookmarks with the given `userId` and `itemId` are deleted.
+    #
     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']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['timestamp'].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :delete
     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
@@ -53,12 +51,13 @@ module RecombeeApiClient
       params['userId'] = @user_id
       params['itemId'] = @item_id
       params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/bookmarks/"
+      '/{databaseId}/bookmarks/'
     end
   end
 end

data/lib/recombee_api_client/api/delete_cart_addition.rb

@@ -5,47 +5,45 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deletes an existing cart addition uniquely specified by `userId`, `itemId`, and `timestamp` or all the cart additions with the given `userId` and `itemId` if `timestamp` is omitted.
+  # Deletes an existing cart addition uniquely specified by `userId`, `itemId`, and `timestamp` or all the cart additions with the given `userId` and `itemId` if `timestamp` is omitted.
   #
   class DeleteCartAddition < 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 cart addition.
-  #   - +item_id+ -> ID of the item which was added to the cart.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +timestamp+ -> Unix timestamp of the cart addition. If the `timestamp` is omitted, then all the cart additions with the given `userId` and `itemId` are deleted.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user who made the cart addition.
+    #   - +item_id+ -> ID of the item which was added to the cart.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +timestamp+ -> Unix timestamp of the cart addition. If the `timestamp` is omitted, then all the cart additions with the given `userId` and `itemId` are deleted.
+    #
     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']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['timestamp'].include? par
       end
     end
-  
+
     # HTTP method
     def method
       :delete
     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
@@ -53,12 +51,13 @@ module RecombeeApiClient
       params['userId'] = @user_id
       params['itemId'] = @item_id
       params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/cartadditions/"
+      '/{databaseId}/cartadditions/'
     end
   end
 end