Class: CyberSourceMergedSpec::InstrumentIdentifier34

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

Overview

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

Returns a new instance of InstrumentIdentifier34.



43
44
45
46
47
48
49
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier34.rb', line 43

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

  @id = id unless id == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#id ⇒ String

Unique identifier for the Instrument Identifier token used in the transaction. When you use this in the request, the card number field becomes optional. Conditional: this field is only required if card number is not sent in through senderInformation.paymentInformation.card.number.

For more information on TMS, please see our originator-facing documentation. Conditional: this field is only required if card number is not sent in through senderInformation.paymentInformation.card.number.

Returns:

  • (String) 


22
23
24
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier34.rb', line 22

def id
  @id
end

Class Method Details

.from_element(root) ⇒ Object 



70
71
72
73
74
75
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier34.rb', line 70

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

  new(id: id,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier34.rb', line 52

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  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.
  InstrumentIdentifier34.new(id: id,
                             additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier34.rb', line 25

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

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier34.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



32
33
34
35
36
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier34.rb', line 32

def self.optionals
  %w[
    id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



94
95
96
97
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier34.rb', line 94

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



88
89
90
91
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier34.rb', line 88

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

#to_xml_element(doc, root_name) ⇒ Object 



77
78
79
80
81
82
83
84
85
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier34.rb', line 77

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

  XmlUtilities.add_as_subelement(doc, root, 'id', id)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end