Class: Plaid::Application

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

Overview

Metadata about the application

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Application

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/plaid/models/application.rb', line 119

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#application_id ⇒ Object

This field will map to the application ID that is returned from /item/application/list, or provided to the institution in an oauth redirect.



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

def application_id
  @application_id
end

#application_url ⇒ Object

The URL for the application’s website



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

def application_url
  @application_url
end

#city ⇒ Object

A string representing the city of the client’s headquarters.



47
48
49
 
# File 'lib/plaid/models/application.rb', line 47

def city
  @city
end

#company_legal_name ⇒ Object

A string representing the name of client’s legal entity.



44
45
46
 
# File 'lib/plaid/models/application.rb', line 44

def company_legal_name
  @company_legal_name
end

#country_code ⇒ Object

A string representing the country code of the client’s headquarters.



56
57
58
 
# File 'lib/plaid/models/application.rb', line 56

def country_code
  @country_code
end

#display_name ⇒ Object

A human-readable name of the application for display purposes



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

def display_name
  @display_name
end

#join_date ⇒ Object

The date this application was granted production access at Plaid in [ISO 8601](wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format in UTC.



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

def join_date
  @join_date
end

#logo_url ⇒ Object

A URL that links to the application logo image.



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

def logo_url
  @logo_url
end

#name ⇒ Object

The name of the application



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

def name
  @name
end

#postal_code ⇒ Object

A string representing the postal code of the client’s headquarters.



53
54
55
 
# File 'lib/plaid/models/application.rb', line 53

def postal_code
  @postal_code
end

#reason_for_access ⇒ Object

A string provided by the connected app stating why they use their respective enabled products.



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

def reason_for_access
  @reason_for_access
end

#region ⇒ Object

A string representing the region of the client’s headquarters.



50
51
52
 
# File 'lib/plaid/models/application.rb', line 50

def region
  @region
end

#use_case ⇒ Object

A string representing client’s broad use case as assessed by Plaid.



41
42
43
 
# File 'lib/plaid/models/application.rb', line 41

def use_case
  @use_case
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/plaid/models/application.rb', line 59

def self.attribute_map
  {
    :'application_id' => :'application_id',
    :'name' => :'name',
    :'display_name' => :'display_name',
    :'join_date' => :'join_date',
    :'logo_url' => :'logo_url',
    :'application_url' => :'application_url',
    :'reason_for_access' => :'reason_for_access',
    :'use_case' => :'use_case',
    :'company_legal_name' => :'company_legal_name',
    :'city' => :'city',
    :'region' => :'region',
    :'postal_code' => :'postal_code',
    :'country_code' => :'country_code'
  }
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



248
249
250
 
# File 'lib/plaid/models/application.rb', line 248

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/plaid/models/application.rb', line 102

def self.openapi_nullable
  Set.new([
    :'display_name',
    :'logo_url',
    :'application_url',
    :'reason_for_access',
    :'use_case',
    :'company_legal_name',
    :'city',
    :'region',
    :'postal_code',
    :'country_code'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'application_id' => :'String',
    :'name' => :'String',
    :'display_name' => :'String',
    :'join_date' => :'Date',
    :'logo_url' => :'String',
    :'application_url' => :'String',
    :'reason_for_access' => :'String',
    :'use_case' => :'String',
    :'company_legal_name' => :'String',
    :'city' => :'String',
    :'region' => :'String',
    :'postal_code' => :'String',
    :'country_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/plaid/models/application.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      application_id == o.application_id &&
      name == o.name &&
      display_name == o.display_name &&
      join_date == o.join_date &&
      logo_url == o.logo_url &&
      application_url == o.application_url &&
      reason_for_access == o.reason_for_access &&
      use_case == o.use_case &&
      company_legal_name == o.company_legal_name &&
      city == o.city &&
      region == o.region &&
      postal_code == o.postal_code &&
      country_code == o.country_code
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/plaid/models/application.rb', line 279

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



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

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/plaid/models/application.rb', line 255

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


235
236
237
 
# File 'lib/plaid/models/application.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/plaid/models/application.rb', line 241

def hash
  [application_id, name, display_name, join_date, logo_url, application_url, reason_for_access, use_case, company_legal_name, city, region, postal_code, country_code].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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/plaid/models/application.rb', line 187

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

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

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



326
327
328
 
# File 'lib/plaid/models/application.rb', line 326

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/plaid/models/application.rb', line 332

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



320
321
322
 
# File 'lib/plaid/models/application.rb', line 320

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



206
207
208
209
210
211
 
# File 'lib/plaid/models/application.rb', line 206

def valid?
  return false if @application_id.nil?
  return false if @name.nil?
  return false if @join_date.nil?
  true
end