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

/**
 * API 2026-07
 *
 * Lightspeed Retail (X-Series) API.
 *
 * The version of the OpenAPI document: 2026-07
 * Contact: x-series.api@lightspeedhq.com
 * Generated by: https://openapi-generator.tech
 * Generator version: 7.23.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 Vend\Model;

use \ArrayAccess;
use \Vend\ObjectSerializer;

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

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

    /**
     * Array of property to type mappings. Used for (de)serialization
     *
     * @var string[]
     */
    protected static $openAPITypes = [
        'average_cost' => 'float',
        'brand_id' => 'string',
        'current_inventory_level' => 'float',
        'location_id' => 'string',
        'name' => 'string',
        'product_id' => 'string',
        'product_type_id' => 'string',
        'quantity_to_procure' => 'float',
        'reorder_amount' => 'float',
        'reorder_method' => 'string',
        'reorder_target' => 'float',
        'reorder_threshold' => 'float',
        'root_product_id' => 'string',
        'supplier_id' => 'string',
        'total_cost' => 'float'
    ];

    /**
     * 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 = [
        'average_cost' => 'double',
        'brand_id' => 'uuid',
        'current_inventory_level' => 'double',
        'location_id' => 'uuid',
        'name' => null,
        'product_id' => 'uuid',
        'product_type_id' => 'uuid',
        'quantity_to_procure' => 'double',
        'reorder_amount' => 'double',
        'reorder_method' => null,
        'reorder_target' => 'double',
        'reorder_threshold' => 'double',
        'root_product_id' => 'uuid',
        'supplier_id' => 'uuid',
        'total_cost' => 'double'
    ];

    /**
     * Array of nullable properties. Used for (de)serialization
     *
     * @var boolean[]
     */
    protected static array $openAPINullables = [
        'average_cost' => false,
        'brand_id' => false,
        'current_inventory_level' => false,
        'location_id' => false,
        'name' => false,
        'product_id' => false,
        'product_type_id' => false,
        'quantity_to_procure' => false,
        'reorder_amount' => false,
        'reorder_method' => false,
        'reorder_target' => false,
        'reorder_threshold' => false,
        'root_product_id' => false,
        'supplier_id' => false,
        'total_cost' => 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 = [
        'average_cost' => 'average_cost',
        'brand_id' => 'brand_id',
        'current_inventory_level' => 'current_inventory_level',
        'location_id' => 'location_id',
        'name' => 'name',
        'product_id' => 'product_id',
        'product_type_id' => 'product_type_id',
        'quantity_to_procure' => 'quantity_to_procure',
        'reorder_amount' => 'reorder_amount',
        'reorder_method' => 'reorder_method',
        'reorder_target' => 'reorder_target',
        'reorder_threshold' => 'reorder_threshold',
        'root_product_id' => 'root_product_id',
        'supplier_id' => 'supplier_id',
        'total_cost' => 'total_cost'
    ];

    /**
     * Array of attributes to setter functions (for deserialization of responses)
     *
     * @var string[]
     */
    protected static $setters = [
        'average_cost' => 'setAverageCost',
        'brand_id' => 'setBrandId',
        'current_inventory_level' => 'setCurrentInventoryLevel',
        'location_id' => 'setLocationId',
        'name' => 'setName',
        'product_id' => 'setProductId',
        'product_type_id' => 'setProductTypeId',
        'quantity_to_procure' => 'setQuantityToProcure',
        'reorder_amount' => 'setReorderAmount',
        'reorder_method' => 'setReorderMethod',
        'reorder_target' => 'setReorderTarget',
        'reorder_threshold' => 'setReorderThreshold',
        'root_product_id' => 'setRootProductId',
        'supplier_id' => 'setSupplierId',
        'total_cost' => 'setTotalCost'
    ];

    /**
     * Array of attributes to getter functions (for serialization of requests)
     *
     * @var string[]
     */
    protected static $getters = [
        'average_cost' => 'getAverageCost',
        'brand_id' => 'getBrandId',
        'current_inventory_level' => 'getCurrentInventoryLevel',
        'location_id' => 'getLocationId',
        'name' => 'getName',
        'product_id' => 'getProductId',
        'product_type_id' => 'getProductTypeId',
        'quantity_to_procure' => 'getQuantityToProcure',
        'reorder_amount' => 'getReorderAmount',
        'reorder_method' => 'getReorderMethod',
        'reorder_target' => 'getReorderTarget',
        'reorder_threshold' => 'getReorderThreshold',
        'root_product_id' => 'getRootProductId',
        'supplier_id' => 'getSupplierId',
        'total_cost' => 'getTotalCost'
    ];

    /**
     * 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;
    }

    public const REORDER_METHOD_FIXED = 'FIXED';
    public const REORDER_METHOD_MIN_MAX = 'MIN_MAX';

    /**
     * Gets allowable values of the enum
     *
     * @return string[]
     */
    public function getReorderMethodAllowableValues()
    {
        return [
            self::REORDER_METHOD_FIXED,
            self::REORDER_METHOD_MIN_MAX,
        ];
    }

    /**
     * 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('average_cost', $data ?? [], null);
        $this->setIfExists('brand_id', $data ?? [], null);
        $this->setIfExists('current_inventory_level', $data ?? [], null);
        $this->setIfExists('location_id', $data ?? [], null);
        $this->setIfExists('name', $data ?? [], null);
        $this->setIfExists('product_id', $data ?? [], null);
        $this->setIfExists('product_type_id', $data ?? [], null);
        $this->setIfExists('quantity_to_procure', $data ?? [], null);
        $this->setIfExists('reorder_amount', $data ?? [], null);
        $this->setIfExists('reorder_method', $data ?? [], null);
        $this->setIfExists('reorder_target', $data ?? [], null);
        $this->setIfExists('reorder_threshold', $data ?? [], null);
        $this->setIfExists('root_product_id', $data ?? [], null);
        $this->setIfExists('supplier_id', $data ?? [], null);
        $this->setIfExists('total_cost', $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 = [];

        $allowedValues = $this->getReorderMethodAllowableValues();
        if (!is_null($this->container['reorder_method']) && !in_array($this->container['reorder_method'], $allowedValues, true)) {
            $invalidProperties[] = sprintf(
                "invalid value '%s' for 'reorder_method', must be one of '%s'",
                $this->container['reorder_method'],
                implode("', '", $allowedValues)
            );
        }

        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 average_cost
     *
     * @return float|null
     */
    public function getAverageCost()
    {
        return $this->container['average_cost'];
    }

    /**
     * Sets average_cost
     *
     * @param float|null $average_cost The average cost of inventory available to sell.  🔒 Requires: `product:cost:view` scope
     *
     * @return self
     */
    public function setAverageCost($average_cost)
    {
        if (is_null($average_cost)) {
            throw new \InvalidArgumentException('non-nullable average_cost cannot be null');
        }
        $this->container['average_cost'] = $average_cost;

        return $this;
    }

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

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

        return $this;
    }

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

    /**
     * Sets current_inventory_level
     *
     * @param float|null $current_inventory_level Total inventory available to sell.
     *
     * @return self
     */
    public function setCurrentInventoryLevel($current_inventory_level)
    {
        if (is_null($current_inventory_level)) {
            throw new \InvalidArgumentException('non-nullable current_inventory_level cannot be null');
        }
        $this->container['current_inventory_level'] = $current_inventory_level;

        return $this;
    }

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

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

        return $this;
    }

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

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

        return $this;
    }

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

    /**
     * Sets product_id
     *
     * @param string|null $product_id product_id
     *
     * @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 product_type_id
     *
     * @return string|null
     */
    public function getProductTypeId()
    {
        return $this->container['product_type_id'];
    }

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

        return $this;
    }

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

    /**
     * Sets quantity_to_procure
     *
     * @param float|null $quantity_to_procure Quantity of stock to procure in order to satisfy current fulfilments and service orders.
     *
     * @return self
     */
    public function setQuantityToProcure($quantity_to_procure)
    {
        if (is_null($quantity_to_procure)) {
            throw new \InvalidArgumentException('non-nullable quantity_to_procure cannot be null');
        }
        $this->container['quantity_to_procure'] = $quantity_to_procure;

        return $this;
    }

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

    /**
     * Sets reorder_amount
     *
     * @param float|null $reorder_amount The quantity of stock to reorder. For `FIXED`, this is the static amount configured when the reorder method was set up. For `MIN_MAX`, this is dynamically computed as `reorder_target` minus `current_inventory_level` (or zero if current stock already meets or exceeds the target). Omitted if no reorder method is configured.
     *
     * @return self
     */
    public function setReorderAmount($reorder_amount)
    {
        if (is_null($reorder_amount)) {
            throw new \InvalidArgumentException('non-nullable reorder_amount cannot be null');
        }
        $this->container['reorder_amount'] = $reorder_amount;

        return $this;
    }

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

    /**
     * Sets reorder_method
     *
     * @param string|null $reorder_method The reorder strategy in use. `FIXED` uses a static reorder amount each time the threshold is reached. `MIN_MAX` dynamically computes the reorder amount to bring stock up to the configured maximum. Omitted if no reorder method is configured.
     *
     * @return self
     */
    public function setReorderMethod($reorder_method)
    {
        if (is_null($reorder_method)) {
            throw new \InvalidArgumentException('non-nullable reorder_method cannot be null');
        }
        $allowedValues = $this->getReorderMethodAllowableValues();
        if (!in_array($reorder_method, $allowedValues, true)) {
            throw new \InvalidArgumentException(
                sprintf(
                    "Invalid value '%s' for 'reorder_method', must be one of '%s'",
                    $reorder_method,
                    implode("', '", $allowedValues)
                )
            );
        }
        $this->container['reorder_method'] = $reorder_method;

        return $this;
    }

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

    /**
     * Sets reorder_target
     *
     * @param float|null $reorder_target The target inventory level for replenishment. For `FIXED`, this equals `reorder_threshold` + `reorder_amount`. For `MIN_MAX`, this is the maximum inventory level to restock to. Omitted if no reorder method is configured.
     *
     * @return self
     */
    public function setReorderTarget($reorder_target)
    {
        if (is_null($reorder_target)) {
            throw new \InvalidArgumentException('non-nullable reorder_target cannot be null');
        }
        $this->container['reorder_target'] = $reorder_target;

        return $this;
    }

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

    /**
     * Sets reorder_threshold
     *
     * @param float|null $reorder_threshold The inventory level at which reordering is triggered. For `FIXED`, this is the reorder point below which a reorder is suggested. For `MIN_MAX`, this is the minimum inventory level. Omitted if no reorder method is configured.
     *
     * @return self
     */
    public function setReorderThreshold($reorder_threshold)
    {
        if (is_null($reorder_threshold)) {
            throw new \InvalidArgumentException('non-nullable reorder_threshold cannot be null');
        }
        $this->container['reorder_threshold'] = $reorder_threshold;

        return $this;
    }

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

    /**
     * Sets root_product_id
     *
     * @param string|null $root_product_id The root product ID of the product's variant family.
     *
     * @return self
     */
    public function setRootProductId($root_product_id)
    {
        if (is_null($root_product_id)) {
            throw new \InvalidArgumentException('non-nullable root_product_id cannot be null');
        }
        $this->container['root_product_id'] = $root_product_id;

        return $this;
    }

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

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

        return $this;
    }

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

    /**
     * Sets total_cost
     *
     * @param float|null $total_cost The total cost of inventory available to sell.
     *
     * @return self
     */
    public function setTotalCost($total_cost)
    {
        if (is_null($total_cost)) {
            throw new \InvalidArgumentException('non-nullable total_cost cannot be null');
        }
        $this->container['total_cost'] = $total_cost;

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


