snaptrade 2.0.128 → 2.0.129
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 +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +8 -5
- data/lib/snaptrade/api/reference_data_api.rb +15 -15
- data/lib/snaptrade/models/brokerage_instrument.rb +5 -0
- data/lib/snaptrade/version.rb +1 -1
- data/spec/api/reference_data_api_spec.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fec778920b549791f66f45c16297693da67c706839886de97a8fbb522a81b8bf
|
4
|
+
data.tar.gz: 90405fd88ab9edf3b6c27409e5331e40c5722a49abc00384b487832d2240bf2d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fd847e8941992c09c6fbea2a2817ae638aeded1ae781cfa0bddee54ccbfd8f8a5dd5a6a37b2bf1c14c27bbe41b31bd9f251bd53a030ac5da38388be4de89dcb9
|
7
|
+
data.tar.gz: f746f821017a9ac832b655a81f84a4878858e95ff0ea933f7485e1f849804d5a22ed14f16e1676c1f8f6e9858b3da6492f8bd73c116e404e08ce46d328871cf9
|
data/Gemfile.lock
CHANGED
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
|
-
[](https://rubygems.org/gems/snaptrade/versions/2.0.129)
|
10
10
|
[](https://snaptrade.com/)
|
11
11
|
|
12
12
|
</div>
|
@@ -81,7 +81,7 @@ Connect brokerage accounts to your app for live positions and trading
|
|
81
81
|
Add to Gemfile:
|
82
82
|
|
83
83
|
```ruby
|
84
|
-
gem 'snaptrade', '~> 2.0.
|
84
|
+
gem 'snaptrade', '~> 2.0.129'
|
85
85
|
```
|
86
86
|
|
87
87
|
## Getting Started<a id="getting-started"></a>
|
@@ -1370,21 +1370,24 @@ Returns a list of all brokerage instruments available for a given brokerage. Not
|
|
1370
1370
|
|
1371
1371
|
```ruby
|
1372
1372
|
result = snaptrade.reference_data.list_all_brokerage_instruments(
|
1373
|
-
|
1373
|
+
slug: "QUESTRADE",
|
1374
1374
|
)
|
1375
1375
|
p result
|
1376
1376
|
```
|
1377
1377
|
|
1378
1378
|
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1379
1379
|
|
1380
|
-
#####
|
1380
|
+
##### slug: `String`<a id="slug-string"></a>
|
1381
|
+
A short, unique identifier for the brokerage. It is usually the name of the
|
1382
|
+
brokerage in capital letters and will never change.
|
1383
|
+
|
1381
1384
|
#### 🔄 Return<a id="🔄-return"></a>
|
1382
1385
|
|
1383
1386
|
[BrokerageInstrumentsResponse](./lib/snaptrade/models/brokerage_instruments_response.rb)
|
1384
1387
|
|
1385
1388
|
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1386
1389
|
|
1387
|
-
`/brokerages/{
|
1390
|
+
`/brokerages/{slug}/instruments` `GET`
|
1388
1391
|
|
1389
1392
|
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1390
1393
|
|
@@ -600,10 +600,10 @@ module SnapTrade
|
|
600
600
|
#
|
601
601
|
# Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
|
602
602
|
#
|
603
|
-
# @param
|
603
|
+
# @param slug [String] A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
|
604
604
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
605
|
-
def list_all_brokerage_instruments(
|
606
|
-
data, _status_code, _headers = list_all_brokerage_instruments_with_http_info_impl(
|
605
|
+
def list_all_brokerage_instruments(slug:, extra: {})
|
606
|
+
data, _status_code, _headers = list_all_brokerage_instruments_with_http_info_impl(slug, extra)
|
607
607
|
data
|
608
608
|
end
|
609
609
|
|
@@ -611,37 +611,37 @@ module SnapTrade
|
|
611
611
|
#
|
612
612
|
# Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
|
613
613
|
#
|
614
|
-
# @param
|
614
|
+
# @param slug [String] A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
|
615
615
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
616
|
-
def list_all_brokerage_instruments_with_http_info(
|
617
|
-
list_all_brokerage_instruments_with_http_info_impl(
|
616
|
+
def list_all_brokerage_instruments_with_http_info(slug:, extra: {})
|
617
|
+
list_all_brokerage_instruments_with_http_info_impl(slug, extra)
|
618
618
|
end
|
619
619
|
|
620
620
|
# Get brokerage instruments
|
621
621
|
# Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
|
622
|
-
# @param
|
622
|
+
# @param slug [String] A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
|
623
623
|
# @param [Hash] opts the optional parameters
|
624
624
|
# @return [BrokerageInstrumentsResponse]
|
625
|
-
private def list_all_brokerage_instruments_impl(
|
626
|
-
data, _status_code, _headers = list_all_brokerage_instruments_with_http_info(
|
625
|
+
private def list_all_brokerage_instruments_impl(slug, opts = {})
|
626
|
+
data, _status_code, _headers = list_all_brokerage_instruments_with_http_info(slug, opts)
|
627
627
|
data
|
628
628
|
end
|
629
629
|
|
630
630
|
# Get brokerage instruments
|
631
631
|
# Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
|
632
|
-
# @param
|
632
|
+
# @param slug [String] A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
|
633
633
|
# @param [Hash] opts the optional parameters
|
634
634
|
# @return [Array<(BrokerageInstrumentsResponse, Integer, Hash)>] BrokerageInstrumentsResponse data, response status code and response headers
|
635
|
-
private def list_all_brokerage_instruments_with_http_info_impl(
|
635
|
+
private def list_all_brokerage_instruments_with_http_info_impl(slug, opts = {})
|
636
636
|
if @api_client.config.debugging
|
637
637
|
@api_client.config.logger.debug 'Calling API: ReferenceDataApi.list_all_brokerage_instruments ...'
|
638
638
|
end
|
639
|
-
# verify the required parameter '
|
640
|
-
if @api_client.config.client_side_validation &&
|
641
|
-
fail ArgumentError, "Missing the required parameter '
|
639
|
+
# verify the required parameter 'slug' is set
|
640
|
+
if @api_client.config.client_side_validation && slug.nil?
|
641
|
+
fail ArgumentError, "Missing the required parameter 'slug' when calling ReferenceDataApi.list_all_brokerage_instruments"
|
642
642
|
end
|
643
643
|
# resource path
|
644
|
-
local_var_path = '/brokerages/{
|
644
|
+
local_var_path = '/brokerages/{slug}/instruments'.sub('{' + 'slug' + '}', CGI.escape(slug.to_s))
|
645
645
|
|
646
646
|
# query parameters
|
647
647
|
query_params = opts[:query_params] || {}
|
@@ -104,12 +104,17 @@ module SnapTrade
|
|
104
104
|
# @return Array for valid properties with the reasons
|
105
105
|
def list_invalid_properties
|
106
106
|
invalid_properties = Array.new
|
107
|
+
if @symbol.nil?
|
108
|
+
invalid_properties.push('invalid value for "symbol", symbol cannot be nil.')
|
109
|
+
end
|
110
|
+
|
107
111
|
invalid_properties
|
108
112
|
end
|
109
113
|
|
110
114
|
# Check to see if the all the properties in the model are valid
|
111
115
|
# @return true if the model is valid
|
112
116
|
def valid?
|
117
|
+
return false if @symbol.nil?
|
113
118
|
true
|
114
119
|
end
|
115
120
|
|
data/lib/snaptrade/version.rb
CHANGED
@@ -111,7 +111,7 @@ describe 'ReferenceDataApi' do
|
|
111
111
|
# unit tests for list_all_brokerage_instruments
|
112
112
|
# Get brokerage instruments
|
113
113
|
# Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don't will return an empty list.
|
114
|
-
# @param
|
114
|
+
# @param slug A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
|
115
115
|
# @param [Hash] opts the optional parameters
|
116
116
|
# @return [BrokerageInstrumentsResponse]
|
117
117
|
describe 'list_all_brokerage_instruments test' 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.
|
4
|
+
version: 2.0.129
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- SnapTrade
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-09-
|
11
|
+
date: 2025-09-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|