Class: Plaid::TransferSweep

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

Overview

Describes a sweep of funds to / from the sweep account. A sweep is associated with many sweep events (events of type ‘swept` or `return_swept`) which can be retrieved by invoking the `/transfer/event/list` endpoint with the corresponding `sweep_id`. `swept` events occur when the transfer amount is credited or debited from your sweep account, depending on the `type` of the transfer. `return_swept` events occur when a transfer is returned and Plaid undoes the credit or debit. The total sum of the `swept` and `return_swept` events is equal to the `amount` of the sweep Plaid creates and matches the amount of the entry on your sweep account ledger.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferSweep

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/plaid/models/transfer_sweep.rb', line 135

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. "-10.00") If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.



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

def amount
  @amount
end

#created ⇒ Object

The datetime when the sweep occurred, in RFC 3339 format.



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

def created
  @created
end

#description ⇒ Object

The description of the deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may not show it on the bank statement.



48
49
50
 
# File 'lib/plaid/models/transfer_sweep.rb', line 48

def description
  @description
end

#expected_funds_available_date ⇒ Object

The expected date when funds from a ledger deposit will be made available and can be withdrawn from the associated ledger balance. Only applies to deposits. This will be of the form YYYY-MM-DD.



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

def expected_funds_available_date
  @expected_funds_available_date
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



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

def failure_reason
  @failure_reason
end

#funding_account_id ⇒ Object

The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.



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

def 
  @funding_account_id
end

#id ⇒ Object

Identifier of the sweep.



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

def id
  @id
end

#iso_currency_code ⇒ Object

The currency of the sweep, e.g. "USD".



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

def iso_currency_code
  @iso_currency_code
end

#ledger_id ⇒ Object

Plaid’s unique identifier for a Plaid Ledger Balance.



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

def ledger_id
  @ledger_id
end

#network_trace_id ⇒ Object

The trace identifier for the transfer based on its network. This will only be set after the transfer has posted. For ‘ach` or `same-day-ach` transfers, this is the ACH trace number. For `rtp` transfers, this is the Transaction Identification number. For `wire` transfers, this is the IMAD (Input Message Accountability Data) number.



51
52
53
 
# File 'lib/plaid/models/transfer_sweep.rb', line 51

def network_trace_id
  @network_trace_id
end

#settled ⇒ Object

The date when the sweep settled, in the YYYY-MM-DD format.



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

def settled
  @settled
end

#status ⇒ Object

Returns the value of attribute status.



43
44
45
 
# File 'lib/plaid/models/transfer_sweep.rb', line 43

def status
  @status
end

#trigger ⇒ Object

Returns the value of attribute trigger.



45
46
47
 
# File 'lib/plaid/models/transfer_sweep.rb', line 45

def trigger
  @trigger
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/plaid/models/transfer_sweep.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'funding_account_id' => :'funding_account_id',
    :'ledger_id' => :'ledger_id',
    :'created' => :'created',
    :'amount' => :'amount',
    :'iso_currency_code' => :'iso_currency_code',
    :'settled' => :'settled',
    :'expected_funds_available_date' => :'expected_funds_available_date',
    :'status' => :'status',
    :'trigger' => :'trigger',
    :'description' => :'description',
    :'network_trace_id' => :'network_trace_id',
    :'failure_reason' => :'failure_reason'
  }
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



274
275
276
 
# File 'lib/plaid/models/transfer_sweep.rb', line 274

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/plaid/models/transfer_sweep.rb', line 121

def self.openapi_nullable
  Set.new([
    :'ledger_id',
    :'settled',
    :'expected_funds_available_date',
    :'status',
    :'trigger',
    :'network_trace_id',
    :'failure_reason'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/plaid/models/transfer_sweep.rb', line 102

def self.openapi_types
  {
    :'id' => :'String',
    :'funding_account_id' => :'String',
    :'ledger_id' => :'String',
    :'created' => :'Time',
    :'amount' => :'String',
    :'iso_currency_code' => :'String',
    :'settled' => :'Date',
    :'expected_funds_available_date' => :'Date',
    :'status' => :'SweepStatus',
    :'trigger' => :'SweepTrigger',
    :'description' => :'String',
    :'network_trace_id' => :'String',
    :'failure_reason' => :'SweepFailure'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/plaid/models/transfer_sweep.rb', line 241

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
       == o. &&
      ledger_id == o.ledger_id &&
      created == o.created &&
      amount == o.amount &&
      iso_currency_code == o.iso_currency_code &&
      settled == o.settled &&
      expected_funds_available_date == o.expected_funds_available_date &&
      status == o.status &&
      trigger == o.trigger &&
      description == o.description &&
      network_trace_id == o.network_trace_id &&
      failure_reason == o.failure_reason
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



305
306
307
308
309
310
311
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
 
# File 'lib/plaid/models/transfer_sweep.rb', line 305

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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/plaid/models/transfer_sweep.rb', line 376

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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/plaid/models/transfer_sweep.rb', line 281

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


261
262
263
 
# File 'lib/plaid/models/transfer_sweep.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



267
268
269
 
# File 'lib/plaid/models/transfer_sweep.rb', line 267

def hash
  [id, , ledger_id, created, amount, iso_currency_code, settled, expected_funds_available_date, status, trigger, description, network_trace_id, failure_reason].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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/plaid/models/transfer_sweep.rb', line 203

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

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

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

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

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



352
353
354
 
# File 'lib/plaid/models/transfer_sweep.rb', line 352

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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/plaid/models/transfer_sweep.rb', line 358

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



346
347
348
 
# File 'lib/plaid/models/transfer_sweep.rb', line 346

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



230
231
232
233
234
235
236
237
 
# File 'lib/plaid/models/transfer_sweep.rb', line 230

def valid?
  return false if @id.nil?
  return false if @funding_account_id.nil?
  return false if @created.nil?
  return false if @amount.nil?
  return false if @iso_currency_code.nil?
  true
end