Release: v5.0.0

- Support new Recommend Items to Item Segment endpoint
- Series API improvements:
	- Add Series endpoint creates associated Item for the Series automatically (based on the cascadeCreate parameter)
	- Breaking change: Remove From Series no longer requires the time parameter
- Removed deprecated Groups endpoints

Author: OndraFiedler

README.md

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

composer.json

@@ -10,12 +10,12 @@
         }
     ],
     "require": {
-      "php": ">=7.2.0",
-      "guzzlehttp/guzzle": "^6.0.0 || ^7.0.0"
+        "php": ">=7.2 || ^8.0",
+        "guzzlehttp/guzzle": "^6.0.0 || ^7.0.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.2.2",
-        "phpdocumentor/phpdocumentor": "2.*"
+        "phpunit/phpunit": "^9.5",
+        "phpdocumentor/phpdocumentor": "^3.0"
     },
     "autoload": {
         "psr-4": {

phpdoc.dist.xml

@@ -13,4 +13,4 @@
     <files>
         <directory>src</directory>
     </files>
-</phpdocumentor>
+</phpdocumentor>

src/RecommApi/Client.php

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

src/RecommApi/Exceptions/ResponseException.php

@@ -25,7 +25,7 @@ class ResponseException extends ApiException{
      */
     public $description;
 
-    public function __construct($request, $status_code, $description, \Exception $previous = null) {
+    public function __construct($request, $status_code, $description, ?\Exception $previous = null) {
         $this->request = $request;
         $this->status_code = $status_code;
         $this->description = $description;

src/RecommApi/Requests/AddBookmark.php

@@ -77,7 +77,7 @@ public function __construct($user_id, $item_id, $optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/AddCartAddition.php

@@ -93,7 +93,7 @@ public function __construct($user_id, $item_id, $optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/AddDetailView.php

@@ -85,7 +85,7 @@ public function __construct($user_id, $item_id, $optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/AddGroup.php

@@ -26,7 +26,7 @@ class AddItem extends Request {
      */
     public function __construct($item_id) {
         $this->item_id = $item_id;
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/AddItem.php

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

src/RecommApi/Requests/AddItemProperty.php

@@ -101,7 +101,7 @@ public function __construct($user_id, $item_id, $optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/AddPurchase.php

@@ -83,7 +83,7 @@ public function __construct($user_id, $item_id, $rating, $optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/AddRating.php

@@ -18,14 +18,36 @@ class AddSeries extends Request {
      * @var string $series_id ID of the series to be created.
      */
     protected $series_id;
+    /**
+     * @var bool $cascade_create If set to `true`, the item will be created with the same ID as the series. Default is `true`.
+     */
+    protected $cascade_create;
+    /**
+     * @var array Array containing values of optional parameters
+     */
+   protected $optional;
 
     /**
      * Construct the request
      * @param string $series_id ID of the series to be created.
+     * @param array $optional Optional parameters given as an array containing pairs name of the parameter => value
+     * - Allowed parameters:
+     *     - *cascadeCreate*
+     *         - Type: bool
+     *         - Description: If set to `true`, the item will be created with the same ID as the series. Default is `true`.
+     * @throws Exceptions\UnknownOptionalParameterException UnknownOptionalParameterException if an unknown optional parameter is given in $optional
      */
-    public function __construct($series_id) {
+    public function __construct($series_id, $optional = array()) {
         $this->series_id = $series_id;
-        $this->timeout = 1000;
+        $this->cascade_create = isset($optional['cascadeCreate']) ? $optional['cascadeCreate'] : null;
+        $this->optional = $optional;
+
+        $existing_optional = array('cascadeCreate');
+        foreach ($this->optional as $key => $value) {
+            if (!in_array($key, $existing_optional))
+                 throw new UnknownOptionalParameterException($key);
+         }
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 
@@ -60,6 +82,8 @@ public function getQueryParameters() {
      */
     public function getBodyParameters() {
         $p = array();
+        if (isset($this->optional['cascadeCreate']))
+             $p['cascadeCreate'] = $this-> optional['cascadeCreate'];
         return $p;
     }
 

src/RecommApi/Requests/AddSeries.php

@@ -25,7 +25,7 @@ class AddUser extends Request {
      */
     public function __construct($user_id) {
         $this->user_id = $user_id;
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/AddUser.php

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

src/RecommApi/Requests/AddUserProperty.php

@@ -53,7 +53,7 @@ public function __construct($user_id, $item_id, $optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/DeleteBookmark.php

@@ -53,7 +53,7 @@ public function __construct($user_id, $item_id, $optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/DeleteCartAddition.php

@@ -53,7 +53,7 @@ public function __construct($user_id, $item_id, $optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/DeleteDetailView.php

@@ -27,7 +27,7 @@ class DeleteItem extends Request {
      */
     public function __construct($item_id) {
         $this->item_id = $item_id;
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/DeleteGroup.php

@@ -53,7 +53,7 @@ public function __construct($user_id, $item_id, $optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }
 

src/RecommApi/Requests/DeleteItem.php

@@ -53,7 +53,7 @@ public function __construct($user_id, $item_id, $optional = array()) {
             if (!in_array($key, $existing_optional))
                  throw new UnknownOptionalParameterException($key);
          }
-        $this->timeout = 1000;
+        $this->timeout = 3000;
         $this->ensure_https = false;
     }