shopify_api 14.4.0 → 14.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc6cb9b900f3eba7d192c4d5091308edeaff8245517254af586192f72f57417c
-  data.tar.gz: bb86d0654b8aa58ce70c017707ac700cb51094467608119d75d2235942483d85
+  metadata.gz: 8b9b61bc6316148fcd2d905384def067e31b4fca5265bb1327a7502020ee6104
+  data.tar.gz: b3971fadf5e0159a68953fee0883be0a6fb5f366d0a25f39201cc6c134caa0bb
 SHA512:
-  metadata.gz: d7a256c3ce166b787b5a21d228fe25d73fc2ea1f0bbe2fca6896c3c07bae3300336c1c2efc7943d7a0096cdfd99bd0938d81fe1c097a39b2ef2f9ee931edbea2
-  data.tar.gz: 42c03e72834f764f6435c7f81286ef45502a36819ce4647eb6a346eb48e349d6f6f59dd5913bef591d4a45ae95e339d6bea9c016109d9d6bec0c077fc86bf29c
+  metadata.gz: 845bcdfac189ab0b17a07540c7cad3ba3621bbc83622d16b32a143f37eaaf9909499beb8791a2f0a0b6726e8283f833c5f1702ae804bbe38393ee5d6fa0fef67
+  data.tar.gz: f0216976a29a1b59ab8bf89316d3ccc9b3cbda4a42b81490cb5e25af19d9cf2b2b196484397816decdde75065f387e1f9bfddd5d82a42c110be8f13654c6f8d9

data/CHANGELOG.md

@@ -4,6 +4,13 @@ Note: For changes to the API, see https://shopify.dev/changelog?filter=api
 
 ## Unreleased
 
+## 14.5.0
+
+- [#1327](https://github.com/Shopify/shopify-api-ruby/pull/1327) Support `?debug=true` parameter in GraphQL client requests
+- [#1308](https://github.com/Shopify/shopify-api-ruby/pull/1308) Support hash_with_indifferent_access when creating REST objects from Shopify responses. Closes #1296
+- [#1332](https://github.com/Shopify/shopify-api-ruby/pull/1332) Fixed an issue where `Customer` REST API PUT requests didn't send all of the fields in the `email_marketing_consent` attribute
+- [#1335](https://github.com/Shopify/shopify-api-ruby/pull/1335) Add back the `current` methods for `Shop` and `RecurringApplicationCharge` resources
+
 ## 14.4.0
 
 - [#1325](https://github.com/Shopify/shopify-api-ruby/pull/1325) Add support for 2024-07 API version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (14.4.0)
+    shopify_api (14.5.0)
       activesupport
       concurrent-ruby
       hash_diff

data/docs/usage/custom_apps.md

@@ -53,6 +53,15 @@ def configure_app
       access_token: "the_token_for_your_custom_app_found_in_admin"
     )
 
+  ShopifyAPI::Context.setup(
+    api_key: "<api-key>",
+    api_secret_key: "<api-secret-key>",
+    scope: "read_orders,read_products,etc",
+    is_embedded: true, # Set to true if you are building an embedded app
+    api_version: "2024-01", # The version of the API you would like to use
+    is_private: true, # Set to true if you have an existing private app
+  )
+
   # Activate session to be used in all API calls
   # session must be type `ShopifyAPI::Auth::Session`
   ShopifyAPI::Context.activate_session(session)
@@ -62,9 +71,31 @@ end
 def make_api_request
   # 1. Create API client without session information
   # The graphql_client will use `ShopifyAPI::Context.active_session` when making API calls
-  graphql_client = ShopifyAPI::Clients::Graphql::Admin.new
+  # you can set the api version for your GraphQL client to override the api version in ShopifyAPI::Context
+  graphql_client = ShopifyAPI::Clients::Graphql::Admin.new(api_version: "2024-07")
 
   # 2. Use API client to make queries
+  # Graphql
+  query = <<~QUERY
+    {
+      products(first: 10) {
+        edges {
+          cursor
+          node {
+            id
+            title
+            onlineStoreUrl
+          }
+        }
+      }
+    }
+  QUERY
+
+  response = graphql_client.query(query: query)
+
+  # Use REST resources to make authenticated API call
+  product_count = ShopifyAPI::Product.count
+  
   ...
 end
 

data/docs/usage/webhooks.md

@@ -21,8 +21,9 @@ module WebhookHandler
   extend ShopifyAPI::Webhooks::WebhookHandler
 
   class << self
-    def handle_webhook(data:)
-      puts "Received webhook! topic: #{data.topic} shop: #{data.shop} body: #{data.body} webhook_id: #{data.webhook_id} api_version: #{data.api_version"
+    def handle(data:)
+      puts "Received webhook! topic: #{data.topic} shop: #{data.shop} body: #{data.body} webhook_id: #{data.webhook_id} api_version: #{data.api_version}"
+      perform_later(topic: data.topic, shop_domain: data.shop, webhook: data.body)
     end
   end
 end

data/lib/shopify_api/clients/graphql/client.rb

@@ -29,14 +29,24 @@ module ShopifyAPI
             headers: T.nilable(T::Hash[T.any(Symbol, String), T.untyped]),
             tries: Integer,
             response_as_struct: T.nilable(T::Boolean),
+            debug: T::Boolean,
           ).returns(HttpResponse)
         end
-        def query(query:, variables: nil, headers: nil, tries: 1, response_as_struct: Context.response_as_struct)
+        def query(
+          query:,
+          variables: nil,
+          headers: nil,
+          tries: 1,
+          response_as_struct: Context.response_as_struct,
+          debug: false
+        )
           body = { query: query, variables: variables }
+          search_params = debug ? "?debug=true" : ""
+
           @http_client.request(
             HttpRequest.new(
               http_method: :post,
-              path: "#{@api_version}/graphql.json",
+              path: "#{@api_version}/graphql.json#{search_params}",
               body: body,
               query: nil,
               extra_headers: headers,

data/lib/shopify_api/clients/graphql/storefront.rb

@@ -46,12 +46,20 @@ module ShopifyAPI
             headers: T.nilable(T::Hash[T.any(Symbol, String), T.untyped]),
             tries: Integer,
             response_as_struct: T.nilable(T::Boolean),
+            debug: T::Boolean,
           ).returns(HttpResponse)
         end
-        def query(query:, variables: nil, headers: {}, tries: 1, response_as_struct: Context.response_as_struct)
+        def query(
+          query:,
+          variables: nil,
+          headers: {},
+          tries: 1,
+          response_as_struct: Context.response_as_struct,
+          debug: false
+        )
           T.must(headers).merge!({ @storefront_auth_header => @storefront_access_token })
           super(query: query, variables: variables, headers: headers, tries: tries,
-                    response_as_struct: response_as_struct)
+                    response_as_struct: response_as_struct, debug: debug)
         end
       end
     end

data/lib/shopify_api/rest/base.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "active_support/inflector"
+require "active_support/core_ext/hash/indifferent_access"
 
 module ShopifyAPI
   module Rest
@@ -16,6 +17,7 @@ module ShopifyAPI
       @paths = T.let([], T::Array[T::Hash[Symbol, T.any(T::Array[Symbol], String, Symbol)]])
       @custom_prefix = T.let(nil, T.nilable(String))
       @read_only_attributes = T.let([], T.nilable(T::Array[Symbol]))
+      @atomic_hash_attributes = T.let([], T::Array[Symbol])
       @aliased_properties = T.let({}, T::Hash[String, String])
 
       sig { returns(T::Hash[Symbol, T.untyped]) }
@@ -61,6 +63,9 @@ module ShopifyAPI
         sig { returns(T::Hash[Symbol, T::Class[T.anything]]) }
         attr_reader :has_one
 
+        sig { returns(T.nilable(T::Array[Symbol])) }
+        attr_reader :atomic_hash_attributes
+
         sig { returns(T.nilable(T::Hash[T.any(Symbol, String), String])) }
         attr_accessor :headers
 
@@ -248,7 +253,7 @@ module ShopifyAPI
         def create_instances_from_response(response:, session:)
           objects = []
 
-          body = T.cast(response.body, T::Hash[String, T.untyped])
+          body = T.cast(response.body, T::Hash[String, T.untyped]).with_indifferent_access
 
           response_names = json_response_body_names
 
@@ -417,6 +422,7 @@ module ShopifyAPI
         ShopifyAPI::Utils::AttributesComparator.compare(
           stringified_updatable_attributes,
           stringified_new_attributes,
+          atomic_hash_attributes: self.class.atomic_hash_attributes || [],
         )
       end
 

data/lib/shopify_api/rest/resources/2022_04/customer.rb

@@ -55,6 +55,7 @@ module ShopifyAPI
       metafield: Metafield
     }, T::Hash[Symbol, Class])
     @has_many = T.let({}, T::Hash[Symbol, Class])
+    @atomic_hash_attributes = [:email_marketing_consent]
     @paths = T.let([
       {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},

data/lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb

@@ -149,6 +149,15 @@ module ShopifyAPI
         T.cast(response, T::Array[RecurringApplicationCharge])
       end
 
+      sig do
+        params(session: Auth::Session)
+          .returns(T.nilable(RecurringApplicationCharge))
+      end
+      def current(session: ShopifyAPI::Context.active_session)
+        charges = all(session: session)
+        charges.select { |charge| charge.status == "active" }.first
+      end
+
     end
 
     sig do

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

@@ -216,6 +216,16 @@ module ShopifyAPI
         T.cast(response, T::Array[Shop])
       end
 
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+        ).returns(T.nilable(Shop))
+      end
+      def current(fields: nil, session: ShopifyAPI::Context.active_session)
+        all(session: session, fields: fields).first
+      end
+
     end
 
   end

data/lib/shopify_api/rest/resources/2022_07/customer.rb

@@ -55,6 +55,7 @@ module ShopifyAPI
       metafield: Metafield
     }, T::Hash[Symbol, Class])
     @has_many = T.let({}, T::Hash[Symbol, Class])
+    @atomic_hash_attributes = [:email_marketing_consent]
     @paths = T.let([
       {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},

data/lib/shopify_api/rest/resources/2022_07/recurring_application_charge.rb

@@ -149,6 +149,15 @@ module ShopifyAPI
         T.cast(response, T::Array[RecurringApplicationCharge])
       end
 
+      sig do
+        params(session: Auth::Session)
+          .returns(T.nilable(RecurringApplicationCharge))
+      end
+      def current(session: ShopifyAPI::Context.active_session)
+        charges = all(session: session)
+        charges.select { |charge| charge.status == "active" }.first
+      end
+
     end
 
     sig do

data/lib/shopify_api/rest/resources/2022_07/shop.rb

@@ -216,6 +216,16 @@ module ShopifyAPI
         T.cast(response, T::Array[Shop])
       end
 
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+        ).returns(T.nilable(Shop))
+      end
+      def current(fields: nil, session: ShopifyAPI::Context.active_session)
+        all(session: session, fields: fields).first
+      end
+
     end
 
   end

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

@@ -55,6 +55,7 @@ module ShopifyAPI
       metafield: Metafield
     }, T::Hash[Symbol, Class])
     @has_many = T.let({}, T::Hash[Symbol, Class])
+    @atomic_hash_attributes = [:email_marketing_consent]
     @paths = T.let([
       {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},

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

@@ -149,6 +149,15 @@ module ShopifyAPI
         T.cast(response, T::Array[RecurringApplicationCharge])
       end
 
+      sig do
+        params(session: Auth::Session)
+          .returns(T.nilable(RecurringApplicationCharge))
+      end
+      def current(session: ShopifyAPI::Context.active_session)
+        charges = all(session: session)
+        charges.select { |charge| charge.status == "active" }.first
+      end
+
     end
 
     sig do

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

@@ -216,6 +216,16 @@ module ShopifyAPI
         T.cast(response, T::Array[Shop])
       end
 
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+        ).returns(T.nilable(Shop))
+      end
+      def current(fields: nil, session: ShopifyAPI::Context.active_session)
+        all(session: session, fields: fields).first
+      end
+
     end
 
   end

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

@@ -55,6 +55,7 @@ module ShopifyAPI
       metafield: Metafield
     }, T::Hash[Symbol, Class])
     @has_many = T.let({}, T::Hash[Symbol, Class])
+    @atomic_hash_attributes = [:email_marketing_consent]
     @paths = T.let([
       {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},

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

@@ -149,6 +149,15 @@ module ShopifyAPI
         T.cast(response, T::Array[RecurringApplicationCharge])
       end
 
+      sig do
+        params(session: Auth::Session)
+          .returns(T.nilable(RecurringApplicationCharge))
+      end
+      def current(session: ShopifyAPI::Context.active_session)
+        charges = all(session: session)
+        charges.select { |charge| charge.status == "active" }.first
+      end
+
     end
 
     sig do

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

@@ -216,6 +216,16 @@ module ShopifyAPI
         T.cast(response, T::Array[Shop])
       end
 
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+        ).returns(T.nilable(Shop))
+      end
+      def current(fields: nil, session: ShopifyAPI::Context.active_session)
+        all(session: session, fields: fields).first
+      end
+
     end
 
   end

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

@@ -55,6 +55,7 @@ module ShopifyAPI
       metafield: Metafield
     }, T::Hash[Symbol, Class])
     @has_many = T.let({}, T::Hash[Symbol, Class])
+    @atomic_hash_attributes = [:email_marketing_consent]
     @paths = T.let([
       {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},

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

@@ -149,6 +149,15 @@ module ShopifyAPI
         T.cast(response, T::Array[RecurringApplicationCharge])
       end
 
+      sig do
+        params(session: Auth::Session)
+          .returns(T.nilable(RecurringApplicationCharge))
+      end
+      def current(session: ShopifyAPI::Context.active_session)
+        charges = all(session: session)
+        charges.select { |charge| charge.status == "active" }.first
+      end
+
     end
 
     sig do

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

@@ -216,6 +216,16 @@ module ShopifyAPI
         T.cast(response, T::Array[Shop])
       end
 
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+        ).returns(T.nilable(Shop))
+      end
+      def current(fields: nil, session: ShopifyAPI::Context.active_session)
+        all(session: session, fields: fields).first
+      end
+
     end
 
   end

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

@@ -55,6 +55,7 @@ module ShopifyAPI
       metafield: Metafield
     }, T::Hash[Symbol, Class])
     @has_many = T.let({}, T::Hash[Symbol, Class])
+    @atomic_hash_attributes = [:email_marketing_consent]
     @paths = T.let([
       {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},

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

@@ -149,6 +149,15 @@ module ShopifyAPI
         T.cast(response, T::Array[RecurringApplicationCharge])
       end
 
+      sig do
+        params(session: Auth::Session)
+          .returns(T.nilable(RecurringApplicationCharge))
+      end
+      def current(session: ShopifyAPI::Context.active_session)
+        charges = all(session: session)
+        charges.select { |charge| charge.status == "active" }.first
+      end
+
     end
 
     sig do

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

@@ -216,6 +216,16 @@ module ShopifyAPI
         T.cast(response, T::Array[Shop])
       end
 
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+        ).returns(T.nilable(Shop))
+      end
+      def current(fields: nil, session: ShopifyAPI::Context.active_session)
+        all(session: session, fields: fields).first
+      end
+
     end
 
   end

data/lib/shopify_api/rest/resources/2023_10/customer.rb

@@ -55,6 +55,7 @@ module ShopifyAPI
       metafield: Metafield
     }, T::Hash[Symbol, Class])
     @has_many = T.let({}, T::Hash[Symbol, Class])
+    @atomic_hash_attributes = [:email_marketing_consent]
     @paths = T.let([
       {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},

data/lib/shopify_api/rest/resources/2023_10/recurring_application_charge.rb

@@ -149,6 +149,15 @@ module ShopifyAPI
         T.cast(response, T::Array[RecurringApplicationCharge])
       end
 
+      sig do
+        params(session: Auth::Session)
+          .returns(T.nilable(RecurringApplicationCharge))
+      end
+      def current(session: ShopifyAPI::Context.active_session)
+        charges = all(session: session)
+        charges.select { |charge| charge.status == "active" }.first
+      end
+
     end
 
     sig do

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

@@ -216,6 +216,16 @@ module ShopifyAPI
         T.cast(response, T::Array[Shop])
       end
 
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+        ).returns(T.nilable(Shop))
+      end
+      def current(fields: nil, session: ShopifyAPI::Context.active_session)
+        all(session: session, fields: fields).first
+      end
+
     end
 
   end

data/lib/shopify_api/rest/resources/2024_01/customer.rb

@@ -55,6 +55,7 @@ module ShopifyAPI
       metafield: Metafield
     }, T::Hash[Symbol, Class])
     @has_many = T.let({}, T::Hash[Symbol, Class])
+    @atomic_hash_attributes = [:email_marketing_consent]
     @paths = T.let([
       {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},

data/lib/shopify_api/rest/resources/2024_01/recurring_application_charge.rb

@@ -149,6 +149,15 @@ module ShopifyAPI
         T.cast(response, T::Array[RecurringApplicationCharge])
       end
 
+      sig do
+        params(session: Auth::Session)
+          .returns(T.nilable(RecurringApplicationCharge))
+      end
+      def current(session: ShopifyAPI::Context.active_session)
+        charges = all(session: session)
+        charges.select { |charge| charge.status == "active" }.first
+      end
+
     end
 
     sig do

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

@@ -216,6 +216,16 @@ module ShopifyAPI
         T.cast(response, T::Array[Shop])
       end
 
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+        ).returns(T.nilable(Shop))
+      end
+      def current(fields: nil, session: ShopifyAPI::Context.active_session)
+        all(session: session, fields: fields).first
+      end
+
     end
 
   end

data/lib/shopify_api/rest/resources/2024_04/customer.rb

@@ -55,6 +55,7 @@ module ShopifyAPI
       metafield: Metafield
     }, T::Hash[Symbol, Class])
     @has_many = T.let({}, T::Hash[Symbol, Class])
+    @atomic_hash_attributes = [:email_marketing_consent]
     @paths = T.let([
       {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},

data/lib/shopify_api/rest/resources/2024_04/recurring_application_charge.rb

@@ -149,6 +149,15 @@ module ShopifyAPI
         T.cast(response, T::Array[RecurringApplicationCharge])
       end
 
+      sig do
+        params(session: Auth::Session)
+          .returns(T.nilable(RecurringApplicationCharge))
+      end
+      def current(session: ShopifyAPI::Context.active_session)
+        charges = all(session: session)
+        charges.select { |charge| charge.status == "active" }.first
+      end
+
     end
 
     sig do

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

@@ -216,6 +216,16 @@ module ShopifyAPI
         T.cast(response, T::Array[Shop])
       end
 
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+        ).returns(T.nilable(Shop))
+      end
+      def current(fields: nil, session: ShopifyAPI::Context.active_session)
+        all(session: session, fields: fields).first
+      end
+
     end
 
   end

data/lib/shopify_api/rest/resources/2024_07/customer.rb

@@ -22,6 +22,7 @@ module ShopifyAPI
       @accepts_marketing_updated_at = T.let(nil, T.nilable(String))
       @addresses = T.let(nil, T.nilable(T::Array[T.untyped]))
       @created_at = T.let(nil, T.nilable(String))
+
       @currency = T.let(nil, T.nilable(String))
       @default_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @email = T.let(nil, T.nilable(String))
@@ -55,6 +56,7 @@ module ShopifyAPI
       metafield: Metafield
     }, T::Hash[Symbol, Class])
     @has_many = T.let({}, T::Hash[Symbol, Class])
+    @atomic_hash_attributes = [:email_marketing_consent]
     @paths = T.let([
       {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},

data/lib/shopify_api/rest/resources/2024_07/recurring_application_charge.rb

@@ -149,6 +149,14 @@ module ShopifyAPI
         T.cast(response, T::Array[RecurringApplicationCharge])
       end
 
+      sig do
+        params(session: Auth::Session)
+          .returns(T.nilable(RecurringApplicationCharge))
+      end
+      def current(session: ShopifyAPI::Context.active_session)
+        charges = all(session: session)
+        charges.select { |charge| charge.status == "active" }.first
+      end
     end
 
     sig do

data/lib/shopify_api/rest/resources/2024_07/shop.rb

@@ -216,6 +216,16 @@ module ShopifyAPI
         T.cast(response, T::Array[Shop])
       end
 
+      sig do
+        params(
+          fields: T.untyped,
+          session: Auth::Session,
+        ).returns(T.nilable(Shop))
+      end
+      def current(fields: nil, session: ShopifyAPI::Context.active_session)
+        all(session: session, fields: fields).first
+      end
+
     end
 
   end

data/lib/shopify_api/utils/attributes_comparator.rb

@@ -13,9 +13,10 @@ module ShopifyAPI
           params(
             original_attributes: T::Hash[String, T.untyped],
             updated_attributes: T::Hash[String, T.untyped],
+            atomic_hash_attributes: T::Array[Symbol],
           ).returns(T::Hash[String, T.untyped])
         end
-        def compare(original_attributes, updated_attributes)
+        def compare(original_attributes, updated_attributes, atomic_hash_attributes: [])
           attributes_diff = HashDiff::Comparison.new(
             original_attributes,
             updated_attributes,
@@ -24,6 +25,7 @@ module ShopifyAPI
           update_value = build_update_value(
             attributes_diff,
             reference_values: updated_attributes,
+            atomic_hash_attributes: atomic_hash_attributes,
           )
 
           update_value
@@ -34,9 +36,10 @@ module ShopifyAPI
             diff: T::Hash[String, T.untyped],
             path: T::Array[String],
             reference_values: T::Hash[String, T.untyped],
+            atomic_hash_attributes: T::Array[Symbol],
           ).returns(T::Hash[String, T.untyped])
         end
-        def build_update_value(diff, path: [], reference_values: {})
+        def build_update_value(diff, path: [], reference_values: {}, atomic_hash_attributes: [])
           new_hash = {}
 
           diff.each do |key, value|
@@ -49,7 +52,19 @@ module ShopifyAPI
               if has_numbered_key && ref_value.is_a?(Array)
                 new_hash[key] = ref_value
               else
-                new_value = build_update_value(value, path: current_path, reference_values: reference_values)
+                new_value = build_update_value(
+                  value,
+                  path: current_path,
+                  reference_values: reference_values,
+                  atomic_hash_attributes: atomic_hash_attributes,
+                )
+
+                atomic_update = atomic_hash_attributes.include?(key.to_sym)
+
+                # If the key is in atomic_hash_attributes, we use the entire reference value
+                # so we update the hash as a whole.
+                if !new_value.empty? && !ref_value.empty? && atomic_update
+                  new_hash[key] = ref_value
 
                 # Only add to new_hash if the user intentionally updates
                 # to empty value like `{}` or `[]`. For example:
@@ -70,7 +85,9 @@ module ShopifyAPI
                 # new_hash = {}
                 #
                 # new_hash is empty because nothing changes
-                new_hash[key] = new_value if !new_value.empty? || ref_value.empty?
+                elsif !new_value.empty? || ref_value.empty?
+                  new_hash[key] = new_value
+                end
               end
             elsif value != HashDiff::NO_VALUE
               new_hash[key] = value

data/lib/shopify_api/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module ShopifyAPI
-  VERSION = "14.4.0"
+  VERSION = "14.5.0"
 end

data/sorbet/rbi/shims/hash.rb

@@ -0,0 +1,3 @@
+class Hash
+  def with_indifferent_access; end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 14.4.0
+  version: 14.5.0
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -1058,6 +1058,7 @@ files:
 - sorbet/rbi/gems/yard@0.9.27.rbi
 - sorbet/rbi/gems/zeitwerk@2.5.4.rbi
 - sorbet/rbi/shims/fakefs.rbi
+- sorbet/rbi/shims/hash.rb
 - sorbet/rbi/shims/openssl.rb
 - sorbet/rbi/todo.rbi
 - sorbet/tapioca/config.yml
@@ -1083,7 +1084,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: The gem for accessing the Shopify API