class Bfwd::AddChargeRequest

Request object for raising a charge against a subscription or invoice.

Attributes

amount[RW]

{"description":"Monetary amount for which to charge. Used only for ad-hoc charges i.e charges not associated with any pricing component. Applicable if pricingComponent is NOT defined","verbs":}

charge_type[RW]

{"default":"<span class=\"label label-default\">Debit</span>","description":"Whether this charge represents an increase or decrease in invoice cost
<span class=\"label label-default\">Credit</span> &mdash; This results in a reduction to the invoice cost
<span class=\"label label-default\">Debit</span> &mdash; This will increase the invoice cost","verbs":}

created[RW]

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

currency[RW]

{ "description" : "Currency of the invoice specified by a three character ISO 4217 currency code.", "verbs":["GET"] }

description[RW]
dry_run[RW]

{"default":false,"description":"Changes described in the response:
<span class=\"label label-default\">true</span> &mdash; Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
<span class=\"label label-default\">false</span> &mdash; Are actually performed and committed.","verbs":}

id[RW]

{"description":"ID of an existing charge to add to the invoice ","verbs":}

invoicing_type[RW]

{"default":"<span class=\"label label-default\">Aggregated</span>","description":"Applicable if adding a charge to the subscription.
<span class=\"label label-default\">Immediate</span> &mdash; Generate straight-away an invoice containing these charges.
<span class=\"label label-default\">Aggregated</span> &mdash; Add these charges to the next invoice &mdash; for example the invoice raised at the current period's end.","verbs":}

name[RW]

{"description":"Friendly name given to the charge to help identify it.","verbs":}

period_end[RW]

{"default":"(End of current period)","description":"(Applicable only if `pricingComponent` is defined)
End of the interval to which the charge applies. Used in pro-rata calculation","verbs":}

period_start[RW]

{"default":"Now","description":"Start of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods. Pro-rating the price of pricingComponents purchased","verbs":}

pricing_component[RW]

{"description":"Specifies that this charge is for consumption of some quantity of this pricing component (whose name or ID can be provided).
If left blank:
The charge will be created as 'ad-hoc'. That is: a monetary lump sum, associated with no pricing component","verbs":}

pricing_component_value[RW]

{"description":"The value consumed of the pricing component which this charge concerns.Required if pricingComponent is defined","verbs":}

remaining_credit_behaviour[RW]

{"default":"<span class=\"label label-default\">Rollover</span>","description":"Defines the behaviour applied to any outstanding credit resulting from the application of the charge.
<span class=\"label label-default\">Rollover</span> &mdash; Outstanding credit is returned to the accounts credit pool.
<span class=\"label label-default\">Discard</span> &mdash; Outstanding credit is lost.","verbs":}

tax_amount[RW]

{"default":false,"description":"Applicable if amount is specified and indicates whether or not to apply tax in addition to the value specified.
<span class=\"label label-default\">true</span> &mdash; Tax will be added on top of the nominal price specified in amount &mdash; in accordance with any taxation strategies you have defined.
<span class=\"label label-default\">false</span> &mdash; No tax will be applied on top of the price specified in amount.","verbs":}

trial[RW]

{"default":"false","description":"Whether the charge is meant in the context of a trial.
<span class=\"label label-default\">false</span> &mdash; This is a non-trial charge, so funds will be sought from the customer.
<span class=\"label label-default\">true</span> &mdash; This is a trial charge, soThe charge can be considered 'Paid' without taking any funds from the customer.","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/add_charge_request.rb, line 89
def self.attribute_map
  {
    :'created' => :'created',
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'currency' => :'currency',
    :'amount' => :'amount',
    :'tax_amount' => :'taxAmount',
    :'period_start' => :'periodStart',
    :'period_end' => :'periodEnd',
    :'invoicing_type' => :'invoicingType',
    :'charge_type' => :'chargeType',
    :'trial' => :'trial',
    :'remaining_credit_behaviour' => :'remainingCreditBehaviour',
    :'pricing_component' => :'pricingComponent',
    :'pricing_component_value' => :'pricingComponentValue',
    :'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/add_charge_request.rb, line 134
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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'pricingComponentValue')
    self.pricing_component_value = attributes[:'pricingComponentValue']
  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/add_charge_request.rb, line 111
def self.swagger_types
  {
    :'created' => :'DateTime',
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'currency' => :'String',
    :'amount' => :'Float',
    :'tax_amount' => :'BOOLEAN',
    :'period_start' => :'DateTime',
    :'period_end' => :'DateTime',
    :'invoicing_type' => :'String',
    :'charge_type' => :'String',
    :'trial' => :'BOOLEAN',
    :'remaining_credit_behaviour' => :'String',
    :'pricing_component' => :'String',
    :'pricing_component_value' => :'Integer',
    :'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/add_charge_request.rb, line 268
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      currency == o.currency &&
      amount == o.amount &&
      tax_amount == o.tax_amount &&
      period_start == o.period_start &&
      period_end == o.period_end &&
      invoicing_type == o.invoicing_type &&
      charge_type == o.charge_type &&
      trial == o.trial &&
      remaining_credit_behaviour == o.remaining_credit_behaviour &&
      pricing_component == o.pricing_component &&
      pricing_component_value == o.pricing_component_value &&
      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/add_charge_request.rb, line 325
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/add_charge_request.rb, line 391
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/add_charge_request.rb, line 304
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
charge_type=(charge_type) click to toggle source

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

# File lib/bf_ruby2/models/add_charge_request.rb, line 248
def charge_type=(charge_type)
  validator = EnumAttributeValidator.new('String', ["Credit", "Debit"])
  unless validator.valid?(charge_type)
    fail ArgumentError, "invalid value for 'charge_type', must be one of #{validator.allowable_values}."
  end
  @charge_type = charge_type
end
eql?(o) click to toggle source

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

# File lib/bf_ruby2/models/add_charge_request.rb, line 291
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/add_charge_request.rb, line 297
def hash
  [created, id, name, description, currency, amount, tax_amount, period_start, period_end, invoicing_type, charge_type, trial, remaining_credit_behaviour, pricing_component, pricing_component_value, dry_run].hash
end
invoicing_type=(invoicing_type) click to toggle source

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

# File lib/bf_ruby2/models/add_charge_request.rb, line 238
def invoicing_type=(invoicing_type)
  validator = EnumAttributeValidator.new('String', ["Immediate", "Aggregated"])
  unless validator.valid?(invoicing_type)
    fail ArgumentError, "invalid value for 'invoicing_type', must be one of #{validator.allowable_values}."
  end
  @invoicing_type = invoicing_type
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/add_charge_request.rb, line 214
def list_invalid_properties
  invalid_properties = Array.new
  if @remaining_credit_behaviour.nil?
    invalid_properties.push("invalid value for 'remaining_credit_behaviour', remaining_credit_behaviour cannot be nil.")
  end

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

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

# File lib/bf_ruby2/models/add_charge_request.rb, line 258
def remaining_credit_behaviour=(remaining_credit_behaviour)
  validator = EnumAttributeValidator.new('String', ["Rollover", "Discard"])
  unless validator.valid?(remaining_credit_behaviour)
    fail ArgumentError, "invalid value for 'remaining_credit_behaviour', must be one of #{validator.allowable_values}."
  end
  @remaining_credit_behaviour = remaining_credit_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/add_charge_request.rb, line 371
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/add_charge_request.rb, line 377
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/add_charge_request.rb, line 365
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/add_charge_request.rb, line 225
def valid?
  invoicing_type_validator = EnumAttributeValidator.new('String', ["Immediate", "Aggregated"])
  return false unless invoicing_type_validator.valid?(@invoicing_type)
  charge_type_validator = EnumAttributeValidator.new('String', ["Credit", "Debit"])
  return false unless charge_type_validator.valid?(@charge_type)
  return false if @remaining_credit_behaviour.nil?
  remaining_credit_behaviour_validator = EnumAttributeValidator.new('String', ["Rollover", "Discard"])
  return false unless remaining_credit_behaviour_validator.valid?(@remaining_credit_behaviour)
  return true
end