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



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/ultracart_api/models/item_option.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_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



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

def cost_if_specified
  @cost_if_specified
end

#cost_per_letter ⇒ Object

Cost per letter



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

def cost_per_letter
  @cost_per_letter
end

#cost_per_line ⇒ Object

Cost per line



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

def cost_per_line
  @cost_per_line
end

#ignore_if_default ⇒ Object

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



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

def ignore_if_default
  @ignore_if_default
end

#label ⇒ Object

Label



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

def label
  @label
end

#label_translated_text_instance_oid ⇒ Object

Label translated text instance ID



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

def label_translated_text_instance_oid
  @label_translated_text_instance_oid
end

#name ⇒ Object

Name



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

def name
  @name
end

#name_translated_text_instance_oid ⇒ Object

Name translated text instance ID



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

def name_translated_text_instance_oid
  @name_translated_text_instance_oid
end

#one_time_fee ⇒ Object

One time fee



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

def one_time_fee
  @one_time_fee
end

#option_oid ⇒ Object

Option object identifier



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

def option_oid
  @option_oid
end

#required ⇒ Object

True if the customer is required to specify an answer



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

def required
  @required
end

#system_option ⇒ Object

True if this is a system option



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

def system_option
  @system_option
end

#type ⇒ Object

Type of option



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

def type
  @type
end

#values ⇒ Object

Values



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

def values
  @values
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/ultracart_api/models/item_option.rb', line 102

def self.swagger_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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/ultracart_api/models/item_option.rb', line 245

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



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
328
329
330
331
332
333
334
335
336
 
# File 'lib/ultracart_api/models/item_option.rb', line 300

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/ultracart_api/models/item_option.rb', line 366

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/ultracart_api/models/item_option.rb', line 279

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


266
267
268
 
# File 'lib/ultracart_api/models/item_option.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



272
273
274
 
# File 'lib/ultracart_api/models/item_option.rb', line 272

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



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/ultracart_api/models/item_option.rb', line 190

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



346
347
348
 
# File 'lib/ultracart_api/models/item_option.rb', line 346

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



352
353
354
355
356
357
358
359
360
 
# File 'lib/ultracart_api/models/item_option.rb', line 352

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



340
341
342
 
# File 'lib/ultracart_api/models/item_option.rb', line 340

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



205
206
207
208
209
210
211
 
# File 'lib/ultracart_api/models/item_option.rb', line 205

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