snaptrade 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee5bb7dcd483b7d6146c4f38ceecaeca2e91a84f25b963c96377f176a1a1393b
-  data.tar.gz: 9f3e145e8c2fff39506177a6fa00c46ebf263e7f7146dfce78be652db7a3a0e2
+  metadata.gz: 66efbd22c5142befa0a2988eca9c54f59bba7beaf50b40cfa89a652666d98d1b
+  data.tar.gz: c477f1fc485265cf76abd8300fdf8bec60d9cae766e3ab05327c398bb235e688
 SHA512:
-  metadata.gz: 976c0c9a2d97b4ee2171b8246a475b72f9886dd96faf722ca13d491ef9911deef537169f59462908526306f5918a72bbbafdd2bd85c177bbe7e5188830688421
-  data.tar.gz: 9ba4c8a7e0ff1068fa7ef828388c34d7d1f619e901693555732e7f22336acef302ebd01555907859c7c264d0c61d72ad862d61703c7ac13af3a3ab28f8839289
+  metadata.gz: 0f65cf6485c1403e25e03d7b63daff0773f04b41eae32310907d75a49bd0aa505d01e9b38597b6d8e1afbce416db1151125449f8af6c2568cfee68619a5af8c3
+  data.tar.gz: 27a214593021f3c1a4b6072889fca143dae46706a7845c750a1d6f7176a6c620eadc9a408581f08988d3bcbb628d22fc1cce98e1907f3636de8cebcfd5accc2c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snaptrade (1.15.0)
+    snaptrade (1.16.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.15.0'
+gem 'snaptrade', '~> 1.16.0'
 ```
 
 ## 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 all history of orders placed in 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_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 all history of orders placed in 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_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 |
@@ -210,7 +210,7 @@ end
 
 ## get_user_account_orders
 
-Get all history of orders placed in account
+Get history of orders placed in account
 
 ### Example
 
@@ -226,7 +226,7 @@ account_id = "accountId_example"
 state = "all"
 
 begin
-  # Get all history of orders placed in account
+  # Get history of orders placed in account
   result = SnapTrade::AccountInformation.get_user_account_orders(
     user_id: user_id,
     user_secret: user_secret,
@@ -250,7 +250,7 @@ account_id = "accountId_example"
 state = "all"
 
 begin
-  # Get all history of orders placed in account
+  # Get history of orders placed in account
   data, status_code, headers, response = SnapTrade::AccountInformation.get_user_account_orders_with_http_info(
     user_id: user_id,
     user_secret: user_secret,

data/docs/UniversalActivity.md

@@ -10,6 +10,7 @@
 | **currency** | [**Currency**](Currency.md) |  | [optional] |
 | **description** | **String** |  | [optional] |
 | **fee** | **Float** |  | [optional] |
+| **fx_rate** | **Float** | The forex conversion rate involved in the transaction if provided by the brokerage | [optional] |
 | **institution** | **String** |  | [optional] |
 | **option_type** | **String** | If an option transaction, then it's type (BUY_TO_OPEN, SELL_TO_CLOSE, etc), otherwise empty string | [optional] |
 | **price** | **Float** |  | [optional] |
@@ -33,6 +34,7 @@ instance = SnapTrade::UniversalActivity.new(
   currency: null,
   description: WALT DISNEY UNIT DIST ON 21 SHS REC 12/31/21 PAY 01/06/22,
   fee: 0,
+  fx_rate: 1.032,
   institution: SnapTrade Investr,
   option_type: BUY_TO_OPEN,
   price: 0.4,

data/lib/snaptrade/api/account_information_api.rb

@@ -308,7 +308,7 @@ module SnapTrade
     end
 
 
-    # Get all history of orders placed in account
+    # Get history of orders placed in account
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account get positions.
@@ -321,7 +321,7 @@ module SnapTrade
       data
     end
 
-    # Get all history of orders placed in account
+    # Get history of orders placed in account
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account get positions.
@@ -333,7 +333,7 @@ module SnapTrade
       get_user_account_orders_with_http_info_impl(user_id, user_secret, account_id, extra)
     end
 
-    # Get all history of orders placed in account
+    # Get history of orders placed in account
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account get positions.
@@ -345,7 +345,7 @@ module SnapTrade
       data
     end
 
-    # Get all history of orders placed in account
+    # Get history of orders placed in account
     # @param user_id [String] 
     # @param user_secret [String] 
     # @param account_id [String] The ID of the account get positions.

data/lib/snaptrade/models/universal_activity.rb

@@ -26,6 +26,9 @@ module SnapTrade
 
     attr_accessor :fee
 
+    # The forex conversion rate involved in the transaction if provided by the brokerage
+    attr_accessor :fx_rate
+
     attr_accessor :institution
 
     # If an option transaction, then it's type (BUY_TO_OPEN, SELL_TO_CLOSE, etc), otherwise empty string
@@ -59,6 +62,7 @@ module SnapTrade
         :'currency' => :'currency',
         :'description' => :'description',
         :'fee' => :'fee',
+        :'fx_rate' => :'fx_rate',
         :'institution' => :'institution',
         :'option_type' => :'option_type',
         :'price' => :'price',
@@ -86,6 +90,7 @@ module SnapTrade
         :'currency' => :'Currency',
         :'description' => :'String',
         :'fee' => :'Float',
+        :'fx_rate' => :'Float',
         :'institution' => :'String',
         :'option_type' => :'String',
         :'price' => :'Float',
@@ -103,6 +108,7 @@ module SnapTrade
     def self.openapi_nullable
       Set.new([
         :'amount',
+        :'fx_rate',
         :'external_reference_id',
         :'trade_date',
       ])
@@ -147,6 +153,10 @@ module SnapTrade
         self.fee = attributes[:'fee']
       end
 
+      if attributes.key?(:'fx_rate')
+        self.fx_rate = attributes[:'fx_rate']
+      end
+
       if attributes.key?(:'institution')
         self.institution = attributes[:'institution']
       end
@@ -212,6 +222,7 @@ module SnapTrade
           currency == o.currency &&
           description == o.description &&
           fee == o.fee &&
+          fx_rate == o.fx_rate &&
           institution == o.institution &&
           option_type == o.option_type &&
           price == o.price &&
@@ -233,7 +244,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, account, amount, currency, description, fee, institution, option_type, price, settlement_date, external_reference_id, symbol, option_symbol, trade_date, type, units].hash
+      [id, account, amount, currency, description, fee, fx_rate, institution, option_type, price, settlement_date, external_reference_id, symbol, option_symbol, trade_date, type, units].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/version.rb

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

data/spec/api/account_information_api_spec.rb

@@ -68,7 +68,7 @@ describe 'AccountInformationApi' do
   end
 
   # unit tests for get_user_account_orders
-  # Get all history of orders placed in account
+  # Get history of orders placed in account
   # @param user_id 
   # @param user_secret 
   # @param account_id The ID of the account get positions.

data/spec/models/universal_activity_spec.rb

@@ -57,6 +57,12 @@ describe SnapTrade::UniversalActivity do
     end
   end
 
+  describe 'test attribute "fx_rate"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "institution"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaptrade
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - SnapTrade
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday