search

Shopify / shopify-api-ruby

ShopifyAPI is a lightweight gem for accessing the Shopify admin REST and GraphQL web services.
MIT License
1.06k stars 473 forks source link

Accessing the `taxes_included` property on a `ShopifyAPI::Shop` object returns a Sorbet TypeError #1170

Open raphaelfeitoza opened 1 year ago

raphaelfeitoza commented 1 year ago

Issue summary

Accessing the taxes_included property on a ShopifyAPI::Shop object returns a Sorbet TypeError due to a mismatch between the auto-generated type on the ShopifyAPI::Shop class and what gets returned in the body of the response

[12] pry(#<ShopRepository>)> shopify_shop.taxes_included
TypeError: Return value: Expected type T.nilable(String), got type FalseClass
Caller: (pry):10

Expected behavior

ShopifyAPI::Shop.all.first.taxes_included should return nillable boolean.

From the documentation: taxes_included: Whether applicable taxes are included in product prices. Valid values: true or null.

Actual behavior

ShopifyAPI::Shop.all.first.taxes_included returns a Sorbet type error: TypeError: Return value: Expected type T.nilable(String), got type FalseClass

Steps to reproduce the problem

  1. retrieve an Shop object through the auto-generated REST API resource class: shop = ShopifyAPI::Shop.all.first
  2. try to access the arguments property: shop.taxes_included