zacks_api.rb in intrinio-sdk-6.26.8

- 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://docs.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.52.1
+OpenAPI spec version: 2.52.5
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
 
 =end
@@ -747,9 +747,96 @@
         :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 Estimates
+    # This database offers consensus sales estimates for over 5,000 US and Canadian listed 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 Sales estimates to those on or after this date
+    # @option opts [Date] :end_date Limit Sales 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 [String] :next_page Gets the next page of data from a previous API call
+    # @option opts [Integer] :page_size The number of results to return (default to 100)
+    # @option opts [String] :next_page2 Gets the next page of data from a previous API call
+    # @return [ApiResponseZacksSalesEstimates]
+    def get_zacks_sales_estimates(opts = {})
+      data, _status_code, _headers = get_zacks_sales_estimates_with_http_info(opts)
+      return data
+    end
+
+    # Zacks Sales Estimates
+    # This database offers consensus sales estimates for over 5,000 US and Canadian listed 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 Sales estimates to those on or after this date
+    # @option opts [Date] :end_date Limit Sales 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 [String] :next_page Gets the next page of data from a previous API call
+    # @option opts [Integer] :page_size The number of results to return
+    # @option opts [String] :next_page2 Gets the next page of data from a previous API call
+    # @return [Array<(ApiResponseZacksSalesEstimates, Fixnum, Hash)>] ApiResponseZacksSalesEstimates data, response status code and response headers
+    def get_zacks_sales_estimates_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_sales_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_sales_estimates, must be smaller than or equal to 10000.'
+      end
+
+      # resource path
+      local_var_path = "/zacks/sales_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[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'next_page'] = opts[:'next_page2'] if !opts[:'next_page2'].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 => 'ApiResponseZacksSalesEstimates')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ZacksApi#get_zacks_sales_estimates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Zacks Sales Surprises