Class: Plaid::TransferLedgerEventListRequest

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

Overview

Defines the request schema for ‘/transfer/ledger/event/list`

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferLedgerEventListRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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_ledger_event_list_request.rb', line 129

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

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

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

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

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

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

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

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

  if attributes.key?(:'count')
    self.count = attributes[:'count']
  else
    self.count = 25
  end

  if attributes.key?(:'offset')
    self.offset = attributes[:'offset']
  else
    self.offset = 0
  end
end

Instance Attribute Details

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

def client_id
  @client_id
end

#count ⇒ Object

The maximum number of transfer events to return. If the number of events matching the above parameters is greater than ‘count`, the most recent events will be returned.



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

def count
  @count
end

#end_date ⇒ Object

The end created datetime of transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)



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

def end_date
  @end_date
end

#ledger_event_id ⇒ Object

Plaid’s unique identifier for the ledger event.



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

def ledger_event_id
  @ledger_event_id
end

#ledger_id ⇒ Object

Plaid’s unique identifier for a Plaid Ledger Balance.



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

def ledger_id
  @ledger_id
end

#offset ⇒ Object

The offset into the list of transfer events. When ‘count`=25 and `offset`=0, the first 25 events will be returned. When `count`=25 and `offset`=25, the next 25 events will be returned.



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

def offset
  @offset
end

#originator_client_id ⇒ Object

Filter transfer events to only those with the specified originator client. (This field is specifically for resellers. Caller’s client ID will be used if this field is not specified.)



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

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.



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

def secret
  @secret
end

#source_id ⇒ Object

Plaid’s unique identifier for a transfer, sweep, or refund.



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

def source_id
  @source_id
end

#source_type ⇒ Object

Returns the value of attribute source_type.



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

def source_type
  @source_type
end

#start_date ⇒ Object

The start created datetime of transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)



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

def start_date
  @start_date
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 74

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'originator_client_id' => :'originator_client_id',
    :'secret' => :'secret',
    :'start_date' => :'start_date',
    :'end_date' => :'end_date',
    :'ledger_id' => :'ledger_id',
    :'ledger_event_id' => :'ledger_event_id',
    :'source_type' => :'source_type',
    :'source_id' => :'source_id',
    :'count' => :'count',
    :'offset' => :'offset'
  }
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



280
281
282
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 280

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 113

def self.openapi_nullable
  Set.new([
    :'originator_client_id',
    :'start_date',
    :'end_date',
    :'ledger_id',
    :'ledger_event_id',
    :'source_type',
    :'source_id',
    :'count',
    :'offset'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 96

def self.openapi_types
  {
    :'client_id' => :'String',
    :'originator_client_id' => :'String',
    :'secret' => :'String',
    :'start_date' => :'Time',
    :'end_date' => :'Time',
    :'ledger_id' => :'String',
    :'ledger_event_id' => :'String',
    :'source_type' => :'LedgerEventSourceType',
    :'source_id' => :'String',
    :'count' => :'Integer',
    :'offset' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      originator_client_id == o.originator_client_id &&
      secret == o.secret &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      ledger_id == o.ledger_id &&
      ledger_event_id == o.ledger_event_id &&
      source_type == o.source_type &&
      source_id == o.source_id &&
      count == o.count &&
      offset == o.offset
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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 311

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



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

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 287

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


267
268
269
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



273
274
275
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 273

def hash
  [client_id, originator_client_id, secret, start_date, end_date, ledger_id, ledger_event_id, source_type, source_id, count, offset].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
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 193

def list_invalid_properties
  invalid_properties = Array.new
  if !@count.nil? && @count > 25
    invalid_properties.push('invalid value for "count", must be smaller than or equal to 25.')
  end

  if !@count.nil? && @count < 1
    invalid_properties.push('invalid value for "count", must be greater than or equal to 1.')
  end


  if !@offset.nil? && @offset < 0
    invalid_properties.push('invalid value for "offset", must be greater than or equal to 0.')
  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



358
359
360
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 358

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 364

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



352
353
354
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 352

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



214
215
216
217
218
219
 
# File 'lib/plaid/models/transfer_ledger_event_list_request.rb', line 214

def valid?
  return false if !@count.nil? && @count > 25
  return false if !@count.nil? && @count < 1
  return false if !@offset.nil? && @offset < 0
  true
end