Class: PureCloud::RoutePathResponse

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

Overview

Route path configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RoutePathResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
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
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 66

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

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

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

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

  
end

Instance Attribute Details

#languageObject

The ID of the language associated with the route path



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

def language
  @language
end

#media_typeObject

The media type of the given queue associated with the route path



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

def media_type
  @media_type
end

#queueObject

The ID of the queue associated with the route path



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

def queue
  @queue
end

#skillsObject

The set of skills associated with the route path



32
33
34
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 32

def skills
  @skills
end

Class Method Details

.attribute_mapObject

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



35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 35

def self.attribute_map
  {
    
    :'queue' => :'queue',
    
    :'media_type' => :'mediaType',
    
    :'language' => :'language',
    
    :'skills' => :'skills'
    
  }
end

.swagger_typesObject

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 50

def self.swagger_types
  {
    
    :'queue' => :'QueueReference',
    
    :'media_type' => :'String',
    
    :'language' => :'LanguageReference',
    
    :'skills' => :'Array<RoutingSkillReference>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



181
182
183
184
185
186
187
188
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      queue == o.queue &&
      media_type == o.media_type &&
      language == o.language &&
      skills == o.skills
end

#_deserialize(type, value) ⇒ Object



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 222

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



282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 282

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 203

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


192
193
194
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 192

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



198
199
200
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 198

def hash
  [queue, media_type, language, skills].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



115
116
117
118
119
120
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 115

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



265
266
267
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 265

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



270
271
272
273
274
275
276
277
278
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 270

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_sObject



260
261
262
# File 'lib/purecloudplatformclientv2/models/route_path_response.rb', line 260

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



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/purecloudplatformclientv2/models/route_path_response.rb', line 124

def valid?
  
  
  
  
  
  
  
  allowed_values = ["Voice", "Chat", "Email", "Callback", "Message"]
  if @media_type && !allowed_values.include?(@media_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end