Class: CyberSourceMergedSpec::RefundOptions

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

Overview

RefundOptions 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(reason: SKIP, reconciliation_id_alternate: SKIP, additional_properties: nil) ⇒ RefundOptions

Returns a new instance of RefundOptions.



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/cyber_source_merged_spec/models/refund_options.rb', line 44

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

  @reason = reason unless reason == SKIP
  unless reconciliation_id_alternate == SKIP
    @reconciliation_id_alternate =
      reconciliation_id_alternate
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#reason ⇒ String

The reason for the refund.

Returns:

  • (String) 


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

def reason
  @reason
end

#reconciliation_id_alternate ⇒ String

Alternative reference number that can be up to 12 characters in length. If this field is used, it overrides any data added to the ccCaptureService_reconciliationID field. You can use this value to reconcile Cybersource reports with processor reports.

Returns:

  • (String) 


21
22
23
 
# File 'lib/cyber_source_merged_spec/models/refund_options.rb', line 21

def reconciliation_id_alternate
  @reconciliation_id_alternate
end

Class Method Details

.from_element(root) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cyber_source_merged_spec/models/refund_options.rb', line 79

def self.from_element(root)
  reason = XmlUtilities.from_element(root, 'reason', String)
  reconciliation_id_alternate = XmlUtilities.from_element(
    root, 'reconciliationIdAlternate', String
  )

  new(reason: reason,
      reconciliation_id_alternate: reconciliation_id_alternate,
      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
77
 
# File 'lib/cyber_source_merged_spec/models/refund_options.rb', line 58

def self.from_hash(hash)
  return nil unless hash

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

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



40
41
42
 
# File 'lib/cyber_source_merged_spec/models/refund_options.rb', line 40

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    reason
    reconciliation_id_alternate
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



110
111
112
113
114
115
 
# File 'lib/cyber_source_merged_spec/models/refund_options.rb', line 110

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



103
104
105
106
107
 
# File 'lib/cyber_source_merged_spec/models/refund_options.rb', line 103

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

#to_xml_element(doc, root_name) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/cyber_source_merged_spec/models/refund_options.rb', line 90

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

  XmlUtilities.add_as_subelement(doc, root, 'reason', reason)
  XmlUtilities.add_as_subelement(doc, root, 'reconciliationIdAlternate',
                                 reconciliation_id_alternate)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end