Merge pull request #134 from akeneo/API-409-bis

API-409: List entities PHP client

Author: Willy Mesnage

content/php-client/resources/family-variants.md

@@ -56,3 +56,45 @@ $client->getFamilyVariantApi()->create('boots', 'boots_size_color', [
     ]
 ]);
 ```
+
+### Get a list of family variants
+
+There are two ways of getting family variants.
+
+#### By getting pages
+
+This method allows to get family variants page per page, as a classical pagination.
+It's possible to get the total number of family variants with this method.
+
+```php
+$client = new \Akeneo\Pim\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
+
+$firstPage = $client->getFamilyVariantApi()->listPerPage('boots', 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 family variants 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 family variants. It will automatically get the next pages for you.
+
+```php
+$client = new \Akeneo\Pim\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
+
+$familyVariants = $client->getFamilyVariantApi()->all('boots', 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).

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

@@ -59,3 +59,45 @@ $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
+
+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).