class Bfwd::InvoiceRecalculationRequest

Request object for recalculating an invoice.

Attributes

created[RW]

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }

dry_run[RW]

{"default":"false","description":"Calculate the invoice but do not store or attempt payment","verbs":}

new_state[RW]

{"default":"Pending","description":"State of the invoice once recalculated","verbs":}

only_invoice_associated_charges[RW]

{"default":true,"description":"Only include charges which are already associated with the invoice. For example the subscription may have pending charges which can be added to the invoice on recalculation by setting this value to false. Note settings this value to true may cause new invoice line itemsto the invoice","verbs":}

recalculation_behaviour[RW]

{"default":"RecalculateAsLatestSubscriptionVersion","description":"On plan change a subscription may have outstanding invoices.If the value of the invoice needs to be changed it can either be calculated via the new or old plan. <span class=\"label label-default\">RecalculateAsLatestSubscriptionVersion</span> calculates as the original plan and <span class=\"label label-default\">RecalculateAsCurrentSubscriptionVersion</span> as the new plan"verbs":}

Public Class Methods

attribute_map() click to toggle source

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

# File lib/bf_ruby2/models/invoice_recalculation_request.rb, line 56
def self.attribute_map
  {
    :'created' => :'created',
    :'recalculation_behaviour' => :'recalculationBehaviour',
    :'new_state' => :'newState',
    :'only_invoice_associated_charges' => :'onlyInvoiceAssociatedCharges',
    :'dry_run' => :'dryRun'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/bf_ruby2/models/invoice_recalculation_request.rb, line 79
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?(:'created')
    self.created = attributes[:'created']
  end

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

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

  if attributes.has_key?(:'onlyInvoiceAssociatedCharges')
    self.only_invoice_associated_charges = attributes[:'onlyInvoiceAssociatedCharges']
  else
    self.only_invoice_associated_charges = false
  end

  if attributes.has_key?(:'dryRun')
    self.dry_run = attributes[:'dryRun']
  else
    self.dry_run = false
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/bf_ruby2/models/invoice_recalculation_request.rb, line 67
def self.swagger_types
  {
    :'created' => :'DateTime',
    :'recalculation_behaviour' => :'String',
    :'new_state' => :'String',
    :'only_invoice_associated_charges' => :'BOOLEAN',
    :'dry_run' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/bf_ruby2/models/invoice_recalculation_request.rb, line 170
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      recalculation_behaviour == o.recalculation_behaviour &&
      new_state == o.new_state &&
      only_invoice_associated_charges == o.only_invoice_associated_charges &&
      dry_run == o.dry_run
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/bf_ruby2/models/invoice_recalculation_request.rb, line 216
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 =~ /\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
    temp_model = Bfwd.const_get(type).new
    temp_model.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/bf_ruby2/models/invoice_recalculation_request.rb, line 282
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/bf_ruby2/models/invoice_recalculation_request.rb, line 195
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/bf_ruby2/models/invoice_recalculation_request.rb, line 182
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/bf_ruby2/models/invoice_recalculation_request.rb, line 188
def hash
  [created, recalculation_behaviour, new_state, only_invoice_associated_charges, dry_run].hash
end
list_invalid_properties() click to toggle source

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

# File lib/bf_ruby2/models/invoice_recalculation_request.rb, line 113
def list_invalid_properties
  invalid_properties = Array.new
  if @recalculation_behaviour.nil?
    invalid_properties.push("invalid value for 'recalculation_behaviour', recalculation_behaviour cannot be nil.")
  end

  if @new_state.nil?
    invalid_properties.push("invalid value for 'new_state', new_state cannot be nil.")
  end

  if @only_invoice_associated_charges.nil?
    invalid_properties.push("invalid value for 'only_invoice_associated_charges', only_invoice_associated_charges cannot be nil.")
  end

  if @dry_run.nil?
    invalid_properties.push("invalid value for 'dry_run', dry_run cannot be nil.")
  end

  return invalid_properties
end
new_state=(new_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] new_state Object to be assigned

# File lib/bf_ruby2/models/invoice_recalculation_request.rb, line 160
def new_state=(new_state)
  validator = EnumAttributeValidator.new('String', ["Paid", "Unpaid", "Pending", "Voided"])
  unless validator.valid?(new_state)
    fail ArgumentError, "invalid value for 'new_state', must be one of #{validator.allowable_values}."
  end
  @new_state = new_state
end
recalculation_behaviour=(recalculation_behaviour) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] recalculation_behaviour Object to be assigned

# File lib/bf_ruby2/models/invoice_recalculation_request.rb, line 150
def recalculation_behaviour=(recalculation_behaviour)
  validator = EnumAttributeValidator.new('String', ["RecalculateAsLatestSubscriptionVersion", "RecalculateAsCurrentSubscriptionVersion"])
  unless validator.valid?(recalculation_behaviour)
    fail ArgumentError, "invalid value for 'recalculation_behaviour', must be one of #{validator.allowable_values}."
  end
  @recalculation_behaviour = recalculation_behaviour
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/bf_ruby2/models/invoice_recalculation_request.rb, line 262
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/bf_ruby2/models/invoice_recalculation_request.rb, line 268
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() click to toggle source

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

# File lib/bf_ruby2/models/invoice_recalculation_request.rb, line 256
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/bf_ruby2/models/invoice_recalculation_request.rb, line 136
def valid?
  return false if @recalculation_behaviour.nil?
  recalculation_behaviour_validator = EnumAttributeValidator.new('String', ["RecalculateAsLatestSubscriptionVersion", "RecalculateAsCurrentSubscriptionVersion"])
  return false unless recalculation_behaviour_validator.valid?(@recalculation_behaviour)
  return false if @new_state.nil?
  new_state_validator = EnumAttributeValidator.new('String', ["Paid", "Unpaid", "Pending", "Voided"])
  return false unless new_state_validator.valid?(@new_state)
  return false if @only_invoice_associated_charges.nil?
  return false if @dry_run.nil?
  return true
end