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

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

use \ArrayAccess;
use \Linnworks\Inventory\ObjectSerializer;

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

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

    /**
      * Array of property to type mappings. Used for (de)serialization
      *
      * @var string[]
      */
    protected static $openAPITypes = [
        'inventory_item_id' => 'string',
        'field_name' => 'string',
        'field_value' => 'string',
        'location_id' => 'string',
        'change_source' => '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 = [
        'inventory_item_id' => 'uuid',
        'field_name' => null,
        'field_value' => null,
        'location_id' => 'uuid',
        'change_source' => null
    ];

    /**
      * Array of nullable properties. Used for (de)serialization
      *
      * @var boolean[]
      */
    protected static array $openAPINullables = [
        'inventory_item_id' => false,
        'field_name' => false,
        'field_value' => false,
        'location_id' => false,
        'change_source' => 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 = [
        'inventory_item_id' => 'inventoryItemId',
        'field_name' => 'fieldName',
        'field_value' => 'fieldValue',
        'location_id' => 'locationId',
        'change_source' => 'changeSource'
    ];

    /**
     * Array of attributes to setter functions (for deserialization of responses)
     *
     * @var string[]
     */
    protected static $setters = [
        'inventory_item_id' => 'setInventoryItemId',
        'field_name' => 'setFieldName',
        'field_value' => 'setFieldValue',
        'location_id' => 'setLocationId',
        'change_source' => 'setChangeSource'
    ];

    /**
     * Array of attributes to getter functions (for serialization of requests)
     *
     * @var string[]
     */
    protected static $getters = [
        'inventory_item_id' => 'getInventoryItemId',
        'field_name' => 'getFieldName',
        'field_value' => 'getFieldValue',
        'location_id' => 'getLocationId',
        'change_source' => 'getChangeSource'
    ];

    /**
     * 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 FIELD_NAME_SKU = 'SKU';
    public const FIELD_NAME_TITLE = 'Title';
    public const FIELD_NAME_VARIATION_GROUP_NAME = 'VariationGroupName';
    public const FIELD_NAME_RETAIL_PRICE = 'RetailPrice';
    public const FIELD_NAME_PURCHASE_PRICE = 'PurchasePrice';
    public const FIELD_NAME_TRACKED = 'Tracked';
    public const FIELD_NAME_BARCODE = 'Barcode';
    public const FIELD_NAME_AVAILABLE = 'Available';
    public const FIELD_NAME_MINIMUM_LEVEL = 'MinimumLevel';
    public const FIELD_NAME_IN_ORDER = 'InOrder';
    public const FIELD_NAME_STOCK_LEVEL = 'StockLevel';
    public const FIELD_NAME_STOCK_VALUE = 'StockValue';
    public const FIELD_NAME_DUE = 'Due';
    public const FIELD_NAME_BIN_RACK = 'BinRack';
    public const FIELD_NAME_CATEGORY = 'Category';
    public const FIELD_NAME_IMAGE = 'Image';
    public const FIELD_NAME_WEIGHT = 'Weight';
    public const FIELD_NAME_DIM_HEIGHT = 'DimHeight';
    public const FIELD_NAME_DIM_WIDTH = 'DimWidth';
    public const FIELD_NAME_DIM_DEPTH = 'DimDepth';
    public const FIELD_NAME_CREATED_DATE = 'CreatedDate';
    public const FIELD_NAME_MODIFIED_DATE = 'ModifiedDate';
    public const FIELD_NAME_SERIAL_NUMBER_SCAN_REQUIRED = 'SerialNumberScanRequired';
    public const FIELD_NAME_BATCH_NUMBER_SCAN_REQUIRED = 'BatchNumberScanRequired';
    public const FIELD_NAME_BATCH_TYPE = 'BatchType';
    public const FIELD_NAME_JIT = 'JIT';
    public const FIELD_NAME_REORDER_AMOUNT = 'ReorderAmount';
    public const FIELD_NAME_REORDER_DATE = 'ReorderDate';
    public const FIELD_NAME_AVERAGE_CONSUMPTION = 'AverageConsumption';
    public const FIELD_NAME_DEFAULT_SUPPLIER = 'DefaultSupplier';

    /**
     * Gets allowable values of the enum
     *
     * @return string[]
     */
    public function getFieldNameAllowableValues()
    {
        return [
            self::FIELD_NAME_SKU,
            self::FIELD_NAME_TITLE,
            self::FIELD_NAME_VARIATION_GROUP_NAME,
            self::FIELD_NAME_RETAIL_PRICE,
            self::FIELD_NAME_PURCHASE_PRICE,
            self::FIELD_NAME_TRACKED,
            self::FIELD_NAME_BARCODE,
            self::FIELD_NAME_AVAILABLE,
            self::FIELD_NAME_MINIMUM_LEVEL,
            self::FIELD_NAME_IN_ORDER,
            self::FIELD_NAME_STOCK_LEVEL,
            self::FIELD_NAME_STOCK_VALUE,
            self::FIELD_NAME_DUE,
            self::FIELD_NAME_BIN_RACK,
            self::FIELD_NAME_CATEGORY,
            self::FIELD_NAME_IMAGE,
            self::FIELD_NAME_WEIGHT,
            self::FIELD_NAME_DIM_HEIGHT,
            self::FIELD_NAME_DIM_WIDTH,
            self::FIELD_NAME_DIM_DEPTH,
            self::FIELD_NAME_CREATED_DATE,
            self::FIELD_NAME_MODIFIED_DATE,
            self::FIELD_NAME_SERIAL_NUMBER_SCAN_REQUIRED,
            self::FIELD_NAME_BATCH_NUMBER_SCAN_REQUIRED,
            self::FIELD_NAME_BATCH_TYPE,
            self::FIELD_NAME_JIT,
            self::FIELD_NAME_REORDER_AMOUNT,
            self::FIELD_NAME_REORDER_DATE,
            self::FIELD_NAME_AVERAGE_CONSUMPTION,
            self::FIELD_NAME_DEFAULT_SUPPLIER,
        ];
    }

    /**
     * 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('inventory_item_id', $data ?? [], null);
        $this->setIfExists('field_name', $data ?? [], null);
        $this->setIfExists('field_value', $data ?? [], null);
        $this->setIfExists('location_id', $data ?? [], null);
        $this->setIfExists('change_source', $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->getFieldNameAllowableValues();
        if (!is_null($this->container['field_name']) && !in_array($this->container['field_name'], $allowedValues, true)) {
            $invalidProperties[] = sprintf(
                "invalid value '%s' for 'field_name', must be one of '%s'",
                $this->container['field_name'],
                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 inventory_item_id
     *
     * @return string|null
     */
    public function getInventoryItemId()
    {
        return $this->container['inventory_item_id'];
    }

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

        return $this;
    }

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

    /**
     * Sets field_name
     *
     * @param string|null $field_name Name of field updated
     *
     * @return self
     */
    public function setFieldName($field_name)
    {
        if (is_null($field_name)) {
            throw new \InvalidArgumentException('non-nullable field_name cannot be null');
        }
        $allowedValues = $this->getFieldNameAllowableValues();
        if (!in_array($field_name, $allowedValues, true)) {
            throw new \InvalidArgumentException(
                sprintf(
                    "Invalid value '%s' for 'field_name', must be one of '%s'",
                    $field_name,
                    implode("', '", $allowedValues)
                )
            );
        }
        $this->container['field_name'] = $field_name;

        return $this;
    }

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

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

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

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

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


