class

Plaid::ProductStatus

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

A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.

Constants

ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [HEALTHY, DEGRADED, DOWN]."
VALID_VALUES_FOR_STATUS = String.static_array("HEALTHY", "DEGRADED", "DOWN")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, status : String | Nil = nil, last_status_change : Time | Nil = nil, breakdown : ProductStatusBreakdown | 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

breakdown
Source
breakdown=(new_value : ProductStatusBreakdown | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] breakdown 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

last_status_change

ISO 8601 formatted timestamp of the last status change for the institution.

Source
last_status_change=(new_value : Time | Nil)

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

Source
list_invalid_properties

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

Source
status

This field is deprecated in favor of the breakdown object, which provides more granular institution health data. HEALTHY: the majority of requests are successful DEGRADED: only some requests are successful DOWN: all requests are failing

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status 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