snaptrade 2.0.7 → 2.0.8

data/lib/snaptrade/api/transactions_and_reporting_api.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'cgi'
@@ -19,7 +18,9 @@ module SnapTrade
     end
 
     # Get transaction history for a user
+    #
     # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param start_date [Date] 
@@ -39,7 +40,9 @@ module SnapTrade
     end
 
     # Get transaction history for a user
+    #
     # Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
+    #
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param start_date [Date] 
@@ -68,7 +71,7 @@ module SnapTrade
     # @option opts [String] :brokerage_authorizations Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
     # @option opts [String] :type Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
     # @return [Array<UniversalActivity>]
-    def get_activities_impl(user_id, user_secret, opts = {})
+    private def get_activities_impl(user_id, user_secret, opts = {})
       data, _status_code, _headers = get_activities_with_http_info(user_id, user_secret, opts)
       data
     end
@@ -84,7 +87,7 @@ module SnapTrade
     # @option opts [String] :brokerage_authorizations Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
     # @option opts [String] :type Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
     # @return [Array<(Array<UniversalActivity>, Integer, Hash)>] Array<UniversalActivity> data, response status code and response headers
-    def get_activities_with_http_info_impl(user_id, user_secret, opts = {})
+    private def get_activities_with_http_info_impl(user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TransactionsAndReportingApi.get_activities ...'
       end
@@ -145,7 +148,9 @@ module SnapTrade
 
 
     # Get performance information for a specific timeframe
+    #
     # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
+    #
     # @param start_date [Date] 
     # @param end_date [Date] 
     # @param user_id [String] 
@@ -163,7 +168,9 @@ module SnapTrade
     end
 
     # Get performance information for a specific timeframe
+    #
     # Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
+    #
     # @param start_date [Date] 
     # @param end_date [Date] 
     # @param user_id [String] 
@@ -190,7 +197,7 @@ module SnapTrade
     # @option opts [Boolean] :detailed Optional, increases frequency of data points for the total value and contribution charts if set to true
     # @option opts [String] :frequency Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
     # @return [PerformanceCustom]
-    def get_reporting_custom_range_impl(start_date, end_date, user_id, user_secret, opts = {})
+    private def get_reporting_custom_range_impl(start_date, end_date, user_id, user_secret, opts = {})
       data, _status_code, _headers = get_reporting_custom_range_with_http_info(start_date, end_date, user_id, user_secret, opts)
       data
     end
@@ -206,7 +213,7 @@ module SnapTrade
     # @option opts [Boolean] :detailed Optional, increases frequency of data points for the total value and contribution charts if set to true
     # @option opts [String] :frequency Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
     # @return [Array<(PerformanceCustom, Integer, Hash)>] PerformanceCustom data, response status code and response headers
-    def get_reporting_custom_range_with_http_info_impl(start_date, end_date, user_id, user_secret, opts = {})
+    private def get_reporting_custom_range_with_http_info_impl(start_date, end_date, user_id, user_secret, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TransactionsAndReportingApi.get_reporting_custom_range ...'
       end

data/lib/snaptrade/api_client.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -179,7 +178,6 @@ module SnapTrade
 
     def build_connection
       Faraday.new(url: config.base_url, ssl: ssl_options) do |conn|
-        basic_auth(conn)
         config.configure_middleware(conn)
         yield(conn) if block_given?
         conn.adapter(Faraday.default_adapter)
@@ -196,16 +194,6 @@ module SnapTrade
       }
     end
 
-    def basic_auth(conn)
-      if config.username && config.password
-        if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
-          conn.request(:authorization, :basic, config.username, config.password)
-        else
-          conn.request(:basic_auth, config.username, config.password)
-        end
-      end
-    end
-
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json
@@ -342,9 +330,11 @@ module SnapTrade
       Array(auth_names).each do |auth_name|
         auth_setting = @config.auth_settings[auth_name]
         next unless auth_setting
+        value = auth_setting[:value]
+        next unless value
         case auth_setting[:in]
-        when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
-        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
+        when 'header' then header_params[auth_setting[:key]] = value
+        when 'query'  then query_params[auth_setting[:key]] = value
         else fail ArgumentError, 'Authentication token must be in `query` or `header`'
         end
       end
@@ -424,4 +414,24 @@ module SnapTrade
       end
     end
   end
+
+  # Represents an HTTP response for method that end with *_with_http_info
+  class APIResponse
+    # [Object] deserialized data
+    attr_reader :data
+    # [Integer] response status code
+    attr_reader :status_code
+    # [Hash] response headers
+    attr_reader :headers
+    # [Faraday::Response] the original Faraday response object
+    attr_reader :response
+
+    def initialize(data, status_code, headers, response)
+      @data = data
+      @status_code = status_code
+      @headers = headers
+      @response = response
+    end
+
+  end
 end

data/lib/snaptrade/api_error.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 module SnapTrade

data/lib/snaptrade/configuration.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 module SnapTrade
@@ -32,15 +31,15 @@ module SnapTrade
     attr_accessor :server_operation_variables
 
     def client_id=(value)
-      @api_key['PartnerClientId'] = value
+      @api_key_store['PartnerClientId'] = value
     end
 
     def signature=(value)
-      @api_key['PartnerSignature'] = value
+      @api_key_store['PartnerSignature'] = value
     end
 
     def timestamp=(value)
-      @api_key['PartnerTimestamp'] = value
+      @api_key_store['PartnerTimestamp'] = value
     end
 
     # client state configured through konfig.yaml
@@ -58,8 +57,8 @@ module SnapTrade
     # @return [Hash] key: parameter name, value: parameter value (API key)
     #
     # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-    #   config.api_key['api_key'] = 'xxx'
-    attr_accessor :api_key
+    #   config.api_key_store['api_key'] = 'xxx'
+    attr_accessor :api_key_store
 
     # Defines API key prefixes used with API Key authentications.
     #
@@ -69,19 +68,6 @@ module SnapTrade
     #   config.api_key_prefix['api_key'] = 'Token'
     attr_accessor :api_key_prefix
 
-    # Defines the username used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :username
-
-    # Defines the password used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :password
-
-    # Defines the access token (Bearer) used with OAuth2.
-    attr_accessor :access_token
-
     # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
     # details will be logged with `logger.debug` (see the `logger` attribute).
     # Default to false.
@@ -165,7 +151,7 @@ module SnapTrade
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
-      @api_key = {}
+      @api_key_store = {}
       @api_key_prefix = {}
       @client_side_validation = true
       @ssl_verify = true
@@ -233,20 +219,16 @@ module SnapTrade
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
     def api_key_with_prefix(param_name, param_alias = nil)
-      key = @api_key[param_name]
-      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
+      value = @api_key_store[param_name]
+      value = @api_key_store.fetch(param_alias, value) unless param_alias.nil?
+      return nil if value.nil?
       if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{key}"
+        "#{@api_key_prefix[param_name]}#{value}"
       else
-        key
+        value
       end
     end
 
-    # Gets Basic Auth token string
-    def basic_auth_token
-      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
-    end
-
     # Returns Auth Settings hash for api client.
     def auth_settings
       {

data/lib/snaptrade/models/account.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/account_balance.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/account_balance_total.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/account_holdings.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/account_holdings_account.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/account_order_record.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'
@@ -25,9 +24,9 @@ module SnapTrade
 
     attr_accessor :option_symbol
 
+    # Trade Action
     attr_accessor :action
 
-    # Trade Units. Cannot work with notional value.
     attr_accessor :total_quantity
 
     # Trade Units
@@ -48,6 +47,7 @@ module SnapTrade
     # Stop Price. If stop loss or stop limit order, the price to trigger the stop
     attr_accessor :stop_price
 
+    # Order Type
     attr_accessor :order_type
 
     # Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled   * GTD - Good Til Date 
@@ -118,6 +118,7 @@ module SnapTrade
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total_quantity',
         :'open_quantity',
         :'canceled_quantity',
         :'filled_quantity',

data/lib/snaptrade/models/account_order_record_status.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/account_simple.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/account_sync_status.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/action.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/amount.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/auth_type.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/authentication_login_snap_trade_user200_response.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/balance.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage_authorization.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage_authorization_type.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage_authorization_type_read_only.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage_authorization_type_read_only_brokerage.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage_authorization_type_read_only_type.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage_authorization_type_type.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage_symbol.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage_symbol_option_symbol.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage_symbol_symbol.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/brokerage_type.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/calculated_trade.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/cash_restriction.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/connection_portal_version.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/connection_type.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/connections_session_events200_response_inner.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/currency.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/delete_user_response.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/dividend_at_date.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/encrypted_response.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/encrypted_response_encrypted_message_data.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/exchange.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/exchange_rate_pairs.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/excluded_asset.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/jwt.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'

data/lib/snaptrade/models/login_redirect_uri.rb

@@ -5,7 +5,6 @@
 
 The version of the OpenAPI document: 1.0.0
 Contact: api@snaptrade.com
-
 =end
 
 require 'date'