shopify_api 10.0.3 → 11.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81babe6da64bc6c8b0e413213fff00c818778c5bc5cf9bd79b1acb25fd3ea3d1
-  data.tar.gz: b9dda7bb0992365df524d1e22d70ee34fee776a68c5dc9e958b826d49c6c0541
+  metadata.gz: 480de35765a695c4111ca43f241270a12a7eb4a22c83844fa5820a27ac829125
+  data.tar.gz: 5d20da61c0cad987a0b6048cf6a10460af29e80df2d7c89617e24e12fc5f1049
 SHA512:
-  metadata.gz: cb1eeacedfe1a0fdd8f0262e0bb63ea52996aa6a98f1ffee803481a2ce38424f31d8aa0658108f53a376fef29d5a65acf7bb1384d6d87ce21e52eabdc4926da8
-  data.tar.gz: 03c666d05fc413b5da1951a0693818ca97c48064bb2735facb019a4e04a55581525ee061e19dc1c1406e4c67a0949ded89ffec69ef5cab1f1d8866f8d514277f
+  metadata.gz: 68662d27963ec681ca2b1604e11991f33ae19b3833711828743ac17905c5ed62ed37d2ca425b2042ea2093608ece1cc14d2bc2052f0f6b71c42d21b667e7ef71
+  data.tar.gz: febcfc8ca74c8bf13529d71d91ef6083075c011edb4aeda539b3e5a7d003471a2536a94180ba182b8bbf335ac7f7d9f4752e49ddfac08d1897e02880b24bbff8

data/.github/workflows/build.yml

@@ -11,7 +11,6 @@ jobs:
     strategy:
       matrix:
         version:
-          - 2.6
           - 2.7
           - 3.0
           - 3.1

data/.rubocop.yml

@@ -5,7 +5,7 @@ require:
   - rubocop-sorbet
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   NewCops: enable
   Exclude:
     - "sorbet/**/*"

data/BREAKING_CHANGES_FOR_OLDER_VERSIONS.md

@@ -0,0 +1,110 @@
+# Breaking changes for older versions
+
+The breaking changes for the previous major release are listed in the main [README](README.md).
+The breaking changes for older major releases are listed below.
+
+### Breaking change notice for version 8.0.0
+
+Version 7.0.0 introduced ApiVersion, and known versions were hardcoded into the gem. Manually defining API versions is no longer required for versions not listed in the gem. Version 8.0.0 removes the following:
+* `ShopifyAPI::ApiVersion::Unstable`
+* `ShopifyAPI::ApiVersion::Release`
+* `ShopifyAPI::ApiVersion.define_version`
+
+The following methods on `ApiVersion` have been deprecated:
+- `.coerce_to_version` deprecated. use `.find_version`
+- `.define_known_versions` deprecated. Use `.fetch_known_versions`
+- `.clear_defined_versions` deprecated. Use. `.clear_known_versions`
+- `.latest_stable_version` deprecated. Use `ShopifyAPI::Meta.admin_versions.find(&:latest_supported)` (this fetches info from Shopify servers. No authentication required.)
+- `#name` deprecated. Use `#handle`
+- `#stable?` deprecated. Use `#supported?`
+
+Version 8.0.0 introduces a _version lookup mode_. By default, `ShopifyAPI::ApiVersion.version_lookup_mode` is `:define_on_unknown`. When setting the api_version on `Session` or `Base`, the `api_version` attribute takes a version handle (i.e. `'2019-07'` or `:unstable`) and sets an instance of `ShopifyAPI::ApiVersion` matching the handle. When the version_lookup_mode is set to `:define_on_unknown`, any handle will naïvely create a new `ApiVersion` if the version is not in the known versions returned by `ShopifyAPI::ApiVersion.versions`.
+
+To ensure you're setting only known and active versions, call :
+
+```ruby
+ShopifyAPI::ApiVersion.version_lookup_mode = :raise_on_unknown
+ShopifyAPI::ApiVersion.fetch_known_versions
+```
+
+Known and active versions are fetched from https://app.shopify.com/services/apis.json and cached. Trying to use a version outside this cached set will raise an error. To switch back to naïve lookup and create a version if one is not found, call `ShopifyAPI::ApiVersion.version_lookup_mode = :define_on_unknown`.
+
+### Breaking change notice for version 7.0.0
+
+#### Changes to ShopifyAPI::Session
+When creating sessions, `api_version`is now required and uses keyword arguments.
+
+To upgrade your use of ShopifyAPI you will need to make the following changes.
+
+```ruby
+ShopifyAPI::Session.new(domain, token, extras)
+```
+is now
+```ruby
+ShopifyAPI::Session.new(domain: domain, token: token, api_version: api_version, extras: extras)
+```
+Note `extras` is still optional. The other arguments are required.
+
+```ruby
+ShopifyAPI::Session.temp(domain, token, extras) do
+  ...
+end
+```
+is now
+```ruby
+ShopifyAPI::Session.temp(domain: domain, token: token, api_version: api_version) do
+  ...
+end
+```
+
+For example, if you want to use the `2019-04` version, you will create a session like this:
+```ruby
+session = ShopifyAPI::Session.new(domain: domain, token: token, api_version: '2019-04')
+```
+if you want to use the `unstable` version, you will create a session like this:
+```ruby
+session = ShopifyAPI::Session.new(domain: domain, token: token, api_version: :unstable)
+```
+
+#### Changes to how to define resources
+
+If you have defined or customized Resources, classes that extend `ShopifyAPI::Base`:
+The use of `self.prefix =` has been deprecated; you should now use `self.resource =` and not include `/admin`.
+For example, if you specified a prefix like this before:
+```ruby
+class MyResource < ShopifyAPI::Base
+  self.prefix = '/admin/shop/'
+end
+```
+You will update this to:
+```ruby
+class MyResource < ShopifyAPI::Base
+  self.resource_prefix = 'shop/'
+end
+```
+
+#### URL construction
+
+If you have specified any full paths for API calls in find
+```ruby
+def self.current(options={})
+  find(:one, options.merge(from: "/admin/shop.#{format.extension}"))
+end
+```
+would be changed to
+
+```ruby
+def self.current(options = {})
+  find(:one, options.merge(
+    from: api_version.construct_api_path("shop.#{format.extension}")
+  ))
+end
+```
+
+#### URLs that have not changed
+
+- OAuth URLs for `authorize`, getting the `access_token` from a code, `access_scopes`, and using a `refresh_token` have _not_ changed.
+  - get: `/admin/oauth/authorize`
+  - post: `/admin/oauth/access_token`
+  - get: `/admin/oauth/access_scopes`
+- URLs for the merchant’s web admin have _not_ changed. For example: to send the merchant to the product page the url is still `/admin/product/<id>`

data/CHANGELOG.md

@@ -1,7 +1,27 @@
 # Changelog
 
+Note: For changes to the API, see https://shopify.dev/changelog?filter=api
+
 ## Unreleased
 
+N/A
+
+## Version 11.0.1
+
+- [#990](https://github.com/Shopify/shopify-api-ruby/pull/991) Validate `hmac` signature of OAuth callback using both old and new API secrets
+
+## Version 11.0.0
+
+- [#987](https://github.com/Shopify/shopify_api/pull/987) ⚠️ [Breaking] Add REST resources for July 2022 API version, remove support and REST resources for July 2021 (`2021-07`) API version
+- [#979](https://github.com/Shopify/shopify_api/pull/979) Update `ShopifyAPI::Context.setup` to take `old_api_secret_key` to support API credentials rotation
+- [#977](https://github.com/Shopify/shopify_api/pull/977) Fix webhook requests when a header is present having a symbol key (e.g. `:clearance`)
+
+## Version 10.1.0
+
+- [#933](https://github.com/Shopify/shopify_api/pull/933) Fix syntax of GraphQL query in `Webhooks.get_webhook_id` method by removing extra curly brace
+- [#941](https://github.com/Shopify/shopify_api/pull/941) Fix `to_hash` to return readonly attributes, unless being used for serialize the object for saving - fix issue [#930](https://github.com/Shopify/shopify_api/issues/930)
+- [#959](https://github.com/Shopify/shopify_api/pull/959) Update `LATEST_SUPPORTED_ADMIN_VERSION` to `2022-04` to align it with the current value
+
 ## Version 10.0.3
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (10.0.3)
+    shopify_api (11.0.1)
       concurrent-ruby
       hash_diff
       httparty
@@ -36,7 +36,7 @@ GEM
       multi_xml (>= 0.5.2)
     i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    jwt (2.3.0)
+    jwt (2.4.1)
     method_source (1.0.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
@@ -44,10 +44,10 @@ GEM
     minitest (5.15.0)
     mocha (1.13.0)
     multi_xml (0.6.0)
-    oj (3.13.11)
+    oj (3.13.15)
     openssl (3.0.0)
     parallel (1.21.0)
-    parser (3.1.0.0)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -55,9 +55,9 @@ GEM
     public_suffix (4.0.6)
     rainbow (3.1.1)
     rake (13.0.6)
-    rbi (0.0.11)
+    rbi (0.0.14)
       ast
-      parser
+      parser (>= 2.6.4.0)
       sorbet-runtime (>= 0.5.9204)
       unparser
     regexp_parser (2.2.0)
@@ -79,29 +79,32 @@ GEM
       rubocop (>= 0.90.0)
     ruby-progressbar (1.11.0)
     securerandom (0.2.0)
-    sorbet (0.5.9924)
-      sorbet-static (= 0.5.9924)
-    sorbet-runtime (0.5.9924)
-    sorbet-static (0.5.9924-universal-darwin-21)
-    sorbet-static (0.5.9924-x86_64-linux)
-    spoom (1.1.8)
+    sorbet (0.5.10109)
+      sorbet-static (= 0.5.10109)
+    sorbet-runtime (0.5.10109)
+    sorbet-static (0.5.10109-universal-darwin-21)
+    sorbet-static (0.5.10109-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10109)
+      sorbet (= 0.5.10109)
+      sorbet-runtime (= 0.5.10109)
+    spoom (1.1.11)
       sorbet (>= 0.5.9204)
       sorbet-runtime (>= 0.5.9204)
       thor (>= 0.19.2)
-    tapioca (0.6.3)
+    tapioca (0.8.3)
       bundler (>= 1.17.3)
+      parallel (>= 1.21.0)
       pry (>= 0.12.2)
-      rbi (~> 0.0.0, >= 0.0.9)
-      sorbet-runtime (>= 0.5.9204)
-      sorbet-static (>= 0.5.9204)
-      spoom (~> 1.1.0, >= 1.1.4)
+      rbi (~> 0.0.0, >= 0.0.14)
+      sorbet-static-and-runtime (>= 0.5.9204)
+      spoom (~> 1.1.0, >= 1.1.11)
       thor (>= 1.2.0)
       yard-sorbet
     thor (1.2.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
-    unparser (0.6.3)
+    unparser (0.6.5)
       diff-lcs (~> 1.3)
       parser (>= 3.1.0)
     webmock (3.14.0)
@@ -109,12 +112,12 @@ GEM
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.7.0)
-    yard (0.9.27)
+    yard (0.9.28)
       webrick (~> 1.7.0)
     yard-sorbet (0.6.1)
       sorbet-runtime (>= 0.5)
       yard (>= 0.9)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -57,7 +57,7 @@ ShopifyAPI::Context.setup(
   session_storage: ShopifyAPI::Auth::FileSessionStorage.new, # See more details below
   is_embedded: true, # Set to true if you are building an embedded app
   is_private: false, # Set to true if you are building a private app
-  api_version: "2022-01" # The vesion of the API you would like to use
+  api_version: "2022-01" # The version of the API you would like to use
 )
 ```
 
@@ -115,112 +115,9 @@ With this, a lot changed in how apps access the library. Here are the updates yo
     | `order = Order.new(<id>)`<br/>`order.post(:close)` | `order = Order.new(session:)`<br/>`order.close()` |
     | `order = Order.new(<id>)`<br/>`order.delete` | `Order.delete(id: <id>, session:)` |
 
-### Breaking change notice for version 8.0.0
-
-Version 7.0.0 introduced ApiVersion, and known versions were hardcoded into the gem. Manually defining API versions is no longer required for versions not listed in the gem. Version 8.0.0 removes the following:
-* `ShopifyAPI::ApiVersion::Unstable`
-* `ShopifyAPI::ApiVersion::Release`
-* `ShopifyAPI::ApiVersion.define_version`
-
-The following methods on `ApiVersion` have been deprecated:
-- `.coerce_to_version` deprecated. use `.find_version`
-- `.define_known_versions` deprecated. Use `.fetch_known_versions`
-- `.clear_defined_versions` deprecated. Use. `.clear_known_versions`
-- `.latest_stable_version` deprecated. Use `ShopifyAPI::Meta.admin_versions.find(&:latest_supported)` (this fetches info from Shopify servers. No authentication required.)
-- `#name` deprecated. Use `#handle`
-- `#stable?` deprecated. Use `#supported?`
-
-Version 8.0.0 introduces a _version lookup mode_. By default, `ShopifyAPI::ApiVersion.version_lookup_mode` is `:define_on_unknown`. When setting the api_version on `Session` or `Base`, the `api_version` attribute takes a version handle (i.e. `'2019-07'` or `:unstable`) and sets an instance of `ShopifyAPI::ApiVersion` matching the handle. When the version_lookup_mode is set to `:define_on_unknown`, any handle will naïvely create a new `ApiVersion` if the version is not in the known versions returned by `ShopifyAPI::ApiVersion.versions`.
-
-To ensure you're setting only known and active versions, call :
-
-```ruby
-ShopifyAPI::ApiVersion.version_lookup_mode = :raise_on_unknown
-ShopifyAPI::ApiVersion.fetch_known_versions
-```
-
-Known and active versions are fetched from https://app.shopify.com/services/apis.json and cached. Trying to use a version outside this cached set will raise an error. To switch back to naïve lookup and create a version if one is not found, call `ShopifyAPI::ApiVersion.version_lookup_mode = :define_on_unknown`.
-
-### Breaking change notice for version 7.0.0
-
-#### Changes to ShopifyAPI::Session
-When creating sessions, `api_version`is now required and uses keyword arguments.
-
-To upgrade your use of ShopifyAPI you will need to make the following changes.
-
-```ruby
-ShopifyAPI::Session.new(domain, token, extras)
-```
-is now
-```ruby
-ShopifyAPI::Session.new(domain: domain, token: token, api_version: api_version, extras: extras)
-```
-Note `extras` is still optional. The other arguments are required.
-
-```ruby
-ShopifyAPI::Session.temp(domain, token, extras) do
-  ...
-end
-```
-is now
-```ruby
-ShopifyAPI::Session.temp(domain: domain, token: token, api_version: api_version) do
-  ...
-end
-```
-
-For example, if you want to use the `2019-04` version, you will create a session like this:
-```ruby
-session = ShopifyAPI::Session.new(domain: domain, token: token, api_version: '2019-04')
-```
-if you want to use the `unstable` version, you will create a session like this:
-```ruby
-session = ShopifyAPI::Session.new(domain: domain, token: token, api_version: :unstable)
-```
-
-#### Changes to how to define resources
-
-If you have defined or customized Resources, classes that extend `ShopifyAPI::Base`:
-The use of `self.prefix =` has been deprecated; you should now use `self.resource =` and not include `/admin`.
-For example, if you specified a prefix like this before:
-```ruby
-class MyResource < ShopifyAPI::Base
-  self.prefix = '/admin/shop/'
-end
-```
-You will update this to:
-```ruby
-class MyResource < ShopifyAPI::Base
-  self.resource_prefix = 'shop/'
-end
-```
-
-#### URL construction
-
-If you have specified any full paths for API calls in find
-```ruby
-def self.current(options={})
-  find(:one, options.merge(from: "/admin/shop.#{format.extension}"))
-end
-```
-would be changed to
-
-```ruby
-def self.current(options = {})
-  find(:one, options.merge(
-    from: api_version.construct_api_path("shop.#{format.extension}")
-  ))
-end
-```
-
-#### URLs that have not changed
-
-- OAuth URLs for `authorize`, getting the `access_token` from a code, `access_scopes`, and using a `refresh_token` have _not_ changed.
-  - get: `/admin/oauth/authorize`
-  - post: `/admin/oauth/access_token`
-  - get: `/admin/oauth/access_scopes`
-- URLs for the merchant’s web admin have _not_ changed. For example: to send the merchant to the product page the url is still `/admin/product/<id>`
+## Breaking changes for older versions
 
+See [BREAKING_CHANGES_FOR_OLDER_VERSIONS](BREAKING_CHANGES_FOR_OLDER_VERSIONS.md)
 
 ## Developing this gem
 

data/RELEASING.md

@@ -1,6 +1,7 @@
 # Releasing ShopifyAPI
 
-1. Before releasing, make sure `sorbet` and `sorbet-runtime` are up to date
+1. Before releasing, make sure `sorbet` and related gems are up to date:
+   `bundle update sorbet sorbet-runtime sorbet-static tapioca --conservative`
 1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
 1. Update the version of ShopifyAPI in lib/shopify_api/version.rb
 1. Run `bundle`

data/docs/usage/graphql.md

@@ -54,7 +54,7 @@ variables = {
   first: 3
 }
 
-response = client.query(data: query, variables: variables)
+response = client.query(query: query, variables: variables)
 
 ```
 

data/lib/shopify_api/admin_versions.rb

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

data/lib/shopify_api/auth/jwt_payload.rb

@@ -16,11 +16,12 @@ module ShopifyAPI
 
       sig { params(token: String).void }
       def initialize(token)
-        begin
-          payload_hash = JWT.decode(token, Context.api_secret_key, true,
-            { exp_leeway: JWT_EXPIRATION_LEEWAY, algorithm: "HS256" })[0]
-        rescue
-          raise ShopifyAPI::Errors::InvalidJwtTokenError, "Failed to parse session token '#{token}'"
+        payload_hash = begin
+          decode_token(token, Context.api_secret_key)
+        rescue ShopifyAPI::Errors::InvalidJwtTokenError
+          raise unless Context.old_api_secret_key
+
+          decode_token(token, T.must(Context.old_api_secret_key))
         end
 
         @iss = T.let(payload_hash["iss"], String)
@@ -67,6 +68,16 @@ module ShopifyAPI
           jti == other.jti &&
           sid == other.sid
       end
+
+      private
+
+      sig { params(token: String, api_secret_key: String).returns(T::Hash[String, T.untyped]) }
+      def decode_token(token, api_secret_key)
+        JWT.decode(token, api_secret_key, true,
+          { exp_leeway: JWT_EXPIRATION_LEEWAY, algorithm: "HS256" })[0]
+      rescue
+        raise ShopifyAPI::Errors::InvalidJwtTokenError, "Failed to parse session token '#{token}'"
+      end
     end
   end
 end

data/lib/shopify_api/context.rb

@@ -18,6 +18,7 @@ module ShopifyAPI
     @notified_missing_resources_folder = T.let({}, T::Hash[String, T::Boolean])
     @active_session = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
     @user_agent_prefix = T.let(nil, T.nilable(String))
+    @old_api_secret_key = T.let(nil, T.nilable(String))
 
     @rest_resource_loader = T.let(nil, T.nilable(Zeitwerk::Loader))
 
@@ -37,6 +38,7 @@ module ShopifyAPI
           logger: Logger,
           private_shop: T.nilable(String),
           user_agent_prefix: T.nilable(String),
+          old_api_secret_key: T.nilable(String),
         ).void
       end
       def setup(
@@ -50,7 +52,8 @@ module ShopifyAPI
         session_storage:,
         logger: Logger.new($stdout),
         private_shop: nil,
-        user_agent_prefix: nil
+        user_agent_prefix: nil,
+        old_api_secret_key: nil
       )
         unless ShopifyAPI::AdminVersions::SUPPORTED_ADMIN_VERSIONS.include?(api_version)
           raise Errors::UnsupportedVersionError,
@@ -68,6 +71,7 @@ module ShopifyAPI
         @logger = logger
         @private_shop = private_shop
         @user_agent_prefix = user_agent_prefix
+        @old_api_secret_key = old_api_secret_key
 
         load_rest_resources(api_version: api_version)
       end
@@ -118,7 +122,7 @@ module ShopifyAPI
       end
 
       sig { returns(T.nilable(String)) }
-      attr_reader :private_shop, :user_agent_prefix
+      attr_reader :private_shop, :user_agent_prefix, :old_api_secret_key
 
       sig { returns(T::Boolean) }
       def embedded?

data/lib/shopify_api/rest/base.rb

@@ -55,6 +55,12 @@ module ShopifyAPI
         sig { returns(T.nilable(String)) }
         attr_reader :custom_prefix
 
+        sig { returns(T::Hash[Symbol, Class]) }
+        attr_reader :has_many
+
+        sig { returns(T::Hash[Symbol, Class]) }
+        attr_reader :has_one
+
         sig do
           params(
             session: T.nilable(Auth::Session),
@@ -261,8 +267,8 @@ module ShopifyAPI
         match.nil? ? true : super
       end
 
-      sig { returns(T::Hash[String, T.untyped]) }
-      def to_hash
+      sig { params(saving: T::Boolean).returns(T::Hash[String, T.untyped]) }
+      def to_hash(saving = false)
         hash = {}
         instance_variables.each do |var|
           next if [
@@ -273,7 +279,7 @@ module ShopifyAPI
             :"@errors",
             :"@aliased_properties",
           ].include?(var)
-          next if self.class.read_only_attributes&.include?(var)
+          next if saving && self.class.read_only_attributes&.include?(var)
 
           var = var.to_s.delete("@")
           attribute = if @aliased_properties.value?(var)
@@ -283,9 +289,16 @@ module ShopifyAPI
           end.to_sym
 
           if self.class.has_many?(attribute)
-            hash[attribute.to_s] = get_property(attribute).map(&:to_hash).to_a if get_property(attribute)
+            attribute_class = self.class.has_many[attribute]
+            hash[attribute.to_s] = get_property(attribute).map do |element|
+              get_element_hash(element, T.unsafe(attribute_class), saving)
+            end.to_a if get_property(attribute)
           elsif self.class.has_one?(attribute)
-            element_hash = get_property(attribute)&.to_hash
+            element_hash = get_element_hash(
+              get_property(attribute),
+              T.unsafe(self.class.has_one[attribute]),
+              saving
+            )
             hash[attribute.to_s] = element_hash if element_hash || @forced_nils[attribute.to_s]
           elsif !get_property(attribute).nil? || @forced_nils[attribute.to_s]
             hash[attribute.to_s] =
@@ -313,7 +326,7 @@ module ShopifyAPI
 
       sig { params(update_object: T::Boolean).void }
       def save(update_object: false)
-        hash = HashDiff::Comparison.new(original_state, to_hash).left_diff
+        hash = HashDiff::Comparison.new(original_state, to_hash(true)).left_diff
         method = hash[self.class.primary_key] ? :put : :post
 
         path = self.class.get_path(http_method: method, operation: method, entity: self)
@@ -355,6 +368,20 @@ module ShopifyAPI
 
         instance_variable_get("@#{clean_key}")
       end
+
+      sig do
+        params(
+          element: T.nilable(T.any(T::Hash[String, T.untyped], ShopifyAPI::Rest::Base)),
+          attribute_class: Class,
+          saving: T::Boolean,
+        ).returns(T.nilable(T::Hash[String, T.untyped]))
+      end
+      def get_element_hash(element, attribute_class, saving)
+        return nil if element.nil?
+        return element.to_hash(saving) unless element.is_a?(Hash)
+
+        T.unsafe(attribute_class).create_instance(session: @session, data: element).to_hash(saving)
+      end
     end
   end
 end

data/lib/shopify_api/rest/resources/2021_10/abandoned_checkout.rb

@@ -1,6 +1,10 @@
 # typed: false
 # frozen_string_literal: true
 
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
 module ShopifyAPI
   class AbandonedCheckout < ShopifyAPI::Rest::Base
     extend T::Sig

data/lib/shopify_api/rest/resources/2021_10/access_scope.rb

@@ -1,6 +1,10 @@
 # typed: false
 # frozen_string_literal: true
 
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
 module ShopifyAPI
   class AccessScope < ShopifyAPI::Rest::Base
     extend T::Sig

data/lib/shopify_api/rest/resources/2021_10/android_pay_key.rb

@@ -1,6 +1,10 @@
 # typed: false
 # frozen_string_literal: true
 
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
 module ShopifyAPI
   class AndroidPayKey < ShopifyAPI::Rest::Base
     extend T::Sig

data/lib/shopify_api/rest/resources/2021_10/apple_pay_certificate.rb

@@ -1,6 +1,10 @@
 # typed: false
 # frozen_string_literal: true
 
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
 module ShopifyAPI
   class ApplePayCertificate < ShopifyAPI::Rest::Base
     extend T::Sig

data/lib/shopify_api/rest/resources/2021_10/application_charge.rb

@@ -1,6 +1,10 @@
 # typed: false
 # frozen_string_literal: true
 
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
 module ShopifyAPI
   class ApplicationCharge < ShopifyAPI::Rest::Base
     extend T::Sig

data/lib/shopify_api/rest/resources/2021_10/application_credit.rb

@@ -1,6 +1,10 @@
 # typed: false
 # frozen_string_literal: true
 
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
 module ShopifyAPI
   class ApplicationCredit < ShopifyAPI::Rest::Base
     extend T::Sig