Support ListScenarios endpoint

Author: OndraFiedler

README.md

@@ -17,7 +17,7 @@ or
 ```
 {
     "require": {
-        "recombee/php-api-client": "^5.0.0"
+        "recombee/php-api-client": "^5.1.0"
     }
 }
 ```

src/RecommApi/Client.php

@@ -86,7 +86,7 @@ protected function getBaseUri() {
     }
 
     protected function getUserAgent() {
-        $user_agent = 'recombee-php-api-client/5.0.0';
+        $user_agent = 'recombee-php-api-client/5.1.0';
         if (isset($this->options['serviceName']))
             $user_agent .= ' '.($this->options['serviceName']);
         return $user_agent;

src/RecommApi/Requests/AddManualReqlSegment.php

@@ -11,7 +11,7 @@
 
 /**
  * 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 extends Request {
 

src/RecommApi/Requests/AddSearchSynonym.php

@@ -10,7 +10,7 @@
 use Recombee\RecommApi\Exceptions\UnknownOptionalParameterException;
 
 /**
- * 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`).
  * An example of a synonym can be `science fiction` for the term `sci-fi`.

src/RecommApi/Requests/CreateAutoReqlSegmentation.php

@@ -10,7 +10,7 @@
 use Recombee\RecommApi\Exceptions\UnknownOptionalParameterException;
 
 /**
- * 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.
  */
 class CreateAutoReqlSegmentation extends Request {

src/RecommApi/Requests/CreateManualReqlSegmentation.php

@@ -10,7 +10,7 @@
 use Recombee\RecommApi\Exceptions\UnknownOptionalParameterException;
 
 /**
- * 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.
  */
 class CreateManualReqlSegmentation extends Request {

src/RecommApi/Requests/DeleteItem.php

@@ -12,7 +12,7 @@
 /**
  * Deletes an item of the given `itemId` from the catalog.
  * 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 extends Request {
 

src/RecommApi/Requests/DeleteMoreItems.php

@@ -11,18 +11,18 @@
 
 /**
  * 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 extends Request {
 
     /**
-     * @var string $filter A [ReQL](https://docs.recombee.com/reql.html) expression, which returns `true` for the items that shall be updated.
+     * @var string $filter A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
      */
     protected $filter;
 
     /**
      * Construct the request
-     * @param string $filter A [ReQL](https://docs.recombee.com/reql.html) expression, which returns `true` for the items that shall be updated.
+     * @param string $filter A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
      */
     public function __construct($filter) {
         $this->filter = $filter;

src/RecommApi/Requests/DeleteSearchSynonym.php

@@ -10,7 +10,7 @@
 use Recombee\RecommApi\Exceptions\UnknownOptionalParameterException;
 
 /**
- * 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 extends Request {
 

src/RecommApi/Requests/ListItems.php

@@ -15,7 +15,7 @@
 class ListItems extends Request {
 
     /**
-     * @var string $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.
+     * @var string $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.
      */
     protected $filter;
     /**
@@ -29,7 +29,7 @@ class ListItems extends Request {
     /**
      * @var bool $return_properties 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",
@@ -52,7 +52,7 @@ class ListItems extends Request {
     /**
      * @var array $included_properties 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",
@@ -79,7 +79,7 @@ class ListItems extends Request {
      * - Allowed parameters:
      *     - *filter*
      *         - Type: string
-     *         - Description: 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.
+     *         - Description: 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*
      *         - Type: int
      *         - Description: The number of items to be listed.
@@ -90,7 +90,7 @@ class ListItems extends Request {
      *         - Type: bool
      *         - Description: 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",
@@ -112,7 +112,7 @@ class ListItems extends Request {
      *         - Type: array
      *         - Description: 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",