Class: PureCloud::Address

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Address

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

end

Instance Attribute Details

#address_displayable ⇒ Object

The displayable address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 34

def address_displayable
  @address_displayable
end

#address_normalized ⇒ Object

The normalized address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 28

def address_normalized
  @address_normalized
end

#address_raw ⇒ Object

The address as close to the bits on the wire as possible.



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

def address_raw
  @address_raw
end

#name ⇒ Object

This will be nameRaw if present, or a locality lookup of the address field otherwise.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 22

def name
  @name
end

#name_raw ⇒ Object

The name as close to the bits on the wire as possible.



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

def name_raw
  @name_raw
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 37

def self.attribute_map
  {
    :'name' => :'name',
    :'name_raw' => :'nameRaw',
    :'address_normalized' => :'addressNormalized',
    :'address_raw' => :'addressRaw',
    :'address_displayable' => :'addressDisplayable'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 48

def self.swagger_types
  {
    :'name' => :'String',
    :'name_raw' => :'String',
    :'address_normalized' => :'String',
    :'address_raw' => :'String',
    :'address_displayable' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
109
110
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 102

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      name_raw == o.name_raw &&
      address_normalized == o.address_normalized &&
      address_raw == o.address_raw &&
      address_displayable == o.address_displayable
end

#_deserialize(type, value) ⇒ Object 



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

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



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 204

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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 125

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


114
115
116
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 114

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 120

def hash
  [name, name_raw, address_normalized, address_raw, address_displayable].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



90
91
92
93
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 90

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))



187
188
189
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 187

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



192
193
194
195
196
197
198
199
200
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 192

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 



182
183
184
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 182

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



97
98
 
# File 'lib/purecloudplatformclientv2/models/address.rb', line 97

def valid?
end