zacks_api.rb in intrinio-sdk-5.4.0

- old
+ new

@@ -1,11 +1,11 @@
 =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.10.0
+OpenAPI spec version: 2.11.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
 
 =end
@@ -22,12 +22,12 @@
 
     # Zacks Analyst Ratings
     # Returns buy, sell, and hold recommendations from analysts at brokerages for all companies in the Zacks universe. Zack’s storied research team aggregates and validates the ratings from professional analysts.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
-    # @option opts [String] :start_date Limit ratings to those on or after this date
-    # @option opts [String] :end_date Limit ratings to those on or before this date
+    # @option opts [Date] :start_date Limit ratings to those on or after this date
+    # @option opts [Date] :end_date Limit ratings to those on or before this date
     # @option opts [Float] :mean_greater Return only records with a mean (average) higher than this value
     # @option opts [Float] :mean_less Return only records with a mean (average) lower than this value
     # @option opts [Integer] :strong_buys_greater Return only records with more than this many Strong Buy recommendations
     # @option opts [Integer] :strong_buys_less Return only records with fewer than this many Strong Buy recommendations
     # @option opts [Integer] :buys_greater Return only records with more than this many Buy recommendations
@@ -50,12 +50,12 @@
 
     # Zacks Analyst Ratings
     # Returns buy, sell, and hold recommendations from analysts at brokerages for all companies in the Zacks universe. Zack’s storied research team aggregates and validates the ratings from professional analysts.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
-    # @option opts [String] :start_date Limit ratings to those on or after this date
-    # @option opts [String] :end_date Limit ratings to those on or before this date
+    # @option opts [Date] :start_date Limit ratings to those on or after this date
+    # @option opts [Date] :end_date Limit ratings to those on or before this date
     # @option opts [Float] :mean_greater Return only records with a mean (average) higher than this value
     # @option opts [Float] :mean_less Return only records with a mean (average) lower than this value
     # @option opts [Integer] :strong_buys_greater Return only records with more than this many Strong Buy recommendations
     # @option opts [Integer] :strong_buys_less Return only records with fewer than this many Strong Buy recommendations
     # @option opts [Integer] :buys_greater Return only records with more than this many Buy recommendations
@@ -190,15 +190,165 @@
         @api_client.config.logger.debug "API called: ZacksApi#get_zacks_analyst_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
+    # Zacks EPS Estimates
+    # Returns Zacks consensus earnings-per-share (EPS) data for all Companies.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+    # @option opts [Date] :start_date Limit EPS estimates to those on or after this date
+    # @option opts [Date] :end_date Limit EPS estimates to those on or before this date
+    # @option opts [Integer] :fiscal_year Only for the given fiscal year
+    # @option opts [String] :fiscal_period The fiscal period
+    # @option opts [Integer] :calendar_year Only for the given calendar year
+    # @option opts [String] :calendar_period The calendar period
+    # @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 [ApiResponseZacksEPSEstimates]
+    def get_zacks_eps_estimates(opts = {})
+      data, _status_code, _headers = get_zacks_eps_estimates_with_http_info(opts)
+      return data
+    end
+
+    # Zacks EPS Estimates
+    # Returns Zacks consensus earnings-per-share (EPS) data for all Companies.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+    # @option opts [Date] :start_date Limit EPS estimates to those on or after this date
+    # @option opts [Date] :end_date Limit EPS estimates to those on or before this date
+    # @option opts [Integer] :fiscal_year Only for the given fiscal year
+    # @option opts [String] :fiscal_period The fiscal period
+    # @option opts [Integer] :calendar_year Only for the given calendar year
+    # @option opts [String] :calendar_period The calendar period
+    # @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<(ApiResponseZacksEPSEstimates, Fixnum, Hash)>] ApiResponseZacksEPSEstimates data, response status code and response headers
+    def get_zacks_eps_estimates_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_eps_estimates ..."
+      end
+      if @api_client.config.client_side_validation && opts[:'fiscal_period'] && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(opts[:'fiscal_period'])
+        fail ArgumentError, 'invalid value for "fiscal_period", must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD'
+      end
+      if @api_client.config.client_side_validation && opts[:'calendar_period'] && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(opts[:'calendar_period'])
+        fail ArgumentError, 'invalid value for "calendar_period", must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD'
+      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 ZacksApi.get_zacks_eps_estimates, must be smaller than or equal to 10000.'
+      end
+
+      # resource path
+      local_var_path = "/zacks/eps_estimates"
+
+      # query parameters
+      query_params = {}
+      query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'fiscal_year'] = opts[:'fiscal_year'] if !opts[:'fiscal_year'].nil?
+      query_params[:'fiscal_period'] = opts[:'fiscal_period'] if !opts[:'fiscal_period'].nil?
+      query_params[:'calendar_year'] = opts[:'calendar_year'] if !opts[:'calendar_year'].nil?
+      query_params[:'calendar_period'] = opts[:'calendar_period'] if !opts[:'calendar_period'].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 => 'ApiResponseZacksEPSEstimates')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ZacksApi#get_zacks_eps_estimates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Zacks EPS Growth Rates
+    # Returns the latest Zacks EPS growth rates
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :company Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)
+    # @option opts [String] :industry_group_name Return only growth rates for companies in the given Zacks industry group name
+    # @option opts [String] :industry_group_number Return only growth rates for companies in the given Zacks industry group number
+    # @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 [ApiResponseZacksEPSGrowthRates]
+    def get_zacks_eps_growth_rates(opts = {})
+      data, _status_code, _headers = get_zacks_eps_growth_rates_with_http_info(opts)
+      return data
+    end
+
+    # Zacks EPS Growth Rates
+    # Returns the latest Zacks EPS growth rates
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :company Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)
+    # @option opts [String] :industry_group_name Return only growth rates for companies in the given Zacks industry group name
+    # @option opts [String] :industry_group_number Return only growth rates for companies in the given Zacks industry group number
+    # @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<(ApiResponseZacksEPSGrowthRates, Fixnum, Hash)>] ApiResponseZacksEPSGrowthRates data, response status code and response headers
+    def get_zacks_eps_growth_rates_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_eps_growth_rates ..."
+      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 ZacksApi.get_zacks_eps_growth_rates, must be smaller than or equal to 10000.'
+      end
+
+      # resource path
+      local_var_path = "/zacks/eps_growth_rates"
+
+      # query parameters
+      query_params = {}
+      query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
+      query_params[:'industry_group_name'] = opts[:'industry_group_name'] if !opts[:'industry_group_name'].nil?
+      query_params[:'industry_group_number'] = opts[:'industry_group_number'] if !opts[:'industry_group_number'].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 => 'ApiResponseZacksEPSGrowthRates')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ZacksApi#get_zacks_eps_growth_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Zacks EPS Surprises
     # Returns Zacks eps surprise data for all Securities.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :start_date Limit EPS surprises to those on or after this date
-    # @option opts [String] :end_date Limit EPS surprises to those on or before this date
+    # @option opts [Date] :start_date Limit EPS surprises to those on or after this date
+    # @option opts [Date] :end_date Limit EPS surprises to those on or before this date
     # @option opts [Float] :eps_actual_greater Return only records with an actual EPS higher than this value
     # @option opts [Float] :eps_actual_less Return only records with an actual EPS lower than this value
     # @option opts [Float] :eps_mean_estimate_greater Return only records with an EPS mean estimate greater than this value
     # @option opts [Float] :eps_mean_estimate_less Return only records with an EPS mean estimate lower than this value
     # @option opts [Float] :eps_amount_diff_greater Return only records with an EPS amount difference greater than this value
@@ -218,12 +368,12 @@
     end
 
     # Zacks EPS Surprises
     # Returns Zacks eps surprise data for all Securities.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :start_date Limit EPS surprises to those on or after this date
-    # @option opts [String] :end_date Limit EPS surprises to those on or before this date
+    # @option opts [Date] :start_date Limit EPS surprises to those on or after this date
+    # @option opts [Date] :end_date Limit EPS surprises to those on or before this date
     # @option opts [Float] :eps_actual_greater Return only records with an actual EPS higher than this value
     # @option opts [Float] :eps_actual_less Return only records with an actual EPS lower than this value
     # @option opts [Float] :eps_mean_estimate_greater Return only records with an EPS mean estimate greater than this value
     # @option opts [Float] :eps_mean_estimate_less Return only records with an EPS mean estimate lower than this value
     # @option opts [Float] :eps_amount_diff_greater Return only records with an EPS amount difference greater than this value
@@ -289,15 +439,75 @@
         @api_client.config.logger.debug "API called: ZacksApi#get_zacks_eps_surprises\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
+    # Zacks Long Term Growth Rates
+    # Returns the latest Zacks long term growth rates
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+    # @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 [ApiResponseZacksLongTermGrowthRates]
+    def get_zacks_long_term_growth_rates(opts = {})
+      data, _status_code, _headers = get_zacks_long_term_growth_rates_with_http_info(opts)
+      return data
+    end
+
+    # Zacks Long Term Growth Rates
+    # Returns the latest Zacks long term growth rates
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+    # @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<(ApiResponseZacksLongTermGrowthRates, Fixnum, Hash)>] ApiResponseZacksLongTermGrowthRates data, response status code and response headers
+    def get_zacks_long_term_growth_rates_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_long_term_growth_rates ..."
+      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 ZacksApi.get_zacks_long_term_growth_rates, must be smaller than or equal to 10000.'
+      end
+
+      # resource path
+      local_var_path = "/zacks/long_term_growth_rates"
+
+      # query parameters
+      query_params = {}
+      query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].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 => 'ApiResponseZacksLongTermGrowthRates')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ZacksApi#get_zacks_long_term_growth_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Zacks Sales Surprises
     # Returns Zacks sales surprise data for all Securities.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :start_date Limit sales surprises to those on or after this date
-    # @option opts [String] :end_date Limit sales surprises to those on or before this date
+    # @option opts [Date] :start_date Limit sales surprises to those on or after this date
+    # @option opts [Date] :end_date Limit sales surprises to those on or before this date
     # @option opts [Float] :sales_actual_greater Return only records with an actual sales higher than this value
     # @option opts [Float] :sales_actual_less Return only records with an actual sales lower than this value
     # @option opts [Float] :sales_mean_estimate_greater Return only records with a sales mean estimate greater than this value
     # @option opts [Float] :sales_mean_estimate_less Return only records with a sales mean estimate lower than this value
     # @option opts [Float] :sales_amount_diff_greater Return only records with a sales amount difference greater than this value
@@ -317,12 +527,12 @@
     end
 
     # Zacks Sales Surprises
     # Returns Zacks sales surprise data for all Securities.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :start_date Limit sales surprises to those on or after this date
-    # @option opts [String] :end_date Limit sales surprises to those on or before this date
+    # @option opts [Date] :start_date Limit sales surprises to those on or after this date
+    # @option opts [Date] :end_date Limit sales surprises to those on or before this date
     # @option opts [Float] :sales_actual_greater Return only records with an actual sales higher than this value
     # @option opts [Float] :sales_actual_less Return only records with an actual sales lower than this value
     # @option opts [Float] :sales_mean_estimate_greater Return only records with a sales mean estimate greater than this value
     # @option opts [Float] :sales_mean_estimate_less Return only records with a sales mean estimate lower than this value
     # @option opts [Float] :sales_amount_diff_greater Return only records with a sales amount difference greater than this value
@@ -384,9 +594,72 @@
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'ApiResponseZacksSalesSurprises')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ZacksApi#get_zacks_sales_surprises\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Zacks Target Price Consensuses
+    # Returns the latest Zacks target price consensus data
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :identifier Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)
+    # @option opts [String] :industry_group_number Return only growth rates for companies in the given Zacks industry group number
+    # @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 [ApiResponseZacksTargetPriceConsensuses]
+    def get_zacks_target_price_consensuses(opts = {})
+      data, _status_code, _headers = get_zacks_target_price_consensuses_with_http_info(opts)
+      return data
+    end
+
+    # Zacks Target Price Consensuses
+    # Returns the latest Zacks target price consensus data
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :identifier Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)
+    # @option opts [String] :industry_group_number Return only growth rates for companies in the given Zacks industry group number
+    # @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<(ApiResponseZacksTargetPriceConsensuses, Fixnum, Hash)>] ApiResponseZacksTargetPriceConsensuses data, response status code and response headers
+    def get_zacks_target_price_consensuses_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_target_price_consensuses ..."
+      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 ZacksApi.get_zacks_target_price_consensuses, must be smaller than or equal to 10000.'
+      end
+
+      # resource path
+      local_var_path = "/zacks/target_price_consensuses"
+
+      # query parameters
+      query_params = {}
+      query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
+      query_params[:'industry_group_number'] = opts[:'industry_group_number'] if !opts[:'industry_group_number'].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 => 'ApiResponseZacksTargetPriceConsensuses')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ZacksApi#get_zacks_target_price_consensuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
   end
 end