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

@@ -0,0 +1,570 @@
+<?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::PaymentInitiation</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::PaymentInitiation">
+    <meta name="description" content="Class used to call the Payment product.">
+    <meta property="og:description" content="Class used to call the Payment product.">
+    <meta name="keywords" content="Plaid::PaymentInitiation class">
+    <meta name="keywords" content="create_recipient, get_recipient, list_recipients, create_payment, create_payment_token, get_payment, list_payments">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::PaymentInitiation
+                <span class="parent">&lt;
+                    <a href="BaseProduct.html">Plaid::BaseProduct</a>
+                </span>
+        </h1>
+        <ul class="files">
+            <li><a href="../../files/lib/plaid/products/payment_initiation_rb.html">lib/plaid/products/payment_initiation.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+<p>Class used to call the Payment 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>C</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-create_payment">create_payment</a>,
+              </li>
+              <li>
+                <a href="#method-i-create_payment_token">create_payment_token</a>,
+              </li>
+              <li>
+                <a href="#method-i-create_recipient">create_recipient</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>G</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-get_payment">get_payment</a>,
+              </li>
+              <li>
+                <a href="#method-i-get_recipient">get_recipient</a>
+              </li>
+          </ul>
+        </dd>
+        <dt>L</dt>
+        <dd>
+          <ul>
+              <li>
+                <a href="#method-i-list_payments">list_payments</a>,
+              </li>
+              <li>
+                <a href="#method-i-list_recipients">list_recipients</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-create_payment">
+              <b>create_payment</b>( recipient_id, reference, amount, schedule: nil, options: nil )
+            <a href="../../classes/Plaid/PaymentInitiation.html#method-i-create_payment" name="method-i-create_payment" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Create a payment.</p>
+<dl class="rdoc-list note-list"><dt>recipient_id
+<dd>
+<p>Recipient ID that the payment will be initiated for.</p>
+</dd><dt>reference
+<dd>
+<p>Payment reference.</p>
+</dd><dt>amount
+<dd>
+<p>Payment amount.</p>
+</dd><dt>schedule
+<dd>
+<p>Payment schedule.</p>
+</dd><dt>options
+<dd>
+<p>Payment options.</p>
+</dd></dl>
+<h3 id="method-i-create_payment-label-Returns">Returns</h3>
+<p>Returns a <a href="PaymentCreateResponse.html">PaymentCreateResponse</a>
+object.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-create_payment_source')" id="l_method-i-create_payment_source">show</a>
+              </p>
+              <div id="method-i-create_payment_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/payment_initiation.rb, line 52</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_payment</span>(
+  <span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">reference</span>, <span class="ruby-identifier">amount</span>, <span class="ruby-value">schedule:</span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">options:</span> <span class="ruby-keyword">nil</span>
+)
+  <span class="ruby-identifier">create_payment</span> = {
+    <span class="ruby-value">&#39;recipient_id&#39;:</span> <span class="ruby-identifier">recipient_id</span>,
+    <span class="ruby-value">&#39;reference&#39;:</span> <span class="ruby-identifier">reference</span>,
+    <span class="ruby-value">&#39;amount&#39;:</span> <span class="ruby-identifier">amount</span>
+  }
+  <span class="ruby-identifier">create_payment</span>[<span class="ruby-string">&#39;schedule&#39;</span>] = <span class="ruby-identifier">schedule</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">schedule</span>.<span class="ruby-identifier">nil?</span>
+  <span class="ruby-identifier">create_payment</span>[<span class="ruby-string">&#39;options&#39;</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;payment_initiation/payment/create&#39;</span>,
+                 <span class="ruby-constant">PaymentCreateResponse</span>,
+                 <span class="ruby-identifier">create_payment</span>)
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-create_payment_token">
+              <b>create_payment_token</b>(payment_id)
+            <a href="../../classes/Plaid/PaymentInitiation.html#method-i-create_payment_token" name="method-i-create_payment_token" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Create a payment token.</p>
+<dl class="rdoc-list note-list"><dt>payment_id
+<dd>
+<p>Payment ID that the token will be created for.</p>
+</dd></dl>
+<h3 id="method-i-create_payment_token-label-Returns">Returns</h3>
+<p>Returns a <a
+href="PaymentTokenCreateResponse.html">PaymentTokenCreateResponse</a>
+object.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-create_payment_token_source')" id="l_method-i-create_payment_token_source">show</a>
+              </p>
+              <div id="method-i-create_payment_token_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/payment_initiation.rb, line 74</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_payment_token</span>(<span class="ruby-identifier">payment_id</span>)
+  <span class="ruby-identifier">puts</span> <span class="ruby-string">&#39;Warning: this method will be deprecated in a future version. &#39;</span>\
+       <span class="ruby-string">&#39;To replace the payment_token, look into the link_token at &#39;</span>\
+       <span class="ruby-string">&#39;https://plaid.com/docs/api/tokens/#linktokencreate.&#39;</span>
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;payment_initiation/payment/token/create&#39;</span>,
+                 <span class="ruby-constant">PaymentTokenCreateResponse</span>,
+                 <span class="ruby-value">payment_id:</span> <span class="ruby-identifier">payment_id</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-create_recipient">
+              <b>create_recipient</b>(name, iban, address, bacs)
+            <a href="../../classes/Plaid/PaymentInitiation.html#method-i-create_recipient" name="method-i-create_recipient" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Create a recipient.</p>
+<dl class="rdoc-list note-list"><dt>name
+<dd>
+<p>Recipient name.</p>
+</dd><dt>iban
+<dd>
+<p>Recipient IBAN. Should be nil if using bacs.</p>
+</dd><dt>address
+<dd>
+<p>Recipient address (hash with “street”, “city”, “postal_code” and
+“country”). Best practice is to set it as nil.</p>
+</dd><dt>bacs
+<dd>
+<p>Recipient BACS (hash with “account” and “sort_code” keys). Should be nil if
+using iban.</p>
+</dd></dl>
+<h3 id="method-i-create_recipient-label-Returns">Returns</h3>
+<p>Returns a <a
+href="PaymentRecipientCreateResponse.html">PaymentRecipientCreateResponse</a>
+object.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-create_recipient_source')" id="l_method-i-create_recipient_source">show</a>
+              </p>
+              <div id="method-i-create_recipient_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/payment_initiation.rb, line 14</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_recipient</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">iban</span>, <span class="ruby-identifier">address</span>, <span class="ruby-identifier">bacs</span>)
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;payment_initiation/recipient/create&#39;</span>,
+                 <span class="ruby-constant">PaymentRecipientCreateResponse</span>,
+                 <span class="ruby-value">name:</span> <span class="ruby-identifier">name</span>,
+                 <span class="ruby-value">iban:</span> <span class="ruby-identifier">iban</span>,
+                 <span class="ruby-value">bacs:</span> <span class="ruby-identifier">bacs</span>,
+                 <span class="ruby-value">address:</span> <span class="ruby-identifier">address</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-get_payment">
+              <b>get_payment</b>(payment_id)
+            <a href="../../classes/Plaid/PaymentInitiation.html#method-i-get_payment" name="method-i-get_payment" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Retrieve a payment.</p>
+<dl class="rdoc-list note-list"><dt>payment_id
+<dd>
+<p>The payment ID from the `create_payment` response.</p>
+</dd></dl>
+<h3 id="method-i-get_payment-label-Returns">Returns</h3>
+<p>Returns a <a href="PaymentGetResponse.html">PaymentGetResponse</a> object.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-get_payment_source')" id="l_method-i-get_payment_source">show</a>
+              </p>
+              <div id="method-i-get_payment_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/payment_initiation.rb, line 89</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_payment</span>(<span class="ruby-identifier">payment_id</span>)
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;payment_initiation/payment/get&#39;</span>,
+                 <span class="ruby-constant">PaymentGetResponse</span>,
+                 <span class="ruby-value">payment_id:</span> <span class="ruby-identifier">payment_id</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-get_recipient">
+              <b>get_recipient</b>(recipient_id)
+            <a href="../../classes/Plaid/PaymentInitiation.html#method-i-get_recipient" name="method-i-get_recipient" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>Retrieve a recipient.</p>
+<dl class="rdoc-list note-list"><dt>recipient_id
+<dd>
+<p>The recipient ID from the `create_recipient` response.</p>
+</dd></dl>
+<h3 id="method-i-get_recipient-label-Returns">Returns</h3>
+<p>Returns a <a
+href="PaymentRecipientGetResponse.html">PaymentRecipientGetResponse</a>
+object.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-get_recipient_source')" id="l_method-i-get_recipient_source">show</a>
+              </p>
+              <div id="method-i-get_recipient_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/payment_initiation.rb, line 28</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_recipient</span>(<span class="ruby-identifier">recipient_id</span>)
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;payment_initiation/recipient/get&#39;</span>,
+                 <span class="ruby-constant">PaymentRecipientGetResponse</span>,
+                 <span class="ruby-value">recipient_id:</span> <span class="ruby-identifier">recipient_id</span>
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+        <div class="method">
+          <div class="title method-title" id="method-i-list_payments">
+              <b>list_payments</b>(options)
+            <a href="../../classes/Plaid/PaymentInitiation.html#method-i-list_payments" name="method-i-list_payments" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>List all payments.</p>
+<dl class="rdoc-list note-list"><dt>options
+<dd>
+<p><a href="../Object.html">Object</a> to specify optional parameters
+&#39;count&#39; and &#39;cursor&#39;. e.g {count: 10, cursor:
+&#39;2019-12-06T22:35:49Z&#39;} returns 10 payments initiated before
+2019-12-06T22:35:49Z.</p>
+</dd></dl>
+<h3 id="method-i-list_payments-label-Returns">Returns</h3>
+<p>Returns a <a href="PaymentListResponse.html">PaymentListResponse</a>
+object.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-list_payments_source')" id="l_method-i-list_payments_source">show</a>
+              </p>
+              <div id="method-i-list_payments_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/payment_initiation.rb, line 102</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">list_payments</span>(<span class="ruby-identifier">options</span>)
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;payment_initiation/payment/list&#39;</span>,
+                 <span class="ruby-constant">PaymentListResponse</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-list_recipients">
+              <b>list_recipients</b>()
+            <a href="../../classes/Plaid/PaymentInitiation.html#method-i-list_recipients" name="method-i-list_recipients" class="permalink">Link</a>
+          </div>
+            <div class="description">
+              <p>List all recipients.</p>
+<h3 id="method-i-list_recipients-label-Returns">Returns</h3>
+<p>Returns a <a
+href="PaymentRecipientListResponse.html">PaymentRecipientListResponse</a>
+object.</p>
+            </div>
+            <div class="sourcecode">
+              <p class="source-link">
+                Source:
+                <a href="javascript:toggleSource('method-i-list_recipients_source')" id="l_method-i-list_recipients_source">show</a>
+              </p>
+              <div id="method-i-list_recipients_source" class="dyn-source">
+                <pre><span class="ruby-comment"># File lib/plaid/products/payment_initiation.rb, line 37</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">list_recipients</span>
+  <span class="ruby-identifier">post_with_auth</span> <span class="ruby-string">&#39;payment_initiation/recipient/list&#39;</span>,
+                 <span class="ruby-constant">PaymentRecipientListResponse</span>,
+                 {}
+<span class="ruby-keyword">end</span></pre>
+              </div>
+            </div>
+          </div>
+</div>
+    </div>
+  </body>
+</html>

data/doc/rdoc/classes/Plaid/PaymentListResponse.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::PaymentListResponse</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::PaymentListResponse">
+    <meta name="description" content="The response wrapper for /payment_initiation/payment/list.">
+    <meta property="og:description" content="The response wrapper for /payment_initiation/payment/list.">
+    <meta name="keywords" content="Plaid::PaymentListResponse class">
+</head>
+<body>
+    <div class="banner">
+        <h1>
+            <span class="type">Class</span>
+            Plaid::PaymentListResponse
+                <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/payment_initiation_rb.html">lib/plaid/products/payment_initiation.rb</a></li>
+        </ul>
+    </div>
+    <div id="bodyContent">
+        <div id="content">
+    <div class="description">
+<p>The response wrapper for /payment_initiation/payment/list.</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'>next_cursor</td>
+            <td class='attr-desc'><p>The cursor (its a timestamp) to use in the next
+/payment_initiation/payment/list call for retrieving more older payments.</p></td>
+          </tr>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [R]
+            </td>
+            <td class='attr-name'>payments</td>
+            <td class='attr-desc'><p>The list of payments.</p></td>
+          </tr>
+      </table>
+    <!-- Methods -->
+</div>
+    </div>
+  </body>
+</html>