Skip to content

Commit 48133ee

Browse files
author
GitHub Actions
committed
Update javadoc
1 parent 85b5595 commit 48133ee

File tree

6 files changed

+80
-80
lines changed

6 files changed

+80
-80
lines changed

docs/com/bitpay/sdk/client/class-use/BitPayClient.html

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,9 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" tit
143143
</tr>
144144
<tbody>
145145
<tr class="altColor">
146-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/CurrencyClient.html" title="class in com.bitpay.sdk.client">CurrencyClient</a></code></td>
147-
<td class="colLast"><span class="typeNameLabel">CurrencyClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/CurrencyClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient)</code>
148-
<div class="block">Factory method for Currency Client.</div>
146+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RateClient.html" title="class in com.bitpay.sdk.client">RateClient</a></code></td>
147+
<td class="colLast"><span class="typeNameLabel">RateClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/RateClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient)</code>
148+
<div class="block">Factory method for Rate Client.</div>
149149
</td>
150150
</tr>
151151
<tr class="rowColor">
@@ -155,16 +155,16 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" tit
155155
</td>
156156
</tr>
157157
<tr class="altColor">
158-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RateClient.html" title="class in com.bitpay.sdk.client">RateClient</a></code></td>
159-
<td class="colLast"><span class="typeNameLabel">RateClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/RateClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient)</code>
160-
<div class="block">Factory method for Rate Client.</div>
158+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/CurrencyClient.html" title="class in com.bitpay.sdk.client">CurrencyClient</a></code></td>
159+
<td class="colLast"><span class="typeNameLabel">CurrencyClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/CurrencyClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient)</code>
160+
<div class="block">Factory method for Currency Client.</div>
161161
</td>
162162
</tr>
163163
<tr class="rowColor">
164-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/LedgerClient.html" title="class in com.bitpay.sdk.client">LedgerClient</a></code></td>
165-
<td class="colLast"><span class="typeNameLabel">LedgerClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/LedgerClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
164+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutGroupClient.html" title="class in com.bitpay.sdk.client">PayoutGroupClient</a></code></td>
165+
<td class="colLast"><span class="typeNameLabel">PayoutGroupClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutGroupClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
166166
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens)</code>
167-
<div class="block">Factory method for Ledger Client.</div>
167+
<div class="block">Factory method for Payout Group Client.</div>
168168
</td>
169169
</tr>
170170
<tr class="altColor">
@@ -175,17 +175,17 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" tit
175175
</td>
176176
</tr>
177177
<tr class="rowColor">
178-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutClient.html" title="class in com.bitpay.sdk.client">PayoutClient</a></code></td>
179-
<td class="colLast"><span class="typeNameLabel">PayoutClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
178+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/LedgerClient.html" title="class in com.bitpay.sdk.client">LedgerClient</a></code></td>
179+
<td class="colLast"><span class="typeNameLabel">LedgerClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/LedgerClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
180180
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens)</code>
181-
<div class="block">Factory method for Bill Client.</div>
181+
<div class="block">Factory method for Ledger Client.</div>
182182
</td>
183183
</tr>
184184
<tr class="altColor">
185-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutGroupClient.html" title="class in com.bitpay.sdk.client">PayoutGroupClient</a></code></td>
186-
<td class="colLast"><span class="typeNameLabel">PayoutGroupClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutGroupClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
185+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutClient.html" title="class in com.bitpay.sdk.client">PayoutClient</a></code></td>
186+
<td class="colLast"><span class="typeNameLabel">PayoutClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
187187
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens)</code>
188-
<div class="block">Factory method for Payout Group Client.</div>
188+
<div class="block">Factory method for Bill Client.</div>
189189
</td>
190190
</tr>
191191
<tr class="rowColor">
@@ -196,24 +196,24 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" tit
196196
</td>
197197
</tr>
198198
<tr class="altColor">
199-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutRecipientsClient.html" title="class in com.bitpay.sdk.client">PayoutRecipientsClient</a></code></td>
200-
<td class="colLast"><span class="typeNameLabel">PayoutRecipientsClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutRecipientsClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-com.bitpay.sdk.util.GuidGenerator-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
199+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/InvoiceClient.html" title="class in com.bitpay.sdk.client">InvoiceClient</a></code></td>
200+
<td class="colLast"><span class="typeNameLabel">InvoiceClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/InvoiceClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-com.bitpay.sdk.util.GuidGenerator-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
201201
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens,
202202
<a href="../../../../../com/bitpay/sdk/util/GuidGenerator.html" title="class in com.bitpay.sdk.util">GuidGenerator</a>&nbsp;guidGenerator)</code>
203-
<div class="block">Factory method for Bill Client.</div>
203+
<div class="block">Factory method for Invoice Client.</div>
204204
</td>
205205
</tr>
206206
<tr class="rowColor">
207-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/InvoiceClient.html" title="class in com.bitpay.sdk.client">InvoiceClient</a></code></td>
208-
<td class="colLast"><span class="typeNameLabel">InvoiceClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/InvoiceClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-com.bitpay.sdk.util.GuidGenerator-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
207+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RefundClient.html" title="class in com.bitpay.sdk.client">RefundClient</a></code></td>
208+
<td class="colLast"><span class="typeNameLabel">RefundClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/RefundClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-com.bitpay.sdk.util.GuidGenerator-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
209209
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens,
210210
<a href="../../../../../com/bitpay/sdk/util/GuidGenerator.html" title="class in com.bitpay.sdk.util">GuidGenerator</a>&nbsp;guidGenerator)</code>
211-
<div class="block">Factory method for Invoice Client.</div>
211+
<div class="block">Factory method for Bill Client.</div>
212212
</td>
213213
</tr>
214214
<tr class="altColor">
215-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RefundClient.html" title="class in com.bitpay.sdk.client">RefundClient</a></code></td>
216-
<td class="colLast"><span class="typeNameLabel">RefundClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/RefundClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-com.bitpay.sdk.util.GuidGenerator-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
215+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutRecipientsClient.html" title="class in com.bitpay.sdk.client">PayoutRecipientsClient</a></code></td>
216+
<td class="colLast"><span class="typeNameLabel">PayoutRecipientsClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutRecipientsClient.html#getInstance-com.bitpay.sdk.client.BitPayClient-com.bitpay.sdk.util.TokenContainer-com.bitpay.sdk.util.GuidGenerator-">getInstance</a></span>(<a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" title="class in com.bitpay.sdk.client">BitPayClient</a>&nbsp;bitPayClient,
217217
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens,
218218
<a href="../../../../../com/bitpay/sdk/util/GuidGenerator.html" title="class in com.bitpay.sdk.util">GuidGenerator</a>&nbsp;guidGenerator)</code>
219219
<div class="block">Factory method for Bill Client.</div>

docs/com/bitpay/sdk/exceptions/class-use/BitPayApiException.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -562,29 +562,29 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/exceptions/BitPayApiException
562562
</td>
563563
</tr>
564564
<tr class="altColor">
565+
<td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/model/payout/PayoutGroup.html" title="class in com.bitpay.sdk.model.payout">PayoutGroup</a></code></td>
566+
<td class="colLast"><span class="typeNameLabel">PayoutGroupClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutGroupClient.html#cancel-java.lang.String-">cancel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;groupId)</code>
567+
<div class="block">Cancel a BitPay Payouts.</div>
568+
</td>
569+
</tr>
570+
<tr class="rowColor">
565571
<td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/model/invoice/Invoice.html" title="class in com.bitpay.sdk.model.invoice">Invoice</a></code></td>
566572
<td class="colLast"><span class="typeNameLabel">InvoiceClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/InvoiceClient.html#cancel-java.lang.String-">cancel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;invoiceId)</code>
567573
<div class="block">Delete a previously created BitPay invoice.</div>
568574
</td>
569575
</tr>
570-
<tr class="rowColor">
576+
<tr class="altColor">
571577
<td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/model/invoice/Refund.html" title="class in com.bitpay.sdk.model.invoice">Refund</a></code></td>
572578
<td class="colLast"><span class="typeNameLabel">RefundClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/RefundClient.html#cancel-java.lang.String-">cancel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;refundId)</code>
573579
<div class="block">Cancel a previously submitted refund request on a BitPay invoice.</div>
574580
</td>
575581
</tr>
576-
<tr class="altColor">
582+
<tr class="rowColor">
577583
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td>
578584
<td class="colLast"><span class="typeNameLabel">PayoutClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutClient.html#cancel-java.lang.String-">cancel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;payoutId)</code>
579585
<div class="block">Cancel a BitPay Payout.</div>
580586
</td>
581587
</tr>
582-
<tr class="rowColor">
583-
<td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/model/payout/PayoutGroup.html" title="class in com.bitpay.sdk.model.payout">PayoutGroup</a></code></td>
584-
<td class="colLast"><span class="typeNameLabel">PayoutGroupClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutGroupClient.html#cancel-java.lang.String-">cancel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;groupId)</code>
585-
<div class="block">Cancel a BitPay Payouts.</div>
586-
</td>
587-
</tr>
588588
<tr class="altColor">
589589
<td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/model/invoice/Invoice.html" title="class in com.bitpay.sdk.model.invoice">Invoice</a></code></td>
590590
<td class="colLast"><span class="typeNameLabel">InvoiceClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/InvoiceClient.html#cancel-java.lang.String-java.lang.Boolean-">cancel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;invoiceId,
@@ -653,23 +653,23 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/exceptions/BitPayApiException
653653
<td class="colLast"><span class="typeNameLabel">HttpResponseProvider.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/HttpResponseProvider.html#fromApacheHttpResponse-org.apache.http.HttpResponse-">fromApacheHttpResponse</a></span>(org.apache.http.HttpResponse&nbsp;apacheHttpResponse)</code>&nbsp;</td>
654654
</tr>
655655
<tr class="altColor">
656-
<td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/model/payout/PayoutRecipient.html" title="class in com.bitpay.sdk.model.payout">PayoutRecipient</a></code></td>
657-
<td class="colLast"><span class="typeNameLabel">PayoutRecipientsClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutRecipientsClient.html#get-java.lang.String-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;recipientId)</code>
658-
<div class="block">Retrieve a BitPay payout recipient by batch id using.</div>
659-
</td>
660-
</tr>
661-
<tr class="rowColor">
662656
<td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/model/settlement/Settlement.html" title="class in com.bitpay.sdk.model.settlement">Settlement</a></code></td>
663657
<td class="colLast"><span class="typeNameLabel">SettlementClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/SettlementClient.html#get-java.lang.String-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;settlementId)</code>
664658
<div class="block">Retrieves a summary of the specified settlement.</div>
665659
</td>
666660
</tr>
667-
<tr class="altColor">
661+
<tr class="rowColor">
668662
<td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/client/HttpResponse.html" title="class in com.bitpay.sdk.client">HttpResponse</a></code></td>
669663
<td class="colLast"><span class="typeNameLabel">BitPayClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/BitPayClient.html#get-java.lang.String-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;uri)</code>
670664
<div class="block">Send GET request.</div>
671665
</td>
672666
</tr>
667+
<tr class="altColor">
668+
<td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/model/payout/PayoutRecipient.html" title="class in com.bitpay.sdk.model.payout">PayoutRecipient</a></code></td>
669+
<td class="colLast"><span class="typeNameLabel">PayoutRecipientsClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutRecipientsClient.html#get-java.lang.String-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;recipientId)</code>
670+
<div class="block">Retrieve a BitPay payout recipient by batch id using.</div>
671+
</td>
672+
</tr>
673673
<tr class="rowColor">
674674
<td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/model/payout/Payout.html" title="class in com.bitpay.sdk.model.payout">Payout</a></code></td>
675675
<td class="colLast"><span class="typeNameLabel">PayoutClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/PayoutClient.html#get-java.lang.String-">get</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;payoutId)</code>

0 commit comments

Comments
 (0)