class Plaid::ProductStatusBreakdown

Overview

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.

Included Modules

Defined in:

plaid/models/product_status_breakdown.cr

Constant Summary

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def error_institution : Float64 | Nil #

[View source]
def error_institution=(new_value : Float64 | Nil) #

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


[View source]
def error_plaid : Float64 | Nil #

[View source]
def error_plaid=(new_value : Float64 | Nil) #

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


[View source]
def hash(hasher) #

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


def list_invalid_properties : Array(String) #

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


[View source]
def refresh_interval : String | Nil #

[View source]
def refresh_interval=(new_value : String | Nil) #

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


[View source]
def success : Float64 | Nil #

[View source]
def success=(new_value : Float64 | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]