Class: Plaid::PaymentInitiationConsentGetResponse

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

Overview

PaymentInitiationConsentGetResponse defines the response schema for ‘/payment_initation/consent/get`

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentInitiationConsentGetResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
155
156
157
158
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 112

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

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

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

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

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

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

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

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

Instance Attribute Details

The consent ID.



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

def consent_id
  @consent_id
end

#constraints ⇒ Object

Returns the value of attribute constraints.



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

def constraints
  @constraints
end

#created_at ⇒ Object

Consent creation timestamp, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format.



25
26
27
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 25

def created_at
  @created_at
end

#recipient_id ⇒ Object

The ID of the recipient the payment consent is for.



28
29
30
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 28

def recipient_id
  @recipient_id
end

#reference ⇒ Object

A reference for the payment consent.



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

def reference
  @reference
end

#request_id ⇒ Object

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.



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

def request_id
  @request_id
end

#scopes ⇒ Object

An array of payment consent scopes.



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

def scopes
  @scopes
end

#status ⇒ Object

Returns the value of attribute status.



22
23
24
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 22

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'consent_id' => :'consent_id',
    :'status' => :'status',
    :'created_at' => :'created_at',
    :'recipient_id' => :'recipient_id',
    :'reference' => :'reference',
    :'constraints' => :'constraints',
    :'scopes' => :'scopes',
    :'request_id' => :'request_id'
  }
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



285
286
287
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 285

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



103
104
105
106
107
108
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 103

def self.openapi_all_of
  [
  :'PaymentInitiationConsent',
  :'PaymentInitiationRecipientGetResponseAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



97
98
99
100
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'consent_id' => :'String',
    :'status' => :'PaymentInitiationConsentStatus',
    :'created_at' => :'Time',
    :'recipient_id' => :'String',
    :'reference' => :'String',
    :'constraints' => :'PaymentInitiationConsentConstraints',
    :'scopes' => :'Array<PaymentInitiationConsentScope>',
    :'request_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      consent_id == o.consent_id &&
      status == o.status &&
      created_at == o.created_at &&
      recipient_id == o.recipient_id &&
      reference == o.reference &&
      constraints == o.constraints &&
      scopes == o.scopes &&
      request_id == o.request_id
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



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
349
350
351
352
353
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 316

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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 387

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 292

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


272
273
274
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 278

def hash
  [consent_id, status, created_at, recipient_id, reference, constraints, scopes, request_id].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



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 162

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

  if @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


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

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

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

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


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

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

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

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



363
364
365
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 363

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 369

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



357
358
359
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 357

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



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/plaid/models/payment_initiation_consent_get_response.rb', line 211

def valid?
  return false if @consent_id.nil?
  return false if @consent_id.to_s.length < 1
  return false if @status.nil?
  return false if @created_at.nil?
  return false if @recipient_id.nil?
  return false if @recipient_id.to_s.length < 1
  return false if @reference.nil?
  return false if @constraints.nil?
  return false if @scopes.nil?
  return false if @request_id.nil?
  true
end