Class: Plaid::OAuthIntrospectResponse

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

Overview

OAuth token introspect response

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuthIntrospectResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



99
100
101
102
103
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 99

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Boolean indicator of whether or not the presented token is currently active. A ‘true` value indicates that the token has been issued, has not been revoked, and is within the time window of validity.



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

def active
  @active
end

#aud ⇒ Object

Audience of the token



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

def aud
  @aud
end

#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.



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

def client_id
  @client_id
end

#exp ⇒ Object

Expiration time as UNIX timestamp since January 1 1970 UTC



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

def exp
  @exp
end

#iat ⇒ Object

Issued at time as UNIX timestamp since January 1 1970 UTC



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

def iat
  @iat
end

#iss ⇒ Object

Issuer of the token



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

def iss
  @iss
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.



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

def request_id
  @request_id
end

#scope ⇒ Object

A JSON string containing a space-separated list of scopes associated with this token, in the format described in [datatracker.ietf.org/doc/html/rfc6749#section-3.3](https://datatracker.ietf.org/doc/html/rfc6749#section-3.3). Currently accepted values are: - ‘user:read` allows reading user data. - `user:write` allows writing user data. - `exchange` allows exchanging a token using the `urn:plaid:params:oauth:user-token` grant type. - `mcp:dashboard` allows access to the MCP dashboard server.



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

def scope
  @scope
end

#sub ⇒ Object

Subject of the token



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

def sub
  @sub
end

#token_type ⇒ Object

Type of the token



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

def token_type
  @token_type
end

#user_id ⇒ Object

User ID of the token



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

def user_id
  @user_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 53

def self.attribute_map
  {
    :'active' => :'active',
    :'scope' => :'scope',
    :'client_id' => :'client_id',
    :'exp' => :'exp',
    :'iat' => :'iat',
    :'sub' => :'sub',
    :'aud' => :'aud',
    :'iss' => :'iss',
    :'token_type' => :'token_type',
    :'user_id' => :'user_id',
    :'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



213
214
215
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 213

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 75

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'scope' => :'String',
    :'client_id' => :'String',
    :'exp' => :'Integer',
    :'iat' => :'Integer',
    :'sub' => :'String',
    :'aud' => :'String',
    :'iss' => :'String',
    :'token_type' => :'String',
    :'user_id' => :'String',
    :'request_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      scope == o.scope &&
      client_id == o.client_id &&
      exp == o.exp &&
      iat == o.iat &&
      sub == o.sub &&
      aud == o.aud &&
      iss == o.iss &&
      token_type == o.token_type &&
      user_id == o.user_id &&
      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



244
245
246
247
248
249
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
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 244

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 315

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 220

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


200
201
202
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [active, scope, client_id, exp, iat, sub, aud, iss, token_type, user_id, 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



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 159

def list_invalid_properties
  invalid_properties = Array.new
  if @active.nil?
    invalid_properties.push('invalid value for "active", active 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



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

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 297

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



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

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



174
175
176
177
178
 
# File 'lib/plaid/models/o_auth_introspect_response.rb', line 174

def valid?
  return false if @active.nil?
  return false if @request_id.nil?
  true
end