Implement SystemInformationApi for the GET endpoint /api/rest/v1/system-information

spec/AkeneoPimClientSpec.php

@@ -42,6 +42,7 @@
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityAttributeOptionApiInterface;
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityMediaFileApiInterface;
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityRecordApiInterface;
+use Akeneo\Pim\ApiClient\Api\SystemInformationApiInterface;
 use Akeneo\Pim\ApiClient\Security\Authentication;
 use PhpSpec\ObjectBehavior;
 
@@ -86,7 +87,8 @@ function let(
         ProductUuidApiInterface $productUuidApi,
         ProductDraftUuidApiInterface $productDraftUuidApi,
         AppCatalogApiInterface $appCatalogApi,
-        AppCatalogProductApiInterface $appCatalogProductApi
+        AppCatalogProductApiInterface $appCatalogProductApi,
+        SystemInformationApiInterface $systemInformationApi,
     ) {
         $this->beConstructedWith(
             $authentication,
@@ -127,7 +129,8 @@ function let(
             $productUuidApi,
             $productDraftUuidApi,
             $appCatalogApi,
-            $appCatalogProductApi
+            $appCatalogProductApi,
+            $systemInformationApi
         );
     }
 

spec/Api/SystemInformationApiSpec.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace spec\Akeneo\Pim\ApiClient\Api;
+
+use Akeneo\Pim\ApiClient\Api\SystemInformationApi;
+use Akeneo\Pim\ApiClient\Api\SystemInformationApiInterface;
+use Akeneo\Pim\ApiClient\Client\ResourceClientInterface;
+use Akeneo\Pim\ApiClient\Pagination\PageFactoryInterface;
+use Akeneo\Pim\ApiClient\Pagination\ResourceCursorFactoryInterface;
+use PhpSpec\ObjectBehavior;
+
+class SystemInformationApiSpec extends ObjectBehavior
+{
+    function let(
+        ResourceClientInterface $resourceClient,
+        PageFactoryInterface $pageFactory,
+        ResourceCursorFactoryInterface $cursorFactory
+    ) {
+        $this->beConstructedWith($resourceClient, $pageFactory, $cursorFactory);
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType(SystemInformationApi::class);
+        $this->shouldImplement(SystemInformationApiInterface::class);
+    }
+
+    function it_returns_system_information($resourceClient)
+    {
+        $systemInformation = [
+            'code'       => 'foo',
+            'attributes' => ['sku'],
+            'sort_order' => 1,
+            'labels'     => [
+                'en_US' => 'Foo',
+            ],
+        ];
+
+        $resourceClient
+            ->getResource(SystemInformationApi::SYSTEM_INFORMATION_URI)
+            ->willReturn($systemInformation);
+
+        $this->get()->shouldReturn($systemInformation);
+    }
+}

src/AkeneoPimClient.php

@@ -41,6 +41,8 @@
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityAttributeOptionApiInterface;
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityMediaFileApiInterface;
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityRecordApiInterface;
+use Akeneo\Pim\ApiClient\Api\SystemInformationApi;
+use Akeneo\Pim\ApiClient\Api\SystemInformationApiInterface;
 use Akeneo\Pim\ApiClient\Security\Authentication;
 
 /**
@@ -91,7 +93,8 @@ public function __construct(
         private ProductUuidApiInterface $productUuidApi,
         private ProductDraftUuidApiInterface $productDraftUuidApi,
         private AppCatalogApiInterface $appCatalogApi,
-        private AppCatalogProductApiInterface $appCatalogProductApi
+        private AppCatalogProductApiInterface $appCatalogProductApi,
+        private SystemInformationApiInterface $systemInformationApi
     ) {
     }
 
@@ -265,7 +268,7 @@ public function getProductDraftApi(): ProductDraftApiInterface
 
     /**
      * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
-     * @see getAssetManagerApi instead.
+     * @see        getAssetManagerApi instead.
      */
     public function getAssetApi(): AssetApiInterface
     {
@@ -274,7 +277,7 @@ public function getAssetApi(): AssetApiInterface
 
     /**
      * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
-     * @see getAssetFamilyApi instead.
+     * @see        getAssetFamilyApi instead.
      */
     public function getAssetCategoryApi(): AssetCategoryApiInterface
     {
@@ -416,4 +419,12 @@ public function getAppCatalogProductApi(): AppCatalogProductApiInterface
     {
         return $this->appCatalogProductApi;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getSystemInformationApi(): SystemInformationApi
+    {
+        return $this->systemInformationApi;
+    }
 }

src/AkeneoPimClientBuilder.php

@@ -41,6 +41,7 @@
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityAttributeOptionApi;
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityMediaFileApi;
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityRecordApi;
+use Akeneo\Pim\ApiClient\Api\SystemInformationApi;
 use Akeneo\Pim\ApiClient\Cache\LRUCache;
 use Akeneo\Pim\ApiClient\Client\AuthenticatedHttpClient;
 use Akeneo\Pim\ApiClient\Client\CachedResourceClient;
@@ -249,7 +250,8 @@ protected function buildAuthenticatedClient(Authentication $authentication): Ake
             new ProductUuidApi($resourceClient, $pageFactory, $cursorFactory),
             new ProductDraftUuidApi($resourceClient, $pageFactory, $cursorFactory),
             new AppCatalogApi($resourceClient, $pageFactory, $cursorFactory),
-            new AppCatalogProductApi($resourceClient, $pageFactory, $cursorFactory)
+            new AppCatalogProductApi($resourceClient, $pageFactory, $cursorFactory),
+            new SystemInformationApi($resourceClient)
         );
     }
 

src/AkeneoPimClientInterface.php

@@ -40,6 +40,7 @@
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityAttributeOptionApiInterface;
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityMediaFileApiInterface;
 use Akeneo\Pim\ApiClient\Api\ReferenceEntityRecordApiInterface;
+use Akeneo\Pim\ApiClient\Api\SystemInformationApi;
 
 /**
  * Client to use the Akeneo PIM API.
@@ -94,13 +95,13 @@ public function getProductDraftApi(): ProductDraftApiInterface;
 
     /**
      * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
-     * @see getAssetManagerApi instead.
+     * @see        getAssetManagerApi instead.
      */
     public function getAssetApi(): AssetApiInterface;
 
     /**
      * @deprecated Route unavailable in latest PIM versions. Will be removed in v12.0.0.
-     * @see getAssetFamilyApi instead.
+     * @see        getAssetFamilyApi instead.
      */
     public function getAssetCategoryApi(): AssetCategoryApiInterface;
 
@@ -146,4 +147,6 @@ public function getProductDraftUuidApi(): ProductDraftUuidApiInterface;
     public function getAppCatalogApi(): AppCatalogApiInterface;
 
     public function getAppCatalogProductApi(): AppCatalogProductApiInterface;
+
+    public function getSystemInformationApi(): SystemInformationApi;
 }

src/Api/SystemInformationApi.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Akeneo\Pim\ApiClient\Api;
+
+use Akeneo\Pim\ApiClient\Client\ResourceClientInterface;
+
+/**
+ * API implementation to manage system information.
+ */
+class SystemInformationApi implements SystemInformationApiInterface
+{
+    public const SYSTEM_INFORMATION_URI = 'api/rest/v1/system-information';
+
+    public function __construct(
+        protected ResourceClientInterface $resourceClient,
+    ) {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get(): array
+    {
+        return $this->resourceClient->getResource(static::SYSTEM_INFORMATION_URI);
+    }
+}

src/Api/SystemInformationApiInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Akeneo\Pim\ApiClient\Api;
+
+use Akeneo\Pim\ApiClient\Api\Operation\GettableResourceInterface;
+use Akeneo\Pim\ApiClient\Api\Operation\ListableResourceInterface;
+use Akeneo\Pim\ApiClient\Exception\HttpException;
+
+/**
+ * API to manage system information.
+ */
+interface SystemInformationApiInterface
+{
+    /**
+     * Gets the system information
+     *
+     * @throws HttpException If the request failed.
+     * @return array
+     */
+    public function get(): array;
+}