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

@@ -0,0 +1,802 @@
+<?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::Client</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::Client">
+    <meta name="description" content="The main interface to Plaid API.">
+    <meta property="og:description" content="The main interface to Plaid API.">
+    <meta name="keywords" content="Plaid::Client class">
+    <meta name="keywords" content="new, link_token, post, post_with_auth, build_default_connection, client, api_host, create_connection">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::Client
+                <span class="parent">&lt;
+                    <a href="../Object.html">Object</a>
+                </span>
+        </h1>
+        <ul class="files">
+            <li><a href="../../files/lib/plaid/client_rb.html">lib/plaid/client.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+<p>The main interface to <a href="../Plaid.html">Plaid</a> API.</p>
+    </div>
+    <!-- Sections -->
+    <div class="sectiontitle">Sections</div>
+    <ul>
+        <li><a href="#Internal">Internal</a></li>
+        <li><a href="#Public">Public</a></li>
+    </ul>
+    <!-- Method ref -->
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+        <dt>A</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-api_host">api_host</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>B</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-c-build_default_connection">build_default_connection</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>C</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-client">client</a>,
+              </li>
+              <li>
+                <a href="#method-i-create_connection">create_connection</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>L</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-link_token">link_token</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>N</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-c-new">new</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>P</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-post">post</a>,
+              </li>
+              <li>
+                <a href="#method-i-post_with_auth">post_with_auth</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'>accounts</td>
+            <td class='attr-desc'><p>The <a href="Accounts.html">Plaid::Accounts</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>asset_report</td>
+            <td class='attr-desc'><p>The <a href="AssetReport.html">Plaid::AssetReport</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>auth</td>
+            <td class='attr-desc'><p>The <a href="Auth.html">Plaid::Auth</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>categories</td>
+            <td class='attr-desc'><p>The <a href="Categories.html">Plaid::Categories</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>credit_details</td>
+            <td class='attr-desc'><p>The <a href="CreditDetails.html">Plaid::CreditDetails</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>deposit_switch</td>
+            <td class='attr-desc'><p>The <a href="DepositSwitch.html">Plaid::DepositSwitch</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>identity</td>
+            <td class='attr-desc'><p>The <a href="Identity.html">Plaid::Identity</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>income</td>
+            <td class='attr-desc'><p>The <a href="Income.html">Plaid::Income</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>institutions</td>
+            <td class='attr-desc'><p>The <a href="Institutions.html">Plaid::Institutions</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>investments</td>
+            <td class='attr-desc'><p>The <a href="Investments.html">Plaid::Investments</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>item</td>
+            <td class='attr-desc'><p>The <a href="Item.html">Plaid::Item</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>liabilities</td>
+            <td class='attr-desc'><p>The <a href="Liabilities.html">Plaid::Liabilities</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>payment_initiation</td>
+            <td class='attr-desc'><p>The <a href="PaymentInitiation.html">Plaid::PaymentInitiation</a> product
+accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>processor</td>
+            <td class='attr-desc'><p>The <a href="Processor.html">Plaid::Processor</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>sandbox</td>
+            <td class='attr-desc'><p>The <a href="Sandbox.html">Plaid::Sandbox</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>transactions</td>
+            <td class='attr-desc'><p>The <a href="Transactions.html">Plaid::Transactions</a> product accessor.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>webhooks</td>
+            <td class='attr-desc'><p>The <a href="Webhooks.html">Plaid::Webhooks</a> endpoint accessor.</p></td>
+          </tr>
+      </table>
+    <!-- Methods -->
+      <div class="sectiontitle">Instance Public methods</div>
+        <div class="method">
+          <div class="title method-title" id="method-i-link_token">
+              <b>link_token</b>
+            <a href="../../classes/Plaid/Client.html#method-i-link_token" name="method-i-link_token" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>:attr_reader: Public: The <a href="LinkToken.html">Plaid::LinkToken</a>
+endpoint accessor.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-link_token_source')" id="l_method-i-link_token_source">show</a>
+              </p>
+              <div id="method-i-link_token_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 121</span>
+<span class="ruby-identifier">subproduct</span> <span class="ruby-value">:link_token</span>
+</pre>
+              </div>
+            </div>
+          </div>
+      <div class="contenttitle" id="Public">
+        Public
+      </div>
+      <!-- Section constants -->
+      <div class="sectiontitle">Constants</div>
+      <table border='0' cellpadding='5'>
+          <tr valign='top'>
+            <td class="attr-name">ENVIRONMENTS</td>
+            <td>=</td>
+            <td class="attr-value">%i[sandbox development production].freeze</td>
+          </tr>
+            <tr valign='top'>
+              <td>&nbsp;</td>
+              <td colspan="2" class="attr-desc"><p>All possible environments for the client to use.</p></td>
+            </tr>
+      </table>
+      <!-- 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'>client_id</td>
+            <td class='attr-desc'><p>The client ID.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>env</td>
+            <td class='attr-desc'><p>The current environment in use (one of <a
+href="Client.html#ENVIRONMENTS">ENVIRONMENTS</a>).</p></td>
+          </tr>
+      </table>
+    <!-- Methods -->
+      <div class="sectiontitle">Class Public methods</div>
+        <div class="method">
+          <div class="title method-title" id="method-c-build_default_connection">
+              <b>build_default_connection</b>(builder)
+            <a href="../../classes/Plaid/Client.html#method-c-build_default_connection" name="method-c-build_default_connection" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Set <a href="../Plaid.html">Plaid</a> defaults on the Faraday connection.</p>
+<dl class="rdoc-list note-list"><dt>builder
+<dd>
+<p>The Faraday builder object.</p>
+</dd></dl>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-c-build_default_connection_source')" id="l_method-c-build_default_connection_source">show</a>
+              </p>
+              <div id="method-c-build_default_connection_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 149</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">build_default_connection</span>(<span class="ruby-identifier">builder</span>)
+  <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">options</span>[<span class="ruby-value">:timeout</span>] = <span class="ruby-constant">Plaid</span><span class="ruby-operator">::</span><span class="ruby-constant">Middleware</span><span class="ruby-operator">::</span><span class="ruby-constant">NETWORK_TIMEOUT</span>
+  <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">headers</span> = <span class="ruby-constant">Plaid</span><span class="ruby-operator">::</span><span class="ruby-constant">Middleware</span><span class="ruby-operator">::</span><span class="ruby-constant">NETWORK_HEADERS</span>
+  <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">request</span> <span class="ruby-value">:json</span>
+  <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">use</span> <span class="ruby-constant">Plaid</span><span class="ruby-operator">::</span><span class="ruby-constant">Middleware</span>
+  <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">response</span> <span class="ruby-value">:json</span>, <span class="ruby-value">content_type:</span> <span class="ruby-regexp">/\bjson$/</span>
+  <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">adapter</span> <span class="ruby-constant">Faraday</span>.<span class="ruby-identifier">default_adapter</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-c-new">
+              <b>new</b>(env:, client_id:, secret:, &amp;block)
+            <a href="../../classes/Plaid/Client.html#method-c-new" name="method-c-new" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Construct a <a href="Client.html">Client</a> instance</p>
+<p>Optionally takes a block to allow overriding the default Faraday connection
+options.</p>
+<dl class="rdoc-list note-list"><dt>env
+<dd>
+<p>The Symbol (:sandbox, :development, :production)</p>
+</dd><dt><a href="Client.html#attribute-i-client_id">#client_id</a>
+<dd>
+<p>The String <a href="../Plaid.html">Plaid</a> account client ID to
+authenticate requests</p>
+</dd><dt>secret
+<dd>
+<p>The String <a href="../Plaid.html">Plaid</a> account secret to authenticate
+requests</p>
+</dd></dl>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-c-new_source')" id="l_method-c-new_source">show</a>
+              </p>
+              <div id="method-c-new_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 22</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-value">env:</span>, <span class="ruby-value">client_id:</span>, <span class="ruby-value">secret:</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+  <span class="ruby-ivar">@env</span>        = <span class="ruby-identifier">env</span>.<span class="ruby-identifier">to_sym</span>
+  <span class="ruby-ivar">@api_host</span>   = <span class="ruby-identifier">api_host</span>
+  <span class="ruby-ivar">@client_id</span>  = <span class="ruby-identifier">client_id</span>
+  <span class="ruby-ivar">@secret</span>     = <span class="ruby-identifier">secret</span>
+  <span class="ruby-identifier">create_connection</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+      <div class="sectiontitle">Instance Public methods</div>
+        <div class="method">
+          <div class="title method-title" id="method-i-post">
+              <b>post</b>(path, payload)
+            <a href="../../classes/Plaid/Client.html#method-i-post" name="method-i-post" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Make a post request</p>
+<dl class="rdoc-list note-list"><dt>path
+<dd>
+<p>Path or URL to make the request to</p>
+</dd><dt>payload
+<dd>
+<p>The payload or data to post</p>
+</dd></dl>
+<h3 id="method-i-post-label-Returns">Returns</h3>
+<p>Returns the resulting parsed JSON of the request</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-post_source')" id="l_method-i-post_source">show</a>
+              </p>
+              <div id="method-i-post_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 129</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">payload</span>)
+  <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">payload</span>).<span class="ruby-identifier">body</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-post_with_auth">
+              <b>post_with_auth</b>(path, payload)
+            <a href="../../classes/Plaid/Client.html#method-i-post_with_auth" name="method-i-post_with_auth" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Make a post request with appended authentication fields</p>
+<dl class="rdoc-list note-list"><dt>path
+<dd>
+<p>Path or URL to make the request to</p>
+</dd><dt>payload
+<dd>
+<p>The payload or data to post</p>
+</dd></dl>
+<h3 id="method-i-post_with_auth-label-Returns">Returns</h3>
+<p>Returns the resulting parsed JSON of the request</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-post_with_auth_source')" id="l_method-i-post_with_auth_source">show</a>
+              </p>
+              <div id="method-i-post_with_auth_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 139</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post_with_auth</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">payload</span>)
+  <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">post</span>(
+    <span class="ruby-identifier">path</span>,
+    <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">client_id:</span> <span class="ruby-ivar">@client_id</span>, <span class="ruby-value">secret:</span> <span class="ruby-ivar">@secret</span>)
+  ).<span class="ruby-identifier">body</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+      <div class="contenttitle" id="Internal">
+        Internal
+      </div>
+    <!-- Methods -->
+      <div class="sectiontitle">Instance Protected methods</div>
+        <div class="method">
+          <div class="title method-title" id="method-i-api_host">
+              <b>api_host</b>()
+            <a href="../../classes/Plaid/Client.html#method-i-api_host" name="method-i-api_host" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Gets the API hostname for given environment.</p>
+<dl class="rdoc-list note-list"><dt>env
+<dd>
+<p>The Symbol (:sandbox, :development, :production)</p>
+</dd></dl>
+<h3 id="method-i-api_host-label-Returns">Returns</h3>
+<p>Returns a String representing the environment URL. Raises ArgumentError if
+environment is unknown.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-api_host_source')" id="l_method-i-api_host_source">show</a>
+              </p>
+              <div id="method-i-api_host_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 171</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">api_host</span>
+  <span class="ruby-keyword">unless</span> <span class="ruby-constant">ENVIRONMENTS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@env</span>)
+    <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>,
+          <span class="ruby-node">&quot;Invalid value for env (#{@env.inspect}): must be one of &quot;</span> <span class="ruby-operator">+</span>
+          <span class="ruby-constant">ENVIRONMENTS</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:inspect</span>) <span class="ruby-operator">*</span> <span class="ruby-string">&#39;, &#39;</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-node">&quot;https://#{@env}.plaid.com&quot;</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-client">
+              <b>client</b>()
+            <a href="../../classes/Plaid/Client.html#method-i-client" name="method-i-client" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>subproduct-generated methods depend on client method.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-client_source')" id="l_method-i-client_source">show</a>
+              </p>
+              <div id="method-i-client_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 161</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">client</span>
+  <span class="ruby-keyword">self</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-create_connection">
+              <b>create_connection</b>()
+            <a href="../../classes/Plaid/Client.html#method-i-create_connection" name="method-i-create_connection" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Initializes a new <a href="../Plaid.html">Plaid</a> connection object via
+Faraday.</p>
+<p>Optionally takes a block to allow overriding the defaults.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-create_connection_source')" id="l_method-i-create_connection_source">show</a>
+              </p>
+              <div id="method-i-create_connection_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 184</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_connection</span>
+  <span class="ruby-ivar">@connection</span> = <span class="ruby-constant">Faraday</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">url:</span> <span class="ruby-ivar">@api_host</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">builder</span><span class="ruby-operator">|</span>
+    <span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">builder</span>) <span class="ruby-operator">:</span> <span class="ruby-constant">Client</span>.<span class="ruby-identifier">build_default_connection</span>(<span class="ruby-identifier">builder</span>)
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+</div>
+    </div>
+  </body>
+</html>