<?php
/**
 * FulfillmentSummaryLineItem
 *
 * 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;

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

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

    /**
     * Array of property to type mappings. Used for (de)serialization
     *
     * @var string[]
     */
    protected static $openAPITypes = [
        'fulfilled_quantity' => 'string',
        'packed_quantity' => 'string',
        'picked_quantity' => 'string',
        'product_id' => 'string',
        'quantity' => 'string',
        'sale_line_item_id' => 'string'
    ];

    /**
     * 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 = [
        'fulfilled_quantity' => null,
        'packed_quantity' => null,
        'picked_quantity' => null,
        'product_id' => null,
        'quantity' => null,
        'sale_line_item_id' => null
    ];

    /**
     * Array of nullable properties. Used for (de)serialization
     *
     * @var boolean[]
     */
    protected static array $openAPINullables = [
        'fulfilled_quantity' => false,
        'packed_quantity' => false,
        'picked_quantity' => false,
        'product_id' => false,
        'quantity' => false,
        'sale_line_item_id' => 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 = [
        'fulfilled_quantity' => 'fulfilled_quantity',
        'packed_quantity' => 'packed_quantity',
        'picked_quantity' => 'picked_quantity',
        'product_id' => 'product_id',
        'quantity' => 'quantity',
        'sale_line_item_id' => 'sale_line_item_id'
    ];

    /**
     * Array of attributes to setter functions (for deserialization of responses)
     *
     * @var string[]
     */
    protected static $setters = [
        'fulfilled_quantity' => 'setFulfilledQuantity',
        'packed_quantity' => 'setPackedQuantity',
        'picked_quantity' => 'setPickedQuantity',
        'product_id' => 'setProductId',
        'quantity' => 'setQuantity',
        'sale_line_item_id' => 'setSaleLineItemId'
    ];

    /**
     * Array of attributes to getter functions (for serialization of requests)
     *
     * @var string[]
     */
    protected static $getters = [
        'fulfilled_quantity' => 'getFulfilledQuantity',
        'packed_quantity' => 'getPackedQuantity',
        'picked_quantity' => 'getPickedQuantity',
        'product_id' => 'getProductId',
        'quantity' => 'getQuantity',
        'sale_line_item_id' => 'getSaleLineItemId'
    ];

    /**
     * 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('fulfilled_quantity', $data ?? [], null);
        $this->setIfExists('packed_quantity', $data ?? [], null);
        $this->setIfExists('picked_quantity', $data ?? [], null);
        $this->setIfExists('product_id', $data ?? [], null);
        $this->setIfExists('quantity', $data ?? [], null);
        $this->setIfExists('sale_line_item_id', $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 = [];

        if ($this->container['fulfilled_quantity'] === null) {
            $invalidProperties[] = "'fulfilled_quantity' can't be null";
        }
        if (!preg_match("/^-?\\d+(\\.\\d+)?$/", $this->container['fulfilled_quantity'])) {
            $invalidProperties[] = "invalid value for 'fulfilled_quantity', must be conform to the pattern /^-?\\d+(\\.\\d+)?$/.";
        }

        if ($this->container['packed_quantity'] === null) {
            $invalidProperties[] = "'packed_quantity' can't be null";
        }
        if (!preg_match("/^-?\\d+(\\.\\d+)?$/", $this->container['packed_quantity'])) {
            $invalidProperties[] = "invalid value for 'packed_quantity', must be conform to the pattern /^-?\\d+(\\.\\d+)?$/.";
        }

        if ($this->container['picked_quantity'] === null) {
            $invalidProperties[] = "'picked_quantity' can't be null";
        }
        if (!preg_match("/^-?\\d+(\\.\\d+)?$/", $this->container['picked_quantity'])) {
            $invalidProperties[] = "invalid value for 'picked_quantity', must be conform to the pattern /^-?\\d+(\\.\\d+)?$/.";
        }

        if ($this->container['product_id'] === null) {
            $invalidProperties[] = "'product_id' can't be null";
        }
        if ($this->container['quantity'] === null) {
            $invalidProperties[] = "'quantity' can't be null";
        }
        if (!preg_match("/^-?\\d+(\\.\\d+)?$/", $this->container['quantity'])) {
            $invalidProperties[] = "invalid value for 'quantity', must be conform to the pattern /^-?\\d+(\\.\\d+)?$/.";
        }

        if ($this->container['sale_line_item_id'] === null) {
            $invalidProperties[] = "'sale_line_item_id' can't be null";
        }
        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 fulfilled_quantity
     *
     * @return string
     */
    public function getFulfilledQuantity()
    {
        return $this->container['fulfilled_quantity'];
    }

    /**
     * Sets fulfilled_quantity
     *
     * @param string $fulfilled_quantity Quantity that has been fulfilled (decimal as string)
     *
     * @return self
     */
    public function setFulfilledQuantity($fulfilled_quantity)
    {
        if (is_null($fulfilled_quantity)) {
            throw new \InvalidArgumentException('non-nullable fulfilled_quantity cannot be null');
        }

        if ((!preg_match("/^-?\\d+(\\.\\d+)?$/", ObjectSerializer::toString($fulfilled_quantity)))) {
            throw new \InvalidArgumentException("invalid value for \$fulfilled_quantity when calling FulfillmentSummaryLineItem., must conform to the pattern /^-?\\d+(\\.\\d+)?$/.");
        }

        $this->container['fulfilled_quantity'] = $fulfilled_quantity;

        return $this;
    }

    /**
     * Gets packed_quantity
     *
     * @return string
     */
    public function getPackedQuantity()
    {
        return $this->container['packed_quantity'];
    }

    /**
     * Sets packed_quantity
     *
     * @param string $packed_quantity Quantity that has been packed (decimal as string)
     *
     * @return self
     */
    public function setPackedQuantity($packed_quantity)
    {
        if (is_null($packed_quantity)) {
            throw new \InvalidArgumentException('non-nullable packed_quantity cannot be null');
        }

        if ((!preg_match("/^-?\\d+(\\.\\d+)?$/", ObjectSerializer::toString($packed_quantity)))) {
            throw new \InvalidArgumentException("invalid value for \$packed_quantity when calling FulfillmentSummaryLineItem., must conform to the pattern /^-?\\d+(\\.\\d+)?$/.");
        }

        $this->container['packed_quantity'] = $packed_quantity;

        return $this;
    }

    /**
     * Gets picked_quantity
     *
     * @return string
     */
    public function getPickedQuantity()
    {
        return $this->container['picked_quantity'];
    }

    /**
     * Sets picked_quantity
     *
     * @param string $picked_quantity Quantity that has been picked (decimal as string)
     *
     * @return self
     */
    public function setPickedQuantity($picked_quantity)
    {
        if (is_null($picked_quantity)) {
            throw new \InvalidArgumentException('non-nullable picked_quantity cannot be null');
        }

        if ((!preg_match("/^-?\\d+(\\.\\d+)?$/", ObjectSerializer::toString($picked_quantity)))) {
            throw new \InvalidArgumentException("invalid value for \$picked_quantity when calling FulfillmentSummaryLineItem., must conform to the pattern /^-?\\d+(\\.\\d+)?$/.");
        }

        $this->container['picked_quantity'] = $picked_quantity;

        return $this;
    }

    /**
     * Gets product_id
     *
     * @return string
     */
    public function getProductId()
    {
        return $this->container['product_id'];
    }

    /**
     * Sets product_id
     *
     * @param string $product_id Identifier of the product
     *
     * @return self
     */
    public function setProductId($product_id)
    {
        if (is_null($product_id)) {
            throw new \InvalidArgumentException('non-nullable product_id cannot be null');
        }
        $this->container['product_id'] = $product_id;

        return $this;
    }

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

    /**
     * Sets quantity
     *
     * @param string $quantity Total quantity (decimal as string)
     *
     * @return self
     */
    public function setQuantity($quantity)
    {
        if (is_null($quantity)) {
            throw new \InvalidArgumentException('non-nullable quantity cannot be null');
        }

        if ((!preg_match("/^-?\\d+(\\.\\d+)?$/", ObjectSerializer::toString($quantity)))) {
            throw new \InvalidArgumentException("invalid value for \$quantity when calling FulfillmentSummaryLineItem., must conform to the pattern /^-?\\d+(\\.\\d+)?$/.");
        }

        $this->container['quantity'] = $quantity;

        return $this;
    }

    /**
     * Gets sale_line_item_id
     *
     * @return string
     */
    public function getSaleLineItemId()
    {
        return $this->container['sale_line_item_id'];
    }

    /**
     * Sets sale_line_item_id
     *
     * @param string $sale_line_item_id Identifier of the sale line item
     *
     * @return self
     */
    public function setSaleLineItemId($sale_line_item_id)
    {
        if (is_null($sale_line_item_id)) {
            throw new \InvalidArgumentException('non-nullable sale_line_item_id cannot be null');
        }
        $this->container['sale_line_item_id'] = $sale_line_item_id;

        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));
    }
}


