Class: CyberSourceMergedSpec::OrderInformation30

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

Overview

OrderInformation30 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(amount_details: SKIP, bill_to: SKIP, ship_to: SKIP, line_items: SKIP, invoice_details: SKIP, additional_properties: nil) ⇒ OrderInformation30

Returns a new instance of OrderInformation30.



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

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

  @amount_details = amount_details unless amount_details == SKIP
  @bill_to = bill_to unless bill_to == SKIP
  @ship_to = ship_to unless ship_to == SKIP
  @line_items = line_items unless line_items == SKIP
  @invoice_details = invoice_details unless invoice_details == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#amount_details ⇒ AmountDetails32

TODO: Write general description for this method

Returns:



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

def amount_details
  @amount_details
end

#bill_to ⇒ BillTo14

TODO: Write general description for this method

Returns:



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

def bill_to
  @bill_to
end

#invoice_details ⇒ InvoiceDetails12

TODO: Write general description for this method

Returns:



30
31
32
 
# File 'lib/cyber_source_merged_spec/models/order_information30.rb', line 30

def invoice_details
  @invoice_details
end

#line_items ⇒ Array[LineItem9]

TODO: Write general description for this method

Returns:



26
27
28
 
# File 'lib/cyber_source_merged_spec/models/order_information30.rb', line 26

def line_items
  @line_items
end

#ship_to ⇒ ShipTo11

TODO: Write general description for this method

Returns:



22
23
24
 
# File 'lib/cyber_source_merged_spec/models/order_information30.rb', line 22

def ship_to
  @ship_to
end

Class Method Details

.from_element(root) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/cyber_source_merged_spec/models/order_information30.rb', line 110

def self.from_element(root)
  amount_details = XmlUtilities.from_element(root, 'AmountDetails32',
                                             AmountDetails32)
  bill_to = XmlUtilities.from_element(root, 'BillTo14', BillTo14)
  ship_to = XmlUtilities.from_element(root, 'ShipTo11', ShipTo11)
  line_items = XmlUtilities.from_element_to_array(root, 'LineItem9',
                                                  LineItem9)
  invoice_details = XmlUtilities.from_element(root, 'InvoiceDetails12',
                                              InvoiceDetails12)

  new(amount_details: amount_details,
      bill_to: bill_to,
      ship_to: ship_to,
      line_items: line_items,
      invoice_details: invoice_details,
      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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/cyber_source_merged_spec/models/order_information30.rb', line 74

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  amount_details = AmountDetails32.from_hash(hash['amountDetails']) if hash['amountDetails']
  bill_to = BillTo14.from_hash(hash['billTo']) if hash['billTo']
  ship_to = ShipTo11.from_hash(hash['shipTo']) if hash['shipTo']
  # 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 << (LineItem9.from_hash(structure) if structure)
    end
  end

  line_items = SKIP unless hash.key?('lineItems')
  invoice_details = InvoiceDetails12.from_hash(hash['invoiceDetails']) if
    hash['invoiceDetails']

  # 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.
  OrderInformation30.new(amount_details: amount_details,
                         bill_to: bill_to,
                         ship_to: ship_to,
                         line_items: line_items,
                         invoice_details: invoice_details,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
41
 
# File 'lib/cyber_source_merged_spec/models/order_information30.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['amount_details'] = 'amountDetails'
  @_hash['bill_to'] = 'billTo'
  @_hash['ship_to'] = 'shipTo'
  @_hash['line_items'] = 'lineItems'
  @_hash['invoice_details'] = 'invoiceDetails'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



55
56
57
 
# File 'lib/cyber_source_merged_spec/models/order_information30.rb', line 55

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    amount_details
    bill_to
    ship_to
    line_items
    invoice_details
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



153
154
155
156
157
158
 
# File 'lib/cyber_source_merged_spec/models/order_information30.rb', line 153

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



145
146
147
148
149
150
 
# File 'lib/cyber_source_merged_spec/models/order_information30.rb', line 145

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

#to_xml_element(doc, root_name) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/cyber_source_merged_spec/models/order_information30.rb', line 128

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

  XmlUtilities.add_as_subelement(doc, root, 'AmountDetails32',
                                 amount_details)
  XmlUtilities.add_as_subelement(doc, root, 'BillTo14', bill_to)
  XmlUtilities.add_as_subelement(doc, root, 'ShipTo11', ship_to)
  XmlUtilities.add_array_as_subelement(doc, root, 'LineItem9', line_items)
  XmlUtilities.add_as_subelement(doc, root, 'InvoiceDetails12',
                                 invoice_details)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end