<?php

// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

namespace Algolia\AlgoliaSearch\Model\AgentStudio;

use Algolia\AlgoliaSearch\Model\AbstractModel;
use Algolia\AlgoliaSearch\Model\ModelInterface;

/**
 * AlgoliaDisplayResultsToolConfig Class Doc Comment.
 *
 * @category Class
 *
 * @description Configuration for the algolia_display_results tool.
 */
class AlgoliaDisplayResultsToolConfig extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
{
    /**
     * Array of property to type mappings. Used for (de)serialization.
     *
     * @var string[]
     */
    protected static $modelTypes = [
        'name' => 'string',
        'type' => 'string',
        'minGroups' => 'int',
        'maxGroups' => 'int',
        'minResultsPerGroup' => 'int',
        'maxResultsPerGroup' => 'int',
    ];

    /**
     * Array of property to format mappings. Used for (de)serialization.
     *
     * @var string[]
     */
    protected static $modelFormats = [
        'name' => null,
        'type' => null,
        'minGroups' => null,
        'maxGroups' => null,
        'minResultsPerGroup' => null,
        'maxResultsPerGroup' => null,
    ];

    /**
     * Array of attributes where the key is the local name,
     * and the value is the original name.
     *
     * @var string[]
     */
    protected static $attributeMap = [
        'name' => 'name',
        'type' => 'type',
        'minGroups' => 'minGroups',
        'maxGroups' => 'maxGroups',
        'minResultsPerGroup' => 'minResultsPerGroup',
        'maxResultsPerGroup' => 'maxResultsPerGroup',
    ];

    /**
     * Array of attributes to setter functions (for deserialization of responses).
     *
     * @var string[]
     */
    protected static $setters = [
        'name' => 'setName',
        'type' => 'setType',
        'minGroups' => 'setMinGroups',
        'maxGroups' => 'setMaxGroups',
        'minResultsPerGroup' => 'setMinResultsPerGroup',
        'maxResultsPerGroup' => 'setMaxResultsPerGroup',
    ];

    /**
     * Array of attributes to getter functions (for serialization of requests).
     *
     * @var string[]
     */
    protected static $getters = [
        'name' => 'getName',
        'type' => 'getType',
        'minGroups' => 'getMinGroups',
        'maxGroups' => 'getMaxGroups',
        'minResultsPerGroup' => 'getMinResultsPerGroup',
        'maxResultsPerGroup' => 'getMaxResultsPerGroup',
    ];

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

    /**
     * Constructor.
     *
     * @param mixed[] $data Associated array of property values
     */
    public function __construct(?array $data = null)
    {
        if (isset($data['name'])) {
            $this->container['name'] = $data['name'];
        }
        if (isset($data['type'])) {
            $this->container['type'] = $data['type'];
        }
        if (isset($data['minGroups'])) {
            $this->container['minGroups'] = $data['minGroups'];
        }
        if (isset($data['maxGroups'])) {
            $this->container['maxGroups'] = $data['maxGroups'];
        }
        if (isset($data['minResultsPerGroup'])) {
            $this->container['minResultsPerGroup'] = $data['minResultsPerGroup'];
        }
        if (isset($data['maxResultsPerGroup'])) {
            $this->container['maxResultsPerGroup'] = $data['maxResultsPerGroup'];
        }
    }

    /**
     * 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 property to type mappings. Used for (de)serialization.
     *
     * @return array
     */
    public static function modelTypes()
    {
        return self::$modelTypes;
    }

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

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

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

        if (!isset($this->container['type']) || null === $this->container['type']) {
            $invalidProperties[] = "'type' 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 0 === count($this->listInvalidProperties());
    }

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

    /**
     * Sets name.
     *
     * @param null|string $name name
     *
     * @return self
     */
    public function setName($name)
    {
        $this->container['name'] = $name;

        return $this;
    }

    /**
     * Gets type.
     *
     * @return string
     */
    public function getType()
    {
        return $this->container['type'] ?? null;
    }

    /**
     * Sets type.
     *
     * @param string $type type
     *
     * @return self
     */
    public function setType($type)
    {
        $this->container['type'] = $type;

        return $this;
    }

    /**
     * Gets minGroups.
     *
     * @return null|int
     */
    public function getMinGroups()
    {
        return $this->container['minGroups'] ?? null;
    }

    /**
     * Sets minGroups.
     *
     * @param null|int $minGroups minGroups
     *
     * @return self
     */
    public function setMinGroups($minGroups)
    {
        $this->container['minGroups'] = $minGroups;

        return $this;
    }

    /**
     * Gets maxGroups.
     *
     * @return null|int
     */
    public function getMaxGroups()
    {
        return $this->container['maxGroups'] ?? null;
    }

    /**
     * Sets maxGroups.
     *
     * @param null|int $maxGroups maxGroups
     *
     * @return self
     */
    public function setMaxGroups($maxGroups)
    {
        $this->container['maxGroups'] = $maxGroups;

        return $this;
    }

    /**
     * Gets minResultsPerGroup.
     *
     * @return null|int
     */
    public function getMinResultsPerGroup()
    {
        return $this->container['minResultsPerGroup'] ?? null;
    }

    /**
     * Sets minResultsPerGroup.
     *
     * @param null|int $minResultsPerGroup minResultsPerGroup
     *
     * @return self
     */
    public function setMinResultsPerGroup($minResultsPerGroup)
    {
        $this->container['minResultsPerGroup'] = $minResultsPerGroup;

        return $this;
    }

    /**
     * Gets maxResultsPerGroup.
     *
     * @return null|int
     */
    public function getMaxResultsPerGroup()
    {
        return $this->container['maxResultsPerGroup'] ?? null;
    }

    /**
     * Sets maxResultsPerGroup.
     *
     * @param null|int $maxResultsPerGroup maxResultsPerGroup
     *
     * @return self
     */
    public function setMaxResultsPerGroup($maxResultsPerGroup)
    {
        $this->container['maxResultsPerGroup'] = $maxResultsPerGroup;

        return $this;
    }

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

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

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

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