class UltracartClient::CustomerSoftwareEntitlement

Attributes

activation_code[RW]

Activation Code Associated with the software

activation_dts[RW]

Date/time when the activation code was created

customer_software_entitlement_oid[RW]

Customer profile software entitlement object identifier

expiration_dts[RW]

Date/time when the activation code will expire

purchased_via_item_description[RW]

Item description used to purchase this software.

purchased_via_item_id[RW]

Item ID used to purchase this software.

purchased_via_order_id[RW]

Order ID used to purchase this software.

software_sku[RW]

SKU of the software

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/customer_software_entitlement.rb, line 42
def self.attribute_map
  {
    :'activation_code' => :'activation_code',
    :'activation_dts' => :'activation_dts',
    :'customer_software_entitlement_oid' => :'customer_software_entitlement_oid',
    :'expiration_dts' => :'expiration_dts',
    :'purchased_via_item_description' => :'purchased_via_item_description',
    :'purchased_via_item_id' => :'purchased_via_item_id',
    :'purchased_via_order_id' => :'purchased_via_order_id',
    :'software_sku' => :'software_sku'
  }
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/customer_software_entitlement.rb, line 71
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')
    self.activation_code = attributes[:'activation_code']
  end

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/customer_software_entitlement.rb, line 56
def self.swagger_types
  {
    :'activation_code' => :'String',
    :'activation_dts' => :'String',
    :'customer_software_entitlement_oid' => :'Integer',
    :'expiration_dts' => :'String',
    :'purchased_via_item_description' => :'String',
    :'purchased_via_item_id' => :'String',
    :'purchased_via_order_id' => :'String',
    :'software_sku' => :'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/customer_software_entitlement.rb, line 200
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activation_code == o.activation_code &&
      activation_dts == o.activation_dts &&
      customer_software_entitlement_oid == o.customer_software_entitlement_oid &&
      expiration_dts == o.expiration_dts &&
      purchased_via_item_description == o.purchased_via_item_description &&
      purchased_via_item_id == o.purchased_via_item_id &&
      purchased_via_order_id == o.purchased_via_order_id &&
      software_sku == o.software_sku
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/customer_software_entitlement.rb, line 249
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/customer_software_entitlement.rb, line 315
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=(activation_code) click to toggle source

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

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

  @activation_code = activation_code
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/customer_software_entitlement.rb, line 228
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/customer_software_entitlement.rb, line 215
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/customer_software_entitlement.rb, line 221
def hash
  [activation_code, activation_dts, customer_software_entitlement_oid, expiration_dts, purchased_via_item_description, purchased_via_item_id, purchased_via_order_id, software_sku].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/customer_software_entitlement.rb, line 112
def list_invalid_properties
  invalid_properties = Array.new
  if !@activation_code.nil? && @activation_code.to_s.length > 50
    invalid_properties.push('invalid value for "activation_code", the character length must be smaller than or equal to 50.')
  end

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

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

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

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

  invalid_properties
end
purchased_via_item_description=(purchased_via_item_description) click to toggle source

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

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

  @purchased_via_item_description = purchased_via_item_description
end
purchased_via_item_id=(purchased_via_item_id) click to toggle source

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

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

  @purchased_via_item_id = purchased_via_item_id
end
purchased_via_order_id=(purchased_via_order_id) click to toggle source

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

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

  @purchased_via_order_id = purchased_via_order_id
end
software_sku=(software_sku) click to toggle source

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

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

  @software_sku = software_sku
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/customer_software_entitlement.rb, line 295
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/customer_software_entitlement.rb, line 301
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/customer_software_entitlement.rb, line 289
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/customer_software_entitlement.rb, line 139
def valid?
  return false if !@activation_code.nil? && @activation_code.to_s.length > 50
  return false if !@purchased_via_item_description.nil? && @purchased_via_item_description.to_s.length > 512
  return false if !@purchased_via_item_id.nil? && @purchased_via_item_id.to_s.length > 20
  return false if !@purchased_via_order_id.nil? && @purchased_via_order_id.to_s.length > 30
  return false if !@software_sku.nil? && @software_sku.to_s.length > 30
  true
end