RubyGems - plaid - Versions diffs - 14.8.0 → 14.9.0 - Mend

plaid 14.8.0 → 14.9.0

Files changed (747) hide show

data/doc/rdoc/classes/Plaid/Institutions.html ADDED Viewed

@@ -0,0 +1,356 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>Plaid::Institutions</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../../css/github.css" type="text/css" media="screen" />
+<script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+<script src="../../js/main.js" type="text/javascript" charset="utf-8"></script>
+<script src="../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
+    <meta property="og:title" value="Plaid::Institutions">
+    <meta name="description" content="Class used to call the Institutions product.">
+    <meta property="og:description" content="Class used to call the Institutions product.">
+    <meta name="keywords" content="Plaid::Institutions class">
+    <meta name="keywords" content="get, get_by_id, search">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::Institutions
+                <span class="parent">&lt;
+                    <a href="BaseProduct.html">Plaid::BaseProduct</a>
+                </span>
+        </h1>
+        <ul class="files">
+            <li><a href="../../files/lib/plaid/products/institutions_rb.html">lib/plaid/products/institutions.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+<p>Class used to call the <a href="Institutions.html">Institutions</a>
+product.</p>
+    </div>
+    <!-- Sections -->
+    <div class="sectiontitle">Sections</div>
+    <ul>
+        <li><a href="#Public">Public</a></li>
+    </ul>
+    <!-- Method ref -->
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+        <dt>G</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-get">get</a>,
+              </li>
+              <li>
+                <a href="#method-i-get_by_id">get_by_id</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>S</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-search">search</a>
+              </li>
+          </ul>
+        </dd>
+    </dl>
+    <!-- Methods -->
+      <div class="contenttitle" id="Public">
+        Public
+      </div>
+    <!-- Methods -->
+      <div class="sectiontitle">Instance Public methods</div>
+        <div class="method">
+          <div class="title method-title" id="method-i-get">
+              <b>get</b>(count:, offset:, country_codes:, options: nil)
+            <a href="../../classes/Plaid/Institutions.html#method-i-get" name="method-i-get" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Get information about <a href="../Plaid.html">Plaid</a> institutions.</p>
+<p>Does a POST /institutions/get call pulls a list of supported <a
+href="../Plaid.html">Plaid</a> institutions with the information for each
+institution.</p>
+<dl class="rdoc-list note-list"><dt>count
+<dd>
+<p>Amount of institutions to pull.</p>
+</dd><dt>offset
+<dd>
+<p>Offset to start pulling institutions.</p>
+</dd><dt>options
+<dd>
+<p>Options for filtering institutions.</p>
+</dd></dl>
+<h3 id="method-i-get-label-Returns">Returns</h3>
+<p>Returns a <a
+href="MultipleInstitutionsResponse.html">MultipleInstitutionsResponse</a>
+instance.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-get_source')" id="l_method-i-get_source">show</a>
+              </p>
+              <div id="method-i-get_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/institutions.rb, line 14</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get</span>(<span class="ruby-value">count:</span>, <span class="ruby-value">offset:</span>, <span class="ruby-value">country_codes:</span>, <span class="ruby-value">options:</span> <span class="ruby-keyword">nil</span>)
+  <span class="ruby-identifier">payload</span> = { <span class="ruby-value">count:</span> <span class="ruby-identifier">count</span>,
+              <span class="ruby-value">offset:</span> <span class="ruby-identifier">offset</span>,
+              <span class="ruby-value">country_codes:</span> <span class="ruby-identifier">country_codes</span> }
+  <span class="ruby-identifier">payload</span>[<span class="ruby-value">:options</span>] = <span class="ruby-identifier">options</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">nil?</span>
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;institutions/get&#39;</span>,
+                 <span class="ruby-constant">MultipleInstitutionsResponse</span>,
+                 <span class="ruby-identifier">payload</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-get_by_id">
+              <b>get_by_id</b>(institution_id, country_codes, options: nil)
+            <a href="../../classes/Plaid/Institutions.html#method-i-get_by_id" name="method-i-get_by_id" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Get information about a <a href="../Plaid.html">Plaid</a> institution by
+ID.</p>
+<p>Does a POST /institutions/get_by_id call which allows you to pull
+information for an institution by ID.</p>
+<dl class="rdoc-list note-list"><dt>institution_id
+<dd>
+<p>Specific institution id to fetch information for.</p>
+</dd><dt>options
+<dd>
+<p>Options for filtering institutions.</p>
+</dd></dl>
+<h3 id="method-i-get_by_id-label-Returns">Returns</h3>
+<p>Returns a <a
+href="SingleInstitutionResponse.html">SingleInstitutionResponse</a>
+instance.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-get_by_id_source')" id="l_method-i-get_by_id_source">show</a>
+              </p>
+              <div id="method-i-get_by_id_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/institutions.rb, line 34</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_by_id</span>(<span class="ruby-identifier">institution_id</span>, <span class="ruby-identifier">country_codes</span>, <span class="ruby-value">options:</span> <span class="ruby-keyword">nil</span>)
+  <span class="ruby-identifier">payload</span> = {
+    <span class="ruby-value">institution_id:</span> <span class="ruby-identifier">institution_id</span>,
+    <span class="ruby-value">country_codes:</span> <span class="ruby-identifier">country_codes</span>
+  }
+  <span class="ruby-identifier">payload</span>[<span class="ruby-value">:options</span>] = <span class="ruby-identifier">options</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">nil?</span>
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;institutions/get_by_id&#39;</span>,
+                 <span class="ruby-constant">SingleInstitutionResponse</span>,
+                 <span class="ruby-identifier">payload</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-search">
+              <b>search</b>(query, country_codes, products = nil, options: nil)
+            <a href="../../classes/Plaid/Institutions.html#method-i-search" name="method-i-search" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Get information about all available institutions matching your query.</p>
+<p>Does a POST /institutions/search call which allows you to pull a list of
+institutions using a query parameter.</p>
+<dl class="rdoc-list note-list"><dt>query
+<dd>
+<p>Search query to attempt to match institutions to.</p>
+</dd><dt>products
+<dd>
+<p>Product supported filter (optional).</p>
+</dd><dt>options
+<dd>
+<p>Options for filtering institutions.</p>
+</dd></dl>
+<h3 id="method-i-search-label-Returns">Returns</h3>
+<p>Returns a <a
+href="MultipleInstitutionsResponse.html">MultipleInstitutionsResponse</a>
+instance.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-search_source')" id="l_method-i-search_source">show</a>
+              </p>
+              <div id="method-i-search_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/institutions.rb, line 56</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search</span>(<span class="ruby-identifier">query</span>, <span class="ruby-identifier">country_codes</span>, <span class="ruby-identifier">products</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-value">options:</span> <span class="ruby-keyword">nil</span>)
+  <span class="ruby-identifier">payload</span> = {
+    <span class="ruby-value">query:</span> <span class="ruby-identifier">query</span>,
+    <span class="ruby-value">products:</span> <span class="ruby-identifier">products</span>,
+    <span class="ruby-value">country_codes:</span> <span class="ruby-identifier">country_codes</span>
+  }
+  <span class="ruby-identifier">payload</span>[<span class="ruby-value">:options</span>] = <span class="ruby-identifier">options</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">nil?</span>
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;institutions/search&#39;</span>,
+                 <span class="ruby-constant">MultipleInstitutionsResponse</span>,
+                 <span class="ruby-identifier">payload</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+</div>
+    </div>
+  </body>
+</html>

data/doc/rdoc/classes/Plaid/InvalidInputError.html ADDED Viewed

@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>Plaid::InvalidInputError</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../../css/github.css" type="text/css" media="screen" />
+<script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+<script src="../../js/main.js" type="text/javascript" charset="utf-8"></script>
+<script src="../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
+    <meta property="og:title" value="Plaid::InvalidInputError">
+    <meta name="description" content="Returned when all fields are provided and are in the correct format, but the values provided are incorrect in some way.">
+    <meta property="og:description" content="Returned when all fields are provided and are in the correct format, but the values provided are incorrect in some way.">
+    <meta name="keywords" content="Plaid::InvalidInputError class">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::InvalidInputError
+                <span class="parent">&lt;
+                    <a href="PlaidAPIError.html">Plaid::PlaidAPIError</a>
+                </span>
+        </h1>
+        <ul class="files">
+            <li><a href="../../files/lib/plaid/errors_rb.html">lib/plaid/errors.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+<p>Returned when all fields are provided and are in the correct format, but
+the values provided are incorrect in some way.</p>
+    </div>
+    <!-- Methods -->
+</div>
+    </div>
+  </body>
+</html>

data/doc/rdoc/classes/Plaid/InvalidRequestError.html ADDED Viewed

@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>Plaid::InvalidRequestError</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../../css/github.css" type="text/css" media="screen" />
+<script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+<script src="../../js/main.js" type="text/javascript" charset="utf-8"></script>
+<script src="../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
+    <meta property="og:title" value="Plaid::InvalidRequestError">
+    <meta name="description" content="Returned when the request is malformed and cannot be processed.">
+    <meta property="og:description" content="Returned when the request is malformed and cannot be processed.">
+    <meta name="keywords" content="Plaid::InvalidRequestError class">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::InvalidRequestError
+                <span class="parent">&lt;
+                    <a href="PlaidAPIError.html">Plaid::PlaidAPIError</a>
+                </span>
+        </h1>
+        <ul class="files">
+            <li><a href="../../files/lib/plaid/errors_rb.html">lib/plaid/errors.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+<p>Returned when the request is malformed and cannot be processed.</p>
+    </div>
+    <!-- Methods -->
+</div>
+    </div>
+  </body>
+</html>

data/doc/rdoc/classes/Plaid/InvestmentTransactions/GetResponse.html ADDED Viewed

@@ -0,0 +1,145 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>Plaid::InvestmentTransactions::GetResponse</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <link rel="stylesheet" href="../../../css/reset.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../../../css/main.css" type="text/css" media="screen" />
+<link rel="stylesheet" href="../../../css/github.css" type="text/css" media="screen" />
+<script src="../../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+<script src="../../../js/main.js" type="text/javascript" charset="utf-8"></script>
+<script src="../../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
+    <meta property="og:title" value="Plaid::InvestmentTransactions::GetResponse">
+    <meta name="description" content="Response for /investments/transactions/get.">
+    <meta property="og:description" content="Response for /investments/transactions/get.">
+    <meta name="keywords" content="Plaid::InvestmentTransactions::GetResponse class">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::InvestmentTransactions::GetResponse
+                <span class="parent">&lt;
+                    <a href="../Models/BaseResponse.html">Plaid::Models::BaseResponse</a>
+                </span>
+        </h1>
+        <ul class="files">
+            <li><a href="../../../files/lib/plaid/products/investments_rb.html">lib/plaid/products/investments.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+<p>Response for /investments/transactions/get.</p>
+    </div>
+      <!-- Section attributes -->
+      <div class="sectiontitle">Attributes</div>
+      <table border='0' cellpadding='5'>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>accounts</td>
+            <td class='attr-desc'><p>The list of accounts: Array of <a
+href="../Models/Account.html">Plaid::Models::Account</a>.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>investment_transactions</td>
+            <td class='attr-desc'><p>The list of investment transactions: Array of <a
+href="../Models/InvestmentTransaction.html">Plaid::Models::InvestmentTransaction</a>.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>item</td>
+            <td class='attr-desc'><p>The item: <a href="../Models/Item.html">Plaid::Models::Item</a>.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>securities</td>
+            <td class='attr-desc'><p>The list of securities referenced by the investment transactions: Array of
+<a href="../Models/Security.html">Plaid::Models::Security</a>.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>total_investment_transactions</td>
+            <td class='attr-desc'><p>The Numeric total investment transactions count.</p></td>
+          </tr>
+      </table>
+    <!-- Methods -->
+</div>
+    </div>
+  </body>
+</html>