<?php
/**
 * BatchPickingWaveStockItems
 *
 * PHP version 7.4
 *
 * @category Class
 * @package  Linnworks\Stock
 * @author   OpenAPI Generator team
 * @link     https://openapi-generator.tech
 */

/**
 * Stock API
 *
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: stock
 * Generated by: https://openapi-generator.tech
 * Generator version: 7.11.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 Linnworks\Stock\Model;

use \ArrayAccess;
use \Linnworks\Stock\ObjectSerializer;

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

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

    /**
      * Array of property to type mappings. Used for (de)serialization
      *
      * @var string[]
      */
    protected static $openAPITypes = [
        'picking_wave_items_row_id' => 'int',
        'picking_wave_id' => 'int',
        'user_name' => 'string',
        'to_pick_quantity' => 'int',
        'picked_quantity' => 'int',
        'stock_item_id' => 'string',
        'order_id' => 'int',
        'user_id' => 'int'
    ];

    /**
      * 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 = [
        'picking_wave_items_row_id' => 'int32',
        'picking_wave_id' => 'int32',
        'user_name' => null,
        'to_pick_quantity' => 'int32',
        'picked_quantity' => 'int32',
        'stock_item_id' => 'uuid',
        'order_id' => 'int32',
        'user_id' => 'int32'
    ];

    /**
      * Array of nullable properties. Used for (de)serialization
      *
      * @var boolean[]
      */
    protected static array $openAPINullables = [
        'picking_wave_items_row_id' => false,
        'picking_wave_id' => false,
        'user_name' => false,
        'to_pick_quantity' => false,
        'picked_quantity' => false,
        'stock_item_id' => false,
        'order_id' => false,
        'user_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 = [
        'picking_wave_items_row_id' => 'PickingWaveItemsRowId',
        'picking_wave_id' => 'PickingWaveId',
        'user_name' => 'UserName',
        'to_pick_quantity' => 'ToPickQuantity',
        'picked_quantity' => 'PickedQuantity',
        'stock_item_id' => 'StockItemId',
        'order_id' => 'OrderId',
        'user_id' => 'UserId'
    ];

    /**
     * Array of attributes to setter functions (for deserialization of responses)
     *
     * @var string[]
     */
    protected static $setters = [
        'picking_wave_items_row_id' => 'setPickingWaveItemsRowId',
        'picking_wave_id' => 'setPickingWaveId',
        'user_name' => 'setUserName',
        'to_pick_quantity' => 'setToPickQuantity',
        'picked_quantity' => 'setPickedQuantity',
        'stock_item_id' => 'setStockItemId',
        'order_id' => 'setOrderId',
        'user_id' => 'setUserId'
    ];

    /**
     * Array of attributes to getter functions (for serialization of requests)
     *
     * @var string[]
     */
    protected static $getters = [
        'picking_wave_items_row_id' => 'getPickingWaveItemsRowId',
        'picking_wave_id' => 'getPickingWaveId',
        'user_name' => 'getUserName',
        'to_pick_quantity' => 'getToPickQuantity',
        'picked_quantity' => 'getPickedQuantity',
        'stock_item_id' => 'getStockItemId',
        'order_id' => 'getOrderId',
        'user_id' => 'getUserId'
    ];

    /**
     * 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('picking_wave_items_row_id', $data ?? [], null);
        $this->setIfExists('picking_wave_id', $data ?? [], null);
        $this->setIfExists('user_name', $data ?? [], null);
        $this->setIfExists('to_pick_quantity', $data ?? [], null);
        $this->setIfExists('picked_quantity', $data ?? [], null);
        $this->setIfExists('stock_item_id', $data ?? [], null);
        $this->setIfExists('order_id', $data ?? [], null);
        $this->setIfExists('user_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 = [];

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

    /**
     * Sets picking_wave_items_row_id
     *
     * @param int|null $picking_wave_items_row_id Pickwave Row Id
     *
     * @return self
     */
    public function setPickingWaveItemsRowId($picking_wave_items_row_id)
    {
        if (is_null($picking_wave_items_row_id)) {
            throw new \InvalidArgumentException('non-nullable picking_wave_items_row_id cannot be null');
        }
        $this->container['picking_wave_items_row_id'] = $picking_wave_items_row_id;

        return $this;
    }

    /**
     * Gets picking_wave_id
     *
     * @return int|null
     */
    public function getPickingWaveId()
    {
        return $this->container['picking_wave_id'];
    }

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

        return $this;
    }

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

    /**
     * Sets user_name
     *
     * @param string|null $user_name User name to whom the pickwave was/is allocated. If unallocated this will be null
     *
     * @return self
     */
    public function setUserName($user_name)
    {
        if (is_null($user_name)) {
            throw new \InvalidArgumentException('non-nullable user_name cannot be null');
        }
        $this->container['user_name'] = $user_name;

        return $this;
    }

    /**
     * Gets to_pick_quantity
     *
     * @return int|null
     */
    public function getToPickQuantity()
    {
        return $this->container['to_pick_quantity'];
    }

    /**
     * Sets to_pick_quantity
     *
     * @param int|null $to_pick_quantity Total Quantity to pick
     *
     * @return self
     */
    public function setToPickQuantity($to_pick_quantity)
    {
        if (is_null($to_pick_quantity)) {
            throw new \InvalidArgumentException('non-nullable to_pick_quantity cannot be null');
        }
        $this->container['to_pick_quantity'] = $to_pick_quantity;

        return $this;
    }

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

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

        return $this;
    }

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

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

        return $this;
    }

    /**
     * Gets order_id
     *
     * @return int|null
     */
    public function getOrderId()
    {
        return $this->container['order_id'];
    }

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

        return $this;
    }

    /**
     * Gets user_id
     *
     * @return int|null
     */
    public function getUserId()
    {
        return $this->container['user_id'];
    }

    /**
     * Sets user_id
     *
     * @param int|null $user_id User Id to whom the pickwave was/is allocated. If unallocated this will be null
     *
     * @return self
     */
    public function setUserId($user_id)
    {
        if (is_null($user_id)) {
            throw new \InvalidArgumentException('non-nullable user_id cannot be null');
        }
        $this->container['user_id'] = $user_id;

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

    /**
     * Gets offset.
     *
     * @param integer $offset Offset
     *
     * @return mixed|null
     */
    #[\ReturnTypeWillChange]
    public function offsetGet($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 $offset Offset
     *
     * @return void
     */
    public function offsetUnset($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));
    }
}


