Class: Brevo::CreateTransactionPayload

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

Overview

Payload for creating a transaction, specifying balance details and optional expiration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTransactionPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
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
114
115
116
117
118
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 77

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Transaction amount (must be provided).



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

def amount
  @amount
end

#auto_complete ⇒ Object

Whether the transaction should be automatically completed.



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

def auto_complete
  @auto_complete
end

#balance_definition_id ⇒ Object

Unique identifier (UUID) of the associated balance definition.



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

def balance_definition_id
  @balance_definition_id
end

#balance_expiry_in_minutes ⇒ Object

Optional expiry time for the balance in minutes (must be greater than 0 if provided).



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

def balance_expiry_in_minutes
  @balance_expiry_in_minutes
end

#contact_id ⇒ Object

Unique identifier of the contact involved in the transaction (required unless ‘LoyaltySubscriptionId` is provided).



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

def contact_id
  @contact_id
end

#event_time ⇒ Object

Optional timestamp specifying when the transaction occurred.



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

def event_time
  @event_time
end

#loyalty_subscription_id ⇒ Object

Unique identifier for the loyalty subscription (required unless ‘contactId` is provided).



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

def loyalty_subscription_id
  @loyalty_subscription_id
end

#meta ⇒ Object

Optional metadata associated with the transaction.



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

def meta
  @meta
end

#ttl ⇒ Object

Optional time-to-live for the transaction (must be greater than 0 if provided).



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

def ttl
  @ttl
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 46

def self.attribute_map
  {
    :'loyalty_subscription_id' => :'LoyaltySubscriptionId',
    :'amount' => :'amount',
    :'auto_complete' => :'autoComplete',
    :'balance_definition_id' => :'balanceDefinitionId',
    :'balance_expiry_in_minutes' => :'balanceExpiryInMinutes',
    :'contact_id' => :'contactId',
    :'event_time' => :'eventTime',
    :'meta' => :'meta',
    :'ttl' => :'ttl'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 61

def self.swagger_types
  {
    :'loyalty_subscription_id' => :'String',
    :'amount' => :'Float',
    :'auto_complete' => :'BOOLEAN',
    :'balance_definition_id' => :'String',
    :'balance_expiry_in_minutes' => :'Integer',
    :'contact_id' => :'Integer',
    :'event_time' => :'String',
    :'meta' => :'Object',
    :'ttl' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      loyalty_subscription_id == o.loyalty_subscription_id &&
      amount == o.amount &&
      auto_complete == o.auto_complete &&
      balance_definition_id == o.balance_definition_id &&
      balance_expiry_in_minutes == o.balance_expiry_in_minutes &&
      contact_id == o.contact_id &&
      event_time == o.event_time &&
      meta == o.meta &&
      ttl == o.ttl
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 210

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 276

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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 182

def hash
  [loyalty_subscription_id, amount, auto_complete, balance_definition_id, balance_expiry_in_minutes, contact_id, event_time, meta, ttl].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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 122

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

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

  if !@contact_id.nil? && @contact_id < 1
    invalid_properties.push('invalid value for "contact_id", must be greater than or equal to 1.')
  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



256
257
258
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 256

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



262
263
264
265
266
267
268
269
270
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 262

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



250
251
252
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 250

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



141
142
143
144
145
146
 
# File 'lib/brevo/models/create_transaction_payload.rb', line 141

def valid?
  return false if @amount.nil?
  return false if @balance_definition_id.nil?
  return false if !@contact_id.nil? && @contact_id < 1
  true
end