class VoucherifySdk::LoyaltyMember
This is an object representing a loyalty member.
Attributes
A flag to toggle the voucher on or off. You can disable a voucher even though it’s within the active period defined by the ‘start_date` and `expiration_date`. - `true` indicates an active voucher - `false` indicates an inactive voucher
An optional field to keep any extra textual information about the code such as a code description and details.
A unique campaign name, identifies the voucher’s parent campaign.
Assigned by the Voucherify API, identifies the voucher’s parent campaign.
Tag defining the category that this voucher belongs to.
Unique category ID assigned by Voucherify.
A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.
Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format.
Expiration timestamp defines when the code expires in ISO 8601 format. Voucher
is *inactive after* this date.
Unique identifier of the customer who owns the voucher.
Assigned by the Voucherify API, identifies the voucher.
This is always false for loyalty members.
The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
The type of the object represented by JSON. Default is ‘voucher`.
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher
is *inactive before* this date.
Defines the type of the voucher.
Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.
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_member.rb, line 416 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_member.rb, line 144 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/VoucherifySdk/models/loyalty_member.rb, line 112 def self.attribute_map { :'id' => :'id', :'code' => :'code', :'campaign' => :'campaign', :'campaign_id' => :'campaign_id', :'category' => :'category', :'category_id' => :'category_id', :'type' => :'type', :'discount' => :'discount', :'gift' => :'gift', :'loyalty_card' => :'loyalty_card', :'start_date' => :'start_date', :'expiration_date' => :'expiration_date', :'validity_timeframe' => :'validity_timeframe', :'validity_day_of_week' => :'validity_day_of_week', :'validity_hours' => :'validity_hours', :'active' => :'active', :'additional_info' => :'additional_info', :'metadata' => :'metadata', :'assets' => :'assets', :'is_referral_code' => :'is_referral_code', :'created_at' => :'created_at', :'updated_at' => :'updated_at', :'holder_id' => :'holder_id', :'object' => :'object', :'publish' => :'publish', :'redemption' => :'redemption' } 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_member.rb, line 392 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_member.rb, line 210 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?(:'campaign') self.campaign = attributes[:'campaign'] end if attributes.key?(:'campaign_id') self.campaign_id = attributes[:'campaign_id'] end if attributes.key?(:'category') self.category = attributes[:'category'] end if attributes.key?(:'category_id') self.category_id = attributes[:'category_id'] end if attributes.key?(:'type') self.type = attributes[:'type'] else self.type = 'LOYALTY_CARD' end if attributes.key?(:'discount') self.discount = attributes[:'discount'] end if attributes.key?(:'gift') self.gift = attributes[:'gift'] end if attributes.key?(:'loyalty_card') self.loyalty_card = attributes[:'loyalty_card'] 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 if attributes.key?(:'active') self.active = attributes[:'active'] end if attributes.key?(:'additional_info') self.additional_info = attributes[:'additional_info'] end if attributes.key?(:'metadata') self.metadata = attributes[:'metadata'] end if attributes.key?(:'assets') self.assets = attributes[:'assets'] end if attributes.key?(:'is_referral_code') self.is_referral_code = attributes[:'is_referral_code'] 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?(:'holder_id') self.holder_id = attributes[:'holder_id'] end if attributes.key?(:'object') self.object = attributes[:'object'] else self.object = 'voucher' end if attributes.key?(:'publish') self.publish = attributes[:'publish'] end if attributes.key?(:'redemption') self.redemption = attributes[:'redemption'] end end
List of attributes with nullable: true
# File lib/VoucherifySdk/models/loyalty_member.rb, line 181 def self.openapi_nullable Set.new([ :'id', :'code', :'campaign', :'campaign_id', :'category', :'category_id', :'type', :'discount', :'gift', :'loyalty_card', :'start_date', :'expiration_date', :'active', :'additional_info', :'metadata', :'is_referral_code', :'created_at', :'updated_at', :'holder_id', :'object', :'publish', :'redemption' ]) end
Attribute type mapping.
# File lib/VoucherifySdk/models/loyalty_member.rb, line 149 def self.openapi_types { :'id' => :'String', :'code' => :'String', :'campaign' => :'String', :'campaign_id' => :'String', :'category' => :'String', :'category_id' => :'String', :'type' => :'String', :'discount' => :'Object', :'gift' => :'Object', :'loyalty_card' => :'LoyaltyMemberLoyaltyCard', :'start_date' => :'Time', :'expiration_date' => :'Time', :'validity_timeframe' => :'ValidityTimeframe', :'validity_day_of_week' => :'Array<Integer>', :'validity_hours' => :'ValidityHours', :'active' => :'Boolean', :'additional_info' => :'String', :'metadata' => :'Object', :'assets' => :'VoucherAssets', :'is_referral_code' => :'Boolean', :'created_at' => :'Time', :'updated_at' => :'Time', :'holder_id' => :'String', :'object' => :'String', :'publish' => :'LoyaltyMemberPublish', :'redemption' => :'LoyaltyMemberRedemption' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/VoucherifySdk/models/loyalty_member.rb, line 346 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && code == o.code && campaign == o.campaign && campaign_id == o.campaign_id && category == o.category && category_id == o.category_id && type == o.type && discount == o.discount && gift == o.gift && loyalty_card == o.loyalty_card && 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 && active == o.active && additional_info == o.additional_info && metadata == o.metadata && assets == o.assets && is_referral_code == o.is_referral_code && created_at == o.created_at && updated_at == o.updated_at && holder_id == o.holder_id && object == o.object && publish == o.publish && redemption == o.redemption 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_member.rb, line 487 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_member.rb, line 379 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/VoucherifySdk/models/loyalty_member.rb, line 385 def hash [id, code, campaign, campaign_id, category, category_id, type, discount, gift, loyalty_card, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, active, additional_info, metadata, assets, is_referral_code, created_at, updated_at, holder_id, object, publish, redemption].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_member.rb, line 329 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new 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_member.rb, line 469 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_member.rb, line 457 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_member.rb, line 337 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["LOYALTY_CARD"]) return false unless type_validator.valid?(@type) true end