Class: DearInventoryRuby::SaleOrderLine

Inherits:
Object
  • Object
show all
Defined in:
lib/dear-inventory-ruby/models/sale_order_line.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SaleOrderLine

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 102

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DearInventoryRuby::SaleOrderLine` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DearInventoryRuby::SaleOrderLine`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'product_id')
    self.product_id = attributes[:'product_id']
  end

  if attributes.key?(:'sku')
    self.sku = attributes[:'sku']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

  if attributes.key?(:'price')
    self.price = attributes[:'price']
  end

  if attributes.key?(:'discount')
    self.discount = attributes[:'discount']
  end

  if attributes.key?(:'tax')
    self.tax = attributes[:'tax']
  end

  if attributes.key?(:'average_cost')
    self.average_cost = attributes[:'average_cost']
  end

  if attributes.key?(:'tax_rule')
    self.tax_rule = attributes[:'tax_rule']
  end

  if attributes.key?(:'comment')
    self.comment = attributes[:'comment']
  end

  if attributes.key?(:'drop_ship')
    self.drop_ship = attributes[:'drop_ship']
  end

  if attributes.key?(:'backorder_quantity')
    self.backorder_quantity = attributes[:'backorder_quantity']
  end

  if attributes.key?(:'total')
    self.total = attributes[:'total']
  end
end

Instance Attribute Details

#average_cost ⇒ Object

Average product cost



39
40
41
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 39

def average_cost
  @average_cost
end

#backorder_quantity ⇒ Object

Quantity of the ordered product on backorder. Read Only for POST



51
52
53
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 51

def backorder_quantity
  @backorder_quantity
end

#comment ⇒ Object

Comment for this line



45
46
47
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 45

def comment
  @comment
end

#discount ⇒ Object

Discount. Value between 0 and 100. For free items discount is 100. Default value is 0



33
34
35
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 33

def discount
  @discount
end

#drop_ship ⇒ Object

Required if product is not a service with “Optional Drop Ship” mode. Otherwise it ignored.



48
49
50
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 48

def drop_ship
  @drop_ship
end

#name ⇒ Object

Product Name referenced by this Line



24
25
26
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 24

def name
  @name
end

#price ⇒ Object

Price per unit in Customer currency



30
31
32
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 30

def price
  @price
end

#product_id ⇒ Object

Product identifier referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false



18
19
20
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 18

def product_id
  @product_id
end

#quantity ⇒ Object

Product or service quantity. Minimal value is 1.



27
28
29
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 27

def quantity
  @quantity
end

#sku ⇒ Object

Product SKU referenced by this Line. Required If CombineAdditionalCharges param exist for this endpoint and it have values = false



21
22
23
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 21

def sku
  @sku
end

#tax ⇒ Object

Tax



36
37
38
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 36

def tax
  @tax
end

#tax_rule ⇒ Object

Line Tax Rule name.



42
43
44
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 42

def tax_rule
  @tax_rule
end

#total ⇒ Object

Line Total. For validation



54
55
56
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 54

def total
  @total
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 57

def self.attribute_map
  {
    :'product_id' => :'ProductID',
    :'sku' => :'SKU',
    :'name' => :'Name',
    :'quantity' => :'Quantity',
    :'price' => :'Price',
    :'discount' => :'Discount',
    :'tax' => :'Tax',
    :'average_cost' => :'AverageCost',
    :'tax_rule' => :'TaxRule',
    :'comment' => :'Comment',
    :'drop_ship' => :'DropShip',
    :'backorder_quantity' => :'BackorderQuantity',
    :'total' => :'Total'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



231
232
233
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 231

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



95
96
97
98
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 95

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 76

def self.openapi_types
  {
    :'product_id' => :'String',
    :'sku' => :'String',
    :'name' => :'String',
    :'quantity' => :'Float',
    :'price' => :'Float',
    :'discount' => :'Float',
    :'tax' => :'Float',
    :'average_cost' => :'Float',
    :'tax_rule' => :'String',
    :'comment' => :'String',
    :'drop_ship' => :'Boolean',
    :'backorder_quantity' => :'Float',
    :'total' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      product_id == o.product_id &&
      sku == o.sku &&
      name == o.name &&
      quantity == o.quantity &&
      price == o.price &&
      discount == o.discount &&
      tax == o.tax &&
      average_cost == o.average_cost &&
      tax_rule == o.tax_rule &&
      comment == o.comment &&
      drop_ship == o.drop_ship &&
      backorder_quantity == o.backorder_quantity &&
      total == o.total
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 259

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    DearInventoryRuby.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 328

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 238

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


218
219
220
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



224
225
226
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 224

def hash
  [product_id, sku, name, quantity, price, discount, tax, average_cost, tax_rule, comment, drop_ship, backorder_quantity, total].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 170

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @quantity.nil?
    invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
  end

  if @price.nil?
    invalid_properties.push('invalid value for "price", price cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



304
305
306
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 304

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 310

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



298
299
300
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 298

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



189
190
191
192
193
194
 
# File 'lib/dear-inventory-ruby/models/sale_order_line.rb', line 189

def valid?
  return false if @name.nil?
  return false if @quantity.nil?
  return false if @price.nil?
  true
end