recombee_api_client 6.1.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 251fbc7719eb5f880e85cbc68996c563e893c0bc30b304ee75c5b34c19ac6b99
-  data.tar.gz: 753e1a9f4bf897a7e15a6ddc2127f7ca062193a1c2fce6674815167eed87ce84
+  metadata.gz: 322e3294002769557374b46669a1958f70b82f0d0934d0c3591fe2171d6f4339
+  data.tar.gz: 454a96ba684ea9cfd9ccfe054dc11a3882c44ea223d791443ebfec60942283d6
 SHA512:
-  metadata.gz: 5a83df05802119f4c100a2f63dfd1efa216db575a6c6547fe93c0611a0a0bd509b603d9a20facb57ba829d944b750ae73d061dbce3fa14de11d5a0d2d7381d51
-  data.tar.gz: 85e6cd1960ebab74f7de00ca4dbf0da42ba001bd9d3f7685d0f43609ebef8323836b04b4cb386aff2519a46c4fd79e39abacaa1bb641704d21d315c6d30d8c89
+  metadata.gz: b81694d2b9129008f36176f97549987cc0b6e70e1483c7255f1a96e93212bd031a39e195affa1a983981a5ebb75bd39a7681769f285e59d718cdc46119c4544d
+  data.tar.gz: bab1496561a47afc49bf0395848d31a903bf6e6bcaee3c438c5c04957b3833a6b59e67886414f49a7a4b077dd2e4dbfdc1951b443867bf639cc2c5ec308bc0cb

data/lib/recombee_api_client/api/add_item_property.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   # Adding an item property is somewhat equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.
   #
   class AddItemProperty < ApiRequest
-    attr_reader :property_name, :type
+    attr_reader :property_name, :type, :role, :metadata
     attr_accessor :timeout, :ensure_https
 
     ##
@@ -19,7 +19,7 @@ module RecombeeApiClient
     #
     #   - +type+ -> Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
     #
-    # * `int`- Signed integer number.
+    # * `int` - Signed integer number.
     #
     # * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
     #
@@ -27,7 +27,7 @@ module RecombeeApiClient
     #
     # * `boolean` - *true* / *false*
     #
-    # * `timestamp` - Value representing date and time.
+    # * `timestamp` - Value representing date and time. ISO8601-1 pattern (string) or UTC epoch time (number).
     #
     # * `set` - Set of strings.
     #
@@ -36,11 +36,23 @@ module RecombeeApiClient
     # * `imageList` - List of URLs that refer to images.
     #
     #
-    def initialize(property_name, type)
+    # * *Optional arguments (given as hash optional)*
+    #   - +role+ -> [Role](https://docs.recombee.com/api/property_roles_metadata#roles) to assign to the property.
+    #
+    #   - +metadata+ -> List of [metadata](https://docs.recombee.com/api/property_roles_metadata#metadata) entries to assign to the property.
+    #
+    def initialize(property_name, type, optional = {})
       @property_name = property_name
       @type = type
+      optional = normalize_hash_to_camel_case(optional)
+      @role = optional['role']
+      @metadata = optional['metadata']
+      @optional = optional
       @timeout = 100_000
       @ensure_https = false
+      @optional.each do |par, _|
+        raise UnknownOptionalParameter.new(par) unless %w[role metadata].include? par
+      end
     end
 
     # HTTP method
@@ -50,16 +62,18 @@ module RecombeeApiClient
 
     # Values of body parameters as a Hash
     def body_parameters
-      {}
+      p = {}
+      p['type'] = @type
+      p['role'] = @optional['role'] if @optional.include? 'role'
+      p['metadata'] = @optional['metadata'] if @optional.include? 'metadata'
+
+      p
     end
 
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params['type'] = @type
-
-      params
+      {}
     end
 
     # Relative path to the endpoint

data/lib/recombee_api_client/api/add_user_property.rb

@@ -10,7 +10,7 @@ module RecombeeApiClient
   # 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
+    attr_reader :property_name, :type, :role, :metadata
     attr_accessor :timeout, :ensure_https
 
     ##
@@ -27,16 +27,28 @@ module RecombeeApiClient
     #
     # * `boolean` - *true* / *false*
     #
-    # * `timestamp` - Value representing date and time.
+    # * `timestamp` - Value representing date and time. ISO8601-1 pattern (string) or UTC epoch time (number).
     #
     # * `set` - Set of strings.
     #
     #
-    def initialize(property_name, type)
+    # * *Optional arguments (given as hash optional)*
+    #   - +role+ -> [Role](https://docs.recombee.com/api/property_roles_metadata#roles) to assign to the property.
+    #
+    #   - +metadata+ -> List of [metadata](https://docs.recombee.com/api/property_roles_metadata#metadata) entries to assign to the property.
+    #
+    def initialize(property_name, type, optional = {})
       @property_name = property_name
       @type = type
+      optional = normalize_hash_to_camel_case(optional)
+      @role = optional['role']
+      @metadata = optional['metadata']
+      @optional = optional
       @timeout = 100_000
       @ensure_https = false
+      @optional.each do |par, _|
+        raise UnknownOptionalParameter.new(par) unless %w[role metadata].include? par
+      end
     end
 
     # HTTP method
@@ -46,16 +58,18 @@ module RecombeeApiClient
 
     # Values of body parameters as a Hash
     def body_parameters
-      {}
+      p = {}
+      p['type'] = @type
+      p['role'] = @optional['role'] if @optional.include? 'role'
+      p['metadata'] = @optional['metadata'] if @optional.include? 'metadata'
+
+      p
     end
 
     # Values of query parameters as a Hash.
     # name of parameter => value of the parameter
     def query_parameters
-      params = {}
-      params['type'] = @type
-
-      params
+      {}
     end
 
     # Relative path to the endpoint

data/lib/recombee_api_client/api/composite_recommendation.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
 
   ##
-  # Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations.html)) and a list of related recommendations in a single response.
+  # Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations)) and a list of related recommendations in a single response.
   #
   # It is ideal for use cases such as personalized homepage sections (*Articles from <category>*), *Because You Watched <movie>*, or *Artists Related to Your Favorite Artist <artist>*.
   #
@@ -37,8 +37,8 @@ module RecombeeApiClient
   # See [this example](https://docs.recombee.com/api#composite-recommendation-example-setting-parameters-for-individual-stages) for more details.
   #
   class CompositeRecommendation < ApiRequest
-    attr_reader :scenario, :count, :item_id, :user_id, :logic, :segment_id, :cascade_create, :source_settings,
-                :result_settings, :expert_settings
+    attr_reader :scenario, :count, :item_id, :user_id, :logic, :segment_id, :search_query, :cascade_create,
+                :source_settings, :result_settings, :expert_settings
     attr_accessor :timeout, :ensure_https
 
     ##
@@ -66,6 +66,8 @@ module RecombeeApiClient
     #
     #   - +segmentId+ -> ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
     #
+    #   - +searchQuery+ -> Search query provided by the user. It is used for the full-text search. Only applicable if the *scenario* corresponds to a search scenario.
+    #
     #   - +cascadeCreate+ -> If the entity for the source recommendation does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that entity, as the entity will be already known to the system.
     #
     #   - +sourceSettings+ -> Parameters applied for recommending the *Source* stage. The accepted parameters correspond with the recommendation sub-endpoint used to recommend the *Source*.
@@ -83,6 +85,7 @@ module RecombeeApiClient
       @user_id = optional['userId']
       @logic = optional['logic']
       @segment_id = optional['segmentId']
+      @search_query = optional['searchQuery']
       @cascade_create = optional['cascadeCreate']
       @source_settings = optional['sourceSettings']
       @result_settings = optional['resultSettings']
@@ -91,8 +94,8 @@ module RecombeeApiClient
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        raise UnknownOptionalParameter.new(par) unless %w[itemId userId logic segmentId cascadeCreate
-                                                          sourceSettings resultSettings expertSettings].include? par
+        raise UnknownOptionalParameter.new(par) unless %w[itemId userId logic segmentId searchQuery
+                                                          cascadeCreate sourceSettings resultSettings expertSettings].include? par
       end
     end
 
@@ -110,6 +113,7 @@ module RecombeeApiClient
       p['userId'] = @optional['userId'] if @optional.include? 'userId'
       p['logic'] = @optional['logic'] if @optional.include? 'logic'
       p['segmentId'] = @optional['segmentId'] if @optional.include? 'segmentId'
+      p['searchQuery'] = @optional['searchQuery'] if @optional.include? 'searchQuery'
       p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
       p['sourceSettings'] = @optional['sourceSettings'] if @optional.include? 'sourceSettings'
       p['resultSettings'] = @optional['resultSettings'] if @optional.include? 'resultSettings'

data/lib/recombee_api_client/api/recommend_next_item_segments.rb

@@ -0,0 +1,70 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+
+  ##
+  # Returns [Item Segments](https://docs.recombee.com/segmentations) to be shown as the next recommendations when a user scrolls (e.g., within a carousel or feed of Item Segments such as brands, artists, topics, or categories).
+  #
+  # The request requires the `recommId` of a base recommendation request and the number of Segments to return (`count`).
+  #
+  # The base request can be one of:
+  #  - [Recommend Item Segments to Item](https://docs.recombee.com/api#recommend-item-segments-to-item)
+  #  - [Recommend Item Segments to User](https://docs.recombee.com/api#recommend-item-segments-to-user)
+  #  - [Recommend Item Segments to Item Segment](https://docs.recombee.com/api#recommend-item-segments-to-item-segment)
+  #  - [Search Item Segments](https://docs.recombee.com/api#search-item-segments)
+  #
+  # All other parameters are inherited from the base request associated with the provided `recommId`.
+  #
+  # This endpoint can be called multiple times for a single `recommId`. Each call returns different Item Segments that have not been recommended in previous calls.
+  # The number of calls made so far is returned in the `numberNextRecommsCalls` field.
+  #
+  # Requests can be made up to 30 minutes after the base request or the most recent Recommend Next Item Segments call.
+  #
+  # For billing purposes, each call to this endpoint is counted as a separate recommendation request.
+  #
+  class RecommendNextItemSegments < ApiRequest
+    attr_reader :recomm_id, :count
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +recomm_id+ -> ID of the base recommendation request for which next recommendations should be returned
+    #   - +count+ -> Number of item segments 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 = {}
+      p['count'] = @count
+
+      p
+    end
+
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      {}
+    end
+
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/recomms/next/item-segments/#{@recomm_id}"
+    end
+  end
+end

data/lib/recombee_api_client/inputs/property_metadata.rb

@@ -0,0 +1,46 @@
+#
+# This file is auto-generated, do not edit
+#
+
+require 'json'
+
+module RecombeeApiClient
+  require_relative 'input'
+  require_relative '../errors'
+
+  ##
+  # Initializes PropertyMetadata input#
+  class PropertyMetadata < Input
+    attr_reader :name, :settings
+
+    ##
+    # * *Required arguments*
+    #   - +name+ -> Name of the [metadata](https://docs.recombee.com/api/property_roles_metadata#metadata) assigned to the property.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +settings+ -> Optional configuration for this metadata entry.
+    #
+    def initialize(name, optional = {})
+      @name = name
+      optional = normalize_hash_to_camel_case(optional)
+      @settings = optional['settings']
+      @optional = optional
+      @optional.each do |par, _|
+        raise UnknownOptionalParameter.new(par) unless ['settings'].include? par
+      end
+    end
+
+    # Return only JSON-serializable primitives.
+    def as_json(_options = {})
+      res = {}
+      res['name'] = @name
+      res['settings'] = @optional['settings'] if @optional['settings']
+
+      res
+    end
+
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+  end
+end

data/lib/recombee_api_client/inputs/property_role.rb

@@ -0,0 +1,46 @@
+#
+# This file is auto-generated, do not edit
+#
+
+require 'json'
+
+module RecombeeApiClient
+  require_relative 'input'
+  require_relative '../errors'
+
+  ##
+  # Initializes PropertyRole input#
+  class PropertyRole < Input
+    attr_reader :name, :settings
+
+    ##
+    # * *Required arguments*
+    #   - +name+ -> Name of the [role](https://docs.recombee.com/api/property_roles_metadata#roles) assigned to the property.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +settings+ -> Optional configuration specific to the selected role.
+    #
+    def initialize(name, optional = {})
+      @name = name
+      optional = normalize_hash_to_camel_case(optional)
+      @settings = optional['settings']
+      @optional = optional
+      @optional.each do |par, _|
+        raise UnknownOptionalParameter.new(par) unless ['settings'].include? par
+      end
+    end
+
+    # Return only JSON-serializable primitives.
+    def as_json(_options = {})
+      res = {}
+      res['name'] = @name
+      res['settings'] = @optional['settings'] if @optional['settings']
+
+      res
+    end
+
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+  end
+end

data/lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '6.1.0'
+  VERSION = '6.3.0'
 end

data/lib/recombee_api_client.rb

@@ -19,7 +19,7 @@ module RecombeeApiClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10_000
-    USER_AGENT = { 'User-Agent' => 'recombee-ruby-api-client/6.1.0' }
+    USER_AGENT = { 'User-Agent' => 'recombee-ruby-api-client/6.3.0' }
 
     ##
     #   - +account+ -> Name of your account at Recombee

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.3.0
 platform: ruby
 authors:
 - Ondřej Fiedler
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -159,6 +159,7 @@ files:
 - 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_item_segments.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
@@ -180,6 +181,8 @@ files:
 - lib/recombee_api_client/inputs/composite_recommendation_stage_parameters.rb
 - lib/recombee_api_client/inputs/input.rb
 - lib/recombee_api_client/inputs/logic.rb
+- lib/recombee_api_client/inputs/property_metadata.rb
+- lib/recombee_api_client/inputs/property_role.rb
 - lib/recombee_api_client/utils/hash_normalizer.rb
 - lib/recombee_api_client/version.rb
 - recombee_api_client.gemspec
@@ -201,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Client for Recombee recommendation API
 test_files: []