<?php
/**
 * SaleResponseLineItem
 *
 * PHP version 8.1
 *
 * @category Class
 * @package  Vend202601
 * @author   OpenAPI Generator team
 * @link     https://openapi-generator.tech
 */

/**
 * API 2026-01
 *
 * Lightspeed Retail (X-Series) API.
 *
 * The version of the OpenAPI document: 2026-01
 * Contact: x-series.api@lightspeedhq.com
 * Generated by: https://openapi-generator.tech
 * Generator version: 7.21.0
 */

/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

namespace Vend202601\Model;

use \ArrayAccess;
use \Vend202601\ObjectSerializer;

/**
 * SaleResponseLineItem Class Doc Comment
 *
 * @category Class
 * @package  Vend202601
 * @author   OpenAPI Generator team
 * @link     https://openapi-generator.tech
 * @implements \ArrayAccess<string, mixed>
 */
class SaleResponseLineItem implements ModelInterface, ArrayAccess, \JsonSerializable
{
    public const DISCRIMINATOR = null;

    /**
     * The original name of the model.
     *
     * @var string
     */
    protected static $openAPIModelName = 'SaleResponseLineItem';

    /**
     * Array of property to type mappings. Used for (de)serialization
     *
     * @var string[]
     */
    protected static $openAPITypes = [
        '_metadata' => '\Vend202601\Model\LineItemResponseMetadata',
        'attributes' => '\Vend202601\Model\LineItemAttribute[]',
        'customizations' => 'object[]',
        'gift_card_number' => 'string',
        'id' => 'string',
        'note' => 'string',
        'pricing' => '\Vend202601\Model\LineItemResponsePricing',
        'product' => '\Vend202601\Model\LineItemProductDetails',
        'promotions' => '\Vend202601\Model\LineItemPromotion[]',
        'quantity' => 'float',
        'return' => '\Vend202601\Model\LineItemReturn',
        'salesperson_id' => 'string',
        'source' => '\Vend202601\Model\LineItemResponseSource',
        'status' => 'string',
        'surcharges' => 'object[]',
        'tax' => '\Vend202601\Model\LineItemResponseTax'
    ];

    /**
     * Array of property to format mappings. Used for (de)serialization
     *
     * @var string[]
     * @phpstan-var array<string, string|null>
     * @psalm-var array<string, string|null>
     */
    protected static $openAPIFormats = [
        '_metadata' => null,
        'attributes' => null,
        'customizations' => null,
        'gift_card_number' => null,
        'id' => 'uuid',
        'note' => null,
        'pricing' => null,
        'product' => null,
        'promotions' => null,
        'quantity' => 'double',
        'return' => null,
        'salesperson_id' => 'uuid',
        'source' => null,
        'status' => null,
        'surcharges' => null,
        'tax' => null
    ];

    /**
     * Array of nullable properties. Used for (de)serialization
     *
     * @var boolean[]
     */
    protected static array $openAPINullables = [
        '_metadata' => false,
        'attributes' => false,
        'customizations' => false,
        'gift_card_number' => false,
        'id' => false,
        'note' => false,
        'pricing' => false,
        'product' => false,
        'promotions' => false,
        'quantity' => false,
        'return' => false,
        'salesperson_id' => false,
        'source' => false,
        'status' => false,
        'surcharges' => false,
        'tax' => false
    ];

    /**
     * If a nullable field gets set to null, insert it here
     *
     * @var boolean[]
     */
    protected array $openAPINullablesSetToNull = [];

    /**
     * Array of property to type mappings. Used for (de)serialization
     *
     * @return array
     */
    public static function openAPITypes()
    {
        return self::$openAPITypes;
    }

    /**
     * Array of property to format mappings. Used for (de)serialization
     *
     * @return array
     */
    public static function openAPIFormats()
    {
        return self::$openAPIFormats;
    }

    /**
     * Array of nullable properties
     *
     * @return array
     */
    protected static function openAPINullables(): array
    {
        return self::$openAPINullables;
    }

    /**
     * Array of nullable field names deliberately set to null
     *
     * @return boolean[]
     */
    private function getOpenAPINullablesSetToNull(): array
    {
        return $this->openAPINullablesSetToNull;
    }

    /**
     * Setter - Array of nullable field names deliberately set to null
     *
     * @param boolean[] $openAPINullablesSetToNull
     */
    private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void
    {
        $this->openAPINullablesSetToNull = $openAPINullablesSetToNull;
    }

    /**
     * Checks if a property is nullable
     *
     * @param string $property
     * @return bool
     */
    public static function isNullable(string $property): bool
    {
        return self::openAPINullables()[$property] ?? false;
    }

    /**
     * Checks if a nullable property is set to null.
     *
     * @param string $property
     * @return bool
     */
    public function isNullableSetToNull(string $property): bool
    {
        return in_array($property, $this->getOpenAPINullablesSetToNull(), true);
    }

    /**
     * Array of attributes where the key is the local name,
     * and the value is the original name
     *
     * @var string[]
     */
    protected static $attributeMap = [
        '_metadata' => '_metadata',
        'attributes' => 'attributes',
        'customizations' => 'customizations',
        'gift_card_number' => 'gift_card_number',
        'id' => 'id',
        'note' => 'note',
        'pricing' => 'pricing',
        'product' => 'product',
        'promotions' => 'promotions',
        'quantity' => 'quantity',
        'return' => 'return',
        'salesperson_id' => 'salesperson_id',
        'source' => 'source',
        'status' => 'status',
        'surcharges' => 'surcharges',
        'tax' => 'tax'
    ];

    /**
     * Array of attributes to setter functions (for deserialization of responses)
     *
     * @var string[]
     */
    protected static $setters = [
        '_metadata' => 'setMetadata',
        'attributes' => 'setAttributes',
        'customizations' => 'setCustomizations',
        'gift_card_number' => 'setGiftCardNumber',
        'id' => 'setId',
        'note' => 'setNote',
        'pricing' => 'setPricing',
        'product' => 'setProduct',
        'promotions' => 'setPromotions',
        'quantity' => 'setQuantity',
        'return' => 'setReturn',
        'salesperson_id' => 'setSalespersonId',
        'source' => 'setSource',
        'status' => 'setStatus',
        'surcharges' => 'setSurcharges',
        'tax' => 'setTax'
    ];

    /**
     * Array of attributes to getter functions (for serialization of requests)
     *
     * @var string[]
     */
    protected static $getters = [
        '_metadata' => 'getMetadata',
        'attributes' => 'getAttributes',
        'customizations' => 'getCustomizations',
        'gift_card_number' => 'getGiftCardNumber',
        'id' => 'getId',
        'note' => 'getNote',
        'pricing' => 'getPricing',
        'product' => 'getProduct',
        'promotions' => 'getPromotions',
        'quantity' => 'getQuantity',
        'return' => 'getReturn',
        'salesperson_id' => 'getSalespersonId',
        'source' => 'getSource',
        'status' => 'getStatus',
        'surcharges' => 'getSurcharges',
        'tax' => 'getTax'
    ];

    /**
     * Array of attributes where the key is the local name,
     * and the value is the original name
     *
     * @return array
     */
    public static function attributeMap()
    {
        return self::$attributeMap;
    }

    /**
     * Array of attributes to setter functions (for deserialization of responses)
     *
     * @return array
     */
    public static function setters()
    {
        return self::$setters;
    }

    /**
     * Array of attributes to getter functions (for serialization of requests)
     *
     * @return array
     */
    public static function getters()
    {
        return self::$getters;
    }

    /**
     * The original name of the model.
     *
     * @return string
     */
    public function getModelName()
    {
        return self::$openAPIModelName;
    }


    /**
     * Associative array for storing property values
     *
     * @var mixed[]
     */
    protected $container = [];

    /**
     * Constructor
     *
     * @param mixed[]|null $data Associated array of property values
     *                      initializing the model
     */
    public function __construct(?array $data = null)
    {
        $this->setIfExists('_metadata', $data ?? [], null);
        $this->setIfExists('attributes', $data ?? [], null);
        $this->setIfExists('customizations', $data ?? [], null);
        $this->setIfExists('gift_card_number', $data ?? [], null);
        $this->setIfExists('id', $data ?? [], null);
        $this->setIfExists('note', $data ?? [], null);
        $this->setIfExists('pricing', $data ?? [], null);
        $this->setIfExists('product', $data ?? [], null);
        $this->setIfExists('promotions', $data ?? [], null);
        $this->setIfExists('quantity', $data ?? [], null);
        $this->setIfExists('return', $data ?? [], null);
        $this->setIfExists('salesperson_id', $data ?? [], null);
        $this->setIfExists('source', $data ?? [], null);
        $this->setIfExists('status', $data ?? [], null);
        $this->setIfExists('surcharges', $data ?? [], null);
        $this->setIfExists('tax', $data ?? [], null);
    }

    /**
     * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName
     * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the
     * $this->openAPINullablesSetToNull array
     *
     * @param string $variableName
     * @param array  $fields
     * @param mixed  $defaultValue
     */
    private function setIfExists(string $variableName, array $fields, $defaultValue): void
    {
        if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) {
            $this->openAPINullablesSetToNull[] = $variableName;
        }

        $this->container[$variableName] = $fields[$variableName] ?? $defaultValue;
    }

    /**
     * Show all the invalid properties with reasons.
     *
     * @return array invalid properties with reasons
     */
    public function listInvalidProperties()
    {
        $invalidProperties = [];

        return $invalidProperties;
    }

    /**
     * Validate all the properties in the model
     * return true if all passed
     *
     * @return bool True if all properties are valid
     */
    public function valid()
    {
        return count($this->listInvalidProperties()) === 0;
    }


    /**
     * Gets _metadata
     *
     * @return \Vend202601\Model\LineItemResponseMetadata|null
     */
    public function getMetadata()
    {
        return $this->container['_metadata'];
    }

    /**
     * Sets _metadata
     *
     * @param \Vend202601\Model\LineItemResponseMetadata|null $_metadata _metadata
     *
     * @return self
     */
    public function setMetadata($_metadata)
    {
        if (is_null($_metadata)) {
            throw new \InvalidArgumentException('non-nullable _metadata cannot be null');
        }
        $this->container['_metadata'] = $_metadata;

        return $this;
    }

    /**
     * Gets attributes
     *
     * @return \Vend202601\Model\LineItemAttribute[]|null
     */
    public function getAttributes()
    {
        return $this->container['attributes'];
    }

    /**
     * Sets attributes
     *
     * @param \Vend202601\Model\LineItemAttribute[]|null $attributes Additional line item attributes.
     *
     * @return self
     */
    public function setAttributes($attributes)
    {
        if (is_null($attributes)) {
            throw new \InvalidArgumentException('non-nullable attributes cannot be null');
        }
        $this->container['attributes'] = $attributes;

        return $this;
    }

    /**
     * Gets customizations
     *
     * @return object[]|null
     */
    public function getCustomizations()
    {
        return $this->container['customizations'];
    }

    /**
     * Sets customizations
     *
     * @param object[]|null $customizations Product customizations for this line item.
     *
     * @return self
     */
    public function setCustomizations($customizations)
    {
        if (is_null($customizations)) {
            throw new \InvalidArgumentException('non-nullable customizations cannot be null');
        }
        $this->container['customizations'] = $customizations;

        return $this;
    }

    /**
     * Gets gift_card_number
     *
     * @return string|null
     */
    public function getGiftCardNumber()
    {
        return $this->container['gift_card_number'];
    }

    /**
     * Sets gift_card_number
     *
     * @param string|null $gift_card_number Gift card number if this line item is a gift card.
     *
     * @return self
     */
    public function setGiftCardNumber($gift_card_number)
    {
        if (is_null($gift_card_number)) {
            throw new \InvalidArgumentException('non-nullable gift_card_number cannot be null');
        }
        $this->container['gift_card_number'] = $gift_card_number;

        return $this;
    }

    /**
     * Gets id
     *
     * @return string|null
     */
    public function getId()
    {
        return $this->container['id'];
    }

    /**
     * Sets id
     *
     * @param string|null $id The ID of this line item.
     *
     * @return self
     */
    public function setId($id)
    {
        if (is_null($id)) {
            throw new \InvalidArgumentException('non-nullable id cannot be null');
        }
        $this->container['id'] = $id;

        return $this;
    }

    /**
     * Gets note
     *
     * @return string|null
     */
    public function getNote()
    {
        return $this->container['note'];
    }

    /**
     * Sets note
     *
     * @param string|null $note Line item note.
     *
     * @return self
     */
    public function setNote($note)
    {
        if (is_null($note)) {
            throw new \InvalidArgumentException('non-nullable note cannot be null');
        }
        $this->container['note'] = $note;

        return $this;
    }

    /**
     * Gets pricing
     *
     * @return \Vend202601\Model\LineItemResponsePricing|null
     */
    public function getPricing()
    {
        return $this->container['pricing'];
    }

    /**
     * Sets pricing
     *
     * @param \Vend202601\Model\LineItemResponsePricing|null $pricing pricing
     *
     * @return self
     */
    public function setPricing($pricing)
    {
        if (is_null($pricing)) {
            throw new \InvalidArgumentException('non-nullable pricing cannot be null');
        }
        $this->container['pricing'] = $pricing;

        return $this;
    }

    /**
     * Gets product
     *
     * @return \Vend202601\Model\LineItemProductDetails|null
     */
    public function getProduct()
    {
        return $this->container['product'];
    }

    /**
     * Sets product
     *
     * @param \Vend202601\Model\LineItemProductDetails|null $product product
     *
     * @return self
     */
    public function setProduct($product)
    {
        if (is_null($product)) {
            throw new \InvalidArgumentException('non-nullable product cannot be null');
        }
        $this->container['product'] = $product;

        return $this;
    }

    /**
     * Gets promotions
     *
     * @return \Vend202601\Model\LineItemPromotion[]|null
     */
    public function getPromotions()
    {
        return $this->container['promotions'];
    }

    /**
     * Sets promotions
     *
     * @param \Vend202601\Model\LineItemPromotion[]|null $promotions Promotions applied to this line item.
     *
     * @return self
     */
    public function setPromotions($promotions)
    {
        if (is_null($promotions)) {
            throw new \InvalidArgumentException('non-nullable promotions cannot be null');
        }
        $this->container['promotions'] = $promotions;

        return $this;
    }

    /**
     * Gets quantity
     *
     * @return float|null
     */
    public function getQuantity()
    {
        return $this->container['quantity'];
    }

    /**
     * Sets quantity
     *
     * @param float|null $quantity Quantity of products for the line item.
     *
     * @return self
     */
    public function setQuantity($quantity)
    {
        if (is_null($quantity)) {
            throw new \InvalidArgumentException('non-nullable quantity cannot be null');
        }
        $this->container['quantity'] = $quantity;

        return $this;
    }

    /**
     * Gets return
     *
     * @return \Vend202601\Model\LineItemReturn|null
     */
    public function getReturn()
    {
        return $this->container['return'];
    }

    /**
     * Sets return
     *
     * @param \Vend202601\Model\LineItemReturn|null $return return
     *
     * @return self
     */
    public function setReturn($return)
    {
        if (is_null($return)) {
            throw new \InvalidArgumentException('non-nullable return cannot be null');
        }
        $this->container['return'] = $return;

        return $this;
    }

    /**
     * Gets salesperson_id
     *
     * @return string|null
     */
    public function getSalespersonId()
    {
        return $this->container['salesperson_id'];
    }

    /**
     * Sets salesperson_id
     *
     * @param string|null $salesperson_id The ID of the salesperson associated with this line item. Salesperson IDs can be retrieved from the /api/2.0/users endpoint. Only needed when this line item is not sold by current login user.
     *
     * @return self
     */
    public function setSalespersonId($salesperson_id)
    {
        if (is_null($salesperson_id)) {
            throw new \InvalidArgumentException('non-nullable salesperson_id cannot be null');
        }
        $this->container['salesperson_id'] = $salesperson_id;

        return $this;
    }

    /**
     * Gets source
     *
     * @return \Vend202601\Model\LineItemResponseSource|null
     */
    public function getSource()
    {
        return $this->container['source'];
    }

    /**
     * Sets source
     *
     * @param \Vend202601\Model\LineItemResponseSource|null $source source
     *
     * @return self
     */
    public function setSource($source)
    {
        if (is_null($source)) {
            throw new \InvalidArgumentException('non-nullable source cannot be null');
        }
        $this->container['source'] = $source;

        return $this;
    }

    /**
     * Gets status
     *
     * @return string|null
     */
    public function getStatus()
    {
        return $this->container['status'];
    }

    /**
     * Sets status
     *
     * @param string|null $status If defined as `CONFIRMED` for pending sales, the line item will be added as **read-only**.
     *
     * @return self
     */
    public function setStatus($status)
    {
        if (is_null($status)) {
            throw new \InvalidArgumentException('non-nullable status cannot be null');
        }
        $this->container['status'] = $status;

        return $this;
    }

    /**
     * Gets surcharges
     *
     * @return object[]|null
     */
    public function getSurcharges()
    {
        return $this->container['surcharges'];
    }

    /**
     * Sets surcharges
     *
     * @param object[]|null $surcharges Collection of surcharges associated with the line item.
     *
     * @return self
     */
    public function setSurcharges($surcharges)
    {
        if (is_null($surcharges)) {
            throw new \InvalidArgumentException('non-nullable surcharges cannot be null');
        }
        $this->container['surcharges'] = $surcharges;

        return $this;
    }

    /**
     * Gets tax
     *
     * @return \Vend202601\Model\LineItemResponseTax|null
     */
    public function getTax()
    {
        return $this->container['tax'];
    }

    /**
     * Sets tax
     *
     * @param \Vend202601\Model\LineItemResponseTax|null $tax tax
     *
     * @return self
     */
    public function setTax($tax)
    {
        if (is_null($tax)) {
            throw new \InvalidArgumentException('non-nullable tax cannot be null');
        }
        $this->container['tax'] = $tax;

        return $this;
    }
    /**
     * Returns true if offset exists. False otherwise.
     *
     * @param integer|string $offset Offset
     *
     * @return boolean
     */
    public function offsetExists(mixed $offset): bool
    {
        return isset($this->container[$offset]);
    }

    /**
     * Gets offset.
     *
     * @param integer|string $offset Offset
     *
     * @return mixed|null
     */
    #[\ReturnTypeWillChange]
    public function offsetGet(mixed $offset)
    {
        return $this->container[$offset] ?? null;
    }

    /**
     * Sets value based on offset.
     *
     * @param int|null $offset Offset
     * @param mixed    $value  Value to be set
     *
     * @return void
     */
    public function offsetSet($offset, $value): void
    {
        if (is_null($offset)) {
            $this->container[] = $value;
        } else {
            $this->container[$offset] = $value;
        }
    }

    /**
     * Unsets offset.
     *
     * @param integer|string $offset Offset
     *
     * @return void
     */
    public function offsetUnset(mixed $offset): void
    {
        unset($this->container[$offset]);
    }

    /**
     * Serializes the object to a value that can be serialized natively by json_encode().
     * @link https://www.php.net/manual/en/jsonserializable.jsonserialize.php
     *
     * @return mixed Returns data which can be serialized by json_encode(), which is a value
     * of any type other than a resource.
     */
    #[\ReturnTypeWillChange]
    public function jsonSerialize()
    {
       return ObjectSerializer::sanitizeForSerialization($this);
    }

    /**
     * Gets the string presentation of the object
     *
     * @return string
     */
    public function __toString()
    {
        return json_encode(
            ObjectSerializer::sanitizeForSerialization($this),
            JSON_PRETTY_PRINT
        );
    }

    /**
     * Gets a header-safe presentation of the object
     *
     * @return string
     */
    public function toHeaderValue()
    {
        return json_encode(ObjectSerializer::sanitizeForSerialization($this));
    }
}


