class

Plaid::InstitutionsGetByIdRequestOptions

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

Specifies optional parameters for /institutions/get_by_id. If provided, must not be null.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, include_optional_metadata : Bool | Nil = false, include_status : Bool | Nil = false, include_auth_metadata : Bool | Nil = false, include_payment_initiation_metadata : Bool | Nil = false)

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

hash(hasher)

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

include_auth_metadata

When true, returns metadata related to the Auth product indicating which auth methods are supported.

Source
include_auth_metadata=(new_value : Bool | Nil)

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

Source
include_optional_metadata

When true, return an institution's logo, brand color, and URL. When available, the bank's logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is false. Note that Plaid does not own any of the logos shared by the API and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.

Source
include_optional_metadata=(new_value : Bool | Nil)

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

Source
include_payment_initiation_metadata

When true, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.

Source
include_payment_initiation_metadata=(new_value : Bool | Nil)

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

Source
include_status

If true, the response will include status information about the institution. Default value is false.

Source
include_status=(new_value : Bool | Nil)

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

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

Source