intrinio-sdk 1.1.1 → 2.0.0

data/spec/api/filing_api_spec.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
@@ -32,37 +32,45 @@ describe 'FilingApi' do
     end
   end
 
-  # unit tests for filter_filings
-  # Filter Filings
-  # Returns filings that match the specified filters
+  # unit tests for get_all_filings
+  # 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 [ApiResponseFilings]
-  describe 'filter_filings test' do
+  describe 'get_all_filings test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  # unit tests for get_all_filings
-  # Get All Filings
-  # Returns all filings
+  # unit tests for get_all_notes
+  # 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
+  # @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 [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 [ApiResponseFilings]
-  describe 'get_all_filings test' do
+  # @return [ApiResponseFilingNotes]
+  describe 'get_all_notes test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_filing_by_id
-  # Get a Filing by ID
-  # Return the filing with the given ID
+  # 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]
@@ -72,4 +80,57 @@ describe 'FilingApi' do
     end
   end
 
+  # unit tests for get_note
+  # 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 [FilingNote]
+  describe 'get_note test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_note_html
+  # Filing Note HTML
+  # 
+  # @param identifier The Intrinio ID of the filing note
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'get_note_html test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_note_text
+  # Filing Note Text
+  # 
+  # @param identifier The Intrinio ID of the filing note
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'get_note_text test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_notes
+  # Search Filing Notes
+  # Searches for Filing Notes using the `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
+  # @option opts [Float] :page_size2 The number of results to return
+  # @return [ApiResponseFilingNotesSearch]
+  describe 'search_notes test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/api/fundamentals_api_spec.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
@@ -33,8 +33,8 @@ describe 'FundamentalsApi' do
   end
 
   # unit tests for get_fundamental_by_id
-  # Get a Fundamental by ID
-  # Retrieves detailed fundamental data for the given `fundamental_id`.
+  # Fundamental by ID
+  # Returns detailed fundamental data for the given `id`.
   # @param id The Intrinio ID for the Fundamental
   # @param [Hash] opts the optional parameters
   # @return [Fundamental]
@@ -45,7 +45,7 @@ describe 'FundamentalsApi' do
   end
 
   # unit tests for get_fundamental_reported_financials
-  # Get Reported Financials for a Fundamental
+  # Reported Financials
   # Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
   # @param id The Intrinio ID for the Fundamental
   # @param [Hash] opts the optional parameters
@@ -57,7 +57,7 @@ describe 'FundamentalsApi' do
   end
 
   # unit tests for get_fundamental_standardized_financials
-  # Get Standardized Financials for a Fundamental
+  # Standardized Financials
   # Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.
   # @param id The Intrinio ID for the Fundamental
   # @param [Hash] opts the optional parameters
@@ -69,7 +69,7 @@ describe 'FundamentalsApi' do
   end
 
   # unit tests for lookup_fundamental
-  # Lookup a Fundamental
+  # Lookup Fundamental
   # Returns the Fundamental for the Company with the given `identifier` and with the given parameters
   # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
   # @param statement_code The statement code

data/spec/api/historical_data_api_spec.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
@@ -33,7 +33,7 @@ describe 'HistoricalDataApi' do
   end
 
   # unit tests for get_historical_data
-  # Get Historical Data
+  # Historical Data
   # Returns historical values for the given `tag` and the entity represented by the given `identifier`
   # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
@@ -42,6 +42,7 @@ describe 'HistoricalDataApi' do
   # @option opts [Date] :start_date Get historical data on or after this date
   # @option opts [Date] :end_date Get historical date on or before this date
   # @option opts [String] :sort_order Sort by date `asc` or `desc`
+  # @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 [ApiResponseHistoricalData]
   describe 'get_historical_data test' do

data/spec/api/index_api_spec.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
@@ -33,9 +33,10 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_all_economic_indices
-  # Get All Economic Indices
+  # All Economic Indices
   # 
   # @param [Hash] opts the optional parameters
+  # @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 [ApiResponseEconomicIndices]
   describe 'get_all_economic_indices test' do
@@ -45,9 +46,10 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_all_sic_indices
-  # Get All SIC Indices
+  # All SIC Indices
   # 
   # @param [Hash] opts the optional parameters
+  # @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 [ApiResponseSICIndices]
   describe 'get_all_sic_indices test' do
@@ -57,9 +59,10 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_all_stock_market_indices
-  # Get All Stock Market Indices
+  # All Stock Market Indices
   # 
   # @param [Hash] opts the optional parameters
+  # @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 [ApiResponseStockMarketIndices]
   describe 'get_all_stock_market_indices test' do
@@ -69,7 +72,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_economic_index_by_id
-  # Get an Economic Index by ID
+  # Lookup Economic Index
   # 
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param [Hash] opts the optional parameters
@@ -81,7 +84,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_economic_index_data_point_number
-  # Get Economic Index Data Point (Number)
+  # Data Point (Number) for an Economic Index
   # Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
@@ -94,7 +97,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_economic_index_data_point_text
-  # Get Economic Index Data Point (Text)
+  # Data Point (Text) for an Economic Index
   # Returns a text value for the given `tag` for the Economic Index with the given `identifier`
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
@@ -107,7 +110,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_economic_index_historical_data
-  # Get Economic Index Historical Data
+  # Historical Data for an Economic Index
   # Returns historical values for the given `tag` and the Economic Index with the given `identifier`
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
@@ -116,6 +119,7 @@ describe 'IndexApi' do
   # @option opts [Date] :start_date Get historical data on or after this date
   # @option opts [Date] :end_date Get historical data on or before this date
   # @option opts [String] :sort_order Sort by date `asc` or `desc`
+  # @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 [ApiResponseEconomicIndexHistoricalData]
   describe 'get_economic_index_historical_data test' do
@@ -125,7 +129,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_sic_index_by_id
-  # Get an SIC Index by ID
+  # Lookup SIC Index
   # 
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param [Hash] opts the optional parameters
@@ -137,7 +141,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_sic_index_data_point_number
-  # Get SIC Index Data Point (Number)
+  # Data Point (Number) for an SIC Index
   # Returns a numeric value for the given `tag` for the SIC Index with the given `identifier`
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
@@ -150,7 +154,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_sic_index_data_point_text
-  # Get SIC Index Data Point (Text)
+  # Data Point (Text) for an SIC Index
   # Returns a text value for the given `tag` for the SIC Index with the given `identifier`
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
@@ -163,7 +167,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_sic_index_historical_data
-  # Get SIC Index Historical Data
+  # Historical Data for an SIC Index
   # Returns historical values for the given `tag` and the SIC Index with the given `identifier`
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
@@ -172,6 +176,7 @@ describe 'IndexApi' do
   # @option opts [Date] :start_date Get historical data on or after this date
   # @option opts [Date] :end_date Get historical data on or before this date
   # @option opts [String] :sort_order Sort by date `asc` or `desc`
+  # @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 [ApiResponseSICIndexHistoricalData]
   describe 'get_sic_index_historical_data test' do
@@ -181,7 +186,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_stock_market_index_by_id
-  # Get a Stock Market Index by ID
+  # Lookup Stock Market Index
   # 
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param [Hash] opts the optional parameters
@@ -193,7 +198,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_stock_market_index_data_point_number
-  # Get Stock Market Index Data Point (Number)
+  # Data Point (Number) for Stock Market Index
   # Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier`
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
@@ -206,7 +211,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_stock_market_index_data_point_text
-  # Get Stock Market Index Data Point (Text)
+  # Data Point (Text) for Stock Market Index
   # Returns a text value for the given `tag` for the Stock Market Index with the given `identifier`
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
@@ -219,7 +224,7 @@ describe 'IndexApi' do
   end
 
   # unit tests for get_stock_market_index_historical_data
-  # Get Stock Market Index Historical Data
+  # Historical Data for Stock Market Index
   # Returns historical values for the given `tag` and the Stock Market Index with the given `identifier`
   # @param identifier An Index Identifier (symbol, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
@@ -228,6 +233,7 @@ describe 'IndexApi' do
   # @option opts [Date] :start_date Get historical data on or after this date
   # @option opts [Date] :end_date Get historical data on or before this date
   # @option opts [String] :sort_order Sort by date `asc` or `desc`
+  # @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 [ApiResponseStockMarketIndexHistoricalData]
   describe 'get_stock_market_index_historical_data test' do
@@ -241,7 +247,8 @@ describe 'IndexApi' do
   # Searches for indices using the text in `query`
   # @param query Search query
   # @param [Hash] opts the optional parameters
-  # @return [ApiResponseEconomicIndices]
+  # @option opts [Float] :page_size The number of results to return
+  # @return [ApiResponseEconomicIndicesSearch]
   describe 'search_economic_indices test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -253,7 +260,8 @@ describe 'IndexApi' do
   # Searches for indices using the text in `query`
   # @param query Search query
   # @param [Hash] opts the optional parameters
-  # @return [ApiResponseSICIndices]
+  # @option opts [Float] :page_size The number of results to return
+  # @return [ApiResponseSICIndicesSearch]
   describe 'search_sic_indices test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -265,7 +273,8 @@ describe 'IndexApi' do
   # Searches for indices using the text in `query`
   # @param query Search query
   # @param [Hash] opts the optional parameters
-  # @return [ApiResponseStockMarketIndices]
+  # @option opts [Float] :page_size The number of results to return
+  # @return [ApiResponseStockMarketIndicesSearch]
   describe 'search_stock_markets_indices test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/municipality_api_spec.rb

@@ -0,0 +1,84 @@
+=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.1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Intrinio::MunicipalityApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'MunicipalityApi' do
+  before do
+    # run before each test
+    @instance = Intrinio::MunicipalityApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MunicipalityApi' do
+    it 'should create an instance of MunicipalityApi' do
+      expect(@instance).to be_instance_of(Intrinio::MunicipalityApi)
+    end
+  end
+
+  # unit tests for get_all_municipalities
+  # All Municipalities
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :has_financials Return municipalities with financials
+  # @option opts [String] :government_name Return municipalities with a government name matching the given query
+  # @option opts [String] :government_type Return municipalities with the given government type
+  # @option opts [String] :area_name Return municipalities with an area name matching the given query
+  # @option opts [String] :area_type Return municipalities with the given area type
+  # @option opts [String] :city Return municipalities in the given city
+  # @option opts [String] :state Return municipalities in the given state
+  # @option opts [Float] :zipcode Return municipalities in the given zipcode
+  # @option opts [Float] :population_greater_than Return municipalities with a population greater than the given number
+  # @option opts [Float] :population_less_than Return municipalities with a population less than the given number
+  # @option opts [Float] :enrollment_greater_than Return municipalities with an enrollment greater than the given number
+  # @option opts [Float] :enrollment_less_than Return municipalities with an enrollment less than the given number
+  # @option opts [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseMunicipalities]
+  describe 'get_all_municipalities test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_municipality_by_id
+  # Municipality by ID
+  # Returns the Municipality with the given ID
+  # @param id An Intrinio ID of a Municipality
+  # @param [Hash] opts the optional parameters
+  # @return [Municipality]
+  describe 'get_municipality_by_id test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_municipality_financials
+  # Financials for a Municipality
+  # Returns financial statement data for the Municipality with the given ID
+  # @param id An Intrinio ID of a Municipality
+  # @param [Hash] opts the optional parameters
+  # @option opts [Float] :fiscal_year Return financials for the given fiscal year
+  # @return [ApiResponseMunicipalitiyFinancials]
+  describe 'get_municipality_financials test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end