Class: ShopifyAPI::Shop

Inherits:
Rest::Base show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/rest/resources/2022_04/shop.rb,
lib/shopify_api/rest/resources/2022_07/shop.rb,
lib/shopify_api/rest/resources/2022_10/shop.rb,
lib/shopify_api/rest/resources/2023_01/shop.rb,
lib/shopify_api/rest/resources/2023_04/shop.rb,
lib/shopify_api/rest/resources/2023_07/shop.rb,
lib/shopify_api/rest/resources/2023_10/shop.rb,
lib/shopify_api/rest/resources/2024_01/shop.rb,
lib/shopify_api/rest/resources/2024_04/shop.rb,
lib/shopify_api/rest/resources/2024_07/shop.rb,
lib/shopify_api/rest/resources/2024_10/shop.rb

Instance Attribute Summary collapse

Attributes inherited from Rest::Base

#errors, #original_state

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Rest::Base

api_call_limit, base_find, class_name, create_instance, create_instances_from_response, #delete, get_path, get_path_ids, has_many?, has_one?, inherited, 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?, retry_request_after, #save, #save!, #to_hash

Constructor Details

#initialize(session: ShopifyAPI::Context.active_session, from_hash: nil) ⇒ Shop

Returns a new instance of Shop.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 19

def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)

  @address1 = T.let(nil, T.nilable(String))
  @address2 = T.let(nil, T.nilable(String))
  @checkout_api_supported = T.let(nil, T.nilable(T::Boolean))
  @city = T.let(nil, T.nilable(String))
  @cookie_consent_level = T.let(nil, T.nilable(String))
  @country = T.let(nil, T.nilable(String))
  @country_code = T.let(nil, T.nilable(String))
  @country_name = T.let(nil, T.nilable(String))
  @county_taxes = T.let(nil, T.nilable(T::Boolean))
  @created_at = T.let(nil, T.nilable(String))
  @currency = T.let(nil, T.nilable(String))
  @customer_email = T.let(nil, T.nilable(String))
  @domain = T.let(nil, T.nilable(String))
  @eligible_for_card_reader_giveaway = T.let(nil, T.nilable(T::Boolean))
  @eligible_for_payments = T.let(nil, T.nilable(T::Boolean))
  @email = T.let(nil, T.nilable(String))
  @enabled_presentment_currencies = T.let(nil, T.nilable(T::Array[T.untyped]))
  @finances = T.let(nil, T.nilable(T::Boolean))
  @force_ssl = T.let(nil, T.nilable(T::Boolean))
  @google_apps_domain = T.let(nil, T.nilable(String))
  @google_apps_login_enabled = T.let(nil, T.nilable(T::Boolean))
  @has_discounts = T.let(nil, T.nilable(T::Boolean))
  @has_gift_cards = T.let(nil, T.nilable(T::Boolean))
  @has_storefront = T.let(nil, T.nilable(T::Boolean))
  @iana_timezone = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @latitude = T.let(nil, T.nilable(Float))
  @longitude = T.let(nil, T.nilable(Float))
  @money_format = T.let(nil, T.nilable(String))
  @money_in_emails_format = T.let(nil, T.nilable(String))
  @money_with_currency_format = T.let(nil, T.nilable(String))
  @money_with_currency_in_emails_format = T.let(nil, T.nilable(String))
  @multi_location_enabled = T.let(nil, T.nilable(T::Boolean))
  @myshopify_domain = T.let(nil, T.nilable(String))
  @name = T.let(nil, T.nilable(String))
  @password_enabled = T.let(nil, T.nilable(T::Boolean))
  @phone = T.let(nil, T.nilable(String))
  @plan_display_name = T.let(nil, T.nilable(String))
  @plan_name = T.let(nil, T.nilable(String))
  @pre_launch_enabled = T.let(nil, T.nilable(T::Boolean))
  @primary_locale = T.let(nil, T.nilable(String))
  @primary_location_id = T.let(nil, T.nilable(Integer))
  @province = T.let(nil, T.nilable(String))
  @province_code = T.let(nil, T.nilable(String))
  @requires_extra_payments_agreement = T.let(nil, T.nilable(T::Boolean))
  @setup_required = T.let(nil, T.nilable(T::Boolean))
  @shop_owner = T.let(nil, T.nilable(String))
  @source = T.let(nil, T.nilable(String))
  @tax_shipping = T.let(nil, T.nilable(T::Boolean))
  @taxes_included = T.let(nil, T.nilable(T::Boolean))
  @timezone = T.let(nil, T.nilable(String))
  @transactional_sms_disabled = T.let(nil, T.nilable(T::Boolean))
  @updated_at = T.let(nil, T.nilable(String))
  @weight_unit = T.let(nil, T.nilable(String))
  @zip = T.let(nil, T.nilable(String))

  super(session: session, from_hash: from_hash)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ShopifyAPI::Rest::Base

Instance Attribute Details

#address1 ⇒ Object (readonly)

Returns the value of attribute address1.



87
88
89
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 87

def address1
  @address1
end

#address2 ⇒ Object (readonly)

Returns the value of attribute address2.



89
90
91
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 89

def address2
  @address2
end

#checkout_api_supported ⇒ Object (readonly)

Returns the value of attribute checkout_api_supported.



91
92
93
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 91

def checkout_api_supported
  @checkout_api_supported
end

#city ⇒ Object (readonly)

Returns the value of attribute city.



93
94
95
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 93

def city
  @city
end

#cookie_consent_level ⇒ Object (readonly)

Returns the value of attribute cookie_consent_level.



95
96
97
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 95

def cookie_consent_level
  @cookie_consent_level
end

#country ⇒ Object (readonly)

Returns the value of attribute country.



97
98
99
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 97

def country
  @country
end

#country_code ⇒ Object (readonly)

Returns the value of attribute country_code.



99
100
101
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 99

def country_code
  @country_code
end

#country_name ⇒ Object (readonly)

Returns the value of attribute country_name.



101
102
103
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 101

def country_name
  @country_name
end

#county_taxes ⇒ Object (readonly)

Returns the value of attribute county_taxes.



103
104
105
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 103

def county_taxes
  @county_taxes
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



105
106
107
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 105

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



107
108
109
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 107

def currency
  @currency
end

#customer_email ⇒ Object (readonly)

Returns the value of attribute customer_email.



109
110
111
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 109

def customer_email
  @customer_email
end

#domain ⇒ Object (readonly)

Returns the value of attribute domain.



111
112
113
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 111

def domain
  @domain
end

#eligible_for_card_reader_giveaway ⇒ Object (readonly)

Returns the value of attribute eligible_for_card_reader_giveaway.



113
114
115
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 113

def eligible_for_card_reader_giveaway
  @eligible_for_card_reader_giveaway
end

#eligible_for_payments ⇒ Object (readonly)

Returns the value of attribute eligible_for_payments.



115
116
117
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 115

def eligible_for_payments
  @eligible_for_payments
end

#email ⇒ Object (readonly)

Returns the value of attribute email.



117
118
119
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 117

def email
  @email
end

#enabled_presentment_currencies ⇒ Object (readonly)

Returns the value of attribute enabled_presentment_currencies.



119
120
121
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 119

def enabled_presentment_currencies
  @enabled_presentment_currencies
end

#finances ⇒ Object (readonly)

Returns the value of attribute finances.



121
122
123
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 121

def finances
  @finances
end

#force_ssl ⇒ Object (readonly)

Returns the value of attribute force_ssl.



123
124
125
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 123

def force_ssl
  @force_ssl
end

#google_apps_domain ⇒ Object (readonly)

Returns the value of attribute google_apps_domain.



125
126
127
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 125

def google_apps_domain
  @google_apps_domain
end

#google_apps_login_enabled ⇒ Object (readonly)

Returns the value of attribute google_apps_login_enabled.



127
128
129
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 127

def 
  @google_apps_login_enabled
end

#has_discounts ⇒ Object (readonly)

Returns the value of attribute has_discounts.



129
130
131
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 129

def has_discounts
  @has_discounts
end

#has_gift_cards ⇒ Object (readonly)

Returns the value of attribute has_gift_cards.



131
132
133
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 131

def has_gift_cards
  @has_gift_cards
end

#has_storefront ⇒ Object (readonly)

Returns the value of attribute has_storefront.



133
134
135
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 133

def has_storefront
  @has_storefront
end

#iana_timezone ⇒ Object (readonly)

Returns the value of attribute iana_timezone.



135
136
137
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 135

def iana_timezone
  @iana_timezone
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



137
138
139
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 137

def id
  @id
end

#latitude ⇒ Object (readonly)

Returns the value of attribute latitude.



139
140
141
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 139

def latitude
  @latitude
end

#longitude ⇒ Object (readonly)

Returns the value of attribute longitude.



141
142
143
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 141

def longitude
  @longitude
end

#marketing_sms_consent_enabled_at_checkout ⇒ Object (readonly)

Returns the value of attribute marketing_sms_consent_enabled_at_checkout.



141
142
143
 
# File 'lib/shopify_api/rest/resources/2022_10/shop.rb', line 141

def marketing_sms_consent_enabled_at_checkout
  @marketing_sms_consent_enabled_at_checkout
end

#money_format ⇒ Object (readonly)

Returns the value of attribute money_format.



143
144
145
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 143

def money_format
  @money_format
end

#money_in_emails_format ⇒ Object (readonly)

Returns the value of attribute money_in_emails_format.



145
146
147
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 145

def money_in_emails_format
  @money_in_emails_format
end

#money_with_currency_format ⇒ Object (readonly)

Returns the value of attribute money_with_currency_format.



147
148
149
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 147

def money_with_currency_format
  @money_with_currency_format
end

#money_with_currency_in_emails_format ⇒ Object (readonly)

Returns the value of attribute money_with_currency_in_emails_format.



149
150
151
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 149

def money_with_currency_in_emails_format
  @money_with_currency_in_emails_format
end

#multi_location_enabled ⇒ Object (readonly)

Returns the value of attribute multi_location_enabled.



151
152
153
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 151

def multi_location_enabled
  @multi_location_enabled
end

#myshopify_domain ⇒ Object (readonly)

Returns the value of attribute myshopify_domain.



153
154
155
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 153

def myshopify_domain
  @myshopify_domain
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



155
156
157
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 155

def name
  @name
end

#password_enabled ⇒ Object (readonly)

Returns the value of attribute password_enabled.



157
158
159
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 157

def password_enabled
  @password_enabled
end

#phone ⇒ Object (readonly)

Returns the value of attribute phone.



159
160
161
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 159

def phone
  @phone
end

#plan_display_name ⇒ Object (readonly)

Returns the value of attribute plan_display_name.



161
162
163
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 161

def plan_display_name
  @plan_display_name
end

#plan_name ⇒ Object (readonly)

Returns the value of attribute plan_name.



163
164
165
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 163

def plan_name
  @plan_name
end

#pre_launch_enabled ⇒ Object (readonly)

Returns the value of attribute pre_launch_enabled.



165
166
167
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 165

def pre_launch_enabled
  @pre_launch_enabled
end

#primary_locale ⇒ Object (readonly)

Returns the value of attribute primary_locale.



167
168
169
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 167

def primary_locale
  @primary_locale
end

#primary_location_id ⇒ Object (readonly)

Returns the value of attribute primary_location_id.



169
170
171
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 169

def primary_location_id
  @primary_location_id
end

#province ⇒ Object (readonly)

Returns the value of attribute province.



171
172
173
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 171

def province
  @province
end

#province_code ⇒ Object (readonly)

Returns the value of attribute province_code.



173
174
175
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 173

def province_code
  @province_code
end

#requires_extra_payments_agreement ⇒ Object (readonly)

Returns the value of attribute requires_extra_payments_agreement.



175
176
177
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 175

def requires_extra_payments_agreement
  @requires_extra_payments_agreement
end

#setup_required ⇒ Object (readonly)

Returns the value of attribute setup_required.



177
178
179
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 177

def setup_required
  @setup_required
end

#shop_owner ⇒ Object (readonly)

Returns the value of attribute shop_owner.



179
180
181
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 179

def shop_owner
  @shop_owner
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



181
182
183
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 181

def source
  @source
end

#tax_shipping ⇒ Object (readonly)

Returns the value of attribute tax_shipping.



183
184
185
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 183

def tax_shipping
  @tax_shipping
end

#taxes_included ⇒ Object (readonly)

Returns the value of attribute taxes_included.



185
186
187
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 185

def taxes_included
  @taxes_included
end

#timezone ⇒ Object (readonly)

Returns the value of attribute timezone.



187
188
189
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 187

def timezone
  @timezone
end

#transactional_sms_disabled ⇒ Object (readonly)

Returns the value of attribute transactional_sms_disabled.



189
190
191
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 189

def transactional_sms_disabled
  @transactional_sms_disabled
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



191
192
193
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 191

def updated_at
  @updated_at
end

#weight_unit ⇒ Object (readonly)

Returns the value of attribute weight_unit.



193
194
195
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 193

def weight_unit
  @weight_unit
end

#zip ⇒ Object (readonly)

Returns the value of attribute zip.



195
196
197
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 195

def zip
  @zip
end

Class Method Details

.all(fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 205

def all(
  fields: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {},
    params: {fields: fields}.merge(kwargs).compact,
  )

  T.cast(response, T::Array[Shop])
end

.current(fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object 



225
226
227
 
# File 'lib/shopify_api/rest/resources/2022_04/shop.rb', line 225

def current(fields: nil, session: ShopifyAPI::Context.active_session)
  all(session: session, fields: fields).first
end