Class: CyberSourceMergedSpec::OrderInformation60

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

Overview

Contains all of the order-related fields, such as the amount and line item details.

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(amount_details:, line_items: SKIP, additional_properties: nil) ⇒ OrderInformation60

Returns a new instance of OrderInformation60.



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

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

  @amount_details = amount_details
  @line_items = line_items unless line_items == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#amount_details ⇒ AmountDetails60

Contains all of the amount-related fields.

Returns:



15
16
17
 
# File 'lib/cyber_source_merged_spec/models/order_information60.rb', line 15

def amount_details
  @amount_details
end

#line_items ⇒ Array[LineItem17]

List of the line items from the order.

Returns:



19
20
21
 
# File 'lib/cyber_source_merged_spec/models/order_information60.rb', line 19

def line_items
  @line_items
end

Class Method Details

.from_element(root) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/cyber_source_merged_spec/models/order_information60.rb', line 81

def self.from_element(root)
  amount_details = XmlUtilities.from_element(root, 'AmountDetails60',
                                             AmountDetails60)
  line_items = XmlUtilities.from_element_to_array(root, 'LineItem17',
                                                  LineItem17)

  new(amount_details: amount_details,
      line_items: line_items,
      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
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/cyber_source_merged_spec/models/order_information60.rb', line 52

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  amount_details = AmountDetails60.from_hash(hash['amountDetails']) if hash['amountDetails']
  # Parameter is an array, so we need to iterate through it
  line_items = nil
  unless hash['lineItems'].nil?
    line_items = []
    hash['lineItems'].each do |structure|
      line_items << (LineItem17.from_hash(structure) if structure)
    end
  end

  line_items = SKIP unless hash.key?('lineItems')

  # 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.
  OrderInformation60.new(amount_details: amount_details,
                         line_items: line_items,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/cyber_source_merged_spec/models/order_information60.rb', line 22

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['amount_details'] = 'amountDetails'
  @_hash['line_items'] = 'lineItems'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
33
34
 
# File 'lib/cyber_source_merged_spec/models/order_information60.rb', line 30

def self.optionals
  %w[
    line_items
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



112
113
114
115
116
 
# File 'lib/cyber_source_merged_spec/models/order_information60.rb', line 112

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



105
106
107
108
109
 
# File 'lib/cyber_source_merged_spec/models/order_information60.rb', line 105

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

#to_xml_element(doc, root_name) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/cyber_source_merged_spec/models/order_information60.rb', line 92

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

  XmlUtilities.add_as_subelement(doc, root, 'AmountDetails60',
                                 amount_details)
  XmlUtilities.add_array_as_subelement(doc, root, 'LineItem17', line_items)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end