<?php
/**
 * Copyright ©  All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Leadlion\AutogedalWarehouses\Api;

use Magento\Framework\Api\SearchCriteriaInterface;

interface WarehouseRepositoryInterface
{

    /**
     * Save warehouse
     * @param \Leadlion\AutogedalWarehouses\Api\Data\WarehouseInterface $warehouse
     * @return \Leadlion\AutogedalWarehouses\Api\Data\WarehouseInterface
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    public function save(
        \Leadlion\AutogedalWarehouses\Api\Data\WarehouseInterface $warehouse
    );

    /**
     * Retrieve warehouse
     * @param string $warehouseId
     * @return \Leadlion\AutogedalWarehouses\Api\Data\WarehouseInterface
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    public function get($warehouseId);

    /**
     * Retrieve warehouse matching the specified criteria.
     * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
     * @return \Leadlion\AutogedalWarehouses\Api\Data\WarehouseSearchResultsInterface
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    public function getList(
        \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
    );

    /**
     * Delete warehouse
     * @param \Leadlion\AutogedalWarehouses\Api\Data\WarehouseInterface $warehouse
     * @return bool true on success
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    public function delete(
        \Leadlion\AutogedalWarehouses\Api\Data\WarehouseInterface $warehouse
    );

    /**
     * Delete warehouse by ID
     * @param string $warehouseId
     * @return bool true on success
     * @throws \Magento\Framework\Exception\NoSuchEntityException
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    public function deleteById($warehouseId);
}