<?php

/*
 * The MIT License
 *
 * Copyright (c) 2024 "YooMoney", NBСO LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace YooKassa\Common;

use Ds\Vector;
use ArrayAccess;
use Countable;
use IteratorAggregate;
use JsonSerializable;

/**
 * Interface ListObjectInterface.
 *
 * @category Interface
 * @package  YooKassa
 * @author   cms@yoomoney.ru
 * @link     https://yookassa.ru/developers/api
 */
interface ListObjectInterface extends ArrayAccess, JsonSerializable, Countable, IteratorAggregate
{
    /**
     * @return string
     */
    public function getType(): string;

    /**
     * @param string $type
     * @return $this
     */
    public function setType(string $type): ListObjectInterface;

    /**
     * @param mixed $item
     * @return $this
     */
    public function add(mixed $item): ListObjectInterface;

    /**
     * @param iterable $data
     * @return $this
     */
    public function merge(iterable $data): ListObjectInterface;

    /**
     * @param int $index
     * @return $this
     */
    public function remove(int $index): ListObjectInterface;

    /**
     * @return $this
     */
    public function clear(): ListObjectInterface;

    /**
     * @return bool
     */
    public function isEmpty(): bool;

    /**
     * @return Vector
     */
    public function getItems(): Vector;

    /**
     * @param int $index
     * @return AbstractObject
     */
    public function get(int $index): AbstractObject;

    /**
     * @return array
     */
    public function toArray(): array;
}
