Plaid::Security
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
Contains details about a security
Constructors
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance methods
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
The security type of the holding. Valid security types are: cash: Cash, currency, and money market funds cryptocurrency: Digital or virtual currencies derivative: Options, warrants, and other derivative instruments equity: Domestic and foreign equities etf: Multi-asset exchange-traded investment funds fixed income: Bonds and certificates of deposit (CDs) loan: Loans and loan receivables mutual fund: Open- and closed-end vehicles pooling funds of multiple investors other: Unknown or other investment types
Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned
Price of the security at the close of the previous trading session. Null for non-public securities. If the security is a foreign currency this field will be updated daily and will be priced in USD. If the security is a cryptocurrency, this field will be updated multiple times a day. As crypto prices can fluctuate quickly and data may become stale sooner than other asset classes, refer to update_datetime with the time when the price was last updated.
Custom attribute writer method checking allowed values (enum). @param [Object] close_price Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] close_price_as_of Object to be assigned
9-character CUSIP, an identifier assigned to North American securities. A verified CUSIP Global Services license is required to receive this data. This field will be null by default for new customers, and null for existing customers starting March 12, 2024. If you would like access to this field, please start the verification process here.
Custom attribute writer method checking allowed values (enum). @param [Object] cusip Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
If institution_security_id is present, this field indicates the Plaid institution_id of the institution to whom the identifier belongs.
Custom attribute writer method checking allowed values (enum). @param [Object] institution_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] institution_security_id Object to be assigned
Indicates that a security is a highly liquid asset and can be treated like cash.
Custom attribute writer method checking allowed values (enum). @param [Object] is_cash_equivalent Object to be assigned
12-character ISIN, a globally unique securities identifier. A verified CUSIP Global Services license is required to receive this data. This field will be null by default for new customers, and null for existing customers starting March 12, 2024. If you would like access to this field, please start the verification process here.
Custom attribute writer method checking allowed values (enum). @param [Object] isin Object to be assigned
The ISO-4217 currency code of the price given. Always null if unofficial_currency_code is non-null.
Custom attribute writer method checking allowed values (enum). @param [Object] iso_currency_code Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] name Object to be assigned
In certain cases, Plaid will provide the ID of another security whose performance resembles this security, typically when the original security has low volume, or when a private security can be modeled with a publicly traded security.
Custom attribute writer method checking allowed values (enum). @param [Object] proxy_security_id Object to be assigned
A unique, Plaid-specific identifier for the security, used to associate securities with holdings. Like all Plaid identifiers, the security_id is case sensitive. The security_id may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change.
Custom attribute writer method checking allowed values (enum). @param [Object] security_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] sedol Object to be assigned
The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available.
Custom attribute writer method checking allowed values (enum). @param [Object] ticker_symbol Object to be assigned
The unofficial currency code associated with the security. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the currency code schema for a full listing of supported iso_currency_codes.
Custom attribute writer method checking allowed values (enum). @param [Object] unofficial_currency_code Object to be assigned
Date and time at which close_price is accurate, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). Always null if close_price is null.
Custom attribute writer method checking allowed values (enum). @param [Object] update_datetime Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid