Class: TalonOne::Coupon

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Coupon

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/talon_one/models/coupon.rb', line 102

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

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

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

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

  if attributes.has_key?(:'startDate')
    self.start_date = attributes[:'startDate']
  end

  if attributes.has_key?(:'expiryDate')
    self.expiry_date = attributes[:'expiryDate']
  end

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

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

  if attributes.has_key?(:'referralId')
    self.referral_id = attributes[:'referralId']
  end

  if attributes.has_key?(:'recipientIntegrationId')
    self.recipient_integration_id = attributes[:'recipientIntegrationId']
  end

  if attributes.has_key?(:'importId')
    self.import_id = attributes[:'importId']
  end

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

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

Instance Attribute Details

#attributes ⇒ Object

Arbitrary properties associated with this item



43
44
45
 
# File 'lib/talon_one/models/coupon.rb', line 43

def attributes
  @attributes
end

#batch_id ⇒ Object

The id of the batch the coupon belongs to.



58
59
60
 
# File 'lib/talon_one/models/coupon.rb', line 58

def batch_id
  @batch_id
end

#campaign_id ⇒ Object

The ID of the campaign that owns this entity.



25
26
27
 
# File 'lib/talon_one/models/coupon.rb', line 25

def campaign_id
  @campaign_id
end

#created ⇒ Object

The exact moment this entity was created.



22
23
24
 
# File 'lib/talon_one/models/coupon.rb', line 22

def created
  @created
end

#expiry_date ⇒ Object

Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative.



37
38
39
 
# File 'lib/talon_one/models/coupon.rb', line 37

def expiry_date
  @expiry_date
end

#id ⇒ Object

Unique ID for this entity.



19
20
21
 
# File 'lib/talon_one/models/coupon.rb', line 19

def id
  @id
end

#import_id ⇒ Object

The ID of the Import which created this coupon.



52
53
54
 
# File 'lib/talon_one/models/coupon.rb', line 52

def import_id
  @import_id
end

#recipient_integration_id ⇒ Object

The integration ID of a referred customer profile.



49
50
51
 
# File 'lib/talon_one/models/coupon.rb', line 49

def recipient_integration_id
  @recipient_integration_id
end

#referral_id ⇒ Object

The integration ID of the referring customer (if any) for whom this coupon was created as an effect.



46
47
48
 
# File 'lib/talon_one/models/coupon.rb', line 46

def referral_id
  @referral_id
end

#reservation ⇒ Object

This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favourite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified.



55
56
57
 
# File 'lib/talon_one/models/coupon.rb', line 55

def reservation
  @reservation
end

#start_date ⇒ Object

Timestamp at which point the coupon becomes valid.



34
35
36
 
# File 'lib/talon_one/models/coupon.rb', line 34

def start_date
  @start_date
end

#usage_counter ⇒ Object

The number of times this coupon has been successfully used.



40
41
42
 
# File 'lib/talon_one/models/coupon.rb', line 40

def usage_counter
  @usage_counter
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.



31
32
33
 
# File 'lib/talon_one/models/coupon.rb', line 31

def usage_limit
  @usage_limit
end

#value ⇒ Object

The actual coupon code.



28
29
30
 
# File 'lib/talon_one/models/coupon.rb', line 28

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'campaign_id' => :'campaignId',
    :'value' => :'value',
    :'usage_limit' => :'usageLimit',
    :'start_date' => :'startDate',
    :'expiry_date' => :'expiryDate',
    :'usage_counter' => :'usageCounter',
    :'attributes' => :'attributes',
    :'referral_id' => :'referralId',
    :'recipient_integration_id' => :'recipientIntegrationId',
    :'import_id' => :'importId',
    :'reservation' => :'reservation',
    :'batch_id' => :'batchId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/talon_one/models/coupon.rb', line 81

def self.swagger_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'campaign_id' => :'Integer',
    :'value' => :'String',
    :'usage_limit' => :'Integer',
    :'start_date' => :'DateTime',
    :'expiry_date' => :'DateTime',
    :'usage_counter' => :'Integer',
    :'attributes' => :'Object',
    :'referral_id' => :'Integer',
    :'recipient_integration_id' => :'String',
    :'import_id' => :'Integer',
    :'reservation' => :'BOOLEAN',
    :'batch_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/talon_one/models/coupon.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      campaign_id == o.campaign_id &&
      value == o.value &&
      usage_limit == o.usage_limit &&
      start_date == o.start_date &&
      expiry_date == o.expiry_date &&
      usage_counter == o.usage_counter &&
      attributes == o.attributes &&
      referral_id == o.referral_id &&
      recipient_integration_id == o.recipient_integration_id &&
      import_id == o.import_id &&
      reservation == o.reservation &&
      batch_id == o.batch_id
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



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
344
345
346
347
348
 
# File 'lib/talon_one/models/coupon.rb', line 312

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
    temp_model = TalonOne.const_get(type).new
    temp_model.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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/talon_one/models/coupon.rb', line 378

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/talon_one/models/coupon.rb', line 291

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


278
279
280
 
# File 'lib/talon_one/models/coupon.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/talon_one/models/coupon.rb', line 284

def hash
  [id, created, campaign_id, value, usage_limit, start_date, expiry_date, usage_counter, attributes, referral_id, recipient_integration_id, import_id, reservation, batch_id].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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/talon_one/models/coupon.rb', line 167

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

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

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

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

  if @value.to_s.length < 4
    invalid_properties.push('invalid value for "value", the character length must be great than or equal to 4.')
  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

  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



358
359
360
 
# File 'lib/talon_one/models/coupon.rb', line 358

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



364
365
366
367
368
369
370
371
372
 
# File 'lib/talon_one/models/coupon.rb', line 364

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



352
353
354
 
# File 'lib/talon_one/models/coupon.rb', line 352

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



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/talon_one/models/coupon.rb', line 210

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @campaign_id.nil?
  return false if @value.nil?
  return false if @value.to_s.length < 4
  return false if @usage_limit.nil?
  return false if @usage_limit > 999999
  return false if @usage_limit < 0
  return false if @usage_counter.nil?
  true
end