intrinio-sdk 3.2.0 → 3.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/docs/ApiResponseStockExchangeRealtimeStockPrices.md +1 -0
- data/docs/CompanyApi.md +12 -0
- data/docs/OptionsApi.md +3 -1
- data/lib/intrinio-sdk/api/company_api.rb +21 -0
- data/lib/intrinio-sdk/api/options_api.rb +3 -0
- data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +14 -4
- data/lib/intrinio-sdk/version.rb +1 -1
- data/spec/api/company_api_spec.rb +6 -0
- data/spec/api/options_api_spec.rb +1 -0
- data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +6 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: eb6353a520fe04db533bc8c66f830c97ee1a6d49
|
4
|
+
data.tar.gz: 8cb11a690e78f2b389af7050ff7bb45b8f587d96
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '0877d38c6b265a7dc5511224b3894a34f444364ac8ff570364a9c5f9772101c08c86f72480db26667f4e1987d29d2d4ee2f282220339bc85f3c0ff394fc168a2'
|
7
|
+
data.tar.gz: ac63c0f4a3157f0f553e336c47b1f5fc0c53f53f668b1c6ccba0a7bd626474ac5a61c48a56b17688cdf9da8775e85cc739f979363dbb5aa52d846de1b50f41fb
|
data/README.md
CHANGED
@@ -9,7 +9,7 @@ Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a
|
|
9
9
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
10
10
|
|
11
11
|
- API version: 2.8.0
|
12
|
-
- Package version: 3.
|
12
|
+
- Package version: 3.3.0
|
13
13
|
|
14
14
|
|
15
15
|
## Installation
|
@@ -14,6 +14,7 @@ Name | Type | Description
|
|
14
14
|
------------ | ------------- | -------------
|
15
15
|
**stock_prices** | [**Array<RealtimeStockPrice>**](RealtimeStockPrice.md) | The realtime stock prices for all Securities traded on the Stock Exchange
|
16
16
|
**stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier
|
17
|
+
**next_page** | String | The token required to request the next page of the data
|
17
18
|
|
18
19
|
[//]: # (END_DEFINITION)
|
19
20
|
|
data/docs/CompanyApi.md
CHANGED
@@ -815,6 +815,12 @@ end
|
|
815
815
|
company_api = Intrinio::CompanyApi.new
|
816
816
|
|
817
817
|
opts = {
|
818
|
+
ticker: nil, # String | Return IPOs with the given ticker (typically the IPO for the company)
|
819
|
+
status: nil, # String | Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand
|
820
|
+
start_date: nil, # Date | Return IPOs on or after the given date
|
821
|
+
end_date: nil, # Date | Return IPOs on or before the given date
|
822
|
+
offer_amount_greater_than: nil, # Integer | Return IPOs with an offer dollar amount greater than the given amount
|
823
|
+
offer_amount_less_than: nil, # Integer | Return IPOs with an offer dollar amount less than the given amount
|
818
824
|
page_size: 100, # Integer | The number of results to return
|
819
825
|
next_page: nil # String | Gets the next page of data from a previous API call
|
820
826
|
}
|
@@ -838,6 +844,12 @@ end
|
|
838
844
|
|
839
845
|
Name | Type | Description | Notes
|
840
846
|
------------- | ------------- | ------------- | -------------
|
847
|
+
**ticker** | String| Return IPOs with the given ticker (typically the IPO for the company) | [optional]
|
848
|
+
**status** | String| Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand | [optional]
|
849
|
+
**start_date** | Date| Return IPOs on or after the given date | [optional]
|
850
|
+
**end_date** | Date| Return IPOs on or before the given date | [optional]
|
851
|
+
**offer_amount_greater_than** | Integer| Return IPOs with an offer dollar amount greater than the given amount | [optional]
|
852
|
+
**offer_amount_less_than** | Integer| Return IPOs with an offer dollar amount less than the given amount | [optional]
|
841
853
|
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
842
854
|
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
843
855
|
<br/>
|
data/docs/OptionsApi.md
CHANGED
@@ -165,9 +165,10 @@ options_api = Intrinio::OptionsApi.new
|
|
165
165
|
|
166
166
|
symbol = "MSFT" # String | The option symbol, corresponding to the underlying security.
|
167
167
|
|
168
|
-
expiration = "2019-
|
168
|
+
expiration = "2019-04-05" # String | The expiration date of the options contract
|
169
169
|
|
170
170
|
opts = {
|
171
|
+
date: Date.parse("2019-04-05"), # Date | The date of the option price. Returns option prices on this date.
|
171
172
|
type: "put", # String | The option contract type.
|
172
173
|
strike: 170.0, # Float | The strike price of the option contract. This will return options contracts with strike price equal to this price.
|
173
174
|
strike_greater_than: 190.0, # Float | The strike price of the option contract. This will return options contracts with strike prices greater than this price.
|
@@ -197,6 +198,7 @@ Name | Type | Description | Notes
|
|
197
198
|
------------- | ------------- | ------------- | -------------
|
198
199
|
**symbol** | String| The option symbol, corresponding to the underlying security. |
|
199
200
|
**expiration** | String| The expiration date of the options contract |
|
201
|
+
**date** | Date| The date of the option price. Returns option prices on this date. | [optional]
|
200
202
|
**type** | String| The option contract type. | [optional]
|
201
203
|
**strike** | Float| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]
|
202
204
|
**strike_greater_than** | Float| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]
|
@@ -593,6 +593,12 @@ module Intrinio
|
|
593
593
|
# IPOs
|
594
594
|
# Returns initial public offerings (IPOs). An IPO is a public offering of private company stock. The act of \"going public\" is initiated by an IPO, at which point the company's stock trades on a major stock exchange (such as NYSE or NASDAQ). Intrinio covers all upcoming and recent IPOs for US exchanges.
|
595
595
|
# @param [Hash] opts the optional parameters
|
596
|
+
# @option opts [String] :ticker Return IPOs with the given ticker (typically the IPO for the company)
|
597
|
+
# @option opts [String] :status Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand
|
598
|
+
# @option opts [Date] :start_date Return IPOs on or after the given date
|
599
|
+
# @option opts [Date] :end_date Return IPOs on or before the given date
|
600
|
+
# @option opts [Integer] :offer_amount_greater_than Return IPOs with an offer dollar amount greater than the given amount
|
601
|
+
# @option opts [Integer] :offer_amount_less_than Return IPOs with an offer dollar amount less than the given amount
|
596
602
|
# @option opts [Integer] :page_size The number of results to return (default to 100)
|
597
603
|
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
598
604
|
# @return [ApiResponseInitialPublicOfferings]
|
@@ -604,6 +610,12 @@ module Intrinio
|
|
604
610
|
# IPOs
|
605
611
|
# Returns initial public offerings (IPOs). An IPO is a public offering of private company stock. The act of \"going public\" is initiated by an IPO, at which point the company's stock trades on a major stock exchange (such as NYSE or NASDAQ). Intrinio covers all upcoming and recent IPOs for US exchanges.
|
606
612
|
# @param [Hash] opts the optional parameters
|
613
|
+
# @option opts [String] :ticker Return IPOs with the given ticker (typically the IPO for the company)
|
614
|
+
# @option opts [String] :status Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand
|
615
|
+
# @option opts [Date] :start_date Return IPOs on or after the given date
|
616
|
+
# @option opts [Date] :end_date Return IPOs on or before the given date
|
617
|
+
# @option opts [Integer] :offer_amount_greater_than Return IPOs with an offer dollar amount greater than the given amount
|
618
|
+
# @option opts [Integer] :offer_amount_less_than Return IPOs with an offer dollar amount less than the given amount
|
607
619
|
# @option opts [Integer] :page_size The number of results to return
|
608
620
|
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
609
621
|
# @return [Array<(ApiResponseInitialPublicOfferings, Fixnum, Hash)>] ApiResponseInitialPublicOfferings data, response status code and response headers
|
@@ -611,6 +623,9 @@ module Intrinio
|
|
611
623
|
if @api_client.config.debugging
|
612
624
|
@api_client.config.logger.debug "Calling API: CompanyApi.get_company_ipos ..."
|
613
625
|
end
|
626
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !['upcoming', 'priced', 'withdrawn'].include?(opts[:'status'])
|
627
|
+
fail ArgumentError, 'invalid value for "status", must be one of upcoming, priced, withdrawn'
|
628
|
+
end
|
614
629
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
|
615
630
|
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CompanyApi.get_company_ipos, must be smaller than or equal to 10000.'
|
616
631
|
end
|
@@ -620,6 +635,12 @@ module Intrinio
|
|
620
635
|
|
621
636
|
# query parameters
|
622
637
|
query_params = {}
|
638
|
+
query_params[:'ticker'] = opts[:'ticker'] if !opts[:'ticker'].nil?
|
639
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
640
|
+
query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
641
|
+
query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
642
|
+
query_params[:'offer_amount_greater_than'] = opts[:'offer_amount_greater_than'] if !opts[:'offer_amount_greater_than'].nil?
|
643
|
+
query_params[:'offer_amount_less_than'] = opts[:'offer_amount_less_than'] if !opts[:'offer_amount_less_than'].nil?
|
623
644
|
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
624
645
|
query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
|
625
646
|
|
@@ -112,6 +112,7 @@ module Intrinio
|
|
112
112
|
# @param symbol The option symbol, corresponding to the underlying security.
|
113
113
|
# @param expiration The expiration date of the options contract
|
114
114
|
# @param [Hash] opts the optional parameters
|
115
|
+
# @option opts [Date] :date The date of the option price. Returns option prices on this date.
|
115
116
|
# @option opts [String] :type The option contract type.
|
116
117
|
# @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
|
117
118
|
# @option opts [Float] :strike_greater_than The strike price of the option contract. This will return options contracts with strike prices greater than this price.
|
@@ -129,6 +130,7 @@ module Intrinio
|
|
129
130
|
# @param symbol The option symbol, corresponding to the underlying security.
|
130
131
|
# @param expiration The expiration date of the options contract
|
131
132
|
# @param [Hash] opts the optional parameters
|
133
|
+
# @option opts [Date] :date The date of the option price. Returns option prices on this date.
|
132
134
|
# @option opts [String] :type The option contract type.
|
133
135
|
# @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
|
134
136
|
# @option opts [Float] :strike_greater_than The strike price of the option contract. This will return options contracts with strike prices greater than this price.
|
@@ -163,6 +165,7 @@ module Intrinio
|
|
163
165
|
|
164
166
|
# query parameters
|
165
167
|
query_params = {}
|
168
|
+
query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
|
166
169
|
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
167
170
|
query_params[:'strike'] = opts[:'strike'] if !opts[:'strike'].nil?
|
168
171
|
query_params[:'strike_greater_than'] = opts[:'strike_greater_than'] if !opts[:'strike_greater_than'].nil?
|
@@ -21,12 +21,16 @@ module Intrinio
|
|
21
21
|
# The Stock Exchange resolved from the given identifier
|
22
22
|
attr_accessor :stock_exchange
|
23
23
|
|
24
|
+
# The token required to request the next page of the data
|
25
|
+
attr_accessor :next_page
|
26
|
+
|
24
27
|
|
25
28
|
# Attribute mapping from ruby-style variable name to JSON key.
|
26
29
|
def self.attribute_map
|
27
30
|
{
|
28
31
|
:'stock_prices' => :'stock_prices',
|
29
|
-
:'stock_exchange' => :'stock_exchange'
|
32
|
+
:'stock_exchange' => :'stock_exchange',
|
33
|
+
:'next_page' => :'next_page'
|
30
34
|
}
|
31
35
|
end
|
32
36
|
|
@@ -34,7 +38,8 @@ module Intrinio
|
|
34
38
|
def self.swagger_types
|
35
39
|
{
|
36
40
|
:'stock_prices' => :'Array<RealtimeStockPrice>',
|
37
|
-
:'stock_exchange' => :'StockExchange'
|
41
|
+
:'stock_exchange' => :'StockExchange',
|
42
|
+
:'next_page' => :'String'
|
38
43
|
}
|
39
44
|
end
|
40
45
|
|
@@ -56,6 +61,10 @@ module Intrinio
|
|
56
61
|
self.stock_exchange = attributes[:'stock_exchange']
|
57
62
|
end
|
58
63
|
|
64
|
+
if attributes.has_key?(:'next_page')
|
65
|
+
self.next_page = attributes[:'next_page']
|
66
|
+
end
|
67
|
+
|
59
68
|
end
|
60
69
|
|
61
70
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -77,7 +86,8 @@ module Intrinio
|
|
77
86
|
return true if self.equal?(o)
|
78
87
|
self.class == o.class &&
|
79
88
|
stock_prices == o.stock_prices &&
|
80
|
-
stock_exchange == o.stock_exchange
|
89
|
+
stock_exchange == o.stock_exchange &&
|
90
|
+
next_page == o.next_page
|
81
91
|
end
|
82
92
|
|
83
93
|
# @see the `==` method
|
@@ -89,7 +99,7 @@ module Intrinio
|
|
89
99
|
# Calculates hash code according to all attributes.
|
90
100
|
# @return [Fixnum] Hash code
|
91
101
|
def hash
|
92
|
-
[stock_prices, stock_exchange].hash
|
102
|
+
[stock_prices, stock_exchange, next_page].hash
|
93
103
|
end
|
94
104
|
|
95
105
|
# Builds the object from hash
|
data/lib/intrinio-sdk/version.rb
CHANGED
@@ -167,6 +167,12 @@ describe 'CompanyApi' do
|
|
167
167
|
# IPOs
|
168
168
|
# Returns initial public offerings (IPOs). An IPO is a public offering of private company stock. The act of \"going public\" is initiated by an IPO, at which point the company's stock trades on a major stock exchange (such as NYSE or NASDAQ). Intrinio covers all upcoming and recent IPOs for US exchanges.
|
169
169
|
# @param [Hash] opts the optional parameters
|
170
|
+
# @option opts [String] :ticker Return IPOs with the given ticker (typically the IPO for the company)
|
171
|
+
# @option opts [String] :status Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand
|
172
|
+
# @option opts [Date] :start_date Return IPOs on or after the given date
|
173
|
+
# @option opts [Date] :end_date Return IPOs on or before the given date
|
174
|
+
# @option opts [Integer] :offer_amount_greater_than Return IPOs with an offer dollar amount greater than the given amount
|
175
|
+
# @option opts [Integer] :offer_amount_less_than Return IPOs with an offer dollar amount less than the given amount
|
170
176
|
# @option opts [Integer] :page_size The number of results to return
|
171
177
|
# @option opts [String] :next_page Gets the next page of data from a previous API call
|
172
178
|
# @return [ApiResponseInitialPublicOfferings]
|
@@ -59,6 +59,7 @@ describe 'OptionsApi' do
|
|
59
59
|
# @param symbol The option symbol, corresponding to the underlying security.
|
60
60
|
# @param expiration The expiration date of the options contract
|
61
61
|
# @param [Hash] opts the optional parameters
|
62
|
+
# @option opts [Date] :date The date of the option price. Returns option prices on this date.
|
62
63
|
# @option opts [String] :type The option contract type.
|
63
64
|
# @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
|
64
65
|
# @option opts [Float] :strike_greater_than The strike price of the option contract. This will return options contracts with strike prices greater than this price.
|
@@ -44,5 +44,11 @@ describe 'ApiResponseStockExchangeRealtimeStockPrices' do
|
|
44
44
|
end
|
45
45
|
end
|
46
46
|
|
47
|
+
describe 'test attribute "next_page"' do
|
48
|
+
it 'should work' do
|
49
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
47
53
|
end
|
48
54
|
|
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: 3.
|
4
|
+
version: 3.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Intrinio
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-07-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|