From 535421a7738a9d789b00f3a27b7a53dfaba50165 Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Tue, 7 May 2024 20:41:14 +0000 Subject: [PATCH] Update phpdoc --- docs/classes/BitPaySDK-Client-BillClient.html | 8 +- docs/classes/BitPaySDK-Client.html | 16 ++-- docs/classes/BitPaySDK-Env.html | 4 +- ...BitPaySDK-Model-Invoice-MinerFeesItem.html | 14 +-- .../BitPaySDK-Model-Invoice-Refund.html | 4 +- ...tPaySDK-Model-Payout-PayoutRecipients.html | 4 +- docs/classes/BitPaySDK-PosClient.html | 95 +++++++++++-------- docs/classes/BitPaySDK-Tokens.html | 4 +- .../BitPaySDK-Util-RESTcli-RESTcli.html | 16 ++-- 9 files changed, 93 insertions(+), 72 deletions(-) diff --git a/docs/classes/BitPaySDK-Client-BillClient.html b/docs/classes/BitPaySDK-Client-BillClient.html index d9663cd8..60ee1bbb 100644 --- a/docs/classes/BitPaySDK-Client-BillClient.html +++ b/docs/classes/BitPaySDK-Client-BillClient.html @@ -608,7 +608,7 @@

public - get( $billId[,  $facade = Facade::MERCHANT ][,  $signRequest = true ]) : Bill + get(mixed $billId[, mixed $facade = Facade::MERCHANT ][, mixed $signRequest = true ]) : Bill
@@ -617,7 +617,7 @@

Parameters
$billId - : + : mixed

string The id of the bill to retrieve.

@@ -626,7 +626,7 @@
Parameters
$facade - : + : mixed = Facade::MERCHANT

string The facade used to retrieve it.

@@ -635,7 +635,7 @@
Parameters
$signRequest - : + : mixed = true

bool Signed request.

diff --git a/docs/classes/BitPaySDK-Client.html b/docs/classes/BitPaySDK-Client.html index 4341b207..b7a482db 100644 --- a/docs/classes/BitPaySDK-Client.html +++ b/docs/classes/BitPaySDK-Client.html @@ -2082,7 +2082,7 @@

public - getBill( $billId[,  $facade = Facade::MERCHANT ][,  $signRequest = true ]) : Bill + getBill(mixed $billId[, mixed $facade = Facade::MERCHANT ][, mixed $signRequest = true ]) : Bill
@@ -2091,7 +2091,7 @@

Parameters
$billId - : + : mixed

string The id of the bill to retrieve.

@@ -2100,7 +2100,7 @@
Parameters
$facade - : + : mixed = Facade::MERCHANT

string The facade used to retrieve it.

@@ -2109,7 +2109,7 @@
Parameters
$signRequest - : + : mixed = true

bool Signed request.

@@ -3817,7 +3817,7 @@

public - getSettlements( $currency,  $dateStart,  $dateEnd[, string|null $status = null ][, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, Settlement> + getSettlements(mixed $currency, mixed $dateStart, mixed $dateEnd[, string|null $status = null ][, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, Settlement>
@@ -3829,7 +3829,7 @@

Parameters
$currency - : + : mixed

string The three digit currency string for the ledger to retrieve.

@@ -3838,7 +3838,7 @@
Parameters
$dateStart - : + : mixed

string The start date for the query.

@@ -3847,7 +3847,7 @@
Parameters
$dateEnd - : + : mixed

string The end date for the query.

diff --git a/docs/classes/BitPaySDK-Env.html b/docs/classes/BitPaySDK-Env.html index 0eabc296..6dc4c687 100644 --- a/docs/classes/BitPaySDK-Env.html +++ b/docs/classes/BitPaySDK-Env.html @@ -213,7 +213,7 @@

BITPAY_PLUGIN_INFO -  = "BitPay_PHP_Client_v9.0.1" +  = "BitPay_PHP_Client_v9.0.2"
@@ -360,7 +360,7 @@

public mixed BITPAY_PLUGIN_INFO - = "BitPay_PHP_Client_v9.0.1" + = "BitPay_PHP_Client_v9.0.2" diff --git a/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html b/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html index ec54b108..d543aeb0 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html +++ b/docs/classes/BitPaySDK-Model-Invoice-MinerFeesItem.html @@ -226,7 +226,7 @@

$satoshisPerByte -  : int|null +  : float|null
@@ -258,7 +258,7 @@

getSatoshisPerByte() -  : int|null +  : float|null
@@ -364,7 +364,7 @@

protected - int|null + float|null $satoshisPerByte = null @@ -501,7 +501,7 @@

public - getSatoshisPerByte() : int|null + getSatoshisPerByte() : float|null
@@ -511,7 +511,7 @@

Return values
- int|null + float|null
@@ -612,7 +612,7 @@

public - setSatoshisPerByte(int $satoshisPerByte) : void + setSatoshisPerByte(float $satoshisPerByte) : void
@@ -621,7 +621,7 @@

Parameters
$satoshisPerByte - : int + : float
diff --git a/docs/classes/BitPaySDK-Model-Invoice-Refund.html b/docs/classes/BitPaySDK-Model-Invoice-Refund.html index 41f17102..5e5e7c68 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-Refund.html +++ b/docs/classes/BitPaySDK-Model-Invoice-Refund.html @@ -2888,7 +2888,9 @@
Parameters
: string
- +

: void

+
+

diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html b/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html index 3926a80f..c8ca1078 100644 --- a/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html +++ b/docs/classes/BitPaySDK-Model-Payout-PayoutRecipients.html @@ -443,7 +443,7 @@

public - __construct([ $recipients = [] ]) : mixed + __construct([mixed $recipients = [] ]) : mixed
@@ -452,7 +452,7 @@

Parameters
$recipients - : + : mixed = []

array array of JSON objects, with containing the following parameters.

diff --git a/docs/classes/BitPaySDK-PosClient.html b/docs/classes/BitPaySDK-PosClient.html index b8b594b7..54d6b06e 100644 --- a/docs/classes/BitPaySDK-PosClient.html +++ b/docs/classes/BitPaySDK-PosClient.html @@ -213,13 +213,13 @@

- $RESTcli + $restCli  : RESTcli
- $restCli + $RESTcli  : RESTcli
@@ -245,11 +245,11 @@

- __construct() + __construct()  : mixed
-
Client constructor.
+
Constructor for the BitPay SDK to use with the POS facade.
cancelInvoice() @@ -740,17 +740,17 @@

-protected " > -

- $RESTcli - +

+ $restCli +

@@ -758,7 +758,7 @@

protected RESTcli - $RESTcli + $restCli @@ -773,17 +773,17 @@

-protected " > -

- $restCli - +

+ $RESTcli +

@@ -791,7 +791,7 @@

protected RESTcli - $restCli + $RESTcli @@ -881,21 +881,21 @@

>

__construct() - +

-

Client constructor.

+

Constructor for the BitPay SDK to use with the POS facade.

public - __construct(RESTcli $restCli, Tokens $tokenCache) : mixed + __construct(mixed $token[, string|null $environment = null ]) : mixed
@@ -903,22 +903,41 @@

Parameters
- $restCli - : RESTcli + $token + : mixed
- +

string The token generated on the BitPay account.

+
+
- $tokenCache - : Tokens -
+ $environment + : string|null + = null
- +

string The target environment [Default: Production].

+
+
+
+ Tags + + +
+
+
+ throws +
+
+ BitPayGenericException + + +
+
@@ -2216,7 +2235,7 @@

public - getBill( $billId[,  $facade = Facade::MERCHANT ][,  $signRequest = true ]) : Bill + getBill(mixed $billId[, mixed $facade = Facade::MERCHANT ][, mixed $signRequest = true ]) : Bill
@@ -2225,7 +2244,7 @@

Parameters
$billId - : + : mixed

string The id of the bill to retrieve.

@@ -2234,7 +2253,7 @@
Parameters
$facade - : + : mixed = Facade::MERCHANT

string The facade used to retrieve it.

@@ -2243,7 +2262,7 @@
Parameters
$signRequest - : + : mixed = true

bool Signed request.

@@ -4014,7 +4033,7 @@

public - getSettlements( $currency,  $dateStart,  $dateEnd[, string|null $status = null ][, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, Settlement> + getSettlements(mixed $currency, mixed $dateStart, mixed $dateEnd[, string|null $status = null ][, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, Settlement>
@@ -4026,7 +4045,7 @@

Parameters
$currency - : + : mixed

string The three digit currency string for the ledger to retrieve.

@@ -4035,7 +4054,7 @@
Parameters
$dateStart - : + : mixed

string The start date for the query.

@@ -4044,7 +4063,7 @@
Parameters
$dateEnd - : + : mixed

string The end date for the query.

@@ -5988,8 +6007,8 @@
Return values
  • @@ -5998,7 +6017,7 @@
    Return values
  • Methods
    • -
    • __construct()
      • +
    • __construct()
    • cancelInvoice()
    • cancelInvoiceByGuid()
    • cancelPayout()
      • diff --git a/docs/classes/BitPaySDK-Tokens.html b/docs/classes/BitPaySDK-Tokens.html index 16dafd8e..76e1fcd9 100644 --- a/docs/classes/BitPaySDK-Tokens.html +++ b/docs/classes/BitPaySDK-Tokens.html @@ -501,7 +501,7 @@

      public - getTokenByFacade( $facade) : string|null + getTokenByFacade(mixed $facade) : string|null
      @@ -510,7 +510,7 @@

      Parameters
      $facade - : + : mixed
      diff --git a/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html b/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html index 16f4673c..45098521 100644 --- a/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html +++ b/docs/classes/BitPaySDK-Util-RESTcli-RESTcli.html @@ -586,7 +586,7 @@

      public - delete( $uri[, array<string|int, mixed>|null $parameters = null ]) : string + delete(mixed $uri[, array<string|int, mixed>|null $parameters = null ]) : string
      @@ -595,7 +595,7 @@

      Parameters
      $uri - : + : mixed
      @@ -662,7 +662,7 @@

      public - get( $uri[, array<string|int, mixed>|null $parameters = null ][, bool $signatureRequired = true ]) : string + get(mixed $uri[, array<string|int, mixed>|null $parameters = null ][, bool $signatureRequired = true ]) : string
      @@ -671,7 +671,7 @@

      Parameters
      $uri - : + : mixed
      @@ -857,7 +857,7 @@

      public - post( $uri[, array<string|int, mixed> $formData = [] ][, bool $signatureRequired = true ]) : string + post(mixed $uri[, array<string|int, mixed> $formData = [] ][, bool $signatureRequired = true ]) : string
      @@ -866,7 +866,7 @@

      Parameters
      $uri - : + : mixed
      @@ -944,7 +944,7 @@

      public - update( $uri[, array<string|int, mixed> $formData = [] ]) : string + update(mixed $uri[, array<string|int, mixed> $formData = [] ]) : string
      @@ -953,7 +953,7 @@

      Parameters
      $uri - : + : mixed