Class: SquareConnect::Customer

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/customer.rb

Overview

Represents one of a business’s customers, which can have one or more cards on file associated with it.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Customer

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/square_connect/models/customer.rb', line 136

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.has_key?(:'cards')
    if (value = attributes[:'cards']).is_a?(Array)
      self.cards = value
    end
  end

  if attributes.has_key?(:'given_name')
    self.given_name = attributes[:'given_name']
  end

  if attributes.has_key?(:'family_name')
    self.family_name = attributes[:'family_name']
  end

  if attributes.has_key?(:'nickname')
    self.nickname = attributes[:'nickname']
  end

  if attributes.has_key?(:'company_name')
    self.company_name = attributes[:'company_name']
  end

  if attributes.has_key?(:'email_address')
    self.email_address = attributes[:'email_address']
  end

  if attributes.has_key?(:'address')
    self.address = attributes[:'address']
  end

  if attributes.has_key?(:'phone_number')
    self.phone_number = attributes[:'phone_number']
  end

  if attributes.has_key?(:'birthday')
    self.birthday = attributes[:'birthday']
  end

  if attributes.has_key?(:'reference_id')
    self.reference_id = attributes[:'reference_id']
  end

  if attributes.has_key?(:'note')
    self.note = attributes[:'note']
  end

  if attributes.has_key?(:'preferences')
    self.preferences = attributes[:'preferences']
  end

  if attributes.has_key?(:'groups')
    if (value = attributes[:'groups']).is_a?(Array)
      self.groups = value
    end
  end

  if attributes.has_key?(:'creation_source')
    self.creation_source = attributes[:'creation_source']
  end

end

Instance Attribute Details

#address ⇒ Object

The customer’s physical address.



43
44
45
 
# File 'lib/square_connect/models/customer.rb', line 43

def address
  @address
end

#birthday ⇒ Object

The customer’s birthday in RFC-3339 format. Year is optional, timezone and times are not allowed. Example: ‘0000-09-01T00:00:00-00:00` for a birthday on September 1st. `1998-09-01T00:00:00-00:00` for a birthday on September 1st 1998.



49
50
51
 
# File 'lib/square_connect/models/customer.rb', line 49

def birthday
  @birthday
end

#cards ⇒ Object

The payment details of the customer’s cards on file.



25
26
27
 
# File 'lib/square_connect/models/customer.rb', line 25

def cards
  @cards
end

#company_name ⇒ Object

The name of the customer’s company.



37
38
39
 
# File 'lib/square_connect/models/customer.rb', line 37

def company_name
  @company_name
end

#created_at ⇒ Object

The time when the customer was created, in RFC 3339 format.



19
20
21
 
# File 'lib/square_connect/models/customer.rb', line 19

def created_at
  @created_at
end

#creation_source ⇒ Object

A creation source represents the method used to create the customer profile. See [CustomerCreationSource](#type-customercreationsource) for possible values



64
65
66
 
# File 'lib/square_connect/models/customer.rb', line 64

def creation_source
  @creation_source
end

#email_address ⇒ Object

The customer’s email address.



40
41
42
 
# File 'lib/square_connect/models/customer.rb', line 40

def email_address
  @email_address
end

#family_name ⇒ Object

The customer’s family (i.e., last) name.



31
32
33
 
# File 'lib/square_connect/models/customer.rb', line 31

def family_name
  @family_name
end

#given_name ⇒ Object

The customer’s given (i.e., first) name.



28
29
30
 
# File 'lib/square_connect/models/customer.rb', line 28

def given_name
  @given_name
end

#groups ⇒ Object

The groups the customer belongs to.



61
62
63
 
# File 'lib/square_connect/models/customer.rb', line 61

def groups
  @groups
end

#id ⇒ Object

The customer’s unique ID.



16
17
18
 
# File 'lib/square_connect/models/customer.rb', line 16

def id
  @id
end

#nickname ⇒ Object

The customer’s nickname.



34
35
36
 
# File 'lib/square_connect/models/customer.rb', line 34

def nickname
  @nickname
end

#note ⇒ Object

A note to associate with the customer.



55
56
57
 
# File 'lib/square_connect/models/customer.rb', line 55

def note
  @note
end

#phone_number ⇒ Object

The customer’s phone number.



46
47
48
 
# File 'lib/square_connect/models/customer.rb', line 46

def phone_number
  @phone_number
end

#preferences ⇒ Object

The customer’s preferences.



58
59
60
 
# File 'lib/square_connect/models/customer.rb', line 58

def preferences
  @preferences
end

#reference_id ⇒ Object

A second ID you can set to associate the customer with an entity in another system.



52
53
54
 
# File 'lib/square_connect/models/customer.rb', line 52

def reference_id
  @reference_id
end

#updated_at ⇒ Object

The time when the customer was last updated, in RFC 3339 format.



22
23
24
 
# File 'lib/square_connect/models/customer.rb', line 22

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/square_connect/models/customer.rb', line 89

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'cards' => :'cards',
    :'given_name' => :'given_name',
    :'family_name' => :'family_name',
    :'nickname' => :'nickname',
    :'company_name' => :'company_name',
    :'email_address' => :'email_address',
    :'address' => :'address',
    :'phone_number' => :'phone_number',
    :'birthday' => :'birthday',
    :'reference_id' => :'reference_id',
    :'note' => :'note',
    :'preferences' => :'preferences',
    :'groups' => :'groups',
    :'creation_source' => :'creation_source'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/square_connect/models/customer.rb', line 112

def self.swagger_types
  {
    :'id' => :'String',
    :'created_at' => :'String',
    :'updated_at' => :'String',
    :'cards' => :'Array<Card>',
    :'given_name' => :'String',
    :'family_name' => :'String',
    :'nickname' => :'String',
    :'company_name' => :'String',
    :'email_address' => :'String',
    :'address' => :'Address',
    :'phone_number' => :'String',
    :'birthday' => :'String',
    :'reference_id' => :'String',
    :'note' => :'String',
    :'preferences' => :'CustomerPreferences',
    :'groups' => :'Array<CustomerGroupInfo>',
    :'creation_source' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/square_connect/models/customer.rb', line 258

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      cards == o.cards &&
      given_name == o.given_name &&
      family_name == o.family_name &&
      nickname == o.nickname &&
      company_name == o.company_name &&
      email_address == o.email_address &&
      address == o.address &&
      phone_number == o.phone_number &&
      birthday == o.birthday &&
      reference_id == o.reference_id &&
      note == o.note &&
      preferences == o.preferences &&
      groups == o.groups &&
      creation_source == o.creation_source
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/square_connect/models/customer.rb', line 316

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = SquareConnect.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/square_connect/models/customer.rb', line 382

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/square_connect/models/customer.rb', line 295

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


282
283
284
 
# File 'lib/square_connect/models/customer.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



288
289
290
 
# File 'lib/square_connect/models/customer.rb', line 288

def hash
  [id, created_at, updated_at, cards, given_name, family_name, nickname, company_name, email_address, address, phone_number, birthday, reference_id, note, preferences, groups, creation_source].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/square_connect/models/customer.rb', line 218

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

  if @created_at.nil?
    invalid_properties.push("invalid value for 'created_at', created_at cannot be nil.")
  end

  if @updated_at.nil?
    invalid_properties.push("invalid value for 'updated_at', updated_at cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



362
363
364
 
# File 'lib/square_connect/models/customer.rb', line 362

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



368
369
370
371
372
373
374
375
376
 
# File 'lib/square_connect/models/customer.rb', line 368

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



356
357
358
 
# File 'lib/square_connect/models/customer.rb', line 356

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



237
238
239
240
241
242
243
244
 
# File 'lib/square_connect/models/customer.rb', line 237

def valid?
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  creation_source_validator = EnumAttributeValidator.new('String', ["OTHER", "APPOINTMENTS", "COUPON", "DELETION_RECOVERY", "DIRECTORY", "EGIFTING", "EMAIL_COLLECTION", "FEEDBACK", "IMPORT", "INVOICES", "LOYALTY", "MARKETING", "MERGE", "ONLINE_STORE", "INSTANT_PROFILE", "TERMINAL", "THIRD_PARTY", "THIRD_PARTY_IMPORT", "UNMERGE_RECOVERY"])
  return false unless creation_source_validator.valid?(@creation_source)
  return true
end