class VoucherifySdk::LoyaltiesEarningRulesUpdateRequestBody
Attributes
A flag to toggle the earning rule on or off. You can disable an earning rule even though it’s within the active period defined by the ‘start_date` and `expiration_date` of the campaign or the earning rule’s own ‘start_date` and `expiration_date`. - `true` indicates an active earning rule - `false` indicates an inactive earning rule
Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format. Earning rule is *inactive after* this date.If you don’t define the expiration date for an earning rule, it’ll inherit the campaign expiration date by default.
The metadata object stores all custom attributes assigned to the earning rule. A set of key/value pairs that you can attach to an earning rule object. It can be useful for storing additional information about the earning rule in a structured format.
Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. Earning rule is *inactive before* this date. If you don’t define the start date for an earning rule, it’ll inherit the campaign start date by default.
A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance.
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/loyalties_earning_rules_update_request_body.rb, line 238 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/loyalties_earning_rules_update_request_body.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/loyalties_earning_rules_update_request_body.rb, line 67 def self.attribute_map { :'validation_rule_id' => :'validation_rule_id', :'loyalty' => :'loyalty', :'source' => :'source', :'active' => :'active', :'start_date' => :'start_date', :'expiration_date' => :'expiration_date', :'validity_timeframe' => :'validity_timeframe', :'validity_day_of_week' => :'validity_day_of_week', :'validity_hours' => :'validity_hours', :'metadata' => :'metadata' } 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/loyalties_earning_rules_update_request_body.rb, line 214 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/loyalties_earning_rules_update_request_body.rb, line 118 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?(:'validation_rule_id') self.validation_rule_id = attributes[:'validation_rule_id'] end if attributes.key?(:'loyalty') self.loyalty = attributes[:'loyalty'] end if attributes.key?(:'source') self.source = attributes[:'source'] end if attributes.key?(:'active') self.active = attributes[:'active'] 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?(:'metadata') self.metadata = attributes[:'metadata'] end end
List of attributes with nullable: true
# File lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body.rb, line 104 def self.openapi_nullable Set.new([ :'validation_rule_id', :'loyalty', :'source', :'active', :'start_date', :'expiration_date', :'metadata' ]) end
Attribute type mapping.
# File lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body.rb, line 88 def self.openapi_types { :'validation_rule_id' => :'String', :'loyalty' => :'LoyaltiesEarningRulesUpdateRequestBodyLoyalty', :'source' => :'LoyaltiesEarningRulesUpdateRequestBodySource', :'active' => :'Boolean', :'start_date' => :'Time', :'expiration_date' => :'Time', :'validity_timeframe' => :'ValidityTimeframe', :'validity_day_of_week' => :'Array<Integer>', :'validity_hours' => :'ValidityHours', :'metadata' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body.rb, line 184 def ==(o) return true if self.equal?(o) self.class == o.class && validation_rule_id == o.validation_rule_id && loyalty == o.loyalty && source == o.source && active == o.active && 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 && metadata == o.metadata 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/loyalties_earning_rules_update_request_body.rb, line 309 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/loyalties_earning_rules_update_request_body.rb, line 201 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body.rb, line 207 def hash [validation_rule_id, loyalty, source, active, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, metadata].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/loyalties_earning_rules_update_request_body.rb, line 169 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/loyalties_earning_rules_update_request_body.rb, line 291 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/loyalties_earning_rules_update_request_body.rb, line 279 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/loyalties_earning_rules_update_request_body.rb, line 177 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end