shopify_api 10.0.3 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81babe6da64bc6c8b0e413213fff00c818778c5bc5cf9bd79b1acb25fd3ea3d1
-  data.tar.gz: b9dda7bb0992365df524d1e22d70ee34fee776a68c5dc9e958b826d49c6c0541
+  metadata.gz: fc4cfe78db0e88c911424f8d3e2b3ed88b41a3bb91db59beea5a250222a784af
+  data.tar.gz: c2f3d45bf47d0b0e5d8da086895c59145b0c84ef4b70f04acee72188278f4b74
 SHA512:
-  metadata.gz: cb1eeacedfe1a0fdd8f0262e0bb63ea52996aa6a98f1ffee803481a2ce38424f31d8aa0658108f53a376fef29d5a65acf7bb1384d6d87ce21e52eabdc4926da8
-  data.tar.gz: 03c666d05fc413b5da1951a0693818ca97c48064bb2735facb019a4e04a55581525ee061e19dc1c1406e4c67a0949ded89ffec69ef5cab1f1d8866f8d514277f
+  metadata.gz: f5fdbadb1ba50cf494e3eee2e08c6e2ee29085093821d24da8965d3215c1197ddadbaf0c1b2fb979ba59a3e3fad315691a85658ba970dd8f58b0a5f4b23456ab
+  data.tar.gz: b71d5ec832995ae090aa52ee61c5fe3a67c05ad04d78a3e8f34cfee2fa8565f221ce5229a354f981c1de2d9eed25e2fd341919c6474695a973b7052b71db72df

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 # Changelog
 
+Note: For changes to the API, see https://shopify.dev/changelog?filter=api
+
 ## Unreleased
 
+## Version 10.1.0
+
+- [#933](https://github.com/Shopify/shopify_api/pull/933) Fix syntax of GraphQL query in `Webhooks.get_webhook_id` method by removing extra curly brace
+- [#941](https://github.com/Shopify/shopify_api/pull/941) Fix `to_hash` to return readonly attributes, unless being used for serialize the object for saving - fix issue [#930](https://github.com/Shopify/shopify_api/issues/930)
+- [#959](https://github.com/Shopify/shopify_api/pull/959) Update `LATEST_SUPPORTED_ADMIN_VERSION` to `2022-04` to align it with the current value
+
 ## Version 10.0.3
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (10.0.3)
+    shopify_api (10.1.0)
       concurrent-ruby
       hash_diff
       httparty
@@ -79,16 +79,16 @@ GEM
       rubocop (>= 0.90.0)
     ruby-progressbar (1.11.0)
     securerandom (0.2.0)
-    sorbet (0.5.9924)
-      sorbet-static (= 0.5.9924)
-    sorbet-runtime (0.5.9924)
-    sorbet-static (0.5.9924-universal-darwin-21)
-    sorbet-static (0.5.9924-x86_64-linux)
+    sorbet (0.5.10016)
+      sorbet-static (= 0.5.10016)
+    sorbet-runtime (0.5.10016)
+    sorbet-static (0.5.10016-universal-darwin-21)
+    sorbet-static (0.5.10016-x86_64-linux)
     spoom (1.1.8)
       sorbet (>= 0.5.9204)
       sorbet-runtime (>= 0.5.9204)
       thor (>= 0.19.2)
-    tapioca (0.6.3)
+    tapioca (0.6.4)
       bundler (>= 1.17.3)
       pry (>= 0.12.2)
       rbi (~> 0.0.0, >= 0.0.9)

data/README.md

@@ -57,7 +57,7 @@ ShopifyAPI::Context.setup(
   session_storage: ShopifyAPI::Auth::FileSessionStorage.new, # See more details below
   is_embedded: true, # Set to true if you are building an embedded app
   is_private: false, # Set to true if you are building a private app
-  api_version: "2022-01" # The vesion of the API you would like to use
+  api_version: "2022-01" # The version of the API you would like to use
 )
 ```
 

data/docs/usage/graphql.md

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

data/lib/shopify_api/admin_versions.rb

@@ -12,7 +12,7 @@ module ShopifyAPI
       "2021-04",
     ], T::Array[String])
 
-    LATEST_SUPPORTED_ADMIN_VERSION = T.let("2022-01", String)
+    LATEST_SUPPORTED_ADMIN_VERSION = T.let("2022-04", String)
   end
 
   SUPPORTED_ADMIN_VERSIONS = ShopifyAPI::AdminVersions::SUPPORTED_ADMIN_VERSIONS

data/lib/shopify_api/rest/base.rb

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

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/shopify_api/rest/resources/2021_07/article.rb

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

data/lib/shopify_api/rest/resources/2021_07/asset.rb

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

data/lib/shopify_api/rest/resources/2021_07/assigned_fulfillment_order.rb

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

data/lib/shopify_api/rest/resources/2021_07/balance.rb

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

data/lib/shopify_api/rest/resources/2021_07/blog.rb

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

data/lib/shopify_api/rest/resources/2021_07/cancellation_request.rb

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

data/lib/shopify_api/rest/resources/2021_07/carrier_service.rb

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

data/lib/shopify_api/rest/resources/2021_07/checkout.rb

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

data/lib/shopify_api/rest/resources/2021_07/collect.rb

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

data/lib/shopify_api/rest/resources/2021_07/collection.rb

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

data/lib/shopify_api/rest/resources/2021_07/collection_listing.rb

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

data/lib/shopify_api/rest/resources/2021_07/comment.rb

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

data/lib/shopify_api/rest/resources/2021_07/country.rb

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

data/lib/shopify_api/rest/resources/2021_07/currency.rb

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

data/lib/shopify_api/rest/resources/2021_07/custom_collection.rb

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

data/lib/shopify_api/rest/resources/2021_07/customer.rb

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

data/lib/shopify_api/rest/resources/2021_07/customer_address.rb

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

data/lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb

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

data/lib/shopify_api/rest/resources/2021_07/deprecated_api_call.rb

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

data/lib/shopify_api/rest/resources/2021_07/discount_code.rb

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

data/lib/shopify_api/rest/resources/2021_07/dispute.rb

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

data/lib/shopify_api/rest/resources/2021_07/draft_order.rb

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

data/lib/shopify_api/rest/resources/2021_07/event.rb

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

data/lib/shopify_api/rest/resources/2021_07/fulfillment.rb

@@ -1,6 +1,10 @@
 # typed: false
 # frozen_string_literal: true
 
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
 module ShopifyAPI
   class Fulfillment < ShopifyAPI::Rest::Base
     extend T::Sig
@@ -37,7 +41,14 @@ module ShopifyAPI
       {http_method: :get, operation: :get, ids: [:fulfillment_order_id], path: "fulfillment_orders/<fulfillment_order_id>/fulfillments.json"},
       {http_method: :get, operation: :get, ids: [:order_id], path: "orders/<order_id>/fulfillments.json"},
       {http_method: :get, operation: :get, ids: [:order_id, :id], path: "orders/<order_id>/fulfillments/<id>.json"},
-      {http_method: :post, operation: :update_tracking, ids: [:id], path: "fulfillments/<id>/update_tracking.json"}
+      {http_method: :post, operation: :cancel, ids: [:id], path: "fulfillments/<id>/cancel.json"},
+      {http_method: :post, operation: :cancel, ids: [:order_id, :id], path: "orders/<order_id>/fulfillments/<id>/cancel.json"},
+      {http_method: :post, operation: :complete, ids: [:order_id, :id], path: "orders/<order_id>/fulfillments/<id>/complete.json"},
+      {http_method: :post, operation: :open, ids: [:order_id, :id], path: "orders/<order_id>/fulfillments/<id>/open.json"},
+      {http_method: :post, operation: :post, ids: [], path: "fulfillments.json"},
+      {http_method: :post, operation: :post, ids: [:order_id], path: "orders/<order_id>/fulfillments.json"},
+      {http_method: :post, operation: :update_tracking, ids: [:id], path: "fulfillments/<id>/update_tracking.json"},
+      {http_method: :put, operation: :put, ids: [:order_id, :id], path: "orders/<order_id>/fulfillments/<id>.json"}
     ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
 
     sig { returns(T.nilable(String)) }
@@ -166,6 +177,69 @@ module ShopifyAPI
 
     end
 
+    sig do
+      params(
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def cancel(
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :cancel,
+        session: @session,
+        ids: {id: @id, order_id: @order_id},
+        params: {}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def complete(
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :complete,
+        session: @session,
+        ids: {id: @id, order_id: @order_id},
+        params: {}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
+    sig do
+      params(
+        body: T.untyped,
+        kwargs: T.untyped
+      ).returns(T.untyped)
+    end
+    def open(
+      body: nil,
+      **kwargs
+    )
+      self.class.request(
+        http_method: :post,
+        operation: :open,
+        session: @session,
+        ids: {id: @id, order_id: @order_id},
+        params: {}.merge(kwargs).compact,
+        body: body,
+        entity: self,
+      )
+    end
+
     sig do
       params(
         body: T.untyped,

data/lib/shopify_api/rest/resources/2021_07/fulfillment_event.rb

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

data/lib/shopify_api/rest/resources/2021_07/fulfillment_order.rb

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