Current File : /home2/selectio/www/fms-worksuite/vendor/square/square/src/Models/GiftCardActivityRefund.php
<?php
declare(strict_types=1);
namespace Square\Models;
use stdClass;
/**
* Present only when `GiftCardActivityType` is REFUND.
*/
class GiftCardActivityRefund implements \JsonSerializable
{
/**
* @var string
*/
private $redeemActivityId;
/**
* @var Money|null
*/
private $amountMoney;
/**
* @var string|null
*/
private $referenceId;
/**
* @var string|null
*/
private $paymentId;
/**
* @param string $redeemActivityId
*/
public function __construct(string $redeemActivityId)
{
$this->redeemActivityId = $redeemActivityId;
}
/**
* Returns Redeem Activity Id.
*
* The ID for the Redeem activity that needs to be refunded. Hence, the activity it
* refers to has to be of the REDEEM type.
*/
public function getRedeemActivityId(): string
{
return $this->redeemActivityId;
}
/**
* Sets Redeem Activity Id.
*
* The ID for the Redeem activity that needs to be refunded. Hence, the activity it
* refers to has to be of the REDEEM type.
*
* @required
* @maps redeem_activity_id
*/
public function setRedeemActivityId(string $redeemActivityId): void
{
$this->redeemActivityId = $redeemActivityId;
}
/**
* Returns Amount Money.
*
* Represents an amount of money. `Money` fields can be signed or unsigned.
* Fields that do not explicitly define whether they are signed or unsigned are
* considered unsigned and can only hold positive amounts. For signed fields, the
* sign of the value indicates the purpose of the money transfer. See
* [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-
* monetary-amounts)
* for more information.
*/
public function getAmountMoney(): ?Money
{
return $this->amountMoney;
}
/**
* Sets Amount Money.
*
* Represents an amount of money. `Money` fields can be signed or unsigned.
* Fields that do not explicitly define whether they are signed or unsigned are
* considered unsigned and can only hold positive amounts. For signed fields, the
* sign of the value indicates the purpose of the money transfer. See
* [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-
* monetary-amounts)
* for more information.
*
* @maps amount_money
*/
public function setAmountMoney(?Money $amountMoney): void
{
$this->amountMoney = $amountMoney;
}
/**
* Returns Reference Id.
*
* A client-specified ID to associate an entity, in another system, with this gift card
* activity. This can be used to track the order or payment related information when the Square Orders
* API is not being used.
*/
public function getReferenceId(): ?string
{
return $this->referenceId;
}
/**
* Sets Reference Id.
*
* A client-specified ID to associate an entity, in another system, with this gift card
* activity. This can be used to track the order or payment related information when the Square Orders
* API is not being used.
*
* @maps reference_id
*/
public function setReferenceId(?string $referenceId): void
{
$this->referenceId = $referenceId;
}
/**
* Returns Payment Id.
*
* When the Square Payments API is used, Refund is not called on the Gift Cards API.
* However, when Square reads a Refund activity from the Gift Cards API, the developer needs to know
* the
* ID of the payment (made using this gift card) that is being refunded.
*/
public function getPaymentId(): ?string
{
return $this->paymentId;
}
/**
* Sets Payment Id.
*
* When the Square Payments API is used, Refund is not called on the Gift Cards API.
* However, when Square reads a Refund activity from the Gift Cards API, the developer needs to know
* the
* ID of the payment (made using this gift card) that is being refunded.
*
* @maps payment_id
*/
public function setPaymentId(?string $paymentId): void
{
$this->paymentId = $paymentId;
}
/**
* Encode this object to JSON
*
* @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields
* are set. (default: false)
*
* @return mixed
*/
public function jsonSerialize(bool $asArrayWhenEmpty = false)
{
$json = [];
$json['redeem_activity_id'] = $this->redeemActivityId;
if (isset($this->amountMoney)) {
$json['amount_money'] = $this->amountMoney;
}
if (isset($this->referenceId)) {
$json['reference_id'] = $this->referenceId;
}
if (isset($this->paymentId)) {
$json['payment_id'] = $this->paymentId;
}
$json = array_filter($json, function ($val) {
return $val !== null;
});
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
}
}
Mini Shell