shopify_api 14.3.0 → 14.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f2fd17eb9b42d6054e8b676c5d446cbc9890b7156f5c4b402a5efb776ad1421
-  data.tar.gz: 1deefc0fdcc79f57b70fb1fbeb2072916847b8d68c614b4b150dafd86f0ff6d5
+  metadata.gz: 8b9b61bc6316148fcd2d905384def067e31b4fca5265bb1327a7502020ee6104
+  data.tar.gz: b3971fadf5e0159a68953fee0883be0a6fb5f366d0a25f39201cc6c134caa0bb
 SHA512:
-  metadata.gz: 3cfdd1a407afb83e8557d607c65dd74322a7ca944fe58b2b42d68a911917442f51c78a0a7e59759a4fca59ae063c7af253ad8a297614a409621c52e0baf60ee6
-  data.tar.gz: e218a6a5c77d9de8e3b0a755c0bcb1b4941bb5cfba503564ffa4ca0a59c19b76e8c0cb56cb1ee458091bd43004fa3b16c200fa4696b058a0b90c9c3475bd37d0
+  metadata.gz: 845bcdfac189ab0b17a07540c7cad3ba3621bbc83622d16b32a143f37eaaf9909499beb8791a2f0a0b6726e8283f833c5f1702ae804bbe38393ee5d6fa0fef67
+  data.tar.gz: f0216976a29a1b59ab8bf89316d3ccc9b3cbda4a42b81490cb5e25af19d9cf2b2b196484397816decdde75065f387e1f9bfddd5d82a42c110be8f13654c6f8d9

data/BREAKING_CHANGES_FOR_V15.md

@@ -0,0 +1,42 @@
+# Breaking change notice for version 15.0.0
+
+## Removal of `ShopifyAPI::Webhooks::Handler`
+
+The `ShopifyAPI::Webhooks::Handler` class has been removed in favor of `ShopifyAPI::Webhooks::WebhookHandler`. The `ShopifyAPI::Webhooks::WebhookHandler` class is now the recommended way to handle webhooks.
+
+Make a module or class that includes or extends `ShopifyAPI::Webhooks::WebhookHandler` and implement the `handle` method which accepts the following named parameters: data: `WebhookMetadata`.
+
+In v14, adding new fields to the callback would become a breaking change. To make this code more flexible, handlers will now receive an object that can be typed and extended.
+
+`data` will have the following keys
+- `topic`, `String` - The topic of the webhook
+- `shop`, `String` - The shop domain of the webhook
+- `body`, `T::Hash[String, T.untyped]`- The body of the webhook
+- `webhook_id`, `String` - The id of the webhook event to [avoid duplicates](https://shopify.dev/docs/apps/webhooks/best-practices#ignore-duplicates)
+- `api_version`, `String` - The api version of the webhook
+
+### New implementation
+```ruby
+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"
+    end
+  end
+end
+```
+
+### Previous implementation
+```ruby
+module WebhookHandler
+  include ShopifyAPI::Webhooks::Handler
+
+  class << self
+    def handle(topic:, shop:, body:)
+      puts "Received webhook! topic: #{topic} shop: #{shop} body: #{body}"
+    end
+  end
+end
+```

data/CHANGELOG.md

@@ -4,8 +4,22 @@ 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
+- [#1320](https://github.com/Shopify/shopify-api-ruby/pull/1320) Fix sorbet type on Shop.tax_shipping field
+
 ## 14.3.0
+
 - [#1312](https://github.com/Shopify/shopify-api-ruby/pull/1312) Use same leeway for `exp` and `nbf` when parsing JWT
+- [#1313](https://github.com/Shopify/shopify-api-ruby/pull/1313) Fix: Webhook Registry now working with response_as_struct enabled
 - [#1314](https://github.com/Shopify/shopify-api-ruby/pull/1314)
   - Add new session util method `SessionUtils::session_id_from_shopify_id_token`
   - `SessionUtils::current_session_id` now accepts shopify Id token in the format of `Bearer this_token` or just `this_token`
@@ -15,9 +29,11 @@ Note: For changes to the API, see https://shopify.dev/changelog?filter=api
   - `expires_at` alias for `exp` - returns the expiration time
 
 ## 14.2.0
+
 - [#1309](https://github.com/Shopify/shopify-api-ruby/pull/1309) Add `Session#copy_attributes_from` method
 
 ## 14.1.0
+
 - [#1071](https://github.com/Shopify/shopify-api-ruby/issues/1071) Fix FulfillmentEvent class types
 - Fix: InventoryItem class `harmonized_system_code` attribute type which can be either integer, string or nil
 - Fix: Variant class `inventory_quantity` attribute type which can be either integer, string or nil
@@ -26,10 +42,12 @@ Note: For changes to the API, see https://shopify.dev/changelog?filter=api
 - [1305](https://github.com/Shopify/shopify-api-ruby/pull/1305/) Adds support for the `2024-04` API version.
 
 ## 14.0.1
+
 - [#1288](https://github.com/Shopify/shopify-api-ruby/pull/1288) Fix FeatureDeprecatedError being raised without a message.
 - [1290](https://github.com/Shopify/shopify-api-ruby/pull/1290) Move deprecation of `ShopifyAPI::Webhooks::Handler#handle` to version 15.0.0
 
 ## 14.0.0
+
 - [#1274](https://github.com/Shopify/shopify-api-ruby/pull/1274) ⚠️ [Breaking] Update sorbet and rbi dependencies. Remove support for ruby 2.7. Minimum required Ruby version is 3.0
 - [#1282](https://github.com/Shopify/shopify-api-ruby/pull/1282) Fixes a bug where diffing attributes to update not take into account of Array changes and required ids.
 - [#1254](https://github.com/Shopify/shopify-api-ruby/pull/1254) Introduce token exchange API for fetching access tokens. This feature is currently unstable and cannot be used yet.
@@ -37,6 +55,7 @@ Note: For changes to the API, see https://shopify.dev/changelog?filter=api
 - [#1275](https://github.com/Shopify/shopify-api-ruby/pull/1275) Allow adding custom headers in REST Resource HTTP calls.
 
 ## 13.4.0
+
 - [#1210](https://github.com/Shopify/shopify-api-ruby/pull/1246) Add context option `response_as_struct` to allow GraphQL API responses to be accessed via dot notation.
 - [#1257](https://github.com/Shopify/shopify-api-ruby/pull/1257) Add `api_call_limit` and `retry_request_after` to REST resources to expose rate limit information.
 - [#1257](https://github.com/Shopify/shopify-api-ruby/pull/1257) Added support for the 2024-01 API version. This also includes a fix for the `for_hash` option when creating resources.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (14.3.0)
+    shopify_api (14.5.0)
       activesupport
       concurrent-ruby
       hash_diff
@@ -160,4 +160,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.3.4
+   2.5.9

data/README.md

@@ -79,6 +79,9 @@ Once your app can perform OAuth, it can now make authenticated Shopify API calls
 
 ## Breaking Change Notices
 
+### Breaking change notice for version 15.0.0
+See [BREAKING_CHANGES_FOR_V15](BREAKING_CHANGES_FOR_V15.md)
+
 ### Breaking change notice for version 10.0.0
 See [BREAKING_CHANGES_FOR_V10](BREAKING_CHANGES_FOR_V10.md)
 

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/oauth.md

@@ -5,31 +5,103 @@ Once the library is set up for your project, you'll be able to use it to start a
 To do this, you can follow the steps below.
 For more information on authenticating a Shopify app please see the [Types of Authentication](https://shopify.dev/docs/apps/auth#types-of-authentication) page.
 
+#### Table of contents
+- [Session Persistence](#session-persistence)
+- [Supported types of OAuth Flow](#supported-types-of-oauth)
+- [Note about Rails](#note-about-rails)
+- [Performing OAuth](#performing-oauth-1)
+  - [Token Exchange](#token-exchange)
+  - [Authorization Code Grant Flow](#authorization-code-grant-flow)
+- [Using OAuth Session to make authenticated API calls](#using-oauth-session-to-make-authenticated-api-calls)
+
 ## Session Persistence
 Session persistence is deprecated from the `ShopifyAPI` library gem since [version 12.3.0](https://github.com/Shopify/shopify-api-ruby/blob/main/CHANGELOG.md#version-1230). The responsibility of session storage typically is fulfilled by the web framework middleware.
 This API library's focus is on making requests and facilitate session creation.
 
 ⚠️ If you're not using the [ShopifyApp](https://github.com/Shopify/shopify_app) gem, you may use ShopifyAPI to perform OAuth to create sessions, but you must implement your own session storage method to persist the session information to be used in authenticated API calls.
 
+## Supported Types of OAuth
+> [!TIP]
+> If you are building an embedded app, we **strongly** recommend using [Shopify managed installation](https://shopify.dev/docs/apps/auth/installation#shopify-managed-installation)
+with [token exchange](#token-exchange) instead of the authorization code grant flow.
+
+1. [Token Exchange](#token-exchange)
+    - OAuth flow by exchanging the current user's [session token (shopify id token)](https://shopify.dev/docs/apps/auth/session-tokens) for an
+[access token](https://shopify.dev/docs/apps/auth/access-token-types/online.md).
+    - Recommended and is only available for embedded apps
+    - Doesn't require redirects, which makes authorization faster and prevents flickering when loading the app
+    - Access scope changes are handled by [Shopify managed installation](https://shopify.dev/docs/apps/auth/installation#shopify-managed-installation)
+2. [Authorization Code Grant Flow](#authorization-code-grant-flow)
+    - OAuth flow that requires the app to redirect the user to Shopify for installation/authorization of the app to access the shop's data.
+    - Suitable for non-embedded apps
+    - Installations, and access scope changes are managed by the app
+
 ## Note about Rails
 If using in the Rails framework, we highly recommend you use the [shopify_app](https://github.com/Shopify/shopify_app) gem to perform OAuth, you won't have to follow the instructions below to start your own OAuth flow.
   - See `ShopifyApp`'s [documentation on session storage](https://github.com/Shopify/shopify_app/blob/main/docs/shopify_app/sessions.md#sessions)
 
 If you aren't using Rails, you can look at how the `ShopifyApp` gem handles OAuth flow for further examples:
-- [Session Controller](https://github.com/Shopify/shopify_app/blob/main/app/controllers/shopify_app/sessions_controller.rb)
-  - Triggering and redirecting user to **begin** OAuth flow
-- [Callback Controller](https://github.com/Shopify/shopify_app/blob/main/app/controllers/shopify_app/callback_controller.rb)
-  - Creating / storing sessions to **complete** the OAuth flow
+- Token Exchange Flow
+  - [Token Exchange](https://github.com/Shopify/shopify_app/blob/main/lib/shopify_app/auth/token_exchange.rb)
+    - Completes token exchange flow to get online and offline access tokens
+- Authorization Code Grant Flow
+    - [Session Controller](https://github.com/Shopify/shopify_app/blob/main/app/controllers/shopify_app/sessions_controller.rb)
+      - Triggering and redirecting user to **begin** OAuth flow
+    - [Callback Controller](https://github.com/Shopify/shopify_app/blob/main/app/controllers/shopify_app/callback_controller.rb)
+      - Creating / storing sessions to **complete** the OAuth flow
 
 ## Performing OAuth
+### Token Exchange
 #### Steps
+1. Enable [Shopify managed installation](https://shopify.dev/docs/apps/auth/installation#shopify-managed-installation)
+    by configuring your scopes [through the Shopify CLI](https://shopify.dev/docs/apps/tools/cli/configuration).
+2. [Perform token exchange](#perform-token-exchange) to get an access token.
+
+#### Perform Token Exchange
+Use [`ShopifyAPI::Auth::TokenExchange`](https://github.com/Shopify/shopify-api-ruby/blob/main/lib/shopify_api/auth/token_exchange.rb) to
+exchange a [session token](https://shopify.dev/docs/apps/auth/session-tokens) (Shopify Id Token) for an [access token](https://shopify.dev/docs/apps/auth/access-token-types/online.md).
+
+#### Input
+| Parameter      | Type                   | Required? | Default Value | Notes                                                                                                       |
+| -------------- | ---------------------- | :-------: | :-----------: | ----------------------------------------------------------------------------------------------------------- |
+| `shop`         | `String` | Yes | - | A Shopify domain name in the form `{exampleshop}.myshopify.com`. |
+| `session_token` | `String` | Yes| - | The session token (Shopify Id Token) provided by App Bridge in either the request 'Authorization' header or URL param when the app is loaded in Admin. |
+| `requested_token_type` | `TokenExchange::RequestedTokenType` | Yes | - | The type of token requested. Online: `TokenExchange::RequestedTokenType::ONLINE_ACCESS_TOKEN` or offline: `TokenExchange::RequestedTokenType::OFFLINE_ACCESS_TOKEN`. |
+
+#### Output
+This method returns the new `ShopifyAPI::Auth::Session` object from the token exchange, 
+your app should store this `Session` object to be used later [when making authenticated API calls](#using-oauth-session-to-make-authenticated-api-calls).
+
+#### Example
+```ruby
+
+# `shop` is the shop domain name - "this-is-my-example-shop.myshopify.com"
+# `session_token` is the session token provided by App Bridge either in:
+#   - the request 'Authorization' header as `Bearer this-is-the-session_token`
+#   - or as a URL param `id_token=this-is-the-session_token`
+
+def authenticate(shop, session_token)
+  session = ShopifyAPI::Auth::TokenExchange.exchange_token(
+     shop: shop,
+     session_token: session_token,
+     requested_token_type: ShopifyAPI::Auth::TokenExchange::RequestedTokenType::OFFLINE_ACCESS_TOKEN,
+     # or if you're requesting an online access token:
+     # requested_token_type: ShopifyAPI::Auth::TokenExchange::RequestedTokenType::ONLINE_ACCESS_TOKEN,
+   )
+
+  SessionRepository.store_session(session)
+end
+
+```
+
+### Authorization Code Grant Flow
+##### Steps
 1. [Add a route to start OAuth](#1-add-a-route-to-start-oauth)
 2. [Add an Oauth callback route](#2-add-an-oauth-callback-route)
 3. [Begin OAuth](#3-begin-oauth)
 4. [Handle OAuth Callback](#4-handle-oauth-callback)
-5. [Using OAuth Session to make authenticated API calls](#5-using-oauth-session-to-make-authenticated-api-calls)
 
-### 1. Add a route to start OAuth
+#### 1. Add a route to start OAuth
 Add a route to your app to start the OAuth process.
 
 ```ruby
@@ -40,7 +112,7 @@ class ShopifyAuthController < ApplicationController
 end
 ```
 
-### 2. Add an OAuth callback route
+#### 2. Add an OAuth callback route
 After the app is authenticated with Shopify, the Shopify platform will send a request back to your app using this route
 (which you will provide as the `redirect_path` parameter to `begin_auth` method, in [step 3 - Begin OAuth](#3-begin-oauth)).
 ```ruby
@@ -50,7 +122,7 @@ class ShopifyCallbackController < ApplicationController
   end
 ```
 
-### 3. Begin OAuth
+#### 3. Begin OAuth
 Use [`ShopifyAPI::Auth::Oauth.begin_auth`](https://github.com/Shopify/shopify-api-ruby/blob/main/lib/shopify_api/auth/oauth.rb#L22) method to start OAuth process for your app.
 
 #### Input
@@ -74,7 +146,7 @@ Use [`ShopifyAPI::Auth::Oauth.begin_auth`](https://github.com/Shopify/shopify-ap
 |`auth_route`|`String`|URI that will be used for redirecting the user to the Shopify Authentication screen|
 |`cookie`|`ShopifyAPI::Auth::Oauth::SessionCookie`|A session cookie to store on the user's browser. |
 
-#### Example
+##### Example
 Your app should take the returned values from the `begin_auth` method and:
 
 1. Set the cookie in the user's browser. We strongly recommend that you use secure, httpOnly cookies for this to help prevent session hijacking.
@@ -109,19 +181,19 @@ end
 
 ⚠️ You can see a concrete example in the `ShopifyApp` gem's [SessionController](https://github.com/Shopify/shopify_app/blob/main/app/controllers/shopify_app/sessions_controller.rb).
 
-### 4. Handle OAuth Callback
+#### 4. Handle OAuth Callback
 When the user grants permission to the app in Shopify admin, they'll be redirected back to the app's callback route
 (configured in [Step 2 - Add an OAuth callback route](#2-add-an-oauth-callback-route)).
 
 Use [`ShopifyAPI::AuthL::Oauth.validate_auth_callback`](https://github.com/Shopify/shopify-api-ruby/blob/main/lib/shopify_api/auth/oauth.rb#L60) method to finalize the OAuth process.
 
-#### Input
+##### Input
 | Parameter    | Type    | Notes                                                                                                       |
 | ------------ | --------| ----------------------------------------------------------------------------------------------------------- |
 | `cookies`    | `Hash`  | All browser cookies in a hash format with key and value as `String` |
 | `auth_query` | `ShopifyAPI::Auth::Oauth::AuthQuery`| An `AuthQuery` containing the authorization request information used to validate the request.|
 
-#### Output
+##### Output
 This method returns a hash containing the new session and a cookie to be set in the browser in form of:
 ```ruby
 {
@@ -134,12 +206,12 @@ This method returns a hash containing the new session and a cookie to be set in
 |`session`|`ShopifyAPI::Auth::Session`|A session object that contains necessary information to identify the session like `shop`, `access_token`, `scope`, etc.|
 |`cookie` |`ShopifyAPI::Auth::Oauth::SessionCookie`|A session cookie to store on the user's browser. |
 
-#### Example
+##### Example
 Your app should call `validate_auth_callback` to construct the `Session` object and cookie that will be used later for authenticated API requests.
 
 1. Call `validate_auth_callback` to construct `Session` and `SessionCookie`.
 2. Update browser cookies with the new value for the session.
-3. Store the `Session` object to be used later when making authenticated API calls.
+3. Store the `Session` object to be used later when [making authenticated API calls](#using-oauth-session-to-make-authenticated-api-calls).
    - See [Make a GraphQL API call](https://github.com/Shopify/shopify-api-ruby/blob/main/docs/usage/graphql.md), or
    [Make a REST API call](https://github.com/Shopify/shopify-api-ruby/blob/main/docs/usage/rest.md) for examples on how to use the result `Session` object.
 
@@ -182,8 +254,8 @@ end
 
 ⚠️ You can see a concrete example in the `ShopifyApp` gem's [CallbackController](https://github.com/Shopify/shopify_app/blob/main/app/controllers/shopify_app/callback_controller.rb).
 
-### 5. Using OAuth Session to make authenticated API calls
-Once your OAuth flow is complete, and you have stored your `Session` object from [Step 4 - Handle OAuth Callback](#4-handle-oauth-callback), you may use that `Session` object to make authenticated API calls.
+## Using OAuth Session to make authenticated API calls
+Once your OAuth flow is complete, and you have persisted your `Session` object, you may use that `Session` object to make authenticated API calls.
 
 Example:
 ```ruby

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/admin_versions.rb

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

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

@@ -28,21 +28,32 @@ module ShopifyAPI
             variables: T.nilable(T::Hash[T.any(Symbol, String), T.untyped]),
             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)
+        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,
               body_type: "application/json",
               tries: tries,
             ),
-            response_as_struct: Context.response_as_struct || false,
+            response_as_struct: response_as_struct || false,
           )
         end
       end

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

@@ -45,11 +45,21 @@ module ShopifyAPI
             variables: T.nilable(T::Hash[T.any(Symbol, String), T.untyped]),
             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)
+        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)
+          super(query: query, variables: variables, headers: headers, tries: tries,
+                    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

@@ -66,7 +66,7 @@ module ShopifyAPI
       @setup_required = T.let(nil, T.nilable(T::Boolean))
       @shop_owner = T.let(nil, T.nilable(String))
       @source = T.let(nil, T.nilable(String))
-      @tax_shipping = T.let(nil, T.nilable(String))
+      @tax_shipping = T.let(nil, T.nilable(T::Boolean))
       @taxes_included = T.let(nil, T.nilable(T::Boolean))
       @timezone = T.let(nil, T.nilable(String))
       @transactional_sms_disabled = T.let(nil, T.nilable(T::Boolean))
@@ -179,7 +179,7 @@ module ShopifyAPI
     attr_reader :shop_owner
     sig { returns(T.nilable(String)) }
     attr_reader :source
-    sig { returns(T.nilable(String)) }
+    sig { returns(T.nilable(T::Boolean)) }
     attr_reader :tax_shipping
     sig { returns(T.nilable(T::Boolean)) }
     attr_reader :taxes_included
@@ -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

@@ -66,7 +66,7 @@ module ShopifyAPI
       @setup_required = T.let(nil, T.nilable(T::Boolean))
       @shop_owner = T.let(nil, T.nilable(String))
       @source = T.let(nil, T.nilable(String))
-      @tax_shipping = T.let(nil, T.nilable(String))
+      @tax_shipping = T.let(nil, T.nilable(T::Boolean))
       @taxes_included = T.let(nil, T.nilable(T::Boolean))
       @timezone = T.let(nil, T.nilable(String))
       @transactional_sms_disabled = T.let(nil, T.nilable(T::Boolean))
@@ -179,7 +179,7 @@ module ShopifyAPI
     attr_reader :shop_owner
     sig { returns(T.nilable(String)) }
     attr_reader :source
-    sig { returns(T.nilable(String)) }
+    sig { returns(T.nilable(T::Boolean)) }
     attr_reader :tax_shipping
     sig { returns(T.nilable(T::Boolean)) }
     attr_reader :taxes_included
@@ -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