Class: Plaid::TransferEvent

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

Overview

Represents an event in the Transfers API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
173
174
175
176
 
# File 'lib/plaid/models/transfer_event.rb', line 112

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferEvent` 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::TransferEvent`. 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?(:'event_id')
    self.event_id = attributes[:'event_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The account ID associated with the transfer.



28
29
30
 
# File 'lib/plaid/models/transfer_event.rb', line 28

def 
  @account_id
end

#event_id ⇒ Object

Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.



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

def event_id
  @event_id
end

#event_type ⇒ Object

Returns the value of attribute event_type.



25
26
27
 
# File 'lib/plaid/models/transfer_event.rb', line 25

def event_type
  @event_type
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



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

def failure_reason
  @failure_reason
end

#origination_account_id ⇒ Object

The ID of the origination account that this balance belongs to.



34
35
36
 
# File 'lib/plaid/models/transfer_event.rb', line 34

def 
  @origination_account_id
end

#originator_client_id ⇒ Object

The Plaid client ID that is the originator of the transfer that this event applies to. Only present if the transfer was created on behalf of another client as a third-party sender (TPS).



53
54
55
 
# File 'lib/plaid/models/transfer_event.rb', line 53

def originator_client_id
  @originator_client_id
end

#refund_id ⇒ Object

Plaid’s unique identifier for a refund. A non-null value indicates the event is for the associated refund of the transfer.



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

def refund_id
  @refund_id
end

#sweep_amount ⇒ Object

A signed amount of how much was ‘swept` or `return_swept` (decimal string with two digits of precision e.g. "-5.50").



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

def sweep_amount
  @sweep_amount
end

#sweep_id ⇒ Object

Plaid’s unique identifier for a sweep.



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

def sweep_id
  @sweep_id
end

#timestamp ⇒ Object

The datetime when this event occurred. This will be of the form ‘2006-01-02T15:04:05Z`.



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

def timestamp
  @timestamp
end

#transfer_amount ⇒ Object

The amount of the transfer (decimal string with two digits of precision e.g. "10.00").



39
40
41
 
# File 'lib/plaid/models/transfer_event.rb', line 39

def transfer_amount
  @transfer_amount
end

#transfer_id ⇒ Object

Plaid’s unique identifier for a transfer.



31
32
33
 
# File 'lib/plaid/models/transfer_event.rb', line 31

def transfer_id
  @transfer_id
end

#transfer_type ⇒ Object

Returns the value of attribute transfer_type.



36
37
38
 
# File 'lib/plaid/models/transfer_event.rb', line 36

def transfer_type
  @transfer_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/plaid/models/transfer_event.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/plaid/models/transfer_event.rb', line 56

def self.attribute_map
  {
    :'event_id' => :'event_id',
    :'timestamp' => :'timestamp',
    :'event_type' => :'event_type',
    :'account_id' => :'account_id',
    :'transfer_id' => :'transfer_id',
    :'origination_account_id' => :'origination_account_id',
    :'transfer_type' => :'transfer_type',
    :'transfer_amount' => :'transfer_amount',
    :'failure_reason' => :'failure_reason',
    :'sweep_id' => :'sweep_id',
    :'sweep_amount' => :'sweep_amount',
    :'refund_id' => :'refund_id',
    :'originator_client_id' => :'originator_client_id'
  }
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



282
283
284
 
# File 'lib/plaid/models/transfer_event.rb', line 282

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/plaid/models/transfer_event.rb', line 99

def self.openapi_nullable
  Set.new([
    :'origination_account_id',
    :'failure_reason',
    :'sweep_id',
    :'sweep_amount',
    :'refund_id',
    :'originator_client_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/plaid/models/transfer_event.rb', line 80

def self.openapi_types
  {
    :'event_id' => :'Integer',
    :'timestamp' => :'Time',
    :'event_type' => :'TransferEventType',
    :'account_id' => :'String',
    :'transfer_id' => :'String',
    :'origination_account_id' => :'String',
    :'transfer_type' => :'TransferType',
    :'transfer_amount' => :'String',
    :'failure_reason' => :'TransferFailure',
    :'sweep_id' => :'String',
    :'sweep_amount' => :'String',
    :'refund_id' => :'String',
    :'originator_client_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/plaid/models/transfer_event.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_id == o.event_id &&
      timestamp == o.timestamp &&
      event_type == o.event_type &&
       == o. &&
      transfer_id == o.transfer_id &&
       == o. &&
      transfer_type == o.transfer_type &&
      transfer_amount == o.transfer_amount &&
      failure_reason == o.failure_reason &&
      sweep_id == o.sweep_id &&
      sweep_amount == o.sweep_amount &&
      refund_id == o.refund_id &&
      originator_client_id == o.originator_client_id
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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/plaid/models/transfer_event.rb', line 312

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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/plaid/models/transfer_event.rb', line 383

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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/plaid/models/transfer_event.rb', line 289

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


269
270
271
 
# File 'lib/plaid/models/transfer_event.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/plaid/models/transfer_event.rb', line 275

def hash
  [event_id, timestamp, event_type, , transfer_id, , transfer_type, transfer_amount, failure_reason, sweep_id, sweep_amount, refund_id, originator_client_id].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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/plaid/models/transfer_event.rb', line 180

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

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


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

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

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

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

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

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



359
360
361
 
# File 'lib/plaid/models/transfer_event.rb', line 359

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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/plaid/models/transfer_event.rb', line 365

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



353
354
355
 
# File 'lib/plaid/models/transfer_event.rb', line 353

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



220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/plaid/models/transfer_event.rb', line 220

def valid?
  return false if @event_id.nil?
  return false if @event_id < 0
  return false if @timestamp.nil?
  return false if @event_type.nil?
  return false if @account_id.nil?
  return false if @transfer_id.nil?
  return false if @transfer_type.nil?
  return false if @transfer_amount.nil?
  true
end