class Plaid::PlaidError

• Plaid::PlaidError
• Reference
• Object

Overview

We use standard HTTP response codes for success and failure notifications, and our errors are further classified by #error_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

plaid/models/plaid_error.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(*, error_type : Plaid::PlaidErrorType | Nil = nil, error_code : String | Nil = nil, error_message : String | Nil = nil, display_message : String | Nil = nil, request_id : String | Nil = nil, causes : Array(Object) | Nil = nil, status : Int32 | Nil = nil, documentation_url : String | Nil = nil, suggested_action : String | Nil = nil)

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

Instance Method Summary

• #==(other : self)

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

• #causes : Array(Object) | Nil
• #causes=(new_value : Array(Object) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #display_message : String | Nil
• #display_message=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #documentation_url : String | Nil
• #documentation_url=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #error_code : String | Nil
• #error_code=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #error_message : String | Nil
• #error_message=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #error_type : Plaid::PlaidErrorType | Nil
• #error_type=(new_value : Plaid::PlaidErrorType | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #request_id : String | Nil
• #request_id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #status : Int32 | Nil
• #status=(new_value : Int32 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #status_present=(status_present : Bool)
• #status_present? : Bool
• #suggested_action : String | Nil
• #suggested_action=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #suggested_action_present=(suggested_action_present : Bool)
• #suggested_action_present? : Bool
• #valid? : Bool

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

Constructor Detail

Instance Method Detail