security_api_spec.rb in intrinio-sdk-2.0.0

- 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://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
 
 =end
@@ -31,35 +31,36 @@
       expect(@instance).to be_instance_of(Intrinio::SecurityApi)
     end
   end
 
   # unit tests for get_all_securities
-  # Get All Securiites
+  # All Securities
   # 
   # @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 [ApiResponseSecurities]
   describe 'get_all_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 get_security_by_id
-  # Get a Security by ID
-  # 
+  # Lookup Security
+  # Returns the Security with the given &#x60;identifier&#x60;
   # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
   # @param [Hash] opts the optional parameters
   # @return [Security]
   describe 'get_security_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_security_data_point_number
-  # Get Security Data Point (Number)
+  # Data Point (Number) for Security
   # Returns a numeric value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;
   # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
   # @param [Hash] opts the optional parameters
   # @return [Float]
@@ -68,11 +69,11 @@
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_security_data_point_text
-  # Get Security Data Point (Text)
+  # Data Point (Text) for Security
   # Returns a text value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;
   # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
   # @param [Hash] opts the optional parameters
   # @return [String]
@@ -81,66 +82,125 @@
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for get_security_historical_data
-  # Get Security Historical Data
+  # Historical Data for Security
   # Returns historical values for the given &#x60;tag&#x60; and the Security with the given &#x60;identifier&#x60;
   # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
   # @param tag An Intrinio data tag ID or code-name
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :frequency Return historical data in the given frequency
   # @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 date on or before this date
   # @option opts [String] :sort_order Sort by date &#x60;asc&#x60; or &#x60;desc&#x60;
+  # @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 [ApiResponseSecurityHistoricalData]
   describe 'get_security_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_security_intraday_prices
+  # Intraday Stock Prices for Security
+  # Return intraday stock prices for the Security with the given &#x60;identifier&#x60;
+  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :source Return intraday prices from the specified data source
+  # @option opts [Date] :start_date Return intraday prices starting at the specified date
+  # @option opts [String] :start_time Return intraday prices starting at the specified time on the &#x60;start_date&#x60; (timezone is UTC)
+  # @option opts [Date] :end_date Return intraday prices stopping at the specified date
+  # @option opts [String] :end_time Return intraday prices stopping at the specified time on the &#x60;end_date&#x60; (timezone is UTC)
+  # @return [ApiResponseSecurityIntradayPrices]
+  describe 'get_security_intraday_prices 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_security_latest_dividend_record
+  # Lastest Dividend Record for Security
+  # Returns the latest available dividend information for the Security with the given &#x60;identifier&#x60;
+  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+  # @param [Hash] opts the optional parameters
+  # @return [DividendRecord]
+  describe 'get_security_latest_dividend_record 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_security_latest_earnings_record
+  # Lastest Earnings Record for Security
+  # Returns latest available earnings information for the Security with the given &#x60;identifier&#x60;
+  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+  # @param [Hash] opts the optional parameters
+  # @return [EarningsRecord]
+  describe 'get_security_latest_earnings_record 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_security_realtime_price
+  # Realtime Stock Price for Security
+  # Return the realtime stock price for the Security with the given &#x60;identifier&#x60;
+  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :source Return the realtime price from the specified data source
+  # @return [RealtimeStockPrice]
+  describe 'get_security_realtime_price 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_security_stock_price_adjustments
-  # Get Stock Price Adjustments for Security
-  # Return stock price adjustments for the Security with the given &#x60;identifier&#x60;
+  # Stock Price Adjustments by Security
+  # Returns stock price adjustments for the Security with the given &#x60;identifier&#x60;
   # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
   # @param [Hash] opts the optional parameters
   # @option opts [Date] :start_date Return price adjustments on or after the date
   # @option opts [Date] :end_date Return price adjustments on or before the 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 [ApiResponseSecurityStockPriceAdjustments]
   describe 'get_security_stock_price_adjustments 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_security_stock_prices
-  # Get Stock Prices for Security
-  # Return stock prices for the Security with the given &#x60;identifier&#x60;
+  # Stock Prices by Security
+  # Return end-of-day stock prices for the Security with the given &#x60;identifier&#x60;
   # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
   # @param [Hash] opts the optional parameters
   # @option opts [Date] :start_date Return prices on or after the date
   # @option opts [Date] :end_date Return prices on or before the date
   # @option opts [String] :frequency Return stock prices in the given frequency
+  # @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 [ApiResponseSecurityStockPrices]
   describe 'get_security_stock_prices 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 screen_securities
   # Screen Securities
-  # Screen securities using complex logic
+  # Screen Securities using complex logic
   # @param [Hash] opts the optional parameters
   # @option opts [SecurityScreenGroup] :logic The logic to screen with, consisting of operators, clauses, and nested groups.&lt;br/&gt; See &lt;a href&#x3D;\&quot;/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.
   # @option opts [String] :order_column Results returned sorted by this column
   # @option opts [String] :order_direction Sort order to use with the order_column
   # @option opts [BOOLEAN] :primary_only Return only primary securities
+  # @option opts [Float] :page_size The number of results to return
   # @return [Array<SecurityScreenResult>]
   describe 'screen_securities test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -149,10 +209,11 @@
   # unit tests for search_securities
   # Search Securities
   # Searches for Securities matching the text &#x60;query&#x60;
   # @param query 
   # @param [Hash] opts the optional parameters
-  # @return [ApiResponseSecurities]
+  # @option opts [Float] :page_size The number of results to return
+  # @return [ApiResponseSecuritiesSearch]
   describe 'search_securities test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end