class Plaid::LinkTokenCreateRequestUpdate
Specifies options for initializing Link for [update mode](plaid.com/docs/link/update-mode).
Attributes
If ‘true`, enables [update mode with Account Select](plaid.com/docs/link/update-mode/#using-update-mode-to-request-new-accounts) for institutions in the US and Canada that do not use OAuth, or that use OAuth but do not have their own account selection flow. For institutions in the US that have an OAuth account selection flow (i.e. most OAuth-enabled institutions), update mode with Account Select will always be enabled, regardless of the value of this field.
An array of ‘item_id`s associated with the user to be updated in update mode. If empty or `null`, this field will default to initializing update mode for the most recent unhealthy Item
associated with the user. A `user_token` must also be provided to use this field.
If ‘true`, a `user_token` must also be provided, and Link will open in update mode for the given user.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/link_token_create_request_update.rb, line 42 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/link_token_create_request_update.rb, line 32 def self.attribute_map { :'account_selection_enabled' => :'account_selection_enabled', :'reauthorization_enabled' => :'reauthorization_enabled', :'user' => :'user', :'item_ids' => :'item_ids' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/link_token_create_request_update.rb, line 140 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/plaid/models/link_token_create_request_update.rb, line 65 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::LinkTokenCreateRequestUpdate` 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::LinkTokenCreateRequestUpdate`. 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?(:'account_selection_enabled') self.account_selection_enabled = attributes[:'account_selection_enabled'] else self.account_selection_enabled = false end if attributes.key?(:'reauthorization_enabled') self.reauthorization_enabled = attributes[:'reauthorization_enabled'] end if attributes.key?(:'user') self.user = attributes[:'user'] else self.user = false end if attributes.key?(:'item_ids') if (value = attributes[:'item_ids']).is_a?(Array) self.item_ids = value end end end
List of attributes with nullable: true
# File lib/plaid/models/link_token_create_request_update.rb, line 57 def self.openapi_nullable Set.new([ :'item_ids' ]) end
Attribute type mapping.
# File lib/plaid/models/link_token_create_request_update.rb, line 47 def self.openapi_types { :'account_selection_enabled' => :'Boolean', :'reauthorization_enabled' => :'Boolean', :'user' => :'Boolean', :'item_ids' => :'Array<String>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/link_token_create_request_update.rb, line 116 def ==(o) return true if self.equal?(o) self.class == o.class && account_selection_enabled == o.account_selection_enabled && reauthorization_enabled == o.reauthorization_enabled && user == o.user && item_ids == o.item_ids end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/plaid/models/link_token_create_request_update.rb, line 171 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
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
# File lib/plaid/models/link_token_create_request_update.rb, line 242 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/link_token_create_request_update.rb, line 147 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/plaid/models/link_token_create_request_update.rb, line 127 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/link_token_create_request_update.rb, line 133 def hash [account_selection_enabled, reauthorization_enabled, user, item_ids].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/plaid/models/link_token_create_request_update.rb, line 103 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/link_token_create_request_update.rb, line 224 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 string representation of the object @return [String] String presentation of the object
# File lib/plaid/models/link_token_create_request_update.rb, line 212 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/plaid/models/link_token_create_request_update.rb, line 110 def valid? true end