Class: Plaid::PaymentInitiationPaymentListRequest

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

Overview

PaymentInitiationPaymentListRequest defines the request schema for ‘/payment_initiation/payment/list`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentInitiationPaymentListRequest

Initializes the object



72
73
74
75
76
77
78
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
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 72

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

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

  if attributes.key?(:'consent_id')
    self.consent_id = attributes[:'consent_id']
  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/payment_initiation_payment_list_request.rb', line 20

def client_id
  @client_id
end

#consent_id ⇒ Object

The consent ID. If specified, only payments, executed using this consent, will be returned.



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

def consent_id
  @consent_id
end

#count ⇒ Object

The maximum number of payments to return. If ‘count` is not specified, a maximum of 10 payments will be returned, beginning with the most recent payment before the cursor (if specified).



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

def count
  @count
end

#cursor ⇒ Object

A string in RFC 3339 format (i.e. "2019-12-06T22:35:49Z"). Only payments created before the cursor will be returned.



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

def cursor
  @cursor
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/payment_initiation_payment_list_request.rb', line 23

def secret
  @secret
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 35

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'count' => :'count',
    :'cursor' => :'cursor',
    :'consent_id' => :'consent_id'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
66
67
68
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 62

def self.openapi_nullable
  Set.new([
    :'count',
    :'cursor',
    :'consent_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 51

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'count' => :'Integer',
    :'cursor' => :'Time',
    :'consent_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



166
167
168
169
170
171
172
173
174
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      count == o.count &&
      cursor == o.cursor &&
      consent_id == o.consent_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 221

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 292

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 198

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

See Also:

  • `==` method


178
179
180
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



184
185
186
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 184

def hash
  [client_id, secret, count, cursor, consent_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 110

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

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


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


  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



268
269
270
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 268

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 274

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



262
263
264
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 262

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



131
132
133
134
135
136
 
# File 'lib/plaid/models/payment_initiation_payment_list_request.rb', line 131

def valid?
  return false if !@count.nil? && @count > 200
  return false if !@count.nil? && @count < 1
  return false if !@consent_id.nil? && @consent_id.to_s.length < 1
  true
end