class UltracartClient::AffiliateLedger

Attributes

affiliate_click_oid[RW]

Unique object identifier for the click associated with this ledger entry

affiliate_oid[RW]

Affiliate object ID associated with this transaction

assigned_by_user[RW]

User that assigned the transaction if it was done manually

click[RW]
item_id[RW]

Item ID associated with this transaction

order[RW]
order_id[RW]

Order ID associated with this transaction

original_transaction_dts[RW]

Date/time of the original transaction for reversals

sub_id[RW]

Sub ID associated with transaction (from the click)

tier_number[RW]

Tier number that this transaction earned

transaction_amount[RW]

Transaction amount

transaction_amount_paid[RW]

Amount of the transaction that has been paid out.

transaction_dts[RW]

Date/time that the transaction was made

transaction_memo[RW]

Memo explaining the transaction

transaction_percentage[RW]

Percentage associated with this transaction

transaction_state[RW]

Transaction state

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/affiliate_ledger.rb, line 91
def self.attribute_map
  {
    :'affiliate_click_oid' => :'affiliate_click_oid',
    :'affiliate_link_oid' => :'affiliate_link_oid',
    :'affiliate_oid' => :'affiliate_oid',
    :'assigned_by_user' => :'assigned_by_user',
    :'click' => :'click',
    :'item_id' => :'item_id',
    :'link' => :'link',
    :'order' => :'order',
    :'order_id' => :'order_id',
    :'original_transaction_dts' => :'original_transaction_dts',
    :'sub_id' => :'sub_id',
    :'tier_number' => :'tier_number',
    :'transaction_amount' => :'transaction_amount',
    :'transaction_amount_paid' => :'transaction_amount_paid',
    :'transaction_dts' => :'transaction_dts',
    :'transaction_memo' => :'transaction_memo',
    :'transaction_percentage' => :'transaction_percentage',
    :'transaction_state' => :'transaction_state'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/ultracart_api/models/affiliate_ledger.rb, line 140
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?(:'affiliate_click_oid')
    self.affiliate_click_oid = attributes[:'affiliate_click_oid']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/affiliate_ledger.rb, line 115
def self.swagger_types
  {
    :'affiliate_click_oid' => :'Integer',
    :'affiliate_link_oid' => :'Integer',
    :'affiliate_oid' => :'Integer',
    :'assigned_by_user' => :'String',
    :'click' => :'AffiliateClick',
    :'item_id' => :'String',
    :'link' => :'AffiliateLink',
    :'order' => :'Order',
    :'order_id' => :'String',
    :'original_transaction_dts' => :'String',
    :'sub_id' => :'String',
    :'tier_number' => :'String',
    :'transaction_amount' => :'Float',
    :'transaction_amount_paid' => :'Float',
    :'transaction_dts' => :'String',
    :'transaction_memo' => :'String',
    :'transaction_percentage' => :'String',
    :'transaction_state' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ultracart_api/models/affiliate_ledger.rb, line 246
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      affiliate_click_oid == o.affiliate_click_oid &&
      affiliate_link_oid == o.affiliate_link_oid &&
      affiliate_oid == o.affiliate_oid &&
      assigned_by_user == o.assigned_by_user &&
      click == o.click &&
      item_id == o.item_id &&
      link == o.link &&
      order == o.order &&
      order_id == o.order_id &&
      original_transaction_dts == o.original_transaction_dts &&
      sub_id == o.sub_id &&
      tier_number == o.tier_number &&
      transaction_amount == o.transaction_amount &&
      transaction_amount_paid == o.transaction_amount_paid &&
      transaction_dts == o.transaction_dts &&
      transaction_memo == o.transaction_memo &&
      transaction_percentage == o.transaction_percentage &&
      transaction_state == o.transaction_state
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/ultracart_api/models/affiliate_ledger.rb, line 305
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 = UltracartClient.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/ultracart_api/models/affiliate_ledger.rb, line 371
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/ultracart_api/models/affiliate_ledger.rb, line 284
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/ultracart_api/models/affiliate_ledger.rb, line 271
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ultracart_api/models/affiliate_ledger.rb, line 277
def hash
  [affiliate_click_oid, affiliate_link_oid, affiliate_oid, assigned_by_user, click, item_id, link, order, order_id, original_transaction_dts, sub_id, tier_number, transaction_amount, transaction_amount_paid, transaction_dts, transaction_memo, transaction_percentage, transaction_state].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/ultracart_api/models/affiliate_ledger.rb, line 221
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/ultracart_api/models/affiliate_ledger.rb, line 351
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/ultracart_api/models/affiliate_ledger.rb, line 357
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/ultracart_api/models/affiliate_ledger.rb, line 345
def to_s
  to_hash.to_s
end
transaction_state=(transaction_state) click to toggle source

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

# File lib/ultracart_api/models/affiliate_ledger.rb, line 236
def transaction_state=(transaction_state)
  validator = EnumAttributeValidator.new('String', ['Pending', 'Posted', 'Approved', 'Paid', 'Rejected', 'Partially Paid'])
  unless validator.valid?(transaction_state)
    fail ArgumentError, 'invalid value for "transaction_state", must be one of #{validator.allowable_values}.'
  end
  @transaction_state = transaction_state
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/ultracart_api/models/affiliate_ledger.rb, line 228
def valid?
  transaction_state_validator = EnumAttributeValidator.new('String', ['Pending', 'Posted', 'Approved', 'Paid', 'Rejected', 'Partially Paid'])
  return false unless transaction_state_validator.valid?(@transaction_state)
  true
end