Skip to content

Commit

Permalink
No release notes for this build
Browse files Browse the repository at this point in the history
  • Loading branch information
kgmiller committed Apr 7, 2020
1 parent ff8131f commit a5b672c
Show file tree
Hide file tree
Showing 14 changed files with 717 additions and 37 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ To get an API key, [sign up here](https://intrinio.com/).

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.

- API version: 2.9.0
- Package version: 5.2.0
- API version: 2.10.0
- Package version: 5.3.0


<a name="frameworks-supported"></a>
Expand Down Expand Up @@ -116,7 +116,7 @@ A listing of classes and methods is also provided below:

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BulkDownloadsApi* | [**GetBulkDownloadLinks**](docs/BulkDownloadsApi.md#getbulkdownloadlinks) | **GET** /bulk_downloads/links | Bulk Downloads
*BulkDownloadsApi* | [**GetBulkDownloadLinks**](docs/BulkDownloadsApi.md#getbulkdownloadlinks) | **GET** /bulk_downloads/links | All Links
*CompanyApi* | [**GetAllCompanies**](docs/CompanyApi.md#getallcompanies) | **GET** /companies | All Companies
*CompanyApi* | [**GetAllCompanyNews**](docs/CompanyApi.md#getallcompanynews) | **GET** /companies/news | All News
*CompanyApi* | [**GetCompany**](docs/CompanyApi.md#getcompany) | **GET** /companies/{identifier} | Lookup Company
Expand All @@ -139,6 +139,8 @@ Class | Method | HTTP request | Description
*FilingApi* | [**GetAllNotes**](docs/FilingApi.md#getallnotes) | **GET** /filings/notes | All Filing Notes
*FilingApi* | [**GetFilingById**](docs/FilingApi.md#getfilingbyid) | **GET** /filings/{id} | Lookup Filing
*FilingApi* | [**GetFilingFundamentals**](docs/FilingApi.md#getfilingfundamentals) | **GET** /filings/{identifier}/fundamentals | All Fundamentals by Filing
*FilingApi* | [**GetFilingHtml**](docs/FilingApi.md#getfilinghtml) | **GET** /filings/{identifier}/html | Filing Html
*FilingApi* | [**GetFilingText**](docs/FilingApi.md#getfilingtext) | **GET** /filings/{identifier}/text | Filing Text
*FilingApi* | [**GetNote**](docs/FilingApi.md#getnote) | **GET** /filings/notes/{identifier} | Filing Note by ID
*FilingApi* | [**GetNoteHtml**](docs/FilingApi.md#getnotehtml) | **GET** /filings/notes/{identifier}/html | Filing Note HTML
*FilingApi* | [**GetNoteText**](docs/FilingApi.md#getnotetext) | **GET** /filings/notes/{identifier}/text | Filing Note Text
Expand Down
4 changes: 2 additions & 2 deletions docs/BulkDownloadsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All URIs are relative to *https://api-v2.intrinio.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**GetBulkDownloadLinks**](BulkDownloadsApi.md#getbulkdownloadlinks) | **GET** /bulk_downloads/links | Bulk Downloads
[**GetBulkDownloadLinks**](BulkDownloadsApi.md#getbulkdownloadlinks) | **GET** /bulk_downloads/links | All Links



Expand Down Expand Up @@ -35,7 +35,7 @@ Method | HTTP request | Description

> ApiResponseBulkDownloadLinks GetBulkDownloadLinks ()
#### Bulk Downloads
#### All Links

Returns all active bulk downloads for your account with links to download.

Expand Down
3 changes: 3 additions & 0 deletions docs/Filing.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ Name | Type | Description
**FilingUrl** | string | The URL to the filing page on the SEC site &nbsp;
**ReportUrl** | string | The URL to the actual report on the SEC site &nbsp;
**InstanceUrl** | string | The URL for the XBRL filing for the report &nbsp;
**IndustryCategory** | string | The company&#39;s operating industry category &nbsp;
**IndustryGroup** | string | The company&#39;s operating industry group &nbsp;
**WordCount** | int? | The number of words in the filing &nbsp;
**Company** | [**CompanySummary**](CompanySummary.md) | &nbsp;

[//]: # (END_DEFINITION)
Expand Down
188 changes: 186 additions & 2 deletions docs/FilingApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Method | HTTP request | Description
[**GetAllNotes**](FilingApi.md#getallnotes) | **GET** /filings/notes | All Filing Notes
[**GetFilingById**](FilingApi.md#getfilingbyid) | **GET** /filings/{id} | Lookup Filing
[**GetFilingFundamentals**](FilingApi.md#getfilingfundamentals) | **GET** /filings/{identifier}/fundamentals | All Fundamentals by Filing
[**GetFilingHtml**](FilingApi.md#getfilinghtml) | **GET** /filings/{identifier}/html | Filing Html
[**GetFilingText**](FilingApi.md#getfilingtext) | **GET** /filings/{identifier}/text | Filing Text
[**GetNote**](FilingApi.md#getnote) | **GET** /filings/notes/{identifier} | Filing Note by ID
[**GetNoteHtml**](FilingApi.md#getnotehtml) | **GET** /filings/notes/{identifier}/html | Filing Note HTML
[**GetNoteText**](FilingApi.md#getnotetext) | **GET** /filings/notes/{identifier}/text | Filing Note Text
Expand Down Expand Up @@ -40,7 +42,7 @@ Method | HTTP request | Description

[//]: # (START_OVERVIEW)

> ApiResponseFilings GetAllFilings (string company, string reportType = null, DateTime? startDate = null, DateTime? endDate = null, int? pageSize = null, string nextPage = null)
> ApiResponseFilings GetAllFilings (string company, string reportType = null, DateTime? startDate = null, DateTime? endDate = null, string industryCategory = null, string industryGroup = null, int? pageSize = null, string nextPage = null)
#### All Filings

Expand Down Expand Up @@ -72,12 +74,14 @@ namespace Example
var reportType = ""; // string | Filter by report type. Separate values with commas to return multiple The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report types</a>. (optional)
var startDate = DateTime.Parse("2015-01-01"); // DateTime? | Filed on or after the given date (optional)
var endDate = DateTime.Now; // DateTime? | Filed before or after the given date (optional)
var industryCategory = ""; // string | Return companies in the given industry category (optional)
var industryGroup = ""; // string | Return companies in the given industry group (optional)
var pageSize = 100; // int? | The number of results to return (optional) (default to 100)
var nextPage = ""; // string | Gets the next page of data from a previous API call (optional)
try
{
ApiResponseFilings result = filingApi.GetAllFilings(company, reportType, startDate, endDate, pageSize, nextPage);
ApiResponseFilings result = filingApi.GetAllFilings(company, reportType, startDate, endDate, industryCategory, industryGroup, pageSize, nextPage);
Console.WriteLine(result.ToJson());
}
catch (Exception e)
Expand All @@ -102,6 +106,8 @@ Name | Type | Description | Notes
**reportType** | string| Filter by report type. Separate values with commas to return multiple The filing &lt;a href&#x3D;\&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\&quot; target&#x3D;\&quot;_blank\&quot;&gt;report types&lt;/a&gt;. | [optional] &nbsp;
**startDate** | DateTime?| Filed on or after the given date | [optional] &nbsp;
**endDate** | DateTime?| Filed before or after the given date | [optional] &nbsp;
**industryCategory** | string| Return companies in the given industry category | [optional] &nbsp;
**industryGroup** | string| Return companies in the given industry group | [optional] &nbsp;
**pageSize** | int?| The number of results to return | [optional] [default to 100] &nbsp;
**nextPage** | string| Gets the next page of data from a previous API call | [optional] &nbsp;
<br/>
Expand Down Expand Up @@ -413,6 +419,184 @@ Name | Type | Description | Notes
[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:Intrinio.SDK.Api.FilingApi)

[//]: # (METHOD:GetFilingHtml)

[//]: # (RETURN_TYPE:string)

[//]: # (RETURN_TYPE_KIND:primitive)

[//]: # (RETURN_TYPE_DOC:)

[//]: # (OPERATION:GetFilingHtml_v2)

[//]: # (ENDPOINT:/filings/{identifier}/html)

[//]: # (DOCUMENT_LINK:FilingApi.md#getfilinghtml)

<a name="getfilinghtml"></a>
## **GetFilingHtml**

[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/csharp/GetFilingHtml_v2)

[//]: # (START_OVERVIEW)

> string GetFilingHtml (string identifier)
#### Filing Html


[//]: # (END_OVERVIEW)

### Example

[//]: # (START_CODE_EXAMPLE)

```csharp
using System;
using System.Diagnostics;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;

namespace Example
{
public class GetFilingHtmlExample
{
public static void Main()
{
Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");

var filingApi = new FilingApi();
var identifier = "fil_B73xBG"; // string | A Filing identifier
try
{
string result = filingApi.GetFilingHtml(identifier);
Console.WriteLine(result.ToJson());
}
catch (Exception e)
{
Console.WriteLine("Exception when calling FilingApi.GetFilingHtml: " + e.Message );
}
}
}
}
```

[//]: # (END_CODE_EXAMPLE)

### Parameters

[//]: # (START_PARAMETERS)


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | string| A Filing identifier | &nbsp;
<br/>

[//]: # (END_PARAMETERS)

### Return type

**string**

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:Intrinio.SDK.Api.FilingApi)

[//]: # (METHOD:GetFilingText)

[//]: # (RETURN_TYPE:string)

[//]: # (RETURN_TYPE_KIND:primitive)

[//]: # (RETURN_TYPE_DOC:)

[//]: # (OPERATION:GetFilingText_v2)

[//]: # (ENDPOINT:/filings/{identifier}/text)

[//]: # (DOCUMENT_LINK:FilingApi.md#getfilingtext)

<a name="getfilingtext"></a>
## **GetFilingText**

[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/csharp/GetFilingText_v2)

[//]: # (START_OVERVIEW)

> string GetFilingText (string identifier)
#### Filing Text


[//]: # (END_OVERVIEW)

### Example

[//]: # (START_CODE_EXAMPLE)

```csharp
using System;
using System.Diagnostics;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;

namespace Example
{
public class GetFilingTextExample
{
public static void Main()
{
Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");

var filingApi = new FilingApi();
var identifier = "fil_B73xBG"; // string | A Filing identifier
try
{
string result = filingApi.GetFilingText(identifier);
Console.WriteLine(result.ToJson());
}
catch (Exception e)
{
Console.WriteLine("Exception when calling FilingApi.GetFilingText: " + e.Message );
}
}
}
}
```

[//]: # (END_CODE_EXAMPLE)

### Parameters

[//]: # (START_PARAMETERS)


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | string| A Filing identifier | &nbsp;
<br/>

[//]: # (END_PARAMETERS)

### Return type

**string**

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:Intrinio.SDK.Api.FilingApi)
Expand Down
28 changes: 27 additions & 1 deletion src/Intrinio.SDK.Test/Api/FilingApiTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,11 @@ public void GetAllFilingsTest()
//string reportType = null;
//DateTime? startDate = null;
//DateTime? endDate = null;
//string industryCategory = null;
//string industryGroup = null;
//int? pageSize = null;
//string nextPage = null;
//var response = instance.GetAllFilings(company, reportType, startDate, endDate, pageSize, nextPage);
//var response = instance.GetAllFilings(company, reportType, startDate, endDate, industryCategory, industryGroup, pageSize, nextPage);
//Assert.IsInstanceOf<ApiResponseFilings> (response, "response is ApiResponseFilings");
}

Expand Down Expand Up @@ -119,6 +121,30 @@ public void GetFilingFundamentalsTest()
//Assert.IsInstanceOf<ApiResponseFilingFundamentals> (response, "response is ApiResponseFilingFundamentals");
}

/// <summary>
/// Test GetFilingHtml
/// </summary>
[Test]
public void GetFilingHtmlTest()
{
// TODO uncomment below to test the method and replace null with proper value
//string identifier = null;
//var response = instance.GetFilingHtml(identifier);
//Assert.IsInstanceOf<string> (response, "response is string");
}

/// <summary>
/// Test GetFilingText
/// </summary>
[Test]
public void GetFilingTextTest()
{
// TODO uncomment below to test the method and replace null with proper value
//string identifier = null;
//var response = instance.GetFilingText(identifier);
//Assert.IsInstanceOf<string> (response, "response is string");
}

/// <summary>
/// Test GetNote
/// </summary>
Expand Down
2 changes: 1 addition & 1 deletion src/Intrinio.SDK.Test/Intrinio.SDK.Test.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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.9.0
OpenAPI spec version: 2.10.0
-->
<Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
Expand Down
24 changes: 24 additions & 0 deletions src/Intrinio.SDK.Test/Model/FilingTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,30 @@ public void InstanceUrlTest()
// TODO unit test for the property 'InstanceUrl'
}
/// <summary>
/// Test the property 'IndustryCategory'
/// </summary>
[Test]
public void IndustryCategoryTest()
{
// TODO unit test for the property 'IndustryCategory'
}
/// <summary>
/// Test the property 'IndustryGroup'
/// </summary>
[Test]
public void IndustryGroupTest()
{
// TODO unit test for the property 'IndustryGroup'
}
/// <summary>
/// Test the property 'WordCount'
/// </summary>
[Test]
public void WordCountTest()
{
// TODO unit test for the property 'WordCount'
}
/// <summary>
/// Test the property 'Company'
/// </summary>
[Test]
Expand Down
Loading

0 comments on commit a5b672c

Please sign in to comment.