intrinio-sdk 5.6.0 → 5.8.0

data/lib/intrinio-sdk/api/security_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.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -40,6 +40,7 @@ module Intrinio
     # @option opts [String] :figi_unique_id Return securities with the given FIGI Unique ID (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>).
     # @option opts [BOOLEAN] :include_non_figi When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned. (default to false)
     # @option opts [Integer] :page_size The number of results to return (default to 100)
+    # @option opts [BOOLEAN] :primary_listing If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange.  Returns both if omitted.
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [ApiResponseSecurities]
     def get_all_securities(opts = {})
@@ -67,6 +68,7 @@ module Intrinio
     # @option opts [String] :figi_unique_id Return securities with the given FIGI Unique ID (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>).
     # @option opts [BOOLEAN] :include_non_figi When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned.
     # @option opts [Integer] :page_size The number of results to return
+    # @option opts [BOOLEAN] :primary_listing If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange.  Returns both if omitted.
     # @option opts [String] :next_page Gets the next page of data from a previous API call
     # @return [Array<(ApiResponseSecurities, Fixnum, Hash)>] ApiResponseSecurities data, response status code and response headers
     def get_all_securities_with_http_info(opts = {})
@@ -99,6 +101,7 @@ module Intrinio
       query_params[:'figi_unique_id'] = opts[:'figi_unique_id'] if !opts[:'figi_unique_id'].nil?
       query_params[:'include_non_figi'] = opts[:'include_non_figi'] if !opts[:'include_non_figi'].nil?
       query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'primary_listing'] = opts[:'primary_listing'] if !opts[:'primary_listing'].nil?
       query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
 
       # header parameters
@@ -179,9 +182,9 @@ module Intrinio
     end
 
     # Data Point (Number) for Security
-    # $$v2_security_data_point_number_description$$
-    # @param identifier $$v2_security_data_point_identifier_description$$
-    # @param tag $$v2_security_data_point_item_description$$
+    # Returns a numeric value for the given `tag` for the Security with the given `identifier`
+    # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+    # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
     # @param [Hash] opts the optional parameters
     # @return [Float]
     def get_security_data_point_number(identifier, tag, opts = {})
@@ -190,9 +193,9 @@ module Intrinio
     end
 
     # Data Point (Number) for Security
-    # $$v2_security_data_point_number_description$$
-    # @param identifier $$v2_security_data_point_identifier_description$$
-    # @param tag $$v2_security_data_point_item_description$$
+    # Returns a numeric value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;
+    # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+    # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
     # @param [Hash] opts the optional parameters
     # @return [Array<(Float, Fixnum, Hash)>] Float data, response status code and response headers
     def get_security_data_point_number_with_http_info(identifier, tag, opts = {})
@@ -238,8 +241,8 @@ module Intrinio
     end
 
     # Data Point (Text) for Security
-    # $$v2_security_data_point_text_description$$
-    # @param identifier $$v2_security_data_point_identifier_description$$
+    # Returns a text value for the given `tag` for the Security with the given `identifier`
+    # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
     # @param tag An Intrinio data tag ID or code-name
     # @param [Hash] opts the optional parameters
     # @return [String]
@@ -249,8 +252,8 @@ module Intrinio
     end
 
     # Data Point (Text) for Security
-    # $$v2_security_data_point_text_description$$
-    # @param identifier $$v2_security_data_point_identifier_description$$
+    # Returns a text value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;
+    # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
     # @param tag An Intrinio data tag ID or code-name
     # @param [Hash] opts the optional parameters
     # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
@@ -297,9 +300,9 @@ module Intrinio
     end
 
     # Historical Data for Security
-    # $$v2_security_historical_data_description$$
-    # @param identifier $$v2_security_historical_data_identifier_description$$
-    # @param tag $$v2_security_data_point_item_description$$
+    # Returns historical values for the given `tag` and the Security with the given `identifier`
+    # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+    # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :frequency Return historical data in the given frequency (default to daily)
     # @option opts [String] :type Filter by type, when applicable
@@ -315,9 +318,9 @@ module Intrinio
     end
 
     # Historical Data for Security
-    # $$v2_security_historical_data_description$$
-    # @param identifier $$v2_security_historical_data_identifier_description$$
-    # @param tag $$v2_security_data_point_item_description$$
+    # Returns historical values for the given &#x60;tag&#x60; and the Security with the given &#x60;identifier&#x60;
+    # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+    # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :frequency Return historical data in the given frequency
     # @option opts [String] :type Filter by type, when applicable
@@ -386,15 +389,101 @@ module Intrinio
       return data, status_code, headers
     end
 
+    # Interval Stock Prices for Security
+    # Return Open, High, Low, Close, and Volume for a particular interval for the Security with the given `identifier`
+    # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :source Return intervals from the specified data source
+    # @option opts [Date] :start_date Return intervals starting at the specified date
+    # @option opts [String] :start_time Return intervals starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)
+    # @option opts [Date] :end_date Return intervals stopping at the specified date
+    # @option opts [String] :end_time Return intervals stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)
+    # @option opts [String] :timezone Returns trading times in this timezone (default to UTC)
+    # @option opts [String] :interval_size The interval for which to return stock prices (default to 1d)
+    # @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 [ApiResponseSecurityIntervalPrices]
+    def get_security_interval_prices(identifier, opts = {})
+      data, _status_code, _headers = get_security_interval_prices_with_http_info(identifier, opts)
+      return data
+    end
+
+    # Interval Stock Prices for Security
+    # Return Open, High, Low, Close, and Volume for a particular interval for the Security with the given &#x60;identifier&#x60;
+    # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :source Return intervals from the specified data source
+    # @option opts [Date] :start_date Return intervals starting at the specified date
+    # @option opts [String] :start_time Return intervals starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)
+    # @option opts [Date] :end_date Return intervals stopping at the specified date
+    # @option opts [String] :end_time Return intervals stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)
+    # @option opts [String] :timezone Returns trading times in this timezone
+    # @option opts [String] :interval_size The interval for which to return stock prices
+    # @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<(ApiResponseSecurityIntervalPrices, Fixnum, Hash)>] ApiResponseSecurityIntervalPrices data, response status code and response headers
+    def get_security_interval_prices_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SecurityApi.get_security_interval_prices ..."
+      end
+      # verify the required parameter 'identifier' is set
+      if @api_client.config.client_side_validation && identifier.nil?
+        fail ArgumentError, "Missing the required parameter 'identifier' when calling SecurityApi.get_security_interval_prices"
+      end
+      if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats'].include?(opts[:'source'])
+        fail ArgumentError, 'invalid value for "source", must be one of iex, bats'
+      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
+      # resource path
+      local_var_path = "/securities/{identifier}/prices/intervals".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'source'] = opts[:'source'] if !opts[:'source'].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[:'timezone'] = opts[:'timezone'] if !opts[:'timezone'].nil?
+      query_params[:'interval_size'] = opts[:'interval_size'] if !opts[:'interval_size'].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 => 'ApiResponseSecurityIntervalPrices')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SecurityApi#get_security_interval_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Intraday Stock Prices for Security
-    # $$v2_security_intraday_prices_description$$
+    # Return intraday stock prices for the Security with the given `identifier`
     # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Return intraday prices from the specified data source
     # @option opts [Date] :start_date Return intraday prices starting at the specified date
-    # @option opts [String] :start_time Return intraday prices starting at the specified time on the &#x60;start_date&#x60; (timezone is UTC)
+    # @option opts [String] :start_time Return intraday prices starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)
     # @option opts [Date] :end_date Return intraday prices stopping at the specified date
-    # @option opts [String] :end_time Return intraday prices stopping at the specified time on the &#x60;end_date&#x60; (timezone is UTC)
+    # @option opts [String] :end_time Return intraday prices stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)
     # @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 [ApiResponseSecurityIntradayPrices]
@@ -404,14 +493,14 @@ module Intrinio
     end
 
     # Intraday Stock Prices for Security
-    # $$v2_security_intraday_prices_description$$
+    # Return intraday stock prices for the Security with the given &#x60;identifier&#x60;
     # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :source Return intraday prices from the specified data source
     # @option opts [Date] :start_date Return intraday prices starting at the specified date
-    # @option opts [String] :start_time Return intraday prices starting at the specified time on the &#x60;start_date&#x60; (timezone is UTC)
+    # @option opts [String] :start_time Return intraday prices starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)
     # @option opts [Date] :end_date Return intraday prices stopping at the specified date
-    # @option opts [String] :end_time Return intraday prices stopping at the specified time on the &#x60;end_date&#x60; (timezone is UTC)
+    # @option opts [String] :end_time Return intraday prices stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)
     # @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<(ApiResponseSecurityIntradayPrices, Fixnum, Hash)>] ApiResponseSecurityIntradayPrices data, response status code and response headers
@@ -423,8 +512,8 @@ module Intrinio
       if @api_client.config.client_side_validation && identifier.nil?
         fail ArgumentError, "Missing the required parameter 'identifier' when calling SecurityApi.get_security_intraday_prices"
       end
-      if @api_client.config.client_side_validation && opts[:'source'] && !['$$v2_stock_price_intraday_sources_enum$$'].include?(opts[:'source'])
-        fail ArgumentError, 'invalid value for "source", must be one of $$v2_stock_price_intraday_sources_enum$$'
+      if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats'].include?(opts[:'source'])
+        fail ArgumentError, 'invalid value for "source", must be one of iex, bats'
       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 SecurityApi.get_security_intraday_prices, must be smaller than or equal to 10000.'
@@ -467,7 +556,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Lastest Dividend Record for Security
+    # Latest Dividend Record for Security
     # Returns the latest available dividend information for the Security with the given `identifier`
     # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
     # @param [Hash] opts the optional parameters
@@ -477,7 +566,7 @@ module Intrinio
       return data
     end
 
-    # Lastest Dividend Record for Security
+    # Latest Dividend Record for Security
     # Returns the latest available dividend information for the Security with the given &#x60;identifier&#x60;
     # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
     # @param [Hash] opts the optional parameters
@@ -520,7 +609,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Lastest Earnings Record for Security
+    # Latest Earnings Record for Security
     # Returns latest available earnings information for the Security with the given `identifier`
     # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
     # @param [Hash] opts the optional parameters
@@ -530,7 +619,7 @@ module Intrinio
       return data
     end
 
-    # Lastest Earnings Record for Security
+    # Latest Earnings Record for Security
     # Returns latest available earnings information for the Security with the given &#x60;identifier&#x60;
     # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
     # @param [Hash] opts the optional parameters
@@ -3046,8 +3135,8 @@ module Intrinio
       if @api_client.config.client_side_validation && identifier.nil?
         fail ArgumentError, "Missing the required parameter 'identifier' when calling SecurityApi.get_security_realtime_price"
       end
-      if @api_client.config.client_side_validation && opts[:'source'] && !['$$v2_stock_price_realtime_sources_enum$$'].include?(opts[:'source'])
-        fail ArgumentError, 'invalid value for "source", must be one of $$v2_stock_price_realtime_sources_enum$$'
+      if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats', 'bats_delayed'].include?(opts[:'source'])
+        fail ArgumentError, 'invalid value for "source", must be one of iex, bats, bats_delayed'
       end
       # resource path
       local_var_path = "/securities/{identifier}/prices/realtime".sub('{' + 'identifier' + '}', identifier.to_s)
@@ -3579,9 +3668,9 @@ module Intrinio
     end
 
     # Screen Securities
-    # Screen Securities using complex logic
+    # Screen Securities using complex logic. Use POST only. See <a href=\"https://docs.intrinio.com/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions.
     # @param [Hash] opts the optional parameters
-    # @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;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
+    # @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;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
     # @option opts [String] :order_column Results returned sorted by this column
     # @option opts [String] :order_direction Sort order to use with the order_column (default to asc)
     # @option opts [BOOLEAN] :primary_only Return only primary securities (default to false)
@@ -3593,9 +3682,9 @@ module Intrinio
     end
 
     # Screen Securities
-    # Screen Securities using complex logic
+    # Screen Securities using complex logic. Use POST only. See &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
     # @param [Hash] opts the optional parameters
-    # @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;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
+    # @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;https://docs.intrinio.com/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
     # @option opts [String] :order_column Results returned sorted by this column
     # @option opts [String] :order_direction Sort order to use with the order_column
     # @option opts [BOOLEAN] :primary_only Return only primary securities

data/lib/intrinio-sdk/api/stock_exchange_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.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -297,8 +297,8 @@ module Intrinio
       if @api_client.config.client_side_validation && identifier.nil?
         fail ArgumentError, "Missing the required parameter 'identifier' when calling StockExchangeApi.get_stock_exchange_realtime_prices"
       end
-      if @api_client.config.client_side_validation && opts[:'source'] && !['$$v2_stock_price_realtime_sources_enum$$'].include?(opts[:'source'])
-        fail ArgumentError, 'invalid value for "source", must be one of $$v2_stock_price_realtime_sources_enum$$'
+      if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats', 'bats_delayed'].include?(opts[:'source'])
+        fail ArgumentError, 'invalid value for "source", must be one of iex, bats, bats_delayed'
       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 StockExchangeApi.get_stock_exchange_realtime_prices, must be smaller than or equal to 10000.'

data/lib/intrinio-sdk/api/technical_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.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api/zacks_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.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk/api_client.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.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -16,9 +16,13 @@ require 'logger'
 require 'tempfile'
 require 'typhoeus'
 require 'uri'
+require 'retriable'
 
 module Intrinio
   class ApiClient
+    # The max number of seconds allowed between each retry interval
+    MAX_INTERVAL_SECONDS = 60
+    
     # The Configuration object holding settings to be used in the API client.
     attr_accessor :config
 
@@ -47,34 +51,62 @@ module Intrinio
     # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
-      request = build_request(http_method, path, opts)
-      response = request.run
+      non_retriable_error = nil
+      retry_amount = @config.allow_retries ? 5 : 1
+      Retriable.retriable(tries: retry_amount, base_interval: 1.0, multiplier: 1.0, rand_factor: 0.5, max_interval: MAX_INTERVAL_SECONDS) do
+        @config.logger.debug("Calling Intrinio API [#{http_method}] - #{path}...") if @config.debugging
+        
+        request = build_request(http_method, path, opts)
+        response = request.run
+        
+        rate_limit_header = response.headers["retry-after"]
+        
+        if @config.debugging
+          @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+        end
 
-      if @config.debugging
-        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
-      end
+        unless response.success?
+          if response.timed_out?
+            fail ApiError.new('Connection timed out')
+          elsif response.code == 429 && rate_limit_header
+            wait_in_seconds = rate_limit_header.to_i
+            
+            #if the rate limit elapse time header is less than the max allowed interval time, sleep the program until the rate limit period elapses
+            if wait_in_seconds < MAX_INTERVAL_SECONDS
+              @config.logger.debug "API Rate Limit Reached - Retrying in #{wait_in_seconds} seconds..."
+              sleep(wait_in_seconds)
+            end
+            
+            fail ApiError.new(:code => 429,
+                              :message => response.return_message)
+          elsif response.code.to_s.split("")[0].to_i == 4
+            # Do not retry any other 400 errors, break the retry block
+            non_retriable_error = ApiError.new(:code => response.code,
+                              :response_headers => response.headers,
+                              :response_body => response.body)
+            break
+          elsif response.code == 0
+            # Errors from libcurl will be made visible here
+            fail ApiError.new(:code => 0,
+                              :message => response.return_message)
+          else
+            fail ApiError.new(:code => response.code,
+                              :response_headers => response.headers,
+                              :response_body => response.body),
+                 response.status_message
+          end
+        end
 
-      unless response.success?
-        if response.timed_out?
-          fail ApiError.new('Connection timed out')
-        elsif response.code == 0
-          # Errors from libcurl will be made visible here
-          fail ApiError.new(:code => 0,
-                            :message => response.return_message)
+        if opts[:return_type]
+          data = deserialize(response, opts[:return_type])
         else
-          fail ApiError.new(:code => response.code,
-                            :response_headers => response.headers,
-                            :response_body => response.body),
-               response.status_message
+          data = nil
         end
+        return data, response.code, response.headers
       end
-
-      if opts[:return_type]
-        data = deserialize(response, opts[:return_type])
-      else
-        data = nil
-      end
-      return data, response.code, response.headers
+      
+      # Catch errors that broke out of retry block
+      fail non_retriable_error
     end
 
     # Builds the HTTP request

data/lib/intrinio-sdk/api_error.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.14.0
+OpenAPI spec version: 2.18.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset