API-412-413: Upsert and upsert list of product models PHP client

Author: Willy

content/php-client/resources/product-models.md

@@ -28,6 +28,48 @@ $client = new \Akeneo\Pim\AkeneoPimClientBuilder('http://akeneo.com/')->buildAut
 $productModel = $client->getProductModelApi()->get('rain_boots_red');
 ```
 
+### Get a list of product models
+
+There are two ways of getting product models.
+
+#### By getting pages
+
+This method allows to get product models page per page, as a classical pagination.
+It's possible to get the total number of product models with this method.
+
+```php
+$client = new \Akeneo\Pim\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
+
+$firstPage = $client->getProductModelApi()->listPerPage(50, true);
+```
+
+::: warning
+There is a maximum limit allowed on server side for the parameter `limit`.
+:::
+
+::: warning
+Setting the parameter `with_count`  to `true`  can drastically decrease the performance.
+It's recommended to let this parameter with the default value `false` if the total number of product models is not needed in the response.
+:::
+
+You can get more information about this method [here](/php-client/list-resources.html#by-getting-pages).
+
+#### With a cursor
+
+This method allows to iterate the product models. It will automatically get the next pages for you.
+
+```php
+$client = new \Akeneo\Pim\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
+
+$productModels = $client->getProductModelApi()->all(50);
+```
+
+:::warning
+There is a maximum limit allowed on server side for the parameter `pageSize`.
+:::
+
+You can get more information about this method [here](/php-client/list-resources.html#with-a-cursor).
+
 ### Create a product model
 
 If the product model does not exist yet, this method creates it, otherwise it throws an exception.
@@ -60,44 +102,61 @@ $client->getProductModelApi()->create('saddle_rain_boots', [
 
 Product model values use the same format as the product values. If you want to know more, take a look at [here](/documentation/resources.html#product-values).
 
-### Get a list of product models
-
-There are two ways of getting product models.
-
-#### By getting pages
+### Upsert a product model
 
-This method allows to get product models page per page, as a classical pagination.
-It's possible to get the total number of product models with this method.
+If the product model does not exist yet, this method creates it, otherwise it updates it.
 
 ```php
 $client = new \Akeneo\Pim\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
 
-$firstPage = $client->getProductModelApi()->listPerPage(50, true);
+$client->getProductModelApi()->upsert('rain_boots_red', [
+    'categories' => ['2014_collection', 'winter_boots']
+]);
 ```
 
-::: warning
-There is a maximum limit allowed on server side for the parameter `limit`.
-:::
+### Upsert a list of product models
 
-::: warning
-Setting the parameter `with_count`  to `true`  can drastically decrease the performance.
-It's recommended to let this parameter with the default value `false` if the total number of product models is not needed in the response.
-:::
+This method allows to create or update a list of product models.
+It has the same behavior as the `upsert` method for a single product model, except that the code must be specified in the data of each product models.
 
-You can get more information about this method [here](/php-client/list-resources.html#by-getting-pages).
-
-#### With a cursor
-
-This method allows to iterate the product models. It will automatically get the next pages for you.
 
 ```php
 $client = new \Akeneo\Pim\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
 
-$productModels = $client->getProductModelApi()->all(50);
+$responseLines = $client->getProductModelApi()->upsertList([
+    [
+        'code' => 'rain_boots_red',
+        'family_variant' => 'rain_boots_color_size',
+        'parent' => 'rain_boots',
+        'categories' => ['2014_collection', 'winter_boots']
+    ],
+    [
+        'code' => 'rain_boots_saddle',
+        'family_variant' => 'rain_boots_color_size',
+        'parent' => 'rain_boots',
+        'categories' => ['2014_collection', 'winter_boots'],
+        'values' => [
+            'description' => [
+                [
+                    'locale' => 'en_US',
+                    'scope' => 'ecommerce',
+                    'data' => 'Saddle rain boots made of rubber for winter.'
+                ]
+            ]
+        ]
+    ]
+]);
+
+foreach ($responseLines as $line) {
+    echo $line['line'];
+    echo $line['identifier'];
+    echo $line['status_code'];
+    if (isset($line['message'])) {
+        echo $line['message'];
+    }
+}
 ```
 
-:::warning
-There is a maximum limit allowed on server side for the parameter `pageSize`.
+::: warning
+There is a limit on the maximum number of product models that you can upsert in one time on server side. By default this limit is set to 100.
 :::
-
-You can get more information about this method [here](/php-client/list-resources.html#with-a-cursor).