<?php

declare(strict_types=1);

namespace Square\Models;

/**
 * An instance of a custom attribute. Custom attributes can be defined and
 * added to `ITEM` and `ITEM_VARIATION` type catalog objects.
 * [Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-
 * attributes).
 */
class CatalogCustomAttributeValue implements \JsonSerializable
{
    /**
     * @var string|null
     */
    private $name;

    /**
     * @var string|null
     */
    private $stringValue;

    /**
     * @var string|null
     */
    private $customAttributeDefinitionId;

    /**
     * @var string|null
     */
    private $type;

    /**
     * @var string|null
     */
    private $numberValue;

    /**
     * @var bool|null
     */
    private $booleanValue;

    /**
     * @var string[]|null
     */
    private $selectionUidValues;

    /**
     * @var string|null
     */
    private $key;

    /**
     * Returns Name.
     *
     * The name of the custom attribute.
     */
    public function getName(): ?string
    {
        return $this->name;
    }

    /**
     * Sets Name.
     *
     * The name of the custom attribute.
     *
     * @maps name
     */
    public function setName(?string $name): void
    {
        $this->name = $name;
    }

    /**
     * Returns String Value.
     *
     * The string value of the custom attribute.  Populated if `type` = `STRING`.
     */
    public function getStringValue(): ?string
    {
        return $this->stringValue;
    }

    /**
     * Sets String Value.
     *
     * The string value of the custom attribute.  Populated if `type` = `STRING`.
     *
     * @maps string_value
     */
    public function setStringValue(?string $stringValue): void
    {
        $this->stringValue = $stringValue;
    }

    /**
     * Returns Custom Attribute Definition Id.
     *
     * __Read-only.__ The id of the [CatalogCustomAttributeDefinition](#type-
     * CatalogCustomAttributeDefinition) this value belongs to.
     */
    public function getCustomAttributeDefinitionId(): ?string
    {
        return $this->customAttributeDefinitionId;
    }

    /**
     * Sets Custom Attribute Definition Id.
     *
     * __Read-only.__ The id of the [CatalogCustomAttributeDefinition](#type-
     * CatalogCustomAttributeDefinition) this value belongs to.
     *
     * @maps custom_attribute_definition_id
     */
    public function setCustomAttributeDefinitionId(?string $customAttributeDefinitionId): void
    {
        $this->customAttributeDefinitionId = $customAttributeDefinitionId;
    }

    /**
     * Returns Type.
     *
     * Defines the possible types for a custom attribute.
     */
    public function getType(): ?string
    {
        return $this->type;
    }

    /**
     * Sets Type.
     *
     * Defines the possible types for a custom attribute.
     *
     * @maps type
     */
    public function setType(?string $type): void
    {
        $this->type = $type;
    }

    /**
     * Returns Number Value.
     *
     * Populated if `type` = `NUMBER`. Contains a string
     * representation of a decimal number, using a `.` as the decimal separator.
     */
    public function getNumberValue(): ?string
    {
        return $this->numberValue;
    }

    /**
     * Sets Number Value.
     *
     * Populated if `type` = `NUMBER`. Contains a string
     * representation of a decimal number, using a `.` as the decimal separator.
     *
     * @maps number_value
     */
    public function setNumberValue(?string $numberValue): void
    {
        $this->numberValue = $numberValue;
    }

    /**
     * Returns Boolean Value.
     *
     * A `true` or `false` value. Populated if `type` = `BOOLEAN`.
     */
    public function getBooleanValue(): ?bool
    {
        return $this->booleanValue;
    }

    /**
     * Sets Boolean Value.
     *
     * A `true` or `false` value. Populated if `type` = `BOOLEAN`.
     *
     * @maps boolean_value
     */
    public function setBooleanValue(?bool $booleanValue): void
    {
        $this->booleanValue = $booleanValue;
    }

    /**
     * Returns Selection Uid Values.
     *
     * One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`.
     *
     * @return string[]|null
     */
    public function getSelectionUidValues(): ?array
    {
        return $this->selectionUidValues;
    }

    /**
     * Sets Selection Uid Values.
     *
     * One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`.
     *
     * @maps selection_uid_values
     *
     * @param string[]|null $selectionUidValues
     */
    public function setSelectionUidValues(?array $selectionUidValues): void
    {
        $this->selectionUidValues = $selectionUidValues;
    }

    /**
     * Returns Key.
     *
     * __Read-only.__ A copy of key from the associated `CatalogCustomAttributeDefinition`.
     */
    public function getKey(): ?string
    {
        return $this->key;
    }

    /**
     * Sets Key.
     *
     * __Read-only.__ A copy of key from the associated `CatalogCustomAttributeDefinition`.
     *
     * @maps key
     */
    public function setKey(?string $key): void
    {
        $this->key = $key;
    }

    /**
     * Encode this object to JSON
     *
     * @return mixed
     */
    public function jsonSerialize()
    {
        $json = [];
        $json['name']                        = $this->name;
        $json['string_value']                = $this->stringValue;
        $json['custom_attribute_definition_id'] = $this->customAttributeDefinitionId;
        $json['type']                        = $this->type;
        $json['number_value']                = $this->numberValue;
        $json['boolean_value']               = $this->booleanValue;
        $json['selection_uid_values']        = $this->selectionUidValues;
        $json['key']                         = $this->key;

        return array_filter($json, function ($val) {
            return $val !== null;
        });
    }
}
