Skip to content

Commit 3e35c3d

Browse files
hrdwdmrblhrdwdmrbl
committed
Fix: FulfillmentEvent returns String for province and country
Feature: Tests for FulfillmentEvent that use non-nil `province` and `country` attributes Q: Does the API ever return Integer? Hard to prove a negative Fix: Variant class `inventory_quantity` attribute type which can be either integer, string or nil Chore: Add to changelog
1 parent 9c96648 commit 3e35c3d

24 files changed

+92
-107
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Note: For changes to the API, see https://shopify.dev/changelog?filter=api
44

55
## Unreleased
66

7+
- [#1071](https://github.com/Shopify/shopify-api-ruby/issues/1071) Fix FulfillmentEvent class types
8+
- Fix: InventoryItem class `harmonized_system_code` attribute type which can be either integer, string or nil
9+
- Fix: Variant class `inventory_quantity` attribute type which can be either integer, string or nil
10+
711
## 14.0.1
812
- [#1288](https://github.com/Shopify/shopify-api-ruby/pull/1288) Fix FeatureDeprecatedError being raised without a message.
913
- [1290](https://github.com/Shopify/shopify-api-ruby/pull/1290) Move deprecation of `ShopifyAPI::Webhooks::Handler#handle` to version 15.0.0

‎lib/shopify_api/rest/resources/2022_04/fulfillment_event.rb‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
2020

2121
@address1 = T.let(nil, T.nilable(String))
2222
@city = T.let(nil, T.nilable(String))
23-
@country = T.let(nil, T.nilable(Country))
23+
@country = T.let(nil, T.nilable(String))
2424
@created_at = T.let(nil, T.nilable(String))
2525
@estimated_delivery_at = T.let(nil, T.nilable(String))
2626
@fulfillment_id = T.let(nil, T.nilable(Integer))
@@ -30,7 +30,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
3030
@longitude = T.let(nil, T.nilable(Float))
3131
@message = T.let(nil, T.nilable(String))
3232
@order_id = T.let(nil, T.nilable(Integer))
33-
@province = T.let(nil, T.nilable(Province))
33+
@province = T.let(nil, T.nilable(String))
3434
@shop_id = T.let(nil, T.nilable(Integer))
3535
@status = T.let(nil, T.nilable(String))
3636
@updated_at = T.let(nil, T.nilable(String))
@@ -39,10 +39,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
3939
super(session: session, from_hash: from_hash)
4040
end
4141

42-
@has_one = T.let({
43-
country: Country,
44-
province: Province
45-
}, T::Hash[Symbol, Class])
42+
@has_one = T.let({}, T::Hash[Symbol, Class])
4643
@has_many = T.let({}, T::Hash[Symbol, Class])
4744
@paths = T.let([
4845
{http_method: :delete, operation: :delete, ids: [:order_id, :fulfillment_id, :id], path: "orders/<order_id>/fulfillments/<fulfillment_id>/events/<id>.json"},
@@ -55,7 +52,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
5552
attr_reader :address1
5653
sig { returns(T.nilable(String)) }
5754
attr_reader :city
58-
sig { returns(T.nilable(Country)) }
55+
sig { returns(T.nilable(String)) }
5956
attr_reader :country
6057
sig { returns(T.nilable(String)) }
6158
attr_reader :created_at
@@ -75,7 +72,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
7572
attr_reader :message
7673
sig { returns(T.nilable(Integer)) }
7774
attr_reader :order_id
78-
sig { returns(T.nilable(Province)) }
75+
sig { returns(T.nilable(String)) }
7976
attr_reader :province
8077
sig { returns(T.nilable(Integer)) }
8178
attr_reader :shop_id

‎lib/shopify_api/rest/resources/2022_04/inventory_item.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
2222
@country_code_of_origin = T.let(nil, T.nilable(String))
2323
@country_harmonized_system_codes = T.let(nil, T.nilable(T::Array[T.untyped]))
2424
@created_at = T.let(nil, T.nilable(String))
25-
@harmonized_system_code = T.let(nil, T.nilable(Integer))
25+
@harmonized_system_code = T.let(nil, T.nilable(T.any(Integer, String)))
2626
@id = T.let(nil, T.nilable(Integer))
2727
@province_code_of_origin = T.let(nil, T.nilable(String))
2828
@requires_shipping = T.let(nil, T.nilable(T::Boolean))
@@ -49,7 +49,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
4949
attr_reader :country_harmonized_system_codes
5050
sig { returns(T.nilable(String)) }
5151
attr_reader :created_at
52-
sig { returns(T.nilable(Integer)) }
52+
sig { returns(T.nilable(T.any(Integer, String))) }
5353
attr_reader :harmonized_system_code
5454
sig { returns(T.nilable(Integer)) }
5555
attr_reader :id

‎lib/shopify_api/rest/resources/2022_04/variant.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
2828
@inventory_item_id = T.let(nil, T.nilable(Integer))
2929
@inventory_management = T.let(nil, T.nilable(String))
3030
@inventory_policy = T.let(nil, T.nilable(String))
31-
@inventory_quantity = T.let(nil, T.nilable(Integer))
32-
@inventory_quantity_adjustment = T.let(nil, T.nilable(Integer))
33-
@old_inventory_quantity = T.let(nil, T.nilable(Integer))
31+
@inventory_quantity = T.let(nil, T.nilable(T.any(Integer, String)))
32+
@inventory_quantity_adjustment = T.let(nil, T.nilable(T.any(Integer, String)))
33+
@old_inventory_quantity = T.let(nil, T.nilable(T.any(Integer, String)))
3434
@option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
3535
@position = T.let(nil, T.nilable(Integer))
3636
@presentment_prices = T.let(nil, T.nilable(T::Array[T.untyped]))
@@ -83,11 +83,11 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
8383
attr_reader :inventory_management
8484
sig { returns(T.nilable(String)) }
8585
attr_reader :inventory_policy
86-
sig { returns(T.nilable(Integer)) }
86+
sig { returns(T.nilable(T.any(Integer, String))) }
8787
attr_reader :inventory_quantity
88-
sig { returns(T.nilable(Integer)) }
88+
sig { returns(T.nilable(T.any(Integer, String))) }
8989
attr_reader :inventory_quantity_adjustment
90-
sig { returns(T.nilable(Integer)) }
90+
sig { returns(T.nilable(T.any(Integer, String))) }
9191
attr_reader :old_inventory_quantity
9292
sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
9393
attr_reader :option

‎lib/shopify_api/rest/resources/2022_07/fulfillment_event.rb‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
2020

2121
@address1 = T.let(nil, T.nilable(String))
2222
@city = T.let(nil, T.nilable(String))
23-
@country = T.let(nil, T.nilable(Country))
23+
@country = T.let(nil, T.nilable(String))
2424
@created_at = T.let(nil, T.nilable(String))
2525
@estimated_delivery_at = T.let(nil, T.nilable(String))
2626
@fulfillment_id = T.let(nil, T.nilable(Integer))
@@ -30,7 +30,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
3030
@longitude = T.let(nil, T.nilable(Float))
3131
@message = T.let(nil, T.nilable(String))
3232
@order_id = T.let(nil, T.nilable(Integer))
33-
@province = T.let(nil, T.nilable(Province))
33+
@province = T.let(nil, T.nilable(String))
3434
@shop_id = T.let(nil, T.nilable(Integer))
3535
@status = T.let(nil, T.nilable(String))
3636
@updated_at = T.let(nil, T.nilable(String))
@@ -39,10 +39,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
3939
super(session: session, from_hash: from_hash)
4040
end
4141

42-
@has_one = T.let({
43-
country: Country,
44-
province: Province
45-
}, T::Hash[Symbol, Class])
42+
@has_one = T.let({}, T::Hash[Symbol, Class])
4643
@has_many = T.let({}, T::Hash[Symbol, Class])
4744
@paths = T.let([
4845
{http_method: :delete, operation: :delete, ids: [:order_id, :fulfillment_id, :id], path: "orders/<order_id>/fulfillments/<fulfillment_id>/events/<id>.json"},
@@ -55,7 +52,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
5552
attr_reader :address1
5653
sig { returns(T.nilable(String)) }
5754
attr_reader :city
58-
sig { returns(T.nilable(Country)) }
55+
sig { returns(T.nilable(String)) }
5956
attr_reader :country
6057
sig { returns(T.nilable(String)) }
6158
attr_reader :created_at
@@ -75,7 +72,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
7572
attr_reader :message
7673
sig { returns(T.nilable(Integer)) }
7774
attr_reader :order_id
78-
sig { returns(T.nilable(Province)) }
75+
sig { returns(T.nilable(String)) }
7976
attr_reader :province
8077
sig { returns(T.nilable(Integer)) }
8178
attr_reader :shop_id

‎lib/shopify_api/rest/resources/2022_07/inventory_item.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
2222
@country_code_of_origin = T.let(nil, T.nilable(String))
2323
@country_harmonized_system_codes = T.let(nil, T.nilable(T::Array[T.untyped]))
2424
@created_at = T.let(nil, T.nilable(String))
25-
@harmonized_system_code = T.let(nil, T.nilable(Integer))
25+
@harmonized_system_code = T.let(nil, T.nilable(T.any(Integer, String)))
2626
@id = T.let(nil, T.nilable(Integer))
2727
@province_code_of_origin = T.let(nil, T.nilable(String))
2828
@requires_shipping = T.let(nil, T.nilable(T::Boolean))
@@ -49,7 +49,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
4949
attr_reader :country_harmonized_system_codes
5050
sig { returns(T.nilable(String)) }
5151
attr_reader :created_at
52-
sig { returns(T.nilable(Integer)) }
52+
sig { returns(T.nilable(T.any(Integer, String))) }
5353
attr_reader :harmonized_system_code
5454
sig { returns(T.nilable(Integer)) }
5555
attr_reader :id

‎lib/shopify_api/rest/resources/2022_07/variant.rb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
2828
@inventory_item_id = T.let(nil, T.nilable(Integer))
2929
@inventory_management = T.let(nil, T.nilable(String))
3030
@inventory_policy = T.let(nil, T.nilable(String))
31-
@inventory_quantity = T.let(nil, T.nilable(Integer))
32-
@inventory_quantity_adjustment = T.let(nil, T.nilable(Integer))
33-
@old_inventory_quantity = T.let(nil, T.nilable(Integer))
31+
@inventory_quantity = T.let(nil, T.nilable(T.any(Integer, String)))
32+
@inventory_quantity_adjustment = T.let(nil, T.nilable(T.any(Integer, String)))
33+
@old_inventory_quantity = T.let(nil, T.nilable(T.any(Integer, String)))
3434
@option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
3535
@position = T.let(nil, T.nilable(Integer))
3636
@presentment_prices = T.let(nil, T.nilable(T::Array[T.untyped]))
@@ -83,11 +83,11 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
8383
attr_reader :inventory_management
8484
sig { returns(T.nilable(String)) }
8585
attr_reader :inventory_policy
86-
sig { returns(T.nilable(Integer)) }
86+
sig { returns(T.nilable(T.any(Integer, String))) }
8787
attr_reader :inventory_quantity
88-
sig { returns(T.nilable(Integer)) }
88+
sig { returns(T.nilable(T.any(Integer, String))) }
8989
attr_reader :inventory_quantity_adjustment
90-
sig { returns(T.nilable(Integer)) }
90+
sig { returns(T.nilable(T.any(Integer, String))) }
9191
attr_reader :old_inventory_quantity
9292
sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
9393
attr_reader :option

‎lib/shopify_api/rest/resources/2022_10/fulfillment_event.rb‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
2020

2121
@address1 = T.let(nil, T.nilable(String))
2222
@city = T.let(nil, T.nilable(String))
23-
@country = T.let(nil, T.nilable(Country))
23+
@country = T.let(nil, T.nilable(String))
2424
@created_at = T.let(nil, T.nilable(String))
2525
@estimated_delivery_at = T.let(nil, T.nilable(String))
2626
@fulfillment_id = T.let(nil, T.nilable(Integer))
@@ -30,7 +30,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
3030
@longitude = T.let(nil, T.nilable(Float))
3131
@message = T.let(nil, T.nilable(String))
3232
@order_id = T.let(nil, T.nilable(Integer))
33-
@province = T.let(nil, T.nilable(Province))
33+
@province = T.let(nil, T.nilable(String))
3434
@shop_id = T.let(nil, T.nilable(Integer))
3535
@status = T.let(nil, T.nilable(String))
3636
@updated_at = T.let(nil, T.nilable(String))
@@ -39,10 +39,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
3939
super(session: session, from_hash: from_hash)
4040
end
4141

42-
@has_one = T.let({
43-
country: Country,
44-
province: Province
45-
}, T::Hash[Symbol, Class])
42+
@has_one = T.let({}, T::Hash[Symbol, Class])
4643
@has_many = T.let({}, T::Hash[Symbol, Class])
4744
@paths = T.let([
4845
{http_method: :delete, operation: :delete, ids: [:order_id, :fulfillment_id, :id], path: "orders/<order_id>/fulfillments/<fulfillment_id>/events/<id>.json"},
@@ -55,7 +52,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
5552
attr_reader :address1
5653
sig { returns(T.nilable(String)) }
5754
attr_reader :city
58-
sig { returns(T.nilable(Country)) }
55+
sig { returns(T.nilable(String)) }
5956
attr_reader :country
6057
sig { returns(T.nilable(String)) }
6158
attr_reader :created_at
@@ -75,7 +72,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
7572
attr_reader :message
7673
sig { returns(T.nilable(Integer)) }
7774
attr_reader :order_id
78-
sig { returns(T.nilable(Province)) }
75+
sig { returns(T.nilable(String)) }
7976
attr_reader :province
8077
sig { returns(T.nilable(Integer)) }
8178
attr_reader :shop_id

‎lib/shopify_api/rest/resources/2022_10/inventory_item.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
2222
@country_code_of_origin = T.let(nil, T.nilable(String))
2323
@country_harmonized_system_codes = T.let(nil, T.nilable(T::Array[T.untyped]))
2424
@created_at = T.let(nil, T.nilable(String))
25-
@harmonized_system_code = T.let(nil, T.nilable(Integer))
25+
@harmonized_system_code = T.let(nil, T.nilable(T.any(Integer, String)))
2626
@id = T.let(nil, T.nilable(Integer))
2727
@province_code_of_origin = T.let(nil, T.nilable(String))
2828
@requires_shipping = T.let(nil, T.nilable(T::Boolean))
@@ -49,7 +49,7 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
4949
attr_reader :country_harmonized_system_codes
5050
sig { returns(T.nilable(String)) }
5151
attr_reader :created_at
52-
sig { returns(T.nilable(Integer)) }
52+
sig { returns(T.nilable(T.any(Integer, String))) }
5353
attr_reader :harmonized_system_code
5454
sig { returns(T.nilable(Integer)) }
5555
attr_reader :id

‎lib/shopify_api/rest/resources/2022_10/variant.rb‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
2828
@inventory_item_id = T.let(nil, T.nilable(Integer))
2929
@inventory_management = T.let(nil, T.nilable(String))
3030
@inventory_policy = T.let(nil, T.nilable(String))
31-
@inventory_quantity = T.let(nil, T.nilable(Integer))
32-
@old_inventory_quantity = T.let(nil, T.nilable(Integer))
31+
@inventory_quantity = T.let(nil, T.nilable(T.any(Integer, String)))
32+
@old_inventory_quantity = T.let(nil, T.nilable(T.any(Integer, String)))
3333
@option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
3434
@position = T.let(nil, T.nilable(Integer))
3535
@presentment_prices = T.let(nil, T.nilable(T::Array[T.untyped]))
@@ -81,9 +81,9 @@ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
8181
attr_reader :inventory_management
8282
sig { returns(T.nilable(String)) }
8383
attr_reader :inventory_policy
84-
sig { returns(T.nilable(Integer)) }
84+
sig { returns(T.nilable(T.any(Integer, String))) }
8585
attr_reader :inventory_quantity
86-
sig { returns(T.nilable(Integer)) }
86+
sig { returns(T.nilable(T.any(Integer, String))) }
8787
attr_reader :old_inventory_quantity
8888
sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
8989
attr_reader :option

0 commit comments

Comments
 (0)