Class: UltracartClient::OrderItemOption

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/order_item_option.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderItemOption

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
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 102

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?(:'additional_dimension_application')
    self.additional_dimension_application = attributes[:'additional_dimension_application']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_dimension_application ⇒ Object

How the additional dimensions are applied to the item.



18
19
20
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 18

def additional_dimension_application
  @additional_dimension_application
end

#cost_change ⇒ Object

Returns the value of attribute cost_change.



20
21
22
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 20

def cost_change
  @cost_change
end

#file_attachment ⇒ Object

Returns the value of attribute file_attachment.



22
23
24
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 22

def file_attachment
  @file_attachment
end

#height ⇒ Object

Returns the value of attribute height.



24
25
26
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 24

def height
  @height
end

#hidden ⇒ Object

True if this option is hidden from display on the order



27
28
29
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 27

def hidden
  @hidden
end

#label ⇒ Object

Label



30
31
32
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 30

def label
  @label
end

#length ⇒ Object

Returns the value of attribute length.



32
33
34
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 32

def length
  @length
end

#one_time_fee ⇒ Object

True if the cost associated with this option is a one time fee or multiplied by the quantity of the item



35
36
37
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 35

def one_time_fee
  @one_time_fee
end

#value ⇒ Object

Value



38
39
40
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 38

def value
  @value
end

#weight_change ⇒ Object

Returns the value of attribute weight_change.



40
41
42
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 40

def weight_change
  @weight_change
end

#width ⇒ Object

Returns the value of attribute width.



42
43
44
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 42

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 67

def self.attribute_map
  {
    :'additional_dimension_application' => :'additional_dimension_application',
    :'cost_change' => :'cost_change',
    :'file_attachment' => :'file_attachment',
    :'height' => :'height',
    :'hidden' => :'hidden',
    :'label' => :'label',
    :'length' => :'length',
    :'one_time_fee' => :'one_time_fee',
    :'value' => :'value',
    :'weight_change' => :'weight_change',
    :'width' => :'width'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 84

def self.swagger_types
  {
    :'additional_dimension_application' => :'String',
    :'cost_change' => :'Currency',
    :'file_attachment' => :'OrderItemOptionFileAttachment',
    :'height' => :'Distance',
    :'hidden' => :'BOOLEAN',
    :'label' => :'String',
    :'length' => :'Distance',
    :'one_time_fee' => :'BOOLEAN',
    :'value' => :'String',
    :'weight_change' => :'Weight',
    :'width' => :'Distance'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_dimension_application == o.additional_dimension_application &&
      cost_change == o.cost_change &&
      file_attachment == o.file_attachment &&
      height == o.height &&
      hidden == o.hidden &&
      label == o.label &&
      length == o.length &&
      one_time_fee == o.one_time_fee &&
      value == o.value &&
      weight_change == o.weight_change &&
      width == o.width
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



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
295
296
297
298
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 262

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 = UltracartClient.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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/ultracart_api/models/order_item_option.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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 241

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


228
229
230
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 234

def hash
  [additional_dimension_application, cost_change, file_attachment, height, hidden, label, length, one_time_fee, value, weight_change, width].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



155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  if !@label.nil? && @label.to_s.length > 50
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 50.')
  end

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



308
309
310
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 308

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



314
315
316
317
318
319
320
321
322
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 314

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



302
303
304
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 302

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



170
171
172
173
174
175
176
 
# File 'lib/ultracart_api/models/order_item_option.rb', line 170

def valid?
  additional_dimension_application_validator = EnumAttributeValidator.new('String', ['none', 'set item to', 'add item'])
  return false unless additional_dimension_application_validator.valid?(@additional_dimension_application)
  return false if !@label.nil? && @label.to_s.length > 50
  return false if !@value.nil? && @value.to_s.length > 1024
  true
end