intrinio-sdk 1.0.0

data/lib/intrinio-sdk/version.rb

@@ -0,0 +1,15 @@
+=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.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+module Intrinio
+  VERSION = "1.0.0"
+end

data/spec/api/company_api_spec.rb

@@ -0,0 +1,233 @@
+=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.0.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::CompanyApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'CompanyApi' do
+  before do
+    # run before each test
+    @instance = Intrinio::CompanyApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CompanyApi' do
+    it 'should create an instance of CompanyApi' do
+      expect(@instance).to be_instance_of(Intrinio::CompanyApi)
+    end
+  end
+
+  # unit tests for filter_companies
+  # Filter Companies
+  # Returns Companies matching the specified filters
+  # @param [Hash] opts the optional parameters
+  # @option opts [Date] :last_filing_date Last filing date
+  # @option opts [String] :sic Standard Industrial Classification code
+  # @option opts [String] :template Template
+  # @option opts [String] :sector Industry sector
+  # @option opts [String] :industry_category Industry category
+  # @option opts [String] :industry_group Industry group
+  # @option opts [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseCompanies]
+  describe 'filter_companies 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 filter_company_fundamentals
+  # Filter Fundamentals for a Company
+  # Returns Fundamentals for the Company with the given `identifier` and matching the specified filters
+  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+  # @param [Hash] opts the optional parameters
+  # @option opts [Date] :filed_after Filed on or after this date
+  # @option opts [Date] :filed_before Filed on or before this date
+  # @option opts [BOOLEAN] :reported_only Only as-reported fundamentals
+  # @option opts [Integer] :fiscal_year Only for the given fiscal year
+  # @option opts [String] :statement_code Only of the given statement code
+  # @option opts [String] :type Only of the given type
+  # @option opts [Date] :start_date Only on or after the given date
+  # @option opts [Date] :end_date Only on or before the given date
+  # @option opts [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseCompanyFundamentals]
+  describe 'filter_company_fundamentals 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_companies
+  # Get All Companies
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseCompanies]
+  describe 'get_all_companies 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_company_news
+  # Get All Company News
+  # Returns all news for all companies
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseNews]
+  describe 'get_all_company_news 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_company
+  # Get a Company by ID
+  # 
+  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+  # @param [Hash] opts the optional parameters
+  # @return [Company]
+  describe 'get_company 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_company_data_point_number
+  # Get Company Data Point (Number)
+  # Returns a numeric value for the given `tag` for the Company with the given `identifier`
+  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+  # @param tag An Intrinio data tag
+  # @param [Hash] opts the optional parameters
+  # @return [Float]
+  describe 'get_company_data_point_number 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_company_data_point_text
+  # Get Company Data Point (Text)
+  # Returns a text value for the given `tag` for the Company with the given `identifier`
+  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+  # @param tag An Intrinio data tag
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'get_company_data_point_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 get_company_filings
+  # Get Filings for a Company
+  # Returns a complete list of SEC filings for the Company with the given `identifier`
+  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseCompanyFilings]
+  describe 'get_company_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_company_fundamentals
+  # Get All Fundamentals for a Company
+  # Returns all Fundamentals for the Company with the given `identifier`
+  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseCompanyFundamentals]
+  describe 'get_company_fundamentals 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_company_historical_data
+  # Get Company Historical Data
+  # Returns historical values for the given `tag` and the Company with the given `identifier`
+  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+  # @param tag Item
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :type Filter by type, when applicable
+  # @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 [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseCompanyHistoricalData]
+  describe 'get_company_historical_data 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_company_news
+  # Get News for a Company
+  # Returns news for the Company with the given `identifier`
+  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseCompanyNews]
+  describe 'get_company_news 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_company_securities
+  # Get Securities by Company
+  # Return Securities for the Company with `identifier`
+  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseCompanySecurities]
+  describe 'get_company_securities 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 lookup_company_fundamental
+  # Lookup a Fundamental for a Company
+  # 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
+  # @param fiscal_period The fiscal period
+  # @param fiscal_year The fiscal year
+  # @param [Hash] opts the optional parameters
+  # @return [Fundamental]
+  describe 'lookup_company_fundamental 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_companies
+  # Search Companies
+  # Searches for Companies matching the text `query`
+  # @param query Search parameters
+  # @param [Hash] opts the optional parameters
+  # @return [ApiResponseCompanies]
+  describe 'search_companies 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/data_point_api_spec.rb

@@ -0,0 +1,61 @@
+=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.0.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::DataPointApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DataPointApi' do
+  before do
+    # run before each test
+    @instance = Intrinio::DataPointApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DataPointApi' do
+    it 'should create an instance of DataPointApi' do
+      expect(@instance).to be_instance_of(Intrinio::DataPointApi)
+    end
+  end
+
+  # unit tests for get_data_point_number
+  # Get a Data Point (Number)
+  # Returns a numeric value for the given `tag` and the entity with 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
+  # @param [Hash] opts the optional parameters
+  # @return [Float]
+  describe 'get_data_point_number 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_data_point_text
+  # Get a Data Point (Text)
+  # Returns a text value for the given `tag` and the entity with 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
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'get_data_point_text 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/data_tag_api_spec.rb

@@ -0,0 +1,88 @@
+=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.0.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::DataTagApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DataTagApi' do
+  before do
+    # run before each test
+    @instance = Intrinio::DataTagApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DataTagApi' do
+    it 'should create an instance of DataTagApi' do
+      expect(@instance).to be_instance_of(Intrinio::DataTagApi)
+    end
+  end
+
+  # unit tests for filter_data_tags
+  # Filter Data Tags
+  # Returns Data Tags that match the given filters
+  # @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 [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseDataTags]
+  describe 'filter_data_tags 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_data_tags
+  # Get 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]
+  describe 'get_all_data_tags 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_data_tag_by_id
+  # Get a Data Tag by ID
+  # Returns a Data Tag with the specified `identifier`
+  # @param identifier The Intrinio ID or the code-name of the Data Tag
+  # @param [Hash] opts the optional parameters
+  # @return [DataTag]
+  describe 'get_data_tag_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 search_data_tags
+  # Search Data Tags
+  # Searches for Data Tags matching the text `query`
+  # @param query 
+  # @param [Hash] opts the optional parameters
+  # @return [ApiResponseDataTags]
+  describe 'search_data_tags 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/filing_api_spec.rb

@@ -0,0 +1,75 @@
+=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.0.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::FilingApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FilingApi' do
+  before do
+    # run before each test
+    @instance = Intrinio::FilingApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FilingApi' do
+    it 'should create an instance of FilingApi' do
+      expect(@instance).to be_instance_of(Intrinio::FilingApi)
+    end
+  end
+
+  # unit tests for filter_filings
+  # Filter Filings
+  # 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
+  # @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 [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseFilings]
+  describe 'filter_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
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :next_page Gets the next page of data from a previous API call
+  # @return [ApiResponseFilings]
+  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_filing_by_id
+  # Get a Filing by ID
+  # Return the filing with the given ID
+  # @param id The Intrinio ID of the Filing
+  # @param [Hash] opts the optional parameters
+  # @return [Filing]
+  describe 'get_filing_by_id test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end