Refresh

This website rubydoc.info/gems/purecloudplatformclientv2/98.0.0/PureCloud/BillingUsageReport is currently offline. Cloudflare's Always Online™ shows a snapshot of this web page from the Internet Archive's Wayback Machine. To check for the live version, click Refresh.

Class: PureCloud::BillingUsageReport

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BillingUsageReport

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

  
end

Instance Attribute Details

#end_date ⇒ Object

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



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 30

def end_date
  @end_date
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 24

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#start_date ⇒ Object

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



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

def start_date
  @start_date
end

#status ⇒ Object

Generation status of report



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 33

def status
  @status
end

#usages ⇒ Object

The usages for the given period.



36
37
38
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 36

def usages
  @usages
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 42

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'start_date' => :'startDate',
    
    :'end_date' => :'endDate',
    
    :'status' => :'status',
    
    :'usages' => :'usages',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 63

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'start_date' => :'DateTime',
    
    :'end_date' => :'DateTime',
    
    :'status' => :'String',
    
    :'usages' => :'Array<BillingUsage>',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      status == o.status &&
      usages == o.usages &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
346
347
348
349
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 313

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 373

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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 294

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


283
284
285
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



289
290
291
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 289

def hash
  [id, name, start_date, end_date, status, usages, 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



161
162
163
164
165
166
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 161

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



356
357
358
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 356

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



361
362
363
364
365
366
367
368
369
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 361

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 



351
352
353
 
# File 'lib/purecloudplatformclientv2/models/billing_usage_report.rb', line 351

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



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

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

  
  
  
  
  
  if @end_date.nil?
    return false
  end

  
  
  
  
  
  
  allowed_values = ["InProgress", "Complete"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  if @usages.nil?
    return false
  end

  
  
  
  
  
  
  
  
end