shopify_api 10.1.0 → 11.1.0

data/RELEASING.md

@@ -1,6 +1,7 @@
 # Releasing ShopifyAPI
 
-1. Before releasing, make sure `sorbet` and `sorbet-runtime` are up to date
+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`

data/docs/usage/graphql.md

@@ -1,6 +1,6 @@
 # Make a GraphQL API call
 
-Once you have a [session](https://github.com/Shopify/shopify_api/blob/main/docs/usage/oauth.md#fetching-sessions) after completing oauth, you can make GraphQL queries to the Admin API with `ShopifyAPI::Clients::Graphql::Admin`
+Once you have a [session](oauth.md#fetching-sessions) after completing oauth, you can make GraphQL queries to the Admin API with `ShopifyAPI::Clients::Graphql::Admin`
 
 Below is an example
 

data/lib/shopify_api/admin_versions.rb

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

data/lib/shopify_api/auth/file_session_storage.rb

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
+require "fileutils"
+
 module ShopifyAPI
   module Auth
     class FileSessionStorage

data/lib/shopify_api/auth/jwt_payload.rb

@@ -16,11 +16,12 @@ module ShopifyAPI
 
       sig { params(token: String).void }
       def initialize(token)
-        begin
-          payload_hash = JWT.decode(token, Context.api_secret_key, true,
-            { exp_leeway: JWT_EXPIRATION_LEEWAY, algorithm: "HS256" })[0]
-        rescue
-          raise ShopifyAPI::Errors::InvalidJwtTokenError, "Failed to parse session token '#{token}'"
+        payload_hash = begin
+          decode_token(token, Context.api_secret_key)
+        rescue ShopifyAPI::Errors::InvalidJwtTokenError
+          raise unless Context.old_api_secret_key
+
+          decode_token(token, T.must(Context.old_api_secret_key))
         end
 
         @iss = T.let(payload_hash["iss"], String)
@@ -67,6 +68,16 @@ module ShopifyAPI
           jti == other.jti &&
           sid == other.sid
       end
+
+      private
+
+      sig { params(token: String, api_secret_key: String).returns(T::Hash[String, T.untyped]) }
+      def decode_token(token, api_secret_key)
+        JWT.decode(token, api_secret_key, true,
+          { exp_leeway: JWT_EXPIRATION_LEEWAY, algorithm: "HS256" })[0]
+      rescue
+        raise ShopifyAPI::Errors::InvalidJwtTokenError, "Failed to parse session token '#{token}'"
+      end
     end
   end
 end

data/lib/shopify_api/auth/session.rb

@@ -83,6 +83,11 @@ module ShopifyAPI
             Context.activate_session(original_session)
           end
         end
+
+        sig { params(str: String).returns(Session) }
+        def deserialize(str)
+          Oj.load(str)
+        end
       end
 
       sig { returns(String) }
@@ -90,16 +95,11 @@ module ShopifyAPI
         Oj.dump(self)
       end
 
-      sig { params(str: String).returns(Session) }
-      def self.deserialize(str)
-        Oj.load(str)
-      end
-
       alias_method :eql?, :==
       sig { params(other: T.nilable(Session)).returns(T::Boolean) }
       def ==(other)
         if other
-          T.must(
+          (
             id == other.id &&
             shop == other.shop &&
             state == other.state &&

data/lib/shopify_api/auth.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module ShopifyAPI
+  module Auth
+    extend T::Sig
+
+    class << self
+      extend T::Sig
+
+      sig { params(host: T.nilable(String)).returns(String) }
+      def embedded_app_url(host)
+        unless Context.setup?
+          raise Errors::ContextNotSetupError, "ShopifyAPI::Context not setup, please call ShopifyAPI::Context.setup"
+        end
+
+        unless host
+          raise Errors::MissingRequiredArgumentError, "host argument is required"
+        end
+
+        decoded_host = Base64.decode64(host)
+        "https://#{decoded_host}/apps/#{Context.api_key}"
+      end
+    end
+  end
+end

data/lib/shopify_api/context.rb

@@ -18,6 +18,7 @@ module ShopifyAPI
     @notified_missing_resources_folder = T.let({}, T::Hash[String, T::Boolean])
     @active_session = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
     @user_agent_prefix = T.let(nil, T.nilable(String))
+    @old_api_secret_key = T.let(nil, T.nilable(String))
 
     @rest_resource_loader = T.let(nil, T.nilable(Zeitwerk::Loader))
 
@@ -37,6 +38,7 @@ module ShopifyAPI
           logger: Logger,
           private_shop: T.nilable(String),
           user_agent_prefix: T.nilable(String),
+          old_api_secret_key: T.nilable(String),
         ).void
       end
       def setup(
@@ -50,7 +52,8 @@ module ShopifyAPI
         session_storage:,
         logger: Logger.new($stdout),
         private_shop: nil,
-        user_agent_prefix: nil
+        user_agent_prefix: nil,
+        old_api_secret_key: nil
       )
         unless ShopifyAPI::AdminVersions::SUPPORTED_ADMIN_VERSIONS.include?(api_version)
           raise Errors::UnsupportedVersionError,
@@ -68,6 +71,7 @@ module ShopifyAPI
         @logger = logger
         @private_shop = private_shop
         @user_agent_prefix = user_agent_prefix
+        @old_api_secret_key = old_api_secret_key
 
         load_rest_resources(api_version: api_version)
       end
@@ -118,7 +122,7 @@ module ShopifyAPI
       end
 
       sig { returns(T.nilable(String)) }
-      attr_reader :private_shop, :user_agent_prefix
+      attr_reader :private_shop, :user_agent_prefix, :old_api_secret_key
 
       sig { returns(T::Boolean) }
       def embedded?

data/lib/shopify_api/errors/missing_required_argument_error.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+module ShopifyAPI
+  module Errors
+    class MissingRequiredArgumentError < StandardError
+    end
+  end
+end

data/lib/shopify_api/rest/resources/{2021_07 → 2022_07}/carrier_service.rb

@@ -20,7 +20,6 @@ module ShopifyAPI
       @admin_graphql_api_id = T.let(nil, T.nilable(String))
       @callback_url = T.let(nil, T.nilable(String))
       @carrier_service_type = T.let(nil, T.nilable(String))
-      @format = T.let(nil, T.nilable(String))
       @id = T.let(nil, T.nilable(Integer))
       @name = T.let(nil, T.nilable(String))
       @service_discovery = T.let(nil, T.nilable(T::Boolean))
@@ -44,8 +43,6 @@ module ShopifyAPI
     attr_reader :callback_url
     sig { returns(T.nilable(String)) }
     attr_reader :carrier_service_type
-    sig { returns(T.nilable(String)) }
-    attr_reader :format
     sig { returns(T.nilable(Integer)) }
     attr_reader :id
     sig { returns(T.nilable(String)) }

data/lib/shopify_api/rest/resources/{2021_07 → 2022_07}/customer.rb

@@ -23,6 +23,7 @@ module ShopifyAPI
       @currency = T.let(nil, T.nilable(String))
       @default_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @email = T.let(nil, T.nilable(String))
+      @email_marketing_consent = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @first_name = T.let(nil, T.nilable(String))
       @id = T.let(nil, T.nilable(Integer))
       @last_name = T.let(nil, T.nilable(String))
@@ -33,7 +34,10 @@ module ShopifyAPI
       @multipass_identifier = T.let(nil, T.nilable(String))
       @note = T.let(nil, T.nilable(String))
       @orders_count = T.let(nil, T.nilable(Integer))
+      @password = T.let(nil, T.nilable(String))
+      @password_confirmation = T.let(nil, T.nilable(String))
       @phone = T.let(nil, T.nilable(String))
+      @sms_marketing_consent = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @state = T.let(nil, T.nilable(String))
       @tags = T.let(nil, T.nilable(String))
       @tax_exempt = T.let(nil, T.nilable(T::Boolean))
@@ -73,6 +77,8 @@ module ShopifyAPI
     attr_reader :default_address
     sig { returns(T.nilable(String)) }
     attr_reader :email
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :email_marketing_consent
     sig { returns(T.nilable(String)) }
     attr_reader :first_name
     sig { returns(T.nilable(Integer)) }
@@ -94,7 +100,13 @@ module ShopifyAPI
     sig { returns(T.nilable(Integer)) }
     attr_reader :orders_count
     sig { returns(T.nilable(String)) }
+    attr_reader :password
+    sig { returns(T.nilable(String)) }
+    attr_reader :password_confirmation
+    sig { returns(T.nilable(String)) }
     attr_reader :phone
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :sms_marketing_consent
     sig { returns(T.nilable(String)) }
     attr_reader :state
     sig { returns(T.nilable(String)) }

data/lib/shopify_api/rest/resources/2022_07/dispute_evidence.rb

@@ -0,0 +1,117 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class DisputeEvidence < ShopifyAPI::Rest::Base
+    extend T::Sig
+
+    @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
+    def initialize(session: ShopifyAPI::Context.active_session)
+      super(session: session)
+
+      @access_activity_log = T.let(nil, T.nilable(String))
+      @billing_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @cancellation_policy_disclosure = T.let(nil, T.nilable(String))
+      @cancellation_rebuttal = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @customer_email_address = T.let(nil, T.nilable(String))
+      @customer_first_name = T.let(nil, T.nilable(String))
+      @customer_last_name = T.let(nil, T.nilable(String))
+      @dispute_evidence_files = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @fulfillments = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @id = T.let(nil, T.nilable(Integer))
+      @payments_dispute_id = T.let(nil, T.nilable(Integer))
+      @product_description = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @refund_policy_disclosure = T.let(nil, T.nilable(String))
+      @refund_refusal_explanation = T.let(nil, T.nilable(String))
+      @shipping_address_attributes = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @submitted = T.let(nil, T.nilable(T::Boolean))
+      @uncategorized_text = T.let(nil, T.nilable(String))
+      @updated_on = T.let(nil, T.nilable(String))
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({
+      fulfillments: Fulfillment
+    }, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :get, operation: :get, ids: [:dispute_id], path: "shopify_payments/disputes/<dispute_id>/dispute_evidences.json"},
+      {http_method: :put, operation: :put, ids: [:dispute_id], path: "shopify_payments/disputes/<dispute_id>/dispute_evidences.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :access_activity_log
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :billing_address
+    sig { returns(T.nilable(String)) }
+    attr_reader :cancellation_policy_disclosure
+    sig { returns(T.nilable(String)) }
+    attr_reader :cancellation_rebuttal
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :customer_email_address
+    sig { returns(T.nilable(String)) }
+    attr_reader :customer_first_name
+    sig { returns(T.nilable(String)) }
+    attr_reader :customer_last_name
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :dispute_evidence_files
+    sig { returns(T.nilable(T::Array[Fulfillment])) }
+    attr_reader :fulfillments
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :payments_dispute_id
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :product_description
+    sig { returns(T.nilable(String)) }
+    attr_reader :refund_policy_disclosure
+    sig { returns(T.nilable(String)) }
+    attr_reader :refund_refusal_explanation
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :shipping_address_attributes
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :submitted
+    sig { returns(T.nilable(String)) }
+    attr_reader :uncategorized_text
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_on
+
+    class << self
+      sig do
+        returns(String)
+      end
+      def primary_key()
+        "dispute_id"
+      end
+
+      sig do
+        params(
+          dispute_id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.nilable(DisputeEvidence))
+      end
+      def find(
+        dispute_id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {dispute_id: dispute_id},
+          params: {},
+        )
+        T.cast(result[0], T.nilable(DisputeEvidence))
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2022_07/dispute_file_upload.rb

@@ -0,0 +1,81 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class DisputeFileUpload < ShopifyAPI::Rest::Base
+    extend T::Sig
+
+    @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
+    def initialize(session: ShopifyAPI::Context.active_session)
+      super(session: session)
+
+      @dispute_evidence_id = T.let(nil, T.nilable(Integer))
+      @dispute_evidence_type = T.let(nil, T.nilable(String))
+      @file_size = T.let(nil, T.nilable(Integer))
+      @file_type = T.let(nil, T.nilable(String))
+      @filename = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @original_filename = T.let(nil, T.nilable(String))
+      @shop_id = T.let(nil, T.nilable(Integer))
+      @url = T.let(nil, T.nilable(String))
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [:dispute_id, :id], path: "shopify_payments/disputes/<dispute_id>/dispute_file_uploads/<id>.json"},
+      {http_method: :post, operation: :post, ids: [:dispute_id], path: "shopify_payments/disputes/<dispute_id>/dispute_file_uploads.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :dispute_evidence_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :dispute_evidence_type
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :file_size
+    sig { returns(T.nilable(String)) }
+    attr_reader :file_type
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(String)) }
+    attr_reader :original_filename
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :shop_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :url
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          dispute_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session
+        ).returns(T.untyped)
+      end
+      def delete(
+        id:,
+        dispute_id: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        request(
+          http_method: :delete,
+          operation: :delete,
+          session: session,
+          ids: {id: id, dispute_id: dispute_id},
+          params: {},
+        )
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/{2021_07 → 2022_07}/draft_order.rb

@@ -31,6 +31,7 @@ module ShopifyAPI
       @note = T.let(nil, T.nilable(String))
       @note_attributes = T.let(nil, T.nilable(T::Array[T.untyped]))
       @order_id = T.let(nil, T.nilable(Integer))
+      @payment_terms = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @shipping_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @shipping_line = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @source_name = T.let(nil, T.nilable(String))
@@ -92,6 +93,8 @@ module ShopifyAPI
     sig { returns(T.nilable(Integer)) }
     attr_reader :order_id
     sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :payment_terms
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
     attr_reader :shipping_address
     sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
     attr_reader :shipping_line
@@ -245,12 +248,14 @@ module ShopifyAPI
 
     sig do
       params(
+        payment_gateway_id: T.untyped,
         payment_pending: T.untyped,
         body: T.untyped,
         kwargs: T.untyped
       ).returns(T.untyped)
     end
     def complete(
+      payment_gateway_id: nil,
       payment_pending: nil,
       body: nil,
       **kwargs
@@ -260,7 +265,7 @@ module ShopifyAPI
         operation: :complete,
         session: @session,
         ids: {id: @id},
-        params: {payment_pending: payment_pending}.merge(kwargs).compact,
+        params: {payment_gateway_id: payment_gateway_id, payment_pending: payment_pending}.merge(kwargs).compact,
         body: body,
         entity: self,
       )

data/lib/shopify_api/rest/resources/{2021_07 → 2022_07}/fulfillment.rb

@@ -23,6 +23,7 @@ module ShopifyAPI
       @name = T.let(nil, T.nilable(String))
       @notify_customer = T.let(nil, T.nilable(T::Boolean))
       @order_id = T.let(nil, T.nilable(Integer))
+      @origin_address = T.let(nil, T.nilable(T::Array[T.untyped]))
       @receipt = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @service = T.let(nil, T.nilable(String))
       @shipment_status = T.let(nil, T.nilable(String))
@@ -42,13 +43,8 @@ module ShopifyAPI
       {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: :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"}
+      {http_method: :post, operation: :update_tracking, ids: [:id], path: "fulfillments/<id>/update_tracking.json"}
     ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
 
     sig { returns(T.nilable(String)) }
@@ -65,6 +61,8 @@ module ShopifyAPI
     attr_reader :notify_customer
     sig { returns(T.nilable(Integer)) }
     attr_reader :order_id
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :origin_address
     sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
     attr_reader :receipt
     sig { returns(T.nilable(String)) }
@@ -191,49 +189,7 @@ module ShopifyAPI
         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},
+        ids: {id: @id},
         params: {}.merge(kwargs).compact,
         body: body,
         entity: self,