intrinio-sdk 2.0.0 → 2.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (120) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -2
  3. data/docs/ApiResponseForexCurrencies.md +8 -0
  4. data/docs/ApiResponseForexPairs.md +8 -0
  5. data/docs/ApiResponseForexPrices.md +10 -0
  6. data/docs/ForexApi.md +138 -0
  7. data/docs/ForexCurrency.md +10 -0
  8. data/docs/ForexPair.md +10 -0
  9. data/docs/ForexPrice.md +17 -0
  10. data/intrinio-sdk-2.0.0.gem +0 -0
  11. data/intrinio-sdk.gemspec +1 -1
  12. data/lib/intrinio-sdk.rb +8 -1
  13. data/lib/intrinio-sdk/api/company_api.rb +1 -1
  14. data/lib/intrinio-sdk/api/data_point_api.rb +1 -1
  15. data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
  16. data/lib/intrinio-sdk/api/filing_api.rb +1 -1
  17. data/lib/intrinio-sdk/api/forex_api.rb +208 -0
  18. data/lib/intrinio-sdk/api/fundamentals_api.rb +1 -1
  19. data/lib/intrinio-sdk/api/historical_data_api.rb +1 -1
  20. data/lib/intrinio-sdk/api/index_api.rb +1 -1
  21. data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
  22. data/lib/intrinio-sdk/api/security_api.rb +1 -1
  23. data/lib/intrinio-sdk/api/stock_exchange_api.rb +1 -1
  24. data/lib/intrinio-sdk/api_client.rb +1 -1
  25. data/lib/intrinio-sdk/api_error.rb +1 -1
  26. data/lib/intrinio-sdk/configuration.rb +1 -1
  27. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  28. data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
  29. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  30. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  31. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  32. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  33. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  34. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  35. data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
  36. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  37. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  38. data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
  39. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
  40. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
  41. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  42. data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +190 -0
  43. data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +190 -0
  44. data/lib/intrinio-sdk/models/api_response_forex_prices.rb +210 -0
  45. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  46. data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
  47. data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
  48. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  49. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  50. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  51. data/lib/intrinio-sdk/models/api_response_securities_search.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_intraday_prices.rb +1 -1
  54. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  55. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  56. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  57. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  58. data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
  59. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  60. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
  61. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  62. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  63. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  64. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  65. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  66. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  67. data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
  68. data/lib/intrinio-sdk/models/company.rb +1 -1
  69. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  70. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  71. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  72. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  73. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  74. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  75. data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
  76. data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
  77. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  78. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  79. data/lib/intrinio-sdk/models/filing.rb +1 -1
  80. data/lib/intrinio-sdk/models/filing_note.rb +1 -1
  81. data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
  82. data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
  83. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  84. data/lib/intrinio-sdk/models/forex_currency.rb +209 -0
  85. data/lib/intrinio-sdk/models/forex_pair.rb +209 -0
  86. data/lib/intrinio-sdk/models/forex_price.rb +279 -0
  87. data/lib/intrinio-sdk/models/fundamental.rb +1 -1
  88. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  89. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  90. data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
  91. data/lib/intrinio-sdk/models/municipality.rb +1 -1
  92. data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
  93. data/lib/intrinio-sdk/models/realtime_stock_price.rb +1 -1
  94. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
  95. data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
  96. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  97. data/lib/intrinio-sdk/models/security.rb +1 -1
  98. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  99. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  100. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  101. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  102. data/lib/intrinio-sdk/models/security_summary.rb +1 -1
  103. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  104. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  105. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  106. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  107. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  108. data/lib/intrinio-sdk/models/stock_price.rb +1 -1
  109. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  110. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  111. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  112. data/lib/intrinio-sdk/version.rb +2 -2
  113. data/spec/api/forex_api_spec.rb +77 -0
  114. data/spec/models/api_response_forex_currencies_spec.rb +42 -0
  115. data/spec/models/api_response_forex_pairs_spec.rb +42 -0
  116. data/spec/models/api_response_forex_prices_spec.rb +54 -0
  117. data/spec/models/forex_currency_spec.rb +54 -0
  118. data/spec/models/forex_pair_spec.rb +54 -0
  119. data/spec/models/forex_price_spec.rb +96 -0
  120. metadata +31 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: d28fbbbba20f94f4eee00841b6e28c8d8d78d7ab
4
- data.tar.gz: 8df2aab4fad7ec9b7b4a904cc8d4625d871660f2
3
+ metadata.gz: 604b86610c9e925cceded84015da9b798c89a325
4
+ data.tar.gz: d1898c9480b630d803b4bc692b32be7f53db7af9
5
5
  SHA512:
6
- metadata.gz: 0f3067f28e7c1df996939c94a42e2188e469796d21defcc028950a972980458e50b08357fbb5e2e5b7f7601217cea1360925ec138d35c3a0e98fe3e95bf45704
7
- data.tar.gz: d801858bd91319b06c6ff4f94ddd8762f7dc9199730b20438665d683e1f4282d9836db6ec6c2f1df6c627e85b8f083835f3966b5f55e1b21236970bff679a521
6
+ metadata.gz: '0180217b557231dde9795c83822dc88ee8b2cfd48a17d552c8c03a050af3c05c7727df487414d5c9803deb49a670d6fdaee4bf51a24c09f454d9e32e614eb89d'
7
+ data.tar.gz: 6c63060baf8c84b37bf07ec73e3b4dad411fb5d6421ac02dc69b23548c8c1e0576a93fab54e418c3594a75e3b623c7ef4e86e88d6ec207585465852b6b5071c2
data/README.md CHANGED
@@ -8,8 +8,8 @@ Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a
8
8
 
9
9
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
10
10
 
11
- - API version: 2.1.1
12
- - Package version: 2.0.0
11
+ - API version: 2.2.0
12
+ - Package version: 2.0.1
13
13
 
14
14
 
15
15
  ## Installation
@@ -81,6 +81,9 @@ Class | Method | HTTP request | Description
81
81
  *Intrinio::FilingApi* | [**get_note_html**](docs/FilingApi.md#get_note_html) | **GET** /filings/notes/{identifier}/html | Filing Note HTML
82
82
  *Intrinio::FilingApi* | [**get_note_text**](docs/FilingApi.md#get_note_text) | **GET** /filings/notes/{identifier}/text | Filing Note Text
83
83
  *Intrinio::FilingApi* | [**search_notes**](docs/FilingApi.md#search_notes) | **GET** /filings/notes/search | Search Filing Notes
84
+ *Intrinio::ForexApi* | [**get_forex_currencies**](docs/ForexApi.md#get_forex_currencies) | **GET** /forex/currencies | Forex Currencies
85
+ *Intrinio::ForexApi* | [**get_forex_pairs**](docs/ForexApi.md#get_forex_pairs) | **GET** /forex/pairs | Forex Currency Pairs
86
+ *Intrinio::ForexApi* | [**get_forex_prices**](docs/ForexApi.md#get_forex_prices) | **GET** /forex/prices/{pair}/{timeframe} | Forex Currency Prices
84
87
  *Intrinio::FundamentalsApi* | [**get_fundamental_by_id**](docs/FundamentalsApi.md#get_fundamental_by_id) | **GET** /fundamentals/{id} | Fundamental by ID
85
88
  *Intrinio::FundamentalsApi* | [**get_fundamental_reported_financials**](docs/FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials
86
89
  *Intrinio::FundamentalsApi* | [**get_fundamental_standardized_financials**](docs/FundamentalsApi.md#get_fundamental_standardized_financials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials
@@ -145,6 +148,9 @@ Class | Method | HTTP request | Description
145
148
  - [Intrinio::ApiResponseFilingNotes](docs/ApiResponseFilingNotes.md)
146
149
  - [Intrinio::ApiResponseFilingNotesSearch](docs/ApiResponseFilingNotesSearch.md)
147
150
  - [Intrinio::ApiResponseFilings](docs/ApiResponseFilings.md)
151
+ - [Intrinio::ApiResponseForexCurrencies](docs/ApiResponseForexCurrencies.md)
152
+ - [Intrinio::ApiResponseForexPairs](docs/ApiResponseForexPairs.md)
153
+ - [Intrinio::ApiResponseForexPrices](docs/ApiResponseForexPrices.md)
148
154
  - [Intrinio::ApiResponseHistoricalData](docs/ApiResponseHistoricalData.md)
149
155
  - [Intrinio::ApiResponseMunicipalities](docs/ApiResponseMunicipalities.md)
150
156
  - [Intrinio::ApiResponseMunicipalitiyFinancials](docs/ApiResponseMunicipalitiyFinancials.md)
@@ -184,6 +190,9 @@ Class | Method | HTTP request | Description
184
190
  - [Intrinio::FilingNoteFiling](docs/FilingNoteFiling.md)
185
191
  - [Intrinio::FilingNoteSummary](docs/FilingNoteSummary.md)
186
192
  - [Intrinio::FilingSummary](docs/FilingSummary.md)
193
+ - [Intrinio::ForexCurrency](docs/ForexCurrency.md)
194
+ - [Intrinio::ForexPair](docs/ForexPair.md)
195
+ - [Intrinio::ForexPrice](docs/ForexPrice.md)
187
196
  - [Intrinio::Fundamental](docs/Fundamental.md)
188
197
  - [Intrinio::FundamentalSummary](docs/FundamentalSummary.md)
189
198
  - [Intrinio::HistoricalData](docs/HistoricalData.md)
@@ -0,0 +1,8 @@
1
+ # Intrinio::ApiResponseForexCurrencies
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **currencies** | [**Array<ForexCurrency>**](ForexCurrency.md) | | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # Intrinio::ApiResponseForexPairs
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **pairs** | [**Array<ForexPair>**](ForexPair.md) | | [optional]
7
+
8
+
@@ -0,0 +1,10 @@
1
+ # Intrinio::ApiResponseForexPrices
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **prices** | [**Array<ForexPrice>**](ForexPrice.md) | | [optional]
7
+ **pair** | [**ForexPair**](ForexPair.md) | The Forex currency pair for which prices were requested | [optional]
8
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
9
+
10
+
data/docs/ForexApi.md ADDED
@@ -0,0 +1,138 @@
1
+ # Intrinio::ForexApi
2
+
3
+ All URIs are relative to *https://api-v2.intrinio.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_forex_currencies**](ForexApi.md#get_forex_currencies) | **GET** /forex/currencies | Forex Currencies
8
+ [**get_forex_pairs**](ForexApi.md#get_forex_pairs) | **GET** /forex/pairs | Forex Currency Pairs
9
+ [**get_forex_prices**](ForexApi.md#get_forex_prices) | **GET** /forex/prices/{pair}/{timeframe} | Forex Currency Prices
10
+
11
+
12
+ # **get_forex_currencies**
13
+ > ApiResponseForexCurrencies get_forex_currencies
14
+
15
+ Forex Currencies
16
+
17
+ Returns a list of forex currencies for which prices are available.
18
+
19
+ ### Example
20
+ ```ruby
21
+ # Load the gem
22
+ require 'intrinio-sdk'
23
+
24
+ # Setup authorization
25
+ Intrinio.configure do |config|
26
+ config.api_key['api_key'] = 'YOUR API KEY'
27
+ end
28
+
29
+ forex_api = Intrinio::ForexApi.new
30
+
31
+ begin
32
+ result = forex_api.get_forex_currencies
33
+ p result
34
+ rescue Intrinio::ApiError => e
35
+ puts "Exception when calling ForexApi->get_forex_currencies: #{e}"
36
+ end
37
+ ```
38
+
39
+ ### Parameters
40
+ This endpoint does not need any parameter.
41
+
42
+ ### Return type
43
+
44
+ [**ApiResponseForexCurrencies**](ApiResponseForexCurrencies.md)
45
+
46
+ # **get_forex_pairs**
47
+ > ApiResponseForexPairs get_forex_pairs
48
+
49
+ Forex Currency Pairs
50
+
51
+ Returns a list of currency pairs used to request foreign exchange (forex) market price data. The currency that is used as the reference is called quote currency and the currency that is quoted in relation is called the base currency. For example, in the pair code “EURGBP” with a price of 0.88, one Euro (base currency) can be exchanged for 0.88 British Pounds (quote currency).
52
+
53
+ ### Example
54
+ ```ruby
55
+ # Load the gem
56
+ require 'intrinio-sdk'
57
+
58
+ # Setup authorization
59
+ Intrinio.configure do |config|
60
+ config.api_key['api_key'] = 'YOUR API KEY'
61
+ end
62
+
63
+ forex_api = Intrinio::ForexApi.new
64
+
65
+ begin
66
+ result = forex_api.get_forex_pairs
67
+ p result
68
+ rescue Intrinio::ApiError => e
69
+ puts "Exception when calling ForexApi->get_forex_pairs: #{e}"
70
+ end
71
+ ```
72
+
73
+ ### Parameters
74
+ This endpoint does not need any parameter.
75
+
76
+ ### Return type
77
+
78
+ [**ApiResponseForexPairs**](ApiResponseForexPairs.md)
79
+
80
+ # **get_forex_prices**
81
+ > ApiResponseForexPrices get_forex_prices(pair, timeframe, opts)
82
+
83
+ Forex Currency Prices
84
+
85
+ Provides a list of forex price quotes for a given forex currency pair and timeframe.
86
+
87
+ ### Example
88
+ ```ruby
89
+ # Load the gem
90
+ require 'intrinio-sdk'
91
+
92
+ # Setup authorization
93
+ Intrinio.configure do |config|
94
+ config.api_key['api_key'] = 'YOUR API KEY'
95
+ end
96
+
97
+ forex_api = Intrinio::ForexApi.new
98
+
99
+ pair = "EURUSD" # String | The Forex Currency Pair code
100
+
101
+ timeframe = "D1" # String | The time interval for the quotes
102
+
103
+ opts = {
104
+ timezone: "UTC", # String | Returns trading times in this timezone
105
+ start_date: "2018-01-01", # String | Return Forex Prices on or after this date
106
+ start_time: "14:20:00", # String | Return Forex Prices at or after this time (24-hour)
107
+ end_date: "2019-01-01", # String | Return Forex Prices on or before this date
108
+ end_time: "21:01:21", # String | Return Forex Prices at or before this time (24-hour)
109
+ page_size: 100, # Integer | The number of results to return
110
+ next_page: nil # String | Gets the next page of data from a previous API call
111
+ }
112
+
113
+ begin
114
+ result = forex_api.get_forex_prices(pair, timeframe, opts)
115
+ p result
116
+ rescue Intrinio::ApiError => e
117
+ puts "Exception when calling ForexApi->get_forex_prices: #{e}"
118
+ end
119
+ ```
120
+
121
+ ### Parameters
122
+
123
+ Name | Type | Description | Notes
124
+ ------------- | ------------- | ------------- | -------------
125
+ **pair** | **String**| The Forex Currency Pair code |
126
+ **timeframe** | **String**| The time interval for the quotes |
127
+ **timezone** | **String**| Returns trading times in this timezone | [optional] [default to UTC]
128
+ **start_date** | **String**| Return Forex Prices on or after this date | [optional]
129
+ **start_time** | **String**| Return Forex Prices at or after this time (24-hour) | [optional]
130
+ **end_date** | **String**| Return Forex Prices on or before this date | [optional]
131
+ **end_time** | **String**| Return Forex Prices at or before this time (24-hour) | [optional]
132
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
133
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
134
+
135
+ ### Return type
136
+
137
+ [**ApiResponseForexPrices**](ApiResponseForexPrices.md)
138
+
@@ -0,0 +1,10 @@
1
+ # Intrinio::ForexCurrency
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | The ISO 4217 currency code | [optional]
7
+ **name** | **String** | The name of the currency | [optional]
8
+ **country** | **String** | The country in which the currency is used | [optional]
9
+
10
+
data/docs/ForexPair.md ADDED
@@ -0,0 +1,10 @@
1
+ # Intrinio::ForexPair
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | The common code of the currency pair | [optional]
7
+ **base_currency** | **String** | The ISO 4217 currency code of the base currency | [optional]
8
+ **quote_currency** | **String** | The ISO 4217 currency code of the quote currency | [optional]
9
+
10
+
@@ -0,0 +1,17 @@
1
+ # Intrinio::ForexPrice
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **occurred_at** | **String** | The timestamp of the beginning of the timeframe. The open prices would be at this time, while close prices would be at this time plus the timeframe. | [optional]
7
+ **open_bid** | **Float** | Open bid | [optional]
8
+ **high_bid** | **Float** | High bid | [optional]
9
+ **low_bid** | **Float** | Low bid | [optional]
10
+ **close_bid** | **Float** | Close bid | [optional]
11
+ **open_ask** | **Float** | Open ask | [optional]
12
+ **high_ask** | **Float** | High ask | [optional]
13
+ **low_ask** | **Float** | Low ask | [optional]
14
+ **close_ask** | **Float** | Close ask | [optional]
15
+ **total_ticks** | **Integer** | Total ticks | [optional]
16
+
17
+
Binary file
data/intrinio-sdk.gemspec CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  #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.
7
7
 
8
- OpenAPI spec version: 2.1.1
8
+ OpenAPI spec version: 2.2.0
9
9
 
10
10
  Generated by: https://github.com/swagger-api/swagger-codegen.git
11
11
  Swagger Codegen version: 2.3.0-SNAPSHOT
data/lib/intrinio-sdk.rb CHANGED
@@ -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.1.1
6
+ OpenAPI spec version: 2.2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -32,6 +32,9 @@ require 'intrinio-sdk/models/api_response_economic_indices_search'
32
32
  require 'intrinio-sdk/models/api_response_filing_notes'
33
33
  require 'intrinio-sdk/models/api_response_filing_notes_search'
34
34
  require 'intrinio-sdk/models/api_response_filings'
35
+ require 'intrinio-sdk/models/api_response_forex_currencies'
36
+ require 'intrinio-sdk/models/api_response_forex_pairs'
37
+ require 'intrinio-sdk/models/api_response_forex_prices'
35
38
  require 'intrinio-sdk/models/api_response_historical_data'
36
39
  require 'intrinio-sdk/models/api_response_municipalities'
37
40
  require 'intrinio-sdk/models/api_response_municipalitiy_financials'
@@ -71,6 +74,9 @@ require 'intrinio-sdk/models/filing_note'
71
74
  require 'intrinio-sdk/models/filing_note_filing'
72
75
  require 'intrinio-sdk/models/filing_note_summary'
73
76
  require 'intrinio-sdk/models/filing_summary'
77
+ require 'intrinio-sdk/models/forex_currency'
78
+ require 'intrinio-sdk/models/forex_pair'
79
+ require 'intrinio-sdk/models/forex_price'
74
80
  require 'intrinio-sdk/models/fundamental'
75
81
  require 'intrinio-sdk/models/fundamental_summary'
76
82
  require 'intrinio-sdk/models/historical_data'
@@ -102,6 +108,7 @@ require 'intrinio-sdk/api/company_api'
102
108
  require 'intrinio-sdk/api/data_point_api'
103
109
  require 'intrinio-sdk/api/data_tag_api'
104
110
  require 'intrinio-sdk/api/filing_api'
111
+ require 'intrinio-sdk/api/forex_api'
105
112
  require 'intrinio-sdk/api/fundamentals_api'
106
113
  require 'intrinio-sdk/api/historical_data_api'
107
114
  require 'intrinio-sdk/api/index_api'
@@ -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.1.1
6
+ OpenAPI spec version: 2.2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -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.1.1
6
+ OpenAPI spec version: 2.2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -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.1.1
6
+ OpenAPI spec version: 2.2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -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.1.1
6
+ OpenAPI spec version: 2.2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -0,0 +1,208 @@
1
+ =begin
2
+ #Intrinio API
3
+
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
+
6
+ OpenAPI spec version: 2.2.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require "uri"
14
+
15
+ module Intrinio
16
+ class ForexApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ # Forex Currencies
24
+ # Returns a list of forex currencies for which prices are available.
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [ApiResponseForexCurrencies]
27
+ def get_forex_currencies(opts = {})
28
+ data, _status_code, _headers = get_forex_currencies_with_http_info(opts)
29
+ return data
30
+ end
31
+
32
+ # Forex Currencies
33
+ # Returns a list of forex currencies for which prices are available.
34
+ # @param [Hash] opts the optional parameters
35
+ # @return [Array<(ApiResponseForexCurrencies, Fixnum, Hash)>] ApiResponseForexCurrencies data, response status code and response headers
36
+ def get_forex_currencies_with_http_info(opts = {})
37
+ if @api_client.config.debugging
38
+ @api_client.config.logger.debug "Calling API: ForexApi.get_forex_currencies ..."
39
+ end
40
+ # resource path
41
+ local_var_path = "/forex/currencies"
42
+
43
+ # query parameters
44
+ query_params = {}
45
+
46
+ # header parameters
47
+ header_params = {}
48
+ # HTTP header 'Accept' (if needed)
49
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
50
+
51
+ # form parameters
52
+ form_params = {}
53
+
54
+ # http body (model)
55
+ post_body = nil
56
+ auth_names = ['ApiKeyAuth']
57
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
58
+ :header_params => header_params,
59
+ :query_params => query_params,
60
+ :form_params => form_params,
61
+ :body => post_body,
62
+ :auth_names => auth_names,
63
+ :return_type => 'ApiResponseForexCurrencies')
64
+ if @api_client.config.debugging
65
+ @api_client.config.logger.debug "API called: ForexApi#get_forex_currencies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
66
+ end
67
+ return data, status_code, headers
68
+ end
69
+
70
+ # Forex Currency Pairs
71
+ # Returns a list of currency pairs used to request foreign exchange (forex) market price data. The currency that is used as the reference is called quote currency and the currency that is quoted in relation is called the base currency. For example, in the pair code “EURGBP” with a price of 0.88, one Euro (base currency) can be exchanged for 0.88 British Pounds (quote currency).
72
+ # @param [Hash] opts the optional parameters
73
+ # @return [ApiResponseForexPairs]
74
+ def get_forex_pairs(opts = {})
75
+ data, _status_code, _headers = get_forex_pairs_with_http_info(opts)
76
+ return data
77
+ end
78
+
79
+ # Forex Currency Pairs
80
+ # Returns a list of currency pairs used to request foreign exchange (forex) market price data. The currency that is used as the reference is called quote currency and the currency that is quoted in relation is called the base currency. For example, in the pair code “EURGBP” with a price of 0.88, one Euro (base currency) can be exchanged for 0.88 British Pounds (quote currency).
81
+ # @param [Hash] opts the optional parameters
82
+ # @return [Array<(ApiResponseForexPairs, Fixnum, Hash)>] ApiResponseForexPairs data, response status code and response headers
83
+ def get_forex_pairs_with_http_info(opts = {})
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "Calling API: ForexApi.get_forex_pairs ..."
86
+ end
87
+ # resource path
88
+ local_var_path = "/forex/pairs"
89
+
90
+ # query parameters
91
+ query_params = {}
92
+
93
+ # header parameters
94
+ header_params = {}
95
+ # HTTP header 'Accept' (if needed)
96
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
97
+
98
+ # form parameters
99
+ form_params = {}
100
+
101
+ # http body (model)
102
+ post_body = nil
103
+ auth_names = ['ApiKeyAuth']
104
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
105
+ :header_params => header_params,
106
+ :query_params => query_params,
107
+ :form_params => form_params,
108
+ :body => post_body,
109
+ :auth_names => auth_names,
110
+ :return_type => 'ApiResponseForexPairs')
111
+ if @api_client.config.debugging
112
+ @api_client.config.logger.debug "API called: ForexApi#get_forex_pairs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
113
+ end
114
+ return data, status_code, headers
115
+ end
116
+
117
+ # Forex Currency Prices
118
+ # Provides a list of forex price quotes for a given forex currency pair and timeframe.
119
+ # @param pair The Forex Currency Pair code
120
+ # @param timeframe The time interval for the quotes
121
+ # @param [Hash] opts the optional parameters
122
+ # @option opts [String] :timezone Returns trading times in this timezone (default to UTC)
123
+ # @option opts [String] :start_date Return Forex Prices on or after this date
124
+ # @option opts [String] :start_time Return Forex Prices at or after this time (24-hour)
125
+ # @option opts [String] :end_date Return Forex Prices on or before this date
126
+ # @option opts [String] :end_time Return Forex Prices at or before this time (24-hour)
127
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
128
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
129
+ # @return [ApiResponseForexPrices]
130
+ def get_forex_prices(pair, timeframe, opts = {})
131
+ data, _status_code, _headers = get_forex_prices_with_http_info(pair, timeframe, opts)
132
+ return data
133
+ end
134
+
135
+ # Forex Currency Prices
136
+ # Provides a list of forex price quotes for a given forex currency pair and timeframe.
137
+ # @param pair The Forex Currency Pair code
138
+ # @param timeframe The time interval for the quotes
139
+ # @param [Hash] opts the optional parameters
140
+ # @option opts [String] :timezone Returns trading times in this timezone
141
+ # @option opts [String] :start_date Return Forex Prices on or after this date
142
+ # @option opts [String] :start_time Return Forex Prices at or after this time (24-hour)
143
+ # @option opts [String] :end_date Return Forex Prices on or before this date
144
+ # @option opts [String] :end_time Return Forex Prices at or before this time (24-hour)
145
+ # @option opts [Integer] :page_size The number of results to return
146
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
147
+ # @return [Array<(ApiResponseForexPrices, Fixnum, Hash)>] ApiResponseForexPrices data, response status code and response headers
148
+ def get_forex_prices_with_http_info(pair, timeframe, opts = {})
149
+ if @api_client.config.debugging
150
+ @api_client.config.logger.debug "Calling API: ForexApi.get_forex_prices ..."
151
+ end
152
+ # verify the required parameter 'pair' is set
153
+ if @api_client.config.client_side_validation && pair.nil?
154
+ fail ArgumentError, "Missing the required parameter 'pair' when calling ForexApi.get_forex_prices"
155
+ end
156
+ # verify the required parameter 'timeframe' is set
157
+ if @api_client.config.client_side_validation && timeframe.nil?
158
+ fail ArgumentError, "Missing the required parameter 'timeframe' when calling ForexApi.get_forex_prices"
159
+ end
160
+ # verify enum value
161
+ if @api_client.config.client_side_validation && !['m1', 'm5', 'm15', 'm30', 'H1', 'H2', 'H3', 'H4', 'H6', 'H8', 'D1', 'W1', 'M1'].include?(timeframe)
162
+ fail ArgumentError, "invalid value for 'timeframe', must be one of m1, m5, m15, m30, H1, H2, H3, H4, H6, H8, D1, W1, M1"
163
+ end
164
+ if @api_client.config.client_side_validation && opts[:'timezone'] && !['Africa/Algiers', 'Africa/Cairo', 'Africa/Casablanca', 'Africa/Harare', 'Africa/Johannesburg', 'Africa/Monrovia', 'Africa/Nairobi', 'America/Argentina/Buenos_Aires', 'America/Bogota', 'America/Caracas', 'America/Chicago', 'America/Chihuahua', 'America/Denver', 'America/Godthab', 'America/Guatemala', 'America/Guyana', 'America/Halifax', 'America/Indiana/Indianapolis', 'America/Juneau', 'America/La_Paz', 'America/Lima', 'America/Lima', 'America/Los_Angeles', 'America/Mazatlan', 'America/Mexico_City', 'America/Mexico_City', 'America/Monterrey', 'America/Montevideo', 'America/New_York', 'America/Phoenix', 'America/Regina', 'America/Santiago', 'America/Sao_Paulo', 'America/St_Johns', 'America/Tijuana', 'Asia/Almaty', 'Asia/Baghdad', 'Asia/Baku', 'Asia/Bangkok', 'Asia/Bangkok', 'Asia/Chongqing', 'Asia/Colombo', 'Asia/Dhaka', 'Asia/Dhaka', 'Asia/Hong_Kong', 'Asia/Irkutsk', 'Asia/Jakarta', 'Asia/Jerusalem', 'Asia/Kabul', 'Asia/Kamchatka', 'Asia/Karachi', 'Asia/Karachi', 'Asia/Kathmandu', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Krasnoyarsk', 'Asia/Kuala_Lumpur', 'Asia/Kuwait', 'Asia/Magadan', 'Asia/Muscat', 'Asia/Muscat', 'Asia/Novosibirsk', 'Asia/Rangoon', 'Asia/Riyadh', 'Asia/Seoul', 'Asia/Shanghai', 'Asia/Singapore', 'Asia/Srednekolymsk', 'Asia/Taipei', 'Asia/Tashkent', 'Asia/Tbilisi', 'Asia/Tehran', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Ulaanbaatar', 'Asia/Urumqi', 'Asia/Vladivostok', 'Asia/Yakutsk', 'Asia/Yekaterinburg', 'Asia/Yerevan', 'Atlantic/Azores', 'Atlantic/Cape_Verde', 'Atlantic/South_Georgia', 'Australia/Adelaide', 'Australia/Brisbane', 'Australia/Darwin', 'Australia/Hobart', 'Australia/Melbourne', 'Australia/Melbourne', 'Australia/Perth', 'Australia/Sydney', 'Etc/UTC', 'UTC', 'Europe/Amsterdam', 'Europe/Athens', 'Europe/Belgrade', 'Europe/Berlin', 'Europe/Berlin', 'Europe/Bratislava', 'Europe/Brussels', 'Europe/Bucharest', 'Europe/Budapest', 'Europe/Copenhagen', 'Europe/Dublin', 'Europe/Helsinki', 'Europe/Istanbul', 'Europe/Kaliningrad', 'Europe/Kiev', 'Europe/Lisbon', 'Europe/Ljubljana', 'Europe/London', 'Europe/London', 'Europe/Madrid', 'Europe/Minsk', 'Europe/Moscow', 'Europe/Moscow', 'Europe/Paris', 'Europe/Prague', 'Europe/Riga', 'Europe/Rome', 'Europe/Samara', 'Europe/Sarajevo', 'Europe/Skopje', 'Europe/Sofia', 'Europe/Stockholm', 'Europe/Tallinn', 'Europe/Vienna', 'Europe/Vilnius', 'Europe/Volgograd', 'Europe/Warsaw', 'Europe/Zagreb', 'Pacific/Apia', 'Pacific/Auckland', 'Pacific/Auckland', 'Pacific/Chatham', 'Pacific/Fakaofo', 'Pacific/Fiji', 'Pacific/Guadalcanal', 'Pacific/Guam', 'Pacific/Honolulu', 'Pacific/Majuro', 'Pacific/Midway', 'Pacific/Midway', 'Pacific/Noumea', 'Pacific/Pago_Pago', 'Pacific/Port_Moresby', 'Pacific/Tongatapu'].include?(opts[:'timezone'])
165
+ fail ArgumentError, 'invalid value for "timezone", must be one of Africa/Algiers, Africa/Cairo, Africa/Casablanca, Africa/Harare, Africa/Johannesburg, Africa/Monrovia, Africa/Nairobi, America/Argentina/Buenos_Aires, America/Bogota, America/Caracas, America/Chicago, America/Chihuahua, America/Denver, America/Godthab, America/Guatemala, America/Guyana, America/Halifax, America/Indiana/Indianapolis, America/Juneau, America/La_Paz, America/Lima, America/Lima, America/Los_Angeles, America/Mazatlan, America/Mexico_City, America/Mexico_City, America/Monterrey, America/Montevideo, America/New_York, America/Phoenix, America/Regina, America/Santiago, America/Sao_Paulo, America/St_Johns, America/Tijuana, Asia/Almaty, Asia/Baghdad, Asia/Baku, Asia/Bangkok, Asia/Bangkok, Asia/Chongqing, Asia/Colombo, Asia/Dhaka, Asia/Dhaka, Asia/Hong_Kong, Asia/Irkutsk, Asia/Jakarta, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Karachi, Asia/Kathmandu, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuwait, Asia/Magadan, Asia/Muscat, Asia/Muscat, Asia/Novosibirsk, Asia/Rangoon, Asia/Riyadh, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tokyo, Asia/Tokyo, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Cape_Verde, Atlantic/South_Georgia, Australia/Adelaide, Australia/Brisbane, Australia/Darwin, Australia/Hobart, Australia/Melbourne, Australia/Melbourne, Australia/Perth, Australia/Sydney, Etc/UTC, UTC, Europe/Amsterdam, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Copenhagen, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/London, Europe/Madrid, Europe/Minsk, Europe/Moscow, Europe/Moscow, Europe/Paris, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/Sarajevo, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Pacific/Apia, Pacific/Auckland, Pacific/Auckland, Pacific/Chatham, Pacific/Fakaofo, Pacific/Fiji, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Majuro, Pacific/Midway, Pacific/Midway, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Port_Moresby, Pacific/Tongatapu'
166
+ end
167
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
168
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ForexApi.get_forex_prices, must be smaller than or equal to 10000.'
169
+ end
170
+
171
+ # resource path
172
+ local_var_path = "/forex/prices/{pair}/{timeframe}".sub('{' + 'pair' + '}', pair.to_s).sub('{' + 'timeframe' + '}', timeframe.to_s)
173
+
174
+ # query parameters
175
+ query_params = {}
176
+ query_params[:'timezone'] = opts[:'timezone'] if !opts[:'timezone'].nil?
177
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
178
+ query_params[:'start_time'] = opts[:'start_time'] if !opts[:'start_time'].nil?
179
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
180
+ query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].nil?
181
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
182
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
183
+
184
+ # header parameters
185
+ header_params = {}
186
+ # HTTP header 'Accept' (if needed)
187
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
188
+
189
+ # form parameters
190
+ form_params = {}
191
+
192
+ # http body (model)
193
+ post_body = nil
194
+ auth_names = ['ApiKeyAuth']
195
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
196
+ :header_params => header_params,
197
+ :query_params => query_params,
198
+ :form_params => form_params,
199
+ :body => post_body,
200
+ :auth_names => auth_names,
201
+ :return_type => 'ApiResponseForexPrices')
202
+ if @api_client.config.debugging
203
+ @api_client.config.logger.debug "API called: ForexApi#get_forex_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
204
+ end
205
+ return data, status_code, headers
206
+ end
207
+ end
208
+ end