Class: PureCloud::Geolocation

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/geolocation.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Geolocation

Returns a new instance of Geolocation.



94
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
144
145
146
147
 
# File 'lib/purecloud/models/geolocation.rb', line 94

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

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

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'primary']
    self.primary = attributes[:'primary']
  end
  
  if attributes[:'latitude']
    self.latitude = attributes[:'latitude']
  end
  
  if attributes[:'longitude']
    self.longitude = attributes[:'longitude']
  end
  
  if attributes[:'country']
    self.country = attributes[:'country']
  end
  
  if attributes[:'region']
    self.region = attributes[:'region']
  end
  
  if attributes[:'city']
    self.city = attributes[:'city']
  end
  
  if attributes[:'locations']
    if (value = attributes[:'locations']).is_a?(Array)
      self.locations = value
    end
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#city ⇒ Object

Returns the value of attribute city.



40
41
42
 
# File 'lib/purecloud/models/geolocation.rb', line 40

def city
  @city
end

#country ⇒ Object

Returns the value of attribute country.



36
37
38
 
# File 'lib/purecloud/models/geolocation.rb', line 36

def country
  @country
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloud/models/geolocation.rb', line 22

def id
  @id
end

#latitude ⇒ Object

Returns the value of attribute latitude.



32
33
34
 
# File 'lib/purecloud/models/geolocation.rb', line 32

def latitude
  @latitude
end

#locations ⇒ Object

Returns the value of attribute locations.



42
43
44
 
# File 'lib/purecloud/models/geolocation.rb', line 42

def locations
  @locations
end

#longitude ⇒ Object

Returns the value of attribute longitude.



34
35
36
 
# File 'lib/purecloud/models/geolocation.rb', line 34

def longitude
  @longitude
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloud/models/geolocation.rb', line 24

def name
  @name
end

#primary ⇒ Object

A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH



30
31
32
 
# File 'lib/purecloud/models/geolocation.rb', line 30

def primary
  @primary
end

#region ⇒ Object

Returns the value of attribute region.



38
39
40
 
# File 'lib/purecloud/models/geolocation.rb', line 38

def region
  @region
end

#self_uri ⇒ Object

The URI for this object



45
46
47
 
# File 'lib/purecloud/models/geolocation.rb', line 45

def self_uri
  @self_uri
end

#type ⇒ Object

A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc.



27
28
29
 
# File 'lib/purecloud/models/geolocation.rb', line 27

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/purecloud/models/geolocation.rb', line 48

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'type' => :'type',
    
    :'primary' => :'primary',
    
    :'latitude' => :'latitude',
    
    :'longitude' => :'longitude',
    
    :'country' => :'country',
    
    :'region' => :'region',
    
    :'city' => :'city',
    
    :'locations' => :'locations',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/purecloud/models/geolocation.rb', line 77

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'primary' => :'BOOLEAN',
    :'latitude' => :'Float',
    :'longitude' => :'Float',
    :'country' => :'String',
    :'region' => :'String',
    :'city' => :'String',
    :'locations' => :'Array<LocationDefinition>',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/purecloud/models/geolocation.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      type == o.type &&
      primary == o.primary &&
      latitude == o.latitude &&
      longitude == o.longitude &&
      country == o.country &&
      region == o.region &&
      city == o.city &&
      locations == o.locations &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/geolocation.rb', line 196

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



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/purecloud/models/geolocation.rb', line 256

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/purecloud/models/geolocation.rb', line 177

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

Returns:

  • (Boolean)

See Also:

  • `==` method


167
168
169
 
# File 'lib/purecloud/models/geolocation.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



172
173
174
 
# File 'lib/purecloud/models/geolocation.rb', line 172

def hash
  [id, name, type, primary, latitude, longitude, country, region, city, locations, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



239
240
241
 
# File 'lib/purecloud/models/geolocation.rb', line 239

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



244
245
246
247
248
249
250
251
252
 
# File 'lib/purecloud/models/geolocation.rb', line 244

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 



234
235
236
 
# File 'lib/purecloud/models/geolocation.rb', line 234

def to_s
  to_hash.to_s
end