Skip to content

Commit 2331071

Browse files
author
GitHub Actions
committed
Update phpdoc
1 parent 06c2e7f commit 2331071

File tree

6 files changed

+62
-62
lines changed

6 files changed

+62
-62
lines changed

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -130,23 +130,23 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" tit
130130
</tr>
131131
<tbody>
132132
<tr class="altColor">
133+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/WalletClient.html" title="class in com.bitpay.sdk.client">WalletClient</a></code></td>
134+
<td class="colLast"><span class="typeNameLabel">WalletClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/WalletClient.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>
135+
<div class="block">Factory method for Wallet Client.</div>
136+
</td>
137+
</tr>
138+
<tr class="rowColor">
133139
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RateClient.html" title="class in com.bitpay.sdk.client">RateClient</a></code></td>
134140
<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>
135141
<div class="block">Factory method for Rate Client.</div>
136142
</td>
137143
</tr>
138-
<tr class="rowColor">
144+
<tr class="altColor">
139145
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/CurrencyClient.html" title="class in com.bitpay.sdk.client">CurrencyClient</a></code></td>
140146
<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>
141147
<div class="block">Factory method for Currency Client.</div>
142148
</td>
143149
</tr>
144-
<tr class="altColor">
145-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/WalletClient.html" title="class in com.bitpay.sdk.client">WalletClient</a></code></td>
146-
<td class="colLast"><span class="typeNameLabel">WalletClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/WalletClient.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>
147-
<div class="block">Factory method for Wallet Client.</div>
148-
</td>
149-
</tr>
150150
<tr class="rowColor">
151151
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/LedgerClient.html" title="class in com.bitpay.sdk.client">LedgerClient</a></code></td>
152152
<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,
@@ -162,40 +162,40 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/client/BitPayClient.html" tit
162162
</td>
163163
</tr>
164164
<tr class="rowColor">
165-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutClient.html" title="class in com.bitpay.sdk.client">PayoutClient</a></code></td>
166-
<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,
165+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/BillClient.html" title="class in com.bitpay.sdk.client">BillClient</a></code></td>
166+
<td class="colLast"><span class="typeNameLabel">BillClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/BillClient.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,
167167
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens)</code>
168168
<div class="block">Factory method for Bill Client.</div>
169169
</td>
170170
</tr>
171171
<tr class="altColor">
172-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutGroupClient.html" title="class in com.bitpay.sdk.client">PayoutGroupClient</a></code></td>
173-
<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,
172+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutClient.html" title="class in com.bitpay.sdk.client">PayoutClient</a></code></td>
173+
<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,
174174
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens)</code>
175-
<div class="block">Factory method for Payout Group Client.</div>
175+
<div class="block">Factory method for Bill Client.</div>
176176
</td>
177177
</tr>
178178
<tr class="rowColor">
179-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/BillClient.html" title="class in com.bitpay.sdk.client">BillClient</a></code></td>
180-
<td class="colLast"><span class="typeNameLabel">BillClient.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/client/BillClient.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,
179+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/PayoutGroupClient.html" title="class in com.bitpay.sdk.client">PayoutGroupClient</a></code></td>
180+
<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,
181181
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens)</code>
182-
<div class="block">Factory method for Bill Client.</div>
182+
<div class="block">Factory method for Payout Group Client.</div>
183183
</td>
184184
</tr>
185185
<tr class="altColor">
186-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RefundClient.html" title="class in com.bitpay.sdk.client">RefundClient</a></code></td>
187-
<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,
186+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/InvoiceClient.html" title="class in com.bitpay.sdk.client">InvoiceClient</a></code></td>
187+
<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,
188188
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens,
189189
<a href="../../../../../com/bitpay/sdk/util/GuidGenerator.html" title="class in com.bitpay.sdk.util">GuidGenerator</a>&nbsp;guidGenerator)</code>
190-
<div class="block">Factory method for Bill Client.</div>
190+
<div class="block">Factory method for Invoice Client.</div>
191191
</td>
192192
</tr>
193193
<tr class="rowColor">
194-
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/InvoiceClient.html" title="class in com.bitpay.sdk.client">InvoiceClient</a></code></td>
195-
<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,
194+
<td class="colFirst"><code>static <a href="../../../../../com/bitpay/sdk/client/RefundClient.html" title="class in com.bitpay.sdk.client">RefundClient</a></code></td>
195+
<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,
196196
<a href="../../../../../com/bitpay/sdk/util/TokenContainer.html" title="class in com.bitpay.sdk.util">TokenContainer</a>&nbsp;accessTokens,
197197
<a href="../../../../../com/bitpay/sdk/util/GuidGenerator.html" title="class in com.bitpay.sdk.util">GuidGenerator</a>&nbsp;guidGenerator)</code>
198-
<div class="block">Factory method for Invoice Client.</div>
198+
<div class="block">Factory method for Bill Client.</div>
199199
</td>
200200
</tr>
201201
<tr class="altColor">

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -616,29 +616,29 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/exceptions/BitPayException.ht
616616
</td>
617617
</tr>
618618
<tr class="altColor">
619+
<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>
620+
<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>
621+
<div class="block">Delete a previously created BitPay invoice.</div>
622+
</td>
623+
</tr>
624+
<tr class="rowColor">
619625
<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>
620626
<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>
621627
<div class="block">Cancel a previously submitted refund request on a BitPay invoice.</div>
622628
</td>
623629
</tr>
624-
<tr class="rowColor">
630+
<tr class="altColor">
625631
<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>
626632
<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>
627633
<div class="block">Cancel a BitPay Payout.</div>
628634
</td>
629635
</tr>
630-
<tr class="altColor">
636+
<tr class="rowColor">
631637
<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>
632638
<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>
633639
<div class="block">Cancel a BitPay Payouts.</div>
634640
</td>
635641
</tr>
636-
<tr class="rowColor">
637-
<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>
638-
<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>
639-
<div class="block">Delete a previously created BitPay invoice.</div>
640-
</td>
641-
</tr>
642642
<tr class="altColor">
643643
<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>
644644
<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,
@@ -699,17 +699,17 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/exceptions/BitPayException.ht
699699
</td>
700700
</tr>
701701
<tr class="rowColor">
702-
<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>
703-
<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>
704-
<div class="block">Retrieve a BitPay payout by payout id using.</div>
705-
</td>
706-
</tr>
707-
<tr class="altColor">
708702
<td class="colFirst"><code>org.apache.http.HttpResponse</code></td>
709703
<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>
710704
<div class="block">Send GET request.</div>
711705
</td>
712706
</tr>
707+
<tr class="altColor">
708+
<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>
709+
<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>
710+
<div class="block">Retrieve a BitPay payout by payout id using.</div>
711+
</td>
712+
</tr>
713713
<tr class="rowColor">
714714
<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>
715715
<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>
@@ -1323,14 +1323,14 @@ <h3>Uses of <a href="../../../../../com/bitpay/sdk/exceptions/BitPayException.ht
13231323
<tbody>
13241324
<tr class="altColor">
13251325
<td class="colFirst"><code>void</code></td>
1326-
<td class="colLast"><span class="typeNameLabel">Invoice.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/model/invoice/Invoice.html#setCurrency-java.lang.String-">setCurrency</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;currency)</code>
1327-
<div class="block">Sets ISO 4217 3-character currency code.</div>
1326+
<td class="colLast"><span class="typeNameLabel">RefundInfo.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/model/invoice/RefundInfo.html#setCurrency-java.lang.String-">setCurrency</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;currency)</code>
1327+
<div class="block">Sets reference currency used for the refund, usually the same as the currency used to create the invoice.</div>
13281328
</td>
13291329
</tr>
13301330
<tr class="rowColor">
13311331
<td class="colFirst"><code>void</code></td>
1332-
<td class="colLast"><span class="typeNameLabel">RefundInfo.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/model/invoice/RefundInfo.html#setCurrency-java.lang.String-">setCurrency</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;currency)</code>
1333-
<div class="block">Sets reference currency used for the refund, usually the same as the currency used to create the invoice.</div>
1332+
<td class="colLast"><span class="typeNameLabel">Invoice.</span><code><span class="memberNameLink"><a href="../../../../../com/bitpay/sdk/model/invoice/Invoice.html#setCurrency-java.lang.String-">setCurrency</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;currency)</code>
1333+
<div class="block">Sets ISO 4217 3-character currency code.</div>
13341334
</td>
13351335
</tr>
13361336
<tr class="altColor">

0 commit comments

Comments
 (0)