Class: Fastly::BillingTotal

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/billing_total.rb

Overview

Complete summary of the billing information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BillingTotal

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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::BillingTotal` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Fastly::BillingTotal`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'bandwidth')
    self.bandwidth = attributes[:'bandwidth']
  end

  if attributes.key?(:'bandwidth_cost')
    self.bandwidth_cost = attributes[:'bandwidth_cost']
  end

  if attributes.key?(:'bandwidth_units')
    self.bandwidth_units = attributes[:'bandwidth_units']
  end

  if attributes.key?(:'cost')
    self.cost = attributes[:'cost']
  end

  if attributes.key?(:'cost_before_discount')
    self.cost_before_discount = attributes[:'cost_before_discount']
  end

  if attributes.key?(:'discount')
    self.discount = attributes[:'discount']
  end

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

  if attributes.key?(:'extras_cost')
    self.extras_cost = attributes[:'extras_cost']
  end

  if attributes.key?(:'incurred_cost')
    self.incurred_cost = attributes[:'incurred_cost']
  end

  if attributes.key?(:'overage')
    self.overage = attributes[:'overage']
  end

  if attributes.key?(:'plan_code')
    self.plan_code = attributes[:'plan_code']
  end

  if attributes.key?(:'plan_minimum')
    self.plan_minimum = attributes[:'plan_minimum']
  end

  if attributes.key?(:'plan_name')
    self.plan_name = attributes[:'plan_name']
  end

  if attributes.key?(:'requests')
    self.requests = attributes[:'requests']
  end

  if attributes.key?(:'requests_cost')
    self.requests_cost = attributes[:'requests_cost']
  end

  if attributes.key?(:'terms')
    self.terms = attributes[:'terms']
  end
end

Instance Attribute Details

#bandwidth ⇒ Object

The total amount of bandwidth used this month (See bandwidth_units for measurement).



18
19
20
 
# File 'lib/fastly/models/billing_total.rb', line 18

def bandwidth
  @bandwidth
end

#bandwidth_cost ⇒ Object

The cost of the bandwidth used this month in USD.



21
22
23
 
# File 'lib/fastly/models/billing_total.rb', line 21

def bandwidth_cost
  @bandwidth_cost
end

#bandwidth_units ⇒ Object

Bandwidth measurement units based on billing plan.



24
25
26
 
# File 'lib/fastly/models/billing_total.rb', line 24

def bandwidth_units
  @bandwidth_units
end

#cost ⇒ Object

The final amount to be paid.



27
28
29
 
# File 'lib/fastly/models/billing_total.rb', line 27

def cost
  @cost
end

#cost_before_discount ⇒ Object

Total incurred cost plus extras cost.



30
31
32
 
# File 'lib/fastly/models/billing_total.rb', line 30

def cost_before_discount
  @cost_before_discount
end

#discount ⇒ Object

Calculated discount rate.



33
34
35
 
# File 'lib/fastly/models/billing_total.rb', line 33

def discount
  @discount
end

#extras ⇒ Object

A list of any extras for this invoice.



36
37
38
 
# File 'lib/fastly/models/billing_total.rb', line 36

def extras
  @extras
end

#extras_cost ⇒ Object

Total cost of all extras.



39
40
41
 
# File 'lib/fastly/models/billing_total.rb', line 39

def extras_cost
  @extras_cost
end

#incurred_cost ⇒ Object

The total cost of bandwidth and requests used this month.



42
43
44
 
# File 'lib/fastly/models/billing_total.rb', line 42

def incurred_cost
  @incurred_cost
end

#overage ⇒ Object

How much over the plan minimum has been incurred.



45
46
47
 
# File 'lib/fastly/models/billing_total.rb', line 45

def overage
  @overage
end

#plan_code ⇒ Object

The short code the plan this invoice was generated under.



48
49
50
 
# File 'lib/fastly/models/billing_total.rb', line 48

def plan_code
  @plan_code
end

#plan_minimum ⇒ Object

The minimum cost of this plan.



51
52
53
 
# File 'lib/fastly/models/billing_total.rb', line 51

def plan_minimum
  @plan_minimum
end

#plan_name ⇒ Object

The name of the plan this invoice was generated under.



54
55
56
 
# File 'lib/fastly/models/billing_total.rb', line 54

def plan_name
  @plan_name
end

#requests ⇒ Object

The total number of requests used this month.



57
58
59
 
# File 'lib/fastly/models/billing_total.rb', line 57

def requests
  @requests
end

#requests_cost ⇒ Object

The cost of the requests used this month.



60
61
62
 
# File 'lib/fastly/models/billing_total.rb', line 60

def requests_cost
  @requests_cost
end

#terms ⇒ Object

Payment terms. Almost always Net15.



63
64
65
 
# File 'lib/fastly/models/billing_total.rb', line 63

def terms
  @terms
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/fastly/models/billing_total.rb', line 88

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/fastly/models/billing_total.rb', line 66

def self.attribute_map
  {
    :'bandwidth' => :'bandwidth',
    :'bandwidth_cost' => :'bandwidth_cost',
    :'bandwidth_units' => :'bandwidth_units',
    :'cost' => :'cost',
    :'cost_before_discount' => :'cost_before_discount',
    :'discount' => :'discount',
    :'extras' => :'extras',
    :'extras_cost' => :'extras_cost',
    :'incurred_cost' => :'incurred_cost',
    :'overage' => :'overage',
    :'plan_code' => :'plan_code',
    :'plan_minimum' => :'plan_minimum',
    :'plan_name' => :'plan_name',
    :'requests' => :'requests',
    :'requests_cost' => :'requests_cost',
    :'terms' => :'terms'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



254
255
256
 
# File 'lib/fastly/models/billing_total.rb', line 254

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
119
 
# File 'lib/fastly/models/billing_total.rb', line 115

def self.fastly_nullable
  Set.new([
    :'bandwidth_units',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/fastly/models/billing_total.rb', line 93

def self.fastly_types
  {
    :'bandwidth' => :'Float',
    :'bandwidth_cost' => :'Float',
    :'bandwidth_units' => :'String',
    :'cost' => :'Float',
    :'cost_before_discount' => :'Float',
    :'discount' => :'Float',
    :'extras' => :'Array<BillingTotalExtras>',
    :'extras_cost' => :'Float',
    :'incurred_cost' => :'Float',
    :'overage' => :'Float',
    :'plan_code' => :'String',
    :'plan_minimum' => :'Float',
    :'plan_name' => :'String',
    :'requests' => :'Float',
    :'requests_cost' => :'Float',
    :'terms' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/fastly/models/billing_total.rb', line 218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bandwidth == o.bandwidth &&
      bandwidth_cost == o.bandwidth_cost &&
      bandwidth_units == o.bandwidth_units &&
      cost == o.cost &&
      cost_before_discount == o.cost_before_discount &&
      discount == o.discount &&
      extras == o.extras &&
      extras_cost == o.extras_cost &&
      incurred_cost == o.incurred_cost &&
      overage == o.overage &&
      plan_code == o.plan_code &&
      plan_minimum == o.plan_minimum &&
      plan_name == o.plan_name &&
      requests == o.requests &&
      requests_cost == o.requests_cost &&
      terms == o.terms
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/fastly/models/billing_total.rb', line 284

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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 =~ /\A(true|t|yes|y|1)\z/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
    # models (e.g. Pet) or oneOf
    klass = Fastly.const_get(type)
    klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/fastly/models/billing_total.rb', line 355

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/fastly/models/billing_total.rb', line 261

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/fastly/models/billing_total.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/fastly/models/billing_total.rb', line 247

def hash
  [bandwidth, bandwidth_cost, bandwidth_units, cost, cost_before_discount, discount, extras, extras_cost, incurred_cost, overage, plan_code, plan_minimum, plan_name, requests, requests_cost, terms].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



205
206
207
208
 
# File 'lib/fastly/models/billing_total.rb', line 205

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



331
332
333
 
# File 'lib/fastly/models/billing_total.rb', line 331

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/fastly/models/billing_total.rb', line 337

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



325
326
327
 
# File 'lib/fastly/models/billing_total.rb', line 325

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



212
213
214
 
# File 'lib/fastly/models/billing_total.rb', line 212

def valid?
  true
end