Class: PureCloud::SubscriptionOverviewUsage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionOverviewUsage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



121
122
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
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
234
235
236
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 121

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#bundle_quantity ⇒ Object

Quantity multiplier for this charge



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 52

def bundle_quantity
  @bundle_quantity
end

#grouping ⇒ Object

UI grouping key



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

def grouping
  @grouping
end

#is_cancellable ⇒ Object

Indicates whether the item is cancellable



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 49

def is_cancellable
  @is_cancellable
end

#is_third_party ⇒ Object

A charge from a third party entity



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 55

def is_third_party
  @is_third_party
end

#name ⇒ Object

Product charge name



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

def name
  @name
end

#overage_price ⇒ Object

Price for usage / overage charge



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

def overage_price
  @overage_price
end

#part_number ⇒ Object

Product part number



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

def part_number
  @part_number
end

#prepay_price ⇒ Object

Price for prepay charge



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

def prepay_price
  @prepay_price
end

#prepay_quantity ⇒ Object

Items prepaid for specified period



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

def prepay_quantity
  @prepay_quantity
end

#unit_of_measure_type ⇒ Object

UI unit of measure



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 31

def unit_of_measure_type
  @unit_of_measure_type
end

#usage_notes ⇒ Object

Notes about the usage/charge item



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 46

def usage_notes
  @usage_notes
end

#usage_quantity ⇒ Object

Usage count for specified period



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 34

def usage_quantity
  @usage_quantity
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 58

def self.attribute_map
  {
    
    :'name' => :'name',
    
    :'part_number' => :'partNumber',
    
    :'grouping' => :'grouping',
    
    :'unit_of_measure_type' => :'unitOfMeasureType',
    
    :'usage_quantity' => :'usageQuantity',
    
    :'overage_price' => :'overagePrice',
    
    :'prepay_quantity' => :'prepayQuantity',
    
    :'prepay_price' => :'prepayPrice',
    
    :'usage_notes' => :'usageNotes',
    
    :'is_cancellable' => :'isCancellable',
    
    :'bundle_quantity' => :'bundleQuantity',
    
    :'is_third_party' => :'isThirdParty'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'name' => :'String',
    
    :'part_number' => :'String',
    
    :'grouping' => :'String',
    
    :'unit_of_measure_type' => :'String',
    
    :'usage_quantity' => :'String',
    
    :'overage_price' => :'String',
    
    :'prepay_quantity' => :'String',
    
    :'prepay_price' => :'String',
    
    :'usage_notes' => :'String',
    
    :'is_cancellable' => :'BOOLEAN',
    
    :'bundle_quantity' => :'String',
    
    :'is_third_party' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 394

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      part_number == o.part_number &&
      grouping == o.grouping &&
      unit_of_measure_type == o.unit_of_measure_type &&
      usage_quantity == o.usage_quantity &&
      overage_price == o.overage_price &&
      prepay_quantity == o.prepay_quantity &&
      prepay_price == o.prepay_price &&
      usage_notes == o.usage_notes &&
      is_cancellable == o.is_cancellable &&
      bundle_quantity == o.bundle_quantity &&
      is_third_party == o.is_third_party
end

#_deserialize(type, value) ⇒ Object 



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 443

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



503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 503

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



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 424

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


413
414
415
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 413

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



419
420
421
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 419

def hash
  [name, part_number, grouping, unit_of_measure_type, usage_quantity, overage_price, prepay_quantity, prepay_price, usage_notes, is_cancellable, bundle_quantity, is_third_party].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



240
241
242
243
244
245
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 240

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



486
487
488
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 486

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



491
492
493
494
495
496
497
498
499
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 491

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 



481
482
483
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 481

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
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
328
329
 
# File 'lib/purecloudplatformclientv2/models/subscription_overview_usage.rb', line 249

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

  
  
  
  
  
  if @part_number.nil?
    return false
  end

  
  
  
  
  
  if @grouping.nil?
    return false
  end

  
  
  
  
  
  if @unit_of_measure_type.nil?
    return false
  end

  
  
  
  
  
  if @usage_quantity.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  if @prepay_quantity.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end