Merge pull request #253 from akeneo/API-1885-php-client-deprecate-old…

…-asset-routes API-1885: Deprecate unused routes
akeneo · Nov 3, 2022 · f8695d2 · f8695d2
2 parents d651cc6 + 5b51536
commit f8695d2
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 5 deletions.
diff --git a/src/AkeneoPimClient.php b/src/AkeneoPimClient.php
@@ -331,39 +331,41 @@ public function getProductDraftApi(): ProductDraftApiInterface
     }
 
     /**
-     * @return AssetApiInterface
+     * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
+     * @see getAssetManagerApi instead.
      */
     public function getAssetApi(): AssetApiInterface
     {
         return $this->assetApi;
     }
 
     /**
-     * {@inheritdoc}
+     * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
+     * @see getAssetFamilyApi instead.
      */
     public function getAssetCategoryApi(): AssetCategoryApiInterface
     {
         return $this->assetCategoryApi;
     }
 
     /**
-     * {@inheritdoc}
+     * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
      */
     public function getAssetTagApi(): AssetTagApiInterface
     {
         return $this->assetTagApi;
     }
 
     /**
-     * {@inheritdoc}
+     * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
      */
     public function getAssetReferenceFileApi(): AssetReferenceFileApiInterface
     {
         return $this->assetReferenceFileApi;
     }
 
     /**
-     * {@inheritdoc}
+     * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
      */
     public function getAssetVariationFileApi(): AssetVariationFileApiInterface
     {

diff --git a/src/AkeneoPimClientInterface.php b/src/AkeneoPimClientInterface.php
@@ -89,14 +89,31 @@ public function getProductModelDraftApi(): ProductModelDraftApiInterface;
 
     public function getProductDraftApi(): ProductDraftApiInterface;
 
+    /**
+     * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
+     * @see getAssetManagerApi instead.
+     */
     public function getAssetApi(): AssetApiInterface;
 
+    /**
+     * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
+     * @see getAssetFamilyApi instead.
+     */
     public function getAssetCategoryApi(): AssetCategoryApiInterface;
 
+    /**
+     * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
+     */
     public function getAssetTagApi(): AssetTagApiInterface;
 
+    /**
+     * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
+     */
     public function getAssetReferenceFileApi(): AssetReferenceFileApiInterface;
 
+    /**
+     * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
+     */
     public function getAssetVariationFileApi(): AssetVariationFileApiInterface;
 
     public function getReferenceEntityRecordApi(): ReferenceEntityRecordApiInterface;

diff --git a/src/Api/AssetApi.php b/src/Api/AssetApi.php
@@ -17,6 +17,8 @@
  * @author    Laurent Petard <[email protected]>
  * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.
+ * @see \Akeneo\Pim\ApiClient\Api\AssetManager\AssetApi instead.
  */
 class AssetApi implements AssetApiInterface
 {

diff --git a/src/Api/AssetApiInterface.php b/src/Api/AssetApiInterface.php
@@ -16,6 +16,8 @@
  * @author    Laurent Petard <[email protected]>
  * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.
+ * @see \Akeneo\Pim\ApiClient\Api\AssetManager\AssetApiInterface instead.
  */
 interface AssetApiInterface extends
     GettableResourceInterface,

diff --git a/src/Api/AssetCategoryApi.php b/src/Api/AssetCategoryApi.php
@@ -17,6 +17,8 @@
  * @author    Laurent Petard <[email protected]>
  * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.
+ * @see \Akeneo\Pim\ApiClient\Api\AssetManager\AssetFamilyApi instead.
  */
 class AssetCategoryApi implements AssetCategoryApiInterface
 {

diff --git a/src/Api/AssetCategoryApiInterface.php b/src/Api/AssetCategoryApiInterface.php
@@ -16,6 +16,8 @@
  * @author    Laurent Petard <[email protected]>
  * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.
+ * @see \Akeneo\Pim\ApiClient\Api\AssetManager\AssetFamilyApiInterface instead.
  */
 interface AssetCategoryApiInterface extends
     GettableResourceInterface,

diff --git a/src/Api/AssetReferenceFileApi.php b/src/Api/AssetReferenceFileApi.php
@@ -15,6 +15,8 @@
  * @author    Laurent Petard <[email protected]>
  * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.
+ * @see \Akeneo\Pim\ApiClient\Api\AssetManager\AssetMediaFileApi instead.
  */
 class AssetReferenceFileApi implements AssetReferenceFileApiInterface
 {

diff --git a/src/Api/AssetReferenceFileApiInterface.php b/src/Api/AssetReferenceFileApiInterface.php
@@ -14,6 +14,8 @@
  * @author    Laurent Petard <[email protected]>
  * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.
+ * @see \Akeneo\Pim\ApiClient\Api\AssetManager\AssetMediaFileApiInterface instead.
  */
 interface AssetReferenceFileApiInterface
 {

diff --git a/src/Api/AssetTagApi.php b/src/Api/AssetTagApi.php
@@ -16,6 +16,7 @@
  * @author    Laurent Petard <[email protected]>
  * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.
  */
 class AssetTagApi implements AssetTagApiInterface
 {

diff --git a/src/Api/AssetTagApiInterface.php b/src/Api/AssetTagApiInterface.php
@@ -14,6 +14,7 @@
  * @author    Laurent Petard <[email protected]>
  * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.
  */
 interface AssetTagApiInterface extends GettableResourceInterface, ListableResourceInterface, UpsertableResourceInterface
 {

diff --git a/src/Api/AssetVariationFileApi.php b/src/Api/AssetVariationFileApi.php
@@ -14,6 +14,7 @@
  * @author    Laurent Petard <[email protected]>
  * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.
  */
 class AssetVariationFileApi implements AssetVariationFileApiInterface
 {

diff --git a/src/Api/AssetVariationFileApiInterface.php b/src/Api/AssetVariationFileApiInterface.php
@@ -12,6 +12,7 @@
  * @author    Laurent Petard <[email protected]>
  * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
  * @license   http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.
  */
 interface AssetVariationFileApiInterface
 {