Class: Brevo::CreateTierGroupRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTierGroupRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 73

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

Instance Attribute Details

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



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

def downgrade_strategy
  @downgrade_strategy
end

#name ⇒ Object

Name of the tier group



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

def name
  @name
end

#tier_order ⇒ Object

Order of the tiers in the group in ascending order



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

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



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

def upgrade_strategy
  @upgrade_strategy
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 52

def self.attribute_map
  {
    :'name' => :'name',
    :'upgrade_strategy' => :'upgradeStrategy',
    :'downgrade_strategy' => :'downgradeStrategy',
    :'tier_order' => :'tierOrder'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 62

def self.swagger_types
  {
    :'name' => :'String',
    :'upgrade_strategy' => :'String',
    :'downgrade_strategy' => :'String',
    :'tier_order' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      upgrade_strategy == o.upgrade_strategy &&
      downgrade_strategy == o.downgrade_strategy &&
      tier_order == o.tier_order
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



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

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 257

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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 170

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 163

def hash
  [name, upgrade_strategy, downgrade_strategy, tier_order].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



104
105
106
107
108
109
110
111
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 104

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



237
238
239
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 237

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



243
244
245
246
247
248
249
250
251
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 243

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

Returns:

  • (String) —

    String presentation of the object



231
232
233
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 231

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



115
116
117
118
119
120
121
122
 
# File 'lib/brevo/models/create_tier_group_request.rb', line 115

def valid?
  return false if @name.nil?
  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