Class: CyberSource::Ptsv1pushfundstransferOrderInformationAmountDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv1pushfundstransferOrderInformationAmountDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 65

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?(:'totalAmount')
    self.total_amount = attributes[:'totalAmount']
  end

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

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

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

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

Instance Attribute Details

#currency ⇒ Object

Use a 3-character alpha currency code for currency of the funds transfer. ISO standard currencies: apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor.



20
21
22
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 20

def currency
  @currency
end

#destination_currency ⇒ Object

Use a 3-character alpha currency code for destination currency of the funds transfer. Supported for card and bank account based cross border funds transfers. ISO standard currencies: apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf



26
27
28
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 26

def destination_currency
  @destination_currency
end

#source_currency ⇒ Object

Use a 3-character alpha currency code for source currency of the funds transfer. Supported for card and bank account based cross border funds transfers. ISO standard currencies: apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf



23
24
25
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 23

def source_currency
  @source_currency
end

#surcharge ⇒ Object

Returns the value of attribute surcharge.



28
29
30
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 28

def surcharge
  @surcharge
end

#total_amount ⇒ Object

Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.



17
18
19
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 17

def total_amount
  @total_amount
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 31

def self.attribute_map
  {
    :'total_amount' => :'totalAmount',
    :'currency' => :'currency',
    :'source_currency' => :'sourceCurrency',
    :'destination_currency' => :'destinationCurrency',
    :'surcharge' => :'surcharge'
  }
end

.json_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 42

def self.json_map
  {
    :'total_amount' => :'total_amount',
    :'currency' => :'currency',
    :'source_currency' => :'source_currency',
    :'destination_currency' => :'destination_currency',
    :'surcharge' => :'surcharge'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 53

def self.swagger_types
  {
    :'total_amount' => :'String',
    :'currency' => :'String',
    :'source_currency' => :'String',
    :'destination_currency' => :'String',
    :'surcharge' => :'Ptsv2paymentsOrderInformationAmountDetailsOctsurcharge'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total_amount == o.total_amount &&
      currency == o.currency &&
      source_currency == o.source_currency &&
      destination_currency == o.destination_currency &&
      surcharge == o.surcharge
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 222

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 = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 288

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 201

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


188
189
190
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 194

def hash
  [total_amount, currency, source_currency, destination_currency, surcharge].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 94

def list_invalid_properties
  invalid_properties = Array.new
  if @total_amount.nil?
    invalid_properties.push('invalid value for "total_amount", total_amount cannot be nil.')
  end

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

  #if @currency !~ Regexp.new(/^(\\s{0,3}|.{3})$/)
    #invalid_properties.push('invalid value for "currency", must conform to the pattern /^(\\s{0,3}|.{3})$/.')
  #end

  #if !@source_currency.nil? && @source_currency !~ Regexp.new(/^(\\s{0,3}|.{3})$/)
    #invalid_properties.push('invalid value for "source_currency", must conform to the pattern /^(\\s{0,3}|.{3})$/.')
  #end

  #if !@destination_currency.nil? && @destination_currency !~ Regexp.new(/^(\\s{0,3}|.{3})$/)
    #invalid_properties.push('invalid value for "destination_currency", must conform to the pattern /^(\\s{0,3}|.{3})$/.')
  #end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



268
269
270
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 268

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



274
275
276
277
278
279
280
281
282
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 274

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



262
263
264
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 262

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



121
122
123
124
125
126
127
128
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb', line 121

def valid?
  return false if @total_amount.nil?
  return false if @currency.nil?
  #return false if @currency !~ Regexp.new(/^(\\s{0,3}|.{3})$/)
  #return false if !@source_currency.nil? && @source_currency !~ Regexp.new(/^(\\s{0,3}|.{3})$/)
  #return false if !@destination_currency.nil? && @destination_currency !~ Regexp.new(/^(\\s{0,3}|.{3})$/)
  true
end