Class: PureCloud::PhoneNumber

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/phone_number.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PhoneNumber

Initializes the object

Parameters:

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

    Model attributes in the form of hash



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 59

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'display')
    self.display = attributes[:'display']
  end

  if attributes.has_key?(:'extension')
    self.extension = attributes[:'extension']
  end

  if attributes.has_key?(:'acceptsSMS')
    self.accepts_sms = attributes[:'acceptsSMS']
  end

  if attributes.has_key?(:'userInput')
    self.user_input = attributes[:'userInput']
  end

  if attributes.has_key?(:'e164')
    self.e164 = attributes[:'e164']
  end

  if attributes.has_key?(:'countryCode')
    self.country_code = attributes[:'countryCode']
  end

end

Instance Attribute Details

#accepts_sms ⇒ Object

Returns the value of attribute accepts_sms.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 25

def accepts_sms
  @accepts_sms
end

#country_code ⇒ Object

Returns the value of attribute country_code.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 31

def country_code
  @country_code
end

#display ⇒ Object

Returns the value of attribute display.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 21

def display
  @display
end

#e164 ⇒ Object

Returns the value of attribute e164.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 29

def e164
  @e164
end

#extension ⇒ Object

Returns the value of attribute extension.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 23

def extension
  @extension
end

#user_input ⇒ Object

Returns the value of attribute user_input.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 27

def user_input
  @user_input
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 34

def self.attribute_map
  {
    :'display' => :'display',
    :'extension' => :'extension',
    :'accepts_sms' => :'acceptsSMS',
    :'user_input' => :'userInput',
    :'e164' => :'e164',
    :'country_code' => :'countryCode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 46

def self.swagger_types
  {
    :'display' => :'String',
    :'extension' => :'Integer',
    :'accepts_sms' => :'BOOLEAN',
    :'user_input' => :'String',
    :'e164' => :'String',
    :'country_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 105

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      display == o.display &&
      extension == o.extension &&
      accepts_sms == o.accepts_sms &&
      user_input == o.user_input &&
      e164 == o.e164 &&
      country_code == o.country_code
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 148

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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 208

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

build the object from hash



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 129

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


118
119
120
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 118

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 124

def hash
  [display, extension, accepts_sms, user_input, e164, country_code].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



93
94
95
96
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 93

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



191
192
193
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 191

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



196
197
198
199
200
201
202
203
204
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 196

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



186
187
188
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 186

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



100
101
 
# File 'lib/purecloudplatformclientv2/models/phone_number.rb', line 100

def valid?
end