recombee_api_client 4.1.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4768bdac13cee19e3667d59b7cac6ac68fb4df9c63f4fbab76eb2168f76e135a
-  data.tar.gz: ce298750cdbcec2ad0ec3d3e9baab087d742f44bc9e3e3fc6bc742dcdfcb8c17
+  metadata.gz: '01199f5f35eecc707fae959cf983926aeb1a27a0abbeba5c04d3aedacf1a750b'
+  data.tar.gz: 96df288201b167f39e340732398f1e084d9cf503b778b220e5fadc0638df4b76
 SHA512:
-  metadata.gz: 1b2c012a478a9a49ebde323fbc5f0b089dbd3287fdd11224abeb2e366a15db0af884068374ffbb46c296ea6f325e9870fda459763e563a7e16391cbc2031cfd3
-  data.tar.gz: e5786b070204e530824968bca26dfb5e5086a9670110a1aced8773c47f1f0a131ff2302a8c15c44483eb2a62bae39cb9744333e898a8749c287456330cae58cb
+  metadata.gz: d248ef770c97da18c94379e924ab57943dfea87b7a4f2483fc28f328623763281853362352321c8d5c25cb8b5556bbf82cf688574ded90da8e530bf611b9407c
+  data.tar.gz: 8c7748c00edff1a6e5459aa853d18cb743a96ec6e4b0d796ade5b6ec69cd0567fc8e3dfbda3b061141a069439e6011447e26540d41e527d1f67e6ef2104c2d02

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Ondřej Fiedler
+Copyright (c) 2015 Recombee
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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_manual_reql_segment.rb

@@ -9,7 +9,7 @@ module RecombeeApiClient
   ##
   #Adds a new Segment into a Manual ReQL Segmentation.
   #
-  #The new Segment is defined by a [ReQL](https://docs.recombee.com/reql.html) filter that returns `true` for an item in case that this item belongs to the segment.
+  #The new Segment is defined by a [ReQL](https://docs.recombee.com/reql) filter that returns `true` for an item in case that this item belongs to the segment.
   #
   class AddManualReqlSegment < ApiRequest
     attr_reader :segmentation_id, :segment_id, :filter, :title

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_search_synonym.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#search-items).
+  #Adds a new synonym for the [Search items](https://docs.recombee.com/api#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`).

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/create_auto_reql_segmentation.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Segment the items using a [ReQL](https://docs.recombee.com/reql.html) expression.
+  #Segment the items using a [ReQL](https://docs.recombee.com/reql) expression.
   #
   #For each item, the expression should return a set that contains IDs of segments to which the item belongs to.
   #

data/lib/recombee_api_client/api/create_manual_reql_segmentation.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Segment the items using multiple [ReQL](https://docs.recombee.com/reql.html) filters.
+  #Segment the items using multiple [ReQL](https://docs.recombee.com/reql) filters.
   #
   #Use the Add Manual ReQL Items Segment endpoint to create the individual segments.
   #

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

@@ -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 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) instead of deleting the item completely.
   #
   class DeleteItem < ApiRequest
     attr_reader :item_id
@@ -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

@@ -9,7 +9,7 @@ module RecombeeApiClient
   ##
   #Deletes 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.
+  #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) instead of deleting the item completely.
   class DeleteMoreItems < ApiRequest
     attr_reader :filter
     attr_accessor :timeout
@@ -17,11 +17,11 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +filter+ -> A [ReQL](https://docs.recombee.com/reql.html) expression, which returns `true` for the items that shall be updated.
+  #   - +filter+ -> A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
   #
     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_search_synonym.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
+  #Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api#search-items).
   #
   class DeleteSearchSynonym < ApiRequest
     attr_reader :id

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/list_items.rb

@@ -16,13 +16,13 @@ module RecombeeApiClient
   ##
   #
   # * *Optional arguments (given as hash optional)*
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter items to be listed. Only the items for which the expression is *true* will be returned.
+  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter items to be listed. Only the items for which the expression is *true* will be returned.
   #   - +count+ -> The number of items to be listed.
   #   - +offset+ -> Specifies the number of items to skip (ordered by `itemId`).
   #   - +returnProperties+ -> With `returnProperties=true`, property values of the listed items are returned along with their IDs in a JSON dictionary. 
   #
   #Example response:
-  #```
+  #```json
   #  [
   #    {
   #      "itemId": "tv-178",
@@ -44,7 +44,7 @@ module RecombeeApiClient
   #   - +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`:
-  #```
+  #```json
   #  [
   #    {
   #      "itemId": "tv-178",

data/lib/recombee_api_client/api/{list_groups.rb → list_scenarios.rb}

@@ -7,8 +7,9 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Gets the list of all the groups currently present in the database.
-  class ListGroups < ApiRequest
+  #Get all [Scenarios](https://docs.recombee.com/scenarios) of the given database.
+  #
+  class ListScenarios < ApiRequest
   
     attr_accessor :timeout
     attr_accessor :ensure_https
@@ -16,7 +17,7 @@ module RecombeeApiClient
   ##
   #
     def initialize()
-      @timeout = 100000
+      @timeout = 10000
       @ensure_https = false
     end
   
@@ -40,7 +41,7 @@ module RecombeeApiClient
   
     # Relative path to the endpoint
     def path
-      "/{databaseId}/groups/list/"
+      "/{databaseId}/scenarios/"
     end
   end
 end

data/lib/recombee_api_client/api/list_users.rb

@@ -16,13 +16,13 @@ module RecombeeApiClient
   ##
   #
   # * *Optional arguments (given as hash optional)*
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned.
+  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned.
   #   - +count+ -> The number of users to be listed.
   #   - +offset+ -> Specifies the number of users to skip (ordered by `userId`).
   #   - +returnProperties+ -> With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary. 
   #
   #Example response:
-  #```
+  #```json
   #  [
   #    {
   #      "userId": "user-81",
@@ -40,7 +40,7 @@ module RecombeeApiClient
   #   - +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=country`:
-  #```
+  #```json
   #  [
   #    {
   #      "userId": "user-81",

data/lib/recombee_api_client/api/merge_users.rb

@@ -12,6 +12,9 @@ module RecombeeApiClient
   #
   #Merging happens between two users referred to as the *target* and the *source*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted**.
   #
+  #By default, the *Merge Users* request is only available from server-side integrations for security reasons, to prevent potential abuse.
+  #If you need to call this request from a client-side environment (such as a web or mobile app), please contact our support and request access to enable this feature for your database.
+  #
   class MergeUsers < ApiRequest
     attr_reader :target_user_id, :source_user_id, :cascade_create
     attr_accessor :timeout

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) 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).
   #
@@ -54,22 +54,22 @@ module RecombeeApiClient
   # * *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.
+  #You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
   #
   #The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
   #
   #   - +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.
   #
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended segments based on the `segmentationId`.
+  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
   #
-  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
+  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
   #
   #   - +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.
+  #See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
   #
   #The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
   #
-  #Logic can also be set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+  #Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
   #
   #   - +expertSettings+ -> Dictionary of custom options.
   #

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) 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).
   #
@@ -53,22 +53,22 @@ module RecombeeApiClient
   # * *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.
+  #You can set various settings to the [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
   #
   #The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
   #
   #   - +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.
   #
-  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended segments based on the `segmentationId`.
+  #   - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
   #
-  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
+  #   - +booster+ -> Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
   #
   #   - +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.
+  #See [this section](https://docs.recombee.com/recommendation_logics) for a list of available logics and other details.
   #
   #The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
   #
-  #Logic can also be set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+  #Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
   #
   #   - +expertSettings+ -> Dictionary of custom options.
   #