class VoucherifySdk::LoyaltiesUpdateCampaignRequestBody
Request body schema for PUT ‘/loyalties/{campaignId}`.
Attributes
Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.
Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
The category assigned to the campaign. Either pass this parameter OR the ‘category_id`.
Unique category ID that this campaign belongs to. Either pass this parameter OR the ‘category`.
An optional field to keep any extra textual information about the campaign such as a campaign description and details.
Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign
is *inactive after* this date.
If this value is set to ‘true`, customers will be able to join the campaign only once.
The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.
Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign
is *inactive before* this date.
Defines whether the campaign can be updated with new vouchers after campaign creation. - ‘AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published.
Determine which metadata should be removed from campaign.
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_update_campaign_request_body.rb, line 308 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_update_campaign_request_body.rb, line 108 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb, line 86 def self.attribute_map { :'start_date' => :'start_date', :'expiration_date' => :'expiration_date', :'validity_timeframe' => :'validity_timeframe', :'validity_day_of_week' => :'validity_day_of_week', :'validity_hours' => :'validity_hours', :'description' => :'description', :'category' => :'category', :'metadata' => :'metadata', :'unset_metadata_fields' => :'unset_metadata_fields', :'category_id' => :'category_id', :'activity_duration_after_publishing' => :'activity_duration_after_publishing', :'join_once' => :'join_once', :'auto_join' => :'auto_join', :'type' => :'type', :'loyalty_tiers_expiration' => :'loyalty_tiers_expiration', :'options' => :'options' } 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_update_campaign_request_body.rb, line 284 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_update_campaign_request_body.rb, line 154 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?(:'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?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'category') self.category = attributes[:'category'] end if attributes.key?(:'metadata') self.metadata = attributes[:'metadata'] end if attributes.key?(:'unset_metadata_fields') if (value = attributes[:'unset_metadata_fields']).is_a?(Array) self.unset_metadata_fields = value end end if attributes.key?(:'category_id') self.category_id = attributes[:'category_id'] end if attributes.key?(:'activity_duration_after_publishing') self.activity_duration_after_publishing = attributes[:'activity_duration_after_publishing'] end if attributes.key?(:'join_once') self.join_once = attributes[:'join_once'] end if attributes.key?(:'auto_join') self.auto_join = attributes[:'auto_join'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'loyalty_tiers_expiration') self.loyalty_tiers_expiration = attributes[:'loyalty_tiers_expiration'] end if attributes.key?(:'options') self.options = attributes[:'options'] end end
List of attributes with nullable: true
# File lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb, line 135 def self.openapi_nullable Set.new([ :'start_date', :'expiration_date', :'description', :'category', :'metadata', :'unset_metadata_fields', :'category_id', :'activity_duration_after_publishing', :'join_once', :'auto_join', :'type', :'options' ]) end
Attribute type mapping.
# File lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb, line 113 def self.openapi_types { :'start_date' => :'Time', :'expiration_date' => :'Time', :'validity_timeframe' => :'ValidityTimeframe', :'validity_day_of_week' => :'Array<Integer>', :'validity_hours' => :'ValidityHours', :'description' => :'String', :'category' => :'String', :'metadata' => :'Object', :'unset_metadata_fields' => :'Array<String>', :'category_id' => :'String', :'activity_duration_after_publishing' => :'String', :'join_once' => :'Boolean', :'auto_join' => :'Boolean', :'type' => :'String', :'loyalty_tiers_expiration' => :'LoyaltyTiersExpirationAll', :'options' => :'LoyaltiesUpdateCampaignRequestBodyOptions' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb, line 248 def ==(o) return true if self.equal?(o) self.class == o.class && 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 && description == o.description && category == o.category && metadata == o.metadata && unset_metadata_fields == o.unset_metadata_fields && category_id == o.category_id && activity_duration_after_publishing == o.activity_duration_after_publishing && join_once == o.join_once && auto_join == o.auto_join && type == o.type && loyalty_tiers_expiration == o.loyalty_tiers_expiration && options == o.options 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_update_campaign_request_body.rb, line 379 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_update_campaign_request_body.rb, line 271 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb, line 277 def hash [start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, description, category, metadata, unset_metadata_fields, category_id, activity_duration_after_publishing, join_once, auto_join, type, loyalty_tiers_expiration, options].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_update_campaign_request_body.rb, line 231 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_update_campaign_request_body.rb, line 361 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_update_campaign_request_body.rb, line 349 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_update_campaign_request_body.rb, line 239 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["AUTO_UPDATE", "STATIC"]) return false unless type_validator.valid?(@type) true end