Class: KoronaCloudClient::Customer

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-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



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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/korona-cloud-client/models/customer.rb', line 168

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `KoronaCloudClient::Customer` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `KoronaCloudClient::Customer`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'active')
    self.active = attributes[:'active']
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'external_id')
    self.external_id = attributes[:'external_id']
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'create_time')
    self.create_time = attributes[:'create_time']
  end

  if attributes.key?(:'last_receipt_time')
    self.last_receipt_time = attributes[:'last_receipt_time']
  end

  if attributes.key?(:'use_email_for_digital_receipt')
    self.use_email_for_digital_receipt = attributes[:'use_email_for_digital_receipt']
  end

  if attributes.key?(:'lock_delivery_note_sales')
    self.lock_delivery_note_sales = attributes[:'lock_delivery_note_sales']
  end
end

Instance Attribute Details

#active ⇒ Object

indicates whether the object is active for use or not



19
20
21
 
# File 'lib/korona-cloud-client/models/customer.rb', line 19

def active
  @active
end

#address ⇒ Object

Returns the value of attribute address.



30
31
32
 
# File 'lib/korona-cloud-client/models/customer.rb', line 30

def address
  @address
end

#birthday ⇒ Object

Format: yyyy-MM-dd’T’HH:mm:ssXXX



33
34
35
 
# File 'lib/korona-cloud-client/models/customer.rb', line 33

def birthday
  @birthday
end

#cards ⇒ Object

Returns the value of attribute cards.



35
36
37
 
# File 'lib/korona-cloud-client/models/customer.rb', line 35

def cards
  @cards
end

#company ⇒ Object

Returns the value of attribute company.



37
38
39
 
# File 'lib/korona-cloud-client/models/customer.rb', line 37

def company
  @company
end

#create_time ⇒ Object

Format: yyyy-MM-dd’T’HH:mm:ssXXX



64
65
66
 
# File 'lib/korona-cloud-client/models/customer.rb', line 64

def create_time
  @create_time
end

#customer_group ⇒ Object

Returns the value of attribute customer_group.



39
40
41
 
# File 'lib/korona-cloud-client/models/customer.rb', line 39

def customer_group
  @customer_group
end

#economic_zone ⇒ Object

Returns the value of attribute economic_zone.



41
42
43
 
# File 'lib/korona-cloud-client/models/customer.rb', line 41

def economic_zone
  @economic_zone
end

#email ⇒ Object

Returns the value of attribute email.



43
44
45
 
# File 'lib/korona-cloud-client/models/customer.rb', line 43

def email
  @email
end

#external_id ⇒ Object

Returns the value of attribute external_id.



45
46
47
 
# File 'lib/korona-cloud-client/models/customer.rb', line 45

def external_id
  @external_id
end

#firstname ⇒ Object

Returns the value of attribute firstname.



47
48
49
 
# File 'lib/korona-cloud-client/models/customer.rb', line 47

def firstname
  @firstname
end

#gender ⇒ Object

Returns the value of attribute gender.



49
50
51
 
# File 'lib/korona-cloud-client/models/customer.rb', line 49

def gender
  @gender
end

#id ⇒ Object

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



22
23
24
 
# File 'lib/korona-cloud-client/models/customer.rb', line 22

def id
  @id
end

#informations ⇒ Object

Returns the value of attribute informations.



51
52
53
 
# File 'lib/korona-cloud-client/models/customer.rb', line 51

def informations
  @informations
end

#last_receipt_time ⇒ Object

Format: yyyy-MM-dd’T’HH:mm:ssXXX



67
68
69
 
# File 'lib/korona-cloud-client/models/customer.rb', line 67

def last_receipt_time
  @last_receipt_time
end

#lastname ⇒ Object

Returns the value of attribute lastname.



53
54
55
 
# File 'lib/korona-cloud-client/models/customer.rb', line 53

def lastname
  @lastname
end

#lock_delivery_note_sales ⇒ Object

Returns the value of attribute lock_delivery_note_sales.



71
72
73
 
# File 'lib/korona-cloud-client/models/customer.rb', line 71

def lock_delivery_note_sales
  @lock_delivery_note_sales
end

#marketing_contact_permitted ⇒ Object

Returns the value of attribute marketing_contact_permitted.



61
62
63
 
# File 'lib/korona-cloud-client/models/customer.rb', line 61

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



28
29
30
 
# File 'lib/korona-cloud-client/models/customer.rb', line 28

def number
  @number
end

#phone ⇒ Object

Returns the value of attribute phone.



55
56
57
 
# File 'lib/korona-cloud-client/models/customer.rb', line 55

def phone
  @phone
end

#privacy_policy_accepted ⇒ Object

Returns the value of attribute privacy_policy_accepted.



59
60
61
 
# File 'lib/korona-cloud-client/models/customer.rb', line 59

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.



25
26
27
 
# File 'lib/korona-cloud-client/models/customer.rb', line 25

def revision
  @revision
end

#tax_id ⇒ Object

Returns the value of attribute tax_id.



57
58
59
 
# File 'lib/korona-cloud-client/models/customer.rb', line 57

def tax_id
  @tax_id
end

#use_email_for_digital_receipt ⇒ Object

Returns the value of attribute use_email_for_digital_receipt.



69
70
71
 
# File 'lib/korona-cloud-client/models/customer.rb', line 69

def use_email_for_digital_receipt
  @use_email_for_digital_receipt
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



126
127
128
 
# File 'lib/korona-cloud-client/models/customer.rb', line 126

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/korona-cloud-client/models/customer.rb', line 96

def self.attribute_map
  {
    :'active' => :'active',
    :'id' => :'id',
    :'revision' => :'revision',
    :'number' => :'number',
    :'address' => :'address',
    :'birthday' => :'birthday',
    :'cards' => :'cards',
    :'company' => :'company',
    :'customer_group' => :'customerGroup',
    :'economic_zone' => :'economicZone',
    :'email' => :'email',
    :'external_id' => :'externalId',
    :'firstname' => :'firstname',
    :'gender' => :'gender',
    :'informations' => :'informations',
    :'lastname' => :'lastname',
    :'phone' => :'phone',
    :'tax_id' => :'taxId',
    :'privacy_policy_accepted' => :'privacyPolicyAccepted',
    :'marketing_contact_permitted' => :'marketingContactPermitted',
    :'create_time' => :'createTime',
    :'last_receipt_time' => :'lastReceiptTime',
    :'use_email_for_digital_receipt' => :'useEmailForDigitalReceipt',
    :'lock_delivery_note_sales' => :'lockDeliveryNoteSales'
  }
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



359
360
361
 
# File 'lib/korona-cloud-client/models/customer.rb', line 359

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



161
162
163
164
 
# File 'lib/korona-cloud-client/models/customer.rb', line 161

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



131
132
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
 
# File 'lib/korona-cloud-client/models/customer.rb', line 131

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'id' => :'String',
    :'revision' => :'Integer',
    :'number' => :'String',
    :'address' => :'AddressInformation',
    :'birthday' => :'Time',
    :'cards' => :'Array<CustomerCard>',
    :'company' => :'String',
    :'customer_group' => :'ModelReference',
    :'economic_zone' => :'ModelReference',
    :'email' => :'String',
    :'external_id' => :'String',
    :'firstname' => :'String',
    :'gender' => :'String',
    :'informations' => :'Array<CustomerInformation>',
    :'lastname' => :'String',
    :'phone' => :'String',
    :'tax_id' => :'String',
    :'privacy_policy_accepted' => :'Boolean',
    :'marketing_contact_permitted' => :'Boolean',
    :'create_time' => :'Date',
    :'last_receipt_time' => :'Date',
    :'use_email_for_digital_receipt' => :'Boolean',
    :'lock_delivery_note_sales' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/korona-cloud-client/models/customer.rb', line 315

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      id == o.id &&
      revision == o.revision &&
      number == o.number &&
      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 &&
      external_id == o.external_id &&
      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 &&
      create_time == o.create_time &&
      last_receipt_time == o.last_receipt_time &&
      use_email_for_digital_receipt == o.use_email_for_digital_receipt &&
      lock_delivery_note_sales == o.lock_delivery_note_sales
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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/korona-cloud-client/models/customer.rb', line 390

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = KoronaCloudClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/korona-cloud-client/models/customer.rb', line 461

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/korona-cloud-client/models/customer.rb', line 366

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


346
347
348
 
# File 'lib/korona-cloud-client/models/customer.rb', line 346

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



352
353
354
 
# File 'lib/korona-cloud-client/models/customer.rb', line 352

def hash
  [active, id, revision, number, address, birthday, cards, company, customer_group, economic_zone, email, external_id, firstname, gender, informations, lastname, phone, tax_id, privacy_policy_accepted, marketing_contact_permitted, create_time, last_receipt_time, use_email_for_digital_receipt, lock_delivery_note_sales].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



284
285
286
287
 
# File 'lib/korona-cloud-client/models/customer.rb', line 284

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



437
438
439
 
# File 'lib/korona-cloud-client/models/customer.rb', line 437

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



443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/korona-cloud-client/models/customer.rb', line 443

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



431
432
433
 
# File 'lib/korona-cloud-client/models/customer.rb', line 431

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



291
292
293
294
295
 
# File 'lib/korona-cloud-client/models/customer.rb', line 291

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