Support ListScenarios endpoint

Author: OndraFiedler

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

lib/recombee_api_client.rb

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

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

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`).

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.
   #

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.
   #

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

lib/recombee_api_client/api/delete_more_items.rb

@@ -9,15 +9,15 @@ 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
     attr_accessor :ensure_https
 
   ##
   # * *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

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

lib/recombee_api_client/api/list_items.rb

@@ -16,13 +16,13 @@ class ListItems < ApiRequest
   ##
   #
   # * *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 @@ class ListItems < ApiRequest
   #   - +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",