class

Plaid::Cause

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

An error object and associated item_id used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, error_type : Plaid::PlaidErrorType | Nil = nil, error_code : String | Nil = nil, error_message : String | Nil = nil, display_message : String | Nil = nil, item_id : 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

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

causes

In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request, causes will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. causes will only be provided for the error_type ASSET_REPORT_ERROR. causes will also not be populated inside an error nested within a warning object.

Source
causes=(new_value : Array(Object) | Nil)

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

Source
display_message

A user-friendly representation of the error code. null if the error is not related to user action. This may change over time and is not safe for programmatic use.

Source
display_message=(new_value : String | Nil)

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

Source
documentation_url

The URL of a Plaid documentation page with more information about the error

Source
documentation_url=(new_value : String | Nil)

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

Source
error_code

The particular error code. Safe for programmatic use.

Source
error_code=(new_value : String | Nil)

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

Source
error_message

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.

Source
error_message=(new_value : String | Nil)

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

Source
error_type
Source
error_type=(new_value : Plaid::PlaidErrorType | Nil)

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

item_id

The item_id of the Item associated with this webhook, warning, or error

Source
item_id=(new_value : String | Nil)

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

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.

Source
request_id=(new_value : String | Nil)

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

Source
status

The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.

Source
status=(new_value : Int32 | Nil)

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

Source
status_present=(status_present : Bool)
Source
status_present?
Source
suggested_action

Suggested steps for resolving the error

Source
suggested_action=(new_value : String | Nil)

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

Source
suggested_action_present=(suggested_action_present : Bool)
Source
suggested_action_present?
Source
valid?

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

Source