diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 188bf6ba..437f8b1e 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -3,7 +3,7 @@ name: Documentation on: push: branches: - - master + - '*.*.x' concurrency: group: documentation diff --git a/README.md b/README.md index b7a83964..f65055d4 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Full implementation of the BitPay Payment Gateway. This library implements BitPa ## Getting Started -To get up and running with our PHP library quickly, follow [the guide](https://bitpay.readme.io/reference/php-full-sdk-getting-started) +To get up and running with our PHP library quickly, follow [the guide](https://developer.bitpay.com/reference/php-full-sdk-getting-started) ## Support @@ -18,7 +18,7 @@ To get up and running with our PHP library quickly, follow [the guide](https://b ### Requirements -- PHP version: 8.0 / 8.1 / 8.2 +- PHP version: 8.1 / 8.2 / 8.3 - PHP extensions: json, reflection ## Unit Tests diff --git a/docs/classes/BitPaySDK-Client-BillClient.html b/docs/classes/BitPaySDK-Client-BillClient.html index 5ff27700..d9663cd8 100644 --- a/docs/classes/BitPaySDK-Client-BillClient.html +++ b/docs/classes/BitPaySDK-Client-BillClient.html @@ -54,7 +54,7 @@

Bit Menu

-public " > -

- getStatus() - +

+ setImmediate() +

public - getStatus() : string + setImmediate(bool|null $immediate) : void
- - +
Parameters
+
+
+ $immediate + : bool|null +
+
+ +
+
-
-
Return values
- string -
+ +
Return values -public " > -

- getSupportRequest() - +

+ setInvoice() +

public - getSupportRequest() : string + setInvoice(string|null $invoice) : void
+
Parameters
+
+
+ $invoice + : string|null +
+
+ +
+
+ + + +
+
+

+ setLastRefundNotification() + + +

+ + + + public + setLastRefundNotification(string|null $lastRefundNotification) : void -
-
Return values
- string -
+
+
+ +
Parameters
+
+
+ $lastRefundNotification + : string|null +
+
+ +
+
+ + +
Return values -public " > -

- setAmount() - +

+ setReference() +

public - setAmount(float $amount) : void + setReference(string|null $reference) : void
@@ -1265,8 +2246,8 @@

Parameters
- $amount - : float + $reference + : string|null
@@ -1283,22 +2264,22 @@
Parameters
-public " > -

- setBuyerPaysRefundFee() - +

+ setRefundAddress() +

public - setBuyerPaysRefundFee(bool $buyerPaysRefundFee) : void + setRefundAddress(string|null $refundAddress) : void
@@ -1306,8 +2287,8 @@

Parameters
- $buyerPaysRefundFee - : bool + $refundAddress + : string|null
@@ -1324,22 +2305,22 @@
Parameters
-public " > -

- setCurrency() - +

+ setRefundFee() +

public - setCurrency(string $currency) : void + setRefundFee(float|null $refundFee) : void
@@ -1347,8 +2328,8 @@

Parameters
- $currency - : string + $refundFee + : float|null
@@ -1365,22 +2346,22 @@
Parameters
-public " > -

- setId() - +

+ setRequestDate() +

public - setId(string $id) : void + setRequestDate(string|null $requestDate) : void
@@ -1388,8 +2369,8 @@

Parameters
- $id - : string + $requestDate + : string|null
@@ -1406,22 +2387,22 @@
Parameters
-public " > -

- setImmediate() - +

+ setStatus() +

public - setImmediate(bool $immediate) : void + setStatus(string|null $status) : void
@@ -1429,8 +2410,8 @@

Parameters
- $immediate - : bool + $status + : string|null
@@ -1447,22 +2428,22 @@
Parameters
-public " > -

- setInvoice() - +

+ setSupportRequest() +

public - setInvoice(string $invoice) : void + setSupportRequest(string|null $supportRequest) : void
@@ -1470,8 +2451,8 @@

Parameters
- $invoice - : string + $supportRequest + : string|null
@@ -1488,22 +2469,22 @@
Parameters
-public " > -

- setLastRefundNotification() - +

+ setTransactionAmount() +

public - setLastRefundNotification(string $lastRefundNotification) : void + setTransactionAmount(float|null $transactionAmount) : void
@@ -1511,8 +2492,8 @@

Parameters
- $lastRefundNotification - : string + $transactionAmount + : float|null
@@ -1529,22 +2510,22 @@
Parameters
-public " > -

- setRefundFee() - +

+ setTransactionCurrency() +

public - setRefundFee(float $refundFee) : void + setTransactionCurrency(string|null $transactionCurrency) : void
@@ -1552,8 +2533,8 @@

Parameters
- $refundFee - : float + $transactionCurrency + : string|null
@@ -1570,22 +2551,22 @@
Parameters
-public " > -

- setRequestDate() - +

+ setTransactionRefundFee() +

public - setRequestDate(string $requestDate) : void + setTransactionRefundFee(float|null $transactionRefundFee) : void
@@ -1593,8 +2574,8 @@

Parameters
- $requestDate - : string + $transactionRefundFee + : float|null
@@ -1611,22 +2592,22 @@
Parameters
-public " > -

- setStatus() - +

+ setTxid() +

public - setStatus(string $status) : void + setTxid(string|null $txid) : void
@@ -1634,8 +2615,8 @@

Parameters
- $status - : string + $txid + : string|null
@@ -1652,22 +2633,22 @@
Parameters
-public " > -

- setSupportRequest() - +

+ setType() +

public - setSupportRequest(string $supportRequest) : void + setType(string|null $type) : void
@@ -1675,8 +2656,8 @@

Parameters
- $supportRequest - : string + $type + : string|null
@@ -1701,7 +2682,7 @@

@@ -1838,43 +2819,66 @@

Return values
  • $amount
  • $buyerPaysRefundFee
  • $currency
    • +
  • $guid
  • $id
  • $immediate
  • $invoice
  • $lastRefundNotification
    • +
  • $reference
    • +
  • $refundAddress
  • $refundFee
  • $requestDate
  • $status
  • $supportRequest
    • +
  • $transactionAmount
    • +
  • $transactionCurrency
    • +
  • $transactionRefundFee
    • +
  • $txid
    • +
  • $type
  • Methods
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-Shopper.html b/docs/classes/BitPaySDK-Model-Invoice-Shopper.html index 768f45b7..d52e1853 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-Shopper.html +++ b/docs/classes/BitPaySDK-Model-Invoice-Shopper.html @@ -54,7 +54,7 @@

    Bit Menu

    - - -
    -

    - Methods - - -

    -

    - __construct() - +

    + $ltc + + +

    -

    SupportedTransactionCurrencies constructor.

    - + - public - __construct() : mixed + protected + SupportedTransactionCurrency + $ltc + -
    -
    -
    + class=" + phpdocumentor-element + -property + -protected + " +> +

    + $matic + + + + +

    + + + + + protected + SupportedTransactionCurrency + $matic + + + + + + +
    +
    +

    + $maticE + + + + +

    + + + + + protected + SupportedTransactionCurrency + $maticE + + + + + + +
    +
    +

    + $pax + + + + +

    + + + + + protected + SupportedTransactionCurrency + $pax + + + + + + +
    +
    +

    + $shibM + + + + +

    + + + + + protected + SupportedTransactionCurrency + $shibM + + + + + + +
    +
    +

    + $usdc + + + + +

    + + + + + protected + SupportedTransactionCurrency + $usdc + + + + + + +
    +
    +

    + $usdcM + + + + +

    + + + + + protected + SupportedTransactionCurrency + $usdcM + + + + + + +
    +
    +

    + $wbtc + + + + +

    + + + + + protected + SupportedTransactionCurrency + $wbtc + + + + + + +
    +
    +

    + $wbtcM + + + + +

    + + + + + protected + SupportedTransactionCurrency + $wbtcM + + + + + + +
    +
    +

    + $xrp + + + + +

    + + + + + protected + SupportedTransactionCurrency + $xrp + + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    SupportedTransactionCurrencies constructor.

    + + + public + __construct() : mixed + +
    +
    + + + + + +
    +

    getBCH() @@ -890,15 +1422,555 @@

    + +

    Gets BCH.

    + + + public + getBCH() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +

    +
    +

    + getBTC() + + +

    + + +

    Gets BTC.

    + + + public + getBTC() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getBUSD() + + +

    + + +

    Gets BUSD.

    + + + public + getBUSD() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getBusdM() + + +

    + + +

    Gets BUSD_m.

    + + + public + getBusdM() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getDAI() + + +

    + + +

    Gets DAI.

    + + + public + getDAI() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getDaiM() + + +

    + + +

    Gets DAI_m.

    + + + public + getDaiM() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getDOGE() + + +

    + + +

    Gets DOGE.

    + + + public + getDOGE() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getETH() + + +

    + + +

    Gets ETH.

    + + + public + getETH() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getEthM() + + +

    + + +

    Gets ETC_m.

    + + + public + getEthM() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getEUROC() + + +

    + + +

    Gets EUROC.

    + + + public + getEUROC() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getGUSD() + + +

    + + +

    Gets GUSD.

    + + + public + getGUSD() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getLTC() + + +

    + + +

    Gets LTC.

    + + + public + getLTC() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getMATIC() + + +

    + + +

    Gets MATIC.

    + + + public + getMATIC() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getMaticE() + + +

    + + +

    Gets MATIC_e

    + + + public + getMaticE() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getPAX() + + +

    + + +

    Gets PAX.

    + + + public + getPAX() : SupportedTransactionCurrency + +
    +
    + + + + +
    +
    Return values
    + SupportedTransactionCurrency +
    + +
    +
    +

    + getShibM() + + +

    + -

    Gets BCH.

    +

    Gets SHIB_m.

    public - getBCH() : SupportedTransactionCurrency + getShibM() : SupportedTransactionCurrency
    @@ -918,23 +1990,23 @@
    Return values
    -public " > -

    - getBTC() - +

    + getUSDC() +

    -

    Gets BTC.

    +

    Gets USDC.

    public - getBTC() : SupportedTransactionCurrency + getUSDC() : SupportedTransactionCurrency
    @@ -954,23 +2026,23 @@
    Return values
    -public " > -

    - getBUSD() - +

    + getUsdcM() +

    -

    Gets BUSD.

    +

    Gets USDC_m.

    public - getBUSD() : SupportedTransactionCurrency + getUsdcM() : SupportedTransactionCurrency
    @@ -990,23 +2062,23 @@
    Return values
    -public " > -

    - getDOGE() - +

    + getWBTC() +

    -

    Gets DOGE.

    +

    Gets WBTC.

    public - getDOGE() : SupportedTransactionCurrency + getWBTC() : SupportedTransactionCurrency
    @@ -1026,23 +2098,23 @@
    Return values
    -public " > -

    - getETH() - +

    + getWbtcM() +

    -

    Gets ETH.

    +

    Gets WBTC_m.

    public - getETH() : SupportedTransactionCurrency + getWbtcM() : SupportedTransactionCurrency
    @@ -1062,23 +2134,23 @@
    Return values
    -public " > -

    - getGUSD() - +

    + getXRP() +

    -

    Gets GUSD.

    +

    Gets XRP.

    public - getGUSD() : SupportedTransactionCurrency + getXRP() : SupportedTransactionCurrency
    @@ -1098,35 +2170,213 @@
    Return values
    -public " > -

    - getLTC() - +

    + setBCH() +

    -

    Gets LTC.

    +

    Sets BCH.

    public - getLTC() : SupportedTransactionCurrency + setBCH(SupportedTransactionCurrency $bch) : void
    +
    Parameters
    +
    +
    + $bch + : SupportedTransactionCurrency +
    +
    +

    the BCH

    +
    + +
    +
    + + +
    +
    +

    + setBTC() + -
    -
    Return values
    - SupportedTransactionCurrency -
    +

    + + +

    Sets BTC.

    + + + public + setBTC(SupportedTransactionCurrency $btc) : void + +
    +
    + +
    Parameters
    +
    +
    + $btc + : SupportedTransactionCurrency +
    +
    +

    the BTC

    +
    + +
    +
    + + + + +
    +
    +

    + setBUSD() + + +

    + + +

    Sets BUSD.

    + + + public + setBUSD(SupportedTransactionCurrency $busd) : void + +
    +
    + +
    Parameters
    +
    +
    + $busd + : SupportedTransactionCurrency +
    +
    + +
    +
    + + + + +
    +
    +

    + setBusdM() + + +

    + + +

    Sets BUSD_m.

    + + + public + setBusdM(SupportedTransactionCurrency $busdM) : void + +
    +
    + +
    Parameters
    +
    +
    + $busdM + : SupportedTransactionCurrency +
    +
    + +
    +
    + + + + +
    +
    +

    + setDAI() + + +

    + + +

    Sets DAI.

    + + + public + setDAI(SupportedTransactionCurrency $dai) : void + +
    +
    + +
    Parameters
    +
    +
    + $dai + : SupportedTransactionCurrency +
    +
    + +
    +
    + + +
    Return values -public " > -

    - getPAX() - +

    + setDaiM() +

    -

    Gets PAX.

    +

    Sets DAI_m.

    public - getPAX() : SupportedTransactionCurrency + setDaiM(SupportedTransactionCurrency $daiM) : void
    - - +
    Parameters
    +
    +
    + $daiM + : SupportedTransactionCurrency +
    +
    + +
    +
    -
    -
    Return values
    - SupportedTransactionCurrency -
    + +
    Return values -public " > -

    - getUSDC() - +

    + setDOGE() +

    -

    Gets USDC.

    +

    Sets DOGE.

    public - getUSDC() : SupportedTransactionCurrency + setDOGE(SupportedTransactionCurrency $doge) : void
    - - +
    Parameters
    +
    +
    + $doge + : SupportedTransactionCurrency +
    +
    + +
    +
    -
    -
    Return values
    - SupportedTransactionCurrency -
    + +
    Return values -public " > -

    - getWBTC() - +

    + setETH() +

    -

    Gets WBTC.

    +

    Sets ETH.

    public - getWBTC() : SupportedTransactionCurrency + setETH(SupportedTransactionCurrency $eth) : void
    - - +
    Parameters
    +
    +
    + $eth + : SupportedTransactionCurrency +
    +
    +

    the ETH

    +
    -
    -
    Return values
    - SupportedTransactionCurrency -
    +
    +
    + + +
    Return values -public " > -

    - getXRP() - +

    + setEthM() +

    -

    Gets XRP.

    +

    Sets ETC_m.

    public - getXRP() : SupportedTransactionCurrency + setEthM(SupportedTransactionCurrency $ethM) : void
    - - +
    Parameters
    +
    +
    + $ethM + : SupportedTransactionCurrency +
    +
    + +
    +
    -
    -
    Return values
    - SupportedTransactionCurrency -
    + +
    Return values -public " > -

    - setBCH() - +

    + setEUROC() +

    -

    Sets BCH.

    +

    Sets EUROC.

    public - setBCH(SupportedTransactionCurrency $bch) : void + setEUROC(SupportedTransactionCurrency $euroc) : void
    @@ -1302,13 +2578,11 @@

    Parameters
    - $bch + $euroc : SupportedTransactionCurrency
    -

    the BCH

    -
    - +
    @@ -1322,23 +2596,23 @@
    Parameters
    -public " > -

    - setBTC() - +

    + setGUSD() +

    -

    Sets BTC.

    +

    Sets GUSD.

    public - setBTC(SupportedTransactionCurrency $btc) : void + setGUSD(SupportedTransactionCurrency $gusd) : void
    @@ -1346,11 +2620,11 @@

    Parameters
    - $btc + $gusd : SupportedTransactionCurrency
    -

    the BTC

    +

    the GUSD

    @@ -1366,23 +2640,23 @@
    Parameters
    -public " > -

    - setBUSD() - +

    + setLTC() +

    -

    Sets BUSD.

    +

    Sets LTC.

    public - setBUSD(SupportedTransactionCurrency $busd) : void + setLTC(SupportedTransactionCurrency $ltc) : void
    @@ -1390,7 +2664,7 @@

    Parameters
    - $busd + $ltc : SupportedTransactionCurrency
    @@ -1408,23 +2682,23 @@
    Parameters
    -public " > -

    - setDOGE() - +

    + setMATIC() +

    -

    Sets DOGE.

    +

    Sets MATIC.

    public - setDOGE(SupportedTransactionCurrency $doge) : void + setMATIC(SupportedTransactionCurrency $matic) : void
    @@ -1432,7 +2706,7 @@

    Parameters
    - $doge + $matic : SupportedTransactionCurrency
    @@ -1450,23 +2724,23 @@
    Parameters
    -public " > -

    - setETH() - +

    + setMaticE() +

    -

    Sets ETH.

    +

    Sets MATIC_e.

    public - setETH(SupportedTransactionCurrency $eth) : void + setMaticE(SupportedTransactionCurrency $maticE) : void
    @@ -1474,13 +2748,11 @@

    Parameters
    - $eth + $maticE : SupportedTransactionCurrency
    -

    the ETH

    -
    - +
    @@ -1494,23 +2766,23 @@
    Parameters
    -public " > -

    - setGUSD() - +

    + setPAX() +

    -

    Sets GUSD.

    +

    Sets PAX.

    public - setGUSD(SupportedTransactionCurrency $gusd) : void + setPAX(SupportedTransactionCurrency $pax) : void
    @@ -1518,11 +2790,11 @@

    Parameters
    - $gusd + $pax : SupportedTransactionCurrency
    -

    the GUSD

    +

    the PAX

    @@ -1538,23 +2810,23 @@
    Parameters
    -public " > -

    - setLTC() - +

    + setShibM() +

    -

    Sets LTC.

    +

    Sets SHIB_m.

    public - setLTC(SupportedTransactionCurrency $ltc) : void + setShibM(SupportedTransactionCurrency $shibM) : void
    @@ -1562,7 +2834,7 @@

    Parameters
    - $ltc + $shibM : SupportedTransactionCurrency
    @@ -1580,23 +2852,23 @@
    Parameters
    -public " > -

    - setPAX() - +

    + setUSDC() +

    -

    Sets PAX.

    +

    Sets USDC.

    public - setPAX(SupportedTransactionCurrency $pax) : void + setUSDC(SupportedTransactionCurrency $usdc) : void
    @@ -1604,11 +2876,11 @@

    Parameters
    - $pax + $usdc : SupportedTransactionCurrency
    -

    the PAX

    +

    the USDC

    @@ -1624,23 +2896,23 @@
    Parameters
    -public " > -

    - setUSDC() - +

    + setUsdcM() +

    -

    Sets USDC.

    +

    Sets USDC_m.

    public - setUSDC(SupportedTransactionCurrency $usdc) : void + setUsdcM(SupportedTransactionCurrency $usdcM) : void
    @@ -1648,13 +2920,11 @@

    Parameters
    - $usdc + $usdcM : SupportedTransactionCurrency
    -

    the USDC

    -
    - +
    @@ -1676,7 +2946,7 @@

    @@ -1703,6 +2973,48 @@

    Parameters
    +
    +
    +

    + setWbtcM() + + +

    + + +

    Sets WBTC_m.

    + + + public + setWbtcM(SupportedTransactionCurrency $wbtcM) : void + +
    +
    + +
    Parameters
    +
    +
    + $wbtcM + : SupportedTransactionCurrency +
    +
    + +
    +
    + + + +
    @@ -1762,7 +3074,7 @@

    @@ -1900,13 +3212,23 @@

    Return values
  • $bch
  • $btc
  • $busd
    • +
  • $busdM
    • +
  • $dai
    • +
  • $daiM
  • $doge
  • $eth
    • +
  • $ethM
    • +
  • $euroc
  • $gusd
  • $ltc
    • +
  • $matic
    • +
  • $maticE
  • $pax
    • +
  • $shibM
  • $usdc
    • +
  • $usdcM
  • $wbtc
    • +
  • $wbtcM
  • $xrp
    • @@ -1918,24 +3240,44 @@
    Return values
  • getBCH()
  • getBTC()
  • getBUSD()
    • +
  • getBusdM()
    • +
  • getDAI()
    • +
  • getDaiM()
  • getDOGE()
  • getETH()
    • +
  • getEthM()
    • +
  • getEUROC()
  • getGUSD()
  • getLTC()
    • +
  • getMATIC()
    • +
  • getMaticE()
  • getPAX()
    • +
  • getShibM()
  • getUSDC()
    • +
  • getUsdcM()
  • getWBTC()
    • +
  • getWbtcM()
  • getXRP()
  • setBCH()
  • setBTC()
  • setBUSD()
    • +
  • setBusdM()
    • +
  • setDAI()
    • +
  • setDaiM()
  • setDOGE()
  • setETH()
    • +
  • setEthM()
    • +
  • setEUROC()
  • setGUSD()
  • setLTC()
    • +
  • setMATIC()
    • +
  • setMaticE()
  • setPAX()
    • +
  • setShibM()
  • setUSDC()
    • +
  • setUsdcM()
  • setWBTC()
    • +
  • setWbtcM()
  • setXRP()
  • toArray()
    • diff --git a/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html b/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html index 73e973b0..cdbe23f0 100644 --- a/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html +++ b/docs/classes/BitPaySDK-Model-Invoice-SupportedTransactionCurrency.html @@ -54,7 +54,7 @@

    Bit Menu

    @@ -1183,7 +1185,7 @@

    public - getCode() : string|null + getCode() : int|null
    @@ -1196,7 +1198,7 @@

    Return values
    - string|null + int|null —

    the code

    @@ -1469,7 +1471,7 @@

    public - getScale() : string|null + getScale() : int|null
    @@ -1481,7 +1483,7 @@

    Return values
    - string|null + int|null —

    the scale

    @@ -1716,7 +1718,7 @@

    public - setAmount(string $amount) : void + setAmount(float $amount) : void
    @@ -1727,7 +1729,7 @@

    Parameters
    $amount - : string + : float

    the amount

    @@ -1806,7 +1808,7 @@

    public - setCode(string $code) : void + setCode(int $code) : void
    @@ -1818,7 +1820,7 @@

    Parameters
    $code - : string + : int

    the code

    @@ -2120,7 +2122,7 @@

    public - setScale(string $scale) : void + setScale(int $scale) : void
    @@ -2131,7 +2133,7 @@

    Parameters
    $scale - : string + : int

    the scale

    diff --git a/docs/classes/BitPaySDK-Model-Payout-Payout.html b/docs/classes/BitPaySDK-Model-Payout-Payout.html index 3cce57ce..4da7004a 100644 --- a/docs/classes/BitPaySDK-Model-Payout-Payout.html +++ b/docs/classes/BitPaySDK-Model-Payout-Payout.html @@ -54,7 +54,7 @@

    Bit Menu

    @@ -252,7 +252,7 @@

    getGuid() -  : string +  : string|null
    Gets guid.
    @@ -266,7 +266,7 @@

    getToken() -  : string +  : string|null
    Gets token.
    @@ -306,6 +306,8 @@

    + +

    Properties @@ -329,16 +331,16 @@

    protected - string + string|null $guid - = '' + = null @@ -362,7 +364,7 @@

    @@ -395,16 +397,16 @@

    protected - string + string|null $token - = '' + = null @@ -433,7 +435,7 @@

    @@ -477,7 +479,7 @@

    @@ -485,7 +487,7 @@

    public - getGuid() : string + getGuid() : string|null
    @@ -495,7 +497,7 @@

    Return values
    - string + string|null
    @@ -513,7 +515,7 @@

    @@ -549,7 +551,7 @@

    @@ -557,7 +559,7 @@

    public - getToken() : string + getToken() : string|null
    @@ -567,7 +569,7 @@

    Return values
    - string + string|null
    @@ -585,7 +587,7 @@

    @@ -627,7 +629,7 @@

    @@ -662,7 +664,7 @@

    throws
    - PayoutRecipientException + BitPayValidationException
    @@ -684,7 +686,7 @@

    @@ -726,7 +728,7 @@

    diff --git a/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html b/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html index 593cc36a..b16d5833 100644 --- a/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html +++ b/docs/classes/BitPaySDK-Model-Payout-PayoutStatus.html @@ -54,7 +54,7 @@

    Bit Menu

    @@ -295,6 +313,12 @@

    Gets image
    +
    + getInvoiceDefault() + +  : string|null +
    +
    getKey() @@ -302,6 +326,12 @@

    Gets A unique identifier for the wallet
    +
    + getOffChainMode() + +  : bool|null +
    +
    getPayPro() @@ -309,6 +339,12 @@

    Gets pay pro
    +
    + getUniCode() + +  : string|null +
    +
    setAvatar() @@ -337,6 +373,12 @@

    Sets image
    +
    + setInvoiceDefault() + +  : void +
    +
    setKey() @@ -344,6 +386,12 @@

    Sets A unique identifier for the wallet
    +
    + setOffChainMode() + +  : void +
    +
    setPayPro() @@ -351,6 +399,12 @@

    Sets pay pro
    +
    + setUniCode() + +  : void +
    +
    toArray() @@ -366,6 +420,8 @@

    + +

    Properties @@ -503,6 +559,39 @@

    + +
    +

    + $invoiceDefault + + + + +

    + + + + + protected + string|null + $invoiceDefault + = null + + + + +
    +
    +
    +

    + $offChainMode + + + + +

    + + + + + protected + bool|null + $offChainMode + = null + + + + +
    +
    +
    +

    + $uniCode + + + + +

    + + + + + protected + string|null + $uniCode + = null + + + + +

    @@ -592,7 +747,7 @@

    @@ -624,7 +779,7 @@

    @@ -666,7 +821,7 @@

    @@ -708,7 +863,7 @@

    @@ -750,7 +905,7 @@

    @@ -777,6 +932,41 @@

    Return values

    + +
    +

    + getInvoiceDefault() + + +

    + + + + + public + getInvoiceDefault() : string|null + +
    +
    + + + + +
    +
    Return values
    + string|null +
    +
    @@ -817,6 +1007,41 @@
    Return values
    + +
    +

    + getOffChainMode() + + +

    + + + + + public + getOffChainMode() : bool|null + +
    +
    + + + + +
    +
    Return values
    + bool|null +
    +
    @@ -859,6 +1084,41 @@
    Return values

    + +
    +

    + getUniCode() + + +

    + + + + + public + getUniCode() : string|null + +
    +
    + + + + +
    +
    Return values
    + string|null +
    +
    +
    +

    + setInvoiceDefault() + + +

    + + + + + public + setInvoiceDefault(string|null $invoiceDefault) : void + +
    +
    + +
    Parameters
    +
    +
    + $invoiceDefault + : string|null +
    +
    + +
    +
    + + + +
    @@ -1087,6 +1388,47 @@
    Parameters
    +
    +
    +

    + setOffChainMode() + + +

    + + + + + public + setOffChainMode(bool|null $offChainMode) : void + +
    +
    + +
    Parameters
    +
    +
    + $offChainMode + : bool|null +
    +
    + +
    +
    + + + +
    @@ -1133,6 +1475,47 @@
    Parameters
    +
    +
    +

    + setUniCode() + + +

    + + + + + public + setUniCode(string|null $uniCode) : void + +
    +
    + +
    Parameters
    +
    +
    + $uniCode + : string|null +
    +
    + +
    +
    + + + +
    @@ -1291,8 +1674,11 @@
    Return values
  • $currencies
  • $displayName
  • $image
    • +
  • $invoiceDefault
  • $key
    • +
  • $offChainMode
  • $payPro
    • +
  • $uniCode
    • @@ -1304,14 +1690,20 @@
    Return values
  • getCurrencies()
  • getDisplayName()
  • getImage()
    • +
  • getInvoiceDefault()
  • getKey()
    • +
  • getOffChainMode()
  • getPayPro()
    • +
  • getUniCode()
  • setAvatar()
  • setCurrencies()
  • setDisplayName()
  • setImage()
    • +
  • setInvoiceDefault()
  • setKey()
    • +
  • setOffChainMode()
  • setPayPro()
    • +
  • setUniCode()
  • toArray()
    • diff --git a/docs/classes/BitPaySDK-PosClient.html b/docs/classes/BitPaySDK-PosClient.html index 315bb679..b8b594b7 100644 --- a/docs/classes/BitPaySDK-PosClient.html +++ b/docs/classes/BitPaySDK-PosClient.html @@ -54,7 +54,7 @@

    Bit Menu

    @@ -955,7 +936,7 @@

    @@ -1009,7 +990,7 @@

    throws
    - InvoiceCancellationException + BitPayApiException
    @@ -1017,7 +998,7 @@
    throws
    - BitPayException + BitPayGenericException
    @@ -1047,7 +1028,7 @@

    @@ -1101,7 +1082,7 @@

    throws
    - InvoiceCancellationException + BitPayApiException
    @@ -1109,7 +1090,7 @@
    throws
    - BitPayException + BitPayGenericException
    @@ -1139,7 +1120,7 @@

    @@ -1186,7 +1167,15 @@

    throws
    - PayoutCancellationException + BitPayGenericException + + +
    +
    + throws +
    +
    + BitPayApiException
    @@ -1212,7 +1201,7 @@

    @@ -1256,7 +1245,15 @@

    throws
    - PayoutCancellationException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -1282,7 +1279,7 @@

    @@ -1329,15 +1326,7 @@

    throws
    - RefundCancellationException - - -
    -
    - throws -
    -
    - BitPayException + BitPayApiException
    @@ -1367,7 +1356,7 @@

    @@ -1414,15 +1403,7 @@

    throws
    - RefundCancellationException - - -
    -
    - throws -
    -
    - BitPayException + BitPayApiException
    @@ -1452,7 +1433,7 @@

    @@ -1517,7 +1498,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -1543,7 +1532,7 @@

    @@ -1608,7 +1597,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -1634,7 +1631,7 @@

    @@ -1678,7 +1675,15 @@

    throws
    - PayoutCreationException + BitPayGenericException + + +
    +
    + throws +
    +
    + BitPayApiException
    @@ -1704,7 +1709,7 @@

    @@ -1806,9 +1811,9 @@

    throws
    - RefundCreationException + BitPayApiException -

    RefundCreationException class

    +

    BitPayException class

    @@ -1816,9 +1821,9 @@
    throws
    - BitPayException + BitPayGenericException -

    BitPayException class

    +

    BitPayGenericException

    @@ -1848,7 +1853,7 @@

    @@ -1922,7 +1927,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -1948,7 +1961,7 @@

    @@ -1985,11 +1998,9 @@

    throws
    - BitPayException + BitPayGenericException -

    BitPayException class

    -
    - +
    @@ -2013,7 +2024,7 @@

    @@ -2060,7 +2071,15 @@

    throws
    - PayoutRecipientCancellationException + BitPayGenericException + + +
    +
    + throws +
    +
    + BitPayApiException
    @@ -2090,7 +2109,7 @@

    @@ -2155,7 +2174,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -2181,7 +2208,7 @@

    @@ -2246,7 +2273,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -2272,7 +2307,7 @@

    @@ -2317,7 +2352,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -2343,7 +2386,7 @@

    @@ -2368,21 +2411,17 @@

    throws
    - CurrencyQueryException + BitPayGenericException -

    CurrencyQueryException class

    -
    - +
    throws
    - BitPayException + BitPayApiException -

    BitPayException class

    -
    - +
    @@ -2410,7 +2449,7 @@

    @@ -2467,7 +2506,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -2497,7 +2544,7 @@

    @@ -2545,7 +2592,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -2575,7 +2630,7 @@

    @@ -2641,7 +2696,15 @@

    throws
    - InvoiceQueryException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -2667,7 +2730,7 @@

    @@ -2734,7 +2797,15 @@

    throws
    - InvoiceQueryException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -2760,7 +2831,7 @@

    @@ -2853,7 +2924,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -2879,7 +2958,7 @@

    @@ -2944,7 +3023,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -2974,7 +3061,7 @@

    @@ -3009,7 +3096,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -3039,7 +3134,7 @@

    @@ -3087,7 +3182,15 @@

    throws
    - PayoutQueryException + BitPayGenericException + + +
    +
    + throws +
    +
    + BitPayApiException
    @@ -3161,7 +3264,7 @@
    throws
    - PayoutQueryException + BitPayGenericException
    @@ -3169,7 +3272,7 @@
    throws
    - PayoutRecipientQueryException + BitPayApiException
    @@ -3195,7 +3298,7 @@

    @@ -3261,7 +3364,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -3287,7 +3398,7 @@

    @@ -3380,7 +3491,15 @@

    throws
    - PayoutQueryException + BitPayGenericException + + +
    +
    + throws +
    +
    + BitPayApiException
    @@ -3406,7 +3525,7 @@

    @@ -3439,7 +3558,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -3465,7 +3592,7 @@

    @@ -3512,7 +3639,7 @@

    throws
    - RefundQueryException + BitPayApiException
    @@ -3520,7 +3647,7 @@
    throws
    - BitPayException + BitPayGenericException
    @@ -3550,7 +3677,7 @@

    @@ -3597,7 +3724,7 @@

    throws
    - BitPayException + BitPayApiException
    @@ -3605,7 +3732,7 @@
    throws
    - RefundQueryException + BitPayGenericException
    @@ -3635,7 +3762,7 @@

    @@ -3682,15 +3809,7 @@

    throws
    - RefundQueryException - - -
    -
    - throws -
    -
    - BitPayException + BitPayApiException
    @@ -3716,7 +3835,7 @@

    @@ -3763,7 +3882,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -3789,7 +3916,7 @@

    Client.php : - 990 + 1005 @@ -3797,7 +3924,7 @@

    public - getSettlementReconciliationReport(Settlement $settlement) : Settlement + getSettlementReconciliationReport(string $settlementId, string $settlementToken) : Settlement
    @@ -3805,11 +3932,20 @@

    Parameters

    - $settlement - : Settlement + $settlementId + : string +
    +
    +

    Settlement ID

    +
    + +
    +
    + $settlementToken + : string
    -

    Settlement to generate report for.

    +

    Settlement Token

    @@ -3836,7 +3972,15 @@
    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -3862,7 +4006,7 @@

    @@ -3957,7 +4101,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -3983,7 +4135,7 @@

    @@ -4018,7 +4170,7 @@

    throws
    - WalletQueryException + BitPayApiException
    @@ -4026,7 +4178,7 @@
    throws
    - BitPayException + BitPayGenericException
    @@ -4052,7 +4204,7 @@

    @@ -4077,7 +4229,7 @@

    throws
    - BitPayException + BitPayApiException
    @@ -4085,7 +4237,7 @@
    throws
    - JsonException + BitPayGenericException
    @@ -4111,7 +4263,7 @@

    @@ -4157,7 +4309,7 @@

    throws
    - InvoicePaymentException + BitPayApiException
    @@ -4165,7 +4317,7 @@
    throws
    - BitPayException + BitPayGenericException
    @@ -4195,7 +4347,7 @@

    @@ -4242,7 +4394,7 @@

    throws
    - InvoiceQueryException + BitPayApiException
    @@ -4250,7 +4402,7 @@
    throws
    - BitPayException + BitPayGenericException
    @@ -4280,7 +4432,7 @@

    @@ -4327,11 +4479,17 @@

    throws
    - PayoutNotificationException + BitPayGenericException -

    BitPayException class

    -
    - + +
    +
    + throws +
    +
    + BitPayApiException + +
    @@ -4355,7 +4513,7 @@

    Client.php : - 807 + 811 @@ -4402,7 +4560,15 @@

    throws
    - PayoutRecipientNotificationException + BitPayGenericException + + +
    +
    + throws +
    +
    + BitPayApiException
    @@ -4432,7 +4598,7 @@

    @@ -4479,15 +4645,7 @@

    throws
    - RefundCreationException - - -
    -
    - throws -
    -
    - BitPayException + BitPayApiException
    @@ -4517,7 +4675,7 @@

    @@ -4564,7 +4722,15 @@

    throws
    - PayoutCreationException + BitPayGenericException + + +
    +
    + throws +
    +
    + BitPayApiException
    @@ -4637,7 +4803,15 @@
    throws
    - PayoutRecipientCreationException + BitPayGenericException + + +
    +
    + throws +
    +
    + BitPayApiException
    @@ -4667,7 +4841,7 @@

    @@ -4723,7 +4897,15 @@

    throws
    - BitPayException + BitPayApiException + + +
    +
    + throws +
    +
    + BitPayGenericException
    @@ -4749,7 +4931,7 @@

    @@ -4832,7 +5014,7 @@

    throws
    - BitPayException + BitPayApiException
    @@ -4840,7 +5022,7 @@
    throws
    - InvoiceUpdateException + BitPayGenericException
    @@ -4866,7 +5048,7 @@

    @@ -4922,7 +5104,15 @@

    throws
    - PayoutRecipientUpdateException + BitPayGenericException + + +
    +
    + throws +
    +
    + BitPayApiException
    @@ -4948,7 +5138,7 @@

    @@ -5004,15 +5194,7 @@

    throws
    - RefundUpdateException - - -
    -
    - throws -
    -
    - BitPayException + BitPayApiException
    @@ -5042,7 +5224,7 @@

    @@ -5098,15 +5280,7 @@

    throws
    - RefundUpdateException - - -
    -
    - throws -
    -
    - BitPayException + BitPayApiException
    @@ -5136,7 +5310,7 @@

    @@ -5176,7 +5350,7 @@

    @@ -5216,7 +5390,7 @@

    @@ -5256,7 +5430,7 @@

    @@ -5296,7 +5470,7 @@

    @@ -5336,7 +5510,7 @@

    @@ -5376,7 +5550,7 @@

    @@ -5416,7 +5590,7 @@

    @@ -5456,7 +5630,7 @@

    @@ -5496,7 +5670,7 @@

    @@ -5530,7 +5704,7 @@

    throws
    - BitPayException + BitPayGenericException
    @@ -5556,7 +5730,7 @@

    @@ -5592,7 +5766,7 @@

    @@ -5617,11 +5791,9 @@

    throws
    - BitPayException + BitPayGenericException -

    BitPayException class

    -
    - +
    @@ -5641,7 +5813,7 @@

    @@ -5682,7 +5854,7 @@

    throws
    - BitPayException + BitPayApiException
    @@ -5816,8 +5988,8 @@
    Return values
  • @@ -5826,7 +5998,7 @@
    Return values
  • Methods
    • -
    +

    Packages

    BitPaySDK @@ -88,10 +92,6 @@

  • Client -
    • -
  • - Exceptions -
  • Model @@ -105,14 +105,14 @@

    • -
    +

    Reports

    Deprecated

    Errors

    Markers

    -
    +

    Indices

    Files

    @@ -147,7 +147,7 @@

    @@ -274,6 +274,8 @@

    + +

    Properties @@ -297,7 +299,7 @@

    @@ -330,7 +332,7 @@

    @@ -363,7 +365,7 @@

    @@ -401,7 +403,7 @@

    @@ -457,7 +459,7 @@

    @@ -492,7 +494,7 @@

    @@ -526,7 +528,7 @@

    throws
    - Exception + BitPayGenericException
    @@ -552,7 +554,7 @@

    @@ -597,7 +599,7 @@

    @@ -638,7 +640,7 @@

    diff --git a/docs/classes/BitPaySDK-Util-JsonMapperFactory.html b/docs/classes/BitPaySDK-Util-JsonMapperFactory.html index b10175b6..da1f661e 100644 --- a/docs/classes/BitPaySDK-Util-JsonMapperFactory.html +++ b/docs/classes/BitPaySDK-Util-JsonMapperFactory.html @@ -54,7 +54,7 @@

    Bit Menu