Class: Plaid::GetRecipientResponse

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

Overview

GetRecipientResponse defines the response schema for ‘/fdx/recipient/recipientId`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetRecipientResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

Instance Attribute Details

#client_name ⇒ Object

The recipient name displayed by the Data Provider during the consent flow



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

def client_name
  @client_name
end

#logo_uri ⇒ Object

Data Recipient Logo URL location



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

def logo_uri
  @logo_uri
end

#recipient_id ⇒ Object

The recipient identifier



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

def recipient_id
  @recipient_id
end

#third_party_legal_name ⇒ Object

The legal name of the recipient



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

def third_party_legal_name
  @third_party_legal_name
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/plaid/models/get_recipient_response.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/plaid/models/get_recipient_response.rb', line 32

def self.attribute_map
  {
    :'recipient_id' => :'recipient_id',
    :'client_name' => :'client_name',
    :'logo_uri' => :'logo_uri',
    :'third_party_legal_name' => :'third_party_legal_name'
  }
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



219
220
221
 
# File 'lib/plaid/models/get_recipient_response.rb', line 219

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'FDXRecipientMetadata'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
60
61
 
# File 'lib/plaid/models/get_recipient_response.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
 
# File 'lib/plaid/models/get_recipient_response.rb', line 47

def self.openapi_types
  {
    :'recipient_id' => :'String',
    :'client_name' => :'String',
    :'logo_uri' => :'String',
    :'third_party_legal_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
 
# File 'lib/plaid/models/get_recipient_response.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      recipient_id == o.recipient_id &&
      client_name == o.client_name &&
      logo_uri == o.logo_uri &&
      third_party_legal_name == o.third_party_legal_name
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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/plaid/models/get_recipient_response.rb', line 250

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/plaid/models/get_recipient_response.rb', line 321

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/plaid/models/get_recipient_response.rb', line 226

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


206
207
208
 
# File 'lib/plaid/models/get_recipient_response.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/plaid/models/get_recipient_response.rb', line 212

def hash
  [recipient_id, client_name, logo_uri, third_party_legal_name].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



104
105
106
107
108
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
 
# File 'lib/plaid/models/get_recipient_response.rb', line 104

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 @recipient_id.to_s.length > 256
    invalid_properties.push('invalid value for "recipient_id", the character length must be smaller than or equal to 256.')
  end


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

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


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

  if @third_party_legal_name.to_s.length > 256
    invalid_properties.push('invalid value for "third_party_legal_name", the character length must be smaller than or equal to 256.')
  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



297
298
299
 
# File 'lib/plaid/models/get_recipient_response.rb', line 297

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/plaid/models/get_recipient_response.rb', line 303

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



291
292
293
 
# File 'lib/plaid/models/get_recipient_response.rb', line 291

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



138
139
140
141
142
143
144
145
146
 
# File 'lib/plaid/models/get_recipient_response.rb', line 138

def valid?
  return false if @recipient_id.nil?
  return false if @recipient_id.to_s.length > 256
  return false if @client_name.nil?
  return false if @client_name.to_s.length > 256
  return false if @third_party_legal_name.nil?
  return false if @third_party_legal_name.to_s.length > 256
  true
end