snaptrade 2.0.43 → 2.0.44

Sign up to get free protection for your applications and to get access to all the features.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +7 -4
  4. data/lib/snaptrade/api/transactions_and_reporting_api.rb +4 -4
  5. data/lib/snaptrade/models/universal_activity.rb +1 -1
  6. data/lib/snaptrade/version.rb +1 -1
  7. data/spec/api/transactions_and_reporting_api_spec.rb +1 -1
  8. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 23a2e3fed05b3c17d3f7ab8dac5541766ba2a112c6d1f14ac5e4f0f9b2ed5c29
4
- data.tar.gz: 609e612c05e085c990ef3bfe195d62eb9849111a409c85e0b8c58f50760c9947
3
+ metadata.gz: 0d8f0b8a1363f9c2578f1cf5d43ba3a892cf2fa147f76637a184a1248e4ca31e
4
+ data.tar.gz: 0cf96b9380ece2e60b9c7acb2fe0d5fbc49f3fd5d536194b13c8352f2bf62160
5
5
  SHA512:
6
- metadata.gz: 7badc683104a2fe4bc32db98ae561c2865433d4fc861d3c0b73420f850757a4cecdb5fb4be78f7efdbe1bcea1839437e9c05e3f9446eeef6d9dde879ed5ab7af
7
- data.tar.gz: 3277c3fc4f7367d6f55c699dbd27bc7abfc0b71ff67a4af619eee0ffbef9801d5805c04af1aa252d8cda41f89199b5ca7bd257eab0ed18d3ec3df5be081db038
6
+ metadata.gz: 990eead66b72fd6c5381f955e7ebfb7559e63f1eeed4576bab7d886d298796dfec308e407c71800393d9acf76a75bd64bc98d23de4b6396630db1e245d7b13d0
7
+ data.tar.gz: 5fd1dfda03290175a8cf0666565070a7c4248224f543b8bd9f7abd0a3788fd86fff84d91a813998da2b1a9a249762be19f6f78b0112eec56c2dc15b5e481f49d
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- snaptrade (2.0.43)
4
+ snaptrade (2.0.44)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
@@ -51,7 +51,7 @@ GEM
51
51
  rspec-mocks (~> 3.13.0)
52
52
  rspec-core (3.13.1)
53
53
  rspec-support (~> 3.13.0)
54
- rspec-expectations (3.13.2)
54
+ rspec-expectations (3.13.3)
55
55
  diff-lcs (>= 1.2.0, < 2.0)
56
56
  rspec-support (~> 3.13.0)
57
57
  rspec-mocks (3.13.1)
data/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Connect brokerage accounts to your app for live positions and trading
8
8
 
9
- [![npm](https://img.shields.io/badge/gem-v2.0.43-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.43)
9
+ [![npm](https://img.shields.io/badge/gem-v2.0.44-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.44)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -70,7 +70,7 @@ Connect brokerage accounts to your app for live positions and trading
70
70
  Add to Gemfile:
71
71
 
72
72
  ```ruby
73
- gem 'snaptrade', '~> 2.0.43'
73
+ gem 'snaptrade', '~> 2.0.44'
74
74
  ```
75
75
 
76
76
  ## Getting Started<a id="getting-started"></a>
@@ -1697,8 +1697,11 @@ parameter takes precedence over the `accounts` parameter.
1697
1697
  ##### type: `String`<a id="type-string"></a>
1698
1698
  Optional comma separated list of transaction types to filter by. SnapTrade does
1699
1699
  a best effort to categorize brokerage transaction types into a common set of
1700
- values. Here are some of the most popular values: - BUY - SELL - DIVIDEND -
1701
- CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
1700
+ values. Here are some of the most popular values: - `BUY` - Asset bought. -
1701
+ `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash
1702
+ contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment.
1703
+ - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from
1704
+ the account.
1702
1705
 
1703
1706
  #### 🔄 Return<a id="🔄-return"></a>
1704
1707
 
data/lib/snaptrade/api/transactions_and_reporting_api.rb CHANGED
@@ -31,7 +31,7 @@ module SnapTrade
31
31
  # @param end_date [Date] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
32
32
  # @param accounts [String] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
33
33
  # @param brokerage_authorizations [String] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
34
- # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
34
+ # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account.
35
35
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
36
36
  def get_activities(user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, accounts: SENTINEL, brokerage_authorizations: SENTINEL, type: SENTINEL, extra: {})
37
37
  extra[:start_date] = start_date if start_date != SENTINEL
@@ -57,7 +57,7 @@ module SnapTrade
57
57
  # @param end_date [Date] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
58
58
  # @param accounts [String] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
59
59
  # @param brokerage_authorizations [String] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
60
- # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
60
+ # @param type [String] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account.
61
61
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
62
62
  def get_activities_with_http_info(user_id:, user_secret:, start_date: SENTINEL, end_date: SENTINEL, accounts: SENTINEL, brokerage_authorizations: SENTINEL, type: SENTINEL, extra: {})
63
63
  extra[:start_date] = start_date if start_date != SENTINEL
@@ -77,7 +77,7 @@ module SnapTrade
77
77
  # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
78
78
  # @option opts [String] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
79
79
  # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
80
- # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
80
+ # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account.
81
81
  # @return [Array<UniversalActivity>]
82
82
  private def get_activities_impl(user_id, user_secret, opts = {})
83
83
  data, _status_code, _headers = get_activities_with_http_info(user_id, user_secret, opts)
@@ -93,7 +93,7 @@ module SnapTrade
93
93
  # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
94
94
  # @option opts [String] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
95
95
  # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
96
- # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
96
+ # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account.
97
97
  # @return [Array<(Array<UniversalActivity>, Integer, Hash)>] Array<UniversalActivity> data, response status code and response headers
98
98
  private def get_activities_with_http_info_impl(user_id, user_secret, opts = {})
99
99
  if @api_client.config.debugging
data/lib/snaptrade/models/universal_activity.rb CHANGED
@@ -33,7 +33,7 @@ module SnapTrade
33
33
 
34
34
  attr_accessor :currency
35
35
 
36
- # A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
36
+ # A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account.
37
37
  attr_accessor :type
38
38
 
39
39
  # If an option `BUY` or `SELL` transaction, this further specifies the type of action. The possible values are: - BUY_TO_OPEN - BUY_TO_CLOSE - SELL_TO_OPEN - SELL_TO_CLOSE
data/lib/snaptrade/version.rb CHANGED
@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
8
8
  =end
9
9
 
10
10
  module SnapTrade
11
- VERSION = '2.0.43'
11
+ VERSION = '2.0.44'
12
12
  end
data/spec/api/transactions_and_reporting_api_spec.rb CHANGED
@@ -37,7 +37,7 @@ describe 'TransactionsAndReportingApi' do
37
37
  # @option opts [Date] :end_date The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on &#x60;trade_date&#x60;.
38
38
  # @option opts [String] :accounts Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The &#x60;brokerageAuthorizations&#x60; parameter takes precedence over this parameter.
39
39
  # @option opts [String] :brokerage_authorizations Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the &#x60;accounts&#x60; parameter.
40
- # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - BUY - SELL - DIVIDEND - CONTRIBUTION - WITHDRAWAL - REI - INTEREST - FEE
40
+ # @option opts [String] :type Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - &#x60;BUY&#x60; - Asset bought. - &#x60;SELL&#x60; - Asset sold. - &#x60;DIVIDEND&#x60; - Dividend payout. - &#x60;CONTRIBUTION&#x60; - Cash contribution. - &#x60;WITHDRAWAL&#x60; - Cash withdrawal. - &#x60;REI&#x60; - Dividend reinvestment. - &#x60;INTEREST&#x60; - Interest deposited into the account. - &#x60;FEE&#x60; - Fee withdrawn from the account.
41
41
  # @return [Array<UniversalActivity>]
42
42
  describe 'get_activities test' do
43
43
  it 'should work' do
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: snaptrade
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.43
4
+ version: 2.0.44
5
5
  platform: ruby
6
6
  authors:
7
7
  - SnapTrade
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-09-05 00:00:00.000000000 Z
11
+ date: 2024-09-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday