intrinio-sdk 5.6.0 → 5.6.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -179,9 +179,9 @@ module Intrinio
179
179
  end
180
180
 
181
181
  # Data Point (Number) for Security
182
- # $$v2_security_data_point_number_description$$
183
- # @param identifier $$v2_security_data_point_identifier_description$$
184
- # @param tag $$v2_security_data_point_item_description$$
182
+ # Returns a numeric value for the given `tag` for the Security with the given `identifier`
183
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
184
+ # @param tag An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
185
185
  # @param [Hash] opts the optional parameters
186
186
  # @return [Float]
187
187
  def get_security_data_point_number(identifier, tag, opts = {})
@@ -190,9 +190,9 @@ module Intrinio
190
190
  end
191
191
 
192
192
  # Data Point (Number) for Security
193
- # $$v2_security_data_point_number_description$$
194
- # @param identifier $$v2_security_data_point_identifier_description$$
195
- # @param tag $$v2_security_data_point_item_description$$
193
+ # Returns a numeric value for the given `tag` for the Security with the given `identifier`
194
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
195
+ # @param tag An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
196
196
  # @param [Hash] opts the optional parameters
197
197
  # @return [Array<(Float, Fixnum, Hash)>] Float data, response status code and response headers
198
198
  def get_security_data_point_number_with_http_info(identifier, tag, opts = {})
@@ -238,8 +238,8 @@ module Intrinio
238
238
  end
239
239
 
240
240
  # Data Point (Text) for Security
241
- # $$v2_security_data_point_text_description$$
242
- # @param identifier $$v2_security_data_point_identifier_description$$
241
+ # Returns a text value for the given `tag` for the Security with the given `identifier`
242
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
243
243
  # @param tag An Intrinio data tag ID or code-name
244
244
  # @param [Hash] opts the optional parameters
245
245
  # @return [String]
@@ -249,8 +249,8 @@ module Intrinio
249
249
  end
250
250
 
251
251
  # Data Point (Text) for Security
252
- # $$v2_security_data_point_text_description$$
253
- # @param identifier $$v2_security_data_point_identifier_description$$
252
+ # Returns a text value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;
253
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
254
254
  # @param tag An Intrinio data tag ID or code-name
255
255
  # @param [Hash] opts the optional parameters
256
256
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
@@ -297,9 +297,9 @@ module Intrinio
297
297
  end
298
298
 
299
299
  # Historical Data for Security
300
- # $$v2_security_historical_data_description$$
301
- # @param identifier $$v2_security_historical_data_identifier_description$$
302
- # @param tag $$v2_security_data_point_item_description$$
300
+ # Returns historical values for the given `tag` and the Security with the given `identifier`
301
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
302
+ # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
303
303
  # @param [Hash] opts the optional parameters
304
304
  # @option opts [String] :frequency Return historical data in the given frequency (default to daily)
305
305
  # @option opts [String] :type Filter by type, when applicable
@@ -315,9 +315,9 @@ module Intrinio
315
315
  end
316
316
 
317
317
  # Historical Data for Security
318
- # $$v2_security_historical_data_description$$
319
- # @param identifier $$v2_security_historical_data_identifier_description$$
320
- # @param tag $$v2_security_data_point_item_description$$
318
+ # Returns historical values for the given &#x60;tag&#x60; and the Security with the given &#x60;identifier&#x60;
319
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
320
+ # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
321
321
  # @param [Hash] opts the optional parameters
322
322
  # @option opts [String] :frequency Return historical data in the given frequency
323
323
  # @option opts [String] :type Filter by type, when applicable
@@ -387,7 +387,7 @@ module Intrinio
387
387
  end
388
388
 
389
389
  # Intraday Stock Prices for Security
390
- # $$v2_security_intraday_prices_description$$
390
+ # Return intraday stock prices for the Security with the given `identifier`
391
391
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
392
392
  # @param [Hash] opts the optional parameters
393
393
  # @option opts [String] :source Return intraday prices from the specified data source
@@ -404,7 +404,7 @@ module Intrinio
404
404
  end
405
405
 
406
406
  # Intraday Stock Prices for Security
407
- # $$v2_security_intraday_prices_description$$
407
+ # Return intraday stock prices for the Security with the given &#x60;identifier&#x60;
408
408
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
409
409
  # @param [Hash] opts the optional parameters
410
410
  # @option opts [String] :source Return intraday prices from the specified data source
@@ -423,8 +423,8 @@ module Intrinio
423
423
  if @api_client.config.client_side_validation && identifier.nil?
424
424
  fail ArgumentError, "Missing the required parameter 'identifier' when calling SecurityApi.get_security_intraday_prices"
425
425
  end
426
- if @api_client.config.client_side_validation && opts[:'source'] && !['$$v2_stock_price_intraday_sources_enum$$'].include?(opts[:'source'])
427
- fail ArgumentError, 'invalid value for "source", must be one of $$v2_stock_price_intraday_sources_enum$$'
426
+ if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats'].include?(opts[:'source'])
427
+ fail ArgumentError, 'invalid value for "source", must be one of iex, bats'
428
428
  end
429
429
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
430
430
  fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SecurityApi.get_security_intraday_prices, must be smaller than or equal to 10000.'
@@ -3046,8 +3046,8 @@ module Intrinio
3046
3046
  if @api_client.config.client_side_validation && identifier.nil?
3047
3047
  fail ArgumentError, "Missing the required parameter 'identifier' when calling SecurityApi.get_security_realtime_price"
3048
3048
  end
3049
- if @api_client.config.client_side_validation && opts[:'source'] && !['$$v2_stock_price_realtime_sources_enum$$'].include?(opts[:'source'])
3050
- fail ArgumentError, 'invalid value for "source", must be one of $$v2_stock_price_realtime_sources_enum$$'
3049
+ if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed'].include?(opts[:'source'])
3050
+ fail ArgumentError, 'invalid value for "source", must be one of iex, bats, bats_delayed, utp_delayed, cta_a_delayed, cta_b_delayed'
3051
3051
  end
3052
3052
  # resource path
3053
3053
  local_var_path = "/securities/{identifier}/prices/realtime".sub('{' + 'identifier' + '}', identifier.to_s)
@@ -297,8 +297,8 @@ module Intrinio
297
297
  if @api_client.config.client_side_validation && identifier.nil?
298
298
  fail ArgumentError, "Missing the required parameter 'identifier' when calling StockExchangeApi.get_stock_exchange_realtime_prices"
299
299
  end
300
- if @api_client.config.client_side_validation && opts[:'source'] && !['$$v2_stock_price_realtime_sources_enum$$'].include?(opts[:'source'])
301
- fail ArgumentError, 'invalid value for "source", must be one of $$v2_stock_price_realtime_sources_enum$$'
300
+ if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed'].include?(opts[:'source'])
301
+ fail ArgumentError, 'invalid value for "source", must be one of iex, bats, bats_delayed, utp_delayed, cta_a_delayed, cta_b_delayed'
302
302
  end
303
303
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
304
304
  fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling StockExchangeApi.get_stock_exchange_realtime_prices, must be smaller than or equal to 10000.'
@@ -107,7 +107,7 @@ module Intrinio
107
107
  # Check to see if the all the properties in the model are valid
108
108
  # @return true if the model is valid
109
109
  def valid?
110
- source_validator = EnumAttributeValidator.new('String', ["$$v2_stock_price_intraday_sources_enum$$"])
110
+ source_validator = EnumAttributeValidator.new('String', ["iex", "bats"])
111
111
  return false unless source_validator.valid?(@source)
112
112
  return true
113
113
  end
@@ -115,7 +115,7 @@ module Intrinio
115
115
  # Custom attribute writer method checking allowed values (enum).
116
116
  # @param [Object] source Object to be assigned
117
117
  def source=(source)
118
- validator = EnumAttributeValidator.new('String', ["$$v2_stock_price_intraday_sources_enum$$"])
118
+ validator = EnumAttributeValidator.new('String', ["iex", "bats"])
119
119
  unless validator.valid?(source)
120
120
  fail ArgumentError, "invalid value for 'source', must be one of #{validator.allowable_values}."
121
121
  end
@@ -11,5 +11,5 @@ Swagger Codegen version: unset
11
11
  =end
12
12
 
13
13
  module Intrinio
14
- VERSION = "5.6.0"
14
+ VERSION = "5.6.1"
15
15
  end
@@ -80,9 +80,9 @@ describe 'CompanyApi' do
80
80
 
81
81
  # unit tests for get_company_data_point_number
82
82
  # Data Point (Number) for Company
83
- # $$v2_company_data_point_number_description$$
84
- # @param identifier $$v2_company_data_point_identifier_description$$
85
- # @param tag $$v2_company_data_point_item_description$$
83
+ # Returns a numeric value for the given &#x60;tag&#x60; for the Company with the given &#x60;identifier&#x60;
84
+ # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
85
+ # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @return [Float]
88
88
  describe 'get_company_data_point_number test' do
@@ -93,9 +93,9 @@ describe 'CompanyApi' do
93
93
 
94
94
  # unit tests for get_company_data_point_text
95
95
  # Data Point (Text) for Company
96
- # $$v2_company_data_point_text_description$$
97
- # @param identifier $$v2_company_data_point_identifier_description$$
98
- # @param tag $$v2_company_data_point_item_description$$
96
+ # Returns a text value for the given &#x60;tag&#x60; for the Company with the given &#x60;identifier&#x60;
97
+ # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
98
+ # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
99
99
  # @param [Hash] opts the optional parameters
100
100
  # @return [String]
101
101
  describe 'get_company_data_point_text test' do
@@ -145,9 +145,9 @@ describe 'CompanyApi' do
145
145
 
146
146
  # unit tests for get_company_historical_data
147
147
  # Historical Data for Company
148
- # $$v2_company_historical_data_description$$
149
- # @param identifier $$v2_company_historical_data_identifier_description$$
150
- # @param tag $$v2_company_historical_data_item_description$$
148
+ # Returns historical values for the given &#x60;tag&#x60; and the Company with the given &#x60;identifier&#x60;
149
+ # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
150
+ # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
151
151
  # @param [Hash] opts the optional parameters
152
152
  # @option opts [String] :frequency Return historical data in the given frequency
153
153
  # @option opts [String] :type Return historical data for given fiscal period type
@@ -34,9 +34,9 @@ describe 'DataPointApi' do
34
34
 
35
35
  # unit tests for get_data_point_number
36
36
  # Data Point (Number)
37
- # $$v2_data_point_number_description$$
38
- # @param identifier $$v2_data_point_identifier_description$$
39
- # @param tag $$v2_data_point_item_description$$
37
+ # Returns a numeric value for the given &#x60;tag&#x60; and the entity with the given &#x60;identifier&#x60;
38
+ # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
39
+ # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @return [Float]
42
42
  describe 'get_data_point_number test' do
@@ -47,9 +47,9 @@ describe 'DataPointApi' do
47
47
 
48
48
  # unit tests for get_data_point_text
49
49
  # Data Point (Text)
50
- # $$v2_data_point_text_description$$
51
- # @param identifier $$v2_data_point_identifier_description$$
52
- # @param tag $$v2_data_point_item_description$$
50
+ # Returns a text value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;
51
+ # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
52
+ # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
53
53
  # @param [Hash] opts the optional parameters
54
54
  # @return [String]
55
55
  describe 'get_data_point_text test' do
@@ -34,9 +34,9 @@ describe 'HistoricalDataApi' do
34
34
 
35
35
  # unit tests for get_historical_data
36
36
  # Historical Data
37
- # $$v2_historical_data_description$$
38
- # @param identifier $$v2_historical_data_identifier_description$$
39
- # @param tag $$v2_historical_data_item_description$$
37
+ # Returns historical values for the given &#x60;tag&#x60; and the entity represented by the given &#x60;identifier&#x60;
38
+ # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
39
+ # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @option opts [String] :frequency Return historical data in the given frequency
42
42
  # @option opts [String] :type Filter by type, when applicable
@@ -75,9 +75,9 @@ describe 'SecurityApi' do
75
75
 
76
76
  # unit tests for get_security_data_point_number
77
77
  # Data Point (Number) for Security
78
- # $$v2_security_data_point_number_description$$
79
- # @param identifier $$v2_security_data_point_identifier_description$$
80
- # @param tag $$v2_security_data_point_item_description$$
78
+ # Returns a numeric value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;
79
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
80
+ # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
81
81
  # @param [Hash] opts the optional parameters
82
82
  # @return [Float]
83
83
  describe 'get_security_data_point_number test' do
@@ -88,8 +88,8 @@ describe 'SecurityApi' do
88
88
 
89
89
  # unit tests for get_security_data_point_text
90
90
  # Data Point (Text) for Security
91
- # $$v2_security_data_point_text_description$$
92
- # @param identifier $$v2_security_data_point_identifier_description$$
91
+ # Returns a text value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;
92
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
93
93
  # @param tag An Intrinio data tag ID or code-name
94
94
  # @param [Hash] opts the optional parameters
95
95
  # @return [String]
@@ -101,9 +101,9 @@ describe 'SecurityApi' do
101
101
 
102
102
  # unit tests for get_security_historical_data
103
103
  # Historical Data for Security
104
- # $$v2_security_historical_data_description$$
105
- # @param identifier $$v2_security_historical_data_identifier_description$$
106
- # @param tag $$v2_security_data_point_item_description$$
104
+ # Returns historical values for the given &#x60;tag&#x60; and the Security with the given &#x60;identifier&#x60;
105
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
106
+ # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
107
107
  # @param [Hash] opts the optional parameters
108
108
  # @option opts [String] :frequency Return historical data in the given frequency
109
109
  # @option opts [String] :type Filter by type, when applicable
@@ -121,7 +121,7 @@ describe 'SecurityApi' do
121
121
 
122
122
  # unit tests for get_security_intraday_prices
123
123
  # Intraday Stock Prices for Security
124
- # $$v2_security_intraday_prices_description$$
124
+ # Return intraday stock prices for the Security with the given &#x60;identifier&#x60;
125
125
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
126
126
  # @param [Hash] opts the optional parameters
127
127
  # @option opts [String] :source Return intraday prices from the specified data source
@@ -47,7 +47,7 @@ describe 'ApiResponseSecurityIntradayPrices' do
47
47
  describe 'test attribute "source"' do
48
48
  it 'should work' do
49
49
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
- #validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["$$v2_stock_price_intraday_sources_enum$$"])
50
+ #validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["iex", "bats"])
51
51
  #validator.allowable_values.each do |value|
52
52
  # expect { @instance.source = value }.not_to raise_error
53
53
  #end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: intrinio-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.6.0
4
+ version: 5.6.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Intrinio
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-05-19 00:00:00.000000000 Z
11
+ date: 2020-07-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus