class UltracartClient::CartItemOption

Attributes

cost_if_specified[RW]
cost_per_letter[RW]
cost_per_line[RW]
ignore_if_default[RW]

True if the default answer is ignored

label[RW]

Display label for the option

name[RW]

Name of the option

one_time_fee[RW]

Charge the fee a single time instead of multiplying by the quantity

option_oid[RW]

Unique identifier for the option

required[RW]

True if the customer is required to select a value

selected_value[RW]

The value of the option specified by the customer

type[RW]

Type of option

values[RW]

Values that the customer can select from for radio or select type options

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/cart_item_option.rb, line 73
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',
    :'name' => :'name',
    :'one_time_fee' => :'one_time_fee',
    :'option_oid' => :'option_oid',
    :'required' => :'required',
    :'selected_value' => :'selected_value',
    :'type' => :'type',
    :'values' => :'values'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ultracart_api/models/cart_item_option.rb, line 110
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?(:'name')
    self.name = attributes[:'name']
  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?(:'selected_value')
    self.selected_value = attributes[:'selected_value']
  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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/cart_item_option.rb, line 91
def self.swagger_types
  {
    :'cost_if_specified' => :'Currency',
    :'cost_per_letter' => :'Currency',
    :'cost_per_line' => :'Currency',
    :'ignore_if_default' => :'BOOLEAN',
    :'label' => :'String',
    :'name' => :'String',
    :'one_time_fee' => :'BOOLEAN',
    :'option_oid' => :'Integer',
    :'required' => :'BOOLEAN',
    :'selected_value' => :'String',
    :'type' => :'String',
    :'values' => :'Array<CartItemOptionValue>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ultracart_api/models/cart_item_option.rb, line 209
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 &&
      name == o.name &&
      one_time_fee == o.one_time_fee &&
      option_oid == o.option_oid &&
      required == o.required &&
      selected_value == o.selected_value &&
      type == o.type &&
      values == o.values
end
_deserialize(type, value) click to toggle source

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/cart_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) click to toggle source

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/cart_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) click to toggle source

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/cart_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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ultracart_api/models/cart_item_option.rb, line 228
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/ultracart_api/models/cart_item_option.rb, line 234
def hash
  [cost_if_specified, cost_per_letter, cost_per_line, ignore_if_default, label, name, one_time_fee, option_oid, required, selected_value, type, values].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/ultracart_api/models/cart_item_option.rb, line 169
def list_invalid_properties
  invalid_properties = Array.new
  if !@selected_value.nil? && @selected_value.to_s.length > 1024
    invalid_properties.push('invalid value for "selected_value", the character length must be smaller than or equal to 1024.')
  end

  invalid_properties
end
selected_value=(selected_value) click to toggle source

Custom attribute writer method with validation @param [Object] selected_value Value to be assigned

# File lib/ultracart_api/models/cart_item_option.rb, line 189
def selected_value=(selected_value)
  if !selected_value.nil? && selected_value.to_s.length > 1024
    fail ArgumentError, 'invalid value for "selected_value", the character length must be smaller than or equal to 1024.'
  end

  @selected_value = selected_value
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/cart_item_option.rb, line 308
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/cart_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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ultracart_api/models/cart_item_option.rb, line 302
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/ultracart_api/models/cart_item_option.rb, line 199
def type=(type)
  validator = EnumAttributeValidator.new('String', ['single', 'multiline', 'dropdown', 'hidden', 'radio', 'fixed'])
  unless validator.valid?(type)
    fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
  end
  @type = type
end
valid?() click to toggle source

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/cart_item_option.rb, line 180
def valid?
  return false if !@selected_value.nil? && @selected_value.to_s.length > 1024
  type_validator = EnumAttributeValidator.new('String', ['single', 'multiline', 'dropdown', 'hidden', 'radio', 'fixed'])
  return false unless type_validator.valid?(@type)
  true
end