snaptrade 1.10.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9cfe431fd52adac8613ffb6b6c0ac9f099b875aa7995c44dc45f4e64eac2ca8
-  data.tar.gz: 2b42cdfe6a0a081d859353101de245045724b0e6f6afdd3108643f608c2fbbd8
+  metadata.gz: 2d35c598e43136c15bacb0ae8e7735a22e8cba4b7e3b116c375494c7738a332b
+  data.tar.gz: fa5c5fdc708d4947d2ac92461ba8623397bcd81d4b8a7156f6b2d740d74c617c
 SHA512:
-  metadata.gz: 65717c6345160fbfd306fc7ab6c9e4a00fec8ee1185dbeb3a26da5556975a05e9bb0d6efbd88d74e898ef0a1742711e50161bc80d2afb703f1fe1d28465706f2
-  data.tar.gz: 10b451314143cbe8e22ae4164675fe88afa4ee83c5119469627f366f7ac72a7fd8afe60ebb96bea329fc655104dbd15e7b3c28f3fa73aea083191bbab0733333
+  metadata.gz: 4860f8b325a55ae350ba4e1f9e5d219aad96232d521ac1ee73f5b9f147012be15997e0fea884e326817856ed7d8e1f63b6f74216c87626c9196054f89193499a
+  data.tar.gz: c9860eefbdf60793799dbe23e26ae9e7026a0a3823849d44e04f5b021fd3cdc2e9d602b68fb50078c2ecadf15d9d8cd900f5dc148036075c6ec89c189aba02ff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (1.10.0)
+    snaptrade (1.12.0)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -9,7 +9,7 @@ For more information, please visit [https://snaptrade.com/](https://snaptrade.co
 Add to Gemfile:
 
 ```ruby
-gem 'snaptrade', '~> 1.10.0'
+gem 'snaptrade', '~> 1.12.0'
 ```
 
 ## Getting Started

data/docs/OptionsApi.md

@@ -287,7 +287,7 @@ begin
   )
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Array<OptionsHoldings>
+  p data # => Array<OptionsPosition>
 rescue SnapTrade::ApiError => e
   puts "Exception when calling SnapTrade::Options.list_option_holdings: #{e}"
 end
@@ -303,7 +303,7 @@ end
 
 ### Return type
 
-[**Array&lt;OptionsHoldings&gt;**](OptionsHoldings.md)
+[**Array&lt;OptionsPosition&gt;**](OptionsPosition.md)
 
 ## place_option_strategy
 

data/docs/TransactionsAndReportingApi.md

@@ -88,7 +88,7 @@ end
 | **end_date** | **Date** |  | [optional] |
 | **accounts** | **String** | Optional comma seperated list of account IDs used to filter the request on specific accounts | [optional] |
 | **brokerage_authorizations** | **String** | Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations | [optional] |
-| **type** | **String** | Optional comma seperated list of types to filter activities by. 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 | [optional] |
+| **type** | **String** | 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 | [optional] |
 
 ### Return type
 

data/lib/snaptrade/api/options_api.rb

@@ -381,7 +381,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account get positions.
     # @param [Hash] opts the optional parameters
-    # @return [Array<OptionsHoldings>]
+    # @return [Array<OptionsPosition>]
     def list_option_holdings_impl(user_id, user_secret, account_id, opts = {})
       data, _status_code, _headers = list_option_holdings_with_http_info(user_id, user_secret, account_id, opts)
       data
@@ -392,7 +392,7 @@ module SnapTrade
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account get positions.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Array<OptionsHoldings>, Integer, Hash)>] Array<OptionsHoldings> data, response status code and response headers
+    # @return [Array<(Array<OptionsPosition>, Integer, Hash)>] Array<OptionsPosition> data, response status code and response headers
     def list_option_holdings_with_http_info_impl(user_id, user_secret, account_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: OptionsApi.list_option_holdings ...'
@@ -429,7 +429,7 @@ module SnapTrade
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Array<OptionsHoldings>'
+      return_type = opts[:debug_return_type] || 'Array<OptionsPosition>'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']

data/lib/snaptrade/api/transactions_and_reporting_api.rb

@@ -26,7 +26,7 @@ module SnapTrade
     # @param end_date [Date] 
     # @param accounts [String] Optional comma seperated list of account IDs used to filter the request on specific accounts
     # @param brokerage_authorizations [String] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
-    # @param type [String] Optional comma seperated list of types to filter activities by. 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
+    # @param type [String] 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
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_activities(user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, accounts: SENTINEL, brokerage_authorizations: SENTINEL, type: SENTINEL, extra: {})
       extra[:start_date] = start_date if start_date != SENTINEL
@@ -47,7 +47,7 @@ module SnapTrade
     # @param end_date [Date] 
     # @param accounts [String] Optional comma seperated list of account IDs used to filter the request on specific accounts
     # @param brokerage_authorizations [String] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
-    # @param type [String] Optional comma seperated list of types to filter activities by. 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
+    # @param type [String] 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
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def get_activities_with_http_info(user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, accounts: SENTINEL, brokerage_authorizations: SENTINEL, type: SENTINEL, extra: {})
       extra[:start_date] = start_date if start_date != SENTINEL
@@ -68,7 +68,7 @@ module SnapTrade
     # @option opts [Date] :end_date 
     # @option opts [String] :accounts Optional comma seperated list of account IDs used to filter the request on specific accounts
     # @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. 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
+    # @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 = {})
       data, _status_code, _headers = get_activities_with_http_info(user_id, user_secret, opts)
@@ -84,7 +84,7 @@ module SnapTrade
     # @option opts [Date] :end_date 
     # @option opts [String] :accounts Optional comma seperated list of account IDs used to filter the request on specific accounts
     # @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. 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
+    # @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 = {})
       if @api_client.config.debugging

data/lib/snaptrade/version.rb

@@ -9,5 +9,5 @@ Contact: api@snaptrade.com
 =end
 
 module SnapTrade
-  VERSION = '1.10.0'
+  VERSION = '1.12.0'
 end

data/spec/api/options_api_spec.rb

@@ -76,7 +76,7 @@ describe 'OptionsApi' do
   # @param user_secret 
   # @param account_id The ID of the account get positions.
   # @param [Hash] opts the optional parameters
-  # @return [Array<OptionsHoldings>]
+  # @return [Array<OptionsPosition>]
   describe 'list_option_holdings test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/transactions_and_reporting_api_spec.rb

@@ -38,7 +38,7 @@ describe 'TransactionsAndReportingApi' do
   # @option opts [Date] :end_date 
   # @option opts [String] :accounts Optional comma seperated list of account IDs used to filter the request on specific accounts
   # @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. 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
+  # @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>]
   describe 'get_activities test' do
     it 'should work' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.12.0
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-31 00:00:00.000000000 Z
+date: 2023-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday