Class: Plaid::OAuthTokenRequest

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

Overview

OAuth token grant request.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuthTokenRequest

Initializes the object



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#audience ⇒ Object

Used when exchanging a token. The meaning depends on the ‘subject_token_type`.



37
38
39
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 37

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



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

def client_id
  @client_id
end

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



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

def client_secret
  @client_secret
end

#grant_type ⇒ Object

Returns the value of attribute grant_type.



19
20
21
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 19

def grant_type
  @grant_type
end

#refresh_token ⇒ Object

Refresh token for OAuth



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

def refresh_token
  @refresh_token
end

#resource ⇒ Object

URI of the target resource server



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

def resource
  @resource
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 ‘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.



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

def scope
  @scope
end

#subject_token ⇒ Object

Token representing the subject. The meaning depends on the ‘subject_token_type`.



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

def subject_token
  @subject_token
end

#subject_token_type ⇒ Object

Returns the value of attribute subject_token_type.



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

def subject_token_type
  @subject_token_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 82

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 67

def self.attribute_map
  {
    :'grant_type' => :'grant_type',
    :'client_id' => :'client_id',
    :'client_secret' => :'client_secret',
    :'scope' => :'scope',
    :'refresh_token' => :'refresh_token',
    :'resource' => :'resource',
    :'audience' => :'audience',
    :'subject_token' => :'subject_token',
    :'subject_token_type' => :'subject_token_type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



208
209
210
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 208

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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'grant_type' => :'OAuthGrantType',
    :'client_id' => :'String',
    :'client_secret' => :'String',
    :'scope' => :'String',
    :'refresh_token' => :'String',
    :'resource' => :'String',
    :'audience' => :'String',
    :'subject_token' => :'String',
    :'subject_token_type' => :'OAuthSubjectTokenType'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      grant_type == o.grant_type &&
      client_id == o.client_id &&
      client_secret == o.client_secret &&
      scope == o.scope &&
      refresh_token == o.refresh_token &&
      resource == o.resource &&
      audience == o.audience &&
      subject_token == o.subject_token &&
      subject_token_type == o.subject_token_type
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



239
240
241
242
243
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
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 239

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 310

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



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

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

See Also:

  • `==` method


195
196
197
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



201
202
203
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 201

def hash
  [grant_type, client_id, client_secret, scope, refresh_token, resource, audience, subject_token, subject_token_type].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



161
162
163
164
165
166
167
168
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 161

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



286
287
288
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 286

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 292

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



280
281
282
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 280

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



172
173
174
175
 
# File 'lib/plaid/models/o_auth_token_request.rb', line 172

def valid?
  return false if @grant_type.nil?
  true
end