class UltracartClient::ItemDigitalItem

Attributes

creation_dts[RW]

File creation date

description[RW]

Description of the digital item

file_size[RW]

File size

mime_type[RW]

Mime type associated with the file

original_filename[RW]

Original filename

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_digital_item.rb, line 33
def self.attribute_map
  {
    :'creation_dts' => :'creation_dts',
    :'description' => :'description',
    :'file_size' => :'file_size',
    :'mime_type' => :'mime_type',
    :'original_filename' => :'original_filename'
  }
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_digital_item.rb, line 56
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?(:'creation_dts')
    self.creation_dts = attributes[:'creation_dts']
  end

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/item_digital_item.rb, line 44
def self.swagger_types
  {
    :'creation_dts' => :'String',
    :'description' => :'String',
    :'file_size' => :'Integer',
    :'mime_type' => :'String',
    :'original_filename' => :'String'
  }
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_digital_item.rb, line 143
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      creation_dts == o.creation_dts &&
      description == o.description &&
      file_size == o.file_size &&
      mime_type == o.mime_type &&
      original_filename == o.original_filename
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_digital_item.rb, line 189
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_digital_item.rb, line 255
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_digital_item.rb, line 168
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
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_digital_item.rb, line 113
def description=(description)
  if !description.nil? && description.to_s.length > 200
    fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 200.'
  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_digital_item.rb, line 155
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/item_digital_item.rb, line 161
def hash
  [creation_dts, description, file_size, mime_type, original_filename].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_digital_item.rb, line 85
def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 200
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 200.')
  end

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

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

  invalid_properties
end
mime_type=(mime_type) click to toggle source

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

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

  @mime_type = mime_type
end
original_filename=(original_filename) click to toggle source

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

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

  @original_filename = original_filename
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_digital_item.rb, line 235
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_digital_item.rb, line 241
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_digital_item.rb, line 229
def to_s
  to_hash.to_s
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_digital_item.rb, line 104
def valid?
  return false if !@description.nil? && @description.to_s.length > 200
  return false if !@mime_type.nil? && @mime_type.to_s.length > 100
  return false if !@original_filename.nil? && @original_filename.to_s.length > 250
  true
end