Skip to content

Commit fffacbc

Browse files
author
GitHub Actions
committed
Update phpdoc
1 parent 65546e6 commit fffacbc

File tree

5 files changed

+181
-121
lines changed

5 files changed

+181
-121
lines changed

docs/classes/BitPaySDK-Client-InvoiceClient.html

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ <h4 class="phpdocumentor-element__name" id="method_cancel">
467467
<aside class="phpdocumentor-element-found-in">
468468
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/InvoiceClient.php"><a href="files/src-bitpaysdk-client-invoiceclient.html"><abbr title="src/BitPaySDK/Client/InvoiceClient.php">InvoiceClient.php</abbr></a></abbr>
469469
:
470-
<span class="phpdocumentor-element-found-in__line">274</span>
470+
<span class="phpdocumentor-element-found-in__line">276</span>
471471

472472
</aside>
473473

@@ -552,7 +552,7 @@ <h4 class="phpdocumentor-element__name" id="method_cancelByGuid">
552552
<aside class="phpdocumentor-element-found-in">
553553
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/InvoiceClient.php"><a href="files/src-bitpaysdk-client-invoiceclient.html"><abbr title="src/BitPaySDK/Client/InvoiceClient.php">InvoiceClient.php</abbr></a></abbr>
554554
:
555-
<span class="phpdocumentor-element-found-in__line">306</span>
555+
<span class="phpdocumentor-element-found-in__line">308</span>
556556

557557
</aside>
558558

@@ -1083,7 +1083,7 @@ <h4 class="phpdocumentor-element__name" id="method_pay">
10831083
<aside class="phpdocumentor-element-found-in">
10841084
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/InvoiceClient.php"><a href="files/src-bitpaysdk-client-invoiceclient.html"><abbr title="src/BitPaySDK/Client/InvoiceClient.php">InvoiceClient.php</abbr></a></abbr>
10851085
:
1086-
<span class="phpdocumentor-element-found-in__line">339</span>
1086+
<span class="phpdocumentor-element-found-in__line">341</span>
10871087

10881088
</aside>
10891089

@@ -1170,15 +1170,15 @@ <h4 class="phpdocumentor-element__name" id="method_requestNotification">
11701170
<aside class="phpdocumentor-element-found-in">
11711171
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/InvoiceClient.php"><a href="files/src-bitpaysdk-client-invoiceclient.html"><abbr title="src/BitPaySDK/Client/InvoiceClient.php">InvoiceClient.php</abbr></a></abbr>
11721172
:
1173-
<span class="phpdocumentor-element-found-in__line">258</span>
1173+
<span class="phpdocumentor-element-found-in__line">260</span>
11741174

11751175
</aside>
11761176

11771177
<p class="phpdocumentor-summary">Request a BitPay Invoice Webhook.</p>
11781178

11791179
<code class="phpdocumentor-code phpdocumentor-signature ">
11801180
<span class="phpdocumentor-signature__visibility">public</span>
1181-
<span class="phpdocumentor-signature__name">requestNotification</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$invoiceId</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
1181+
<span class="phpdocumentor-signature__name">requestNotification</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$invoiceId</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$invoiceToken</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
11821182

11831183
<div class="phpdocumentor-label-line">
11841184
</div>
@@ -1194,6 +1194,16 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
11941194
<section class="phpdocumentor-description"><p>A BitPay invoice ID.</p>
11951195
</section>
11961196

1197+
</dd>
1198+
<dt class="phpdocumentor-argument-list__entry">
1199+
<span class="phpdocumentor-signature__argument__name">$invoiceToken</span>
1200+
: <span class="phpdocumentor-signature__argument__return-type">string</span>
1201+
</dt>
1202+
<dd class="phpdocumentor-argument-list__definition">
1203+
<section class="phpdocumentor-description"><p>The resource token for the invoiceId.
1204+
This token can be retrieved from the Bitpay's invoice object.</p>
1205+
</section>
1206+
11971207
</dd>
11981208
</dl>
11991209

@@ -1409,7 +1419,7 @@ <h4 class="phpdocumentor-element__name" id="method_validateBuyerEmailAndSms">
14091419
<aside class="phpdocumentor-element-found-in">
14101420
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/InvoiceClient.php"><a href="files/src-bitpaysdk-client-invoiceclient.html"><abbr title="src/BitPaySDK/Client/InvoiceClient.php">InvoiceClient.php</abbr></a></abbr>
14111421
:
1412-
<span class="phpdocumentor-element-found-in__line">369</span>
1422+
<span class="phpdocumentor-element-found-in__line">371</span>
14131423

14141424
</aside>
14151425

@@ -1482,7 +1492,7 @@ <h4 class="phpdocumentor-element__name" id="method_validateSmsCode">
14821492
<aside class="phpdocumentor-element-found-in">
14831493
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/InvoiceClient.php"><a href="files/src-bitpaysdk-client-invoiceclient.html"><abbr title="src/BitPaySDK/Client/InvoiceClient.php">InvoiceClient.php</abbr></a></abbr>
14841494
:
1485-
<span class="phpdocumentor-element-found-in__line">387</span>
1495+
<span class="phpdocumentor-element-found-in__line">389</span>
14861496

14871497
</aside>
14881498

docs/classes/BitPaySDK-Client-RefundClient.html

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ <h4 class="phpdocumentor-element__name" id="method_cancel">
453453
<aside class="phpdocumentor-element-found-in">
454454
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/RefundClient.php"><a href="files/src-bitpaysdk-client-refundclient.html"><abbr title="src/BitPaySDK/Client/RefundClient.php">RefundClient.php</abbr></a></abbr>
455455
:
456-
<span class="phpdocumentor-element-found-in__line">290</span>
456+
<span class="phpdocumentor-element-found-in__line">292</span>
457457

458458
</aside>
459459

@@ -531,7 +531,7 @@ <h4 class="phpdocumentor-element__name" id="method_cancelByGuid">
531531
<aside class="phpdocumentor-element-found-in">
532532
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/RefundClient.php"><a href="files/src-bitpaysdk-client-refundclient.html"><abbr title="src/BitPaySDK/Client/RefundClient.php">RefundClient.php</abbr></a></abbr>
533533
:
534-
<span class="phpdocumentor-element-found-in__line">318</span>
534+
<span class="phpdocumentor-element-found-in__line">320</span>
535535

536536
</aside>
537537

@@ -1059,15 +1059,15 @@ <h4 class="phpdocumentor-element__name" id="method_sendNotification">
10591059
<aside class="phpdocumentor-element-found-in">
10601060
<abbr class="phpdocumentor-element-found-in__file" title="src/BitPaySDK/Client/RefundClient.php"><a href="files/src-bitpaysdk-client-refundclient.html"><abbr title="src/BitPaySDK/Client/RefundClient.php">RefundClient.php</abbr></a></abbr>
10611061
:
1062-
<span class="phpdocumentor-element-found-in__line">266</span>
1062+
<span class="phpdocumentor-element-found-in__line">268</span>
10631063

10641064
</aside>
10651065

10661066
<p class="phpdocumentor-summary">Send a refund notification.</p>
10671067

10681068
<code class="phpdocumentor-code phpdocumentor-signature ">
10691069
<span class="phpdocumentor-signature__visibility">public</span>
1070-
<span class="phpdocumentor-signature__name">sendNotification</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$refundId</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
1070+
<span class="phpdocumentor-signature__name">sendNotification</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$refundId</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$refundToken</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
10711071

10721072
<div class="phpdocumentor-label-line">
10731073
</div>
@@ -1083,6 +1083,16 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
10831083
<section class="phpdocumentor-description"><p>A BitPay refund ID.</p>
10841084
</section>
10851085

1086+
</dd>
1087+
<dt class="phpdocumentor-argument-list__entry">
1088+
<span class="phpdocumentor-signature__argument__name">$refundToken</span>
1089+
: <span class="phpdocumentor-signature__argument__return-type">string</span>
1090+
</dt>
1091+
<dd class="phpdocumentor-argument-list__definition">
1092+
<section class="phpdocumentor-description"><p>The resource token for the refundId.
1093+
This token can be retrieved from the Bitpay's refund object.</p>
1094+
</section>
1095+
10861096
</dd>
10871097
</dl>
10881098

0 commit comments

Comments
 (0)