Merge pull request #297 from Shopify/melaniew/custom-json-body-names-to-array

mllemango · web-flow · commit f5f4fe4c9cdb · 2023-09-05T11:55:22.000-04:00
getJsonResponseBodyName is now an array
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+- [#297](https://github.com/Shopify/shopify-api-php/pull/297) [Patch] Fix CustomerAddress methods, FulfillmentRequest save method
+
 ## v5.1.0 - 2023-07-11
 
 - [#285](https://github.com/Shopify/shopify-api-php/pull/285) [Minor] Adding support for 2023-07 API version
diff --git a/src/Rest/Admin2022_10/AssignedFulfillmentOrder.php b/src/Rest/Admin2022_10/AssignedFulfillmentOrder.php
@@ -33,11 +33,13 @@ class AssignedFulfillmentOrder extends Base
     /**
 
      *
-     * @return string
+     * @return string[]
      */
-    protected static function getJsonResponseBodyName(): string
+    protected static function getJsonResponseBodyNames(): array
     {
-        return "fulfillment_order";
+        return [
+            "fulfillment_order"
+        ];
     }
 
     /**
diff --git a/src/Rest/Admin2022_10/CustomerAddress.php b/src/Rest/Admin2022_10/CustomerAddress.php
@@ -54,6 +54,19 @@ protected static function getJsonBodyName(): string
         return "address";
     }
 
+    /**
+
+     *
+     * @return string[]
+     */
+    protected static function getJsonResponseBodyNames(): array
+    {
+        return [
+            "customer_address",
+            "address"
+        ];
+    }
+
     /**
      * @param Session $session
      * @param int|string $id
diff --git a/src/Rest/Admin2022_10/FulfillmentRequest.php b/src/Rest/Admin2022_10/FulfillmentRequest.php
@@ -25,6 +25,19 @@ class FulfillmentRequest extends Base
         ["http_method" => "post", "operation" => "reject", "ids" => ["fulfillment_order_id"], "path" => "fulfillment_orders/<fulfillment_order_id>/fulfillment_request/reject.json"]
     ];
 
+    /**
+
+     *
+     * @return string[]
+     */
+    protected static function getJsonResponseBodyNames(): array
+    {
+        return [
+            "submitted_fulfillment_order",
+            "fulfillment_order"
+        ];
+    }
+
     /**
      * @param mixed[] $params Allowed indexes:
      *     message
diff --git a/src/Rest/Admin2022_10/OrderRisk.php b/src/Rest/Admin2022_10/OrderRisk.php
@@ -49,11 +49,13 @@ protected static function getJsonBodyName(): string
     /**
 
      *
-     * @return string
+     * @return string[]
      */
-    protected static function getJsonResponseBodyName(): string
+    protected static function getJsonResponseBodyNames(): array
     {
-        return "risk";
+        return [
+            "risk"
+        ];
     }
 
     /**
diff --git a/src/Rest/Admin2023_01/AssignedFulfillmentOrder.php b/src/Rest/Admin2023_01/AssignedFulfillmentOrder.php
@@ -33,11 +33,13 @@ class AssignedFulfillmentOrder extends Base
     /**
 
      *
-     * @return string
+     * @return string[]
      */
-    protected static function getJsonResponseBodyName(): string
+    protected static function getJsonResponseBodyNames(): array
     {
-        return "fulfillment_order";
+        return [
+            "fulfillment_order"
+        ];
     }
 
     /**
diff --git a/src/Rest/Admin2023_01/CustomerAddress.php b/src/Rest/Admin2023_01/CustomerAddress.php
@@ -54,6 +54,19 @@ protected static function getJsonBodyName(): string
         return "address";
     }
 
+    /**
+
+     *
+     * @return string[]
+     */
+    protected static function getJsonResponseBodyNames(): array
+    {
+        return [
+            "customer_address",
+            "address"
+        ];
+    }
+
     /**
      * @param Session $session
      * @param int|string $id
diff --git a/src/Rest/Admin2023_01/FulfillmentRequest.php b/src/Rest/Admin2023_01/FulfillmentRequest.php
@@ -25,6 +25,19 @@ class FulfillmentRequest extends Base
         ["http_method" => "post", "operation" => "reject", "ids" => ["fulfillment_order_id"], "path" => "fulfillment_orders/<fulfillment_order_id>/fulfillment_request/reject.json"]
     ];
 
+    /**
+
+     *
+     * @return string[]
+     */
+    protected static function getJsonResponseBodyNames(): array
+    {
+        return [
+            "submitted_fulfillment_order",
+            "fulfillment_order"
+        ];
+    }
+
     /**
      * @param mixed[] $params Allowed indexes:
      *     message
diff --git a/src/Rest/Admin2023_01/OrderRisk.php b/src/Rest/Admin2023_01/OrderRisk.php
@@ -49,11 +49,13 @@ protected static function getJsonBodyName(): string
     /**
 
      *
-     * @return string
+     * @return string[]
      */
-    protected static function getJsonResponseBodyName(): string
+    protected static function getJsonResponseBodyNames(): array
     {
-        return "risk";
+        return [
+            "risk"
+        ];
     }
 
     /**
diff --git a/src/Rest/Admin2023_04/AssignedFulfillmentOrder.php b/src/Rest/Admin2023_04/AssignedFulfillmentOrder.php
@@ -33,11 +33,13 @@ class AssignedFulfillmentOrder extends Base
     /**
 
      *
-     * @return string
+     * @return string[]
      */
-    protected static function getJsonResponseBodyName(): string
+    protected static function getJsonResponseBodyNames(): array
     {
-        return "fulfillment_order";
+        return [
+            "fulfillment_order"
+        ];
     }
 
     /**
diff --git a/src/Rest/Admin2023_04/CustomerAddress.php b/src/Rest/Admin2023_04/CustomerAddress.php
@@ -54,6 +54,19 @@ protected static function getJsonBodyName(): string
         return "address";
     }
 
+    /**
+
+     *
+     * @return string[]
+     */
+    protected static function getJsonResponseBodyNames(): array
+    {
+        return [
+            "customer_address",
+            "address"
+        ];
+    }
+
     /**
      * @param Session $session
      * @param int|string $id
diff --git a/src/Rest/Admin2023_04/FulfillmentRequest.php b/src/Rest/Admin2023_04/FulfillmentRequest.php
@@ -25,6 +25,19 @@ class FulfillmentRequest extends Base
         ["http_method" => "post", "operation" => "reject", "ids" => ["fulfillment_order_id"], "path" => "fulfillment_orders/<fulfillment_order_id>/fulfillment_request/reject.json"]
     ];
 
+    /**
+
+     *
+     * @return string[]
+     */
+    protected static function getJsonResponseBodyNames(): array
+    {
+        return [
+            "submitted_fulfillment_order",
+            "fulfillment_order"
+        ];
+    }
+
     /**
      * @param mixed[] $params Allowed indexes:
      *     message
diff --git a/src/Rest/Admin2023_04/OrderRisk.php b/src/Rest/Admin2023_04/OrderRisk.php
@@ -49,11 +49,13 @@ protected static function getJsonBodyName(): string
     /**
 
      *
-     * @return string
+     * @return string[]
      */
-    protected static function getJsonResponseBodyName(): string
+    protected static function getJsonResponseBodyNames(): array
     {
-        return "risk";
+        return [
+            "risk"
+        ];
     }
 
     /**
diff --git a/src/Rest/Admin2023_07/AssignedFulfillmentOrder.php b/src/Rest/Admin2023_07/AssignedFulfillmentOrder.php
@@ -33,11 +33,13 @@ class AssignedFulfillmentOrder extends Base
     /**
 
      *
-     * @return string
+     * @return string[]
      */
-    protected static function getJsonResponseBodyName(): string
+    protected static function getJsonResponseBodyNames(): array
     {
-        return "fulfillment_order";
+        return [
+            "fulfillment_order"
+        ];
     }
 
     /**
diff --git a/src/Rest/Admin2023_07/CustomerAddress.php b/src/Rest/Admin2023_07/CustomerAddress.php
@@ -54,6 +54,19 @@ protected static function getJsonBodyName(): string
         return "address";
     }
 
+    /**
+
+     *
+     * @return string[]
+     */
+    protected static function getJsonResponseBodyNames(): array
+    {
+        return [
+            "customer_address",
+            "address"
+        ];
+    }
+
     /**
      * @param Session $session
      * @param int|string $id
diff --git a/src/Rest/Admin2023_07/FulfillmentRequest.php b/src/Rest/Admin2023_07/FulfillmentRequest.php
@@ -25,6 +25,19 @@ class FulfillmentRequest extends Base
         ["http_method" => "post", "operation" => "reject", "ids" => ["fulfillment_order_id"], "path" => "fulfillment_orders/<fulfillment_order_id>/fulfillment_request/reject.json"]
     ];
 
+    /**
+
+     *
+     * @return string[]
+     */
+    protected static function getJsonResponseBodyNames(): array
+    {
+        return [
+            "submitted_fulfillment_order",
+            "fulfillment_order"
+        ];
+    }
+
     /**
      * @param mixed[] $params Allowed indexes:
      *     message
diff --git a/src/Rest/Admin2023_07/OrderRisk.php b/src/Rest/Admin2023_07/OrderRisk.php
@@ -49,11 +49,13 @@ protected static function getJsonBodyName(): string
     /**
 
      *
-     * @return string
+     * @return string[]
      */
-    protected static function getJsonResponseBodyName(): string
+    protected static function getJsonResponseBodyNames(): array
     {
-        return "risk";
+        return [
+            "risk"
+        ];
     }
 
     /**
diff --git a/src/Rest/Base.php b/src/Rest/Base.php
@@ -136,10 +136,10 @@ protected static function getJsonBodyName(): string
         return strtolower(preg_replace("/([a-z])([A-Z])/", "$1_$2", $className));
     }
 
-    protected static function getJsonResponseBodyName(): string
+    protected static function getJsonResponseBodyNames(): array
     {
         $className = preg_replace("/^([A-z_0-9]+\\\)*([A-z_]+)/", "$2", static::class);
-        return strtolower(preg_replace("/([a-z])([A-Z])/", "$1_$2", $className));
+        return [strtolower(preg_replace("/([a-z])([A-Z])/", "$1_$2", $className))];
     }
 
     /**
@@ -280,20 +280,23 @@ private static function createInstancesFromResponse(RestResponse $response, Sess
         $objects = [];
 
         $body = $response->getDecodedBody();
-        $className = static::getJsonResponseBodyName();
-        $pluralClass = self::pluralize($className);
+        $classNames = static::getJsonResponseBodyNames();
 
-        if (!empty($body)) {
-            if (array_key_exists($pluralClass, $body)) {
-                foreach ($body[$pluralClass] as $entry) {
-                    array_push($objects, self::createInstance($entry, $session));
-                }
-            } elseif (array_key_exists($className, $body) && array_key_exists(0, $body[$className])) {
-                foreach ($body[$className] as $entry) {
-                    array_push($objects, self::createInstance($entry, $session));
+        foreach ($classNames as $className) {
+            $pluralClass = self::pluralize($className);
+
+            if (!empty($body)) {
+                if (array_key_exists($pluralClass, $body)) {
+                    foreach ($body[$pluralClass] as $entry) {
+                        array_push($objects, self::createInstance($entry, $session));
+                    }
+                } elseif (array_key_exists($className, $body) && array_key_exists(0, $body[$className])) {
+                    foreach ($body[$className] as $entry) {
+                        array_push($objects, self::createInstance($entry, $session));
+                    }
+                } elseif (array_key_exists($className, $body)) {
+                    array_push($objects, self::createInstance($body[$className], $session));
                 }
-            } elseif (array_key_exists($className, $body)) {
-                array_push($objects, self::createInstance($body[$className], $session));
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -33,11 +33,13 @@ class AssignedFulfillmentOrder extends Base`
`33`	`33`	`/**`
`34`	`34`
`35`	`35`	`*`
`36`		`- * @return string`
	`36`	`+ * @return string[]`
`37`	`37`	`*/`
`38`		`- protected static function getJsonResponseBodyName(): string`
	`38`	`+ protected static function getJsonResponseBodyNames(): array`
`39`	`39`	`{`
`40`		`- return "fulfillment_order";`
	`40`	`+ return [`
	`41`	`+ "fulfillment_order"`
	`42`	`+ ];`
`41`	`43`	`}`
`42`	`44`
`43`	`45`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -49,11 +49,13 @@ protected static function getJsonBodyName(): string`
`49`	`49`	`/**`
`50`	`50`
`51`	`51`	`*`
`52`		`- * @return string`
	`52`	`+ * @return string[]`
`53`	`53`	`*/`
`54`		`- protected static function getJsonResponseBodyName(): string`
	`54`	`+ protected static function getJsonResponseBodyNames(): array`
`55`	`55`	`{`
`56`		`- return "risk";`
	`56`	`+ return [`
	`57`	`+ "risk"`
	`58`	`+ ];`
`57`	`59`	`}`
`58`	`60`
`59`	`61`	`/**`