class Plaid::ProductStatus

Overview

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.

Included Modules

Defined in:

plaid/models/product_status.cr

Constant Summary

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

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(*, 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


[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 breakdown : ProductStatusBreakdown | Nil #

[View source]
def breakdown=(new_value : ProductStatusBreakdown | Nil) #

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

[View source]
def last_status_change=(new_value : Time | Nil) #

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


[View source]
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 status : String | Nil #

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

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