snaptrade 2.0.74 → 2.0.76

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 10510d1b0e28e82d9e28b3736e5c54a65a388dd809320e1f2d42b9dd729ee0ac
4
- data.tar.gz: a758897cb02823c1edbd25eac795d1affda2e56f56a245e745c3fa9fe5bff7d7
3
+ metadata.gz: 3749026228728a05a08bfbf7657726a116ea744200748c25230a571f3effa668
4
+ data.tar.gz: 622ba6546c2dd261e9e5710d9af5d0501b97a3fbe02aafb6d62df051de960775
5
5
  SHA512:
6
- metadata.gz: 4ffdcd5168be3bbe67c5482bf430ba73466d1f253aa7384dd1abbd65e94362f9c8c4615ce1053a7d5528602c3f2874be38c895bab232b1fab60c3b6ef6c43c31
7
- data.tar.gz: 5c4944425a9384ac96fea0afbbc1c3e35b6d6c32d97b60e3d887416f56227979f4217901c4a3d9bcfa779509d8ac10cd2856c6c322716cfa32c29381123c2481
6
+ metadata.gz: f013fc15f8a665e1690019a7baffa67d590730e571083b67dd62d54bab95a31d7ce6204d732ac28851e0c3799a6d2eb8cc6ea8f4cf0c9cdba12dde48fbf02192
7
+ data.tar.gz: 9148b5b882a788096f01d09213d42b6f0751a84632564cb021c961d8d1a8a8ab49e993a8ed07e90a1d4d954fa8b0862b2c2bfaf4ab7708fcee0061d8f5ad11af
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- snaptrade (2.0.74)
4
+ snaptrade (2.0.76)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
@@ -29,7 +29,7 @@ GEM
29
29
  method_source (1.1.0)
30
30
  multipart-post (2.4.1)
31
31
  parallel (1.26.3)
32
- parser (3.3.7.0)
32
+ parser (3.3.7.1)
33
33
  ast (~> 2.4.1)
34
34
  racc
35
35
  pry (0.14.2)
@@ -49,7 +49,7 @@ GEM
49
49
  rspec-core (~> 3.13.0)
50
50
  rspec-expectations (~> 3.13.0)
51
51
  rspec-mocks (~> 3.13.0)
52
- rspec-core (3.13.2)
52
+ rspec-core (3.13.3)
53
53
  rspec-support (~> 3.13.0)
54
54
  rspec-expectations (3.13.3)
55
55
  diff-lcs (>= 1.2.0, < 2.0)
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.74-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.74)
9
+ [![npm](https://img.shields.io/badge/gem-v2.0.76-blue)](https://rubygems.org/gems/snaptrade/versions/2.0.76)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -74,7 +74,7 @@ Connect brokerage accounts to your app for live positions and trading
74
74
  Add to Gemfile:
75
75
 
76
76
  ```ruby
77
- gem 'snaptrade', '~> 2.0.74'
77
+ gem 'snaptrade', '~> 2.0.76'
78
78
  ```
79
79
 
80
80
  ## Getting Started<a id="getting-started"></a>
@@ -114,7 +114,7 @@ result = snaptrade.account_information.get_account_activities_with_http_info(
114
114
  limit: 1,
115
115
  type: "BUY,SELL,DIVIDEND",
116
116
  )
117
- p result[0] # [Array<PaginatedUniversalActivity>] Deserialized data
117
+ p result[0] # [PaginatedUniversalActivity] Deserialized data
118
118
  p.result[1] # [Integer] HTTP status code
119
119
  p.result[2] # [Hash] HTTP headers
120
120
  p.result[3] # [Faraday::Response] Raw HTTP response
@@ -127,7 +127,7 @@ p.result[3] # [Faraday::Response] Raw HTTP response
127
127
 
128
128
  Returns all historical transactions for the specified account.
129
129
 
130
- This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
130
+ This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
131
131
 
132
132
  Transaction are returned in reverse chronological order, using the `trade_date` field.
133
133
 
@@ -21,7 +21,7 @@ module SnapTrade
21
21
  #
22
22
  # Returns all historical transactions for the specified account.
23
23
  #
24
- # This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
24
+ # This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
25
25
  #
26
26
  # Transaction are returned in reverse chronological order, using the `trade_date` field.
27
27
  #
@@ -50,7 +50,7 @@ module SnapTrade
50
50
  #
51
51
  # Returns all historical transactions for the specified account.
52
52
  #
53
- # This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
53
+ # This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
54
54
  #
55
55
  # Transaction are returned in reverse chronological order, using the `trade_date` field.
56
56
  #
@@ -75,7 +75,7 @@ module SnapTrade
75
75
  end
76
76
 
77
77
  # List account activities
78
- # Returns all historical transactions for the specified account. This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. The data returned here is always cached and refreshed once a day.
78
+ # Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. The data returned here is always cached and refreshed once a day.
79
79
  # @param account_id [String]
80
80
  # @param user_id [String]
81
81
  # @param user_secret [String]
@@ -85,14 +85,14 @@ module SnapTrade
85
85
  # @option opts [Integer] :offset An integer that specifies the starting point of the paginated results. Default is 0.
86
86
  # @option opts [Integer] :limit An integer that specifies the maximum number of transactions to return. Default of 1000.
87
87
  # @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. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another
88
- # @return [Array<PaginatedUniversalActivity>]
88
+ # @return [PaginatedUniversalActivity]
89
89
  private def get_account_activities_impl(account_id, user_id, user_secret, opts = {})
90
90
  data, _status_code, _headers = get_account_activities_with_http_info(account_id, user_id, user_secret, opts)
91
91
  data
92
92
  end
93
93
 
94
94
  # List account activities
95
- # Returns all historical transactions for the specified account. This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the &#x60;trade_date&#x60; field. The data returned here is always cached and refreshed once a day.
95
+ # Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the &#x60;trade_date&#x60; field. The data returned here is always cached and refreshed once a day.
96
96
  # @param account_id [String]
97
97
  # @param user_id [String]
98
98
  # @param user_secret [String]
@@ -102,7 +102,7 @@ module SnapTrade
102
102
  # @option opts [Integer] :offset An integer that specifies the starting point of the paginated results. Default is 0.
103
103
  # @option opts [Integer] :limit An integer that specifies the maximum number of transactions to return. Default of 1000.
104
104
  # @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. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another
105
- # @return [Array<(Array<PaginatedUniversalActivity>, Integer, Hash)>] Array<PaginatedUniversalActivity> data, response status code and response headers
105
+ # @return [Array<(PaginatedUniversalActivity, Integer, Hash)>] PaginatedUniversalActivity data, response status code and response headers
106
106
  private def get_account_activities_with_http_info_impl(account_id, user_id, user_secret, opts = {})
107
107
  if @api_client.config.debugging
108
108
  @api_client.config.logger.debug 'Calling API: AccountInformationApi.get_account_activities ...'
@@ -152,7 +152,7 @@ module SnapTrade
152
152
  post_body = opts[:debug_body]
153
153
 
154
154
  # return_type
155
- return_type = opts[:debug_return_type] || 'Array<PaginatedUniversalActivity>'
155
+ return_type = opts[:debug_return_type] || 'PaginatedUniversalActivity'
156
156
 
157
157
  # auth_names
158
158
  auth_names = opts[:debug_auth_names] || ['PartnerClientId', 'PartnerSignature', 'PartnerTimestamp']
@@ -8,5 +8,5 @@ Contact: api@snaptrade.com
8
8
  =end
9
9
 
10
10
  module SnapTrade
11
- VERSION = '2.0.74'
11
+ VERSION = '2.0.76'
12
12
  end
@@ -29,7 +29,7 @@ describe 'AccountInformationApi' do
29
29
 
30
30
  # unit tests for get_account_activities
31
31
  # List account activities
32
- # Returns all historical transactions for the specified account. This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the &#x60;trade_date&#x60; field. The data returned here is always cached and refreshed once a day.
32
+ # Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the &#x60;trade_date&#x60; field. The data returned here is always cached and refreshed once a day.
33
33
  # @param account_id
34
34
  # @param user_id
35
35
  # @param user_secret
@@ -39,7 +39,7 @@ describe 'AccountInformationApi' do
39
39
  # @option opts [Integer] :offset An integer that specifies the starting point of the paginated results. Default is 0.
40
40
  # @option opts [Integer] :limit An integer that specifies the maximum number of transactions to return. Default of 1000.
41
41
  # @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. - &#x60;OPTIONEXPIRATION&#x60; - Option expiration event. - &#x60;OPTIONASSIGNMENT&#x60; - Option assignment event. - &#x60;OPTIONEXERCISE&#x60; - Option exercise event. - &#x60;TRANSFER&#x60; - Transfer of assets from one account to another
42
- # @return [Array<PaginatedUniversalActivity>]
42
+ # @return [PaginatedUniversalActivity]
43
43
  describe 'get_account_activities test' do
44
44
  it 'should work' do
45
45
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
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.74
4
+ version: 2.0.76
5
5
  platform: ruby
6
6
  authors:
7
7
  - SnapTrade
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-02-03 00:00:00.000000000 Z
11
+ date: 2025-02-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday