Merge pull request #306 from Shopify/add_2023_10_api_version

Add 2023-10 api version

CHANGELOG.md

@@ -7,6 +7,7 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+- [#306](https://github.com/Shopify/shopify-api-php/pull/306) [Minor] Adding support for 2023-10 API version
 - [#297](https://github.com/Shopify/shopify-api-php/pull/297) [Patch] Fix CustomerAddress methods, FulfillmentRequest save method
 
 ## v5.1.0 - 2023-07-11

src/ApiVersion.php

@@ -21,7 +21,9 @@ class ApiVersion
     /** @var string */
     public const JULY_2023 = "2023-07";
     /** @var string */
-    public const LATEST = self::JULY_2023;
+    public const OCTOBER_2023 = "2023-10";
+    /** @var string */
+    public const LATEST = self::OCTOBER_2023;
 
     private static $ALL_VERSIONS = [
         self::UNSTABLE,
@@ -31,6 +33,7 @@ class ApiVersion
         self::JANUARY_2023,
         self::APRIL_2023,
         self::JULY_2023,
+        self::OCTOBER_2023,
     ];
 
     public static function isValid(string $version): bool

src/Rest/Admin2022_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"
+        ];
     }
 
     /**

src/Rest/Admin2022_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

src/Rest/Admin2022_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

src/Rest/Admin2022_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"
+        ];
     }
 
     /**

src/Rest/Admin2022_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"
+        ];
     }
 
     /**

src/Rest/Admin2022_07/Balance.php

@@ -12,7 +12,7 @@
 use Shopify\Rest\Base;
 
 /**
-
+ * @property array[]|null $balance
  */
 class Balance extends Base
 {

src/Rest/Admin2022_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

src/Rest/Admin2022_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

src/Rest/Admin2022_07/Order.php

@@ -23,6 +23,7 @@
  * @property string|null $checkout_token
  * @property array|null $client_details
  * @property string|null $closed_at
+ * @property string|null $confirmation_number
  * @property string|null $created_at
  * @property string|null $currency
  * @property string|null $current_subtotal_price

src/Rest/Admin2022_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"
+        ];
     }
 
     /**

src/Rest/Admin2022_10/Balance.php

@@ -12,7 +12,7 @@
 use Shopify\Rest\Base;
 
 /**
-
+ * @property array[]|null $balance
  */
 class Balance extends Base
 {

src/Rest/Admin2022_10/Order.php

@@ -23,6 +23,7 @@
  * @property string|null $checkout_token
  * @property array|null $client_details
  * @property string|null $closed_at
+ * @property string|null $confirmation_number
  * @property string|null $created_at
  * @property string|null $currency
  * @property string|null $current_subtotal_price

src/Rest/Admin2022_10/Shop.php

@@ -16,7 +16,6 @@
  * @property string|null $address2
  * @property bool|null $checkout_api_supported
  * @property string|null $city
- * @property string|null $cookie_consent_level
  * @property string|null $country
  * @property string|null $country_code
  * @property string|null $country_name

src/Rest/Admin2022_10/Variant.php

@@ -23,7 +23,6 @@
  * @property string|null $inventory_management
  * @property string|null $inventory_policy
  * @property int|null $inventory_quantity
- * @property int|null $inventory_quantity_adjustment
  * @property int|null $old_inventory_quantity
  * @property array|null $option
  * @property int|null $position
@@ -53,8 +52,7 @@ class Variant extends Base
         ["http_method" => "put", "operation" => "put", "ids" => ["id"], "path" => "variants/<id>.json"]
     ];
     protected static array $READ_ONLY_ATTRIBUTES = [
-        "inventory_quantity",
-        "inventory_quantity_adjustment"
+        "inventory_quantity"
     ];
 
     /**

src/Rest/Admin2023_01/Balance.php

@@ -12,7 +12,7 @@
 use Shopify\Rest\Base;
 
 /**
-
+ * @property array[]|null $balance
  */
 class Balance extends Base
 {

src/Rest/Admin2023_01/Order.php

@@ -24,6 +24,7 @@
  * @property array|null $client_details
  * @property string|null $closed_at
  * @property array|null $company
+ * @property string|null $confirmation_number
  * @property string|null $created_at
  * @property string|null $currency
  * @property string|null $current_subtotal_price

src/Rest/Admin2023_01/Shop.php

@@ -16,7 +16,6 @@
  * @property string|null $address2
  * @property bool|null $checkout_api_supported
  * @property string|null $city
- * @property string|null $cookie_consent_level
  * @property string|null $country
  * @property string|null $country_code
  * @property string|null $country_name

src/Rest/Admin2023_01/Variant.php

@@ -23,7 +23,6 @@
  * @property string|null $inventory_management
  * @property string|null $inventory_policy
  * @property int|null $inventory_quantity
- * @property int|null $inventory_quantity_adjustment
  * @property int|null $old_inventory_quantity
  * @property array|null $option
  * @property int|null $position
@@ -53,8 +52,7 @@ class Variant extends Base
         ["http_method" => "put", "operation" => "put", "ids" => ["id"], "path" => "variants/<id>.json"]
     ];
     protected static array $READ_ONLY_ATTRIBUTES = [
-        "inventory_quantity",
-        "inventory_quantity_adjustment"
+        "inventory_quantity"
     ];
 
     /**

src/Rest/Admin2023_04/Balance.php

@@ -12,7 +12,7 @@
 use Shopify\Rest\Base;
 
 /**
-
+ * @property array[]|null $balance
  */
 class Balance extends Base
 {

src/Rest/Admin2023_04/Order.php

@@ -24,6 +24,7 @@
  * @property array|null $client_details
  * @property string|null $closed_at
  * @property array|null $company
+ * @property string|null $confirmation_number
  * @property string|null $created_at
  * @property string|null $currency
  * @property string|null $current_subtotal_price

src/Rest/Admin2023_04/Shop.php

@@ -16,7 +16,6 @@
  * @property string|null $address2
  * @property bool|null $checkout_api_supported
  * @property string|null $city
- * @property string|null $cookie_consent_level
  * @property string|null $country
  * @property string|null $country_code
  * @property string|null $country_name

src/Rest/Admin2023_04/Variant.php

@@ -23,7 +23,6 @@
  * @property string|null $inventory_management
  * @property string|null $inventory_policy
  * @property int|null $inventory_quantity
- * @property int|null $inventory_quantity_adjustment
  * @property int|null $old_inventory_quantity
  * @property array|null $option
  * @property int|null $position
@@ -53,8 +52,7 @@ class Variant extends Base
         ["http_method" => "put", "operation" => "put", "ids" => ["id"], "path" => "variants/<id>.json"]
     ];
     protected static array $READ_ONLY_ATTRIBUTES = [
-        "inventory_quantity",
-        "inventory_quantity_adjustment"
+        "inventory_quantity"
     ];
 
     /**

src/Rest/Admin2023_07/Balance.php

@@ -12,7 +12,7 @@
 use Shopify\Rest\Base;
 
 /**
-
+ * @property array[]|null $balance
  */
 class Balance extends Base
 {

src/Rest/Admin2023_07/Order.php

@@ -24,6 +24,7 @@
  * @property array|null $client_details
  * @property string|null $closed_at
  * @property array|null $company
+ * @property string|null $confirmation_number
  * @property string|null $created_at
  * @property string|null $currency
  * @property string|null $current_subtotal_price