shopify_api 13.1.0 → 13.2.0

data/lib/shopify_api/admin_versions.rb

@@ -5,6 +5,7 @@ module ShopifyAPI
   module AdminVersions
     SUPPORTED_ADMIN_VERSIONS = T.let([
       "unstable",
+      "2023-10",
       "2023-07",
       "2023-04",
       "2023-01",
@@ -14,7 +15,7 @@ module ShopifyAPI
       "2022-01",
     ], T::Array[String])
 
-    LATEST_SUPPORTED_ADMIN_VERSION = T.let("2023-07", String)
+    LATEST_SUPPORTED_ADMIN_VERSION = T.let("2023-10", String)
   end
 
   SUPPORTED_ADMIN_VERSIONS = ShopifyAPI::AdminVersions::SUPPORTED_ADMIN_VERSIONS

data/lib/shopify_api/context.rb

@@ -12,7 +12,9 @@ module ShopifyAPI
     @is_private = T.let(false, T::Boolean)
     @private_shop = T.let(nil, T.nilable(String))
     @is_embedded = T.let(true, T::Boolean)
-    @logger = T.let(::Logger.new($stdout), ::Logger)
+    # Logger can either be a Logger or an ActiveSupport::BroadcastLogger, which is new in Rails 7.1.0. To avoid adding a
+    # dependency Active Support >= 7.1.0, we go with T.untyped
+    @logger = T.let(::Logger.new($stdout), T.untyped)
     @log_level = T.let(:info, Symbol)
     @notified_missing_resources_folder = T.let({}, T::Hash[String, T::Boolean])
     @active_session = T.let(Concurrent::ThreadLocalVar.new { nil }, T.nilable(Concurrent::ThreadLocalVar))
@@ -33,7 +35,7 @@ module ShopifyAPI
           is_private: T::Boolean,
           is_embedded: T::Boolean,
           log_level: T.any(String, Symbol),
-          logger: ::Logger,
+          logger: T.untyped,
           host_name: T.nilable(String),
           host: T.nilable(String),
           private_shop: T.nilable(String),
@@ -116,7 +118,7 @@ module ShopifyAPI
       sig { returns(Auth::AuthScopes) }
       attr_reader :scope
 
-      sig { returns(::Logger) }
+      sig { returns(T.untyped) }
       attr_reader :logger
 
       sig { returns(Symbol) }

data/lib/shopify_api/rest/base.rb

@@ -97,9 +97,9 @@ module ShopifyAPI
           class_name.underscore
         end
 
-        sig { returns(String) }
-        def json_response_body_name
-          class_name
+        sig { returns(T::Array[String]) }
+        def json_response_body_names
+          [class_name]
         end
 
         sig { returns(T.nilable(String)) }
@@ -210,14 +210,16 @@ module ShopifyAPI
 
           body = T.cast(response.body, T::Hash[String, T.untyped])
 
-          response_name = json_response_body_name
+          response_names = json_response_body_names
 
-          if body.key?(response_name.pluralize) || (body.key?(response_name) && body[response_name].is_a?(Array))
-            (body[response_name.pluralize] || body[response_name]).each do |entry|
-              objects << create_instance(data: entry, session: session)
+          response_names.each do |response_name|
+            if body.key?(response_name.pluralize) || (body.key?(response_name) && body[response_name].is_a?(Array))
+              (body[response_name.pluralize] || body[response_name]).each do |entry|
+                objects << create_instance(data: entry, session: session)
+              end
+            elsif body.key?(response_name)
+              objects << create_instance(data: body[response_name], session: session)
             end
-          elsif body.key?(response_name)
-            objects << create_instance(data: body[response_name], session: session)
           end
 
           objects
@@ -347,10 +349,8 @@ module ShopifyAPI
         )
 
         if update_object
-          self.class.create_instance(
-            data: response.body[self.class.class_name.downcase],
-            session: @session, instance: self
-          )
+          response_name = self.class.json_response_body_names & response.body.keys
+          self.class.create_instance(data: response.body[response_name.first], session: @session, instance: self)
         end
       rescue ShopifyAPI::Errors::HttpResponseError => e
         @errors.errors << e
@@ -365,10 +365,18 @@ module ShopifyAPI
           self.class.read_only_attributes&.include?("@#{attribute}".to_sym)
         end
 
-        HashDiff::Comparison.new(
+        diff = HashDiff::Comparison.new(
           deep_stringify_keys(original_state_for_update),
           deep_stringify_keys(to_hash(true)),
         ).left_diff
+
+        diff.each do |attribute, value|
+          if value.is_a?(Hash) && value[0] == HashDiff::NO_VALUE
+            diff[attribute] = send(attribute)
+          end
+        end
+
+        diff
       end
 
       sig { returns(Symbol) }

data/lib/shopify_api/rest/resources/2022_10/assigned_fulfillment_order.rb

@@ -51,10 +51,12 @@ module ShopifyAPI
 
     class << self
       sig do
-        returns(String)
+        returns(T::Array[String])
       end
-      def json_response_body_name()
-        "fulfillment_order"
+      def json_response_body_names()
+        [
+          "fulfillment_order"
+        ]
       end
 
       sig do

data/lib/shopify_api/rest/resources/2022_10/customer_address.rb

@@ -87,6 +87,16 @@ module ShopifyAPI
         "address"
       end
 
+      sig do
+        returns(T::Array[String])
+      end
+      def json_response_body_names()
+        [
+          "customer_address",
+          "address"
+        ]
+      end
+
       sig do
         params(
           id: T.any(Integer, String),

data/lib/shopify_api/rest/resources/2022_10/fulfillment_request.rb

@@ -31,6 +31,16 @@ module ShopifyAPI
     attr_reader :fulfillment_order_id
 
     class << self
+      sig do
+        returns(T::Array[String])
+      end
+      def json_response_body_names()
+        [
+          "submitted_fulfillment_order",
+          "fulfillment_order"
+        ]
+      end
+
     end
 
     sig do

data/lib/shopify_api/rest/resources/2022_10/order_risk.rb

@@ -68,10 +68,12 @@ module ShopifyAPI
       end
 
       sig do
-        returns(String)
+        returns(T::Array[String])
       end
-      def json_response_body_name()
-        "risk"
+      def json_response_body_names()
+        [
+          "risk"
+        ]
       end
 
       sig do

data/lib/shopify_api/rest/resources/2023_01/assigned_fulfillment_order.rb

@@ -51,10 +51,12 @@ module ShopifyAPI
 
     class << self
       sig do
-        returns(String)
+        returns(T::Array[String])
       end
-      def json_response_body_name()
-        "fulfillment_order"
+      def json_response_body_names()
+        [
+          "fulfillment_order"
+        ]
       end
 
       sig do

data/lib/shopify_api/rest/resources/2023_01/balance.rb

@@ -16,6 +16,7 @@ module ShopifyAPI
     def initialize(session: ShopifyAPI::Context.active_session)
       super(session: session)
 
+      @balance = T.let(nil, T.nilable(T::Array[T.untyped]))
     end
 
     @has_one = T.let({}, T::Hash[Symbol, Class])
@@ -24,6 +25,9 @@ module ShopifyAPI
       {http_method: :get, operation: :get, ids: [], path: "shopify_payments/balance.json"}
     ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
 
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :balance
+
     class << self
       sig do
         params(

data/lib/shopify_api/rest/resources/2023_01/customer_address.rb

@@ -87,6 +87,16 @@ module ShopifyAPI
         "address"
       end
 
+      sig do
+        returns(T::Array[String])
+      end
+      def json_response_body_names()
+        [
+          "customer_address",
+          "address"
+        ]
+      end
+
       sig do
         params(
           id: T.any(Integer, String),

data/lib/shopify_api/rest/resources/2023_01/fulfillment_request.rb

@@ -31,6 +31,16 @@ module ShopifyAPI
     attr_reader :fulfillment_order_id
 
     class << self
+      sig do
+        returns(T::Array[String])
+      end
+      def json_response_body_names()
+        [
+          "submitted_fulfillment_order",
+          "fulfillment_order"
+        ]
+      end
+
     end
 
     sig do

data/lib/shopify_api/rest/resources/2023_01/order.rb

@@ -28,6 +28,7 @@ module ShopifyAPI
       @client_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @closed_at = T.let(nil, T.nilable(String))
       @company = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @confirmation_number = T.let(nil, T.nilable(String))
       @created_at = T.let(nil, T.nilable(String))
       @currency = T.let(nil, T.nilable(String))
       @current_subtotal_price = T.let(nil, T.nilable(String))
@@ -142,6 +143,8 @@ module ShopifyAPI
     sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
     attr_reader :company
     sig { returns(T.nilable(String)) }
+    attr_reader :confirmation_number
+    sig { returns(T.nilable(String)) }
     attr_reader :created_at
     sig { returns(T.nilable(String)) }
     attr_reader :currency

data/lib/shopify_api/rest/resources/2023_01/order_risk.rb

@@ -68,10 +68,12 @@ module ShopifyAPI
       end
 
       sig do
-        returns(String)
+        returns(T::Array[String])
       end
-      def json_response_body_name()
-        "risk"
+      def json_response_body_names()
+        [
+          "risk"
+        ]
       end
 
       sig do

data/lib/shopify_api/rest/resources/2023_01/shop.rb

@@ -20,7 +20,6 @@ module ShopifyAPI
       @address2 = T.let(nil, T.nilable(String))
       @checkout_api_supported = T.let(nil, T.nilable(T::Boolean))
       @city = T.let(nil, T.nilable(String))
-      @cookie_consent_level = T.let(nil, T.nilable(String))
       @country = T.let(nil, T.nilable(String))
       @country_code = T.let(nil, T.nilable(String))
       @country_name = T.let(nil, T.nilable(String))
@@ -89,8 +88,6 @@ module ShopifyAPI
     sig { returns(T.nilable(String)) }
     attr_reader :city
     sig { returns(T.nilable(String)) }
-    attr_reader :cookie_consent_level
-    sig { returns(T.nilable(String)) }
     attr_reader :country
     sig { returns(T.nilable(String)) }
     attr_reader :country_code

data/lib/shopify_api/rest/resources/2023_01/variant.rb

@@ -27,7 +27,6 @@ module ShopifyAPI
       @inventory_management = T.let(nil, T.nilable(String))
       @inventory_policy = T.let(nil, T.nilable(String))
       @inventory_quantity = T.let(nil, T.nilable(Integer))
-      @inventory_quantity_adjustment = T.let(nil, T.nilable(Integer))
       @old_inventory_quantity = T.let(nil, T.nilable(Integer))
       @option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @position = T.let(nil, T.nilable(Integer))
@@ -55,8 +54,7 @@ module ShopifyAPI
       {http_method: :put, operation: :put, ids: [:id], path: "variants/<id>.json"}
     ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
     @read_only_attributes = T.let([
-      :inventory_quantity,
-      :inventory_quantity_adjustment
+      :inventory_quantity
     ], T::Array[Symbol])
 
     sig { returns(T.nilable(String)) }
@@ -82,8 +80,6 @@ module ShopifyAPI
     sig { returns(T.nilable(Integer)) }
     attr_reader :inventory_quantity
     sig { returns(T.nilable(Integer)) }
-    attr_reader :inventory_quantity_adjustment
-    sig { returns(T.nilable(Integer)) }
     attr_reader :old_inventory_quantity
     sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
     attr_reader :option

data/lib/shopify_api/rest/resources/2023_04/assigned_fulfillment_order.rb

@@ -51,10 +51,12 @@ module ShopifyAPI
 
     class << self
       sig do
-        returns(String)
+        returns(T::Array[String])
       end
-      def json_response_body_name()
-        "fulfillment_order"
+      def json_response_body_names()
+        [
+          "fulfillment_order"
+        ]
       end
 
       sig do

data/lib/shopify_api/rest/resources/2023_04/balance.rb

@@ -16,6 +16,7 @@ module ShopifyAPI
     def initialize(session: ShopifyAPI::Context.active_session)
       super(session: session)
 
+      @balance = T.let(nil, T.nilable(T::Array[T.untyped]))
     end
 
     @has_one = T.let({}, T::Hash[Symbol, Class])
@@ -24,6 +25,9 @@ module ShopifyAPI
       {http_method: :get, operation: :get, ids: [], path: "shopify_payments/balance.json"}
     ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
 
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :balance
+
     class << self
       sig do
         params(

data/lib/shopify_api/rest/resources/2023_04/customer_address.rb

@@ -87,6 +87,16 @@ module ShopifyAPI
         "address"
       end
 
+      sig do
+        returns(T::Array[String])
+      end
+      def json_response_body_names()
+        [
+          "customer_address",
+          "address"
+        ]
+      end
+
       sig do
         params(
           id: T.any(Integer, String),

data/lib/shopify_api/rest/resources/2023_04/fulfillment_request.rb

@@ -31,6 +31,16 @@ module ShopifyAPI
     attr_reader :fulfillment_order_id
 
     class << self
+      sig do
+        returns(T::Array[String])
+      end
+      def json_response_body_names()
+        [
+          "submitted_fulfillment_order",
+          "fulfillment_order"
+        ]
+      end
+
     end
 
     sig do

data/lib/shopify_api/rest/resources/2023_04/order.rb

@@ -28,6 +28,7 @@ module ShopifyAPI
       @client_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @closed_at = T.let(nil, T.nilable(String))
       @company = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @confirmation_number = T.let(nil, T.nilable(String))
       @created_at = T.let(nil, T.nilable(String))
       @currency = T.let(nil, T.nilable(String))
       @current_subtotal_price = T.let(nil, T.nilable(String))
@@ -144,6 +145,8 @@ module ShopifyAPI
     sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
     attr_reader :company
     sig { returns(T.nilable(String)) }
+    attr_reader :confirmation_number
+    sig { returns(T.nilable(String)) }
     attr_reader :created_at
     sig { returns(T.nilable(String)) }
     attr_reader :currency

data/lib/shopify_api/rest/resources/2023_04/order_risk.rb

@@ -68,10 +68,12 @@ module ShopifyAPI
       end
 
       sig do
-        returns(String)
+        returns(T::Array[String])
       end
-      def json_response_body_name()
-        "risk"
+      def json_response_body_names()
+        [
+          "risk"
+        ]
       end
 
       sig do

data/lib/shopify_api/rest/resources/2023_04/shop.rb

@@ -20,7 +20,6 @@ module ShopifyAPI
       @address2 = T.let(nil, T.nilable(String))
       @checkout_api_supported = T.let(nil, T.nilable(T::Boolean))
       @city = T.let(nil, T.nilable(String))
-      @cookie_consent_level = T.let(nil, T.nilable(String))
       @country = T.let(nil, T.nilable(String))
       @country_code = T.let(nil, T.nilable(String))
       @country_name = T.let(nil, T.nilable(String))
@@ -89,8 +88,6 @@ module ShopifyAPI
     sig { returns(T.nilable(String)) }
     attr_reader :city
     sig { returns(T.nilable(String)) }
-    attr_reader :cookie_consent_level
-    sig { returns(T.nilable(String)) }
     attr_reader :country
     sig { returns(T.nilable(String)) }
     attr_reader :country_code

data/lib/shopify_api/rest/resources/2023_04/variant.rb

@@ -27,7 +27,6 @@ module ShopifyAPI
       @inventory_management = T.let(nil, T.nilable(String))
       @inventory_policy = T.let(nil, T.nilable(String))
       @inventory_quantity = T.let(nil, T.nilable(Integer))
-      @inventory_quantity_adjustment = T.let(nil, T.nilable(Integer))
       @old_inventory_quantity = T.let(nil, T.nilable(Integer))
       @option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @position = T.let(nil, T.nilable(Integer))
@@ -55,8 +54,7 @@ module ShopifyAPI
       {http_method: :put, operation: :put, ids: [:id], path: "variants/<id>.json"}
     ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
     @read_only_attributes = T.let([
-      :inventory_quantity,
-      :inventory_quantity_adjustment
+      :inventory_quantity
     ], T::Array[Symbol])
 
     sig { returns(T.nilable(String)) }
@@ -82,8 +80,6 @@ module ShopifyAPI
     sig { returns(T.nilable(Integer)) }
     attr_reader :inventory_quantity
     sig { returns(T.nilable(Integer)) }
-    attr_reader :inventory_quantity_adjustment
-    sig { returns(T.nilable(Integer)) }
     attr_reader :old_inventory_quantity
     sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
     attr_reader :option

data/lib/shopify_api/rest/resources/2023_07/assigned_fulfillment_order.rb

@@ -51,10 +51,12 @@ module ShopifyAPI
 
     class << self
       sig do
-        returns(String)
+        returns(T::Array[String])
       end
-      def json_response_body_name()
-        "fulfillment_order"
+      def json_response_body_names()
+        [
+          "fulfillment_order"
+        ]
       end
 
       sig do

data/lib/shopify_api/rest/resources/2023_07/balance.rb

@@ -16,6 +16,7 @@ module ShopifyAPI
     def initialize(session: ShopifyAPI::Context.active_session)
       super(session: session)
 
+      @balance = T.let(nil, T.nilable(T::Array[T.untyped]))
     end
 
     @has_one = T.let({}, T::Hash[Symbol, Class])
@@ -24,6 +25,9 @@ module ShopifyAPI
       {http_method: :get, operation: :get, ids: [], path: "shopify_payments/balance.json"}
     ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
 
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :balance
+
     class << self
       sig do
         params(

data/lib/shopify_api/rest/resources/2023_07/customer_address.rb

@@ -87,6 +87,16 @@ module ShopifyAPI
         "address"
       end
 
+      sig do
+        returns(T::Array[String])
+      end
+      def json_response_body_names()
+        [
+          "customer_address",
+          "address"
+        ]
+      end
+
       sig do
         params(
           id: T.any(Integer, String),

data/lib/shopify_api/rest/resources/2023_07/fulfillment_request.rb

@@ -31,6 +31,16 @@ module ShopifyAPI
     attr_reader :fulfillment_order_id
 
     class << self
+      sig do
+        returns(T::Array[String])
+      end
+      def json_response_body_names()
+        [
+          "submitted_fulfillment_order",
+          "fulfillment_order"
+        ]
+      end
+
     end
 
     sig do

data/lib/shopify_api/rest/resources/2023_07/order.rb

@@ -28,6 +28,7 @@ module ShopifyAPI
       @client_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @closed_at = T.let(nil, T.nilable(String))
       @company = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @confirmation_number = T.let(nil, T.nilable(String))
       @created_at = T.let(nil, T.nilable(String))
       @currency = T.let(nil, T.nilable(String))
       @current_subtotal_price = T.let(nil, T.nilable(String))
@@ -145,6 +146,8 @@ module ShopifyAPI
     sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
     attr_reader :company
     sig { returns(T.nilable(String)) }
+    attr_reader :confirmation_number
+    sig { returns(T.nilable(String)) }
     attr_reader :created_at
     sig { returns(T.nilable(String)) }
     attr_reader :currency

data/lib/shopify_api/rest/resources/2023_07/order_risk.rb

@@ -68,10 +68,12 @@ module ShopifyAPI
       end
 
       sig do
-        returns(String)
+        returns(T::Array[String])
       end
-      def json_response_body_name()
-        "risk"
+      def json_response_body_names()
+        [
+          "risk"
+        ]
       end
 
       sig do