Class: PureCloud::LocationDefinition

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LocationDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 74

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

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

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

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

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

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

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

  if attributes.has_key?(:'path')
    if (value = attributes[:'path']).is_a?(Array)
      self.path = value
    end
  end

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

end

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 26

def address
  @address
end

#address_verified ⇒ Object

Returns the value of attribute address_verified.



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

def address_verified
  @address_verified
end

#emergency_number ⇒ Object

Returns the value of attribute emergency_number.



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 30

def emergency_number
  @emergency_number
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 24

def name
  @name
end

#path ⇒ Object

Returns the value of attribute path.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 37

def path
  @path
end

#self_uri ⇒ Object

The URI for this object



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 40

def self_uri
  @self_uri
end

#state ⇒ Object

Current activity status of the location.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 33

def state
  @state
end

#version ⇒ Object

Returns the value of attribute version.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 35

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'address' => :'address',
    :'address_verified' => :'addressVerified',
    :'emergency_number' => :'emergencyNumber',
    :'state' => :'state',
    :'version' => :'version',
    :'path' => :'path',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'address' => :'LocationAddress',
    :'address_verified' => :'BOOLEAN',
    :'emergency_number' => :'LocationEmergencyNumber',
    :'state' => :'String',
    :'version' => :'Integer',
    :'path' => :'Array<String>',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 148

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      address == o.address &&
      address_verified == o.address_verified &&
      emergency_number == o.emergency_number &&
      state == o.state &&
      version == o.version &&
      path == o.path &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



194
195
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
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 194

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 254

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 175

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


164
165
166
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



170
171
172
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 170

def hash
  [id, name, address, address_verified, emergency_number, state, version, path, self_uri].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



122
123
124
125
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 122

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



237
238
239
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 237

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



242
243
244
245
246
247
248
249
250
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 242

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 



232
233
234
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 232

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



129
130
131
132
133
134
 
# File 'lib/purecloudplatformclientv2/models/location_definition.rb', line 129

def valid?
  allowed_values = ["active", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
end