Class: UltracartClient::ItemOption

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemOption

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/ultracart_api/models/item_option.rb', line 135

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ItemOption` 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 `UltracartClient::ItemOption`. 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?(:'cost_if_specified')
    self.cost_if_specified = attributes[:'cost_if_specified']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cost_if_specified ⇒ Object

Cost if specified



19
20
21
 
# File 'lib/ultracart_api/models/item_option.rb', line 19

def cost_if_specified
  @cost_if_specified
end

#cost_per_letter ⇒ Object

Cost per letter



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

def cost_per_letter
  @cost_per_letter
end

#cost_per_line ⇒ Object

Cost per line



25
26
27
 
# File 'lib/ultracart_api/models/item_option.rb', line 25

def cost_per_line
  @cost_per_line
end

#ignore_if_default ⇒ Object

Ignore this option on the order if the default value is selected



28
29
30
 
# File 'lib/ultracart_api/models/item_option.rb', line 28

def ignore_if_default
  @ignore_if_default
end

#label ⇒ Object

Label



31
32
33
 
# File 'lib/ultracart_api/models/item_option.rb', line 31

def label
  @label
end

#label_translated_text_instance_oid ⇒ Object

Label translated text instance ID



34
35
36
 
# File 'lib/ultracart_api/models/item_option.rb', line 34

def label_translated_text_instance_oid
  @label_translated_text_instance_oid
end

#name ⇒ Object

Name



37
38
39
 
# File 'lib/ultracart_api/models/item_option.rb', line 37

def name
  @name
end

#name_translated_text_instance_oid ⇒ Object

Name translated text instance ID



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

def name_translated_text_instance_oid
  @name_translated_text_instance_oid
end

#one_time_fee ⇒ Object

One time fee



43
44
45
 
# File 'lib/ultracart_api/models/item_option.rb', line 43

def one_time_fee
  @one_time_fee
end

#option_oid ⇒ Object

Option object identifier



46
47
48
 
# File 'lib/ultracart_api/models/item_option.rb', line 46

def option_oid
  @option_oid
end

#required ⇒ Object

True if the customer is required to specify an answer



49
50
51
 
# File 'lib/ultracart_api/models/item_option.rb', line 49

def required
  @required
end

#system_option ⇒ Object

True if this is a system option



52
53
54
 
# File 'lib/ultracart_api/models/item_option.rb', line 52

def system_option
  @system_option
end

#type ⇒ Object

Type of option



55
56
57
 
# File 'lib/ultracart_api/models/item_option.rb', line 55

def type
  @type
end

#values ⇒ Object

Values



58
59
60
 
# File 'lib/ultracart_api/models/item_option.rb', line 58

def values
  @values
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/ultracart_api/models/item_option.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'cost_if_specified' => :'cost_if_specified',
    :'cost_per_letter' => :'cost_per_letter',
    :'cost_per_line' => :'cost_per_line',
    :'ignore_if_default' => :'ignore_if_default',
    :'label' => :'label',
    :'label_translated_text_instance_oid' => :'label_translated_text_instance_oid',
    :'name' => :'name',
    :'name_translated_text_instance_oid' => :'name_translated_text_instance_oid',
    :'one_time_fee' => :'one_time_fee',
    :'option_oid' => :'option_oid',
    :'required' => :'required',
    :'system_option' => :'system_option',
    :'type' => :'type',
    :'values' => :'values'
  }
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



298
299
300
 
# File 'lib/ultracart_api/models/item_option.rb', line 298

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
 
# File 'lib/ultracart_api/models/item_option.rb', line 128

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

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/ultracart_api/models/item_option.rb', line 108

def self.openapi_types
  {
    :'cost_if_specified' => :'Float',
    :'cost_per_letter' => :'Float',
    :'cost_per_line' => :'Float',
    :'ignore_if_default' => :'Boolean',
    :'label' => :'String',
    :'label_translated_text_instance_oid' => :'Integer',
    :'name' => :'String',
    :'name_translated_text_instance_oid' => :'Integer',
    :'one_time_fee' => :'Boolean',
    :'option_oid' => :'Integer',
    :'required' => :'Boolean',
    :'system_option' => :'Boolean',
    :'type' => :'String',
    :'values' => :'Array<ItemOptionValue>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/ultracart_api/models/item_option.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cost_if_specified == o.cost_if_specified &&
      cost_per_letter == o.cost_per_letter &&
      cost_per_line == o.cost_per_line &&
      ignore_if_default == o.ignore_if_default &&
      label == o.label &&
      label_translated_text_instance_oid == o.label_translated_text_instance_oid &&
      name == o.name &&
      name_translated_text_instance_oid == o.name_translated_text_instance_oid &&
      one_time_fee == o.one_time_fee &&
      option_oid == o.option_oid &&
      required == o.required &&
      system_option == o.system_option &&
      type == o.type &&
      values == o.values
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/ultracart_api/models/item_option.rb', line 329

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/ultracart_api/models/item_option.rb', line 400

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/ultracart_api/models/item_option.rb', line 305

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


285
286
287
 
# File 'lib/ultracart_api/models/item_option.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



291
292
293
 
# File 'lib/ultracart_api/models/item_option.rb', line 291

def hash
  [cost_if_specified, cost_per_letter, cost_per_line, ignore_if_default, label, label_translated_text_instance_oid, name, name_translated_text_instance_oid, one_time_fee, option_oid, required, system_option, type, values].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



209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/ultracart_api/models/item_option.rb', line 209

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



376
377
378
 
# File 'lib/ultracart_api/models/item_option.rb', line 376

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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/ultracart_api/models/item_option.rb', line 382

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



370
371
372
 
# File 'lib/ultracart_api/models/item_option.rb', line 370

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



224
225
226
227
228
229
230
 
# File 'lib/ultracart_api/models/item_option.rb', line 224

def valid?
  return false if !@label.nil? && @label.to_s.length > 50
  return false if !@name.nil? && @name.to_s.length > 50
  type_validator = EnumAttributeValidator.new('String', ["dropdown", "file attachment", "fixed", "hidden", "multiline", "radio", "single"])
  return false unless type_validator.valid?(@type)
  true
end