Class: CyberSourceMergedSpec::AccountFeatures3

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/cyber_source_merged_spec/models/account_features3.rb

Overview

AccountFeatures3 Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(balance_amount: SKIP, previous_balance_amount: SKIP, currency: SKIP, additional_properties: nil) ⇒ AccountFeatures3

Returns a new instance of AccountFeatures3.



62
63
64
65
66
67
68
69
70
71
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 62

def initialize(balance_amount: SKIP, previous_balance_amount: SKIP,
               currency: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @balance_amount = balance_amount unless balance_amount == SKIP
  @previous_balance_amount = previous_balance_amount unless previous_balance_amount == SKIP
  @currency = currency unless currency == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#balance_amountString

Remaining balance on the account. Returned by authorization service.

PIN debit

Remaining balance on the prepaid card. Returned by PIN debit purchase.

Returns:

  • (String)


18
19
20
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 18

def balance_amount
  @balance_amount
end

#currencyString

Currency of the remaining balance on the account. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/cur rencies.pdf) Returned by authorization service.

PIN debit

Currency of the remaining balance on the prepaid card. Returned by PIN debit purchase.

Returns:

  • (String)


37
38
39
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 37

def currency
  @currency
end

#previous_balance_amountString

Remaining balance on the account. Returned by authorization service.

PIN debit

Remaining balance on the prepaid card. Returned by PIN debit purchase.

Returns:

  • (String)


26
27
28
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 26

def previous_balance_amount
  @previous_balance_amount
end

Class Method Details

.from_element(root) ⇒ Object



97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 97

def self.from_element(root)
  balance_amount = XmlUtilities.from_element(root, 'balanceAmount', String)
  previous_balance_amount = XmlUtilities.from_element(
    root, 'previousBalanceAmount', String
  )
  currency = XmlUtilities.from_element(root, 'currency', String)

  new(balance_amount: balance_amount,
      previous_balance_amount: previous_balance_amount,
      currency: currency,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 74

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  balance_amount = hash.key?('balanceAmount') ? hash['balanceAmount'] : SKIP
  previous_balance_amount =
    hash.key?('previousBalanceAmount') ? hash['previousBalanceAmount'] : SKIP
  currency = hash.key?('currency') ? hash['currency'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  AccountFeatures3.new(balance_amount: balance_amount,
                       previous_balance_amount: previous_balance_amount,
                       currency: currency,
                       additional_properties: additional_properties)
end

.namesObject

A mapping from model property names to API property names.



40
41
42
43
44
45
46
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 40

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['balance_amount'] = 'balanceAmount'
  @_hash['previous_balance_amount'] = 'previousBalanceAmount'
  @_hash['currency'] = 'currency'
  @_hash
end

.nullablesObject

An array for nullable fields



58
59
60
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 58

def self.nullables
  []
end

.optionalsObject

An array for optional fields



49
50
51
52
53
54
55
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 49

def self.optionals
  %w[
    balance_amount
    previous_balance_amount
    currency
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



132
133
134
135
136
137
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 132

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} balance_amount: #{@balance_amount.inspect}, previous_balance_amount:"\
  " #{@previous_balance_amount.inspect}, currency: #{@currency.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_sObject

Provides a human-readable string representation of the object.



124
125
126
127
128
129
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 124

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} balance_amount: #{@balance_amount}, previous_balance_amount:"\
  " #{@previous_balance_amount}, currency: #{@currency}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object



110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/cyber_source_merged_spec/models/account_features3.rb', line 110

def to_xml_element(doc, root_name)
  root = doc.create_element(root_name)

  XmlUtilities.add_as_subelement(doc, root, 'balanceAmount', balance_amount)
  XmlUtilities.add_as_subelement(doc, root, 'previousBalanceAmount',
                                 previous_balance_amount)
  XmlUtilities.add_as_subelement(doc, root, 'currency', currency)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end