Class: TalonOne::CouponCreationJob

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CouponCreationJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 147

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

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

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

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

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

  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?(:'reservation_limit')
    self.reservation_limit = attributes[:'reservation_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?(:'coupon_settings')
    self.coupon_settings = attributes[:'coupon_settings']
  end

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

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

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

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

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

  if attributes.key?(:'errors')
    if (value = attributes[:'errors']).is_a?(Array)
      self.errors = value
    end
  end

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the account that owns this entity.



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

def 
  @account_id
end

#application_id ⇒ Object

The ID of the application that owns this entity.



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

def application_id
  @application_id
end

#attributes ⇒ Object

Arbitrary properties associated with coupons.



54
55
56
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 54

def attributes
  @attributes
end

#batch_id ⇒ Object

The batch ID coupons created by this job will bear.



57
58
59
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 57

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_creation_job.rb', line 25

def campaign_id
  @campaign_id
end

#chunk_execution_count ⇒ Object

The number of times an attempt to create a chunk of coupons was made during the processing of the job.



78
79
80
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 78

def chunk_execution_count
  @chunk_execution_count
end

#chunk_size ⇒ Object

The number of coupons that will be created in a single transactions. Coupons will be created in chunks until arriving at the requested amount.



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

def chunk_size
  @chunk_size
end

#communicated ⇒ Object

Whether or not the user that created this job was notified of its final state.



75
76
77
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 75

def communicated
  @communicated
end

#coupon_settings ⇒ Object

Returns the value of attribute coupon_settings.



51
52
53
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 51

def coupon_settings
  @coupon_settings
end

#created ⇒ Object

The time this entity was created.



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

def created
  @created
end

#created_amount ⇒ Object

The number of coupon codes that were already created for this request.



63
64
65
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 63

def created_amount
  @created_amount
end

#created_by ⇒ Object

ID of the user who created this effect.



72
73
74
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 72

def created_by
  @created_by
end

#discount_limit ⇒ Object

The total discount value that the code can give. Typically used to represent a gift card value.



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

def discount_limit
  @discount_limit
end

#errors ⇒ Object

An array of individual problems encountered during the request.



69
70
71
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 69

def errors
  @errors
end

#expiry_date ⇒ Object

Expiration date of the coupon. Coupon never expires if this is omitted.



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

def expiry_date
  @expiry_date
end

#fail_count ⇒ Object

The number of times this job failed.



66
67
68
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 66

def fail_count
  @fail_count
end

#id ⇒ Object

Internal ID of this entity.



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

def id
  @id
end

#number_of_coupons ⇒ Object

The number of new coupon codes to generate for the campaign.



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

def number_of_coupons
  @number_of_coupons
end

#reservation_limit ⇒ Object

The number of reservations that can be made with this coupon code.



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

def reservation_limit
  @reservation_limit
end

#start_date ⇒ Object

Timestamp at which point the coupon becomes valid.



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

def start_date
  @start_date
end

#status ⇒ Object

The current status of this request. Possible values: - ‘pending verification` - `pending` - `completed` - `failed` - `coupon pattern full`



60
61
62
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 60

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



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

def usage_limit
  @usage_limit
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 84

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'campaign_id' => :'campaignId',
    :'application_id' => :'applicationId',
    :'account_id' => :'accountId',
    :'usage_limit' => :'usageLimit',
    :'discount_limit' => :'discountLimit',
    :'reservation_limit' => :'reservationLimit',
    :'start_date' => :'startDate',
    :'expiry_date' => :'expiryDate',
    :'number_of_coupons' => :'numberOfCoupons',
    :'coupon_settings' => :'couponSettings',
    :'attributes' => :'attributes',
    :'batch_id' => :'batchId',
    :'status' => :'status',
    :'created_amount' => :'createdAmount',
    :'fail_count' => :'failCount',
    :'errors' => :'errors',
    :'created_by' => :'createdBy',
    :'communicated' => :'communicated',
    :'chunk_execution_count' => :'chunkExecutionCount',
    :'chunk_size' => :'chunkSize'
  }
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



492
493
494
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 492

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



140
141
142
143
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 140

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'campaign_id' => :'Integer',
    :'application_id' => :'Integer',
    :'account_id' => :'Integer',
    :'usage_limit' => :'Integer',
    :'discount_limit' => :'Float',
    :'reservation_limit' => :'Integer',
    :'start_date' => :'DateTime',
    :'expiry_date' => :'DateTime',
    :'number_of_coupons' => :'Integer',
    :'coupon_settings' => :'CodeGeneratorSettings',
    :'attributes' => :'Object',
    :'batch_id' => :'String',
    :'status' => :'String',
    :'created_amount' => :'Integer',
    :'fail_count' => :'Integer',
    :'errors' => :'Array<String>',
    :'created_by' => :'Integer',
    :'communicated' => :'Boolean',
    :'chunk_execution_count' => :'Integer',
    :'chunk_size' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 450

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      campaign_id == o.campaign_id &&
      application_id == o.application_id &&
       == o. &&
      usage_limit == o.usage_limit &&
      discount_limit == o.discount_limit &&
      reservation_limit == o.reservation_limit &&
      start_date == o.start_date &&
      expiry_date == o.expiry_date &&
      number_of_coupons == o.number_of_coupons &&
      coupon_settings == o.coupon_settings &&
      attributes == o.attributes &&
      batch_id == o.batch_id &&
      status == o.status &&
      created_amount == o.created_amount &&
      fail_count == o.fail_count &&
      errors == o.errors &&
      created_by == o.created_by &&
      communicated == o.communicated &&
      chunk_execution_count == o.chunk_execution_count &&
      chunk_size == o.chunk_size
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



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 520

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



589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 589

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



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 499

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


479
480
481
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 479

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



485
486
487
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 485

def hash
  [id, created, campaign_id, application_id, , usage_limit, discount_limit, reservation_limit, start_date, expiry_date, number_of_coupons, coupon_settings, attributes, batch_id, status, created_amount, fail_count, errors, created_by, communicated, chunk_execution_count, chunk_size].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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
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
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
349
350
351
352
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 253

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

  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  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 !@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 !@reservation_limit.nil? && @reservation_limit > 999999
    invalid_properties.push('invalid value for "reservation_limit", must be smaller than or equal to 999999.')
  end

  if !@reservation_limit.nil? && @reservation_limit < 0
    invalid_properties.push('invalid value for "reservation_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 @number_of_coupons > 5000000
    invalid_properties.push('invalid value for "number_of_coupons", must be smaller than or equal to 5000000.')
  end

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

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

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

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

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

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

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

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

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

  if @chunk_execution_count.nil?
    invalid_properties.push('invalid value for "chunk_execution_count", chunk_execution_count 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



565
566
567
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 565

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



571
572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 571

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



559
560
561
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 559

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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/talon_one/models/coupon_creation_job.rb', line 356

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @campaign_id.nil?
  return false if @application_id.nil?
  return false if @account_id.nil?
  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 !@reservation_limit.nil? && @reservation_limit > 999999
  return false if !@reservation_limit.nil? && @reservation_limit < 0
  return false if @number_of_coupons.nil?
  return false if @number_of_coupons > 5000000
  return false if @number_of_coupons < 1
  return false if @attributes.nil?
  return false if @batch_id.nil?
  return false if @status.nil?
  return false if @created_amount.nil?
  return false if @fail_count.nil?
  return false if @errors.nil?
  return false if @created_by.nil?
  return false if @communicated.nil?
  return false if @chunk_execution_count.nil?
  true
end