class VoucherifySdk::VouchersCreateRequestBody
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.
Identifies the voucher’s parent campaign using a unique campaign name.
Identifies the voucher’s parent campaign using a unique campaign ID assigned by the Voucherify API.
The name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](ref:list-vouchers) endpoint.
Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](ref:list-vouchers) endpoint.
Code that identifies a voucher. The pattern can use all the letters of the English alphabet, Arabic numerals, and special characters. Pass this attribute in the request body to create a distinct code. Otherwise, either use the ‘code_config` object to set the rules that the Voucherify API will use to create a random code, or don’t pass any code and Voucherify will generate a random code.
Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format. Voucher
is *inactive after* this date.
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.
Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher
is *inactive before* this date.
Array containing the ID of the validation rule associated with the 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/vouchers_create_request_body.rb, line 344 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/vouchers_create_request_body.rb, line 119 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/VoucherifySdk/models/vouchers_create_request_body.rb, line 93 def self.attribute_map { :'code' => :'code', :'campaign' => :'campaign', :'campaign_id' => :'campaign_id', :'category' => :'category', :'category_id' => :'category_id', :'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', :'validation_rules' => :'validation_rules', :'redemption' => :'redemption', :'type' => :'type', :'loyalty_card' => :'loyalty_card', :'code_config' => :'code_config', :'gift' => :'gift', :'discount' => :'discount' } 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/vouchers_create_request_body.rb, line 320 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/vouchers_create_request_body.rb, line 170 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?(:'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?(:'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?(:'validation_rules') if (value = attributes[:'validation_rules']).is_a?(Array) self.validation_rules = value end end if attributes.key?(:'redemption') self.redemption = attributes[:'redemption'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'loyalty_card') self.loyalty_card = attributes[:'loyalty_card'] end if attributes.key?(:'code_config') self.code_config = attributes[:'code_config'] end if attributes.key?(:'gift') self.gift = attributes[:'gift'] end if attributes.key?(:'discount') self.discount = attributes[:'discount'] end end
List of attributes with nullable: true
# File lib/VoucherifySdk/models/vouchers_create_request_body.rb, line 150 def self.openapi_nullable Set.new([ :'code', :'campaign', :'campaign_id', :'category', :'category_id', :'start_date', :'expiration_date', :'active', :'additional_info', :'metadata', :'validation_rules', :'redemption', :'type', ]) end
Attribute type mapping.
# File lib/VoucherifySdk/models/vouchers_create_request_body.rb, line 124 def self.openapi_types { :'code' => :'String', :'campaign' => :'String', :'campaign_id' => :'String', :'category' => :'String', :'category_id' => :'String', :'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', :'validation_rules' => :'Array<String>', :'redemption' => :'VouchersCreateRequestBodyRedemption', :'type' => :'String', :'loyalty_card' => :'SimpleLoyaltyCard', :'code_config' => :'CodeConfig', :'gift' => :'Gift', :'discount' => :'Discount' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/VoucherifySdk/models/vouchers_create_request_body.rb, line 280 def ==(o) return true if self.equal?(o) self.class == o.class && code == o.code && campaign == o.campaign && campaign_id == o.campaign_id && category == o.category && category_id == o.category_id && 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 && validation_rules == o.validation_rules && redemption == o.redemption && type == o.type && loyalty_card == o.loyalty_card && code_config == o.code_config && gift == o.gift && discount == o.discount 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/vouchers_create_request_body.rb, line 415 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/vouchers_create_request_body.rb, line 307 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/VoucherifySdk/models/vouchers_create_request_body.rb, line 313 def hash [code, campaign, campaign_id, category, category_id, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, active, additional_info, metadata, validation_rules, redemption, type, loyalty_card, code_config, gift, discount].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/vouchers_create_request_body.rb, line 263 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/vouchers_create_request_body.rb, line 397 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/vouchers_create_request_body.rb, line 385 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/vouchers_create_request_body.rb, line 271 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["LOYALTY_CARD", "GIFT_VOUCHER", "DISCOUNT_VOUCHER"]) return false unless type_validator.valid?(@type) true end