Class: MailSlurpClient::PhoneNumberDto

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/phone_number_dto.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PhoneNumberDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 95

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#compliance_address ⇒ Object

Returns the value of attribute compliance_address.



21
22
23
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 21

def compliance_address
  @compliance_address
end

#created_at ⇒ Object

Returns the value of attribute created_at.



31
32
33
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 31

def created_at
  @created_at
end

#emergency_address ⇒ Object

Returns the value of attribute emergency_address.



23
24
25
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 23

def emergency_address
  @emergency_address
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 17

def id
  @id
end

#phone_country ⇒ Object

Returns the value of attribute phone_country.



27
28
29
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 27

def phone_country
  @phone_country
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



25
26
27
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 25

def phone_number
  @phone_number
end

#phone_plan ⇒ Object

Returns the value of attribute phone_plan.



29
30
31
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 29

def phone_plan
  @phone_plan
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



33
34
35
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 33

def updated_at
  @updated_at
end

#user_id ⇒ Object

Returns the value of attribute user_id.



19
20
21
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 19

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 58

def self.attribute_map
  {
    :'id' => :'id',
    :'user_id' => :'userId',
    :'compliance_address' => :'complianceAddress',
    :'emergency_address' => :'emergencyAddress',
    :'phone_number' => :'phoneNumber',
    :'phone_country' => :'phoneCountry',
    :'phone_plan' => :'phonePlan',
    :'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



236
237
238
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 236

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 73

def self.openapi_types
  {
    :'id' => :'String',
    :'user_id' => :'String',
    :'compliance_address' => :'String',
    :'emergency_address' => :'String',
    :'phone_number' => :'String',
    :'phone_country' => :'String',
    :'phone_plan' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user_id == o.user_id &&
      compliance_address == o.compliance_address &&
      emergency_address == o.emergency_address &&
      phone_number == o.phone_number &&
      phone_country == o.phone_country &&
      phone_plan == o.phone_plan &&
      created_at == o.created_at &&
      updated_at == o.updated_at
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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 264

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
    MailSlurpClient.const_get(type).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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 333

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 243

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # 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


223
224
225
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



229
230
231
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 229

def hash
  [id, user_id, compliance_address, emergency_address, phone_number, phone_country, phone_plan, 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



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
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 147

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

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

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

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

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



309
310
311
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 309

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 315

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



303
304
305
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 303

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



182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/mailslurp_client/models/phone_number_dto.rb', line 182

def valid?
  return false if @id.nil?
  return false if @user_id.nil?
  return false if @phone_number.nil?
  return false if @phone_country.nil?
  phone_country_validator = EnumAttributeValidator.new('String', ["US", "GB", "AU"])
  return false unless phone_country_validator.valid?(@phone_country)
  return false if @phone_plan.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end