Class: Plaid::PaymentInitiationConsentCreateRequest

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

Overview

PaymentInitiationConsentCreateRequest defines the request schema for ‘/payment_initiation/consent/create`

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentInitiationConsentCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

def client_id
  @client_id
end

#constraints ⇒ Object

Returns the value of attribute constraints.



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

def constraints
  @constraints
end

#options ⇒ Object

Returns the value of attribute options.



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

def options
  @options
end

#payer_details ⇒ Object

Returns the value of attribute payer_details.



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

def payer_details
  @payer_details
end

#recipient_id ⇒ Object

The ID of the recipient the payment consent is for. The created consent can be used to transfer funds to this recipient only.



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

def recipient_id
  @recipient_id
end

#reference ⇒ Object

A reference for the payment consent. This must be an alphanumeric string with at most 18 characters and must not contain any special characters.



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

def reference
  @reference
end

#scopes ⇒ Object

An array of payment consent scopes.



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

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

def secret
  @secret
end

#type ⇒ Object

Returns the value of attribute type.



34
35
36
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 34

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 80

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
77
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 65

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'recipient_id' => :'recipient_id',
    :'reference' => :'reference',
    :'scopes' => :'scopes',
    :'type' => :'type',
    :'constraints' => :'constraints',
    :'options' => :'options',
    :'payer_details' => :'payer_details'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
104
105
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 100

def self.openapi_nullable
  Set.new([
    :'options',
    :'payer_details'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'recipient_id' => :'String',
    :'reference' => :'String',
    :'scopes' => :'Array<PaymentInitiationConsentScope>',
    :'type' => :'PaymentInitiationConsentType',
    :'constraints' => :'PaymentInitiationConsentConstraints',
    :'options' => :'ExternalPaymentInitiationConsentOptions',
    :'payer_details' => :'PaymentInitiationConsentPayerDetails'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      recipient_id == o.recipient_id &&
      reference == o.reference &&
      scopes == o.scopes &&
      type == o.type &&
      constraints == o.constraints &&
      options == o.options &&
      payer_details == o.payer_details
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



298
299
300
301
302
303
304
305
306
307
308
309
310
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
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 298

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



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

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 274

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


254
255
256
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 260

def hash
  [client_id, secret, recipient_id, reference, scopes, type, constraints, options, payer_details].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



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

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

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

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

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



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

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



345
346
347
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 345

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



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

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



339
340
341
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 339

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



196
197
198
199
200
201
202
203
204
 
# File 'lib/plaid/models/payment_initiation_consent_create_request.rb', line 196

def valid?
  return false if @recipient_id.nil?
  return false if @reference.nil?
  return false if @reference.to_s.length > 18
  return false if @reference.to_s.length < 1
  return false if !@scopes.nil? && @scopes.length < 1
  return false if @constraints.nil?
  true
end