class AmzSpApi::FinancesApiModel::FinancialEventGroup

Information related to a financial event group.

Attributes

account_tail[RW]

The account tail of the payment instrument.

beginning_balance[RW]
converted_total[RW]
financial_event_group_end[RW]
financial_event_group_id[RW]

A unique identifier for the financial event group.

financial_event_group_start[RW]
fund_transfer_date[RW]
fund_transfer_status[RW]

The status of the fund transfer.

original_total[RW]
processing_status[RW]

The processing status of the financial event group indicates whether the balance of the financial event group is settled. Possible values: * Open * Closed

trace_id[RW]

The trace identifier used by sellers to look up transactions externally.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/finances-api-model/models/financial_event_group.rb, line 45
def self.attribute_map
  {
    :'financial_event_group_id' => :'FinancialEventGroupId',
    :'processing_status' => :'ProcessingStatus',
    :'fund_transfer_status' => :'FundTransferStatus',
    :'original_total' => :'OriginalTotal',
    :'converted_total' => :'ConvertedTotal',
    :'fund_transfer_date' => :'FundTransferDate',
    :'trace_id' => :'TraceId',
    :'account_tail' => :'AccountTail',
    :'beginning_balance' => :'BeginningBalance',
    :'financial_event_group_start' => :'FinancialEventGroupStart',
    :'financial_event_group_end' => :'FinancialEventGroupEnd'
  }
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/finances-api-model/models/financial_event_group.rb, line 190
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/finances-api-model/models/financial_event_group.rb, line 86
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FinancesApiModel::FinancialEventGroup` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `AmzSpApi::FinancesApiModel::FinancialEventGroup`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'financial_event_group_id')
    self.financial_event_group_id = attributes[:'financial_event_group_id']
  end

  if attributes.key?(:'processing_status')
    self.processing_status = attributes[:'processing_status']
  end

  if attributes.key?(:'fund_transfer_status')
    self.fund_transfer_status = attributes[:'fund_transfer_status']
  end

  if attributes.key?(:'original_total')
    self.original_total = attributes[:'original_total']
  end

  if attributes.key?(:'converted_total')
    self.converted_total = attributes[:'converted_total']
  end

  if attributes.key?(:'fund_transfer_date')
    self.fund_transfer_date = attributes[:'fund_transfer_date']
  end

  if attributes.key?(:'trace_id')
    self.trace_id = attributes[:'trace_id']
  end

  if attributes.key?(:'account_tail')
    self.account_tail = attributes[:'account_tail']
  end

  if attributes.key?(:'beginning_balance')
    self.beginning_balance = attributes[:'beginning_balance']
  end

  if attributes.key?(:'financial_event_group_start')
    self.financial_event_group_start = attributes[:'financial_event_group_start']
  end

  if attributes.key?(:'financial_event_group_end')
    self.financial_event_group_end = attributes[:'financial_event_group_end']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/finances-api-model/models/financial_event_group.rb, line 79
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/finances-api-model/models/financial_event_group.rb, line 62
def self.openapi_types
  {
    :'financial_event_group_id' => :'Object',
    :'processing_status' => :'Object',
    :'fund_transfer_status' => :'Object',
    :'original_total' => :'Object',
    :'converted_total' => :'Object',
    :'fund_transfer_date' => :'Object',
    :'trace_id' => :'Object',
    :'account_tail' => :'Object',
    :'beginning_balance' => :'Object',
    :'financial_event_group_start' => :'Object',
    :'financial_event_group_end' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/finances-api-model/models/financial_event_group.rb, line 159
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      financial_event_group_id == o.financial_event_group_id &&
      processing_status == o.processing_status &&
      fund_transfer_status == o.fund_transfer_status &&
      original_total == o.original_total &&
      converted_total == o.converted_total &&
      fund_transfer_date == o.fund_transfer_date &&
      trace_id == o.trace_id &&
      account_tail == o.account_tail &&
      beginning_balance == o.beginning_balance &&
      financial_event_group_start == o.financial_event_group_start &&
      financial_event_group_end == o.financial_event_group_end
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/finances-api-model/models/financial_event_group.rb, line 220
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
    AmzSpApi::FinancesApiModel.const_get(type).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/finances-api-model/models/financial_event_group.rb, line 289
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/finances-api-model/models/financial_event_group.rb, line 197
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end
eql?(o) click to toggle source

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

# File lib/finances-api-model/models/financial_event_group.rb, line 177
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/finances-api-model/models/financial_event_group.rb, line 183
def hash
  [financial_event_group_id, processing_status, fund_transfer_status, original_total, converted_total, fund_transfer_date, trace_id, account_tail, beginning_balance, financial_event_group_start, financial_event_group_end].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/finances-api-model/models/financial_event_group.rb, line 146
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/finances-api-model/models/financial_event_group.rb, line 265
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/finances-api-model/models/financial_event_group.rb, line 271
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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/finances-api-model/models/financial_event_group.rb, line 259
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/finances-api-model/models/financial_event_group.rb, line 153
def valid?
  true
end