class UltracartClient::ItemContentMultimedia

Attributes

cloud_url[RW]

URL where the image can be downloaded from the cloud

cloud_url_expiration[RW]

Expiration date of the cloud URL

code[RW]

Code assigned to the file

description[RW]

Description

file_name[RW]

File name

height[RW]

Height of the image

merchant_item_multimedia_oid[RW]

Item multimedia object identifier

orphan[RW]

True if the multimedia is an orphan of the active StoreFront themes

placeholder[RW]

True if the object is a place holder that can be populated

temp_multimedia_oid[RW]

Temporary multimedia object identifier assigned if uploading new multimedia

thumbnails[RW]

Thumbnails of this image

type[RW]

Type of file

url[RW]

URL to download file (on new multimedia record this can be a URL for UltraCart to fetch)

width[RW]

Width of the image

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/item_content_multimedia.rb, line 85
def self.attribute_map
  {
    :'cloud_url' => :'cloud_url',
    :'cloud_url_expiration' => :'cloud_url_expiration',
    :'code' => :'code',
    :'description' => :'description',
    :'exclude_from_gallery' => :'exclude_from_gallery',
    :'file_name' => :'file_name',
    :'height' => :'height',
    :'merchant_item_multimedia_oid' => :'merchant_item_multimedia_oid',
    :'orphan' => :'orphan',
    :'placeholder' => :'placeholder',
    :'temp_multimedia_oid' => :'temp_multimedia_oid',
    :'thumbnails' => :'thumbnails',
    :'type' => :'type',
    :'url' => :'url',
    :'width' => :'width'
  }
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/item_content_multimedia.rb, line 128
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?(:'cloud_url')
    self.cloud_url = attributes[:'cloud_url']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'width')
    self.width = attributes[:'width']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/item_content_multimedia.rb, line 106
def self.swagger_types
  {
    :'cloud_url' => :'String',
    :'cloud_url_expiration' => :'String',
    :'code' => :'String',
    :'description' => :'String',
    :'exclude_from_gallery' => :'BOOLEAN',
    :'file_name' => :'String',
    :'height' => :'Integer',
    :'merchant_item_multimedia_oid' => :'Integer',
    :'orphan' => :'BOOLEAN',
    :'placeholder' => :'BOOLEAN',
    :'temp_multimedia_oid' => :'Integer',
    :'thumbnails' => :'Array<ItemContentMultimediaThumbnail>',
    :'type' => :'String',
    :'url' => :'String',
    :'width' => :'Integer'
  }
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/item_content_multimedia.rb, line 269
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cloud_url == o.cloud_url &&
      cloud_url_expiration == o.cloud_url_expiration &&
      code == o.code &&
      description == o.description &&
      exclude_from_gallery == o.exclude_from_gallery &&
      file_name == o.file_name &&
      height == o.height &&
      merchant_item_multimedia_oid == o.merchant_item_multimedia_oid &&
      orphan == o.orphan &&
      placeholder == o.placeholder &&
      temp_multimedia_oid == o.temp_multimedia_oid &&
      thumbnails == o.thumbnails &&
      type == o.type &&
      url == o.url &&
      width == o.width
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/item_content_multimedia.rb, line 325
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/item_content_multimedia.rb, line 391
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/item_content_multimedia.rb, line 304
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
code=(code) click to toggle source

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

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

  @code = code
end
description=(description) click to toggle source

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

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

  @description = description
end
eql?(o) click to toggle source

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

# File lib/ultracart_api/models/item_content_multimedia.rb, line 291
def eql?(o)
  self == o
end
file_name=(file_name) click to toggle source

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

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

  @file_name = file_name
end
hash() click to toggle source

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

# File lib/ultracart_api/models/item_content_multimedia.rb, line 297
def hash
  [cloud_url, cloud_url_expiration, code, description, exclude_from_gallery, file_name, height, merchant_item_multimedia_oid, orphan, placeholder, temp_multimedia_oid, thumbnails, type, url, width].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/item_content_multimedia.rb, line 199
def list_invalid_properties
  invalid_properties = Array.new
  if !@code.nil? && @code.to_s.length > 20
    invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 20.')
  end

  if !@description.nil? && @description.to_s.length > 50000
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 50000.')
  end

  if !@file_name.nil? && @file_name.to_s.length > 75
    invalid_properties.push('invalid value for "file_name", the character length must be smaller than or equal to 75.')
  end

  invalid_properties
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/item_content_multimedia.rb, line 371
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/item_content_multimedia.rb, line 377
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/item_content_multimedia.rb, line 365
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/item_content_multimedia.rb, line 259
def type=(type)
  validator = EnumAttributeValidator.new('String', ['Image', 'PDF', 'Text', 'Unknown', 'Video'])
  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/item_content_multimedia.rb, line 218
def valid?
  return false if !@code.nil? && @code.to_s.length > 20
  return false if !@description.nil? && @description.to_s.length > 50000
  return false if !@file_name.nil? && @file_name.to_s.length > 75
  type_validator = EnumAttributeValidator.new('String', ['Image', 'PDF', 'Text', 'Unknown', 'Video'])
  return false unless type_validator.valid?(@type)
  true
end