Skip to content

Commit d56ca39

Browse files
author
GitHub Actions
committed
Update javadoc
1 parent 6c79393 commit d56ca39

File tree

249 files changed

+944
-853
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

249 files changed

+944
-853
lines changed

docs/BitPaySetup.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<head>
55
<!-- Generated by javadoc -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>BitPaySetup (BitPay 10.1.2 API)</title>
7+
<title>BitPaySetup (BitPay 10.1.3 API)</title>
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
1111
<body>
1212
<script type="text/javascript"><!--
1313
try {
1414
if (location.href.indexOf('is-external=true') == -1) {
15-
parent.document.title="BitPaySetup (BitPay 10.1.2 API)";
15+
parent.document.title="BitPaySetup (BitPay 10.1.3 API)";
1616
}
1717
}
1818
catch(err) {
@@ -266,6 +266,6 @@ <h4>main</h4>
266266
<!-- -->
267267
</a></div>
268268
<!-- ======== END OF BOTTOM NAVBAR ======= -->
269-
<p class="legalCopy"><small>Copyright &#169; 2024 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
269+
<p class="legalCopy"><small>Copyright &#169; 2025 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
270270
</body>
271271
</html>

docs/allclasses-frame.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<!-- Generated by javadoc -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>All Classes (BitPay 10.1.2 API)</title>
7+
<title>All Classes (BitPay 10.1.3 API)</title>
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>

docs/allclasses-noframe.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<!-- Generated by javadoc -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>All Classes (BitPay 10.1.2 API)</title>
7+
<title>All Classes (BitPay 10.1.3 API)</title>
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>

docs/class-use/BitPaySetup.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<head>
55
<!-- Generated by javadoc -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>Uses of Class BitPaySetup (BitPay 10.1.2 API)</title>
7+
<title>Uses of Class BitPaySetup (BitPay 10.1.3 API)</title>
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../script.js"></script>
1010
</head>
1111
<body>
1212
<script type="text/javascript"><!--
1313
try {
1414
if (location.href.indexOf('is-external=true') == -1) {
15-
parent.document.title="Uses of Class BitPaySetup (BitPay 10.1.2 API)";
15+
parent.document.title="Uses of Class BitPaySetup (BitPay 10.1.3 API)";
1616
}
1717
}
1818
catch(err) {
@@ -120,6 +120,6 @@ <h2 title="Uses of Class BitPaySetup" class="title">Uses of Class<br>BitPaySetup
120120
<!-- -->
121121
</a></div>
122122
<!-- ======== END OF BOTTOM NAVBAR ======= -->
123-
<p class="legalCopy"><small>Copyright &#169; 2024 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
123+
<p class="legalCopy"><small>Copyright &#169; 2025 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
124124
</body>
125125
</html>

docs/com/bitpay/sdk/Client.html

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<head>
55
<!-- Generated by javadoc -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>Client (BitPay 10.1.2 API)</title>
7+
<title>Client (BitPay 10.1.3 API)</title>
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>
1111
<body>
1212
<script type="text/javascript"><!--
1313
try {
1414
if (location.href.indexOf('is-external=true') == -1) {
15-
parent.document.title="Client (BitPay 10.1.2 API)";
15+
parent.document.title="Client (BitPay 10.1.3 API)";
1616
}
1717
}
1818
catch(err) {
@@ -766,7 +766,8 @@ <h3>Method Summary</h3>
766766
</tr>
767767
<tr id="i77" class="rowColor">
768768
<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>
769-
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/bitpay/sdk/Client.html#requestInvoiceWebhookToBeResent-java.lang.String-">requestInvoiceWebhookToBeResent</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>
769+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/bitpay/sdk/Client.html#requestInvoiceWebhookToBeResent-java.lang.String-java.lang.String-">requestInvoiceWebhookToBeResent</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,
770+
<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;invoiceToken)</code>
770771
<div class="block">The intent of this call is to address issues when BitPay sends a webhook but the client doesn't receive it,
771772
so the client can request that BitPay resend it.</div>
772773
</td>
@@ -785,7 +786,8 @@ <h3>Method Summary</h3>
785786
</tr>
786787
<tr id="i80" class="altColor">
787788
<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>
788-
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/bitpay/sdk/Client.html#sendRefundNotification-java.lang.String-">sendRefundNotification</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>
789+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/bitpay/sdk/Client.html#sendRefundNotification-java.lang.String-java.lang.String-">sendRefundNotification</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,
790+
<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;refundToken)</code>
789791
<div class="block">Send a refund notification.</div>
790792
</td>
791793
</tr>
@@ -1757,20 +1759,23 @@ <h4>cancelInvoiceByGuid</h4>
17571759
</dl>
17581760
</li>
17591761
</ul>
1760-
<a name="requestInvoiceWebhookToBeResent-java.lang.String-">
1762+
<a name="requestInvoiceWebhookToBeResent-java.lang.String-java.lang.String-">
17611763
<!-- -->
17621764
</a>
17631765
<ul class="blockList">
17641766
<li class="blockList">
17651767
<h4>requestInvoiceWebhookToBeResent</h4>
1766-
<pre>public&nbsp;<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>&nbsp;requestInvoiceWebhookToBeResent(<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)
1768+
<pre>public&nbsp;<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>&nbsp;requestInvoiceWebhookToBeResent(<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,
1769+
<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;invoiceToken)
17671770
throws <a href="../../../com/bitpay/sdk/exceptions/BitPayApiException.html" title="class in com.bitpay.sdk.exceptions">BitPayApiException</a>,
17681771
<a href="../../../com/bitpay/sdk/exceptions/BitPayGenericException.html" title="class in com.bitpay.sdk.exceptions">BitPayGenericException</a></pre>
17691772
<div class="block">The intent of this call is to address issues when BitPay sends a webhook but the client doesn't receive it,
17701773
so the client can request that BitPay resend it.</div>
17711774
<dl>
17721775
<dt><span class="paramLabel">Parameters:</span></dt>
17731776
<dd><code>invoiceId</code> - The id of the invoice for which you want the last webhook to be resent.</dd>
1777+
<dd><code>invoiceToken</code> - The resource token for the invoiceId.
1778+
This token can be retrieved from the Bitpay's invoice object.</dd>
17741779
<dt><span class="returnLabel">Returns:</span></dt>
17751780
<dd>Boolean status of request</dd>
17761781
<dt><span class="throwsLabel">Throws:</span></dt>
@@ -2005,19 +2010,22 @@ <h4>updateRefundByGuid</h4>
20052010
</dl>
20062011
</li>
20072012
</ul>
2008-
<a name="sendRefundNotification-java.lang.String-">
2013+
<a name="sendRefundNotification-java.lang.String-java.lang.String-">
20092014
<!-- -->
20102015
</a>
20112016
<ul class="blockList">
20122017
<li class="blockList">
20132018
<h4>sendRefundNotification</h4>
2014-
<pre>public&nbsp;<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>&nbsp;sendRefundNotification(<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)
2019+
<pre>public&nbsp;<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>&nbsp;sendRefundNotification(<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,
2020+
<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;refundToken)
20152021
throws <a href="../../../com/bitpay/sdk/exceptions/BitPayGenericException.html" title="class in com.bitpay.sdk.exceptions">BitPayGenericException</a>,
20162022
<a href="../../../com/bitpay/sdk/exceptions/BitPayApiException.html" title="class in com.bitpay.sdk.exceptions">BitPayApiException</a></pre>
20172023
<div class="block">Send a refund notification.</div>
20182024
<dl>
20192025
<dt><span class="paramLabel">Parameters:</span></dt>
20202026
<dd><code>refundId</code> - A BitPay refund ID.</dd>
2027+
<dd><code>refundToken</code> - The resource token for the refundId.
2028+
This token can be retrieved from the Bitpay's refund object.</dd>
20212029
<dt><span class="returnLabel">Returns:</span></dt>
20222030
<dd>An updated Refund Object</dd>
20232031
<dt><span class="throwsLabel">Throws:</span></dt>
@@ -3202,6 +3210,6 @@ <h4>getWalletClient</h4>
32023210
<!-- -->
32033211
</a></div>
32043212
<!-- ======== END OF BOTTOM NAVBAR ======= -->
3205-
<p class="legalCopy"><small>Copyright &#169; 2024 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
3213+
<p class="legalCopy"><small>Copyright &#169; 2025 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
32063214
</body>
32073215
</html>

docs/com/bitpay/sdk/Config.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<head>
55
<!-- Generated by javadoc -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>Config (BitPay 10.1.2 API)</title>
7+
<title>Config (BitPay 10.1.3 API)</title>
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>
1111
<body>
1212
<script type="text/javascript"><!--
1313
try {
1414
if (location.href.indexOf('is-external=true') == -1) {
15-
parent.document.title="Config (BitPay 10.1.2 API)";
15+
parent.document.title="Config (BitPay 10.1.3 API)";
1616
}
1717
}
1818
catch(err) {
@@ -521,6 +521,6 @@ <h4>getApiTokens</h4>
521521
<!-- -->
522522
</a></div>
523523
<!-- ======== END OF BOTTOM NAVBAR ======= -->
524-
<p class="legalCopy"><small>Copyright &#169; 2024 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
524+
<p class="legalCopy"><small>Copyright &#169; 2025 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
525525
</body>
526526
</html>

docs/com/bitpay/sdk/ConfigFilePath.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<head>
55
<!-- Generated by javadoc -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>ConfigFilePath (BitPay 10.1.2 API)</title>
7+
<title>ConfigFilePath (BitPay 10.1.3 API)</title>
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>
1111
<body>
1212
<script type="text/javascript"><!--
1313
try {
1414
if (location.href.indexOf('is-external=true') == -1) {
15-
parent.document.title="ConfigFilePath (BitPay 10.1.2 API)";
15+
parent.document.title="ConfigFilePath (BitPay 10.1.3 API)";
1616
}
1717
}
1818
catch(err) {
@@ -282,6 +282,6 @@ <h4>value</h4>
282282
<!-- -->
283283
</a></div>
284284
<!-- ======== END OF BOTTOM NAVBAR ======= -->
285-
<p class="legalCopy"><small>Copyright &#169; 2024 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
285+
<p class="legalCopy"><small>Copyright &#169; 2025 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
286286
</body>
287287
</html>

docs/com/bitpay/sdk/Environment.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<head>
55
<!-- Generated by javadoc -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>Environment (BitPay 10.1.2 API)</title>
7+
<title>Environment (BitPay 10.1.3 API)</title>
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>
1111
<body>
1212
<script type="text/javascript"><!--
1313
try {
1414
if (location.href.indexOf('is-external=true') == -1) {
15-
parent.document.title="Environment (BitPay 10.1.2 API)";
15+
parent.document.title="Environment (BitPay 10.1.3 API)";
1616
}
1717
}
1818
catch(err) {
@@ -383,6 +383,6 @@ <h4>toString</h4>
383383
<!-- -->
384384
</a></div>
385385
<!-- ======== END OF BOTTOM NAVBAR ======= -->
386-
<p class="legalCopy"><small>Copyright &#169; 2024 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
386+
<p class="legalCopy"><small>Copyright &#169; 2025 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
387387
</body>
388388
</html>

docs/com/bitpay/sdk/PosToken.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<head>
55
<!-- Generated by javadoc -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>PosToken (BitPay 10.1.2 API)</title>
7+
<title>PosToken (BitPay 10.1.3 API)</title>
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>
1111
<body>
1212
<script type="text/javascript"><!--
1313
try {
1414
if (location.href.indexOf('is-external=true') == -1) {
15-
parent.document.title="PosToken (BitPay 10.1.2 API)";
15+
parent.document.title="PosToken (BitPay 10.1.3 API)";
1616
}
1717
}
1818
catch(err) {
@@ -282,6 +282,6 @@ <h4>value</h4>
282282
<!-- -->
283283
</a></div>
284284
<!-- ======== END OF BOTTOM NAVBAR ======= -->
285-
<p class="legalCopy"><small>Copyright &#169; 2024 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
285+
<p class="legalCopy"><small>Copyright &#169; 2025 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
286286
</body>
287287
</html>

docs/com/bitpay/sdk/PrivateKey.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<head>
55
<!-- Generated by javadoc -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>PrivateKey (BitPay 10.1.2 API)</title>
7+
<title>PrivateKey (BitPay 10.1.3 API)</title>
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../script.js"></script>
1010
</head>
1111
<body>
1212
<script type="text/javascript"><!--
1313
try {
1414
if (location.href.indexOf('is-external=true') == -1) {
15-
parent.document.title="PrivateKey (BitPay 10.1.2 API)";
15+
parent.document.title="PrivateKey (BitPay 10.1.3 API)";
1616
}
1717
}
1818
catch(err) {
@@ -282,6 +282,6 @@ <h4>value</h4>
282282
<!-- -->
283283
</a></div>
284284
<!-- ======== END OF BOTTOM NAVBAR ======= -->
285-
<p class="legalCopy"><small>Copyright &#169; 2024 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
285+
<p class="legalCopy"><small>Copyright &#169; 2025 <a href="https://bitpay.com">BitPay</a>. All rights reserved.</small></p>
286286
</body>
287287
</html>

0 commit comments

Comments
 (0)