Class: TalonOne::ExpiringCouponsData

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/expiring_coupons_data.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExpiringCouponsData

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



87
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
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 87

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::ExpiringCouponsData` 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::ExpiringCouponsData`. 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?(:'coupon_value')
    self.coupon_value = attributes[:'coupon_value']
  end

  if attributes.key?(:'created_date')
    self.created_date = attributes[:'created_date']
  end

  if attributes.key?(:'valid_from')
    self.valid_from = attributes[:'valid_from']
  end

  if attributes.key?(:'valid_until')
    self.valid_until = attributes[:'valid_until']
  end

  if attributes.key?(:'campaign_id')
    self.campaign_id = attributes[:'campaign_id']
  end

  if attributes.key?(:'customer_profile_id')
    self.customer_profile_id = attributes[:'customer_profile_id']
  end

  if attributes.key?(:'usage_limit')
    self.usage_limit = attributes[:'usage_limit']
  end

  if attributes.key?(:'usage_counter')
    self.usage_counter = attributes[:'usage_counter']
  end

  if attributes.key?(:'batch_id')
    self.batch_id = attributes[:'batch_id']
  end

  if attributes.key?(:'attributes')
    self.attributes = attributes[:'attributes']
  end
end

Instance Attribute Details

#attributes ⇒ Object

Custom attributes associated with this coupon.



45
46
47
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 45

def attributes
  @attributes
end

#batch_id ⇒ Object

The ID of the batch the coupon belongs to.



42
43
44
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 42

def batch_id
  @batch_id
end

#campaign_id ⇒ Object

The ID of the campaign to which the coupon belongs.



30
31
32
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 30

def campaign_id
  @campaign_id
end

#coupon_value ⇒ Object

The coupon code.



18
19
20
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 18

def coupon_value
  @coupon_value
end

#created_date ⇒ Object

Timestamp at which point the coupon was created.



21
22
23
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 21

def created_date
  @created_date
end

#customer_profile_id ⇒ Object

The Integration ID of the customer that is allowed to redeem this coupon.



33
34
35
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 33

def customer_profile_id
  @customer_profile_id
end

#usage_counter ⇒ Object

The number of times the coupon has been successfully redeemed.



39
40
41
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 39

def usage_counter
  @usage_counter
end

#usage_limit ⇒ Object

The number of times the coupon code can be redeemed. ‘0` means unlimited redemptions but any campaign usage limits will still apply.



36
37
38
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 36

def usage_limit
  @usage_limit
end

#valid_from ⇒ Object

Timestamp at which point the coupon becomes valid.



24
25
26
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 24

def valid_from
  @valid_from
end

#valid_until ⇒ Object

Timestamp at which point the coupon expires. Coupon never expires if this is omitted, zero, or negative.



27
28
29
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 27

def valid_until
  @valid_until
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 48

def self.attribute_map
  {
    :'coupon_value' => :'CouponValue',
    :'created_date' => :'CreatedDate',
    :'valid_from' => :'ValidFrom',
    :'valid_until' => :'ValidUntil',
    :'campaign_id' => :'CampaignId',
    :'customer_profile_id' => :'CustomerProfileId',
    :'usage_limit' => :'UsageLimit',
    :'usage_counter' => :'UsageCounter',
    :'batch_id' => :'BatchId',
    :'attributes' => :'Attributes'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



258
259
260
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 258

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 80

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 64

def self.openapi_types
  {
    :'coupon_value' => :'String',
    :'created_date' => :'DateTime',
    :'valid_from' => :'DateTime',
    :'valid_until' => :'DateTime',
    :'campaign_id' => :'Integer',
    :'customer_profile_id' => :'String',
    :'usage_limit' => :'Integer',
    :'usage_counter' => :'Integer',
    :'batch_id' => :'String',
    :'attributes' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      coupon_value == o.coupon_value &&
      created_date == o.created_date &&
      valid_from == o.valid_from &&
      valid_until == o.valid_until &&
      campaign_id == o.campaign_id &&
      customer_profile_id == o.customer_profile_id &&
      usage_limit == o.usage_limit &&
      usage_counter == o.usage_counter &&
      batch_id == o.batch_id &&
      attributes == o.attributes
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 286

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 355

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 265

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 251

def hash
  [coupon_value, created_date, valid_from, valid_until, campaign_id, customer_profile_id, usage_limit, usage_counter, batch_id, attributes].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



143
144
145
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
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 143

def list_invalid_properties
  invalid_properties = Array.new
  if @coupon_value.nil?
    invalid_properties.push('invalid value for "coupon_value", coupon_value cannot be nil.')
  end

  if @campaign_id.nil?
    invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
  end

  if @campaign_id < 1
    invalid_properties.push('invalid value for "campaign_id", must be greater than or equal to 1.')
  end

  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 @usage_counter.nil?
    invalid_properties.push('invalid value for "usage_counter", usage_counter cannot be nil.')
  end

  if @attributes.nil?
    invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



331
332
333
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 331

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 337

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

Returns:

  • (String) —

    String presentation of the object



325
326
327
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 325

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/talon_one/models/expiring_coupons_data.rb', line 182

def valid?
  return false if @coupon_value.nil?
  return false if @campaign_id.nil?
  return false if @campaign_id < 1
  return false if @usage_limit.nil?
  return false if @usage_limit > 999999
  return false if @usage_limit < 0
  return false if @usage_counter.nil?
  return false if @attributes.nil?
  true
end