class VoucherifySdk::LoyaltyCampaignVoucher
Schema model for a campaign voucher.
Attributes
Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign
is *inactive after* this date.
Always ‘false` for a loyalty card voucher
Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign
is *inactive before* this date.
Type of voucher.
Integer array corresponding to the particular days of the week in which the voucher is valid. - ‘0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday
Public Class Methods
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/loyalty_campaign_voucher.rb, line 247 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
Returns all the JSON keys this model knows about
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 83 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 67 def self.attribute_map { :'type' => :'type', :'loyalty_card' => :'loyalty_card', :'redemption' => :'redemption', :'code_config' => :'code_config', :'is_referral_code' => :'is_referral_code', :'start_date' => :'start_date', :'expiration_date' => :'expiration_date', :'validity_timeframe' => :'validity_timeframe', :'validity_day_of_week' => :'validity_day_of_week', :'validity_hours' => :'validity_hours' } end
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/loyalty_campaign_voucher.rb, line 223 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 116 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?(:'type') self.type = attributes[:'type'] else self.type = 'LOYALTY_CARD' end if attributes.key?(:'loyalty_card') self.loyalty_card = attributes[:'loyalty_card'] end if attributes.key?(:'redemption') self.redemption = attributes[:'redemption'] end if attributes.key?(:'code_config') self.code_config = attributes[:'code_config'] else self.code_config = nil end if attributes.key?(:'is_referral_code') self.is_referral_code = attributes[:'is_referral_code'] 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?(:'validity_timeframe') self.validity_timeframe = attributes[:'validity_timeframe'] end if attributes.key?(:'validity_day_of_week') if (value = attributes[:'validity_day_of_week']).is_a?(Array) self.validity_day_of_week = value end end if attributes.key?(:'validity_hours') self.validity_hours = attributes[:'validity_hours'] end end
List of attributes with nullable: true
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 104 def self.openapi_nullable Set.new([ :'type', :'redemption', :'is_referral_code', :'start_date', :'expiration_date', ]) end
Attribute type mapping.
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 88 def self.openapi_types { :'type' => :'String', :'loyalty_card' => :'CampaignLoyaltyCard', :'redemption' => :'LoyaltyCampaignVoucherRedemption', :'code_config' => :'CodeConfig', :'is_referral_code' => :'Boolean', :'start_date' => :'Time', :'expiration_date' => :'Time', :'validity_timeframe' => :'ValidityTimeframe', :'validity_day_of_week' => :'Array<Integer>', :'validity_hours' => :'ValidityHours' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 193 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && loyalty_card == o.loyalty_card && redemption == o.redemption && code_config == o.code_config && is_referral_code == o.is_referral_code && start_date == o.start_date && expiration_date == o.expiration_date && validity_timeframe == o.validity_timeframe && validity_day_of_week == o.validity_day_of_week && validity_hours == o.validity_hours end
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/loyalty_campaign_voucher.rb, line 318 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 210 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 216 def hash [type, loyalty_card, redemption, code_config, is_referral_code, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 171 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @code_config.nil? invalid_properties.push('invalid value for "code_config", code_config cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 300 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 288 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/VoucherifySdk/models/loyalty_campaign_voucher.rb, line 183 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["LOYALTY_CARD"]) return false unless type_validator.valid?(@type) return false if @code_config.nil? true end