Class: CyberSourceMergedSpec::SenderInformation5

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

Overview

SenderInformation5 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(reference_number: SKIP, additional_properties: nil) ⇒ SenderInformation5

Returns a new instance of SenderInformation5.



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

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

  @reference_number = reference_number unless reference_number == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#reference_number ⇒ String

This field is applicable for AFT transactions. Contains a transaction reference number provided by the Merchant. Only alpha numeric values are supported.

Returns:

  • (String) 


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

def reference_number
  @reference_number
end

Class Method Details

.from_element(root) ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/cyber_source_merged_spec/models/sender_information5.rb', line 65

def self.from_element(root)
  reference_number = XmlUtilities.from_element(root, 'referenceNumber',
                                               String)

  new(reference_number: reference_number,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/cyber_source_merged_spec/models/sender_information5.rb', line 46

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  reference_number =
    hash.key?('referenceNumber') ? hash['referenceNumber'] : 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.
  SenderInformation5.new(reference_number: reference_number,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



19
20
21
22
23
 
# File 'lib/cyber_source_merged_spec/models/sender_information5.rb', line 19

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['reference_number'] = 'referenceNumber'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



33
34
35
 
# File 'lib/cyber_source_merged_spec/models/sender_information5.rb', line 33

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



26
27
28
29
30
 
# File 'lib/cyber_source_merged_spec/models/sender_information5.rb', line 26

def self.optionals
  %w[
    reference_number
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



92
93
94
95
96
 
# File 'lib/cyber_source_merged_spec/models/sender_information5.rb', line 92

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



85
86
87
88
89
 
# File 'lib/cyber_source_merged_spec/models/sender_information5.rb', line 85

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

#to_xml_element(doc, root_name) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cyber_source_merged_spec/models/sender_information5.rb', line 73

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

  XmlUtilities.add_as_subelement(doc, root, 'referenceNumber',
                                 reference_number)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end