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/InvestmentTransactions.html ADDED Viewed

@@ -0,0 +1,240 @@
+<?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</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">
+    <meta name="description" content="Class used to get InvestmentTransactions for the Investments product.">
+    <meta property="og:description" content="Class used to get InvestmentTransactions for the Investments product.">
+    <meta name="keywords" content="Plaid::InvestmentTransactions class">
+    <meta name="keywords" content="get">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::InvestmentTransactions
+                <span class="parent">&lt;
+                    <a href="BaseProduct.html">Plaid::BaseProduct</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>Class used to get <a
+href="InvestmentTransactions.html">InvestmentTransactions</a> for the <a
+href="Investments.html">Investments</a> product.</p>
+    </div>
+    <!-- Sections -->
+    <div class="sectiontitle">Sections</div>
+    <ul>
+        <li><a href="#Public">Public</a></li>
+    </ul>
+    <!-- Namespace -->
+    <div class="sectiontitle">Namespace</div>
+    <ul>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="InvestmentTransactions/GetResponse.html">Plaid::InvestmentTransactions::GetResponse</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>
+          </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>(access_token, start_date, end_date, account_ids: nil, count: nil, offset: nil, options: nil)
+            <a href="../../classes/Plaid/InvestmentTransactions.html#method-i-get" name="method-i-get" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Get information about all available investment transactions.</p>
+<p>Does a POST /investments/transactions/get call which gives you high level
+account data along with investment transactions and associated securities
+from all investment accounts contained in the access_token&#39;s item.</p>
+<dl class="rdoc-list note-list"><dt>access_token
+<dd>
+<p>access_token who&#39;s item to get investment transactions for.</p>
+</dd><dt>start_date
+<dd>
+<p>Start of query for investment transactions.</p>
+</dd><dt>end_date
+<dd>
+<p>End of query for investment transactions.</p>
+</dd><dt>account_ids
+<dd>
+<p>Specific account ids to fetch transactions for (optional).</p>
+</dd><dt>count
+<dd>
+<p>Amount of investment transactions to pull (optional).</p>
+</dd><dt>offset
+<dd>
+<p>Offset to start pulling investment transactions (optional).</p>
+</dd><dt>options
+<dd>
+<p>Additional options to merge into API request.</p>
+</dd></dl>
+<h3 id="method-i-get-label-Returns">Returns</h3>
+<p>Returns <a href="InvestmentTransactions/GetResponse.html">GetResponse</a>.</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/investments.rb, line 22</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get</span>(<span class="ruby-identifier">access_token</span>, <span class="ruby-identifier">start_date</span>, <span class="ruby-identifier">end_date</span>,
+        <span class="ruby-value">account_ids:</span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">count:</span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">offset:</span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">options:</span> <span class="ruby-keyword">nil</span>)
+  <span class="ruby-identifier">options_payload</span> = {}
+  <span class="ruby-identifier">options_payload</span>[<span class="ruby-value">:account_ids</span>] = <span class="ruby-identifier">account_ids</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">account_ids</span>.<span class="ruby-identifier">nil?</span>
+  <span class="ruby-identifier">options_payload</span>[<span class="ruby-value">:count</span>] = <span class="ruby-identifier">count</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">count</span>.<span class="ruby-identifier">nil?</span>
+  <span class="ruby-identifier">options_payload</span>[<span class="ruby-value">:offset</span>] = <span class="ruby-identifier">offset</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">offset</span>.<span class="ruby-identifier">nil?</span>
+  <span class="ruby-identifier">options_payload</span>.<span class="ruby-identifier">merge!</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;investments/transactions/get&#39;</span>,
+                 <span class="ruby-constant">GetResponse</span>,
+                 <span class="ruby-value">access_token:</span> <span class="ruby-identifier">access_token</span>,
+                 <span class="ruby-value">start_date:</span> <span class="ruby-constant">Plaid</span>.<span class="ruby-identifier">convert_to_date_string</span>(<span class="ruby-identifier">start_date</span>),
+                 <span class="ruby-value">end_date:</span> <span class="ruby-constant">Plaid</span>.<span class="ruby-identifier">convert_to_date_string</span>(<span class="ruby-identifier">end_date</span>),
+                 <span class="ruby-value">options:</span> <span class="ruby-identifier">options_payload</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+</div>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,204 @@
+<?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::Investments</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::Investments">
+    <meta name="description" content="Class used to call the Accounts product.">
+    <meta property="og:description" content="Class used to call the Accounts product.">
+    <meta name="keywords" content="Plaid::Investments class">
+    <meta name="keywords" content="transactions, holdings">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::Investments
+                <span class="parent">&lt;
+                    <a href="BaseProduct.html">Plaid::BaseProduct</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>Class used to call the <a href="Accounts.html">Accounts</a> product.</p>
+    </div>
+    <!-- Method ref -->
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+        <dt>H</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-holdings">holdings</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>T</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-transactions">transactions</a>
+              </li>
+          </ul>
+        </dd>
+    </dl>
+    <!-- Methods -->
+      <div class="sectiontitle">Instance Public methods</div>
+        <div class="method">
+          <div class="title method-title" id="method-i-holdings">
+              <b>holdings</b>
+            <a href="../../classes/Plaid/Investments.html#method-i-holdings" name="method-i-holdings" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>The <a href="Holdings.html">Plaid::Holdings</a> product accessor.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-holdings_source')" id="l_method-i-holdings_source">show</a>
+              </p>
+              <div id="method-i-holdings_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/investments.rb, line 125</span>
+<span class="ruby-identifier">subproduct</span> <span class="ruby-value">:holdings</span>
+</pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-transactions">
+              <b>transactions</b>
+            <a href="../../classes/Plaid/Investments.html#method-i-transactions" name="method-i-transactions" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>The <a href="InvestmentTransactions.html">Plaid::InvestmentTransactions</a>
+product accessor.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-transactions_source')" id="l_method-i-transactions_source">show</a>
+              </p>
+              <div id="method-i-transactions_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/investments.rb, line 121</span>
+<span class="ruby-identifier">subproduct</span> <span class="ruby-value">:transactions</span>, <span class="ruby-constant">Plaid</span><span class="ruby-operator">::</span><span class="ruby-constant">InvestmentTransactions</span>
+</pre>
+              </div>
+            </div>
+          </div>
+</div>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,119 @@
+<?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::Item::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::Item::GetResponse">
+    <meta name="description" content="Response for /item/get.">
+    <meta property="og:description" content="Response for /item/get.">
+    <meta name="keywords" content="Plaid::Item::GetResponse class">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::Item::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/item_rb.html">lib/plaid/products/item.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+<p>Response for /item/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'>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'>status</td>
+            <td class='attr-desc'><p>The item status: <a
+href="../Models/ItemStatus.html">Plaid::Models::ItemStatus</a>.</p></td>
+          </tr>
+      </table>
+    <!-- Methods -->
+</div>
+    </div>
+  </body>
+</html>

data/doc/rdoc/classes/Plaid/Item/ImportResponse.html ADDED Viewed

@@ -0,0 +1,110 @@
+<?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::Item::ImportResponse</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::Item::ImportResponse">
+    <meta name="description" content="Response for /item/import.">
+    <meta property="og:description" content="Response for /item/import.">
+    <meta name="keywords" content="Plaid::Item::ImportResponse class">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::Item::ImportResponse
+                <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/item_rb.html">lib/plaid/products/item.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+<p>Response for /item/import.</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'>access_token</td>
+            <td class='attr-desc'><p>The access token string</p></td>
+          </tr>
+      </table>
+    <!-- Methods -->
+</div>
+    </div>
+  </body>
+</html>