Class: StickyIoRestfulApiV2025731::LineItem

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

Overview

LineItem 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(id:, name:, qty:, base_price:, unit_price:, total:, is_taxable:, is_shippable:, is_prepaid:, additional_properties: nil) ⇒ LineItem

Returns a new instance of LineItem.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 73

def initialize(id:, name:, qty:, base_price:, unit_price:, total:,
               is_taxable:, is_shippable:, is_prepaid:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @id = id
  @name = name
  @qty = qty
  @base_price = base_price
  @unit_price = unit_price
  @total = total
  @is_taxable = is_taxable
  @is_shippable = is_shippable
  @is_prepaid = is_prepaid
  @additional_properties = additional_properties
end

Instance Attribute Details

#base_price ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def base_price
  @base_price
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def id
  @id
end

#is_prepaid ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


46
47
48
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 46

def is_prepaid
  @is_prepaid
end

#is_shippable ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


42
43
44
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 42

def is_shippable
  @is_shippable
end

#is_taxable ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


38
39
40
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 38

def is_taxable
  @is_taxable
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def name
  @name
end

#qty ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def qty
  @qty
end

#total ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


34
35
36
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 34

def total
  @total
end

#unit_price ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def unit_price
  @unit_price
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 92

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : nil
  name = hash.key?('name') ? hash['name'] : nil
  qty = hash.key?('qty') ? hash['qty'] : nil
  base_price = hash.key?('base_price') ? hash['base_price'] : nil
  unit_price = hash.key?('unit_price') ? hash['unit_price'] : nil
  total = hash.key?('total') ? hash['total'] : nil
  is_taxable = hash.key?('is_taxable') ? hash['is_taxable'] : nil
  is_shippable = hash.key?('is_shippable') ? hash['is_shippable'] : nil
  is_prepaid = hash.key?('is_prepaid') ? hash['is_prepaid'] : nil

  # 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.
  LineItem.new(id: id,
               name: name,
               qty: qty,
               base_price: base_price,
               unit_price: unit_price,
               total: total,
               is_taxable: is_taxable,
               is_shippable: is_shippable,
               is_prepaid: is_prepaid,
               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 49

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['name'] = 'name'
  @_hash['qty'] = 'qty'
  @_hash['base_price'] = 'base_price'
  @_hash['unit_price'] = 'unit_price'
  @_hash['total'] = 'total'
  @_hash['is_taxable'] = 'is_taxable'
  @_hash['is_shippable'] = 'is_shippable'
  @_hash['is_prepaid'] = 'is_prepaid'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



69
70
71
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 69

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



64
65
66
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 64

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



136
137
138
139
140
141
142
143
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 136

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}, qty: #{@qty.inspect},"\
  " base_price: #{@base_price.inspect}, unit_price: #{@unit_price.inspect}, total:"\
  " #{@total.inspect}, is_taxable: #{@is_taxable.inspect}, is_shippable:"\
  " #{@is_shippable.inspect}, is_prepaid: #{@is_prepaid.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



127
128
129
130
131
132
133
 
# File 'lib/sticky_io_restful_api_v2025731/models/line_item.rb', line 127

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id}, name: #{@name}, qty: #{@qty}, base_price: #{@base_price},"\
  " unit_price: #{@unit_price}, total: #{@total}, is_taxable: #{@is_taxable}, is_shippable:"\
  " #{@is_shippable}, is_prepaid: #{@is_prepaid}, additional_properties:"\
  " #{@additional_properties}>"
end