Class: Plaid::DepositSwitchGetResponse

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

Overview

DepositSwitchGetResponse defines the response schema for ‘/deposit_switch/get`

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DepositSwitchGetResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
230
231
232
233
234
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 158

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_has_multiple_allocations ⇒ Object

When ‘true`, user’s direct deposit goes to multiple banks. When false, user’s direct deposit only goes to the target account. Always `null` if the deposit switch has not been completed.



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

def 
  @account_has_multiple_allocations
end

#amount_allocated ⇒ Object

The dollar amount of direct deposit allocated to the target account. Always ‘null` if the target account is not allocated an amount or if the deposit switch has not been completed.



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

def amount_allocated
  @amount_allocated
end

#date_completed ⇒ Object

[ISO 8601](wikipedia.org/wiki/ISO_8601) date the deposit switch was completed. Always ‘null` if the deposit switch has not been completed.



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

def date_completed
  @date_completed
end

#date_created ⇒ Object

[ISO 8601](wikipedia.org/wiki/ISO_8601) date the deposit switch was created.



59
60
61
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 59

def date_created
  @date_created
end

#deposit_switch_id ⇒ Object

The ID of the deposit switch.



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

def deposit_switch_id
  @deposit_switch_id
end

#employer_id ⇒ Object

The ID of the employer selected by the user. If the user did not select an employer, the value returned is ‘null`.



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

def employer_id
  @employer_id
end

#employer_name ⇒ Object

The name of the employer selected by the user. If the user did not select an employer, the value returned is ‘null`.



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

def employer_name
  @employer_name
end

#institution_id ⇒ Object

The ID of the institution selected by the user. If the user did not select an institution, the value returned is ‘null`.



56
57
58
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 56

def institution_id
  @institution_id
end

#institution_name ⇒ Object

The name of the institution selected by the user. If the user did not select an institution, the value returned is ‘null`.



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

def institution_name
  @institution_name
end

#is_allocated_remainder ⇒ Object

When ‘true`, the target account is allocated the remainder of direct deposit after all other allocations have been deducted. When `false`, user’s direct deposit is allocated as a percent or amount. Always `null` if the deposit switch has not been completed.



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

def is_allocated_remainder
  @is_allocated_remainder
end

#percent_allocated ⇒ Object

The percentage of direct deposit allocated to the target account. Always ‘null` if the target account is not allocated a percentage or if the deposit switch has not been completed or if `is_allocated_remainder` is true.



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

def percent_allocated
  @percent_allocated
end

#request_id ⇒ Object

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.



65
66
67
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 65

def request_id
  @request_id
end

#state ⇒ Object

The state, or status, of the deposit switch. - ‘initialized` – The deposit switch has been initialized with the user entering the information required to submit the deposit switch request. - `processing` – The deposit switch request has been submitted and is being processed. - `completed` – The user’s employer has fulfilled the deposit switch request. - ‘error` – There was an error processing the deposit switch request.



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

def state
  @state
end

#switch_method ⇒ Object

The method used to make the deposit switch. - ‘instant` – User instantly switched their direct deposit to a new or existing bank account by connecting their payroll or employer account. - `mail` – User requested that Plaid contact their employer by mail to make the direct deposit switch. - `pdf` – User generated a PDF or email to be sent to their employer with the information necessary to make the deposit switch.’



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

def switch_method
  @switch_method
end

#target_account_id ⇒ Object

The ID of the bank account the direct deposit was switched to.



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

def 
  @target_account_id
end

#target_item_id ⇒ Object

The ID of the Item the direct deposit was switched to.



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

def target_item_id
  @target_item_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



112
113
114
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 112

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'deposit_switch_id' => :'deposit_switch_id',
    :'target_account_id' => :'target_account_id',
    :'target_item_id' => :'target_item_id',
    :'state' => :'state',
    :'switch_method' => :'switch_method',
    :'account_has_multiple_allocations' => :'account_has_multiple_allocations',
    :'is_allocated_remainder' => :'is_allocated_remainder',
    :'percent_allocated' => :'percent_allocated',
    :'amount_allocated' => :'amount_allocated',
    :'employer_name' => :'employer_name',
    :'employer_id' => :'employer_id',
    :'institution_name' => :'institution_name',
    :'institution_id' => :'institution_id',
    :'date_created' => :'date_created',
    :'date_completed' => :'date_completed',
    :'request_id' => :'request_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



331
332
333
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 331

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 139

def self.openapi_nullable
  Set.new([
    :'target_account_id',
    :'target_item_id',
    :'switch_method',
    :'account_has_multiple_allocations',
    :'is_allocated_remainder',
    :'percent_allocated',
    :'amount_allocated',
    :'employer_name',
    :'employer_id',
    :'institution_name',
    :'institution_id',
    :'date_completed',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'deposit_switch_id' => :'String',
    :'target_account_id' => :'String',
    :'target_item_id' => :'String',
    :'state' => :'String',
    :'switch_method' => :'String',
    :'account_has_multiple_allocations' => :'Boolean',
    :'is_allocated_remainder' => :'Boolean',
    :'percent_allocated' => :'Float',
    :'amount_allocated' => :'Float',
    :'employer_name' => :'String',
    :'employer_id' => :'String',
    :'institution_name' => :'String',
    :'institution_id' => :'String',
    :'date_created' => :'Date',
    :'date_completed' => :'Date',
    :'request_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      deposit_switch_id == o.deposit_switch_id &&
       == o. &&
      target_item_id == o.target_item_id &&
      state == o.state &&
      switch_method == o.switch_method &&
       == o. &&
      is_allocated_remainder == o.is_allocated_remainder &&
      percent_allocated == o.percent_allocated &&
      amount_allocated == o.amount_allocated &&
      employer_name == o.employer_name &&
      employer_id == o.employer_id &&
      institution_name == o.institution_name &&
      institution_id == o.institution_id &&
      date_created == o.date_created &&
      date_completed == o.date_completed &&
      request_id == o.request_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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 361

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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 432

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 338

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [deposit_switch_id, , target_item_id, state, switch_method, , is_allocated_remainder, percent_allocated, amount_allocated, employer_name, employer_id, institution_name, institution_id, date_created, date_completed, request_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



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

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

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

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

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



408
409
410
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 408

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 414

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



402
403
404
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 402

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



261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/plaid/models/deposit_switch_get_response.rb', line 261

def valid?
  return false if @deposit_switch_id.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["initialized", "processing", "completed", "error"])
  return false unless state_validator.valid?(@state)
  switch_method_validator = EnumAttributeValidator.new('String', ["instant", "mail", "pdf", "null"])
  return false unless switch_method_validator.valid?(@switch_method)
  return false if @date_created.nil?
  return false if @request_id.nil?
  true
end