Class: TalonOne::NewCoupons
- Inherits:
-
Object
- Object
- TalonOne::NewCoupons
- Defined in:
- lib/talon_one/models/new_coupons.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
Arbitrary properties associated with this item.
-
#coupon_pattern ⇒ Object
The pattern that will be used to generate coupon codes.
-
#discount_limit ⇒ Object
The amount of discounts that can be given with this coupon code.
-
#expiry_date ⇒ Object
Expiry date of the coupon.
-
#number_of_coupons ⇒ Object
The number of new coupon codes to generate for the campaign.
-
#recipient_integration_id ⇒ Object
The integration ID for this coupon’s beneficiary’s profile.
-
#start_date ⇒ Object
Timestamp at which point the coupon becomes valid.
-
#unique_prefix ⇒ Object
A unique prefix to prepend to all generated coupons.
-
#usage_limit ⇒ Object
The number of times a coupon code can be redeemed.
-
#valid_characters ⇒ Object
Set of characters to be used when generating random part of code.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ NewCoupons
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ NewCoupons
Initializes the object
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# 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?(:'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 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 end |
Instance Attribute Details
#attributes ⇒ Object
Arbitrary properties associated with this item
43 44 45 |
# File 'lib/talon_one/models/new_coupons.rb', line 43 def attributes @attributes end |
#coupon_pattern ⇒ Object
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.
34 35 36 |
# File 'lib/talon_one/models/new_coupons.rb', line 34 def coupon_pattern @coupon_pattern end |
#discount_limit ⇒ Object
The amount of discounts that can be given with this coupon code.
22 23 24 |
# File 'lib/talon_one/models/new_coupons.rb', line 22 def discount_limit @discount_limit end |
#expiry_date ⇒ Object
Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative.
28 29 30 |
# File 'lib/talon_one/models/new_coupons.rb', line 28 def expiry_date @expiry_date end |
#number_of_coupons ⇒ Object
The number of new coupon codes to generate for the campaign. Must be at least 1.
37 38 39 |
# File 'lib/talon_one/models/new_coupons.rb', line 37 def number_of_coupons @number_of_coupons end |
#recipient_integration_id ⇒ Object
The integration ID for this coupon’s beneficiary’s profile
46 47 48 |
# File 'lib/talon_one/models/new_coupons.rb', line 46 def recipient_integration_id @recipient_integration_id end |
#start_date ⇒ Object
Timestamp at which point the coupon becomes valid.
25 26 27 |
# File 'lib/talon_one/models/new_coupons.rb', line 25 def start_date @start_date end |
#unique_prefix ⇒ Object
A unique prefix to prepend to all generated coupons.
40 41 42 |
# File 'lib/talon_one/models/new_coupons.rb', line 40 def unique_prefix @unique_prefix end |
#usage_limit ⇒ Object
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.
19 20 21 |
# File 'lib/talon_one/models/new_coupons.rb', line 19 def usage_limit @usage_limit end |
#valid_characters ⇒ Object
Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp).
31 32 33 |
# File 'lib/talon_one/models/new_coupons.rb', line 31 def valid_characters @valid_characters end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# 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', :'valid_characters' => :'validCharacters', :'coupon_pattern' => :'couponPattern', :'number_of_coupons' => :'numberOfCoupons', :'unique_prefix' => :'uniquePrefix', :'attributes' => :'attributes', :'recipient_integration_id' => :'recipientIntegrationId' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
280 281 282 |
# File 'lib/talon_one/models/new_coupons.rb', line 280 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
81 82 83 84 |
# File 'lib/talon_one/models/new_coupons.rb', line 81 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# 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', :'valid_characters' => :'Array<String>', :'coupon_pattern' => :'String', :'number_of_coupons' => :'Integer', :'unique_prefix' => :'String', :'attributes' => :'Object', :'recipient_integration_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/talon_one/models/new_coupons.rb', line 250 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 && valid_characters == o.valid_characters && coupon_pattern == o.coupon_pattern && number_of_coupons == o.number_of_coupons && unique_prefix == o.unique_prefix && attributes == o.attributes && recipient_integration_id == o.recipient_integration_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/talon_one/models/new_coupons.rb', line 308 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
377 378 379 380 381 382 383 384 385 386 387 388 389 |
# File 'lib/talon_one/models/new_coupons.rb', line 377 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
# File 'lib/talon_one/models/new_coupons.rb', line 287 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 |
#eql?(o) ⇒ Boolean
267 268 269 |
# File 'lib/talon_one/models/new_coupons.rb', line 267 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
273 274 275 |
# File 'lib/talon_one/models/new_coupons.rb', line 273 def hash [usage_limit, discount_limit, start_date, expiry_date, valid_characters, coupon_pattern, number_of_coupons, unique_prefix, attributes, recipient_integration_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# 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 @valid_characters.nil? invalid_properties.push('invalid value for "valid_characters", valid_characters cannot be nil.') end if @coupon_pattern.nil? invalid_properties.push('invalid value for "coupon_pattern", coupon_pattern cannot be nil.') end if @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 if @number_of_coupons.nil? invalid_properties.push('invalid value for "number_of_coupons", number_of_coupons cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
353 354 355 |
# File 'lib/talon_one/models/new_coupons.rb', line 353 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'lib/talon_one/models/new_coupons.rb', line 359 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 |
#to_s ⇒ String
Returns the string representation of the object
347 348 349 |
# File 'lib/talon_one/models/new_coupons.rb', line 347 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/talon_one/models/new_coupons.rb', line 189 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 @valid_characters.nil? return false if @coupon_pattern.nil? return false if @coupon_pattern.to_s.length < 3 return false if @number_of_coupons.nil? true end |