Class: Brevo::Transaction

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

Overview

Represents a transaction involving a balance, including status and timestamps.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transaction

Initializes the object



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

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

  if attributes.has_key?(:'completedAt')
    self.completed_at = attributes[:'completedAt']
  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?(:'eventTime')
    self.event_time = attributes[:'eventTime']
  end

  if attributes.has_key?(:'expirationDate')
    self.expiration_date = attributes[:'expirationDate']
  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?(:'rejectReason')
    self.reject_reason = attributes[:'rejectReason']
  end

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

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

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

Instance Attribute Details

#amount ⇒ Object

The transaction amount.



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

def amount
  @amount
end

#balance_definition_id ⇒ Object

Unique identifier (UUID) of the associated balance definition.



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

def balance_definition_id
  @balance_definition_id
end

#cancelled_at ⇒ Object

Timestamp when the transaction was canceled (nullable).



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

def cancelled_at
  @cancelled_at
end

#completed_at ⇒ Object

Timestamp when the transaction was completed (nullable).



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

def completed_at
  @completed_at
end

#contact_id ⇒ Object

Unique identifier of the contact associated with the transaction.



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

def contact_id
  @contact_id
end

#created_at ⇒ Object

Timestamp when the transaction was created.



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

def created_at
  @created_at
end

#event_time ⇒ Object

Optional timestamp indicating when the transaction event occurred.



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

def event_time
  @event_time
end

#expiration_date ⇒ Object

Expiry date of the transaction (nullable).



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

def expiration_date
  @expiration_date
end

#id ⇒ Object

Unique identifier (UUID) of the transaction.



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

def id
  @id
end

#loyalty_program_id ⇒ Object

Unique identifier (UUID) of the associated loyalty program.



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

def loyalty_program_id
  @loyalty_program_id
end

#meta ⇒ Object

Optional metadata associated with the transaction.



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

def meta
  @meta
end

#reject_reason ⇒ Object

Reason for rejection if the transaction was declined (nullable).



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

def reject_reason
  @reject_reason
end

#rejected_at ⇒ Object

Timestamp when the transaction was rejected (nullable).



55
56
57
 
# File 'lib/brevo/models/transaction.rb', line 55

def rejected_at
  @rejected_at
end

#status ⇒ Object

The current status of the transaction (e.g., pending, completed, rejected).



58
59
60
 
# File 'lib/brevo/models/transaction.rb', line 58

def status
  @status
end

#updated_at ⇒ Object

Timestamp when the transaction was last updated.



61
62
63
 
# File 'lib/brevo/models/transaction.rb', line 61

def updated_at
  @updated_at
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
76
77
78
79
80
81
82
 
# File 'lib/brevo/models/transaction.rb', line 64

def self.attribute_map
  {
    :'amount' => :'amount',
    :'balance_definition_id' => :'balanceDefinitionId',
    :'cancelled_at' => :'cancelledAt',
    :'completed_at' => :'completedAt',
    :'contact_id' => :'contactId',
    :'created_at' => :'createdAt',
    :'event_time' => :'eventTime',
    :'expiration_date' => :'expirationDate',
    :'id' => :'id',
    :'loyalty_program_id' => :'loyaltyProgramId',
    :'meta' => :'meta',
    :'reject_reason' => :'rejectReason',
    :'rejected_at' => :'rejectedAt',
    :'status' => :'status',
    :'updated_at' => :'updatedAt'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/brevo/models/transaction.rb', line 85

def self.swagger_types
  {
    :'amount' => :'Float',
    :'balance_definition_id' => :'String',
    :'cancelled_at' => :'String',
    :'completed_at' => :'String',
    :'contact_id' => :'Integer',
    :'created_at' => :'String',
    :'event_time' => :'String',
    :'expiration_date' => :'String',
    :'id' => :'String',
    :'loyalty_program_id' => :'String',
    :'meta' => :'Object',
    :'reject_reason' => :'String',
    :'rejected_at' => :'String',
    :'status' => :'String',
    :'updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/brevo/models/transaction.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      balance_definition_id == o.balance_definition_id &&
      cancelled_at == o.cancelled_at &&
      completed_at == o.completed_at &&
      contact_id == o.contact_id &&
      created_at == o.created_at &&
      event_time == o.event_time &&
      expiration_date == o.expiration_date &&
      id == o.id &&
      loyalty_program_id == o.loyalty_program_id &&
      meta == o.meta &&
      reject_reason == o.reject_reason &&
      rejected_at == o.rejected_at &&
      status == o.status &&
      updated_at == o.updated_at
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
275
276
277
278
279
280
281
 
# File 'lib/brevo/models/transaction.rb', line 245

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/brevo/models/transaction.rb', line 311

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/brevo/models/transaction.rb', line 224

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


211
212
213
 
# File 'lib/brevo/models/transaction.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



217
218
219
 
# File 'lib/brevo/models/transaction.rb', line 217

def hash
  [amount, balance_definition_id, cancelled_at, completed_at, contact_id, created_at, event_time, expiration_date, id, loyalty_program_id, meta, reject_reason, rejected_at, status, updated_at].hash
end

#list_invalid_properties ⇒ Object

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



176
177
178
179
 
# File 'lib/brevo/models/transaction.rb', line 176

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



291
292
293
 
# File 'lib/brevo/models/transaction.rb', line 291

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



297
298
299
300
301
302
303
304
305
 
# File 'lib/brevo/models/transaction.rb', line 297

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



285
286
287
 
# File 'lib/brevo/models/transaction.rb', line 285

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



183
184
185
 
# File 'lib/brevo/models/transaction.rb', line 183

def valid?
  true
end