Class: PureCloud::VoiceRateExtended

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VoiceRateExtended

Returns a new instance of VoiceRateExtended.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 148

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[:'currency']
    self.currency = attributes[:'currency']
  end
  
  if attributes[:'amendmentId']
    self.amendment_id = attributes[:'amendmentId']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'effectiveDate']
    self.effective_date = attributes[:'effectiveDate']
  end
  
  if attributes[:'groupName']
    self.group_name = attributes[:'groupName']
  end
  
  if attributes[:'areaCode']
    self.area_code = attributes[:'areaCode']
  end
  
  if attributes[:'deletionMarker']
    self.deletion_marker = attributes[:'deletionMarker']
  else
    self.deletion_marker = false
  end
  
  if attributes[:'outboundRate']
    self.outbound_rate = attributes[:'outboundRate']
  end
  
  if attributes[:'outboundDurationMinimumSeconds']
    self.outbound_duration_minimum_seconds = attributes[:'outboundDurationMinimumSeconds']
  end
  
  if attributes[:'outboundDurationIncrementSeconds']
    self.outbound_duration_increment_seconds = attributes[:'outboundDurationIncrementSeconds']
  end
  
  if attributes[:'inboundTolledRate']
    self.inbound_tolled_rate = attributes[:'inboundTolledRate']
  end
  
  if attributes[:'inboundTolledDurationMinimumSeconds']
    self.inbound_tolled_duration_minimum_seconds = attributes[:'inboundTolledDurationMinimumSeconds']
  end
  
  if attributes[:'inboundTolledDurationIncrementSeconds']
    self.inbound_tolled_duration_increment_seconds = attributes[:'inboundTolledDurationIncrementSeconds']
  end
  
  if attributes[:'inboundTollFreeRate']
    self.inbound_toll_free_rate = attributes[:'inboundTollFreeRate']
  end
  
  if attributes[:'inboundTollFreeDurationMinimumSeconds']
    self.inbound_toll_free_duration_minimum_seconds = attributes[:'inboundTollFreeDurationMinimumSeconds']
  end
  
  if attributes[:'inboundTollFreeDurationIncrementSeconds']
    self.inbound_toll_free_duration_increment_seconds = attributes[:'inboundTollFreeDurationIncrementSeconds']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#amendment_id ⇒ Object

The amendment Id of the voice rate.



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

def amendment_id
  @amendment_id
end

#area_code ⇒ Object

The area code.



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

def area_code
  @area_code
end

#currency ⇒ Object

The ISO 4217 currency code of the voice rate.



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

def currency
  @currency
end

#deletion_marker ⇒ Object

The deletion marker.



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

def deletion_marker
  @deletion_marker
end

#effective_date ⇒ Object

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



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

def effective_date
  @effective_date
end

#group_name ⇒ Object

The group containing this area code.



39
40
41
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 39

def group_name
  @group_name
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#inbound_toll_free_duration_increment_seconds ⇒ Object

The billing duration increment in seconds.



72
73
74
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 72

def inbound_toll_free_duration_increment_seconds
  @inbound_toll_free_duration_increment_seconds
end

#inbound_toll_free_duration_minimum_seconds ⇒ Object

The minimum duration charged in seconds.



69
70
71
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 69

def inbound_toll_free_duration_minimum_seconds
  @inbound_toll_free_duration_minimum_seconds
end

#inbound_toll_free_rate ⇒ Object

The inbound toll-free rate.



66
67
68
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 66

def inbound_toll_free_rate
  @inbound_toll_free_rate
end

#inbound_tolled_duration_increment_seconds ⇒ Object

The billing duration increment in seconds.



63
64
65
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 63

def inbound_tolled_duration_increment_seconds
  @inbound_tolled_duration_increment_seconds
end

#inbound_tolled_duration_minimum_seconds ⇒ Object

The minimum duration charged in seconds.



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

def inbound_tolled_duration_minimum_seconds
  @inbound_tolled_duration_minimum_seconds
end

#inbound_tolled_rate ⇒ Object

The inbound tolled rate.



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

def inbound_tolled_rate
  @inbound_tolled_rate
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#outbound_duration_increment_seconds ⇒ Object

The billing duration increment in seconds.



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

def outbound_duration_increment_seconds
  @outbound_duration_increment_seconds
end

#outbound_duration_minimum_seconds ⇒ Object

The minimum duration charged in seconds.



51
52
53
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 51

def outbound_duration_minimum_seconds
  @outbound_duration_minimum_seconds
end

#outbound_rate ⇒ Object

The outbound extended rate.



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

def outbound_rate
  @outbound_rate
end

#self_uri ⇒ Object

The URI for this object



75
76
77
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 75

def self_uri
  @self_uri
end

#type ⇒ Object

The voice rate type.



33
34
35
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 33

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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
119
120
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 78

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'currency' => :'currency',
    
    :'amendment_id' => :'amendmentId',
    
    :'type' => :'type',
    
    :'effective_date' => :'effectiveDate',
    
    :'group_name' => :'groupName',
    
    :'area_code' => :'areaCode',
    
    :'deletion_marker' => :'deletionMarker',
    
    :'outbound_rate' => :'outboundRate',
    
    :'outbound_duration_minimum_seconds' => :'outboundDurationMinimumSeconds',
    
    :'outbound_duration_increment_seconds' => :'outboundDurationIncrementSeconds',
    
    :'inbound_tolled_rate' => :'inboundTolledRate',
    
    :'inbound_tolled_duration_minimum_seconds' => :'inboundTolledDurationMinimumSeconds',
    
    :'inbound_tolled_duration_increment_seconds' => :'inboundTolledDurationIncrementSeconds',
    
    :'inbound_toll_free_rate' => :'inboundTollFreeRate',
    
    :'inbound_toll_free_duration_minimum_seconds' => :'inboundTollFreeDurationMinimumSeconds',
    
    :'inbound_toll_free_duration_increment_seconds' => :'inboundTollFreeDurationIncrementSeconds',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 123

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'currency' => :'String',
    :'amendment_id' => :'String',
    :'type' => :'String',
    :'effective_date' => :'DateTime',
    :'group_name' => :'String',
    :'area_code' => :'String',
    :'deletion_marker' => :'BOOLEAN',
    :'outbound_rate' => :'Float',
    :'outbound_duration_minimum_seconds' => :'Integer',
    :'outbound_duration_increment_seconds' => :'Integer',
    :'inbound_tolled_rate' => :'Float',
    :'inbound_tolled_duration_minimum_seconds' => :'Integer',
    :'inbound_tolled_duration_increment_seconds' => :'Integer',
    :'inbound_toll_free_rate' => :'Float',
    :'inbound_toll_free_duration_minimum_seconds' => :'Integer',
    :'inbound_toll_free_duration_increment_seconds' => :'Integer',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 245

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      currency == o.currency &&
      amendment_id == o.amendment_id &&
      type == o.type &&
      effective_date == o.effective_date &&
      group_name == o.group_name &&
      area_code == o.area_code &&
      deletion_marker == o.deletion_marker &&
      outbound_rate == o.outbound_rate &&
      outbound_duration_minimum_seconds == o.outbound_duration_minimum_seconds &&
      outbound_duration_increment_seconds == o.outbound_duration_increment_seconds &&
      inbound_tolled_rate == o.inbound_tolled_rate &&
      inbound_tolled_duration_minimum_seconds == o.inbound_tolled_duration_minimum_seconds &&
      inbound_tolled_duration_increment_seconds == o.inbound_tolled_duration_increment_seconds &&
      inbound_toll_free_rate == o.inbound_toll_free_rate &&
      inbound_toll_free_duration_minimum_seconds == o.inbound_toll_free_duration_minimum_seconds &&
      inbound_toll_free_duration_increment_seconds == o.inbound_toll_free_duration_increment_seconds &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
328
329
330
331
332
333
334
335
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 299

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 359

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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 280

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


270
271
272
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



275
276
277
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 275

def hash
  [id, name, currency, amendment_id, type, effective_date, group_name, area_code, deletion_marker, outbound_rate, outbound_duration_minimum_seconds, outbound_duration_increment_seconds, inbound_tolled_rate, inbound_tolled_duration_minimum_seconds, inbound_tolled_duration_increment_seconds, inbound_toll_free_rate, inbound_toll_free_duration_minimum_seconds, inbound_toll_free_duration_increment_seconds, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



342
343
344
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 342

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



347
348
349
350
351
352
353
354
355
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 347

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 



337
338
339
 
# File 'lib/purecloud/models/voice_rate_extended.rb', line 337

def to_s
  to_hash.to_s
end