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

LevFlavien · web-flow · commit f8695d232109 · 2022-11-03T10:39:31.000+01:00
API-1885: Deprecate unused routes
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 <laurent.petard@akeneo.com>
  * @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 <laurent.petard@akeneo.com>
  * @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 <laurent.petard@akeneo.com>
  * @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 <laurent.petard@akeneo.com>
  * @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 <laurent.petard@akeneo.com>
  * @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 <laurent.petard@akeneo.com>
  * @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 <laurent.petard@akeneo.com>
  * @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 <laurent.petard@akeneo.com>
  * @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 <laurent.petard@akeneo.com>
  * @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 <laurent.petard@akeneo.com>
  * @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
 {

Original file line number	Diff line number	Diff line change
`@@ -331,39 +331,41 @@ public function getProductDraftApi(): ProductDraftApiInterface`
`331`	`331`	`}`
`332`	`332`
`333`	`333`	`/**`
`334`		`- * @return AssetApiInterface`
	`334`	`+ * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.`
	`335`	`+ * @see getAssetManagerApi instead.`
`335`	`336`	`*/`
`336`	`337`	`public function getAssetApi(): AssetApiInterface`
`337`	`338`	`{`
`338`	`339`	`return $this->assetApi;`
`339`	`340`	`}`
`340`	`341`
`341`	`342`	`/**`
`342`		`- * {@inheritdoc}`
	`343`	`+ * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.`
	`344`	`+ * @see getAssetFamilyApi instead.`
`343`	`345`	`*/`
`344`	`346`	`public function getAssetCategoryApi(): AssetCategoryApiInterface`
`345`	`347`	`{`
`346`	`348`	`return $this->assetCategoryApi;`
`347`	`349`	`}`
`348`	`350`
`349`	`351`	`/**`
`350`		`- * {@inheritdoc}`
	`352`	`+ * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.`
`351`	`353`	`*/`
`352`	`354`	`public function getAssetTagApi(): AssetTagApiInterface`
`353`	`355`	`{`
`354`	`356`	`return $this->assetTagApi;`
`355`	`357`	`}`
`356`	`358`
`357`	`359`	`/**`
`358`		`- * {@inheritdoc}`
	`360`	`+ * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.`
`359`	`361`	`*/`
`360`	`362`	`public function getAssetReferenceFileApi(): AssetReferenceFileApiInterface`
`361`	`363`	`{`
`362`	`364`	`return $this->assetReferenceFileApi;`
`363`	`365`	`}`
`364`	`366`
`365`	`367`	`/**`
`366`		`- * {@inheritdoc}`
	`368`	`+ * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.`
`367`	`369`	`*/`
`368`	`370`	`public function getAssetVariationFileApi(): AssetVariationFileApiInterface`
`369`	`371`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`* @author Laurent Petard <laurent.petard@akeneo.com>`
`18`	`18`	`* @copyright 2017 Akeneo SAS (http://www.akeneo.com)`
`19`	`19`	`* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)`
	`20`	`+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.`
	`21`	`+ * @see \Akeneo\Pim\ApiClient\Api\AssetManager\AssetApi instead.`
`20`	`22`	`*/`
`21`	`23`	`class AssetApi implements AssetApiInterface`
`22`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@`
`15`	`15`	`* @author Laurent Petard <laurent.petard@akeneo.com>`
`16`	`16`	`* @copyright 2017 Akeneo SAS (http://www.akeneo.com)`
`17`	`17`	`* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)`
	`18`	`+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.`
	`19`	`+ * @see \Akeneo\Pim\ApiClient\Api\AssetManager\AssetMediaFileApi instead.`
`18`	`20`	`*/`
`19`	`21`	`class AssetReferenceFileApi implements AssetReferenceFileApiInterface`
`20`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@`
`14`	`14`	`* @author Laurent Petard <laurent.petard@akeneo.com>`
`15`	`15`	`* @copyright 2017 Akeneo SAS (http://www.akeneo.com)`
`16`	`16`	`* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)`
	`17`	`+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.`
	`18`	`+ * @see \Akeneo\Pim\ApiClient\Api\AssetManager\AssetMediaFileApiInterface instead.`
`17`	`19`	`*/`
`18`	`20`	`interface AssetReferenceFileApiInterface`
`19`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`* @author Laurent Petard <laurent.petard@akeneo.com>`
`17`	`17`	`* @copyright 2017 Akeneo SAS (http://www.akeneo.com)`
`18`	`18`	`* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)`
	`19`	`+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.`
`19`	`20`	`*/`
`20`	`21`	`class AssetTagApi implements AssetTagApiInterface`
`21`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`* @author Laurent Petard <laurent.petard@akeneo.com>`
`15`	`15`	`* @copyright 2017 Akeneo SAS (http://www.akeneo.com)`
`16`	`16`	`* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)`
	`17`	`+ * @deprecated Route unavailable in latest PIM versions. Class will be removed in v12.0.0.`
`17`	`18`	`*/`
`18`	`19`	`interface AssetTagApiInterface extends GettableResourceInterface, ListableResourceInterface, UpsertableResourceInterface`
`19`	`20`	`{`