Class: Plaid::TransferLedgerDistributeRequest

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferLedgerDistributeRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 79

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The amount to move (decimal string with two digits of precision e.g. "10.00"). Amount must be positive.



32
33
34
 
# File 'lib/plaid/models/transfer_ledger_distribute_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_distribute_request.rb', line 20

def client_id
  @client_id
end

#description ⇒ Object

An optional description for the ledger distribute operation.



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

def description
  @description
end

#from_ledger_id ⇒ Object

The Ledger to pull money from.



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

def from_ledger_id
  @from_ledger_id
end

#idempotency_key ⇒ Object

A unique key provided by the client, per unique ledger distribute. 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 distribute fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single distribute is created.



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

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

def secret
  @secret
end

#to_ledger_id ⇒ Object

The Ledger to credit money to.



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

def to_ledger_id
  @to_ledger_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 54

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 41

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



204
205
206
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 204

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 72

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 59

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'from_ledger_id' => :'String',
    :'to_ledger_id' => :'String',
    :'amount' => :'String',
    :'idempotency_key' => :'String',
    :'description' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 177

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



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

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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 306

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 211

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


191
192
193
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



197
198
199
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 197

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



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

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

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

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


  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



282
283
284
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 282

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 288

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



276
277
278
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 276

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



151
152
153
154
155
156
157
158
 
# File 'lib/plaid/models/transfer_ledger_distribute_request.rb', line 151

def valid?
  return false if @from_ledger_id.nil?
  return false if @to_ledger_id.nil?
  return false if @amount.nil?
  return false if @idempotency_key.nil?
  return false if @idempotency_key.to_s.length > 50
  true
end