Merge pull request #645 from akeneo/API-1860

PHP client product UUID update

Author: LevFlavien

content/php-client/exception.md

@@ -11,7 +11,7 @@ You can get the request and the response that are responsible for this exception
 
 ```php
 try {
-    $client->getProductApi()->get('top');
+    $client->getProductUuidApi()->get('1cf1d135-26fe-4ac2-9cf5-cdb69ada0547');
 } catch (HttpException $e) {
     // do your stuff with the exception
     $requestBody = $e->getRequest()->getBody();
@@ -80,7 +80,7 @@ It returns an empty array if there is no error in the array.
 
 ```php
 try {
-    $client->getProductApi()->create('top');
+    $client->getProductUuidApi()->create('1cf1d135-26fe-4ac2-9cf5-cdb69ada0547');
 } catch (UnprocessableEntityHttpException $e) {
     // do your stuff with the exception
     $requestBody = $e->getRequest()->getBody();
@@ -103,7 +103,7 @@ It corresponds to the HTTP code 429.
 
 ```php
 try {
-    $client->getProductApi()->get('top');
+    $client->getProductUuidApi()->get('1cf1d135-26fe-4ac2-9cf5-cdb69ada0547');
 } catch (TooManyRequestsHttpException $e) {
     $requestBody = $e->getRequest()->getBody();
     $responseBody = $e->getResponse()->getBody();

content/php-client/getting-started.md

@@ -87,8 +87,8 @@ Want to know more about authentication? It's over [there](/php-client/authentica
 Getting a product is as simple as:
 
 ```
-$product = $client->getProductApi()->get('top');
-echo $product['identifier'];
+$product = $client->getProductUuidApi()->get('1cf1d135-26fe-4ac2-9cf5-cdb69ada0547');
+echo $product['uuid'];
 ```
 
 Want to [update an attribute](/php-client/resources.html#upsert-an-attribute), [create a category](/php-client/resources.html#create-a-category) or [delete a product](/php-client/resources.html#delete-a-product)? You can get code snippets for all the resources [here](/php-client/resources.html)

content/php-client/list-resources.md

@@ -16,10 +16,10 @@ You can define the first parameter `page size` to adjust the number of resources
 
 ```php
 
-$products = $client->getProductApi()->all(50);
+$products = $client->getProductUuidApi()->all(50);
 foreach ($products as $product) {
     // do your stuff here
-    echo $product['identifier'];
+    echo $product['uuid'];
 }
 ```
 
@@ -39,7 +39,7 @@ This method allows to get a list of resources page per page, as a classical pagi
 You get the first page by calling the function `listPerpage`. The first parameter `limit` is the number of elements per page.
 
 ```php
-$firstPage = $client->getProductApi()->listPerPage(50);
+$firstPage = $client->getProductUuidApi()->listPerPage(50);
 ```
 
 ::: warning
@@ -50,7 +50,7 @@ Then, you can iterate the items of this page:
 ```php
 foreach ($firstPage->getItems() as $product) {
     // do your stuff here
-    echo $product['identifier'];
+    echo $product['uuid'];
 }
 ```
 

content/php-client/resources/products/product-drafts-uuid.md

@@ -0,0 +1,82 @@
+### Product draft UUID
+
+::: info
+The following endpoints are largely the same as for [products](/php-client/resources.html#products-draft). The difference? Here, you can query or drafts identified by their uuid. More information [here](/content/getting-started/from-identifiers-to-uuid-7x/welcome.md).
+:::
+
+#### Get a product draft 
+::: php-client-availability versions=10.0
+
+```php
+$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
+
+/*
+ * Returns an array like this:
+ * [
+ *     'uuid' => '12951d98-210e-4bRC-ab18-7fdgf1bd14f3',
+ *     'enabled' => true,
+ *     'family' => 'tshirt',
+ *     'categories' => ['summer_collection'],
+ *     'groups' => [],
+ *     'values' => [
+ *         'sku' => [
+ *             [
+ *                 'locale' => null,
+ *                 'scope' => null,
+ *                 'data' => 'top'
+ *             ]
+ *         ],
+ *         'name' => [
+ *              [
+ *                  'data' => 'Top',
+ *                  'locale' => 'en_US',
+ *                  'scope' => null
+ *              ],
+ *              [
+ *                  'data' => 'Débardeur',
+ *                  'locale' => 'fr_FR',
+ *                  'scope' => null
+ *              ],
+ *         ],
+ *     ],
+ *     'created' => '2016-06-23T18:24:44+02:00',
+ *     'updated' => '2016-06-25T17:56:12+02:00',
+ *     'associations' => [
+ *         'PACK' => [
+ *             'products' => [
+ *                 'sunglass'
+ *             ],
+ *             'groups' => [],
+ *             'product_models' => []
+ *         ],
+ *     ],
+ *     'quantified_associations' => [
+ *         'PRODUCT_SET' => [
+ *             'products' => [
+ *                 ['uuid' => '5719e119-613c-49af-9244-fa39a9e0cb1d', 'quantity' => 2],
+ *             ],
+ *             'product_models' => [],
+ *         ],
+ *     ],
+ *     'metadata' => [
+ *         'workflow_status' => 'draft_in_progress',
+ *     ],
+ * ]
+ */
+$draftProduct = $client->getProductDraftUuidApi()->get('12951d98-210e-4bRC-ab18-7fdgf1bd14f3');
+```
+
+You can get more information about the returned format of the product values [here](/concepts/products.html#focus-on-the-product-values).
+
+The field `metadata` is specific to Akeneo PIM Enterprise Edition. The status of the draft is specified in this field.
+
+#### Submit a product draft for approval
+::: php-client-availability versions=10.0
+
+```php
+$client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
+
+$client->getProductDraftUuidApi()->submitForApproval('12951d98-210e-4bRC-ab18-7fdgf1bd14f3');
+```
+
+It is mandatory that the user already created a draft for this product, and that this draft was not approved yet.