👁 查看:CreateLoyaltyRewardRequest.php
路径:/home/forge/woocommerce-square/vendor/square/square/src/Models/CreateLoyaltyRewardRequest.php
大小:2.86 KB · 修改:2025-12-23 20:26:26 · 权限:0644 · 可写
<?php
declare(strict_types=1);
namespace Square\Models;
use stdClass;
/**
* A request to create a loyalty reward.
*/
class CreateLoyaltyRewardRequest implements \JsonSerializable
{
/**
* @var LoyaltyReward
*/
private $reward;
/**
* @var string
*/
private $idempotencyKey;
/**
* @param LoyaltyReward $reward
* @param string $idempotencyKey
*/
public function __construct(LoyaltyReward $reward, string $idempotencyKey)
{
$this->reward = $reward;
$this->idempotencyKey = $idempotencyKey;
}
/**
* Returns Reward.
* Represents a contract to redeem loyalty points for a [reward tier]($m/LoyaltyProgramRewardTier)
* discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state.
* For more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-
* api/loyalty-rewards).
*/
public function getReward(): LoyaltyReward
{
return $this->reward;
}
/**
* Sets Reward.
* Represents a contract to redeem loyalty points for a [reward tier]($m/LoyaltyProgramRewardTier)
* discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state.
* For more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-
* api/loyalty-rewards).
*
* @required
* @maps reward
*/
public function setReward(LoyaltyReward $reward): void
{
$this->reward = $reward;
}
/**
* Returns Idempotency Key.
* A unique string that identifies this `CreateLoyaltyReward` request.
* Keys can be any valid string, but must be unique for every request.
*/
public function getIdempotencyKey(): string
{
return $this->idempotencyKey;
}
/**
* Sets Idempotency Key.
* A unique string that identifies this `CreateLoyaltyReward` request.
* Keys can be any valid string, but must be unique for every request.
*
* @required
* @maps idempotency_key
*/
public function setIdempotencyKey(string $idempotencyKey): void
{
$this->idempotencyKey = $idempotencyKey;
}
/**
* Encode this object to JSON
*
* @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields
* are set. (default: false)
*
* @return array|stdClass
*/
#[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1)
public function jsonSerialize(bool $asArrayWhenEmpty = false)
{
$json = [];
$json['reward'] = $this->reward;
$json['idempotency_key'] = $this->idempotencyKey;
$json = array_filter($json, function ($val) {
return $val !== null;
});
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
}
}