Class: VoucherifySdk::PromotionTierCreateParams

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

Overview

This is an object representing a promotion tier create params. Promotion tiers are always assigned to a campaign and cannot be used standalone.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PromotionTierCreateParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
202
203
204
205
206
207
208
209
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 144

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

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

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

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

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



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

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



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

def active
  @active
end

Text to be displayed to your customers on your website.



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

def banner
  @banner
end

#category ⇒ Object

Assign category to the promotion tier.



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

def category
  @category
end

#category_id ⇒ Object

Instead of using the category name, you can alternatively assign a new category to a promotion tier using a unique category ID, i.e. ‘cat_0c9da30e7116ba6bba`.



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

def category_id
  @category_id
end

#expiration_date ⇒ Object

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



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

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.



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

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



28
29
30
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 28

def metadata
  @metadata
end

#name ⇒ Object

Name of the promotion tier.



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

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



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

def start_date
  @start_date
end

#validation_rules ⇒ Object

Array containing the ID of the validation rule associated with the promotion tier.



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

def validation_rules
  @validation_rules
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



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

def validity_day_of_week
  @validity_day_of_week
end

#validity_hours ⇒ Object

Returns the value of attribute validity_hours.



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

def validity_hours
  @validity_hours
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



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

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



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

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



101
102
103
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 101

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'name' => :'name',
    :'banner' => :'banner',
    :'action' => :'action',
    :'metadata' => :'metadata',
    :'validation_rules' => :'validation_rules',
    :'active' => :'active',
    :'hierarchy' => :'hierarchy',
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'validity_timeframe' => :'validity_timeframe',
    :'validity_day_of_week' => :'validity_day_of_week',
    :'validity_hours' => :'validity_hours',
    :'category' => :'category',
    :'category_id' => :'category_id'
  }
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 262

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 126

def self.openapi_nullable
  Set.new([
    :'name',
    :'banner',
    :'action',
    :'metadata',
    :'validation_rules',
    :'active',
    :'hierarchy',
    :'start_date',
    :'expiration_date',
    :'category',
    :'category_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 106

def self.openapi_types
  {
    :'name' => :'String',
    :'banner' => :'String',
    :'action' => :'PromotionTierCreateParamsAction',
    :'metadata' => :'Object',
    :'validation_rules' => :'Array<String>',
    :'active' => :'Boolean',
    :'hierarchy' => :'Integer',
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'validity_timeframe' => :'ValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'validity_hours' => :'ValidityHours',
    :'category' => :'String',
    :'category_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      banner == o.banner &&
      action == o.action &&
      metadata == o.metadata &&
      validation_rules == o.validation_rules &&
      active == o.active &&
      hierarchy == o.hierarchy &&
      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 &&
      category == o.category &&
      category_id == o.category_id
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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 357

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


249
250
251
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



255
256
257
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 255

def hash
  [name, banner, action, metadata, validation_rules, active, hierarchy, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, category, category_id].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



213
214
215
216
217
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 213

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



333
334
335
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 333

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 339

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



327
328
329
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 327

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



221
222
223
224
 
# File 'lib/VoucherifySdk/models/promotion_tier_create_params.rb', line 221

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