class

Plaid::InstitutionStatus

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

The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Balance requests, Identity requests, Investments requests, and Liabilities requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution's status, Plaid will return null rather than potentially inaccurate data. Institution status is accessible in the Dashboard and via the API using the /institutions/get_by_id endpoint with the include_status option set to true. Note that institution status is not available in the Sandbox environment.

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, item_logins : ProductStatus | Nil = nil, transactions_updates : ProductStatus | Nil = nil, auth : ProductStatus | Nil = nil, identity : ProductStatus | Nil = nil, investments_updates : ProductStatus | Nil = nil, liabilities_updates : ProductStatus | Nil = nil, liabilities : ProductStatus | Nil = nil, investments : ProductStatus | Nil = nil, health_incidents : Array(HealthIncident) | Nil = nil)

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

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

auth

auth=(new_value : ProductStatus | Nil)

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

auth_present=(auth_present : Bool)

auth_present?

hash(hasher)

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

health_incidents

Details of recent health incidents associated with the institution.

health_incidents=(new_value : Array(HealthIncident) | Nil)

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

health_incidents_present=(health_incidents_present : Bool)

health_incidents_present?

identity

identity=(new_value : ProductStatus | Nil)

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

identity_present=(identity_present : Bool)

identity_present?

investments

investments=(new_value : ProductStatus | Nil)

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

investments_present=(investments_present : Bool)

investments_present?

investments_updates

investments_updates=(new_value : ProductStatus | Nil)

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

investments_updates_present=(investments_updates_present : Bool)

investments_updates_present?

item_logins

item_logins=(new_value : ProductStatus | Nil)

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

item_logins_present=(item_logins_present : Bool)

item_logins_present?

liabilities

liabilities=(new_value : ProductStatus | Nil)

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

liabilities_present=(liabilities_present : Bool)

liabilities_present?

liabilities_updates

liabilities_updates=(new_value : ProductStatus | Nil)

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

liabilities_updates_present=(liabilities_updates_present : Bool)

liabilities_updates_present?

list_invalid_properties

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

transactions_updates

transactions_updates=(new_value : ProductStatus | Nil)

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

transactions_updates_present=(transactions_updates_present : Bool)

transactions_updates_present?

valid?

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