class Plaid::ProductStatusBreakdown
A detailed breakdown of the institution’s performance for a request type. The values for ‘success`, `error_plaid`, and `error_institution` sum to 1. The time range used for calculating the breakdown may range from the most recent few minutes to the past six hours. In general, smaller institutions will show status that was calculated over a longer period of time. For Investment updates, which are refreshed less frequently, the period assessed may be 24 hours or more. For more details, see [Institution status details](plaid.com/docs/account/activity/#institution-status-details).
Attributes
The percentage of logins that are failing due to an issue in the institution’s system, expressed as a decimal.
The percentage of logins that are failing due to an internal Plaid
issue, expressed as a decimal.
How frequently data for subscription products like Investments, Transactions, and Liabilities, is being refreshed, relative to the institution’s normal scheduling. The ‘refresh_interval` may be `DELAYED` or `STOPPED` even when the success rate is high.
The percentage of login attempts that are successful, expressed as a decimal.
Public Class Methods
Source
# File lib/plaid/models/product_status_breakdown.rb, line 64 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/product_status_breakdown.rb, line 54 def self.attribute_map { :'success' => :'success', :'error_plaid' => :'error_plaid', :'error_institution' => :'error_institution', :'refresh_interval' => :'refresh_interval' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/product_status_breakdown.rb, line 182 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/product_status_breakdown.rb, line 86 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::ProductStatusBreakdown` 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::ProductStatusBreakdown`. 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?(:'success') self.success = attributes[:'success'] end if attributes.key?(:'error_plaid') self.error_plaid = attributes[:'error_plaid'] end if attributes.key?(:'error_institution') self.error_institution = attributes[:'error_institution'] end if attributes.key?(:'refresh_interval') self.refresh_interval = attributes[:'refresh_interval'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/product_status_breakdown.rb, line 79 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/product_status_breakdown.rb, line 69 def self.openapi_types { :'success' => :'Float', :'error_plaid' => :'Float', :'error_institution' => :'Float', :'refresh_interval' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/product_status_breakdown.rb, line 158 def ==(o) return true if self.equal?(o) self.class == o.class && success == o.success && error_plaid == o.error_plaid && error_institution == o.error_institution && refresh_interval == o.refresh_interval end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/product_status_breakdown.rb, line 213 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/product_status_breakdown.rb, line 284 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/product_status_breakdown.rb, line 189 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/product_status_breakdown.rb, line 169 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/product_status_breakdown.rb, line 175 def hash [success, error_plaid, error_institution, refresh_interval].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/product_status_breakdown.rb, line 118 def list_invalid_properties invalid_properties = Array.new if @success.nil? invalid_properties.push('invalid value for "success", success cannot be nil.') end if @error_plaid.nil? invalid_properties.push('invalid value for "error_plaid", error_plaid cannot be nil.') end if @error_institution.nil? invalid_properties.push('invalid value for "error_institution", error_institution 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
# File lib/plaid/models/product_status_breakdown.rb, line 148 def refresh_interval=(refresh_interval) validator = EnumAttributeValidator.new('String', ["NORMAL", "DELAYED", "STOPPED"]) unless validator.valid?(refresh_interval) fail ArgumentError, "invalid value for \"refresh_interval\", must be one of #{validator.allowable_values}." end @refresh_interval = refresh_interval end
Custom attribute writer method checking allowed values (enum). @param [Object] refresh_interval
Object to be assigned
Source
Source
# File lib/plaid/models/product_status_breakdown.rb, line 266 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/product_status_breakdown.rb, line 254 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/product_status_breakdown.rb, line 137 def valid? return false if @success.nil? return false if @error_plaid.nil? return false if @error_institution.nil? refresh_interval_validator = EnumAttributeValidator.new('String', ["NORMAL", "DELAYED", "STOPPED"]) return false unless refresh_interval_validator.valid?(@refresh_interval) true end
Check to see if the all the properties in the model are valid @return true if the model is valid