class Plaid::SessionTokenCreateRequest
SessionTokenCreateRequest
defines the request schema for ‘/session/token/create`
Attributes
The name of your app’s Android package. Required if using the session token to initialize Layer on Android. Any package name specified here must also be added to the Allowed Android package names setting on the [developer dashboard](dashboard.plaid.com/team/api). When creating a session token for initializing Layer on other platforms, ‘android_package_name` must be left blank and `redirect_uri` should be used instead.
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.
A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or another app. The ‘redirect_uri` should not contain any query parameters. When used in Production, must be an https URI. To specify any subdomain, use `*` as a wildcard character, e.g. `*.example.com/oauth.html`. Note that any redirect URI must also be added to the Allowed redirect URIs list in the [developer dashboard](dashboard.plaid.com/team/api). If initializing on Android, `android_package_name` must be specified instead and `redirect_uri` should be left blank.
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.
The id of a template defined in Plaid
Dashboard
The destination URL to which any webhooks should be sent. If you use the same webhook listener for all Sandbox or all Production activity, set this value in the Layer template editor in the Dashboard instead. Only provide a value in this field if you need to use multiple webhook URLs per environment (an uncommon use case). If provided, a value in this field will take priority over webhook values set in the Layer template editor.
Public Class Methods
Source
# File lib/plaid/models/session_token_create_request.rb, line 53 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/session_token_create_request.rb, line 40 def self.attribute_map { :'client_id' => :'client_id', :'secret' => :'secret', :'template_id' => :'template_id', :'user' => :'user', :'redirect_uri' => :'redirect_uri', :'android_package_name' => :'android_package_name', :'webhook' => :'webhook' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/session_token_create_request.rb, line 172 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/session_token_create_request.rb, line 78 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::SessionTokenCreateRequest` 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::SessionTokenCreateRequest`. 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?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.key?(:'secret') self.secret = attributes[:'secret'] end if attributes.key?(:'template_id') self.template_id = attributes[:'template_id'] end if attributes.key?(:'user') self.user = attributes[:'user'] end if attributes.key?(:'redirect_uri') self.redirect_uri = attributes[:'redirect_uri'] end if attributes.key?(:'android_package_name') self.android_package_name = attributes[:'android_package_name'] end if attributes.key?(:'webhook') self.webhook = attributes[:'webhook'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/session_token_create_request.rb, line 71 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/session_token_create_request.rb, line 58 def self.openapi_types { :'client_id' => :'String', :'secret' => :'String', :'template_id' => :'String', :'user' => :'SessionTokenCreateRequestUser', :'redirect_uri' => :'String', :'android_package_name' => :'String', :'webhook' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/session_token_create_request.rb, line 145 def ==(o) return true if self.equal?(o) self.class == o.class && client_id == o.client_id && secret == o.secret && template_id == o.template_id && user == o.user && redirect_uri == o.redirect_uri && android_package_name == o.android_package_name && webhook == o.webhook end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/session_token_create_request.rb, line 203 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/session_token_create_request.rb, line 274 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/session_token_create_request.rb, line 179 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/session_token_create_request.rb, line 159 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/session_token_create_request.rb, line 165 def hash [client_id, secret, template_id, user, redirect_uri, android_package_name, webhook].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/session_token_create_request.rb, line 122 def list_invalid_properties invalid_properties = Array.new if @template_id.nil? invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') end if @user.nil? invalid_properties.push('invalid value for "user", user 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/session_token_create_request.rb, line 256 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/session_token_create_request.rb, line 244 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/session_token_create_request.rb, line 137 def valid? return false if @template_id.nil? return false if @user.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid