shopify_api 14.11.1 → 16.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a74f8e8dd48cdc2900573e00f7dc6bb4ba302608075c7b06c285ee5dab6ca8ed
-  data.tar.gz: e7cf3797171b79502f913bb289b518f349841de3adc1f576753f403732f7ea1f
+  metadata.gz: fcfda3eae9679802b0a7d174700dfbd87d43f31f2a06a94369f5466c52da9c25
+  data.tar.gz: cd43a51872ca579701c3592603c9a41b9662191a62420fdbe87e26cd71020e3f
 SHA512:
-  metadata.gz: 45a9b83fddf9151bc99ba13e3353a8ac42cbf6559442cc6133f2c587670f1bbb1638ab5e40d8a799d412fb6d6943acc0ca60e99838480f45292f2951cb2de67f
-  data.tar.gz: 7ce124fc5e459a17c2230efc2577ace84922db124a7d79f3cf59693664507b319077558bd7a20146d2f0848c6eeb689eba535c3614e8443b546d3fa8583f75cf
+  metadata.gz: 33c6187ea237123c293e5597e184f633ddcfedb7433f7d3ad14141fb4b401cd618264f2fe3143982141b03ba7ee00aad7ec08b26a0b489b6c00b836edc61a8ec
+  data.tar.gz: 251fea50aaa98a67b55797934744bd9a57599084740530535dd6c98d9a8f1f2f886617d3dd66a99c7f877c508ac2afbcf3cf18a52758dfb9b2262c0314d06c8e

data/.github/workflows/api_update_reminder.yml

@@ -8,8 +8,8 @@ jobs:
   reminder:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
-      - uses: JasonEtco/create-an-issue@e6b4b190af80961b6462c725454e7828d0247a68 # v2.4.0
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: JasonEtco/create-an-issue@1b14a70e4d8dc185e5cc76d3bec9eab20257b2c5 # v2.9.2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

data/.github/workflows/api_update_reminder_on_release.yml

@@ -8,8 +8,8 @@ jobs:
   reminder:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
-      - uses: JasonEtco/create-an-issue@e6b4b190af80961b6462c725454e7828d0247a68 # v2.4.0
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: JasonEtco/create-an-issue@1b14a70e4d8dc185e5cc76d3bec9eab20257b2c5 # v2.9.2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

data/.github/workflows/build.yml

@@ -11,14 +11,13 @@ jobs:
     strategy:
       matrix:
         version:
-          - 3.0
-          - 3.1
           - 3.2
           - 3.3
+          - 3.4
     steps:
-      - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - name: Set up Ruby ${{ matrix.version }}
-        uses: ruby/setup-ruby@e34163cd15f4bb403dcd72d98e295997e6a55798 # v1.238.0
+        uses: ruby/setup-ruby@829114fc20da43a41d27359103ec7a63020954d4 # v1.255.0
         with:
           ruby-version: ${{ matrix.version }}
       - name: Install OpenSSL

data/.github/workflows/close-waiting-for-response-issues.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: close-issues
-        uses: actions-cool/issues-helper@a610082f8ac0cf03e357eb8dd0d5e2ba075e017e # v3.6.0
+        uses: actions-cool/issues-helper@45d75b6cf72bf4f254be6230cb887ad002702491 # v3.6.3
         with:
           actions: 'close-issues'
           token: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/remove-labels-on-activity.yml

@@ -7,7 +7,7 @@ jobs:
   remove-labels-on-activity:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - uses: actions-ecosystem/action-remove-labels@2ce5d41b4b6aa8503e285553f75ed56e0a40bae0 # v1.2.0
         if: contains(github.event.issue.labels.*.name, 'Waiting for Response')
         with:

data/BREAKING_CHANGES_FOR_V15.md

@@ -1,5 +1,99 @@
 # Breaking change notice for version 15.0.0
 
+## Removal of positional `storefront_access_token` parameter from Storefront GraphQL Client
+
+The `ShopifyAPI::Clients::Graphql::Storefront` class no longer accepts the public Storefront access token as a positional parameter. You must now use the named parameters `private_token:` or `public_token:` instead.
+
+This parameter was deprecated in [PR #1302](https://github.com/Shopify/shopify-api-ruby/pull/1302) (v14.1.0).
+
+### Previous implementation (deprecated in v14.1.0)
+
+```ruby
+# Old way: passing token as positional parameter
+client = ShopifyAPI::Clients::Graphql::Storefront.new(shop_url, storefront_access_token)
+
+# With API version
+client = ShopifyAPI::Clients::Graphql::Storefront.new(shop_url, storefront_access_token, api_version: "2024-01")
+```
+
+### New implementation (required in v15.0.0)
+
+```ruby
+# Use private token (recommended)
+client = ShopifyAPI::Clients::Graphql::Storefront.new(shop_url, private_token: storefront_private_access_token)
+
+# Or use public token
+client = ShopifyAPI::Clients::Graphql::Storefront.new(shop_url, public_token: storefront_public_access_token)
+
+# With API version
+client = ShopifyAPI::Clients::Graphql::Storefront.new(
+  shop_url,
+  private_token: storefront_private_access_token,
+  api_version: "2024-01"
+)
+```
+
+For more information on private vs public Storefront access tokens, see [Shopify's authentication documentation](https://shopify.dev/docs/api/usage/authentication#getting-started-with-private-access).
+## Removal of `LATEST_SUPPORTED_ADMIN_VERSION` and `RELEASE_CANDIDATE_ADMIN_VERSION` constants
+
+The `LATEST_SUPPORTED_ADMIN_VERSION` and `RELEASE_CANDIDATE_ADMIN_VERSION` constants have been removed to prevent semantic versioning (semver) breaking changes. Previously, these constants would automatically update every quarter when new API versions were released, causing unintended breaking changes for apps.
+
+### Migration Guide
+
+**If you were using these constants directly:**
+
+```ruby
+# Before (v14 and earlier)
+api_version = ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION
+# or
+api_version = ShopifyAPI::RELEASE_CANDIDATE_ADMIN_VERSION
+
+# After (v15+)
+api_version = "2025-07" # Explicitly specify the version you want to use
+```
+
+**In your Context.setup:**
+
+The `api_version` parameter has always been required in `Context.setup`, so most apps should not be affected. However, you must now explicitly specify which API version you want to use:
+
+```ruby
+# Before (v14 and earlier)
+ShopifyAPI::Context.setup(
+  api_key: "<api-key>",
+  api_secret_key: "<api-secret-key>",
+  host: "<https://application-host-name.com>",
+  scope: "read_orders,read_products,etc",
+  is_embedded: true,
+  api_version: ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION, # This constant no longer exists
+  is_private: false,
+)
+
+# After (v15+)
+ShopifyAPI::Context.setup(
+  api_key: "<api-key>",
+  api_secret_key: "<api-secret-key>",
+  host: "<https://application-host-name.com>",
+  scope: "read_orders,read_products,etc",
+  is_embedded: true,
+  api_version: "2025-07", # Explicitly specify the version
+  is_private: false,
+)
+```
+
+**Finding the right API version:**
+
+You can see all supported API versions by referencing:
+```ruby
+ShopifyAPI::SUPPORTED_ADMIN_VERSIONS
+# => ["unstable", "2025-10", "2025-07", "2025-04", ...]
+```
+
+**Why this change?**
+ By requiring explicit version specification, apps can:
+- Control when they upgrade to new API versions
+- Test thoroughly before upgrading
+- Avoid unexpected breaking changes from automatic version updates
+
 ## 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.
@@ -8,7 +102,8 @@ Make a module or class that includes or extends `ShopifyAPI::Webhooks::WebhookHa
 
 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
+`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
@@ -21,8 +116,8 @@ 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}"
     end
   end
 end

data/BREAKING_CHANGES_FOR_V16.md

@@ -0,0 +1,76 @@
+# Breaking change notice for version 16.0.0
+
+## Minimum Ruby Version Requirement
+
+The minimum required Ruby version has been updated from 3.0 to 3.2.
+
+### Why this change?
+
+Ruby 3.0  and 3.1 have reached End of Life (EOL).
+
+### Migration Guide
+
+If you're currently using Ruby 3.0 or 3.1, you'll need to upgrade to Ruby 3.2 or higher before upgrading to shopify-api-ruby v16.0.0.
+
+**Note:** Ruby 3.2+ includes performance improvements and new features. Most applications should not require code changes beyond updating the Ruby version itself.
+## Removal of `Session#serialize` and `Session.deserialize` methods
+
+The `Session#serialize` and `Session.deserialize` methods have been removed due to a security vulnerability. The `deserialize` method used `Oj.load` without safe mode, which allows instantiation of arbitrary Ruby objects.
+
+These methods were originally created for session persistence when the library handled session storage. After session storage was deprecated in v12.3.0, applications became responsible for their own session persistence, making these methods unnecessary for their original purpose.
+
+### Why this change?
+
+**No impact on most applications:** The `shopify_app gem` stores individual session attributes in database columns and reconstructs sessions using `Session.new()`, which is the recommended pattern.
+
+## Migration Guide
+
+If your application was using `Session#serialize` and `Session.deserialize` for session persistence, you'll need to refactor to store individual session attributes and reconstruct sessions using `Session.new()`.
+
+### Previous implementation (removed in v16.0.0)
+
+```ruby
+# Storing a session
+session = ShopifyAPI::Auth::Session.new(
+  shop: "example.myshopify.com",
+  access_token: "shpat_xxxxx",
+  scope: "read_products,write_orders"
+)
+
+serialized_data = session.serialize
+# Store serialized_data in Redis, database, etc.
+redis.set("session:#{session.id}", serialized_data)
+
+# Retrieving a session
+serialized_data = redis.get("session:#{session_id}")
+session = ShopifyAPI::Auth::Session.deserialize(serialized_data)
+```
+
+### New implementation (required in v16.0.0)
+
+Store individual session attributes and reconstruct using `Session.new()`:
+
+## Reference: shopify_app gem implementation
+
+The [shopify_app gem](https://github.com/Shopify/shopify_app) provides a reference implementation of session storage that follows these best practices:
+
+**Shop Session Storage** ([source](https://github.com/Shopify/shopify_app/blob/main/lib/shopify_app/session/shop_session_storage.rb)):
+```ruby
+# Stores attributes in database columns
+def store(auth_session)
+  shop = find_or_initialize_by(shopify_domain: auth_session.shop)
+  shop.shopify_token = auth_session.access_token
+  shop.save!
+end
+
+# Reconstructs using Session.new()
+def retrieve(id)
+  shop = find_by(id: id)
+  return unless shop
+
+  ShopifyAPI::Auth::Session.new(
+    shop: shop.shopify_domain,
+    access_token: shop.shopify_token
+  )
+end
+```

data/CHANGELOG.md

@@ -1,7 +1,21 @@
 # Changelog
 
 Note: For changes to the API, see https://shopify.dev/changelog?filter=api
-## Unreleased
+## 16.0.0 (2025-12-10)
+- ⚠️ [Breaking] Minimum required Ruby version is now 3.2. Ruby 3.0 and 3.1 are no longer supported.
+- ⚠️ [Breaking] Removed `Session#serialize` and `Session.deserialize` methods due to security concerns (RCE vulnerability via `Oj.load`). These methods were not used internally by the library. If your application relies on session serialization, use `Session.new()` to reconstruct sessions from stored attributes instead.
+
+- Add support for expiring offline access tokens with refresh tokens. See [OAuth documentation](docs/usage/oauth.md#expiring-offline-access-tokens) for details.
+- Add `ShopifyAPI::Auth::TokenExchange.migrate_to_expiring_token` method to migrate existing non-expiring offline tokens to expiring tokens. See [migration documentation](docs/usage/oauth.md#migrating-non-expiring-tokens-to-expiring-tokens) for details.
+
+### 15.0.0
+
+- ⚠️ [Breaking] Removed deprecated `ShopifyAPI::Webhooks::Handler` interface. Apps must migrate to `ShopifyAPI::Webhooks::WebhookHandler` which provides `webhook_id` and `api_version` in addition to `topic`, `shop`, and `body`. See [BREAKING_CHANGES_FOR_V15.md](BREAKING_CHANGES_FOR_V15.md) for migration guide.
+- Add support for 2025-10 API version
+  - Updated `LATEST_SUPPORTED_ADMIN_VERSION` to `2025-10`
+- [#1411](https://github.com/Shopify/shopify-api-ruby/pull/1411) Remove `LATEST_SUPPORTED_ADMIN_VERSION` and `RELEASE_CANDIDATE_ADMIN_VERSION` constants to prevent semver violations. Developers must now explicitly specify API versions. See the [migration guide](BREAKING_CHANGES_FOR_V15.md#removal-of-latest_supported_admin_version-and-release_candidate_admin_version-constants) for details.
+
+- [#1405](https://github.com/Shopify/shopify-api-ruby/pull/1405) Fix webhook registration for topics containing dots (e.g., `customer.tags_added`, `customer.tags_removed`)
 
 ## 14.11.1
 

data/Gemfile.lock

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

data/RELEASING.md

@@ -1,19 +1,110 @@
 # Releasing ShopifyAPI
 
-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`
-1. Add a CHANGELOG entry for the new release
-1. Commit the changes with a commit message like "Packaging for release X.Y.Z"
-1. Tag the release with the version (Leave REV blank for HEAD or provide a SHA)
-   $ git tag vX.Y.Z REV
-1. Push out the changes
-   $ git push
-1. Push out the tags
-   $ git push --tags
-1. Publish the gem using Shipit
-1. Consider if the dependency in Shopify/shopify needs updated. It's used only by the tests so is a low risk change.
-   Also consider Shopify/shopify_app whose gemspec depends on this.
-   We don't need to do this for every release, but we should try to keep them relatively up to date.
+## Prerequisites
+
+Before starting a release, ensure you have:
+
+- Merged all code change PRs into main
+
+## Release Process
+
+### Step 1: Prepare the Release Branch
+
+1. **Ensure all feature changes are merged**
+
+   ```bash
+   git checkout main
+   git pull origin main
+   ```
+
+   Verify: Latest commits should match GitHub's main branch.
+
+2. **Review changes to determine version bump**
+   - Review merged PRs since last release: `git log v14.11.1..HEAD --oneline`
+   - Apply [semantic versioning](https://semver.org/):
+     - PATCH (X.Y.Z+1): Bug fixes only
+     - MINOR (X.Y+1.0): New features, backward compatible
+     - MAJOR (X+1.0.0): Breaking changes
+
+### Step 2: Create Release Pull Request
+
+1. **Create a new branch**
+
+   ```bash
+   git checkout -b vX.Y.Z
+   ```
+
+2. **Update version number**
+   Edit `lib/shopify_api/version.rb`:
+
+   ```ruby
+   module ShopifyAPI
+     VERSION = "X.Y.Z"  # Replace with your version
+   end
+   ```
+
+3. **Update dependencies**
+
+   ```bash
+   bundle update sorbet sorbet-runtime sorbet-static tapioca --conservative
+   bundle install
+   ```
+
+   Expected: Gemfile.lock updates with new dependency versions.
+
+4. **Update CHANGELOG**
+   - Add entry under "## Unreleased" with format:
+
+     ```markdown
+     ## X.Y.Z (YYYY-MM-DD)
+     
+     - [#PR_NUMBER](https://github.com/Shopify/shopify-api-ruby/pull/PR_NUMBER) Description of change
+     ```
+
+   - Move all unreleased items under the new version
+
+5. **Create and push PR**
+
+   ```bash
+   git add -A
+   git commit -m "preparing for release v X.Y.Z"
+   git push origin release-X.Y.Z
+   ```
+
+   - Title PR: "Release vX.Y.Z"
+   - Add release notes to PR description
+
+### Step 3: Tag and Publish
+
+1. **After PR is merged, update local main**
+
+   ```bash
+   git checkout main
+   git pull origin main
+   ```
+
+   Verify: `git log -1` shows your merge commit.
+
+2. **Create and push tag**
+
+   ```bash
+   git tag -f vX.Y.Z && git push origin vX.Y.Z
+   ```
+
+   Verify: Tag appears at [https://github.com/Shopify/shopify-api-ruby/tags](https://github.com/Shopify/shopify-api-ruby/tags)
+
+3. **Publish via Shipit**
+
+4. **Verify gem publication**
+
+   List the gem on [https://rubygems.org/gems/shopify_api](https://rubygems.org/gems/shopify_api/versions/)
+
+   Expected: Shows your new version (may take 5-10 minutes).
+
+### Step 4: Update Dependent Projects (Optional)
+
+For major/minor releases, update these repositories:
+  
+- **Shopify/shopify_app**: Update gemspec
+  - File: `shopify_app.gemspec`
+  - Priority: High for breaking changes, medium otherwise

data/REST_RESOURCES.md

@@ -0,0 +1,161 @@
+# Adding a New API Version to Shopify API Ruby
+
+## Overview
+This guide provides step-by-step instructions for adding a new API version to the Shopify API Ruby library. This example uses the addition of the 2025-07 API version as a reference, but the process applies to any new API version.
+
+## Prerequisites
+- Understanding of any breaking changes or removed resources in the new API version
+
+## Step 1: Update API Version Constants
+
+### Update admin_versions.rb
+Edit `lib/shopify_api/admin_versions.rb` to add your new version:
+
+```ruby
+module ShopifyAPI
+  module AdminVersions
+    SUPPORTED_ADMIN_VERSIONS = T.let([
+      "unstable",
+      "2025-10",  # Add new version here
+      "2025-07",
+      "2025-04",
+      # ... other versions
+    ], T::Array[String])
+
+    LATEST_SUPPORTED_ADMIN_VERSION = T.let("2025-07", String)  # Update if this is the latest stable
+    RELEASE_CANDIDATE_ADMIN_VERSION = T.let("2025-10", String)  # Update if this is RC
+  end
+end
+```
+
+**Version Management:**
+- Add new versions to the top of `SUPPORTED_ADMIN_VERSIONS`
+- Update `LATEST_SUPPORTED_ADMIN_VERSION` when the version is stable
+- Update `RELEASE_CANDIDATE_ADMIN_VERSION` for release candidates
+
+## Step 2: Create Directory Structure
+
+### Create Resource Directory
+```bash
+mkdir lib/shopify_api/rest/resources/{YYYY_MM}/
+```
+Example: `lib/shopify_api/rest/resources/2025_07/`
+
+### Create Test Directory
+```bash
+mkdir test/rest/{YYYY_MM}/
+```
+Example: `test/rest/2025_07/`
+
+**Directory Naming Convention:**
+- Format: `YYYY_MM` (e.g., `2025_04`, `2025_07`, `2025_10`)
+- Use underscore between year and month
+
+## Step 3: Copy Resource Files from Previous Version
+
+### Copy All Resource Files
+```bash
+# Copy resource files
+cp -r lib/shopify_api/rest/resources/{PREVIOUS_VERSION}/* lib/shopify_api/rest/resources/{NEW_VERSION}/
+
+# Copy test files
+cp -r test/rest/{PREVIOUS_VERSION}/* test/rest/{NEW_VERSION}/
+```
+
+Example:
+```bash
+cp -r lib/shopify_api/rest/resources/2025_04/* lib/shopify_api/rest/resources/2025_07/
+cp -r test/rest/2025_04/* test/rest/2025_07/
+```
+
+## Step 4: Update Test Files
+
+After copying test files, you must update version-specific information in each test file.
+
+### Update Test Class Names
+Change the class name to include the new version:
+
+```ruby
+# From
+class AbandonedCheckout202504Test < Test::Unit::TestCase
+
+# To
+class AbandonedCheckout202507Test < Test::Unit::TestCase
+```
+
+**Naming Pattern:** `{ResourceName}{YYYYMM}Test`
+- Remove underscores from the version (e.g., `202507` not `2025_07`)
+
+### Update Context API Version
+In the `setup` method, update the API version:
+
+```ruby
+def setup
+  super
+  test_session = ShopifyAPI::Auth::Session.new(id: "id", shop: "test-shop.myshopify.io", access_token: "this_is_a_test_token")
+  ShopifyAPI::Context.activate_session(test_session)
+  
+  # Update this line:
+  modify_context(api_version: "2025-07")  # Was "2025-04"
+end
+```
+
+### Update URLs in Stub Requests
+Update all API URLs in the test methods:
+
+```ruby
+# From
+stub_request(:get, "https://test-shop.myshopify.io/admin/api/2025-04/checkouts.json")
+
+# To
+stub_request(:get, "https://test-shop.myshopify.io/admin/api/2025-07/checkouts.json")
+```
+
+## Step 5: Handle Breaking Changes
+
+### Identify Removed Resources
+In this example, `CustomerAddress` was removed in 2025-07.
+
+### Remove Deprecated Resources
+If a resource is removed:
+```bash
+# Remove resource file
+rm lib/shopify_api/rest/resources/{NEW_VERSION}/{resource_name}.rb
+
+# Remove test file
+rm test/rest/{NEW_VERSION}/{resource_name}_test.rb
+```
+
+### Update Modified Resources
+If a resource has structural changes:
+1. Update the resource class attributes
+2. Modify the `@paths` array if endpoints changed
+3. Update method signatures if parameters changed
+4. Adjust test cases accordingly
+
+## Step 7: Run Tests
+
+### Execute Test Suite
+```bash
+# Run all tests
+bundle exec rake test
+
+# Run specific version tests
+bundle exec rake test TEST=test/rest/{NEW_VERSION}/*
+```
+
+## Checklist
+
+- [ ] Added new version to `SUPPORTED_ADMIN_VERSIONS` in `admin_versions.rb`
+- [ ] Updated `LATEST_SUPPORTED_ADMIN_VERSION` if applicable
+- [ ] Updated `RELEASE_CANDIDATE_ADMIN_VERSION` if applicable
+- [ ] Created `lib/shopify_api/rest/resources/{NEW_VERSION}/` directory
+- [ ] Created `test/rest/{NEW_VERSION}/` directory
+- [ ] Copied all resource files from previous version
+- [ ] Copied all test files from previous version
+- [ ] Updated test class names (e.g., `Article202507Test`)
+- [ ] Updated API version in test contexts (`modify_context(api_version: "2025-07")`)
+- [ ] Updated all API URLs in test stub requests
+- [ ] Removed deprecated resources and their tests
+- [ ] Updated any modified resources
+- [ ] Run test suite successfully

data/docs/getting_started.md

@@ -28,7 +28,8 @@ ShopifyAPI::Context.setup(
   scope: "read_orders,read_products,etc",
   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: "2021-01" # The version of the API you would like to use
+  api_version: "2021-01", # The version of the API you would like to use
+  expiring_offline_access_tokens: true # Set to true to enable expiring offline access tokens with refresh tokens
 )
 ```