Class: PureCloud::Trunk

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Trunk

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#created_by ⇒ Object

Returns the value of attribute created_by.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 39

def created_by
  @created_by
end

#created_by_app ⇒ Object

Returns the value of attribute created_by_app.



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 45

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



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

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



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

def date_modified
  @date_modified
end

#description ⇒ Object

Returns the value of attribute description.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 27

def description
  @description
end

#edge ⇒ Object

The Edge using this trunk.



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 51

def edge
  @edge
end

#edge_group ⇒ Object

The edge group associated with this trunk.



60
61
62
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 60

def edge_group
  @edge_group
end

#enabled ⇒ Object

True if the Edge used by this trunk is in-service



66
67
68
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 66

def enabled
  @enabled
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#in_service ⇒ Object

True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base.



63
64
65
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 63

def in_service
  @in_service
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



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

def modified_by
  @modified_by
end

#modified_by_app ⇒ Object

Returns the value of attribute modified_by_app.



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 43

def modified_by_app
  @modified_by_app
end

#name ⇒ Object

The name of the entity.



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

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



69
70
71
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 69

def self_uri
  @self_uri
end

#state ⇒ Object

Returns the value of attribute state.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 41

def state
  @state
end

#trunk_base ⇒ Object

The trunk base configuration used on this trunk.



54
55
56
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 54

def trunk_base
  @trunk_base
end

#trunk_metabase ⇒ Object

The metabase used to create this trunk.



57
58
59
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 57

def trunk_metabase
  @trunk_metabase
end

#trunk_type ⇒ Object

The type of this trunk.



48
49
50
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 48

def trunk_type
  @trunk_type
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 72

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',
    :'trunk_type' => :'trunkType',
    :'edge' => :'edge',
    :'trunk_base' => :'trunkBase',
    :'trunk_metabase' => :'trunkMetabase',
    :'edge_group' => :'edgeGroup',
    :'in_service' => :'inService',
    :'enabled' => :'enabled',
    :'self_uri' => :'selfUri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 97

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',
    :'trunk_type' => :'String',
    :'edge' => :'UriReference',
    :'trunk_base' => :'UriReference',
    :'trunk_metabase' => :'UriReference',
    :'edge_group' => :'UriReference',
    :'in_service' => :'BOOLEAN',
    :'enabled' => :'BOOLEAN',
    :'self_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 253

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 &&
      trunk_type == o.trunk_type &&
      edge == o.edge &&
      trunk_base == o.trunk_base &&
      trunk_metabase == o.trunk_metabase &&
      edge_group == o.edge_group &&
      in_service == o.in_service &&
      enabled == o.enabled &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 309

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 369

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 290

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


279
280
281
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



285
286
287
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 285

def hash
  [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, trunk_type, edge, trunk_base, trunk_metabase, edge_group, in_service, enabled, 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



209
210
211
212
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 209

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



352
353
354
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 352

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



357
358
359
360
361
362
363
364
365
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 357

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 



347
348
349
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 347

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/purecloudplatformclientv2/models/trunk.rb', line 216

def valid?
  if @name.nil?
    return false
  end

  allowed_values = ["active", "inactive", "deleted"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  allowed_values = ["EXTERNAL", "PHONE", "EDGE"]
  if @trunk_type && !allowed_values.include?(@trunk_type)
    return false
  end
end