class TalonOne::NewCoupons
Attributes
Arbitrary properties associated with this item
The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set.
The amount of discounts that can be given with this coupon code.
Expiry date of the coupon. Coupon
never expires if this is omitted, zero, or negative.
The number of new coupon codes to generate for the campaign. Must be at least 1.
The integration ID for this coupon's beneficiary's profile
Timestamp at which point the coupon becomes valid.
A unique prefix to prepend to all generated coupons.
The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply.
Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp).
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/talon_one/models/new_coupons.rb, line 49 def self.attribute_map { :'usage_limit' => :'usageLimit', :'discount_limit' => :'discountLimit', :'start_date' => :'startDate', :'expiry_date' => :'expiryDate', :'number_of_coupons' => :'numberOfCoupons', :'unique_prefix' => :'uniquePrefix', :'attributes' => :'attributes', :'recipient_integration_id' => :'recipientIntegrationId', :'valid_characters' => :'validCharacters', :'coupon_pattern' => :'couponPattern' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/talon_one/models/new_coupons.rb, line 275 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/talon_one/models/new_coupons.rb, line 88 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::NewCoupons` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::NewCoupons`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'usage_limit') self.usage_limit = attributes[:'usage_limit'] end if attributes.key?(:'discount_limit') self.discount_limit = attributes[:'discount_limit'] end if attributes.key?(:'start_date') self.start_date = attributes[:'start_date'] end if attributes.key?(:'expiry_date') self.expiry_date = attributes[:'expiry_date'] end if attributes.key?(:'number_of_coupons') self.number_of_coupons = attributes[:'number_of_coupons'] end if attributes.key?(:'unique_prefix') self.unique_prefix = attributes[:'unique_prefix'] end if attributes.key?(:'attributes') self.attributes = attributes[:'attributes'] end if attributes.key?(:'recipient_integration_id') self.recipient_integration_id = attributes[:'recipient_integration_id'] end if attributes.key?(:'valid_characters') if (value = attributes[:'valid_characters']).is_a?(Array) self.valid_characters = value end end if attributes.key?(:'coupon_pattern') self.coupon_pattern = attributes[:'coupon_pattern'] end end
List of attributes with nullable: true
# File lib/talon_one/models/new_coupons.rb, line 81 def self.openapi_nullable Set.new([ ]) end
Attribute
type mapping.
# File lib/talon_one/models/new_coupons.rb, line 65 def self.openapi_types { :'usage_limit' => :'Integer', :'discount_limit' => :'Float', :'start_date' => :'DateTime', :'expiry_date' => :'DateTime', :'number_of_coupons' => :'Integer', :'unique_prefix' => :'String', :'attributes' => :'Object', :'recipient_integration_id' => :'String', :'valid_characters' => :'Array<String>', :'coupon_pattern' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/talon_one/models/new_coupons.rb, line 245 def ==(o) return true if self.equal?(o) self.class == o.class && usage_limit == o.usage_limit && discount_limit == o.discount_limit && start_date == o.start_date && expiry_date == o.expiry_date && number_of_coupons == o.number_of_coupons && unique_prefix == o.unique_prefix && attributes == o.attributes && recipient_integration_id == o.recipient_integration_id && valid_characters == o.valid_characters && coupon_pattern == o.coupon_pattern end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/talon_one/models/new_coupons.rb, line 303 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 TalonOne.const_get(type).build_from_hash(value) end 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/talon_one/models/new_coupons.rb, line 372 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/talon_one/models/new_coupons.rb, line 282 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if 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[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
Custom attribute writer method with validation @param [Object] coupon_pattern
Value to be assigned
# File lib/talon_one/models/new_coupons.rb, line 231 def coupon_pattern=(coupon_pattern) if !coupon_pattern.nil? && coupon_pattern.to_s.length > 100 fail ArgumentError, 'invalid value for "coupon_pattern", the character length must be smaller than or equal to 100.' end if !coupon_pattern.nil? && coupon_pattern.to_s.length < 3 fail ArgumentError, 'invalid value for "coupon_pattern", the character length must be great than or equal to 3.' end @coupon_pattern = coupon_pattern end
Custom attribute writer method with validation @param [Object] discount_limit
Value to be assigned
# File lib/talon_one/models/new_coupons.rb, line 217 def discount_limit=(discount_limit) if !discount_limit.nil? && discount_limit > 999999 fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 999999.' end if !discount_limit.nil? && discount_limit < 0 fail ArgumentError, 'invalid value for "discount_limit", must be greater than or equal to 0.' end @discount_limit = discount_limit end
@see the `==` method @param [Object] Object to be compared
# File lib/talon_one/models/new_coupons.rb, line 262 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/talon_one/models/new_coupons.rb, line 268 def hash [usage_limit, discount_limit, start_date, expiry_date, number_of_coupons, unique_prefix, attributes, recipient_integration_id, valid_characters, coupon_pattern].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/talon_one/models/new_coupons.rb, line 146 def list_invalid_properties invalid_properties = Array.new if @usage_limit.nil? invalid_properties.push('invalid value for "usage_limit", usage_limit cannot be nil.') end if @usage_limit > 999999 invalid_properties.push('invalid value for "usage_limit", must be smaller than or equal to 999999.') end if @usage_limit < 0 invalid_properties.push('invalid value for "usage_limit", must be greater than or equal to 0.') end if !@discount_limit.nil? && @discount_limit > 999999 invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 999999.') end if !@discount_limit.nil? && @discount_limit < 0 invalid_properties.push('invalid value for "discount_limit", must be greater than or equal to 0.') end if @number_of_coupons.nil? invalid_properties.push('invalid value for "number_of_coupons", number_of_coupons cannot be nil.') end if !@coupon_pattern.nil? && @coupon_pattern.to_s.length > 100 invalid_properties.push('invalid value for "coupon_pattern", the character length must be smaller than or equal to 100.') end if !@coupon_pattern.nil? && @coupon_pattern.to_s.length < 3 invalid_properties.push('invalid value for "coupon_pattern", the character length must be great than or equal to 3.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/talon_one/models/new_coupons.rb, line 354 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/talon_one/models/new_coupons.rb, line 342 def to_s to_hash.to_s end
Custom attribute writer method with validation @param [Object] usage_limit
Value to be assigned
# File lib/talon_one/models/new_coupons.rb, line 199 def usage_limit=(usage_limit) if usage_limit.nil? fail ArgumentError, 'usage_limit cannot be nil' end if usage_limit > 999999 fail ArgumentError, 'invalid value for "usage_limit", must be smaller than or equal to 999999.' end if usage_limit < 0 fail ArgumentError, 'invalid value for "usage_limit", must be greater than or equal to 0.' end @usage_limit = usage_limit end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/talon_one/models/new_coupons.rb, line 185 def valid? return false if @usage_limit.nil? return false if @usage_limit > 999999 return false if @usage_limit < 0 return false if !@discount_limit.nil? && @discount_limit > 999999 return false if !@discount_limit.nil? && @discount_limit < 0 return false if @number_of_coupons.nil? return false if !@coupon_pattern.nil? && @coupon_pattern.to_s.length > 100 return false if !@coupon_pattern.nil? && @coupon_pattern.to_s.length < 3 true end