Class: WhiteLabelMachineName::LineItemCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LineItemCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
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
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 87

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'amountIncludingTax')
    self.amount_including_tax = attributes[:'amountIncludingTax']
  end

  if attributes.has_key?(:'attributes')
    if (value = attributes[:'attributes']).is_a?(Hash)
      self.attributes = value
    end
  end

  if attributes.has_key?(:'discountIncludingTax')
    self.discount_including_tax = attributes[:'discountIncludingTax']
  end

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

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

  if attributes.has_key?(:'shippingRequired')
    self.shipping_required = attributes[:'shippingRequired']
  end

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

  if attributes.has_key?(:'taxes')
    if (value = attributes[:'taxes']).is_a?(Array)
      self.taxes = value
    end
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'uniqueId')
    self.unique_id = attributes[:'uniqueId']
  end
end

Instance Attribute Details

#amount_including_tax ⇒ Object

Returns the value of attribute amount_including_tax.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 24

def amount_including_tax
  @amount_including_tax
end

#attributes ⇒ Object

Returns the value of attribute attributes.



27
28
29
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 27

def attributes
  @attributes
end

#discount_including_tax ⇒ Object

Returns the value of attribute discount_including_tax.



30
31
32
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 30

def discount_including_tax
  @discount_including_tax
end

#name ⇒ Object

Returns the value of attribute name.



33
34
35
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 33

def name
  @name
end

#quantity ⇒ Object

Returns the value of attribute quantity.



36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 36

def quantity
  @quantity
end

#shipping_required ⇒ Object

Returns the value of attribute shipping_required.



39
40
41
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 39

def shipping_required
  @shipping_required
end

#sku ⇒ Object

Returns the value of attribute sku.



42
43
44
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 42

def sku
  @sku
end

#taxes ⇒ Object

Returns the value of attribute taxes.



45
46
47
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 45

def taxes
  @taxes
end

#type ⇒ Object

Returns the value of attribute type.



48
49
50
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 48

def type
  @type
end

#unique_id ⇒ Object

The unique id identifies the line item within the set of line items associated with the transaction.



51
52
53
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 51

def unique_id
  @unique_id
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 54

def self.attribute_map
  {
    :'amount_including_tax' => :'amountIncludingTax',
    :'attributes' => :'attributes',
    :'discount_including_tax' => :'discountIncludingTax',
    :'name' => :'name',
    :'quantity' => :'quantity',
    :'shipping_required' => :'shippingRequired',
    :'sku' => :'sku',
    :'taxes' => :'taxes',
    :'type' => :'type',
    :'unique_id' => :'uniqueId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 70

def self.swagger_types
  {
    :'amount_including_tax' => :'Float',
    :'attributes' => :'Hash<String, LineItemAttributeCreate>',
    :'discount_including_tax' => :'Float',
    :'name' => :'String',
    :'quantity' => :'Float',
    :'shipping_required' => :'BOOLEAN',
    :'sku' => :'String',
    :'taxes' => :'Array<TaxCreate>',
    :'type' => :'LineItemType',
    :'unique_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount_including_tax == o.amount_including_tax &&
      attributes == o.attributes &&
      discount_including_tax == o.discount_including_tax &&
      name == o.name &&
      quantity == o.quantity &&
      shipping_required == o.shipping_required &&
      sku == o.sku &&
      taxes == o.taxes &&
      type == o.type &&
      unique_id == o.unique_id
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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 291

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
    temp_model = WhiteLabelMachineName.const_get(type).new
    temp_model.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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 357

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 270

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


257
258
259
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



263
264
265
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 263

def hash
  [amount_including_tax, attributes, discount_including_tax, name, quantity, shipping_required, sku, taxes, type, unique_id].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



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
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 140

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

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

  if @name.to_s.length > 150
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 150.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

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

  if !@sku.nil? && @sku.to_s.length > 200
    invalid_properties.push('invalid value for "sku", the character length must be smaller than or equal to 200.')
  end

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

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

  if @unique_id.to_s.length > 200
    invalid_properties.push('invalid value for "unique_id", the character length must be smaller than or equal to 200.')
  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



337
338
339
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 337

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



343
344
345
346
347
348
349
350
351
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 343

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



331
332
333
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 331

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



183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/line_item_create.rb', line 183

def valid?
  return false if @amount_including_tax.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 150
  return false if @name.to_s.length < 1
  return false if @quantity.nil?
  return false if !@sku.nil? && @sku.to_s.length > 200
  return false if @type.nil?
  return false if @unique_id.nil?
  return false if @unique_id.to_s.length > 200
  true
end