Class: VoucherifySdk::PromotionsTiersEnableResponseBody

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

Overview

Response body schema for POST ‘v1/promotions/tiers/promotionTierId/enable`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PromotionsTiersEnableResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



34
35
36
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 34

def action
  @action
end

#active ⇒ Object

A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it’s within the active period defined by the ‘start_date` and `expiration_date`. - `true` indicates an active promotion tier - `false` indicates an inactive promotion tier



51
52
53
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 51

def active
  @active
end

Text to be displayed to your customers on your website.



32
33
34
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 32

def banner
  @banner
end

#campaign ⇒ Object

Returns the value of attribute campaign.



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

def campaign
  @campaign
end

#campaign_id ⇒ Object

Promotion tier’s parent campaign’s unique ID.



48
49
50
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 48

def campaign_id
  @campaign_id
end

#categories ⇒ Object

Returns the value of attribute categories.



76
77
78
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 76

def categories
  @categories
end

#category_id ⇒ Object

Promotion tier category ID.



74
75
76
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 74

def category_id
  @category_id
end

#created_at ⇒ Object

Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format.



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

def created_at
  @created_at
end

#expiration_date ⇒ Object

Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is *inactive after* this date.



57
58
59
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 57

def expiration_date
  @expiration_date
end

#hierarchy ⇒ Object

The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer’s order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.



40
41
42
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 40

def hierarchy
  @hierarchy
end

#id ⇒ Object

Unique promotion tier ID.



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

def id
  @id
end

#metadata ⇒ Object

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



37
38
39
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 37

def metadata
  @metadata
end

#name ⇒ Object

Name of the promotion tier.



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

def name
  @name
end

#object ⇒ Object

The type of the object represented by JSON. This object stores information about the promotion tier.



69
70
71
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 69

def object
  @object
end

#promotion_id ⇒ Object

Promotion unique ID.



43
44
45
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 43

def promotion_id
  @promotion_id
end

#start_date ⇒ Object

Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is *inactive before* this date.



54
55
56
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 54

def start_date
  @start_date
end

#summary ⇒ Object

Returns the value of attribute summary.



66
67
68
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 66

def summary
  @summary
end

#updated_at ⇒ Object

Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format.



26
27
28
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 26

def updated_at
  @updated_at
end

#validation_rule_assignments ⇒ Object

Returns the value of attribute validation_rule_assignments.



71
72
73
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 71

def validation_rule_assignments
  @validation_rule_assignments
end

#validity_day_of_week ⇒ Object

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



62
63
64
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 62

def validity_day_of_week
  @validity_day_of_week
end

#validity_hours ⇒ Object

Returns the value of attribute validity_hours.



64
65
66
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 64

def validity_hours
  @validity_hours
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



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

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



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

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



129
130
131
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 129

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'name' => :'name',
    :'banner' => :'banner',
    :'action' => :'action',
    :'metadata' => :'metadata',
    :'hierarchy' => :'hierarchy',
    :'promotion_id' => :'promotion_id',
    :'campaign' => :'campaign',
    :'campaign_id' => :'campaign_id',
    :'active' => :'active',
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'validity_timeframe' => :'validity_timeframe',
    :'validity_day_of_week' => :'validity_day_of_week',
    :'validity_hours' => :'validity_hours',
    :'summary' => :'summary',
    :'object' => :'object',
    :'validation_rule_assignments' => :'validation_rule_assignments',
    :'category_id' => :'category_id',
    :'categories' => :'categories'
  }
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



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

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_nullable ⇒ Object

List of attributes with nullable: true



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 162

def self.openapi_nullable
  Set.new([
    :'id',
    :'created_at',
    :'updated_at',
    :'name',
    :'banner',
    :'action',
    :'metadata',
    :'hierarchy',
    :'promotion_id',
    :'campaign',
    :'campaign_id',
    :'active',
    :'start_date',
    :'expiration_date',
    :'summary',
    :'object',
    :'category_id',
    :'categories'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'name' => :'String',
    :'banner' => :'String',
    :'action' => :'PromotionsTiersEnableResponseBodyAction',
    :'metadata' => :'Object',
    :'hierarchy' => :'Integer',
    :'promotion_id' => :'String',
    :'campaign' => :'PromotionsTiersEnableResponseBodyCampaign',
    :'campaign_id' => :'String',
    :'active' => :'Boolean',
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'validity_timeframe' => :'ValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'validity_hours' => :'ValidityHours',
    :'summary' => :'PromotionsTiersEnableResponseBodySummary',
    :'object' => :'String',
    :'validation_rule_assignments' => :'ValidationRuleAssignmentsList',
    :'category_id' => :'String',
    :'categories' => :'Array<Category>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      banner == o.banner &&
      action == o.action &&
      metadata == o.metadata &&
      hierarchy == o.hierarchy &&
      promotion_id == o.promotion_id &&
      campaign == o.campaign &&
      campaign_id == o.campaign_id &&
      active == o.active &&
      start_date == o.start_date &&
      expiration_date == o.expiration_date &&
      validity_timeframe == o.validity_timeframe &&
      validity_day_of_week == o.validity_day_of_week &&
      validity_hours == o.validity_hours &&
      summary == o.summary &&
      object == o.object &&
      validation_rule_assignments == o.validation_rule_assignments &&
      category_id == o.category_id &&
      categories == o.categories
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



442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 442

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


334
335
336
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 334

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



340
341
342
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 340

def hash
  [id, created_at, updated_at, name, banner, action, metadata, hierarchy, promotion_id, campaign, campaign_id, active, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, summary, object, validation_rule_assignments, category_id, categories].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



290
291
292
293
294
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 290

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



418
419
420
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 418

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



424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 424

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



412
413
414
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 412

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



298
299
300
301
 
# File 'lib/VoucherifySdk/models/promotions_tiers_enable_response_body.rb', line 298

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end