intrinio-sdk 1.1.1 → 2.0.0

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.0
+OpenAPI spec version: 2.1.1
 
 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.0
+OpenAPI spec version: 2.1.1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -20,34 +20,36 @@ module Intrinio
       @api_client = api_client
     end
 
-    # Filter Data Tags
-    # Returns Data Tags that match the given filters
+    # All Data Tags
+    # Returns all Data Tags. Returns Data Tags matching parameters when specified.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :tag Tag
     # @option opts [String] :type Type
     # @option opts [String] :parent ID of tag parent
     # @option opts [String] :statement_code Statement Code
     # @option opts [String] :fs_template Template (default to industrial)
+    # @option opts [Float] :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 [ApiResponseDataTags]
-    def filter_data_tags(opts = {})
-      data, _status_code, _headers = filter_data_tags_with_http_info(opts)
+    def get_all_data_tags(opts = {})
+      data, _status_code, _headers = get_all_data_tags_with_http_info(opts)
       return data
     end
 
-    # Filter Data Tags
-    # Returns Data Tags that match the given filters
+    # All Data Tags
+    # Returns all Data Tags. Returns Data Tags matching parameters when specified.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :tag Tag
     # @option opts [String] :type Type
     # @option opts [String] :parent ID of tag parent
     # @option opts [String] :statement_code Statement Code
     # @option opts [String] :fs_template Template
+    # @option opts [Float] :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<(ApiResponseDataTags, Fixnum, Hash)>] ApiResponseDataTags data, response status code and response headers
-    def filter_data_tags_with_http_info(opts = {})
+    def get_all_data_tags_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: DataTagApi.filter_data_tags ..."
+        @api_client.config.logger.debug "Calling API: DataTagApi.get_all_data_tags ..."
       end
       if @api_client.config.client_side_validation && opts[:'statement_code'] && !['income_statement', 'balance_sheet_statement', 'cash_flow_statement', 'calculations'].include?(opts[:'statement_code'])
         fail ArgumentError, 'invalid value for "statement_code", must be one of income_statement, balance_sheet_statement, cash_flow_statement, calculations'
@@ -55,8 +57,12 @@ module Intrinio
       if @api_client.config.client_side_validation && opts[:'fs_template'] && !['industrial', 'financial'].include?(opts[:'fs_template'])
         fail ArgumentError, 'invalid value for "fs_template", must be one of industrial, financial'
       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 DataTagApi.get_all_data_tags, must be smaller than or equal to 10000.'
+      end
+
       # resource path
-      local_var_path = "/data_tags/filter"
+      local_var_path = "/data_tags"
 
       # query parameters
       query_params = {}
@@ -65,56 +71,7 @@ module Intrinio
       query_params[:'parent'] = opts[:'parent'] if !opts[:'parent'].nil?
       query_params[:'statement_code'] = opts[:'statement_code'] if !opts[:'statement_code'].nil?
       query_params[:'fs_template'] = opts[:'fs_template'] if !opts[:'fs_template'].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 => 'ApiResponseDataTags')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: DataTagApi#filter_data_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # All Data Tags
-    # Returns All Data Tags
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :next_page Gets the next page of data from a previous API call
-    # @return [ApiResponseDataTags]
-    def get_all_data_tags(opts = {})
-      data, _status_code, _headers = get_all_data_tags_with_http_info(opts)
-      return data
-    end
-
-    # All Data Tags
-    # Returns All Data Tags
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :next_page Gets the next page of data from a previous API call
-    # @return [Array<(ApiResponseDataTags, Fixnum, Hash)>] ApiResponseDataTags data, response status code and response headers
-    def get_all_data_tags_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: DataTagApi.get_all_data_tags ..."
-      end
-      # resource path
-      local_var_path = "/data_tags"
-
-      # query parameters
-      query_params = {}
+      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
@@ -198,7 +155,8 @@ module Intrinio
     # Searches for Data Tags matching the text `query`
     # @param query 
     # @param [Hash] opts the optional parameters
-    # @return [ApiResponseDataTags]
+    # @option opts [Float] :page_size The number of results to return (default to 100)
+    # @return [ApiResponseDataTagsSearch]
     def search_data_tags(query, opts = {})
       data, _status_code, _headers = search_data_tags_with_http_info(query, opts)
       return data
@@ -208,7 +166,8 @@ module Intrinio
     # Searches for Data Tags matching the text &#x60;query&#x60;
     # @param query 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ApiResponseDataTags, Fixnum, Hash)>] ApiResponseDataTags data, response status code and response headers
+    # @option opts [Float] :page_size The number of results to return
+    # @return [Array<(ApiResponseDataTagsSearch, Fixnum, Hash)>] ApiResponseDataTagsSearch data, response status code and response headers
     def search_data_tags_with_http_info(query, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: DataTagApi.search_data_tags ..."
@@ -217,12 +176,17 @@ module Intrinio
       if @api_client.config.client_side_validation && query.nil?
         fail ArgumentError, "Missing the required parameter 'query' when calling DataTagApi.search_data_tags"
       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 DataTagApi.search_data_tags, must be smaller than or equal to 10000.'
+      end
+
       # resource path
       local_var_path = "/data_tags/search"
 
       # query parameters
       query_params = {}
       query_params[:'query'] = query
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
 
       # header parameters
       header_params = {}
@@ -241,7 +205,7 @@ module Intrinio
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'ApiResponseDataTags')
+        :return_type => 'ApiResponseDataTagsSearch')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: DataTagApi#search_data_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

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.0
+OpenAPI spec version: 2.1.1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -20,39 +20,45 @@ module Intrinio
       @api_client = api_client
     end
 
-    # Filter Filings
-    # Returns Filings that match the specified filters
+    # All Filings
+    # Returns all Filings. Returns Filings matching parameters when supplied.
     # @param company Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :report_type Filter by report type
     # @option opts [Date] :start_date Filed on or after the given date
     # @option opts [Date] :end_date Filed before or after the given date
+    # @option opts [Float] :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 [ApiResponseFilings]
-    def filter_filings(company, opts = {})
-      data, _status_code, _headers = filter_filings_with_http_info(company, opts)
+    def get_all_filings(company, opts = {})
+      data, _status_code, _headers = get_all_filings_with_http_info(company, opts)
       return data
     end
 
-    # Filter Filings
-    # Returns Filings that match the specified filters
+    # All Filings
+    # Returns all Filings. Returns Filings matching parameters when supplied.
     # @param company Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :report_type Filter by report type
     # @option opts [Date] :start_date Filed on or after the given date
     # @option opts [Date] :end_date Filed before or after the given date
+    # @option opts [Float] :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<(ApiResponseFilings, Fixnum, Hash)>] ApiResponseFilings data, response status code and response headers
-    def filter_filings_with_http_info(company, opts = {})
+    def get_all_filings_with_http_info(company, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: FilingApi.filter_filings ..."
+        @api_client.config.logger.debug "Calling API: FilingApi.get_all_filings ..."
       end
       # verify the required parameter 'company' is set
       if @api_client.config.client_side_validation && company.nil?
-        fail ArgumentError, "Missing the required parameter 'company' when calling FilingApi.filter_filings"
+        fail ArgumentError, "Missing the required parameter 'company' when calling FilingApi.get_all_filings"
+      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 FilingApi.get_all_filings, must be smaller than or equal to 10000.'
       end
+
       # resource path
-      local_var_path = "/filings/filter"
+      local_var_path = "/filings"
 
       # query parameters
       query_params = {}
@@ -60,6 +66,7 @@ module Intrinio
       query_params[:'report_type'] = opts[:'report_type'] if !opts[:'report_type'].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[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
       query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
 
       # header parameters
@@ -81,13 +88,13 @@ module Intrinio
         :auth_names => auth_names,
         :return_type => 'ApiResponseFilings')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: FilingApi#filter_filings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: FilingApi#get_all_filings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Filter Filing Notes
-    # Returns Filing Notes that match the specified filters
+    # All Filing Notes
+    # Return all Notes from all Filings, most-recent first. Returns notes matching parameters when supplied.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :company A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @option opts [String] :report_type Notes contained in filings that match the given report type
@@ -95,15 +102,16 @@ module Intrinio
     # @option opts [Date] :filing_end_date Limit search to filings on or before this date
     # @option opts [Date] :period_ended_start_date Limit search to filings with a period end date on or after this date
     # @option opts [Date] :period_ended_end_date Limit search to filings with a period end date on or before this date
+    # @option opts [Float] :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 [ApiResponseFilingNotes]
-    def filter_notes(opts = {})
-      data, _status_code, _headers = filter_notes_with_http_info(opts)
+    def get_all_notes(opts = {})
+      data, _status_code, _headers = get_all_notes_with_http_info(opts)
       return data
     end
 
-    # Filter Filing Notes
-    # Returns Filing Notes that match the specified filters
+    # All Filing Notes
+    # Return all Notes from all Filings, most-recent first. Returns notes matching parameters when supplied.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :company A Company identifier (Ticker, CIK, LEI, Intrinio ID)
     # @option opts [String] :report_type Notes contained in filings that match the given report type
@@ -111,17 +119,22 @@ module Intrinio
     # @option opts [Date] :filing_end_date Limit search to filings on or before this date
     # @option opts [Date] :period_ended_start_date Limit search to filings with a period end date on or after this date
     # @option opts [Date] :period_ended_end_date Limit search to filings with a period end date on or before this date
+    # @option opts [Float] :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<(ApiResponseFilingNotes, Fixnum, Hash)>] ApiResponseFilingNotes data, response status code and response headers
-    def filter_notes_with_http_info(opts = {})
+    def get_all_notes_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: FilingApi.filter_notes ..."
+        @api_client.config.logger.debug "Calling API: FilingApi.get_all_notes ..."
       end
       if @api_client.config.client_side_validation && opts[:'report_type'] && !['10-Q', '10-K'].include?(opts[:'report_type'])
         fail ArgumentError, 'invalid value for "report_type", must be one of 10-Q, 10-K'
       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 FilingApi.get_all_notes, must be smaller than or equal to 10000.'
+      end
+
       # resource path
-      local_var_path = "/filings/notes/filter"
+      local_var_path = "/filings/notes"
 
       # query parameters
       query_params = {}
@@ -131,106 +144,7 @@ module Intrinio
       query_params[:'filing_end_date'] = opts[:'filing_end_date'] if !opts[:'filing_end_date'].nil?
       query_params[:'period_ended_start_date'] = opts[:'period_ended_start_date'] if !opts[:'period_ended_start_date'].nil?
       query_params[:'period_ended_end_date'] = opts[:'period_ended_end_date'] if !opts[:'period_ended_end_date'].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 => 'ApiResponseFilingNotes')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: FilingApi#filter_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # All Filings
-    # Returns all Filings
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :next_page Gets the next page of data from a previous API call
-    # @return [ApiResponseFilings]
-    def get_all_filings(opts = {})
-      data, _status_code, _headers = get_all_filings_with_http_info(opts)
-      return data
-    end
-
-    # All Filings
-    # Returns all Filings
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :next_page Gets the next page of data from a previous API call
-    # @return [Array<(ApiResponseFilings, Fixnum, Hash)>] ApiResponseFilings data, response status code and response headers
-    def get_all_filings_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: FilingApi.get_all_filings ..."
-      end
-      # resource path
-      local_var_path = "/filings"
-
-      # query parameters
-      query_params = {}
-      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 => 'ApiResponseFilings')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: FilingApi#get_all_filings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # All Filing Notes
-    # Return all Notes from all Filings, most-recent first
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :next_page Gets the next page of data from a previous API call
-    # @return [ApiResponseFilingNotes]
-    def get_all_notes(opts = {})
-      data, _status_code, _headers = get_all_notes_with_http_info(opts)
-      return data
-    end
-
-    # All Filing Notes
-    # Return all Notes from all Filings, most-recent first
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :next_page Gets the next page of data from a previous API call
-    # @return [Array<(ApiResponseFilingNotes, Fixnum, Hash)>] ApiResponseFilingNotes data, response status code and response headers
-    def get_all_notes_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: FilingApi.get_all_notes ..."
-      end
-      # resource path
-      local_var_path = "/filings/notes"
-
-      # query parameters
-      query_params = {}
+      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
@@ -482,6 +396,7 @@ module Intrinio
     # @option opts [Date] :filing_start_date Limit search to filings on or after this date
     # @option opts [Date] :filing_end_date Limit search to filings on or before this date
     # @option opts [Float] :page_size The number of results to return (default to 100)
+    # @option opts [Float] :page_size2 The number of results to return (default to 100)
     # @return [ApiResponseFilingNotesSearch]
     def search_notes(query, opts = {})
       data, _status_code, _headers = search_notes_with_http_info(query, opts)
@@ -495,6 +410,7 @@ module Intrinio
     # @option opts [Date] :filing_start_date Limit search to filings on or after this date
     # @option opts [Date] :filing_end_date Limit search to filings on or before this date
     # @option opts [Float] :page_size The number of results to return
+    # @option opts [Float] :page_size2 The number of results to return
     # @return [Array<(ApiResponseFilingNotesSearch, Fixnum, Hash)>] ApiResponseFilingNotesSearch data, response status code and response headers
     def search_notes_with_http_info(query, opts = {})
       if @api_client.config.debugging
@@ -508,6 +424,10 @@ module Intrinio
         fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FilingApi.search_notes, must be smaller than or equal to 1000.'
       end
 
+      if @api_client.config.client_side_validation && !opts[:'page_size2'].nil? && opts[:'page_size2'] > 10000
+        fail ArgumentError, 'invalid value for "opts[:"page_size2"]" when calling FilingApi.search_notes, must be smaller than or equal to 10000.'
+      end
+
       # resource path
       local_var_path = "/filings/notes/search"
 
@@ -517,6 +437,7 @@ module Intrinio
       query_params[:'filing_start_date'] = opts[:'filing_start_date'] if !opts[:'filing_start_date'].nil?
       query_params[:'filing_end_date'] = opts[:'filing_end_date'] if !opts[:'filing_end_date'].nil?
       query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'page_size'] = opts[:'page_size2'] if !opts[:'page_size2'].nil?
 
       # header parameters
       header_params = {}