Skip to content

Commit 28a1551

Browse files
author
GitHub Actions
committed
Update phpdoc
1 parent 258cf51 commit 28a1551

File tree

78 files changed

+3029
-3912
lines changed

Some content is hidden

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

78 files changed

+3029
-3912
lines changed

‎docs/classes/BitPaySDK-Client-BillClient.html‎

Lines changed: 26 additions & 31 deletions
Large diffs are not rendered by default.

‎docs/classes/BitPaySDK-Client-InvoiceClient.html‎

Lines changed: 43 additions & 48 deletions
Large diffs are not rendered by default.

‎docs/classes/BitPaySDK-Client-LedgerClient.html‎

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -184,10 +184,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
184184
</dd>
185185
</dl>
186186

187-
188-
189-
190-
187+
188+
191189
<h3 id="toc">
192190
Table of Contents
193191
<a href="classes/BitPaySDK-Client-LedgerClient.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
@@ -307,9 +305,8 @@ <h4 class="phpdocumentor-element__name" id="property_instance">
307305

308306

309307

310-
311-
312-
308+
309+
313310

314311
</article>
315312
<article
@@ -345,9 +342,8 @@ <h4 class="phpdocumentor-element__name" id="property_restCli">
345342

346343

347344

348-
349-
350-
345+
346+
351347

352348
</article>
353349
<article
@@ -383,9 +379,8 @@ <h4 class="phpdocumentor-element__name" id="property_tokenCache">
383379

384380

385381

386-
387-
388-
382+
383+
389384

390385
</article>
391386
</section>
@@ -480,8 +475,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
480475
</dd>
481476
</dl>
482477

478+
483479

484-
485480
<section>
486481
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
487482
<span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/BitPaySDK-Model-Ledger-LedgerEntry.html"><abbr title="\BitPaySDK\Model\Ledger\LedgerEntry">LedgerEntry</abbr></a>&gt;</span>
@@ -540,8 +535,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
540535

541536

542537

538+
543539

544-
545540
<section>
546541
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
547542
<span class="phpdocumentor-signature__response_type">static</span>
@@ -602,8 +597,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
602597
</dd>
603598
</dl>
604599

600+
605601

606-
607602
<section>
608603
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
609604
<span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/BitPaySDK-Model-Ledger-Ledger.html"><abbr title="\BitPaySDK\Model\Ledger\Ledger">Ledger</abbr></a>&gt;</span>
@@ -661,8 +656,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
661656

662657

663658

659+
664660

665-
666661

667662
</article>
668663
</section>

‎docs/classes/BitPaySDK-Client-PayoutClient.html‎

Lines changed: 25 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -184,10 +184,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
184184
</dd>
185185
</dl>
186186

187-
188-
189-
190-
187+
188+
191189
<h3 id="toc">
192190
Table of Contents
193191
<a href="classes/BitPaySDK-Client-PayoutClient.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
@@ -347,9 +345,8 @@ <h4 class="phpdocumentor-element__name" id="property_instance">
347345

348346

349347

350-
351-
352-
348+
349+
353350

354351
</article>
355352
<article
@@ -385,9 +382,8 @@ <h4 class="phpdocumentor-element__name" id="property_restCli">
385382

386383

387384

388-
389-
390-
385+
386+
391387

392388
</article>
393389
<article
@@ -423,9 +419,8 @@ <h4 class="phpdocumentor-element__name" id="property_tokenCache">
423419

424420

425421

426-
427-
428-
422+
423+
429424

430425
</article>
431426
</section>
@@ -502,8 +497,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
502497
</dd>
503498
</dl>
504499

500+
505501

506-
507502
<section>
508503
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
509504
<span class="phpdocumentor-signature__response_type">bool</span>
@@ -573,8 +568,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
573568
</dd>
574569
</dl>
575570

571+
576572

577-
578573
<section>
579574
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
580575
<span class="phpdocumentor-signature__response_type"><a href="classes/BitPaySDK-Model-Payout-PayoutGroup.html"><abbr title="\BitPaySDK\Model\Payout\PayoutGroup">PayoutGroup</abbr></a></span>
@@ -644,8 +639,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
644639
</dd>
645640
</dl>
646641

642+
647643

648-
649644
<section>
650645
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
651646
<span class="phpdocumentor-signature__response_type"><a href="classes/BitPaySDK-Model-Payout-PayoutGroup.html"><abbr title="\BitPaySDK\Model\Payout\PayoutGroup">PayoutGroup</abbr></a></span>
@@ -719,8 +714,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
719714
</dd>
720715
</dl>
721716

717+
722718

723-
724719
<section>
725720
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
726721
<span class="phpdocumentor-signature__response_type"><a href="classes/BitPaySDK-Model-Payout-Payout.html"><abbr title="\BitPaySDK\Model\Payout\Payout">Payout</abbr></a></span>
@@ -775,8 +770,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
775770

776771

777772

773+
778774

779-
780775
<section>
781776
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
782777
<span class="phpdocumentor-signature__response_type">static</span>
@@ -805,7 +800,7 @@ <h4 class="phpdocumentor-element__name" id="method_getPayouts">
805800

806801
<code class="phpdocumentor-code phpdocumentor-signature ">
807802
<span class="phpdocumentor-signature__visibility">public</span>
808-
<span class="phpdocumentor-signature__name">getPayouts</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startDate</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$endDate</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$status</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$reference</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limit</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$offset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/BitPaySDK-Model-Payout-Payout.html"><abbr title="\BitPaySDK\Model\Payout\Payout">Payout</abbr></a>&gt;</span></code>
803+
<span class="phpdocumentor-signature__name">getPayouts</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$startDate</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$endDate</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$status</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$reference</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$limit</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$offset</span><span> = </span><span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/BitPaySDK-Model-Payout-Payout.html"><abbr title="\BitPaySDK\Model\Payout\Payout">Payout</abbr></a>&gt;</span></code>
809804

810805
<div class="phpdocumentor-label-line">
811806
</div>
@@ -816,7 +811,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
816811
<dt class="phpdocumentor-argument-list__entry">
817812
<span class="phpdocumentor-signature__argument__name">$startDate</span>
818813
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
819-
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
814+
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span> </dt>
820815
<dd class="phpdocumentor-argument-list__definition">
821816
<section class="phpdocumentor-description"><p>The start date to filter the Payout Batches.</p>
822817
</section>
@@ -825,7 +820,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
825820
<dt class="phpdocumentor-argument-list__entry">
826821
<span class="phpdocumentor-signature__argument__name">$endDate</span>
827822
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
828-
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
823+
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span> </dt>
829824
<dd class="phpdocumentor-argument-list__definition">
830825
<section class="phpdocumentor-description"><p>The end date to filter the Payout Batches.</p>
831826
</section>
@@ -834,7 +829,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
834829
<dt class="phpdocumentor-argument-list__entry">
835830
<span class="phpdocumentor-signature__argument__name">$status</span>
836831
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
837-
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
832+
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span> </dt>
838833
<dd class="phpdocumentor-argument-list__definition">
839834
<section class="phpdocumentor-description"><p>The status to filter the Payout Batches.</p>
840835
</section>
@@ -843,7 +838,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
843838
<dt class="phpdocumentor-argument-list__entry">
844839
<span class="phpdocumentor-signature__argument__name">$reference</span>
845840
: <span class="phpdocumentor-signature__argument__return-type">string|null</span>
846-
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
841+
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span> </dt>
847842
<dd class="phpdocumentor-argument-list__definition">
848843
<section class="phpdocumentor-description"><p>The optional reference specified at payout request creation.</p>
849844
</section>
@@ -852,7 +847,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
852847
<dt class="phpdocumentor-argument-list__entry">
853848
<span class="phpdocumentor-signature__argument__name">$limit</span>
854849
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
855-
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
850+
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span> </dt>
856851
<dd class="phpdocumentor-argument-list__definition">
857852
<section class="phpdocumentor-description"><p>Maximum results that the query will return (useful for paging results).</p>
858853
</section>
@@ -861,7 +856,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
861856
<dt class="phpdocumentor-argument-list__entry">
862857
<span class="phpdocumentor-signature__argument__name">$offset</span>
863858
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
864-
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
859+
= <span class="phpdocumentor-signature__argument__default-value"><abbr title="\BitPaySDK\Client\null">null</abbr></span> </dt>
865860
<dd class="phpdocumentor-argument-list__definition">
866861
<section class="phpdocumentor-description"><p>Number of results to offset (ex. skip 10 will give you results
867862
starting with the 11th result).</p>
@@ -895,8 +890,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
895890
</dd>
896891
</dl>
897892

893+
898894

899-
900895
<section>
901896
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
902897
<span class="phpdocumentor-signature__response_type">array&lt;string|int, <a href="classes/BitPaySDK-Model-Payout-Payout.html"><abbr title="\BitPaySDK\Model\Payout\Payout">Payout</abbr></a>&gt;</span>
@@ -969,8 +964,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
969964
</dd>
970965
</dl>
971966

967+
972968

973-
974969
<section>
975970
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
976971
<span class="phpdocumentor-signature__response_type">bool</span>
@@ -1043,8 +1038,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
10431038
</dd>
10441039
</dl>
10451040

1041+
10461042

1047-
10481043
<section>
10491044
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
10501045
<span class="phpdocumentor-signature__response_type"><a href="classes/BitPaySDK-Model-Payout-Payout.html"><abbr title="\BitPaySDK\Model\Payout\Payout">Payout</abbr></a></span>
@@ -1098,8 +1093,8 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
10981093

10991094

11001095

1096+
11011097

1102-
11031098

11041099
</article>
11051100
<article
@@ -1166,8 +1161,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
11661161
</dd>
11671162
</dl>
11681163

1164+
11691165

1170-
11711166
<section>
11721167
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
11731168
<span class="phpdocumentor-signature__response_type"><a href="classes/BitPaySDK-Model-Payout-PayoutGroup.html"><abbr title="\BitPaySDK\Model\Payout\PayoutGroup">PayoutGroup</abbr></a></span>

0 commit comments

Comments
 (0)