Add support for reorderMetadataFields Admin API

YomesInc · web-flow · commit 551ef2b087e4 · 2022-03-31T19:50:25.000+03:00
diff --git a/src/Api/Admin/MetadataFieldsTrait.php b/src/Api/Admin/MetadataFieldsTrait.php
@@ -200,4 +200,23 @@ public function reorderMetadataFieldDatasource($fieldExternalId, $orderBy, $dire
 
         return $this->apiClient->postJson($uri, $params);
     }
+
+    /**
+     * Reorders metadata fields.
+     *
+     * @param string $orderBy   Criteria for the order (one of the fields 'label', 'external_id', 'created_at').
+     * @param string $direction Optional (gets either asc or desc).
+     *
+     * @return ApiResponse
+     */
+    public function reorderMetadataFields($orderBy, $direction = null)
+    {
+        $uri    = [ApiEndPoint::METADATA_FIELDS, 'order'];
+        $params = [
+            'order_by'  => $orderBy,
+            'direction' => $direction,
+        ];
+
+        return $this->apiClient->putJson($uri, $params);
+    }
 }
diff --git a/tests/Helpers/RequestAssertionsTrait.php b/tests/Helpers/RequestAssertionsTrait.php
@@ -56,6 +56,17 @@ protected static function assertRequestDelete(RequestInterface $request, $messag
         self::assertEquals('DELETE', $request->getMethod(), $message);
     }
 
+    /**
+     * Assert the HTTP request method is PUT.
+     *
+     * @param RequestInterface $request
+     * @param string           $message
+     */
+    protected static function assertRequestPut(RequestInterface $request, $message = 'HTTP method should be PUT')
+    {
+        self::assertEquals('PUT', $request->getMethod(), $message);
+    }
+
     /**
      * Asserts that a request contains the expected fields and values.
      *
diff --git a/tests/Unit/Admin/MetadataFieldsTest.php b/tests/Unit/Admin/MetadataFieldsTest.php
@@ -160,4 +160,67 @@ public function testDeleteMetadataField()
         self::assertRequestDelete($lastRequest);
         self::assertRequestFields($lastRequest);
     }
+
+    /**
+     * Test the reorder of metadata fields for label order by asc.
+     */
+    public function testReorderMetadataFieldsByLabel()
+    {
+        $mockAdminApi = new MockAdminApi();
+
+        $mockAdminApi->reorderMetadataFields('label', 'asc');
+        $lastRequest = $mockAdminApi->getMockHandler()->getLastRequest();
+
+        self::assertRequestUrl(
+            $lastRequest,
+            '/metadata_fields/order'
+        );
+        self::assertRequestPut($lastRequest);
+        self::assertRequestJsonBodySubset(
+            $lastRequest,
+            ['order_by' => 'label', 'direction' => 'asc']
+        );
+    }
+
+    /**
+     * Test the reorder of metadata fields for external_id order by desc.
+     */
+    public function testReorderMetadataFieldsByExternalId()
+    {
+        $mockAdminApi = new MockAdminApi();
+
+        $mockAdminApi->reorderMetadataFields('external_id', 'asc');
+        $lastRequest = $mockAdminApi->getMockHandler()->getLastRequest();
+
+        self::assertRequestUrl(
+            $lastRequest,
+            '/metadata_fields/order'
+        );
+        self::assertRequestPut($lastRequest);
+        self::assertRequestJsonBodySubset(
+            $lastRequest,
+            ['order_by' => 'external_id', 'direction' => 'asc']
+        );
+    }
+
+    /**
+     * Test the reorder of metadata fields for created_at order by asc.
+     */
+    public function testReorderMetadataFieldsByCreatedAt()
+    {
+        $mockAdminApi = new MockAdminApi();
+
+        $mockAdminApi->reorderMetadataFields('created_at', 'asc');
+        $lastRequest = $mockAdminApi->getMockHandler()->getLastRequest();
+
+        self::assertRequestUrl(
+            $lastRequest,
+            '/metadata_fields/order'
+        );
+        self::assertRequestPut($lastRequest);
+        self::assertRequestJsonBodySubset(
+            $lastRequest,
+            ['order_by' => 'created_at', 'direction' => 'asc']
+        );
+    }
 }
