Class: TogaiClient::Customer

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

Overview

Structure of customer

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'lib/togai_client/models/customer.rb', line 108

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#billing_address ⇒ Object

billing address of the customer



32
33
34
 
# File 'lib/togai_client/models/customer.rb', line 32

def billing_address
  @billing_address
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#id ⇒ Object

Identifier of customer



20
21
22
 
# File 'lib/togai_client/models/customer.rb', line 20

def id
  @id
end

#name ⇒ Object

Name of the Customer



26
27
28
 
# File 'lib/togai_client/models/customer.rb', line 26

def name
  @name
end

#primary_email ⇒ Object

Primary email of the customer



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

def primary_email
  @primary_email
end

#status ⇒ Object

Status of the customer



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

def status
  @status
end

#togai_customer_id ⇒ Object

Unique identifier of customer



23
24
25
 
# File 'lib/togai_client/models/customer.rb', line 23

def togai_customer_id
  @togai_customer_id
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
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



388
389
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
 
# File 'lib/togai_client/models/customer.rb', line 388

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



81
82
83
 
# File 'lib/togai_client/models/customer.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/togai_client/models/customer.rb', line 66

def self.attribute_map
  {
    :'id' => :'id',
    :'togai_customer_id' => :'togaiCustomerId',
    :'name' => :'name',
    :'primary_email' => :'primaryEmail',
    :'billing_address' => :'billingAddress',
    :'address' => :'address',
    :'status' => :'status',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt'
  }
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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/togai_client/models/customer.rb', line 364

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



101
102
103
104
 
# File 'lib/togai_client/models/customer.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/togai_client/models/customer.rb', line 86

def self.openapi_types
  {
    :'id' => :'String',
    :'togai_customer_id' => :'String',
    :'name' => :'String',
    :'primary_email' => :'String',
    :'billing_address' => :'String',
    :'address' => :'Address',
    :'status' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/togai_client/models/customer.rb', line 335

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      togai_customer_id == o.togai_customer_id &&
      name == o.name &&
      primary_email == o.primary_email &&
      billing_address == o.billing_address &&
      address == o.address &&
      status == o.status &&
      created_at == o.created_at &&
      updated_at == o.updated_at
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



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/togai_client/models/customer.rb', line 459

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


351
352
353
 
# File 'lib/togai_client/models/customer.rb', line 351

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



357
358
359
 
# File 'lib/togai_client/models/customer.rb', line 357

def hash
  [id, togai_customer_id, name, primary_email, billing_address, address, status, created_at, updated_at].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



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
 
# File 'lib/togai_client/models/customer.rb', line 178

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

  if @id.to_s.length > 50
    invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 50.')
  end

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

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

  if @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if @name.to_s.length < 3
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 3.')
  end

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

  if @primary_email.to_s.length > 320
    invalid_properties.push('invalid value for "primary_email", the character length must be smaller than or equal to 320.')
  end

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

  if @billing_address.to_s.length > 1000
    invalid_properties.push('invalid value for "billing_address", the character length must be smaller than or equal to 1000.')
  end

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

  if @status.nil?
    invalid_properties.push('invalid value for "status", status 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

  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



435
436
437
 
# File 'lib/togai_client/models/customer.rb', line 435

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/togai_client/models/customer.rb', line 441

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



429
430
431
 
# File 'lib/togai_client/models/customer.rb', line 429

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/togai_client/models/customer.rb', line 242

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @id.to_s.length > 50
  return false if @togai_customer_id.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @name.to_s.length < 3
  return false if @primary_email.nil?
  return false if @primary_email.to_s.length > 320
  return false if @billing_address.nil?
  return false if @billing_address.to_s.length > 1000
  return false if @address.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "ARCHIVED"])
  return false unless status_validator.valid?(@status)
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end