shopify_api 12.3.0 → 12.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60567c4e9da3da8eb19c903b704297d4cb194a3f63d0644e3273357554e86321
-  data.tar.gz: 19ec21a447be21e2f88ca5e4d3bb2978c587857f63976264bcaf998f7dddce47
+  metadata.gz: 7fee0ac74bfc70897541951eb87b46e750e0ed650c11b77d3a1c582451c3f4c0
+  data.tar.gz: 2e935108619f59022b9101a838582311bb5824a268fe2c1034b629339613dce3
 SHA512:
-  metadata.gz: a09451f3182e19d125d662dad337b737377622079e23c03de6949999812bfdbee83fb319bc6ada35d202343a535536b7dc0622fe9d28a66a04465dca0074187a
-  data.tar.gz: 5c1ad7e58afebc440aa712f881c60823c070603b171d1eb80fcb2b3c703b2f0730c1a942d5e3a237cca1adef1d997d087bad716244baca716fd131e4ce8c935b
+  metadata.gz: f5830157e403f197fedd154dbd5b69653026fc8ec9cce3d4427764b8e1e189ff303e1104b82faf124e7093f92979003b33be5061db81d825e2219fd7a70e8bef
+  data.tar.gz: e8fac7416a292ade97b591fa86e91034ae04a50e1d0f870b1f5289dcf40df0b1ccada6210b4255aae8c4e1d57e263bd38a8d0b990da0fa3e3383ef83a1333c60

data/.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,40 @@
+---
+name: "🐛 Bug Report"
+about: Something isn't working
+labels: "Type: Bug 🐛"
+---
+
+# Issue summary
+
+<!--
+
+Write a short description of the issue here. Please provide any details or logs that
+can help us debug it.
+
+Increase the logs as described in the README by setting log_level to :debug, and paste the relevant portion here.
+
+Learn more: https://github.com/Shopify/shopify-api-ruby#setup-shopify-context
+
+-->
+
+- `shopify_api` version:
+- Ruby version:
+- Operating system:
+
+```
+// Paste any relevant logs here
+```
+
+## Expected behavior
+
+<!-- What do you think should happen? -->
+
+## Actual behavior
+
+<!-- What actually happens? -->
+
+## Steps to reproduce the problem
+
+1.
+1.
+1.

data/.github/ISSUE_TEMPLATE/ENHANCEMENT.md

@@ -0,0 +1,9 @@
+---
+name: '📈 Enhancement'
+about: Enhancement to our codebase that isn't a adding or changing a feature
+labels: 'Type: Enhancement 📈'
+---
+
+## Overview/summary
+
+<!-- Write a short description of the enhancement here ↓ -->

data/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,9 @@
+---
+name: "🙌 Feature Request"
+about: Suggest a new feature, or changes to an existing one
+labels: "Type: Feature Request :raised_hands:"
+---
+
+## Overview
+
+<!-- Write a short description of the request here ↓ -->

data/.github/api_update_reminder.md

@@ -0,0 +1,25 @@
+---
+title: A new release of the Shopify API is due soon
+labels: automated
+---
+
+This is an automated reminder for the maintainers that a new Stable release of the Shopify API is due soon, so the library needs to be updated.
+
+A new library release should be prepared to:
+* add the upcoming Stable release
+* remove the oldest Stable release which will no longer be supported.
+
+The PR should be created as a **draft** but not yet be merged.
+
+The release schedule can be found at https://shopify.dev/concepts/about-apis/versioning
+
+Review the changelog and consider if anything in the library needs to change:
+
+https://shopify.dev/changelog
+
+Test against the upcoming release by using the Release Candidate.
+
+Another reminder issue will be created on the date of the next release.
+When that happens, test again using the now Stable API version, and aim to release an update of the library within one week.
+
+Thank you!

data/.github/api_update_reminder_on_release.md

@@ -0,0 +1,19 @@
+---
+title: A new release of the Shopify API occurred
+labels: automated
+---
+
+This is an automated reminder for the maintainers that a new Stable release of the Shopify API is scheduled for today
+at 12pm Eastern Time, so a new release of the library is now due.
+
+A draft PR should already exist for this.
+
+Review the changelog again and consider if anything in the library needs to change:
+
+https://shopify.dev/changelog
+
+Test against the new release by using the Stable version just released.
+
+Aim to release an update of the library within one week.
+
+Thank you!

data/.github/workflows/api_update_reminder.yml

@@ -0,0 +1,16 @@
+on:
+  workflow_dispatch: ~
+  schedule:
+    - cron: "0 0 1 3,6,9,12 *" # At 00:00 on 1st of March, June, September, and December
+
+name: API update reminder
+jobs:
+  reminder:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: JasonEtco/create-an-issue@v2.4.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          filename: .github/api_update_reminder.md

data/.github/workflows/api_update_reminder_on_release.yml

@@ -0,0 +1,16 @@
+on:
+  workflow_dispatch: ~
+  schedule:
+    - cron: "0 0 1 1,4,7,10 *" # At 00:00 on 1st of January, April, July, and October
+
+name: API update reminder on release
+jobs:
+  reminder:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: JasonEtco/create-an-issue@v2.4.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          filename: .github/api_update_reminder_on_release.md

data/.github/workflows/build.yml

@@ -16,9 +16,6 @@ jobs:
           - 3.1
     steps:
       - uses: actions/checkout@v2
-      - name: Remove Gemfile.lock
-        run: |
-          rm -f ${GITHUB_WORKSPACE}/Gemfile.lock
       - name: Set up Ruby ${{ matrix.version }}
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/stale.yml

@@ -1,32 +1,43 @@
-name: Close inactive issues
+name: Close inactive issues / prs
 on:
   schedule:
     - cron: "30 1 * * *"
 
 jobs:
-  close-issues:
+  stale:
     runs-on: ubuntu-latest
     permissions:
       issues: write
       pull-requests: write
     steps:
-      - uses: actions/stale@v5
+      - uses: actions/stale@v7
         with:
           days-before-issue-stale: 60
           days-before-issue-close: 14
+          days-before-pr-stale: 60
+          days-before-pr-close: 14
           operations-per-run: 1000
           stale-issue-label: "Stale"
+          stale-pr-label: "Stale"
           stale-issue-message: >
-            This issue is stale because it has been open for 60 days with no activity. It will be closed if no further action occurs in 14 days. 
+            This issue is stale because it has been open for 60 days with no activity. It will be closed if no further action occurs in 14 days.
           close-issue-message: |
-            We are closing this issue because it has been inactive for a few months. 
-            This probably means that it is not reproducible or it has been fixed in a newer version. 
+            We are closing this issue because it has been inactive for a few months.
+            This probably means that it is not reproducible or it has been fixed in a newer version.
             If it’s an enhancement and hasn’t been taken on since it was submitted, then it seems other issues have taken priority.
 
             If you still encounter this issue with the latest stable version, please reopen using the issue template. You can also contribute directly by submitting a pull request– see the [CONTRIBUTING.md](https://github.com/Shopify/shopify-api-ruby/blob/main/CONTRIBUTING.md) file for guidelines
 
             Thank you!
-          days-before-pr-stale: -1
-          days-before-pr-close: -1
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-          exempt-issue-labels: "feature request"
+          stale-pr-message: >
+            This pull request is stale because it has been open for 60 days with no activity. It will be closed if no further action occurs in 14 days.
+          close-pr-message: |
+            We are closing this pull request because it has been inactive for a few months.
+            This probably means that it is not reproducible or it has been fixed in a newer version.
+            If it’s an enhancement and hasn’t been taken on since it was submitted, then it seems other issues have taken priority.
+
+            If you still encounter this pull request with the latest stable version, please reopen using the pull request template. You can also contribute directly by submitting a pull request– see the [CONTRIBUTING.md](https://github.com/Shopify/shopify-api-ruby/blob/main/CONTRIBUTING.md) file for guidelines
+
+            Thank you!
+          repo-token: ${{ github.token }}
+          close-issue-reason: "not_planned"

data/CHANGELOG.md

@@ -3,14 +3,28 @@
 Note: For changes to the API, see https://shopify.dev/changelog?filter=api
 
 ## Unreleased
+
+## 12.5.0
+
+- [#1113](https://github.com/Shopify/shopify-api-ruby/pull/1113) Handle JSON::ParserError when http response is HTML and raise ShopifyAPI::Errors::HttpResponseError
+- [#1098](https://github.com/Shopify/shopify-api-ruby/pull/1098) Gracefully handle HTTP 204 repsonse bodies
+- [#1104](https://github.com/Shopify/shopify-api-ruby/pull/1104) Allow api version overrides.
+- [#1137](https://github.com/Shopify/shopify-api-ruby/pull/1137) Support for 2023_04 API version. Fix reported typing bugs.
+
+## Version 12.4.0
+
+- [#1092](https://github.com/Shopify/shopify-api-ruby/pull/1092) Add support for 2023-01 API version.
+- [#1081](https://github.com/Shopify/shopify-api-ruby/pull/1081) Fixed an error when parsing the JSON response body for the AssignedFulfillmentOrder resource.
+
 ## Version 12.3.0
 
 - [#1040](https://github.com/Shopify/shopify-api-ruby/pull/1040) `ShopifyAPI::Clients::HttpResponse` as argument for `ShopifyAPI::Errors::HttpResponseError`
-- [#1055](https://github.com/Shopify/shopify-api-ruby/pull/1055) Makes session_storage optional. Configuring the API with session_storage is now deprecated.  Session persistence is handled by the [shopify_app gem](https://github.com/Shopify/shopify_app) if using Rails.
+- [#1055](https://github.com/Shopify/shopify-api-ruby/pull/1055) Makes session_storage optional. Configuring the API with session_storage is now deprecated. Session persistence is handled by the [shopify_app gem](https://github.com/Shopify/shopify_app) if using Rails.
 - [#1063](https://github.com/Shopify/shopify-api-ruby/pull/1063) Fix ActiveSupport inflector dependency
 - [#1069](https://github.com/Shopify/shopify-api-ruby/pull/1069) Adds a custom Logger to help write uniform logs across the api and the [shopify_app gem](https://github.com/Shopify/shopify_app)
 
 ## Version 12.2.1
+
 - [#1045](https://github.com/Shopify/shopify-api-ruby/pull/1045) Fixes bug with host/host_name requirement.
 
 ## Version 12.2.0
@@ -122,13 +136,13 @@ Note: For changes to the API, see https://shopify.dev/changelog?filter=api
 ## Version 9.0.3
 
 - We now raise a `ShopifyAPI::ValidationException` exception when clients try to use `Product` and `Variant` with deprecated inventory-related fields in API version `2019-10` or later. [#655](https://github.com/Shopify/shopify-api-ruby/pull/655) Deprecation and migration information can be found in the following documents:
-  - [Product Variant REST API Reference](https://shopify.dev/docs/admin-api/rest/reference/products/product-variant)
+  - [Product Variant REST API Reference](https://shopify.dev/docs/api/admin-rest/reference/resources/product-variant)
   - [Migrate your app to support multiple locations](https://shopify.dev/tutorials/migrate-your-app-to-support-multiple-locations)
   - [Manage product inventory with the Admin API](https://shopify.dev/tutorials/manage-product-inventory-with-admin-api)
 - Added support for the Discount Code API batch endpoints [#701](https://github.com/Shopify/shopify-api-ruby/pull/701)
-  - [Create](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-01)
-  - [Show](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-01)
-  - [List](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-01)
+  - [Create](https://shopify.dev/docs/api/admin-rest/reference/resources/discountcode#batch_create-2020-01)
+  - [Show](https://shopify.dev/docs/api/admin-rest/reference/resources/discountcode#batch_show-2020-01)
+  - [List](https://shopify.dev/docs/api/admin-rest/reference/resources/discountcode#batch_discount_codes_index-2020-01)
 - Fix issue in the README to explicitly say clients need to require the `shopify_api` gem [#700](https://github.com/Shopify/shopify-api-ruby/pull/700)
 
 ## Version 9.0.2

data/CONTRIBUTING.md

@@ -2,8 +2,8 @@
 Submitting Issues
 -----------------
 
-Please open an issue here if you encounter a specific bug with this API client library or if something is documented here https://shopify.dev/apps but is missing from this package.
+Please open an issue here if you encounter a specific bug with this API client library or if something is documented here https://shopify.dev/docs/apps but is missing from this package.
 
 General questions about the Shopify API and usage of this package (not necessarily a bug) should be posted on the [Shopify forums](https://community.shopify.com/c/partners-and-developers/ct-p/appdev).
 
-When in doubt, post on the forum first. You'll likely have your questions answered more quickly if you post there; more people monitor the forum than Github.
+When in doubt, post on the forum first. You'll likely have your questions answered more quickly if you post there; more people monitor the forum than Github.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (12.3.0)
+    shopify_api (12.5.0)
       activesupport
       concurrent-ruby
       hash_diff
@@ -16,7 +16,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -26,31 +26,29 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     fakefs (1.4.1)
     hash_diff (1.1.1)
     hashdiff (1.0.1)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.2)
-    jwt (2.5.0)
+    jwt (2.7.0)
     language_server-protocol (3.17.0.1)
     method_source (1.0.0)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
+    mini_mime (1.1.2)
     minitest (5.15.0)
     mocha (1.13.0)
     multi_xml (0.6.0)
     netrc (0.11.0)
-    oj (3.13.23)
-    openssl (3.0.1)
+    oj (3.14.3)
+    openssl (3.1.0)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -92,11 +90,12 @@ GEM
       sorbet-runtime
       syntax_tree (>= 3.4)
     ruby-progressbar (1.11.0)
-    securerandom (0.2.1)
+    securerandom (0.2.2)
     sorbet (0.5.10438)
       sorbet-static (= 0.5.10438)
     sorbet-runtime (0.5.10438)
     sorbet-static (0.5.10438-universal-darwin-21)
+    sorbet-static (0.5.10438-universal-darwin-22)
     sorbet-static (0.5.10438-x86_64-linux)
     sorbet-static-and-runtime (0.5.10438)
       sorbet (= 0.5.10438)
@@ -118,7 +117,7 @@ GEM
       thor (>= 1.2.0)
       yard-sorbet
     thor (1.2.1)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
     unparser (0.6.5)
@@ -138,6 +137,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  universal-darwin-22
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -4,14 +4,14 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
 ![Build Status](https://github.com/Shopify/shopify-api-ruby/workflows/CI/badge.svg?branch=main)
 
-This library provides support for Ruby [Shopify apps](https://apps.shopify.com/) to access the [Shopify Admin API](https://shopify.dev/api/admin), by making it easier to perform the following actions:
+This library provides support for Ruby [Shopify apps](https://apps.shopify.com/) to access the [Shopify Admin API](https://shopify.dev/docs/api/admin), by making it easier to perform the following actions:
 
-- Creating [online](https://shopify.dev/apps/auth/oauth/access-modes#online-access) or [offline](https://shopify.dev/apps/auth/oauth/access-modes#offline-access) access tokens for the Admin API via OAuth
-- Making requests to the [REST API](https://shopify.dev/api/admin-rest)
-- Making requests to the [GraphQL API](https://shopify.dev/api/admin-graphql)
+- Creating [online](https://shopify.dev/docs/apps/auth/oauth/access-modes#online-access) or [offline](https://shopify.dev/docs/apps/auth/oauth/access-modes#offline-access) access tokens for the Admin API via OAuth
+- Making requests to the [REST API](https://shopify.dev/docs/api/admin-rest)
+- Making requests to the [GraphQL API](https://shopify.dev/docs/api/admin-graphql)
 - Registering/processing webhooks
 
-In addition to the Admin API, this library also allows querying the [Storefront API](https://shopify.dev/docs/storefront-api).
+In addition to the Admin API, this library also allows querying the [Storefront API](https://shopify.dev/docs/api/storefront).
 
 You can use this library in any application that has a Ruby backend, since it doesn't rely on any specific framework — you can include it alongside your preferred stack and use the features that you need to build your app.
 
@@ -54,7 +54,7 @@ ShopifyAPI::Context.setup(
   scope: "read_orders,read_products,etc",
   session_storage: ShopifyAPI::Auth::FileSessionStorage.new, # See more details below
   is_embedded: true, # Set to true if you are building an embedded app
-  api_version: "2022-01" # The version of the API you would like to use
+  api_version: "2022-01", # The version of the API you would like to use
   is_private: false, # Set to true if you have an existing private app
 )
 ```
@@ -63,11 +63,11 @@ ShopifyAPI::Context.setup(
 
 In order for the Shopify API gem to properly store sessions it needs an implementation of `ShopifyAPI::Auth::SessionStorage`. We provide one implementation in the gem, `ShopifyAPI::Auth::FileSessionStorage`, which is suitable for testing/development, but isn't intended for production apps. See the [Session Storage doc](docs/usage/session_storage.md) for instructions on how to create a custom session store for a production application.
 
-Session information would is typically stored in cookies on the browser. However, due to restrictions with modern browsers we highly discourage using cookies for embedded apps. For this reason, an app needs to define a storage implementation that the library can use to store and retrieve a session given its ID. In a non-embedded app this ID will come from a cookie, whereas in an embedded app this ID will come from [App Bridge](https://shopify.dev/apps/tools/app-bridge).
+Session information would is typically stored in cookies on the browser. However, due to restrictions with modern browsers we highly discourage using cookies for embedded apps. For this reason, an app needs to define a storage implementation that the library can use to store and retrieve a session given its ID. In a non-embedded app this ID will come from a cookie, whereas in an embedded app this ID will come from [App Bridge](https://shopify.dev/docs/apps/tools/app-bridge).
 
 ### Performing OAuth
 
-You need to go through OAuth as described [here](https://shopify.dev/apps/auth/oauth) to create sessions for shops using your app.
+You need to go through OAuth as described [here](https://shopify.dev/docs/apps/auth/oauth) to create sessions for shops using your app.
 The Shopify API gem tries to make this easy by providing functions to begin and complete the OAuth process. See the [Oauth doc](docs/usage/oauth.md) for instructions on how to use these.
 
 ### Register Webhooks and a Webhook Handler
@@ -90,7 +90,7 @@ Here are the main features it provides:
 - Full, transparent support for JWT sessions for embedded apps and cookies for non-embedded ones.
   - Removal of support for 3rd party cookies which are increasingly more difficult to use with modern browsers.
 - Admin API support
-  - Auto-generated, version-specific REST resources which are similar to `ActiveResource` (though not identical), that provide methods for all endpoints defined in our [REST API reference](https://shopify.dev/api/admin-rest), as well as direct definition of known attributes.
+  - Auto-generated, version-specific REST resources which are similar to `ActiveResource` (though not identical), that provide methods for all endpoints defined in our [REST API reference](https://shopify.dev/docs/api/admin-rest), as well as direct definition of known attributes.
   - A GraphQL client that doesn't rely on the ActiveResource implementation for REST.
 - Webhook management, with features for adding handlers and registering them with Shopify.
 - Storefront GraphQL API support
@@ -102,7 +102,7 @@ With this, a lot changed in how apps access the library. Here are the updates yo
 - Call `ShopifyAPI::Context.setup` when setting up your app. This class holds global configurations for your app and defines how the library behaves.
 - If not using the `shopify_app` gem, your app needs to provide an implementation of `ShopifyAPI::Auth::SessionStorage` for production. Read more about this [in our documentation](docs/usage/session_storage.md).
 - To change the `User-Agent` header, use `user_agent_prefix` in `ShopifyAPI::Context.setup`.
-- Usages of the `ActiveResource` classes for REST API requests need to be refactored into the new format. You can find detailed examples on how each of the endpoints work in our [reference documentation](https://shopify.dev/api/admin-rest).
+- Usages of the `ActiveResource` classes for REST API requests need to be refactored into the new format. You can find detailed examples on how each of the endpoints work in our [reference documentation](https://shopify.dev/docs/api/admin-rest).
 
     Please see below a (non-exhaustive) list of common replacements to guide you in your updates, using the `Order` resource as an example.
 

data/docs/getting_started.md

@@ -37,11 +37,11 @@ ShopifyAPI::Context.setup(
 
 In order for the Shopify API gem to properly store sessions it needs an implementation of `ShopifyAPI::Auth::SessionStorage`. There is one provided in the gem, `ShopifyAPI::Auth::FileSessionStorage`, this is suitable for testing, however it is not intended for production apps. See the [Session Storage doc](usage/session_storage.md) for instructions on how to create a custom session store for a production application.
 
-Normally session information would be stored in cookies on the browser. However, due to restrictions with modern browsers we highly discourage using cookies for embedded apps. For this reason, an app needs to define a storage implementation that can be used to store and retrieve a session given an ID. In a non embedded app this ID will come from a cookie however, in an embedded app this ID will come from [App Bridge](https://shopify.dev/apps/tools/app-bridge)
+Normally session information would be stored in cookies on the browser. However, due to restrictions with modern browsers we highly discourage using cookies for embedded apps. For this reason, an app needs to define a storage implementation that can be used to store and retrieve a session given an ID. In a non embedded app this ID will come from a cookie however, in an embedded app this ID will come from [App Bridge](https://shopify.dev/docs/apps/tools/app-bridge)
 
 ### Performing OAuth
 
-Next, unless you are making a private app, you need to go through OAuth as described [here](https://shopify.dev/apps/auth/oauth) to create sessions for shops using your app.
+Next, unless you are making a private app, you need to go through OAuth as described [here](https://shopify.dev/docs/apps/auth/oauth) to create sessions for shops using your app.
 The Shopify API gem tries to make this easy by providing functions to begin and complete the OAuth process. See the [Oauth doc](usage/oauth.md) for instructions on how to use these.
 
 ### Register Webhooks and a Webhook Handler

data/docs/usage/graphql.md

@@ -88,6 +88,12 @@ response = client.query(query: query, variables: variables)
 # do something with the reponse
 ```
 
+By default, the client uses the API version configured in `ShopifyAPI`.  To use a different API version, set the optional `api_version` parameter.  To experiment with prerelease API features, use `"unstable"` for the API version.
+
+```ruby
+client = ShopifyAPI::Clients::Graphql::Admin.new(session: session, api_version: "unstable")
+```
+
 Want to make calls to the Storefront API? Click [here](graphql_storefront.md)
 
 # Proxy a GraphQL Query

data/docs/usage/graphql_storefront.md

@@ -1,8 +1,8 @@
 # Make a Storefront API call
 
-The library also allows you to send GraphQL requests to the [Shopify Storefront API](https://shopify.dev/docs/storefront-api). To do that, you can use `ShopifyAPI::Clients::Graphql::Storefront` with the current session and a `storefrontAccessToken`.
+The library also allows you to send GraphQL requests to the [Shopify Storefront API](https://shopify.dev/docs/api/storefront). To do that, you can use `ShopifyAPI::Clients::Graphql::Storefront` with the current session and a `storefrontAccessToken`.
 
-You can obtain Storefront API access tokens for both private apps and sales channels. Please read [our documentation](https://shopify.dev/docs/storefront-api/getting-started) to learn more about Storefront Access Tokens.
+You can obtain Storefront API access tokens for both private apps and sales channels. Please read [our documentation](https://shopify.dev/docs/custom-storefronts/building-with-the-storefront-api/getting-started) to learn more about Storefront Access Tokens.
 
 Below is an example of how you may query the Storefront API:
 
@@ -39,4 +39,10 @@ response = client.query(query: query)
 # do something with the returned data
 ```
 
+By default, the client uses the API version configured in `ShopifyAPI`.  To use a different API version, set the optional `api_version` parameter.  To experiment with prerelease API features, use `"unstable"` for the API version.
+
+```ruby
+client = ShopifyAPI::Clients::Graphql::Storefront.new(shop_url, storefront_access_token, api_version: "unstable")
+```
+
 Want to make calls to the Admin API? Click [here](graphql.md)

data/docs/usage/oauth.md

@@ -3,7 +3,7 @@
 Once the library is set up for your project, you'll be able to use it to start adding functionality to your app. The first thing your app will need to do is to obtain an access token to the Admin API by performing the OAuth process.
 
 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/apps/auth#types-of-authentication) page.
+For more information on authenticating a Shopify app please see the [Types of Authentication](https://shopify.dev/docs/apps/auth#types-of-authentication) page.
 
 ## Add a route to start OAuth
 

data/docs/usage/rest.md

@@ -60,11 +60,18 @@ client.post({
 });
 ```
 
-_for more information on the `products` endpoint, [check out our API reference guide](https://shopify.dev/api/admin-rest/unstable/resources/product)._
+_for more information on the `products` endpoint, [check out our API reference guide](https://shopify.dev/docs/api/admin-rest/unstable/resources/product)._
+
+### Override the `api_version`:
+
+```ruby
+# To experiment with prerelease features, pass the api_version "unstable".
+client = ShopifyAPI::Clients::Rest::Admin.new(session: session, api_version: "unstable")
+```
 
 ## Pagination
 
-This library also supports cursor-based pagination for REST Admin API requests. [Learn more about REST request pagination](https://shopify.dev/api/usage/pagination-rest).
+This library also supports cursor-based pagination for REST Admin API requests. [Learn more about REST request pagination](https://shopify.dev/docs/api/usage/pagination-rest).
 
 After making a request, the `next_page_info` and `prev_page_info` can be found on the response object and passed as the page_info query param in other requests.
 

data/docs/usage/webhooks.md

@@ -90,7 +90,7 @@ To process an http webhook, you need to listen on the route(s) you provided duri
 class WebhookController < ApplicationController
   def webhook
     ShopifyAPI::Webhooks::Registry.process(
-      ShopifyAPI::Webhooks::WebhookRequest.new(raw_body: request.raw_post, headers: request.headers.to_h)
+      ShopifyAPI::Webhooks::Request.new(raw_body: request.raw_post, headers: request.headers.to_h)
     )
     render json: {success: true}.to_json
   end

data/lib/shopify_api/admin_versions.rb

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

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

@@ -5,9 +5,9 @@ module ShopifyAPI
   module Clients
     module Graphql
       class Admin < Client
-        sig { params(session: T.nilable(Auth::Session)).void }
-        def initialize(session:)
-          super(session: session, base_path: "/admin/api")
+        sig { params(session: T.nilable(Auth::Session), api_version: T.nilable(String)).void }
+        def initialize(session:, api_version: nil)
+          super(session: session, base_path: "/admin/api", api_version: api_version)
         end
       end
     end

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

@@ -7,9 +7,19 @@ module ShopifyAPI
       class Client
         extend T::Sig
 
-        sig { params(session: T.nilable(Auth::Session), base_path: String).void }
-        def initialize(session:, base_path:)
+        sig { params(session: T.nilable(Auth::Session), base_path: String, api_version: T.nilable(String)).void }
+        def initialize(session:, base_path:, api_version: nil)
           @http_client = T.let(HttpClient.new(session: session, base_path: base_path), HttpClient)
+          @api_version = T.let(api_version || Context.api_version, String)
+          if api_version
+            if api_version == Context.api_version
+              Context.logger.debug("Graphql client has a redundant API version override "\
+                "to the default #{Context.api_version}")
+            else
+              Context.logger.debug("Graphql client overriding default API version "\
+                "#{Context.api_version} with #{api_version}")
+            end
+          end
         end
 
         sig do
@@ -25,7 +35,7 @@ module ShopifyAPI
           @http_client.request(
             HttpRequest.new(
               http_method: :post,
-              path: "#{Context.api_version}/graphql.json",
+              path: "#{@api_version}/graphql.json",
               body: body,
               query: nil,
               extra_headers: headers,

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

@@ -5,15 +5,15 @@ module ShopifyAPI
   module Clients
     module Graphql
       class Storefront < Client
-        sig { params(shop: String, storefront_access_token: String).void }
-        def initialize(shop, storefront_access_token)
+        sig { params(shop: String, storefront_access_token: String, api_version: T.nilable(String)).void }
+        def initialize(shop, storefront_access_token, api_version: nil)
           session = Auth::Session.new(
             id: shop,
             shop: shop,
             access_token: "",
             is_online: false,
           )
-          super(session: session, base_path: "/api")
+          super(session: session, base_path: "/api", api_version: api_version)
           @storefront_access_token = storefront_access_token
         end
 

data/lib/shopify_api/clients/http_client.rb

@@ -48,7 +48,14 @@ module ShopifyAPI
             body: request.body.class == Hash ? T.unsafe(request.body).to_json : request.body,
           ), HTTParty::Response)
 
-          body = res.body.empty? ? {} : JSON.parse(res.body)
+          begin
+            body = res.body.nil? || res.body.empty? ? {} : JSON.parse(res.body)
+          rescue JSON::ParserError
+            raise if res.code.to_i < 500
+
+            body = res.body
+          end
+
           response = HttpResponse.new(code: res.code.to_i, headers: res.headers.to_h, body: body)
 
           if response.headers["x-shopify-api-deprecated-reason"]