Update javadoc

bitpay · Oct 8, 2024 · 48133ee · 48133ee
1 parent 85b5595
commit 48133ee
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 80 deletions.
diff --git a/docs/com/bitpay/sdk/client/class-use/BitPayClient.html b/docs/com/bitpay/sdk/client/class-use/BitPayClient.html
@@ -143,9 +143,9 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" tit
 </tr>
 <tbody>
 <tr class="altColor">
-<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/CurrencyClient.html" title="class in com.bitpay.sdk.client">CurrencyClient</a></code></td>
-<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>
-<div class="block">Factory method for Currency Client.</div>
+<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RateClient.html" title="class in com.bitpay.sdk.client">RateClient</a></code></td>
+<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>
+<div class="block">Factory method for Rate Client.</div>
 </td>
 </tr>
 <tr class="rowColor">
@@ -155,16 +155,16 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" tit
 </td>
 </tr>
 <tr class="altColor">
-<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RateClient.html" title="class in com.bitpay.sdk.client">RateClient</a></code></td>
-<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>
-<div class="block">Factory method for Rate Client.</div>
+<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/CurrencyClient.html" title="class in com.bitpay.sdk.client">CurrencyClient</a></code></td>
+<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>
+<div class="block">Factory method for Currency Client.</div>
 </td>
 </tr>
 <tr class="rowColor">
-<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/LedgerClient.html" title="class in com.bitpay.sdk.client">LedgerClient</a></code></td>
-<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,
+<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutGroupClient.html" title="class in com.bitpay.sdk.client">PayoutGroupClient</a></code></td>
+<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,
            <a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens)</code>
-<div class="block">Factory method for Ledger Client.</div>
+<div class="block">Factory method for Payout Group Client.</div>
 </td>
 </tr>
 <tr class="altColor">
@@ -175,17 +175,17 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" tit
 </td>
 </tr>
 <tr class="rowColor">
-<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutClient.html" title="class in com.bitpay.sdk.client">PayoutClient</a></code></td>
-<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,
+<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/LedgerClient.html" title="class in com.bitpay.sdk.client">LedgerClient</a></code></td>
+<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,
            <a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens)</code>
-<div class="block">Factory method for Bill Client.</div>
+<div class="block">Factory method for Ledger Client.</div>
 </td>
 </tr>
 <tr class="altColor">
-<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutGroupClient.html" title="class in com.bitpay.sdk.client">PayoutGroupClient</a></code></td>
-<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,
+<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutClient.html" title="class in com.bitpay.sdk.client">PayoutClient</a></code></td>
+<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,
            <a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens)</code>
-<div class="block">Factory method for Payout Group Client.</div>
+<div class="block">Factory method for Bill Client.</div>
 </td>
 </tr>
 <tr class="rowColor">
@@ -196,24 +196,24 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" tit
 </td>
 </tr>
 <tr class="altColor">
-<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutRecipientsClient.html" title="class in com.bitpay.sdk.client">PayoutRecipientsClient</a></code></td>
-<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,
+<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/InvoiceClient.html" title="class in com.bitpay.sdk.client">InvoiceClient</a></code></td>
+<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,
            <a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens,
            <a href="../../../../../com/bitpay/sdk/util/GuidGenerator.html" title="class in com.bitpay.sdk.util">GuidGenerator</a>&nbsp;guidGenerator)</code>
-<div class="block">Factory method for Bill Client.</div>
+<div class="block">Factory method for Invoice Client.</div>
 </td>
 </tr>
 <tr class="rowColor">
-<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/InvoiceClient.html" title="class in com.bitpay.sdk.client">InvoiceClient</a></code></td>
-<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,
+<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RefundClient.html" title="class in com.bitpay.sdk.client">RefundClient</a></code></td>
+<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,
            <a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens,
            <a href="../../../../../com/bitpay/sdk/util/GuidGenerator.html" title="class in com.bitpay.sdk.util">GuidGenerator</a>&nbsp;guidGenerator)</code>
-<div class="block">Factory method for Invoice Client.</div>
+<div class="block">Factory method for Bill Client.</div>
 </td>
 </tr>
 <tr class="altColor">
-<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RefundClient.html" title="class in com.bitpay.sdk.client">RefundClient</a></code></td>
-<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,
+<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutRecipientsClient.html" title="class in com.bitpay.sdk.client">PayoutRecipientsClient</a></code></td>
+<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,
            <a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens,
            <a href="../../../../../com/bitpay/sdk/util/GuidGenerator.html" title="class in com.bitpay.sdk.util">GuidGenerator</a>&nbsp;guidGenerator)</code>
 <div class="block">Factory method for Bill Client.</div>

diff --git a/docs/com/bitpay/sdk/exceptions/class-use/BitPayApiException.html b/docs/com/bitpay/sdk/exceptions/class-use/BitPayApiException.html
@@ -562,29 +562,29 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/exceptions/BitPayApiException
 </td>
 </tr>
 <tr class="altColor">
+<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>
+<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>
+<div class="block">Cancel a BitPay Payouts.</div>
+</td>
+</tr>
+<tr class="rowColor">
 <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>
 <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>
 <div class="block">Delete a previously created BitPay invoice.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <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>
 <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>
 <div class="block">Cancel a previously submitted refund request on a BitPay invoice.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <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>
 <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>
 <div class="block">Cancel a BitPay Payout.</div>
 </td>
 </tr>
-<tr class="rowColor">
-<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>
-<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>
-<div class="block">Cancel a BitPay Payouts.</div>
-</td>
-</tr>
 <tr class="altColor">
 <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>
 <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
 <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>
 </tr>
 <tr class="altColor">
-<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>
-<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>
-<div class="block">Retrieve a BitPay payout recipient by batch id using.</div>
-</td>
-</tr>
-<tr class="rowColor">
 <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>
 <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>
 <div class="block">Retrieves a summary of the specified settlement.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code><a href="../../../../../com/bitpay/sdk/client/HttpResponse.html" title="class in com.bitpay.sdk.client">HttpResponse</a></code></td>
 <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>
 <div class="block">Send GET request.</div>
 </td>
 </tr>
+<tr class="altColor">
+<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>
+<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>
+<div class="block">Retrieve a BitPay payout recipient by batch id using.</div>
+</td>
+</tr>
 <tr class="rowColor">
 <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>
 <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>