Merge pull request #220 from akeneo/fix-client-doc

NolwennP · web-flow · commit ac76189d1618 · 2018-09-20T16:03:12.000+02:00
Some error in the 3.0 content
diff --git a/content/php-client/ee-resources/product-model-drafts.md b/content/php-client/ee-resources/product-model-drafts.md
diff --git a/content/php-client/introduction.md b/content/php-client/introduction.md
@@ -6,9 +6,10 @@ Two clients exist:
 - a **Community Edition** client, covering the API endpoints of the PIM Community Edition
 - an **Enterprise Edition** client, covering the API endpoints of both the PIM Community Edition and the PIM Enterprise Edition
 
-There are two versions of these clients:
+There are three versions of these clients:
 - The version v1.0 is compatible with the PIM 2.0.
-- The current and latest version v2.0 is compatible with the PIM 2.1
+- The version v2.0 is compatible with the PIM 2.1 and 2.2.
+- The current and latest version v3.0 is compatible with the PIM 2.3.
 
 ## Support & issues
 Please be aware that these PHP clients are only supported **in best effort**, whether you are an Entreprise or Community customer.
diff --git a/content/php-client/resources/product-entities/product-drafts.md b/content/php-client/resources/product-entities/product-drafts.md
@@ -12,34 +12,34 @@ $client = new \Akeneo\PimEnterprise\ApiClient\AkeneoPimEnterpriseClientBuilder('
 /*
  * Returns an array like this:
  * [
- *     'identifier': 'top',
- *     'enabled': true,
- *     'family': 'tshirt',
- *     'categories': ['summer_collection'],
- *     'groups': [],
- *     'values': [
- *         'name': [
+ *     'identifier' => 'top',
+ *     'enabled' => true,
+ *     'family' => 'tshirt',
+ *     'categories' => ['summer_collection'],
+ *     'groups' => [],
+ *     'values' => [
+ *         'name' => [
  *              [
- *                  'data': 'Top',
- *                  'locale': 'en_US',
- *                  'scope': null
+ *                  'data' => 'Top',
+ *                  'locale' => 'en_US',
+ *                  'scope' => null
  *              ],
  *              [
- *                  'data': 'Débardeur',
- *                  'locale': 'fr_FR',
- *                  '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': [
+ *     'created' => '2016-06-23T18:24:44+02:00',
+ *     'updated' => '2016-06-25T17:56:12+02:00',
+ *     'associations' => [
+ *         'PACK' => [
+ *             'products' => [
  *                 'sunglass'
  *             ],
- *             'groups': [],
- *             'product_models': []
+ *             'groups' => [],
+ *             'product_models' => []
  *         ],
  *     ],
  *     'metadata' => [
diff --git a/content/php-client/resources/product-entities/product-model-drafts.md b/content/php-client/resources/product-entities/product-model-drafts.md
@@ -0,0 +1,51 @@
+### Product model draft
+
+::: warning
+This resource is only available in the [Entreprise Edition](https://www.akeneo.com/enterprise-edition/) and in the 3.0 version of the PHP API client.
+:::
+
+#### Get a product model draft 
+
+```php
+$client = new \Akeneo\PimEnterprise\ApiClient\AkeneoPimEnterpriseClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
+
+/*
+ * Returns an array like this:
+ * [
+ *     'code'           => 'rain_boots_red',
+ *     'family_variant' => 'boots_color_size',
+ *     'parent'         => 'rain_boots',
+ *     'categories'     => ['2014_collection', 'winter_collection', 'winter_boots'],
+ *     'values'         => [
+ *         'name' => [
+ *             [
+ *                 'locale' => 'en_US',
+ *                 'scope' => null,
+ *                 'data' => 'Red rain boots',
+ *             ]
+ *         ],
+ *     ],
+ *     'created' => '2017-10-17T14:12:35+00:00',
+ *     'updated' => '2017-10-17T14:12:35+00:00',
+ *     'metadata' => [
+ *         'workflow_status' => 'draft_in_progress',
+ *     ],
+ * ]
+ */
+$draftProduct = $client->getProductModelDraftApi()->get('rain_boots_red');
+```
+
+You can get more information about the returned format of the product values [here](/documentation/resources.html#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 model draft for approval
+
+```php
+$client = new \Akeneo\PimEnterprise\ApiClient\AkeneoPimEnterpriseClientBuilder('http://akeneo.com/')->buildAuthenticatedByPassword('client_id', 'secret', 'admin', 'admin');
+
+$client->getProductModelDraftApi()->submitForApproval('rain_boots_red');
+```
+
+It is mandatory that the user already created a draft for the product model `rain_boots_red`, and that this draft was not approved yet.
diff --git a/content/php-client/resources/product-entities/product-models.md b/content/php-client/resources/product-entities/product-models.md
@@ -30,16 +30,16 @@ $productModel = $client->getProductModelApi()->get('rain_boots_red');
 
 You can get more information about the returned format of the product values [here](/documentation/resources.html#product-values).
 
-Since the 2.3 version, in the Enterprise Edition, the response contains one more field `metadata`. Look at the [product model drafts](/php-client/ee-resources.html#product-model-draft) for an example.
+Since the 2.3 version, in the Enterprise Edition, the response contains one more field `metadata`. Look at the [product model drafts](/php-client/resources.html#product-model-draft) for an example.
 
 #### Get a list of product models
 
 There are two ways of getting product models.
 
-*Search builder**
+**Search builder**
 
 ::: warning
-This feature is only available since the version 2.0 of the PHP API client.
+This feature is only available since the version 3.0 of the PHP API client.
 Also it was added in the 2.3 version of the PIM and is therefore not present in previous versions.
 :::
 
@@ -62,7 +62,7 @@ $searchFilters = $searchBuilder->getFilters();
 
 This method allows you 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.
-As for the paginated method, since the 2.3 version of the Akeneo PIM, the search builder can be used and all query parameters are available, except `with_count`.
+As for the paginated method, since the 3.0 version of the PHP client, the search builder can be used and all query parameters are available, except `with_count`.
 
 For example, we only return product values belonging to the channel "ecommerce" by adding the query parameter `'scope' => 'ecommerce'`. 
 ```php
@@ -93,7 +93,7 @@ You can get more information about this method [here](/php-client/list-resources
 This method allows you to iterate the product models. It will automatically get the next pages for you.
 With this method, it's not possible to get the previous page, or get the total number of product models.
 
-As for the paginated method, since the 2.3 version of the Akeneo PIM, the search builder can be used and all query parameters are available, except `with_count`.
+As for the paginated method, since the 3.0 version of the PHP client, the search builder can be used and all query parameters are available, except `with_count`.
 
 For example, in this example, we only return product values belonging to the channel "ecommerce" by adding the query parameter `'scope' => 'ecommerce'`. 
 
diff --git a/content/php-client/resources/product-entities/products.md b/content/php-client/resources/product-entities/products.md
@@ -8,35 +8,35 @@ $client = new \Akeneo\Pim\ApiClient\AkeneoPimClientBuilder('http://akeneo.com/')
 /*
  * Returns an array like this:
  * [
- *     'identifier': 'top',
- *     'enabled': true,
- *     'family': 'tshirt',
- *     'categories': ['summer_collection'],
- *     'groups': [],
- *     'parent': null,
- *     'values': [
- *         'name': [
+ *     'identifier' => 'top',
+ *     'enabled' => true,
+ *     'family' => 'tshirt',
+ *     'categories' => ['summer_collection'],
+ *     'groups' => [],
+ *     'parent' => null,
+ *     'values' => [
+ *         'name' => [
  *              [
- *                  'data': 'Top',
- *                  'locale': 'en_US',
- *                  'scope': null
+ *                  'data' => 'Top',
+ *                  'locale' => 'en_US',
+ *                  'scope' => null
  *              ],
  *              [
- *                  'data': 'Débardeur',
- *                  'locale': 'fr_FR',
- *                  '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': [
+ *     'created' => '2016-06-23T18:24:44+02:00',
+ *     'updated' => '2016-06-25T17:56:12+02:00',
+ *     'associations' => [
+ *         'PACK' => [
+ *             'products' => [
  *                 'sunglass'
  *             ],
- *             'groups': [],
- *             'product_models': []
+ *             'groups' => [],
+ *             'product_models' => []
  *         ],
  *     ],
  * ]
@@ -46,7 +46,7 @@ $product = $client->getProductApi()->get('top');
 
 You can get more information about the returned format of the product values [here](/documentation/resources.html#product-values).
 
-In the Enterprise Edition, the response contains one more field `metadata`. Look at the [product drafts](/php-client/ee-resources.html#product-draft) for an example.
+In the Enterprise Edition, the response contains one more field `metadata`. Look at the [product drafts](/php-client/resources.html#product-draft) for an example.
 
 ::: warning
 The field `product_models` in the `associations` property was added in the 2.1 version of the PIM and is therefore not present in previous versions.
diff --git a/content/php-client/resources/product-entities/published-products.md b/content/php-client/resources/product-entities/published-products.md
@@ -12,34 +12,34 @@ $client = new \Akeneo\PimEnterprise\ApiClient\AkeneoPimEnterpriseClientBuilder('
 /*
  * Returns an array like this:
  * [
- *     'identifier': 'top',
- *     'enabled': true,
- *     'family': 'tshirt',
- *     'categories': ['summer_collection'],
- *     'groups': [],
- *     'values': [
- *         'name': [
+ *     'identifier' => 'top',
+ *     'enabled' => true,
+ *     'family' => 'tshirt',
+ *     'categories' => ['summer_collection'],
+ *     'groups' => [],
+ *     'values' => [
+ *         'name' => [
  *              [
- *                  'data': 'Top',
- *                  'locale': 'en_US',
- *                  'scope': null
+ *                  'data' => 'Top',
+ *                  'locale' => 'en_US',
+ *                  'scope' => null
  *              ],
  *              [
- *                  'data': 'Débardeur',
- *                  'locale': 'fr_FR',
- *                  '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': [
+ *     'created' => '2016-06-23T18:24:44+02:00',
+ *     'updated' => '2016-06-25T17:56:12+02:00',
+ *     'associations' => [
+ *         'PACK' => [
+ *             'products' => [
  *                 'sunglass'
  *             ],
- *             'groups': [],
- *             'product_models': []
+ *             'groups' => [],
+ *             'product_models' => []
  *         ],
  *     ],
  * ]
