Fixes DiscountCode errors type, adds new BatchResult type

CHANGELOG.md

@@ -3,6 +3,7 @@
 Note: For changes to the API, see https://shopify.dev/changelog?filter=api
 
 ## Unreleased
+- [#1279](https://github.com/Shopify/shopify-api-ruby/pull/1276) Fixes DiscountCode errors type, adds new BatchResult type
 - [#1254](https://github.com/Shopify/shopify-api-ruby/pull/1254) Introduce token exchange API for fetching access tokens. This feature is currently unstable and cannot be used yet.
 - [#1268](https://github.com/Shopify/shopify-api-ruby/pull/1268) Add [new webhook handler interface](https://github.com/Shopify/shopify-api-ruby/blob/main/docs/usage/webhooks.md#create-a-webhook-handler) to provide `webhook_id ` and `api_version` information to webhook handlers.
 

lib/shopify_api/rest/resources/2024_01/discount_code.rb

@@ -20,7 +20,6 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
 
       @code = T.let(nil, T.nilable(String))
       @created_at = T.let(nil, T.nilable(String))
-      @errors = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
       @id = T.let(nil, T.nilable(Integer))
       @price_rule_id = T.let(nil, T.nilable(Integer))
       @updated_at = T.let(nil, T.nilable(String))
@@ -35,6 +34,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
       {http_method: :delete, operation: :delete, ids: [:price_rule_id, :id], path: "price_rules/<price_rule_id>/discount_codes/<id>.json"},
       {http_method: :get, operation: :count, ids: [], path: "discount_codes/count.json"},
       {http_method: :get, operation: :get, ids: [:price_rule_id, :batch_id], path: "price_rules/<price_rule_id>/batch/<batch_id>/discount_codes.json"},
+      {http_method: :get, operation: :get_batch_results, ids: [:price_rule_id, :batch_id], path: "price_rules/<price_rule_id>/batch/<batch_id>/discount_codes.json"},
       {http_method: :get, operation: :get, ids: [:price_rule_id], path: "price_rules/<price_rule_id>/discount_codes.json"},
       {http_method: :get, operation: :get, ids: [:price_rule_id, :id], path: "price_rules/<price_rule_id>/discount_codes/<id>.json"},
       {http_method: :get, operation: :get_all, ids: [:price_rule_id, :batch_id], path: "price_rules/<price_rule_id>/batch/<batch_id>.json"},
@@ -48,8 +48,6 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
     attr_reader :code
     sig { returns(T.nilable(String)) }
     attr_reader :created_at
-    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
-    attr_reader :errors
     sig { returns(T.nilable(Integer)) }
     attr_reader :id
     sig { returns(T.nilable(Integer)) }
@@ -59,6 +57,12 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
     sig { returns(T.nilable(Integer)) }
     attr_reader :usage_count
 
+    class BatchResult < T::Struct
+      const :id, T.nilable(Integer)
+      const :code, T.nilable(String)
+      const :errors, T.nilable(T::Hash[T.untyped, T.untyped])
+    end
+
     class << self
       sig do
         params(
@@ -115,6 +119,17 @@ def all(
         session: ShopifyAPI::Context.active_session,
         **kwargs
       )
+        unless batch_id.nil?
+          deprecation_msg = <<~MSG
+            DEPRECATED: Use `.get_batch_results`
+            instead of `.all` with `batch_id` argument to get the right return type.
+          MSG
+          ShopifyAPI::Logger.deprecated(
+            deprecation_msg,
+            "14.0.0",
+          )
+        end
+
         response = base_find(
           session: session,
           ids: {price_rule_id: price_rule_id, batch_id: batch_id},
@@ -176,6 +191,52 @@ def get_all(
         )
       end
 
+      sig do
+        params(
+          price_rule_id: T.nilable(T.any(Integer, String)),
+          batch_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[BatchResult])
+      end
+      def get_batch_results(
+        price_rule_id: nil,
+        batch_id: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = request(
+          http_method: :get,
+          operation: :get_batch_results,
+          session: session,
+          ids: {price_rule_id: price_rule_id, batch_id: batch_id},
+          params: {}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+
+        body = T.cast(response.body, T::Hash[String, T.untyped])
+        results = T.let([], T::Array[BatchResult])
+
+        response_names = json_response_body_names
+        response_names.each do |response_name|
+          root = response_name.pluralize
+          batch_results = body[root]
+
+          results = batch_results.map do |result|
+            original_state = result.transform_keys(&:to_sym)
+
+            BatchResult.new(
+              id: original_state[:id],
+              code: original_state[:code],
+              errors: original_state[:errors],
+            )
+          end
+        end
+
+        results
+      end
+
       sig do
         params(
           code: T.untyped,

lib/shopify_api/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module ShopifyAPI
-  VERSION = "13.4.0"
+  VERSION = "13.4.1"
 end

test/rest/2024_01/discount_code_test.rb

@@ -324,4 +324,44 @@ def test_9()
     end
   end
 
+  sig do
+    void
+  end
+  def test_10()
+    stub_request(:get, "https://test-shop.myshopify.io/admin/api/2024-01/price_rules/507328175/batch/173232803/discount_codes.json")
+      .with(
+        headers: {"X-Shopify-Access-Token"=>"this_is_a_test_token", "Accept"=>"application/json"},
+        body: {}
+      )
+      .to_return(
+        status: 200,
+        body: JSON.generate(
+          {
+            "discount_codes" => [
+              {"id" => nil, "code" => "foo", "errors" => { "code": ["Must be unique, please try a different code"] }},
+            ]
+          }
+        ), headers: {})
+
+    response = ShopifyAPI::DiscountCode.get_batch_results(
+      price_rule_id: 507328175,
+      batch_id: 173232803,
+    )
+
+    assert_requested(:get, "https://test-shop.myshopify.io/admin/api/2024-01/price_rules/507328175/batch/173232803/discount_codes.json")
+
+    response = response.first if response.respond_to?(:first)
+
+    # Assert attributes are correctly typed preventing Sorbet errors downstream
+    if response.respond_to?(:original_state)
+      response&.original_state&.each do |key, value|
+        begin
+          response.send(key)
+        rescue TypeError => error
+          fail TypeError.new("#{self.class}##{key} is mistyped: #{error.message}")
+        end
+        response.send(key)
+      end
+    end
+  end
 end