snaptrade 3.0.24 → 3.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9df4e76cb3da6b488147d7745b180d4d75cab1948235e4ac334ce88965de8e4e
-  data.tar.gz: 7aa57bc8082a53ed75116518580ea3eeff31230e84ab1514b3c0682d6d0569a3
+  metadata.gz: e6d90e855f96cbd008caa69f70d3080bed33318902839e5cc89897ae74bf3fe1
+  data.tar.gz: c4fcc81059b739ad7b7fc3693541cf055f0e50a5e642b58bc8536c23ea198cd4
 SHA512:
-  metadata.gz: 847a600ec41e79537cd2fbeca6a3cd4306679c5164ff2db7b57dcf819cb0fc647ed148ae68abf39649858bc5f0f51f47a91d5fc26ad1d5fbf9637bec5df91328
-  data.tar.gz: dac7c94d335aeaace43faa9cd4f229fa7bd5ff667417df5f5f9ec21b8cf0b948d24d5393ba80e471968857e71000fa28684e3427149cdbc6f7030076e0f96411
+  metadata.gz: 2a7d3d5d00874bdd136950039c86f10b9cafdd8816093ffe40eabdde50e25b3d846c0b8b01931057e4fc1a7352401b69addb917b93a9fc9eb1dd1de2184bba92
+  data.tar.gz: e0490b47de01ce9730a5f8db15ff11f0dac2ca9ace18c27ca356df48aa2a96b4b72507dc42e2bb8a0dc7e872bca4a7f6456b2615c5a91ce87f6f73299fdad36a

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.24-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.24)
+[![npm](https://img.shields.io/badge/gem-v3.0.26-blue)](https://rubygems.org/gems/snaptrade/versions/3.0.26)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -116,6 +116,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
   * [`snaptrade.reference_data.list_all_brokerage_authorization_type`](#snaptradereference_datalist_all_brokerage_authorization_type)
   * [`snaptrade.reference_data.list_all_brokerage_instruments`](#snaptradereference_datalist_all_brokerage_instruments)
   * [`snaptrade.reference_data.list_all_brokerages`](#snaptradereference_datalist_all_brokerages)
+  * [`snaptrade.reference_data.list_institutions`](#snaptradereference_datalist_institutions)
   * [`snaptrade.reference_data.symbol_search_user_account`](#snaptradereference_datasymbol_search_user_account)
   * [`snaptrade.trading.cancel_order`](#snaptradetradingcancel_order)
   * [`snaptrade.trading.get_cryptocurrency_pair_quote`](#snaptradetradingget_cryptocurrency_pair_quote)
@@ -139,7 +140,7 @@ See https://docs.snaptrade.com/docs/ratelimiting.
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 3.0.24'
+gem 'snaptrade', '~> 3.0.26'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -271,7 +272,7 @@ one account to another. - `SPLIT` - A stock share split.
 
 ### `snaptrade.account_information.get_account_balance_history`<a id="snaptradeaccount_informationget_account_balance_history"></a>
 
-An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the Add-on section of the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)
+An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons)
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -563,7 +564,7 @@ false to retrieve non executed orders as well
 
 ### `snaptrade.account_information.get_user_account_return_rates`<a id="snaptradeaccount_informationget_user_account_return_rates"></a>
 
-Returns a list of rate of return percents for a given account.
+DEPRECATED. Returns a list of rate of return percents for a given account.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1219,7 +1220,7 @@ p result
 
 ### `snaptrade.connections.return_rates`<a id="snaptradeconnectionsreturn_rates"></a>
 
-Returns a list of rate of return percents for a given connection.
+DEPRECATED. Returns a list of rate of return percents for a given connection.
 
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -1724,6 +1725,33 @@ p result
 ---
 
 
+### `snaptrade.reference_data.list_institutions`<a id="snaptradereference_datalist_institutions"></a>
+
+Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.
+
+A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don't recognize.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = snaptrade.reference_data.list_institutions
+p result
+```
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[Institution](./lib/snaptrade/models/institution.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/institutions` `GET`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.reference_data.symbol_search_user_account`<a id="snaptradereference_datasymbol_search_user_account"></a>
 
 Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.

data/lib/snaptrade/api/account_information_api.rb

@@ -185,7 +185,7 @@ module SnapTrade
 
     # List historical account total value
     #
-    # An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the Add-on section of the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)
+    # An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons)
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -198,7 +198,7 @@ module SnapTrade
 
     # List historical account total value
     #
-    # An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the Add-on section of the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)
+    # An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons)
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -209,7 +209,7 @@ module SnapTrade
     end
 
     # List historical account total value
-    # An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the Add-on section of the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) 
+    # An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -221,7 +221,7 @@ module SnapTrade
     end
 
     # List historical account total value
-    # An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the Add-on section of the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) 
+    # An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -1030,7 +1030,7 @@ module SnapTrade
 
     # List account rate of returns
     #
-    # Returns a list of rate of return percents for a given account.
+    # DEPRECATED. Returns a list of rate of return percents for a given account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -1045,7 +1045,7 @@ module SnapTrade
 
     # List account rate of returns
     #
-    # Returns a list of rate of return percents for a given account.
+    # DEPRECATED. Returns a list of rate of return percents for a given account.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -1058,7 +1058,7 @@ module SnapTrade
     end
 
     # List account rate of returns
-    # Returns a list of rate of return percents for a given account. 
+    # DEPRECATED. Returns a list of rate of return percents for a given account. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 
@@ -1071,7 +1071,7 @@ module SnapTrade
     end
 
     # List account rate of returns
-    # Returns a list of rate of return percents for a given account. 
+    # DEPRECATED. Returns a list of rate of return percents for a given account. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] 

data/lib/snaptrade/api/connections_api.rb

@@ -782,7 +782,7 @@ module SnapTrade
 
     # List connection rate of returns
     #
-    # Returns a list of rate of return percents for a given connection.
+    # DEPRECATED. Returns a list of rate of return percents for a given connection.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -797,7 +797,7 @@ module SnapTrade
 
     # List connection rate of returns
     #
-    # Returns a list of rate of return percents for a given connection.
+    # DEPRECATED. Returns a list of rate of return percents for a given connection.
     #
     # @param user_id [String] 
     # @param user_secret [String] 
@@ -810,7 +810,7 @@ module SnapTrade
     end
 
     # List connection rate of returns
-    # Returns a list of rate of return percents for a given connection. 
+    # DEPRECATED. Returns a list of rate of return percents for a given connection. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param authorization_id [String] 
@@ -823,7 +823,7 @@ module SnapTrade
     end
 
     # List connection rate of returns
-    # Returns a list of rate of return percents for a given connection. 
+    # DEPRECATED. Returns a list of rate of return percents for a given connection. 
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param authorization_id [String] 

data/lib/snaptrade/api/reference_data_api.rb

@@ -596,6 +596,87 @@ module SnapTrade
     end
 
 
+    # List institutions
+    #
+    # Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.
+    # 
+    # A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don't recognize.
+    #
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def list_institutions(extra: {})
+      data, _status_code, _headers = list_institutions_with_http_info_impl(extra)
+      data
+    end
+
+    # List institutions
+    #
+    # Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.
+    # 
+    # A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don't recognize.
+    #
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def list_institutions_with_http_info(extra: {})
+      list_institutions_with_http_info_impl(extra)
+    end
+
+    # List institutions
+    # Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead.  A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don't recognize. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Institution>]
+    private def list_institutions_impl(opts = {})
+      data, _status_code, _headers = list_institutions_with_http_info(opts)
+      data
+    end
+
+    # List institutions
+    # Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use &#x60;GET /brokerages&#x60; instead.  A &#x60;null&#x60; field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don&#39;t recognize. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Institution>, Integer, Hash)>] Array<Institution> data, response status code and response headers
+    private def list_institutions_with_http_info_impl(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ReferenceDataApi.list_institutions ...'
+      end
+      # resource path
+      local_var_path = '/institutions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'Array<Institution>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ReferenceDataApi.list_institutions",
+        :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: ReferenceDataApi#list_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers, response
+    end
+
+
     # Search account symbols
     #
     # Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.

data/lib/snaptrade/models/brokerage_authorization_data_freshness_mode.rb

@@ -35,7 +35,7 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'institution' => :'Institution',
+        :'institution' => :'BrokerageAuthorizationInstitution',
         :'snaptrade' => :'Snaptrade'
       }
     end

data/lib/snaptrade/models/brokerage_authorization_institution.rb

@@ -0,0 +1,37 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading.  ## Rate limiting  Two limits apply to requests signed with your `clientId`. The stricter one wins, and exceeding either returns `429 Too Many Requests`.  - **Customer-level** — 250 requests/minute by default, scoped to your   `clientId` and applied across all endpoints. Reported in   `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. - **Account-level** — 10 requests/minute per account, scoped to   (`clientId`, `accountId`). All covered operations for one account draw on   the same bucket — reading balances and reading positions share it — and   enforcement does not depend on the HTTP method, so updating an account   consumes the same bucket as reading it. Only enforced for Personal users,   and only for integrations it has been rolled out to — it is not yet in   force for every Personal integration. It also does not apply on every   operation that documents a 429 below. Where it applies it is reported in   `X-RateLimit-Account-Limit`, `X-RateLimit-Account-Remaining` and   `X-RateLimit-Account-Reset`. Do not read the absence of those headers as   proof the limit is off — some configurations omit the rate limit headers   while still enforcing the limit, so header absence tells you nothing   about your allowance.  On a 429, `X-RateLimit-Remaining: 0` means you hit the customer-level limit and `X-RateLimit-Account-Remaining: 0` means the account-level one. Wait for the corresponding `*-Reset` value (seconds) before retrying, or fall back to exponential backoff with jitter.  Not every 429 is explained by those headers. A separate per-authenticated-user limit, reported in no `X-RateLimit-*` header, covers OAuth-authenticated requests and signed requests in configurations where the customer-level limit is not in effect — on the operations that use the default throttles. A few operations override those and are governed by the customer-level limit alone. The two do not stack: a signed request governed by the customer-level limit above is not additionally subject to the per-user one. If a 429 arrives with no header at zero — or with no `X-RateLimit-*` headers at all — honour `Retry-After` and back off. Treat the remaining counts as a hint, not a guarantee that the next request will succeed.  Because the customer-level limit applies everywhere, any signed request can return 429.  **OAuth-authenticated requests are an exception.** They are not subject to the customer-level limit and do not receive `X-RateLimit-Limit`, `X-RateLimit-Remaining` or `X-RateLimit-Reset` — do not wait on those headers or design around a customer-level allowance on this path. The account-level limit still applies to them on the account-data endpoints above, reported in the `X-RateLimit-Account-*` headers. On operations using the default throttles the per-user limit above applies to them as well, so an OAuth request can be rejected while the account headers still show capacity; on the few operations that override those throttles, OAuth callers have no per-user ceiling at all. Drive retries from `Retry-After` and exponential backoff with jitter rather than from the headers.  See https://docs.snaptrade.com/docs/ratelimiting. 
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  class BrokerageAuthorizationInstitution
+    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 BrokerageAuthorizationInstitution.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #BrokerageAuthorizationInstitution"
+    end
+  end
+end