Class: VoucherifySdk::LoyaltiesEarningRulesEnableResponseBody

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb

Overview

Response body schema for POST ‘/loyalties/campaignId/earning-rules/earningRuleId/enable`

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltiesEarningRulesEnableResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 148

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

A flag to toggle the earning rule on or off. You can disable an earning rule even though it’s within the active period defined by the start_date and expiration_date of the campaign or the earning rule’s own start_date and expiration_date.



59
60
61
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 59

def active
  @active
end

#automation_id ⇒ Object

For internal use by Voucherify.



39
40
41
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 39

def automation_id
  @automation_id
end

#created_at ⇒ Object

Timestamp representing the date and time when the earning rule was created in ISO 8601 format.



23
24
25
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 23

def created_at
  @created_at
end

#custom_event ⇒ Object

Returns the value of attribute custom_event.



29
30
31
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 29

def custom_event
  @custom_event
end

#event ⇒ Object

Returns the value of attribute event.



27
28
29
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 27

def event
  @event
end

#expiration_date ⇒ Object

Expiration date defines when the earning rule expires. Expiration timestamp in ISO 8601 format. Earning rule is inactive after this date.If you don’t define the expiration date for an earning rule, it’ll inherit the campaign expiration date by default.



45
46
47
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 45

def expiration_date
  @expiration_date
end

#id ⇒ Object

Assigned by the Voucherify API, identifies the earning rule object.



20
21
22
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 20

def id
  @id
end

#loyalty ⇒ Object

Returns the value of attribute loyalty.



25
26
27
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 25

def loyalty
  @loyalty
end

#metadata ⇒ Object

The metadata object stores all custom attributes assigned to the earning rule. A set of key/value pairs that you can attach to an earning rule object. It can be useful for storing additional information about the earning rule in a structured format.



53
54
55
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 53

def metadata
  @metadata
end

#object ⇒ Object

The type of object represented by JSON. Default is earning_rule.



36
37
38
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 36

def object
  @object
end

#segment ⇒ Object

Returns the value of attribute segment.



31
32
33
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 31

def segment
  @segment
end

#source ⇒ Object

Returns the value of attribute source.



33
34
35
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 33

def source
  @source
end

#start_date ⇒ Object

Start date defines when the earning rule starts to be active. Activation timestamp in ISO 8601 format. Earning rule is inactive before this date. If you don’t define the start date for an earning rule, it’ll inherit the campaign start date by default.



42
43
44
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 42

def start_date
  @start_date
end

#updated_at ⇒ Object

Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format.



56
57
58
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 56

def updated_at
  @updated_at
end

#validity_day_of_week ⇒ Object

Integer array corresponding to the particular days of the week in which the earning rule is valid. - ‘0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday



50
51
52
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 50

def validity_day_of_week
  @validity_day_of_week
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



47
48
49
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 47

def validity_timeframe
  @validity_timeframe
end

Class Method Details

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



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
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 375

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = VoucherifySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



106
107
108
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 106

def self.acceptable_attributes
  attribute_map.values
end

.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
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 84

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'loyalty' => :'loyalty',
    :'event' => :'event',
    :'custom_event' => :'custom_event',
    :'segment' => :'segment',
    :'source' => :'source',
    :'object' => :'object',
    :'automation_id' => :'automation_id',
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'validity_timeframe' => :'validity_timeframe',
    :'validity_day_of_week' => :'validity_day_of_week',
    :'metadata' => :'metadata',
    :'updated_at' => :'updated_at',
    :'active' => :'active'
  }
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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 351

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)



140
141
142
143
144
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 140

def self.openapi_all_of
  [
  :'EarningRuleBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



133
134
135
136
137
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 133

def self.openapi_nullable
  Set.new([
    :'updated_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 111

def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Time',
    :'loyalty' => :'EarningRuleBaseLoyalty',
    :'event' => :'EarningRuleEvent',
    :'custom_event' => :'EarningRuleBaseCustomEvent',
    :'segment' => :'EarningRuleBaseSegment',
    :'source' => :'EarningRuleBaseSource',
    :'object' => :'String',
    :'automation_id' => :'String',
    :'start_date' => :'String',
    :'expiration_date' => :'String',
    :'validity_timeframe' => :'EarningRuleBaseValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'metadata' => :'Object',
    :'updated_at' => :'Time',
    :'active' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 315

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      loyalty == o.loyalty &&
      event == o.event &&
      custom_event == o.custom_event &&
      segment == o.segment &&
      source == o.source &&
      object == o.object &&
      automation_id == o.automation_id &&
      start_date == o.start_date &&
      expiration_date == o.expiration_date &&
      validity_timeframe == o.validity_timeframe &&
      validity_day_of_week == o.validity_day_of_week &&
      metadata == o.metadata &&
      updated_at == o.updated_at &&
      active == o.active
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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 446

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


338
339
340
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



344
345
346
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 344

def hash
  [id, created_at, loyalty, event, custom_event, segment, source, object, automation_id, start_date, expiration_date, validity_timeframe, validity_day_of_week, metadata, updated_at, active].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



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
282
283
284
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 248

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

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

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



422
423
424
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 422

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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 428

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



416
417
418
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 416

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb', line 288

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @loyalty.nil?
  return false if @source.nil?
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["earning_rule"])
  return false unless object_validator.valid?(@object)
  return false if @automation_id.nil?
  return false if @metadata.nil?
  return false if @active.nil?
  true
end