class UltracartClient::ItemOption
Attributes
Cost if specified
Cost per letter
Cost per line
Ignore this option on the order if the default value is selected
Label
Label translated text instance ID
Name
Name translated text instance ID
One time fee
Option object identifier
True if the customer is required to specify an answer
True if this is a system option
Type of option
Values
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/ultracart_api/models/item_option.rb, line 266 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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
Custom attribute writer method with validation @param [Object] label Value to be assigned
# File lib/ultracart_api/models/item_option.rb, line 215 def label=(label) if !label.nil? && label.to_s.length > 50 fail ArgumentError, 'invalid value for "label", the character length must be smaller than or equal to 50.' end @label = label end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# 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
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/ultracart_api/models/item_option.rb, line 225 def name=(name) if !name.nil? && name.to_s.length > 50 fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 50.' end @name = name end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ultracart_api/models/item_option.rb, line 340 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/ultracart_api/models/item_option.rb, line 235 def type=(type) validator = EnumAttributeValidator.new('String', ['dropdown', 'file attachment', 'fixed', 'hidden', 'multiline', 'radio', 'single']) unless validator.valid?(type) fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.' end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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