Class: DigitalFemsa::CustomerResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/digital_femsa/models/customer_response.rb

Overview

customer response

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



122
123
124
125
126
127
128
129
130
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
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/digital_femsa/models/customer_response.rb', line 122

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DigitalFemsa::CustomerResponse` 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 `DigitalFemsa::CustomerResponse`. 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?(:'antifraud_info')
    self.antifraud_info = attributes[:'antifraud_info']
  end

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

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end

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

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

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

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

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

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

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

  if attributes.key?(:'livemode')
    self.livemode = attributes[:'livemode']
  else
    self.livemode = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

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

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = nil
  end

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

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

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

Instance Attribute Details

#antifraud_info ⇒ Object

Returns the value of attribute antifraud_info.



19
20
21
 
# File 'lib/digital_femsa/models/customer_response.rb', line 19

def antifraud_info
  @antifraud_info
end

#corporate ⇒ Object

true if the customer is a company



22
23
24
 
# File 'lib/digital_femsa/models/customer_response.rb', line 22

def corporate
  @corporate
end

#created_at ⇒ Object

Creation date of the object



25
26
27
 
# File 'lib/digital_femsa/models/customer_response.rb', line 25

def created_at
  @created_at
end

#custom_reference ⇒ Object

Custom reference



28
29
30
 
# File 'lib/digital_femsa/models/customer_response.rb', line 28

def custom_reference
  @custom_reference
end

#default_fiscal_entity_id ⇒ Object

Returns the value of attribute default_fiscal_entity_id.



30
31
32
 
# File 'lib/digital_femsa/models/customer_response.rb', line 30

def default_fiscal_entity_id
  @default_fiscal_entity_id
end

#default_payment_source_id ⇒ Object

Returns the value of attribute default_payment_source_id.



34
35
36
 
# File 'lib/digital_femsa/models/customer_response.rb', line 34

def default_payment_source_id
  @default_payment_source_id
end

#default_shipping_contact_id ⇒ Object

Returns the value of attribute default_shipping_contact_id.



32
33
34
 
# File 'lib/digital_femsa/models/customer_response.rb', line 32

def default_shipping_contact_id
  @default_shipping_contact_id
end

#email ⇒ Object

Returns the value of attribute email.



36
37
38
 
# File 'lib/digital_femsa/models/customer_response.rb', line 36

def email
  @email
end

#fiscal_entities ⇒ Object

Returns the value of attribute fiscal_entities.



38
39
40
 
# File 'lib/digital_femsa/models/customer_response.rb', line 38

def fiscal_entities
  @fiscal_entities
end

#id ⇒ Object

Customer’s ID



41
42
43
 
# File 'lib/digital_femsa/models/customer_response.rb', line 41

def id
  @id
end

#livemode ⇒ Object

true if the object exists in live mode or the value false if the object exists in test mode



44
45
46
 
# File 'lib/digital_femsa/models/customer_response.rb', line 44

def livemode
  @livemode
end

#metadata ⇒ Object

Returns the value of attribute metadata.



49
50
51
 
# File 'lib/digital_femsa/models/customer_response.rb', line 49

def metadata
  @metadata
end

#name ⇒ Object

Customer’s name



47
48
49
 
# File 'lib/digital_femsa/models/customer_response.rb', line 47

def name
  @name
end

#object ⇒ Object

Returns the value of attribute object.



51
52
53
 
# File 'lib/digital_femsa/models/customer_response.rb', line 51

def object
  @object
end

#payment_sources ⇒ Object

Returns the value of attribute payment_sources.



53
54
55
 
# File 'lib/digital_femsa/models/customer_response.rb', line 53

def payment_sources
  @payment_sources
end

#phone ⇒ Object

Customer’s phone number



56
57
58
 
# File 'lib/digital_femsa/models/customer_response.rb', line 56

def phone
  @phone
end

#shipping_contacts ⇒ Object

Returns the value of attribute shipping_contacts.



58
59
60
 
# File 'lib/digital_femsa/models/customer_response.rb', line 58

def shipping_contacts
  @shipping_contacts
end

Class Method Details

._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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/digital_femsa/models/customer_response.rb', line 338

def self._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 = DigitalFemsa.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/digital_femsa/models/customer_response.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/digital_femsa/models/customer_response.rb', line 61

def self.attribute_map
  {
    :'antifraud_info' => :'antifraud_info',
    :'corporate' => :'corporate',
    :'created_at' => :'created_at',
    :'custom_reference' => :'custom_reference',
    :'default_fiscal_entity_id' => :'default_fiscal_entity_id',
    :'default_shipping_contact_id' => :'default_shipping_contact_id',
    :'default_payment_source_id' => :'default_payment_source_id',
    :'email' => :'email',
    :'fiscal_entities' => :'fiscal_entities',
    :'id' => :'id',
    :'livemode' => :'livemode',
    :'name' => :'name',
    :'metadata' => :'metadata',
    :'object' => :'object',
    :'payment_sources' => :'payment_sources',
    :'phone' => :'phone',
    :'shipping_contacts' => :'shipping_contacts'
  }
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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/digital_femsa/models/customer_response.rb', line 314

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
116
117
118
 
# File 'lib/digital_femsa/models/customer_response.rb', line 112

def self.openapi_nullable
  Set.new([
    :'antifraud_info',
    :'default_fiscal_entity_id',
    :'default_payment_source_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'antifraud_info' => :'CustomerAntifraudInfoResponse',
    :'corporate' => :'Boolean',
    :'created_at' => :'Integer',
    :'custom_reference' => :'String',
    :'default_fiscal_entity_id' => :'String',
    :'default_shipping_contact_id' => :'String',
    :'default_payment_source_id' => :'String',
    :'email' => :'String',
    :'fiscal_entities' => :'CustomerFiscalEntitiesResponse',
    :'id' => :'String',
    :'livemode' => :'Boolean',
    :'name' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'object' => :'String',
    :'payment_sources' => :'CustomerPaymentMethodsResponse',
    :'phone' => :'String',
    :'shipping_contacts' => :'CustomerResponseShippingContacts'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/digital_femsa/models/customer_response.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      antifraud_info == o.antifraud_info &&
      corporate == o.corporate &&
      created_at == o.created_at &&
      custom_reference == o.custom_reference &&
      default_fiscal_entity_id == o.default_fiscal_entity_id &&
      default_shipping_contact_id == o.default_shipping_contact_id &&
      default_payment_source_id == o.default_payment_source_id &&
      email == o.email &&
      fiscal_entities == o.fiscal_entities &&
      id == o.id &&
      livemode == o.livemode &&
      name == o.name &&
      metadata == o.metadata &&
      object == o.object &&
      payment_sources == o.payment_sources &&
      phone == o.phone &&
      shipping_contacts == o.shipping_contacts
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



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/digital_femsa/models/customer_response.rb', line 409

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


301
302
303
 
# File 'lib/digital_femsa/models/customer_response.rb', line 301

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



307
308
309
 
# File 'lib/digital_femsa/models/customer_response.rb', line 307

def hash
  [antifraud_info, corporate, created_at, custom_reference, default_fiscal_entity_id, default_shipping_contact_id, default_payment_source_id, email, fiscal_entities, id, livemode, name, metadata, object, payment_sources, phone, shipping_contacts].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



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
 
# File 'lib/digital_femsa/models/customer_response.rb', line 218

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

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

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

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

  if !@metadata.nil? && @metadata.length > 100
    invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 100.')
  end

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

  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



385
386
387
 
# File 'lib/digital_femsa/models/customer_response.rb', line 385

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/digital_femsa/models/customer_response.rb', line 391

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



379
380
381
 
# File 'lib/digital_femsa/models/customer_response.rb', line 379

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



250
251
252
253
254
255
256
257
258
259
 
# File 'lib/digital_femsa/models/customer_response.rb', line 250

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @created_at.nil?
  return false if @id.nil?
  return false if @livemode.nil?
  return false if @name.nil?
  return false if !@metadata.nil? && @metadata.length > 100
  return false if @object.nil?
  true
end