Class: CyberSourceMergedSpec::Initiator30

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

Overview

Initiator30 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(originator_initiated_transaction: SKIP, type: SKIP, stored_credential_used: SKIP, credential_stored_on_file: SKIP, additional_properties: nil) ⇒ Initiator30

Returns a new instance of Initiator30.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/cyber_source_merged_spec/models/initiator30.rb', line 73

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

  unless originator_initiated_transaction == SKIP
    @originator_initiated_transaction =
      originator_initiated_transaction
  end
  @type = type unless type == SKIP
  @stored_credential_used = stored_credential_used unless stored_credential_used == SKIP
  unless credential_stored_on_file == SKIP
    @credential_stored_on_file =
      credential_stored_on_file
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#credential_stored_on_file ⇒ TrueClass | FalseClass

Flag that indicates whether the transaction is the first originator-initiated transaction in a series, which means that the customer initiated the previous transaction. Possible values:

  • True: First originator-initiated transaction
  • False: Not the first originator-initiated transaction Conditional for MITCOF transactions

Returns:

  • (TrueClass | FalseClass) 


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

def credential_stored_on_file
  @credential_stored_on_file
end

#originator_initiated_transaction ⇒ OriginatorInitiatedTransaction

TODO: Write general description for this method

Returns:



14
15
16
 
# File 'lib/cyber_source_merged_spec/models/initiator30.rb', line 14

def originator_initiated_transaction
  @originator_initiated_transaction
end

#stored_credential_used ⇒ TrueClass | FalseClass

Indicates to an issuing bank whether an originator-initiated transaction came from a card that was already stored on file. Possible values:

  • True = originator-initiated transaction came from a card that was already stored on file
  • False = originator-initiated transaction came from a card that was not stored on file Conditional for MITCOF transactions

Returns:

  • (TrueClass | FalseClass) 


35
36
37
 
# File 'lib/cyber_source_merged_spec/models/initiator30.rb', line 35

def stored_credential_used
  @stored_credential_used
end

#type ⇒ String

This field indicates whether the transaction is a originator-initiated transaction or sender-initiated transaction. Valid values:

  • sender
  • originator Conditional field. If value in this field is originator, this field is mandatory for originator-initated transactions.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.from_element(root) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/cyber_source_merged_spec/models/initiator30.rb', line 121

def self.from_element(root)
  originator_initiated_transaction = XmlUtilities.from_element(
    root, 'OriginatorInitiatedTransaction',
    OriginatorInitiatedTransaction
  )
  type = XmlUtilities.from_element(root, 'type', String)
  stored_credential_used = XmlUtilities.from_element(root,
                                                     'storedCredentialUsed',
                                                     TrueClass)
  credential_stored_on_file = XmlUtilities.from_element(
    root, 'credentialStoredOnFile', TrueClass
  )

  new(originator_initiated_transaction: originator_initiated_transaction,
      type: type,
      stored_credential_used: stored_credential_used,
      credential_stored_on_file: credential_stored_on_file,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  if hash['originatorInitiatedTransaction']
    originator_initiated_transaction = OriginatorInitiatedTransaction.from_hash(hash['originatorInitiatedTransaction'])
  end
  type = hash.key?('type') ? hash['type'] : SKIP
  stored_credential_used =
    hash.key?('storedCredentialUsed') ? hash['storedCredentialUsed'] : SKIP
  credential_stored_on_file =
    hash.key?('credentialStoredOnFile') ? hash['credentialStoredOnFile'] : 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.
  Initiator30.new(originator_initiated_transaction: originator_initiated_transaction,
                  type: type,
                  stored_credential_used: stored_credential_used,
                  credential_stored_on_file: credential_stored_on_file,
                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['originator_initiated_transaction'] =
    'originatorInitiatedTransaction'
  @_hash['type'] = 'type'
  @_hash['stored_credential_used'] = 'storedCredentialUsed'
  @_hash['credential_stored_on_file'] = 'credentialStoredOnFile'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



69
70
71
 
# File 'lib/cyber_source_merged_spec/models/initiator30.rb', line 69

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



59
60
61
62
63
64
65
66
 
# File 'lib/cyber_source_merged_spec/models/initiator30.rb', line 59

def self.optionals
  %w[
    originator_initiated_transaction
    type
    stored_credential_used
    credential_stored_on_file
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



168
169
170
171
172
173
174
 
# File 'lib/cyber_source_merged_spec/models/initiator30.rb', line 168

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



159
160
161
162
163
164
165
 
# File 'lib/cyber_source_merged_spec/models/initiator30.rb', line 159

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

#to_xml_element(doc, root_name) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/cyber_source_merged_spec/models/initiator30.rb', line 141

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

  XmlUtilities.add_as_subelement(doc, root,
                                 'OriginatorInitiatedTransaction',
                                 originator_initiated_transaction)
  XmlUtilities.add_as_subelement(doc, root, 'type', type)
  XmlUtilities.add_as_subelement(doc, root, 'storedCredentialUsed',
                                 stored_credential_used)
  XmlUtilities.add_as_subelement(doc, root, 'credentialStoredOnFile',
                                 credential_stored_on_file)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end