class Plaid::OAuthTokenRequest
OAuth token grant request.
Attributes
Used when exchanging a token. The meaning depends on the ‘subject_token_type`.
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.
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 as either `secret` or `client_secret`.
Refresh token for OAuth
URI of the target resource server
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.
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 as either `secret` or `client_secret`.
Token representing the subject. The ‘subject token` must be an OAuth refresh token issued from the `/oauth/token` endpoint. The meaning depends on the `subject_token_type`.
Public Class Methods
Source
# File lib/plaid/models/o_auth_token_request.rb, line 86 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/o_auth_token_request.rb, line 70 def self.attribute_map { :'grant_type' => :'grant_type', :'client_id' => :'client_id', :'client_secret' => :'client_secret', :'secret' => :'secret', :'scope' => :'scope', :'refresh_token' => :'refresh_token', :'resource' => :'resource', :'audience' => :'audience', :'subject_token' => :'subject_token', :'subject_token_type' => :'subject_token_type' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/o_auth_token_request.rb, line 218 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/o_auth_token_request.rb, line 114 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?(:'secret') self.secret = attributes[:'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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/o_auth_token_request.rb, line 107 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/o_auth_token_request.rb, line 91 def self.openapi_types { :'grant_type' => :'OAuthGrantType', :'client_id' => :'String', :'client_secret' => :'String', :'secret' => :'String', :'scope' => :'String', :'refresh_token' => :'String', :'resource' => :'String', :'audience' => :'String', :'subject_token' => :'String', :'subject_token_type' => :'OAuthSubjectTokenType' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/o_auth_token_request.rb, line 188 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 && secret == o.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
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/o_auth_token_request.rb, line 249 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/o_auth_token_request.rb, line 320 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/plaid/models/o_auth_token_request.rb, line 225 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/o_auth_token_request.rb, line 205 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/o_auth_token_request.rb, line 211 def hash [grant_type, client_id, client_secret, secret, scope, refresh_token, resource, audience, subject_token, subject_token_type].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/o_auth_token_request.rb, line 170 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/o_auth_token_request.rb, line 302 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/o_auth_token_request.rb, line 290 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/o_auth_token_request.rb, line 181 def valid? return false if @grant_type.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid