class Bfwd::SubscriptionCharge

Represents a monetary amount — or quantity consumed — attributed to some invoice or subscription.

Attributes

account_id[RW]

{"description":"ID of the account owning the subscription for which the charge was generated.","verbs":}

amount[RW]

{"description":"Monetary amount of the charge — including any tax applied to the final amount.","verbs":}

amount_excluding_tax[RW]

{"description":"Monetary amount of the charge — excluding any tax applied to the final amount.","verbs":}

calculation[RW]

{"default":"(Empty string)","description":"A human-readable explanation of how the value of the charge was calculated.","verbs":}

changed_by[RW]

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }

charge_type[RW]

{"default":"<span class=\"label label-default\">Debit</span>","description":"Whether this charge represents money given to or taken from the customer.
<span class=\"label label-default\">Credit</span> &mdash; This is a charge for money given to the customer.
<span class=\"label label-default\">Debit</span> &mdash; This is a charge for money taken from the customer.","verbs":}

created[RW]

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

crm_id[RW]

{"description":"Customer-relationship-management ID of the charge.","verbs":}

currency[RW]

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

description[RW]

{"description":"Description given to the charge.","verbs":}

id[RW]

{"description":"The ID of the charge.","verbs":}

invoice_id[RW]

{"description":"ID of the invoice to which this charge applies (if the charge targets a specific invoice).","verbs":}

invoicing_type[RW]

{"default":"<span class=\"label label-default\">Aggregated</span>","description":"The strategy for how this charge will raise invoices.
<span class=\"label label-default\">Immediate</span> &mdash; Generate straight-away an invoice containing this charge.
<span class=\"label label-default\">Aggregated</span> &mdash; Add this charge to the next invoice which is generated naturally &mdash; i.e. 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":"The time-ending of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.","verbs":}

period_start[RW]

{"default":"(Now)","description":"The time-beginning of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.","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":}

state[RW]

{"default":"<span class=\"label label-default\">Pending</span>","description":"The current state of the charge.","verbs":}

subscription_id[RW]

{"description":"ID of the subscription for which the charge was generated.","verbs":}

subscription_version_id[RW]

{"description":"Version ID of the subscription for which the charge was generated.","verbs":}

trial[RW]

{"default":"false","description":"(Applicable only if any of [`pricingComponentName`, `pricingComponentID`] are defined)
Whether the charge was created for a subscription whilst in a trial period.
<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":}

type[RW]

{"description":"A type describing the nature of the charge.","verbs":}

updated[RW]

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

version_id[RW]

{"description":"The version ID of the charge.","verbs":}

version_number[RW]

{"description":"The version number of the charge. The first version of a charge is version number 1.","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/subscription_charge.rb, line 116
def self.attribute_map
  {
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'updated' => :'updated',
    :'id' => :'id',
    :'crm_id' => :'crmID',
    :'account_id' => :'accountID',
    :'subscription_id' => :'subscriptionID',
    :'subscription_version_id' => :'subscriptionVersionID',
    :'invoice_id' => :'invoiceID',
    :'name' => :'name',
    :'description' => :'description',
    :'amount' => :'amount',
    :'amount_excluding_tax' => :'amountExcludingTax',
    :'currency' => :'currency',
    :'period_start' => :'periodStart',
    :'period_end' => :'periodEnd',
    :'type' => :'type',
    :'invoicing_type' => :'invoicingType',
    :'state' => :'state',
    :'charge_type' => :'chargeType',
    :'calculation' => :'calculation',
    :'remaining_credit_behaviour' => :'remainingCreditBehaviour',
    :'trial' => :'trial',
    :'version_id' => :'versionID',
    :'version_number' => :'versionNumber'
  }
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/subscription_charge.rb, line 179
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?(:'changedBy')
    self.changed_by = attributes[:'changedBy']
  end

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

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

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

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

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

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

  if attributes.has_key?(:'invoiceID')
    self.invoice_id = attributes[:'invoiceID']
  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?(:'amount')
    self.amount = attributes[:'amount']
  end

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

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  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?(:'type')
    self.type = attributes[:'type']
  end

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/bf_ruby2/models/subscription_charge.rb, line 147
def self.swagger_types
  {
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'updated' => :'DateTime',
    :'id' => :'String',
    :'crm_id' => :'String',
    :'account_id' => :'String',
    :'subscription_id' => :'String',
    :'subscription_version_id' => :'String',
    :'invoice_id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'amount' => :'Float',
    :'amount_excluding_tax' => :'Float',
    :'currency' => :'String',
    :'period_start' => :'DateTime',
    :'period_end' => :'DateTime',
    :'type' => :'String',
    :'invoicing_type' => :'String',
    :'state' => :'String',
    :'charge_type' => :'String',
    :'calculation' => :'String',
    :'remaining_credit_behaviour' => :'String',
    :'trial' => :'BOOLEAN',
    :'version_id' => :'String',
    :'version_number' => :'Integer'
  }
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/subscription_charge.rb, line 394
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      changed_by == o.changed_by &&
      updated == o.updated &&
      id == o.id &&
      crm_id == o.crm_id &&
      account_id == o.account_id &&
      subscription_id == o.subscription_id &&
      subscription_version_id == o.subscription_version_id &&
      invoice_id == o.invoice_id &&
      name == o.name &&
      description == o.description &&
      amount == o.amount &&
      amount_excluding_tax == o.amount_excluding_tax &&
      currency == o.currency &&
      period_start == o.period_start &&
      period_end == o.period_end &&
      type == o.type &&
      invoicing_type == o.invoicing_type &&
      state == o.state &&
      charge_type == o.charge_type &&
      calculation == o.calculation &&
      remaining_credit_behaviour == o.remaining_credit_behaviour &&
      trial == o.trial &&
      version_id == o.version_id &&
      version_number == o.version_number
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/subscription_charge.rb, line 460
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/subscription_charge.rb, line 526
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/subscription_charge.rb, line 439
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/subscription_charge.rb, line 374
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/subscription_charge.rb, line 426
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/subscription_charge.rb, line 432
def hash
  [created, changed_by, updated, id, crm_id, account_id, subscription_id, subscription_version_id, invoice_id, name, description, amount, amount_excluding_tax, currency, period_start, period_end, type, invoicing_type, state, charge_type, calculation, remaining_credit_behaviour, trial, version_id, version_number].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/subscription_charge.rb, line 354
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/subscription_charge.rb, line 291
def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push("invalid value for 'type', type cannot be nil.")
  end

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

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

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

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

  if @version_number.nil?
    invalid_properties.push("invalid value for 'version_number', version_number 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/subscription_charge.rb, line 384
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
state=(state) click to toggle source

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

# File lib/bf_ruby2/models/subscription_charge.rb, line 364
def state=(state)
  validator = EnumAttributeValidator.new('String', ["Voided", "Pending", "AwaitingPayment", "Paid", "Failed"])
  unless validator.valid?(state)
    fail ArgumentError, "invalid value for 'state', must be one of #{validator.allowable_values}."
  end
  @state = state
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/subscription_charge.rb, line 506
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/subscription_charge.rb, line 512
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/subscription_charge.rb, line 500
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

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

# File lib/bf_ruby2/models/subscription_charge.rb, line 344
def type=(type)
  validator = EnumAttributeValidator.new('String', ["Setup", "Upgrade", "Manual", "ProductRatePlanMigration", "Arrears", "Advance", "Coupon", "Usage", "PricingComponent"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
  end
  @type = type
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/subscription_charge.rb, line 322
def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["Setup", "Upgrade", "Manual", "ProductRatePlanMigration", "Arrears", "Advance", "Coupon", "Usage", "PricingComponent"])
  return false unless type_validator.valid?(@type)
  return false if @invoicing_type.nil?
  invoicing_type_validator = EnumAttributeValidator.new('String', ["Immediate", "Aggregated"])
  return false unless invoicing_type_validator.valid?(@invoicing_type)
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["Voided", "Pending", "AwaitingPayment", "Paid", "Failed"])
  return false unless state_validator.valid?(@state)
  return false if @charge_type.nil?
  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 false if @version_number.nil?
  return true
end