snaptrade 3.0.42 → 3.0.44

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 259eb257284767acbee75826a15896abc4384d04c19d77eb00c398cba3b423ba
-  data.tar.gz: c845086679b3fb579de413879b24717cc86bb080951e913f5d0eb17fb4165d68
+  metadata.gz: 50b2501e3d9392b7acb54ee9a9f7695f151bd66ce5294c269dda5c0d069019a3
+  data.tar.gz: fc8a7a7ae361a81022f22d06acadebb7852ab7a74d52e299df49c3cf0e338973
 SHA512:
-  metadata.gz: 5ca0512b36e8f1c48643392070042d9b4d21e8776956da342520d95bf50abebd7474fbd7d90804b88d0b7dd9a6d0cc009dc2881f8f73b143a048b6612afdbd7c
-  data.tar.gz: 00471b506ed00b533537ebfc49b22dd740b5261f1673cdd5748aff0de6a21c493bc5218cd55e50f21335f8f317ff8a5f66bd9575211a5470c52cf07df6f55909
+  metadata.gz: 1343586ce71be84d05bb048cce55c96401c48b47d67513feb6eedd04edb8a897b8e317a04a36ec41640daf92fba791ea10416c7c15c1f5ac03ae7df81b3b9ef4
+  data.tar.gz: c199f9fac61a030b683dade5dec570a0b17bbef97deb4bf0991810cbcf4ce2439c3beb41130c36e7790da4ebc9ea4fe120669c123e9d1201a10809df582f6157

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.42-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.42)
+[![npm](https://img.shields.io/badge/gem-v3.0.44-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.44)
 [![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.42'
+gem 'snaptrade', '~> 3.0.44'
 ```
 
 ## 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

@@ -16,15 +16,15 @@ module SnapTrade
     # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
     attr_accessor :account_id
 
-    # Whether the account is a cash or margin account. Same values as `cash_or_margin` on the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint.
+    # Whether the account is a cash or margin account, normalized across institutions. Same values as `cash_or_margin` on the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint. - `cash`: the account can't borrow on margin. - `margin`: the account can borrow on margin. - `unknown`: SnapTrade doesn't have enough information to tell, or the distinction doesn't apply (for example crypto accounts). 
     attr_accessor :cash_or_margin
 
     attr_accessor :net_value
 
-    # Cash held in the account, one entry per currency. Some institutions allow holding multiple currencies in the same account.
+    # Cash held in the account, one entry per currency, as reported by the institution. Some institutions allow holding multiple currencies in the same account. May include proceeds from trades that haven't settled yet. Can be negative, for example on a margin account that is borrowing in a currency.
     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, each covering purchases in that currency and 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 for the whole account, covering purchases in any currency. It's usually in the account's main currency (the currency of `net_value`). It's 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
@@ -55,7 +55,7 @@ module SnapTrade
         :'account_id' => :'String',
         :'cash_or_margin' => :'AccountBalancesV2ResponseCashOrMargin',
         :'net_value' => :'AccountBalancesV2ResponseNetValue',
-        :'cash' => :'Array<AccountBalancesV2ResponseCashInner>',
+        :'cash' => :'Array<BalanceV2CurrencyAmount>',
         :'buying_power' => :'Array<AccountBalancesV2ResponseBuyingPowerInner>',
         :'margin' => :'AccountBalancesV2ResponseMargin',
         :'data_freshness' => :'AccountBalancesV2ResponseDataFreshness'

data/lib/snaptrade/models/account_balances_v2_response_buying_power_inner.rb

@@ -15,7 +15,7 @@ module SnapTrade
     # ISO-4217 currency code.
     attr_accessor :currency
 
-    # Buying power in this currency. Can be negative, for example on a margin account that has exceeded its margin requirement.
+    # Buying power in this currency, rounded to 2 decimal places. Can be negative, for example on a margin account that has exceeded its margin requirement.
     attr_accessor :amount
 
     # What the amount may include. - `settled`: settled cash only. Excludes proceeds from sales that haven't settled and cash already committed to purchases that haven't settled, so spending it won't cause a good-faith violation. - `cash`: may include proceeds from trades that haven't settled. - `margin`: may include money borrowed on margin.  To avoid good-faith violations on cash accounts, only treat the amount as safe to spend when `basis` is `settled`. 

data/lib/snaptrade/models/balance_v2_currency_amount.rb

@@ -15,6 +15,7 @@ module SnapTrade
     # ISO-4217 currency code.
     attr_accessor :currency
 
+    # Rounded to 2 decimal places.
     attr_accessor :amount
 
     # Attribute mapping from ruby-style variable name to JSON key.