snaptrade 2.0.23 → 2.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78be9220e71d2500da395e0c580190dc48202e134fb2340ba1ff69f4b38fc774
-  data.tar.gz: ccbbd494512272fecb0c894f72c4a0b4101a15172f4fb10919167c5ee169055d
+  metadata.gz: 1972714969f69805cc22e43f640774a439dfa47616884f4b499e954629a2e794
+  data.tar.gz: 2a1c839688235913f4a11ae234c4a0f1cb8f67dfebdc45871dc965fbb7644d58
 SHA512:
-  metadata.gz: a797f328841f7fa481c1a05c562a63d27f443738aa74a685bb4a6c64f7c3a6fa495abadc2b501dae54cd3d98a21fa788d36cabaebdde8f8344779797d095fb63
-  data.tar.gz: 06e0e87b861f77e1e2419258a9b22eb8c4847dd7d2a7e40033e4924eda42a8cd75abe09d6398fea05300f71233a578e73c9058d67874086393d1528948ded437
+  metadata.gz: 3ea0918d1207fd6addc2b0591cc3e969104b882ef029533ca540a8c955f6f60d382125d5e114c21583b079dfa0af8802878a5196b5c71110e820c5c55361d3c7
+  data.tar.gz: c160f91c727da185a9c78b6bb1eaf639c601184c0f72fa9d3ab68f7fb015d0a714be98a98f4d0a8e8da4f5f1804aaa7fbbb276461eb9ca9a64bfb16cf64497ea

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (2.0.22)
+    snaptrade (2.0.24)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/gem-v2.0.23-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.23)
+[![npm](https://img.shields.io/badge/gem-v2.0.24-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.24)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -70,7 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 2.0.23'
+gem 'snaptrade', '~> 2.0.24'
 ```
 
 ## Getting Started<a id="getting-started"></a>

data/lib/snaptrade/models/amount.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Total Value of the account
+  # Total value of the account, as reported by the brokerage
   class Amount
     attr_accessor :amount
 

data/lib/snaptrade/models/option_brokerage_symbol.rb

@@ -0,0 +1,235 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  # Option Brokerage symbol
+  class OptionBrokerageSymbol
+    attr_accessor :id
+
+    attr_accessor :description
+
+    attr_accessor :option_symbol
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'description' => :'description',
+        :'option_symbol' => :'option_symbol'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'description' => :'String',
+        :'option_symbol' => :'OptionsSymbol'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::OptionBrokerageSymbol` 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 `SnapTrade::OptionBrokerageSymbol`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'option_symbol')
+        self.option_symbol = attributes[:'option_symbol']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          description == o.description &&
+          option_symbol == o.option_symbol
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, description, option_symbol].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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 = SnapTrade.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end

data/lib/snaptrade/models/options_position.rb

@@ -44,7 +44,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'symbol' => :'BrokerageSymbol',
+        :'symbol' => :'OptionBrokerageSymbol',
         :'price' => :'Float',
         :'units' => :'Float',
         :'currency' => :'OptionsPositionCurrency',

data/lib/snaptrade/models/snap_trade_holdings_total_value.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Summed value of account positions and cash balances
+  # Calculated based on the sum of the values of account positions and cash balances
   class SnapTradeHoldingsTotalValue
     attr_accessor :value
 

data/lib/snaptrade/version.rb

@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '2.0.23'
+  VERSION = '2.0.24'
 end

data/lib/snaptrade.rb

@@ -83,6 +83,7 @@ require 'snaptrade/models/monthly_dividends'
 require 'snaptrade/models/net_contributions'
 require 'snaptrade/models/net_dividend'
 require 'snaptrade/models/notional_value'
+require 'snaptrade/models/option_brokerage_symbol'
 require 'snaptrade/models/option_chain_inner'
 require 'snaptrade/models/option_chain_inner_chain_per_root_inner'
 require 'snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner'

data/spec/models/option_brokerage_symbol_spec.rb

@@ -0,0 +1,41 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SnapTrade::OptionBrokerageSymbol
+describe SnapTrade::OptionBrokerageSymbol do
+  let(:instance) { SnapTrade::OptionBrokerageSymbol.new }
+
+  describe 'test an instance of OptionBrokerageSymbol' do
+    it 'should create an instance of OptionBrokerageSymbol' do
+      expect(instance).to be_instance_of(SnapTrade::OptionBrokerageSymbol)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "description"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "option_symbol"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 2.0.23
+  version: 2.0.24
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -162,6 +162,7 @@ files:
 - lib/snaptrade/models/net_contributions.rb
 - lib/snaptrade/models/net_dividend.rb
 - lib/snaptrade/models/notional_value.rb
+- lib/snaptrade/models/option_brokerage_symbol.rb
 - lib/snaptrade/models/option_chain_inner.rb
 - lib/snaptrade/models/option_chain_inner_chain_per_root_inner.rb
 - lib/snaptrade/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner.rb
@@ -312,6 +313,7 @@ files:
 - spec/models/net_contributions_spec.rb
 - spec/models/net_dividend_spec.rb
 - spec/models/notional_value_spec.rb
+- spec/models/option_brokerage_symbol_spec.rb
 - spec/models/option_chain_inner_chain_per_root_inner_chain_per_strike_price_inner_spec.rb
 - spec/models/option_chain_inner_chain_per_root_inner_spec.rb
 - spec/models/option_chain_inner_spec.rb
@@ -470,6 +472,7 @@ test_files:
 - spec/models/connection_portal_version_spec.rb
 - spec/models/account_order_record_status_spec.rb
 - spec/models/snap_trade_api_disclaimer_accept_status_spec.rb
+- spec/models/option_brokerage_symbol_spec.rb
 - spec/models/snap_trade_login_user_request_body_spec.rb
 - spec/models/brokerage_authorization_type_type_spec.rb
 - spec/models/portfolio_group_settings_spec.rb