snaptrade 3.0.13 → 3.0.15

data/lib/snaptrade/models/{line_of_credit_account_credit_details_minimum_payment_amount.rb → line_of_credit_account_minimum_payment_amount.rb}

@@ -11,8 +11,8 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # The minimum payment due on the account's next statement.
-  class LineOfCreditAccountCreditDetailsMinimumPaymentAmount
+  # The minimum payment due on the account's next statement. Omitted when no such data is available.
+  class LineOfCreditAccountMinimumPaymentAmount
     attr_accessor :amount
 
     attr_accessor :currency
@@ -50,13 +50,13 @@ module SnapTrade
     # @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::LineOfCreditAccountCreditDetailsMinimumPaymentAmount` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::LineOfCreditAccountMinimumPaymentAmount` 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::LineOfCreditAccountCreditDetailsMinimumPaymentAmount`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::LineOfCreditAccountMinimumPaymentAmount`. 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
       }

data/lib/snaptrade/models/other_instrument.rb

@@ -11,7 +11,7 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  # Security instrument metadata for other mapped security positions.
+  # Security instrument metadata for bonds and other mapped security positions.
   class OtherInstrument
     # Type of security instrument.
     attr_accessor :kind

data/lib/snaptrade/models/other_instrument_kind.rb

@@ -12,10 +12,11 @@ require 'time'
 
 module SnapTrade
   class OtherInstrumentKind
+    BOND = "bond".freeze
     OTHER = "other".freeze
 
     def self.all_vars
-      @all_vars ||= [OTHER].freeze
+      @all_vars ||= [BOND, OTHER].freeze
     end
 
     # Builds the enum from string

data/lib/snaptrade/models/snaptrade.rb

@@ -0,0 +1,37 @@
+=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
+  class Snaptrade
+    REALTIME = "realtime".freeze
+    DELAYED = "delayed".freeze
+
+    def self.all_vars
+      @all_vars ||= [REALTIME, DELAYED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if Snaptrade.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #Snaptrade"
+    end
+  end
+end

data/lib/snaptrade/models/underlying_cfd_instrument.rb

@@ -36,6 +36,7 @@ module SnapTrade
       def openapi_discriminator_mapping
         {
           :'adr' => :'AdrInstrument',
+          :'bond' => :'OtherInstrument',
           :'cef' => :'CefInstrument',
           :'crypto' => :'CryptoInstrument',
           :'etf' => :'EtfInstrument',

data/lib/snaptrade/models/underlying_option_instrument.rb

@@ -36,6 +36,7 @@ module SnapTrade
       def openapi_discriminator_mapping
         {
           :'adr' => :'AdrInstrument',
+          :'bond' => :'OtherInstrument',
           :'cef' => :'CefInstrument',
           :'crypto' => :'CryptoInstrument',
           :'etf' => :'EtfInstrument',

data/lib/snaptrade/version.rb

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

data/lib/snaptrade.rb

@@ -60,6 +60,7 @@ require 'snaptrade/models/balance'
 require 'snaptrade/models/balance_currency'
 require 'snaptrade/models/brokerage'
 require 'snaptrade/models/brokerage_authorization'
+require 'snaptrade/models/brokerage_authorization_data_freshness_mode'
 require 'snaptrade/models/brokerage_authorization_disabled_confirmation'
 require 'snaptrade/models/brokerage_authorization_refresh_confirmation'
 require 'snaptrade/models/brokerage_authorization_transactions_sync_confirmation'
@@ -113,14 +114,14 @@ require 'snaptrade/models/figi_instrument'
 require 'snaptrade/models/future_instrument'
 require 'snaptrade/models/future_instrument_kind'
 require 'snaptrade/models/holdings_status'
+require 'snaptrade/models/institution'
 require 'snaptrade/models/instrument'
 require 'snaptrade/models/investment_account'
 require 'snaptrade/models/investment_account_net_value'
 require 'snaptrade/models/kind'
 require 'snaptrade/models/line_of_credit_account'
-require 'snaptrade/models/line_of_credit_account_credit_details'
-require 'snaptrade/models/line_of_credit_account_credit_details_minimum_payment_amount'
 require 'snaptrade/models/line_of_credit_account_kind'
+require 'snaptrade/models/line_of_credit_account_minimum_payment_amount'
 require 'snaptrade/models/line_of_credit_account_net_value'
 require 'snaptrade/models/line_of_credit_account_sync_status'
 require 'snaptrade/models/login_redirect_uri'
@@ -211,6 +212,7 @@ require 'snaptrade/models/snap_trade_holdings_account'
 require 'snaptrade/models/snap_trade_holdings_total_value'
 require 'snaptrade/models/snap_trade_login_user_request_body'
 require 'snaptrade/models/snap_trade_register_user_request_body'
+require 'snaptrade/models/snaptrade'
 require 'snaptrade/models/status'
 require 'snaptrade/models/stock_instrument'
 require 'snaptrade/models/stock_instrument_figi_instrument'

data/spec/api/account_information_api_spec.rb

@@ -62,7 +62,7 @@ describe 'AccountInformationApi' do
 
   # unit tests for get_all_account_positions
   # List all account positions
-  # Returns a list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  `mutualfund` positions may also include `cash_equivalent`. `stock`, `etf`, and `mutualfund` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
+  # Returns a list of all positions in the specified account.  The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, bonds, crypto, futures, option positions, and CFD positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.  Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages).  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection. 
   # @param user_id 
   # @param user_secret 
   # @param account_id 

data/spec/api/connections_api_spec.rb

@@ -98,7 +98,7 @@ describe 'ConnectionsApi' do
 
   # unit tests for refresh_brokerage_authorization
   # Refresh holdings for a connection
-  # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.  **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless the connection is delayed. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to the `data_freshness_mode` field on a connection to determine this.** 
+  # Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred.  **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless SnapTrade uses delayed data for the connection. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to `data_freshness_mode.snaptrade` on a connection to determine this.** 
   # @param authorization_id 
   # @param user_id 
   # @param user_secret 

data/spec/models/brokerage_authorization_data_freshness_mode_spec.rb

@@ -0,0 +1,35 @@
+=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::BrokerageAuthorizationDataFreshnessMode
+describe SnapTrade::BrokerageAuthorizationDataFreshnessMode do
+  let(:instance) { SnapTrade::BrokerageAuthorizationDataFreshnessMode.new }
+
+  describe 'test an instance of BrokerageAuthorizationDataFreshnessMode' do
+    it 'should create an instance of BrokerageAuthorizationDataFreshnessMode' do
+      expect(instance).to be_instance_of(SnapTrade::BrokerageAuthorizationDataFreshnessMode)
+    end
+  end
+  describe 'test attribute "institution"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "snaptrade"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/connection_account_spec.rb

@@ -27,7 +27,7 @@ describe SnapTrade::ConnectionAccount do
 
   describe '.openapi_discriminator_mapping' do
     it 'returns the key/values of the "mapping" property' do
-      expect(described_class.openapi_discriminator_mapping.values.sort).to eq(described_class.openapi_one_of.sort)
+      expect(described_class.openapi_discriminator_mapping.values.uniq.sort).to eq(described_class.openapi_one_of.sort)
     end
   end
 

data/spec/models/deposit_account_spec.rb

@@ -44,7 +44,7 @@ describe SnapTrade::DepositAccount do
     end
   end
 
-  describe 'test attribute "number"' do
+  describe 'test attribute "masked_account_number"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/models/institution_spec.rb

@@ -0,0 +1,23 @@
+=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::Institution
+describe SnapTrade::Institution do
+  let(:instance) { SnapTrade::Institution.new }
+
+  describe 'test an instance of Institution' do
+    it 'should create an instance of Institution' do
+      expect(instance).to be_instance_of(SnapTrade::Institution)
+    end
+  end
+end

data/spec/models/instrument_spec.rb

@@ -27,7 +27,7 @@ describe SnapTrade::Instrument do
 
   describe '.openapi_discriminator_mapping' do
     it 'returns the key/values of the "mapping" property' do
-      expect(described_class.openapi_discriminator_mapping.values.sort).to eq(described_class.openapi_one_of.sort)
+      expect(described_class.openapi_discriminator_mapping.values.uniq.sort).to eq(described_class.openapi_one_of.sort)
     end
   end
 

data/spec/models/investment_account_spec.rb

@@ -44,7 +44,7 @@ describe SnapTrade::InvestmentAccount do
     end
   end
 
-  describe 'test attribute "number"' do
+  describe 'test attribute "masked_account_number"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/models/{line_of_credit_account_credit_details_minimum_payment_amount_spec.rb → line_of_credit_account_minimum_payment_amount_spec.rb}

@@ -11,13 +11,13 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SnapTrade::LineOfCreditAccountCreditDetailsMinimumPaymentAmount
-describe SnapTrade::LineOfCreditAccountCreditDetailsMinimumPaymentAmount do
-  let(:instance) { SnapTrade::LineOfCreditAccountCreditDetailsMinimumPaymentAmount.new }
+# Unit tests for SnapTrade::LineOfCreditAccountMinimumPaymentAmount
+describe SnapTrade::LineOfCreditAccountMinimumPaymentAmount do
+  let(:instance) { SnapTrade::LineOfCreditAccountMinimumPaymentAmount.new }
 
-  describe 'test an instance of LineOfCreditAccountCreditDetailsMinimumPaymentAmount' do
-    it 'should create an instance of LineOfCreditAccountCreditDetailsMinimumPaymentAmount' do
-      expect(instance).to be_instance_of(SnapTrade::LineOfCreditAccountCreditDetailsMinimumPaymentAmount)
+  describe 'test an instance of LineOfCreditAccountMinimumPaymentAmount' do
+    it 'should create an instance of LineOfCreditAccountMinimumPaymentAmount' do
+      expect(instance).to be_instance_of(SnapTrade::LineOfCreditAccountMinimumPaymentAmount)
     end
   end
   describe 'test attribute "amount"' do

data/spec/models/line_of_credit_account_spec.rb

@@ -44,7 +44,7 @@ describe SnapTrade::LineOfCreditAccount do
     end
   end
 
-  describe 'test attribute "number"' do
+  describe 'test attribute "masked_account_number"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -86,7 +86,7 @@ describe SnapTrade::LineOfCreditAccount do
     end
   end
 
-  describe 'test attribute "credit_details"' do
+  describe 'test attribute "minimum_payment_amount"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/models/snaptrade_spec.rb

@@ -0,0 +1,23 @@
+=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::Snaptrade
+describe SnapTrade::Snaptrade do
+  let(:instance) { SnapTrade::Snaptrade.new }
+
+  describe 'test an instance of Snaptrade' do
+    it 'should create an instance of Snaptrade' do
+      expect(instance).to be_instance_of(SnapTrade::Snaptrade)
+    end
+  end
+end

data/spec/models/underlying_cfd_instrument_spec.rb

@@ -27,7 +27,7 @@ describe SnapTrade::UnderlyingCfdInstrument do
 
   describe '.openapi_discriminator_mapping' do
     it 'returns the key/values of the "mapping" property' do
-      expect(described_class.openapi_discriminator_mapping.values.sort).to eq(described_class.openapi_one_of.sort)
+      expect(described_class.openapi_discriminator_mapping.values.uniq.sort).to eq(described_class.openapi_one_of.sort)
     end
   end
 

data/spec/models/underlying_option_instrument_spec.rb

@@ -27,7 +27,7 @@ describe SnapTrade::UnderlyingOptionInstrument do
 
   describe '.openapi_discriminator_mapping' do
     it 'returns the key/values of the "mapping" property' do
-      expect(described_class.openapi_discriminator_mapping.values.sort).to eq(described_class.openapi_one_of.sort)
+      expect(described_class.openapi_discriminator_mapping.values.uniq.sort).to eq(described_class.openapi_one_of.sort)
     end
   end
 

data/spec/regression/all_account_positions_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'json'
+
+describe 'All account positions response deserialization' do
+  let(:payload) do
+    JSON.parse(File.read(File.join(__dir__, 'fixtures/all_account_positions.json')))
+  end
+  let(:body) { JSON.generate(payload) }
+  let(:configuration) do
+    SnapTrade::Configuration.new.tap do |config|
+      config.host = 'https://sdk-test.invalid'
+      config.client_id = 'TEST_CLIENT'
+      config.consumer_key = 'TEST_KEY'
+    end
+  end
+  let(:api_client) { SnapTrade::ApiClient.new(configuration) }
+  let(:api) { SnapTrade::AccountInformationApi.new(api_client) }
+  let(:arguments) do
+    { user_id: 12345, user_secret: 'TEST_SECRET', account_id: 'TEST_ACCOUNT' }
+  end
+  let(:stubs) do
+    Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.get('/accounts/TEST_ACCOUNT/positions/all') do
+        [200, { 'content-type' => 'application/json' }, body]
+      end
+    end
+  end
+  let(:connection) do
+    Faraday.new(url: configuration.base_url) { |conn| conn.adapter :test, stubs }
+  end
+
+  before do
+    allow(api_client).to receive(:connection).and_return(connection)
+  end
+
+  after do
+    stubs.verify_stubbed_calls
+  end
+
+  [:get_all_account_positions, :get_all_account_positions_with_http_info].each do |operation|
+    context operation.to_s do
+      let(:data) do
+        result = api.public_send(operation, **arguments)
+        if operation == :get_all_account_positions_with_http_info
+          parsed, status, headers, response = result
+          expect(status).to eq(200)
+          expect(headers['content-type']).to eq('application/json')
+          expect(response.body).to eq(body)
+          parsed
+        else
+          result
+        end
+      end
+
+      it 'returns the full response and both bond instruments from a populated HTTP 200 body' do
+        expect(data).to be_a(SnapTrade::AllAccountPositionsResponse)
+        expect(data.data_freshness.as_of).to eq(Time.utc(2026, 9, 8, 11, 2, 57))
+        expect(data.results.length).to eq(2)
+        expect(data.results.map(&:units)).to eq([70.0, 70.0])
+        expect(data.results.map(&:price)).to eq([99.768, 100.025])
+        expect(data.results.map(&:cost_basis)).to eq([97.51, 100.25])
+        expect(data.results.map(&:instrument)).to all(be_a(SnapTrade::OtherInstrument))
+        expect(data.results.map { |position| position.instrument.kind }).to eq(['bond', 'bond'])
+        expect(data.results.map { |position| position.instrument.symbol }).to eq(['912797SA6', '91282CJT9'])
+        expect(data.to_hash[:results].map { |position| position[:instrument][:kind] }).to eq(['bond', 'bond'])
+      end
+
+      it 'keeps a response object when there are no positions' do
+        payload['results'] = []
+
+        expect(data).to be_a(SnapTrade::AllAccountPositionsResponse)
+        expect(data.results).to eq([])
+        expect(data.data_freshness.as_of).to eq(Time.utc(2026, 9, 8, 11, 2, 57))
+      end
+
+      it 'retains instruments when bond and other positions appear together' do
+        payload['results'][1]['instrument']['kind'] = 'other'
+
+        expect(data).to be_a(SnapTrade::AllAccountPositionsResponse)
+        expect(data.results.map(&:instrument)).to all(be_a(SnapTrade::OtherInstrument))
+        expect(data.results.map { |position| position.instrument.kind }).to eq(['bond', 'other'])
+        expect(data.results.map { |position| position.instrument.symbol }).to eq(['912797SA6', '91282CJT9'])
+      end
+    end
+  end
+end

data/spec/regression/fixtures/all_account_positions.json

@@ -0,0 +1,33 @@
+{
+  "results": [
+    {
+      "instrument": {
+        "kind": "bond",
+        "id": "a7ade77d-74f4-4d8a-a1f8-1a582c2f4e3b",
+        "symbol": "912797SA6",
+        "raw_symbol": "912797SA6",
+        "description": "UNITED STATES TREAS BILLS ZERO CPN 0.00000% 10/01/2026",
+        "currency": "USD"
+      },
+      "units": "70",
+      "price": "99.768",
+      "cost_basis": "97.51",
+      "currency": "USD"
+    },
+    {
+      "instrument": {
+        "kind": "bond",
+        "id": "e538a57c-2bb8-40e2-812d-d07ee525b1cf",
+        "symbol": "91282CJT9",
+        "raw_symbol": "91282CJT9",
+        "description": "UNITED STATES TREAS SER AJ-2027 4.00000% 01/15/2027 NTS NOTE",
+        "currency": "USD"
+      },
+      "units": "70",
+      "price": "100.025",
+      "cost_basis": "100.25",
+      "currency": "USD"
+    }
+  ],
+  "data_freshness": { "as_of": "2026-09-08T11:02:57Z" }
+}

data/spec/regression/request_signing_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe SnapTrade::ApiClientCustom do
+  let(:configuration) do
+    SnapTrade::Configuration.new.tap { |config| config.consumer_key = 'TEST_KEY' }
+  end
+  let(:request) do
+    Faraday::Request.create(:post) do |req|
+      req.path = path
+      req.body = body
+      req.headers = {}
+      req.params = {
+        clientId: 'TEST_CLIENT',
+        userId: 'TEST_USER',
+        userSecret: 'TEST_SECRET'
+      }
+    end
+  end
+
+  before do
+    allow(Time).to receive(:now).and_return(Time.at(1_700_000_000))
+  end
+
+  context 'without a request body' do
+    let(:path) { '/accounts/TEST_ACCOUNT/positions/all' }
+    let(:body) { nil }
+
+    it 'preserves the existing signature bytes' do
+      described_class.request_hook(request, configuration)
+
+      expect(request.params[:timestamp]).to eq(1_700_000_000)
+      expect(request.headers[:Signature]).to eq('R7iYdxifiq/4joFEkOkaQj9QiW8LsgxmSDXco44gqtk=')
+    end
+  end
+
+  context 'with unsorted JSON body keys' do
+    let(:path) { '/orders' }
+    let(:body) { '{"z":2,"a":1}' }
+
+    it 'preserves body key sorting and the existing signature bytes' do
+      described_class.request_hook(request, configuration)
+
+      expect(request.headers[:Signature]).to eq('Zs3cXbvLmIEVPi69lHV6rah6wZ1phfk9cK6kbTYnSf4=')
+    end
+  end
+end