snaptrade 1.2.0

data/lib/snaptrade.rb

@@ -0,0 +1,214 @@
+=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 'forwardable'
+
+# Common files
+require 'snaptrade/api_client'
+require 'snaptrade/api_error'
+require 'snaptrade/version'
+require 'snaptrade/configuration'
+
+# Models
+require 'snaptrade/models/account'
+require 'snaptrade/models/account_holdings'
+require 'snaptrade/models/account_holdings_account'
+require 'snaptrade/models/account_order_record'
+require 'snaptrade/models/account_order_record_status'
+require 'snaptrade/models/account_simple'
+require 'snaptrade/models/account_sync_status'
+require 'snaptrade/models/action'
+require 'snaptrade/models/auth_type'
+require 'snaptrade/models/authentication_login_snap_trade_user200_response'
+require 'snaptrade/models/balance'
+require 'snaptrade/models/brokerage'
+require 'snaptrade/models/brokerage_authorization'
+require 'snaptrade/models/brokerage_authorization_type'
+require 'snaptrade/models/brokerage_authorization_type_read_only'
+require 'snaptrade/models/brokerage_authorization_type_read_only_brokerage'
+require 'snaptrade/models/brokerage_authorization_type_read_only_type'
+require 'snaptrade/models/brokerage_authorization_type_type'
+require 'snaptrade/models/brokerage_symbol'
+require 'snaptrade/models/brokerage_type'
+require 'snaptrade/models/calculated_trade'
+require 'snaptrade/models/cash_restriction'
+require 'snaptrade/models/connection_type'
+require 'snaptrade/models/connections_session_events200_response_inner'
+require 'snaptrade/models/currency'
+require 'snaptrade/models/delete_user_response'
+require 'snaptrade/models/dividend_at_date'
+require 'snaptrade/models/encrypted_response'
+require 'snaptrade/models/encrypted_response_encrypted_message_data'
+require 'snaptrade/models/exchange'
+require 'snaptrade/models/exchange_rate_pairs'
+require 'snaptrade/models/excluded_asset'
+require 'snaptrade/models/jwt'
+require 'snaptrade/models/login_redirect_uri'
+require 'snaptrade/models/manual_trade'
+require 'snaptrade/models/manual_trade_and_impact'
+require 'snaptrade/models/manual_trade_balance'
+require 'snaptrade/models/manual_trade_form'
+require 'snaptrade/models/manual_trade_symbol'
+require 'snaptrade/models/model400_failed_request_response'
+require 'snaptrade/models/model401_failed_request_response'
+require 'snaptrade/models/model403_failed_request_response'
+require 'snaptrade/models/model404_failed_request_response'
+require 'snaptrade/models/model_asset_class'
+require 'snaptrade/models/model_asset_class_details'
+require 'snaptrade/models/model_asset_class_target'
+require 'snaptrade/models/model_portfolio'
+require 'snaptrade/models/model_portfolio_asset_class'
+require 'snaptrade/models/model_portfolio_details'
+require 'snaptrade/models/model_portfolio_security'
+require 'snaptrade/models/model_type'
+require 'snaptrade/models/monthly_dividends'
+require 'snaptrade/models/net_contributions'
+require 'snaptrade/models/net_dividend'
+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'
+require 'snaptrade/models/option_leg'
+require 'snaptrade/models/option_leg_action'
+require 'snaptrade/models/option_strategy'
+require 'snaptrade/models/option_strategy_legs_inner'
+require 'snaptrade/models/options_get_option_strategy_request'
+require 'snaptrade/models/options_holdings'
+require 'snaptrade/models/options_place_option_strategy_request'
+require 'snaptrade/models/options_position'
+require 'snaptrade/models/options_symbol'
+require 'snaptrade/models/order_strategy_execute_body_order_type'
+require 'snaptrade/models/order_strategy_execute_body_time_in_force'
+require 'snaptrade/models/order_type'
+require 'snaptrade/models/partner_data'
+require 'snaptrade/models/past_value'
+require 'snaptrade/models/performance_custom'
+require 'snaptrade/models/portfolio_group'
+require 'snaptrade/models/portfolio_group_info'
+require 'snaptrade/models/portfolio_group_position'
+require 'snaptrade/models/portfolio_group_settings'
+require 'snaptrade/models/position'
+require 'snaptrade/models/position_symbol'
+require 'snaptrade/models/redirect_tokenand_pin'
+require 'snaptrade/models/security_type'
+require 'snaptrade/models/session_event'
+require 'snaptrade/models/session_event_type'
+require 'snaptrade/models/snap_trade_api_disclaimer_accept_status'
+require 'snaptrade/models/snap_trade_holdings_account'
+require 'snaptrade/models/snap_trade_holdings_account_account_id'
+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/state'
+require 'snaptrade/models/status'
+require 'snaptrade/models/strategy_impact'
+require 'snaptrade/models/strategy_impact_legs_inner'
+require 'snaptrade/models/strategy_order_place'
+require 'snaptrade/models/strategy_order_place_orders_inner'
+require 'snaptrade/models/strategy_order_place_orders_inner_legs_inner'
+require 'snaptrade/models/strategy_order_record'
+require 'snaptrade/models/strategy_order_record_order_type'
+require 'snaptrade/models/strategy_order_record_status'
+require 'snaptrade/models/strategy_order_record_time_in_force'
+require 'snaptrade/models/strategy_quotes'
+require 'snaptrade/models/strategy_quotes_greek'
+require 'snaptrade/models/strategy_type'
+require 'snaptrade/models/sub_period_return_rate'
+require 'snaptrade/models/symbol'
+require 'snaptrade/models/symbol_query'
+require 'snaptrade/models/symbols_quotes'
+require 'snaptrade/models/target_asset'
+require 'snaptrade/models/time_in_force'
+require 'snaptrade/models/trade'
+require 'snaptrade/models/trade_action'
+require 'snaptrade/models/trade_execution_status'
+require 'snaptrade/models/trade_execution_status_action'
+require 'snaptrade/models/trade_impact'
+require 'snaptrade/models/trading_cancel_user_account_order_request'
+require 'snaptrade/models/trading_place_oco_order_request'
+require 'snaptrade/models/transactions_status'
+require 'snaptrade/models/type'
+require 'snaptrade/models/us_exchange'
+require 'snaptrade/models/underlying_symbol'
+require 'snaptrade/models/universal_activity'
+require 'snaptrade/models/universal_symbol'
+require 'snaptrade/models/universal_symbol_ticker'
+require 'snaptrade/models/user_error_log'
+require 'snaptrade/models/user_i_dand_secret'
+require 'snaptrade/models/user_settings'
+
+# APIs
+require 'snaptrade/api/account_information_api'
+require 'snaptrade/api/api_status_api'
+require 'snaptrade/api/authentication_api'
+require 'snaptrade/api/connections_api'
+require 'snaptrade/api/error_logs_api'
+require 'snaptrade/api/options_api'
+require 'snaptrade/api/portfolio_management_api'
+require 'snaptrade/api/reference_data_api'
+require 'snaptrade/api/trading_api'
+require 'snaptrade/api/transactions_and_reporting_api'
+
+module SnapTrade
+  @config = Configuration.default
+  SENTINEL = Object.new
+  class << self
+    extend Forwardable
+
+    def is_sentinel(value)
+      value == SENTINEL
+    end
+
+    def_delegators :@config, :client_id, :client_id= # api key
+    def_delegators :@config, :signature, :signature= # api key
+    def_delegators :@config, :timestamp, :timestamp= # api key
+    def_delegators :@config, :consumer_key, :consumer_key= # client state from konfig.yaml
+
+    # Customize default settings for the SDK using block.
+    #   SnapTrade.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+
+  class Client
+    attr_accessor :account_information
+    attr_accessor :api_status
+    attr_accessor :authentication
+    attr_accessor :connections
+    attr_accessor :error_logs
+    attr_accessor :options
+    attr_accessor :portfolio_management
+    attr_accessor :reference_data
+    attr_accessor :trading
+    attr_accessor :transactions_and_reporting
+
+    def initialize(config = Configuration.default)
+      @api_client = ApiClient::new(config)
+      @account_information = SnapTrade::AccountInformationApi.new(@api_client)
+      @api_status = SnapTrade::APIStatusApi.new(@api_client)
+      @authentication = SnapTrade::AuthenticationApi.new(@api_client)
+      @connections = SnapTrade::ConnectionsApi.new(@api_client)
+      @error_logs = SnapTrade::ErrorLogsApi.new(@api_client)
+      @options = SnapTrade::OptionsApi.new(@api_client)
+      @portfolio_management = SnapTrade::PortfolioManagementApi.new(@api_client)
+      @reference_data = SnapTrade::ReferenceDataApi.new(@api_client)
+      @trading = SnapTrade::TradingApi.new(@api_client)
+      @transactions_and_reporting = SnapTrade::TransactionsAndReportingApi.new(@api_client)
+    end
+  end
+end

data/snaptrade.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "snaptrade/version"
+
+Gem::Specification.new do |s|
+  s.name        = "snaptrade"
+  s.version     = SnapTrade::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["SnapTrade"]
+  s.email       = ["api@snaptrade.com"]
+  s.homepage    = "https://snaptrade.com/"
+  s.summary     = "SnapTrade Ruby Gem"
+  s.description = "Connect brokerage accounts to your app for live positions and trading"
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.4"
+  s.metadata = {
+    "documentation_uri" => "https://github.com/passiv/snaptrade-sdks/tree/master/sdks/ruby",
+    "source_code_uri"   => "https://github.com/passiv/snaptrade-sdks/tree/master/sdks/ruby",
+  }
+
+  s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_runtime_dependency 'faraday-multipart', '~> 1.0', '>= 1.0.4'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/account_information_api_spec.rb

@@ -0,0 +1,135 @@
+=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'
+
+# Unit tests for SnapTrade::AccountInformationApi
+describe 'AccountInformationApi' do
+  before do
+    # run before each test
+    @api_instance = SnapTrade::AccountInformationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountInformationApi' do
+    it 'should create an instance of AccountInformationApi' do
+      expect(@api_instance).to be_instance_of(SnapTrade::AccountInformationApi)
+    end
+  end
+
+  # unit tests for get_all_user_holdings
+  # List all accounts for the user, plus balances and positions for each account.
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :brokerage_authorizations Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
+  # @return [Array<AccountHoldings>]
+  describe 'get_all_user_holdings test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_user_account_balance
+  # Get all cash balances of an investment account
+  # @param user_id 
+  # @param user_secret 
+  # @param account_id The ID of the account get positions.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Balance>]
+  describe 'get_user_account_balance test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_user_account_details
+  # Return details of a specific investment account
+  # @param user_id 
+  # @param user_secret 
+  # @param account_id The ID of the account to get detail of.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Account>]
+  describe 'get_user_account_details test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_user_account_orders
+  # Get all history of orders placed in account
+  # @param user_id 
+  # @param user_secret 
+  # @param account_id The ID of the account get positions.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :state defaults value is set to \&quot;all\&quot;
+  # @return [Array<AccountOrderRecord>]
+  describe 'get_user_account_orders test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_user_account_positions
+  # Get all positions of an investment account
+  # @param user_id 
+  # @param user_secret 
+  # @param account_id The ID of the account get positions.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Position>]
+  describe 'get_user_account_positions test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_user_holdings
+  # List balances, positions and orders for the specified account.
+  # @param account_id The ID of the account to fetch holdings for.
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [AccountHoldingsAccount]
+  describe 'get_user_holdings test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_user_accounts
+  # List all investment accounts for the user
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Account>]
+  describe 'list_user_accounts test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_user_account
+  # Update details of an investment account
+  # @param user_id 
+  # @param user_secret 
+  # @param account_id The ID of the account to update.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Account>]
+  describe 'update_user_account test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/api_status_api_spec.rb

@@ -0,0 +1,42 @@
+=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'
+
+# Unit tests for SnapTrade::APIStatusApi
+describe 'APIStatusApi' do
+  before do
+    # run before each test
+    @api_instance = SnapTrade::APIStatusApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of APIStatusApi' do
+    it 'should create an instance of APIStatusApi' do
+      expect(@api_instance).to be_instance_of(SnapTrade::APIStatusApi)
+    end
+  end
+
+  # unit tests for check
+  # Get API Status
+  # Check whether the API is operational and verify timestamps.
+  # @param [Hash] opts the optional parameters
+  # @return [Status]
+  describe 'check test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/authentication_api_spec.rb

@@ -0,0 +1,88 @@
+=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'
+
+# Unit tests for SnapTrade::AuthenticationApi
+describe 'AuthenticationApi' do
+  before do
+    # run before each test
+    @api_instance = SnapTrade::AuthenticationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AuthenticationApi' do
+    it 'should create an instance of AuthenticationApi' do
+      expect(@api_instance).to be_instance_of(SnapTrade::AuthenticationApi)
+    end
+  end
+
+  # unit tests for delete_snap_trade_user
+  # Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+  # @param user_id 
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteUserResponse]
+  describe 'delete_snap_trade_user test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_user_jwt
+  # Obtains an encrypted JWT tokens that should be decrypted on a user's local device
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [EncryptedResponse]
+  describe 'get_user_jwt test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_snap_trade_users
+  # Get a list of all SnapTrade users you've registered on our platform
+  # @param [Hash] opts the optional parameters
+  # @return [Array<String>]
+  describe 'list_snap_trade_users test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for login_snap_trade_user
+  # Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @option opts [SnapTradeLoginUserRequestBody] :snap_trade_login_user_request_body 
+  # @return [AuthenticationLoginSnapTradeUser200Response]
+  describe 'login_snap_trade_user test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for register_snap_trade_user
+  # Register user with SnapTrade in order to create secure brokerage authorizations
+  # @param snap_trade_register_user_request_body 
+  # @param [Hash] opts the optional parameters
+  # @return [UserIDandSecret]
+  describe 'register_snap_trade_user test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/connections_api_spec.rb

@@ -0,0 +1,82 @@
+=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'
+
+# Unit tests for SnapTrade::ConnectionsApi
+describe 'ConnectionsApi' do
+  before do
+    # run before each test
+    @api_instance = SnapTrade::ConnectionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ConnectionsApi' do
+    it 'should create an instance of ConnectionsApi' do
+      expect(@api_instance).to be_instance_of(SnapTrade::ConnectionsApi)
+    end
+  end
+
+  # unit tests for detail_brokerage_authorization
+  # Get detail of a specific brokerage authorizations for the user
+  # @param authorization_id The ID of a brokerage authorization object.
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [BrokerageAuthorization]
+  describe 'detail_brokerage_authorization test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_brokerage_authorizations
+  # List all brokerage authorizations for the user
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<BrokerageAuthorization>]
+  describe 'list_brokerage_authorizations test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for remove_brokerage_authorization
+  # Remove a brokerage authorization.
+  # @param authorization_id The ID of the Authorization to delete.
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'remove_brokerage_authorization test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for session_events
+  # List all session events for the partner
+  # @param partner_client_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :user_id Optional comma seperated list of user IDs used to filter the request on specific users
+  # @option opts [String] :session_id Optional comma seperated list of session IDs used to filter the request on specific users
+  # @return [Array<ConnectionsSessionEvents200ResponseInner>]
+  describe 'session_events test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/error_logs_api_spec.rb

@@ -0,0 +1,43 @@
+=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'
+
+# Unit tests for SnapTrade::ErrorLogsApi
+describe 'ErrorLogsApi' do
+  before do
+    # run before each test
+    @api_instance = SnapTrade::ErrorLogsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ErrorLogsApi' do
+    it 'should create an instance of ErrorLogsApi' do
+      expect(@api_instance).to be_instance_of(SnapTrade::ErrorLogsApi)
+    end
+  end
+
+  # unit tests for list_user_errors
+  # Retrieve error logs on behalf of your SnapTrade users
+  # @param user_id 
+  # @param user_secret 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<UserErrorLog>]
+  describe 'list_user_errors test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end