intrinio-sdk 1.0.0 → 1.1.0

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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -91,7 +91,7 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get All Data Tags
+    # 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
@@ -101,7 +101,7 @@ module Intrinio
       return data
     end
 
-    # Get All Data Tags
+    # 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
@@ -141,8 +141,8 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get a Data Tag by ID
-    # Returns a Data Tag with the specified `identifier`
+    # Lookup Data Tag
+    # Returns the Data Tag with the given `identifier`
     # @param identifier The Intrinio ID or the code-name of the Data Tag
     # @param [Hash] opts the optional parameters
     # @return [DataTag]
@@ -151,8 +151,8 @@ module Intrinio
       return data
     end
 
-    # Get a Data Tag by ID
-    # Returns a Data Tag with the specified `identifier`
+    # Lookup Data Tag
+    # Returns the Data Tag with the given `identifier`
     # @param identifier The Intrinio ID or the code-name of the Data Tag
     # @param [Hash] opts the optional parameters
     # @return [Array<(DataTag, Fixnum, Hash)>] DataTag data, response status code and response headers

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.0.0
+OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -21,7 +21,7 @@ module Intrinio
     end
 
     # Filter Filings
-    # Returns filings that match the specified filters
+    # Returns Filings that match the specified filters
     # @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
@@ -35,7 +35,7 @@ module Intrinio
     end
 
     # Filter Filings
-    # Returns filings that match the specified filters
+    # Returns Filings that match the specified filters
     # @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
@@ -86,8 +86,79 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get All Filings
-    # Returns all filings
+    # Filter SEC filing notes
+    # Returns SEC filing notes matching the supplied criteria
+    # @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
+    # @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 [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 [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)
+      return data
+    end
+
+    # Filter SEC filing notes
+    # Returns SEC filing notes matching the supplied criteria
+    # @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
+    # @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 [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 [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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FilingApi.filter_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
+      # resource path
+      local_var_path = "/filings/notes/filter"
+
+      # query parameters
+      query_params = {}
+      query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
+      query_params[:'report_type'] = opts[:'report_type'] if !opts[:'report_type'].nil?
+      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[:'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]
@@ -96,8 +167,8 @@ module Intrinio
       return data
     end
 
-    # Get All Filings
-    # Returns all filings
+    # 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
@@ -136,8 +207,58 @@ module Intrinio
       return data, status_code, headers
     end
 
-    # Get a Filing by ID
-    # Return the filing with the given ID
+    # Get All SEC filing notes
+    # Return All notes from SEC 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
+
+    # Get All SEC filing notes
+    # Return All notes from SEC 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[:'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#get_all_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lookup Filing
+    # Returns the Filing with the given `identifier`
     # @param id The Intrinio ID of the Filing
     # @param [Hash] opts the optional parameters
     # @return [Filing]
@@ -146,8 +267,8 @@ module Intrinio
       return data
     end
 
-    # Get a Filing by ID
-    # Return the filing with the given ID
+    # Lookup Filing
+    # Returns the Filing with the given &#x60;identifier&#x60;
     # @param id The Intrinio ID of the Filing
     # @param [Hash] opts the optional parameters
     # @return [Array<(Filing, Fixnum, Hash)>] Filing data, response status code and response headers
@@ -188,5 +309,237 @@ module Intrinio
       end
       return data, status_code, headers
     end
+
+    # Get an SEC filing note by ID
+    # 
+    # @param identifier The Intrinio ID of the filing note
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :content_format Returns content in html (as filed) or plain text (default to text)
+    # @return [FilingNote]
+    def get_note(identifier, opts = {})
+      data, _status_code, _headers = get_note_with_http_info(identifier, opts)
+      return data
+    end
+
+    # Get an SEC filing note by ID
+    # 
+    # @param identifier The Intrinio ID of the filing note
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :content_format Returns content in html (as filed) or plain text
+    # @return [Array<(FilingNote, Fixnum, Hash)>] FilingNote data, response status code and response headers
+    def get_note_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FilingApi.get_note ..."
+      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 FilingApi.get_note"
+      end
+      if @api_client.config.client_side_validation && opts[:'content_format'] && !['text', 'html'].include?(opts[:'content_format'])
+        fail ArgumentError, 'invalid value for "content_format", must be one of text, html'
+      end
+      # resource path
+      local_var_path = "/filings/notes/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'content_format'] = opts[:'content_format'] if !opts[:'content_format'].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 => 'FilingNote')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilingApi#get_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns the content of an SEC filing note as originally filed
+    # 
+    # @param identifier The Intrinio ID of the filing note
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def get_note_html(identifier, opts = {})
+      data, _status_code, _headers = get_note_html_with_http_info(identifier, opts)
+      return data
+    end
+
+    # Returns the content of an SEC filing note as originally filed
+    # 
+    # @param identifier The Intrinio ID of the filing note
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def get_note_html_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FilingApi.get_note_html ..."
+      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 FilingApi.get_note_html"
+      end
+      # resource path
+      local_var_path = "/filings/notes/{identifier}/html".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])
+
+      # 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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilingApi#get_note_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns the content of an SEC filing note stripped of HTML
+    # 
+    # @param identifier The Intrinio ID of the filing note
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def get_note_text(identifier, opts = {})
+      data, _status_code, _headers = get_note_text_with_http_info(identifier, opts)
+      return data
+    end
+
+    # Returns the content of an SEC filing note stripped of HTML
+    # 
+    # @param identifier The Intrinio ID of the filing note
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def get_note_text_with_http_info(identifier, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FilingApi.get_note_text ..."
+      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 FilingApi.get_note_text"
+      end
+      # resource path
+      local_var_path = "/filings/notes/{identifier}/text".sub('{' + 'identifier' + '}', identifier.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])
+
+      # 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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilingApi#get_note_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search Filing Notes
+    # Searches SEC filing notes using the text in `query`
+    # @param query Search for notes that contain all or parts of this text
+    # @param [Hash] opts the optional parameters
+    # @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)
+    # @return [ApiResponseFilingNotesSearch]
+    def search_notes(query, opts = {})
+      data, _status_code, _headers = search_notes_with_http_info(query, opts)
+      return data
+    end
+
+    # Search Filing Notes
+    # Searches SEC filing notes using the text in &#x60;query&#x60;
+    # @param query Search for notes that contain all or parts of this text
+    # @param [Hash] opts the optional parameters
+    # @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
+    # @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
+        @api_client.config.logger.debug "Calling API: FilingApi.search_notes ..."
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling FilingApi.search_notes"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FilingApi.search_notes, must be smaller than or equal to 1000.'
+      end
+
+      # resource path
+      local_var_path = "/filings/notes/search"
+
+      # query parameters
+      query_params = {}
+      query_params[:'query'] = query
+      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?
+
+      # 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 => 'ApiResponseFilingNotesSearch')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilingApi#search_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end