RubyGems - plaid - Versions diffs - 14.2.0 → 14.6.0 - Mend

plaid 14.2.0 → 14.6.0

Files changed (704) hide show

data/doc/rdoc/classes/Plaid/Item/RemoveResponse.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::RemoveResponse</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::RemoveResponse">
+    <meta name="description" content="Response for /item/remove.">
+    <meta property="og:description" content="Response for /item/remove.">
+    <meta name="keywords" content="Plaid::Item::RemoveResponse class">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::Item::RemoveResponse
+                <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/remove.</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'>removed</td>
+            <td class='attr-desc'><p>The Boolean flag meaning successful removal.</p></td>
+          </tr>
+      </table>
+    <!-- Methods -->
+</div>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,382 @@
+<?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</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">
+    <meta name="description" content="Class used to call the Item product.">
+    <meta property="og:description" content="Class used to call the Item product.">
+    <meta name="keywords" content="Plaid::Item class">
+    <meta name="keywords" content="get, remove, import">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::Item
+                <span class="parent">&lt;
+                    <a href="BaseProduct.html">Plaid::BaseProduct</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>Class used to call the <a href="Item.html">Item</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="Item/GetResponse.html">Plaid::Item::GetResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Item/ImportResponse.html">Plaid::Item::ImportResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Item/RemoveResponse.html">Plaid::Item::RemoveResponse</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>
+        <dt>I</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-import">import</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>R</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-remove">remove</a>
+              </li>
+          </ul>
+        </dd>
+    </dl>
+      <!-- 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 <a href="AccessToken.html">Plaid::AccessToken</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>public_token</td>
+            <td class='attr-desc'><p>The <a href="PublicToken.html">Plaid::PublicToken</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>webhook</td>
+            <td class='attr-desc'><p>The <a href="Webhook.html">Plaid::Webhook</a> product accessor.</p></td>
+          </tr>
+      </table>
+    <!-- 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)
+            <a href="../../classes/Plaid/Item.html#method-i-get" name="method-i-get" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Get information about an item.</p>
+<p>Does a POST /item/get call which returns information about an item or
+ItemStatus.</p>
+<dl class="rdoc-list note-list"><dt><a href="Item.html#attribute-i-access_token">#access_token</a>
+<dd>
+<p><a href="Item.html#attribute-i-access_token">#access_token</a> who&#39;s
+item to fetch status for</p>
+</dd></dl>
+<h3 id="method-i-get-label-Returns">Returns</h3>
+<p>Returns a <a href="Item/GetResponse.html">GetResponse</a> object with item
+information.</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/item.rb, line 144</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">post_with_auth</span> <span class="ruby-string">&#39;item/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-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-import">
+              <b>import</b>(products, user_auth, options)
+            <a href="../../classes/Plaid/Item.html#method-i-import" name="method-i-import" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Import an item.</p>
+<p>Does a POST /item/import call which imports an item.</p>
+<dl class="rdoc-list note-list"><dt>products
+<dd>
+<p>array of products to enable</p>
+</dd><dt>user_auth
+<dd>
+<p>hash map of user authentication information</p>
+</dd><dt>options
+<dd>
+<p>optional hash map of options</p>
+</dd></dl>
+<h3 id="method-i-import-label-Returns">Returns</h3>
+<p>Returns an access token for the item.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-import_source')" id="l_method-i-import_source">show</a>
+              </p>
+              <div id="method-i-import_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/item.rb, line 193</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">import</span>(<span class="ruby-identifier">products</span>, <span class="ruby-identifier">user_auth</span>, <span class="ruby-identifier">options</span>)
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;item/import&#39;</span>,
+                 <span class="ruby-constant">ImportResponse</span>,
+                 <span class="ruby-value">products:</span> <span class="ruby-identifier">products</span>,
+                 <span class="ruby-value">user_auth:</span> <span class="ruby-identifier">user_auth</span>,
+                 <span class="ruby-value">options:</span> <span class="ruby-identifier">options</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-remove">
+              <b>remove</b>(access_token)
+            <a href="../../classes/Plaid/Item.html#method-i-remove" name="method-i-remove" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Removes an item</p>
+<p>Does a POST /item/remove call which is used to remove an item</p>
+<dl class="rdoc-list note-list"><dt><a href="Item.html#attribute-i-access_token">#access_token</a>
+<dd>
+<p><a href="Item.html#attribute-i-access_token">#access_token</a> who&#39;s
+item to remove</p>
+</dd></dl>
+<h3 id="method-i-remove-label-Returns">Returns</h3>
+<p>Returns a <a href="Item/RemoveResponse.html">RemoveResponse</a> object with
+remove result.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-remove_source')" id="l_method-i-remove_source">show</a>
+              </p>
+              <div id="method-i-remove_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/item.rb, line 170</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">remove</span>(<span class="ruby-identifier">access_token</span>)
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;item/remove&#39;</span>,
+                 <span class="ruby-constant">RemoveResponse</span>,
+                 <span class="ruby-value">access_token:</span> <span class="ruby-identifier">access_token</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+</div>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,98 @@
+<?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::ItemError</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::ItemError">
+    <meta name="description" content="Indicates that information provided for the item (such as credentials or MFA) may be invalid or that the item is not supported on Plaid&#39;s platform.">
+    <meta property="og:description" content="Indicates that information provided for the item (such as credentials or MFA) may be invalid or that the item is not supported on Plaid&#39;s platform.">
+    <meta name="keywords" content="Plaid::ItemError class">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::ItemError
+                <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>Indicates that information provided for the item (such as credentials or
+MFA) may be invalid or that the item is not supported on Plaid&#39;s
+platform.</p>
+    </div>
+    <!-- Methods -->
+</div>
+    </div>
+  </body>
+</html>