Class: Plaid::TransferIntentCreateRequest

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

Overview

Defines the request schema for ‘/transfer/intent/create`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferIntentCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 115

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

  if attributes.key?(:'secret')
    self.secret = attributes[:'secret']
  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?(:'mode')
    self.mode = attributes[:'mode']
  end

  if attributes.key?(:'network')
    self.network = attributes[:'network']
  else
    self.network = 'same-day-ach'
  end

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

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

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

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

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

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

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

  if attributes.key?(:'require_guarantee')
    self.require_guarantee = attributes[:'require_guarantee']
  else
    self.require_guarantee = false
  end
end

Instance Attribute Details

#account_id ⇒ Object

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



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

def 
  @account_id
end

#ach_class ⇒ Object

Returns the value of attribute ach_class.



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

def ach_class
  @ach_class
end

#amount ⇒ Object

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



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

def amount
  @amount
end

#client_id ⇒ Object

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.



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

def client_id
  @client_id
end

#description ⇒ Object

A description for the underlying transfer. Maximum of 8 characters.



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

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. Defaults to the account configured during onboarding.



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

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/transfer_intent_create_request.rb', line 52

def iso_currency_code
  @iso_currency_code
end

#metadata ⇒ Object

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nested JSON objects allowed) Only ASCII characters may be used Maximum of 50 key/value pairs Maximum key length of 40 characters Maximum value length of 500 characters



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

def metadata
  @metadata
end

#mode ⇒ Object

Returns the value of attribute mode.



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

def mode
  @mode
end

#network ⇒ Object

Returns the value of attribute network.



33
34
35
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 33

def network
  @network
end

#origination_account_id ⇒ Object

Plaid’s unique identifier for the origination account for the intent. If not provided, the default account will be used.



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

def 
  @origination_account_id
end

#require_guarantee ⇒ Object

When ‘true`, the transfer requires a `GUARANTEED` decision by Plaid to proceed (Guarantee customers only).



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

def require_guarantee
  @require_guarantee
end

#secret ⇒ Object

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.



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

def secret
  @secret
end

#user ⇒ Object

Returns the value of attribute user.



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

def user
  @user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 58

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'account_id' => :'account_id',
    :'funding_account_id' => :'funding_account_id',
    :'mode' => :'mode',
    :'network' => :'network',
    :'amount' => :'amount',
    :'description' => :'description',
    :'ach_class' => :'ach_class',
    :'origination_account_id' => :'origination_account_id',
    :'user' => :'user',
    :'metadata' => :'metadata',
    :'iso_currency_code' => :'iso_currency_code',
    :'require_guarantee' => :'require_guarantee'
  }
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



299
300
301
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 299

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
107
108
109
110
111
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 103

def self.openapi_nullable
  Set.new([
    :'account_id',
    :'funding_account_id',
    :'origination_account_id',
    :'metadata',
    :'require_guarantee'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 83

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'account_id' => :'String',
    :'funding_account_id' => :'String',
    :'mode' => :'TransferIntentCreateMode',
    :'network' => :'TransferIntentCreateNetwork',
    :'amount' => :'String',
    :'description' => :'String',
    :'ach_class' => :'ACHClass',
    :'origination_account_id' => :'String',
    :'user' => :'TransferUserInRequest',
    :'metadata' => :'Hash<String, String>',
    :'iso_currency_code' => :'String',
    :'require_guarantee' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
       == o. &&
       == o. &&
      mode == o.mode &&
      network == o.network &&
      amount == o.amount &&
      description == o.description &&
      ach_class == o.ach_class &&
       == o. &&
      user == o.user &&
      metadata == o.metadata &&
      iso_currency_code == o.iso_currency_code &&
      require_guarantee == o.require_guarantee
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 329

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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 400

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 306

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


286
287
288
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



292
293
294
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 292

def hash
  [client_id, secret, , , mode, network, amount, description, ach_class, , user, metadata, iso_currency_code, require_guarantee].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



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
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 193

def list_invalid_properties
  invalid_properties = Array.new
  if @mode.nil?
    invalid_properties.push('invalid value for "mode", mode 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 @description.to_s.length > 8
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 8.')
  end

  if @description.to_s.length < 1
    invalid_properties.push('invalid value for "description", the character length must be great than or equal to 1.')
  end


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



376
377
378
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 376

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



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

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



370
371
372
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 370

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



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/plaid/models/transfer_intent_create_request.rb', line 226

def valid?
  return false if @mode.nil?
  return false if @amount.nil?
  return false if @description.nil?
  return false if @description.to_s.length > 8
  return false if @description.to_s.length < 1
  return false if @user.nil?
  return false if !@metadata.nil? && @metadata.length > 50
  true
end