class Plaid::OptionContract
Details about the option security. For the Sandbox environment, this data is currently only available if the Item
is using a [custom Sandbox user](plaid.com/docs/sandbox/user-custom/) and the ‘ticker` field of the custom security follows the [OCC Option Symbol](en.wikipedia.org/wiki/Option_symbol#The_OCC_Option_Symbol) standard with no spaces. For an example of simulating this in Sandbox, see the [custom Sandbox GitHub](github.com/plaid/sandbox-custom-users).
Attributes
The type of this option contract. It is one of: ‘put`: for Put option contracts `call`: for Call option contracts
The expiration date for this option contract, in [ISO 8601](wikipedia.org/wiki/ISO_8601) format.
The strike price for this option contract, per share of security.
The ticker of the underlying security for this option contract.
Public Class Methods
Source
# File lib/plaid/models/option_contract.rb, line 42 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/option_contract.rb, line 32 def self.attribute_map { :'contract_type' => :'contract_type', :'expiration_date' => :'expiration_date', :'strike_price' => :'strike_price', :'underlying_security_ticker' => :'underlying_security_ticker' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/option_contract.rb, line 153 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/option_contract.rb, line 64 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::OptionContract` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::OptionContract`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'contract_type') self.contract_type = attributes[:'contract_type'] end if attributes.key?(:'expiration_date') self.expiration_date = attributes[:'expiration_date'] end if attributes.key?(:'strike_price') self.strike_price = attributes[:'strike_price'] end if attributes.key?(:'underlying_security_ticker') self.underlying_security_ticker = attributes[:'underlying_security_ticker'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/option_contract.rb, line 57 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/option_contract.rb, line 47 def self.openapi_types { :'contract_type' => :'String', :'expiration_date' => :'Date', :'strike_price' => :'Float', :'underlying_security_ticker' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/option_contract.rb, line 129 def ==(o) return true if self.equal?(o) self.class == o.class && contract_type == o.contract_type && expiration_date == o.expiration_date && strike_price == o.strike_price && underlying_security_ticker == o.underlying_security_ticker end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/option_contract.rb, line 184 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/option_contract.rb, line 255 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/plaid/models/option_contract.rb, line 160 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/option_contract.rb, line 140 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/option_contract.rb, line 146 def hash [contract_type, expiration_date, strike_price, underlying_security_ticker].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/option_contract.rb, line 96 def list_invalid_properties invalid_properties = Array.new if @contract_type.nil? invalid_properties.push('invalid value for "contract_type", contract_type cannot be nil.') end if @expiration_date.nil? invalid_properties.push('invalid value for "expiration_date", expiration_date cannot be nil.') end if @strike_price.nil? invalid_properties.push('invalid value for "strike_price", strike_price cannot be nil.') end if @underlying_security_ticker.nil? invalid_properties.push('invalid value for "underlying_security_ticker", underlying_security_ticker cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/option_contract.rb, line 237 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/option_contract.rb, line 225 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/option_contract.rb, line 119 def valid? return false if @contract_type.nil? return false if @expiration_date.nil? return false if @strike_price.nil? return false if @underlying_security_ticker.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid