Class: Brevo::TierGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/models/tier_group.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TierGroup

Initializes the object



93
94
95
96
97
98
99
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
 
# File 'lib/brevo/models/tier_group.rb', line 93

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

  if attributes.has_key?(:'tierOrder')
    if (value = attributes[:'tierOrder']).is_a?(Array)
      self.tier_order = value
    end
  end

  if attributes.has_key?(:'loyaltyProgramId')
    self.loyalty_program_id = attributes[:'loyaltyProgramId']
  end

  if attributes.has_key?(:'upgradeStrategy')
    self.upgrade_strategy = attributes[:'upgradeStrategy']
  else
    self.upgrade_strategy = 'real_time'
  end

  if attributes.has_key?(:'downgradeStrategy')
    self.downgrade_strategy = attributes[:'downgradeStrategy']
  else
    self.downgrade_strategy = 'real_time'
  end

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

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

Instance Attribute Details

#created_at ⇒ Object

Timestamp when the tier group was created



36
37
38
 
# File 'lib/brevo/models/tier_group.rb', line 36

def created_at
  @created_at
end

#downgrade_strategy ⇒ Object

Select real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary.



33
34
35
 
# File 'lib/brevo/models/tier_group.rb', line 33

def downgrade_strategy
  @downgrade_strategy
end

#id ⇒ Object

Tier group unique identifier



18
19
20
 
# File 'lib/brevo/models/tier_group.rb', line 18

def id
  @id
end

#loyalty_program_id ⇒ Object

Associated loyalty program Id



27
28
29
 
# File 'lib/brevo/models/tier_group.rb', line 27

def loyalty_program_id
  @loyalty_program_id
end

#name ⇒ Object

Tier group name



21
22
23
 
# File 'lib/brevo/models/tier_group.rb', line 21

def name
  @name
end

#tier_order ⇒ Object

Order of the tiers in the group in ascending order



24
25
26
 
# File 'lib/brevo/models/tier_group.rb', line 24

def tier_order
  @tier_order
end

#updated_at ⇒ Object

Timestamp when the tier group was last updated



39
40
41
 
# File 'lib/brevo/models/tier_group.rb', line 39

def updated_at
  @updated_at
end

#upgrade_strategy ⇒ Object

Select real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary.



30
31
32
 
# File 'lib/brevo/models/tier_group.rb', line 30

def upgrade_strategy
  @upgrade_strategy
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/brevo/models/tier_group.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'tier_order' => :'tierOrder',
    :'loyalty_program_id' => :'loyaltyProgramId',
    :'upgrade_strategy' => :'upgradeStrategy',
    :'downgrade_strategy' => :'downgradeStrategy',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/brevo/models/tier_group.rb', line 78

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'tier_order' => :'Array<String>',
    :'loyalty_program_id' => :'String',
    :'upgrade_strategy' => :'String',
    :'downgrade_strategy' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/brevo/models/tier_group.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      tier_order == o.tier_order &&
      loyalty_program_id == o.loyalty_program_id &&
      upgrade_strategy == o.upgrade_strategy &&
      downgrade_strategy == o.downgrade_strategy &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
 
# File 'lib/brevo/models/tier_group.rb', line 226

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
    temp_model = Brevo.const_get(type).new
    temp_model.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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/brevo/models/tier_group.rb', line 292

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/brevo/models/tier_group.rb', line 205

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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

See Also:

  • `==` method


192
193
194
 
# File 'lib/brevo/models/tier_group.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



198
199
200
 
# File 'lib/brevo/models/tier_group.rb', line 198

def hash
  [id, name, tier_order, loyalty_program_id, upgrade_strategy, downgrade_strategy, created_at, updated_at].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



140
141
142
143
 
# File 'lib/brevo/models/tier_group.rb', line 140

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



272
273
274
 
# File 'lib/brevo/models/tier_group.rb', line 272

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



278
279
280
281
282
283
284
285
286
 
# File 'lib/brevo/models/tier_group.rb', line 278

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



266
267
268
 
# File 'lib/brevo/models/tier_group.rb', line 266

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



147
148
149
150
151
152
153
 
# File 'lib/brevo/models/tier_group.rb', line 147

def valid?
  upgrade_strategy_validator = EnumAttributeValidator.new('String', ['real_time', 'membership_anniversary', 'tier_anniversary'])
  return false unless upgrade_strategy_validator.valid?(@upgrade_strategy)
  downgrade_strategy_validator = EnumAttributeValidator.new('String', ['real_time', 'membership_anniversary', 'tier_anniversary'])
  return false unless downgrade_strategy_validator.valid?(@downgrade_strategy)
  true
end