class VoucherifySdk::SimpleVoucher

Simplified voucher data.

Attributes

active[RW]

Shows whether the voucher is on or off. ‘true` indicates an active voucher and `false` indicates an inactive voucher.

campaign[RW]

Campaign name.

campaign_id[RW]

Campaign unique ID.

categories[RW]

Contains details about the category.

category_id[RW]

Unique identifier of the category that this voucher belongs to.

code[RW]

Voucher code.

created_at[RW]

Timestamp representing the date and time when the order was created in the ISO 8601 format.

discount[RW]
expiration_date[RW]

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is *inactive after* this date.

gift[RW]
holder_id[RW]

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

id[RW]

A unique identifier that represents the voucher assigned by Voucherify.

is_referral_code[RW]

Flag indicating whether this voucher is a referral code; ‘true` for campaign type `REFERRAL_PROGRAM`.

loyalty_card[RW]
metadata[RW]

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.

object[RW]

The type of the object represented by JSON.

redemption[RW]
referrer_id[RW]

Unique identifier of the referrer assigned by Voucherify.

start_date[RW]

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is *inactive before* this date.

type[RW]

Type of the voucher.

updated_at[RW]

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

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/simple_voucher.rb, line 366
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/simple_voucher.rb, line 128
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/simple_voucher.rb, line 101
def self.attribute_map
  {
    :'id' => :'id',
    :'code' => :'code',
    :'gift' => :'gift',
    :'discount' => :'discount',
    :'loyalty_card' => :'loyalty_card',
    :'type' => :'type',
    :'campaign' => :'campaign',
    :'campaign_id' => :'campaign_id',
    :'is_referral_code' => :'is_referral_code',
    :'holder_id' => :'holder_id',
    :'referrer_id' => :'referrer_id',
    :'category_id' => :'category_id',
    :'categories' => :'categories',
    :'active' => :'active',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'redemption' => :'redemption',
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'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/simple_voucher.rb, line 342
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/simple_voucher.rb, line 185
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?(:'code')
    self.code = attributes[:'code']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/VoucherifySdk/models/simple_voucher.rb, line 160
def self.openapi_nullable
  Set.new([
    :'id',
    :'code',
    :'type',
    :'campaign',
    :'campaign_id',
    :'is_referral_code',
    :'holder_id',
    :'referrer_id',
    :'category_id',
    :'categories',
    :'active',
    :'created_at',
    :'updated_at',
    :'redemption',
    :'start_date',
    :'expiration_date',
    :'metadata',
    :'object'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/VoucherifySdk/models/simple_voucher.rb, line 133
def self.openapi_types
  {
    :'id' => :'String',
    :'code' => :'String',
    :'gift' => :'Gift',
    :'discount' => :'Discount',
    :'loyalty_card' => :'SimpleLoyaltyCard',
    :'type' => :'String',
    :'campaign' => :'String',
    :'campaign_id' => :'String',
    :'is_referral_code' => :'Boolean',
    :'holder_id' => :'String',
    :'referrer_id' => :'String',
    :'category_id' => :'String',
    :'categories' => :'Array<Category>',
    :'active' => :'Boolean',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'redemption' => :'SimpleVoucherRedemption',
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'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/simple_voucher.rb, line 301
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      code == o.code &&
      gift == o.gift &&
      discount == o.discount &&
      loyalty_card == o.loyalty_card &&
      type == o.type &&
      campaign == o.campaign &&
      campaign_id == o.campaign_id &&
      is_referral_code == o.is_referral_code &&
      holder_id == o.holder_id &&
      referrer_id == o.referrer_id &&
      category_id == o.category_id &&
      categories == o.categories &&
      active == o.active &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      redemption == o.redemption &&
      start_date == o.start_date &&
      expiration_date == o.expiration_date &&
      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/simple_voucher.rb, line 437
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/simple_voucher.rb, line 329
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/simple_voucher.rb, line 335
def hash
  [id, code, gift, discount, loyalty_card, type, campaign, campaign_id, is_referral_code, holder_id, referrer_id, category_id, categories, active, created_at, updated_at, redemption, start_date, expiration_date, 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/simple_voucher.rb, line 282
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/simple_voucher.rb, line 413
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/simple_voucher.rb, line 419
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/simple_voucher.rb, line 407
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/simple_voucher.rb, line 290
def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["DISCOUNT_VOUCHER", "LOYALTY_CARD", "GIFT_VOUCHER"])
  return false unless type_validator.valid?(@type)
  object_validator = EnumAttributeValidator.new('String', ["voucher"])
  return false unless object_validator.valid?(@object)
  true
end