Class: KoronaClient::Customer

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

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



133
134
135
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
215
216
217
218
 
# File 'lib/korona_client/models/customer.rb', line 133

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?(:'active')
    self.active = attributes[:'active']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

indicates whether the object is active for use or not



18
19
20
 
# File 'lib/korona_client/models/customer.rb', line 18

def active
  @active
end

#address ⇒ Object

Returns the value of attribute address.



29
30
31
 
# File 'lib/korona_client/models/customer.rb', line 29

def address
  @address
end

#birthday ⇒ Object

Returns the value of attribute birthday.



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

def birthday
  @birthday
end

#cards ⇒ Object

Returns the value of attribute cards.



33
34
35
 
# File 'lib/korona_client/models/customer.rb', line 33

def cards
  @cards
end

#company ⇒ Object

Returns the value of attribute company.



35
36
37
 
# File 'lib/korona_client/models/customer.rb', line 35

def company
  @company
end

#customer_group ⇒ Object

Returns the value of attribute customer_group.



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

def customer_group
  @customer_group
end

#economic_zone ⇒ Object

Returns the value of attribute economic_zone.



39
40
41
 
# File 'lib/korona_client/models/customer.rb', line 39

def economic_zone
  @economic_zone
end

#email ⇒ Object

Returns the value of attribute email.



41
42
43
 
# File 'lib/korona_client/models/customer.rb', line 41

def email
  @email
end

#firstname ⇒ Object

Returns the value of attribute firstname.



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

def firstname
  @firstname
end

#gender ⇒ Object

Returns the value of attribute gender.



45
46
47
 
# File 'lib/korona_client/models/customer.rb', line 45

def gender
  @gender
end

#id ⇒ Object

global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)



21
22
23
 
# File 'lib/korona_client/models/customer.rb', line 21

def id
  @id
end

#informations ⇒ Object

Returns the value of attribute informations.



47
48
49
 
# File 'lib/korona_client/models/customer.rb', line 47

def informations
  @informations
end

#lastname ⇒ Object

Returns the value of attribute lastname.



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

def lastname
  @lastname
end

#marketing_contact_permitted ⇒ Object

Returns the value of attribute marketing_contact_permitted.



57
58
59
 
# File 'lib/korona_client/models/customer.rb', line 57

def marketing_contact_permitted
  @marketing_contact_permitted
end

#number ⇒ Object

number of the object, like it is set in backoffice; will be removed when active=false



24
25
26
 
# File 'lib/korona_client/models/customer.rb', line 24

def number
  @number
end

#phone ⇒ Object

Returns the value of attribute phone.



51
52
53
 
# File 'lib/korona_client/models/customer.rb', line 51

def phone
  @phone
end

#privacy_policy_accepted ⇒ Object

Returns the value of attribute privacy_policy_accepted.



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

def privacy_policy_accepted
  @privacy_policy_accepted
end

#revision ⇒ Object

the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers.



27
28
29
 
# File 'lib/korona_client/models/customer.rb', line 27

def revision
  @revision
end

#tax_id ⇒ Object

Returns the value of attribute tax_id.



53
54
55
 
# File 'lib/korona_client/models/customer.rb', line 53

def tax_id
  @tax_id
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/korona_client/models/customer.rb', line 82

def self.attribute_map
  {
    :'active' => :'active',
    :'id' => :'id',
    :'number' => :'number',
    :'revision' => :'revision',
    :'address' => :'address',
    :'birthday' => :'birthday',
    :'cards' => :'cards',
    :'company' => :'company',
    :'customer_group' => :'customerGroup',
    :'economic_zone' => :'economicZone',
    :'email' => :'email',
    :'firstname' => :'firstname',
    :'gender' => :'gender',
    :'informations' => :'informations',
    :'lastname' => :'lastname',
    :'phone' => :'phone',
    :'tax_id' => :'taxId',
    :'privacy_policy_accepted' => :'privacyPolicyAccepted',
    :'marketing_contact_permitted' => :'marketingContactPermitted'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/korona_client/models/customer.rb', line 107

def self.swagger_types
  {
    :'active' => :'BOOLEAN',
    :'id' => :'String',
    :'number' => :'String',
    :'revision' => :'Integer',
    :'address' => :'AddressInformation',
    :'birthday' => :'DateTime',
    :'cards' => :'Array<CustomerCard>',
    :'company' => :'String',
    :'customer_group' => :'ModelReference',
    :'economic_zone' => :'ModelReference',
    :'email' => :'String',
    :'firstname' => :'String',
    :'gender' => :'String',
    :'informations' => :'Array<CustomerInformation>',
    :'lastname' => :'String',
    :'phone' => :'String',
    :'tax_id' => :'String',
    :'privacy_policy_accepted' => :'BOOLEAN',
    :'marketing_contact_permitted' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/korona_client/models/customer.rb', line 247

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      id == o.id &&
      number == o.number &&
      revision == o.revision &&
      address == o.address &&
      birthday == o.birthday &&
      cards == o.cards &&
      company == o.company &&
      customer_group == o.customer_group &&
      economic_zone == o.economic_zone &&
      email == o.email &&
      firstname == o.firstname &&
      gender == o.gender &&
      informations == o.informations &&
      lastname == o.lastname &&
      phone == o.phone &&
      tax_id == o.tax_id &&
      privacy_policy_accepted == o.privacy_policy_accepted &&
      marketing_contact_permitted == o.marketing_contact_permitted
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



307
308
309
310
311
312
313
314
315
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
 
# File 'lib/korona_client/models/customer.rb', line 307

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 = KoronaClient.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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/korona_client/models/customer.rb', line 373

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/korona_client/models/customer.rb', line 286

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


273
274
275
 
# File 'lib/korona_client/models/customer.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



279
280
281
 
# File 'lib/korona_client/models/customer.rb', line 279

def hash
  [active, id, number, revision, address, birthday, cards, company, customer_group, economic_zone, email, firstname, gender, informations, lastname, phone, tax_id, privacy_policy_accepted, marketing_contact_permitted].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



222
223
224
225
 
# File 'lib/korona_client/models/customer.rb', line 222

def list_invalid_properties
  invalid_properties = Array.new
  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



353
354
355
 
# File 'lib/korona_client/models/customer.rb', line 353

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



359
360
361
362
363
364
365
366
367
 
# File 'lib/korona_client/models/customer.rb', line 359

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



347
348
349
 
# File 'lib/korona_client/models/customer.rb', line 347

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



229
230
231
232
233
 
# File 'lib/korona_client/models/customer.rb', line 229

def valid?
  gender_validator = EnumAttributeValidator.new('String', ['MALE', 'FEMALE'])
  return false unless gender_validator.valid?(@gender)
  true
end