Class: Brevo::BalanceOrder

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

Overview

Represents an order linked to a balance definition, including amount, due date, and transaction details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BalanceOrder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
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
137
138
139
140
141
142
143
144
145
 
# File 'lib/brevo/models/balance_order.rb', line 92

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Order amount (must not be zero).



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

def amount
  @amount
end

#balance_definition_id ⇒ Object

Optional unique identifier (UUID) of the associated balance definition.



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

def balance_definition_id
  @balance_definition_id
end

#contact_id ⇒ Object

Unique identifier of the contact placing the order (must be ≥ 1).



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

def contact_id
  @contact_id
end

#created_at ⇒ Object

RFC3339 timestamp indicating when the order was created.



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

def created_at
  @created_at
end

#due_at ⇒ Object

RFC3339 timestamp specifying when the order is due in the future.



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

def due_at
  @due_at
end

#expires_at ⇒ Object

Optional RFC3339 timestamp defining order expiration in the future.



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

def expires_at
  @expires_at
end

#id ⇒ Object

Unique identifier for the balance order.



37
38
39
 
# File 'lib/brevo/models/balance_order.rb', line 37

def id
  @id
end

#loyalty_program_id ⇒ Object

Unique identifier of the loyalty program associated with the order.



40
41
42
 
# File 'lib/brevo/models/balance_order.rb', line 40

def loyalty_program_id
  @loyalty_program_id
end

#meta ⇒ Object

Optional metadata associated with the order.



43
44
45
 
# File 'lib/brevo/models/balance_order.rb', line 43

def meta
  @meta
end

#processed_at ⇒ Object

Optional RFC3339 timestamp indicating when the order was processed.



46
47
48
 
# File 'lib/brevo/models/balance_order.rb', line 46

def processed_at
  @processed_at
end

#transactionid ⇒ Object

Optional reference to the associated transaction ID.



49
50
51
 
# File 'lib/brevo/models/balance_order.rb', line 49

def transactionid
  @transactionid
end

#updated_at ⇒ Object

RFC3339 timestamp indicating the last update to the order.



52
53
54
 
# File 'lib/brevo/models/balance_order.rb', line 52

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/brevo/models/balance_order.rb', line 55

def self.attribute_map
  {
    :'amount' => :'amount',
    :'balance_definition_id' => :'balanceDefinitionId',
    :'contact_id' => :'contactId',
    :'created_at' => :'createdAt',
    :'due_at' => :'dueAt',
    :'expires_at' => :'expiresAt',
    :'id' => :'id',
    :'loyalty_program_id' => :'loyaltyProgramId',
    :'meta' => :'meta',
    :'processed_at' => :'processedAt',
    :'transactionid' => :'transactionid',
    :'updated_at' => :'updatedAt'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/brevo/models/balance_order.rb', line 73

def self.swagger_types
  {
    :'amount' => :'Float',
    :'balance_definition_id' => :'String',
    :'contact_id' => :'Integer',
    :'created_at' => :'String',
    :'due_at' => :'String',
    :'expires_at' => :'String',
    :'id' => :'String',
    :'loyalty_program_id' => :'String',
    :'meta' => :'Object',
    :'processed_at' => :'String',
    :'transactionid' => :'String',
    :'updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/brevo/models/balance_order.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      balance_definition_id == o.balance_definition_id &&
      contact_id == o.contact_id &&
      created_at == o.created_at &&
      due_at == o.due_at &&
      expires_at == o.expires_at &&
      id == o.id &&
      loyalty_program_id == o.loyalty_program_id &&
      meta == o.meta &&
      processed_at == o.processed_at &&
      transactionid == o.transactionid &&
      updated_at == o.updated_at
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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/brevo/models/balance_order.rb', line 264

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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/brevo/models/balance_order.rb', line 330

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/brevo/models/balance_order.rb', line 243

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


230
231
232
 
# File 'lib/brevo/models/balance_order.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



236
237
238
 
# File 'lib/brevo/models/balance_order.rb', line 236

def hash
  [amount, balance_definition_id, contact_id, created_at, due_at, expires_at, id, loyalty_program_id, meta, processed_at, transactionid, updated_at].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



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

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

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

  if @contact_id < 1
    invalid_properties.push('invalid value for "contact_id", must be greater than or equal to 1.')
  end

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

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

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

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



310
311
312
 
# File 'lib/brevo/models/balance_order.rb', line 310

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



316
317
318
319
320
321
322
323
324
 
# File 'lib/brevo/models/balance_order.rb', line 316

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



304
305
306
 
# File 'lib/brevo/models/balance_order.rb', line 304

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



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/brevo/models/balance_order.rb', line 184

def valid?
  return false if @amount.nil?
  return false if @contact_id.nil?
  return false if @contact_id < 1
  return false if @created_at.nil?
  return false if @due_at.nil?
  return false if @loyalty_program_id.nil?
  return false if @updated_at.nil?
  true
end