recombee_api_client 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a942eeaa73f8037bc616520dbf570cb1fd257dbf
-  data.tar.gz: d2baff7ca3c650a0f3486141262c83f95ace0726
+SHA256:
+  metadata.gz: ddc59d0fe517546ea3c3e201f4ba31fdab38fee38ef7ab2780a226744d94ed8a
+  data.tar.gz: 2afe45ef3d9540eb9a1c112152b33a2559d8be9dd49bc613904020ee648e300a
 SHA512:
-  metadata.gz: 3bbea9fa0a442823d6b13a83fdb97c28bee3cc2776efc8082d5f620153a2efd5f1aece23ee72ecba7e6ec1d7af539b2e53ce4d937ba222327ae4071447e0c702
-  data.tar.gz: da781be2989614d534eec5b7f823f897dd0a8b8e3d6c9f399a9956a430e58fada2150cdcf3f0b62a94364b9f08e31a7f862e30bab48068b33611a158b4c1033f
+  metadata.gz: 4550dea796a247b45f3e80c840b876dec5065835f9127ad5f991440256e512dbd40c9d1c95675c7d3d4fe8700d5851201c278193ed561d2d28414b660b111d30
+  data.tar.gz: efa14da6a11f0fa00490e38cf22f0e9bdf741e7a331ef69a9b609ef683c28b2f7c07afb70548d07077e8b366ca968f2592290249591b28f1d8f0320136b54f49

data/README.md

@@ -29,7 +29,7 @@ Or install it yourself as:
 require 'recombee_api_client'
 include RecombeeApiClient
 
-client = RecombeeClient('--my-database-id--', '--db-private-token--')
+client = RecombeeClient('--my-database-id--', '--db-private-token--', {:region => 'us-west'})
 
 # Generate some random purchases of items by users
 NUM = 100
@@ -55,8 +55,13 @@ begin
   client.send(Batch.new(purchases))
   
   # Get recommendations for user 'user-25'
-  recommended = client.send(RecommendItemsToUser.new('user-25', 5))
-  puts "Recommended items for user-25: #{recommended}"
+  response = client.send(RecommendItemsToUser.new('user-25', 5))
+  puts "Recommended items for user-25: #{response}"
+
+  # User scrolled down - get next 3 recommended items
+  response = client.send(RecommendNextItems.new(response['recommId'], 3))
+  puts "Next recommended items for user-25: #{response}"
+
 rescue APIError => e
   puts e
   # Use fallback
@@ -71,7 +76,7 @@ include RecombeeApiClient
 NUM = 100
 PROBABILITY_PURCHASED = 0.1
 
-client = RecombeeClient('--my-database-id--', '--db-private-token--')
+client = RecombeeClient('--my-database-id--', '--db-private-token--', {:region => 'ap-se'})
 client.send(ResetDatabase.new) # Clear everything from the database (asynchronous)
 
 # We will use computers as items in this example
@@ -146,7 +151,7 @@ recommended = client.send(
 
 # Perform personalized full-text search with a user's search query (e.g. 'computers').
 matches = client.send(
-  SearchItems.new('user-42', 'computers', 5)
+  SearchItems.new('user-42', 'computers', 5, {:scenario => 'search_top'})
   )
 puts "Matched items: #{matches}"
 ```

data/lib/recombee_api_client/api/add_search_synonym.rb

@@ -0,0 +1,72 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#search-items).
+  #
+  #When the `term` is used in the search query, the `synonym` is also used for the full-text search.
+  #Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).
+  #
+  #An example of a synonym can be `science fiction` for the term `sci-fi`.
+  #
+  class AddSearchSynonym < ApiRequest
+    attr_reader :term, :synonym, :one_way
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +term+ -> A word to which the `synonym` is specified.
+  #   - +synonym+ -> A word that should be considered equal to the `term` by the full-text search engine.
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +oneWay+ -> If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
+  #
+  #Default: `false`.
+  #
+  #
+    def initialize(term, synonym, optional = {})
+      @term = term
+      @synonym = synonym
+      optional = normalize_optional(optional)
+      @one_way = optional['oneWay']
+      @optional = optional
+      @timeout = 10000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["oneWay"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['term'] = @term
+      p['synonym'] = @synonym
+      p['oneWay'] = @optional['oneWay'] if @optional.include? 'oneWay'
+      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/"
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_all_search_synonyms.rb

@@ -0,0 +1,47 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes all synonyms defined in the database.
+  #
+  class DeleteAllSearchSynonyms < ApiRequest
+  
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  #
+    def initialize()
+      @timeout = 10000
+      @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/"
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_item.rb

@@ -11,7 +11,7 @@ module RecombeeApiClient
   #
   #If there are any *purchases*, *ratings*, *bookmarks*, *cart additions* or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
   #
-  #If an item becomes obsolete/no longer available, it is often meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and only exclude the item from recommendations. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+  #If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
   #
   class DeleteItem < ApiRequest
     attr_reader :item_id

data/lib/recombee_api_client/api/delete_more_items.rb

@@ -0,0 +1,52 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Delete all the items that pass the filter.
+  #
+  #If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+  class DeleteMoreItems < ApiRequest
+    attr_reader :filter
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +filter+ -> A [ReQL](https://docs.recombee.com/reql.html) expression, which return `true` for the items that shall be updated.
+  #
+    def initialize(filter)
+      @filter = filter
+      @timeout = 1000
+      @ensure_https = false
+    end
+  
+    # HTTP method
+    def method
+      :delete
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['filter'] = @filter
+      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}/more-items/"
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_search_synonym.rb

@@ -0,0 +1,50 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes synonym of given `id` and this synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
+  #
+  class DeleteSearchSynonym < ApiRequest
+    attr_reader :id
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +id+ -> ID of the synonym that should be deleted.
+  #
+    def initialize(id)
+      @id = id
+      @timeout = 10000
+      @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/#{@id}"
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_user.rb

@@ -18,7 +18,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +user_id+ -> ID of the user to be added.
+  #   - +user_id+ -> ID of the user to be deleted.
   #
     def initialize(user_id)
       @user_id = user_id

data/lib/recombee_api_client/api/list_search_synonyms.rb

@@ -0,0 +1,59 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Gives the list of synonyms defined in the database.
+  class ListSearchSynonyms < ApiRequest
+    attr_reader :count, :offset
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +count+ -> The number of synonyms to be listed.
+  #   - +offset+ -> Specifies the number of synonyms to skip (ordered by `term`).
+  #
+    def initialize(optional = {})
+      optional = normalize_optional(optional)
+      @count = optional['count']
+      @offset = optional['offset']
+      @optional = optional
+      @timeout = 100000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["count","offset"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :get
+    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['count'] = @optional['count'] if @optional['count']
+      params['offset'] = @optional['offset'] if @optional['offset']
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/synonyms/items/"
+    end
+  end
+end

data/lib/recombee_api_client/api/recommend_items_to_item.rb

@@ -9,9 +9,14 @@ module RecombeeApiClient
   ##
   #Recommends set of items that are somehow related to one given item, *X*. Typical scenario  is when user *A* is viewing *X*. Then you may display items to the user that he might be also interested in. Recommend items to item request gives you Top-N such items, optionally taking the target user *A* into account.
   #
-  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+  #The returned items are sorted by relevance (first item being the most relevant).
+  #
+  #Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
   #
-  #The returned items are sorted by relevancy (first item being the most relevant).
+  #- Let Recombee know that this recommendation was successful (e.g. user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui.html#reported-metrics).
+  #- Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api.html#recommend-next-items).
+  #
+  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
   #
   class RecommendItemsToItem < ApiRequest
     attr_reader :item_id, :target_user_id, :count, :scenario, :cascade_create, :return_properties, :included_properties, :filter, :booster, :logic, :user_impact, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings, :return_ab_group
@@ -75,7 +80,8 @@ module RecombeeApiClient
   #            "url": "myshop.com/mixer-42"
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "numberNextRecommsCalls": 0
   #  }
   #```
   #
@@ -101,7 +107,8 @@ module RecombeeApiClient
   #            "price": 39
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "numberNextRecommsCalls": 0
   #  }
   #```
   #
@@ -124,7 +131,7 @@ module RecombeeApiClient
   #
   #   - +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** If the *targetUserId* is provided:  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 relevancy, and may return less than *count* items when there is not enough data to fulfill it.
+  #   - +minRelevance+ -> **Expert option** If the *targetUserId* is provided:  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 relevance, and may return less than *count* items when there is not enough data to fulfill it.
   #
   #   - +rotationRate+ -> **Expert option** If the *targetUserId* is provided: If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items.
   #

data/lib/recombee_api_client/api/recommend_items_to_user.rb

@@ -11,9 +11,14 @@ module RecombeeApiClient
   #
   #The most typical use cases are recommendations at homepage, in some "Picked just for you" section or in email.
   #
-  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+  #The returned items are sorted by relevance (first item being the most relevant).
+  #
+  #Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
   #
-  #The returned items are sorted by relevancy (first item being the most relevant).
+  #- Let Recombee know that this recommendation was successful (e.g. user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui.html#reported-metrics).
+  #- Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api.html#recommend-next-items).
+  #
+  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
   #
   class RecommendItemsToUser < ApiRequest
     attr_reader :user_id, :count, :scenario, :cascade_create, :return_properties, :included_properties, :filter, :booster, :logic, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings, :return_ab_group
@@ -61,7 +66,8 @@ module RecombeeApiClient
   #            "url": "myshop.com/mixer-42"
   #          }
   #        }
-  #      ]
+  #      ],
+  #     "numberNextRecommsCalls": 0
   #  }
   #```
   #
@@ -87,7 +93,8 @@ module RecombeeApiClient
   #            "price": 39
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "numberNextRecommsCalls": 0
   #  }
   #```
   #
@@ -108,9 +115,9 @@ module RecombeeApiClient
   #
   #   - +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 relevancy, and may return less than *count* items when there is not enough data to fulfill it.
+  #   - +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 relevance, and may return less than *count* items when there is not enough data to fulfill it.
   #
-  #   - +rotationRate+ -> **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0.1`.
+  #   - +rotationRate+ -> **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0`.
   #
   #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
   #

data/lib/recombee_api_client/api/recommend_next_items.rb

@@ -0,0 +1,69 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Returns items that shall be shown to a user as next recommendations when the user e.g. scrolls the page down (*infinite scroll*) or goes to a next page.
+  #
+  #It accepts `recommId` of a base recommendation request (e.g. request from the first page) and number of items that shall be returned (`count`).
+  #The base request can be one of:
+  #  - [Recommend items to item](https://docs.recombee.com/api.html#recommend-items-to-item)
+  #  - [Recommend items to user](https://docs.recombee.com/api.html#recommend-items-to-user)
+  #  - [Search items](https://docs.recombee.com/api.html#search-items)
+  #
+  #All the other parameters are inherited from the base request.
+  #
+  #*Recommend next items* can be called many times for a single `recommId` and each call returns different (previously not recommended) items.
+  #The number of *Recommend next items* calls performed so far is returned in the `numberNextRecommsCalls` field.
+  #
+  #*Recommend next items* can be requested up to 30 minutes after the base request or a previous *Recommend next items* call.
+  #
+  #For billing purposes, each call to *Recommend next items* is counted as a separate recommendation request.
+  #
+  class RecommendNextItems < ApiRequest
+    attr_reader :recomm_id, :count
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +recomm_id+ -> ID of the base recommendation request for which next recommendations should be returned
+  #   - +count+ -> Number of items to be recommended
+  #
+  #
+    def initialize(recomm_id, count)
+      @recomm_id = recomm_id
+      @count = count
+      @timeout = 3000
+      @ensure_https = false
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['count'] = @count
+      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}/recomms/next/items/#{@recomm_id}"
+    end
+  end
+end

data/lib/recombee_api_client/api/recommend_users_to_item.rb

@@ -53,7 +53,8 @@ module RecombeeApiClient
   #            "sex": "M"
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "numberNextRecommsCalls": 0
   #  }
   #```
   #
@@ -77,7 +78,8 @@ module RecombeeApiClient
   #            "country": "CAN"
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "numberNextRecommsCalls": 0
   #  }
   #```
   #

data/lib/recombee_api_client/api/recommend_users_to_user.rb

@@ -53,8 +53,9 @@ module RecombeeApiClient
   #            "sex": "M"
   #          }
   #        }
-  #      ]
-  #    }
+  #      ],
+  #    "numberNextRecommsCalls": 0
+  #  }
   #```
   #
   #   - +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
@@ -77,7 +78,8 @@ module RecombeeApiClient
   #            "country": "CAN"
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "numberNextRecommsCalls": 0
   #  }
   #```
   #

data/lib/recombee_api_client/api/search_items.rb

@@ -13,9 +13,14 @@ module RecombeeApiClient
   #
   #This endpoint should be used in a search box at your website/app. It can be called multiple times as the user is typing the query in order to get the most viable suggestions based on current state of the query, or once after submitting the whole query. 
   #
-  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+  #The returned items are sorted by relevance (first item being the most relevant).
+  #
+  #Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
   #
-  #The returned items are sorted by relevancy (first item being the most relevant).
+  #- Let Recombee know that this search was successful (e.g. user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui.html#reported-metrics).
+  #- Get subsequent search results when the user scrolls down or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api.html#recommend-next-items).
+  #
+  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
   #
   class SearchItems < ApiRequest
     attr_reader :user_id, :search_query, :count, :scenario, :cascade_create, :return_properties, :included_properties, :filter, :booster, :logic, :expert_settings, :return_ab_group
@@ -62,7 +67,8 @@ module RecombeeApiClient
   #            "url": "myshop.com/mixer-42"
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "numberNextRecommsCalls": 0
   #  }
   #```
   #
@@ -88,7 +94,8 @@ module RecombeeApiClient
   #            "price": 39
   #          }
   #        }
-  #      ]
+  #      ],
+  #    "numberNextRecommsCalls": 0
   #  }
   #```
   #

data/lib/recombee_api_client/api/update_more_items.rb

@@ -0,0 +1,63 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Update (some) property values of all the items that pass the filter.
+  #
+  #Example: *Setting all the items that are older than a week as unavailable*
+  #
+  #  ```
+  #    {
+  #      "filter": "'releaseDate' < now() - 7*24*3600",
+  #      "changes": {"available": false}
+  #    }
+  #  ```
+  #
+  class UpdateMoreItems < ApiRequest
+    attr_reader :filter, :changes
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +filter+ -> A [ReQL](https://docs.recombee.com/reql.html) expression, which return `true` for the items that shall be updated.
+  #   - +changes+ -> A dictionary where the keys are properties which shall be updated.
+  #
+    def initialize(filter, changes)
+      @filter = filter
+      @changes = changes
+      @timeout = 1000
+      @ensure_https = false
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['filter'] = @filter
+      p['changes'] = @changes
+      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}/more-items/"
+    end
+  end
+end

data/lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '3.0.0'
+  VERSION = '4.0.0'
 end

data/lib/recombee_api_client.rb

@@ -18,19 +18,16 @@ module RecombeeApiClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/3.0.0'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/4.0.0'}
 
     ##
     #   - +account+ -> Name of your account at Recombee
     #   - +token+ -> Secret token obtained from Recombee for signing requests
-    #   - +protocol+ -> Default protocol for sending requests. Possible values: 'http', 'https'.
-    def initialize(account, token, protocol = 'https', options = {})
+    def initialize(account, token, options = {})
       @account = account
       @token = token
-      @protocol = protocol
-      @base_uri = ENV['RAPI_URI'] if ENV.key? 'RAPI_URI'
-      @base_uri||=  options[:base_uri]
-      @base_uri||= 'rapi.recombee.com'
+      @protocol = options[:protocol] || 'https'
+      @base_uri = get_base_uri(options)
     end
 
     ##
@@ -42,7 +39,7 @@ module RecombeeApiClient
       timeout = request.timeout / 1000
       uri = process_request_uri(request)
       uri = sign_url(uri)
-      protocol = request.ensure_https ? 'https' : @protocol
+      protocol = request.ensure_https ? 'https' : @protocol.to_s
       uri = protocol + '://' + @base_uri + uri
       # puts uri
       begin
@@ -63,10 +60,33 @@ module RecombeeApiClient
 
     private
 
+    def get_regional_base_uri(region)
+      uri = {
+            'ap-se' => 'rapi-ap-se.recombee.com',
+            'ca-east' => 'rapi-ca-east.recombee.com',
+            'eu-west' => 'rapi-eu-west.recombee.com',
+            'us-west' => 'rapi-us-west.recombee.com'
+          }[region.to_s.gsub('_', '-').downcase]
+      raise ArgumentError.new("Region \"#{region}\" is unknown. You may need to update the version of the SDK.") if uri == nil
+      uri
+    end
+
+    def get_base_uri(options)
+      base_uri = ENV['RAPI_URI']
+      base_uri ||= options[:base_uri]
+
+      if options.key? :region
+        raise ArgumentError.new(':base_uri and :region cannot be specified at the same time') if base_uri
+        base_uri = get_regional_base_uri(options[:region])
+      end
+      base_uri||= 'rapi.recombee.com'
+      base_uri
+    end
+
     def put(request, uri, timeout)
       response = self.class.put(uri, body: request.body_parameters.to_json, 
-                        headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
-                        timeout: timeout)
+                                headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
+                                timeout: timeout)
       check_errors(response, request)
       response.body
     end
@@ -78,10 +98,9 @@ module RecombeeApiClient
     end
 
     def post(request, uri, timeout)
-      # pass arguments in body
       response = self.class.post(uri, body: request.body_parameters.to_json, 
-                        headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
-                        timeout: timeout)
+                                 headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
+                                 timeout: timeout)
       check_errors(response, request)
       begin
         return JSON.parse(response.body)
@@ -91,9 +110,15 @@ module RecombeeApiClient
     end
 
     def delete(request, uri, timeout)
-      response = self.class.delete(uri, timeout: timeout, headers: USER_AGENT)
+      response = self.class.delete(uri, body: request.body_parameters.to_json,
+                                   headers: { 'Content-Type' => 'application/json' }.merge(USER_AGENT),
+                                   timeout: timeout)
       check_errors(response, request)
-      response.body
+      begin
+        return JSON.parse(response.body)
+      rescue JSON::ParserError
+        return response.body
+      end
     end
 
     def check_errors(response, request)

data/recombee_api_client.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'multi_json'
   spec.add_dependency 'httparty'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.2.10'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Ondřej Fiedler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,18 +100,22 @@ files:
 - lib/recombee_api_client/api/add_item_property.rb
 - lib/recombee_api_client/api/add_purchase.rb
 - lib/recombee_api_client/api/add_rating.rb
+- lib/recombee_api_client/api/add_search_synonym.rb
 - lib/recombee_api_client/api/add_series.rb
 - lib/recombee_api_client/api/add_user.rb
 - lib/recombee_api_client/api/add_user_property.rb
 - lib/recombee_api_client/api/batch.rb
+- lib/recombee_api_client/api/delete_all_search_synonyms.rb
 - lib/recombee_api_client/api/delete_bookmark.rb
 - lib/recombee_api_client/api/delete_cart_addition.rb
 - lib/recombee_api_client/api/delete_detail_view.rb
 - lib/recombee_api_client/api/delete_group.rb
 - lib/recombee_api_client/api/delete_item.rb
 - lib/recombee_api_client/api/delete_item_property.rb
+- lib/recombee_api_client/api/delete_more_items.rb
 - lib/recombee_api_client/api/delete_purchase.rb
 - lib/recombee_api_client/api/delete_rating.rb
+- lib/recombee_api_client/api/delete_search_synonym.rb
 - lib/recombee_api_client/api/delete_series.rb
 - lib/recombee_api_client/api/delete_user.rb
 - lib/recombee_api_client/api/delete_user_property.rb
@@ -123,7 +127,6 @@ files:
 - lib/recombee_api_client/api/hash_normalizer.rb
 - lib/recombee_api_client/api/insert_to_group.rb
 - lib/recombee_api_client/api/insert_to_series.rb
-- lib/recombee_api_client/api/item_based_recommendation.rb
 - lib/recombee_api_client/api/list_group_items.rb
 - lib/recombee_api_client/api/list_groups.rb
 - lib/recombee_api_client/api/list_item_bookmarks.rb
@@ -134,6 +137,7 @@ files:
 - lib/recombee_api_client/api/list_item_ratings.rb
 - lib/recombee_api_client/api/list_item_view_portions.rb
 - lib/recombee_api_client/api/list_items.rb
+- lib/recombee_api_client/api/list_search_synonyms.rb
 - lib/recombee_api_client/api/list_series.rb
 - lib/recombee_api_client/api/list_series_items.rb
 - lib/recombee_api_client/api/list_user_bookmarks.rb
@@ -147,6 +151,7 @@ files:
 - lib/recombee_api_client/api/merge_users.rb
 - lib/recombee_api_client/api/recommend_items_to_item.rb
 - lib/recombee_api_client/api/recommend_items_to_user.rb
+- lib/recombee_api_client/api/recommend_next_items.rb
 - lib/recombee_api_client/api/recommend_users_to_item.rb
 - lib/recombee_api_client/api/recommend_users_to_user.rb
 - lib/recombee_api_client/api/remove_from_group.rb
@@ -158,7 +163,7 @@ files:
 - lib/recombee_api_client/api/set_user_values.rb
 - lib/recombee_api_client/api/set_values.rb
 - lib/recombee_api_client/api/set_view_portion.rb
-- lib/recombee_api_client/api/user_based_recommendation.rb
+- lib/recombee_api_client/api/update_more_items.rb
 - lib/recombee_api_client/errors.rb
 - lib/recombee_api_client/version.rb
 - recombee_api_client.gemspec
@@ -181,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Client for Recombee recommendation API

data/lib/recombee_api_client/api/item_based_recommendation.rb

@@ -1,159 +0,0 @@
-#
-# This file is auto-generated, do not edit
-#
-
-module RecombeeApiClient
-  require_relative 'request'
-  require_relative '../errors'
-  
-  ##
-  #Deprecated since version 2.0.0. Use RecommendItemsToItem request instead.
-  #
-  #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.
-  #
-  # It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
-  #
-  class ItemBasedRecommendation < ApiRequest
-    attr_reader :item_id, :count, :target_user_id, :user_impact, :filter, :booster, :allow_nonexistent, :cascade_create, :scenario, :return_properties, :included_properties, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item for which the recommendations are to be generated.
-  #   - +count+ -> Number of items to be recommended (N for the top-N recommendation).
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +targetUserId+ -> ID of the user who will see the recommendations.
-  #
-  #Specifying the *targetUserId* is beneficial because:
-  #
-  #* It makes the recommendations personalized
-  #* Allows the calculation of Actions and Conversions in the graphical user interface,
-  #  as Recombee can pair the user who got recommendations and who afterwards viewed/purchased an item.
-  #
-  #For the above reasons, we encourage you to set the *targetUserId* even for anonymous/unregistered users (i.e. use their session ID).
-  #
-  #   - +userImpact+ -> If *targetUserId* parameter is present, the recommendations are biased towards the user given. Using *userImpact*, you may control this bias. For an extreme case of `userImpact=0.0`, the interactions made by the user are not taken into account at all (with the exception of history-based blacklisting), for `userImpact=1.0`, you'll get user-based recommendation. The default value is `0`.
-  #
-  #   - +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+ -> 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", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. 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.
-  #   - +returnProperties+ -> With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used for easy displaying of the recommended items to the user. 
-  #
-  #Example response:
-  #```
-  #  [
-  #    {
-  #      "itemId": "tv-178",
-  #      "description": "4K TV with 3D feature",
-  #      "categories":   ["Electronics", "Televisions"],
-  #      "price": 342,
-  #      "url": "myshop.com/tv-178"
-  #    },
-  #    {
-  #      "itemId": "mixer-42",
-  #      "description": "Stainless Steel Mixer",
-  #      "categories":   ["Home & Kitchen"],
-  #      "price": 39,
-  #      "url": "myshop.com/mixer-42"
-  #    }
-  #  ]
-  #```
-  #
-  #   - +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
-  #
-  #Example response for `includedProperties=description,price`:
-  #```
-  #  [
-  #    {
-  #      "itemId": "tv-178",
-  #      "description": "4K TV with 3D feature",
-  #      "price": 342
-  #    },
-  #    {
-  #      "itemId": "mixer-42",
-  #      "description": "Stainless Steel Mixer",
-  #      "price": 39
-  #    }
-  #  ]
-  #```
-  #
-  #   - +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** If the *targetUserId* is provided:  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.
-  #
-  #   - +rotationRate+ -> **Expert option** If the *targetUserId* is provided: If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0.01`.
-  #
-  #   - +rotationTime+ -> **Expert option** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
-  #
-  #   - +expertSettings+ -> Dictionary of custom options.
-  #
-  #
-    def initialize(item_id, count, optional = {})
-      @item_id = item_id
-      @count = count
-      optional = normalize_optional(optional)
-      @target_user_id = optional['targetUserId']
-      @user_impact = optional['userImpact']
-      @filter = optional['filter']
-      @booster = optional['booster']
-      @allow_nonexistent = optional['allowNonexistent']
-      @cascade_create = optional['cascadeCreate']
-      @scenario = optional['scenario']
-      @return_properties = optional['returnProperties']
-      @included_properties = optional['includedProperties']
-      @diversity = optional['diversity']
-      @min_relevance = optional['minRelevance']
-      @rotation_rate = optional['rotationRate']
-      @rotation_time = optional['rotationTime']
-      @expert_settings = optional['expertSettings']
-      @optional = optional
-      @timeout = 3000
-      @ensure_https = false
-      @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["targetUserId","userImpact","filter","booster","allowNonexistent","cascadeCreate","scenario","returnProperties","includedProperties","diversity","minRelevance","rotationRate","rotationTime","expertSettings"].include? par
-      end
-    end
-  
-    # HTTP method
-    def method
-      :post
-    end
-  
-    # Values of body parameters as a Hash
-    def body_parameters
-      p = Hash.new
-      p['count'] = @count
-      p['targetUserId'] = @optional['targetUserId'] if @optional.include? 'targetUserId'
-      p['userImpact'] = @optional['userImpact'] if @optional.include? 'userImpact'
-      p['filter'] = @optional['filter'] if @optional.include? 'filter'
-      p['booster'] = @optional['booster'] if @optional.include? 'booster'
-      p['allowNonexistent'] = @optional['allowNonexistent'] if @optional.include? 'allowNonexistent'
-      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
-      p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
-      p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
-      p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
-      p['diversity'] = @optional['diversity'] if @optional.include? 'diversity'
-      p['minRelevance'] = @optional['minRelevance'] if @optional.include? 'minRelevance'
-      p['rotationRate'] = @optional['rotationRate'] if @optional.include? 'rotationRate'
-      p['rotationTime'] = @optional['rotationTime'] if @optional.include? 'rotationTime'
-      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
-      params = {}
-      params
-    end
-  
-    # Relative path to the endpoint
-    def path
-      "/{databaseId}/items/#{@item_id}/recomms/"
-    end
-  end
-end

data/lib/recombee_api_client/api/user_based_recommendation.rb

@@ -1,143 +0,0 @@
-#
-# This file is auto-generated, do not edit
-#
-
-module RecombeeApiClient
-  require_relative 'request'
-  require_relative '../errors'
-  
-  ##
-  #Deprecated since version 2.0.0. Use RecommendItemsToUser request instead.
-  #
-  #Based on user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for a given user.
-  #
-  #It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
-  #
-  class UserBasedRecommendation < ApiRequest
-    attr_reader :user_id, :count, :filter, :booster, :allow_nonexistent, :cascade_create, :scenario, :return_properties, :included_properties, :diversity, :min_relevance, :rotation_rate, :rotation_time, :expert_settings
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> ID of the user for whom the personalized recommendations are to be generated.
-  #   - +count+ -> Number of items to be recommended (N for the top-N recommendation).
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +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. It doesn't create the user in the database.
-  #   - +cascadeCreate+ -> If the user 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 user, as the user will be already known to the system.
-  #   - +scenario+ -> Scenario defines a particular application of recommendations. It can be for example "homepage", "cart" or "emailing". You can see each scenario in the UI separately, so you can check how well each application performs. 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.
-  #   - +returnProperties+ -> With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used for easy displaying of the recommended items to the user. 
-  #
-  #Example response:
-  #```
-  #  [
-  #    {
-  #      "itemId": "tv-178",
-  #      "description": "4K TV with 3D feature",
-  #      "categories":   ["Electronics", "Televisions"],
-  #      "price": 342,
-  #      "url": "myshop.com/tv-178"
-  #    },
-  #    {
-  #      "itemId": "mixer-42",
-  #      "description": "Stainless Steel Mixer",
-  #      "categories":   ["Home & Kitchen"],
-  #      "price": 39,
-  #      "url": "myshop.com/mixer-42"
-  #    }
-  #  ]
-  #```
-  #
-  #   - +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
-  #
-  #Example response for `includedProperties=description,price`:
-  #```
-  #  [
-  #    {
-  #      "itemId": "tv-178",
-  #      "description": "4K TV with 3D feature",
-  #      "price": 342
-  #    },
-  #    {
-  #      "itemId": "mixer-42",
-  #      "description": "Stainless Steel Mixer",
-  #      "price": 39
-  #    }
-  #  ]
-  #```
-  #
-  #   - +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.
-  #
-  #   - +rotationRate+ -> **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0.1`.
-  #
-  #   - +rotationTime+ -> **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
-  #
-  #   - +expertSettings+ -> Dictionary of custom options.
-  #
-  #
-    def initialize(user_id, count, optional = {})
-      @user_id = user_id
-      @count = count
-      optional = normalize_optional(optional)
-      @filter = optional['filter']
-      @booster = optional['booster']
-      @allow_nonexistent = optional['allowNonexistent']
-      @cascade_create = optional['cascadeCreate']
-      @scenario = optional['scenario']
-      @return_properties = optional['returnProperties']
-      @included_properties = optional['includedProperties']
-      @diversity = optional['diversity']
-      @min_relevance = optional['minRelevance']
-      @rotation_rate = optional['rotationRate']
-      @rotation_time = optional['rotationTime']
-      @expert_settings = optional['expertSettings']
-      @optional = optional
-      @timeout = 3000
-      @ensure_https = false
-      @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["filter","booster","allowNonexistent","cascadeCreate","scenario","returnProperties","includedProperties","diversity","minRelevance","rotationRate","rotationTime","expertSettings"].include? par
-      end
-    end
-  
-    # HTTP method
-    def method
-      :post
-    end
-  
-    # Values of body parameters as a Hash
-    def body_parameters
-      p = Hash.new
-      p['count'] = @count
-      p['filter'] = @optional['filter'] if @optional.include? 'filter'
-      p['booster'] = @optional['booster'] if @optional.include? 'booster'
-      p['allowNonexistent'] = @optional['allowNonexistent'] if @optional.include? 'allowNonexistent'
-      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
-      p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
-      p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
-      p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
-      p['diversity'] = @optional['diversity'] if @optional.include? 'diversity'
-      p['minRelevance'] = @optional['minRelevance'] if @optional.include? 'minRelevance'
-      p['rotationRate'] = @optional['rotationRate'] if @optional.include? 'rotationRate'
-      p['rotationTime'] = @optional['rotationTime'] if @optional.include? 'rotationTime'
-      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
-      params = {}
-      params
-    end
-  
-    # Relative path to the endpoint
-    def path
-      "/{databaseId}/users/#{@user_id}/recomms/"
-    end
-  end
-end