Class: ShopifyAPI::Country
- Inherits:
-
Rest::Base
- Object
- Rest::Base
- ShopifyAPI::Country
- Extended by:
- T::Sig
- Defined in:
- lib/shopify_api/rest/resources/2022_04/country.rb,
lib/shopify_api/rest/resources/2022_07/country.rb,
lib/shopify_api/rest/resources/2022_10/country.rb,
lib/shopify_api/rest/resources/2023_01/country.rb,
lib/shopify_api/rest/resources/2023_04/country.rb,
lib/shopify_api/rest/resources/2023_07/country.rb
Instance Attribute Summary collapse
-
#code ⇒ Object
readonly
Returns the value of attribute code.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#provinces ⇒ Object
readonly
Returns the value of attribute provinces.
-
#tax ⇒ Object
readonly
Returns the value of attribute tax.
Attributes inherited from Rest::Base
Class Method Summary collapse
- .all(since_id: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
- .count(session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
- .delete(id:, session: ShopifyAPI::Context.active_session) ⇒ Object
- .find(id:, fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object
Instance Method Summary collapse
-
#initialize(session: ShopifyAPI::Context.active_session) ⇒ Country
constructor
A new instance of Country.
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, json_response_body_names, #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) ⇒ Country
Returns a new instance of Country.
16 17 18 19 20 21 22 23 24 |
# File 'lib/shopify_api/rest/resources/2022_04/country.rb', line 16 def initialize(session: ShopifyAPI::Context.active_session) super(session: session) @code = T.let(nil, T.nilable(String)) @id = T.let(nil, T.nilable(Integer)) @name = T.let(nil, T.nilable(String)) @provinces = T.let(nil, T.nilable(T::Array[T.untyped])) @tax = T.let(nil, T.nilable(Float)) 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.
40 41 42 |
# File 'lib/shopify_api/rest/resources/2022_04/country.rb', line 40 def code @code end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
42 43 44 |
# File 'lib/shopify_api/rest/resources/2022_04/country.rb', line 42 def id @id end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
44 45 46 |
# File 'lib/shopify_api/rest/resources/2022_04/country.rb', line 44 def name @name end |
#provinces ⇒ Object (readonly)
Returns the value of attribute provinces.
46 47 48 |
# File 'lib/shopify_api/rest/resources/2022_04/country.rb', line 46 def provinces @provinces end |
#tax ⇒ Object (readonly)
Returns the value of attribute tax.
48 49 50 |
# File 'lib/shopify_api/rest/resources/2022_04/country.rb', line 48 def tax @tax end |
Class Method Details
.all(since_id: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/shopify_api/rest/resources/2022_04/country.rb', line 98 def all( since_id: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs ) response = base_find( session: session, ids: {}, params: {since_id: since_id, fields: fields}.merge(kwargs).compact, ) T.cast(response, T::Array[Country]) end |
.count(session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object
119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/shopify_api/rest/resources/2022_04/country.rb', line 119 def count( session: ShopifyAPI::Context.active_session, **kwargs ) request( http_method: :get, operation: :count, session: session, ids: {}, params: {}.merge(kwargs).compact, body: {}, entity: nil, ) end |
.delete(id:, session: ShopifyAPI::Context.active_session) ⇒ Object
77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/shopify_api/rest/resources/2022_04/country.rb', line 77 def delete( id:, session: ShopifyAPI::Context.active_session ) request( http_method: :delete, operation: :delete, session: session, ids: {id: id}, params: {}, ) end |
.find(id:, fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object
58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/shopify_api/rest/resources/2022_04/country.rb', line 58 def find( id:, fields: nil, session: ShopifyAPI::Context.active_session ) result = base_find( session: session, ids: {id: id}, params: {fields: fields}, ) T.cast(result[0], T.nilable(Country)) end |