shopify_api 13.0.0 → 13.2.0

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

@@ -0,0 +1,208 @@
+# 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)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
+    def initialize(session: ShopifyAPI::Context.active_session)
+      super(session: session)
+
+      @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(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))
+      @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))
+    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(Integer)) }
+    attr_reader :inventory_quantity
+    sig { returns(T.nilable(Integer)) }
+    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/2023_10/webhook.rb

@@ -0,0 +1,168 @@
+# 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)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
+    def initialize(session: ShopifyAPI::Context.active_session)
+      super(session: session)
+
+      @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))
+    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/version.rb

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

data/lib/shopify_api/webhooks/registration.rb

@@ -19,16 +19,21 @@ module ShopifyAPI
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :fields
 
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :metafield_namespaces
+
       sig do
         params(topic: String, path: String, handler: T.nilable(Handler),
-          fields: T.nilable(T.any(String, T::Array[String]))).void
+          fields: T.nilable(T.any(String, T::Array[String])),
+          metafield_namespaces: T.nilable(T::Array[String])).void
       end
-      def initialize(topic:, path:, handler: nil, fields: nil)
+      def initialize(topic:, path:, handler: nil, fields: nil, metafield_namespaces: nil)
         @topic = T.let(topic.gsub("/", "_").upcase, String)
         @path = path
         @handler = handler
         fields_array = fields.is_a?(String) ? fields.split(FIELDS_DELIMITER) : fields
         @fields = T.let(fields_array&.map(&:strip)&.compact, T.nilable(T::Array[String]))
+        @metafield_namespaces = T.let(metafield_namespaces&.map(&:strip)&.compact, T.nilable(T::Array[String]))
       end
 
       sig { abstract.returns(String) }
@@ -51,7 +56,7 @@ module ShopifyAPI
         identifier = webhook_id ? "id: \"#{webhook_id}\"" : "topic: #{@topic}"
 
         subscription_args_string = subscription_args.map do |k, v|
-          "#{k}: #{k == :includeFields ? v : '"' + v + '"'}"
+          "#{k}: #{[:includeFields, :metafieldNamespaces].include?(k) ? v : %("#{v}")}"
         end.join(", ")
 
         <<~QUERY
@@ -62,12 +67,22 @@ module ShopifyAPI
                 message
               }
               webhookSubscription {
-                id#{@fields.nil? ? "" : "\n      includeFields"}
+                #{subscription_response_attributes.join("\n      ")}
               }
             }
           }
         QUERY
       end
+
+      private
+
+      sig { returns(T::Array[String]) }
+      def subscription_response_attributes
+        attributes = ["id"]
+        attributes << "includeFields" if @fields
+        attributes << "metafieldNamespaces" if @metafield_namespaces
+        attributes
+      end
     end
   end
 end

data/lib/shopify_api/webhooks/registrations/event_bridge.rb

@@ -14,7 +14,7 @@ module ShopifyAPI
 
         sig { override.returns(T::Hash[Symbol, String]) }
         def subscription_args
-          { arn: callback_address, includeFields: fields }.compact
+          { arn: callback_address, includeFields: fields, metafieldNamespaces: metafield_namespaces }.compact
         end
 
         sig { override.params(webhook_id: T.nilable(String)).returns(String) }

data/lib/shopify_api/webhooks/registrations/http.rb

@@ -20,7 +20,7 @@ module ShopifyAPI
 
         sig { override.returns(T::Hash[Symbol, String]) }
         def subscription_args
-          { callbackUrl: callback_address, includeFields: fields }.compact
+          { callbackUrl: callback_address, includeFields: fields, metafieldNamespaces: metafield_namespaces }.compact
         end
 
         sig { override.params(webhook_id: T.nilable(String)).returns(String) }

data/lib/shopify_api/webhooks/registrations/pub_sub.rb

@@ -17,7 +17,8 @@ module ShopifyAPI
           project_topic_pair = callback_address.gsub(%r{^pubsub://}, "").split(":")
           project = project_topic_pair[0]
           topic = project_topic_pair[1]
-          { pubSubProject: project, pubSubTopic: topic, includeFields: fields }.compact
+          { pubSubProject: project, pubSubTopic: topic, includeFields: fields,
+            metafieldNamespaces: metafield_namespaces, }.compact
         end
 
         sig { override.params(webhook_id: T.nilable(String)).returns(String) }

data/lib/shopify_api/webhooks/registry.rb

@@ -13,20 +13,24 @@ module ShopifyAPI
             delivery_method: Symbol,
             path: String,
             handler: T.nilable(Handler),
-            fields: T.nilable(String)).void
+            fields: T.nilable(T.any(String, T::Array[String])),
+            metafield_namespaces: T.nilable(T::Array[String])).void
         end
-        def add_registration(topic:, delivery_method:, path:, handler: nil, fields: nil)
+        def add_registration(topic:, delivery_method:, path:, handler: nil, fields: nil, metafield_namespaces: nil)
           @registry[topic] = case delivery_method
           when :pub_sub
-            Registrations::PubSub.new(topic: topic, path: path, fields: fields)
+            Registrations::PubSub.new(topic: topic, path: path, fields: fields,
+              metafield_namespaces: metafield_namespaces)
           when :event_bridge
-            Registrations::EventBridge.new(topic: topic, path: path, fields: fields)
+            Registrations::EventBridge.new(topic: topic, path: path, fields: fields,
+              metafield_namespaces: metafield_namespaces)
           when :http
             unless handler
               raise Errors::InvalidWebhookRegistrationError, "Cannot create an Http registration without a handler."
             end
 
-            Registrations::Http.new(topic: topic, path: path, handler: handler, fields: fields)
+            Registrations::Http.new(topic: topic, path: path, handler: handler,
+              fields: fields, metafield_namespaces: metafield_namespaces)
           else
             raise Errors::InvalidWebhookRegistrationError,
               "Unsupported delivery method #{delivery_method}. Allowed values: {:http, :pub_sub, :event_bridge}."

data/shopify_api.gemspec

@@ -41,7 +41,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("openssl")
   s.add_runtime_dependency("securerandom")
   s.add_runtime_dependency("sorbet-runtime")
-  s.add_runtime_dependency("zeitwerk", "~> 2.5", "< 2.6.5") # https://github.com/Shopify/shopify-api-ruby/issues/1058
+  s.add_runtime_dependency("zeitwerk", "~> 2.5")
 
   s.add_development_dependency("pry-byebug")
   s.add_development_dependency("rake")