Class: Plaid::RecurringTransfer

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

Overview

Represents a recurring transfer within the Transfers API.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecurringTransfer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/plaid/models/recurring_transfer.rb', line 147

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'transfer_ids')
    if (value = attributes[:'transfer_ids']).is_a?(Array)
      self.transfer_ids = value
    end
  end

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

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

Instance Attribute Details

#account_id ⇒ Object

The Plaid ‘account_id` corresponding to the end-user account that will be debited or credited.



46
47
48
 
# File 'lib/plaid/models/recurring_transfer.rb', line 46

def 
  @account_id
end

#ach_class ⇒ Object

Returns the value of attribute ach_class.



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

def ach_class
  @ach_class
end

#amount ⇒ Object

The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling ‘/transfer/authorization/create`, specify the maximum amount to authorize. When calling `/transfer/create`, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling `/transfer/create`, the maximum amount authorized in the `authorization_id` will be sent.



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

def amount
  @amount
end

#created ⇒ Object

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



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

def created
  @created
end

#description ⇒ Object

The description of the recurring transfer.



55
56
57
 
# File 'lib/plaid/models/recurring_transfer.rb', line 55

def description
  @description
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.



49
50
51
 
# File 'lib/plaid/models/recurring_transfer.rb', line 49

def 
  @funding_account_id
end

#iso_currency_code ⇒ Object

The currency of the transfer amount, e.g. "USD"



52
53
54
 
# File 'lib/plaid/models/recurring_transfer.rb', line 52

def iso_currency_code
  @iso_currency_code
end

#network ⇒ Object

Returns the value of attribute network.



40
41
42
 
# File 'lib/plaid/models/recurring_transfer.rb', line 40

def network
  @network
end

#next_origination_date ⇒ Object

A date in [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). The next transfer origination date after bank holiday adjustment.



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

def next_origination_date
  @next_origination_date
end

#origination_account_id ⇒ Object

Plaid’s unique identifier for the origination account that was used for this transfer.



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

def 
  @origination_account_id
end

#recurring_transfer_id ⇒ Object

Plaid’s unique identifier for a recurring transfer.



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

def recurring_transfer_id
  @recurring_transfer_id
end

#schedule ⇒ Object

Returns the value of attribute schedule.



62
63
64
 
# File 'lib/plaid/models/recurring_transfer.rb', line 62

def schedule
  @schedule
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#test_clock_id ⇒ Object

Plaid’s unique identifier for a test clock.



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

def test_clock_id
  @test_clock_id
end

#transfer_ids ⇒ Object

The created transfer instances associated with this ‘recurring_transfer_id`. If the recurring transfer has been newly created, this array will be empty.



58
59
60
 
# File 'lib/plaid/models/recurring_transfer.rb', line 58

def transfer_ids
  @transfer_ids
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#user ⇒ Object

Returns the value of attribute user.



60
61
62
 
# File 'lib/plaid/models/recurring_transfer.rb', line 60

def user
  @user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



110
111
112
 
# File 'lib/plaid/models/recurring_transfer.rb', line 110

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/plaid/models/recurring_transfer.rb', line 87

def self.attribute_map
  {
    :'recurring_transfer_id' => :'recurring_transfer_id',
    :'created' => :'created',
    :'next_origination_date' => :'next_origination_date',
    :'test_clock_id' => :'test_clock_id',
    :'type' => :'type',
    :'amount' => :'amount',
    :'status' => :'status',
    :'ach_class' => :'ach_class',
    :'network' => :'network',
    :'origination_account_id' => :'origination_account_id',
    :'account_id' => :'account_id',
    :'funding_account_id' => :'funding_account_id',
    :'iso_currency_code' => :'iso_currency_code',
    :'description' => :'description',
    :'transfer_ids' => :'transfer_ids',
    :'user' => :'user',
    :'schedule' => :'schedule'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



138
139
140
141
142
143
 
# File 'lib/plaid/models/recurring_transfer.rb', line 138

def self.openapi_nullable
  Set.new([
    :'next_origination_date',
    :'test_clock_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/plaid/models/recurring_transfer.rb', line 115

def self.openapi_types
  {
    :'recurring_transfer_id' => :'String',
    :'created' => :'Time',
    :'next_origination_date' => :'Date',
    :'test_clock_id' => :'String',
    :'type' => :'TransferType',
    :'amount' => :'String',
    :'status' => :'TransferRecurringStatus',
    :'ach_class' => :'ACHClass',
    :'network' => :'TransferRecurringNetwork',
    :'origination_account_id' => :'String',
    :'account_id' => :'String',
    :'funding_account_id' => :'String',
    :'iso_currency_code' => :'String',
    :'description' => :'String',
    :'transfer_ids' => :'Array<String>',
    :'user' => :'TransferUserInResponse',
    :'schedule' => :'TransferRecurringSchedule'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/plaid/models/recurring_transfer.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      recurring_transfer_id == o.recurring_transfer_id &&
      created == o.created &&
      next_origination_date == o.next_origination_date &&
      test_clock_id == o.test_clock_id &&
      type == o.type &&
      amount == o.amount &&
      status == o.status &&
      ach_class == o.ach_class &&
      network == o.network &&
       == o. &&
       == o. &&
       == o. &&
      iso_currency_code == o.iso_currency_code &&
      description == o.description &&
      transfer_ids == o.transfer_ids &&
      user == o.user &&
      schedule == o.schedule
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



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/plaid/models/recurring_transfer.rb', line 384

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



455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/plaid/models/recurring_transfer.rb', line 455

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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/plaid/models/recurring_transfer.rb', line 360

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


340
341
342
 
# File 'lib/plaid/models/recurring_transfer.rb', line 340

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [recurring_transfer_id, created, next_origination_date, test_clock_id, type, amount, status, ach_class, network, , , , iso_currency_code, description, transfer_ids, user, schedule].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



233
234
235
236
237
238
239
240
241
242
243
244
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
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/plaid/models/recurring_transfer.rb', line 233

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

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

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

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

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

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

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

  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_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 @iso_currency_code.nil?
    invalid_properties.push('invalid value for "iso_currency_code", iso_currency_code cannot be nil.')
  end

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

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

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

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



431
432
433
 
# File 'lib/plaid/models/recurring_transfer.rb', line 431

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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/plaid/models/recurring_transfer.rb', line 437

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



425
426
427
 
# File 'lib/plaid/models/recurring_transfer.rb', line 425

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/plaid/models/recurring_transfer.rb', line 296

def valid?
  return false if @recurring_transfer_id.nil?
  return false if @created.nil?
  return false if @type.nil?
  return false if @amount.nil?
  return false if @status.nil?
  return false if @network.nil?
  return false if @origination_account_id.nil?
  return false if @account_id.nil?
  return false if @funding_account_id.nil?
  return false if @iso_currency_code.nil?
  return false if @description.nil?
  return false if @transfer_ids.nil?
  return false if @user.nil?
  return false if @schedule.nil?
  true
end