Skip to content

Commit 20a7de3

Browse files
jzheng-plaidjzheng-plaid
committed
updated docs for version 2.2.1
1 parent 32f4fee commit 20a7de3

6 files changed

Lines changed: 19 additions & 16 deletions

File tree

‎Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ setup:
1717
docs:
1818
-rm -r docs/
1919
sphinx-build docs_source/ docs/ -b html
20+
touch docs/.nojekyll

‎docs/genindex.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
<head>
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
99

10-
<title>Index &#8212; Plaid Python 2.2.0 documentation</title>
10+
<title>Index &#8212; Plaid Python 2.2.1 documentation</title>
1111

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

1515
<script type="text/javascript">
1616
var DOCUMENTATION_OPTIONS = {
1717
URL_ROOT: './',
18-
VERSION: '2.2.0',
18+
VERSION: '2.2.1',
1919
COLLAPSE_INDEX: false,
2020
FILE_SUFFIX: '.html',
2121
HAS_SOURCE: false,

‎docs/index.html‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88

9-
<title>Plaid Python Documentation! &#8212; Plaid Python 2.2.0 documentation</title>
9+
<title>Plaid Python Documentation! &#8212; Plaid Python 2.2.1 documentation</title>
1010

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

1414
<script type="text/javascript">
1515
var DOCUMENTATION_OPTIONS = {
1616
URL_ROOT: './',
17-
VERSION: '2.2.0',
17+
VERSION: '2.2.1',
1818
COLLAPSE_INDEX: false,
1919
FILE_SUFFIX: '.html',
2020
HAS_SOURCE: false,
@@ -647,7 +647,7 @@ <h2>API Endpoints<a class="headerlink" href="#api-endpoints" title="Permalink to
647647
<span id="errors"></span><h2>Errors<a class="headerlink" href="#module-plaid.errors" title="Permalink to this headline"></a></h2>
648648
<dl class="exception">
649649
<dt id="plaid.errors.PlaidError">
650-
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">PlaidError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.PlaidError" title="Permalink to this definition"></a></dt>
650+
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">PlaidError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em>, <em>request_id=''</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.PlaidError" title="Permalink to this definition"></a></dt>
651651
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></p>
652652
<p>A Plaid API error.</p>
653653
<table class="docutils field-list" frame="void" rules="none">
@@ -662,6 +662,8 @@ <h2>API Endpoints<a class="headerlink" href="#api-endpoints" title="Permalink to
662662
safe for programmatic use.</li>
663663
<li><strong>display_message</strong> (<em>str</em>) &#8211; A user-friendly error message. Not safe
664664
for programmatic use. May be None.</li>
665+
<li><strong>request_id</strong> (<em>str</em>) &#8211; A unique id returned for all server
666+
responses.</li>
665667
</ul>
666668
</td>
667669
</tr>
@@ -678,42 +680,42 @@ <h2>API Endpoints<a class="headerlink" href="#api-endpoints" title="Permalink to
678680

679681
<dl class="exception">
680682
<dt id="plaid.errors.InvalidRequestError">
681-
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">InvalidRequestError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.InvalidRequestError" title="Permalink to this definition"></a></dt>
683+
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">InvalidRequestError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em>, <em>request_id=''</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.InvalidRequestError" title="Permalink to this definition"></a></dt>
682684
<dd><p>Bases: <a class="reference internal" href="#plaid.errors.PlaidError" title="plaid.errors.PlaidError"><code class="xref py py-class docutils literal"><span class="pre">plaid.errors.PlaidError</span></code></a></p>
683685
<p>The request is malformed and cannot be processed.</p>
684686
</dd></dl>
685687

686688
<dl class="exception">
687689
<dt id="plaid.errors.InvalidInputError">
688-
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">InvalidInputError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.InvalidInputError" title="Permalink to this definition"></a></dt>
690+
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">InvalidInputError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em>, <em>request_id=''</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.InvalidInputError" title="Permalink to this definition"></a></dt>
689691
<dd><p>Bases: <a class="reference internal" href="#plaid.errors.PlaidError" title="plaid.errors.PlaidError"><code class="xref py py-class docutils literal"><span class="pre">plaid.errors.PlaidError</span></code></a></p>
690692
<p>The request is correctly formatted, but the values are incorrect.</p>
691693
</dd></dl>
692694

693695
<dl class="exception">
694696
<dt id="plaid.errors.RateLimitExceededError">
695-
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">RateLimitExceededError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.RateLimitExceededError" title="Permalink to this definition"></a></dt>
697+
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">RateLimitExceededError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em>, <em>request_id=''</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.RateLimitExceededError" title="Permalink to this definition"></a></dt>
696698
<dd><p>Bases: <a class="reference internal" href="#plaid.errors.PlaidError" title="plaid.errors.PlaidError"><code class="xref py py-class docutils literal"><span class="pre">plaid.errors.PlaidError</span></code></a></p>
697699
<p>The request is valid but has exceeded established rate limits.</p>
698700
</dd></dl>
699701

700702
<dl class="exception">
701703
<dt id="plaid.errors.APIError">
702-
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">APIError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.APIError" title="Permalink to this definition"></a></dt>
704+
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">APIError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em>, <em>request_id=''</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.APIError" title="Permalink to this definition"></a></dt>
703705
<dd><p>Bases: <a class="reference internal" href="#plaid.errors.PlaidError" title="plaid.errors.PlaidError"><code class="xref py py-class docutils literal"><span class="pre">plaid.errors.PlaidError</span></code></a></p>
704706
<p>Planned maintenance or an API internal server error.</p>
705707
</dd></dl>
706708

707709
<dl class="exception">
708710
<dt id="plaid.errors.ItemError">
709-
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">ItemError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.ItemError" title="Permalink to this definition"></a></dt>
711+
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">ItemError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em>, <em>request_id=''</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.ItemError" title="Permalink to this definition"></a></dt>
710712
<dd><p>Bases: <a class="reference internal" href="#plaid.errors.PlaidError" title="plaid.errors.PlaidError"><code class="xref py py-class docutils literal"><span class="pre">plaid.errors.PlaidError</span></code></a></p>
711713
<p>There is invalid information about an item or it is not supported.</p>
712714
</dd></dl>
713715

714716
<dl class="exception">
715717
<dt id="plaid.errors.InstitutionError">
716-
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">InstitutionError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.InstitutionError" title="Permalink to this definition"></a></dt>
718+
<em class="property">exception </em><code class="descclassname">plaid.errors.</code><code class="descname">InstitutionError</code><span class="sig-paren">(</span><em>message</em>, <em>type</em>, <em>code</em>, <em>display_message</em>, <em>request_id=''</em><span class="sig-paren">)</span><a class="headerlink" href="#plaid.errors.InstitutionError" title="Permalink to this definition"></a></dt>
717719
<dd><p>Bases: <a class="reference internal" href="#plaid.errors.PlaidError" title="plaid.errors.PlaidError"><code class="xref py py-class docutils literal"><span class="pre">plaid.errors.PlaidError</span></code></a></p>
718720
<p>There are errors for the requested financial institution.</p>
719721
</dd></dl>

‎docs/py-modindex.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88

9-
<title>Python Module Index &#8212; Plaid Python 2.2.0 documentation</title>
9+
<title>Python Module Index &#8212; Plaid Python 2.2.1 documentation</title>
1010

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

1414
<script type="text/javascript">
1515
var DOCUMENTATION_OPTIONS = {
1616
URL_ROOT: './',
17-
VERSION: '2.2.0',
17+
VERSION: '2.2.1',
1818
COLLAPSE_INDEX: false,
1919
FILE_SUFFIX: '.html',
2020
HAS_SOURCE: false,

‎docs/search.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
<head>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88

9-
<title>Search &#8212; Plaid Python 2.2.0 documentation</title>
9+
<title>Search &#8212; Plaid Python 2.2.1 documentation</title>
1010

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

1414
<script type="text/javascript">
1515
var DOCUMENTATION_OPTIONS = {
1616
URL_ROOT: './',
17-
VERSION: '2.2.0',
17+
VERSION: '2.2.1',
1818
COLLAPSE_INDEX: false,
1919
FILE_SUFFIX: '.html',
2020
HAS_SOURCE: false,

0 commit comments

Comments
 (0)