Class: TalonOne::NewCouponsForMultipleRecipients

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ NewCouponsForMultipleRecipients

Initializes the object

Parameters:

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

    Model attributes in the form of hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 100

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::NewCouponsForMultipleRecipients` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::NewCouponsForMultipleRecipients`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

Instance Attribute Details

#attributes ⇒ Object

Arbitrary properties associated with this item.



34
35
36
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 34

def attributes
  @attributes
end

#coupon_pattern ⇒ Object

The pattern used to generate coupon codes. The character ‘#` is a placeholder and is replaced by a random character from the `validCharacters` set.



43
44
45
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 43

def coupon_pattern
  @coupon_pattern
end

#discount_limit ⇒ Object

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



22
23
24
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 22

def discount_limit
  @discount_limit
end

#expiry_date ⇒ Object

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



31
32
33
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 31

def expiry_date
  @expiry_date
end

#recipients_integration_ids ⇒ Object

The integration IDs for recipients.



37
38
39
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 37

def recipients_integration_ids
  @recipients_integration_ids
end

#reservation_limit ⇒ Object

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



25
26
27
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 25

def reservation_limit
  @reservation_limit
end

#start_date ⇒ Object

Timestamp at which point the coupon becomes valid.



28
29
30
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 28

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



19
20
21
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 19

def usage_limit
  @usage_limit
end

#valid_characters ⇒ Object

List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the ‘[A-Z, 0-9]` regular expression.



40
41
42
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 40

def valid_characters
  @valid_characters
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



61
62
63
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 61

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 66

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 46

def self.attribute_map
  {
    :'usage_limit' => :'usageLimit',
    :'discount_limit' => :'discountLimit',
    :'reservation_limit' => :'reservationLimit',
    :'start_date' => :'startDate',
    :'expiry_date' => :'expiryDate',
    :'attributes' => :'attributes',
    :'recipients_integration_ids' => :'recipientsIntegrationIds',
    :'valid_characters' => :'validCharacters',
    :'coupon_pattern' => :'couponPattern'
  }
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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 348

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



92
93
94
95
96
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 92

def self.openapi_all_of
  [
  :'CouponConstraints'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 71

def self.openapi_types
  {
    :'usage_limit' => :'Integer',
    :'discount_limit' => :'Float',
    :'reservation_limit' => :'Integer',
    :'start_date' => :'Time',
    :'expiry_date' => :'Time',
    :'attributes' => :'Object',
    :'recipients_integration_ids' => :'Array<String>',
    :'valid_characters' => :'Array<String>',
    :'coupon_pattern' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 319

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      attributes == o.attributes &&
      recipients_integration_ids == o.recipients_integration_ids &&
      valid_characters == o.valid_characters &&
      coupon_pattern == o.coupon_pattern
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


335
336
337
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 335

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



341
342
343
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 341

def hash
  [usage_limit, discount_limit, reservation_limit, start_date, expiry_date, attributes, recipients_integration_ids, valid_characters, coupon_pattern].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



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
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 159

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@usage_limit.nil? && @usage_limit > 999999
    invalid_properties.push('invalid value for "usage_limit", must be smaller than or equal to 999999.')
  end

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

  if @recipients_integration_ids.length > 1000
    invalid_properties.push('invalid value for "recipients_integration_ids", number of items must be less than or equal to 1000.')
  end

  if @recipients_integration_ids.length < 1
    invalid_properties.push('invalid value for "recipients_integration_ids", number of items must be greater than or equal to 1.')
  end

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

  if !@coupon_pattern.nil? && @coupon_pattern.to_s.length < 3
    invalid_properties.push('invalid value for "coupon_pattern", the character length must be greater than or equal to 3.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 370

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/talon_one_sdk/models/new_coupons_for_multiple_recipients.rb', line 211

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@usage_limit.nil? && @usage_limit > 999999
  return false if !@usage_limit.nil? && @usage_limit < 0
  return false if !@discount_limit.nil? && @discount_limit > 1000000000000000
  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 @recipients_integration_ids.nil?
  return false if @recipients_integration_ids.length > 1000
  return false if @recipients_integration_ids.length < 1
  return false if !@coupon_pattern.nil? && @coupon_pattern.to_s.length > 100
  return false if !@coupon_pattern.nil? && @coupon_pattern.to_s.length < 3
  true
end