Class: ShopifyAPI::Customer

Inherits:
Rest::Base show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/rest/resources/2022_04/customer.rb,
lib/shopify_api/rest/resources/2022_07/customer.rb,
lib/shopify_api/rest/resources/2022_10/customer.rb,
lib/shopify_api/rest/resources/2023_01/customer.rb,
lib/shopify_api/rest/resources/2023_04/customer.rb,
lib/shopify_api/rest/resources/2023_07/customer.rb,
lib/shopify_api/rest/resources/2023_10/customer.rb,
lib/shopify_api/rest/resources/2024_01/customer.rb,
lib/shopify_api/rest/resources/2024_04/customer.rb,
lib/shopify_api/rest/resources/2024_07/customer.rb,
lib/shopify_api/rest/resources/2024_10/customer.rb,
lib/shopify_api/rest/resources/2025_01/customer.rb,
lib/shopify_api/rest/resources/2025_04/customer.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) ⇒ Customer

Returns a new instance of Customer.



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
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 19

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

  @accepts_marketing = T.let(nil, T.nilable(T::Boolean))
  @accepts_marketing_updated_at = T.let(nil, T.nilable(String))
  @addresses = T.let(nil, T.nilable(T::Array[T.untyped]))
  @created_at = T.let(nil, T.nilable(String))
  @currency = T.let(nil, T.nilable(String))
  @default_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @email = T.let(nil, T.nilable(String))
  @email_marketing_consent = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @first_name = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @last_name = T.let(nil, T.nilable(String))
  @last_order_id = T.let(nil, T.nilable(Integer))
  @last_order_name = T.let(nil, T.nilable(String))
  @marketing_opt_in_level = T.let(nil, T.nilable(String))
  @metafield = T.let(nil, T.nilable(Metafield))
  @multipass_identifier = T.let(nil, T.nilable(String))
  @note = T.let(nil, T.nilable(String))
  @orders_count = T.let(nil, T.nilable(Integer))
  @password = T.let(nil, T.nilable(String))
  @password_confirmation = T.let(nil, T.nilable(String))
  @phone = T.let(nil, T.nilable(String))
  @sms_marketing_consent = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @state = T.let(nil, T.nilable(String))
  @tags = T.let(nil, T.nilable(String))
  @tax_exempt = T.let(nil, T.nilable(T::Boolean))
  @tax_exemptions = T.let(nil, T.nilable(T::Array[T.untyped]))
  @total_spent = T.let(nil, T.nilable(String))
  @updated_at = T.let(nil, T.nilable(String))
  @verified_email = T.let(nil, T.nilable(T::Boolean))

  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

#accepts_marketing ⇒ Object (readonly)

Returns the value of attribute accepts_marketing.



73
74
75
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 73

def accepts_marketing
  @accepts_marketing
end

#accepts_marketing_updated_at ⇒ Object (readonly)

Returns the value of attribute accepts_marketing_updated_at.



75
76
77
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 75

def accepts_marketing_updated_at
  @accepts_marketing_updated_at
end

#addresses ⇒ Object (readonly)

Returns the value of attribute addresses.



77
78
79
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 77

def addresses
  @addresses
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



79
80
81
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 79

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



81
82
83
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 81

def currency
  @currency
end

#default_address ⇒ Object (readonly)

Returns the value of attribute default_address.



83
84
85
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 83

def default_address
  @default_address
end

#email ⇒ Object (readonly)

Returns the value of attribute email.



85
86
87
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 85

def email
  @email
end

#email_marketing_consent ⇒ Object (readonly)

Returns the value of attribute email_marketing_consent.



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

def email_marketing_consent
  @email_marketing_consent
end

#first_name ⇒ Object (readonly)

Returns the value of attribute first_name.



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

def first_name
  @first_name
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#last_name ⇒ Object (readonly)

Returns the value of attribute last_name.



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

def last_name
  @last_name
end

#last_order_id ⇒ Object (readonly)

Returns the value of attribute last_order_id.



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

def last_order_id
  @last_order_id
end

#last_order_name ⇒ Object (readonly)

Returns the value of attribute last_order_name.



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

def last_order_name
  @last_order_name
end

#marketing_opt_in_level ⇒ Object (readonly)

Returns the value of attribute marketing_opt_in_level.



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

def marketing_opt_in_level
  @marketing_opt_in_level
end

#metafield ⇒ Object (readonly)

Returns the value of attribute metafield.



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

def metafield
  @metafield
end

#multipass_identifier ⇒ Object (readonly)

Returns the value of attribute multipass_identifier.



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

def multipass_identifier
  @multipass_identifier
end

#note ⇒ Object (readonly)

Returns the value of attribute note.



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

def note
  @note
end

#orders_count ⇒ Object (readonly)

Returns the value of attribute orders_count.



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

def orders_count
  @orders_count
end

#password ⇒ Object (readonly)

Returns the value of attribute password.



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

def password
  @password
end

#password_confirmation ⇒ Object (readonly)

Returns the value of attribute password_confirmation.



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

def password_confirmation
  @password_confirmation
end

#phone ⇒ Object (readonly)

Returns the value of attribute phone.



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

def phone
  @phone
end

#sms_marketing_consent ⇒ Object (readonly)

Returns the value of attribute sms_marketing_consent.



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

def sms_marketing_consent
  @sms_marketing_consent
end

#state ⇒ Object (readonly)

Returns the value of attribute state.



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

def state
  @state
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



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

def tags
  @tags
end

#tax_exempt ⇒ Object (readonly)

Returns the value of attribute tax_exempt.



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

def tax_exempt
  @tax_exempt
end

#tax_exemptions ⇒ Object (readonly)

Returns the value of attribute tax_exemptions.



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

def tax_exemptions
  @tax_exemptions
end

#total_spent ⇒ Object (readonly)

Returns the value of attribute total_spent.



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

def total_spent
  @total_spent
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#verified_email ⇒ Object (readonly)

Returns the value of attribute verified_email.



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

def verified_email
  @verified_email
end

Class Method Details

.all(ids: nil, since_id: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, limit: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 185

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

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

.count(created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 216

def count(
  created_at_min: nil,
  created_at_max: nil,
  updated_at_min: nil,
  updated_at_max: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :count,
    session: session,
    ids: {},
    params: {created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
end

.delete(id:, session: ShopifyAPI::Context.active_session) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 158

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 



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 139

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(Customer))
end

.orders(id:, status: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 243

def orders(
  id:,
  status: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :orders,
    session: session,
    ids: {id: id},
    params: {status: status}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
end

.search(order: nil, query: nil, limit: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 270

def search(
  order: nil,
  query: nil,
  limit: nil,
  fields: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :search,
    session: session,
    ids: {},
    params: {order: order, query: query, limit: limit, fields: fields}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
end

Instance Method Details

#account_activation_url(body: nil, **kwargs) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 297

def (
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :account_activation_url,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end

#send_invite(body: nil, **kwargs) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/shopify_api/rest/resources/2022_04/customer.rb', line 318

def send_invite(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :send_invite,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end