Class: ShopifyAPI::Province
- Inherits:
-
Rest::Base
- Object
- Rest::Base
- ShopifyAPI::Province
- Extended by:
- T::Sig
- Defined in:
- lib/shopify_api/rest/resources/2021_07/province.rb,
lib/shopify_api/rest/resources/2021_10/province.rb,
lib/shopify_api/rest/resources/2022_01/province.rb,
lib/shopify_api/rest/resources/2022_04/province.rb
Instance Attribute Summary collapse
-
#code ⇒ Object
readonly
Returns the value of attribute code.
-
#country_id ⇒ Object
readonly
Returns the value of attribute country_id.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#shipping_zone_id ⇒ Object
readonly
Returns the value of attribute shipping_zone_id.
-
#tax ⇒ Object
readonly
Returns the value of attribute tax.
-
#tax_name ⇒ Object
readonly
Returns the value of attribute tax_name.
-
#tax_percentage ⇒ Object
readonly
Returns the value of attribute tax_percentage.
-
#tax_type ⇒ Object
readonly
Returns the value of attribute tax_type.
Attributes inherited from Rest::Base
Class Method Summary collapse
- .all(country_id: nil, since_id: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
- .count(country_id: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
- .find(id:, country_id: nil, fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object
Instance Method Summary collapse
-
#initialize(session: ShopifyAPI::Context.active_session) ⇒ Province
constructor
A new instance of Province.
Methods inherited from Rest::Base
base_find, class_name, create_instance, create_instances_from_response, #delete, get_path, has_many?, has_one?, json_body_name, #method_missing, next_page?, next_page_info, prev_page?, prev_page_info, primary_key, read_only_attributes, request, #respond_to_missing?, #save, #save!, #to_hash
Constructor Details
#initialize(session: ShopifyAPI::Context.active_session) ⇒ Province
Returns a new instance of Province.
12 13 14 15 16 17 18 19 20 21 22 23 24 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 12 def initialize(session: ShopifyAPI::Context.active_session) super(session: session) @code = T.let(nil, T.nilable(String)) @country_id = T.let(nil, T.nilable(Integer)) @id = T.let(nil, T.nilable(Integer)) @name = T.let(nil, T.nilable(String)) @shipping_zone_id = T.let(nil, T.nilable(Integer)) @tax = T.let(nil, T.nilable(Float)) @tax_name = T.let(nil, T.nilable(String)) @tax_percentage = T.let(nil, T.nilable(Float)) @tax_type = T.let(nil, T.nilable(String)) end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class ShopifyAPI::Rest::Base
Instance Attribute Details
#code ⇒ Object (readonly)
Returns the value of attribute code.
36 37 38 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 36 def code @code end |
#country_id ⇒ Object (readonly)
Returns the value of attribute country_id.
38 39 40 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 38 def country_id @country_id end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
40 41 42 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 40 def id @id end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
42 43 44 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 42 def name @name end |
#shipping_zone_id ⇒ Object (readonly)
Returns the value of attribute shipping_zone_id.
44 45 46 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 44 def shipping_zone_id @shipping_zone_id end |
#tax ⇒ Object (readonly)
Returns the value of attribute tax.
46 47 48 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 46 def tax @tax end |
#tax_name ⇒ Object (readonly)
Returns the value of attribute tax_name.
48 49 50 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 48 def tax_name @tax_name end |
#tax_percentage ⇒ Object (readonly)
Returns the value of attribute tax_percentage.
50 51 52 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 50 def tax_percentage @tax_percentage end |
#tax_type ⇒ Object (readonly)
Returns the value of attribute tax_type.
52 53 54 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 52 def tax_type @tax_type end |
Class Method Details
.all(country_id: nil, since_id: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 86 def all( country_id: nil, since_id: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs ) response = base_find( session: session, ids: {country_id: country_id}, params: {since_id: since_id, fields: fields}.merge(kwargs).compact, ) T.cast(response, T::Array[Province]) end |
.count(country_id: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 109 def count( country_id: nil, session: ShopifyAPI::Context.active_session, **kwargs ) request( http_method: :get, operation: :count, session: session, ids: {country_id: country_id}, params: {}.merge(kwargs).compact, body: {}, entity: nil, ) end |
.find(id:, country_id: nil, fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object
63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/shopify_api/rest/resources/2021_07/province.rb', line 63 def find( id:, country_id: nil, fields: nil, session: ShopifyAPI::Context.active_session ) result = base_find( session: session, ids: {id: id, country_id: country_id}, params: {fields: fields}, ) T.cast(result[0], T.nilable(Province)) end |