Class: CyberSourceMergedSpec::InstrumentIdentifier2

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

Overview

InstrumentIdentifier2 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, state: SKIP, additional_properties: nil) ⇒ InstrumentIdentifier2

Returns a new instance of InstrumentIdentifier2.



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

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

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

Instance Attribute Details

#id ⇒ String

Unique identifier for the Instrument Identifier token used in the transaction. When you include this value in your request, many of the fields that can be supplied for an authorization or credit become optional.

Returns:

  • (String) 


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

def id
  @id
end

#state ⇒ String

Issuers state for the card number. Valid values:

  • ACTIVE
  • CLOSED : The account has been closed.

Returns:

  • (String) 


25
26
27
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier2.rb', line 25

def state
  @state
end

Class Method Details

.from_element(root) ⇒ Object 



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

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

  new(id: id,
      state: state,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier2.rb', line 58

def self.from_hash(hash)
  return nil unless hash

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

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



44
45
46
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier2.rb', line 44

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    id
    state
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



106
107
108
109
110
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier2.rb', line 106

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



99
100
101
102
103
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier2.rb', line 99

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

#to_xml_element(doc, root_name) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cyber_source_merged_spec/models/instrument_identifier2.rb', line 87

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, 'state', state)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end