intrinio-sdk 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d28fbbbba20f94f4eee00841b6e28c8d8d78d7ab
-  data.tar.gz: 8df2aab4fad7ec9b7b4a904cc8d4625d871660f2
+  metadata.gz: 604b86610c9e925cceded84015da9b798c89a325
+  data.tar.gz: d1898c9480b630d803b4bc692b32be7f53db7af9
 SHA512:
-  metadata.gz: 0f3067f28e7c1df996939c94a42e2188e469796d21defcc028950a972980458e50b08357fbb5e2e5b7f7601217cea1360925ec138d35c3a0e98fe3e95bf45704
-  data.tar.gz: d801858bd91319b06c6ff4f94ddd8762f7dc9199730b20438665d683e1f4282d9836db6ec6c2f1df6c627e85b8f083835f3966b5f55e1b21236970bff679a521
+  metadata.gz: '0180217b557231dde9795c83822dc88ee8b2cfd48a17d552c8c03a050af3c05c7727df487414d5c9803deb49a670d6fdaee4bf51a24c09f454d9e32e614eb89d'
+  data.tar.gz: 6c63060baf8c84b37bf07ec73e3b4dad411fb5d6421ac02dc69b23548c8c1e0576a93fab54e418c3594a75e3b623c7ef4e86e88d6ec207585465852b6b5071c2

data/README.md

@@ -8,8 +8,8 @@ Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 2.1.1
-- Package version: 2.0.0
+- API version: 2.2.0
+- Package version: 2.0.1
 
 
 ## Installation
@@ -81,6 +81,9 @@ Class | Method | HTTP request | Description
 *Intrinio::FilingApi* | [**get_note_html**](docs/FilingApi.md#get_note_html) | **GET** /filings/notes/{identifier}/html | Filing Note HTML
 *Intrinio::FilingApi* | [**get_note_text**](docs/FilingApi.md#get_note_text) | **GET** /filings/notes/{identifier}/text | Filing Note Text
 *Intrinio::FilingApi* | [**search_notes**](docs/FilingApi.md#search_notes) | **GET** /filings/notes/search | Search Filing Notes
+*Intrinio::ForexApi* | [**get_forex_currencies**](docs/ForexApi.md#get_forex_currencies) | **GET** /forex/currencies | Forex Currencies
+*Intrinio::ForexApi* | [**get_forex_pairs**](docs/ForexApi.md#get_forex_pairs) | **GET** /forex/pairs | Forex Currency Pairs
+*Intrinio::ForexApi* | [**get_forex_prices**](docs/ForexApi.md#get_forex_prices) | **GET** /forex/prices/{pair}/{timeframe} | Forex Currency Prices
 *Intrinio::FundamentalsApi* | [**get_fundamental_by_id**](docs/FundamentalsApi.md#get_fundamental_by_id) | **GET** /fundamentals/{id} | Fundamental by ID
 *Intrinio::FundamentalsApi* | [**get_fundamental_reported_financials**](docs/FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials
 *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
  - [Intrinio::ApiResponseFilingNotes](docs/ApiResponseFilingNotes.md)
  - [Intrinio::ApiResponseFilingNotesSearch](docs/ApiResponseFilingNotesSearch.md)
  - [Intrinio::ApiResponseFilings](docs/ApiResponseFilings.md)
+ - [Intrinio::ApiResponseForexCurrencies](docs/ApiResponseForexCurrencies.md)
+ - [Intrinio::ApiResponseForexPairs](docs/ApiResponseForexPairs.md)
+ - [Intrinio::ApiResponseForexPrices](docs/ApiResponseForexPrices.md)
  - [Intrinio::ApiResponseHistoricalData](docs/ApiResponseHistoricalData.md)
  - [Intrinio::ApiResponseMunicipalities](docs/ApiResponseMunicipalities.md)
  - [Intrinio::ApiResponseMunicipalitiyFinancials](docs/ApiResponseMunicipalitiyFinancials.md)
@@ -184,6 +190,9 @@ Class | Method | HTTP request | Description
  - [Intrinio::FilingNoteFiling](docs/FilingNoteFiling.md)
  - [Intrinio::FilingNoteSummary](docs/FilingNoteSummary.md)
  - [Intrinio::FilingSummary](docs/FilingSummary.md)
+ - [Intrinio::ForexCurrency](docs/ForexCurrency.md)
+ - [Intrinio::ForexPair](docs/ForexPair.md)
+ - [Intrinio::ForexPrice](docs/ForexPrice.md)
  - [Intrinio::Fundamental](docs/Fundamental.md)
  - [Intrinio::FundamentalSummary](docs/FundamentalSummary.md)
  - [Intrinio::HistoricalData](docs/HistoricalData.md)

data/docs/ApiResponseForexCurrencies.md

@@ -0,0 +1,8 @@
+# Intrinio::ApiResponseForexCurrencies
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currencies** | [**Array<ForexCurrency>**](ForexCurrency.md) |  | [optional] 
+
+

data/docs/ApiResponseForexPairs.md

@@ -0,0 +1,8 @@
+# Intrinio::ApiResponseForexPairs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pairs** | [**Array<ForexPair>**](ForexPair.md) |  | [optional] 
+
+

data/docs/ApiResponseForexPrices.md

@@ -0,0 +1,10 @@
+# Intrinio::ApiResponseForexPrices
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prices** | [**Array<ForexPrice>**](ForexPrice.md) |  | [optional] 
+**pair** | [**ForexPair**](ForexPair.md) | The Forex currency pair for which prices were requested | [optional] 
+**next_page** | **String** | The token required to request the next page of the data | [optional] 
+
+

data/docs/ForexApi.md

@@ -0,0 +1,138 @@
+# Intrinio::ForexApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_forex_currencies**](ForexApi.md#get_forex_currencies) | **GET** /forex/currencies | Forex Currencies
+[**get_forex_pairs**](ForexApi.md#get_forex_pairs) | **GET** /forex/pairs | Forex Currency Pairs
+[**get_forex_prices**](ForexApi.md#get_forex_prices) | **GET** /forex/prices/{pair}/{timeframe} | Forex Currency Prices
+
+
+# **get_forex_currencies**
+> ApiResponseForexCurrencies get_forex_currencies
+
+Forex Currencies
+
+Returns a list of forex currencies for which prices are available.
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+forex_api = Intrinio::ForexApi.new
+
+begin
+  result = forex_api.get_forex_currencies
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ForexApi->get_forex_currencies: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApiResponseForexCurrencies**](ApiResponseForexCurrencies.md)
+
+# **get_forex_pairs**
+> ApiResponseForexPairs get_forex_pairs
+
+Forex Currency Pairs
+
+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).
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+forex_api = Intrinio::ForexApi.new
+
+begin
+  result = forex_api.get_forex_pairs
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ForexApi->get_forex_pairs: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApiResponseForexPairs**](ApiResponseForexPairs.md)
+
+# **get_forex_prices**
+> ApiResponseForexPrices get_forex_prices(pair, timeframe, opts)
+
+Forex Currency Prices
+
+Provides a list of forex price quotes for a given forex currency pair and timeframe.
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+forex_api = Intrinio::ForexApi.new
+
+pair = "EURUSD" # String | The Forex Currency Pair code
+
+timeframe = "D1" # String | The time interval for the quotes
+
+opts = { 
+  timezone: "UTC", # String | Returns trading times in this timezone
+  start_date: "2018-01-01", # String | Return Forex Prices on or after this date
+  start_time: "14:20:00", # String | Return Forex Prices at or after this time (24-hour)
+  end_date: "2019-01-01", # String | Return Forex Prices on or before this date
+  end_time: "21:01:21", # String | Return Forex Prices at or before this time (24-hour)
+  page_size: 100, # Integer | The number of results to return
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = forex_api.get_forex_prices(pair, timeframe, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling ForexApi->get_forex_prices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pair** | **String**| The Forex Currency Pair code | 
+ **timeframe** | **String**| The time interval for the quotes | 
+ **timezone** | **String**| Returns trading times in this timezone | [optional] [default to UTC]
+ **start_date** | **String**| Return Forex Prices on or after this date | [optional] 
+ **start_time** | **String**| Return Forex Prices at or after this time (24-hour) | [optional] 
+ **end_date** | **String**| Return Forex Prices on or before this date | [optional] 
+ **end_time** | **String**| Return Forex Prices at or before this time (24-hour) | [optional] 
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseForexPrices**](ApiResponseForexPrices.md)
+

data/docs/ForexCurrency.md

@@ -0,0 +1,10 @@
+# Intrinio::ForexCurrency
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The ISO 4217 currency code | [optional] 
+**name** | **String** | The name of the currency | [optional] 
+**country** | **String** | The country in which the currency is used | [optional] 
+
+

data/docs/ForexPair.md

@@ -0,0 +1,10 @@
+# Intrinio::ForexPair
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The common code of the currency pair | [optional] 
+**base_currency** | **String** | The ISO 4217 currency code of the base currency | [optional] 
+**quote_currency** | **String** | The ISO 4217 currency code of the quote currency | [optional] 
+
+

data/docs/ForexPrice.md

@@ -0,0 +1,17 @@
+# Intrinio::ForexPrice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**open_bid** | **Float** | Open bid | [optional] 
+**high_bid** | **Float** | High bid | [optional] 
+**low_bid** | **Float** | Low bid | [optional] 
+**close_bid** | **Float** | Close bid | [optional] 
+**open_ask** | **Float** | Open ask | [optional] 
+**high_ask** | **Float** | High ask | [optional] 
+**low_ask** | **Float** | Low ask | [optional] 
+**close_ask** | **Float** | Close ask | [optional] 
+**total_ticks** | **Integer** | Total ticks | [optional] 
+
+

data/intrinio-sdk.gemspec

@@ -5,7 +5,7 @@
 
 #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.
 
-OpenAPI spec version: 2.1.1
+OpenAPI spec version: 2.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk.rb

@@ -3,7 +3,7 @@
 
 #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.
 
-OpenAPI spec version: 2.1.1
+OpenAPI spec version: 2.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -32,6 +32,9 @@ require 'intrinio-sdk/models/api_response_economic_indices_search'
 require 'intrinio-sdk/models/api_response_filing_notes'
 require 'intrinio-sdk/models/api_response_filing_notes_search'
 require 'intrinio-sdk/models/api_response_filings'
+require 'intrinio-sdk/models/api_response_forex_currencies'
+require 'intrinio-sdk/models/api_response_forex_pairs'
+require 'intrinio-sdk/models/api_response_forex_prices'
 require 'intrinio-sdk/models/api_response_historical_data'
 require 'intrinio-sdk/models/api_response_municipalities'
 require 'intrinio-sdk/models/api_response_municipalitiy_financials'
@@ -71,6 +74,9 @@ require 'intrinio-sdk/models/filing_note'
 require 'intrinio-sdk/models/filing_note_filing'
 require 'intrinio-sdk/models/filing_note_summary'
 require 'intrinio-sdk/models/filing_summary'
+require 'intrinio-sdk/models/forex_currency'
+require 'intrinio-sdk/models/forex_pair'
+require 'intrinio-sdk/models/forex_price'
 require 'intrinio-sdk/models/fundamental'
 require 'intrinio-sdk/models/fundamental_summary'
 require 'intrinio-sdk/models/historical_data'
@@ -102,6 +108,7 @@ require 'intrinio-sdk/api/company_api'
 require 'intrinio-sdk/api/data_point_api'
 require 'intrinio-sdk/api/data_tag_api'
 require 'intrinio-sdk/api/filing_api'
+require 'intrinio-sdk/api/forex_api'
 require 'intrinio-sdk/api/fundamentals_api'
 require 'intrinio-sdk/api/historical_data_api'
 require 'intrinio-sdk/api/index_api'

data/lib/intrinio-sdk/api/company_api.rb

@@ -3,7 +3,7 @@
 
 #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.
 
-OpenAPI spec version: 2.1.1
+OpenAPI spec version: 2.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/api/data_point_api.rb

@@ -3,7 +3,7 @@
 
 #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.
 
-OpenAPI spec version: 2.1.1
+OpenAPI spec version: 2.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/api/data_tag_api.rb

@@ -3,7 +3,7 @@
 
 #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.
 
-OpenAPI spec version: 2.1.1
+OpenAPI spec version: 2.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/api/filing_api.rb

@@ -3,7 +3,7 @@
 
 #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.
 
-OpenAPI spec version: 2.1.1
+OpenAPI spec version: 2.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT

data/lib/intrinio-sdk/api/forex_api.rb

@@ -0,0 +1,208 @@
+=begin
+#Intrinio API
+
+#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.
+
+OpenAPI spec version: 2.2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require "uri"
+
+module Intrinio
+  class ForexApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Forex Currencies
+    # Returns a list of forex currencies for which prices are available.
+    # @param [Hash] opts the optional parameters
+    # @return [ApiResponseForexCurrencies]
+    def get_forex_currencies(opts = {})
+      data, _status_code, _headers = get_forex_currencies_with_http_info(opts)
+      return data
+    end
+
+    # Forex Currencies
+    # Returns a list of forex currencies for which prices are available.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiResponseForexCurrencies, Fixnum, Hash)>] ApiResponseForexCurrencies data, response status code and response headers
+    def get_forex_currencies_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ForexApi.get_forex_currencies ..."
+      end
+      # resource path
+      local_var_path = "/forex/currencies"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiResponseForexCurrencies')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ForexApi#get_forex_currencies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Forex Currency Pairs
+    # 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).
+    # @param [Hash] opts the optional parameters
+    # @return [ApiResponseForexPairs]
+    def get_forex_pairs(opts = {})
+      data, _status_code, _headers = get_forex_pairs_with_http_info(opts)
+      return data
+    end
+
+    # Forex Currency Pairs
+    # 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).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiResponseForexPairs, Fixnum, Hash)>] ApiResponseForexPairs data, response status code and response headers
+    def get_forex_pairs_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ForexApi.get_forex_pairs ..."
+      end
+      # resource path
+      local_var_path = "/forex/pairs"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiResponseForexPairs')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ForexApi#get_forex_pairs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Forex Currency Prices
+    # Provides a list of forex price quotes for a given forex currency pair and timeframe.
+    # @param pair The Forex Currency Pair code
+    # @param timeframe The time interval for the quotes
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :timezone Returns trading times in this timezone (default to UTC)
+    # @option opts [String] :start_date Return Forex Prices on or after this date
+    # @option opts [String] :start_time Return Forex Prices at or after this time (24-hour)
+    # @option opts [String] :end_date Return Forex Prices on or before this date
+    # @option opts [String] :end_time Return Forex Prices at or before this time (24-hour)
+    # @option opts [Integer] :page_size The number of results to return (default to 100)
+    # @option opts [String] :next_page Gets the next page of data from a previous API call
+    # @return [ApiResponseForexPrices]
+    def get_forex_prices(pair, timeframe, opts = {})
+      data, _status_code, _headers = get_forex_prices_with_http_info(pair, timeframe, opts)
+      return data
+    end
+
+    # Forex Currency Prices
+    # Provides a list of forex price quotes for a given forex currency pair and timeframe.
+    # @param pair The Forex Currency Pair code
+    # @param timeframe The time interval for the quotes
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :timezone Returns trading times in this timezone
+    # @option opts [String] :start_date Return Forex Prices on or after this date
+    # @option opts [String] :start_time Return Forex Prices at or after this time (24-hour)
+    # @option opts [String] :end_date Return Forex Prices on or before this date
+    # @option opts [String] :end_time Return Forex Prices at or before this time (24-hour)
+    # @option opts [Integer] :page_size The number of results to return
+    # @option opts [String] :next_page Gets the next page of data from a previous API call
+    # @return [Array<(ApiResponseForexPrices, Fixnum, Hash)>] ApiResponseForexPrices data, response status code and response headers
+    def get_forex_prices_with_http_info(pair, timeframe, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ForexApi.get_forex_prices ..."
+      end
+      # verify the required parameter 'pair' is set
+      if @api_client.config.client_side_validation && pair.nil?
+        fail ArgumentError, "Missing the required parameter 'pair' when calling ForexApi.get_forex_prices"
+      end
+      # verify the required parameter 'timeframe' is set
+      if @api_client.config.client_side_validation && timeframe.nil?
+        fail ArgumentError, "Missing the required parameter 'timeframe' when calling ForexApi.get_forex_prices"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['m1', 'm5', 'm15', 'm30', 'H1', 'H2', 'H3', 'H4', 'H6', 'H8', 'D1', 'W1', 'M1'].include?(timeframe)
+        fail ArgumentError, "invalid value for 'timeframe', must be one of m1, m5, m15, m30, H1, H2, H3, H4, H6, H8, D1, W1, M1"
+      end
+      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'])
+        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'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ForexApi.get_forex_prices, must be smaller than or equal to 10000.'
+      end
+
+      # resource path
+      local_var_path = "/forex/prices/{pair}/{timeframe}".sub('{' + 'pair' + '}', pair.to_s).sub('{' + 'timeframe' + '}', timeframe.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'timezone'] = opts[:'timezone'] if !opts[:'timezone'].nil?
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'start_time'] = opts[:'start_time'] if !opts[:'start_time'].nil?
+      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiResponseForexPrices')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ForexApi#get_forex_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end