Class: StickyIoRestfulApiV2025731::DataCalculateOrderTotal

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb

Overview

DataCalculateOrderTotal 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(total:, subtotal:, line_items:, shipping:, discounts:, additional_properties: nil) ⇒ DataCalculateOrderTotal

Returns a new instance of DataCalculateOrderTotal.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 53

def initialize(total:, subtotal:, line_items:, shipping:, discounts:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @total = total
  @subtotal = subtotal
  @line_items = line_items
  @shipping = shipping
  @discounts = discounts
  @additional_properties = additional_properties
end

Instance Attribute Details

#discounts ⇒ Array[DiscountsData]

TODO: Write general description for this method

Returns:



30
31
32
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 30

def discounts
  @discounts
end

#line_items ⇒ Array[LineItem]

TODO: Write general description for this method

Returns:



22
23
24
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 22

def line_items
  @line_items
end

#shipping ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


26
27
28
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 26

def shipping
  @shipping
end

#subtotal ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 18

def subtotal
  @subtotal
end

#total ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 14

def total
  @total
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



67
68
69
70
71
72
73
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
109
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 67

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  total = hash.key?('total') ? hash['total'] : nil
  subtotal = hash.key?('subtotal') ? hash['subtotal'] : nil
  # Parameter is an array, so we need to iterate through it
  line_items = nil
  unless hash['line_items'].nil?
    line_items = []
    hash['line_items'].each do |structure|
      line_items << (LineItem.from_hash(structure) if structure)
    end
  end

  line_items = nil unless hash.key?('line_items')
  shipping = hash.key?('shipping') ? hash['shipping'] : nil
  # Parameter is an array, so we need to iterate through it
  discounts = nil
  unless hash['discounts'].nil?
    discounts = []
    hash['discounts'].each do |structure|
      discounts << (DiscountsData.from_hash(structure) if structure)
    end
  end

  discounts = nil unless hash.key?('discounts')

  # 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.
  DataCalculateOrderTotal.new(total: total,
                              subtotal: subtotal,
                              line_items: line_items,
                              shipping: shipping,
                              discounts: discounts,
                              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/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['total'] = 'total'
  @_hash['subtotal'] = 'subtotal'
  @_hash['line_items'] = 'line_items'
  @_hash['shipping'] = 'shipping'
  @_hash['discounts'] = 'discounts'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



44
45
46
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 44

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



120
121
122
123
124
125
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 120

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



112
113
114
115
116
117
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_calculate_order_total.rb', line 112

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