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

@@ -0,0 +1,772 @@
+<?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</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">
+    <meta name="description" content="The namespace for all the things Plaid.  The Plaid namespace.">
+    <meta property="og:description" content="The namespace for all the things Plaid.  The Plaid namespace.">
+    <meta name="keywords" content="Plaid class">
+    <meta name="keywords" content="relaxed_models?, relaxed_models=, convert_to_date_string">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Module</span>
+            Plaid
+        </h1>
+        <ul class="files">
+            <li><a href="../files/lib/plaid_rb.html">lib/plaid.rb</a></li>
+            <li><a href="../files/lib/plaid/client_rb.html">lib/plaid/client.rb</a></li>
+            <li><a href="../files/lib/plaid/errors_rb.html">lib/plaid/errors.rb</a></li>
+            <li><a href="../files/lib/plaid/middleware_rb.html">lib/plaid/middleware.rb</a></li>
+            <li><a href="../files/lib/plaid/models_rb.html">lib/plaid/models.rb</a></li>
+            <li><a href="../files/lib/plaid/products/accounts_rb.html">lib/plaid/products/accounts.rb</a></li>
+            <li><a href="../files/lib/plaid/products/asset_report_rb.html">lib/plaid/products/asset_report.rb</a></li>
+            <li><a href="../files/lib/plaid/products/auth_rb.html">lib/plaid/products/auth.rb</a></li>
+            <li><a href="../files/lib/plaid/products/base_product_rb.html">lib/plaid/products/base_product.rb</a></li>
+            <li><a href="../files/lib/plaid/products/categories_rb.html">lib/plaid/products/categories.rb</a></li>
+            <li><a href="../files/lib/plaid/products/credit_details_rb.html">lib/plaid/products/credit_details.rb</a></li>
+            <li><a href="../files/lib/plaid/products/deposit_switch_rb.html">lib/plaid/products/deposit_switch.rb</a></li>
+            <li><a href="../files/lib/plaid/products/identity_rb.html">lib/plaid/products/identity.rb</a></li>
+            <li><a href="../files/lib/plaid/products/income_rb.html">lib/plaid/products/income.rb</a></li>
+            <li><a href="../files/lib/plaid/products/institutions_rb.html">lib/plaid/products/institutions.rb</a></li>
+            <li><a href="../files/lib/plaid/products/investments_rb.html">lib/plaid/products/investments.rb</a></li>
+            <li><a href="../files/lib/plaid/products/item_rb.html">lib/plaid/products/item.rb</a></li>
+            <li><a href="../files/lib/plaid/products/liabilities_rb.html">lib/plaid/products/liabilities.rb</a></li>
+            <li><a href="../files/lib/plaid/products/link_token_rb.html">lib/plaid/products/link_token.rb</a></li>
+            <li><a href="../files/lib/plaid/products/payment_initiation_rb.html">lib/plaid/products/payment_initiation.rb</a></li>
+            <li><a href="../files/lib/plaid/products/processor_rb.html">lib/plaid/products/processor.rb</a></li>
+            <li><a href="../files/lib/plaid/products/sandbox_rb.html">lib/plaid/products/sandbox.rb</a></li>
+            <li><a href="../files/lib/plaid/products/transactions_rb.html">lib/plaid/products/transactions.rb</a></li>
+            <li><a href="../files/lib/plaid/products/webhooks_rb.html">lib/plaid/products/webhooks.rb</a></li>
+            <li><a href="../files/lib/plaid/version_rb.html">lib/plaid/version.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+<p>The namespace for all the things <a href="Plaid.html">Plaid</a>.</p>
+<p>The <a href="Plaid.html">Plaid</a> namespace.</p>
+    </div>
+    <!-- Sections -->
+    <div class="sectiontitle">Sections</div>
+    <ul>
+        <li><a href="#Internal">Internal</a></li>
+        <li><a href="#Public">Public</a></li>
+    </ul>
+    <!-- Namespace -->
+    <div class="sectiontitle">Namespace</div>
+    <ul>
+        <li>
+          <span class="type">MODULE</span>
+          <a href="Plaid/Error.html">Plaid::Error</a>
+        </li>
+        <li>
+          <span class="type">MODULE</span>
+          <a href="Plaid/Models.html">Plaid::Models</a>
+        </li>
+        <li>
+          <span class="type">MODULE</span>
+          <a href="Plaid/SubproductMixin.html">Plaid::SubproductMixin</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/APIError.html">Plaid::APIError</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AccessToken.html">Plaid::AccessToken</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Accounts.html">Plaid::Accounts</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AccountsResponse.html">Plaid::AccountsResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Apex.html">Plaid::Apex</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AssetReport.html">Plaid::AssetReport</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AssetReportCreateResponse.html">Plaid::AssetReportCreateResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AssetReportFilterResponse.html">Plaid::AssetReportFilterResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AssetReportGetResponse.html">Plaid::AssetReportGetResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AssetReportRefreshResponse.html">Plaid::AssetReportRefreshResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AssetReportRemoveResponse.html">Plaid::AssetReportRemoveResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AuditCopyCreateResponse.html">Plaid::AuditCopyCreateResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AuditCopyGetResponse.html">Plaid::AuditCopyGetResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AuditCopyRemoveResponse.html">Plaid::AuditCopyRemoveResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Auth.html">Plaid::Auth</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/AuthResponse.html">Plaid::AuthResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Balance.html">Plaid::Balance</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/BaseProduct.html">Plaid::BaseProduct</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Categories.html">Plaid::Categories</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/CategoriesResponse.html">Plaid::CategoriesResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Client.html">Plaid::Client</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/CreateResponse.html">Plaid::CreateResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/CreditDetails.html">Plaid::CreditDetails</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/CreditDetailsResponse.html">Plaid::CreditDetailsResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/DepositSwitch.html">Plaid::DepositSwitch</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Dwolla.html">Plaid::Dwolla</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/GetResponse.html">Plaid::GetResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Holdings.html">Plaid::Holdings</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Identity.html">Plaid::Identity</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/IdentityResponse.html">Plaid::IdentityResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Income.html">Plaid::Income</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/IncomeResponse.html">Plaid::IncomeResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/InstitutionError.html">Plaid::InstitutionError</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Institutions.html">Plaid::Institutions</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/InvalidInputError.html">Plaid::InvalidInputError</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/InvalidRequestError.html">Plaid::InvalidRequestError</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/InvestmentTransactions.html">Plaid::InvestmentTransactions</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Investments.html">Plaid::Investments</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Item.html">Plaid::Item</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/ItemError.html">Plaid::ItemError</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Liabilities.html">Plaid::Liabilities</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/LiabilitiesResponse.html">Plaid::LiabilitiesResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/LinkToken.html">Plaid::LinkToken</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Middleware.html">Plaid::Middleware</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/MultipleInstitutionsResponse.html">Plaid::MultipleInstitutionsResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Ocrolus.html">Plaid::Ocrolus</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PaymentCreateResponse.html">Plaid::PaymentCreateResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PaymentGetResponse.html">Plaid::PaymentGetResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PaymentInitiation.html">Plaid::PaymentInitiation</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PaymentListResponse.html">Plaid::PaymentListResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PaymentRecipientCreateResponse.html">Plaid::PaymentRecipientCreateResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PaymentRecipientGetResponse.html">Plaid::PaymentRecipientGetResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PaymentRecipientListResponse.html">Plaid::PaymentRecipientListResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PaymentTokenCreateResponse.html">Plaid::PaymentTokenCreateResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PlaidAPIError.html">Plaid::PlaidAPIError</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PlaidError.html">Plaid::PlaidError</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PlaidServerError.html">Plaid::PlaidServerError</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Processor.html">Plaid::Processor</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/ProcessorToken.html">Plaid::ProcessorToken</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/ProcessorTokenResponse.html">Plaid::ProcessorTokenResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/PublicToken.html">Plaid::PublicToken</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/RateLimitExceededError.html">Plaid::RateLimitExceededError</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Sandbox.html">Plaid::Sandbox</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/SandboxItem.html">Plaid::SandboxItem</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/SandboxPublicToken.html">Plaid::SandboxPublicToken</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/SingleInstitutionResponse.html">Plaid::SingleInstitutionResponse</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Stripe.html">Plaid::Stripe</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Transactions.html">Plaid::Transactions</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Webhook.html">Plaid::Webhook</a>
+        </li>
+        <li>
+          <span class="type">CLASS</span>
+          <a href="Plaid/Webhooks.html">Plaid::Webhooks</a>
+        </li>
+    </ul>
+    <!-- Method ref -->
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+        <dt>C</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-c-convert_to_date_string">convert_to_date_string</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>R</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-c-relaxed_models-3D">relaxed_models=</a>,
+              </li>
+              <li>
+                <a href="#method-c-relaxed_models-3F">relaxed_models?</a>
+              </li>
+          </ul>
+        </dd>
+    </dl>
+      <!-- Section constants -->
+      <div class="sectiontitle">Constants</div>
+      <table border='0' cellpadding='5'>
+          <tr valign='top'>
+            <td class="attr-name">VERSION</td>
+            <td>=</td>
+            <td class="attr-value">&#39;13.2.0&#39;.freeze</td>
+          </tr>
+            <tr valign='top'>
+              <td>&nbsp;</td>
+              <td colspan="2" class="attr-desc"></td>
+            </tr>
+          <tr valign='top'>
+            <td class="attr-name">API_VERSION</td>
+            <td>=</td>
+            <td class="attr-value">&#39;2020-09-14&#39;.freeze</td>
+          </tr>
+            <tr valign='top'>
+              <td>&nbsp;</td>
+              <td colspan="2" class="attr-desc"></td>
+            </tr>
+      </table>
+    <!-- Methods -->
+      <div class="sectiontitle">Class Public methods</div>
+        <div class="method">
+          <div class="title method-title" id="method-c-relaxed_models-3D">
+              <b>relaxed_models=</b>(value)
+            <a href="../classes/Plaid.html#method-c-relaxed_models-3D" name="method-c-relaxed_models-3D" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Sets value for relaxed_models.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-c-relaxed_models-3D_source')" id="l_method-c-relaxed_models-3D_source">show</a>
+              </p>
+              <div id="method-c-relaxed_models-3D_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid.rb, line 51</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">relaxed_models=</span>(<span class="ruby-identifier">value</span>)
+  <span class="ruby-ivar">@relaxed_models</span> = <span class="ruby-identifier">value</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-c-relaxed_models-3F">
+              <b>relaxed_models?</b>()
+            <a href="../classes/Plaid.html#method-c-relaxed_models-3F" name="method-c-relaxed_models-3F" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Get relaxed models state.</p>
+<p>We support two modes for parsing response bodies.</p>
+<p>Strict mode: Unknown attributes will cause NoMethodError.</p>
+<p>Relaxed mode (default): If a response contains an unknown attribute, it
+won&#39;t cause any error and will be accessible using brackets notation:
+`<a href="'unknown_attribute'">response</a>`.</p>
+<h3 id="method-c-relaxed_models-3F-label-Returns">Returns</h3>
+<p>Returns truey value for relaxed mode and falsey for strict.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-c-relaxed_models-3F_source')" id="l_method-c-relaxed_models-3F_source">show</a>
+              </p>
+              <div id="method-c-relaxed_models-3F_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid.rb, line 42</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">relaxed_models?</span>
+  <span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@relaxed_models</span>)
+    <span class="ruby-ivar">@relaxed_models</span>
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-keyword">true</span>
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+      <div class="contenttitle" id="Public">
+        Public
+      </div>
+    <!-- Methods -->
+      <div class="contenttitle" id="Internal">
+        Internal
+      </div>
+    <!-- Methods -->
+      <div class="sectiontitle">Class Public methods</div>
+        <div class="method">
+          <div class="title method-title" id="method-c-convert_to_date_string">
+              <b>convert_to_date_string</b>(date)
+            <a href="../classes/Plaid.html#method-c-convert_to_date_string" name="method-c-convert_to_date_string" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Converts date objects to strings if needed.</p>
+<p>Takes in a string or a Date object and performs necessary operations to
+return a string representation of the Date.</p>
+<dl class="rdoc-list note-list"><dt>date
+<dd>
+<p>Date in Date object form or string form (YYYY-MM-DD).</p>
+</dd></dl>
+<h3 id="method-c-convert_to_date_string-label-Returns">Returns</h3>
+<p>Returns a String with an ISO-8601 date.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-c-convert_to_date_string_source')" id="l_method-c-convert_to_date_string_source">show</a>
+              </p>
+              <div id="method-c-convert_to_date_string_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid.rb, line 65</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">convert_to_date_string</span>(<span class="ruby-identifier">date</span>)
+  <span class="ruby-identifier">date</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">date</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">to_date</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-string">&#39;%Y-%m-%d&#39;</span>)
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+</div>
+    </div>
+  </body>
+</html>