snaptrade 3.0.41 → 3.0.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec93bc8cc8465a3554c1b31a3db03031fc099dbc315c097dc34e497660dd34a0
-  data.tar.gz: 5ff44c8cb725bf1f541d54bbacdfc5c9073bc56f5fe75848e6850b7a98f2fda5
+  metadata.gz: e4f85b9d1b1c3c35297f0b4e937782ddd87ac1fefe8a44d89d1db6fb15e91a6d
+  data.tar.gz: b3ebe1a7502cd05431555ca0eece1885d0c6c218e2aa94acce12f922aa5561ee
 SHA512:
-  metadata.gz: 11ecc92785fb7ee7923926d95e5a57eeb3679c478ffd431cb24ae7a58e5ab52876b8b1ba39ad14d2282204473595e386dbc4cff7031bf7d1a748e97859361307
-  data.tar.gz: bdf7b353d053c768d900492552ee5f3a84b64b697c0390948cfaae8c08909c5eb7575f357e669772e981ab52a8e110adc2c656cbdafc36b51b4b17dd7f7ed1cb
+  metadata.gz: 9ab272bfcc080dc03433a1577adeb1bc7963c47d13fb8d839c1c9a387e8e37202e72631107951ec339f255be10aa16a6840d4671eda5d54e3fa5a5e1989105cb
+  data.tar.gz: d9135555eead25f271e1a2401d22f959e0535f182da7b320e7275963ad0b1a7a409617e6760ede9569fd6bfbe8b7797cc3f8c4971e150e87493c71c9c9f6d27e

data/README.md

@@ -63,7 +63,7 @@ backoff with jitter rather than from the headers.
 See https://docs.snaptrade.com/docs/ratelimiting.
 
 
-[![npm](https://img.shields.io/badge/gem-v3.0.41-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.41)
+[![npm](https://img.shields.io/badge/gem-v3.0.43-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.43)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -114,6 +114,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
   * [`snaptrade.experimental_endpoints.list_subscriptions`](#snaptradeexperimental_endpointslist_subscriptions)
   * [`snaptrade.experimental_endpoints.place_simple_order`](#snaptradeexperimental_endpointsplace_simple_order)
   * [`snaptrade.management.get_stats`](#snaptrademanagementget_stats)
+  * [`snaptrade.management.get_stats_legacy`](#snaptrademanagementget_stats_legacy)
   * [`snaptrade.reference_data.get_partner_info`](#snaptradereference_dataget_partner_info)
   * [`snaptrade.reference_data.get_stock_exchanges`](#snaptradereference_dataget_stock_exchanges)
   * [`snaptrade.reference_data.get_symbols`](#snaptradereference_dataget_symbols)
@@ -145,7 +146,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 3.0.41'
+gem 'snaptrade', '~> 3.0.43'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1778,9 +1779,11 @@ extended-hours enablement. Futures and multi-leg orders only accept regular.
 
 ### `snaptrade.management.get_stats`<a id="snaptrademanagementget_stats"></a>
 
+**Beta.** This endpoint and its response schema may change.
+
 Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.
 
-User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `assets_under_management_calculated_at` indicates when it was last calculated.
+User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `connected_assets_calculated_at` indicates when it was last calculated.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1799,6 +1802,43 @@ ISO 4217 currency code to express connected asset values in. Defaults to `USD`.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
+[ConnectedAssetPartnerStats](./lib/snaptrade/models/connected_asset_partner_stats.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/management/stats` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
+### `snaptrade.management.get_stats_legacy`<a id="snaptrademanagementget_stats_legacy"></a>
+![Deprecated](https://img.shields.io/badge/deprecated-yellow)
+
+**Deprecated.** Use `GET /management/stats` for the beta response with connected asset field names.
+
+Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.
+
+User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `assets_under_management_calculated_at` indicates when it was last calculated.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.management.get_stats_legacy(
+  currency: "USD",
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### currency: `String`<a id="currency-string"></a>
+ISO 4217 currency code to express connected asset values in. Defaults to `USD`.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
 [PartnerStats](./lib/snaptrade/models/partner_stats.rb)
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>

data/lib/snaptrade/api/management_api.rb

@@ -17,11 +17,13 @@ module SnapTrade
       @api_client = api_client
     end
 
-    # Get usage stats
+    # Get usage stats (beta)
     #
+    # **Beta.** This endpoint and its response schema may change.
+    # 
     # Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.
     # 
-    # User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `assets_under_management_calculated_at` indicates when it was last calculated.
+    # User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `connected_assets_calculated_at` indicates when it was last calculated.
     #
     # @param currency [String] ISO 4217 currency code to express connected asset values in. Defaults to `USD`.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -31,11 +33,13 @@ module SnapTrade
       data
     end
 
-    # Get usage stats
+    # Get usage stats (beta)
     #
+    # **Beta.** This endpoint and its response schema may change.
+    # 
     # Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.
     # 
-    # User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `assets_under_management_calculated_at` indicates when it was last calculated.
+    # User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `connected_assets_calculated_at` indicates when it was last calculated.
     #
     # @param currency [String] ISO 4217 currency code to express connected asset values in. Defaults to `USD`.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -44,27 +48,27 @@ module SnapTrade
       get_stats_with_http_info_impl(extra)
     end
 
-    # Get usage stats
-    # Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.  User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `assets_under_management_calculated_at` indicates when it was last calculated. 
+    # Get usage stats (beta)
+    # **Beta.** This endpoint and its response schema may change.  Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.  User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `connected_assets_calculated_at` indicates when it was last calculated. 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :currency ISO 4217 currency code to express connected asset values in. Defaults to `USD`.
-    # @return [PartnerStats]
+    # @return [ConnectedAssetPartnerStats]
     private def get_stats_impl(opts = {})
       data, _status_code, _headers = get_stats_with_http_info(opts)
       data
     end
 
-    # Get usage stats
-    # Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.  User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `assets_under_management_calculated_at` indicates when it was last calculated. 
+    # Get usage stats (beta)
+    # **Beta.** This endpoint and its response schema may change.  Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.  User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `connected_assets_calculated_at` indicates when it was last calculated. 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :currency ISO 4217 currency code to express connected asset values in. Defaults to `USD`.
-    # @return [Array<(PartnerStats, Integer, Hash)>] PartnerStats data, response status code and response headers
+    # @return [Array<(ConnectedAssetPartnerStats, Integer, Hash)>] ConnectedAssetPartnerStats data, response status code and response headers
     private def get_stats_with_http_info_impl(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ManagementApi.get_stats ...'
       end
       # resource path
-      local_var_path = '/snapTrade/stats'
+      local_var_path = '/management/stats'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -82,7 +86,7 @@ module SnapTrade
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'PartnerStats'
+      return_type = opts[:debug_return_type] || 'ConnectedAssetPartnerStats'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
@@ -103,6 +107,98 @@ module SnapTrade
       end
       return data, status_code, headers, response
     end
+
+
+    # Get usage stats (deprecated)
+    #
+    # **Deprecated.** Use `GET /management/stats` for the beta response with connected asset field names.
+    # 
+    # Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.
+    # 
+    # User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `assets_under_management_calculated_at` indicates when it was last calculated.
+    #
+    # @param currency [String] ISO 4217 currency code to express connected asset values in. Defaults to `USD`.
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_stats_legacy(currency: SENTINEL, extra: {})
+      extra[:currency] = currency if currency != SENTINEL
+      data, _status_code, _headers = get_stats_legacy_with_http_info_impl(extra)
+      data
+    end
+
+    # Get usage stats (deprecated)
+    #
+    # **Deprecated.** Use `GET /management/stats` for the beta response with connected asset field names.
+    # 
+    # Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.
+    # 
+    # User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `assets_under_management_calculated_at` indicates when it was last calculated.
+    #
+    # @param currency [String] ISO 4217 currency code to express connected asset values in. Defaults to `USD`.
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def get_stats_legacy_with_http_info(currency: SENTINEL, extra: {})
+      extra[:currency] = currency if currency != SENTINEL
+      get_stats_legacy_with_http_info_impl(extra)
+    end
+
+    # Get usage stats (deprecated)
+    # **Deprecated.** Use `GET /management/stats` for the beta response with connected asset field names.  Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users & Connections page of the SnapTrade Dashboard.  User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; `assets_under_management_calculated_at` indicates when it was last calculated. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :currency ISO 4217 currency code to express connected asset values in. Defaults to `USD`.
+    # @return [PartnerStats]
+    private def get_stats_legacy_impl(opts = {})
+      data, _status_code, _headers = get_stats_legacy_with_http_info(opts)
+      data
+    end
+
+    # Get usage stats (deprecated)
+    # **Deprecated.** Use &#x60;GET /management/stats&#x60; for the beta response with connected asset field names.  Returns user, connection, and connected asset totals for your SnapTrade Client ID. These are the same numbers shown on the Users &amp; Connections page of the SnapTrade Dashboard.  User and connection counts are cached for up to 5 minutes. Connected asset values come from a snapshot calculated once a day; &#x60;assets_under_management_calculated_at&#x60; indicates when it was last calculated. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :currency ISO 4217 currency code to express connected asset values in. Defaults to `USD`.
+    # @return [Array<(PartnerStats, Integer, Hash)>] PartnerStats data, response status code and response headers
+    private def get_stats_legacy_with_http_info_impl(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ManagementApi.get_stats_legacy ...'
+      end
+      # resource path
+      local_var_path = '/snapTrade/stats'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'currency'] = opts[:'currency'] if !opts[:'currency'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PartnerStats'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
+
+      new_options = opts.merge(
+        :operation => :"ManagementApi.get_stats_legacy",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ManagementApi#get_stats_legacy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
   end
 
   # top-level client access to avoid having the user to insantiate their own API instances

data/lib/snaptrade/models/account_balances_v2_response.rb

@@ -24,7 +24,7 @@ module SnapTrade
     # Cash held in the account, one entry per currency. Some institutions allow holding multiple currencies in the same account.
     attr_accessor :cash
 
-    # How much the account can spend on new purchases, one entry per currency. Amounts are in different currencies and shouldn't be added together. Null when it can't be determined. - **Cash accounts:** one entry per currency held, never more than the cash in that currency. Each entry is the settled cash available to spend in that currency where the institution reports it; otherwise it's the institution's buying power or cash, which may include proceeds from trades that haven't settled. Check `basis`. - **Margin accounts:** usually a single entry: the institution's buying power for positions held overnight, based on the account's total equity. Buying power for trades opened and closed on the same day can be higher and isn't included. 
+    # How much the account can spend on new purchases, one entry per currency. Amounts are in different currencies and shouldn't be added together. Null when it can't be determined. - **Cash accounts:** one entry per currency held, never more than the cash in that currency. Each entry is the settled cash available to spend in that currency where the institution reports it; otherwise it's the institution's buying power or cash, which may include proceeds from trades that haven't settled. Check `basis`. - **Margin accounts:** a single entry with the institution's buying power, typically its overnight figure (day-trading buying power isn't included). How it's calculated varies by institution, it can be negative, and it may not cover options or other non-marginable securities. 
     attr_accessor :buying_power
 
     attr_accessor :margin

data/lib/snaptrade/models/account_balances_v2_response_margin.rb

@@ -13,7 +13,7 @@ require 'time'
 module SnapTrade
   # Margin details. Null when `cash_or_margin` is `cash`; present for `margin` and `unknown` accounts.
   class AccountBalancesV2ResponseMargin
-    # The margin debit the institution is charging interest on, one entry per currency owed, as positive amounts. Debits in different currencies are listed separately and are never netted against cash in another currency, because institutions charge interest on each currency's debit.  An empty list means the account isn't borrowing. Null when the institution doesn't report it. 
+    # The margin debit the institution is charging interest on, one entry per currency owed, as positive amounts. Debits in different currencies are listed separately and are never netted against cash in another currency, because institutions charge interest on each currency's debit.  An empty list means the account isn't borrowing. Debits under 0.01 are left out as rounding leftovers. Null when the institution doesn't report it. 
     attr_accessor :loan_balances
 
     # Attribute mapping from ruby-style variable name to JSON key.