Class: PureCloud::OutboundRoute

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OutboundRoute

Returns a new instance of OutboundRoute.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/purecloud/models/outbound_route.rb', line 130

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[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'version']
    self.version = attributes[:'version']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'modifiedBy']
    self.modified_by = attributes[:'modifiedBy']
  end
  
  if attributes[:'createdBy']
    self.created_by = attributes[:'createdBy']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'modifiedByApp']
    self.modified_by_app = attributes[:'modifiedByApp']
  end
  
  if attributes[:'createdByApp']
    self.created_by_app = attributes[:'createdByApp']
  end
  
  if attributes[:'site']
    self.site = attributes[:'site']
  end
  
  if attributes[:'classificationTypes']
    if (value = attributes[:'classificationTypes']).is_a?(Array)
      self.classification_types = value
    end
  end
  
  if attributes[:'enabled']
    self.enabled = attributes[:'enabled']
  else
    self.enabled = false
  end
  
  if attributes[:'distribution']
    self.distribution = attributes[:'distribution']
  end
  
  if attributes[:'managed']
    self.managed = attributes[:'managed']
  else
    self.managed = false
  end
  
  if attributes[:'externalTrunkBases']
    if (value = attributes[:'externalTrunkBases']).is_a?(Array)
      self.external_trunk_bases = value
    end
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#classification_types ⇒ Object

Returns the value of attribute classification_types.



48
49
50
 
# File 'lib/purecloud/models/outbound_route.rb', line 48

def classification_types
  @classification_types
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#created_by_app ⇒ Object

Returns the value of attribute created_by_app.



44
45
46
 
# File 'lib/purecloud/models/outbound_route.rb', line 44

def created_by_app
  @created_by_app
end

#date_created ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



31
32
33
 
# File 'lib/purecloud/models/outbound_route.rb', line 31

def date_created
  @date_created
end

#date_modified ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



26
27
28
 
# File 'lib/purecloud/models/outbound_route.rb', line 26

def description
  @description
end

#distribution ⇒ Object

Returns the value of attribute distribution.



52
53
54
 
# File 'lib/purecloud/models/outbound_route.rb', line 52

def distribution
  @distribution
end

#enabled ⇒ Object

Returns the value of attribute enabled.



50
51
52
 
# File 'lib/purecloud/models/outbound_route.rb', line 50

def enabled
  @enabled
end

#external_trunk_bases ⇒ Object

Trunk base settings of trunkType "EXTERNAL". This base must also be set on an edge logical interface for correct routing.



57
58
59
 
# File 'lib/purecloud/models/outbound_route.rb', line 57

def external_trunk_bases
  @external_trunk_bases
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#managed ⇒ Object

Returns the value of attribute managed.



54
55
56
 
# File 'lib/purecloud/models/outbound_route.rb', line 54

def managed
  @managed
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



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

def modified_by
  @modified_by
end

#modified_by_app ⇒ Object

Returns the value of attribute modified_by_app.



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

def modified_by_app
  @modified_by_app
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



60
61
62
 
# File 'lib/purecloud/models/outbound_route.rb', line 60

def self_uri
  @self_uri
end

#site ⇒ Object

Returns the value of attribute site.



46
47
48
 
# File 'lib/purecloud/models/outbound_route.rb', line 46

def site
  @site
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#version ⇒ Object

Returns the value of attribute version.



28
29
30
 
# File 'lib/purecloud/models/outbound_route.rb', line 28

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/purecloud/models/outbound_route.rb', line 63

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'version' => :'version',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'modified_by' => :'modifiedBy',
    
    :'created_by' => :'createdBy',
    
    :'state' => :'state',
    
    :'modified_by_app' => :'modifiedByApp',
    
    :'created_by_app' => :'createdByApp',
    
    :'site' => :'site',
    
    :'classification_types' => :'classificationTypes',
    
    :'enabled' => :'enabled',
    
    :'distribution' => :'distribution',
    
    :'managed' => :'managed',
    
    :'external_trunk_bases' => :'externalTrunkBases',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/purecloud/models/outbound_route.rb', line 106

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'version' => :'Integer',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'modified_by' => :'String',
    :'created_by' => :'String',
    :'state' => :'String',
    :'modified_by_app' => :'String',
    :'created_by_app' => :'String',
    :'site' => :'Site',
    :'classification_types' => :'Array<String>',
    :'enabled' => :'BOOLEAN',
    :'distribution' => :'String',
    :'managed' => :'BOOLEAN',
    :'external_trunk_bases' => :'Array<UriReference>',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/purecloud/models/outbound_route.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      version == o.version &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      modified_by == o.modified_by &&
      created_by == o.created_by &&
      state == o.state &&
      modified_by_app == o.modified_by_app &&
      created_by_app == o.created_by_app &&
      site == o.site &&
      classification_types == o.classification_types &&
      enabled == o.enabled &&
      distribution == o.distribution &&
      managed == o.managed &&
      external_trunk_bases == o.external_trunk_bases &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/purecloud/models/outbound_route.rb', line 291

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/purecloud/models/outbound_route.rb', line 351

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/purecloud/models/outbound_route.rb', line 272

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


262
263
264
 
# File 'lib/purecloud/models/outbound_route.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



267
268
269
 
# File 'lib/purecloud/models/outbound_route.rb', line 267

def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, site, classification_types, enabled, distribution, managed, external_trunk_bases, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



334
335
336
 
# File 'lib/purecloud/models/outbound_route.rb', line 334

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



339
340
341
342
343
344
345
346
347
 
# File 'lib/purecloud/models/outbound_route.rb', line 339

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 



329
330
331
 
# File 'lib/purecloud/models/outbound_route.rb', line 329

def to_s
  to_hash.to_s
end