Class: Brevo::UpdateBalanceLimitPayload

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

Overview

Payload for updating an existing balance limit, specifying constraints on transactions or amounts.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateBalanceLimitPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 84

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?(:'constraintType')
    self.constraint_type = attributes[:'constraintType']
  end

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

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

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

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

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

Instance Attribute Details

#constraint_type ⇒ Object

Defines whether the limit applies to transaction count or amount.



19
20
21
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 19

def constraint_type
  @constraint_type
end

#duration_unit ⇒ Object

Unit of time for which the limit is applicable.



22
23
24
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 22

def duration_unit
  @duration_unit
end

#duration_value ⇒ Object

Number of time units for the balance limit.



25
26
27
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 25

def duration_value
  @duration_value
end

#sliding_schedule ⇒ Object

Determines if the limit resets on a rolling schedule.



28
29
30
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 28

def sliding_schedule
  @sliding_schedule
end

#transaction_type ⇒ Object

Specifies whether the limit applies to credit or debit transactions.



31
32
33
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 31

def transaction_type
  @transaction_type
end

#value ⇒ Object

Maximum allowed value for the specified constraint type.



34
35
36
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 34

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 59

def self.attribute_map
  {
    :'constraint_type' => :'constraintType',
    :'duration_unit' => :'durationUnit',
    :'duration_value' => :'durationValue',
    :'sliding_schedule' => :'slidingSchedule',
    :'transaction_type' => :'transactionType',
    :'value' => :'value'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 71

def self.swagger_types
  {
    :'constraint_type' => :'String',
    :'duration_unit' => :'String',
    :'duration_value' => :'Integer',
    :'sliding_schedule' => :'BOOLEAN',
    :'transaction_type' => :'String',
    :'value' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      constraint_type == o.constraint_type &&
      duration_unit == o.duration_unit &&
      duration_value == o.duration_value &&
      sliding_schedule == o.sliding_schedule &&
      transaction_type == o.transaction_type &&
      value == o.value
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



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

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 304

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 217

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


204
205
206
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 210

def hash
  [constraint_type, duration_unit, duration_value, sliding_schedule, transaction_type, value].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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 117

def list_invalid_properties
  invalid_properties = Array.new
  if @constraint_type.nil?
    invalid_properties.push('invalid value for "constraint_type", constraint_type cannot be nil.')
  end

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

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

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

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



284
285
286
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 284

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



290
291
292
293
294
295
296
297
298
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 290

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



278
279
280
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 278

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/brevo/models/update_balance_limit_payload.rb', line 144

def valid?
  return false if @constraint_type.nil?
  constraint_type_validator = EnumAttributeValidator.new('String', ['transaction', 'amount'])
  return false unless constraint_type_validator.valid?(@constraint_type)
  return false if @duration_unit.nil?
  duration_unit_validator = EnumAttributeValidator.new('String', ['day', 'week', 'month', 'year'])
  return false unless duration_unit_validator.valid?(@duration_unit)
  return false if @duration_value.nil?
  return false if @transaction_type.nil?
  transaction_type_validator = EnumAttributeValidator.new('String', ['credit', 'debit'])
  return false unless transaction_type_validator.valid?(@transaction_type)
  return false if @value.nil?
  true
end