Class: CyberSourceMergedSpec::Capture1

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

Overview

Capture1 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(status: SKIP, reason: SKIP, message: SKIP, additional_properties: nil) ⇒ Capture1

Returns a new instance of Capture1.



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/cyber_source_merged_spec/models/capture1.rb', line 62

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

  @status = status unless status == SKIP
  @reason = reason unless reason == SKIP
  @message = message unless message == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#message ⇒ String

The detail message related to the status and reason listed above.

Returns:

  • (String) 


37
38
39
 
# File 'lib/cyber_source_merged_spec/models/capture1.rb', line 37

def message
  @message
end

#reason ⇒ String

The reason of the status. Possible values:

  • MISSING_FIELD
  • INVALID_DATA
  • DUPLICATE_REQUEST
  • INVALID_MERCHANT_CONFIGURATION
  • EXCEEDS_AUTH_AMOUNT
  • AUTH_ALREADY_REVERSED
  • TRANSACTION_ALREADY_SETTLED
  • INVALID_AMOUNT
  • MISSING_AUTH
  • TRANSACTION_ALREADY_REVERSED_OR_SETTLED
  • NOT_SUPPORTED

Returns:

  • (String) 


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

def reason
  @reason
end

#status ⇒ String

The status of the submitted transaction. Possible values:

  • PENDING
  • TRANSMITTED (Only for Online Capture enabled merchants)

Returns:

  • (String) 


17
18
19
 
# File 'lib/cyber_source_merged_spec/models/capture1.rb', line 17

def status
  @status
end

Class Method Details

.from_element(root) ⇒ Object 



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

def self.from_element(root)
  status = XmlUtilities.from_element(root, 'status', String)
  reason = XmlUtilities.from_element(root, 'reason', String)
  message = XmlUtilities.from_element(root, 'message', String)

  new(status: status,
      reason: reason,
      message: message,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

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

.names ⇒ Object

A mapping from model property names to API property names.



40
41
42
43
44
45
46
 
# File 'lib/cyber_source_merged_spec/models/capture1.rb', line 40

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

.nullables ⇒ Object

An array for nullable fields



58
59
60
 
# File 'lib/cyber_source_merged_spec/models/capture1.rb', line 58

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    status
    reason
    message
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



127
128
129
130
131
 
# File 'lib/cyber_source_merged_spec/models/capture1.rb', line 127

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



120
121
122
123
124
 
# File 'lib/cyber_source_merged_spec/models/capture1.rb', line 120

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

#to_xml_element(doc, root_name) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cyber_source_merged_spec/models/capture1.rb', line 107

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

  XmlUtilities.add_as_subelement(doc, root, 'status', status)
  XmlUtilities.add_as_subelement(doc, root, 'reason', reason)
  XmlUtilities.add_as_subelement(doc, root, 'message', message)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end