Class: UltracartClient::Coupon

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/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



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
353
354
355
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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/ultracart_api/models/coupon.rb', line 285

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#affiliate_oid ⇒ Object

Associates an order with an affiliate when this value is set.



18
19
20
 
# File 'lib/ultracart_api/models/coupon.rb', line 18

def affiliate_oid
  @affiliate_oid
end

#allow_multiple_one_time_codes ⇒ Object

True if multiple one time codes for this coupon can be used on a cart at the same time.



21
22
23
 
# File 'lib/ultracart_api/models/coupon.rb', line 21

def allow_multiple_one_time_codes
  @allow_multiple_one_time_codes
end

#amount_off_items ⇒ Object

Returns the value of attribute amount_off_items.



23
24
25
 
# File 'lib/ultracart_api/models/coupon.rb', line 23

def amount_off_items
  @amount_off_items
end

#amount_off_shipping ⇒ Object

Returns the value of attribute amount_off_shipping.



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

def amount_off_shipping
  @amount_off_shipping
end

#amount_off_shipping_with_items_purchase ⇒ Object

Returns the value of attribute amount_off_shipping_with_items_purchase.



27
28
29
 
# File 'lib/ultracart_api/models/coupon.rb', line 27

def amount_off_shipping_with_items_purchase
  @amount_off_shipping_with_items_purchase
end

#amount_off_subtotal ⇒ Object

Returns the value of attribute amount_off_subtotal.



29
30
31
 
# File 'lib/ultracart_api/models/coupon.rb', line 29

def amount_off_subtotal
  @amount_off_subtotal
end

#amount_off_subtotal_and_free_shipping ⇒ Object

Returns the value of attribute amount_off_subtotal_and_free_shipping.



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

def amount_off_subtotal_and_free_shipping
  @amount_off_subtotal_and_free_shipping
end

#amount_off_subtotal_and_shipping ⇒ Object

Returns the value of attribute amount_off_subtotal_and_shipping.



33
34
35
 
# File 'lib/ultracart_api/models/coupon.rb', line 33

def amount_off_subtotal_and_shipping
  @amount_off_subtotal_and_shipping
end

#amount_off_subtotal_with_block_purchase ⇒ Object

Returns the value of attribute amount_off_subtotal_with_block_purchase.



35
36
37
 
# File 'lib/ultracart_api/models/coupon.rb', line 35

def amount_off_subtotal_with_block_purchase
  @amount_off_subtotal_with_block_purchase
end

#amount_off_subtotal_with_items_purchase ⇒ Object

Returns the value of attribute amount_off_subtotal_with_items_purchase.



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

def amount_off_subtotal_with_items_purchase
  @amount_off_subtotal_with_items_purchase
end

#amount_off_subtotal_with_purchase ⇒ Object

Returns the value of attribute amount_off_subtotal_with_purchase.



39
40
41
 
# File 'lib/ultracart_api/models/coupon.rb', line 39

def amount_off_subtotal_with_purchase
  @amount_off_subtotal_with_purchase
end

#automatically_apply_coupon_codes ⇒ Object

Returns the value of attribute automatically_apply_coupon_codes.



41
42
43
 
# File 'lib/ultracart_api/models/coupon.rb', line 41

def automatically_apply_coupon_codes
  @automatically_apply_coupon_codes
end

#buy_one_get_one ⇒ Object

Returns the value of attribute buy_one_get_one.



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

def buy_one_get_one
  @buy_one_get_one
end

#calculated_description ⇒ Object

Calculated description displayed to the customer if no description is specified.



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

def calculated_description
  @calculated_description
end

#can_be_used_with_other_coupons ⇒ Object

True if this coupon can be used with other coupons in a single order.



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

def can_be_used_with_other_coupons
  @can_be_used_with_other_coupons
end

#coupon_oid ⇒ Object

Coupon oid.



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

def coupon_oid
  @coupon_oid
end

#coupon_type ⇒ Object

Coupon type.



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

def coupon_type
  @coupon_type
end

#description ⇒ Object

Description of the coupon up to 50 characters.



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

def description
  @description
end

#discount_item_with_item_purchase ⇒ Object

Returns the value of attribute discount_item_with_item_purchase.



60
61
62
 
# File 'lib/ultracart_api/models/coupon.rb', line 60

def discount_item_with_item_purchase
  @discount_item_with_item_purchase
end

#discount_items ⇒ Object

Returns the value of attribute discount_items.



62
63
64
 
# File 'lib/ultracart_api/models/coupon.rb', line 62

def discount_items
  @discount_items
end

#expiration_dts ⇒ Object

Date/time when coupon expires



65
66
67
 
# File 'lib/ultracart_api/models/coupon.rb', line 65

def expiration_dts
  @expiration_dts
end

#free_item_and_shipping_with_subtotal ⇒ Object

Returns the value of attribute free_item_and_shipping_with_subtotal.



67
68
69
 
# File 'lib/ultracart_api/models/coupon.rb', line 67

def free_item_and_shipping_with_subtotal
  @free_item_and_shipping_with_subtotal
end

#free_item_with_item_purchase ⇒ Object

Returns the value of attribute free_item_with_item_purchase.



69
70
71
 
# File 'lib/ultracart_api/models/coupon.rb', line 69

def free_item_with_item_purchase
  @free_item_with_item_purchase
end

#free_item_with_subtotal ⇒ Object

Returns the value of attribute free_item_with_subtotal.



71
72
73
 
# File 'lib/ultracart_api/models/coupon.rb', line 71

def free_item_with_subtotal
  @free_item_with_subtotal
end

#free_items_with_item_purchase ⇒ Object

Returns the value of attribute free_items_with_item_purchase.



73
74
75
 
# File 'lib/ultracart_api/models/coupon.rb', line 73

def free_items_with_item_purchase
  @free_items_with_item_purchase
end

#free_items_with_mixmatch_purchase ⇒ Object

Returns the value of attribute free_items_with_mixmatch_purchase.



75
76
77
 
# File 'lib/ultracart_api/models/coupon.rb', line 75

def free_items_with_mixmatch_purchase
  @free_items_with_mixmatch_purchase
end

#free_shipping ⇒ Object

Returns the value of attribute free_shipping.



77
78
79
 
# File 'lib/ultracart_api/models/coupon.rb', line 77

def free_shipping
  @free_shipping
end

#free_shipping_specific_items ⇒ Object

Returns the value of attribute free_shipping_specific_items.



79
80
81
 
# File 'lib/ultracart_api/models/coupon.rb', line 79

def free_shipping_specific_items
  @free_shipping_specific_items
end

#free_shipping_with_items_purchase ⇒ Object

Returns the value of attribute free_shipping_with_items_purchase.



81
82
83
 
# File 'lib/ultracart_api/models/coupon.rb', line 81

def free_shipping_with_items_purchase
  @free_shipping_with_items_purchase
end

#free_shipping_with_subtotal ⇒ Object

Returns the value of attribute free_shipping_with_subtotal.



83
84
85
 
# File 'lib/ultracart_api/models/coupon.rb', line 83

def free_shipping_with_subtotal
  @free_shipping_with_subtotal
end

#hide_from_customer ⇒ Object

Hide coupon from customer during checkout. Often used when coupons are automatic discounting mechanisms.



86
87
88
 
# File 'lib/ultracart_api/models/coupon.rb', line 86

def hide_from_customer
  @hide_from_customer
end

#merchant_code ⇒ Object

Merchant code of coupon up to 20 characters.



89
90
91
 
# File 'lib/ultracart_api/models/coupon.rb', line 89

def merchant_code
  @merchant_code
end

#merchant_notes ⇒ Object

Internal notes about this coupon. These are not visible to customer.



92
93
94
 
# File 'lib/ultracart_api/models/coupon.rb', line 92

def merchant_notes
  @merchant_notes
end

#multiple_amounts_off_items ⇒ Object

Returns the value of attribute multiple_amounts_off_items.



94
95
96
 
# File 'lib/ultracart_api/models/coupon.rb', line 94

def multiple_amounts_off_items
  @multiple_amounts_off_items
end

#no_discount ⇒ Object

Returns the value of attribute no_discount.



96
97
98
 
# File 'lib/ultracart_api/models/coupon.rb', line 96

def no_discount
  @no_discount
end

#percent_off_item_with_items_quantity_purchase ⇒ Object

Returns the value of attribute percent_off_item_with_items_quantity_purchase.



98
99
100
 
# File 'lib/ultracart_api/models/coupon.rb', line 98

def percent_off_item_with_items_quantity_purchase
  @percent_off_item_with_items_quantity_purchase
end

#percent_off_items ⇒ Object

Returns the value of attribute percent_off_items.



100
101
102
 
# File 'lib/ultracart_api/models/coupon.rb', line 100

def percent_off_items
  @percent_off_items
end

#percent_off_items_and_free_shipping ⇒ Object

Returns the value of attribute percent_off_items_and_free_shipping.



102
103
104
 
# File 'lib/ultracart_api/models/coupon.rb', line 102

def percent_off_items_and_free_shipping
  @percent_off_items_and_free_shipping
end

#percent_off_items_with_items_purchase ⇒ Object

Returns the value of attribute percent_off_items_with_items_purchase.



104
105
106
 
# File 'lib/ultracart_api/models/coupon.rb', line 104

def percent_off_items_with_items_purchase
  @percent_off_items_with_items_purchase
end

#percent_off_msrp_items ⇒ Object

Returns the value of attribute percent_off_msrp_items.



106
107
108
 
# File 'lib/ultracart_api/models/coupon.rb', line 106

def percent_off_msrp_items
  @percent_off_msrp_items
end

#percent_off_retail_price_items ⇒ Object

Returns the value of attribute percent_off_retail_price_items.



108
109
110
 
# File 'lib/ultracart_api/models/coupon.rb', line 108

def percent_off_retail_price_items
  @percent_off_retail_price_items
end

#percent_off_shipping ⇒ Object

Returns the value of attribute percent_off_shipping.



110
111
112
 
# File 'lib/ultracart_api/models/coupon.rb', line 110

def percent_off_shipping
  @percent_off_shipping
end

#percent_off_subtotal ⇒ Object

Returns the value of attribute percent_off_subtotal.



112
113
114
 
# File 'lib/ultracart_api/models/coupon.rb', line 112

def percent_off_subtotal
  @percent_off_subtotal
end

#percent_off_subtotal_and_free_shipping ⇒ Object

Returns the value of attribute percent_off_subtotal_and_free_shipping.



114
115
116
 
# File 'lib/ultracart_api/models/coupon.rb', line 114

def percent_off_subtotal_and_free_shipping
  @percent_off_subtotal_and_free_shipping
end

#percent_off_subtotal_limit ⇒ Object

Returns the value of attribute percent_off_subtotal_limit.



116
117
118
 
# File 'lib/ultracart_api/models/coupon.rb', line 116

def percent_off_subtotal_limit
  @percent_off_subtotal_limit
end

#percent_off_subtotal_with_items_purchase ⇒ Object

Returns the value of attribute percent_off_subtotal_with_items_purchase.



118
119
120
 
# File 'lib/ultracart_api/models/coupon.rb', line 118

def percent_off_subtotal_with_items_purchase
  @percent_off_subtotal_with_items_purchase
end

#percent_off_subtotal_with_subtotal ⇒ Object

Returns the value of attribute percent_off_subtotal_with_subtotal.



120
121
122
 
# File 'lib/ultracart_api/models/coupon.rb', line 120

def percent_off_subtotal_with_subtotal
  @percent_off_subtotal_with_subtotal
end

#quickbooks_code ⇒ Object

Quickbooks accounting code.



123
124
125
 
# File 'lib/ultracart_api/models/coupon.rb', line 123

def quickbooks_code
  @quickbooks_code
end

#restrict_by_postal_codes ⇒ Object

Optional list of postal codes which restrict a coupon to within these postal codes.



126
127
128
 
# File 'lib/ultracart_api/models/coupon.rb', line 126

def restrict_by_postal_codes
  @restrict_by_postal_codes
end

#restrict_by_screen_branding_theme_codes ⇒ Object

Optional list of legacy screen branding theme codes to limit coupon use to only those themes.



129
130
131
 
# File 'lib/ultracart_api/models/coupon.rb', line 129

def restrict_by_screen_branding_theme_codes
  @restrict_by_screen_branding_theme_codes
end

#restrict_by_storefronts ⇒ Object

Optional list of storefronts to limit coupon use to only those storefronts.



132
133
134
 
# File 'lib/ultracart_api/models/coupon.rb', line 132

def restrict_by_storefronts
  @restrict_by_storefronts
end

#start_dts ⇒ Object

Date/time when coupon is valid



135
136
137
 
# File 'lib/ultracart_api/models/coupon.rb', line 135

def start_dts
  @start_dts
end

#super_coupon ⇒ Object

If true, this coupon can be used with ANY other coupon regardless of the other coupons configuration



138
139
140
 
# File 'lib/ultracart_api/models/coupon.rb', line 138

def super_coupon
  @super_coupon
end

#tiered_amount_off_items ⇒ Object

Returns the value of attribute tiered_amount_off_items.



140
141
142
 
# File 'lib/ultracart_api/models/coupon.rb', line 140

def tiered_amount_off_items
  @tiered_amount_off_items
end

#tiered_amount_off_subtotal ⇒ Object

Returns the value of attribute tiered_amount_off_subtotal.



142
143
144
 
# File 'lib/ultracart_api/models/coupon.rb', line 142

def tiered_amount_off_subtotal
  @tiered_amount_off_subtotal
end

#tiered_percent_off_items ⇒ Object

Returns the value of attribute tiered_percent_off_items.



144
145
146
 
# File 'lib/ultracart_api/models/coupon.rb', line 144

def tiered_percent_off_items
  @tiered_percent_off_items
end

#tiered_percent_off_shipping ⇒ Object

Returns the value of attribute tiered_percent_off_shipping.



146
147
148
 
# File 'lib/ultracart_api/models/coupon.rb', line 146

def tiered_percent_off_shipping
  @tiered_percent_off_shipping
end

#tiered_percent_off_subtotal ⇒ Object

Returns the value of attribute tiered_percent_off_subtotal.



148
149
150
 
# File 'lib/ultracart_api/models/coupon.rb', line 148

def tiered_percent_off_subtotal
  @tiered_percent_off_subtotal
end

#usable_by ⇒ Object

Who may use this coupon.



151
152
153
 
# File 'lib/ultracart_api/models/coupon.rb', line 151

def usable_by
  @usable_by
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/ultracart_api/models/coupon.rb', line 154

def self.attribute_map
  {
    :'affiliate_oid' => :'affiliate_oid',
    :'allow_multiple_one_time_codes' => :'allow_multiple_one_time_codes',
    :'amount_off_items' => :'amount_off_items',
    :'amount_off_shipping' => :'amount_off_shipping',
    :'amount_off_shipping_with_items_purchase' => :'amount_off_shipping_with_items_purchase',
    :'amount_off_subtotal' => :'amount_off_subtotal',
    :'amount_off_subtotal_and_free_shipping' => :'amount_off_subtotal_and_free_shipping',
    :'amount_off_subtotal_and_shipping' => :'amount_off_subtotal_and_shipping',
    :'amount_off_subtotal_with_block_purchase' => :'amount_off_subtotal_with_block_purchase',
    :'amount_off_subtotal_with_items_purchase' => :'amount_off_subtotal_with_items_purchase',
    :'amount_off_subtotal_with_purchase' => :'amount_off_subtotal_with_purchase',
    :'automatically_apply_coupon_codes' => :'automatically_apply_coupon_codes',
    :'buy_one_get_one' => :'buy_one_get_one',
    :'calculated_description' => :'calculated_description',
    :'can_be_used_with_other_coupons' => :'can_be_used_with_other_coupons',
    :'coupon_oid' => :'coupon_oid',
    :'coupon_type' => :'coupon_type',
    :'description' => :'description',
    :'discount_item_with_item_purchase' => :'discount_item_with_item_purchase',
    :'discount_items' => :'discount_items',
    :'expiration_dts' => :'expiration_dts',
    :'free_item_and_shipping_with_subtotal' => :'free_item_and_shipping_with_subtotal',
    :'free_item_with_item_purchase' => :'free_item_with_item_purchase',
    :'free_item_with_subtotal' => :'free_item_with_subtotal',
    :'free_items_with_item_purchase' => :'free_items_with_item_purchase',
    :'free_items_with_mixmatch_purchase' => :'free_items_with_mixmatch_purchase',
    :'free_shipping' => :'free_shipping',
    :'free_shipping_specific_items' => :'free_shipping_specific_items',
    :'free_shipping_with_items_purchase' => :'free_shipping_with_items_purchase',
    :'free_shipping_with_subtotal' => :'free_shipping_with_subtotal',
    :'hide_from_customer' => :'hide_from_customer',
    :'merchant_code' => :'merchant_code',
    :'merchant_notes' => :'merchant_notes',
    :'multiple_amounts_off_items' => :'multiple_amounts_off_items',
    :'no_discount' => :'no_discount',
    :'percent_off_item_with_items_quantity_purchase' => :'percent_off_item_with_items_quantity_purchase',
    :'percent_off_items' => :'percent_off_items',
    :'percent_off_items_and_free_shipping' => :'percent_off_items_and_free_shipping',
    :'percent_off_items_with_items_purchase' => :'percent_off_items_with_items_purchase',
    :'percent_off_msrp_items' => :'percent_off_msrp_items',
    :'percent_off_retail_price_items' => :'percent_off_retail_price_items',
    :'percent_off_shipping' => :'percent_off_shipping',
    :'percent_off_subtotal' => :'percent_off_subtotal',
    :'percent_off_subtotal_and_free_shipping' => :'percent_off_subtotal_and_free_shipping',
    :'percent_off_subtotal_limit' => :'percent_off_subtotal_limit',
    :'percent_off_subtotal_with_items_purchase' => :'percent_off_subtotal_with_items_purchase',
    :'percent_off_subtotal_with_subtotal' => :'percent_off_subtotal_with_subtotal',
    :'quickbooks_code' => :'quickbooks_code',
    :'restrict_by_postal_codes' => :'restrict_by_postal_codes',
    :'restrict_by_screen_branding_theme_codes' => :'restrict_by_screen_branding_theme_codes',
    :'restrict_by_storefronts' => :'restrict_by_storefronts',
    :'start_dts' => :'start_dts',
    :'super_coupon' => :'super_coupon',
    :'tiered_amount_off_items' => :'tiered_amount_off_items',
    :'tiered_amount_off_subtotal' => :'tiered_amount_off_subtotal',
    :'tiered_percent_off_items' => :'tiered_percent_off_items',
    :'tiered_percent_off_shipping' => :'tiered_percent_off_shipping',
    :'tiered_percent_off_subtotal' => :'tiered_percent_off_subtotal',
    :'usable_by' => :'usable_by'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
250
251
252
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
 
# File 'lib/ultracart_api/models/coupon.rb', line 219

def self.swagger_types
  {
    :'affiliate_oid' => :'Integer',
    :'allow_multiple_one_time_codes' => :'BOOLEAN',
    :'amount_off_items' => :'CouponAmountOffItems',
    :'amount_off_shipping' => :'CouponAmountOffShipping',
    :'amount_off_shipping_with_items_purchase' => :'CouponAmountOffShippingWithItemsPurchase',
    :'amount_off_subtotal' => :'CouponAmountOffSubtotal',
    :'amount_off_subtotal_and_free_shipping' => :'CouponAmountOffSubtotalFreeShippingWithPurchase',
    :'amount_off_subtotal_and_shipping' => :'CouponAmountOffSubtotalAndShipping',
    :'amount_off_subtotal_with_block_purchase' => :'CouponAmountOffSubtotalWithBlockPurchase',
    :'amount_off_subtotal_with_items_purchase' => :'CouponAmountOffSubtotalWithItemsPurchase',
    :'amount_off_subtotal_with_purchase' => :'CouponAmountOffSubtotalWithPurchase',
    :'automatically_apply_coupon_codes' => :'CouponAutomaticallyApplyCouponCodes',
    :'buy_one_get_one' => :'CouponBuyOneGetOneLimit',
    :'calculated_description' => :'String',
    :'can_be_used_with_other_coupons' => :'BOOLEAN',
    :'coupon_oid' => :'Integer',
    :'coupon_type' => :'String',
    :'description' => :'String',
    :'discount_item_with_item_purchase' => :'CouponDiscountItemWithItemPurchase',
    :'discount_items' => :'CouponDiscountItems',
    :'expiration_dts' => :'String',
    :'free_item_and_shipping_with_subtotal' => :'CouponFreeItemAndShippingWithSubtotal',
    :'free_item_with_item_purchase' => :'CouponFreeItemWithItemPurchase',
    :'free_item_with_subtotal' => :'CouponFreeItemWithSubtotal',
    :'free_items_with_item_purchase' => :'CouponFreeItemsWithItemPurchase',
    :'free_items_with_mixmatch_purchase' => :'CouponFreeItemsWithMixMatchPurchase',
    :'free_shipping' => :'CouponFreeShipping',
    :'free_shipping_specific_items' => :'CouponFreeShippingSpecificItems',
    :'free_shipping_with_items_purchase' => :'CouponFreeShippingWithItemsPurchase',
    :'free_shipping_with_subtotal' => :'CouponFreeShippingWithSubtotal',
    :'hide_from_customer' => :'BOOLEAN',
    :'merchant_code' => :'String',
    :'merchant_notes' => :'String',
    :'multiple_amounts_off_items' => :'CouponMultipleAmountsOffItems',
    :'no_discount' => :'CouponNoDiscount',
    :'percent_off_item_with_items_quantity_purchase' => :'CouponPercentOffItemWithItemsQuantityPurchase',
    :'percent_off_items' => :'CouponPercentOffItems',
    :'percent_off_items_and_free_shipping' => :'CouponPercentOffItemsAndFreeShipping',
    :'percent_off_items_with_items_purchase' => :'CouponPercentOffItemsWithItemsPurchase',
    :'percent_off_msrp_items' => :'CouponPercentOffMsrpItems',
    :'percent_off_retail_price_items' => :'CouponPercentOffRetailPriceItems',
    :'percent_off_shipping' => :'CouponPercentOffShipping',
    :'percent_off_subtotal' => :'CouponPercentOffSubtotal',
    :'percent_off_subtotal_and_free_shipping' => :'CouponPercentOffSubtotalAndFreeShipping',
    :'percent_off_subtotal_limit' => :'CouponPercentOffSubtotalLimit',
    :'percent_off_subtotal_with_items_purchase' => :'CouponPercentOffSubtotalWithItemsPurchase',
    :'percent_off_subtotal_with_subtotal' => :'CouponPercentOffSubtotalWithSubtotal',
    :'quickbooks_code' => :'String',
    :'restrict_by_postal_codes' => :'Array<String>',
    :'restrict_by_screen_branding_theme_codes' => :'Array<CouponRestriction>',
    :'restrict_by_storefronts' => :'Array<CouponRestriction>',
    :'start_dts' => :'String',
    :'super_coupon' => :'BOOLEAN',
    :'tiered_amount_off_items' => :'CouponTieredAmountOffItems',
    :'tiered_amount_off_subtotal' => :'CouponTieredAmountOffSubtotal',
    :'tiered_percent_off_items' => :'CouponTieredPercentOffItems',
    :'tiered_percent_off_shipping' => :'CouponTieredPercentOffShipping',
    :'tiered_percent_off_subtotal' => :'CouponTieredPercentOffSubtotal',
    :'usable_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/ultracart_api/models/coupon.rb', line 639

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      affiliate_oid == o.affiliate_oid &&
      allow_multiple_one_time_codes == o.allow_multiple_one_time_codes &&
      amount_off_items == o.amount_off_items &&
      amount_off_shipping == o.amount_off_shipping &&
      amount_off_shipping_with_items_purchase == o.amount_off_shipping_with_items_purchase &&
      amount_off_subtotal == o.amount_off_subtotal &&
      amount_off_subtotal_and_free_shipping == o.amount_off_subtotal_and_free_shipping &&
      amount_off_subtotal_and_shipping == o.amount_off_subtotal_and_shipping &&
      amount_off_subtotal_with_block_purchase == o.amount_off_subtotal_with_block_purchase &&
      amount_off_subtotal_with_items_purchase == o.amount_off_subtotal_with_items_purchase &&
      amount_off_subtotal_with_purchase == o.amount_off_subtotal_with_purchase &&
      automatically_apply_coupon_codes == o.automatically_apply_coupon_codes &&
      buy_one_get_one == o.buy_one_get_one &&
      calculated_description == o.calculated_description &&
      can_be_used_with_other_coupons == o.can_be_used_with_other_coupons &&
      coupon_oid == o.coupon_oid &&
      coupon_type == o.coupon_type &&
      description == o.description &&
      discount_item_with_item_purchase == o.discount_item_with_item_purchase &&
      discount_items == o.discount_items &&
      expiration_dts == o.expiration_dts &&
      free_item_and_shipping_with_subtotal == o.free_item_and_shipping_with_subtotal &&
      free_item_with_item_purchase == o.free_item_with_item_purchase &&
      free_item_with_subtotal == o.free_item_with_subtotal &&
      free_items_with_item_purchase == o.free_items_with_item_purchase &&
      free_items_with_mixmatch_purchase == o.free_items_with_mixmatch_purchase &&
      free_shipping == o.free_shipping &&
      free_shipping_specific_items == o.free_shipping_specific_items &&
      free_shipping_with_items_purchase == o.free_shipping_with_items_purchase &&
      free_shipping_with_subtotal == o.free_shipping_with_subtotal &&
      hide_from_customer == o.hide_from_customer &&
      merchant_code == o.merchant_code &&
      merchant_notes == o.merchant_notes &&
      multiple_amounts_off_items == o.multiple_amounts_off_items &&
      no_discount == o.no_discount &&
      percent_off_item_with_items_quantity_purchase == o.percent_off_item_with_items_quantity_purchase &&
      percent_off_items == o.percent_off_items &&
      percent_off_items_and_free_shipping == o.percent_off_items_and_free_shipping &&
      percent_off_items_with_items_purchase == o.percent_off_items_with_items_purchase &&
      percent_off_msrp_items == o.percent_off_msrp_items &&
      percent_off_retail_price_items == o.percent_off_retail_price_items &&
      percent_off_shipping == o.percent_off_shipping &&
      percent_off_subtotal == o.percent_off_subtotal &&
      percent_off_subtotal_and_free_shipping == o.percent_off_subtotal_and_free_shipping &&
      percent_off_subtotal_limit == o.percent_off_subtotal_limit &&
      percent_off_subtotal_with_items_purchase == o.percent_off_subtotal_with_items_purchase &&
      percent_off_subtotal_with_subtotal == o.percent_off_subtotal_with_subtotal &&
      quickbooks_code == o.quickbooks_code &&
      restrict_by_postal_codes == o.restrict_by_postal_codes &&
      restrict_by_screen_branding_theme_codes == o.restrict_by_screen_branding_theme_codes &&
      restrict_by_storefronts == o.restrict_by_storefronts &&
      start_dts == o.start_dts &&
      super_coupon == o.super_coupon &&
      tiered_amount_off_items == o.tiered_amount_off_items &&
      tiered_amount_off_subtotal == o.tiered_amount_off_subtotal &&
      tiered_percent_off_items == o.tiered_percent_off_items &&
      tiered_percent_off_shipping == o.tiered_percent_off_shipping &&
      tiered_percent_off_subtotal == o.tiered_percent_off_subtotal &&
      usable_by == o.usable_by
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



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/ultracart_api/models/coupon.rb', line 739

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 = UltracartClient.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



805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/ultracart_api/models/coupon.rb', line 805

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



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'lib/ultracart_api/models/coupon.rb', line 718

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 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


705
706
707
 
# File 'lib/ultracart_api/models/coupon.rb', line 705

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



711
712
713
 
# File 'lib/ultracart_api/models/coupon.rb', line 711

def hash
  [affiliate_oid, allow_multiple_one_time_codes, amount_off_items, amount_off_shipping, amount_off_shipping_with_items_purchase, amount_off_subtotal, amount_off_subtotal_and_free_shipping, amount_off_subtotal_and_shipping, amount_off_subtotal_with_block_purchase, amount_off_subtotal_with_items_purchase, amount_off_subtotal_with_purchase, automatically_apply_coupon_codes, buy_one_get_one, calculated_description, can_be_used_with_other_coupons, coupon_oid, coupon_type, description, discount_item_with_item_purchase, discount_items, expiration_dts, free_item_and_shipping_with_subtotal, free_item_with_item_purchase, free_item_with_subtotal, free_items_with_item_purchase, free_items_with_mixmatch_purchase, free_shipping, free_shipping_specific_items, free_shipping_with_items_purchase, free_shipping_with_subtotal, hide_from_customer, merchant_code, merchant_notes, multiple_amounts_off_items, no_discount, percent_off_item_with_items_quantity_purchase, percent_off_items, percent_off_items_and_free_shipping, percent_off_items_with_items_purchase, percent_off_msrp_items, percent_off_retail_price_items, percent_off_shipping, percent_off_subtotal, percent_off_subtotal_and_free_shipping, percent_off_subtotal_limit, percent_off_subtotal_with_items_purchase, percent_off_subtotal_with_subtotal, quickbooks_code, restrict_by_postal_codes, restrict_by_screen_branding_theme_codes, restrict_by_storefronts, start_dts, super_coupon, tiered_amount_off_items, tiered_amount_off_subtotal, tiered_percent_off_items, tiered_percent_off_shipping, tiered_percent_off_subtotal, usable_by].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



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/ultracart_api/models/coupon.rb', line 536

def list_invalid_properties
  invalid_properties = Array.new
  if !@coupon_type.nil? && @coupon_type.to_s.length > 65
    invalid_properties.push('invalid value for "coupon_type", the character length must be smaller than or equal to 65.')
  end

  if !@description.nil? && @description.to_s.length > 50
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 50.')
  end

  if !@merchant_code.nil? && @merchant_code.to_s.length > 20
    invalid_properties.push('invalid value for "merchant_code", the character length must be smaller than or equal to 20.')
  end

  if !@merchant_notes.nil? && @merchant_notes.to_s.length > 250
    invalid_properties.push('invalid value for "merchant_notes", the character length must be smaller than or equal to 250.')
  end

  if !@quickbooks_code.nil? && @quickbooks_code.to_s.length > 20
    invalid_properties.push('invalid value for "quickbooks_code", the character length must be smaller than or equal to 20.')
  end

  if !@usable_by.nil? && @usable_by.to_s.length > 50
    invalid_properties.push('invalid value for "usable_by", the character length must be smaller than or equal to 50.')
  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



785
786
787
 
# File 'lib/ultracart_api/models/coupon.rb', line 785

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



791
792
793
794
795
796
797
798
799
 
# File 'lib/ultracart_api/models/coupon.rb', line 791

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



779
780
781
 
# File 'lib/ultracart_api/models/coupon.rb', line 779

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



567
568
569
570
571
572
573
574
575
 
# File 'lib/ultracart_api/models/coupon.rb', line 567

def valid?
  return false if !@coupon_type.nil? && @coupon_type.to_s.length > 65
  return false if !@description.nil? && @description.to_s.length > 50
  return false if !@merchant_code.nil? && @merchant_code.to_s.length > 20
  return false if !@merchant_notes.nil? && @merchant_notes.to_s.length > 250
  return false if !@quickbooks_code.nil? && @quickbooks_code.to_s.length > 20
  return false if !@usable_by.nil? && @usable_by.to_s.length > 50
  true
end