Class: TalonOne::CouponDeletionFilters

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CouponDeletionFilters

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#batch_id ⇒ Object

Filter results by batches of coupons



48
49
50
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 48

def batch_id
  @batch_id
end

#created_after ⇒ Object

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.



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

def created_after
  @created_after
end

#created_before ⇒ Object

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.



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

def created_before
  @created_before
end

#exact_match ⇒ Object

Filter results to an exact case-insensitive matching against the coupon code



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

def exact_match
  @exact_match
end

#expires_after ⇒ Object

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.



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

def expires_after
  @expires_after
end

#expires_before ⇒ Object

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.



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

def expires_before
  @expires_before
end

#recipient_integration_id ⇒ Object

Filter results by match with a profile id specified in the coupon’s ‘RecipientIntegrationId` field.



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

def recipient_integration_id
  @recipient_integration_id
end

#redeemed ⇒ Object

  • ‘true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. Note: This field cannot be used in conjunction with the `usable` query parameter.



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

def redeemed
  @redeemed
end

#referral_id ⇒ Object

Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.



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

def referral_id
  @referral_id
end

#starts_after ⇒ Object

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.



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

def starts_after
  @starts_after
end

#starts_before ⇒ Object

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.



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

def starts_before
  @starts_before
end

#usable ⇒ Object

  • ‘true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. - This field cannot be used in conjunction with the `usable` query parameter.



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

def usable
  @usable
end

#valid ⇒ Object

  • ‘expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which the start date is null or in the past and the expiration date is null or in the future. - `validFuture`: Matches coupons in which the start date is set and in the future.



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

def valid
  @valid
end

#value ⇒ Object

Filter results by the coupon code



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

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'created_before' => :'createdBefore',
    :'created_after' => :'createdAfter',
    :'starts_after' => :'startsAfter',
    :'starts_before' => :'startsBefore',
    :'valid' => :'valid',
    :'usable' => :'usable',
    :'redeemed' => :'redeemed',
    :'recipient_integration_id' => :'recipientIntegrationId',
    :'exact_match' => :'exactMatch',
    :'value' => :'value',
    :'batch_id' => :'batchId',
    :'referral_id' => :'referralId',
    :'expires_after' => :'expiresAfter',
    :'expires_before' => :'expiresBefore'
  }
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



264
265
266
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 264

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 102

def self.openapi_types
  {
    :'created_before' => :'DateTime',
    :'created_after' => :'DateTime',
    :'starts_after' => :'DateTime',
    :'starts_before' => :'DateTime',
    :'valid' => :'String',
    :'usable' => :'Boolean',
    :'redeemed' => :'Boolean',
    :'recipient_integration_id' => :'String',
    :'exact_match' => :'Boolean',
    :'value' => :'String',
    :'batch_id' => :'String',
    :'referral_id' => :'Integer',
    :'expires_after' => :'DateTime',
    :'expires_before' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_before == o.created_before &&
      created_after == o.created_after &&
      starts_after == o.starts_after &&
      starts_before == o.starts_before &&
      valid == o.valid &&
      usable == o.usable &&
      redeemed == o.redeemed &&
      recipient_integration_id == o.recipient_integration_id &&
      exact_match == o.exact_match &&
      value == o.value &&
      batch_id == o.batch_id &&
      referral_id == o.referral_id &&
      expires_after == o.expires_after &&
      expires_before == o.expires_before
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



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

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 361

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 271

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 257

def hash
  [created_before, created_after, starts_after, starts_before, valid, usable, redeemed, recipient_integration_id, exact_match, value, batch_id, referral_id, expires_after, expires_before].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



205
206
207
208
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 205

def list_invalid_properties
  invalid_properties = Array.new
  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



337
338
339
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 337

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 343

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



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

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



212
213
214
215
216
 
# File 'lib/talon_one/models/coupon_deletion_filters.rb', line 212

def valid?
  valid_validator = EnumAttributeValidator.new('String', ["expired", "validNow", "validFuture"])
  return false unless valid_validator.valid?(@valid)
  true
end