class Fastly::BillingTotal

Complete summary of the billing information.

Attributes

bandwidth[RW]

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

bandwidth_cost[RW]

The cost of the bandwidth used this month in USD.

bandwidth_units[RW]

Bandwidth measurement units based on billing plan.

cost[RW]

The final amount to be paid.

cost_before_discount[RW]

Total incurred cost plus extras cost.

discount[RW]

Calculated discount rate.

extras[RW]

A list of any extras for this invoice.

extras_cost[RW]

Total cost of all extras.

incurred_cost[RW]

The total cost of bandwidth and requests used this month.

overage[RW]

How much over the plan minimum has been incurred.

plan_code[RW]

The short code the plan this invoice was generated under.

plan_minimum[RW]

The minimum cost of this plan.

plan_name[RW]

The name of the plan this invoice was generated under.

requests[RW]

The total number of requests used this month.

requests_cost[RW]

The cost of the requests used this month.

terms[RW]

Payment terms. Almost always Net15.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/fastly/models/billing_total.rb, line 88
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/fastly/models/billing_total.rb, line 254
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
fastly_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fastly/models/billing_total.rb, line 115
def self.fastly_nullable
  Set.new([
    :'bandwidth_units',
  ])
end
fastly_types() click to toggle source

Attribute type mapping.

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/fastly/models/billing_total.rb, line 241
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/fastly/models/billing_total.rb, line 205
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/fastly/models/billing_total.rb, line 331
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/fastly/models/billing_total.rb, line 325
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/fastly/models/billing_total.rb, line 212
def valid?
  true
end