Class: CyberSourceMergedSpec::CurrencyConversion

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

Overview

CurrencyConversion 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(indicator: SKIP, reconciliation_id: SKIP, id: SKIP, additional_properties: nil) ⇒ CurrencyConversion

Returns a new instance of CurrencyConversion.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 49

def initialize(indicator: SKIP, reconciliation_id: SKIP, id: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @indicator = indicator unless indicator == SKIP
  @reconciliation_id = reconciliation_id unless reconciliation_id == SKIP
  @id = id unless id == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#id ⇒ String

Value of the Cybersource request ID returned in a DCC Lookup transaction.

Returns:

  • (String) 


24
25
26
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 24

def id
  @id
end

#indicator ⇒ String

Flag indicating that DCC Lookup has been performed before this transaction. Set this field to 1 when cardholders opts to use DCC on the transaction.

Returns:

  • (String) 


16
17
18
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 16

def indicator
  @indicator
end

#reconciliation_id ⇒ String

Unique identifier generated by the DCC provider.

Returns:

  • (String) 


20
21
22
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 20

def reconciliation_id
  @reconciliation_id
end

Class Method Details

.from_element(root) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 84

def self.from_element(root)
  indicator = XmlUtilities.from_element(root, 'indicator', String)
  reconciliation_id = XmlUtilities.from_element(root, 'reconciliationId',
                                                String)
  id = XmlUtilities.from_element(root, 'id', String)

  new(indicator: indicator,
      reconciliation_id: reconciliation_id,
      id: id,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 61

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  indicator = hash.key?('indicator') ? hash['indicator'] : SKIP
  reconciliation_id =
    hash.key?('reconciliationId') ? hash['reconciliationId'] : SKIP
  id = hash.key?('id') ? hash['id'] : 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.
  CurrencyConversion.new(indicator: indicator,
                         reconciliation_id: reconciliation_id,
                         id: id,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



27
28
29
30
31
32
33
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 27

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['indicator'] = 'indicator'
  @_hash['reconciliation_id'] = 'reconciliationId'
  @_hash['id'] = 'id'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



45
46
47
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 45

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



36
37
38
39
40
41
42
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 36

def self.optionals
  %w[
    indicator
    reconciliation_id
    id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



117
118
119
120
121
122
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 117

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



110
111
112
113
114
 
# File 'lib/cyber_source_merged_spec/models/currency_conversion.rb', line 110

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

#to_xml_element(doc, root_name) ⇒ Object 



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

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

  XmlUtilities.add_as_subelement(doc, root, 'indicator', indicator)
  XmlUtilities.add_as_subelement(doc, root, 'reconciliationId',
                                 reconciliation_id)
  XmlUtilities.add_as_subelement(doc, root, 'id', id)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end