shopify_api 13.1.0 → 13.4.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 13.1.0
+  version: 13.4.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,20 +220,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-lsp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -286,9 +272,9 @@ files:
 - ".github/workflows/cla.yml"
 - ".github/workflows/close-waiting-for-response-issues.yml"
 - ".github/workflows/remove-labels-on-activity.yml"
-- ".github/workflows/stale.yml"
 - ".rubocop.yml"
 - BREAKING_CHANGES_FOR_OLDER_VERSIONS.md
+- BREAKING_CHANGES_FOR_V10.md
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -296,18 +282,18 @@ files:
 - LICENSE
 - README.md
 - RELEASING.md
+- ROADMAP.md
 - Rakefile
 - SECURITY.md
 - bin/tapioca
 - dev.yml
 - docs/README.md
 - docs/getting_started.md
-- docs/issues.md
+- docs/usage/custom_apps.md
 - docs/usage/graphql.md
 - docs/usage/graphql_storefront.md
 - docs/usage/oauth.md
 - docs/usage/rest.md
-- docs/usage/session_storage.md
 - docs/usage/webhooks.md
 - lib/shopify_api.rb
 - lib/shopify_api/admin_versions.rb
@@ -452,7 +438,6 @@ files:
 - lib/shopify_api/rest/resources/2022_07/custom_collection.rb
 - lib/shopify_api/rest/resources/2022_07/customer.rb
 - lib/shopify_api/rest/resources/2022_07/customer_address.rb
-- lib/shopify_api/rest/resources/2022_07/customer_saved_search.rb
 - lib/shopify_api/rest/resources/2022_07/deprecated_api_call.rb
 - lib/shopify_api/rest/resources/2022_07/discount_code.rb
 - lib/shopify_api/rest/resources/2022_07/dispute.rb
@@ -528,7 +513,6 @@ files:
 - lib/shopify_api/rest/resources/2022_10/custom_collection.rb
 - lib/shopify_api/rest/resources/2022_10/customer.rb
 - lib/shopify_api/rest/resources/2022_10/customer_address.rb
-- lib/shopify_api/rest/resources/2022_10/customer_saved_search.rb
 - lib/shopify_api/rest/resources/2022_10/deprecated_api_call.rb
 - lib/shopify_api/rest/resources/2022_10/discount_code.rb
 - lib/shopify_api/rest/resources/2022_10/dispute.rb
@@ -792,6 +776,7 @@ files:
 - lib/shopify_api/rest/resources/2023_07/recurring_application_charge.rb
 - lib/shopify_api/rest/resources/2023_07/redirect.rb
 - lib/shopify_api/rest/resources/2023_07/refund.rb
+- lib/shopify_api/rest/resources/2023_07/report.rb
 - lib/shopify_api/rest/resources/2023_07/resource_feedback.rb
 - lib/shopify_api/rest/resources/2023_07/script_tag.rb
 - lib/shopify_api/rest/resources/2023_07/shipping_zone.rb
@@ -805,6 +790,154 @@ files:
 - lib/shopify_api/rest/resources/2023_07/user.rb
 - lib/shopify_api/rest/resources/2023_07/variant.rb
 - lib/shopify_api/rest/resources/2023_07/webhook.rb
+- lib/shopify_api/rest/resources/2023_10/abandoned_checkout.rb
+- lib/shopify_api/rest/resources/2023_10/access_scope.rb
+- lib/shopify_api/rest/resources/2023_10/apple_pay_certificate.rb
+- lib/shopify_api/rest/resources/2023_10/application_charge.rb
+- lib/shopify_api/rest/resources/2023_10/application_credit.rb
+- lib/shopify_api/rest/resources/2023_10/article.rb
+- lib/shopify_api/rest/resources/2023_10/asset.rb
+- lib/shopify_api/rest/resources/2023_10/assigned_fulfillment_order.rb
+- lib/shopify_api/rest/resources/2023_10/balance.rb
+- lib/shopify_api/rest/resources/2023_10/blog.rb
+- lib/shopify_api/rest/resources/2023_10/cancellation_request.rb
+- lib/shopify_api/rest/resources/2023_10/carrier_service.rb
+- lib/shopify_api/rest/resources/2023_10/checkout.rb
+- lib/shopify_api/rest/resources/2023_10/collect.rb
+- lib/shopify_api/rest/resources/2023_10/collection.rb
+- lib/shopify_api/rest/resources/2023_10/collection_listing.rb
+- lib/shopify_api/rest/resources/2023_10/comment.rb
+- lib/shopify_api/rest/resources/2023_10/country.rb
+- lib/shopify_api/rest/resources/2023_10/currency.rb
+- lib/shopify_api/rest/resources/2023_10/custom_collection.rb
+- lib/shopify_api/rest/resources/2023_10/customer.rb
+- lib/shopify_api/rest/resources/2023_10/customer_address.rb
+- lib/shopify_api/rest/resources/2023_10/deprecated_api_call.rb
+- lib/shopify_api/rest/resources/2023_10/discount_code.rb
+- lib/shopify_api/rest/resources/2023_10/dispute.rb
+- lib/shopify_api/rest/resources/2023_10/dispute_evidence.rb
+- lib/shopify_api/rest/resources/2023_10/dispute_file_upload.rb
+- lib/shopify_api/rest/resources/2023_10/draft_order.rb
+- lib/shopify_api/rest/resources/2023_10/event.rb
+- lib/shopify_api/rest/resources/2023_10/fulfillment.rb
+- lib/shopify_api/rest/resources/2023_10/fulfillment_event.rb
+- lib/shopify_api/rest/resources/2023_10/fulfillment_order.rb
+- lib/shopify_api/rest/resources/2023_10/fulfillment_request.rb
+- lib/shopify_api/rest/resources/2023_10/fulfillment_service.rb
+- lib/shopify_api/rest/resources/2023_10/gift_card.rb
+- lib/shopify_api/rest/resources/2023_10/gift_card_adjustment.rb
+- lib/shopify_api/rest/resources/2023_10/image.rb
+- lib/shopify_api/rest/resources/2023_10/inventory_item.rb
+- lib/shopify_api/rest/resources/2023_10/inventory_level.rb
+- lib/shopify_api/rest/resources/2023_10/location.rb
+- lib/shopify_api/rest/resources/2023_10/locations_for_move.rb
+- lib/shopify_api/rest/resources/2023_10/marketing_event.rb
+- lib/shopify_api/rest/resources/2023_10/metafield.rb
+- lib/shopify_api/rest/resources/2023_10/mobile_platform_application.rb
+- lib/shopify_api/rest/resources/2023_10/order.rb
+- lib/shopify_api/rest/resources/2023_10/order_risk.rb
+- lib/shopify_api/rest/resources/2023_10/page.rb
+- lib/shopify_api/rest/resources/2023_10/payment.rb
+- lib/shopify_api/rest/resources/2023_10/payment_gateway.rb
+- lib/shopify_api/rest/resources/2023_10/payment_transaction.rb
+- lib/shopify_api/rest/resources/2023_10/payout.rb
+- lib/shopify_api/rest/resources/2023_10/policy.rb
+- lib/shopify_api/rest/resources/2023_10/price_rule.rb
+- lib/shopify_api/rest/resources/2023_10/product.rb
+- lib/shopify_api/rest/resources/2023_10/product_listing.rb
+- lib/shopify_api/rest/resources/2023_10/product_resource_feedback.rb
+- lib/shopify_api/rest/resources/2023_10/province.rb
+- lib/shopify_api/rest/resources/2023_10/recurring_application_charge.rb
+- lib/shopify_api/rest/resources/2023_10/redirect.rb
+- lib/shopify_api/rest/resources/2023_10/refund.rb
+- lib/shopify_api/rest/resources/2023_10/report.rb
+- lib/shopify_api/rest/resources/2023_10/resource_feedback.rb
+- lib/shopify_api/rest/resources/2023_10/script_tag.rb
+- lib/shopify_api/rest/resources/2023_10/shipping_zone.rb
+- lib/shopify_api/rest/resources/2023_10/shop.rb
+- lib/shopify_api/rest/resources/2023_10/smart_collection.rb
+- lib/shopify_api/rest/resources/2023_10/storefront_access_token.rb
+- lib/shopify_api/rest/resources/2023_10/tender_transaction.rb
+- lib/shopify_api/rest/resources/2023_10/theme.rb
+- lib/shopify_api/rest/resources/2023_10/transaction.rb
+- lib/shopify_api/rest/resources/2023_10/usage_charge.rb
+- lib/shopify_api/rest/resources/2023_10/user.rb
+- lib/shopify_api/rest/resources/2023_10/variant.rb
+- lib/shopify_api/rest/resources/2023_10/webhook.rb
+- lib/shopify_api/rest/resources/2024_01/abandoned_checkout.rb
+- lib/shopify_api/rest/resources/2024_01/access_scope.rb
+- lib/shopify_api/rest/resources/2024_01/apple_pay_certificate.rb
+- lib/shopify_api/rest/resources/2024_01/application_charge.rb
+- lib/shopify_api/rest/resources/2024_01/application_credit.rb
+- lib/shopify_api/rest/resources/2024_01/article.rb
+- lib/shopify_api/rest/resources/2024_01/asset.rb
+- lib/shopify_api/rest/resources/2024_01/assigned_fulfillment_order.rb
+- lib/shopify_api/rest/resources/2024_01/balance.rb
+- lib/shopify_api/rest/resources/2024_01/blog.rb
+- lib/shopify_api/rest/resources/2024_01/cancellation_request.rb
+- lib/shopify_api/rest/resources/2024_01/carrier_service.rb
+- lib/shopify_api/rest/resources/2024_01/checkout.rb
+- lib/shopify_api/rest/resources/2024_01/collect.rb
+- lib/shopify_api/rest/resources/2024_01/collection.rb
+- lib/shopify_api/rest/resources/2024_01/collection_listing.rb
+- lib/shopify_api/rest/resources/2024_01/comment.rb
+- lib/shopify_api/rest/resources/2024_01/country.rb
+- lib/shopify_api/rest/resources/2024_01/currency.rb
+- lib/shopify_api/rest/resources/2024_01/custom_collection.rb
+- lib/shopify_api/rest/resources/2024_01/customer.rb
+- lib/shopify_api/rest/resources/2024_01/customer_address.rb
+- lib/shopify_api/rest/resources/2024_01/deprecated_api_call.rb
+- lib/shopify_api/rest/resources/2024_01/discount_code.rb
+- lib/shopify_api/rest/resources/2024_01/dispute.rb
+- lib/shopify_api/rest/resources/2024_01/dispute_evidence.rb
+- lib/shopify_api/rest/resources/2024_01/dispute_file_upload.rb
+- lib/shopify_api/rest/resources/2024_01/draft_order.rb
+- lib/shopify_api/rest/resources/2024_01/event.rb
+- lib/shopify_api/rest/resources/2024_01/fulfillment.rb
+- lib/shopify_api/rest/resources/2024_01/fulfillment_event.rb
+- lib/shopify_api/rest/resources/2024_01/fulfillment_order.rb
+- lib/shopify_api/rest/resources/2024_01/fulfillment_request.rb
+- lib/shopify_api/rest/resources/2024_01/fulfillment_service.rb
+- lib/shopify_api/rest/resources/2024_01/gift_card.rb
+- lib/shopify_api/rest/resources/2024_01/gift_card_adjustment.rb
+- lib/shopify_api/rest/resources/2024_01/image.rb
+- lib/shopify_api/rest/resources/2024_01/inventory_item.rb
+- lib/shopify_api/rest/resources/2024_01/inventory_level.rb
+- lib/shopify_api/rest/resources/2024_01/location.rb
+- lib/shopify_api/rest/resources/2024_01/locations_for_move.rb
+- lib/shopify_api/rest/resources/2024_01/marketing_event.rb
+- lib/shopify_api/rest/resources/2024_01/metafield.rb
+- lib/shopify_api/rest/resources/2024_01/mobile_platform_application.rb
+- lib/shopify_api/rest/resources/2024_01/order.rb
+- lib/shopify_api/rest/resources/2024_01/order_risk.rb
+- lib/shopify_api/rest/resources/2024_01/page.rb
+- lib/shopify_api/rest/resources/2024_01/payment.rb
+- lib/shopify_api/rest/resources/2024_01/payment_gateway.rb
+- lib/shopify_api/rest/resources/2024_01/payment_transaction.rb
+- lib/shopify_api/rest/resources/2024_01/payout.rb
+- lib/shopify_api/rest/resources/2024_01/policy.rb
+- lib/shopify_api/rest/resources/2024_01/price_rule.rb
+- lib/shopify_api/rest/resources/2024_01/product.rb
+- lib/shopify_api/rest/resources/2024_01/product_listing.rb
+- lib/shopify_api/rest/resources/2024_01/product_resource_feedback.rb
+- lib/shopify_api/rest/resources/2024_01/province.rb
+- lib/shopify_api/rest/resources/2024_01/recurring_application_charge.rb
+- lib/shopify_api/rest/resources/2024_01/redirect.rb
+- lib/shopify_api/rest/resources/2024_01/refund.rb
+- lib/shopify_api/rest/resources/2024_01/report.rb
+- lib/shopify_api/rest/resources/2024_01/resource_feedback.rb
+- lib/shopify_api/rest/resources/2024_01/script_tag.rb
+- lib/shopify_api/rest/resources/2024_01/shipping_zone.rb
+- lib/shopify_api/rest/resources/2024_01/shop.rb
+- lib/shopify_api/rest/resources/2024_01/smart_collection.rb
+- lib/shopify_api/rest/resources/2024_01/storefront_access_token.rb
+- lib/shopify_api/rest/resources/2024_01/tender_transaction.rb
+- lib/shopify_api/rest/resources/2024_01/theme.rb
+- lib/shopify_api/rest/resources/2024_01/transaction.rb
+- lib/shopify_api/rest/resources/2024_01/usage_charge.rb
+- lib/shopify_api/rest/resources/2024_01/user.rb
+- lib/shopify_api/rest/resources/2024_01/variant.rb
+- lib/shopify_api/rest/resources/2024_01/webhook.rb
 - lib/shopify_api/utils/graphql_proxy.rb
 - lib/shopify_api/utils/hmac_validator.rb
 - lib/shopify_api/utils/http_utils.rb
@@ -896,7 +1029,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.5.4
 signing_key: 
 specification_version: 4
 summary: The gem for accessing the Shopify API

data/.github/workflows/stale.yml

@@ -1,43 +0,0 @@
-name: Close inactive issues / prs
-on:
-  schedule:
-    - cron: "30 1 * * *"
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-    steps:
-      - 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.
-          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.
-            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!
-          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/docs/issues.md

@@ -1,39 +0,0 @@
-# Known issues and caveats
-
-By following this guide, you will have a fully functional Shopify app. However, there are some things you should be aware of before using your new app in a production environment.
-
-## Notes on session handling
-
-Before you start writing your application, please note that the Shopify library needs to store some information for OAuth in sessions. Since each application may choose a different strategy to store information, the library cannot dictate any specific storage strategy. When calling `ShopifyAPI::Context.setup`, you'll need to provide an instance of a class that implements the `ShopifyAPI::Auth::SessionStorage` interface.
-
-This library provides a very simple implementation of that interface which stores sessions in files, `ShopifyAPI::Auth::FileSessionStorage` ([source code](../lib/shopify_api/auth/file_session_storage.rb)). This class is meant to speed up development with this library, but it is not suitable for production use, because it will lead to disk build-up as old sessions are not cleaned up.
-
-Before you deploy your app to production, it should use your selected storage method for sessions. You can do that by creating a class that implements the `SessionStorage` interface and pass that in your `Context.setup` call. Your class will need to implement the methods below.
-
-**Note**: After you create your implementation of `SessionStorage`, you should make sure to clean up old sessions periodically in your data storage. The library will delete some sessions when they are no longer useful, but it cannot guarantee that expired sessions are deleted automatically.
-
-#### `SessionStorage.storeSession`
-
-Creates **or updates** a `Session` object in your storage. This function should return a `bool` indicating whether the operation was successful.
-
-| Param     | Type      | Notes                       |
-| --------- | --------- | --------------------------- |
-| `session` | `Session` | The session object to store |
-
-#### `SessionStorage.loadSession`
-
-Fetches a `Session` object from your storage. This function should return a `Session` object, or `null` if it was not found.
-
-| Param       | Type     | Notes                         |
-| ----------- | -------- | ----------------------------- |
-| `sessionId` | `string` | The id of the session to load |
-
-#### `SessionStorage.deleteSession`
-
-Deletes a session from your storage. This function should return a `bool` indicating whether the operation was successful.
-
-| Param       | Type     | Notes                           |
-| ----------- | -------- | ------------------------------- |
-| `sessionId` | `string` | The id of the session to delete |
-
-[Back to guide index](README.md)

data/docs/usage/session_storage.md

@@ -1,46 +0,0 @@
-
-# Create a Session Storage Implementation
-
-The implementation of session storage that you pass in `ShopifyAPI::Context.setup` is what the Shopify gem will use to store and load sessions. [Shopify::Auth::FileSessionStorage](../../lib/shopify_api/auth/file_session_storage.rb) can be used for testing purposes and as an example of how to make an implementation in your app. This is not recommended for production, we recommend you implement a solution that will store and load serialized sessions from a more ideal store such as a database like MySQL or MongoDB.
-
-## Create a New Session Storage Class
-
-You can create a session storage class that includes `ShopifyAPI::Auth::SessionStorage` and override the methods as shown in the table and example below:
-
-|       Method Name      |             Input Type            |           Return Type          |
-| ---------------------- | --------------------------------- | ------------------------------ |
-| `store_session`        | `ShopifyAPI::Auth::Session`       | `Boolean` (true if successful) |
-| `load_session`         | `String` (session id)             | `ShopifyAPI::Auth::Session`    |
-| `delete_session`       | `String` (session id)             | `Boolean` (true if successful) |
-
-
-```ruby
-class CustomSessionStorage
-  include ShopifyAPI::Auth::SessionStorage
-
-  def initialize
-    # Initialize as needed
-  end
-
-  def store_session(session)
-    # Implement a store function
-    some_store_function(id: session.id, session_data: session.serialize)
-  end
-
-  def load_session(id)
-    # Implement a fetch function
-    session_data = some_fetch_function(id)
-    ShopifyAPI::Auth::Session.deserialize(session_data)
-  end
-
-  def delete_session(id)
-    # Implement a delete function
-    some_delete_function(id)
-    true
-  end
-end
-```
-
-**Note:** We recommend utilizing the Session `serialize` and `deserialize` functions to make storing and loading sessions easier.
-
-Once this is complete you can pass an instance of this session storage class as `session_storage` in `ShopifyAPI::Context.setup`