shopify_api 14.1.0 → 14.6.0

data/lib/shopify_api/rest/resources/2024_10/variant.rb

@@ -0,0 +1,212 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Variant < ShopifyAPI::Rest::Base
+    extend T::Sig
+
+    @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
+    def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
+
+      @barcode = T.let(nil, T.nilable(String))
+      @compare_at_price = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @fulfillment_service = T.let(nil, T.nilable(String))
+      @grams = T.let(nil, T.nilable(Integer))
+      @id = T.let(nil, T.nilable(Integer))
+      @image_id = T.let(nil, T.nilable(Integer))
+      @inventory_item_id = T.let(nil, T.nilable(Integer))
+      @inventory_management = T.let(nil, T.nilable(String))
+      @inventory_policy = T.let(nil, T.nilable(String))
+      @inventory_quantity = T.let(nil, T.nilable(T.any(Integer, String)))
+      @old_inventory_quantity = T.let(nil, T.nilable(T.any(Integer, String)))
+      @option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @position = T.let(nil, T.nilable(Integer))
+      @presentment_prices = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @price = T.let(nil, T.nilable(String))
+      @product_id = T.let(nil, T.nilable(Integer))
+      @requires_shipping = T.let(nil, T.nilable(T::Boolean))
+      @sku = T.let(nil, T.nilable(String))
+      @tax_code = T.let(nil, T.nilable(String))
+      @taxable = T.let(nil, T.nilable(T::Boolean))
+      @title = T.let(nil, T.nilable(String))
+      @updated_at = T.let(nil, T.nilable(String))
+      @weight = T.let(nil, T.nilable(Float))
+      @weight_unit = T.let(nil, T.nilable(String))
+
+      super(session: session, from_hash: from_hash)
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [:product_id, :id], path: "products/<product_id>/variants/<id>.json"},
+      {http_method: :get, operation: :count, ids: [:product_id], path: "products/<product_id>/variants/count.json"},
+      {http_method: :get, operation: :get, ids: [:product_id], path: "products/<product_id>/variants.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "variants/<id>.json"},
+      {http_method: :post, operation: :post, ids: [:product_id], path: "products/<product_id>/variants.json"},
+      {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
+    ], T::Array[Symbol])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :barcode
+    sig { returns(T.nilable(String)) }
+    attr_reader :compare_at_price
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :fulfillment_service
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :grams
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :image_id
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :inventory_item_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :inventory_management
+    sig { returns(T.nilable(String)) }
+    attr_reader :inventory_policy
+    sig { returns(T.nilable(T.any(Integer, String))) }
+    attr_reader :inventory_quantity
+    sig { returns(T.nilable(T.any(Integer, String))) }
+    attr_reader :old_inventory_quantity
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :option
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :position
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :presentment_prices
+    sig { returns(T.nilable(String)) }
+    attr_reader :price
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :product_id
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :requires_shipping
+    sig { returns(T.nilable(String)) }
+    attr_reader :sku
+    sig { returns(T.nilable(String)) }
+    attr_reader :tax_code
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :taxable
+    sig { returns(T.nilable(String)) }
+    attr_reader :title
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+    sig { returns(T.nilable(Float)) }
+    attr_reader :weight
+    sig { returns(T.nilable(String)) }
+    attr_reader :weight_unit
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          fields: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(Variant))
+      end
+      def find(
+        id:,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {fields: fields},
+        )
+        T.cast(result[0], T.nilable(Variant))
+      end
+
+      sig do
+        params(
+          id: T.any(Integer, String),
+          product_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session
+        ).returns(T.untyped)
+      end
+      def delete(
+        id:,
+        product_id: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        request(
+          http_method: :delete,
+          operation: :delete,
+          session: session,
+          ids: {id: id, product_id: product_id},
+          params: {},
+        )
+      end
+
+      sig do
+        params(
+          product_id: T.nilable(T.any(Integer, String)),
+          limit: T.untyped,
+          presentment_currencies: T.untyped,
+          since_id: T.untyped,
+          fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Variant])
+      end
+      def all(
+        product_id: nil,
+        limit: nil,
+        presentment_currencies: nil,
+        since_id: nil,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {product_id: product_id},
+          params: {limit: limit, presentment_currencies: presentment_currencies, since_id: since_id, fields: fields}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[Variant])
+      end
+
+      sig do
+        params(
+          product_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        product_id: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {product_id: product_id},
+          params: {}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2024_10/webhook.rb

@@ -0,0 +1,172 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Webhook < ShopifyAPI::Rest::Base
+    extend T::Sig
+
+    @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
+    def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
+
+      @address = T.let(nil, T.nilable(String))
+      @topic = T.let(nil, T.nilable(String))
+      @api_version = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @fields = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @format = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @metafield_namespaces = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @private_metafield_namespaces = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @updated_at = T.let(nil, T.nilable(String))
+
+      super(session: session, from_hash: from_hash)
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [:id], path: "webhooks/<id>.json"},
+      {http_method: :get, operation: :count, ids: [], path: "webhooks/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "webhooks.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "webhooks/<id>.json"},
+      {http_method: :post, operation: :post, ids: [], path: "webhooks.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "webhooks/<id>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :address
+    sig { returns(T.nilable(String)) }
+    attr_reader :topic
+    sig { returns(T.nilable(String)) }
+    attr_reader :api_version
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :fields
+    sig { returns(T.nilable(String)) }
+    attr_reader :format
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :metafield_namespaces
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :private_metafield_namespaces
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          fields: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(Webhook))
+      end
+      def find(
+        id:,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {fields: fields},
+        )
+        T.cast(result[0], T.nilable(Webhook))
+      end
+
+      sig do
+        params(
+          id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.untyped)
+      end
+      def delete(
+        id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        request(
+          http_method: :delete,
+          operation: :delete,
+          session: session,
+          ids: {id: id},
+          params: {},
+        )
+      end
+
+      sig do
+        params(
+          address: T.untyped,
+          created_at_max: T.untyped,
+          created_at_min: T.untyped,
+          fields: T.untyped,
+          limit: T.untyped,
+          since_id: T.untyped,
+          topic: T.untyped,
+          updated_at_min: T.untyped,
+          updated_at_max: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Webhook])
+      end
+      def all(
+        address: nil,
+        created_at_max: nil,
+        created_at_min: nil,
+        fields: nil,
+        limit: nil,
+        since_id: nil,
+        topic: nil,
+        updated_at_min: nil,
+        updated_at_max: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {address: address, created_at_max: created_at_max, created_at_min: created_at_min, fields: fields, limit: limit, since_id: since_id, topic: topic, updated_at_min: updated_at_min, updated_at_max: updated_at_max}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[Webhook])
+      end
+
+      sig do
+        params(
+          address: T.untyped,
+          topic: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        address: nil,
+        topic: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {},
+          params: {address: address, topic: topic}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    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/utils/session_utils.rb

@@ -11,28 +11,16 @@ module ShopifyAPI
 
         sig do
           params(
-            auth_header: T.nilable(String),
+            shopify_id_token: T.nilable(String),
             cookies: T.nilable(T::Hash[String, String]),
             online: T::Boolean,
           ).returns(T.nilable(String))
         end
-        def current_session_id(auth_header, cookies, online)
+        def current_session_id(shopify_id_token, cookies, online)
           if Context.embedded?
-            if auth_header
-              matches = auth_header.match(/^Bearer (.+)$/)
-              unless matches
-                ShopifyAPI::Logger.warn("Missing Bearer token in authorization header")
-                raise Errors::MissingJwtTokenError, "Missing Bearer token in authorization header"
-              end
-
-              jwt_payload = Auth::JwtPayload.new(T.must(matches[1]))
-              shop = jwt_payload.shop
-
-              if online
-                jwt_session_id(shop, jwt_payload.sub)
-              else
-                offline_session_id(shop)
-              end
+            if shopify_id_token
+              id_token = shopify_id_token.gsub("Bearer ", "")
+              session_id_from_shopify_id_token(id_token: id_token, online: online)
             else
               # falling back to session cookie
               raise Errors::CookieNotFoundError, "JWT token or Session cookie not found for app" unless
@@ -48,6 +36,25 @@ module ShopifyAPI
           end
         end
 
+        sig do
+          params(
+            id_token: T.nilable(String),
+            online: T::Boolean,
+          ).returns(String)
+        end
+        def session_id_from_shopify_id_token(id_token:, online:)
+          raise Errors::MissingJwtTokenError, "Missing Shopify ID Token" if id_token.nil? || id_token.empty?
+
+          payload = Auth::JwtPayload.new(id_token)
+          shop = payload.shop
+
+          if online
+            jwt_session_id(shop, payload.sub)
+          else
+            offline_session_id(shop)
+          end
+        end
+
         sig { params(shop: String, user_id: String).returns(String) }
         def jwt_session_id(shop, user_id)
           "#{shop}_#{user_id}"

data/lib/shopify_api/version.rb

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

data/lib/shopify_api/webhooks/registry.rb

@@ -138,7 +138,7 @@ module ShopifyAPI
             }
           MUTATION
 
-          delete_response = client.query(query: delete_mutation)
+          delete_response = client.query(query: delete_mutation, response_as_struct: false)
           raise Errors::WebhookRegistrationError,
             "Failed to delete webhook from Shopify" unless delete_response.ok?
           result = T.cast(delete_response.body, T::Hash[String, T.untyped])
@@ -170,7 +170,7 @@ module ShopifyAPI
             }
           QUERY
 
-          fetch_id_response = client.query(query: fetch_id_query)
+          fetch_id_response = client.query(query: fetch_id_query, response_as_struct: false)
           raise Errors::WebhookRegistrationError,
             "Failed to fetch webhook from Shopify" unless fetch_id_response.ok?
           body = T.cast(fetch_id_response.body, T::Hash[String, T.untyped])
@@ -216,7 +216,7 @@ module ShopifyAPI
           ).returns(T::Hash[Symbol, T.untyped])
         end
         def webhook_registration_needed?(client, registration)
-          check_response = client.query(query: registration.build_check_query)
+          check_response = client.query(query: registration.build_check_query, response_as_struct: false)
           raise Errors::WebhookRegistrationError,
             "Failed to check if webhook was already registered" unless check_response.ok?
           parsed_check_result = registration.parse_check_result(T.cast(check_response.body, T::Hash[String, T.untyped]))
@@ -233,7 +233,8 @@ module ShopifyAPI
           ).returns(T::Hash[String, T.untyped])
         end
         def send_register_request(client, registration, webhook_id)
-          register_response = client.query(query: registration.build_register_query(webhook_id: webhook_id))
+          register_response = client.query(query: registration.build_register_query(webhook_id: webhook_id),
+            response_as_struct: false)
 
           raise Errors::WebhookRegistrationError, "Failed to register webhook with Shopify" unless register_response.ok?
 

data/sorbet/rbi/shims/hash.rb

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