class

Plaid::ProductStatusBreakdown

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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.

Constants

ERROR_MESSAGE_FOR_REFRESH_INTERVAL = "invalid value for \"refresh_interval\", must be one of [NORMAL, DELAYED, STOPPED]."
VALID_VALUES_FOR_REFRESH_INTERVAL = String.static_array("NORMAL", "DELAYED", "STOPPED")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, success : Float64 | Nil = nil, error_plaid : Float64 | Nil = nil, error_institution : Float64 | Nil = nil, refresh_interval : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

error_institution

The percentage of logins that are failing due to an issue in the institution's system, expressed as a decimal.

Source
error_institution=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] error_institution Object to be assigned

Source
error_plaid

The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.

Source
error_plaid=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] error_plaid Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
refresh_interval

The refresh_interval may be DELAYED or STOPPED even when the success rate is high. This value is only returned for Transactions status breakdowns.

Source
refresh_interval=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] refresh_interval Object to be assigned

Source
success

The percentage of login attempts that are successful, expressed as a decimal.

Source
success=(new_value : Float64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] success Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source