class Plaid::UserCustomPassword
Custom test accounts are configured with a JSON configuration object formulated according to the schema below. All top level fields are optional. Sending an empty object as a configuration will result in an account configured with random balances and transaction history.
Attributes
An error code to force on Item
creation. Possible values are: ‘"INSTITUTION_NOT_RESPONDING"` `"INSTITUTION_NO_LONGER_SUPPORTED"` `"INVALID_CREDENTIALS"` `"INVALID_MFA"` `"ITEM_LOCKED"` `"ITEM_LOGIN_REQUIRED"` `"ITEM_NOT_SUPPORTED"` `"INVALID_LINK_TOKEN"` `"MFA_NOT_SUPPORTED"` `"NO_ACCOUNTS"` `"PLAID_ERROR"` `"USER_INPUT_TIMEOUT"` `"USER_SETUP_REQUIRED"`
An array of account overrides to configure the accounts for the Item
. By default, if no override is specified, transactions and account data will be randomly generated based on the account type and subtype, and other products will have fixed or empty data.
You may trigger a reCAPTCHA in Plaid
Link in the Sandbox environment by using the recaptcha field. Possible values are ‘good` or `bad`. A value of `good` will result in successful Item
creation and `bad` will result in a `RECAPTCHA_BAD` error to simulate a failed reCAPTCHA. Both values require the reCAPTCHA to be manually solved within Plaid
Link.
A seed, in the form of a string, that will be used to randomly generate account and transaction data, if this data is not specified using the ‘override_accounts` argument. If no seed is specified, the randomly generated data will be different each time. Note that transactions data is generated relative to the Item’s creation date. Different Items created on different dates with the same seed for transactions data will have different dates for the transactions. The number of days between each transaction and the Item
creation will remain constant. For example, an Item
created on December 15 might show a transaction on December 14. An Item
created on December 20, using the same seed, would show that same transaction occurring on December 19.
The version of the password schema to use, possible values are 1 or 2. The default value is 2. You should only specify 1 if you know it is necessary for your test suite.
Public Class Methods
Source
# File lib/plaid/models/user_custom_password.rb, line 49 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/user_custom_password.rb, line 37 def self.attribute_map { :'version' => :'version', :'seed' => :'seed', :'override_accounts' => :'override_accounts', :'mfa' => :'mfa', :'recaptcha' => :'recaptcha', :'force_error' => :'force_error' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/user_custom_password.rb, line 180 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/user_custom_password.rb, line 74 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::UserCustomPassword` 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::UserCustomPassword`. 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?(:'version') self.version = attributes[:'version'] end if attributes.key?(:'seed') self.seed = attributes[:'seed'] end if attributes.key?(:'override_accounts') if (value = attributes[:'override_accounts']).is_a?(Array) self.override_accounts = value end end if attributes.key?(:'mfa') self.mfa = attributes[:'mfa'] end if attributes.key?(:'recaptcha') self.recaptcha = attributes[:'recaptcha'] end if attributes.key?(:'force_error') self.force_error = attributes[:'force_error'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/user_custom_password.rb, line 66 def self.openapi_nullable Set.new([ :'version', ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/user_custom_password.rb, line 54 def self.openapi_types { :'version' => :'String', :'seed' => :'String', :'override_accounts' => :'Array<OverrideAccounts>', :'mfa' => :'MFA', :'recaptcha' => :'String', :'force_error' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/user_custom_password.rb, line 154 def ==(o) return true if self.equal?(o) self.class == o.class && version == o.version && seed == o.seed && override_accounts == o.override_accounts && mfa == o.mfa && recaptcha == o.recaptcha && force_error == o.force_error end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/user_custom_password.rb, line 211 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/user_custom_password.rb, line 282 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/user_custom_password.rb, line 187 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/user_custom_password.rb, line 167 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/user_custom_password.rb, line 173 def hash [version, seed, override_accounts, mfa, recaptcha, force_error].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/user_custom_password.rb, line 116 def list_invalid_properties invalid_properties = Array.new if @seed.nil? invalid_properties.push('invalid value for "seed", seed cannot be nil.') end if @override_accounts.nil? invalid_properties.push('invalid value for "override_accounts", override_accounts cannot be nil.') end if @mfa.nil? invalid_properties.push('invalid value for "mfa", mfa cannot be nil.') end if @recaptcha.nil? invalid_properties.push('invalid value for "recaptcha", recaptcha cannot be nil.') end if @force_error.nil? invalid_properties.push('invalid value for "force_error", force_error 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/user_custom_password.rb, line 264 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/user_custom_password.rb, line 252 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/user_custom_password.rb, line 143 def valid? return false if @seed.nil? return false if @override_accounts.nil? return false if @mfa.nil? return false if @recaptcha.nil? return false if @force_error.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid