Class: Plaid::TransferLedgerWithdrawRequest

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

Overview

Defines the request schema for ‘/transfer/ledger/withdraw`

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferLedgerWithdrawRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
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
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 108

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

A positive amount of how much will be withdrawn from the ledger balance (decimal string with two digits of precision e.g. "5.50").



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

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_ledger_withdraw_request.rb', line 20

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



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

def description
  @description
end

#funding_account_id ⇒ Object

Specify which funding account linked to this Plaid Ledger to use. Customers can find a list of ‘funding_account_id`s in the Accounts page of your Plaid Dashboard, under the "Account ID" column. If this field is left blank, this will default to the default `funding_account_id` specified during onboarding. If an `originator_client_id` is specified, the `funding_account_id` must belong to the specified originator, and if `funding_account_id` is left blank, the originator’s default ‘funding_account_id` will be used.



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

def 
  @funding_account_id
end

#idempotency_key ⇒ Object

A unique key provided by the client, per unique ledger withdraw. Maximum of 50 characters. The API supports idempotency for safely retrying the request without accidentally performing the same operation twice. For example, if a request to create a ledger withdraw fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single withdraw is created.



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

def idempotency_key
  @idempotency_key
end

#network ⇒ Object

Returns the value of attribute network.



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

def network
  @network
end

#originator_client_id ⇒ Object

Client ID of the customer that owns the Ledger balance. This is so Plaid knows which of your customers to payout or collect funds. Only applicable for [Platform customers](plaid.com/docs/transfer/application/#originators-vs-platforms). Do not include if you’re paying out to yourself.



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

def originator_client_id
  @originator_client_id
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_ledger_withdraw_request.rb', line 23

def secret
  @secret
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 65

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'originator_client_id' => :'originator_client_id',
    :'funding_account_id' => :'funding_account_id',
    :'amount' => :'amount',
    :'description' => :'description',
    :'idempotency_key' => :'idempotency_key',
    :'network' => :'network'
  }
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



250
251
252
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 250

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
102
103
104
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 98

def self.openapi_nullable
  Set.new([
    :'originator_client_id',
    :'funding_account_id',
    :'description',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 84

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'originator_client_id' => :'String',
    :'funding_account_id' => :'String',
    :'amount' => :'String',
    :'description' => :'String',
    :'idempotency_key' => :'String',
    :'network' => :'TransferNetwork'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      originator_client_id == o.originator_client_id &&
       == o. &&
      amount == o.amount &&
      description == o.description &&
      idempotency_key == o.idempotency_key &&
      network == o.network
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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 281

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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 352

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 257

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


237
238
239
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 237

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



243
244
245
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 243

def hash
  [client_id, secret, originator_client_id, , amount, description, idempotency_key, network].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



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

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

  if !@description.nil? && @description.to_s.length > 10
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 10.')
  end


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

  if @idempotency_key.to_s.length > 50
    invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 50.')
  end


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



328
329
330
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 328

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 334

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



322
323
324
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 322

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



185
186
187
188
189
190
191
192
 
# File 'lib/plaid/models/transfer_ledger_withdraw_request.rb', line 185

def valid?
  return false if @amount.nil?
  return false if !@description.nil? && @description.to_s.length > 10
  return false if @idempotency_key.nil?
  return false if @idempotency_key.to_s.length > 50
  return false if @network.nil?
  true
end