FileMaster

Edit File: CatalogQuickAmount.php

<?php

declare(strict_types=1);

namespace Square\Models;

use stdClass;

/**
 * Represents a Quick Amount in the Catalog.
 */
class CatalogQuickAmount implements \JsonSerializable
{
    /**
     * @var string
     */
    private $type;

/**
     * @var Money
     */
    private $amount;

/**
     * @var array
     */
    private $score = [];

/**
     * @var array
     */
    private $ordinal = [];

/**
     * @param string $type
     * @param Money $amount
     */
    public function __construct(string $type, Money $amount)
    {
        $this->type = $type;
        $this->amount = $amount;
    }

/**
     * Returns Type.
     * Determines the type of a specific Quick Amount.
     */
    public function getType(): string
    {
        return $this->type;
    }

/**
     * Sets Type.
     * Determines the type of a specific Quick Amount.
     *
     * @required
     * @maps type
     */
    public function setType(string $type): void
    {
        $this->type = $type;
    }

/**
     * Returns Amount.
     * 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 getAmount(): Money
    {
        return $this->amount;
    }

/**
     * Sets Amount.
     * 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.
     *
     * @required
     * @maps amount
     */
    public function setAmount(Money $amount): void
    {
        $this->amount = $amount;
    }

/**
     * Returns Score.
     * Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100].
     * MANUAL type amount will always have score = 100.
     */
    public function getScore(): ?int
    {
        if (count($this->score) == 0) {
            return null;
        }
        return $this->score['value'];
    }

/**
     * Sets Score.
     * Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100].
     * MANUAL type amount will always have score = 100.
     *
     * @maps score
     */
    public function setScore(?int $score): void
    {
        $this->score['value'] = $score;
    }

/**
     * Unsets Score.
     * Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100].
     * MANUAL type amount will always have score = 100.
     */
    public function unsetScore(): void
    {
        $this->score = [];
    }

/**
     * Returns Ordinal.
     * The order in which this Quick Amount should be displayed.
     */
    public function getOrdinal(): ?int
    {
        if (count($this->ordinal) == 0) {
            return null;
        }
        return $this->ordinal['value'];
    }

/**
     * Sets Ordinal.
     * The order in which this Quick Amount should be displayed.
     *
     * @maps ordinal
     */
    public function setOrdinal(?int $ordinal): void
    {
        $this->ordinal['value'] = $ordinal;
    }

/**
     * Unsets Ordinal.
     * The order in which this Quick Amount should be displayed.
     */
    public function unsetOrdinal(): void
    {
        $this->ordinal = [];
    }

/**
     * 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['type']        = $this->type;
        $json['amount']      = $this->amount;
        if (!empty($this->score)) {
            $json['score']   = $this->score['value'];
        }
        if (!empty($this->ordinal)) {
            $json['ordinal'] = $this->ordinal['value'];
        }
        $json = array_filter($json, function ($val) {
            return $val !== null;
        });

return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
    }
}

Back