snaptrade 1.17.4 → 1.17.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ee1e44cc2bde366d7731faac581c68b517af3621461ab2a0953c9f2b0a4a6ec
-  data.tar.gz: dd2db85f3b6c31d935d5ef6411025e7a8c4139bcbf0701603f51ff2a34074706
+  metadata.gz: a1819cd355ee52f0df86d45d381e9eb2c4fac4db67e1f387077217b6292a7ce4
+  data.tar.gz: 6098b1f89a59f9665eefbbc26cb13f697eb84b918ccdd82d49a11a5efd9270fa
 SHA512:
-  metadata.gz: 2379e02876c21f12630d35108960f22b988f2c9d5eb13211f4811d5106eda52132a8bf168e529cbe1dcb0b8f8395b96c4a36a9b8b31a65b5ad8cd5453cc4eead
-  data.tar.gz: 2eed9e6b4512eb372a4fa1c0d554ba4664b02d069404275393b88f6ee3956de4624a15541749d0f3fc4e76120bcf6953e8b97713cafe9632955db2c7f33f3494
+  metadata.gz: 66cca49a69c1157dfa9f6f0578cb1a6900e2f1e0b28e7918756c10fdfc4ec231d0ce637c31acf1d4e35e4cf40ed57444c95f4534cbee8a06250a9b0f731605ee
+  data.tar.gz: 77b5bf192f667d6613ecc530a3e06a9422d85a88f14ce728165bd352fc1f456caf3068aa0b5aec772f9d3fe1095b145e881eab0b0564ac7ffd2482b8b9a4488f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (1.17.3)
+    snaptrade (1.17.5)
       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.17.4'
+gem 'snaptrade', '~> 1.17.5'
 ```
 
 ## Getting Started
@@ -46,7 +46,7 @@ Class | Method | HTTP request | Description
 *SnapTrade::AccountInformationApi* | [**get_all_user_holdings**](docs/AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account.
 *SnapTrade::AccountInformationApi* | [**get_user_account_balance**](docs/AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | List account balances
 *SnapTrade::AccountInformationApi* | [**get_user_account_details**](docs/AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account
-*SnapTrade::AccountInformationApi* | [**get_user_account_orders**](docs/AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get history of orders placed in account
+*SnapTrade::AccountInformationApi* | [**get_user_account_orders**](docs/AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | List account orders
 *SnapTrade::AccountInformationApi* | [**get_user_account_positions**](docs/AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions
 *SnapTrade::AccountInformationApi* | [**get_user_holdings**](docs/AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account
 *SnapTrade::AccountInformationApi* | [**list_user_accounts**](docs/AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts

data/docs/AccountInformationApi.md

@@ -7,7 +7,7 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
 | [**get_all_user_holdings**](AccountInformationApi.md#get_all_user_holdings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account. |
 | [**get_user_account_balance**](AccountInformationApi.md#get_user_account_balance) | **GET** /accounts/{accountId}/balances | List account balances |
 | [**get_user_account_details**](AccountInformationApi.md#get_user_account_details) | **GET** /accounts/{accountId} | Return details of a specific investment account |
-| [**get_user_account_orders**](AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | Get history of orders placed in account |
+| [**get_user_account_orders**](AccountInformationApi.md#get_user_account_orders) | **GET** /accounts/{accountId}/orders | List account orders |
 | [**get_user_account_positions**](AccountInformationApi.md#get_user_account_positions) | **GET** /accounts/{accountId}/positions | List account positions |
 | [**get_user_holdings**](AccountInformationApi.md#get_user_holdings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account |
 | [**list_user_accounts**](AccountInformationApi.md#list_user_accounts) | **GET** /accounts | List accounts |
@@ -212,7 +212,7 @@ end
 
 ## get_user_account_orders
 
-Get history of orders placed in account
+List account orders
 
 Fetch all recent orders from a user's account.
 
@@ -228,14 +228,16 @@ user_id = "John.doe@snaptrade.com"
 user_secret = "USERSECRET123"
 account_id = "accountId_example"
 state = "all"
+days = 30
 
 begin
-  # Get history of orders placed in account
+  # List account orders
   result = SnapTrade::AccountInformation.get_user_account_orders(
                                                                     user_id: user_id,
                                                                     user_secret: user_secret,
                                                                     account_id: account_id,
                                                                     state: state,
+                                                                    days: days,
                                                                   )
   p result
 rescue SnapTrade::ApiError => e
@@ -252,14 +254,16 @@ user_id = "John.doe@snaptrade.com"
 user_secret = "USERSECRET123"
 account_id = "accountId_example"
 state = "all"
+days = 30
 
 begin
-  # Get history of orders placed in account
+  # List account orders
   data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_orders_with_http_info(
                                                                                                                  user_id: user_id,
                                                                                                                  user_secret: user_secret,
                                                                                                                  account_id: account_id,
                                                                                                                  state: state,
+                                                                                                                 days: days,
                                                                                                                )
   p status_code # => 2xx
   p headers # => { ... }
@@ -277,6 +281,7 @@ end
 | **user_secret** | **String** |  |  |
 | **account_id** | **String** | The ID of the account to get orders. |  |
 | **state** | **String** | defaults value is set to \"all\" | [optional] |
+| **days** | **Integer** | Number of days in the past to fetch the most recent orders. Defaults to the last 90 days if no value is passed in. | [optional] |
 
 ### Return type
 

data/lib/snaptrade/api/account_information_api.rb

@@ -306,51 +306,57 @@ module SnapTrade
     end
 
 
-    # Get history of orders placed in account
+    # List account orders
     # Fetch all recent orders from a user's account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get orders.
     # @param state [String] defaults value is set to \"all\"
+    # @param days [Integer] Number of days in the past to fetch the most recent orders. Defaults to the last 90 days if no value is passed in.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_user_account_orders(user_id:, user_secret:, account_id:, state: SENTINEL, extra: {})
+    def get_user_account_orders(user_id:, user_secret:, account_id:, state: SENTINEL, days: SENTINEL, extra: {})
       extra[:state] = state if state != SENTINEL
+      extra[:days] = days if days != SENTINEL
       data, _status_code, _headers = get_user_account_orders_with_http_info_impl(user_id, user_secret, account_id, extra)
       data
     end
 
-    # Get history of orders placed in account
+    # List account orders
     # Fetch all recent orders from a user's account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get orders.
     # @param state [String] defaults value is set to \"all\"
+    # @param days [Integer] Number of days in the past to fetch the most recent orders. Defaults to the last 90 days if no value is passed in.
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def get_user_account_orders_with_http_info(user_id:, user_secret:, account_id:, state: SENTINEL, extra: {})
+    def get_user_account_orders_with_http_info(user_id:, user_secret:, account_id:, state: SENTINEL, days: SENTINEL, extra: {})
       extra[:state] = state if state != SENTINEL
+      extra[:days] = days if days != SENTINEL
       get_user_account_orders_with_http_info_impl(user_id, user_secret, account_id, extra)
     end
 
-    # Get history of orders placed in account
+    # List account orders
     # Fetch all recent orders from a user's account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get orders.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :state defaults value is set to \"all\"
+    # @option opts [Integer] :days Number of days in the past to fetch the most recent orders. Defaults to the last 90 days if no value is passed in.
     # @return [Array<AccountOrderRecord>]
     def get_user_account_orders_impl(user_id, user_secret, account_id, opts = {})
       data, _status_code, _headers = get_user_account_orders_with_http_info(user_id, user_secret, account_id, opts)
       data
     end
 
-    # Get history of orders placed in account
+    # List account orders
     # Fetch all recent orders from a user&#39;s account.
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account to get orders.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :state defaults value is set to \&quot;all\&quot;
+    # @option opts [Integer] :days Number of days in the past to fetch the most recent orders. Defaults to the last 90 days if no value is passed in.
     # @return [Array<(Array<AccountOrderRecord>, Integer, Hash)>] Array<AccountOrderRecord> data, response status code and response headers
     def get_user_account_orders_with_http_info_impl(user_id, user_secret, account_id, opts = {})
       if @api_client.config.debugging
@@ -372,6 +378,10 @@ module SnapTrade
       if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
         fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
       end
+      if @api_client.config.client_side_validation && !opts[:'days'].nil? && opts[:'days'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"days"]" when calling AccountInformationApi.get_user_account_orders, must be greater than or equal to 1.'
+      end
+
       # resource path
       local_var_path = '/accounts/{accountId}/orders'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
 
@@ -380,6 +390,7 @@ module SnapTrade
       query_params[:'userId'] = user_id
       query_params[:'userSecret'] = user_secret
       query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
+      query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -69,13 +69,14 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for get_user_account_orders
-  # Get history of orders placed in account
+  # List account orders
   # Fetch all recent orders from a user's account.
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account to get orders.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :state defaults value is set to \"all\"
+  # @option opts [Integer] :days Number of days in the past to fetch the most recent orders. Defaults to the last 90 days if no value is passed in.
   # @return [Array<AccountOrderRecord>]
   describe 'get_user_account_orders test' do
     it 'should work' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 1.17.4
+  version: 1.17.5
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday