class VoucherifySdk::RedeemableHolder

Single customer’s redeemable

Attributes

campaign_id[RW]

Unique identifier of the campaign as assigned by Voucherify.

campaign_type[RW]

Defines the type of the campaign.

created_at[RW]

Timestamp representing the date and time when the redeemable was assigned. The value is shown in the ISO 8601 format.

customer_id[RW]

Unique identifier of the customer.

holder_role[RW]

Role of the holder.

id[RW]

Unique identifier of the redeemable holder.

metadata[RW]

A set of custom key/value pairs that you can attach to a redeemable holder. The metadata object stores all custom attributes assigned to the ‘redeemable_holder` object.

object[RW]

The type of the object represented by JSON.

redeemable_id[RW]

Identifier of the redeemable item.

redeemable_object[RW]

Type of the redeemable.

voucher_type[RW]

Defines the type of the voucher.

Public Class Methods

_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/VoucherifySdk/models/redeemable_holder.rb, line 267
def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = VoucherifySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/VoucherifySdk/models/redeemable_holder.rb, line 92
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/VoucherifySdk/models/redeemable_holder.rb, line 75
def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'redeemable_id' => :'redeemable_id',
    :'redeemable_object' => :'redeemable_object',
    :'customer_id' => :'customer_id',
    :'holder_role' => :'holder_role',
    :'campaign_id' => :'campaign_id',
    :'campaign_type' => :'campaign_type',
    :'voucher_type' => :'voucher_type',
    :'metadata' => :'metadata',
    :'object' => :'object'
  }
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/VoucherifySdk/models/redeemable_holder.rb, line 243
def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end
new(attributes = {}) click to toggle source

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

# File lib/VoucherifySdk/models/redeemable_holder.rb, line 132
def initialize(attributes = {})
  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'redeemable_id')
    self.redeemable_id = attributes[:'redeemable_id']
  end

  if attributes.key?(:'redeemable_object')
    self.redeemable_object = attributes[:'redeemable_object']
  end

  if attributes.key?(:'customer_id')
    self.customer_id = attributes[:'customer_id']
  end

  if attributes.key?(:'holder_role')
    self.holder_role = attributes[:'holder_role']
  end

  if attributes.key?(:'campaign_id')
    self.campaign_id = attributes[:'campaign_id']
  end

  if attributes.key?(:'campaign_type')
    self.campaign_type = attributes[:'campaign_type']
  else
    self.campaign_type = 'REFERRAL_PROGRAM'
  end

  if attributes.key?(:'voucher_type')
    self.voucher_type = attributes[:'voucher_type']
  end

  if attributes.key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'redeemable_holder'
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/VoucherifySdk/models/redeemable_holder.rb, line 114
def self.openapi_nullable
  Set.new([
    :'id',
    :'created_at',
    :'redeemable_id',
    :'redeemable_object',
    :'customer_id',
    :'holder_role',
    :'campaign_id',
    :'campaign_type',
    :'voucher_type',
    :'metadata',
    :'object'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/VoucherifySdk/models/redeemable_holder.rb, line 97
def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Time',
    :'redeemable_id' => :'String',
    :'redeemable_object' => :'String',
    :'customer_id' => :'String',
    :'holder_role' => :'String',
    :'campaign_id' => :'String',
    :'campaign_type' => :'String',
    :'voucher_type' => :'String',
    :'metadata' => :'Object',
    :'object' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/VoucherifySdk/models/redeemable_holder.rb, line 212
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      redeemable_id == o.redeemable_id &&
      redeemable_object == o.redeemable_object &&
      customer_id == o.customer_id &&
      holder_role == o.holder_role &&
      campaign_id == o.campaign_id &&
      campaign_type == o.campaign_type &&
      voucher_type == o.voucher_type &&
      metadata == o.metadata &&
      object == o.object
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/VoucherifySdk/models/redeemable_holder.rb, line 338
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
eql?(o) click to toggle source

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

# File lib/VoucherifySdk/models/redeemable_holder.rb, line 230
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/VoucherifySdk/models/redeemable_holder.rb, line 236
def hash
  [id, created_at, redeemable_id, redeemable_object, customer_id, holder_role, campaign_id, campaign_type, voucher_type, metadata, object].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/VoucherifySdk/models/redeemable_holder.rb, line 189
def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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/VoucherifySdk/models/redeemable_holder.rb, line 314
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/VoucherifySdk/models/redeemable_holder.rb, line 320
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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/VoucherifySdk/models/redeemable_holder.rb, line 308
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/VoucherifySdk/models/redeemable_holder.rb, line 197
def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  holder_role_validator = EnumAttributeValidator.new('String', ["OWNER", "REFERRER", "REFEREE"])
  return false unless holder_role_validator.valid?(@holder_role)
  campaign_type_validator = EnumAttributeValidator.new('String', ["REFERRAL_PROGRAM"])
  return false unless campaign_type_validator.valid?(@campaign_type)
  voucher_type_validator = EnumAttributeValidator.new('String', ["GIFT_VOUCHER", "DISCOUNT_VOUCHER", "LOYALTY_CARD"])
  return false unless voucher_type_validator.valid?(@voucher_type)
  object_validator = EnumAttributeValidator.new('String', ["redeemable_holder"])
  return false unless object_validator.valid?(@object)
  true
end