class Wallee::SubscriptionLedgerEntry

The subscription ledger entry represents a single change on the subscription balance.

Attributes

aggregated_tax_rate[RW]
amount_excluding_tax[RW]
amount_including_tax[RW]
created_by[RW]
created_on[RW]

The created on date indicates the date on which the entity was stored into the database.

discount_including_tax[RW]
external_id[RW]

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.

id[RW]

The ID is the primary key of the entity. The ID identifies the entity uniquely.

linked_space_id[RW]

The linked space id holds the ID of the space to which the entity belongs to.

planned_purge_date[RW]

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.

quantity[RW]
state[RW]
subscription_version[RW]
tax_amount[RW]
taxes[RW]
title[RW]
version[RW]

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 75
def self.attribute_map
  {
    :'aggregated_tax_rate' => :'aggregatedTaxRate',
    :'amount_excluding_tax' => :'amountExcludingTax',
    :'amount_including_tax' => :'amountIncludingTax',
    :'created_by' => :'createdBy',
    :'created_on' => :'createdOn',
    :'discount_including_tax' => :'discountIncludingTax',
    :'external_id' => :'externalId',
    :'id' => :'id',
    :'linked_space_id' => :'linkedSpaceId',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'quantity' => :'quantity',
    :'state' => :'state',
    :'subscription_version' => :'subscriptionVersion',
    :'tax_amount' => :'taxAmount',
    :'taxes' => :'taxes',
    :'title' => :'title',
    :'version' => :'version'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 122
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?(:'aggregatedTaxRate')
    self.aggregated_tax_rate = attributes[:'aggregatedTaxRate']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 98
def self.swagger_types
  {
    :'aggregated_tax_rate' => :'Float',
    :'amount_excluding_tax' => :'Float',
    :'amount_including_tax' => :'Float',
    :'created_by' => :'Integer',
    :'created_on' => :'DateTime',
    :'discount_including_tax' => :'Float',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'planned_purge_date' => :'DateTime',
    :'quantity' => :'Float',
    :'state' => :'SubscriptionLedgerEntryState',
    :'subscription_version' => :'Integer',
    :'tax_amount' => :'Float',
    :'taxes' => :'Array<Tax>',
    :'title' => :'String',
    :'version' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 238
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      aggregated_tax_rate == o.aggregated_tax_rate &&
      amount_excluding_tax == o.amount_excluding_tax &&
      amount_including_tax == o.amount_including_tax &&
      created_by == o.created_by &&
      created_on == o.created_on &&
      discount_including_tax == o.discount_including_tax &&
      external_id == o.external_id &&
      id == o.id &&
      linked_space_id == o.linked_space_id &&
      planned_purge_date == o.planned_purge_date &&
      quantity == o.quantity &&
      state == o.state &&
      subscription_version == o.subscription_version &&
      tax_amount == o.tax_amount &&
      taxes == o.taxes &&
      title == o.title &&
      version == o.version
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/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 296
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 = Wallee.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/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 362
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/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 275
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 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/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 262
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 268
def hash
  [aggregated_tax_rate, amount_excluding_tax, amount_including_tax, created_by, created_on, discount_including_tax, external_id, id, linked_space_id, planned_purge_date, quantity, state, subscription_version, tax_amount, taxes, title, version].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/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 201
def list_invalid_properties
  invalid_properties = Array.new
  if !@title.nil? && @title.to_s.length > 150
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 150.')
  end

  if !@title.nil? && @title.to_s.length < 1
    invalid_properties.push('invalid value for "title", the character length must be great than or equal to 1.')
  end

  invalid_properties
end
title=(title) click to toggle source

Custom attribute writer method with validation @param [Object] title Value to be assigned

# File lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 224
def title=(title)
  if !title.nil? && title.to_s.length > 150
    fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 150.'
  end

  if !title.nil? && title.to_s.length < 1
    fail ArgumentError, 'invalid value for "title", the character length must be great than or equal to 1.'
  end

  @title = title
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/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 342
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/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 348
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/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 336
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/wallee-ruby-sdk/models/subscription_ledger_entry.rb, line 216
def valid?
  return false if !@title.nil? && @title.to_s.length > 150
  return false if !@title.nil? && @title.to_s.length < 1
  true
end