class UltracartClient::ItemDigitalDelivery

Attributes

activation_code_description[RW]

Description of the activation code

activation_code_low_warning[RW]

The number of activation codes whcih should generate a warning email

activation_code_realtime_url[RW]

The URL to retrieve activation codes from in real-time

activation_code_shared_secret[RW]

Shared secret used when communicating with the real-time URL

activation_code_type[RW]

Type of activation code

digital_items[RW]

Digital items that customer can download when this item is purchased

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_delivery.rb, line 36
def self.attribute_map
  {
    :'activation_code_description' => :'activation_code_description',
    :'activation_code_low_warning' => :'activation_code_low_warning',
    :'activation_code_realtime_url' => :'activation_code_realtime_url',
    :'activation_code_shared_secret' => :'activation_code_shared_secret',
    :'activation_code_type' => :'activation_code_type',
    :'digital_items' => :'digital_items'
  }
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_delivery.rb, line 61
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?(:'activation_code_description')
    self.activation_code_description = attributes[:'activation_code_description']
  end

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

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

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

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

  if attributes.has_key?(:'digital_items')
    if (value = attributes[:'digital_items']).is_a?(Array)
      self.digital_items = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/item_digital_delivery.rb, line 48
def self.swagger_types
  {
    :'activation_code_description' => :'String',
    :'activation_code_low_warning' => :'Integer',
    :'activation_code_realtime_url' => :'String',
    :'activation_code_shared_secret' => :'String',
    :'activation_code_type' => :'String',
    :'digital_items' => :'Array<ItemDigitalItem>'
  }
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_delivery.rb, line 154
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activation_code_description == o.activation_code_description &&
      activation_code_low_warning == o.activation_code_low_warning &&
      activation_code_realtime_url == o.activation_code_realtime_url &&
      activation_code_shared_secret == o.activation_code_shared_secret &&
      activation_code_type == o.activation_code_type &&
      digital_items == o.digital_items
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_delivery.rb, line 201
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_delivery.rb, line 267
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
activation_code_description=(activation_code_description) click to toggle source

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

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

  @activation_code_description = activation_code_description
end
activation_code_realtime_url=(activation_code_realtime_url) click to toggle source

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

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

  @activation_code_realtime_url = activation_code_realtime_url
end
activation_code_shared_secret=(activation_code_shared_secret) click to toggle source

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

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

  @activation_code_shared_secret = activation_code_shared_secret
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_delivery.rb, line 180
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/item_digital_delivery.rb, line 167
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_delivery.rb, line 173
def hash
  [activation_code_description, activation_code_low_warning, activation_code_realtime_url, activation_code_shared_secret, activation_code_type, digital_items].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_delivery.rb, line 96
def list_invalid_properties
  invalid_properties = Array.new
  if !@activation_code_description.nil? && @activation_code_description.to_s.length > 50
    invalid_properties.push('invalid value for "activation_code_description", the character length must be smaller than or equal to 50.')
  end

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

  if !@activation_code_shared_secret.nil? && @activation_code_shared_secret.to_s.length > 20
    invalid_properties.push('invalid value for "activation_code_shared_secret", the character length must be smaller than or equal to 20.')
  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_digital_delivery.rb, line 247
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_delivery.rb, line 253
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_delivery.rb, line 241
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_delivery.rb, line 115
def valid?
  return false if !@activation_code_description.nil? && @activation_code_description.to_s.length > 50
  return false if !@activation_code_realtime_url.nil? && @activation_code_realtime_url.to_s.length > 350
  return false if !@activation_code_shared_secret.nil? && @activation_code_shared_secret.to_s.length > 20
  true
end