Class: MailSlurpClient::PhoneNumberProjection

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

Overview

Phone number projection

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PhoneNumberProjection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 104

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#carrier_name ⇒ Object

Returns the value of attribute carrier_name.



32
33
34
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 32

def carrier_name
  @carrier_name
end

#created_at ⇒ Object

Returns the value of attribute created_at.



26
27
28
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 26

def created_at
  @created_at
end

#id ⇒ Object

Returns the value of attribute id.



20
21
22
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 20

def id
  @id
end

#line_type ⇒ Object

Returns the value of attribute line_type.



30
31
32
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 30

def line_type
  @line_type
end

#mobile_country_code ⇒ Object

Returns the value of attribute mobile_country_code.



34
35
36
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 34

def mobile_country_code
  @mobile_country_code
end

#mobile_network_code ⇒ Object

Returns the value of attribute mobile_network_code.



36
37
38
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 36

def mobile_network_code
  @mobile_network_code
end

#name ⇒ Object

Returns the value of attribute name.



18
19
20
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 18

def name
  @name
end

#phone_country ⇒ Object

Returns the value of attribute phone_country.



24
25
26
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 24

def phone_country
  @phone_country
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



38
39
40
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 38

def phone_number
  @phone_number
end

#provider_label ⇒ Object

Returns the value of attribute provider_label.



28
29
30
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 28

def provider_label
  @provider_label
end

#user_id ⇒ Object

Returns the value of attribute user_id.



22
23
24
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 22

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 63

def self.attribute_map
  {
    :'name' => :'name',
    :'id' => :'id',
    :'user_id' => :'userId',
    :'phone_country' => :'phoneCountry',
    :'created_at' => :'createdAt',
    :'provider_label' => :'providerLabel',
    :'line_type' => :'lineType',
    :'carrier_name' => :'carrierName',
    :'mobile_country_code' => :'mobileCountryCode',
    :'mobile_network_code' => :'mobileNetworkCode',
    :'phone_number' => :'phoneNumber'
  }
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



245
246
247
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 245

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



97
98
99
100
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 80

def self.openapi_types
  {
    :'name' => :'String',
    :'id' => :'String',
    :'user_id' => :'String',
    :'phone_country' => :'String',
    :'created_at' => :'DateTime',
    :'provider_label' => :'String',
    :'line_type' => :'String',
    :'carrier_name' => :'String',
    :'mobile_country_code' => :'String',
    :'mobile_network_code' => :'String',
    :'phone_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      id == o.id &&
      user_id == o.user_id &&
      phone_country == o.phone_country &&
      created_at == o.created_at &&
      provider_label == o.provider_label &&
      line_type == o.line_type &&
      carrier_name == o.carrier_name &&
      mobile_country_code == o.mobile_country_code &&
      mobile_network_code == o.mobile_network_code &&
      phone_number == o.phone_number
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



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
300
301
302
303
304
305
306
307
308
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 273

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 342

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 252

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


232
233
234
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 232

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



238
239
240
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 238

def hash
  [name, id, user_id, phone_country, created_at, provider_label, line_type, carrier_name, mobile_country_code, mobile_network_code, phone_number].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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 164

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_country.nil?
    invalid_properties.push('invalid value for "phone_country", phone_country cannot be nil.')
  end

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

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



318
319
320
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 318

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 324

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



312
313
314
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 312

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



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/mailslurp_client/models/phone_number_projection.rb', line 191

def valid?
  return false if @id.nil?
  return false if @user_id.nil?
  return false if @phone_country.nil?
  phone_country_validator = EnumAttributeValidator.new('String', ["US", "GB", "AU", "CA", "EE", "HK", "PL", "PT", "NL", "IL", "FI", "SE"])
  return false unless phone_country_validator.valid?(@phone_country)
  return false if @created_at.nil?
  return false if @phone_number.nil?
  true
end