class

Plaid::SecurityOverride

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

Specify the security associated with the holding or investment transaction. When inputting custom security data to the Sandbox, Plaid will perform post-data-retrieval normalization and enrichment. These processes may cause the data returned by the Sandbox to be slightly different from the data you input. An ISO-4217 currency code and a security identifier (ticker_symbol, cusip, isin, or sedol) are required.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, isin : String | Nil = nil, cusip : String | Nil = nil, sedol : String | Nil = nil, name : String | Nil = nil, ticker_symbol : String | Nil = nil, currency : 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

currency

Either a valid iso_currency_code or unofficial_currency_code

Source
currency=(new_value : String | Nil)

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

Source
cusip

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.

Source
cusip=(new_value : String | Nil)

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

isin

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.

Source
isin=(new_value : String | Nil)

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

A descriptive name for the security, suitable for display.

Source
name=(new_value : String | Nil)

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

Source
sedol

7-character SEDOL, an identifier assigned to securities in the UK.

Source
sedol=(new_value : String | Nil)

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

Source
ticker_symbol

The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available.

Source
ticker_symbol=(new_value : String | Nil)

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

Source
valid?

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

Source