Class: Plaid::TransferLedgerEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/transfer_ledger_event.rb

Overview

Represents a ledger event in the Transfers API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferLedgerEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 102

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferLedgerEvent` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransferLedgerEvent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'ledger_event_id')
    self.ledger_event_id = attributes[:'ledger_event_id']
  end

  if attributes.key?(:'ledger_id')
    self.ledger_id = attributes[:'ledger_id']
  end

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

  if attributes.key?(:'transfer_id')
    self.transfer_id = attributes[:'transfer_id']
  end

  if attributes.key?(:'refund_id')
    self.refund_id = attributes[:'refund_id']
  end

  if attributes.key?(:'sweep_id')
    self.sweep_id = attributes[:'sweep_id']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'pending_balance')
    self.pending_balance = attributes[:'pending_balance']
  end

  if attributes.key?(:'available_balance')
    self.available_balance = attributes[:'available_balance']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'timestamp')
    self.timestamp = attributes[:'timestamp']
  end
end

Instance Attribute Details

#amount ⇒ Object

The amount of the ledger event as a decimal string.



26
27
28
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 26

def amount
  @amount
end

#available_balance ⇒ Object

The new available balance after this event.



44
45
46
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 44

def available_balance
  @available_balance
end

#description ⇒ Object

A description of the ledger event.



38
39
40
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 38

def description
  @description
end

#ledger_event_id ⇒ Object

Plaid’s unique identifier for this ledger event.



20
21
22
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 20

def ledger_event_id
  @ledger_event_id
end

#ledger_id ⇒ Object

The ID of the ledger this event belongs to.



23
24
25
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 23

def ledger_id
  @ledger_id
end

#pending_balance ⇒ Object

The new pending balance after this event.



41
42
43
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 41

def pending_balance
  @pending_balance
end

#refund_id ⇒ Object

The ID of the refund source that triggered this ledger event.



32
33
34
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 32

def refund_id
  @refund_id
end

#sweep_id ⇒ Object

The ID of the sweep source that triggered this ledger event.



35
36
37
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 35

def sweep_id
  @sweep_id
end

#timestamp ⇒ Object

The datetime when this ledger event occurred.



50
51
52
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 50

def timestamp
  @timestamp
end

#transfer_id ⇒ Object

The ID of the transfer source that triggered this ledger event.



29
30
31
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 29

def transfer_id
  @transfer_id
end

#type ⇒ Object

The type of balance that was impacted by this event.



47
48
49
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 47

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 53

def self.attribute_map
  {
    :'ledger_event_id' => :'ledger_event_id',
    :'ledger_id' => :'ledger_id',
    :'amount' => :'amount',
    :'transfer_id' => :'transfer_id',
    :'refund_id' => :'refund_id',
    :'sweep_id' => :'sweep_id',
    :'description' => :'description',
    :'pending_balance' => :'pending_balance',
    :'available_balance' => :'available_balance',
    :'type' => :'type',
    :'timestamp' => :'timestamp'
  }
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



246
247
248
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 246

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
96
97
98
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 92

def self.openapi_nullable
  Set.new([
    :'transfer_id',
    :'refund_id',
    :'sweep_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 75

def self.openapi_types
  {
    :'ledger_event_id' => :'String',
    :'ledger_id' => :'String',
    :'amount' => :'String',
    :'transfer_id' => :'String',
    :'refund_id' => :'String',
    :'sweep_id' => :'String',
    :'description' => :'String',
    :'pending_balance' => :'String',
    :'available_balance' => :'String',
    :'type' => :'String',
    :'timestamp' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ledger_event_id == o.ledger_event_id &&
      ledger_id == o.ledger_id &&
      amount == o.amount &&
      transfer_id == o.transfer_id &&
      refund_id == o.refund_id &&
      sweep_id == o.sweep_id &&
      description == o.description &&
      pending_balance == o.pending_balance &&
      available_balance == o.available_balance &&
      type == o.type &&
      timestamp == o.timestamp
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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 277

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 348

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 253

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


233
234
235
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



239
240
241
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 239

def hash
  [ledger_event_id, ledger_id, amount, transfer_id, refund_id, sweep_id, description, pending_balance, available_balance, type, timestamp].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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 162

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

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

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

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

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

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

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

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



324
325
326
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 324

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



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

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



318
319
320
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 318

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



201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/plaid/models/transfer_ledger_event.rb', line 201

def valid?
  return false if @ledger_event_id.nil?
  return false if @ledger_id.nil?
  return false if @amount.nil?
  return false if @description.nil?
  return false if @pending_balance.nil?
  return false if @available_balance.nil?
  return false if @type.nil?
  return false if @timestamp.nil?
  true
end