Skip to content

Add support for Assets with Insights reports #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dsfish merged 3 commits into from
Dec 4, 2018
Merged

Add support for Assets with Insights reports #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bfab1e9
Add support for Asset + Insights reports
Nov 1, 2018
c29849a
docs
Nov 1, 2018
2e21e64
docs; add test
Dec 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Index &#8212; Plaid Python 2.3.3 documentation</title>
<title>Index &#8212; Plaid Python 2.3.4 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.3.3',
VERSION: '2.3.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false,
Expand Down
18 changes: 13 additions & 5 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Plaid Python Documentation! &#8212; Plaid Python 2.3.3 documentation</title>
<title>Plaid Python Documentation! &#8212; Plaid Python 2.3.4 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.3.3',
VERSION: '2.3.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false,
Expand Down Expand Up @@ -208,14 +208,22 @@ <h2>API Endpoints<a class="headerlink" href="#api-endpoints" title="Permalink to

<dl class="method">
<dt id="plaid.api.AssetReport.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>asset_report_token</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.api.AssetReport.get" title="Permalink to this definition">¶</a></dt>
<code class="descname">get</code><span class="sig-paren">(</span><em>asset_report_token</em>, <em>include_insights=False</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.api.AssetReport.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves an asset report.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>asset_report_token</strong> (<em>str</em>) &#8211; The asset report token for the
asset report you created.</td>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>asset_report_token</strong> (<em>str</em>) &#8211; The asset report token for the
asset report you created.</li>
<li><strong>include_insights</strong> (<em>bool</em>) &#8211; An optional boolean specifying
whether we should retrieve the
report as an Asset Report with
Insights. For more, see
<a class="reference external" href="https://plaid.com/docs/#retrieve-json-report-request">https://plaid.com/docs/#retrieve-json-report-request</a>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
Expand Down
4 changes: 2 additions & 2 deletions docs/py-modindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Python Module Index &#8212; Plaid Python 2.3.3 documentation</title>
<title>Python Module Index &#8212; Plaid Python 2.3.4 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.3.3',
VERSION: '2.3.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false,
Expand Down
4 changes: 2 additions & 2 deletions docs/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Search &#8212; Plaid Python 2.3.3 documentation</title>
<title>Search &#8212; Plaid Python 2.3.4 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.3.3',
VERSION: '2.3.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false,
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion plaid/api/assets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,16 +73,23 @@ def refresh(self,
})

def get(self,
asset_report_token):
asset_report_token,
include_insights=False):
'''
Retrieves an asset report.

:param str asset_report_token: The asset report token for the
asset report you created.
:param bool include_insights: An optional boolean specifying
whether we should retrieve the
report as an Asset Report with
Insights. For more, see
https://plaid.com/docs/#retrieve-json-report-request.
'''

return self.client.post('/asset_report/get', {
'asset_report_token': asset_report_token,
'include_insights': include_insights,
})

def get_pdf(self,
Expand Down
9 changes: 9 additions & 0 deletions tests/integration/test_assets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ def test_full_flow():
report = response['report']
assert report is not None

# retrieve the asset report as an Asset Report with Insights
response = client.AssetReport.get(asset_report_token, True)
report = response['report']
assert report is not None

# The transactions in an Asset Report with Insights should have a non-null
# `name` (when available).
assert report['items'][0]['accounts'][0]['transactions'][0]['name'] is not None

# retrieve the asset report as a PDF
pdf = client.AssetReport.get_pdf(asset_report_token)
assert pdf is not None
Expand Down