intrinio-sdk 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (114) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +78 -52
  3. data/docs/ApiResponseFilingNotes.md +9 -0
  4. data/docs/ApiResponseFilingNotesSearch.md +8 -0
  5. data/docs/ApiResponseStockExchangeRealtimeStockPrices.md +9 -0
  6. data/docs/CompanyApi.md +34 -28
  7. data/docs/DataPointApi.md +4 -4
  8. data/docs/DataTagApi.md +5 -5
  9. data/docs/DividendRecord.md +17 -0
  10. data/docs/EarningsRecord.md +30 -0
  11. data/docs/FilingApi.md +273 -7
  12. data/docs/FilingNote.md +11 -0
  13. data/docs/FilingNoteFiling.md +11 -0
  14. data/docs/FilingNoteSummary.md +10 -0
  15. data/docs/FundamentalsApi.md +9 -9
  16. data/docs/HistoricalDataApi.md +2 -2
  17. data/docs/IndexApi.md +30 -30
  18. data/docs/RealtimeStockPrice.md +21 -0
  19. data/docs/RealtimeStockPriceSecurity.md +12 -0
  20. data/docs/SecurityApi.md +148 -17
  21. data/docs/StockExchangeApi.md +64 -15
  22. data/intrinio-sdk.gemspec +1 -1
  23. data/lib/intrinio-sdk.rb +11 -1
  24. data/lib/intrinio-sdk/api/company_api.rb +41 -35
  25. data/lib/intrinio-sdk/api/data_point_api.rb +5 -5
  26. data/lib/intrinio-sdk/api/data_tag_api.rb +7 -7
  27. data/lib/intrinio-sdk/api/filing_api.rb +364 -11
  28. data/lib/intrinio-sdk/api/fundamentals_api.rb +11 -11
  29. data/lib/intrinio-sdk/api/historical_data_api.rb +3 -3
  30. data/lib/intrinio-sdk/api/index_api.rb +31 -31
  31. data/lib/intrinio-sdk/api/security_api.rb +194 -23
  32. data/lib/intrinio-sdk/api/stock_exchange_api.rb +85 -23
  33. data/lib/intrinio-sdk/api_client.rb +1 -1
  34. data/lib/intrinio-sdk/api_error.rb +1 -1
  35. data/lib/intrinio-sdk/configuration.rb +1 -1
  36. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  37. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  38. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  39. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  40. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  41. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  42. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  43. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  44. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  45. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +200 -0
  46. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +190 -0
  47. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  48. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  49. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  50. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  51. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  52. data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
  53. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  54. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  55. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  56. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  57. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  58. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +201 -0
  59. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  60. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  61. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  62. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  63. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  64. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  65. data/lib/intrinio-sdk/models/company.rb +1 -1
  66. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  67. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  68. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  69. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  70. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  71. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  72. data/lib/intrinio-sdk/models/dividend_record.rb +311 -0
  73. data/lib/intrinio-sdk/models/earnings_record.rb +465 -0
  74. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  75. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  76. data/lib/intrinio-sdk/models/filing.rb +1 -1
  77. data/lib/intrinio-sdk/models/filing_note.rb +218 -0
  78. data/lib/intrinio-sdk/models/filing_note_filing.rb +219 -0
  79. data/lib/intrinio-sdk/models/filing_note_summary.rb +208 -0
  80. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  81. data/lib/intrinio-sdk/models/fundamental.rb +1 -1
  82. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  83. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  84. data/lib/intrinio-sdk/models/realtime_stock_price.rb +318 -0
  85. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +229 -0
  86. data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
  87. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  88. data/lib/intrinio-sdk/models/security.rb +1 -1
  89. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  90. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  91. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  92. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  93. data/lib/intrinio-sdk/models/security_summary.rb +1 -1
  94. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  95. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  96. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  97. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  98. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  99. data/lib/intrinio-sdk/models/stock_price.rb +1 -1
  100. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  101. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  102. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  103. data/lib/intrinio-sdk/version.rb +2 -2
  104. data/spec/models/api_response_filing_notes_search_spec.rb +42 -0
  105. data/spec/models/api_response_filing_notes_spec.rb +48 -0
  106. data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +48 -0
  107. data/spec/models/dividend_record_spec.rb +100 -0
  108. data/spec/models/earnings_record_spec.rb +186 -0
  109. data/spec/models/filing_note_filing_spec.rb +60 -0
  110. data/spec/models/filing_note_spec.rb +60 -0
  111. data/spec/models/filing_note_summary_spec.rb +54 -0
  112. data/spec/models/realtime_stock_price_security_spec.rb +66 -0
  113. data/spec/models/realtime_stock_price_spec.rb +120 -0
  114. metadata +43 -3
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.0.0
6
+ OpenAPI spec version: 2.1.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -20,8 +20,8 @@ module Intrinio
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- # Get a Fundamental by ID
24
- # Retrieves detailed fundamental data for the given `fundamental_id`.
23
+ # Fundamental by ID
24
+ # Returns detailed fundamental data for the given `id`.
25
25
  # @param id The Intrinio ID for the Fundamental
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @return [Fundamental]
@@ -30,8 +30,8 @@ module Intrinio
30
30
  return data
31
31
  end
32
32
 
33
- # Get a Fundamental by ID
34
- # Retrieves detailed fundamental data for the given `fundamental_id`.
33
+ # Fundamental by ID
34
+ # Returns detailed fundamental data for the given `id`.
35
35
  # @param id The Intrinio ID for the Fundamental
36
36
  # @param [Hash] opts the optional parameters
37
37
  # @return [Array<(Fundamental, Fixnum, Hash)>] Fundamental data, response status code and response headers
@@ -73,7 +73,7 @@ module Intrinio
73
73
  return data, status_code, headers
74
74
  end
75
75
 
76
- # Get Reported Financials for a Fundamental
76
+ # Reported Financials
77
77
  # Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
78
78
  # @param id The Intrinio ID for the Fundamental
79
79
  # @param [Hash] opts the optional parameters
@@ -83,7 +83,7 @@ module Intrinio
83
83
  return data
84
84
  end
85
85
 
86
- # Get Reported Financials for a Fundamental
86
+ # Reported Financials
87
87
  # Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
88
88
  # @param id The Intrinio ID for the Fundamental
89
89
  # @param [Hash] opts the optional parameters
@@ -126,7 +126,7 @@ module Intrinio
126
126
  return data, status_code, headers
127
127
  end
128
128
 
129
- # Get Standardized Financials for a Fundamental
129
+ # Standardized Financials
130
130
  # Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.
131
131
  # @param id The Intrinio ID for the Fundamental
132
132
  # @param [Hash] opts the optional parameters
@@ -136,7 +136,7 @@ module Intrinio
136
136
  return data
137
137
  end
138
138
 
139
- # Get Standardized Financials for a Fundamental
139
+ # Standardized Financials
140
140
  # Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.
141
141
  # @param id The Intrinio ID for the Fundamental
142
142
  # @param [Hash] opts the optional parameters
@@ -179,7 +179,7 @@ module Intrinio
179
179
  return data, status_code, headers
180
180
  end
181
181
 
182
- # Lookup a Fundamental
182
+ # Lookup Fundamental
183
183
  # Returns the Fundamental for the Company with the given `identifier` and with the given parameters
184
184
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
185
185
  # @param statement_code The statement code
@@ -192,7 +192,7 @@ module Intrinio
192
192
  return data
193
193
  end
194
194
 
195
- # Lookup a Fundamental
195
+ # Lookup Fundamental
196
196
  # Returns the Fundamental for the Company with the given &#x60;identifier&#x60; and with the given parameters
197
197
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
198
198
  # @param statement_code The statement code
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.0.0
6
+ OpenAPI spec version: 2.1.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -20,7 +20,7 @@ module Intrinio
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- # Get Historical Data
23
+ # Historical Data
24
24
  # Returns historical values for the given `tag` and the entity represented by the given `identifier`
25
25
  # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
26
26
  # @param tag An Intrinio data tag ID or code-name
@@ -36,7 +36,7 @@ module Intrinio
36
36
  return data
37
37
  end
38
38
 
39
- # Get Historical Data
39
+ # Historical Data
40
40
  # Returns historical values for the given &#x60;tag&#x60; and the entity represented by the given &#x60;identifier&#x60;
41
41
  # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
42
42
  # @param tag An Intrinio data tag ID or code-name
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.0.0
6
+ OpenAPI spec version: 2.1.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -20,7 +20,7 @@ module Intrinio
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- # Get All Economic Indices
23
+ # All Economic Indices
24
24
  #
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -30,7 +30,7 @@ module Intrinio
30
30
  return data
31
31
  end
32
32
 
33
- # Get All Economic Indices
33
+ # All Economic Indices
34
34
  #
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -70,7 +70,7 @@ module Intrinio
70
70
  return data, status_code, headers
71
71
  end
72
72
 
73
- # Get All SIC Indices
73
+ # All SIC Indices
74
74
  #
75
75
  # @param [Hash] opts the optional parameters
76
76
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -80,7 +80,7 @@ module Intrinio
80
80
  return data
81
81
  end
82
82
 
83
- # Get All SIC Indices
83
+ # All SIC Indices
84
84
  #
85
85
  # @param [Hash] opts the optional parameters
86
86
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -120,7 +120,7 @@ module Intrinio
120
120
  return data, status_code, headers
121
121
  end
122
122
 
123
- # Get All Stock Market Indices
123
+ # All Stock Market Indices
124
124
  #
125
125
  # @param [Hash] opts the optional parameters
126
126
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -130,7 +130,7 @@ module Intrinio
130
130
  return data
131
131
  end
132
132
 
133
- # Get All Stock Market Indices
133
+ # All Stock Market Indices
134
134
  #
135
135
  # @param [Hash] opts the optional parameters
136
136
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -170,7 +170,7 @@ module Intrinio
170
170
  return data, status_code, headers
171
171
  end
172
172
 
173
- # Get an Economic Index by ID
173
+ # Lookup Economic Index
174
174
  #
175
175
  # @param identifier An Index Identifier (symbol, Intrinio ID)
176
176
  # @param [Hash] opts the optional parameters
@@ -180,7 +180,7 @@ module Intrinio
180
180
  return data
181
181
  end
182
182
 
183
- # Get an Economic Index by ID
183
+ # Lookup Economic Index
184
184
  #
185
185
  # @param identifier An Index Identifier (symbol, Intrinio ID)
186
186
  # @param [Hash] opts the optional parameters
@@ -223,7 +223,7 @@ module Intrinio
223
223
  return data, status_code, headers
224
224
  end
225
225
 
226
- # Get Economic Index Data Point (Number)
226
+ # Data Point (Number) for an Economic Index
227
227
  # Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
228
228
  # @param identifier An Index Identifier (symbol, Intrinio ID)
229
229
  # @param tag An Intrinio data tag ID or code-name
@@ -234,7 +234,7 @@ module Intrinio
234
234
  return data
235
235
  end
236
236
 
237
- # Get Economic Index Data Point (Number)
237
+ # Data Point (Number) for an Economic Index
238
238
  # Returns a numeric value for the given &#x60;tag&#x60; for the Economic Index with the given &#x60;identifier&#x60;
239
239
  # @param identifier An Index Identifier (symbol, Intrinio ID)
240
240
  # @param tag An Intrinio data tag ID or code-name
@@ -282,7 +282,7 @@ module Intrinio
282
282
  return data, status_code, headers
283
283
  end
284
284
 
285
- # Get Economic Index Data Point (Text)
285
+ # Data Point (Text) for an Economic Index
286
286
  # Returns a text value for the given `tag` for the Economic Index with the given `identifier`
287
287
  # @param identifier An Index Identifier (symbol, Intrinio ID)
288
288
  # @param tag An Intrinio data tag ID or code-name
@@ -293,7 +293,7 @@ module Intrinio
293
293
  return data
294
294
  end
295
295
 
296
- # Get Economic Index Data Point (Text)
296
+ # Data Point (Text) for an Economic Index
297
297
  # Returns a text value for the given &#x60;tag&#x60; for the Economic Index with the given &#x60;identifier&#x60;
298
298
  # @param identifier An Index Identifier (symbol, Intrinio ID)
299
299
  # @param tag An Intrinio data tag ID or code-name
@@ -341,7 +341,7 @@ module Intrinio
341
341
  return data, status_code, headers
342
342
  end
343
343
 
344
- # Get Economic Index Historical Data
344
+ # Historical Data for an Economic Index
345
345
  # Returns historical values for the given `tag` and the Economic Index with the given `identifier`
346
346
  # @param identifier An Index Identifier (symbol, Intrinio ID)
347
347
  # @param tag An Intrinio data tag ID or code-name
@@ -357,7 +357,7 @@ module Intrinio
357
357
  return data
358
358
  end
359
359
 
360
- # Get Economic Index Historical Data
360
+ # Historical Data for an Economic Index
361
361
  # Returns historical values for the given &#x60;tag&#x60; and the Economic Index with the given &#x60;identifier&#x60;
362
362
  # @param identifier An Index Identifier (symbol, Intrinio ID)
363
363
  # @param tag An Intrinio data tag ID or code-name
@@ -418,7 +418,7 @@ module Intrinio
418
418
  return data, status_code, headers
419
419
  end
420
420
 
421
- # Get an SIC Index by ID
421
+ # Lookup SIC Index
422
422
  #
423
423
  # @param identifier An Index Identifier (symbol, Intrinio ID)
424
424
  # @param [Hash] opts the optional parameters
@@ -428,7 +428,7 @@ module Intrinio
428
428
  return data
429
429
  end
430
430
 
431
- # Get an SIC Index by ID
431
+ # Lookup SIC Index
432
432
  #
433
433
  # @param identifier An Index Identifier (symbol, Intrinio ID)
434
434
  # @param [Hash] opts the optional parameters
@@ -471,7 +471,7 @@ module Intrinio
471
471
  return data, status_code, headers
472
472
  end
473
473
 
474
- # Get SIC Index Data Point (Number)
474
+ # Data Point (Number) for an SIC Index
475
475
  # Returns a numeric value for the given `tag` for the SIC Index with the given `identifier`
476
476
  # @param identifier An Index Identifier (symbol, Intrinio ID)
477
477
  # @param tag An Intrinio data tag ID or code-name
@@ -482,7 +482,7 @@ module Intrinio
482
482
  return data
483
483
  end
484
484
 
485
- # Get SIC Index Data Point (Number)
485
+ # Data Point (Number) for an SIC Index
486
486
  # Returns a numeric value for the given &#x60;tag&#x60; for the SIC Index with the given &#x60;identifier&#x60;
487
487
  # @param identifier An Index Identifier (symbol, Intrinio ID)
488
488
  # @param tag An Intrinio data tag ID or code-name
@@ -530,7 +530,7 @@ module Intrinio
530
530
  return data, status_code, headers
531
531
  end
532
532
 
533
- # Get SIC Index Data Point (Text)
533
+ # Data Point (Text) for an SIC Index
534
534
  # Returns a text value for the given `tag` for the SIC Index with the given `identifier`
535
535
  # @param identifier An Index Identifier (symbol, Intrinio ID)
536
536
  # @param tag An Intrinio data tag ID or code-name
@@ -541,7 +541,7 @@ module Intrinio
541
541
  return data
542
542
  end
543
543
 
544
- # Get SIC Index Data Point (Text)
544
+ # Data Point (Text) for an SIC Index
545
545
  # Returns a text value for the given &#x60;tag&#x60; for the SIC Index with the given &#x60;identifier&#x60;
546
546
  # @param identifier An Index Identifier (symbol, Intrinio ID)
547
547
  # @param tag An Intrinio data tag ID or code-name
@@ -589,7 +589,7 @@ module Intrinio
589
589
  return data, status_code, headers
590
590
  end
591
591
 
592
- # Get SIC Index Historical Data
592
+ # Historical Data for an SIC Index
593
593
  # Returns historical values for the given `tag` and the SIC Index with the given `identifier`
594
594
  # @param identifier An Index Identifier (symbol, Intrinio ID)
595
595
  # @param tag An Intrinio data tag ID or code-name
@@ -605,7 +605,7 @@ module Intrinio
605
605
  return data
606
606
  end
607
607
 
608
- # Get SIC Index Historical Data
608
+ # Historical Data for an SIC Index
609
609
  # Returns historical values for the given &#x60;tag&#x60; and the SIC Index with the given &#x60;identifier&#x60;
610
610
  # @param identifier An Index Identifier (symbol, Intrinio ID)
611
611
  # @param tag An Intrinio data tag ID or code-name
@@ -666,7 +666,7 @@ module Intrinio
666
666
  return data, status_code, headers
667
667
  end
668
668
 
669
- # Get a Stock Market Index by ID
669
+ # Lookup Stock Market Index
670
670
  #
671
671
  # @param identifier An Index Identifier (symbol, Intrinio ID)
672
672
  # @param [Hash] opts the optional parameters
@@ -676,7 +676,7 @@ module Intrinio
676
676
  return data
677
677
  end
678
678
 
679
- # Get a Stock Market Index by ID
679
+ # Lookup Stock Market Index
680
680
  #
681
681
  # @param identifier An Index Identifier (symbol, Intrinio ID)
682
682
  # @param [Hash] opts the optional parameters
@@ -719,7 +719,7 @@ module Intrinio
719
719
  return data, status_code, headers
720
720
  end
721
721
 
722
- # Get Stock Market Index Data Point (Number)
722
+ # Data Point (Number) for Stock Market Index
723
723
  # Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier`
724
724
  # @param identifier An Index Identifier (symbol, Intrinio ID)
725
725
  # @param tag An Intrinio data tag ID or code-name
@@ -730,7 +730,7 @@ module Intrinio
730
730
  return data
731
731
  end
732
732
 
733
- # Get Stock Market Index Data Point (Number)
733
+ # Data Point (Number) for Stock Market Index
734
734
  # Returns a numeric value for the given &#x60;tag&#x60; for the Stock Market Index with the given &#x60;identifier&#x60;
735
735
  # @param identifier An Index Identifier (symbol, Intrinio ID)
736
736
  # @param tag An Intrinio data tag ID or code-name
@@ -778,7 +778,7 @@ module Intrinio
778
778
  return data, status_code, headers
779
779
  end
780
780
 
781
- # Get Stock Market Index Data Point (Text)
781
+ # Data Point (Text) for Stock Market Index
782
782
  # Returns a text value for the given `tag` for the Stock Market Index with the given `identifier`
783
783
  # @param identifier An Index Identifier (symbol, Intrinio ID)
784
784
  # @param tag An Intrinio data tag ID or code-name
@@ -789,7 +789,7 @@ module Intrinio
789
789
  return data
790
790
  end
791
791
 
792
- # Get Stock Market Index Data Point (Text)
792
+ # Data Point (Text) for Stock Market Index
793
793
  # Returns a text value for the given &#x60;tag&#x60; for the Stock Market Index with the given &#x60;identifier&#x60;
794
794
  # @param identifier An Index Identifier (symbol, Intrinio ID)
795
795
  # @param tag An Intrinio data tag ID or code-name
@@ -837,7 +837,7 @@ module Intrinio
837
837
  return data, status_code, headers
838
838
  end
839
839
 
840
- # Get Stock Market Index Historical Data
840
+ # Historical Data for Stock Market Index
841
841
  # Returns historical values for the given `tag` and the Stock Market Index with the given `identifier`
842
842
  # @param identifier An Index Identifier (symbol, Intrinio ID)
843
843
  # @param tag An Intrinio data tag ID or code-name
@@ -853,7 +853,7 @@ module Intrinio
853
853
  return data
854
854
  end
855
855
 
856
- # Get Stock Market Index Historical Data
856
+ # Historical Data for Stock Market Index
857
857
  # Returns historical values for the given &#x60;tag&#x60; and the Stock Market Index with the given &#x60;identifier&#x60;
858
858
  # @param identifier An Index Identifier (symbol, Intrinio ID)
859
859
  # @param tag An Intrinio data tag ID or code-name
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.0.0
6
+ OpenAPI spec version: 2.1.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -20,7 +20,7 @@ module Intrinio
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- # Get All Securiites
23
+ # All Securities
24
24
  #
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -30,7 +30,7 @@ module Intrinio
30
30
  return data
31
31
  end
32
32
 
33
- # Get All Securiites
33
+ # All Securities
34
34
  #
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -70,8 +70,8 @@ module Intrinio
70
70
  return data, status_code, headers
71
71
  end
72
72
 
73
- # Get a Security by ID
74
- #
73
+ # Lookup Security
74
+ # Returns the Security with the given `identifier`
75
75
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
76
76
  # @param [Hash] opts the optional parameters
77
77
  # @return [Security]
@@ -80,8 +80,8 @@ module Intrinio
80
80
  return data
81
81
  end
82
82
 
83
- # Get a Security by ID
84
- #
83
+ # Lookup Security
84
+ # Returns the Security with the given &#x60;identifier&#x60;
85
85
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @return [Array<(Security, Fixnum, Hash)>] Security data, response status code and response headers
@@ -123,7 +123,7 @@ module Intrinio
123
123
  return data, status_code, headers
124
124
  end
125
125
 
126
- # Get Security Data Point (Number)
126
+ # Data Point (Number) for Security
127
127
  # Returns a numeric value for the given `tag` for the Security with the given `identifier`
128
128
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
129
129
  # @param tag An Intrinio data tag ID or code-name
@@ -134,7 +134,7 @@ module Intrinio
134
134
  return data
135
135
  end
136
136
 
137
- # Get Security Data Point (Number)
137
+ # Data Point (Number) for Security
138
138
  # Returns a numeric value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;
139
139
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
140
140
  # @param tag An Intrinio data tag ID or code-name
@@ -182,7 +182,7 @@ module Intrinio
182
182
  return data, status_code, headers
183
183
  end
184
184
 
185
- # Get Security Data Point (Text)
185
+ # Data Point (Text) for Security
186
186
  # Returns a text value for the given `tag` for the Security with the given `identifier`
187
187
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
188
188
  # @param tag An Intrinio data tag ID or code-name
@@ -193,7 +193,7 @@ module Intrinio
193
193
  return data
194
194
  end
195
195
 
196
- # Get Security Data Point (Text)
196
+ # Data Point (Text) for Security
197
197
  # Returns a text value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;
198
198
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
199
199
  # @param tag An Intrinio data tag ID or code-name
@@ -241,11 +241,12 @@ module Intrinio
241
241
  return data, status_code, headers
242
242
  end
243
243
 
244
- # Get Security Historical Data
244
+ # Historical Data for Security
245
245
  # Returns historical values for the given `tag` and the Security with the given `identifier`
246
246
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
247
247
  # @param tag An Intrinio data tag ID or code-name
248
248
  # @param [Hash] opts the optional parameters
249
+ # @option opts [String] :frequency Return historical data in the given frequency (default to daily)
249
250
  # @option opts [String] :type Filter by type, when applicable
250
251
  # @option opts [Date] :start_date Get historical data on or after this date
251
252
  # @option opts [Date] :end_date Get historical date on or before this date
@@ -257,11 +258,12 @@ module Intrinio
257
258
  return data
258
259
  end
259
260
 
260
- # Get Security Historical Data
261
+ # Historical Data for Security
261
262
  # Returns historical values for the given &#x60;tag&#x60; and the Security with the given &#x60;identifier&#x60;
262
263
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
263
264
  # @param tag An Intrinio data tag ID or code-name
264
265
  # @param [Hash] opts the optional parameters
266
+ # @option opts [String] :frequency Return historical data in the given frequency
265
267
  # @option opts [String] :type Filter by type, when applicable
266
268
  # @option opts [Date] :start_date Get historical data on or after this date
267
269
  # @option opts [Date] :end_date Get historical date on or before this date
@@ -280,6 +282,9 @@ module Intrinio
280
282
  if @api_client.config.client_side_validation && tag.nil?
281
283
  fail ArgumentError, "Missing the required parameter 'tag' when calling SecurityApi.get_security_historical_data"
282
284
  end
285
+ if @api_client.config.client_side_validation && opts[:'frequency'] && !['daily', 'weekly', 'monthly', 'quarterly', 'yearly'].include?(opts[:'frequency'])
286
+ fail ArgumentError, 'invalid value for "frequency", must be one of daily, weekly, monthly, quarterly, yearly'
287
+ end
283
288
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
284
289
  fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
285
290
  end
@@ -288,6 +293,7 @@ module Intrinio
288
293
 
289
294
  # query parameters
290
295
  query_params = {}
296
+ query_params[:'frequency'] = opts[:'frequency'] if !opts[:'frequency'].nil?
291
297
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
292
298
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
293
299
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
@@ -318,8 +324,173 @@ module Intrinio
318
324
  return data, status_code, headers
319
325
  end
320
326
 
321
- # Get Stock Price Adjustments for Security
322
- # Return stock price adjustments for the Security with the given `identifier`
327
+ # Lastest Dividend Record for Security
328
+ # Returns the latest available dividend information for the Security with the given `identifier`
329
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
330
+ # @param [Hash] opts the optional parameters
331
+ # @return [DividendRecord]
332
+ def get_security_latest_dividend_record(identifier, opts = {})
333
+ data, _status_code, _headers = get_security_latest_dividend_record_with_http_info(identifier, opts)
334
+ return data
335
+ end
336
+
337
+ # Lastest Dividend Record for Security
338
+ # Returns the latest available dividend information for the Security with the given &#x60;identifier&#x60;
339
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
340
+ # @param [Hash] opts the optional parameters
341
+ # @return [Array<(DividendRecord, Fixnum, Hash)>] DividendRecord data, response status code and response headers
342
+ def get_security_latest_dividend_record_with_http_info(identifier, opts = {})
343
+ if @api_client.config.debugging
344
+ @api_client.config.logger.debug "Calling API: SecurityApi.get_security_latest_dividend_record ..."
345
+ end
346
+ # verify the required parameter 'identifier' is set
347
+ if @api_client.config.client_side_validation && identifier.nil?
348
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling SecurityApi.get_security_latest_dividend_record"
349
+ end
350
+ # resource path
351
+ local_var_path = "/securities/{identifier}/dividends/latest".sub('{' + 'identifier' + '}', identifier.to_s)
352
+
353
+ # query parameters
354
+ query_params = {}
355
+
356
+ # header parameters
357
+ header_params = {}
358
+ # HTTP header 'Accept' (if needed)
359
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
360
+
361
+ # form parameters
362
+ form_params = {}
363
+
364
+ # http body (model)
365
+ post_body = nil
366
+ auth_names = ['ApiKeyAuth']
367
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
368
+ :header_params => header_params,
369
+ :query_params => query_params,
370
+ :form_params => form_params,
371
+ :body => post_body,
372
+ :auth_names => auth_names,
373
+ :return_type => 'DividendRecord')
374
+ if @api_client.config.debugging
375
+ @api_client.config.logger.debug "API called: SecurityApi#get_security_latest_dividend_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
376
+ end
377
+ return data, status_code, headers
378
+ end
379
+
380
+ # Lastest Earnings Record for Security
381
+ # Returns latest available earnings information for the Security with the given `identifier`
382
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
383
+ # @param [Hash] opts the optional parameters
384
+ # @return [EarningsRecord]
385
+ def get_security_latest_earnings_record(identifier, opts = {})
386
+ data, _status_code, _headers = get_security_latest_earnings_record_with_http_info(identifier, opts)
387
+ return data
388
+ end
389
+
390
+ # Lastest Earnings Record for Security
391
+ # Returns latest available earnings information for the Security with the given &#x60;identifier&#x60;
392
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
393
+ # @param [Hash] opts the optional parameters
394
+ # @return [Array<(EarningsRecord, Fixnum, Hash)>] EarningsRecord data, response status code and response headers
395
+ def get_security_latest_earnings_record_with_http_info(identifier, opts = {})
396
+ if @api_client.config.debugging
397
+ @api_client.config.logger.debug "Calling API: SecurityApi.get_security_latest_earnings_record ..."
398
+ end
399
+ # verify the required parameter 'identifier' is set
400
+ if @api_client.config.client_side_validation && identifier.nil?
401
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling SecurityApi.get_security_latest_earnings_record"
402
+ end
403
+ # resource path
404
+ local_var_path = "/securities/{identifier}/earnings/latest".sub('{' + 'identifier' + '}', identifier.to_s)
405
+
406
+ # query parameters
407
+ query_params = {}
408
+
409
+ # header parameters
410
+ header_params = {}
411
+ # HTTP header 'Accept' (if needed)
412
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
413
+
414
+ # form parameters
415
+ form_params = {}
416
+
417
+ # http body (model)
418
+ post_body = nil
419
+ auth_names = ['ApiKeyAuth']
420
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
421
+ :header_params => header_params,
422
+ :query_params => query_params,
423
+ :form_params => form_params,
424
+ :body => post_body,
425
+ :auth_names => auth_names,
426
+ :return_type => 'EarningsRecord')
427
+ if @api_client.config.debugging
428
+ @api_client.config.logger.debug "API called: SecurityApi#get_security_latest_earnings_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
429
+ end
430
+ return data, status_code, headers
431
+ end
432
+
433
+ # Realtime Stock Price for Security
434
+ # Return the realtime stock price for the Security with the given `identifier`
435
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
436
+ # @param [Hash] opts the optional parameters
437
+ # @option opts [String] :source Return the realtime price from the specified data source
438
+ # @return [RealtimeStockPrice]
439
+ def get_security_realtime_price(identifier, opts = {})
440
+ data, _status_code, _headers = get_security_realtime_price_with_http_info(identifier, opts)
441
+ return data
442
+ end
443
+
444
+ # Realtime Stock Price for Security
445
+ # Return the realtime stock price for the Security with the given &#x60;identifier&#x60;
446
+ # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
447
+ # @param [Hash] opts the optional parameters
448
+ # @option opts [String] :source Return the realtime price from the specified data source
449
+ # @return [Array<(RealtimeStockPrice, Fixnum, Hash)>] RealtimeStockPrice data, response status code and response headers
450
+ def get_security_realtime_price_with_http_info(identifier, opts = {})
451
+ if @api_client.config.debugging
452
+ @api_client.config.logger.debug "Calling API: SecurityApi.get_security_realtime_price ..."
453
+ end
454
+ # verify the required parameter 'identifier' is set
455
+ if @api_client.config.client_side_validation && identifier.nil?
456
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling SecurityApi.get_security_realtime_price"
457
+ end
458
+ if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats', 'bats_delayed'].include?(opts[:'source'])
459
+ fail ArgumentError, 'invalid value for "source", must be one of iex, bats, bats_delayed'
460
+ end
461
+ # resource path
462
+ local_var_path = "/securities/{identifier}/prices/realtime".sub('{' + 'identifier' + '}', identifier.to_s)
463
+
464
+ # query parameters
465
+ query_params = {}
466
+ query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
467
+
468
+ # header parameters
469
+ header_params = {}
470
+ # HTTP header 'Accept' (if needed)
471
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
472
+
473
+ # form parameters
474
+ form_params = {}
475
+
476
+ # http body (model)
477
+ post_body = nil
478
+ auth_names = ['ApiKeyAuth']
479
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
480
+ :header_params => header_params,
481
+ :query_params => query_params,
482
+ :form_params => form_params,
483
+ :body => post_body,
484
+ :auth_names => auth_names,
485
+ :return_type => 'RealtimeStockPrice')
486
+ if @api_client.config.debugging
487
+ @api_client.config.logger.debug "API called: SecurityApi#get_security_realtime_price\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
488
+ end
489
+ return data, status_code, headers
490
+ end
491
+
492
+ # Stock Price Adjustments by Security
493
+ # Returns stock price adjustments for the Security with the given `identifier`
323
494
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
324
495
  # @param [Hash] opts the optional parameters
325
496
  # @option opts [Date] :start_date Return price adjustments on or after the date
@@ -331,8 +502,8 @@ module Intrinio
331
502
  return data
332
503
  end
333
504
 
334
- # Get Stock Price Adjustments for Security
335
- # Return stock price adjustments for the Security with the given &#x60;identifier&#x60;
505
+ # Stock Price Adjustments by Security
506
+ # Returns stock price adjustments for the Security with the given &#x60;identifier&#x60;
336
507
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
337
508
  # @param [Hash] opts the optional parameters
338
509
  # @option opts [Date] :start_date Return price adjustments on or after the date
@@ -380,8 +551,8 @@ module Intrinio
380
551
  return data, status_code, headers
381
552
  end
382
553
 
383
- # Get Stock Prices for Security
384
- # Return stock prices for the Security with the given `identifier`
554
+ # Stock Prices by Security
555
+ # Return end-of-day stock prices for the Security with the given `identifier`
385
556
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
386
557
  # @param [Hash] opts the optional parameters
387
558
  # @option opts [Date] :start_date Return prices on or after the date
@@ -394,8 +565,8 @@ module Intrinio
394
565
  return data
395
566
  end
396
567
 
397
- # Get Stock Prices for Security
398
- # Return stock prices for the Security with the given &#x60;identifier&#x60;
568
+ # Stock Prices by Security
569
+ # Return end-of-day stock prices for the Security with the given &#x60;identifier&#x60;
399
570
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
400
571
  # @param [Hash] opts the optional parameters
401
572
  # @option opts [Date] :start_date Return prices on or after the date
@@ -449,7 +620,7 @@ module Intrinio
449
620
  end
450
621
 
451
622
  # Screen Securities
452
- # Screen securities using complex logic
623
+ # Screen Securities using complex logic
453
624
  # @param [Hash] opts the optional parameters
454
625
  # @option opts [SecurityScreenGroup] :logic The logic to screen with, consisting of operators, clauses, and nested groups.&lt;br/&gt; See &lt;a href&#x3D;\&quot;/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
455
626
  # @option opts [String] :order_column Results returned sorted by this column
@@ -462,7 +633,7 @@ module Intrinio
462
633
  end
463
634
 
464
635
  # Screen Securities
465
- # Screen securities using complex logic
636
+ # Screen Securities using complex logic
466
637
  # @param [Hash] opts the optional parameters
467
638
  # @option opts [SecurityScreenGroup] :logic The logic to screen with, consisting of operators, clauses, and nested groups.&lt;br/&gt; See &lt;a href&#x3D;\&quot;/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
468
639
  # @option opts [String] :order_column Results returned sorted by this column