recombee_api_client 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4768bdac13cee19e3667d59b7cac6ac68fb4df9c63f4fbab76eb2168f76e135a
-  data.tar.gz: ce298750cdbcec2ad0ec3d3e9baab087d742f44bc9e3e3fc6bc742dcdfcb8c17
+  metadata.gz: b6ba78bee5be7cbf745ccd6a3515fdd2bb33d1b44d7bad833496f03253c9d33d
+  data.tar.gz: 60b9259daa982cc5a1d7b7f754673d2283bb8d016a3b1d11358f14e61f2c4d4c
 SHA512:
-  metadata.gz: 1b2c012a478a9a49ebde323fbc5f0b089dbd3287fdd11224abeb2e366a15db0af884068374ffbb46c296ea6f325e9870fda459763e563a7e16391cbc2031cfd3
-  data.tar.gz: e5786b070204e530824968bca26dfb5e5086a9670110a1aced8773c47f1f0a131ff2302a8c15c44483eb2a62bae39cb9744333e898a8749c287456330cae58cb
+  metadata.gz: 367c36d059d054f2be05651d41ee4c0c2a268f05a68667c424b690ebb21b41fe81a2f40d0e578848cf53ba252f0b61d8143da5c3c44d85ada360c1506b4d089b
+  data.tar.gz: a2e076c146940a86bab07eac90756745a6af9343b69e571f636b4e2bd309b22771f690a170b14cb58feebf69d4c215eaa8f2fee09ae320d05b9d8cef867db9aa

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--', {:region => 'us-west'})
+client = RecombeeClient.new('--my-database-id--', '--db-private-token--', {:region => 'us-west'})
 
 # Generate some random purchases of items by users
 NUM = 100
@@ -76,7 +76,7 @@ include RecombeeApiClient
 NUM = 100
 PROBABILITY_PURCHASED = 0.1
 
-client = RecombeeClient('--my-database-id--', '--db-private-token--', {:region => 'ap-se'})
+client = RecombeeClient.new('--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
@@ -177,4 +177,4 @@ rescue ApiTimeout => e
 rescue APIError => e
   # APIError is parent of both ResponseError and ApiTimeout
 end
-```
+```

data/lib/recombee_api_client/api/add_bookmark.rb

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

data/lib/recombee_api_client/api/add_cart_addition.rb

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

data/lib/recombee_api_client/api/add_detail_view.rb

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

data/lib/recombee_api_client/api/add_item.rb

@@ -22,7 +22,7 @@ module RecombeeApiClient
   #
     def initialize(item_id)
       @item_id = item_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/add_item_property.rb

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

data/lib/recombee_api_client/api/add_purchase.rb

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

data/lib/recombee_api_client/api/add_rating.rb

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

data/lib/recombee_api_client/api/add_series.rb

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

data/lib/recombee_api_client/api/add_user.rb

@@ -20,7 +20,7 @@ module RecombeeApiClient
   #
     def initialize(user_id)
       @user_id = user_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/add_user_property.rb

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

data/lib/recombee_api_client/api/delete_bookmark.rb

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

data/lib/recombee_api_client/api/delete_cart_addition.rb

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

data/lib/recombee_api_client/api/delete_detail_view.rb

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

data/lib/recombee_api_client/api/delete_item.rb

@@ -24,7 +24,7 @@ module RecombeeApiClient
   #
     def initialize(item_id)
       @item_id = item_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/delete_more_items.rb

@@ -21,7 +21,7 @@ module RecombeeApiClient
   #
     def initialize(filter)
       @filter = filter
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/delete_purchase.rb

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

data/lib/recombee_api_client/api/delete_rating.rb

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

data/lib/recombee_api_client/api/delete_series.rb

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

data/lib/recombee_api_client/api/delete_user.rb

@@ -22,7 +22,7 @@ module RecombeeApiClient
   #
     def initialize(user_id)
       @user_id = user_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/delete_view_portion.rb

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

data/lib/recombee_api_client/api/get_item_property_info.rb

@@ -20,7 +20,7 @@ module RecombeeApiClient
   #
     def initialize(property_name)
       @property_name = property_name
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/get_item_values.rb

@@ -21,7 +21,7 @@ module RecombeeApiClient
   #
     def initialize(item_id)
       @item_id = item_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/get_user_values.rb

@@ -21,7 +21,7 @@ module RecombeeApiClient
   #
     def initialize(user_id)
       @user_id = user_id
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/api/insert_to_series.rb

@@ -22,7 +22,7 @@ module RecombeeApiClient
   #   - +time+ -> Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.
   #
   # * *Optional arguments (given as hash optional)*
-  #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.
+  #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. In case of `item`, an item is created, in case of `series` a series + corresponding item with the same ID is created.
   #
     def initialize(series_id, item_type, item_id, time, optional = {})
       @series_id = series_id
@@ -32,7 +32,7 @@ module RecombeeApiClient
       optional = normalize_optional(optional)
       @cascade_create = optional['cascadeCreate']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par

data/lib/recombee_api_client/api/recommend_item_segments_to_item.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Recommends Segments from a Segmentation that are the most relevant to a particular item.
+  #Recommends Segments from a [Segmentation](https://docs.recombee.com/segmentations.html) that are the most relevant to a particular item.
   #
   #Based on the used Segmentation, this endpoint can be used for example for:
   #
@@ -16,7 +16,7 @@ module RecombeeApiClient
   #  - Recommending the related brands
   #  - Recommending the related artists
   #
-  #You need to set the used Segmentation the Admin UI in the Scenario settings prior to using this endpoint.
+  #You need to set the used Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.
   #
   #The returned segments are sorted by relevance (first segment being the most relevant).
   #

data/lib/recombee_api_client/api/recommend_item_segments_to_item_segment.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Recommends Segments from a result Segmentation that are the most relevant to a particular Segment from a context Segmentation.
+  #Recommends Segments from a result [Segmentation](https://docs.recombee.com/segmentations.html) that are the most relevant to a particular Segment from a context Segmentation.
   #
   #Based on the used Segmentations, this endpoint can be used for example for:
   #
@@ -15,7 +15,7 @@ module RecombeeApiClient
   #  - Recommending the related brands to particular category
   #  - Recommending the related artists to a particular genre (assuming songs are the Items)
   #
-  #You need to set the used context and result Segmentation the Admin UI in the Scenario settings prior to using this endpoint.
+  #You need to set the used context and result Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.
   #
   #The returned segments are sorted by relevance (first segment being the most relevant).
   #

data/lib/recombee_api_client/api/recommend_item_segments_to_user.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Recommends the top Segments from a Segmentation for a particular user, based on the user's past interactions.
+  #Recommends the top Segments from a [Segmentation](https://docs.recombee.com/segmentations.html) for a particular user, based on the user's past interactions.
   #
   #Based on the used Segmentation, this endpoint can be used for example for:
   #
@@ -16,7 +16,7 @@ module RecombeeApiClient
   #  - Recommending the top brands for the user
   #  - Recommending the top artists for the user
   #
-  #You need to set the used Segmentation the Admin UI in the Scenario settings prior to using this endpoint.
+  #You need to set the used Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.
   #
   #The returned segments are sorted by relevance (first segment being the most relevant).
   #

data/lib/recombee_api_client/api/recommend_items_to_item_segment.rb

@@ -0,0 +1,207 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Recommends Items that are the most relevant to a particular Segment from a context [Segmentation](https://docs.recombee.com/segmentations.html).
+  #
+  #Based on the used Segmentation, this endpoint can be used for example for:
+  #
+  #- Recommending articles related to a particular topic
+  #- Recommending songs belonging to a particular genre
+  #- Recommending products produced by a particular brand
+  #
+  #You need to set the used context Segmentation in the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.
+  #
+  #The returned items are sorted by relevance (the first item being the most relevant).
+  #
+  #It is also possible to use the POST HTTP method (for example, in the case of a very long ReQL filter) — query parameters then become body parameters.
+  #
+  class RecommendItemsToItemSegment < ApiRequest
+    attr_reader :context_segment_id, :target_user_id, :count, :scenario, :cascade_create, :return_properties, :included_properties, :filter, :booster, :logic, :min_relevance, :rotation_rate, :rotation_time, :expert_settings, :return_ab_group
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +context_segment_id+ -> ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
+  #   - +target_user_id+ -> 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 afterward viewed/purchased an item.
+  #
+  #If you insist on not specifying the user, pass `null`
+  #(`None`, `nil`, `NULL` etc., depending on the language) to *targetUserId*.
+  #Do not create some special dummy user for getting recommendations,
+  #as it could mislead the recommendation models,
+  #and result in wrong recommendations.
+  #
+  #For anonymous/unregistered users, it is possible to use, for example, their session ID.
+  #
+  #   - +count+ -> Number of items to be recommended (N for the top-N recommendation).
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +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.html) 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.
+  #
+  #   - +cascadeCreate+ -> If an item of the given *itemId* or user of the given *targetUserId* doesn't exist in the database, it creates the missing entity/entities and returns some (non-personalized) recommendations. This allows, for example, rotations in the following recommendations for the user of the given *targetUserId*, as the user will be already known to the system.
+  #   - +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 to easily display the recommended items to the user. 
+  #
+  #Example response:
+  #```
+  #  {
+  #    "recommId": "0c6189e7-dc1a-429a-b613-192696309361",
+  #    "recomms":
+  #      [
+  #        {
+  #          "id": "tv-178",
+  #          "values": {
+  #            "description": "4K TV with 3D feature",
+  #            "categories":   ["Electronics", "Televisions"],
+  #            "price": 342,
+  #            "url": "myshop.com/tv-178"
+  #          }
+  #        },
+  #        {
+  #          "id": "mixer-42",
+  #          "values": {
+  #            "description": "Stainless Steel Mixer",
+  #            "categories":   ["Home & Kitchen"],
+  #            "price": 39,
+  #            "url": "myshop.com/mixer-42"
+  #          }
+  #        }
+  #      ],
+  #    "numberNextRecommsCalls": 0
+  #  }
+  #```
+  #
+  #   - +includedProperties+ -> Allows specifying 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`:
+  #```
+  #  {
+  #    "recommId": "6842c725-a79f-4537-a02c-f34d668a3f80",
+  #    "recomms": 
+  #      [
+  #        {
+  #          "id": "tv-178",
+  #          "values": {
+  #            "description": "4K TV with 3D feature",
+  #            "price": 342
+  #          }
+  #        },
+  #        {
+  #          "id": "mixer-42",
+  #          "values": {
+  #            "description": "Stainless Steel Mixer",
+  #            "price": 39
+  #          }
+  #        }
+  #      ],
+  #    "numberNextRecommsCalls": 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.
+  #
+  #Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+  #
+  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
+  #
+  #Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+  #
+  #   - +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.html) 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.html) in the [Admin UI](https://admin.recombee.com).
+  #
+  #   - +minRelevance+ -> **Expert option** If the *targetUserId* is provided:  Specifies the threshold of how 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 a number of items equal to *count* at any cost. If there is not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations being 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 a 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.
+  #
+  #   - +rotationTime+ -> **Expert option** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long it takes for an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
+  #
+  #   - +expertSettings+ -> Dictionary of custom options.
+  #
+  #   - +returnAbGroup+ -> If there is a custom AB-testing running, return the name of the group to which the request belongs.
+  #
+  #
+    def initialize(context_segment_id, target_user_id, count, optional = {})
+      @context_segment_id = context_segment_id
+      @target_user_id = target_user_id
+      @count = count
+      optional = normalize_optional(optional)
+      @scenario = optional['scenario']
+      @cascade_create = optional['cascadeCreate']
+      @return_properties = optional['returnProperties']
+      @included_properties = optional['includedProperties']
+      @filter = optional['filter']
+      @booster = optional['booster']
+      @logic = optional['logic']
+      @min_relevance = optional['minRelevance']
+      @rotation_rate = optional['rotationRate']
+      @rotation_time = optional['rotationTime']
+      @expert_settings = optional['expertSettings']
+      @return_ab_group = optional['returnAbGroup']
+      @optional = optional
+      @timeout = 3000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["scenario","cascadeCreate","returnProperties","includedProperties","filter","booster","logic","minRelevance","rotationRate","rotationTime","expertSettings","returnAbGroup"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['contextSegmentId'] = @context_segment_id
+      p['targetUserId'] = @target_user_id
+      p['count'] = @count
+      p['scenario'] = @optional['scenario'] if @optional.include? 'scenario'
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p['returnProperties'] = @optional['returnProperties'] if @optional.include? 'returnProperties'
+      p['includedProperties'] = @optional['includedProperties'] if @optional.include? 'includedProperties'
+      p['filter'] = @optional['filter'] if @optional.include? 'filter'
+      p['booster'] = @optional['booster'] if @optional.include? 'booster'
+      p['logic'] = @optional['logic'] if @optional.include? 'logic'
+      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['returnAbGroup'] = @optional['returnAbGroup'] if @optional.include? 'returnAbGroup'
+      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/item-segments/items/"
+    end
+  end
+end

data/lib/recombee_api_client/api/remove_from_series.rb

@@ -9,7 +9,7 @@ module RecombeeApiClient
   ##
   #Removes an existing series item from the series.
   class RemoveFromSeries < ApiRequest
-    attr_reader :series_id, :item_type, :item_id, :time
+    attr_reader :series_id, :item_type, :item_id
     attr_accessor :timeout
     attr_accessor :ensure_https
   
@@ -18,14 +18,12 @@ module RecombeeApiClient
   #   - +series_id+ -> ID of the series from which a series item is to be removed.
   #   - +item_type+ -> Type of the item to be removed.
   #   - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.
-  #   - +time+ -> Time index of the item to be removed.
   #
-    def initialize(series_id, item_type, item_id, time)
+    def initialize(series_id, item_type, item_id)
       @series_id = series_id
       @item_type = item_type
       @item_id = item_id
-      @time = time
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
     end
   
@@ -37,6 +35,8 @@ module RecombeeApiClient
     # Values of body parameters as a Hash
     def body_parameters
       p = Hash.new
+      p['itemType'] = @item_type
+      p['itemId'] = @item_id
       p
     end
   
@@ -44,9 +44,6 @@ module RecombeeApiClient
     # name of parameter => value of the parameter
     def query_parameters
       params = {}
-      params['itemType'] = @item_type
-      params['itemId'] = @item_id
-      params['time'] = @time
       params
     end
   

data/lib/recombee_api_client/api/set_view_portion.rb

@@ -39,7 +39,7 @@ module RecombeeApiClient
       @recomm_id = optional['recommId']
       @additional_data = optional['additionalData']
       @optional = optional
-      @timeout = 1000
+      @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
         fail UnknownOptionalParameter.new(par) unless ["sessionId","timestamp","cascadeCreate","recommId","additionalData"].include? par

data/lib/recombee_api_client/api/update_more_items.rb

@@ -31,7 +31,7 @@ module RecombeeApiClient
     def initialize(filter, changes)
       @filter = filter
       @changes = changes
-      @timeout = 1000
+      @timeout = 100000
       @ensure_https = false
     end
   

data/lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '4.1.0'
+  VERSION = '5.0.0'
 end

data/lib/recombee_api_client.rb

@@ -18,7 +18,7 @@ module RecombeeApiClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/4.1.0'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/5.0.0'}
 
     ##
     #   - +account+ -> Name of your account at Recombee

data/recombee_api_client.gemspec

@@ -10,17 +10,19 @@ Gem::Specification.new do |spec|
   spec.email         = ['ondrej.fiedler@recombee.com']
 
   spec.summary       = 'Client for Recombee recommendation API'
-  spec.homepage      = 'http://recombee.com'
+  spec.description   = 'A Ruby client for accessing the Recombee recommendation API. Supports personalization and search capabilities with ease.'
+  spec.homepage      = 'https://recombee.com'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 1.9.0'
+
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'multi_json'
-  spec.add_dependency 'httparty'
+  spec.add_dependency 'multi_json', '~> 1.15'
+  spec.add_dependency 'httparty', '~> 0.18'
 
-  spec.add_development_dependency 'bundler', '~> 2.2.10'
-  spec.add_development_dependency 'rake', '~> 12.3.3'
-  spec.add_development_dependency 'rspec'
-end
+  spec.add_development_dependency 'bundler', '~> 2.6.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+end

metadata

@@ -1,86 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Ondřej Fiedler
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2025-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.10
+        version: 2.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.10
+        version: 2.6.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '3.11'
+description: A Ruby client for accessing the Recombee recommendation API. Supports
+  personalization and search capabilities with ease.
 email:
 - ondrej.fiedler@recombee.com
 executables: []
@@ -95,7 +95,6 @@ files:
 - lib/recombee_api_client/api/add_bookmark.rb
 - lib/recombee_api_client/api/add_cart_addition.rb
 - lib/recombee_api_client/api/add_detail_view.rb
-- lib/recombee_api_client/api/add_group.rb
 - lib/recombee_api_client/api/add_item.rb
 - lib/recombee_api_client/api/add_item_property.rb
 - lib/recombee_api_client/api/add_manual_reql_segment.rb
@@ -113,7 +112,6 @@ files:
 - 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_manual_reql_segment.rb
@@ -132,10 +130,7 @@ files:
 - lib/recombee_api_client/api/get_user_property_info.rb
 - lib/recombee_api_client/api/get_user_values.rb
 - 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/list_group_items.rb
-- lib/recombee_api_client/api/list_groups.rb
 - lib/recombee_api_client/api/list_item_bookmarks.rb
 - lib/recombee_api_client/api/list_item_cart_additions.rb
 - lib/recombee_api_client/api/list_item_detail_views.rb
@@ -161,11 +156,11 @@ files:
 - lib/recombee_api_client/api/recommend_item_segments_to_item_segment.rb
 - lib/recombee_api_client/api/recommend_item_segments_to_user.rb
 - lib/recombee_api_client/api/recommend_items_to_item.rb
+- lib/recombee_api_client/api/recommend_items_to_item_segment.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
 - lib/recombee_api_client/api/remove_from_series.rb
 - lib/recombee_api_client/api/request.rb
 - lib/recombee_api_client/api/reset_database.rb
@@ -183,11 +178,10 @@ files:
 - lib/recombee_api_client/errors.rb
 - lib/recombee_api_client/version.rb
 - recombee_api_client.gemspec
-homepage: http://recombee.com
+homepage: https://recombee.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -195,15 +189,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Client for Recombee recommendation API
 test_files: []

data/lib/recombee_api_client/api/add_group.rb

@@ -1,49 +0,0 @@
-#
-# This file is auto-generated, do not edit
-#
-
-module RecombeeApiClient
-  require_relative 'request'
-  require_relative '../errors'
-  
-  ##
-  #Creates a new group in the database.
-  class AddGroup < ApiRequest
-    attr_reader :group_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +group_id+ -> ID of the group to be created.
-  #
-    def initialize(group_id)
-      @group_id = group_id
-      @timeout = 1000
-      @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}/groups/#{@group_id}"
-    end
-  end
-end

data/lib/recombee_api_client/api/delete_group.rb

@@ -1,52 +0,0 @@
-#
-# This file is auto-generated, do not edit
-#
-
-module RecombeeApiClient
-  require_relative 'request'
-  require_relative '../errors'
-  
-  ##
-  #Deletes the group of the given `groupId` from the database.
-  #
-  #Deleting a group will only delete the assignment of items to it, not the items themselves!
-  #
-  class DeleteGroup < ApiRequest
-    attr_reader :group_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +group_id+ -> ID of the group to be deleted.
-  #
-    def initialize(group_id)
-      @group_id = group_id
-      @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
-    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}/groups/#{@group_id}"
-    end
-  end
-end

data/lib/recombee_api_client/api/insert_to_group.rb

@@ -1,66 +0,0 @@
-#
-# This file is auto-generated, do not edit
-#
-
-module RecombeeApiClient
-  require_relative 'request'
-  require_relative '../errors'
-  
-  ##
-  #Inserts an existing item/group into a group of the given `groupId`.
-  #
-  class InsertToGroup < ApiRequest
-    attr_reader :group_id, :item_type, :item_id, :cascade_create
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +group_id+ -> ID of the group to be inserted into.
-  #   - +item_type+ -> `item` iff the regular item from the catalog is to be inserted, `group` iff group is inserted as the item.
-  #   - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the group iff `itemType` is `group`.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.
-  #
-    def initialize(group_id, item_type, item_id, optional = {})
-      @group_id = group_id
-      @item_type = item_type
-      @item_id = item_id
-      optional = normalize_optional(optional)
-      @cascade_create = optional['cascadeCreate']
-      @optional = optional
-      @timeout = 1000
-      @ensure_https = false
-      @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["cascadeCreate"].include? par
-      end
-    end
-  
-    # HTTP method
-    def method
-      :post
-    end
-  
-    # Values of body parameters as a Hash
-    def body_parameters
-      p = Hash.new
-      p['itemType'] = @item_type
-      p['itemId'] = @item_id
-      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
-      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}/groups/#{@group_id}/items/"
-    end
-  end
-end

data/lib/recombee_api_client/api/list_group_items.rb

@@ -1,49 +0,0 @@
-#
-# This file is auto-generated, do not edit
-#
-
-module RecombeeApiClient
-  require_relative 'request'
-  require_relative '../errors'
-  
-  ##
-  #List all the items present in the given group.
-  class ListGroupItems < ApiRequest
-    attr_reader :group_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +group_id+ -> ID of the group whose items are to be listed.
-  #
-    def initialize(group_id)
-      @group_id = group_id
-      @timeout = 100000
-      @ensure_https = false
-    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
-    end
-  
-    # Relative path to the endpoint
-    def path
-      "/{databaseId}/groups/#{@group_id}/items/"
-    end
-  end
-end

data/lib/recombee_api_client/api/list_groups.rb

@@ -1,46 +0,0 @@
-#
-# This file is auto-generated, do not edit
-#
-
-module RecombeeApiClient
-  require_relative 'request'
-  require_relative '../errors'
-  
-  ##
-  #Gets the list of all the groups currently present in the database.
-  class ListGroups < ApiRequest
-  
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  #
-    def initialize()
-      @timeout = 100000
-      @ensure_https = false
-    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
-    end
-  
-    # Relative path to the endpoint
-    def path
-      "/{databaseId}/groups/list/"
-    end
-  end
-end

data/lib/recombee_api_client/api/remove_from_group.rb

@@ -1,55 +0,0 @@
-#
-# This file is auto-generated, do not edit
-#
-
-module RecombeeApiClient
-  require_relative 'request'
-  require_relative '../errors'
-  
-  ##
-  #Removes an existing group item from the group.
-  class RemoveFromGroup < ApiRequest
-    attr_reader :group_id, :item_type, :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +group_id+ -> ID of the group from which a group item is to be removed.
-  #   - +item_type+ -> Type of the item to be removed.
-  #   - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the group iff `itemType` is `group`.
-  #
-    def initialize(group_id, item_type, item_id)
-      @group_id = group_id
-      @item_type = item_type
-      @item_id = item_id
-      @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
-    end
-  
-    # Values of query parameters as a Hash.
-    # name of parameter => value of the parameter
-    def query_parameters
-      params = {}
-      params['itemType'] = @item_type
-      params['itemId'] = @item_id
-      params
-    end
-  
-    # Relative path to the endpoint
-    def path
-      "/{databaseId}/groups/#{@group_id}/items/"
-    end
-  end
-end